blob: d1fb67d3db81e8ce32e635e4479ea904b58bf15c [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05302/*
Stefan Roese4acd2d22014-10-22 12:13:23 +02003 * Image manipulator for Marvell SoCs
Pali Rohár8010f4f2021-09-24 23:07:02 +02004 * supports Kirkwood, Dove, Armada 370, Armada XP, Armada 375, Armada 38x and
5 * Armada 39x
Stefan Roese4acd2d22014-10-22 12:13:23 +02006 *
7 * (C) Copyright 2013 Thomas Petazzoni
8 * <thomas.petazzoni@free-electrons.com>
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05309 */
10
Heinrich Schuchardt3a8b9192021-12-18 11:25:12 +010011#define OPENSSL_API_COMPAT 0x10101000L
12
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070013#include "imagetool.h"
Andreas Bießmanne5f1a582014-10-24 23:39:11 +020014#include <limits.h>
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +053015#include <image.h>
Mario Sixa1b6b0a2017-01-11 16:01:00 +010016#include <stdarg.h>
Stefan Roese4acd2d22014-10-22 12:13:23 +020017#include <stdint.h>
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +053018#include "kwbimage.h"
19
Jelle van der Waae15843b2017-05-08 21:31:20 +020020#include <openssl/bn.h>
Mario Sixa1b6b0a2017-01-11 16:01:00 +010021#include <openssl/rsa.h>
22#include <openssl/pem.h>
23#include <openssl/err.h>
24#include <openssl/evp.h>
Jelle van der Waae15843b2017-05-08 21:31:20 +020025
Jonathan Graya2d5efd2018-02-21 02:59:01 +110026#if OPENSSL_VERSION_NUMBER < 0x10100000L || \
27 (defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER < 0x2070000fL)
Jelle van der Waae15843b2017-05-08 21:31:20 +020028static void RSA_get0_key(const RSA *r,
29 const BIGNUM **n, const BIGNUM **e, const BIGNUM **d)
30{
31 if (n != NULL)
32 *n = r->n;
33 if (e != NULL)
34 *e = r->e;
35 if (d != NULL)
36 *d = r->d;
37}
38
Jonathan Graya2d5efd2018-02-21 02:59:01 +110039#elif !defined(LIBRESSL_VERSION_NUMBER)
Jelle van der Waae15843b2017-05-08 21:31:20 +020040void EVP_MD_CTX_cleanup(EVP_MD_CTX *ctx)
41{
42 EVP_MD_CTX_reset(ctx);
43}
44#endif
Mario Sixa1b6b0a2017-01-11 16:01:00 +010045
Stefan Roese4acd2d22014-10-22 12:13:23 +020046static struct image_cfg_element *image_cfg;
47static int cfgn;
Mario Sixa1b6b0a2017-01-11 16:01:00 +010048static int verbose_mode;
Stefan Roese4acd2d22014-10-22 12:13:23 +020049
50struct boot_mode {
51 unsigned int id;
52 const char *name;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +053053};
54
Mario Sixa1b6b0a2017-01-11 16:01:00 +010055/*
56 * SHA2-256 hash
57 */
58struct hash_v1 {
59 uint8_t hash[32];
60};
61
Stefan Roese4acd2d22014-10-22 12:13:23 +020062struct boot_mode boot_modes[] = {
Pali Roháre515a332021-08-11 10:14:17 +020063 { IBR_HDR_I2C_ID, "i2c" },
64 { IBR_HDR_SPI_ID, "spi" },
65 { IBR_HDR_NAND_ID, "nand" },
66 { IBR_HDR_SATA_ID, "sata" },
67 { IBR_HDR_PEX_ID, "pex" },
68 { IBR_HDR_UART_ID, "uart" },
69 { IBR_HDR_SDIO_ID, "sdio" },
Stefan Roese4acd2d22014-10-22 12:13:23 +020070 {},
71};
72
73struct nand_ecc_mode {
74 unsigned int id;
75 const char *name;
76};
77
78struct nand_ecc_mode nand_ecc_modes[] = {
Pali Roháre515a332021-08-11 10:14:17 +020079 { IBR_HDR_ECC_DEFAULT, "default" },
80 { IBR_HDR_ECC_FORCED_HAMMING, "hamming" },
81 { IBR_HDR_ECC_FORCED_RS, "rs" },
82 { IBR_HDR_ECC_DISABLED, "disabled" },
Stefan Roese4acd2d22014-10-22 12:13:23 +020083 {},
84};
85
86/* Used to identify an undefined execution or destination address */
87#define ADDR_INVALID ((uint32_t)-1)
88
Pali Rohár6c7f1522021-07-23 11:14:07 +020089#define BINARY_MAX_ARGS 255
Stefan Roese4acd2d22014-10-22 12:13:23 +020090
91/* In-memory representation of a line of the configuration file */
Mario Six4991b4f2017-01-11 16:00:59 +010092
93enum image_cfg_type {
94 IMAGE_CFG_VERSION = 0x1,
95 IMAGE_CFG_BOOT_FROM,
96 IMAGE_CFG_DEST_ADDR,
97 IMAGE_CFG_EXEC_ADDR,
98 IMAGE_CFG_NAND_BLKSZ,
99 IMAGE_CFG_NAND_BADBLK_LOCATION,
100 IMAGE_CFG_NAND_ECC_MODE,
101 IMAGE_CFG_NAND_PAGESZ,
Pali Roháraf496052022-01-12 18:20:40 +0100102 IMAGE_CFG_CPU,
Mario Six4991b4f2017-01-11 16:00:59 +0100103 IMAGE_CFG_BINARY,
Mario Six4991b4f2017-01-11 16:00:59 +0100104 IMAGE_CFG_DATA,
Pali Rohárf63c5832021-07-23 11:14:12 +0200105 IMAGE_CFG_DATA_DELAY,
Mario Six4991b4f2017-01-11 16:00:59 +0100106 IMAGE_CFG_BAUDRATE,
Pali Rohár12f2c032021-11-08 18:12:41 +0100107 IMAGE_CFG_UART_PORT,
108 IMAGE_CFG_UART_MPP,
Mario Six4991b4f2017-01-11 16:00:59 +0100109 IMAGE_CFG_DEBUG,
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100110 IMAGE_CFG_KAK,
111 IMAGE_CFG_CSK,
112 IMAGE_CFG_CSK_INDEX,
113 IMAGE_CFG_JTAG_DELAY,
114 IMAGE_CFG_BOX_ID,
115 IMAGE_CFG_FLASH_ID,
116 IMAGE_CFG_SEC_COMMON_IMG,
117 IMAGE_CFG_SEC_SPECIALIZED_IMG,
118 IMAGE_CFG_SEC_BOOT_DEV,
119 IMAGE_CFG_SEC_FUSE_DUMP,
Mario Six4991b4f2017-01-11 16:00:59 +0100120
121 IMAGE_CFG_COUNT
122} type;
123
124static const char * const id_strs[] = {
125 [IMAGE_CFG_VERSION] = "VERSION",
126 [IMAGE_CFG_BOOT_FROM] = "BOOT_FROM",
127 [IMAGE_CFG_DEST_ADDR] = "DEST_ADDR",
128 [IMAGE_CFG_EXEC_ADDR] = "EXEC_ADDR",
129 [IMAGE_CFG_NAND_BLKSZ] = "NAND_BLKSZ",
130 [IMAGE_CFG_NAND_BADBLK_LOCATION] = "NAND_BADBLK_LOCATION",
131 [IMAGE_CFG_NAND_ECC_MODE] = "NAND_ECC_MODE",
132 [IMAGE_CFG_NAND_PAGESZ] = "NAND_PAGE_SIZE",
Pali Roháraf496052022-01-12 18:20:40 +0100133 [IMAGE_CFG_CPU] = "CPU",
Mario Six4991b4f2017-01-11 16:00:59 +0100134 [IMAGE_CFG_BINARY] = "BINARY",
Mario Six4991b4f2017-01-11 16:00:59 +0100135 [IMAGE_CFG_DATA] = "DATA",
Pali Rohárf63c5832021-07-23 11:14:12 +0200136 [IMAGE_CFG_DATA_DELAY] = "DATA_DELAY",
Mario Six4991b4f2017-01-11 16:00:59 +0100137 [IMAGE_CFG_BAUDRATE] = "BAUDRATE",
Pali Rohár12f2c032021-11-08 18:12:41 +0100138 [IMAGE_CFG_UART_PORT] = "UART_PORT",
139 [IMAGE_CFG_UART_MPP] = "UART_MPP",
Mario Six4991b4f2017-01-11 16:00:59 +0100140 [IMAGE_CFG_DEBUG] = "DEBUG",
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100141 [IMAGE_CFG_KAK] = "KAK",
142 [IMAGE_CFG_CSK] = "CSK",
143 [IMAGE_CFG_CSK_INDEX] = "CSK_INDEX",
144 [IMAGE_CFG_JTAG_DELAY] = "JTAG_DELAY",
145 [IMAGE_CFG_BOX_ID] = "BOX_ID",
146 [IMAGE_CFG_FLASH_ID] = "FLASH_ID",
147 [IMAGE_CFG_SEC_COMMON_IMG] = "SEC_COMMON_IMG",
148 [IMAGE_CFG_SEC_SPECIALIZED_IMG] = "SEC_SPECIALIZED_IMG",
149 [IMAGE_CFG_SEC_BOOT_DEV] = "SEC_BOOT_DEV",
150 [IMAGE_CFG_SEC_FUSE_DUMP] = "SEC_FUSE_DUMP"
Mario Six4991b4f2017-01-11 16:00:59 +0100151};
152
Stefan Roese4acd2d22014-10-22 12:13:23 +0200153struct image_cfg_element {
Mario Six4991b4f2017-01-11 16:00:59 +0100154 enum image_cfg_type type;
Stefan Roese4acd2d22014-10-22 12:13:23 +0200155 union {
156 unsigned int version;
Pali Roháraf496052022-01-12 18:20:40 +0100157 unsigned int cpu_sheeva;
Stefan Roese4acd2d22014-10-22 12:13:23 +0200158 unsigned int bootfrom;
159 struct {
160 const char *file;
Pali Rohár0aca27e2022-01-12 18:20:41 +0100161 unsigned int loadaddr;
Stefan Roese4acd2d22014-10-22 12:13:23 +0200162 unsigned int args[BINARY_MAX_ARGS];
163 unsigned int nargs;
164 } binary;
Stefan Roese4acd2d22014-10-22 12:13:23 +0200165 unsigned int dstaddr;
166 unsigned int execaddr;
167 unsigned int nandblksz;
168 unsigned int nandbadblklocation;
169 unsigned int nandeccmode;
170 unsigned int nandpagesz;
171 struct ext_hdr_v0_reg regdata;
Pali Rohárf63c5832021-07-23 11:14:12 +0200172 unsigned int regdata_delay;
Chris Packham4bdb5472016-11-09 22:07:45 +1300173 unsigned int baudrate;
Pali Rohár12f2c032021-11-08 18:12:41 +0100174 unsigned int uart_port;
175 unsigned int uart_mpp;
Chris Packham2611c052016-11-09 22:21:45 +1300176 unsigned int debug;
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100177 const char *key_name;
178 int csk_idx;
179 uint8_t jtag_delay;
180 uint32_t boxid;
181 uint32_t flashid;
182 bool sec_specialized_img;
183 unsigned int sec_boot_dev;
184 const char *name;
Stefan Roese4acd2d22014-10-22 12:13:23 +0200185 };
186};
187
188#define IMAGE_CFG_ELEMENT_MAX 256
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530189
190/*
Stefan Roese4acd2d22014-10-22 12:13:23 +0200191 * Utility functions to manipulate boot mode and ecc modes (convert
192 * them back and forth between description strings and the
193 * corresponding numerical identifiers).
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530194 */
Stefan Roese4acd2d22014-10-22 12:13:23 +0200195
196static const char *image_boot_mode_name(unsigned int id)
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530197{
Stefan Roese4acd2d22014-10-22 12:13:23 +0200198 int i;
Mario Six94490a42017-01-11 16:00:54 +0100199
Stefan Roese4acd2d22014-10-22 12:13:23 +0200200 for (i = 0; boot_modes[i].name; i++)
201 if (boot_modes[i].id == id)
202 return boot_modes[i].name;
203 return NULL;
204}
205
Pali Rohár6eb20bb2022-01-12 18:20:35 +0100206static int image_boot_mode_id(const char *boot_mode_name)
Stefan Roese4acd2d22014-10-22 12:13:23 +0200207{
208 int i;
Mario Six94490a42017-01-11 16:00:54 +0100209
Stefan Roese4acd2d22014-10-22 12:13:23 +0200210 for (i = 0; boot_modes[i].name; i++)
211 if (!strcmp(boot_modes[i].name, boot_mode_name))
212 return boot_modes[i].id;
213
214 return -1;
215}
216
Pali Rohár6eb20bb2022-01-12 18:20:35 +0100217static int image_nand_ecc_mode_id(const char *nand_ecc_mode_name)
Stefan Roese4acd2d22014-10-22 12:13:23 +0200218{
219 int i;
Mario Six94490a42017-01-11 16:00:54 +0100220
Stefan Roese4acd2d22014-10-22 12:13:23 +0200221 for (i = 0; nand_ecc_modes[i].name; i++)
222 if (!strcmp(nand_ecc_modes[i].name, nand_ecc_mode_name))
223 return nand_ecc_modes[i].id;
224 return -1;
225}
226
227static struct image_cfg_element *
228image_find_option(unsigned int optiontype)
229{
230 int i;
231
232 for (i = 0; i < cfgn; i++) {
233 if (image_cfg[i].type == optiontype)
234 return &image_cfg[i];
235 }
236
237 return NULL;
238}
239
240static unsigned int
241image_count_options(unsigned int optiontype)
242{
243 int i;
244 unsigned int count = 0;
245
246 for (i = 0; i < cfgn; i++)
247 if (image_cfg[i].type == optiontype)
248 count++;
249
250 return count;
251}
252
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100253static int image_get_csk_index(void)
254{
255 struct image_cfg_element *e;
256
257 e = image_find_option(IMAGE_CFG_CSK_INDEX);
258 if (!e)
259 return -1;
260
261 return e->csk_idx;
262}
263
264static bool image_get_spezialized_img(void)
265{
266 struct image_cfg_element *e;
267
268 e = image_find_option(IMAGE_CFG_SEC_SPECIALIZED_IMG);
269 if (!e)
270 return false;
271
272 return e->sec_specialized_img;
273}
274
Pali Rohárd1547b32021-11-08 18:12:43 +0100275static int image_get_bootfrom(void)
276{
277 struct image_cfg_element *e;
278
279 e = image_find_option(IMAGE_CFG_BOOT_FROM);
280 if (!e)
281 /* fallback to SPI if no BOOT_FROM is not provided */
282 return IBR_HDR_SPI_ID;
283
284 return e->bootfrom;
285}
286
Pali Roháraf496052022-01-12 18:20:40 +0100287static int image_is_cpu_sheeva(void)
288{
289 struct image_cfg_element *e;
290
291 e = image_find_option(IMAGE_CFG_CPU);
292 if (!e)
293 return 0;
294
295 return e->cpu_sheeva;
296}
297
Stefan Roese4acd2d22014-10-22 12:13:23 +0200298/*
299 * Compute a 8-bit checksum of a memory area. This algorithm follows
300 * the requirements of the Marvell SoC BootROM specifications.
301 */
302static uint8_t image_checksum8(void *start, uint32_t len)
303{
304 uint8_t csum = 0;
305 uint8_t *p = start;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530306
307 /* check len and return zero checksum if invalid */
308 if (!len)
309 return 0;
310
311 do {
Stefan Roese4acd2d22014-10-22 12:13:23 +0200312 csum += *p;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530313 p++;
314 } while (--len);
Stefan Roese4acd2d22014-10-22 12:13:23 +0200315
316 return csum;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530317}
318
Baruch Siachdb7cd4ed2017-07-04 20:23:40 +0300319/*
320 * Verify checksum over a complete header that includes the checksum field.
321 * Return 1 when OK, otherwise 0.
322 */
323static int main_hdr_checksum_ok(void *hdr)
324{
325 /* Offsets of checksum in v0 and v1 headers are the same */
326 struct main_hdr_v0 *main_hdr = (struct main_hdr_v0 *)hdr;
327 uint8_t checksum;
328
Marek Behúnfe2fd732021-09-24 23:07:01 +0200329 checksum = image_checksum8(hdr, kwbheader_size_for_csum(hdr));
Baruch Siachdb7cd4ed2017-07-04 20:23:40 +0300330 /* Calculated checksum includes the header checksum field. Compensate
331 * for that.
332 */
333 checksum -= main_hdr->checksum;
334
335 return checksum == main_hdr->checksum;
336}
337
Stefan Roese4acd2d22014-10-22 12:13:23 +0200338static uint32_t image_checksum32(void *start, uint32_t len)
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530339{
Stefan Roese4acd2d22014-10-22 12:13:23 +0200340 uint32_t csum = 0;
341 uint32_t *p = start;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530342
343 /* check len and return zero checksum if invalid */
344 if (!len)
345 return 0;
346
347 if (len % sizeof(uint32_t)) {
Stefan Roese4acd2d22014-10-22 12:13:23 +0200348 fprintf(stderr, "Length %d is not in multiple of %zu\n",
349 len, sizeof(uint32_t));
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530350 return 0;
351 }
352
353 do {
Stefan Roese4acd2d22014-10-22 12:13:23 +0200354 csum += *p;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530355 p++;
356 len -= sizeof(uint32_t);
357 } while (len > 0);
Stefan Roese4acd2d22014-10-22 12:13:23 +0200358
359 return csum;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530360}
361
Chris Packham4bdb5472016-11-09 22:07:45 +1300362static uint8_t baudrate_to_option(unsigned int baudrate)
363{
364 switch (baudrate) {
365 case 2400:
366 return MAIN_HDR_V1_OPT_BAUD_2400;
367 case 4800:
368 return MAIN_HDR_V1_OPT_BAUD_4800;
369 case 9600:
370 return MAIN_HDR_V1_OPT_BAUD_9600;
371 case 19200:
372 return MAIN_HDR_V1_OPT_BAUD_19200;
373 case 38400:
374 return MAIN_HDR_V1_OPT_BAUD_38400;
375 case 57600:
376 return MAIN_HDR_V1_OPT_BAUD_57600;
377 case 115200:
378 return MAIN_HDR_V1_OPT_BAUD_115200;
379 default:
380 return MAIN_HDR_V1_OPT_BAUD_DEFAULT;
381 }
382}
383
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100384static void kwb_msg(const char *fmt, ...)
385{
386 if (verbose_mode) {
387 va_list ap;
388
389 va_start(ap, fmt);
390 vfprintf(stdout, fmt, ap);
391 va_end(ap);
392 }
393}
394
395static int openssl_err(const char *msg)
396{
397 unsigned long ssl_err = ERR_get_error();
398
399 fprintf(stderr, "%s", msg);
400 fprintf(stderr, ": %s\n",
401 ERR_error_string(ssl_err, 0));
402
403 return -1;
404}
405
406static int kwb_load_rsa_key(const char *keydir, const char *name, RSA **p_rsa)
407{
408 char path[PATH_MAX];
409 RSA *rsa;
410 FILE *f;
411
412 if (!keydir)
413 keydir = ".";
414
415 snprintf(path, sizeof(path), "%s/%s.key", keydir, name);
416 f = fopen(path, "r");
417 if (!f) {
418 fprintf(stderr, "Couldn't open RSA private key: '%s': %s\n",
419 path, strerror(errno));
420 return -ENOENT;
421 }
422
423 rsa = PEM_read_RSAPrivateKey(f, 0, NULL, "");
424 if (!rsa) {
425 openssl_err("Failure reading private key");
426 fclose(f);
427 return -EPROTO;
428 }
429 fclose(f);
430 *p_rsa = rsa;
431
432 return 0;
433}
434
435static int kwb_load_cfg_key(struct image_tool_params *params,
436 unsigned int cfg_option, const char *key_name,
437 RSA **p_key)
438{
439 struct image_cfg_element *e_key;
440 RSA *key;
441 int res;
442
443 *p_key = NULL;
444
445 e_key = image_find_option(cfg_option);
446 if (!e_key) {
447 fprintf(stderr, "%s not configured\n", key_name);
448 return -ENOENT;
449 }
450
451 res = kwb_load_rsa_key(params->keydir, e_key->key_name, &key);
452 if (res < 0) {
453 fprintf(stderr, "Failed to load %s\n", key_name);
454 return -ENOENT;
455 }
456
457 *p_key = key;
458
459 return 0;
460}
461
462static int kwb_load_kak(struct image_tool_params *params, RSA **p_kak)
463{
464 return kwb_load_cfg_key(params, IMAGE_CFG_KAK, "KAK", p_kak);
465}
466
467static int kwb_load_csk(struct image_tool_params *params, RSA **p_csk)
468{
469 return kwb_load_cfg_key(params, IMAGE_CFG_CSK, "CSK", p_csk);
470}
471
472static int kwb_compute_pubkey_hash(struct pubkey_der_v1 *pk,
473 struct hash_v1 *hash)
474{
475 EVP_MD_CTX *ctx;
476 unsigned int key_size;
477 unsigned int hash_size;
478 int ret = 0;
479
480 if (!pk || !hash || pk->key[0] != 0x30 || pk->key[1] != 0x82)
481 return -EINVAL;
482
483 key_size = (pk->key[2] << 8) + pk->key[3] + 4;
484
485 ctx = EVP_MD_CTX_create();
486 if (!ctx)
487 return openssl_err("EVP context creation failed");
488
489 EVP_MD_CTX_init(ctx);
490 if (!EVP_DigestInit(ctx, EVP_sha256())) {
491 ret = openssl_err("Digest setup failed");
492 goto hash_err_ctx;
493 }
494
495 if (!EVP_DigestUpdate(ctx, pk->key, key_size)) {
496 ret = openssl_err("Hashing data failed");
497 goto hash_err_ctx;
498 }
499
500 if (!EVP_DigestFinal(ctx, hash->hash, &hash_size)) {
501 ret = openssl_err("Could not obtain hash");
502 goto hash_err_ctx;
503 }
504
505 EVP_MD_CTX_cleanup(ctx);
506
507hash_err_ctx:
508 EVP_MD_CTX_destroy(ctx);
509 return ret;
510}
511
512static int kwb_import_pubkey(RSA **key, struct pubkey_der_v1 *src, char *keyname)
513{
514 RSA *rsa;
515 const unsigned char *ptr;
516
517 if (!key || !src)
518 goto fail;
519
520 ptr = src->key;
521 rsa = d2i_RSAPublicKey(key, &ptr, sizeof(src->key));
522 if (!rsa) {
523 openssl_err("error decoding public key");
524 goto fail;
525 }
526
527 return 0;
528fail:
529 fprintf(stderr, "Failed to decode %s pubkey\n", keyname);
530 return -EINVAL;
531}
532
533static int kwb_export_pubkey(RSA *key, struct pubkey_der_v1 *dst, FILE *hashf,
534 char *keyname)
535{
536 int size_exp, size_mod, size_seq;
Jelle van der Waae15843b2017-05-08 21:31:20 +0200537 const BIGNUM *key_e, *key_n;
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100538 uint8_t *cur;
539 char *errmsg = "Failed to encode %s\n";
540
Jelle van der Waae15843b2017-05-08 21:31:20 +0200541 RSA_get0_key(key, NULL, &key_e, NULL);
542 RSA_get0_key(key, &key_n, NULL, NULL);
543
544 if (!key || !key_e || !key_n || !dst) {
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100545 fprintf(stderr, "export pk failed: (%p, %p, %p, %p)",
Jelle van der Waae15843b2017-05-08 21:31:20 +0200546 key, key_e, key_n, dst);
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100547 fprintf(stderr, errmsg, keyname);
548 return -EINVAL;
549 }
550
551 /*
552 * According to the specs, the key should be PKCS#1 DER encoded.
553 * But unfortunately the really required encoding seems to be different;
554 * it violates DER...! (But it still conformes to BER.)
555 * (Length always in long form w/ 2 byte length code; no leading zero
556 * when MSB of first byte is set...)
557 * So we cannot use the encoding func provided by OpenSSL and have to
558 * do the encoding manually.
559 */
560
Jelle van der Waae15843b2017-05-08 21:31:20 +0200561 size_exp = BN_num_bytes(key_e);
562 size_mod = BN_num_bytes(key_n);
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100563 size_seq = 4 + size_mod + 4 + size_exp;
564
565 if (size_mod > 256) {
566 fprintf(stderr, "export pk failed: wrong mod size: %d\n",
567 size_mod);
568 fprintf(stderr, errmsg, keyname);
569 return -EINVAL;
570 }
571
572 if (4 + size_seq > sizeof(dst->key)) {
Marek Behún3b5da642021-09-24 23:06:38 +0200573 fprintf(stderr, "export pk failed: seq too large (%d, %zu)\n",
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100574 4 + size_seq, sizeof(dst->key));
575 fprintf(stderr, errmsg, keyname);
576 return -ENOBUFS;
577 }
578
579 cur = dst->key;
580
581 /* PKCS#1 (RFC3447) RSAPublicKey structure */
582 *cur++ = 0x30; /* SEQUENCE */
583 *cur++ = 0x82;
584 *cur++ = (size_seq >> 8) & 0xFF;
585 *cur++ = size_seq & 0xFF;
586 /* Modulus */
587 *cur++ = 0x02; /* INTEGER */
588 *cur++ = 0x82;
589 *cur++ = (size_mod >> 8) & 0xFF;
590 *cur++ = size_mod & 0xFF;
Jelle van der Waae15843b2017-05-08 21:31:20 +0200591 BN_bn2bin(key_n, cur);
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100592 cur += size_mod;
593 /* Exponent */
594 *cur++ = 0x02; /* INTEGER */
595 *cur++ = 0x82;
596 *cur++ = (size_exp >> 8) & 0xFF;
597 *cur++ = size_exp & 0xFF;
Jelle van der Waae15843b2017-05-08 21:31:20 +0200598 BN_bn2bin(key_e, cur);
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100599
600 if (hashf) {
601 struct hash_v1 pk_hash;
602 int i;
603 int ret = 0;
604
605 ret = kwb_compute_pubkey_hash(dst, &pk_hash);
606 if (ret < 0) {
607 fprintf(stderr, errmsg, keyname);
608 return ret;
609 }
610
611 fprintf(hashf, "SHA256 = ");
612 for (i = 0 ; i < sizeof(pk_hash.hash); ++i)
613 fprintf(hashf, "%02X", pk_hash.hash[i]);
614 fprintf(hashf, "\n");
615 }
616
617 return 0;
618}
619
Pali Rohár6eb20bb2022-01-12 18:20:35 +0100620static int kwb_sign(RSA *key, void *data, int datasz, struct sig_v1 *sig,
621 char *signame)
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100622{
623 EVP_PKEY *evp_key;
624 EVP_MD_CTX *ctx;
625 unsigned int sig_size;
626 int size;
627 int ret = 0;
628
629 evp_key = EVP_PKEY_new();
630 if (!evp_key)
631 return openssl_err("EVP_PKEY object creation failed");
632
633 if (!EVP_PKEY_set1_RSA(evp_key, key)) {
634 ret = openssl_err("EVP key setup failed");
635 goto err_key;
636 }
637
638 size = EVP_PKEY_size(evp_key);
639 if (size > sizeof(sig->sig)) {
640 fprintf(stderr, "Buffer to small for signature (%d bytes)\n",
641 size);
642 ret = -ENOBUFS;
643 goto err_key;
644 }
645
646 ctx = EVP_MD_CTX_create();
647 if (!ctx) {
648 ret = openssl_err("EVP context creation failed");
649 goto err_key;
650 }
651 EVP_MD_CTX_init(ctx);
652 if (!EVP_SignInit(ctx, EVP_sha256())) {
653 ret = openssl_err("Signer setup failed");
654 goto err_ctx;
655 }
656
657 if (!EVP_SignUpdate(ctx, data, datasz)) {
658 ret = openssl_err("Signing data failed");
659 goto err_ctx;
660 }
661
662 if (!EVP_SignFinal(ctx, sig->sig, &sig_size, evp_key)) {
663 ret = openssl_err("Could not obtain signature");
664 goto err_ctx;
665 }
666
667 EVP_MD_CTX_cleanup(ctx);
668 EVP_MD_CTX_destroy(ctx);
669 EVP_PKEY_free(evp_key);
670
671 return 0;
672
673err_ctx:
674 EVP_MD_CTX_destroy(ctx);
675err_key:
676 EVP_PKEY_free(evp_key);
677 fprintf(stderr, "Failed to create %s signature\n", signame);
678 return ret;
679}
680
Pali Rohár6eb20bb2022-01-12 18:20:35 +0100681static int kwb_verify(RSA *key, void *data, int datasz, struct sig_v1 *sig,
682 char *signame)
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100683{
684 EVP_PKEY *evp_key;
685 EVP_MD_CTX *ctx;
686 int size;
687 int ret = 0;
688
689 evp_key = EVP_PKEY_new();
690 if (!evp_key)
691 return openssl_err("EVP_PKEY object creation failed");
692
693 if (!EVP_PKEY_set1_RSA(evp_key, key)) {
694 ret = openssl_err("EVP key setup failed");
695 goto err_key;
696 }
697
698 size = EVP_PKEY_size(evp_key);
699 if (size > sizeof(sig->sig)) {
700 fprintf(stderr, "Invalid signature size (%d bytes)\n",
701 size);
702 ret = -EINVAL;
703 goto err_key;
704 }
705
706 ctx = EVP_MD_CTX_create();
707 if (!ctx) {
708 ret = openssl_err("EVP context creation failed");
709 goto err_key;
710 }
711 EVP_MD_CTX_init(ctx);
712 if (!EVP_VerifyInit(ctx, EVP_sha256())) {
713 ret = openssl_err("Verifier setup failed");
714 goto err_ctx;
715 }
716
717 if (!EVP_VerifyUpdate(ctx, data, datasz)) {
718 ret = openssl_err("Hashing data failed");
719 goto err_ctx;
720 }
721
Young Xiao22515122019-04-17 17:20:24 +0800722 if (EVP_VerifyFinal(ctx, sig->sig, sizeof(sig->sig), evp_key) != 1) {
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100723 ret = openssl_err("Could not verify signature");
724 goto err_ctx;
725 }
726
727 EVP_MD_CTX_cleanup(ctx);
728 EVP_MD_CTX_destroy(ctx);
729 EVP_PKEY_free(evp_key);
730
731 return 0;
732
733err_ctx:
734 EVP_MD_CTX_destroy(ctx);
735err_key:
736 EVP_PKEY_free(evp_key);
737 fprintf(stderr, "Failed to verify %s signature\n", signame);
738 return ret;
739}
740
Pali Rohár6eb20bb2022-01-12 18:20:35 +0100741static int kwb_sign_and_verify(RSA *key, void *data, int datasz,
742 struct sig_v1 *sig, char *signame)
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100743{
744 if (kwb_sign(key, data, datasz, sig, signame) < 0)
745 return -1;
746
747 if (kwb_verify(key, data, datasz, sig, signame) < 0)
748 return -1;
749
750 return 0;
751}
752
753
Pali Rohár6eb20bb2022-01-12 18:20:35 +0100754static int kwb_dump_fuse_cmds_38x(FILE *out, struct secure_hdr_v1 *sec_hdr)
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100755{
756 struct hash_v1 kak_pub_hash;
757 struct image_cfg_element *e;
758 unsigned int fuse_line;
759 int i, idx;
760 uint8_t *ptr;
761 uint32_t val;
762 int ret = 0;
763
764 if (!out || !sec_hdr)
765 return -EINVAL;
766
767 ret = kwb_compute_pubkey_hash(&sec_hdr->kak, &kak_pub_hash);
768 if (ret < 0)
769 goto done;
770
771 fprintf(out, "# burn KAK pub key hash\n");
772 ptr = kak_pub_hash.hash;
773 for (fuse_line = 26; fuse_line <= 30; ++fuse_line) {
774 fprintf(out, "fuse prog -y %u 0 ", fuse_line);
775
776 for (i = 4; i-- > 0;)
777 fprintf(out, "%02hx", (ushort)ptr[i]);
778 ptr += 4;
779 fprintf(out, " 00");
780
781 if (fuse_line < 30) {
782 for (i = 3; i-- > 0;)
783 fprintf(out, "%02hx", (ushort)ptr[i]);
784 ptr += 3;
785 } else {
786 fprintf(out, "000000");
787 }
788
789 fprintf(out, " 1\n");
790 }
791
792 fprintf(out, "# burn CSK selection\n");
793
794 idx = image_get_csk_index();
795 if (idx < 0 || idx > 15) {
796 ret = -EINVAL;
797 goto done;
798 }
799 if (idx > 0) {
800 for (fuse_line = 31; fuse_line < 31 + idx; ++fuse_line)
801 fprintf(out, "fuse prog -y %u 0 00000001 00000000 1\n",
802 fuse_line);
803 } else {
804 fprintf(out, "# CSK index is 0; no mods needed\n");
805 }
806
807 e = image_find_option(IMAGE_CFG_BOX_ID);
808 if (e) {
809 fprintf(out, "# set box ID\n");
810 fprintf(out, "fuse prog -y 48 0 %08x 00000000 1\n", e->boxid);
811 }
812
813 e = image_find_option(IMAGE_CFG_FLASH_ID);
814 if (e) {
815 fprintf(out, "# set flash ID\n");
816 fprintf(out, "fuse prog -y 47 0 %08x 00000000 1\n", e->flashid);
817 }
818
819 fprintf(out, "# enable secure mode ");
820 fprintf(out, "(must be the last fuse line written)\n");
821
822 val = 1;
823 e = image_find_option(IMAGE_CFG_SEC_BOOT_DEV);
824 if (!e) {
825 fprintf(stderr, "ERROR: secured mode boot device not given\n");
826 ret = -EINVAL;
827 goto done;
828 }
829
830 if (e->sec_boot_dev > 0xff) {
831 fprintf(stderr, "ERROR: secured mode boot device invalid\n");
832 ret = -EINVAL;
833 goto done;
834 }
835
836 val |= (e->sec_boot_dev << 8);
837
838 fprintf(out, "fuse prog -y 24 0 %08x 0103e0a9 1\n", val);
839
840 fprintf(out, "# lock (unused) fuse lines (0-23)s\n");
841 for (fuse_line = 0; fuse_line < 24; ++fuse_line)
842 fprintf(out, "fuse prog -y %u 2 1\n", fuse_line);
843
844 fprintf(out, "# OK, that's all :-)\n");
845
846done:
847 return ret;
848}
849
850static int kwb_dump_fuse_cmds(struct secure_hdr_v1 *sec_hdr)
851{
852 int ret = 0;
853 struct image_cfg_element *e;
854
855 e = image_find_option(IMAGE_CFG_SEC_FUSE_DUMP);
856 if (!e)
857 return 0;
858
859 if (!strcmp(e->name, "a38x")) {
860 FILE *out = fopen("kwb_fuses_a38x.txt", "w+");
861
Heinrich Schuchardtf858bb22021-08-17 07:03:20 +0200862 if (!out) {
863 fprintf(stderr, "Couldn't open eFuse settings: '%s': %s\n",
864 "kwb_fuses_a38x.txt", strerror(errno));
865 return -ENOENT;
866 }
867
Mario Sixa1b6b0a2017-01-11 16:01:00 +0100868 kwb_dump_fuse_cmds_38x(out, sec_hdr);
869 fclose(out);
870 goto done;
871 }
872
873 ret = -ENOSYS;
874
875done:
876 return ret;
877}
878
Pali Rohár5cad2e62021-11-08 18:12:48 +0100879static size_t image_headersz_align(size_t headersz, uint8_t blockid)
880{
881 /*
882 * Header needs to be 4-byte aligned, which is already ensured by code
883 * above. Moreover UART images must have header aligned to 128 bytes
884 * (xmodem block size), NAND images to 256 bytes (ECC calculation),
885 * and SATA and SDIO images to 512 bytes (storage block size).
886 * Note that SPI images do not have to have header size aligned
887 * to 256 bytes because it is possible to read from SPI storage from
888 * any offset (read offset does not have to be aligned to block size).
889 */
890 if (blockid == IBR_HDR_UART_ID)
891 return ALIGN(headersz, 128);
892 else if (blockid == IBR_HDR_NAND_ID)
893 return ALIGN(headersz, 256);
894 else if (blockid == IBR_HDR_SATA_ID || blockid == IBR_HDR_SDIO_ID)
895 return ALIGN(headersz, 512);
896 else
897 return headersz;
898}
899
Pali Rohár851114b2021-11-08 18:12:50 +0100900static size_t image_headersz_v0(int *hasext)
901{
902 size_t headersz;
903
904 headersz = sizeof(struct main_hdr_v0);
905 if (image_count_options(IMAGE_CFG_DATA) > 0) {
906 headersz += sizeof(struct ext_hdr_v0);
907 if (hasext)
908 *hasext = 1;
909 }
910
911 return image_headersz_align(headersz, image_get_bootfrom());
912}
913
Stefan Roese4acd2d22014-10-22 12:13:23 +0200914static void *image_create_v0(size_t *imagesz, struct image_tool_params *params,
915 int payloadsz)
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530916{
Stefan Roese4acd2d22014-10-22 12:13:23 +0200917 struct image_cfg_element *e;
918 size_t headersz;
919 struct main_hdr_v0 *main_hdr;
Mario Six885fba12017-01-11 16:00:55 +0100920 uint8_t *image;
Stefan Roese4acd2d22014-10-22 12:13:23 +0200921 int has_ext = 0;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530922
Stefan Roese4acd2d22014-10-22 12:13:23 +0200923 /*
924 * Calculate the size of the header and the size of the
925 * payload
926 */
Pali Rohár851114b2021-11-08 18:12:50 +0100927 headersz = image_headersz_v0(&has_ext);
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530928
Stefan Roese4acd2d22014-10-22 12:13:23 +0200929 image = malloc(headersz);
930 if (!image) {
931 fprintf(stderr, "Cannot allocate memory for image\n");
932 return NULL;
933 }
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530934
Stefan Roese4acd2d22014-10-22 12:13:23 +0200935 memset(image, 0, headersz);
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530936
Mario Six885fba12017-01-11 16:00:55 +0100937 main_hdr = (struct main_hdr_v0 *)image;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530938
Stefan Roese4acd2d22014-10-22 12:13:23 +0200939 /* Fill in the main header */
Reinhard Pfaua8840dc2015-11-29 15:48:25 +0100940 main_hdr->blocksize =
Pali Roháre23ad5d2021-11-08 18:12:47 +0100941 cpu_to_le32(payloadsz);
Reinhard Pfaua8840dc2015-11-29 15:48:25 +0100942 main_hdr->srcaddr = cpu_to_le32(headersz);
Stefan Roese4acd2d22014-10-22 12:13:23 +0200943 main_hdr->ext = has_ext;
Pali Rohár01bdac62021-11-08 18:12:42 +0100944 main_hdr->version = 0;
Reinhard Pfaua8840dc2015-11-29 15:48:25 +0100945 main_hdr->destaddr = cpu_to_le32(params->addr);
946 main_hdr->execaddr = cpu_to_le32(params->ep);
Pali Rohárd1547b32021-11-08 18:12:43 +0100947 main_hdr->blockid = image_get_bootfrom();
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530948
Stefan Roese4acd2d22014-10-22 12:13:23 +0200949 e = image_find_option(IMAGE_CFG_NAND_ECC_MODE);
950 if (e)
951 main_hdr->nandeccmode = e->nandeccmode;
952 e = image_find_option(IMAGE_CFG_NAND_PAGESZ);
953 if (e)
Reinhard Pfaua8840dc2015-11-29 15:48:25 +0100954 main_hdr->nandpagesize = cpu_to_le16(e->nandpagesz);
Stefan Roese4acd2d22014-10-22 12:13:23 +0200955 main_hdr->checksum = image_checksum8(image,
956 sizeof(struct main_hdr_v0));
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530957
Pali Rohár5c617102021-11-08 18:12:51 +0100958 /*
959 * For SATA srcaddr is specified in number of sectors starting from
960 * sector 0. The main header is stored at sector number 1.
961 * This expects the sector size to be 512 bytes.
962 * Header size is already aligned.
963 */
964 if (main_hdr->blockid == IBR_HDR_SATA_ID)
965 main_hdr->srcaddr = cpu_to_le32(headersz / 512 + 1);
966
967 /*
968 * For SDIO srcaddr is specified in number of sectors starting from
969 * sector 0. The main header is stored at sector number 0.
970 * This expects sector size to be 512 bytes.
971 * Header size is already aligned.
972 */
973 if (main_hdr->blockid == IBR_HDR_SDIO_ID)
974 main_hdr->srcaddr = cpu_to_le32(headersz / 512);
975
976 /* For PCIe srcaddr is not used and must be set to 0xFFFFFFFF. */
977 if (main_hdr->blockid == IBR_HDR_PEX_ID)
978 main_hdr->srcaddr = cpu_to_le32(0xFFFFFFFF);
979
Stefan Roese4acd2d22014-10-22 12:13:23 +0200980 /* Generate the ext header */
981 if (has_ext) {
Mario Sixe89016c2017-01-11 16:00:56 +0100982 struct ext_hdr_v0 *ext_hdr;
Stefan Roese4acd2d22014-10-22 12:13:23 +0200983 int cfgi, datai;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530984
Mario Six885fba12017-01-11 16:00:55 +0100985 ext_hdr = (struct ext_hdr_v0 *)
986 (image + sizeof(struct main_hdr_v0));
Reinhard Pfaua8840dc2015-11-29 15:48:25 +0100987 ext_hdr->offset = cpu_to_le32(0x40);
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530988
Stefan Roese4acd2d22014-10-22 12:13:23 +0200989 for (cfgi = 0, datai = 0; cfgi < cfgn; cfgi++) {
990 e = &image_cfg[cfgi];
991 if (e->type != IMAGE_CFG_DATA)
992 continue;
993
Reinhard Pfaua8840dc2015-11-29 15:48:25 +0100994 ext_hdr->rcfg[datai].raddr =
995 cpu_to_le32(e->regdata.raddr);
996 ext_hdr->rcfg[datai].rdata =
997 cpu_to_le32(e->regdata.rdata);
Stefan Roese4acd2d22014-10-22 12:13:23 +0200998 datai++;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530999 }
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301000
Stefan Roese4acd2d22014-10-22 12:13:23 +02001001 ext_hdr->checksum = image_checksum8(ext_hdr,
1002 sizeof(struct ext_hdr_v0));
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301003 }
1004
Stefan Roese4acd2d22014-10-22 12:13:23 +02001005 *imagesz = headersz;
1006 return image;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301007}
1008
Mario Sixe93cf532017-01-11 16:00:57 +01001009static size_t image_headersz_v1(int *hasext)
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301010{
Pali Rohár0aca27e2022-01-12 18:20:41 +01001011 struct image_cfg_element *e;
Pali Rohár02ba70a2021-07-23 11:14:11 +02001012 unsigned int count;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001013 size_t headersz;
Pali Rohár0aca27e2022-01-12 18:20:41 +01001014 int cpu_sheeva;
1015 struct stat s;
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001016 int cfgi;
Pali Rohár0aca27e2022-01-12 18:20:41 +01001017 int ret;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301018
Stefan Roese4acd2d22014-10-22 12:13:23 +02001019 /*
1020 * Calculate the size of the header and the size of the
1021 * payload
1022 */
1023 headersz = sizeof(struct main_hdr_v1);
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301024
Pali Roháre58f08b2021-10-21 16:46:07 +02001025 if (image_get_csk_index() >= 0) {
1026 headersz += sizeof(struct secure_hdr_v1);
1027 if (hasext)
1028 *hasext = 1;
1029 }
1030
Pali Rohár0aca27e2022-01-12 18:20:41 +01001031 cpu_sheeva = image_is_cpu_sheeva();
1032
Pali Rohárd737d5d2022-01-12 18:20:37 +01001033 count = 0;
1034 for (cfgi = 0; cfgi < cfgn; cfgi++) {
1035 e = &image_cfg[cfgi];
1036
1037 if (e->type == IMAGE_CFG_DATA)
1038 count++;
1039
Pali Rohár3db9c412022-01-12 18:20:38 +01001040 if (e->type == IMAGE_CFG_DATA_DELAY ||
1041 (e->type == IMAGE_CFG_BINARY && count > 0)) {
Pali Rohárd737d5d2022-01-12 18:20:37 +01001042 headersz += sizeof(struct register_set_hdr_v1) + 8 * count + 4;
1043 count = 0;
1044 }
Pali Rohár02ba70a2021-07-23 11:14:11 +02001045
Pali Rohár0aca27e2022-01-12 18:20:41 +01001046 if (e->type != IMAGE_CFG_BINARY)
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001047 continue;
1048
Pali Rohár0aca27e2022-01-12 18:20:41 +01001049 ret = stat(e->binary.file, &s);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001050 if (ret < 0) {
Andreas Bießmanne5f1a582014-10-24 23:39:11 +02001051 char cwd[PATH_MAX];
1052 char *dir = cwd;
1053
1054 memset(cwd, 0, sizeof(cwd));
1055 if (!getcwd(cwd, sizeof(cwd))) {
1056 dir = "current working directory";
1057 perror("getcwd() failed");
1058 }
1059
Stefan Roese4acd2d22014-10-22 12:13:23 +02001060 fprintf(stderr,
1061 "Didn't find the file '%s' in '%s' which is mandatory to generate the image\n"
1062 "This file generally contains the DDR3 training code, and should be extracted from an existing bootable\n"
Pali Rohár3d7b93d2021-07-23 11:14:35 +02001063 "image for your board. Use 'dumpimage -T kwbimage -p 0' to extract it from an existing image.\n",
Pali Rohár0aca27e2022-01-12 18:20:41 +01001064 e->binary.file, dir);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001065 return 0;
1066 }
1067
Pali Roháre58f08b2021-10-21 16:46:07 +02001068 headersz += sizeof(struct opt_hdr_v1) + sizeof(uint32_t) +
Pali Rohár0aca27e2022-01-12 18:20:41 +01001069 (e->binary.nargs) * sizeof(uint32_t);
1070
1071 if (e->binary.loadaddr) {
1072 /*
1073 * BootROM loads kwbimage header (in which the
1074 * executable code is also stored) to address
1075 * 0x40004000 or 0x40000000. Thus there is
1076 * restriction for the load address of the N-th
1077 * BINARY image.
1078 */
1079 unsigned int base_addr, low_addr, high_addr;
1080
1081 base_addr = cpu_sheeva ? 0x40004000 : 0x40000000;
1082 low_addr = base_addr + headersz;
1083 high_addr = low_addr +
1084 (BINARY_MAX_ARGS - e->binary.nargs) * sizeof(uint32_t);
1085
1086 if (cpu_sheeva && e->binary.loadaddr % 16) {
1087 fprintf(stderr,
1088 "Invalid LOAD_ADDRESS 0x%08x for BINARY %s with %d args.\n"
1089 "Address for CPU SHEEVA must be 16-byte aligned.\n",
1090 e->binary.loadaddr, e->binary.file, e->binary.nargs);
1091 return 0;
1092 }
1093
1094 if (e->binary.loadaddr % 4 || e->binary.loadaddr < low_addr ||
1095 e->binary.loadaddr > high_addr) {
1096 fprintf(stderr,
1097 "Invalid LOAD_ADDRESS 0x%08x for BINARY %s with %d args.\n"
1098 "Address must be 4-byte aligned and in range 0x%08x-0x%08x.\n",
1099 e->binary.loadaddr, e->binary.file,
1100 e->binary.nargs, low_addr, high_addr);
1101 return 0;
1102 }
1103 headersz = e->binary.loadaddr - base_addr;
Pali Rohárbdf8c9f2022-01-12 18:20:46 +01001104 } else if (cpu_sheeva) {
Pali Rohár0aca27e2022-01-12 18:20:41 +01001105 headersz = ALIGN(headersz, 16);
Pali Rohárbdf8c9f2022-01-12 18:20:46 +01001106 } else {
1107 headersz = ALIGN(headersz, 4);
Pali Rohár0aca27e2022-01-12 18:20:41 +01001108 }
1109
Pali Roháre58f08b2021-10-21 16:46:07 +02001110 headersz += ALIGN(s.st_size, 4) + sizeof(uint32_t);
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001111 if (hasext)
1112 *hasext = 1;
1113 }
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001114
Pali Rohár0aca27e2022-01-12 18:20:41 +01001115 if (count > 0)
1116 headersz += sizeof(struct register_set_hdr_v1) + 8 * count + 4;
1117
Pali Rohár5cad2e62021-11-08 18:12:48 +01001118 return image_headersz_align(headersz, image_get_bootfrom());
Stefan Roese4acd2d22014-10-22 12:13:23 +02001119}
1120
Pali Rohár6eb20bb2022-01-12 18:20:35 +01001121static int add_binary_header_v1(uint8_t **cur, uint8_t **next_ext,
1122 struct image_cfg_element *binarye,
1123 struct main_hdr_v1 *main_hdr)
Mario Six79066ef2017-01-11 16:00:58 +01001124{
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001125 struct opt_hdr_v1 *hdr = (struct opt_hdr_v1 *)*cur;
Pali Rohár0aca27e2022-01-12 18:20:41 +01001126 uint32_t base_addr;
Pali Roháre58f08b2021-10-21 16:46:07 +02001127 uint32_t add_args;
1128 uint32_t offset;
Mario Six79066ef2017-01-11 16:00:58 +01001129 uint32_t *args;
1130 size_t binhdrsz;
Pali Rohár0aca27e2022-01-12 18:20:41 +01001131 int cpu_sheeva;
Mario Six79066ef2017-01-11 16:00:58 +01001132 struct stat s;
1133 int argi;
1134 FILE *bin;
1135 int ret;
1136
Mario Six79066ef2017-01-11 16:00:58 +01001137 hdr->headertype = OPT_HDR_V1_BINARY_TYPE;
1138
1139 bin = fopen(binarye->binary.file, "r");
1140 if (!bin) {
1141 fprintf(stderr, "Cannot open binary file %s\n",
1142 binarye->binary.file);
1143 return -1;
1144 }
1145
Mario Six1f6c8a52017-02-13 10:11:55 +01001146 if (fstat(fileno(bin), &s)) {
1147 fprintf(stderr, "Cannot stat binary file %s\n",
1148 binarye->binary.file);
1149 goto err_close;
1150 }
Mario Six79066ef2017-01-11 16:00:58 +01001151
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001152 *cur += sizeof(struct opt_hdr_v1);
Mario Six79066ef2017-01-11 16:00:58 +01001153
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001154 args = (uint32_t *)*cur;
Mario Six79066ef2017-01-11 16:00:58 +01001155 *args = cpu_to_le32(binarye->binary.nargs);
1156 args++;
1157 for (argi = 0; argi < binarye->binary.nargs; argi++)
1158 args[argi] = cpu_to_le32(binarye->binary.args[argi]);
1159
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001160 *cur += (binarye->binary.nargs + 1) * sizeof(uint32_t);
Mario Six79066ef2017-01-11 16:00:58 +01001161
Pali Roháre58f08b2021-10-21 16:46:07 +02001162 /*
Pali Rohárbdf8c9f2022-01-12 18:20:46 +01001163 * ARM executable code inside the BIN header on platforms with Sheeva
1164 * CPU (A370 and AXP) must always be aligned with the 128-bit boundary.
Pali Rohár0aca27e2022-01-12 18:20:41 +01001165 * In the case when this code is not position independent (e.g. ARM
1166 * SPL), it must be placed at fixed load and execute address.
Pali Roháre58f08b2021-10-21 16:46:07 +02001167 * This requirement can be met by inserting dummy arguments into
1168 * BIN header, if needed.
1169 */
Pali Rohár0aca27e2022-01-12 18:20:41 +01001170 cpu_sheeva = image_is_cpu_sheeva();
1171 base_addr = cpu_sheeva ? 0x40004000 : 0x40000000;
Pali Roháre58f08b2021-10-21 16:46:07 +02001172 offset = *cur - (uint8_t *)main_hdr;
Pali Rohár0aca27e2022-01-12 18:20:41 +01001173 if (binarye->binary.loadaddr)
1174 add_args = (binarye->binary.loadaddr - base_addr - offset) / sizeof(uint32_t);
Pali Rohárbdf8c9f2022-01-12 18:20:46 +01001175 else if (cpu_sheeva)
Pali Rohár0aca27e2022-01-12 18:20:41 +01001176 add_args = ((16 - offset % 16) % 16) / sizeof(uint32_t);
Pali Rohárbdf8c9f2022-01-12 18:20:46 +01001177 else
1178 add_args = 0;
Pali Roháre58f08b2021-10-21 16:46:07 +02001179 if (add_args) {
1180 *(args - 1) = cpu_to_le32(binarye->binary.nargs + add_args);
1181 *cur += add_args * sizeof(uint32_t);
1182 }
1183
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001184 ret = fread(*cur, s.st_size, 1, bin);
Mario Six79066ef2017-01-11 16:00:58 +01001185 if (ret != 1) {
1186 fprintf(stderr,
1187 "Could not read binary image %s\n",
1188 binarye->binary.file);
Mario Six1f6c8a52017-02-13 10:11:55 +01001189 goto err_close;
Mario Six79066ef2017-01-11 16:00:58 +01001190 }
1191
1192 fclose(bin);
1193
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001194 *cur += ALIGN(s.st_size, 4);
Mario Six79066ef2017-01-11 16:00:58 +01001195
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001196 *((uint32_t *)*cur) = 0x00000000;
1197 **next_ext = 1;
1198 *next_ext = *cur;
Mario Six79066ef2017-01-11 16:00:58 +01001199
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001200 *cur += sizeof(uint32_t);
Mario Six79066ef2017-01-11 16:00:58 +01001201
Pali Roháre58f08b2021-10-21 16:46:07 +02001202 binhdrsz = sizeof(struct opt_hdr_v1) +
1203 (binarye->binary.nargs + add_args + 2) * sizeof(uint32_t) +
1204 ALIGN(s.st_size, 4);
1205 hdr->headersz_lsb = cpu_to_le16(binhdrsz & 0xFFFF);
1206 hdr->headersz_msb = (binhdrsz & 0xFFFF0000) >> 16;
1207
Mario Six79066ef2017-01-11 16:00:58 +01001208 return 0;
Mario Six1f6c8a52017-02-13 10:11:55 +01001209
1210err_close:
1211 fclose(bin);
1212
1213 return -1;
Mario Six79066ef2017-01-11 16:00:58 +01001214}
1215
Pali Rohár6eb20bb2022-01-12 18:20:35 +01001216static int export_pub_kak_hash(RSA *kak, struct secure_hdr_v1 *secure_hdr)
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001217{
1218 FILE *hashf;
1219 int res;
1220
1221 hashf = fopen("pub_kak_hash.txt", "w");
Heinrich Schuchardtf858bb22021-08-17 07:03:20 +02001222 if (!hashf) {
1223 fprintf(stderr, "Couldn't open hash file: '%s': %s\n",
1224 "pub_kak_hash.txt", strerror(errno));
1225 return 1;
1226 }
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001227
1228 res = kwb_export_pubkey(kak, &secure_hdr->kak, hashf, "KAK");
1229
1230 fclose(hashf);
1231
1232 return res < 0 ? 1 : 0;
1233}
1234
Pali Rohár6eb20bb2022-01-12 18:20:35 +01001235static int kwb_sign_csk_with_kak(struct image_tool_params *params,
1236 struct secure_hdr_v1 *secure_hdr, RSA *csk)
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001237{
1238 RSA *kak = NULL;
1239 RSA *kak_pub = NULL;
1240 int csk_idx = image_get_csk_index();
1241 struct sig_v1 tmp_sig;
1242
Heinrich Schuchardtf0317d72021-08-17 07:11:58 +02001243 if (csk_idx < 0 || csk_idx > 15) {
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001244 fprintf(stderr, "Invalid CSK index %d\n", csk_idx);
1245 return 1;
1246 }
1247
1248 if (kwb_load_kak(params, &kak) < 0)
1249 return 1;
1250
1251 if (export_pub_kak_hash(kak, secure_hdr))
1252 return 1;
1253
1254 if (kwb_import_pubkey(&kak_pub, &secure_hdr->kak, "KAK") < 0)
1255 return 1;
1256
1257 if (kwb_export_pubkey(csk, &secure_hdr->csk[csk_idx], NULL, "CSK") < 0)
1258 return 1;
1259
1260 if (kwb_sign_and_verify(kak, &secure_hdr->csk,
1261 sizeof(secure_hdr->csk) +
1262 sizeof(secure_hdr->csksig),
1263 &tmp_sig, "CSK") < 0)
1264 return 1;
1265
1266 if (kwb_verify(kak_pub, &secure_hdr->csk,
1267 sizeof(secure_hdr->csk) +
1268 sizeof(secure_hdr->csksig),
1269 &tmp_sig, "CSK (2)") < 0)
1270 return 1;
1271
1272 secure_hdr->csksig = tmp_sig;
1273
1274 return 0;
1275}
1276
Pali Rohár6eb20bb2022-01-12 18:20:35 +01001277static int add_secure_header_v1(struct image_tool_params *params, uint8_t *ptr,
1278 int payloadsz, size_t headersz, uint8_t *image,
1279 struct secure_hdr_v1 *secure_hdr)
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001280{
1281 struct image_cfg_element *e_jtagdelay;
1282 struct image_cfg_element *e_boxid;
1283 struct image_cfg_element *e_flashid;
1284 RSA *csk = NULL;
1285 unsigned char *image_ptr;
1286 size_t image_size;
1287 struct sig_v1 tmp_sig;
1288 bool specialized_img = image_get_spezialized_img();
1289
1290 kwb_msg("Create secure header content\n");
1291
1292 e_jtagdelay = image_find_option(IMAGE_CFG_JTAG_DELAY);
1293 e_boxid = image_find_option(IMAGE_CFG_BOX_ID);
1294 e_flashid = image_find_option(IMAGE_CFG_FLASH_ID);
1295
1296 if (kwb_load_csk(params, &csk) < 0)
1297 return 1;
1298
1299 secure_hdr->headertype = OPT_HDR_V1_SECURE_TYPE;
1300 secure_hdr->headersz_msb = 0;
1301 secure_hdr->headersz_lsb = cpu_to_le16(sizeof(struct secure_hdr_v1));
1302 if (e_jtagdelay)
1303 secure_hdr->jtag_delay = e_jtagdelay->jtag_delay;
1304 if (e_boxid && specialized_img)
1305 secure_hdr->boxid = cpu_to_le32(e_boxid->boxid);
1306 if (e_flashid && specialized_img)
1307 secure_hdr->flashid = cpu_to_le32(e_flashid->flashid);
1308
1309 if (kwb_sign_csk_with_kak(params, secure_hdr, csk))
1310 return 1;
1311
1312 image_ptr = ptr + headersz;
1313 image_size = payloadsz - headersz;
1314
1315 if (kwb_sign_and_verify(csk, image_ptr, image_size,
1316 &secure_hdr->imgsig, "image") < 0)
1317 return 1;
1318
1319 if (kwb_sign_and_verify(csk, image, headersz, &tmp_sig, "header") < 0)
1320 return 1;
1321
1322 secure_hdr->hdrsig = tmp_sig;
1323
1324 kwb_dump_fuse_cmds(secure_hdr);
1325
1326 return 0;
1327}
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001328
Pali Rohár9ac1def2022-01-12 18:20:36 +01001329static void finish_register_set_header_v1(uint8_t **cur, uint8_t **next_ext,
1330 struct register_set_hdr_v1 *register_set_hdr,
1331 int *datai, uint8_t delay)
1332{
1333 int size = sizeof(struct register_set_hdr_v1) + 8 * (*datai) + 4;
1334
1335 register_set_hdr->headertype = OPT_HDR_V1_REGISTER_TYPE;
1336 register_set_hdr->headersz_lsb = cpu_to_le16(size & 0xFFFF);
1337 register_set_hdr->headersz_msb = size >> 16;
1338 register_set_hdr->data[*datai].last_entry.delay = delay;
1339 *cur += size;
1340 **next_ext = 1;
1341 *next_ext = &register_set_hdr->data[*datai].last_entry.next;
1342 *datai = 0;
1343}
1344
Stefan Roese4acd2d22014-10-22 12:13:23 +02001345static void *image_create_v1(size_t *imagesz, struct image_tool_params *params,
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001346 uint8_t *ptr, int payloadsz)
Stefan Roese4acd2d22014-10-22 12:13:23 +02001347{
Mario Six79066ef2017-01-11 16:00:58 +01001348 struct image_cfg_element *e;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001349 struct main_hdr_v1 *main_hdr;
Pali Rohár2b0980c2021-11-08 18:12:49 +01001350 struct opt_hdr_v1 *ohdr;
Pali Rohár02ba70a2021-07-23 11:14:11 +02001351 struct register_set_hdr_v1 *register_set_hdr;
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001352 struct secure_hdr_v1 *secure_hdr = NULL;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001353 size_t headersz;
Mario Six885fba12017-01-11 16:00:55 +01001354 uint8_t *image, *cur;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001355 int hasext = 0;
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001356 uint8_t *next_ext = NULL;
Pali Rohár9ac1def2022-01-12 18:20:36 +01001357 int cfgi, datai;
Pali Rohár3db9c412022-01-12 18:20:38 +01001358 uint8_t delay;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001359
1360 /*
1361 * Calculate the size of the header and the size of the
1362 * payload
1363 */
Mario Sixe93cf532017-01-11 16:00:57 +01001364 headersz = image_headersz_v1(&hasext);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001365 if (headersz == 0)
1366 return NULL;
1367
1368 image = malloc(headersz);
1369 if (!image) {
1370 fprintf(stderr, "Cannot allocate memory for image\n");
1371 return NULL;
1372 }
1373
1374 memset(image, 0, headersz);
1375
Mario Six885fba12017-01-11 16:00:55 +01001376 main_hdr = (struct main_hdr_v1 *)image;
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001377 cur = image;
1378 cur += sizeof(struct main_hdr_v1);
1379 next_ext = &main_hdr->ext;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001380
1381 /* Fill the main header */
Reinhard Pfaua8840dc2015-11-29 15:48:25 +01001382 main_hdr->blocksize =
Pali Roháre23ad5d2021-11-08 18:12:47 +01001383 cpu_to_le32(payloadsz);
Reinhard Pfaua8840dc2015-11-29 15:48:25 +01001384 main_hdr->headersz_lsb = cpu_to_le16(headersz & 0xFFFF);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001385 main_hdr->headersz_msb = (headersz & 0xFFFF0000) >> 16;
Pali Rohárcc3443f2021-07-23 11:14:06 +02001386 main_hdr->destaddr = cpu_to_le32(params->addr);
Reinhard Pfaua8840dc2015-11-29 15:48:25 +01001387 main_hdr->execaddr = cpu_to_le32(params->ep);
1388 main_hdr->srcaddr = cpu_to_le32(headersz);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001389 main_hdr->ext = hasext;
1390 main_hdr->version = 1;
Pali Rohárd1547b32021-11-08 18:12:43 +01001391 main_hdr->blockid = image_get_bootfrom();
1392
Stefan Roese4acd2d22014-10-22 12:13:23 +02001393 e = image_find_option(IMAGE_CFG_NAND_BLKSZ);
1394 if (e)
1395 main_hdr->nandblocksize = e->nandblksz / (64 * 1024);
Pali Rohár2fdba4f2021-10-22 12:37:46 +02001396 e = image_find_option(IMAGE_CFG_NAND_PAGESZ);
1397 if (e)
1398 main_hdr->nandpagesize = cpu_to_le16(e->nandpagesz);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001399 e = image_find_option(IMAGE_CFG_NAND_BADBLK_LOCATION);
1400 if (e)
1401 main_hdr->nandbadblklocation = e->nandbadblklocation;
Chris Packham4bdb5472016-11-09 22:07:45 +13001402 e = image_find_option(IMAGE_CFG_BAUDRATE);
1403 if (e)
Pali Rohár12f2c032021-11-08 18:12:41 +01001404 main_hdr->options |= baudrate_to_option(e->baudrate);
1405 e = image_find_option(IMAGE_CFG_UART_PORT);
1406 if (e)
1407 main_hdr->options |= (e->uart_port & 3) << 3;
1408 e = image_find_option(IMAGE_CFG_UART_MPP);
1409 if (e)
1410 main_hdr->options |= (e->uart_mpp & 7) << 5;
Chris Packham2611c052016-11-09 22:21:45 +13001411 e = image_find_option(IMAGE_CFG_DEBUG);
1412 if (e)
1413 main_hdr->flags = e->debug ? 0x1 : 0;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001414
Pali Rohár501a54a2021-07-23 11:13:59 +02001415 /*
1416 * For SATA srcaddr is specified in number of sectors starting from
1417 * sector 0. The main header is stored at sector number 1.
1418 * This expects the sector size to be 512 bytes.
1419 * Header size is already aligned.
1420 */
1421 if (main_hdr->blockid == IBR_HDR_SATA_ID)
1422 main_hdr->srcaddr = cpu_to_le32(headersz / 512 + 1);
1423
1424 /*
1425 * For SDIO srcaddr is specified in number of sectors starting from
1426 * sector 0. The main header is stored at sector number 0.
1427 * This expects sector size to be 512 bytes.
1428 * Header size is already aligned.
1429 */
1430 if (main_hdr->blockid == IBR_HDR_SDIO_ID)
1431 main_hdr->srcaddr = cpu_to_le32(headersz / 512);
1432
1433 /* For PCIe srcaddr is not used and must be set to 0xFFFFFFFF. */
1434 if (main_hdr->blockid == IBR_HDR_PEX_ID)
1435 main_hdr->srcaddr = cpu_to_le32(0xFFFFFFFF);
1436
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001437 if (image_get_csk_index() >= 0) {
1438 /*
1439 * only reserve the space here; we fill the header later since
1440 * we need the header to be complete to compute the signatures
1441 */
1442 secure_hdr = (struct secure_hdr_v1 *)cur;
1443 cur += sizeof(struct secure_hdr_v1);
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001444 *next_ext = 1;
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001445 next_ext = &secure_hdr->next;
1446 }
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001447
Pali Rohár02ba70a2021-07-23 11:14:11 +02001448 datai = 0;
Pali Rohár02ba70a2021-07-23 11:14:11 +02001449 for (cfgi = 0; cfgi < cfgn; cfgi++) {
1450 e = &image_cfg[cfgi];
Pali Rohárf63c5832021-07-23 11:14:12 +02001451 if (e->type != IMAGE_CFG_DATA &&
Pali Rohár3db9c412022-01-12 18:20:38 +01001452 e->type != IMAGE_CFG_DATA_DELAY &&
1453 e->type != IMAGE_CFG_BINARY)
Pali Rohár02ba70a2021-07-23 11:14:11 +02001454 continue;
Pali Rohár3db9c412022-01-12 18:20:38 +01001455
Pali Rohárd737d5d2022-01-12 18:20:37 +01001456 if (datai == 0)
1457 register_set_hdr = (struct register_set_hdr_v1 *)cur;
Pali Rohár3db9c412022-01-12 18:20:38 +01001458
1459 /* If delay is not specified, use the smallest possible value. */
1460 if (e->type == IMAGE_CFG_DATA_DELAY)
1461 delay = e->regdata_delay;
1462 else
1463 delay = REGISTER_SET_HDR_OPT_DELAY_MS(0);
1464
1465 /*
1466 * DATA_DELAY command is the last entry in the register set
1467 * header and BINARY command inserts new binary header.
1468 * Therefore BINARY command requires to finish register set
1469 * header if some DATA command was specified. And DATA_DELAY
1470 * command automatically finish register set header even when
1471 * there was no DATA command.
1472 */
1473 if (e->type == IMAGE_CFG_DATA_DELAY ||
1474 (e->type == IMAGE_CFG_BINARY && datai != 0))
Pali Rohár9ac1def2022-01-12 18:20:36 +01001475 finish_register_set_header_v1(&cur, &next_ext, register_set_hdr,
Pali Rohár3db9c412022-01-12 18:20:38 +01001476 &datai, delay);
1477
1478 if (e->type == IMAGE_CFG_DATA) {
1479 register_set_hdr->data[datai].entry.address =
1480 cpu_to_le32(e->regdata.raddr);
1481 register_set_hdr->data[datai].entry.value =
1482 cpu_to_le32(e->regdata.rdata);
1483 datai++;
Pali Rohárf63c5832021-07-23 11:14:12 +02001484 }
Pali Rohár3db9c412022-01-12 18:20:38 +01001485
1486 if (e->type == IMAGE_CFG_BINARY) {
1487 if (add_binary_header_v1(&cur, &next_ext, e, main_hdr))
1488 return NULL;
1489 }
Pali Rohár02ba70a2021-07-23 11:14:11 +02001490 }
1491 if (datai != 0) {
Pali Rohár9ac1def2022-01-12 18:20:36 +01001492 /* Set delay to the smallest possible value. */
Pali Rohár3db9c412022-01-12 18:20:38 +01001493 delay = REGISTER_SET_HDR_OPT_DELAY_MS(0);
Pali Rohár9ac1def2022-01-12 18:20:36 +01001494 finish_register_set_header_v1(&cur, &next_ext, register_set_hdr,
Pali Rohár3db9c412022-01-12 18:20:38 +01001495 &datai, delay);
Pali Rohárd9fb82c2021-07-23 11:14:09 +02001496 }
Stefan Roese4acd2d22014-10-22 12:13:23 +02001497
Pali Roháre23ad5d2021-11-08 18:12:47 +01001498 if (secure_hdr && add_secure_header_v1(params, ptr, payloadsz + headersz,
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001499 headersz, image, secure_hdr))
1500 return NULL;
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001501
Stefan Roese4acd2d22014-10-22 12:13:23 +02001502 *imagesz = headersz;
Pali Rohár2b0980c2021-11-08 18:12:49 +01001503
1504 /* Fill the real header size without padding into the main header */
1505 headersz = sizeof(*main_hdr);
1506 for_each_opt_hdr_v1 (ohdr, main_hdr)
1507 headersz += opt_hdr_v1_size(ohdr);
1508 main_hdr->headersz_lsb = cpu_to_le16(headersz & 0xFFFF);
1509 main_hdr->headersz_msb = (headersz & 0xFFFF0000) >> 16;
1510
Pierre Bourdon9203c732021-12-25 20:50:19 +01001511 /* Calculate and set the header checksum */
1512 main_hdr->checksum = image_checksum8(main_hdr, headersz);
1513
Stefan Roese4acd2d22014-10-22 12:13:23 +02001514 return image;
1515}
1516
Pali Rohár6eb20bb2022-01-12 18:20:35 +01001517static int recognize_keyword(char *keyword)
Mario Six4991b4f2017-01-11 16:00:59 +01001518{
1519 int kw_id;
1520
1521 for (kw_id = 1; kw_id < IMAGE_CFG_COUNT; ++kw_id)
1522 if (!strcmp(keyword, id_strs[kw_id]))
1523 return kw_id;
1524
1525 return 0;
1526}
1527
Stefan Roese4acd2d22014-10-22 12:13:23 +02001528static int image_create_config_parse_oneline(char *line,
1529 struct image_cfg_element *el)
1530{
Mario Six4991b4f2017-01-11 16:00:59 +01001531 char *keyword, *saveptr, *value1, *value2;
1532 char delimiters[] = " \t";
1533 int keyword_id, ret, argi;
1534 char *unknown_msg = "Ignoring unknown line '%s'\n";
Stefan Roese4acd2d22014-10-22 12:13:23 +02001535
Mario Six4991b4f2017-01-11 16:00:59 +01001536 keyword = strtok_r(line, delimiters, &saveptr);
1537 keyword_id = recognize_keyword(keyword);
Mario Six94490a42017-01-11 16:00:54 +01001538
Mario Six4991b4f2017-01-11 16:00:59 +01001539 if (!keyword_id) {
1540 fprintf(stderr, unknown_msg, line);
1541 return 0;
1542 }
1543
1544 el->type = keyword_id;
1545
1546 value1 = strtok_r(NULL, delimiters, &saveptr);
1547
1548 if (!value1) {
1549 fprintf(stderr, "Parameter missing in line '%s'\n", line);
1550 return -1;
1551 }
1552
1553 switch (keyword_id) {
1554 case IMAGE_CFG_VERSION:
1555 el->version = atoi(value1);
1556 break;
Pali Roháraf496052022-01-12 18:20:40 +01001557 case IMAGE_CFG_CPU:
1558 if (strcmp(value1, "FEROCEON") == 0)
1559 el->cpu_sheeva = 0;
1560 else if (strcmp(value1, "SHEEVA") == 0)
1561 el->cpu_sheeva = 1;
1562 else if (strcmp(value1, "A9") == 0)
1563 el->cpu_sheeva = 0;
1564 else {
1565 fprintf(stderr, "Invalid CPU %s\n", value1);
1566 return -1;
1567 }
1568 break;
Mario Six4991b4f2017-01-11 16:00:59 +01001569 case IMAGE_CFG_BOOT_FROM:
1570 ret = image_boot_mode_id(value1);
Mario Six94490a42017-01-11 16:00:54 +01001571
Andreas Bießmannf411b8f2014-10-24 23:25:52 +02001572 if (ret < 0) {
Mario Six4991b4f2017-01-11 16:00:59 +01001573 fprintf(stderr, "Invalid boot media '%s'\n", value1);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001574 return -1;
1575 }
Andreas Bießmannf411b8f2014-10-24 23:25:52 +02001576 el->bootfrom = ret;
Mario Six4991b4f2017-01-11 16:00:59 +01001577 break;
1578 case IMAGE_CFG_NAND_BLKSZ:
1579 el->nandblksz = strtoul(value1, NULL, 16);
1580 break;
1581 case IMAGE_CFG_NAND_BADBLK_LOCATION:
1582 el->nandbadblklocation = strtoul(value1, NULL, 16);
1583 break;
1584 case IMAGE_CFG_NAND_ECC_MODE:
1585 ret = image_nand_ecc_mode_id(value1);
Mario Six94490a42017-01-11 16:00:54 +01001586
Andreas Bießmannf411b8f2014-10-24 23:25:52 +02001587 if (ret < 0) {
Mario Six4991b4f2017-01-11 16:00:59 +01001588 fprintf(stderr, "Invalid NAND ECC mode '%s'\n", value1);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001589 return -1;
1590 }
Andreas Bießmannf411b8f2014-10-24 23:25:52 +02001591 el->nandeccmode = ret;
Mario Six4991b4f2017-01-11 16:00:59 +01001592 break;
1593 case IMAGE_CFG_NAND_PAGESZ:
1594 el->nandpagesz = strtoul(value1, NULL, 16);
1595 break;
1596 case IMAGE_CFG_BINARY:
1597 argi = 0;
Mario Six94490a42017-01-11 16:00:54 +01001598
Mario Six4991b4f2017-01-11 16:00:59 +01001599 el->binary.file = strdup(value1);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001600 while (1) {
Mario Six4991b4f2017-01-11 16:00:59 +01001601 char *value = strtok_r(NULL, delimiters, &saveptr);
Pali Rohár0aca27e2022-01-12 18:20:41 +01001602 char *endptr;
Mario Six4991b4f2017-01-11 16:00:59 +01001603
Stefan Roese4acd2d22014-10-22 12:13:23 +02001604 if (!value)
1605 break;
Pali Rohár0aca27e2022-01-12 18:20:41 +01001606
1607 if (!strcmp(value, "LOAD_ADDRESS")) {
1608 value = strtok_r(NULL, delimiters, &saveptr);
1609 if (!value) {
1610 fprintf(stderr,
1611 "Missing address argument for BINARY LOAD_ADDRESS\n");
1612 return -1;
1613 }
1614 el->binary.loadaddr = strtoul(value, &endptr, 16);
1615 if (*endptr) {
1616 fprintf(stderr,
1617 "Invalid argument '%s' for BINARY LOAD_ADDRESS\n",
1618 value);
1619 return -1;
1620 }
1621 value = strtok_r(NULL, delimiters, &saveptr);
1622 if (value) {
1623 fprintf(stderr,
1624 "Unexpected argument '%s' after BINARY LOAD_ADDRESS\n",
1625 value);
1626 return -1;
1627 }
1628 break;
1629 }
1630
1631 el->binary.args[argi] = strtoul(value, &endptr, 16);
1632 if (*endptr) {
1633 fprintf(stderr, "Invalid argument '%s' for BINARY\n", value);
1634 return -1;
1635 }
Stefan Roese4acd2d22014-10-22 12:13:23 +02001636 argi++;
1637 if (argi >= BINARY_MAX_ARGS) {
1638 fprintf(stderr,
Mario Six4991b4f2017-01-11 16:00:59 +01001639 "Too many arguments for BINARY\n");
Stefan Roese4acd2d22014-10-22 12:13:23 +02001640 return -1;
1641 }
1642 }
1643 el->binary.nargs = argi;
Mario Six4991b4f2017-01-11 16:00:59 +01001644 break;
1645 case IMAGE_CFG_DATA:
1646 value2 = strtok_r(NULL, delimiters, &saveptr);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001647
1648 if (!value1 || !value2) {
1649 fprintf(stderr,
1650 "Invalid number of arguments for DATA\n");
1651 return -1;
1652 }
1653
Stefan Roese4acd2d22014-10-22 12:13:23 +02001654 el->regdata.raddr = strtoul(value1, NULL, 16);
1655 el->regdata.rdata = strtoul(value2, NULL, 16);
Mario Six4991b4f2017-01-11 16:00:59 +01001656 break;
Pali Rohárf63c5832021-07-23 11:14:12 +02001657 case IMAGE_CFG_DATA_DELAY:
1658 if (!strcmp(value1, "SDRAM_SETUP"))
1659 el->regdata_delay = REGISTER_SET_HDR_OPT_DELAY_SDRAM_SETUP;
1660 else
1661 el->regdata_delay = REGISTER_SET_HDR_OPT_DELAY_MS(strtoul(value1, NULL, 10));
Pali Rohárfdcae262022-01-12 18:20:48 +01001662 if (el->regdata_delay > 255) {
1663 fprintf(stderr, "Maximal DATA_DELAY is 255\n");
1664 return -1;
1665 }
Pali Rohárf63c5832021-07-23 11:14:12 +02001666 break;
Mario Six4991b4f2017-01-11 16:00:59 +01001667 case IMAGE_CFG_BAUDRATE:
1668 el->baudrate = strtoul(value1, NULL, 10);
1669 break;
Pali Rohár12f2c032021-11-08 18:12:41 +01001670 case IMAGE_CFG_UART_PORT:
1671 el->uart_port = strtoul(value1, NULL, 16);
1672 break;
1673 case IMAGE_CFG_UART_MPP:
1674 el->uart_mpp = strtoul(value1, NULL, 16);
1675 break;
Mario Six4991b4f2017-01-11 16:00:59 +01001676 case IMAGE_CFG_DEBUG:
1677 el->debug = strtoul(value1, NULL, 10);
1678 break;
Mario Sixa1b6b0a2017-01-11 16:01:00 +01001679 case IMAGE_CFG_KAK:
1680 el->key_name = strdup(value1);
1681 break;
1682 case IMAGE_CFG_CSK:
1683 el->key_name = strdup(value1);
1684 break;
1685 case IMAGE_CFG_CSK_INDEX:
1686 el->csk_idx = strtol(value1, NULL, 0);
1687 break;
1688 case IMAGE_CFG_JTAG_DELAY:
1689 el->jtag_delay = strtoul(value1, NULL, 0);
1690 break;
1691 case IMAGE_CFG_BOX_ID:
1692 el->boxid = strtoul(value1, NULL, 0);
1693 break;
1694 case IMAGE_CFG_FLASH_ID:
1695 el->flashid = strtoul(value1, NULL, 0);
1696 break;
1697 case IMAGE_CFG_SEC_SPECIALIZED_IMG:
1698 el->sec_specialized_img = true;
1699 break;
1700 case IMAGE_CFG_SEC_COMMON_IMG:
1701 el->sec_specialized_img = false;
1702 break;
1703 case IMAGE_CFG_SEC_BOOT_DEV:
1704 el->sec_boot_dev = strtoul(value1, NULL, 0);
1705 break;
1706 case IMAGE_CFG_SEC_FUSE_DUMP:
1707 el->name = strdup(value1);
1708 break;
Mario Six4991b4f2017-01-11 16:00:59 +01001709 default:
1710 fprintf(stderr, unknown_msg, line);
Stefan Roese4acd2d22014-10-22 12:13:23 +02001711 }
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301712
1713 return 0;
1714}
1715
Stefan Roese4acd2d22014-10-22 12:13:23 +02001716/*
1717 * Parse the configuration file 'fcfg' into the array of configuration
1718 * elements 'image_cfg', and return the number of configuration
1719 * elements in 'cfgn'.
1720 */
1721static int image_create_config_parse(FILE *fcfg)
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301722{
Stefan Roese4acd2d22014-10-22 12:13:23 +02001723 int ret;
1724 int cfgi = 0;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301725
Stefan Roese4acd2d22014-10-22 12:13:23 +02001726 /* Parse the configuration file */
1727 while (!feof(fcfg)) {
1728 char *line;
1729 char buf[256];
1730
1731 /* Read the current line */
1732 memset(buf, 0, sizeof(buf));
1733 line = fgets(buf, sizeof(buf), fcfg);
1734 if (!line)
1735 break;
1736
1737 /* Ignore useless lines */
1738 if (line[0] == '\n' || line[0] == '#')
1739 continue;
1740
1741 /* Strip final newline */
1742 if (line[strlen(line) - 1] == '\n')
1743 line[strlen(line) - 1] = 0;
1744
1745 /* Parse the current line */
1746 ret = image_create_config_parse_oneline(line,
1747 &image_cfg[cfgi]);
1748 if (ret)
1749 return ret;
1750
1751 cfgi++;
1752
1753 if (cfgi >= IMAGE_CFG_ELEMENT_MAX) {
1754 fprintf(stderr,
1755 "Too many configuration elements in .cfg file\n");
1756 return -1;
1757 }
1758 }
1759
1760 cfgn = cfgi;
1761 return 0;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301762}
1763
Stefan Roese4acd2d22014-10-22 12:13:23 +02001764static int image_get_version(void)
1765{
1766 struct image_cfg_element *e;
1767
1768 e = image_find_option(IMAGE_CFG_VERSION);
1769 if (!e)
1770 return -1;
1771
1772 return e->version;
1773}
1774
Stefan Roese4acd2d22014-10-22 12:13:23 +02001775static void kwbimage_set_header(void *ptr, struct stat *sbuf, int ifd,
1776 struct image_tool_params *params)
1777{
1778 FILE *fcfg;
1779 void *image = NULL;
1780 int version;
Łukasz Majewski93e93712014-11-21 09:22:43 +01001781 size_t headersz = 0;
Pali Roháre23ad5d2021-11-08 18:12:47 +01001782 size_t datasz;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001783 uint32_t checksum;
Pali Roháre23ad5d2021-11-08 18:12:47 +01001784 struct stat s;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001785 int ret;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001786
Pali Roháre23ad5d2021-11-08 18:12:47 +01001787 /*
1788 * Do not use sbuf->st_size as it contains size with padding.
1789 * We need original image data size, so stat original file.
1790 */
1791 if (stat(params->datafile, &s)) {
1792 fprintf(stderr, "Could not stat data file %s: %s\n",
1793 params->datafile, strerror(errno));
1794 exit(EXIT_FAILURE);
1795 }
1796 datasz = ALIGN(s.st_size, 4);
1797
Stefan Roese4acd2d22014-10-22 12:13:23 +02001798 fcfg = fopen(params->imagename, "r");
1799 if (!fcfg) {
1800 fprintf(stderr, "Could not open input file %s\n",
1801 params->imagename);
1802 exit(EXIT_FAILURE);
1803 }
1804
1805 image_cfg = malloc(IMAGE_CFG_ELEMENT_MAX *
1806 sizeof(struct image_cfg_element));
1807 if (!image_cfg) {
1808 fprintf(stderr, "Cannot allocate memory\n");
1809 fclose(fcfg);
1810 exit(EXIT_FAILURE);
1811 }
1812
1813 memset(image_cfg, 0,
1814 IMAGE_CFG_ELEMENT_MAX * sizeof(struct image_cfg_element));
1815 rewind(fcfg);
1816
1817 ret = image_create_config_parse(fcfg);
1818 fclose(fcfg);
1819 if (ret) {
1820 free(image_cfg);
1821 exit(EXIT_FAILURE);
1822 }
1823
1824 version = image_get_version();
Stefan Roese934a5292014-10-28 11:32:24 +01001825 switch (version) {
1826 /*
1827 * Fallback to version 0 if no version is provided in the
1828 * cfg file
1829 */
1830 case -1:
1831 case 0:
Pali Roháre23ad5d2021-11-08 18:12:47 +01001832 image = image_create_v0(&headersz, params, datasz + 4);
Stefan Roese934a5292014-10-28 11:32:24 +01001833 break;
1834
1835 case 1:
Pali Roháre23ad5d2021-11-08 18:12:47 +01001836 image = image_create_v1(&headersz, params, ptr, datasz + 4);
Stefan Roese934a5292014-10-28 11:32:24 +01001837 break;
1838
1839 default:
1840 fprintf(stderr, "Unsupported version %d\n", version);
1841 free(image_cfg);
1842 exit(EXIT_FAILURE);
1843 }
Stefan Roese4acd2d22014-10-22 12:13:23 +02001844
1845 if (!image) {
1846 fprintf(stderr, "Could not create image\n");
1847 free(image_cfg);
1848 exit(EXIT_FAILURE);
1849 }
1850
1851 free(image_cfg);
1852
Pali Roháre23ad5d2021-11-08 18:12:47 +01001853 /* Build and add image data checksum */
Pali Rohár37cb9c12021-07-23 11:13:56 +02001854 checksum = cpu_to_le32(image_checksum32((uint8_t *)ptr + headersz,
Pali Roháre23ad5d2021-11-08 18:12:47 +01001855 datasz));
1856 memcpy((uint8_t *)ptr + headersz + datasz, &checksum, sizeof(uint32_t));
Stefan Roese4acd2d22014-10-22 12:13:23 +02001857
1858 /* Finally copy the header into the image area */
1859 memcpy(ptr, image, headersz);
1860
1861 free(image);
1862}
1863
1864static void kwbimage_print_header(const void *ptr)
1865{
1866 struct main_hdr_v0 *mhdr = (struct main_hdr_v0 *)ptr;
Marek Behún732c9302021-08-18 00:59:15 +02001867 struct opt_hdr_v1 *ohdr;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001868
1869 printf("Image Type: MVEBU Boot from %s Image\n",
1870 image_boot_mode_name(mhdr->blockid));
Marek Behúnacb0b382021-09-24 23:07:00 +02001871 printf("Image version:%d\n", kwbimage_version(ptr));
Pali Rohár34dcf952021-07-23 11:14:04 +02001872
Marek Behún732c9302021-08-18 00:59:15 +02001873 for_each_opt_hdr_v1 (ohdr, mhdr) {
1874 if (ohdr->headertype == OPT_HDR_V1_BINARY_TYPE) {
Pali Rohárc934c9a2022-01-12 18:20:49 +01001875 printf("BIN Img Size: ");
Marek Behún732c9302021-08-18 00:59:15 +02001876 genimg_print_size(opt_hdr_v1_size(ohdr) - 12 -
1877 4 * ohdr->data[0]);
Pali Rohárc934c9a2022-01-12 18:20:49 +01001878 printf("BIN Img Offs: %08x\n",
1879 (unsigned)((uint8_t *)ohdr - (uint8_t *)mhdr) +
1880 8 + 4 * ohdr->data[0]);
Pali Rohár34dcf952021-07-23 11:14:04 +02001881 }
1882 }
Marek Behún732c9302021-08-18 00:59:15 +02001883
Gerald Kerma26f195c2014-10-31 01:03:27 +01001884 printf("Data Size: ");
Stefan Roese4acd2d22014-10-22 12:13:23 +02001885 genimg_print_size(mhdr->blocksize - sizeof(uint32_t));
1886 printf("Load Address: %08x\n", mhdr->destaddr);
1887 printf("Entry Point: %08x\n", mhdr->execaddr);
1888}
1889
1890static int kwbimage_check_image_types(uint8_t type)
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301891{
1892 if (type == IH_TYPE_KWBIMAGE)
1893 return EXIT_SUCCESS;
Mario Six94490a42017-01-11 16:00:54 +01001894
1895 return EXIT_FAILURE;
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05301896}
1897
Stefan Roese4acd2d22014-10-22 12:13:23 +02001898static int kwbimage_verify_header(unsigned char *ptr, int image_size,
1899 struct image_tool_params *params)
1900{
Marek Behúnfe2fd732021-09-24 23:07:01 +02001901 size_t header_size = kwbheader_size(ptr);
Pali Rohár700ea982021-11-08 18:12:44 +01001902 uint8_t blockid;
1903 uint32_t offset;
1904 uint32_t size;
Marek Behúnfe2fd732021-09-24 23:07:01 +02001905 uint8_t csum;
Alexander Graf6cd56782018-03-15 11:14:19 +01001906
1907 if (header_size > image_size)
1908 return -FDT_ERR_BADSTRUCTURE;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001909
Baruch Siachdb7cd4ed2017-07-04 20:23:40 +03001910 if (!main_hdr_checksum_ok(ptr))
Stefan Roese4acd2d22014-10-22 12:13:23 +02001911 return -FDT_ERR_BADSTRUCTURE;
1912
1913 /* Only version 0 extended header has checksum */
Marek Behúnacb0b382021-09-24 23:07:00 +02001914 if (kwbimage_version(ptr) == 0) {
Pali Rohárfe2c0e22021-07-23 11:14:01 +02001915 struct main_hdr_v0 *mhdr = (struct main_hdr_v0 *)ptr;
Mario Sixe89016c2017-01-11 16:00:56 +01001916
Pali Rohárfe2c0e22021-07-23 11:14:01 +02001917 if (mhdr->ext & 0x1) {
Marek Behúnfe2fd732021-09-24 23:07:01 +02001918 struct ext_hdr_v0 *ext_hdr = (void *)(mhdr + 1);
Pali Rohárfe2c0e22021-07-23 11:14:01 +02001919
Marek Behúnfe2fd732021-09-24 23:07:01 +02001920 csum = image_checksum8(ext_hdr, sizeof(*ext_hdr) - 1);
1921 if (csum != ext_hdr->checksum)
Pali Rohárfe2c0e22021-07-23 11:14:01 +02001922 return -FDT_ERR_BADSTRUCTURE;
1923 }
Pali Rohár700ea982021-11-08 18:12:44 +01001924
1925 blockid = mhdr->blockid;
1926 offset = le32_to_cpu(mhdr->srcaddr);
1927 size = le32_to_cpu(mhdr->blocksize);
Marek Behúnacb0b382021-09-24 23:07:00 +02001928 } else if (kwbimage_version(ptr) == 1) {
Pali Rohár93804452021-07-23 11:14:02 +02001929 struct main_hdr_v1 *mhdr = (struct main_hdr_v1 *)ptr;
Marek Behún732c9302021-08-18 00:59:15 +02001930 const uint8_t *mhdr_end;
1931 struct opt_hdr_v1 *ohdr;
Pali Rohár93804452021-07-23 11:14:02 +02001932
Marek Behún732c9302021-08-18 00:59:15 +02001933 mhdr_end = (uint8_t *)mhdr + header_size;
1934 for_each_opt_hdr_v1 (ohdr, ptr)
1935 if (!opt_hdr_v1_valid_size(ohdr, mhdr_end))
1936 return -FDT_ERR_BADSTRUCTURE;
Pali Roháre0c243c2021-07-23 11:14:03 +02001937
Pali Rohár700ea982021-11-08 18:12:44 +01001938 blockid = mhdr->blockid;
Pali Roháre0c243c2021-07-23 11:14:03 +02001939 offset = le32_to_cpu(mhdr->srcaddr);
Pali Roháre0c243c2021-07-23 11:14:03 +02001940 size = le32_to_cpu(mhdr->blocksize);
Pali Rohárb9840562021-08-11 10:14:14 +02001941 } else {
1942 return -FDT_ERR_BADSTRUCTURE;
Pali Rohár93804452021-07-23 11:14:02 +02001943 }
1944
Pali Rohár700ea982021-11-08 18:12:44 +01001945 /*
1946 * For SATA srcaddr is specified in number of sectors.
1947 * The main header is must be stored at sector number 1.
1948 * This expects that sector size is 512 bytes and recalculates
1949 * data offset to bytes relative to the main header.
1950 */
1951 if (blockid == IBR_HDR_SATA_ID) {
1952 if (offset < 1)
1953 return -FDT_ERR_BADSTRUCTURE;
1954 offset -= 1;
1955 offset *= 512;
1956 }
1957
1958 /*
1959 * For SDIO srcaddr is specified in number of sectors.
1960 * This expects that sector size is 512 bytes and recalculates
1961 * data offset to bytes.
1962 */
1963 if (blockid == IBR_HDR_SDIO_ID)
1964 offset *= 512;
1965
1966 /*
1967 * For PCIe srcaddr is always set to 0xFFFFFFFF.
1968 * This expects that data starts after all headers.
1969 */
1970 if (blockid == IBR_HDR_PEX_ID && offset == 0xFFFFFFFF)
1971 offset = header_size;
1972
1973 if (offset > image_size || offset % 4 != 0)
1974 return -FDT_ERR_BADSTRUCTURE;
1975
1976 if (size < 4 || offset + size > image_size || size % 4 != 0)
1977 return -FDT_ERR_BADSTRUCTURE;
1978
1979 if (image_checksum32(ptr + offset, size - 4) !=
1980 *(uint32_t *)(ptr + offset + size - 4))
1981 return -FDT_ERR_BADSTRUCTURE;
1982
Stefan Roese4acd2d22014-10-22 12:13:23 +02001983 return 0;
1984}
1985
1986static int kwbimage_generate(struct image_tool_params *params,
1987 struct image_type_params *tparams)
1988{
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02001989 FILE *fcfg;
Pali Rohár37cb9c12021-07-23 11:13:56 +02001990 struct stat s;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001991 int alloc_len;
Pali Rohárc934aad2021-07-23 11:13:57 +02001992 int bootfrom;
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02001993 int version;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001994 void *hdr;
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02001995 int ret;
Stefan Roese4acd2d22014-10-22 12:13:23 +02001996
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02001997 fcfg = fopen(params->imagename, "r");
1998 if (!fcfg) {
1999 fprintf(stderr, "Could not open input file %s\n",
2000 params->imagename);
2001 exit(EXIT_FAILURE);
2002 }
2003
Pali Rohár37cb9c12021-07-23 11:13:56 +02002004 if (stat(params->datafile, &s)) {
2005 fprintf(stderr, "Could not stat data file %s: %s\n",
2006 params->datafile, strerror(errno));
2007 exit(EXIT_FAILURE);
2008 }
2009
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02002010 image_cfg = malloc(IMAGE_CFG_ELEMENT_MAX *
2011 sizeof(struct image_cfg_element));
2012 if (!image_cfg) {
2013 fprintf(stderr, "Cannot allocate memory\n");
2014 fclose(fcfg);
2015 exit(EXIT_FAILURE);
2016 }
2017
2018 memset(image_cfg, 0,
2019 IMAGE_CFG_ELEMENT_MAX * sizeof(struct image_cfg_element));
2020 rewind(fcfg);
2021
2022 ret = image_create_config_parse(fcfg);
2023 fclose(fcfg);
2024 if (ret) {
2025 free(image_cfg);
2026 exit(EXIT_FAILURE);
2027 }
2028
Pali Rohárc934aad2021-07-23 11:13:57 +02002029 bootfrom = image_get_bootfrom();
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02002030 version = image_get_version();
2031 switch (version) {
2032 /*
2033 * Fallback to version 0 if no version is provided in the
2034 * cfg file
2035 */
2036 case -1:
2037 case 0:
Pali Rohár851114b2021-11-08 18:12:50 +01002038 alloc_len = image_headersz_v0(NULL);
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02002039 break;
2040
2041 case 1:
Mario Sixe93cf532017-01-11 16:00:57 +01002042 alloc_len = image_headersz_v1(NULL);
Pali Rohár252e7c32022-01-12 18:20:42 +01002043 if (!alloc_len) {
2044 free(image_cfg);
2045 exit(EXIT_FAILURE);
2046 }
Pali Rohár78d997f2022-01-12 18:20:43 +01002047 if (alloc_len > 192*1024) {
2048 fprintf(stderr, "Header is too big (%u bytes), maximal kwbimage header size is %u bytes\n", alloc_len, 192*1024);
2049 free(image_cfg);
2050 exit(EXIT_FAILURE);
2051 }
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02002052 break;
2053
2054 default:
2055 fprintf(stderr, "Unsupported version %d\n", version);
2056 free(image_cfg);
2057 exit(EXIT_FAILURE);
Stefan Roese4acd2d22014-10-22 12:13:23 +02002058 }
2059
Patrick Wildt6cbf7ed2017-05-10 22:18:54 +02002060 free(image_cfg);
2061
Stefan Roese4acd2d22014-10-22 12:13:23 +02002062 hdr = malloc(alloc_len);
2063 if (!hdr) {
2064 fprintf(stderr, "%s: malloc return failure: %s\n",
2065 params->cmdname, strerror(errno));
2066 exit(EXIT_FAILURE);
2067 }
2068
2069 memset(hdr, 0, alloc_len);
2070 tparams->header_size = alloc_len;
2071 tparams->hdr = hdr;
2072
Stefan Roese77720852015-11-24 09:14:59 +01002073 /*
2074 * The resulting image needs to be 4-byte aligned. At least
2075 * the Marvell hdrparser tool complains if its unaligned.
Pali Rohár37cb9c12021-07-23 11:13:56 +02002076 * After the image data is stored 4-byte checksum.
Pali Rohár188099e2021-11-08 18:12:46 +01002077 * Final UART image must be aligned to 128 bytes.
Pali Rohárc934aad2021-07-23 11:13:57 +02002078 * Final SPI and NAND images must be aligned to 256 bytes.
Pali Rohár501a54a2021-07-23 11:13:59 +02002079 * Final SATA and SDIO images must be aligned to 512 bytes.
Stefan Roese77720852015-11-24 09:14:59 +01002080 */
Pali Rohárc934aad2021-07-23 11:13:57 +02002081 if (bootfrom == IBR_HDR_SPI_ID || bootfrom == IBR_HDR_NAND_ID)
2082 return 4 + (256 - (alloc_len + s.st_size + 4) % 256) % 256;
Pali Rohár501a54a2021-07-23 11:13:59 +02002083 else if (bootfrom == IBR_HDR_SATA_ID || bootfrom == IBR_HDR_SDIO_ID)
2084 return 4 + (512 - (alloc_len + s.st_size + 4) % 512) % 512;
Pali Rohár188099e2021-11-08 18:12:46 +01002085 else if (bootfrom == IBR_HDR_UART_ID)
2086 return 4 + (128 - (alloc_len + s.st_size + 4) % 128) % 128;
Pali Rohárc934aad2021-07-23 11:13:57 +02002087 else
2088 return 4 + (4 - s.st_size % 4) % 4;
Stefan Roese4acd2d22014-10-22 12:13:23 +02002089}
2090
Pali Roháraa6943c2021-07-23 11:14:34 +02002091static int kwbimage_extract_subimage(void *ptr, struct image_tool_params *params)
2092{
2093 struct main_hdr_v1 *mhdr = (struct main_hdr_v1 *)ptr;
Marek Behúnfe2fd732021-09-24 23:07:01 +02002094 size_t header_size = kwbheader_size(ptr);
Marek Behún732c9302021-08-18 00:59:15 +02002095 struct opt_hdr_v1 *ohdr;
Pali Roháraa6943c2021-07-23 11:14:34 +02002096 int idx = params->pflag;
2097 int cur_idx = 0;
2098 uint32_t offset;
2099 ulong image;
2100 ulong size;
2101
Marek Behún732c9302021-08-18 00:59:15 +02002102 for_each_opt_hdr_v1 (ohdr, ptr) {
2103 if (ohdr->headertype != OPT_HDR_V1_BINARY_TYPE)
2104 continue;
Pali Roháraa6943c2021-07-23 11:14:34 +02002105
Marek Behún732c9302021-08-18 00:59:15 +02002106 if (idx == cur_idx) {
2107 image = (ulong)&ohdr->data[4 + 4 * ohdr->data[0]];
2108 size = opt_hdr_v1_size(ohdr) - 12 - 4 * ohdr->data[0];
2109 goto extract;
Pali Roháraa6943c2021-07-23 11:14:34 +02002110 }
Marek Behún732c9302021-08-18 00:59:15 +02002111
2112 ++cur_idx;
Pali Roháraa6943c2021-07-23 11:14:34 +02002113 }
2114
2115 if (idx != cur_idx) {
2116 printf("Image %d is not present\n", idx);
2117 return -1;
2118 }
2119
2120 offset = le32_to_cpu(mhdr->srcaddr);
2121
2122 if (mhdr->blockid == IBR_HDR_SATA_ID) {
2123 offset -= 1;
2124 offset *= 512;
2125 }
2126
2127 if (mhdr->blockid == IBR_HDR_SDIO_ID)
2128 offset *= 512;
2129
2130 if (mhdr->blockid == IBR_HDR_PEX_ID && offset == 0xFFFFFFFF)
2131 offset = header_size;
2132
2133 image = (ulong)((uint8_t *)ptr + offset);
2134 size = le32_to_cpu(mhdr->blocksize) - 4;
2135
2136extract:
2137 return imagetool_save_subimage(params->outfile, image, size);
2138}
2139
Stefan Roese4acd2d22014-10-22 12:13:23 +02002140/*
2141 * Report Error if xflag is set in addition to default
2142 */
2143static int kwbimage_check_params(struct image_tool_params *params)
2144{
Pali Roháraa6943c2021-07-23 11:14:34 +02002145 if (!params->iflag && (!params->imagename || !strlen(params->imagename))) {
Mario Six94490a42017-01-11 16:00:54 +01002146 char *msg = "Configuration file for kwbimage creation omitted";
2147
2148 fprintf(stderr, "Error:%s - %s\n", params->cmdname, msg);
Pali Rohár56087c12021-11-08 18:12:45 +01002149 return 1;
Stefan Roese4acd2d22014-10-22 12:13:23 +02002150 }
2151
2152 return (params->dflag && (params->fflag || params->lflag)) ||
2153 (params->fflag && (params->dflag || params->lflag)) ||
2154 (params->lflag && (params->dflag || params->fflag)) ||
Pali Roháraa6943c2021-07-23 11:14:34 +02002155 (params->xflag);
Stefan Roese4acd2d22014-10-22 12:13:23 +02002156}
2157
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +05302158/*
2159 * kwbimage type parameters definition
2160 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -02002161U_BOOT_IMAGE_TYPE(
2162 kwbimage,
2163 "Marvell MVEBU Boot Image support",
2164 0,
2165 NULL,
2166 kwbimage_check_params,
2167 kwbimage_verify_header,
2168 kwbimage_print_header,
2169 kwbimage_set_header,
Pali Roháraa6943c2021-07-23 11:14:34 +02002170 kwbimage_extract_subimage,
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -02002171 kwbimage_check_image_types,
2172 NULL,
2173 kwbimage_generate
2174);