image.h 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997
  1. /*
  2. * (C) Copyright 2008 Semihalf
  3. *
  4. * (C) Copyright 2000-2005
  5. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  6. *
  7. * SPDX-License-Identifier: GPL-2.0+
  8. ********************************************************************
  9. * NOTE: This header file defines an interface to U-Boot. Including
  10. * this (unmodified) header file in another file is considered normal
  11. * use of U-Boot, and does *not* fall under the heading of "derived
  12. * work".
  13. ********************************************************************
  14. */
  15. #ifndef __IMAGE_H__
  16. #define __IMAGE_H__
  17. #include "compiler.h"
  18. #include <asm/byteorder.h>
  19. /* Define this to avoid #ifdefs later on */
  20. struct lmb;
  21. #ifdef USE_HOSTCC
  22. /* new uImage format support enabled on host */
  23. #define CONFIG_FIT 1
  24. #define CONFIG_OF_LIBFDT 1
  25. #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
  26. #define IMAGE_ENABLE_IGNORE 0
  27. #define IMAGE_INDENT_STRING ""
  28. #else
  29. #include <lmb.h>
  30. #include <asm/u-boot.h>
  31. #include <command.h>
  32. /* Take notice of the 'ignore' property for hashes */
  33. #define IMAGE_ENABLE_IGNORE 1
  34. #define IMAGE_INDENT_STRING " "
  35. #endif /* USE_HOSTCC */
  36. #if defined(CONFIG_FIT)
  37. #include <libfdt.h>
  38. #include <fdt_support.h>
  39. # ifdef CONFIG_SPL_BUILD
  40. # ifdef CONFIG_SPL_CRC32_SUPPORT
  41. # define IMAGE_ENABLE_CRC32 1
  42. # endif
  43. # ifdef CONFIG_SPL_MD5_SUPPORT
  44. # define IMAGE_ENABLE_MD5 1
  45. # endif
  46. # ifdef CONFIG_SPL_SHA1_SUPPORT
  47. # define IMAGE_ENABLE_SHA1 1
  48. # endif
  49. # else
  50. # define CONFIG_CRC32 /* FIT images need CRC32 support */
  51. # define CONFIG_MD5 /* and MD5 */
  52. # define CONFIG_SHA1 /* and SHA1 */
  53. # define IMAGE_ENABLE_CRC32 1
  54. # define IMAGE_ENABLE_MD5 1
  55. # define IMAGE_ENABLE_SHA1 1
  56. # endif
  57. #ifndef IMAGE_ENABLE_CRC32
  58. #define IMAGE_ENABLE_CRC32 0
  59. #endif
  60. #ifndef IMAGE_ENABLE_MD5
  61. #define IMAGE_ENABLE_MD5 0
  62. #endif
  63. #ifndef IMAGE_ENABLE_SHA1
  64. #define IMAGE_ENABLE_SHA1 0
  65. #endif
  66. #endif /* CONFIG_FIT */
  67. #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
  68. # define IMAGE_ENABLE_RAMDISK_HIGH 1
  69. #else
  70. # define IMAGE_ENABLE_RAMDISK_HIGH 0
  71. #endif
  72. #ifdef CONFIG_OF_LIBFDT
  73. # define IMAGE_ENABLE_OF_LIBFDT 1
  74. #else
  75. # define IMAGE_ENABLE_OF_LIBFDT 0
  76. #endif
  77. #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
  78. # define IMAGE_BOOT_GET_CMDLINE 1
  79. #else
  80. # define IMAGE_BOOT_GET_CMDLINE 0
  81. #endif
  82. #ifdef CONFIG_OF_BOARD_SETUP
  83. # define IMAAGE_OF_BOARD_SETUP 1
  84. #else
  85. # define IMAAGE_OF_BOARD_SETUP 0
  86. #endif
  87. /*
  88. * Operating System Codes
  89. */
  90. #define IH_OS_INVALID 0 /* Invalid OS */
  91. #define IH_OS_OPENBSD 1 /* OpenBSD */
  92. #define IH_OS_NETBSD 2 /* NetBSD */
  93. #define IH_OS_FREEBSD 3 /* FreeBSD */
  94. #define IH_OS_4_4BSD 4 /* 4.4BSD */
  95. #define IH_OS_LINUX 5 /* Linux */
  96. #define IH_OS_SVR4 6 /* SVR4 */
  97. #define IH_OS_ESIX 7 /* Esix */
  98. #define IH_OS_SOLARIS 8 /* Solaris */
  99. #define IH_OS_IRIX 9 /* Irix */
  100. #define IH_OS_SCO 10 /* SCO */
  101. #define IH_OS_DELL 11 /* Dell */
  102. #define IH_OS_NCR 12 /* NCR */
  103. #define IH_OS_LYNXOS 13 /* LynxOS */
  104. #define IH_OS_VXWORKS 14 /* VxWorks */
  105. #define IH_OS_PSOS 15 /* pSOS */
  106. #define IH_OS_QNX 16 /* QNX */
  107. #define IH_OS_U_BOOT 17 /* Firmware */
  108. #define IH_OS_RTEMS 18 /* RTEMS */
  109. #define IH_OS_ARTOS 19 /* ARTOS */
  110. #define IH_OS_UNITY 20 /* Unity OS */
  111. #define IH_OS_INTEGRITY 21 /* INTEGRITY */
  112. #define IH_OS_OSE 22 /* OSE */
  113. #define IH_OS_PLAN9 23 /* Plan 9 */
  114. /*
  115. * CPU Architecture Codes (supported by Linux)
  116. */
  117. #define IH_ARCH_INVALID 0 /* Invalid CPU */
  118. #define IH_ARCH_ALPHA 1 /* Alpha */
  119. #define IH_ARCH_ARM 2 /* ARM */
  120. #define IH_ARCH_I386 3 /* Intel x86 */
  121. #define IH_ARCH_IA64 4 /* IA64 */
  122. #define IH_ARCH_MIPS 5 /* MIPS */
  123. #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
  124. #define IH_ARCH_PPC 7 /* PowerPC */
  125. #define IH_ARCH_S390 8 /* IBM S390 */
  126. #define IH_ARCH_SH 9 /* SuperH */
  127. #define IH_ARCH_SPARC 10 /* Sparc */
  128. #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
  129. #define IH_ARCH_M68K 12 /* M68K */
  130. #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
  131. #define IH_ARCH_NIOS2 15 /* Nios-II */
  132. #define IH_ARCH_BLACKFIN 16 /* Blackfin */
  133. #define IH_ARCH_AVR32 17 /* AVR32 */
  134. #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
  135. #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
  136. #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
  137. #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
  138. /*
  139. * Image Types
  140. *
  141. * "Standalone Programs" are directly runnable in the environment
  142. * provided by U-Boot; it is expected that (if they behave
  143. * well) you can continue to work in U-Boot after return from
  144. * the Standalone Program.
  145. * "OS Kernel Images" are usually images of some Embedded OS which
  146. * will take over control completely. Usually these programs
  147. * will install their own set of exception handlers, device
  148. * drivers, set up the MMU, etc. - this means, that you cannot
  149. * expect to re-enter U-Boot except by resetting the CPU.
  150. * "RAMDisk Images" are more or less just data blocks, and their
  151. * parameters (address, size) are passed to an OS kernel that is
  152. * being started.
  153. * "Multi-File Images" contain several images, typically an OS
  154. * (Linux) kernel image and one or more data images like
  155. * RAMDisks. This construct is useful for instance when you want
  156. * to boot over the network using BOOTP etc., where the boot
  157. * server provides just a single image file, but you want to get
  158. * for instance an OS kernel and a RAMDisk image.
  159. *
  160. * "Multi-File Images" start with a list of image sizes, each
  161. * image size (in bytes) specified by an "uint32_t" in network
  162. * byte order. This list is terminated by an "(uint32_t)0".
  163. * Immediately after the terminating 0 follow the images, one by
  164. * one, all aligned on "uint32_t" boundaries (size rounded up to
  165. * a multiple of 4 bytes - except for the last file).
  166. *
  167. * "Firmware Images" are binary images containing firmware (like
  168. * U-Boot or FPGA images) which usually will be programmed to
  169. * flash memory.
  170. *
  171. * "Script files" are command sequences that will be executed by
  172. * U-Boot's command interpreter; this feature is especially
  173. * useful when you configure U-Boot to use a real shell (hush)
  174. * as command interpreter (=> Shell Scripts).
  175. */
  176. #define IH_TYPE_INVALID 0 /* Invalid Image */
  177. #define IH_TYPE_STANDALONE 1 /* Standalone Program */
  178. #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
  179. #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
  180. #define IH_TYPE_MULTI 4 /* Multi-File Image */
  181. #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
  182. #define IH_TYPE_SCRIPT 6 /* Script file */
  183. #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
  184. #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
  185. #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
  186. #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
  187. #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
  188. #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
  189. #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
  190. #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
  191. #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
  192. #define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
  193. /*
  194. * Compression Types
  195. */
  196. #define IH_COMP_NONE 0 /* No Compression Used */
  197. #define IH_COMP_GZIP 1 /* gzip Compression Used */
  198. #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
  199. #define IH_COMP_LZMA 3 /* lzma Compression Used */
  200. #define IH_COMP_LZO 4 /* lzo Compression Used */
  201. #define IH_MAGIC 0x27051956 /* Image Magic Number */
  202. #define IH_NMLEN 32 /* Image Name Length */
  203. /* Reused from common.h */
  204. #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
  205. /*
  206. * Legacy format image header,
  207. * all data in network byte order (aka natural aka bigendian).
  208. */
  209. typedef struct image_header {
  210. __be32 ih_magic; /* Image Header Magic Number */
  211. __be32 ih_hcrc; /* Image Header CRC Checksum */
  212. __be32 ih_time; /* Image Creation Timestamp */
  213. __be32 ih_size; /* Image Data Size */
  214. __be32 ih_load; /* Data Load Address */
  215. __be32 ih_ep; /* Entry Point Address */
  216. __be32 ih_dcrc; /* Image Data CRC Checksum */
  217. uint8_t ih_os; /* Operating System */
  218. uint8_t ih_arch; /* CPU architecture */
  219. uint8_t ih_type; /* Image Type */
  220. uint8_t ih_comp; /* Compression Type */
  221. uint8_t ih_name[IH_NMLEN]; /* Image Name */
  222. } image_header_t;
  223. typedef struct image_info {
  224. ulong start, end; /* start/end of blob */
  225. ulong image_start, image_len; /* start of image within blob, len of image */
  226. ulong load; /* load addr for the image */
  227. uint8_t comp, type, os; /* compression, type of image, os type */
  228. } image_info_t;
  229. /*
  230. * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
  231. * routines.
  232. */
  233. typedef struct bootm_headers {
  234. /*
  235. * Legacy os image header, if it is a multi component image
  236. * then boot_get_ramdisk() and get_fdt() will attempt to get
  237. * data from second and third component accordingly.
  238. */
  239. image_header_t *legacy_hdr_os; /* image header pointer */
  240. image_header_t legacy_hdr_os_copy; /* header copy */
  241. ulong legacy_hdr_valid;
  242. #if defined(CONFIG_FIT)
  243. const char *fit_uname_cfg; /* configuration node unit name */
  244. void *fit_hdr_os; /* os FIT image header */
  245. const char *fit_uname_os; /* os subimage node unit name */
  246. int fit_noffset_os; /* os subimage node offset */
  247. void *fit_hdr_rd; /* init ramdisk FIT image header */
  248. const char *fit_uname_rd; /* init ramdisk subimage node unit name */
  249. int fit_noffset_rd; /* init ramdisk subimage node offset */
  250. void *fit_hdr_fdt; /* FDT blob FIT image header */
  251. const char *fit_uname_fdt; /* FDT blob subimage node unit name */
  252. int fit_noffset_fdt;/* FDT blob subimage node offset */
  253. #endif
  254. #ifndef USE_HOSTCC
  255. image_info_t os; /* os image info */
  256. ulong ep; /* entry point of OS */
  257. ulong rd_start, rd_end;/* ramdisk start/end */
  258. char *ft_addr; /* flat dev tree address */
  259. ulong ft_len; /* length of flat device tree */
  260. ulong initrd_start;
  261. ulong initrd_end;
  262. ulong cmdline_start;
  263. ulong cmdline_end;
  264. bd_t *kbd;
  265. #endif
  266. int verify; /* getenv("verify")[0] != 'n' */
  267. #define BOOTM_STATE_START (0x00000001)
  268. #define BOOTM_STATE_FINDOS (0x00000002)
  269. #define BOOTM_STATE_FINDOTHER (0x00000004)
  270. #define BOOTM_STATE_LOADOS (0x00000008)
  271. #define BOOTM_STATE_RAMDISK (0x00000010)
  272. #define BOOTM_STATE_FDT (0x00000020)
  273. #define BOOTM_STATE_OS_CMDLINE (0x00000040)
  274. #define BOOTM_STATE_OS_BD_T (0x00000080)
  275. #define BOOTM_STATE_OS_PREP (0x00000100)
  276. #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
  277. #define BOOTM_STATE_OS_GO (0x00000400)
  278. int state;
  279. #ifdef CONFIG_LMB
  280. struct lmb lmb; /* for memory mgmt */
  281. #endif
  282. } bootm_headers_t;
  283. extern bootm_headers_t images;
  284. /*
  285. * Some systems (for example LWMON) have very short watchdog periods;
  286. * we must make sure to split long operations like memmove() or
  287. * checksum calculations into reasonable chunks.
  288. */
  289. #ifndef CHUNKSZ
  290. #define CHUNKSZ (64 * 1024)
  291. #endif
  292. #ifndef CHUNKSZ_CRC32
  293. #define CHUNKSZ_CRC32 (64 * 1024)
  294. #endif
  295. #ifndef CHUNKSZ_MD5
  296. #define CHUNKSZ_MD5 (64 * 1024)
  297. #endif
  298. #ifndef CHUNKSZ_SHA1
  299. #define CHUNKSZ_SHA1 (64 * 1024)
  300. #endif
  301. #define uimage_to_cpu(x) be32_to_cpu(x)
  302. #define cpu_to_uimage(x) cpu_to_be32(x)
  303. /*
  304. * Translation table for entries of a specific type; used by
  305. * get_table_entry_id() and get_table_entry_name().
  306. */
  307. typedef struct table_entry {
  308. int id;
  309. char *sname; /* short (input) name to find table entry */
  310. char *lname; /* long (output) name to print for messages */
  311. } table_entry_t;
  312. /*
  313. * get_table_entry_id() scans the translation table trying to find an
  314. * entry that matches the given short name. If a matching entry is
  315. * found, it's id is returned to the caller.
  316. */
  317. int get_table_entry_id(const table_entry_t *table,
  318. const char *table_name, const char *name);
  319. /*
  320. * get_table_entry_name() scans the translation table trying to find
  321. * an entry that matches the given id. If a matching entry is found,
  322. * its long name is returned to the caller.
  323. */
  324. char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
  325. const char *genimg_get_os_name(uint8_t os);
  326. const char *genimg_get_arch_name(uint8_t arch);
  327. const char *genimg_get_type_name(uint8_t type);
  328. const char *genimg_get_comp_name(uint8_t comp);
  329. int genimg_get_os_id(const char *name);
  330. int genimg_get_arch_id(const char *name);
  331. int genimg_get_type_id(const char *name);
  332. int genimg_get_comp_id(const char *name);
  333. void genimg_print_size(uint32_t size);
  334. #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
  335. defined(USE_HOSTCC)
  336. #define IMAGE_ENABLE_TIMESTAMP 1
  337. #else
  338. #define IMAGE_ENABLE_TIMESTAMP 0
  339. #endif
  340. void genimg_print_time(time_t timestamp);
  341. /* What to do with a image load address ('load = <> 'in the FIT) */
  342. enum fit_load_op {
  343. FIT_LOAD_IGNORED, /* Ignore load address */
  344. FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
  345. FIT_LOAD_REQUIRED, /* Must be provided */
  346. };
  347. #ifndef USE_HOSTCC
  348. /* Image format types, returned by _get_format() routine */
  349. #define IMAGE_FORMAT_INVALID 0x00
  350. #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
  351. #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
  352. int genimg_get_format(const void *img_addr);
  353. int genimg_has_config(bootm_headers_t *images);
  354. ulong genimg_get_image(ulong img_addr);
  355. int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
  356. uint8_t arch, ulong *rd_start, ulong *rd_end);
  357. /**
  358. * fit_image_load() - load an image from a FIT
  359. *
  360. * This deals with all aspects of loading an image from a FIT, including
  361. * selecting the right image based on configuration, verifying it, printing
  362. * out progress messages, checking the type/arch/os and optionally copying it
  363. * to the right load address.
  364. *
  365. * @param images Boot images structure
  366. * @param prop_name Property name to look up (FIT_..._PROP)
  367. * @param addr Address of FIT in memory
  368. * @param fit_unamep On entry this is the requested image name
  369. * (e.g. "kernel@1") or NULL to use the default. On exit
  370. * points to the selected image name
  371. * @param fit_uname_configp On entry this is the requested configuration
  372. * name (e.g. "conf@1") or NULL to use the default. On
  373. * exit points to the selected configuration name.
  374. * @param arch Expected architecture (IH_ARCH_...)
  375. * @param image_type Required image type (IH_TYPE_...). If this is
  376. * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
  377. * also.
  378. * @param bootstage_id ID of starting bootstage to use for progress updates.
  379. * This will be added to the BOOTSTAGE_SUB values when
  380. * calling bootstage_mark()
  381. * @param load_op Decribes what to do with the load address
  382. * @param datap Returns address of loaded image
  383. * @param lenp Returns length of loaded image
  384. */
  385. int fit_image_load(bootm_headers_t *images, const char *prop_name, ulong addr,
  386. const char **fit_unamep, const char **fit_uname_configp,
  387. int arch, int image_type, int bootstage_id,
  388. enum fit_load_op load_op, ulong *datap, ulong *lenp);
  389. /**
  390. * fit_get_node_from_config() - Look up an image a FIT by type
  391. *
  392. * This looks in the selected conf@ node (images->fit_uname_cfg) for a
  393. * particular image type (e.g. "kernel") and then finds the image that is
  394. * referred to.
  395. *
  396. * For example, for something like:
  397. *
  398. * images {
  399. * kernel@1 {
  400. * ...
  401. * };
  402. * };
  403. * configurations {
  404. * conf@1 {
  405. * kernel = "kernel@1";
  406. * };
  407. * };
  408. *
  409. * the function will return the node offset of the kernel@1 node, assuming
  410. * that conf@1 is the chosen configuration.
  411. *
  412. * @param images Boot images structure
  413. * @param prop_name Property name to look up (FIT_..._PROP)
  414. * @param addr Address of FIT in memory
  415. */
  416. int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
  417. ulong addr);
  418. int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
  419. bootm_headers_t *images,
  420. char **of_flat_tree, ulong *of_size);
  421. void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
  422. int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
  423. int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
  424. ulong *initrd_start, ulong *initrd_end);
  425. int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
  426. #ifdef CONFIG_SYS_BOOT_GET_KBD
  427. int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
  428. #endif /* CONFIG_SYS_BOOT_GET_KBD */
  429. #endif /* !USE_HOSTCC */
  430. /*******************************************************************/
  431. /* Legacy format specific code (prefixed with image_) */
  432. /*******************************************************************/
  433. static inline uint32_t image_get_header_size(void)
  434. {
  435. return (sizeof(image_header_t));
  436. }
  437. #define image_get_hdr_l(f) \
  438. static inline uint32_t image_get_##f(const image_header_t *hdr) \
  439. { \
  440. return uimage_to_cpu(hdr->ih_##f); \
  441. }
  442. image_get_hdr_l(magic) /* image_get_magic */
  443. image_get_hdr_l(hcrc) /* image_get_hcrc */
  444. image_get_hdr_l(time) /* image_get_time */
  445. image_get_hdr_l(size) /* image_get_size */
  446. image_get_hdr_l(load) /* image_get_load */
  447. image_get_hdr_l(ep) /* image_get_ep */
  448. image_get_hdr_l(dcrc) /* image_get_dcrc */
  449. #define image_get_hdr_b(f) \
  450. static inline uint8_t image_get_##f(const image_header_t *hdr) \
  451. { \
  452. return hdr->ih_##f; \
  453. }
  454. image_get_hdr_b(os) /* image_get_os */
  455. image_get_hdr_b(arch) /* image_get_arch */
  456. image_get_hdr_b(type) /* image_get_type */
  457. image_get_hdr_b(comp) /* image_get_comp */
  458. static inline char *image_get_name(const image_header_t *hdr)
  459. {
  460. return (char *)hdr->ih_name;
  461. }
  462. static inline uint32_t image_get_data_size(const image_header_t *hdr)
  463. {
  464. return image_get_size(hdr);
  465. }
  466. /**
  467. * image_get_data - get image payload start address
  468. * @hdr: image header
  469. *
  470. * image_get_data() returns address of the image payload. For single
  471. * component images it is image data start. For multi component
  472. * images it points to the null terminated table of sub-images sizes.
  473. *
  474. * returns:
  475. * image payload data start address
  476. */
  477. static inline ulong image_get_data(const image_header_t *hdr)
  478. {
  479. return ((ulong)hdr + image_get_header_size());
  480. }
  481. static inline uint32_t image_get_image_size(const image_header_t *hdr)
  482. {
  483. return (image_get_size(hdr) + image_get_header_size());
  484. }
  485. static inline ulong image_get_image_end(const image_header_t *hdr)
  486. {
  487. return ((ulong)hdr + image_get_image_size(hdr));
  488. }
  489. #define image_set_hdr_l(f) \
  490. static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
  491. { \
  492. hdr->ih_##f = cpu_to_uimage(val); \
  493. }
  494. image_set_hdr_l(magic) /* image_set_magic */
  495. image_set_hdr_l(hcrc) /* image_set_hcrc */
  496. image_set_hdr_l(time) /* image_set_time */
  497. image_set_hdr_l(size) /* image_set_size */
  498. image_set_hdr_l(load) /* image_set_load */
  499. image_set_hdr_l(ep) /* image_set_ep */
  500. image_set_hdr_l(dcrc) /* image_set_dcrc */
  501. #define image_set_hdr_b(f) \
  502. static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
  503. { \
  504. hdr->ih_##f = val; \
  505. }
  506. image_set_hdr_b(os) /* image_set_os */
  507. image_set_hdr_b(arch) /* image_set_arch */
  508. image_set_hdr_b(type) /* image_set_type */
  509. image_set_hdr_b(comp) /* image_set_comp */
  510. static inline void image_set_name(image_header_t *hdr, const char *name)
  511. {
  512. strncpy(image_get_name(hdr), name, IH_NMLEN);
  513. }
  514. int image_check_hcrc(const image_header_t *hdr);
  515. int image_check_dcrc(const image_header_t *hdr);
  516. #ifndef USE_HOSTCC
  517. ulong getenv_bootm_low(void);
  518. phys_size_t getenv_bootm_size(void);
  519. phys_size_t getenv_bootm_mapsize(void);
  520. void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
  521. #endif
  522. static inline int image_check_magic(const image_header_t *hdr)
  523. {
  524. return (image_get_magic(hdr) == IH_MAGIC);
  525. }
  526. static inline int image_check_type(const image_header_t *hdr, uint8_t type)
  527. {
  528. return (image_get_type(hdr) == type);
  529. }
  530. static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
  531. {
  532. return (image_get_arch(hdr) == arch);
  533. }
  534. static inline int image_check_os(const image_header_t *hdr, uint8_t os)
  535. {
  536. return (image_get_os(hdr) == os);
  537. }
  538. ulong image_multi_count(const image_header_t *hdr);
  539. void image_multi_getimg(const image_header_t *hdr, ulong idx,
  540. ulong *data, ulong *len);
  541. void image_print_contents(const void *hdr);
  542. #ifndef USE_HOSTCC
  543. static inline int image_check_target_arch(const image_header_t *hdr)
  544. {
  545. #ifndef IH_ARCH_DEFAULT
  546. # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
  547. #endif
  548. return image_check_arch(hdr, IH_ARCH_DEFAULT);
  549. }
  550. #endif /* USE_HOSTCC */
  551. /**
  552. * Set up properties in the FDT
  553. *
  554. * This sets up properties in the FDT that is to be passed to linux.
  555. *
  556. * @images: Images information
  557. * @blob: FDT to update
  558. * @of_size: Size of the FDT
  559. * @lmb: Points to logical memory block structure
  560. * @return 0 if ok, <0 on failure
  561. */
  562. int image_setup_libfdt(bootm_headers_t *images, void *blob,
  563. int of_size, struct lmb *lmb);
  564. /**
  565. * Set up the FDT to use for booting a kernel
  566. *
  567. * This performs ramdisk setup, sets up the FDT if required, and adds
  568. * paramters to the FDT if libfdt is available.
  569. *
  570. * @param images Images information
  571. * @return 0 if ok, <0 on failure
  572. */
  573. int image_setup_linux(bootm_headers_t *images);
  574. /**
  575. * bootz_setup() - Extract stat and size of a Linux xImage
  576. *
  577. * @image: Address of image
  578. * @start: Returns start address of image
  579. * @end : Returns end address of image
  580. * @return 0 if OK, 1 if the image was not recognised
  581. */
  582. int bootz_setup(ulong image, ulong *start, ulong *end);
  583. /*******************************************************************/
  584. /* New uImage format specific code (prefixed with fit_) */
  585. /*******************************************************************/
  586. #if defined(CONFIG_FIT)
  587. #define FIT_IMAGES_PATH "/images"
  588. #define FIT_CONFS_PATH "/configurations"
  589. /* hash/signature node */
  590. #define FIT_HASH_NODENAME "hash"
  591. #define FIT_ALGO_PROP "algo"
  592. #define FIT_VALUE_PROP "value"
  593. #define FIT_IGNORE_PROP "uboot-ignore"
  594. #define FIT_SIG_NODENAME "signature"
  595. /* image node */
  596. #define FIT_DATA_PROP "data"
  597. #define FIT_TIMESTAMP_PROP "timestamp"
  598. #define FIT_DESC_PROP "description"
  599. #define FIT_ARCH_PROP "arch"
  600. #define FIT_TYPE_PROP "type"
  601. #define FIT_OS_PROP "os"
  602. #define FIT_COMP_PROP "compression"
  603. #define FIT_ENTRY_PROP "entry"
  604. #define FIT_LOAD_PROP "load"
  605. /* configuration node */
  606. #define FIT_KERNEL_PROP "kernel"
  607. #define FIT_RAMDISK_PROP "ramdisk"
  608. #define FIT_FDT_PROP "fdt"
  609. #define FIT_DEFAULT_PROP "default"
  610. #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
  611. /* cmdline argument format parsing */
  612. int fit_parse_conf(const char *spec, ulong addr_curr,
  613. ulong *addr, const char **conf_name);
  614. int fit_parse_subimage(const char *spec, ulong addr_curr,
  615. ulong *addr, const char **image_name);
  616. void fit_print_contents(const void *fit);
  617. void fit_image_print(const void *fit, int noffset, const char *p);
  618. /**
  619. * fit_get_end - get FIT image size
  620. * @fit: pointer to the FIT format image header
  621. *
  622. * returns:
  623. * size of the FIT image (blob) in memory
  624. */
  625. static inline ulong fit_get_size(const void *fit)
  626. {
  627. return fdt_totalsize(fit);
  628. }
  629. /**
  630. * fit_get_end - get FIT image end
  631. * @fit: pointer to the FIT format image header
  632. *
  633. * returns:
  634. * end address of the FIT image (blob) in memory
  635. */
  636. static inline ulong fit_get_end(const void *fit)
  637. {
  638. return (ulong)fit + fdt_totalsize(fit);
  639. }
  640. /**
  641. * fit_get_name - get FIT node name
  642. * @fit: pointer to the FIT format image header
  643. *
  644. * returns:
  645. * NULL, on error
  646. * pointer to node name, on success
  647. */
  648. static inline const char *fit_get_name(const void *fit_hdr,
  649. int noffset, int *len)
  650. {
  651. return fdt_get_name(fit_hdr, noffset, len);
  652. }
  653. int fit_get_desc(const void *fit, int noffset, char **desc);
  654. int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
  655. int fit_image_get_node(const void *fit, const char *image_uname);
  656. int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
  657. int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
  658. int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
  659. int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
  660. int fit_image_get_load(const void *fit, int noffset, ulong *load);
  661. int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
  662. int fit_image_get_data(const void *fit, int noffset,
  663. const void **data, size_t *size);
  664. int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
  665. int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
  666. int *value_len);
  667. int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
  668. /**
  669. * fit_add_verification_data() - add verification data to FIT image nodes
  670. *
  671. * @keydir: Directory containing keys
  672. * @kwydest: FDT blob to write public key information to
  673. * @fit: Pointer to the FIT format image header
  674. * @comment: Comment to add to signature nodes
  675. * @require_keys: Mark all keys as 'required'
  676. *
  677. * Adds hash values for all component images in the FIT blob.
  678. * Hashes are calculated for all component images which have hash subnodes
  679. * with algorithm property set to one of the supported hash algorithms.
  680. *
  681. * Also add signatures if signature nodes are present.
  682. *
  683. * returns
  684. * 0, on success
  685. * libfdt error code, on failure
  686. */
  687. int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
  688. const char *comment, int require_keys);
  689. int fit_image_verify(const void *fit, int noffset);
  690. int fit_config_verify(const void *fit, int conf_noffset);
  691. int fit_all_image_verify(const void *fit);
  692. int fit_image_check_os(const void *fit, int noffset, uint8_t os);
  693. int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
  694. int fit_image_check_type(const void *fit, int noffset, uint8_t type);
  695. int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
  696. int fit_check_format(const void *fit);
  697. int fit_conf_find_compat(const void *fit, const void *fdt);
  698. int fit_conf_get_node(const void *fit, const char *conf_uname);
  699. /**
  700. * fit_conf_get_prop_node() - Get node refered to by a configuration
  701. * @fit: FIT to check
  702. * @noffset: Offset of conf@xxx node to check
  703. * @prop_name: Property to read from the conf node
  704. *
  705. * The conf@ nodes contain references to other nodes, using properties
  706. * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
  707. * return the offset of the node referred to (e.g. offset of node
  708. * "/images/kernel@1".
  709. */
  710. int fit_conf_get_prop_node(const void *fit, int noffset,
  711. const char *prop_name);
  712. void fit_conf_print(const void *fit, int noffset, const char *p);
  713. int fit_check_ramdisk(const void *fit, int os_noffset,
  714. uint8_t arch, int verify);
  715. int calculate_hash(const void *data, int data_len, const char *algo,
  716. uint8_t *value, int *value_len);
  717. /*
  718. * At present we only support signing on the host, and verification on the
  719. * device
  720. */
  721. #if defined(CONFIG_FIT_SIGNATURE)
  722. # ifdef USE_HOSTCC
  723. # define IMAGE_ENABLE_SIGN 1
  724. # define IMAGE_ENABLE_VERIFY 0
  725. #else
  726. # define IMAGE_ENABLE_SIGN 0
  727. # define IMAGE_ENABLE_VERIFY 1
  728. # endif
  729. #else
  730. # define IMAGE_ENABLE_SIGN 0
  731. # define IMAGE_ENABLE_VERIFY 0
  732. #endif
  733. #ifdef USE_HOSTCC
  734. # define gd_fdt_blob() NULL
  735. #else
  736. # define gd_fdt_blob() (gd->fdt_blob)
  737. #endif
  738. #ifdef CONFIG_FIT_BEST_MATCH
  739. #define IMAGE_ENABLE_BEST_MATCH 1
  740. #else
  741. #define IMAGE_ENABLE_BEST_MATCH 0
  742. #endif
  743. /* Information passed to the signing routines */
  744. struct image_sign_info {
  745. const char *keydir; /* Directory conaining keys */
  746. const char *keyname; /* Name of key to use */
  747. void *fit; /* Pointer to FIT blob */
  748. int node_offset; /* Offset of signature node */
  749. struct image_sig_algo *algo; /* Algorithm information */
  750. const void *fdt_blob; /* FDT containing public keys */
  751. int required_keynode; /* Node offset of key to use: -1=any */
  752. const char *require_keys; /* Value for 'required' property */
  753. };
  754. /* A part of an image, used for hashing */
  755. struct image_region {
  756. const void *data;
  757. int size;
  758. };
  759. struct image_sig_algo {
  760. const char *name; /* Name of algorithm */
  761. /**
  762. * sign() - calculate and return signature for given input data
  763. *
  764. * @info: Specifies key and FIT information
  765. * @data: Pointer to the input data
  766. * @data_len: Data length
  767. * @sigp: Set to an allocated buffer holding the signature
  768. * @sig_len: Set to length of the calculated hash
  769. *
  770. * This computes input data signature according to selected algorithm.
  771. * Resulting signature value is placed in an allocated buffer, the
  772. * pointer is returned as *sigp. The length of the calculated
  773. * signature is returned via the sig_len pointer argument. The caller
  774. * should free *sigp.
  775. *
  776. * @return: 0, on success, -ve on error
  777. */
  778. int (*sign)(struct image_sign_info *info,
  779. const struct image_region region[],
  780. int region_count, uint8_t **sigp, uint *sig_len);
  781. /**
  782. * add_verify_data() - Add verification information to FDT
  783. *
  784. * Add public key information to the FDT node, suitable for
  785. * verification at run-time. The information added depends on the
  786. * algorithm being used.
  787. *
  788. * @info: Specifies key and FIT information
  789. * @keydest: Destination FDT blob for public key data
  790. * @return: 0, on success, -ve on error
  791. */
  792. int (*add_verify_data)(struct image_sign_info *info, void *keydest);
  793. /**
  794. * verify() - Verify a signature against some data
  795. *
  796. * @info: Specifies key and FIT information
  797. * @data: Pointer to the input data
  798. * @data_len: Data length
  799. * @sig: Signature
  800. * @sig_len: Number of bytes in signature
  801. * @return 0 if verified, -ve on error
  802. */
  803. int (*verify)(struct image_sign_info *info,
  804. const struct image_region region[], int region_count,
  805. uint8_t *sig, uint sig_len);
  806. };
  807. /**
  808. * image_get_sig_algo() - Look up a signature algortihm
  809. *
  810. * @param name Name of algorithm
  811. * @return pointer to algorithm information, or NULL if not found
  812. */
  813. struct image_sig_algo *image_get_sig_algo(const char *name);
  814. /**
  815. * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
  816. *
  817. * @fit: FIT to check
  818. * @image_noffset: Offset of image node to check
  819. * @data: Image data to check
  820. * @size: Size of image data
  821. * @sig_blob: FDT containing public keys
  822. * @no_sigsp: Returns 1 if no signatures were required, and
  823. * therefore nothing was checked. The caller may wish
  824. * to fall back to other mechanisms, or refuse to
  825. * boot.
  826. * @return 0 if all verified ok, <0 on error
  827. */
  828. int fit_image_verify_required_sigs(const void *fit, int image_noffset,
  829. const char *data, size_t size, const void *sig_blob,
  830. int *no_sigsp);
  831. /**
  832. * fit_image_check_sig() - Check a single image signature node
  833. *
  834. * @fit: FIT to check
  835. * @noffset: Offset of signature node to check
  836. * @data: Image data to check
  837. * @size: Size of image data
  838. * @required_keynode: Offset in the control FDT of the required key node,
  839. * if any. If this is given, then the image wil not
  840. * pass verification unless that key is used. If this is
  841. * -1 then any signature will do.
  842. * @err_msgp: In the event of an error, this will be pointed to a
  843. * help error string to display to the user.
  844. * @return 0 if all verified ok, <0 on error
  845. */
  846. int fit_image_check_sig(const void *fit, int noffset, const void *data,
  847. size_t size, int required_keynode, char **err_msgp);
  848. /**
  849. * fit_region_make_list() - Make a list of regions to hash
  850. *
  851. * Given a list of FIT regions (offset, size) provided by libfdt, create
  852. * a list of regions (void *, size) for use by the signature creationg
  853. * and verification code.
  854. *
  855. * @fit: FIT image to process
  856. * @fdt_regions: Regions as returned by libfdt
  857. * @count: Number of regions returned by libfdt
  858. * @region: Place to put list of regions (NULL to allocate it)
  859. * @return pointer to list of regions, or NULL if out of memory
  860. */
  861. struct image_region *fit_region_make_list(const void *fit,
  862. struct fdt_region *fdt_regions, int count,
  863. struct image_region *region);
  864. static inline int fit_image_check_target_arch(const void *fdt, int node)
  865. {
  866. return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
  867. }
  868. #ifdef CONFIG_FIT_VERBOSE
  869. #define fit_unsupported(msg) printf("! %s:%d " \
  870. "FIT images not supported for '%s'\n", \
  871. __FILE__, __LINE__, (msg))
  872. #define fit_unsupported_reset(msg) printf("! %s:%d " \
  873. "FIT images not supported for '%s' " \
  874. "- must reset board to recover!\n", \
  875. __FILE__, __LINE__, (msg))
  876. #else
  877. #define fit_unsupported(msg)
  878. #define fit_unsupported_reset(msg)
  879. #endif /* CONFIG_FIT_VERBOSE */
  880. #endif /* CONFIG_FIT */
  881. #endif /* __IMAGE_H__ */