imximage.c 27 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * (C) Copyright 2009
  4. * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
  5. *
  6. * (C) Copyright 2008
  7. * Marvell Semiconductor <www.marvell.com>
  8. * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
  9. */
  10. #include "imagetool.h"
  11. #include <image.h>
  12. #include "imximage.h"
  13. #include <generated/autoconf.h>
  14. #define UNDEFINED 0xFFFFFFFF
  15. #if !defined(CONFIG_IMX_DCD_ADDR)
  16. #define CONFIG_IMX_DCD_ADDR 0x00910000
  17. #endif
  18. /*
  19. * Supported commands for configuration file
  20. */
  21. static table_entry_t imximage_cmds[] = {
  22. {CMD_BOOT_FROM, "BOOT_FROM", "boot command", },
  23. {CMD_BOOT_OFFSET, "BOOT_OFFSET", "Boot offset", },
  24. {CMD_WRITE_DATA, "DATA", "Reg Write Data", },
  25. {CMD_WRITE_CLR_BIT, "CLR_BIT", "Reg clear bit", },
  26. {CMD_WRITE_SET_BIT, "SET_BIT", "Reg set bit", },
  27. {CMD_CHECK_BITS_SET, "CHECK_BITS_SET", "Reg Check bits set", },
  28. {CMD_CHECK_BITS_CLR, "CHECK_BITS_CLR", "Reg Check bits clr", },
  29. {CMD_CSF, "CSF", "Command Sequence File", },
  30. {CMD_IMAGE_VERSION, "IMAGE_VERSION", "image version", },
  31. {CMD_PLUGIN, "PLUGIN", "file plugin_addr", },
  32. {-1, "", "", },
  33. };
  34. /*
  35. * Supported Boot options for configuration file
  36. * this is needed to set the correct flash offset
  37. */
  38. static table_entry_t imximage_boot_offset[] = {
  39. {FLASH_OFFSET_ONENAND, "onenand", "OneNAND Flash",},
  40. {FLASH_OFFSET_NAND, "nand", "NAND Flash", },
  41. {FLASH_OFFSET_NOR, "nor", "NOR Flash", },
  42. {FLASH_OFFSET_SATA, "sata", "SATA Disk", },
  43. {FLASH_OFFSET_SD, "sd", "SD Card", },
  44. {FLASH_OFFSET_SPI, "spi", "SPI Flash", },
  45. {FLASH_OFFSET_QSPI, "qspi", "QSPI NOR Flash",},
  46. {-1, "", "Invalid", },
  47. };
  48. /*
  49. * Supported Boot options for configuration file
  50. * this is needed to determine the initial load size
  51. */
  52. static table_entry_t imximage_boot_loadsize[] = {
  53. {FLASH_LOADSIZE_ONENAND, "onenand", "OneNAND Flash",},
  54. {FLASH_LOADSIZE_NAND, "nand", "NAND Flash", },
  55. {FLASH_LOADSIZE_NOR, "nor", "NOR Flash", },
  56. {FLASH_LOADSIZE_SATA, "sata", "SATA Disk", },
  57. {FLASH_LOADSIZE_SD, "sd", "SD Card", },
  58. {FLASH_LOADSIZE_SPI, "spi", "SPI Flash", },
  59. {FLASH_LOADSIZE_QSPI, "qspi", "QSPI NOR Flash",},
  60. {-1, "", "Invalid", },
  61. };
  62. /*
  63. * IMXIMAGE version definition for i.MX chips
  64. */
  65. static table_entry_t imximage_versions[] = {
  66. {IMXIMAGE_V1, "", " (i.MX25/35/51 compatible)", },
  67. {IMXIMAGE_V2, "", " (i.MX53/6/7 compatible)", },
  68. {-1, "", " (Invalid)", },
  69. };
  70. static struct imx_header imximage_header;
  71. static uint32_t imximage_version;
  72. /*
  73. * Image Vector Table Offset
  74. * Initialized to a wrong not 4-bytes aligned address to
  75. * check if it is was set by the cfg file.
  76. */
  77. static uint32_t imximage_ivt_offset = UNDEFINED;
  78. static uint32_t imximage_csf_size = UNDEFINED;
  79. /* Initial Load Region Size */
  80. static uint32_t imximage_init_loadsize;
  81. static uint32_t imximage_iram_free_start;
  82. static uint32_t imximage_plugin_size;
  83. static uint32_t plugin_image;
  84. static set_dcd_val_t set_dcd_val;
  85. static set_dcd_param_t set_dcd_param;
  86. static set_dcd_rst_t set_dcd_rst;
  87. 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. static uint32_t get_cfg_value(char *token, char *name, int linenr)
  92. {
  93. char *endptr;
  94. uint32_t value;
  95. errno = 0;
  96. value = strtoul(token, &endptr, 16);
  97. if (errno || (token == endptr)) {
  98. fprintf(stderr, "Error: %s[%d] - Invalid hex data(%s)\n",
  99. name, linenr, token);
  100. exit(EXIT_FAILURE);
  101. }
  102. return value;
  103. }
  104. static uint32_t detect_imximage_version(struct imx_header *imx_hdr)
  105. {
  106. imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
  107. imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
  108. flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
  109. flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
  110. /* Try to detect V1 */
  111. if ((fhdr_v1->app_code_barker == APP_CODE_BARKER) &&
  112. (hdr_v1->dcd_table.preamble.barker == DCD_BARKER))
  113. return IMXIMAGE_V1;
  114. /* Try to detect V2 */
  115. if ((fhdr_v2->header.tag == IVT_HEADER_TAG) &&
  116. (hdr_v2->data.dcd_table.header.tag == DCD_HEADER_TAG))
  117. return IMXIMAGE_V2;
  118. if ((fhdr_v2->header.tag == IVT_HEADER_TAG) &&
  119. hdr_v2->boot_data.plugin)
  120. return IMXIMAGE_V2;
  121. return IMXIMAGE_VER_INVALID;
  122. }
  123. static void err_imximage_version(int version)
  124. {
  125. fprintf(stderr,
  126. "Error: Unsupported imximage version:%d\n", version);
  127. exit(EXIT_FAILURE);
  128. }
  129. static void set_dcd_val_v1(struct imx_header *imxhdr, char *name, int lineno,
  130. int fld, uint32_t value, uint32_t off)
  131. {
  132. dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
  133. switch (fld) {
  134. case CFG_REG_SIZE:
  135. /* Byte, halfword, word */
  136. if ((value != 1) && (value != 2) && (value != 4)) {
  137. fprintf(stderr, "Error: %s[%d] - "
  138. "Invalid register size " "(%d)\n",
  139. name, lineno, value);
  140. exit(EXIT_FAILURE);
  141. }
  142. dcd_v1->addr_data[off].type = value;
  143. break;
  144. case CFG_REG_ADDRESS:
  145. dcd_v1->addr_data[off].addr = value;
  146. break;
  147. case CFG_REG_VALUE:
  148. dcd_v1->addr_data[off].value = value;
  149. break;
  150. default:
  151. break;
  152. }
  153. }
  154. static struct dcd_v2_cmd *gd_last_cmd;
  155. static void set_dcd_param_v2(struct imx_header *imxhdr, uint32_t dcd_len,
  156. int32_t cmd)
  157. {
  158. dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.data.dcd_table;
  159. struct dcd_v2_cmd *d = gd_last_cmd;
  160. struct dcd_v2_cmd *d2;
  161. int len;
  162. if (!d)
  163. d = &dcd_v2->dcd_cmd;
  164. d2 = d;
  165. len = be16_to_cpu(d->write_dcd_command.length);
  166. if (len > 4)
  167. d2 = (struct dcd_v2_cmd *)(((char *)d) + len);
  168. switch (cmd) {
  169. case CMD_WRITE_DATA:
  170. if ((d->write_dcd_command.tag == DCD_WRITE_DATA_COMMAND_TAG) &&
  171. (d->write_dcd_command.param == DCD_WRITE_DATA_PARAM))
  172. break;
  173. d = d2;
  174. d->write_dcd_command.tag = DCD_WRITE_DATA_COMMAND_TAG;
  175. d->write_dcd_command.length = cpu_to_be16(4);
  176. d->write_dcd_command.param = DCD_WRITE_DATA_PARAM;
  177. break;
  178. case CMD_WRITE_CLR_BIT:
  179. if ((d->write_dcd_command.tag == DCD_WRITE_DATA_COMMAND_TAG) &&
  180. (d->write_dcd_command.param == DCD_WRITE_CLR_BIT_PARAM))
  181. break;
  182. d = d2;
  183. d->write_dcd_command.tag = DCD_WRITE_DATA_COMMAND_TAG;
  184. d->write_dcd_command.length = cpu_to_be16(4);
  185. d->write_dcd_command.param = DCD_WRITE_CLR_BIT_PARAM;
  186. break;
  187. case CMD_WRITE_SET_BIT:
  188. if ((d->write_dcd_command.tag == DCD_WRITE_DATA_COMMAND_TAG) &&
  189. (d->write_dcd_command.param == DCD_WRITE_SET_BIT_PARAM))
  190. break;
  191. d = d2;
  192. d->write_dcd_command.tag = DCD_WRITE_DATA_COMMAND_TAG;
  193. d->write_dcd_command.length = cpu_to_be16(4);
  194. d->write_dcd_command.param = DCD_WRITE_SET_BIT_PARAM;
  195. break;
  196. /*
  197. * Check data command only supports one entry,
  198. */
  199. case CMD_CHECK_BITS_SET:
  200. d = d2;
  201. d->write_dcd_command.tag = DCD_CHECK_DATA_COMMAND_TAG;
  202. d->write_dcd_command.length = cpu_to_be16(4);
  203. d->write_dcd_command.param = DCD_CHECK_BITS_SET_PARAM;
  204. break;
  205. case CMD_CHECK_BITS_CLR:
  206. d = d2;
  207. d->write_dcd_command.tag = DCD_CHECK_DATA_COMMAND_TAG;
  208. d->write_dcd_command.length = cpu_to_be16(4);
  209. d->write_dcd_command.param = DCD_CHECK_BITS_CLR_PARAM;
  210. break;
  211. default:
  212. break;
  213. }
  214. gd_last_cmd = d;
  215. }
  216. static void set_dcd_val_v2(struct imx_header *imxhdr, char *name, int lineno,
  217. int fld, uint32_t value, uint32_t off)
  218. {
  219. struct dcd_v2_cmd *d = gd_last_cmd;
  220. int len;
  221. len = be16_to_cpu(d->write_dcd_command.length);
  222. off = (len - 4) >> 3;
  223. switch (fld) {
  224. case CFG_REG_ADDRESS:
  225. d->addr_data[off].addr = cpu_to_be32(value);
  226. break;
  227. case CFG_REG_VALUE:
  228. d->addr_data[off].value = cpu_to_be32(value);
  229. off++;
  230. d->write_dcd_command.length = cpu_to_be16((off << 3) + 4);
  231. break;
  232. default:
  233. break;
  234. }
  235. }
  236. /*
  237. * Complete setting up the rest field of DCD of V1
  238. * such as barker code and DCD data length.
  239. */
  240. static void set_dcd_rst_v1(struct imx_header *imxhdr, uint32_t dcd_len,
  241. char *name, int lineno)
  242. {
  243. dcd_v1_t *dcd_v1 = &imxhdr->header.hdr_v1.dcd_table;
  244. dcd_v1->preamble.barker = DCD_BARKER;
  245. dcd_v1->preamble.length = dcd_len * sizeof(dcd_type_addr_data_t);
  246. }
  247. /*
  248. * Complete setting up the reset field of DCD of V2
  249. * such as DCD tag, version, length, etc.
  250. */
  251. static void set_dcd_rst_v2(struct imx_header *imxhdr, uint32_t dcd_len,
  252. char *name, int lineno)
  253. {
  254. if (!imxhdr->header.hdr_v2.boot_data.plugin) {
  255. dcd_v2_t *dcd_v2 = &imxhdr->header.hdr_v2.data.dcd_table;
  256. struct dcd_v2_cmd *d = gd_last_cmd;
  257. int len;
  258. if (!d)
  259. d = &dcd_v2->dcd_cmd;
  260. len = be16_to_cpu(d->write_dcd_command.length);
  261. if (len > 4)
  262. d = (struct dcd_v2_cmd *)(((char *)d) + len);
  263. len = (char *)d - (char *)&dcd_v2->header;
  264. dcd_v2->header.tag = DCD_HEADER_TAG;
  265. dcd_v2->header.length = cpu_to_be16(len);
  266. dcd_v2->header.version = DCD_VERSION;
  267. }
  268. }
  269. static void set_imx_hdr_v1(struct imx_header *imxhdr, uint32_t dcd_len,
  270. uint32_t entry_point, uint32_t flash_offset)
  271. {
  272. imx_header_v1_t *hdr_v1 = &imxhdr->header.hdr_v1;
  273. flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
  274. dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
  275. uint32_t hdr_base;
  276. uint32_t header_length = (((char *)&dcd_v1->addr_data[dcd_len].addr)
  277. - ((char *)imxhdr));
  278. /* Set magic number */
  279. fhdr_v1->app_code_barker = APP_CODE_BARKER;
  280. hdr_base = entry_point - imximage_init_loadsize + flash_offset;
  281. fhdr_v1->app_dest_ptr = hdr_base - flash_offset;
  282. fhdr_v1->app_code_jump_vector = entry_point;
  283. fhdr_v1->dcd_ptr_ptr = hdr_base + offsetof(flash_header_v1_t, dcd_ptr);
  284. fhdr_v1->dcd_ptr = hdr_base + offsetof(imx_header_v1_t, dcd_table);
  285. /* Security feature are not supported */
  286. fhdr_v1->app_code_csf = 0;
  287. fhdr_v1->super_root_key = 0;
  288. header_size_ptr = (uint32_t *)(((char *)imxhdr) + header_length - 4);
  289. }
  290. static void set_imx_hdr_v2(struct imx_header *imxhdr, uint32_t dcd_len,
  291. uint32_t entry_point, uint32_t flash_offset)
  292. {
  293. imx_header_v2_t *hdr_v2 = &imxhdr->header.hdr_v2;
  294. flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
  295. uint32_t hdr_base;
  296. /* Set magic number */
  297. fhdr_v2->header.tag = IVT_HEADER_TAG; /* 0xD1 */
  298. fhdr_v2->header.length = cpu_to_be16(sizeof(flash_header_v2_t));
  299. fhdr_v2->header.version = IVT_VERSION; /* 0x40 */
  300. if (!hdr_v2->boot_data.plugin) {
  301. fhdr_v2->entry = entry_point;
  302. fhdr_v2->reserved1 = 0;
  303. fhdr_v2->reserved1 = 0;
  304. hdr_base = entry_point - imximage_init_loadsize +
  305. flash_offset;
  306. fhdr_v2->self = hdr_base;
  307. if (dcd_len > 0)
  308. fhdr_v2->dcd_ptr = hdr_base +
  309. offsetof(imx_header_v2_t, data);
  310. else
  311. fhdr_v2->dcd_ptr = 0;
  312. fhdr_v2->boot_data_ptr = hdr_base
  313. + offsetof(imx_header_v2_t, boot_data);
  314. hdr_v2->boot_data.start = entry_point - imximage_init_loadsize;
  315. fhdr_v2->csf = 0;
  316. header_size_ptr = &hdr_v2->boot_data.size;
  317. csf_ptr = &fhdr_v2->csf;
  318. } else {
  319. imx_header_v2_t *next_hdr_v2;
  320. flash_header_v2_t *next_fhdr_v2;
  321. if (imximage_csf_size != 0) {
  322. fprintf(stderr, "Error: Header v2: SECURE_BOOT is only supported in DCD mode!");
  323. exit(EXIT_FAILURE);
  324. }
  325. fhdr_v2->entry = imximage_iram_free_start +
  326. flash_offset + sizeof(flash_header_v2_t) +
  327. sizeof(boot_data_t);
  328. fhdr_v2->reserved1 = 0;
  329. fhdr_v2->reserved2 = 0;
  330. fhdr_v2->self = imximage_iram_free_start + flash_offset;
  331. fhdr_v2->dcd_ptr = 0;
  332. fhdr_v2->boot_data_ptr = fhdr_v2->self +
  333. offsetof(imx_header_v2_t, boot_data);
  334. hdr_v2->boot_data.start = imximage_iram_free_start;
  335. /*
  336. * The actural size of plugin image is "imximage_plugin_size +
  337. * sizeof(flash_header_v2_t) + sizeof(boot_data_t)", plus the
  338. * flash_offset space.The ROM code only need to copy this size
  339. * to run the plugin code. However, later when copy the whole
  340. * U-Boot image to DDR, the ROM code use memcpy to copy the
  341. * first part of the image, and use the storage read function
  342. * to get the remaining part. This requires the dividing point
  343. * must be multiple of storage sector size. Here we set the
  344. * first section to be MAX_PLUGIN_CODE_SIZE(64KB) for this
  345. * purpose.
  346. */
  347. hdr_v2->boot_data.size = MAX_PLUGIN_CODE_SIZE;
  348. /* Security feature are not supported */
  349. fhdr_v2->csf = 0;
  350. next_hdr_v2 = (imx_header_v2_t *)((char *)hdr_v2 +
  351. imximage_plugin_size);
  352. next_fhdr_v2 = &next_hdr_v2->fhdr;
  353. next_fhdr_v2->header.tag = IVT_HEADER_TAG; /* 0xD1 */
  354. next_fhdr_v2->header.length =
  355. cpu_to_be16(sizeof(flash_header_v2_t));
  356. next_fhdr_v2->header.version = IVT_VERSION; /* 0x40 */
  357. next_fhdr_v2->entry = entry_point;
  358. hdr_base = entry_point - sizeof(struct imx_header);
  359. next_fhdr_v2->reserved1 = 0;
  360. next_fhdr_v2->reserved2 = 0;
  361. next_fhdr_v2->self = hdr_base + imximage_plugin_size;
  362. next_fhdr_v2->dcd_ptr = 0;
  363. next_fhdr_v2->boot_data_ptr = next_fhdr_v2->self +
  364. offsetof(imx_header_v2_t, boot_data);
  365. next_hdr_v2->boot_data.start = hdr_base - flash_offset;
  366. header_size_ptr = &next_hdr_v2->boot_data.size;
  367. next_hdr_v2->boot_data.plugin = 0;
  368. next_fhdr_v2->csf = 0;
  369. }
  370. }
  371. static void set_hdr_func(void)
  372. {
  373. switch (imximage_version) {
  374. case IMXIMAGE_V1:
  375. set_dcd_val = set_dcd_val_v1;
  376. set_dcd_param = NULL;
  377. set_dcd_rst = set_dcd_rst_v1;
  378. set_imx_hdr = set_imx_hdr_v1;
  379. max_dcd_entries = MAX_HW_CFG_SIZE_V1;
  380. break;
  381. case IMXIMAGE_V2:
  382. gd_last_cmd = NULL;
  383. set_dcd_val = set_dcd_val_v2;
  384. set_dcd_param = set_dcd_param_v2;
  385. set_dcd_rst = set_dcd_rst_v2;
  386. set_imx_hdr = set_imx_hdr_v2;
  387. max_dcd_entries = MAX_HW_CFG_SIZE_V2;
  388. break;
  389. default:
  390. err_imximage_version(imximage_version);
  391. break;
  392. }
  393. }
  394. static void print_hdr_v1(struct imx_header *imx_hdr)
  395. {
  396. imx_header_v1_t *hdr_v1 = &imx_hdr->header.hdr_v1;
  397. flash_header_v1_t *fhdr_v1 = &hdr_v1->fhdr;
  398. dcd_v1_t *dcd_v1 = &hdr_v1->dcd_table;
  399. uint32_t size, length, ver;
  400. size = dcd_v1->preamble.length;
  401. if (size > (MAX_HW_CFG_SIZE_V1 * sizeof(dcd_type_addr_data_t))) {
  402. fprintf(stderr,
  403. "Error: Image corrupt DCD size %d exceed maximum %d\n",
  404. (uint32_t)(size / sizeof(dcd_type_addr_data_t)),
  405. MAX_HW_CFG_SIZE_V1);
  406. exit(EXIT_FAILURE);
  407. }
  408. length = dcd_v1->preamble.length / sizeof(dcd_type_addr_data_t);
  409. ver = detect_imximage_version(imx_hdr);
  410. printf("Image Type: Freescale IMX Boot Image\n");
  411. printf("Image Ver: %x", ver);
  412. printf("%s\n", get_table_entry_name(imximage_versions, NULL, ver));
  413. printf("Data Size: ");
  414. genimg_print_size(dcd_v1->addr_data[length].type);
  415. printf("Load Address: %08x\n", (uint32_t)fhdr_v1->app_dest_ptr);
  416. printf("Entry Point: %08x\n", (uint32_t)fhdr_v1->app_code_jump_vector);
  417. }
  418. static void print_hdr_v2(struct imx_header *imx_hdr)
  419. {
  420. imx_header_v2_t *hdr_v2 = &imx_hdr->header.hdr_v2;
  421. flash_header_v2_t *fhdr_v2 = &hdr_v2->fhdr;
  422. dcd_v2_t *dcd_v2 = &hdr_v2->data.dcd_table;
  423. uint32_t size, version, plugin;
  424. plugin = hdr_v2->boot_data.plugin;
  425. if (!plugin) {
  426. size = be16_to_cpu(dcd_v2->header.length);
  427. if (size > (MAX_HW_CFG_SIZE_V2 * sizeof(dcd_addr_data_t))) {
  428. fprintf(stderr,
  429. "Error: Image corrupt DCD size %d exceed maximum %d\n",
  430. (uint32_t)(size / sizeof(dcd_addr_data_t)),
  431. MAX_HW_CFG_SIZE_V2);
  432. exit(EXIT_FAILURE);
  433. }
  434. }
  435. version = detect_imximage_version(imx_hdr);
  436. printf("Image Type: Freescale IMX Boot Image\n");
  437. printf("Image Ver: %x", version);
  438. printf("%s\n", get_table_entry_name(imximage_versions, NULL, version));
  439. printf("Mode: %s\n", plugin ? "PLUGIN" : "DCD");
  440. if (!plugin) {
  441. printf("Data Size: ");
  442. genimg_print_size(hdr_v2->boot_data.size);
  443. printf("Load Address: %08x\n", (uint32_t)fhdr_v2->boot_data_ptr);
  444. printf("Entry Point: %08x\n", (uint32_t)fhdr_v2->entry);
  445. if (fhdr_v2->csf) {
  446. uint16_t dcdlen;
  447. int offs;
  448. dcdlen = hdr_v2->data.dcd_table.header.length;
  449. offs = (char *)&hdr_v2->data.dcd_table
  450. - (char *)hdr_v2;
  451. /*
  452. * The HAB block is the first part of the image, from
  453. * start of IVT header (fhdr_v2->self) to the start of
  454. * the CSF block (fhdr_v2->csf). So HAB size is
  455. * calculated as:
  456. * HAB_size = fhdr_v2->csf - fhdr_v2->self
  457. */
  458. printf("HAB Blocks: 0x%08x 0x%08x 0x%08x\n",
  459. (uint32_t)fhdr_v2->self, 0,
  460. (uint32_t)(fhdr_v2->csf - fhdr_v2->self));
  461. printf("DCD Blocks: 0x%08x 0x%08x 0x%08x\n",
  462. CONFIG_IMX_DCD_ADDR, offs, be16_to_cpu(dcdlen));
  463. }
  464. } else {
  465. imx_header_v2_t *next_hdr_v2;
  466. flash_header_v2_t *next_fhdr_v2;
  467. /*First Header*/
  468. printf("Plugin Data Size: ");
  469. genimg_print_size(hdr_v2->boot_data.size);
  470. printf("Plugin Code Size: ");
  471. genimg_print_size(imximage_plugin_size);
  472. printf("Plugin Load Address: %08x\n", hdr_v2->boot_data.start);
  473. printf("Plugin Entry Point: %08x\n", (uint32_t)fhdr_v2->entry);
  474. /*Second Header*/
  475. next_hdr_v2 = (imx_header_v2_t *)((char *)hdr_v2 +
  476. imximage_plugin_size);
  477. next_fhdr_v2 = &next_hdr_v2->fhdr;
  478. printf("U-Boot Data Size: ");
  479. genimg_print_size(next_hdr_v2->boot_data.size);
  480. printf("U-Boot Load Address: %08x\n",
  481. next_hdr_v2->boot_data.start);
  482. printf("U-Boot Entry Point: %08x\n",
  483. (uint32_t)next_fhdr_v2->entry);
  484. }
  485. }
  486. static void copy_plugin_code(struct imx_header *imxhdr, char *plugin_file)
  487. {
  488. int ifd;
  489. struct stat sbuf;
  490. char *plugin_buf = imxhdr->header.hdr_v2.data.plugin_code;
  491. char *ptr;
  492. ifd = open(plugin_file, O_RDONLY|O_BINARY);
  493. if (ifd < 0) {
  494. fprintf(stderr, "Can't open %s: %s\n",
  495. plugin_file,
  496. strerror(errno));
  497. exit(EXIT_FAILURE);
  498. }
  499. if (fstat(ifd, &sbuf) < 0) {
  500. fprintf(stderr, "Can't stat %s: %s\n",
  501. plugin_file,
  502. strerror(errno));
  503. exit(EXIT_FAILURE);
  504. }
  505. ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
  506. if (ptr == MAP_FAILED) {
  507. fprintf(stderr, "Can't read %s: %s\n",
  508. plugin_file,
  509. strerror(errno));
  510. exit(EXIT_FAILURE);
  511. }
  512. if (sbuf.st_size > MAX_PLUGIN_CODE_SIZE) {
  513. printf("plugin binary size too large\n");
  514. exit(EXIT_FAILURE);
  515. }
  516. memcpy(plugin_buf, ptr, sbuf.st_size);
  517. imximage_plugin_size = sbuf.st_size;
  518. (void) munmap((void *)ptr, sbuf.st_size);
  519. (void) close(ifd);
  520. imxhdr->header.hdr_v2.boot_data.plugin = 1;
  521. }
  522. static void parse_cfg_cmd(struct imx_header *imxhdr, int32_t cmd, char *token,
  523. char *name, int lineno, int fld, int dcd_len)
  524. {
  525. int value;
  526. static int cmd_ver_first = ~0;
  527. switch (cmd) {
  528. case CMD_IMAGE_VERSION:
  529. imximage_version = get_cfg_value(token, name, lineno);
  530. if (cmd_ver_first == 0) {
  531. fprintf(stderr, "Error: %s[%d] - IMAGE_VERSION "
  532. "command need be the first before other "
  533. "valid command in the file\n", name, lineno);
  534. exit(EXIT_FAILURE);
  535. }
  536. cmd_ver_first = 1;
  537. set_hdr_func();
  538. break;
  539. case CMD_BOOT_FROM:
  540. imximage_ivt_offset = get_table_entry_id(imximage_boot_offset,
  541. "imximage boot option", token);
  542. if (imximage_ivt_offset == -1) {
  543. fprintf(stderr, "Error: %s[%d] -Invalid boot device"
  544. "(%s)\n", name, lineno, token);
  545. exit(EXIT_FAILURE);
  546. }
  547. imximage_init_loadsize =
  548. get_table_entry_id(imximage_boot_loadsize,
  549. "imximage boot option", token);
  550. if (imximage_init_loadsize == -1) {
  551. fprintf(stderr,
  552. "Error: %s[%d] -Invalid boot device(%s)\n",
  553. name, lineno, token);
  554. exit(EXIT_FAILURE);
  555. }
  556. /*
  557. * The SOC loads from the storage starting at address 0
  558. * then ensures that the load size contains the offset
  559. */
  560. if (imximage_init_loadsize < imximage_ivt_offset)
  561. imximage_init_loadsize = imximage_ivt_offset;
  562. if (unlikely(cmd_ver_first != 1))
  563. cmd_ver_first = 0;
  564. break;
  565. case CMD_BOOT_OFFSET:
  566. imximage_ivt_offset = get_cfg_value(token, name, lineno);
  567. if (unlikely(cmd_ver_first != 1))
  568. cmd_ver_first = 0;
  569. break;
  570. case CMD_WRITE_DATA:
  571. case CMD_WRITE_CLR_BIT:
  572. case CMD_WRITE_SET_BIT:
  573. case CMD_CHECK_BITS_SET:
  574. case CMD_CHECK_BITS_CLR:
  575. value = get_cfg_value(token, name, lineno);
  576. if (set_dcd_param)
  577. (*set_dcd_param)(imxhdr, dcd_len, cmd);
  578. (*set_dcd_val)(imxhdr, name, lineno, fld, value, dcd_len);
  579. if (unlikely(cmd_ver_first != 1))
  580. cmd_ver_first = 0;
  581. break;
  582. case CMD_CSF:
  583. if (imximage_version != 2) {
  584. fprintf(stderr,
  585. "Error: %s[%d] - CSF only supported for VERSION 2(%s)\n",
  586. name, lineno, token);
  587. exit(EXIT_FAILURE);
  588. }
  589. imximage_csf_size = get_cfg_value(token, name, lineno);
  590. if (unlikely(cmd_ver_first != 1))
  591. cmd_ver_first = 0;
  592. break;
  593. case CMD_PLUGIN:
  594. plugin_image = 1;
  595. copy_plugin_code(imxhdr, token);
  596. break;
  597. }
  598. }
  599. static void parse_cfg_fld(struct imx_header *imxhdr, int32_t *cmd,
  600. char *token, char *name, int lineno, int fld, int *dcd_len)
  601. {
  602. int value;
  603. switch (fld) {
  604. case CFG_COMMAND:
  605. *cmd = get_table_entry_id(imximage_cmds,
  606. "imximage commands", token);
  607. if (*cmd < 0) {
  608. fprintf(stderr, "Error: %s[%d] - Invalid command"
  609. "(%s)\n", name, lineno, token);
  610. exit(EXIT_FAILURE);
  611. }
  612. break;
  613. case CFG_REG_SIZE:
  614. parse_cfg_cmd(imxhdr, *cmd, token, name, lineno, fld, *dcd_len);
  615. break;
  616. case CFG_REG_ADDRESS:
  617. case CFG_REG_VALUE:
  618. switch(*cmd) {
  619. case CMD_WRITE_DATA:
  620. case CMD_WRITE_CLR_BIT:
  621. case CMD_WRITE_SET_BIT:
  622. case CMD_CHECK_BITS_SET:
  623. case CMD_CHECK_BITS_CLR:
  624. value = get_cfg_value(token, name, lineno);
  625. if (set_dcd_param)
  626. (*set_dcd_param)(imxhdr, *dcd_len, *cmd);
  627. (*set_dcd_val)(imxhdr, name, lineno, fld, value,
  628. *dcd_len);
  629. if (fld == CFG_REG_VALUE) {
  630. (*dcd_len)++;
  631. if (*dcd_len > max_dcd_entries) {
  632. fprintf(stderr, "Error: %s[%d] -"
  633. "DCD table exceeds maximum size(%d)\n",
  634. name, lineno, max_dcd_entries);
  635. exit(EXIT_FAILURE);
  636. }
  637. }
  638. break;
  639. case CMD_PLUGIN:
  640. value = get_cfg_value(token, name, lineno);
  641. imximage_iram_free_start = value;
  642. break;
  643. default:
  644. break;
  645. }
  646. break;
  647. default:
  648. break;
  649. }
  650. }
  651. static uint32_t parse_cfg_file(struct imx_header *imxhdr, char *name)
  652. {
  653. FILE *fd = NULL;
  654. char *line = NULL;
  655. char *token, *saveptr1, *saveptr2;
  656. int lineno = 0;
  657. int fld;
  658. size_t len;
  659. int dcd_len = 0;
  660. int32_t cmd;
  661. fd = fopen(name, "r");
  662. if (fd == 0) {
  663. fprintf(stderr, "Error: %s - Can't open DCD file\n", name);
  664. exit(EXIT_FAILURE);
  665. }
  666. /*
  667. * Very simple parsing, line starting with # are comments
  668. * and are dropped
  669. */
  670. while ((getline(&line, &len, fd)) > 0) {
  671. lineno++;
  672. token = strtok_r(line, "\r\n", &saveptr1);
  673. if (token == NULL)
  674. continue;
  675. /* Check inside the single line */
  676. for (fld = CFG_COMMAND, cmd = CMD_INVALID,
  677. line = token; ; line = NULL, fld++) {
  678. token = strtok_r(line, " \t", &saveptr2);
  679. if (token == NULL)
  680. break;
  681. /* Drop all text starting with '#' as comments */
  682. if (token[0] == '#')
  683. break;
  684. parse_cfg_fld(imxhdr, &cmd, token, name,
  685. lineno, fld, &dcd_len);
  686. }
  687. }
  688. (*set_dcd_rst)(imxhdr, dcd_len, name, lineno);
  689. fclose(fd);
  690. /* Exit if there is no BOOT_FROM field specifying the flash_offset */
  691. if (imximage_ivt_offset == FLASH_OFFSET_UNDEFINED) {
  692. fprintf(stderr, "Error: No BOOT_FROM tag in %s\n", name);
  693. exit(EXIT_FAILURE);
  694. }
  695. return dcd_len;
  696. }
  697. static int imximage_check_image_types(uint8_t type)
  698. {
  699. if (type == IH_TYPE_IMXIMAGE)
  700. return EXIT_SUCCESS;
  701. else
  702. return EXIT_FAILURE;
  703. }
  704. static int imximage_verify_header(unsigned char *ptr, int image_size,
  705. struct image_tool_params *params)
  706. {
  707. struct imx_header *imx_hdr = (struct imx_header *) ptr;
  708. if (detect_imximage_version(imx_hdr) == IMXIMAGE_VER_INVALID)
  709. return -FDT_ERR_BADSTRUCTURE;
  710. return 0;
  711. }
  712. static void imximage_print_header(const void *ptr)
  713. {
  714. struct imx_header *imx_hdr = (struct imx_header *) ptr;
  715. uint32_t version = detect_imximage_version(imx_hdr);
  716. switch (version) {
  717. case IMXIMAGE_V1:
  718. print_hdr_v1(imx_hdr);
  719. break;
  720. case IMXIMAGE_V2:
  721. print_hdr_v2(imx_hdr);
  722. break;
  723. default:
  724. err_imximage_version(version);
  725. break;
  726. }
  727. }
  728. static void imximage_set_header(void *ptr, struct stat *sbuf, int ifd,
  729. struct image_tool_params *params)
  730. {
  731. struct imx_header *imxhdr = (struct imx_header *)ptr;
  732. uint32_t dcd_len;
  733. uint32_t header_size;
  734. /*
  735. * In order to not change the old imx cfg file
  736. * by adding VERSION command into it, here need
  737. * set up function ptr group to V1 by default.
  738. */
  739. imximage_version = IMXIMAGE_V1;
  740. /* Be able to detect if the cfg file has no BOOT_FROM tag */
  741. imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
  742. imximage_csf_size = 0;
  743. set_hdr_func();
  744. /* Parse dcd configuration file */
  745. dcd_len = parse_cfg_file(imxhdr, params->imagename);
  746. if (imximage_version == IMXIMAGE_V1)
  747. header_size = sizeof(flash_header_v1_t);
  748. else {
  749. header_size = sizeof(flash_header_v2_t) + sizeof(boot_data_t);
  750. if (!plugin_image)
  751. header_size += sizeof(dcd_v2_t);
  752. else
  753. header_size += MAX_PLUGIN_CODE_SIZE;
  754. }
  755. if (imximage_init_loadsize < imximage_ivt_offset + header_size)
  756. imximage_init_loadsize = imximage_ivt_offset + header_size;
  757. /* Set the imx header */
  758. (*set_imx_hdr)(imxhdr, dcd_len, params->ep, imximage_ivt_offset);
  759. /*
  760. * ROM bug alert
  761. *
  762. * MX53 only loads 512 byte multiples in case of SD boot.
  763. * MX53 only loads NAND page multiples in case of NAND boot and
  764. * supports up to 4096 byte large pages, thus align to 4096.
  765. *
  766. * The remaining fraction of a block bytes would not be loaded!
  767. */
  768. *header_size_ptr = ROUND((sbuf->st_size + imximage_ivt_offset), 4096);
  769. if (csf_ptr && imximage_csf_size) {
  770. *csf_ptr = params->ep - imximage_init_loadsize +
  771. *header_size_ptr;
  772. *header_size_ptr += imximage_csf_size;
  773. }
  774. }
  775. int imximage_check_params(struct image_tool_params *params)
  776. {
  777. if (!params)
  778. return CFG_INVALID;
  779. if (!strlen(params->imagename)) {
  780. fprintf(stderr, "Error: %s - Configuration file not specified, "
  781. "it is needed for imximage generation\n",
  782. params->cmdname);
  783. return CFG_INVALID;
  784. }
  785. /*
  786. * Check parameters:
  787. * XIP is not allowed and verify that incompatible
  788. * parameters are not sent at the same time
  789. * For example, if list is required a data image must not be provided
  790. */
  791. return (params->dflag && (params->fflag || params->lflag)) ||
  792. (params->fflag && (params->dflag || params->lflag)) ||
  793. (params->lflag && (params->dflag || params->fflag)) ||
  794. (params->xflag) || !(strlen(params->imagename));
  795. }
  796. static int imximage_generate(struct image_tool_params *params,
  797. struct image_type_params *tparams)
  798. {
  799. struct imx_header *imxhdr;
  800. size_t alloc_len;
  801. struct stat sbuf;
  802. char *datafile = params->datafile;
  803. uint32_t pad_len, header_size;
  804. memset(&imximage_header, 0, sizeof(imximage_header));
  805. /*
  806. * In order to not change the old imx cfg file
  807. * by adding VERSION command into it, here need
  808. * set up function ptr group to V1 by default.
  809. */
  810. imximage_version = IMXIMAGE_V1;
  811. /* Be able to detect if the cfg file has no BOOT_FROM tag */
  812. imximage_ivt_offset = FLASH_OFFSET_UNDEFINED;
  813. imximage_csf_size = 0;
  814. set_hdr_func();
  815. /* Parse dcd configuration file */
  816. parse_cfg_file(&imximage_header, params->imagename);
  817. if (imximage_version == IMXIMAGE_V1)
  818. header_size = sizeof(imx_header_v1_t);
  819. else {
  820. header_size = sizeof(flash_header_v2_t) + sizeof(boot_data_t);
  821. if (!plugin_image)
  822. header_size += sizeof(dcd_v2_t);
  823. else
  824. header_size += MAX_PLUGIN_CODE_SIZE;
  825. }
  826. if (imximage_init_loadsize < imximage_ivt_offset + header_size)
  827. imximage_init_loadsize = imximage_ivt_offset + header_size;
  828. alloc_len = imximage_init_loadsize - imximage_ivt_offset;
  829. if (alloc_len < header_size) {
  830. fprintf(stderr, "%s: header error\n",
  831. params->cmdname);
  832. exit(EXIT_FAILURE);
  833. }
  834. imxhdr = malloc(alloc_len);
  835. if (!imxhdr) {
  836. fprintf(stderr, "%s: malloc return failure: %s\n",
  837. params->cmdname, strerror(errno));
  838. exit(EXIT_FAILURE);
  839. }
  840. memset(imxhdr, 0, alloc_len);
  841. tparams->header_size = alloc_len;
  842. tparams->hdr = imxhdr;
  843. /* determine data image file length */
  844. if (stat(datafile, &sbuf) < 0) {
  845. fprintf(stderr, "%s: Can't stat %s: %s\n",
  846. params->cmdname, datafile, strerror(errno));
  847. exit(EXIT_FAILURE);
  848. }
  849. pad_len = ROUND(sbuf.st_size, 4096) - sbuf.st_size;
  850. return pad_len;
  851. }
  852. /*
  853. * imximage parameters
  854. */
  855. U_BOOT_IMAGE_TYPE(
  856. imximage,
  857. "Freescale i.MX Boot Image support",
  858. 0,
  859. NULL,
  860. imximage_check_params,
  861. imximage_verify_header,
  862. imximage_print_header,
  863. imximage_set_header,
  864. NULL,
  865. imximage_check_image_types,
  866. NULL,
  867. imximage_generate
  868. );