imximage.c 21.5 KB
Newer Older
1 2 3 4 5 6 7 8
/*
 * (C) Copyright 2009
 * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
 *
 * (C) Copyright 2008
 * Marvell Semiconductor <www.marvell.com>
 * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
 *
9
 * SPDX-License-Identifier:	GPL-2.0+
10 11
 */

12
#include "imagetool.h"
13 14 15
#include <image.h>
#include "imximage.h"

16 17
#define UNDEFINED 0xFFFFFFFF

18 19 20 21
/*
 * Supported commands for configuration file
 */
static table_entry_t imximage_cmds[] = {
22
	{CMD_BOOT_FROM,         "BOOT_FROM",            "boot command",	  },
23
	{CMD_BOOT_OFFSET,       "BOOT_OFFSET",          "Boot offset",	  },
24 25 26 27
	{CMD_WRITE_DATA,        "DATA",                 "Reg Write Data", },
	{CMD_WRITE_CLR_BIT,     "CLR_BIT",              "Reg clear bit",  },
	{CMD_CHECK_BITS_SET,    "CHECK_BITS_SET",   "Reg Check bits set", },
	{CMD_CHECK_BITS_CLR,    "CHECK_BITS_CLR",   "Reg Check bits clr", },
28
	{CMD_CSF,               "CSF",           "Command Sequence File", },
29 30
	{CMD_IMAGE_VERSION,     "IMAGE_VERSION",        "image version",  },
	{-1,                    "",                     "",	          },
31 32 33 34 35 36
};

/*
 * Supported Boot options for configuration file
 * this is needed to set the correct flash offset
 */
37
static table_entry_t imximage_boot_offset[] = {
38
	{FLASH_OFFSET_ONENAND,	"onenand",	"OneNAND Flash",},
39
	{FLASH_OFFSET_NAND,	"nand",		"NAND Flash",	},
40 41
	{FLASH_OFFSET_NOR,	"nor",		"NOR Flash",	},
	{FLASH_OFFSET_SATA,	"sata",		"SATA Disk",	},
42 43
	{FLASH_OFFSET_SD,	"sd",		"SD Card",	},
	{FLASH_OFFSET_SPI,	"spi",		"SPI Flash",	},
44
	{FLASH_OFFSET_QSPI,	"qspi",		"QSPI NOR Flash",},
45 46 47
	{-1,			"",		"Invalid",	},
};

48 49 50 51 52 53 54 55 56 57 58
/*
 * Supported Boot options for configuration file
 * this is needed to determine the initial load size
 */
static table_entry_t imximage_boot_loadsize[] = {
	{FLASH_LOADSIZE_ONENAND,	"onenand",	"OneNAND Flash",},
	{FLASH_LOADSIZE_NAND,		"nand",		"NAND Flash",	},
	{FLASH_LOADSIZE_NOR,		"nor",		"NOR Flash",	},
	{FLASH_LOADSIZE_SATA,		"sata",		"SATA Disk",	},
	{FLASH_LOADSIZE_SD,		"sd",		"SD Card",	},
	{FLASH_LOADSIZE_SPI,		"spi",		"SPI Flash",	},
59
	{FLASH_LOADSIZE_QSPI,		"qspi",		"QSPI NOR Flash",},
60 61 62
	{-1,				"",		"Invalid",	},
};

63 64 65 66 67
/*
 * IMXIMAGE version definition for i.MX chips
 */
static table_entry_t imximage_versions[] = {
	{IMXIMAGE_V1,	"",	" (i.MX25/35/51 compatible)", },
68
	{IMXIMAGE_V2,	"",	" (i.MX53/6/7 compatible)",   },
69 70
	{-1,            "",     " (Invalid)",                 },
};
71 72

static struct imx_header imximage_header;
73
static uint32_t imximage_version;
74 75 76 77 78 79 80
/*
 * Image Vector Table Offset
 * Initialized to a wrong not 4-bytes aligned address to
 * check if it is was set by the cfg file.
 */
static uint32_t imximage_ivt_offset = UNDEFINED;
static uint32_t imximage_csf_size = UNDEFINED;
81 82
/* Initial Load Region Size */
static uint32_t imximage_init_loadsize;
83 84

static set_dcd_val_t set_dcd_val;
85
static set_dcd_param_t set_dcd_param;
86 87
static set_dcd_rst_t set_dcd_rst;
static set_imx_hdr_t set_imx_hdr;
88
static uint32_t max_dcd_entries;
89
static uint32_t *header_size_ptr;
90
static uint32_t *csf_ptr;
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

static uint32_t get_cfg_value(char *token, char *name,  int linenr)
{
	char *endptr;
	uint32_t value;

	errno = 0;
	value = strtoul(token, &endptr, 16);
	if (errno || (token == endptr)) {
		fprintf(stderr, "Error: %s[%d] - Invalid hex data(%s)\n",
			name,  linenr, token);
		exit(EXIT_FAILURE);
	}
	return value;
}

107
static uint32_t detect_imximage_version(struct imx_header *imx_hdr)
108
{
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
	imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
	imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
	flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
	flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;

	/* Try to detect V1 */
	if ((fhdr_v1->app_code_barker == APP_CODE_BARKER) &&
		(hdr_v1->dcd_table.preamble.barker == DCD_BARKER))
		return IMXIMAGE_V1;

	/* Try to detect V2 */
	if ((fhdr_v2->header.tag == IVT_HEADER_TAG) &&
		(hdr_v2->dcd_table.header.tag == DCD_HEADER_TAG))
		return IMXIMAGE_V2;

	return IMXIMAGE_VER_INVALID;
125 126
}

127
static void err_imximage_version(int version)
128
{
129 130
	fprintf(stderr,
		"Error: Unsupported imximage version:%d\n", version);
131

132 133
	exit(EXIT_FAILURE);
}
134

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
static void set_dcd_val_v1(struct imx_header *imxhdr, char *name, int lineno,
					int fld, uint32_t value, uint32_t off)
{
	dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;

	switch (fld) {
	case CFG_REG_SIZE:
		/* Byte, halfword, word */
		if ((value != 1) && (value != 2) && (value != 4)) {
			fprintf(stderr, "Error: %s[%d] - "
				"Invalid register size " "(%d)\n",
				name, lineno, value);
			exit(EXIT_FAILURE);
		}
		dcd_v1->addr_data[off].type = value;
		break;
	case CFG_REG_ADDRESS:
		dcd_v1->addr_data[off].addr = value;
		break;
	case CFG_REG_VALUE:
		dcd_v1->addr_data[off].value = value;
		break;
	default:
		break;
159

160 161
	}
}
162

163 164
static struct dcd_v2_cmd *gd_last_cmd;

165 166 167 168
static void set_dcd_param_v2(struct imx_header *imxhdr, uint32_t dcd_len,
		int32_t cmd)
{
	dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
169 170 171 172 173 174 175 176 177 178
	struct dcd_v2_cmd *d = gd_last_cmd;
	struct dcd_v2_cmd *d2;
	int len;

	if (!d)
		d = &dcd_v2->dcd_cmd;
	d2 = d;
	len = be16_to_cpu(d->write_dcd_command.length);
	if (len > 4)
		d2 = (struct dcd_v2_cmd *)(((char *)d) + len);
179 180 181

	switch (cmd) {
	case CMD_WRITE_DATA:
182 183 184 185 186 187 188
		if ((d->write_dcd_command.tag == DCD_WRITE_DATA_COMMAND_TAG) &&
		    (d->write_dcd_command.param == DCD_WRITE_DATA_PARAM))
			break;
		d = d2;
		d->write_dcd_command.tag = DCD_WRITE_DATA_COMMAND_TAG;
		d->write_dcd_command.length = cpu_to_be16(4);
		d->write_dcd_command.param = DCD_WRITE_DATA_PARAM;
189 190
		break;
	case CMD_WRITE_CLR_BIT:
191 192 193 194 195 196 197
		if ((d->write_dcd_command.tag == DCD_WRITE_DATA_COMMAND_TAG) &&
		    (d->write_dcd_command.param == DCD_WRITE_CLR_BIT_PARAM))
			break;
		d = d2;
		d->write_dcd_command.tag = DCD_WRITE_DATA_COMMAND_TAG;
		d->write_dcd_command.length = cpu_to_be16(4);
		d->write_dcd_command.param = DCD_WRITE_CLR_BIT_PARAM;
198 199 200 201 202
		break;
	/*
	 * Check data command only supports one entry,
	 */
	case CMD_CHECK_BITS_SET:
203 204 205 206
		d = d2;
		d->write_dcd_command.tag = DCD_CHECK_DATA_COMMAND_TAG;
		d->write_dcd_command.length = cpu_to_be16(4);
		d->write_dcd_command.param = DCD_CHECK_BITS_SET_PARAM;
207 208
		break;
	case CMD_CHECK_BITS_CLR:
209 210 211 212
		d = d2;
		d->write_dcd_command.tag = DCD_CHECK_DATA_COMMAND_TAG;
		d->write_dcd_command.length = cpu_to_be16(4);
		d->write_dcd_command.param = DCD_CHECK_BITS_SET_PARAM;
213 214 215 216
		break;
	default:
		break;
	}
217
	gd_last_cmd = d;
218 219
}

220 221 222
static void set_dcd_val_v2(struct imx_header *imxhdr, char *name, int lineno,
					int fld, uint32_t value, uint32_t off)
{
223 224 225 226 227
	struct dcd_v2_cmd *d = gd_last_cmd;
	int len;

	len = be16_to_cpu(d->write_dcd_command.length);
	off = (len - 4) >> 3;
228 229 230

	switch (fld) {
	case CFG_REG_ADDRESS:
231
		d->addr_data[off].addr = cpu_to_be32(value);
232 233
		break;
	case CFG_REG_VALUE:
234 235 236
		d->addr_data[off].value = cpu_to_be32(value);
		off++;
		d->write_dcd_command.length = cpu_to_be16((off << 3) + 4);
237 238 239 240 241
		break;
	default:
		break;

	}
242 243
}

244 245 246 247 248 249
/*
 * Complete setting up the rest field of DCD of V1
 * such as barker code and DCD data length.
 */
static void set_dcd_rst_v1(struct imx_header *imxhdr, uint32_t dcd_len,
						char *name, int lineno)
250
{
251 252 253 254 255 256 257 258 259 260 261 262 263 264
	dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;

	dcd_v1->preamble.barker = DCD_BARKER;
	dcd_v1->preamble.length = dcd_len * sizeof(dcd_type_addr_data_t);
}

/*
 * Complete setting up the reset field of DCD of V2
 * such as DCD tag, version, length, etc.
 */
static void set_dcd_rst_v2(struct imx_header *imxhdr, uint32_t dcd_len,
						char *name, int lineno)
{
	dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
265 266 267 268 269 270 271 272 273 274
	struct dcd_v2_cmd *d = gd_last_cmd;
	int len;

	if (!d)
		d = &dcd_v2->dcd_cmd;
	len = be16_to_cpu(d->write_dcd_command.length);
	if (len > 4)
		d = (struct dcd_v2_cmd *)(((char *)d) + len);

	len = (char *)d - (char *)&dcd_v2->header;
275 276

	dcd_v2->header.tag = DCD_HEADER_TAG;
277
	dcd_v2->header.length = cpu_to_be16(len);
278 279 280 281
	dcd_v2->header.version = DCD_VERSION;
}

static void set_imx_hdr_v1(struct imx_header *imxhdr, uint32_t dcd_len,
282
		uint32_t entry_point, uint32_t flash_offset)
283 284 285 286
{
	imx_header_v1_t *hdr_v1 = &imxhdr->header.hdr_v1;
	flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
	dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
287
	uint32_t hdr_base;
288 289
	uint32_t header_length = (((char *)&dcd_v1->addr_data[dcd_len].addr)
			- ((char *)imxhdr));
290 291 292 293

	/* Set magic number */
	fhdr_v1->app_code_barker = APP_CODE_BARKER;

294 295
	/* TODO: check i.MX image V1 handling, for now use 'old' style */
	hdr_base = entry_point - 4096;
296
	fhdr_v1->app_dest_ptr = hdr_base - flash_offset;
297
	fhdr_v1->app_code_jump_vector = entry_point;
298

299 300
	fhdr_v1->dcd_ptr_ptr = hdr_base + offsetof(flash_header_v1_t, dcd_ptr);
	fhdr_v1->dcd_ptr = hdr_base + offsetof(imx_header_v1_t, dcd_table);
301 302 303 304

	/* Security feature are not supported */
	fhdr_v1->app_code_csf = 0;
	fhdr_v1->super_root_key = 0;
305
	header_size_ptr = (uint32_t *)(((char *)imxhdr) + header_length - 4);
306 307 308
}

static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len,
309
		uint32_t entry_point, uint32_t flash_offset)
310 311 312
{
	imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2;
	flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
313
	uint32_t hdr_base;
314 315 316 317 318 319

	/* Set magic number */
	fhdr_v2->header.tag = IVT_HEADER_TAG; /* 0xD1 */
	fhdr_v2->header.length = cpu_to_be16(sizeof(flash_header_v2_t));
	fhdr_v2->header.version = IVT_VERSION; /* 0x40 */

320
	fhdr_v2->entry = entry_point;
321
	fhdr_v2->reserved1 = fhdr_v2->reserved2 = 0;
322 323 324
	hdr_base = entry_point - imximage_init_loadsize +
		flash_offset;
	fhdr_v2->self = hdr_base;
325 326 327 328 329
	if (dcd_len > 0)
		fhdr_v2->dcd_ptr = hdr_base
			+ offsetof(imx_header_v2_t, dcd_table);
	else
		fhdr_v2->dcd_ptr = 0;
330 331
	fhdr_v2->boot_data_ptr = hdr_base
			+ offsetof(imx_header_v2_t, boot_data);
332
	hdr_v2->boot_data.start = entry_point - imximage_init_loadsize;
333 334

	fhdr_v2->csf = 0;
335

336
	header_size_ptr = &hdr_v2->boot_data.size;
337
	csf_ptr = &fhdr_v2->csf;
338 339
}

340
static void set_hdr_func(void)
341 342 343 344
{
	switch (imximage_version) {
	case IMXIMAGE_V1:
		set_dcd_val = set_dcd_val_v1;
345
		set_dcd_param = NULL;
346 347
		set_dcd_rst = set_dcd_rst_v1;
		set_imx_hdr = set_imx_hdr_v1;
348
		max_dcd_entries = MAX_HW_CFG_SIZE_V1;
349 350
		break;
	case IMXIMAGE_V2:
351
		gd_last_cmd = NULL;
352
		set_dcd_val = set_dcd_val_v2;
353
		set_dcd_param = set_dcd_param_v2;
354 355
		set_dcd_rst = set_dcd_rst_v2;
		set_imx_hdr = set_imx_hdr_v2;
356
		max_dcd_entries = MAX_HW_CFG_SIZE_V2;
357 358 359 360 361 362
		break;
	default:
		err_imximage_version(imximage_version);
		break;
	}
}
363

364 365 366 367 368 369 370 371 372
static void print_hdr_v1(struct imx_header *imx_hdr)
{
	imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
	flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
	dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
	uint32_t size, length, ver;

	size = dcd_v1->preamble.length;
	if (size > (MAX_HW_CFG_SIZE_V1 * sizeof(dcd_type_addr_data_t))) {
373 374
		fprintf(stderr,
			"Error: Image corrupt DCD size %d exceed maximum %d\n",
375
			(uint32_t)(size / sizeof(dcd_type_addr_data_t)),
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
			MAX_HW_CFG_SIZE_V1);
		exit(EXIT_FAILURE);
	}

	length = dcd_v1->preamble.length / sizeof(dcd_type_addr_data_t);
	ver = detect_imximage_version(imx_hdr);

	printf("Image Type:   Freescale IMX Boot Image\n");
	printf("Image Ver:    %x", ver);
	printf("%s\n", get_table_entry_name(imximage_versions, NULL, ver));
	printf("Data Size:    ");
	genimg_print_size(dcd_v1->addr_data[length].type);
	printf("Load Address: %08x\n", (uint32_t)fhdr_v1->app_dest_ptr);
	printf("Entry Point:  %08x\n", (uint32_t)fhdr_v1->app_code_jump_vector);
}

static void print_hdr_v2(struct imx_header *imx_hdr)
{
	imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
	flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
	dcd_v2_t *dcd_v2 = &hdr_v2->dcd_table;
	uint32_t size, version;

399 400
	size = be16_to_cpu(dcd_v2->header.length);
	if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t)) + 8) {
401 402 403 404
		fprintf(stderr,
			"Error: Image corrupt DCD size %d exceed maximum %d\n",
			(uint32_t)(size / sizeof(dcd_addr_data_t)),
			MAX_HW_CFG_SIZE_V2);
405 406 407
		exit(EXIT_FAILURE);
	}

408
	version = detect_imximage_version(imx_hdr);
409 410

	printf("Image Type:   Freescale IMX Boot Image\n");
411 412
	printf("Image Ver:    %x", version);
	printf("%s\n", get_table_entry_name(imximage_versions, NULL, version));
413
	printf("Data Size:    ");
414 415 416
	genimg_print_size(hdr_v2->boot_data.size);
	printf("Load Address: %08x\n", (uint32_t)fhdr_v2->boot_data_ptr);
	printf("Entry Point:  %08x\n", (uint32_t)fhdr_v2->entry);
417 418 419 420 421 422 423
	if (fhdr_v2->csf && (imximage_ivt_offset != UNDEFINED) &&
	    (imximage_csf_size != UNDEFINED)) {
		printf("HAB Blocks:   %08x %08x %08x\n",
		       (uint32_t)fhdr_v2->self, 0,
		       hdr_v2->boot_data.size - imximage_ivt_offset -
		       imximage_csf_size);
	}
424 425
}

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
static void parse_cfg_cmd(struct imx_header *imxhdr, int32_t cmd, char *token,
				char *name, int lineno, int fld, int dcd_len)
{
	int value;
	static int cmd_ver_first = ~0;

	switch (cmd) {
	case CMD_IMAGE_VERSION:
		imximage_version = get_cfg_value(token, name, lineno);
		if (cmd_ver_first == 0) {
			fprintf(stderr, "Error: %s[%d] - IMAGE_VERSION "
				"command need be the first before other "
				"valid command in the file\n", name, lineno);
			exit(EXIT_FAILURE);
		}
		cmd_ver_first = 1;
442
		set_hdr_func();
443 444
		break;
	case CMD_BOOT_FROM:
445
		imximage_ivt_offset = get_table_entry_id(imximage_boot_offset,
446
					"imximage boot option", token);
447
		if (imximage_ivt_offset == -1) {
448 449 450 451
			fprintf(stderr, "Error: %s[%d] -Invalid boot device"
				"(%s)\n", name, lineno, token);
			exit(EXIT_FAILURE);
		}
452 453 454 455 456 457 458 459 460 461 462

		imximage_init_loadsize =
			get_table_entry_id(imximage_boot_loadsize,
					   "imximage boot option", token);

		if (imximage_init_loadsize == -1) {
			fprintf(stderr,
				"Error: %s[%d] -Invalid boot device(%s)\n",
				name, lineno, token);
			exit(EXIT_FAILURE);
		}
463 464 465 466 467 468 469

		/*
		 * The SOC loads from the storage starting at address 0
		 * then ensures that the load size contains the offset
		 */
		if (imximage_init_loadsize < imximage_ivt_offset)
			imximage_init_loadsize = imximage_ivt_offset;
470 471 472
		if (unlikely(cmd_ver_first != 1))
			cmd_ver_first = 0;
		break;
473
	case CMD_BOOT_OFFSET:
474
		imximage_ivt_offset = get_cfg_value(token, name, lineno);
475 476 477
		if (unlikely(cmd_ver_first != 1))
			cmd_ver_first = 0;
		break;
478 479 480 481
	case CMD_WRITE_DATA:
	case CMD_WRITE_CLR_BIT:
	case CMD_CHECK_BITS_SET:
	case CMD_CHECK_BITS_CLR:
482
		value = get_cfg_value(token, name, lineno);
483 484
		if (set_dcd_param)
			(*set_dcd_param)(imxhdr, dcd_len, cmd);
485 486 487 488
		(*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len);
		if (unlikely(cmd_ver_first != 1))
			cmd_ver_first = 0;
		break;
489 490 491 492 493 494 495 496 497 498 499
	case CMD_CSF:
		if (imximage_version != 2) {
			fprintf(stderr,
				"Error: %s[%d] - CSF only supported for VERSION 2(%s)\n",
				name, lineno, token);
			exit(EXIT_FAILURE);
		}
		imximage_csf_size = get_cfg_value(token, name, lineno);
		if (unlikely(cmd_ver_first != 1))
			cmd_ver_first = 0;
		break;
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
	}
}

static void parse_cfg_fld(struct imx_header *imxhdr, int32_t *cmd,
		char *token, char *name, int lineno, int fld, int *dcd_len)
{
	int value;

	switch (fld) {
	case CFG_COMMAND:
		*cmd = get_table_entry_id(imximage_cmds,
			"imximage commands", token);
		if (*cmd < 0) {
			fprintf(stderr, "Error: %s[%d] - Invalid command"
			"(%s)\n", name, lineno, token);
			exit(EXIT_FAILURE);
		}
		break;
	case CFG_REG_SIZE:
		parse_cfg_cmd(imxhdr, *cmd, token, name, lineno, fld, *dcd_len);
		break;
	case CFG_REG_ADDRESS:
	case CFG_REG_VALUE:
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
		switch(*cmd) {
		case CMD_WRITE_DATA:
		case CMD_WRITE_CLR_BIT:
		case CMD_CHECK_BITS_SET:
		case CMD_CHECK_BITS_CLR:

			value = get_cfg_value(token, name, lineno);
			if (set_dcd_param)
				(*set_dcd_param)(imxhdr, *dcd_len, *cmd);
			(*set_dcd_val)(imxhdr, name, lineno, fld, value,
					*dcd_len);

			if (fld == CFG_REG_VALUE) {
				(*dcd_len)++;
				if (*dcd_len > max_dcd_entries) {
					fprintf(stderr, "Error: %s[%d] -"
						"DCD table exceeds maximum size(%d)\n",
						name, lineno, max_dcd_entries);
					exit(EXIT_FAILURE);
				}
543
			}
544 545 546
			break;
		default:
			break;
547
		}
548 549 550 551 552 553
		break;
	default:
		break;
	}
}
static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name)
554 555 556 557 558
{
	FILE *fd = NULL;
	char *line = NULL;
	char *token, *saveptr1, *saveptr2;
	int lineno = 0;
559
	int fld;
560
	size_t len;
561 562 563 564 565 566 567 568 569
	int dcd_len = 0;
	int32_t cmd;

	fd = fopen(name, "r");
	if (fd == 0) {
		fprintf(stderr, "Error: %s - Can't open DCD file\n", name);
		exit(EXIT_FAILURE);
	}

570 571
	/*
	 * Very simple parsing, line starting with # are comments
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
	 * and are dropped
	 */
	while ((getline(&line, &len, fd)) > 0) {
		lineno++;

		token = strtok_r(line, "\r\n", &saveptr1);
		if (token == NULL)
			continue;

		/* Check inside the single line */
		for (fld = CFG_COMMAND, cmd = CMD_INVALID,
				line = token; ; line = NULL, fld++) {
			token = strtok_r(line, " \t", &saveptr2);
			if (token == NULL)
				break;

			/* Drop all text starting with '#' as comments */
			if (token[0] == '#')
				break;

592 593
			parse_cfg_fld(imxhdr, &cmd, token, name,
					lineno, fld, &dcd_len);
594 595 596
		}

	}
597 598

	(*set_dcd_rst)(imxhdr, dcd_len, name, lineno);
599 600
	fclose(fd);

601
	/* Exit if there is no BOOT_FROM field specifying the flash_offset */
602
	if (imximage_ivt_offset == FLASH_OFFSET_UNDEFINED) {
603 604 605
		fprintf(stderr, "Error: No BOOT_FROM tag in %s\n", name);
		exit(EXIT_FAILURE);
	}
606
	return dcd_len;
607 608 609
}


610 611 612 613 614 615 616
static int imximage_check_image_types(uint8_t type)
{
	if (type == IH_TYPE_IMXIMAGE)
		return EXIT_SUCCESS;
	else
		return EXIT_FAILURE;
}
617

618
static int imximage_verify_header(unsigned char *ptr, int image_size,
619
			struct image_tool_params *params)
620 621
{
	struct imx_header *imx_hdr = (struct imx_header *) ptr;
622

623 624
	if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID)
		return -FDT_ERR_BADSTRUCTURE;
625

626 627
	return 0;
}
628

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
static void imximage_print_header(const void *ptr)
{
	struct imx_header *imx_hdr = (struct imx_header *) ptr;
	uint32_t version = detect_imximage_version(imx_hdr);

	switch (version) {
	case IMXIMAGE_V1:
		print_hdr_v1(imx_hdr);
		break;
	case IMXIMAGE_V2:
		print_hdr_v2(imx_hdr);
		break;
	default:
		err_imximage_version(version);
		break;
	}
}
646

647
static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd,
648
				struct image_tool_params *params)
649 650 651
{
	struct imx_header *imxhdr = (struct imx_header *)ptr;
	uint32_t dcd_len;
652

653 654 655 656 657 658
	/*
	 * In order to not change the old imx cfg file
	 * by adding VERSION command into it, here need
	 * set up function ptr group to V1 by default.
	 */
	imximage_version = IMXIMAGE_V1;
659
	/* Be able to detect if the cfg file has no BOOT_FROM tag */
660
	imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
661
	imximage_csf_size = 0;
662
	set_hdr_func();
663

664 665
	/* Parse dcd configuration file */
	dcd_len = parse_cfg_file(imxhdr, params->imagename);
666

667 668 669 670 671 672 673
	if (imximage_version == IMXIMAGE_V2) {
		if (imximage_init_loadsize < imximage_ivt_offset +
			sizeof(imx_header_v2_t))
				imximage_init_loadsize = imximage_ivt_offset +
					sizeof(imx_header_v2_t);
	}

674
	/* Set the imx header */
675
	(*set_imx_hdr)(imxhdr, dcd_len, params->ep, imximage_ivt_offset);
676 677 678

	/*
	 * ROM bug alert
679 680 681 682 683 684
	 *
	 * MX53 only loads 512 byte multiples in case of SD boot.
	 * MX53 only loads NAND page multiples in case of NAND boot and
	 * supports up to 4096 byte large pages, thus align to 4096.
	 *
	 * The remaining fraction of a block bytes would not be loaded!
685
	 */
686
	*header_size_ptr = ROUND((sbuf->st_size + imximage_ivt_offset), 4096);
687 688 689 690 691 692

	if (csf_ptr && imximage_csf_size) {
		*csf_ptr = params->ep - imximage_init_loadsize +
			*header_size_ptr;
		*header_size_ptr += imximage_csf_size;
	}
693 694
}

695
int imximage_check_params(struct image_tool_params *params)
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
{
	if (!params)
		return CFG_INVALID;
	if (!strlen(params->imagename)) {
		fprintf(stderr, "Error: %s - Configuration file not specified, "
			"it is needed for imximage generation\n",
			params->cmdname);
		return CFG_INVALID;
	}
	/*
	 * Check parameters:
	 * XIP is not allowed and verify that incompatible
	 * parameters are not sent at the same time
	 * For example, if list is required a data image must not be provided
	 */
	return	(params->dflag && (params->fflag || params->lflag)) ||
		(params->fflag && (params->dflag || params->lflag)) ||
		(params->lflag && (params->dflag || params->fflag)) ||
		(params->xflag) || !(strlen(params->imagename));
}

717
static int imximage_generate(struct image_tool_params *params,
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
	struct image_type_params *tparams)
{
	struct imx_header *imxhdr;
	size_t alloc_len;
	struct stat sbuf;
	char *datafile = params->datafile;
	uint32_t pad_len;

	memset(&imximage_header, 0, sizeof(imximage_header));

	/*
	 * In order to not change the old imx cfg file
	 * by adding VERSION command into it, here need
	 * set up function ptr group to V1 by default.
	 */
	imximage_version = IMXIMAGE_V1;
	/* Be able to detect if the cfg file has no BOOT_FROM tag */
	imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
	imximage_csf_size = 0;
737
	set_hdr_func();
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789

	/* Parse dcd configuration file */
	parse_cfg_file(&imximage_header, params->imagename);

	/* TODO: check i.MX image V1 handling, for now use 'old' style */
	if (imximage_version == IMXIMAGE_V1) {
		alloc_len = 4096;
	} else {
		if (imximage_init_loadsize < imximage_ivt_offset +
			sizeof(imx_header_v2_t))
				imximage_init_loadsize = imximage_ivt_offset +
					sizeof(imx_header_v2_t);
		alloc_len = imximage_init_loadsize - imximage_ivt_offset;
	}

	if (alloc_len < sizeof(struct imx_header)) {
		fprintf(stderr, "%s: header error\n",
			params->cmdname);
		exit(EXIT_FAILURE);
	}

	imxhdr = malloc(alloc_len);

	if (!imxhdr) {
		fprintf(stderr, "%s: malloc return failure: %s\n",
			params->cmdname, strerror(errno));
		exit(EXIT_FAILURE);
	}

	memset(imxhdr, 0, alloc_len);

	tparams->header_size = alloc_len;
	tparams->hdr         = imxhdr;

	/* determine data image file length */

	if (stat(datafile, &sbuf) < 0) {
		fprintf(stderr, "%s: Can't stat %s: %s\n",
			params->cmdname, datafile, strerror(errno));
		exit(EXIT_FAILURE);
	}

	pad_len = ROUND(sbuf.st_size, 4096) - sbuf.st_size;

	/* TODO: check i.MX image V1 handling, for now use 'old' style */
	if (imximage_version == IMXIMAGE_V1)
		return 0;
	else
		return pad_len;
}


790 791 792
/*
 * imximage parameters
 */
793 794 795 796 797 798 799 800 801 802 803 804 805 806
U_BOOT_IMAGE_TYPE(
	imximage,
	"Freescale i.MX Boot Image support",
	0,
	NULL,
	imximage_check_params,
	imximage_verify_header,
	imximage_print_header,
	imximage_set_header,
	NULL,
	imximage_check_image_types,
	NULL,
	imximage_generate
);