image.h 22 KB

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