image.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
  1. /*
  2. * (C) Copyright 2008 Semihalf
  3. *
  4. * (C) Copyright 2000-2005
  5. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  6. *
  7. * See file CREDITS for list of people who contributed to this
  8. * project.
  9. *
  10. * This program is free software; you can redistribute it and/or
  11. * modify it under the terms of the GNU General Public License as
  12. * published by the Free Software Foundation; either version 2 of
  13. * the License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU General Public License
  21. * along with this program; if not, write to the Free Software
  22. * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  23. * MA 02111-1307 USA
  24. *
  25. ********************************************************************
  26. * NOTE: This header file defines an interface to U-Boot. Including
  27. * this (unmodified) header file in another file is considered normal
  28. * use of U-Boot, and does *not* fall under the heading of "derived
  29. * work".
  30. ********************************************************************
  31. */
  32. #ifndef __IMAGE_H__
  33. #define __IMAGE_H__
  34. #include "compiler.h"
  35. #include <asm/byteorder.h>
  36. /* Define this to avoid #ifdefs later on */
  37. struct lmb;
  38. #ifdef USE_HOSTCC
  39. /* new uImage format support enabled on host */
  40. #define CONFIG_FIT 1
  41. #define CONFIG_OF_LIBFDT 1
  42. #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
  43. #define IMAGE_ENABLE_IGNORE 0
  44. #define IMAGE_INDENT_STRING ""
  45. #else
  46. #include <lmb.h>
  47. #include <asm/u-boot.h>
  48. #include <command.h>
  49. /* Take notice of the 'ignore' property for hashes */
  50. #define IMAGE_ENABLE_IGNORE 1
  51. #define IMAGE_INDENT_STRING " "
  52. #endif /* USE_HOSTCC */
  53. #if defined(CONFIG_FIT)
  54. #include <libfdt.h>
  55. #include <fdt_support.h>
  56. # ifdef CONFIG_SPL_BUILD
  57. # ifdef CONFIG_SPL_CRC32_SUPPORT
  58. # define IMAGE_ENABLE_CRC32 1
  59. # endif
  60. # ifdef CONFIG_SPL_MD5_SUPPORT
  61. # define IMAGE_ENABLE_MD5 1
  62. # endif
  63. # ifdef CONFIG_SPL_SHA1_SUPPORT
  64. # define IMAGE_ENABLE_SHA1 1
  65. # endif
  66. # else
  67. # define CONFIG_CRC32 /* FIT images need CRC32 support */
  68. # define CONFIG_MD5 /* and MD5 */
  69. # define CONFIG_SHA1 /* and SHA1 */
  70. # define IMAGE_ENABLE_CRC32 1
  71. # define IMAGE_ENABLE_MD5 1
  72. # define IMAGE_ENABLE_SHA1 1
  73. # endif
  74. #ifndef IMAGE_ENABLE_CRC32
  75. #define IMAGE_ENABLE_CRC32 0
  76. #endif
  77. #ifndef IMAGE_ENABLE_MD5
  78. #define IMAGE_ENABLE_MD5 0
  79. #endif
  80. #ifndef IMAGE_ENABLE_SHA1
  81. #define IMAGE_ENABLE_SHA1 0
  82. #endif
  83. #endif /* CONFIG_FIT */
  84. #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
  85. # define IMAGE_ENABLE_RAMDISK_HIGH 1
  86. #else
  87. # define IMAGE_ENABLE_RAMDISK_HIGH 0
  88. #endif
  89. #ifdef CONFIG_OF_LIBFDT
  90. # define IMAGE_ENABLE_OF_LIBFDT 1
  91. #else
  92. # define IMAGE_ENABLE_OF_LIBFDT 0
  93. #endif
  94. #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
  95. # define IMAGE_BOOT_GET_CMDLINE 1
  96. #else
  97. # define IMAGE_BOOT_GET_CMDLINE 0
  98. #endif
  99. #ifdef CONFIG_OF_BOARD_SETUP
  100. # define IMAAGE_OF_BOARD_SETUP 1
  101. #else
  102. # define IMAAGE_OF_BOARD_SETUP 0
  103. #endif
  104. /*
  105. * Operating System Codes
  106. */
  107. #define IH_OS_INVALID 0 /* Invalid OS */
  108. #define IH_OS_OPENBSD 1 /* OpenBSD */
  109. #define IH_OS_NETBSD 2 /* NetBSD */
  110. #define IH_OS_FREEBSD 3 /* FreeBSD */
  111. #define IH_OS_4_4BSD 4 /* 4.4BSD */
  112. #define IH_OS_LINUX 5 /* Linux */
  113. #define IH_OS_SVR4 6 /* SVR4 */
  114. #define IH_OS_ESIX 7 /* Esix */
  115. #define IH_OS_SOLARIS 8 /* Solaris */
  116. #define IH_OS_IRIX 9 /* Irix */
  117. #define IH_OS_SCO 10 /* SCO */
  118. #define IH_OS_DELL 11 /* Dell */
  119. #define IH_OS_NCR 12 /* NCR */
  120. #define IH_OS_LYNXOS 13 /* LynxOS */
  121. #define IH_OS_VXWORKS 14 /* VxWorks */
  122. #define IH_OS_PSOS 15 /* pSOS */
  123. #define IH_OS_QNX 16 /* QNX */
  124. #define IH_OS_U_BOOT 17 /* Firmware */
  125. #define IH_OS_RTEMS 18 /* RTEMS */
  126. #define IH_OS_ARTOS 19 /* ARTOS */
  127. #define IH_OS_UNITY 20 /* Unity OS */
  128. #define IH_OS_INTEGRITY 21 /* INTEGRITY */
  129. #define IH_OS_OSE 22 /* OSE */
  130. #define IH_OS_PLAN9 23 /* Plan 9 */
  131. /*
  132. * CPU Architecture Codes (supported by Linux)
  133. */
  134. #define IH_ARCH_INVALID 0 /* Invalid CPU */
  135. #define IH_ARCH_ALPHA 1 /* Alpha */
  136. #define IH_ARCH_ARM 2 /* ARM */
  137. #define IH_ARCH_I386 3 /* Intel x86 */
  138. #define IH_ARCH_IA64 4 /* IA64 */
  139. #define IH_ARCH_MIPS 5 /* MIPS */
  140. #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
  141. #define IH_ARCH_PPC 7 /* PowerPC */
  142. #define IH_ARCH_S390 8 /* IBM S390 */
  143. #define IH_ARCH_SH 9 /* SuperH */
  144. #define IH_ARCH_SPARC 10 /* Sparc */
  145. #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
  146. #define IH_ARCH_M68K 12 /* M68K */
  147. #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
  148. #define IH_ARCH_NIOS2 15 /* Nios-II */
  149. #define IH_ARCH_BLACKFIN 16 /* Blackfin */
  150. #define IH_ARCH_AVR32 17 /* AVR32 */
  151. #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
  152. #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
  153. #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
  154. #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
  155. /*
  156. * Image Types
  157. *
  158. * "Standalone Programs" are directly runnable in the environment
  159. * provided by U-Boot; it is expected that (if they behave
  160. * well) you can continue to work in U-Boot after return from
  161. * the Standalone Program.
  162. * "OS Kernel Images" are usually images of some Embedded OS which
  163. * will take over control completely. Usually these programs
  164. * will install their own set of exception handlers, device
  165. * drivers, set up the MMU, etc. - this means, that you cannot
  166. * expect to re-enter U-Boot except by resetting the CPU.
  167. * "RAMDisk Images" are more or less just data blocks, and their
  168. * parameters (address, size) are passed to an OS kernel that is
  169. * being started.
  170. * "Multi-File Images" contain several images, typically an OS
  171. * (Linux) kernel image and one or more data images like
  172. * RAMDisks. This construct is useful for instance when you want
  173. * to boot over the network using BOOTP etc., where the boot
  174. * server provides just a single image file, but you want to get
  175. * for instance an OS kernel and a RAMDisk image.
  176. *
  177. * "Multi-File Images" start with a list of image sizes, each
  178. * image size (in bytes) specified by an "uint32_t" in network
  179. * byte order. This list is terminated by an "(uint32_t)0".
  180. * Immediately after the terminating 0 follow the images, one by
  181. * one, all aligned on "uint32_t" boundaries (size rounded up to
  182. * a multiple of 4 bytes - except for the last file).
  183. *
  184. * "Firmware Images" are binary images containing firmware (like
  185. * U-Boot or FPGA images) which usually will be programmed to
  186. * flash memory.
  187. *
  188. * "Script files" are command sequences that will be executed by
  189. * U-Boot's command interpreter; this feature is especially
  190. * useful when you configure U-Boot to use a real shell (hush)
  191. * as command interpreter (=> Shell Scripts).
  192. */
  193. #define IH_TYPE_INVALID 0 /* Invalid Image */
  194. #define IH_TYPE_STANDALONE 1 /* Standalone Program */
  195. #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
  196. #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
  197. #define IH_TYPE_MULTI 4 /* Multi-File Image */
  198. #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
  199. #define IH_TYPE_SCRIPT 6 /* Script file */
  200. #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
  201. #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
  202. #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
  203. #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
  204. #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
  205. #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
  206. #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
  207. #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
  208. #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
  209. /*
  210. * Compression Types
  211. */
  212. #define IH_COMP_NONE 0 /* No Compression Used */
  213. #define IH_COMP_GZIP 1 /* gzip Compression Used */
  214. #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
  215. #define IH_COMP_LZMA 3 /* lzma Compression Used */
  216. #define IH_COMP_LZO 4 /* lzo Compression Used */
  217. #define IH_MAGIC 0x27051956 /* Image Magic Number */
  218. #define IH_NMLEN 32 /* Image Name Length */
  219. /* Reused from common.h */
  220. #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
  221. /*
  222. * Legacy format image header,
  223. * all data in network byte order (aka natural aka bigendian).
  224. */
  225. typedef struct image_header {
  226. __be32 ih_magic; /* Image Header Magic Number */
  227. __be32 ih_hcrc; /* Image Header CRC Checksum */
  228. __be32 ih_time; /* Image Creation Timestamp */
  229. __be32 ih_size; /* Image Data Size */
  230. __be32 ih_load; /* Data Load Address */
  231. __be32 ih_ep; /* Entry Point Address */
  232. __be32 ih_dcrc; /* Image Data CRC Checksum */
  233. uint8_t ih_os; /* Operating System */
  234. uint8_t ih_arch; /* CPU architecture */
  235. uint8_t ih_type; /* Image Type */
  236. uint8_t ih_comp; /* Compression Type */
  237. uint8_t ih_name[IH_NMLEN]; /* Image Name */
  238. } image_header_t;
  239. typedef struct image_info {
  240. ulong start, end; /* start/end of blob */
  241. ulong image_start, image_len; /* start of image within blob, len of image */
  242. ulong load; /* load addr for the image */
  243. uint8_t comp, type, os; /* compression, type of image, os type */
  244. } image_info_t;
  245. /*
  246. * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
  247. * routines.
  248. */
  249. typedef struct bootm_headers {
  250. /*
  251. * Legacy os image header, if it is a multi component image
  252. * then boot_get_ramdisk() and get_fdt() will attempt to get
  253. * data from second and third component accordingly.
  254. */
  255. image_header_t *legacy_hdr_os; /* image header pointer */
  256. image_header_t legacy_hdr_os_copy; /* header copy */
  257. ulong legacy_hdr_valid;
  258. #if defined(CONFIG_FIT)
  259. const char *fit_uname_cfg; /* configuration node unit name */
  260. void *fit_hdr_os; /* os FIT image header */
  261. const char *fit_uname_os; /* os subimage node unit name */
  262. int fit_noffset_os; /* os subimage node offset */
  263. void *fit_hdr_rd; /* init ramdisk FIT image header */
  264. const char *fit_uname_rd; /* init ramdisk subimage node unit name */
  265. int fit_noffset_rd; /* init ramdisk subimage node offset */
  266. void *fit_hdr_fdt; /* FDT blob FIT image header */
  267. const char *fit_uname_fdt; /* FDT blob subimage node unit name */
  268. int fit_noffset_fdt;/* FDT blob subimage node offset */
  269. #endif
  270. #ifndef USE_HOSTCC
  271. image_info_t os; /* os image info */
  272. ulong ep; /* entry point of OS */
  273. ulong rd_start, rd_end;/* ramdisk start/end */
  274. char *ft_addr; /* flat dev tree address */
  275. ulong ft_len; /* length of flat device tree */
  276. ulong initrd_start;
  277. ulong initrd_end;
  278. ulong cmdline_start;
  279. ulong cmdline_end;
  280. bd_t *kbd;
  281. #endif
  282. int verify; /* getenv("verify")[0] != 'n' */
  283. #define BOOTM_STATE_START (0x00000001)
  284. #define BOOTM_STATE_LOADOS (0x00000002)
  285. #define BOOTM_STATE_RAMDISK (0x00000004)
  286. #define BOOTM_STATE_FDT (0x00000008)
  287. #define BOOTM_STATE_OS_CMDLINE (0x00000010)
  288. #define BOOTM_STATE_OS_BD_T (0x00000020)
  289. #define BOOTM_STATE_OS_PREP (0x00000040)
  290. #define BOOTM_STATE_OS_GO (0x00000080)
  291. int state;
  292. #ifdef CONFIG_LMB
  293. struct lmb lmb; /* for memory mgmt */
  294. #endif
  295. } bootm_headers_t;
  296. extern bootm_headers_t images;
  297. /*
  298. * Some systems (for example LWMON) have very short watchdog periods;
  299. * we must make sure to split long operations like memmove() or
  300. * checksum calculations into reasonable chunks.
  301. */
  302. #ifndef CHUNKSZ
  303. #define CHUNKSZ (64 * 1024)
  304. #endif
  305. #ifndef CHUNKSZ_CRC32
  306. #define CHUNKSZ_CRC32 (64 * 1024)
  307. #endif
  308. #ifndef CHUNKSZ_MD5
  309. #define CHUNKSZ_MD5 (64 * 1024)
  310. #endif
  311. #ifndef CHUNKSZ_SHA1
  312. #define CHUNKSZ_SHA1 (64 * 1024)
  313. #endif
  314. #define uimage_to_cpu(x) be32_to_cpu(x)
  315. #define cpu_to_uimage(x) cpu_to_be32(x)
  316. /*
  317. * Translation table for entries of a specific type; used by
  318. * get_table_entry_id() and get_table_entry_name().
  319. */
  320. typedef struct table_entry {
  321. int id;
  322. char *sname; /* short (input) name to find table entry */
  323. char *lname; /* long (output) name to print for messages */
  324. } table_entry_t;
  325. /*
  326. * get_table_entry_id() scans the translation table trying to find an
  327. * entry that matches the given short name. If a matching entry is
  328. * found, it's id is returned to the caller.
  329. */
  330. int get_table_entry_id(const table_entry_t *table,
  331. const char *table_name, const char *name);
  332. /*
  333. * get_table_entry_name() scans the translation table trying to find
  334. * an entry that matches the given id. If a matching entry is found,
  335. * its long name is returned to the caller.
  336. */
  337. char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
  338. const char *genimg_get_os_name(uint8_t os);
  339. const char *genimg_get_arch_name(uint8_t arch);
  340. const char *genimg_get_type_name(uint8_t type);
  341. const char *genimg_get_comp_name(uint8_t comp);
  342. int genimg_get_os_id(const char *name);
  343. int genimg_get_arch_id(const char *name);
  344. int genimg_get_type_id(const char *name);
  345. int genimg_get_comp_id(const char *name);
  346. void genimg_print_size(uint32_t size);
  347. #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
  348. defined(USE_HOSTCC)
  349. #define IMAGE_ENABLE_TIMESTAMP 1
  350. #else
  351. #define IMAGE_ENABLE_TIMESTAMP 0
  352. #endif
  353. void genimg_print_time(time_t timestamp);
  354. #ifndef USE_HOSTCC
  355. /* Image format types, returned by _get_format() routine */
  356. #define IMAGE_FORMAT_INVALID 0x00
  357. #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
  358. #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
  359. int genimg_get_format(const void *img_addr);
  360. int genimg_has_config(bootm_headers_t *images);
  361. ulong genimg_get_image(ulong img_addr);
  362. int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
  363. uint8_t arch, ulong *rd_start, ulong *rd_end);
  364. int boot_get_fdt(int flag, int argc, char * const argv[],
  365. bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
  366. void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
  367. int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
  368. int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
  369. ulong *initrd_start, ulong *initrd_end);
  370. int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
  371. #ifdef CONFIG_SYS_BOOT_GET_KBD
  372. int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
  373. #endif /* CONFIG_SYS_BOOT_GET_KBD */
  374. #endif /* !USE_HOSTCC */
  375. /*******************************************************************/
  376. /* Legacy format specific code (prefixed with image_) */
  377. /*******************************************************************/
  378. static inline uint32_t image_get_header_size(void)
  379. {
  380. return (sizeof(image_header_t));
  381. }
  382. #define image_get_hdr_l(f) \
  383. static inline uint32_t image_get_##f(const image_header_t *hdr) \
  384. { \
  385. return uimage_to_cpu(hdr->ih_##f); \
  386. }
  387. image_get_hdr_l(magic) /* image_get_magic */
  388. image_get_hdr_l(hcrc) /* image_get_hcrc */
  389. image_get_hdr_l(time) /* image_get_time */
  390. image_get_hdr_l(size) /* image_get_size */
  391. image_get_hdr_l(load) /* image_get_load */
  392. image_get_hdr_l(ep) /* image_get_ep */
  393. image_get_hdr_l(dcrc) /* image_get_dcrc */
  394. #define image_get_hdr_b(f) \
  395. static inline uint8_t image_get_##f(const image_header_t *hdr) \
  396. { \
  397. return hdr->ih_##f; \
  398. }
  399. image_get_hdr_b(os) /* image_get_os */
  400. image_get_hdr_b(arch) /* image_get_arch */
  401. image_get_hdr_b(type) /* image_get_type */
  402. image_get_hdr_b(comp) /* image_get_comp */
  403. static inline char *image_get_name(const image_header_t *hdr)
  404. {
  405. return (char *)hdr->ih_name;
  406. }
  407. static inline uint32_t image_get_data_size(const image_header_t *hdr)
  408. {
  409. return image_get_size(hdr);
  410. }
  411. /**
  412. * image_get_data - get image payload start address
  413. * @hdr: image header
  414. *
  415. * image_get_data() returns address of the image payload. For single
  416. * component images it is image data start. For multi component
  417. * images it points to the null terminated table of sub-images sizes.
  418. *
  419. * returns:
  420. * image payload data start address
  421. */
  422. static inline ulong image_get_data(const image_header_t *hdr)
  423. {
  424. return ((ulong)hdr + image_get_header_size());
  425. }
  426. static inline uint32_t image_get_image_size(const image_header_t *hdr)
  427. {
  428. return (image_get_size(hdr) + image_get_header_size());
  429. }
  430. static inline ulong image_get_image_end(const image_header_t *hdr)
  431. {
  432. return ((ulong)hdr + image_get_image_size(hdr));
  433. }
  434. #define image_set_hdr_l(f) \
  435. static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
  436. { \
  437. hdr->ih_##f = cpu_to_uimage(val); \
  438. }
  439. image_set_hdr_l(magic) /* image_set_magic */
  440. image_set_hdr_l(hcrc) /* image_set_hcrc */
  441. image_set_hdr_l(time) /* image_set_time */
  442. image_set_hdr_l(size) /* image_set_size */
  443. image_set_hdr_l(load) /* image_set_load */
  444. image_set_hdr_l(ep) /* image_set_ep */
  445. image_set_hdr_l(dcrc) /* image_set_dcrc */
  446. #define image_set_hdr_b(f) \
  447. static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
  448. { \
  449. hdr->ih_##f = val; \
  450. }
  451. image_set_hdr_b(os) /* image_set_os */
  452. image_set_hdr_b(arch) /* image_set_arch */
  453. image_set_hdr_b(type) /* image_set_type */
  454. image_set_hdr_b(comp) /* image_set_comp */
  455. static inline void image_set_name(image_header_t *hdr, const char *name)
  456. {
  457. strncpy(image_get_name(hdr), name, IH_NMLEN);
  458. }
  459. int image_check_hcrc(const image_header_t *hdr);
  460. int image_check_dcrc(const image_header_t *hdr);
  461. #ifndef USE_HOSTCC
  462. ulong getenv_bootm_low(void);
  463. phys_size_t getenv_bootm_size(void);
  464. phys_size_t getenv_bootm_mapsize(void);
  465. void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
  466. #endif
  467. static inline int image_check_magic(const image_header_t *hdr)
  468. {
  469. return (image_get_magic(hdr) == IH_MAGIC);
  470. }
  471. static inline int image_check_type(const image_header_t *hdr, uint8_t type)
  472. {
  473. return (image_get_type(hdr) == type);
  474. }
  475. static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
  476. {
  477. return (image_get_arch(hdr) == arch);
  478. }
  479. static inline int image_check_os(const image_header_t *hdr, uint8_t os)
  480. {
  481. return (image_get_os(hdr) == os);
  482. }
  483. ulong image_multi_count(const image_header_t *hdr);
  484. void image_multi_getimg(const image_header_t *hdr, ulong idx,
  485. ulong *data, ulong *len);
  486. void image_print_contents(const void *hdr);
  487. #ifndef USE_HOSTCC
  488. static inline int image_check_target_arch(const image_header_t *hdr)
  489. {
  490. #ifndef IH_ARCH_DEFAULT
  491. # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
  492. #endif
  493. return image_check_arch(hdr, IH_ARCH_DEFAULT);
  494. }
  495. #endif /* USE_HOSTCC */
  496. /**
  497. * Set up properties in the FDT
  498. *
  499. * This sets up properties in the FDT that is to be passed to linux.
  500. *
  501. * @images: Images information
  502. * @blob: FDT to update
  503. * @of_size: Size of the FDT
  504. * @lmb: Points to logical memory block structure
  505. * @return 0 if ok, <0 on failure
  506. */
  507. int image_setup_libfdt(bootm_headers_t *images, void *blob,
  508. int of_size, struct lmb *lmb);
  509. /**
  510. * Set up the FDT to use for booting a kernel
  511. *
  512. * This performs ramdisk setup, sets up the FDT if required, and adds
  513. * paramters to the FDT if libfdt is available.
  514. *
  515. * @param images Images information
  516. * @return 0 if ok, <0 on failure
  517. */
  518. int image_setup_linux(bootm_headers_t *images);
  519. /*******************************************************************/
  520. /* New uImage format specific code (prefixed with fit_) */
  521. /*******************************************************************/
  522. #if defined(CONFIG_FIT)
  523. #define FIT_IMAGES_PATH "/images"
  524. #define FIT_CONFS_PATH "/configurations"
  525. /* hash node */
  526. #define FIT_HASH_NODENAME "hash"
  527. #define FIT_ALGO_PROP "algo"
  528. #define FIT_VALUE_PROP "value"
  529. #define FIT_IGNORE_PROP "uboot-ignore"
  530. /* image node */
  531. #define FIT_DATA_PROP "data"
  532. #define FIT_TIMESTAMP_PROP "timestamp"
  533. #define FIT_DESC_PROP "description"
  534. #define FIT_ARCH_PROP "arch"
  535. #define FIT_TYPE_PROP "type"
  536. #define FIT_OS_PROP "os"
  537. #define FIT_COMP_PROP "compression"
  538. #define FIT_ENTRY_PROP "entry"
  539. #define FIT_LOAD_PROP "load"
  540. /* configuration node */
  541. #define FIT_KERNEL_PROP "kernel"
  542. #define FIT_RAMDISK_PROP "ramdisk"
  543. #define FIT_FDT_PROP "fdt"
  544. #define FIT_DEFAULT_PROP "default"
  545. #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
  546. /* cmdline argument format parsing */
  547. int fit_parse_conf(const char *spec, ulong addr_curr,
  548. ulong *addr, const char **conf_name);
  549. int fit_parse_subimage(const char *spec, ulong addr_curr,
  550. ulong *addr, const char **image_name);
  551. void fit_print_contents(const void *fit);
  552. void fit_image_print(const void *fit, int noffset, const char *p);
  553. /**
  554. * fit_get_end - get FIT image size
  555. * @fit: pointer to the FIT format image header
  556. *
  557. * returns:
  558. * size of the FIT image (blob) in memory
  559. */
  560. static inline ulong fit_get_size(const void *fit)
  561. {
  562. return fdt_totalsize(fit);
  563. }
  564. /**
  565. * fit_get_end - get FIT image end
  566. * @fit: pointer to the FIT format image header
  567. *
  568. * returns:
  569. * end address of the FIT image (blob) in memory
  570. */
  571. static inline ulong fit_get_end(const void *fit)
  572. {
  573. return (ulong)fit + fdt_totalsize(fit);
  574. }
  575. /**
  576. * fit_get_name - get FIT node name
  577. * @fit: pointer to the FIT format image header
  578. *
  579. * returns:
  580. * NULL, on error
  581. * pointer to node name, on success
  582. */
  583. static inline const char *fit_get_name(const void *fit_hdr,
  584. int noffset, int *len)
  585. {
  586. return fdt_get_name(fit_hdr, noffset, len);
  587. }
  588. int fit_get_desc(const void *fit, int noffset, char **desc);
  589. int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
  590. int fit_image_get_node(const void *fit, const char *image_uname);
  591. int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
  592. int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
  593. int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
  594. int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
  595. int fit_image_get_load(const void *fit, int noffset, ulong *load);
  596. int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
  597. int fit_image_get_data(const void *fit, int noffset,
  598. const void **data, size_t *size);
  599. int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
  600. int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
  601. int *value_len);
  602. int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
  603. /**
  604. * fit_add_verification_data() - Calculate and add hashes to FIT
  605. *
  606. * @fit: Fit image to process
  607. * @return 0 if ok, <0 for error
  608. */
  609. int fit_add_verification_data(void *fit);
  610. int fit_image_verify(const void *fit, int noffset);
  611. int fit_all_image_verify(const void *fit);
  612. int fit_image_check_os(const void *fit, int noffset, uint8_t os);
  613. int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
  614. int fit_image_check_type(const void *fit, int noffset, uint8_t type);
  615. int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
  616. int fit_check_format(const void *fit);
  617. int fit_conf_find_compat(const void *fit, const void *fdt);
  618. int fit_conf_get_node(const void *fit, const char *conf_uname);
  619. int fit_conf_get_kernel_node(const void *fit, int noffset);
  620. int fit_conf_get_ramdisk_node(const void *fit, int noffset);
  621. int fit_conf_get_fdt_node(const void *fit, int noffset);
  622. /**
  623. * fit_conf_get_prop_node() - Get node refered to by a configuration
  624. * @fit: FIT to check
  625. * @noffset: Offset of conf@xxx node to check
  626. * @prop_name: Property to read from the conf node
  627. *
  628. * The conf@ nodes contain references to other nodes, using properties
  629. * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
  630. * return the offset of the node referred to (e.g. offset of node
  631. * "/images/kernel@1".
  632. */
  633. int fit_conf_get_prop_node(const void *fit, int noffset,
  634. const char *prop_name);
  635. void fit_conf_print(const void *fit, int noffset, const char *p);
  636. int fit_check_ramdisk(const void *fit, int os_noffset,
  637. uint8_t arch, int verify);
  638. int calculate_hash(const void *data, int data_len, const char *algo,
  639. uint8_t *value, int *value_len);
  640. #ifndef USE_HOSTCC
  641. static inline int fit_image_check_target_arch(const void *fdt, int node)
  642. {
  643. return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
  644. }
  645. #endif /* USE_HOSTCC */
  646. #ifdef CONFIG_FIT_VERBOSE
  647. #define fit_unsupported(msg) printf("! %s:%d " \
  648. "FIT images not supported for '%s'\n", \
  649. __FILE__, __LINE__, (msg))
  650. #define fit_unsupported_reset(msg) printf("! %s:%d " \
  651. "FIT images not supported for '%s' " \
  652. "- must reset board to recover!\n", \
  653. __FILE__, __LINE__, (msg))
  654. #else
  655. #define fit_unsupported(msg)
  656. #define fit_unsupported_reset(msg)
  657. #endif /* CONFIG_FIT_VERBOSE */
  658. #endif /* CONFIG_FIT */
  659. #endif /* __IMAGE_H__ */