Blame view

tools/imximage.c 19 KB
8edcde5e4   Stefano Babic   mkimage: Add Free...
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>
   *
3765b3e7b   Wolfgang Denk   Coding Style clea...
9
   * SPDX-License-Identifier:	GPL-2.0+
8edcde5e4   Stefano Babic   mkimage: Add Free...
10
   */
f86ed6a8d   Guilherme Maciel Ferreira   tools: moved code...
11
  #include "imagetool.h"
8edcde5e4   Stefano Babic   mkimage: Add Free...
12
13
  #include <image.h>
  #include "imximage.h"
0187c985a   Stefano Babic   tools: add suppor...
14
  #define UNDEFINED 0xFFFFFFFF
8edcde5e4   Stefano Babic   mkimage: Add Free...
15
16
17
18
  /*
   * Supported commands for configuration file
   */
  static table_entry_t imximage_cmds[] = {
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
19
  	{CMD_BOOT_FROM,         "BOOT_FROM",            "boot command",	  },
6cb83829a   Marek Vasut   tools: arm: imx: ...
20
  	{CMD_BOOT_OFFSET,       "BOOT_OFFSET",          "Boot offset",	  },
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
21
  	{CMD_DATA,              "DATA",                 "Reg Write Data", },
0187c985a   Stefano Babic   tools: add suppor...
22
  	{CMD_CSF,               "CSF",           "Command Sequence File", },
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
23
24
  	{CMD_IMAGE_VERSION,     "IMAGE_VERSION",        "image version",  },
  	{-1,                    "",                     "",	          },
8edcde5e4   Stefano Babic   mkimage: Add Free...
25
26
27
28
29
30
  };
  
  /*
   * Supported Boot options for configuration file
   * this is needed to set the correct flash offset
   */
377e367a8   Stefano Babic   tools: dynamicall...
31
  static table_entry_t imximage_boot_offset[] = {
8edcde5e4   Stefano Babic   mkimage: Add Free...
32
  	{FLASH_OFFSET_ONENAND,	"onenand",	"OneNAND Flash",},
bd25864cc   Dirk Behme   imximage: Sort bo...
33
  	{FLASH_OFFSET_NAND,	"nand",		"NAND Flash",	},
19b409c00   Dirk Behme   imximage: Add sup...
34
35
  	{FLASH_OFFSET_NOR,	"nor",		"NOR Flash",	},
  	{FLASH_OFFSET_SATA,	"sata",		"SATA Disk",	},
bd25864cc   Dirk Behme   imximage: Sort bo...
36
37
  	{FLASH_OFFSET_SD,	"sd",		"SD Card",	},
  	{FLASH_OFFSET_SPI,	"spi",		"SPI Flash",	},
8edcde5e4   Stefano Babic   mkimage: Add Free...
38
39
  	{-1,			"",		"Invalid",	},
  };
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
40
  /*
377e367a8   Stefano Babic   tools: dynamicall...
41
42
43
44
45
46
47
48
49
50
51
52
53
54
   * 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",	},
  	{-1,				"",		"Invalid",	},
  };
  
  /*
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
55
56
57
58
   * IMXIMAGE version definition for i.MX chips
   */
  static table_entry_t imximage_versions[] = {
  	{IMXIMAGE_V1,	"",	" (i.MX25/35/51 compatible)", },
19b409c00   Dirk Behme   imximage: Add sup...
59
  	{IMXIMAGE_V2,	"",	" (i.MX53/6 compatible)",     },
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
60
61
  	{-1,            "",     " (Invalid)",                 },
  };
8edcde5e4   Stefano Babic   mkimage: Add Free...
62
63
  
  static struct imx_header imximage_header;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
64
  static uint32_t imximage_version;
0187c985a   Stefano Babic   tools: add suppor...
65
66
67
68
69
70
71
  /*
   * 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;
377e367a8   Stefano Babic   tools: dynamicall...
72
73
  /* Initial Load Region Size */
  static uint32_t imximage_init_loadsize;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
74
75
76
77
  
  static set_dcd_val_t set_dcd_val;
  static set_dcd_rst_t set_dcd_rst;
  static set_imx_hdr_t set_imx_hdr;
4d5fa9853   Troy Kisky   imximage: check d...
78
  static uint32_t max_dcd_entries;
243319825   Troy Kisky   imximage: delay s...
79
  static uint32_t *header_size_ptr;
0187c985a   Stefano Babic   tools: add suppor...
80
  static uint32_t *csf_ptr;
8edcde5e4   Stefano Babic   mkimage: Add Free...
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
  
  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)
  ",
  			name,  linenr, token);
  		exit(EXIT_FAILURE);
  	}
  	return value;
  }
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
97
  static uint32_t detect_imximage_version(struct imx_header *imx_hdr)
8edcde5e4   Stefano Babic   mkimage: Add Free...
98
  {
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
  	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;
8edcde5e4   Stefano Babic   mkimage: Add Free...
115
  }
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
116
  static void err_imximage_version(int version)
8edcde5e4   Stefano Babic   mkimage: Add Free...
117
  {
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
118
119
120
  	fprintf(stderr,
  		"Error: Unsupported imximage version:%d
  ", version);
8edcde5e4   Stefano Babic   mkimage: Add Free...
121

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
122
123
  	exit(EXIT_FAILURE);
  }
8edcde5e4   Stefano Babic   mkimage: Add Free...
124

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
  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)
  ",
  				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;
8edcde5e4   Stefano Babic   mkimage: Add Free...
150

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
151
152
  	}
  }
8edcde5e4   Stefano Babic   mkimage: Add Free...
153

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
  static void set_dcd_val_v2(struct imx_header *imxhdr, char *name, int lineno,
  					int fld, uint32_t value, uint32_t off)
  {
  	dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.dcd_table;
  
  	switch (fld) {
  	case CFG_REG_ADDRESS:
  		dcd_v2->addr_data[off].addr = cpu_to_be32(value);
  		break;
  	case CFG_REG_VALUE:
  		dcd_v2->addr_data[off].value = cpu_to_be32(value);
  		break;
  	default:
  		break;
  
  	}
8edcde5e4   Stefano Babic   mkimage: Add Free...
170
  }
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
171
172
173
174
175
176
  /*
   * 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)
8edcde5e4   Stefano Babic   mkimage: Add Free...
177
  {
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
178
  	dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
179
180
181
182
183
184
185
186
187
188
189
190
  	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;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
191
192
193
194
195
196
197
198
199
200
201
  	dcd_v2->header.tag = DCD_HEADER_TAG;
  	dcd_v2->header.length = cpu_to_be16(
  			dcd_len * sizeof(dcd_addr_data_t) + 8);
  	dcd_v2->header.version = DCD_VERSION;
  	dcd_v2->write_dcd_command.tag = DCD_COMMAND_TAG;
  	dcd_v2->write_dcd_command.length = cpu_to_be16(
  			dcd_len * sizeof(dcd_addr_data_t) + 4);
  	dcd_v2->write_dcd_command.param = DCD_COMMAND_PARAM;
  }
  
  static void set_imx_hdr_v1(struct imx_header *imxhdr, uint32_t dcd_len,
ad0826dcd   Troy Kisky   imximage: change ...
202
  		uint32_t entry_point, uint32_t flash_offset)
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
203
204
205
206
  {
  	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;
ab857f261   Troy Kisky   imximage: make se...
207
  	uint32_t hdr_base;
243319825   Troy Kisky   imximage: delay s...
208
209
  	uint32_t header_length = (((char *)&dcd_v1->addr_data[dcd_len].addr)
  			- ((char *)imxhdr));
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
210

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
211
212
  	/* Set magic number */
  	fhdr_v1->app_code_barker = APP_CODE_BARKER;
377e367a8   Stefano Babic   tools: dynamicall...
213
214
  	/* TODO: check i.MX image V1 handling, for now use 'old' style */
  	hdr_base = entry_point - 4096;
ab857f261   Troy Kisky   imximage: make se...
215
  	fhdr_v1->app_dest_ptr = hdr_base - flash_offset;
ad0826dcd   Troy Kisky   imximage: change ...
216
  	fhdr_v1->app_code_jump_vector = entry_point;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
217

ab857f261   Troy Kisky   imximage: make se...
218
219
  	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);
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
220

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
221
222
223
  	/* Security feature are not supported */
  	fhdr_v1->app_code_csf = 0;
  	fhdr_v1->super_root_key = 0;
243319825   Troy Kisky   imximage: delay s...
224
  	header_size_ptr = (uint32_t *)(((char *)imxhdr) + header_length - 4);
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
225
226
227
  }
  
  static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len,
ad0826dcd   Troy Kisky   imximage: change ...
228
  		uint32_t entry_point, uint32_t flash_offset)
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
229
230
231
  {
  	imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2;
  	flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
ab857f261   Troy Kisky   imximage: make se...
232
  	uint32_t hdr_base;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
233

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
234
235
236
237
  	/* 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 */
ad0826dcd   Troy Kisky   imximage: change ...
238
  	fhdr_v2->entry = entry_point;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
239
  	fhdr_v2->reserved1 = fhdr_v2->reserved2 = 0;
377e367a8   Stefano Babic   tools: dynamicall...
240
241
242
  	hdr_base = entry_point - imximage_init_loadsize +
  		flash_offset;
  	fhdr_v2->self = hdr_base;
ab857f261   Troy Kisky   imximage: make se...
243
244
245
  	fhdr_v2->dcd_ptr = hdr_base + offsetof(imx_header_v2_t, dcd_table);
  	fhdr_v2->boot_data_ptr = hdr_base
  			+ offsetof(imx_header_v2_t, boot_data);
377e367a8   Stefano Babic   tools: dynamicall...
246
  	hdr_v2->boot_data.start = entry_point - imximage_init_loadsize;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
247

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
248
  	fhdr_v2->csf = 0;
0187c985a   Stefano Babic   tools: add suppor...
249

243319825   Troy Kisky   imximage: delay s...
250
  	header_size_ptr = &hdr_v2->boot_data.size;
0187c985a   Stefano Babic   tools: add suppor...
251
  	csf_ptr = &fhdr_v2->csf;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
252
  }
72048bc3f   York Sun   tools/imximage.c:...
253
  static void set_hdr_func(void)
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
254
255
256
257
258
259
  {
  	switch (imximage_version) {
  	case IMXIMAGE_V1:
  		set_dcd_val = set_dcd_val_v1;
  		set_dcd_rst = set_dcd_rst_v1;
  		set_imx_hdr = set_imx_hdr_v1;
4d5fa9853   Troy Kisky   imximage: check d...
260
  		max_dcd_entries = MAX_HW_CFG_SIZE_V1;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
261
262
263
264
265
  		break;
  	case IMXIMAGE_V2:
  		set_dcd_val = set_dcd_val_v2;
  		set_dcd_rst = set_dcd_rst_v2;
  		set_imx_hdr = set_imx_hdr_v2;
4d5fa9853   Troy Kisky   imximage: check d...
266
  		max_dcd_entries = MAX_HW_CFG_SIZE_V2;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
267
268
269
270
271
272
  		break;
  	default:
  		err_imximage_version(imximage_version);
  		break;
  	}
  }
8edcde5e4   Stefano Babic   mkimage: Add Free...
273

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
274
275
276
277
278
279
280
281
282
  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))) {
8edcde5e4   Stefano Babic   mkimage: Add Free...
283
284
285
  		fprintf(stderr,
  			"Error: Image corrupt DCD size %d exceed maximum %d
  ",
5b28e913f   Stefano Babic   mkimage: SEGFAULT...
286
  			(uint32_t)(size / sizeof(dcd_type_addr_data_t)),
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
  			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
  ");
  	printf("Image Ver:    %x", ver);
  	printf("%s
  ", get_table_entry_name(imximage_versions, NULL, ver));
  	printf("Data Size:    ");
  	genimg_print_size(dcd_v1->addr_data[length].type);
  	printf("Load Address: %08x
  ", (uint32_t)fhdr_v1->app_dest_ptr);
  	printf("Entry Point:  %08x
  ", (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;
  
  	size = be16_to_cpu(dcd_v2->header.length) - 8;
  	if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t))) {
  		fprintf(stderr,
  			"Error: Image corrupt DCD size %d exceed maximum %d
  ",
  			(uint32_t)(size / sizeof(dcd_addr_data_t)),
  			MAX_HW_CFG_SIZE_V2);
8edcde5e4   Stefano Babic   mkimage: Add Free...
321
322
  		exit(EXIT_FAILURE);
  	}
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
323
  	version = detect_imximage_version(imx_hdr);
8edcde5e4   Stefano Babic   mkimage: Add Free...
324
325
326
  
  	printf("Image Type:   Freescale IMX Boot Image
  ");
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
327
328
329
  	printf("Image Ver:    %x", version);
  	printf("%s
  ", get_table_entry_name(imximage_versions, NULL, version));
8edcde5e4   Stefano Babic   mkimage: Add Free...
330
  	printf("Data Size:    ");
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
331
332
333
334
335
  	genimg_print_size(hdr_v2->boot_data.size);
  	printf("Load Address: %08x
  ", (uint32_t)fhdr_v2->boot_data_ptr);
  	printf("Entry Point:  %08x
  ", (uint32_t)fhdr_v2->entry);
0187c985a   Stefano Babic   tools: add suppor...
336
337
338
339
340
341
342
343
  	if (fhdr_v2->csf && (imximage_ivt_offset != UNDEFINED) &&
  	    (imximage_csf_size != UNDEFINED)) {
  		printf("HAB Blocks:   %08x %08x %08x
  ",
  		       (uint32_t)fhdr_v2->self, 0,
  		       hdr_v2->boot_data.size - imximage_ivt_offset -
  		       imximage_csf_size);
  	}
8edcde5e4   Stefano Babic   mkimage: Add Free...
344
  }
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
  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
  ", name, lineno);
  			exit(EXIT_FAILURE);
  		}
  		cmd_ver_first = 1;
72048bc3f   York Sun   tools/imximage.c:...
362
  		set_hdr_func();
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
363
364
  		break;
  	case CMD_BOOT_FROM:
377e367a8   Stefano Babic   tools: dynamicall...
365
  		imximage_ivt_offset = get_table_entry_id(imximage_boot_offset,
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
366
  					"imximage boot option", token);
3150f92c2   Stefano Babic   tools: rename mxi...
367
  		if (imximage_ivt_offset == -1) {
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
368
369
370
371
372
  			fprintf(stderr, "Error: %s[%d] -Invalid boot device"
  				"(%s)
  ", name, lineno, token);
  			exit(EXIT_FAILURE);
  		}
377e367a8   Stefano Babic   tools: dynamicall...
373
374
375
376
377
378
379
380
381
382
383
384
  
  		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)
  ",
  				name, lineno, token);
  			exit(EXIT_FAILURE);
  		}
01390aff2   Stefano Babic   tools: add paddin...
385
386
387
388
389
390
391
  
  		/*
  		 * 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;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
392
393
394
  		if (unlikely(cmd_ver_first != 1))
  			cmd_ver_first = 0;
  		break;
6cb83829a   Marek Vasut   tools: arm: imx: ...
395
  	case CMD_BOOT_OFFSET:
3150f92c2   Stefano Babic   tools: rename mxi...
396
  		imximage_ivt_offset = get_cfg_value(token, name, lineno);
6cb83829a   Marek Vasut   tools: arm: imx: ...
397
398
399
  		if (unlikely(cmd_ver_first != 1))
  			cmd_ver_first = 0;
  		break;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
400
401
402
403
404
405
  	case CMD_DATA:
  		value = get_cfg_value(token, name, lineno);
  		(*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len);
  		if (unlikely(cmd_ver_first != 1))
  			cmd_ver_first = 0;
  		break;
0187c985a   Stefano Babic   tools: add suppor...
406
407
408
409
410
411
412
413
414
415
416
417
  	case CMD_CSF:
  		if (imximage_version != 2) {
  			fprintf(stderr,
  				"Error: %s[%d] - CSF only supported for VERSION 2(%s)
  ",
  				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;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
  	}
  }
  
  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)
  ", 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:
  		if (*cmd != CMD_DATA)
  			return;
  
  		value = get_cfg_value(token, name, lineno);
  		(*set_dcd_val)(imxhdr, name, lineno, fld, value, *dcd_len);
4d5fa9853   Troy Kisky   imximage: check d...
447
  		if (fld == CFG_REG_VALUE) {
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
448
  			(*dcd_len)++;
4d5fa9853   Troy Kisky   imximage: check d...
449
450
451
452
453
454
455
456
  			if (*dcd_len > max_dcd_entries) {
  				fprintf(stderr, "Error: %s[%d] -"
  					"DCD table exceeds maximum size(%d)
  ",
  					name, lineno, max_dcd_entries);
  				exit(EXIT_FAILURE);
  			}
  		}
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
457
458
459
460
461
462
  		break;
  	default:
  		break;
  	}
  }
  static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name)
8edcde5e4   Stefano Babic   mkimage: Add Free...
463
464
465
466
467
  {
  	FILE *fd = NULL;
  	char *line = NULL;
  	char *token, *saveptr1, *saveptr2;
  	int lineno = 0;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
468
  	int fld;
0ad22703f   Kim Phillips   tools: fix imxima...
469
  	size_t len;
8edcde5e4   Stefano Babic   mkimage: Add Free...
470
  	int dcd_len = 0;
8edcde5e4   Stefano Babic   mkimage: Add Free...
471
472
473
474
475
476
477
478
  	int32_t cmd;
  
  	fd = fopen(name, "r");
  	if (fd == 0) {
  		fprintf(stderr, "Error: %s - Can't open DCD file
  ", name);
  		exit(EXIT_FAILURE);
  	}
01390aff2   Stefano Babic   tools: add paddin...
479
480
  	/*
  	 * Very simple parsing, line starting with # are comments
8edcde5e4   Stefano Babic   mkimage: Add Free...
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
  	 * and are dropped
  	 */
  	while ((getline(&line, &len, fd)) > 0) {
  		lineno++;
  
  		token = strtok_r(line, "\r
  ", &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;
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
501
502
  			parse_cfg_fld(imxhdr, &cmd, token, name,
  					lineno, fld, &dcd_len);
8edcde5e4   Stefano Babic   mkimage: Add Free...
503
  		}
8edcde5e4   Stefano Babic   mkimage: Add Free...
504
  	}
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
505
506
  
  	(*set_dcd_rst)(imxhdr, dcd_len, name, lineno);
8edcde5e4   Stefano Babic   mkimage: Add Free...
507
  	fclose(fd);
8d8cc828f   Troy Kisky   imximage: move fl...
508
  	/* Exit if there is no BOOT_FROM field specifying the flash_offset */
3150f92c2   Stefano Babic   tools: rename mxi...
509
  	if (imximage_ivt_offset == FLASH_OFFSET_UNDEFINED) {
8d8cc828f   Troy Kisky   imximage: move fl...
510
511
512
513
  		fprintf(stderr, "Error: No BOOT_FROM tag in %s
  ", name);
  		exit(EXIT_FAILURE);
  	}
5b28e913f   Stefano Babic   mkimage: SEGFAULT...
514
  	return dcd_len;
8edcde5e4   Stefano Babic   mkimage: Add Free...
515
  }
8edcde5e4   Stefano Babic   mkimage: Add Free...
516

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
517
518
519
520
521
522
523
  static int imximage_check_image_types(uint8_t type)
  {
  	if (type == IH_TYPE_IMXIMAGE)
  		return EXIT_SUCCESS;
  	else
  		return EXIT_FAILURE;
  }
8edcde5e4   Stefano Babic   mkimage: Add Free...
524

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
525
  static int imximage_verify_header(unsigned char *ptr, int image_size,
f86ed6a8d   Guilherme Maciel Ferreira   tools: moved code...
526
  			struct image_tool_params *params)
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
527
528
  {
  	struct imx_header *imx_hdr = (struct imx_header *) ptr;
8edcde5e4   Stefano Babic   mkimage: Add Free...
529

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
530
531
  	if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID)
  		return -FDT_ERR_BADSTRUCTURE;
8edcde5e4   Stefano Babic   mkimage: Add Free...
532

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
533
534
  	return 0;
  }
8edcde5e4   Stefano Babic   mkimage: Add Free...
535

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
  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;
  	}
  }
8edcde5e4   Stefano Babic   mkimage: Add Free...
553

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
554
  static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd,
f86ed6a8d   Guilherme Maciel Ferreira   tools: moved code...
555
  				struct image_tool_params *params)
8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
556
557
558
  {
  	struct imx_header *imxhdr = (struct imx_header *)ptr;
  	uint32_t dcd_len;
8edcde5e4   Stefano Babic   mkimage: Add Free...
559

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
560
561
562
563
564
565
  	/*
  	 * 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;
49d3e2721   Dirk Behme   imximage: Remove ...
566
  	/* Be able to detect if the cfg file has no BOOT_FROM tag */
3150f92c2   Stefano Babic   tools: rename mxi...
567
  	imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
0187c985a   Stefano Babic   tools: add suppor...
568
  	imximage_csf_size = 0;
72048bc3f   York Sun   tools/imximage.c:...
569
  	set_hdr_func();
8edcde5e4   Stefano Babic   mkimage: Add Free...
570

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
571
572
  	/* Parse dcd configuration file */
  	dcd_len = parse_cfg_file(imxhdr, params->imagename);
8edcde5e4   Stefano Babic   mkimage: Add Free...
573

8a1edd7d5   Liu Hui-R64343   imximage: Add MX5...
574
  	/* Set the imx header */
3150f92c2   Stefano Babic   tools: rename mxi...
575
  	(*set_imx_hdr)(imxhdr, dcd_len, params->ep, imximage_ivt_offset);
1411fb37b   Fabio Estevam   tools: imximage: ...
576
577
578
  
  	/*
  	 * ROM bug alert
895d99667   Marek Vasut   imx: Align the im...
579
580
581
582
583
584
  	 *
  	 * 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!
1411fb37b   Fabio Estevam   tools: imximage: ...
585
  	 */
377e367a8   Stefano Babic   tools: dynamicall...
586
  	*header_size_ptr = ROUND(sbuf->st_size, 4096);
0187c985a   Stefano Babic   tools: add suppor...
587
588
589
590
591
592
  
  	if (csf_ptr && imximage_csf_size) {
  		*csf_ptr = params->ep - imximage_init_loadsize +
  			*header_size_ptr;
  		*header_size_ptr += imximage_csf_size;
  	}
8edcde5e4   Stefano Babic   mkimage: Add Free...
593
  }
f86ed6a8d   Guilherme Maciel Ferreira   tools: moved code...
594
  int imximage_check_params(struct image_tool_params *params)
8edcde5e4   Stefano Babic   mkimage: Add Free...
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
  {
  	if (!params)
  		return CFG_INVALID;
  	if (!strlen(params->imagename)) {
  		fprintf(stderr, "Error: %s - Configuration file not specified, "
  			"it is needed for imximage generation
  ",
  			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));
  }
f86ed6a8d   Guilherme Maciel Ferreira   tools: moved code...
616
  static int imximage_generate(struct image_tool_params *params,
01390aff2   Stefano Babic   tools: add paddin...
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
  	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;
72048bc3f   York Sun   tools/imximage.c:...
636
  	set_hdr_func();
01390aff2   Stefano Babic   tools: add paddin...
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
  
  	/* 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
  ",
  			params->cmdname);
  		exit(EXIT_FAILURE);
  	}
  
  	imxhdr = malloc(alloc_len);
  
  	if (!imxhdr) {
  		fprintf(stderr, "%s: malloc return failure: %s
  ",
  			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
  ",
  			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;
  }
8edcde5e4   Stefano Babic   mkimage: Add Free...
690
691
692
693
  /*
   * imximage parameters
   */
  static struct image_type_params imximage_params = {
6e0838571   Fabio Estevam   tools: imximage: ...
694
  	.name		= "Freescale i.MX Boot Image support",
01390aff2   Stefano Babic   tools: add paddin...
695
696
  	.header_size	= 0,
  	.hdr		= NULL,
8edcde5e4   Stefano Babic   mkimage: Add Free...
697
698
699
700
701
  	.check_image_type = imximage_check_image_types,
  	.verify_header	= imximage_verify_header,
  	.print_header	= imximage_print_header,
  	.set_header	= imximage_set_header,
  	.check_params	= imximage_check_params,
01390aff2   Stefano Babic   tools: add paddin...
702
  	.vrec_header	= imximage_generate,
8edcde5e4   Stefano Babic   mkimage: Add Free...
703
704
705
706
  };
  
  void init_imx_image_type(void)
  {
f86ed6a8d   Guilherme Maciel Ferreira   tools: moved code...
707
  	register_image_type(&imximage_params);
8edcde5e4   Stefano Babic   mkimage: Add Free...
708
  }