imximage.c 21 KB

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