image.h 52 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2008 Semihalf
  4. *
  5. * (C) Copyright 2000-2005
  6. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  7. ********************************************************************
  8. * NOTE: This header file defines an interface to U-Boot. Including
  9. * this (unmodified) header file in another file is considered normal
  10. * use of U-Boot, and does *not* fall under the heading of "derived
  11. * work".
  12. ********************************************************************
  13. */
  14. #ifndef __IMAGE_H__
  15. #define __IMAGE_H__
  16. #include "compiler.h"
  17. #include <asm/byteorder.h>
  18. #include <stdbool.h>
  19. /* Define this to avoid #ifdefs later on */
  20. struct lmb;
  21. struct fdt_region;
  22. #ifdef USE_HOSTCC
  23. #include <sys/types.h>
  24. /* new uImage format support enabled on host */
  25. #define IMAGE_ENABLE_FIT 1
  26. #define IMAGE_ENABLE_OF_LIBFDT 1
  27. #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
  28. #define CONFIG_FIT_RSASSA_PSS 1
  29. #define CONFIG_MD5
  30. #define CONFIG_SHA1
  31. #define CONFIG_SHA256
  32. #define CONFIG_SHA384
  33. #define CONFIG_SHA512
  34. #define IMAGE_ENABLE_IGNORE 0
  35. #define IMAGE_INDENT_STRING ""
  36. #else
  37. #include <lmb.h>
  38. #include <asm/u-boot.h>
  39. #include <command.h>
  40. #include <linker_lists.h>
  41. /* Take notice of the 'ignore' property for hashes */
  42. #define IMAGE_ENABLE_IGNORE 1
  43. #define IMAGE_INDENT_STRING " "
  44. #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
  45. #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
  46. #endif /* USE_HOSTCC */
  47. #if IMAGE_ENABLE_FIT
  48. #include <hash.h>
  49. #include <linux/libfdt.h>
  50. #include <fdt_support.h>
  51. #endif /* IMAGE_ENABLE_FIT */
  52. #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
  53. # define IMAGE_BOOT_GET_CMDLINE 1
  54. #else
  55. # define IMAGE_BOOT_GET_CMDLINE 0
  56. #endif
  57. #ifdef CONFIG_OF_BOARD_SETUP
  58. # define IMAGE_OF_BOARD_SETUP 1
  59. #else
  60. # define IMAGE_OF_BOARD_SETUP 0
  61. #endif
  62. #ifdef CONFIG_OF_SYSTEM_SETUP
  63. # define IMAGE_OF_SYSTEM_SETUP 1
  64. #else
  65. # define IMAGE_OF_SYSTEM_SETUP 0
  66. #endif
  67. extern ulong image_load_addr; /* Default Load Address */
  68. extern ulong image_save_addr; /* Default Save Address */
  69. extern ulong image_save_size; /* Default Save Size */
  70. /* An invalid size, meaning that the image size is not known */
  71. #define IMAGE_SIZE_INVAL (-1UL)
  72. enum ih_category {
  73. IH_ARCH,
  74. IH_COMP,
  75. IH_OS,
  76. IH_TYPE,
  77. IH_COUNT,
  78. };
  79. /*
  80. * Operating System Codes
  81. *
  82. * The following are exposed to uImage header.
  83. * New IDs *MUST* be appended at the end of the list and *NEVER*
  84. * inserted for backward compatibility.
  85. */
  86. enum {
  87. IH_OS_INVALID = 0, /* Invalid OS */
  88. IH_OS_OPENBSD, /* OpenBSD */
  89. IH_OS_NETBSD, /* NetBSD */
  90. IH_OS_FREEBSD, /* FreeBSD */
  91. IH_OS_4_4BSD, /* 4.4BSD */
  92. IH_OS_LINUX, /* Linux */
  93. IH_OS_SVR4, /* SVR4 */
  94. IH_OS_ESIX, /* Esix */
  95. IH_OS_SOLARIS, /* Solaris */
  96. IH_OS_IRIX, /* Irix */
  97. IH_OS_SCO, /* SCO */
  98. IH_OS_DELL, /* Dell */
  99. IH_OS_NCR, /* NCR */
  100. IH_OS_LYNXOS, /* LynxOS */
  101. IH_OS_VXWORKS, /* VxWorks */
  102. IH_OS_PSOS, /* pSOS */
  103. IH_OS_QNX, /* QNX */
  104. IH_OS_U_BOOT, /* Firmware */
  105. IH_OS_RTEMS, /* RTEMS */
  106. IH_OS_ARTOS, /* ARTOS */
  107. IH_OS_UNITY, /* Unity OS */
  108. IH_OS_INTEGRITY, /* INTEGRITY */
  109. IH_OS_OSE, /* OSE */
  110. IH_OS_PLAN9, /* Plan 9 */
  111. IH_OS_OPENRTOS, /* OpenRTOS */
  112. IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
  113. IH_OS_TEE, /* Trusted Execution Environment */
  114. IH_OS_OPENSBI, /* RISC-V OpenSBI */
  115. IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
  116. IH_OS_COUNT,
  117. };
  118. /*
  119. * CPU Architecture Codes (supported by Linux)
  120. *
  121. * The following are exposed to uImage header.
  122. * New IDs *MUST* be appended at the end of the list and *NEVER*
  123. * inserted for backward compatibility.
  124. */
  125. enum {
  126. IH_ARCH_INVALID = 0, /* Invalid CPU */
  127. IH_ARCH_ALPHA, /* Alpha */
  128. IH_ARCH_ARM, /* ARM */
  129. IH_ARCH_I386, /* Intel x86 */
  130. IH_ARCH_IA64, /* IA64 */
  131. IH_ARCH_MIPS, /* MIPS */
  132. IH_ARCH_MIPS64, /* MIPS 64 Bit */
  133. IH_ARCH_PPC, /* PowerPC */
  134. IH_ARCH_S390, /* IBM S390 */
  135. IH_ARCH_SH, /* SuperH */
  136. IH_ARCH_SPARC, /* Sparc */
  137. IH_ARCH_SPARC64, /* Sparc 64 Bit */
  138. IH_ARCH_M68K, /* M68K */
  139. IH_ARCH_NIOS, /* Nios-32 */
  140. IH_ARCH_MICROBLAZE, /* MicroBlaze */
  141. IH_ARCH_NIOS2, /* Nios-II */
  142. IH_ARCH_BLACKFIN, /* Blackfin */
  143. IH_ARCH_AVR32, /* AVR32 */
  144. IH_ARCH_ST200, /* STMicroelectronics ST200 */
  145. IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
  146. IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
  147. IH_ARCH_OPENRISC, /* OpenRISC 1000 */
  148. IH_ARCH_ARM64, /* ARM64 */
  149. IH_ARCH_ARC, /* Synopsys DesignWare ARC */
  150. IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
  151. IH_ARCH_XTENSA, /* Xtensa */
  152. IH_ARCH_RISCV, /* RISC-V */
  153. IH_ARCH_COUNT,
  154. };
  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. * The following are exposed to uImage header.
  194. * New IDs *MUST* be appended at the end of the list and *NEVER*
  195. * inserted for backward compatibility.
  196. */
  197. enum {
  198. IH_TYPE_INVALID = 0, /* Invalid Image */
  199. IH_TYPE_STANDALONE, /* Standalone Program */
  200. IH_TYPE_KERNEL, /* OS Kernel Image */
  201. IH_TYPE_RAMDISK, /* RAMDisk Image */
  202. IH_TYPE_MULTI, /* Multi-File Image */
  203. IH_TYPE_FIRMWARE, /* Firmware Image */
  204. IH_TYPE_SCRIPT, /* Script file */
  205. IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
  206. IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
  207. IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
  208. IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
  209. IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
  210. IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
  211. IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
  212. /* OS Kernel Image, can run from any load address */
  213. IH_TYPE_KERNEL_NOLOAD,
  214. IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
  215. IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
  216. IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
  217. IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
  218. IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
  219. IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
  220. IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
  221. IH_TYPE_LOADABLE, /* A list of typeless images */
  222. IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
  223. IH_TYPE_RKSD, /* Rockchip SD card */
  224. IH_TYPE_RKSPI, /* Rockchip SPI image */
  225. IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
  226. IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
  227. IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
  228. IH_TYPE_FPGA, /* FPGA Image */
  229. IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
  230. IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
  231. IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
  232. IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
  233. IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
  234. IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
  235. IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
  236. IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
  237. IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
  238. IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
  239. IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
  240. IH_TYPE_COUNT, /* Number of image types */
  241. };
  242. /*
  243. * Compression Types
  244. *
  245. * The following are exposed to uImage header.
  246. * New IDs *MUST* be appended at the end of the list and *NEVER*
  247. * inserted for backward compatibility.
  248. */
  249. enum {
  250. IH_COMP_NONE = 0, /* No Compression Used */
  251. IH_COMP_GZIP, /* gzip Compression Used */
  252. IH_COMP_BZIP2, /* bzip2 Compression Used */
  253. IH_COMP_LZMA, /* lzma Compression Used */
  254. IH_COMP_LZO, /* lzo Compression Used */
  255. IH_COMP_LZ4, /* lz4 Compression Used */
  256. IH_COMP_ZSTD, /* zstd Compression Used */
  257. IH_COMP_COUNT,
  258. };
  259. #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
  260. #define IH_MAGIC 0x27051956 /* Image Magic Number */
  261. #define IH_NMLEN 32 /* Image Name Length */
  262. /* Reused from common.h */
  263. #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
  264. /*
  265. * Legacy format image header,
  266. * all data in network byte order (aka natural aka bigendian).
  267. */
  268. typedef struct image_header {
  269. uint32_t ih_magic; /* Image Header Magic Number */
  270. uint32_t ih_hcrc; /* Image Header CRC Checksum */
  271. uint32_t ih_time; /* Image Creation Timestamp */
  272. uint32_t ih_size; /* Image Data Size */
  273. uint32_t ih_load; /* Data Load Address */
  274. uint32_t ih_ep; /* Entry Point Address */
  275. uint32_t ih_dcrc; /* Image Data CRC Checksum */
  276. uint8_t ih_os; /* Operating System */
  277. uint8_t ih_arch; /* CPU architecture */
  278. uint8_t ih_type; /* Image Type */
  279. uint8_t ih_comp; /* Compression Type */
  280. uint8_t ih_name[IH_NMLEN]; /* Image Name */
  281. } image_header_t;
  282. typedef struct image_info {
  283. ulong start, end; /* start/end of blob */
  284. ulong image_start, image_len; /* start of image within blob, len of image */
  285. ulong load; /* load addr for the image */
  286. uint8_t comp, type, os; /* compression, type of image, os type */
  287. uint8_t arch; /* CPU architecture */
  288. } image_info_t;
  289. /*
  290. * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
  291. * routines.
  292. */
  293. typedef struct bootm_headers {
  294. /*
  295. * Legacy os image header, if it is a multi component image
  296. * then boot_get_ramdisk() and get_fdt() will attempt to get
  297. * data from second and third component accordingly.
  298. */
  299. image_header_t *legacy_hdr_os; /* image header pointer */
  300. image_header_t legacy_hdr_os_copy; /* header copy */
  301. ulong legacy_hdr_valid;
  302. #if IMAGE_ENABLE_FIT
  303. const char *fit_uname_cfg; /* configuration node unit name */
  304. void *fit_hdr_os; /* os FIT image header */
  305. const char *fit_uname_os; /* os subimage node unit name */
  306. int fit_noffset_os; /* os subimage node offset */
  307. void *fit_hdr_rd; /* init ramdisk FIT image header */
  308. const char *fit_uname_rd; /* init ramdisk subimage node unit name */
  309. int fit_noffset_rd; /* init ramdisk subimage node offset */
  310. void *fit_hdr_fdt; /* FDT blob FIT image header */
  311. const char *fit_uname_fdt; /* FDT blob subimage node unit name */
  312. int fit_noffset_fdt;/* FDT blob subimage node offset */
  313. void *fit_hdr_setup; /* x86 setup FIT image header */
  314. const char *fit_uname_setup; /* x86 setup subimage node name */
  315. int fit_noffset_setup;/* x86 setup subimage node offset */
  316. #endif
  317. #ifndef USE_HOSTCC
  318. image_info_t os; /* os image info */
  319. ulong ep; /* entry point of OS */
  320. ulong rd_start, rd_end;/* ramdisk start/end */
  321. char *ft_addr; /* flat dev tree address */
  322. ulong ft_len; /* length of flat device tree */
  323. ulong initrd_start;
  324. ulong initrd_end;
  325. ulong cmdline_start;
  326. ulong cmdline_end;
  327. struct bd_info *kbd;
  328. #endif
  329. int verify; /* env_get("verify")[0] != 'n' */
  330. #define BOOTM_STATE_START (0x00000001)
  331. #define BOOTM_STATE_FINDOS (0x00000002)
  332. #define BOOTM_STATE_FINDOTHER (0x00000004)
  333. #define BOOTM_STATE_LOADOS (0x00000008)
  334. #define BOOTM_STATE_RAMDISK (0x00000010)
  335. #define BOOTM_STATE_FDT (0x00000020)
  336. #define BOOTM_STATE_OS_CMDLINE (0x00000040)
  337. #define BOOTM_STATE_OS_BD_T (0x00000080)
  338. #define BOOTM_STATE_OS_PREP (0x00000100)
  339. #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
  340. #define BOOTM_STATE_OS_GO (0x00000400)
  341. int state;
  342. #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
  343. struct lmb lmb; /* for memory mgmt */
  344. #endif
  345. } bootm_headers_t;
  346. extern bootm_headers_t images;
  347. /*
  348. * Some systems (for example LWMON) have very short watchdog periods;
  349. * we must make sure to split long operations like memmove() or
  350. * checksum calculations into reasonable chunks.
  351. */
  352. #ifndef CHUNKSZ
  353. #define CHUNKSZ (64 * 1024)
  354. #endif
  355. #ifndef CHUNKSZ_CRC32
  356. #define CHUNKSZ_CRC32 (64 * 1024)
  357. #endif
  358. #ifndef CHUNKSZ_MD5
  359. #define CHUNKSZ_MD5 (64 * 1024)
  360. #endif
  361. #ifndef CHUNKSZ_SHA1
  362. #define CHUNKSZ_SHA1 (64 * 1024)
  363. #endif
  364. #define uimage_to_cpu(x) be32_to_cpu(x)
  365. #define cpu_to_uimage(x) cpu_to_be32(x)
  366. /*
  367. * Translation table for entries of a specific type; used by
  368. * get_table_entry_id() and get_table_entry_name().
  369. */
  370. typedef struct table_entry {
  371. int id;
  372. char *sname; /* short (input) name to find table entry */
  373. char *lname; /* long (output) name to print for messages */
  374. } table_entry_t;
  375. /*
  376. * Compression type and magic number mapping table.
  377. */
  378. struct comp_magic_map {
  379. int comp_id;
  380. const char *name;
  381. unsigned char magic[2];
  382. };
  383. /*
  384. * get_table_entry_id() scans the translation table trying to find an
  385. * entry that matches the given short name. If a matching entry is
  386. * found, it's id is returned to the caller.
  387. */
  388. int get_table_entry_id(const table_entry_t *table,
  389. const char *table_name, const char *name);
  390. /*
  391. * get_table_entry_name() scans the translation table trying to find
  392. * an entry that matches the given id. If a matching entry is found,
  393. * its long name is returned to the caller.
  394. */
  395. char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
  396. const char *genimg_get_os_name(uint8_t os);
  397. /**
  398. * genimg_get_os_short_name() - get the short name for an OS
  399. *
  400. * @param os OS (IH_OS_...)
  401. * @return OS short name, or "unknown" if unknown
  402. */
  403. const char *genimg_get_os_short_name(uint8_t comp);
  404. const char *genimg_get_arch_name(uint8_t arch);
  405. /**
  406. * genimg_get_arch_short_name() - get the short name for an architecture
  407. *
  408. * @param arch Architecture type (IH_ARCH_...)
  409. * @return architecture short name, or "unknown" if unknown
  410. */
  411. const char *genimg_get_arch_short_name(uint8_t arch);
  412. const char *genimg_get_type_name(uint8_t type);
  413. /**
  414. * genimg_get_type_short_name() - get the short name for an image type
  415. *
  416. * @param type Image type (IH_TYPE_...)
  417. * @return image short name, or "unknown" if unknown
  418. */
  419. const char *genimg_get_type_short_name(uint8_t type);
  420. const char *genimg_get_comp_name(uint8_t comp);
  421. /**
  422. * genimg_get_comp_short_name() - get the short name for a compression method
  423. *
  424. * @param comp compression method (IH_COMP_...)
  425. * @return compression method short name, or "unknown" if unknown
  426. */
  427. const char *genimg_get_comp_short_name(uint8_t comp);
  428. /**
  429. * genimg_get_cat_name() - Get the name of an item in a category
  430. *
  431. * @category: Category of item
  432. * @id: Item ID
  433. * @return name of item, or "Unknown ..." if unknown
  434. */
  435. const char *genimg_get_cat_name(enum ih_category category, uint id);
  436. /**
  437. * genimg_get_cat_short_name() - Get the short name of an item in a category
  438. *
  439. * @category: Category of item
  440. * @id: Item ID
  441. * @return short name of item, or "Unknown ..." if unknown
  442. */
  443. const char *genimg_get_cat_short_name(enum ih_category category, uint id);
  444. /**
  445. * genimg_get_cat_count() - Get the number of items in a category
  446. *
  447. * @category: Category to check
  448. * @return the number of items in the category (IH_xxx_COUNT)
  449. */
  450. int genimg_get_cat_count(enum ih_category category);
  451. /**
  452. * genimg_get_cat_desc() - Get the description of a category
  453. *
  454. * @category: Category to check
  455. * @return the description of a category, e.g. "architecture". This
  456. * effectively converts the enum to a string.
  457. */
  458. const char *genimg_get_cat_desc(enum ih_category category);
  459. /**
  460. * genimg_cat_has_id() - Check whether a category has an item
  461. *
  462. * @category: Category to check
  463. * @id: Item ID
  464. * @return true or false as to whether a category has an item
  465. */
  466. bool genimg_cat_has_id(enum ih_category category, uint id);
  467. int genimg_get_os_id(const char *name);
  468. int genimg_get_arch_id(const char *name);
  469. int genimg_get_type_id(const char *name);
  470. int genimg_get_comp_id(const char *name);
  471. void genimg_print_size(uint32_t size);
  472. #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
  473. defined(USE_HOSTCC)
  474. #define IMAGE_ENABLE_TIMESTAMP 1
  475. #else
  476. #define IMAGE_ENABLE_TIMESTAMP 0
  477. #endif
  478. void genimg_print_time(time_t timestamp);
  479. /* What to do with a image load address ('load = <> 'in the FIT) */
  480. enum fit_load_op {
  481. FIT_LOAD_IGNORED, /* Ignore load address */
  482. FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
  483. FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
  484. FIT_LOAD_REQUIRED, /* Must be provided */
  485. };
  486. int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
  487. ulong *setup_len);
  488. #ifndef USE_HOSTCC
  489. /* Image format types, returned by _get_format() routine */
  490. #define IMAGE_FORMAT_INVALID 0x00
  491. #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
  492. #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
  493. #endif
  494. #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
  495. #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
  496. ulong genimg_get_kernel_addr_fit(char * const img_addr,
  497. const char **fit_uname_config,
  498. const char **fit_uname_kernel);
  499. ulong genimg_get_kernel_addr(char * const img_addr);
  500. int genimg_get_format(const void *img_addr);
  501. int genimg_has_config(bootm_headers_t *images);
  502. int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
  503. uint8_t arch, const ulong *ld_start, ulong * const ld_len);
  504. int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
  505. uint8_t arch, ulong *rd_start, ulong *rd_end);
  506. /**
  507. * boot_get_loadable - routine to load a list of binaries to memory
  508. * @argc: Ignored Argument
  509. * @argv: Ignored Argument
  510. * @images: pointer to the bootm images structure
  511. * @arch: expected architecture for the image
  512. * @ld_start: Ignored Argument
  513. * @ld_len: Ignored Argument
  514. *
  515. * boot_get_loadable() will take the given FIT configuration, and look
  516. * for a field named "loadables". Loadables, is a list of elements in
  517. * the FIT given as strings. exe:
  518. * loadables = "linux_kernel", "fdt-2";
  519. * this function will attempt to parse each string, and load the
  520. * corresponding element from the FIT into memory. Once placed,
  521. * no aditional actions are taken.
  522. *
  523. * @return:
  524. * 0, if only valid images or no images are found
  525. * error code, if an error occurs during fit_image_load
  526. */
  527. int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
  528. uint8_t arch, const ulong *ld_start, ulong *const ld_len);
  529. #endif /* !USE_HOSTCC */
  530. int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
  531. ulong *setup_start, ulong *setup_len);
  532. /**
  533. * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
  534. *
  535. * This deals with all aspects of loading an DTB from a FIT.
  536. * The correct base image based on configuration will be selected, and
  537. * then any overlays specified will be applied (as present in fit_uname_configp).
  538. *
  539. * @param images Boot images structure
  540. * @param addr Address of FIT in memory
  541. * @param fit_unamep On entry this is the requested image name
  542. * (e.g. "kernel") or NULL to use the default. On exit
  543. * points to the selected image name
  544. * @param fit_uname_configp On entry this is the requested configuration
  545. * name (e.g. "conf-1") or NULL to use the default. On
  546. * exit points to the selected configuration name.
  547. * @param arch Expected architecture (IH_ARCH_...)
  548. * @param datap Returns address of loaded image
  549. * @param lenp Returns length of loaded image
  550. *
  551. * @return node offset of base image, or -ve error code on error
  552. */
  553. int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
  554. const char **fit_unamep, const char **fit_uname_configp,
  555. int arch, ulong *datap, ulong *lenp);
  556. /**
  557. * fit_image_load() - load an image from a FIT
  558. *
  559. * This deals with all aspects of loading an image from a FIT, including
  560. * selecting the right image based on configuration, verifying it, printing
  561. * out progress messages, checking the type/arch/os and optionally copying it
  562. * to the right load address.
  563. *
  564. * The property to look up is defined by image_type.
  565. *
  566. * @param images Boot images structure
  567. * @param addr Address of FIT in memory
  568. * @param fit_unamep On entry this is the requested image name
  569. * (e.g. "kernel") or NULL to use the default. On exit
  570. * points to the selected image name
  571. * @param fit_uname_configp On entry this is the requested configuration
  572. * name (e.g. "conf-1") or NULL to use the default. On
  573. * exit points to the selected configuration name.
  574. * @param arch Expected architecture (IH_ARCH_...)
  575. * @param image_type Required image type (IH_TYPE_...). If this is
  576. * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
  577. * also.
  578. * @param bootstage_id ID of starting bootstage to use for progress updates.
  579. * This will be added to the BOOTSTAGE_SUB values when
  580. * calling bootstage_mark()
  581. * @param load_op Decribes what to do with the load address
  582. * @param datap Returns address of loaded image
  583. * @param lenp Returns length of loaded image
  584. * @return node offset of image, or -ve error code on error
  585. */
  586. int fit_image_load(bootm_headers_t *images, ulong addr,
  587. const char **fit_unamep, const char **fit_uname_configp,
  588. int arch, int image_type, int bootstage_id,
  589. enum fit_load_op load_op, ulong *datap, ulong *lenp);
  590. /**
  591. * image_source_script() - Execute a script
  592. *
  593. * Executes a U-Boot script at a particular address in memory. The script should
  594. * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
  595. *
  596. * @addr: Address of script
  597. * @fit_uname: FIT subimage name
  598. * @return result code (enum command_ret_t)
  599. */
  600. int image_source_script(ulong addr, const char *fit_uname);
  601. #ifndef USE_HOSTCC
  602. /**
  603. * fit_get_node_from_config() - Look up an image a FIT by type
  604. *
  605. * This looks in the selected conf- node (images->fit_uname_cfg) for a
  606. * particular image type (e.g. "kernel") and then finds the image that is
  607. * referred to.
  608. *
  609. * For example, for something like:
  610. *
  611. * images {
  612. * kernel {
  613. * ...
  614. * };
  615. * };
  616. * configurations {
  617. * conf-1 {
  618. * kernel = "kernel";
  619. * };
  620. * };
  621. *
  622. * the function will return the node offset of the kernel@1 node, assuming
  623. * that conf-1 is the chosen configuration.
  624. *
  625. * @param images Boot images structure
  626. * @param prop_name Property name to look up (FIT_..._PROP)
  627. * @param addr Address of FIT in memory
  628. */
  629. int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
  630. ulong addr);
  631. int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
  632. bootm_headers_t *images,
  633. char **of_flat_tree, ulong *of_size);
  634. void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
  635. int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
  636. int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
  637. ulong *initrd_start, ulong *initrd_end);
  638. int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
  639. #ifdef CONFIG_SYS_BOOT_GET_KBD
  640. int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
  641. #endif /* CONFIG_SYS_BOOT_GET_KBD */
  642. #endif /* !USE_HOSTCC */
  643. /*******************************************************************/
  644. /* Legacy format specific code (prefixed with image_) */
  645. /*******************************************************************/
  646. static inline uint32_t image_get_header_size(void)
  647. {
  648. return (sizeof(image_header_t));
  649. }
  650. #define image_get_hdr_l(f) \
  651. static inline uint32_t image_get_##f(const image_header_t *hdr) \
  652. { \
  653. return uimage_to_cpu(hdr->ih_##f); \
  654. }
  655. image_get_hdr_l(magic) /* image_get_magic */
  656. image_get_hdr_l(hcrc) /* image_get_hcrc */
  657. image_get_hdr_l(time) /* image_get_time */
  658. image_get_hdr_l(size) /* image_get_size */
  659. image_get_hdr_l(load) /* image_get_load */
  660. image_get_hdr_l(ep) /* image_get_ep */
  661. image_get_hdr_l(dcrc) /* image_get_dcrc */
  662. #define image_get_hdr_b(f) \
  663. static inline uint8_t image_get_##f(const image_header_t *hdr) \
  664. { \
  665. return hdr->ih_##f; \
  666. }
  667. image_get_hdr_b(os) /* image_get_os */
  668. image_get_hdr_b(arch) /* image_get_arch */
  669. image_get_hdr_b(type) /* image_get_type */
  670. image_get_hdr_b(comp) /* image_get_comp */
  671. static inline char *image_get_name(const image_header_t *hdr)
  672. {
  673. return (char *)hdr->ih_name;
  674. }
  675. static inline uint32_t image_get_data_size(const image_header_t *hdr)
  676. {
  677. return image_get_size(hdr);
  678. }
  679. /**
  680. * image_get_data - get image payload start address
  681. * @hdr: image header
  682. *
  683. * image_get_data() returns address of the image payload. For single
  684. * component images it is image data start. For multi component
  685. * images it points to the null terminated table of sub-images sizes.
  686. *
  687. * returns:
  688. * image payload data start address
  689. */
  690. static inline ulong image_get_data(const image_header_t *hdr)
  691. {
  692. return ((ulong)hdr + image_get_header_size());
  693. }
  694. static inline uint32_t image_get_image_size(const image_header_t *hdr)
  695. {
  696. return (image_get_size(hdr) + image_get_header_size());
  697. }
  698. static inline ulong image_get_image_end(const image_header_t *hdr)
  699. {
  700. return ((ulong)hdr + image_get_image_size(hdr));
  701. }
  702. #define image_set_hdr_l(f) \
  703. static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
  704. { \
  705. hdr->ih_##f = cpu_to_uimage(val); \
  706. }
  707. image_set_hdr_l(magic) /* image_set_magic */
  708. image_set_hdr_l(hcrc) /* image_set_hcrc */
  709. image_set_hdr_l(time) /* image_set_time */
  710. image_set_hdr_l(size) /* image_set_size */
  711. image_set_hdr_l(load) /* image_set_load */
  712. image_set_hdr_l(ep) /* image_set_ep */
  713. image_set_hdr_l(dcrc) /* image_set_dcrc */
  714. #define image_set_hdr_b(f) \
  715. static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
  716. { \
  717. hdr->ih_##f = val; \
  718. }
  719. image_set_hdr_b(os) /* image_set_os */
  720. image_set_hdr_b(arch) /* image_set_arch */
  721. image_set_hdr_b(type) /* image_set_type */
  722. image_set_hdr_b(comp) /* image_set_comp */
  723. static inline void image_set_name(image_header_t *hdr, const char *name)
  724. {
  725. strncpy(image_get_name(hdr), name, IH_NMLEN);
  726. }
  727. int image_check_hcrc(const image_header_t *hdr);
  728. int image_check_dcrc(const image_header_t *hdr);
  729. #ifndef USE_HOSTCC
  730. ulong env_get_bootm_low(void);
  731. phys_size_t env_get_bootm_size(void);
  732. phys_size_t env_get_bootm_mapsize(void);
  733. #endif
  734. void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
  735. static inline int image_check_magic(const image_header_t *hdr)
  736. {
  737. return (image_get_magic(hdr) == IH_MAGIC);
  738. }
  739. static inline int image_check_type(const image_header_t *hdr, uint8_t type)
  740. {
  741. return (image_get_type(hdr) == type);
  742. }
  743. static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
  744. {
  745. #ifndef USE_HOSTCC
  746. /* Let's assume that sandbox can load any architecture */
  747. if (IS_ENABLED(CONFIG_SANDBOX))
  748. return true;
  749. #endif
  750. return (image_get_arch(hdr) == arch) ||
  751. (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
  752. }
  753. static inline int image_check_os(const image_header_t *hdr, uint8_t os)
  754. {
  755. return (image_get_os(hdr) == os);
  756. }
  757. ulong image_multi_count(const image_header_t *hdr);
  758. void image_multi_getimg(const image_header_t *hdr, ulong idx,
  759. ulong *data, ulong *len);
  760. void image_print_contents(const void *hdr);
  761. #ifndef USE_HOSTCC
  762. static inline int image_check_target_arch(const image_header_t *hdr)
  763. {
  764. #ifndef IH_ARCH_DEFAULT
  765. # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
  766. #endif
  767. return image_check_arch(hdr, IH_ARCH_DEFAULT);
  768. }
  769. #endif /* USE_HOSTCC */
  770. /**
  771. * image_decomp_type() - Find out compression type of an image
  772. *
  773. * @buf: Address in U-Boot memory where image is loaded.
  774. * @len: Length of the compressed image.
  775. * @return compression type or IH_COMP_NONE if not compressed.
  776. *
  777. * Note: Only following compression types are supported now.
  778. * lzo, lzma, gzip, bzip2
  779. */
  780. int image_decomp_type(const unsigned char *buf, ulong len);
  781. /**
  782. * image_decomp() - decompress an image
  783. *
  784. * @comp: Compression algorithm that is used (IH_COMP_...)
  785. * @load: Destination load address in U-Boot memory
  786. * @image_start Image start address (where we are decompressing from)
  787. * @type: OS type (IH_OS_...)
  788. * @load_bug: Place to decompress to
  789. * @image_buf: Address to decompress from
  790. * @image_len: Number of bytes in @image_buf to decompress
  791. * @unc_len: Available space for decompression
  792. * @return 0 if OK, -ve on error (BOOTM_ERR_...)
  793. */
  794. int image_decomp(int comp, ulong load, ulong image_start, int type,
  795. void *load_buf, void *image_buf, ulong image_len,
  796. uint unc_len, ulong *load_end);
  797. /**
  798. * Set up properties in the FDT
  799. *
  800. * This sets up properties in the FDT that is to be passed to linux.
  801. *
  802. * @images: Images information
  803. * @blob: FDT to update
  804. * @of_size: Size of the FDT
  805. * @lmb: Points to logical memory block structure
  806. * @return 0 if ok, <0 on failure
  807. */
  808. int image_setup_libfdt(bootm_headers_t *images, void *blob,
  809. int of_size, struct lmb *lmb);
  810. /**
  811. * Set up the FDT to use for booting a kernel
  812. *
  813. * This performs ramdisk setup, sets up the FDT if required, and adds
  814. * paramters to the FDT if libfdt is available.
  815. *
  816. * @param images Images information
  817. * @return 0 if ok, <0 on failure
  818. */
  819. int image_setup_linux(bootm_headers_t *images);
  820. /**
  821. * bootz_setup() - Extract stat and size of a Linux xImage
  822. *
  823. * @image: Address of image
  824. * @start: Returns start address of image
  825. * @end : Returns end address of image
  826. * @return 0 if OK, 1 if the image was not recognised
  827. */
  828. int bootz_setup(ulong image, ulong *start, ulong *end);
  829. /**
  830. * Return the correct start address and size of a Linux aarch64 Image.
  831. *
  832. * @image: Address of image
  833. * @start: Returns start address of image
  834. * @size : Returns size image
  835. * @force_reloc: Ignore image->ep field, always place image to RAM start
  836. * @return 0 if OK, 1 if the image was not recognised
  837. */
  838. int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
  839. bool force_reloc);
  840. /*******************************************************************/
  841. /* New uImage format specific code (prefixed with fit_) */
  842. /*******************************************************************/
  843. #define FIT_IMAGES_PATH "/images"
  844. #define FIT_CONFS_PATH "/configurations"
  845. /* hash/signature/key node */
  846. #define FIT_HASH_NODENAME "hash"
  847. #define FIT_ALGO_PROP "algo"
  848. #define FIT_VALUE_PROP "value"
  849. #define FIT_IGNORE_PROP "uboot-ignore"
  850. #define FIT_SIG_NODENAME "signature"
  851. #define FIT_KEY_REQUIRED "required"
  852. #define FIT_KEY_HINT "key-name-hint"
  853. /* cipher node */
  854. #define FIT_CIPHER_NODENAME "cipher"
  855. #define FIT_ALGO_PROP "algo"
  856. /* image node */
  857. #define FIT_DATA_PROP "data"
  858. #define FIT_DATA_POSITION_PROP "data-position"
  859. #define FIT_DATA_OFFSET_PROP "data-offset"
  860. #define FIT_DATA_SIZE_PROP "data-size"
  861. #define FIT_TIMESTAMP_PROP "timestamp"
  862. #define FIT_DESC_PROP "description"
  863. #define FIT_ARCH_PROP "arch"
  864. #define FIT_TYPE_PROP "type"
  865. #define FIT_OS_PROP "os"
  866. #define FIT_COMP_PROP "compression"
  867. #define FIT_ENTRY_PROP "entry"
  868. #define FIT_LOAD_PROP "load"
  869. /* configuration node */
  870. #define FIT_KERNEL_PROP "kernel"
  871. #define FIT_RAMDISK_PROP "ramdisk"
  872. #define FIT_FDT_PROP "fdt"
  873. #define FIT_LOADABLE_PROP "loadables"
  874. #define FIT_DEFAULT_PROP "default"
  875. #define FIT_SETUP_PROP "setup"
  876. #define FIT_FPGA_PROP "fpga"
  877. #define FIT_FIRMWARE_PROP "firmware"
  878. #define FIT_STANDALONE_PROP "standalone"
  879. #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
  880. #if IMAGE_ENABLE_FIT
  881. /* cmdline argument format parsing */
  882. int fit_parse_conf(const char *spec, ulong addr_curr,
  883. ulong *addr, const char **conf_name);
  884. int fit_parse_subimage(const char *spec, ulong addr_curr,
  885. ulong *addr, const char **image_name);
  886. int fit_get_subimage_count(const void *fit, int images_noffset);
  887. void fit_print_contents(const void *fit);
  888. void fit_image_print(const void *fit, int noffset, const char *p);
  889. /**
  890. * fit_get_end - get FIT image size
  891. * @fit: pointer to the FIT format image header
  892. *
  893. * returns:
  894. * size of the FIT image (blob) in memory
  895. */
  896. static inline ulong fit_get_size(const void *fit)
  897. {
  898. return fdt_totalsize(fit);
  899. }
  900. /**
  901. * fit_get_end - get FIT image end
  902. * @fit: pointer to the FIT format image header
  903. *
  904. * returns:
  905. * end address of the FIT image (blob) in memory
  906. */
  907. ulong fit_get_end(const void *fit);
  908. /**
  909. * fit_get_name - get FIT node name
  910. * @fit: pointer to the FIT format image header
  911. *
  912. * returns:
  913. * NULL, on error
  914. * pointer to node name, on success
  915. */
  916. static inline const char *fit_get_name(const void *fit_hdr,
  917. int noffset, int *len)
  918. {
  919. return fdt_get_name(fit_hdr, noffset, len);
  920. }
  921. int fit_get_desc(const void *fit, int noffset, char **desc);
  922. int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
  923. int fit_image_get_node(const void *fit, const char *image_uname);
  924. int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
  925. int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
  926. int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
  927. int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
  928. int fit_image_get_load(const void *fit, int noffset, ulong *load);
  929. int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
  930. int fit_image_get_data(const void *fit, int noffset,
  931. const void **data, size_t *size);
  932. int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
  933. int fit_image_get_data_position(const void *fit, int noffset,
  934. int *data_position);
  935. int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
  936. int fit_image_get_data_size_unciphered(const void *fit, int noffset,
  937. size_t *data_size);
  938. int fit_image_get_data_and_size(const void *fit, int noffset,
  939. const void **data, size_t *size);
  940. int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
  941. int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
  942. int *value_len);
  943. int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
  944. int fit_cipher_data(const char *keydir, void *keydest, void *fit,
  945. const char *comment, int require_keys,
  946. const char *engine_id, const char *cmdname);
  947. /**
  948. * fit_add_verification_data() - add verification data to FIT image nodes
  949. *
  950. * @keydir: Directory containing keys
  951. * @kwydest: FDT blob to write public key information to
  952. * @fit: Pointer to the FIT format image header
  953. * @comment: Comment to add to signature nodes
  954. * @require_keys: Mark all keys as 'required'
  955. * @engine_id: Engine to use for signing
  956. * @cmdname: Command name used when reporting errors
  957. *
  958. * Adds hash values for all component images in the FIT blob.
  959. * Hashes are calculated for all component images which have hash subnodes
  960. * with algorithm property set to one of the supported hash algorithms.
  961. *
  962. * Also add signatures if signature nodes are present.
  963. *
  964. * returns
  965. * 0, on success
  966. * libfdt error code, on failure
  967. */
  968. int fit_add_verification_data(const char *keydir, const char *keyfile,
  969. void *keydest, void *fit, const char *comment,
  970. int require_keys, const char *engine_id,
  971. const char *cmdname);
  972. int fit_image_verify_with_data(const void *fit, int image_noffset,
  973. const void *data, size_t size);
  974. int fit_image_verify(const void *fit, int noffset);
  975. int fit_config_verify(const void *fit, int conf_noffset);
  976. int fit_all_image_verify(const void *fit);
  977. int fit_config_decrypt(const void *fit, int conf_noffset);
  978. int fit_image_check_os(const void *fit, int noffset, uint8_t os);
  979. int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
  980. int fit_image_check_type(const void *fit, int noffset, uint8_t type);
  981. int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
  982. /**
  983. * fit_check_format() - Check that the FIT is valid
  984. *
  985. * This performs various checks on the FIT to make sure it is suitable for
  986. * use, looking for mandatory properties, nodes, etc.
  987. *
  988. * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
  989. * sure that there are no strange tags or broken nodes in the FIT.
  990. *
  991. * @fit: pointer to the FIT format image header
  992. * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
  993. * failed (e.g. due to bad structure), -ENOMSG if the description is
  994. * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
  995. * path is missing
  996. */
  997. int fit_check_format(const void *fit, ulong size);
  998. int fit_conf_find_compat(const void *fit, const void *fdt);
  999. /**
  1000. * fit_conf_get_node - get node offset for configuration of a given unit name
  1001. * @fit: pointer to the FIT format image header
  1002. * @conf_uname: configuration node unit name (NULL to use default)
  1003. *
  1004. * fit_conf_get_node() finds a configuration (within the '/configurations'
  1005. * parent node) of a provided unit name. If configuration is found its node
  1006. * offset is returned to the caller.
  1007. *
  1008. * When NULL is provided in second argument fit_conf_get_node() will search
  1009. * for a default configuration node instead. Default configuration node unit
  1010. * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
  1011. * node.
  1012. *
  1013. * returns:
  1014. * configuration node offset when found (>=0)
  1015. * negative number on failure (FDT_ERR_* code)
  1016. */
  1017. int fit_conf_get_node(const void *fit, const char *conf_uname);
  1018. int fit_conf_get_prop_node_count(const void *fit, int noffset,
  1019. const char *prop_name);
  1020. int fit_conf_get_prop_node_index(const void *fit, int noffset,
  1021. const char *prop_name, int index);
  1022. /**
  1023. * fit_conf_get_prop_node() - Get node refered to by a configuration
  1024. * @fit: FIT to check
  1025. * @noffset: Offset of conf@xxx node to check
  1026. * @prop_name: Property to read from the conf node
  1027. *
  1028. * The conf- nodes contain references to other nodes, using properties
  1029. * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
  1030. * return the offset of the node referred to (e.g. offset of node
  1031. * "/images/kernel".
  1032. */
  1033. int fit_conf_get_prop_node(const void *fit, int noffset,
  1034. const char *prop_name);
  1035. int fit_check_ramdisk(const void *fit, int os_noffset,
  1036. uint8_t arch, int verify);
  1037. #endif /* IMAGE_ENABLE_FIT */
  1038. int calculate_hash(const void *data, int data_len, const char *algo,
  1039. uint8_t *value, int *value_len);
  1040. /*
  1041. * At present we only support signing on the host, and verification on the
  1042. * device
  1043. */
  1044. #if defined(USE_HOSTCC)
  1045. # if defined(CONFIG_FIT_SIGNATURE)
  1046. # define IMAGE_ENABLE_SIGN 1
  1047. # define FIT_IMAGE_ENABLE_VERIFY 1
  1048. # include <openssl/evp.h>
  1049. # else
  1050. # define IMAGE_ENABLE_SIGN 0
  1051. # define FIT_IMAGE_ENABLE_VERIFY 0
  1052. # endif
  1053. #else
  1054. # define IMAGE_ENABLE_SIGN 0
  1055. # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
  1056. #endif
  1057. #if IMAGE_ENABLE_FIT
  1058. #ifdef USE_HOSTCC
  1059. void *image_get_host_blob(void);
  1060. void image_set_host_blob(void *host_blob);
  1061. # define gd_fdt_blob() image_get_host_blob()
  1062. #else
  1063. # define gd_fdt_blob() (gd->fdt_blob)
  1064. #endif
  1065. #endif /* IMAGE_ENABLE_FIT */
  1066. /*
  1067. * Information passed to the signing routines
  1068. *
  1069. * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
  1070. * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
  1071. * neither are valid, some operations might fail with EINVAL.
  1072. */
  1073. struct image_sign_info {
  1074. const char *keydir; /* Directory conaining keys */
  1075. const char *keyname; /* Name of key to use */
  1076. const char *keyfile; /* Filename of private or public key */
  1077. void *fit; /* Pointer to FIT blob */
  1078. int node_offset; /* Offset of signature node */
  1079. const char *name; /* Algorithm name */
  1080. struct checksum_algo *checksum; /* Checksum algorithm information */
  1081. struct padding_algo *padding; /* Padding algorithm information */
  1082. struct crypto_algo *crypto; /* Crypto algorithm information */
  1083. const void *fdt_blob; /* FDT containing public keys */
  1084. int required_keynode; /* Node offset of key to use: -1=any */
  1085. const char *require_keys; /* Value for 'required' property */
  1086. const char *engine_id; /* Engine to use for signing */
  1087. /*
  1088. * Note: the following two fields are always valid even w/o
  1089. * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
  1090. * the same on target and host. Otherwise, vboot test may fail.
  1091. */
  1092. const void *key; /* Pointer to public key in DER */
  1093. int keylen; /* Length of public key */
  1094. };
  1095. /* A part of an image, used for hashing */
  1096. struct image_region {
  1097. const void *data;
  1098. int size;
  1099. };
  1100. #if FIT_IMAGE_ENABLE_VERIFY
  1101. # include <u-boot/hash-checksum.h>
  1102. #endif
  1103. struct checksum_algo {
  1104. const char *name;
  1105. const int checksum_len;
  1106. const int der_len;
  1107. const uint8_t *der_prefix;
  1108. #if IMAGE_ENABLE_SIGN
  1109. const EVP_MD *(*calculate_sign)(void);
  1110. #endif
  1111. int (*calculate)(const char *name,
  1112. const struct image_region region[],
  1113. int region_count, uint8_t *checksum);
  1114. };
  1115. struct crypto_algo {
  1116. const char *name; /* Name of algorithm */
  1117. const int key_len;
  1118. /**
  1119. * sign() - calculate and return signature for given input data
  1120. *
  1121. * @info: Specifies key and FIT information
  1122. * @data: Pointer to the input data
  1123. * @data_len: Data length
  1124. * @sigp: Set to an allocated buffer holding the signature
  1125. * @sig_len: Set to length of the calculated hash
  1126. *
  1127. * This computes input data signature according to selected algorithm.
  1128. * Resulting signature value is placed in an allocated buffer, the
  1129. * pointer is returned as *sigp. The length of the calculated
  1130. * signature is returned via the sig_len pointer argument. The caller
  1131. * should free *sigp.
  1132. *
  1133. * @return: 0, on success, -ve on error
  1134. */
  1135. int (*sign)(struct image_sign_info *info,
  1136. const struct image_region region[],
  1137. int region_count, uint8_t **sigp, uint *sig_len);
  1138. /**
  1139. * add_verify_data() - Add verification information to FDT
  1140. *
  1141. * Add public key information to the FDT node, suitable for
  1142. * verification at run-time. The information added depends on the
  1143. * algorithm being used.
  1144. *
  1145. * @info: Specifies key and FIT information
  1146. * @keydest: Destination FDT blob for public key data
  1147. * @return: 0, on success, -ve on error
  1148. */
  1149. int (*add_verify_data)(struct image_sign_info *info, void *keydest);
  1150. /**
  1151. * verify() - Verify a signature against some data
  1152. *
  1153. * @info: Specifies key and FIT information
  1154. * @data: Pointer to the input data
  1155. * @data_len: Data length
  1156. * @sig: Signature
  1157. * @sig_len: Number of bytes in signature
  1158. * @return 0 if verified, -ve on error
  1159. */
  1160. int (*verify)(struct image_sign_info *info,
  1161. const struct image_region region[], int region_count,
  1162. uint8_t *sig, uint sig_len);
  1163. };
  1164. /* Declare a new U-Boot crypto algorithm handler */
  1165. #define U_BOOT_CRYPTO_ALGO(__name) \
  1166. ll_entry_declare(struct crypto_algo, __name, cryptos)
  1167. struct padding_algo {
  1168. const char *name;
  1169. int (*verify)(struct image_sign_info *info,
  1170. uint8_t *pad, int pad_len,
  1171. const uint8_t *hash, int hash_len);
  1172. };
  1173. /* Declare a new U-Boot padding algorithm handler */
  1174. #define U_BOOT_PADDING_ALGO(__name) \
  1175. ll_entry_declare(struct padding_algo, __name, paddings)
  1176. /**
  1177. * image_get_checksum_algo() - Look up a checksum algorithm
  1178. *
  1179. * @param full_name Name of algorithm in the form "checksum,crypto"
  1180. * @return pointer to algorithm information, or NULL if not found
  1181. */
  1182. struct checksum_algo *image_get_checksum_algo(const char *full_name);
  1183. /**
  1184. * image_get_crypto_algo() - Look up a cryptosystem algorithm
  1185. *
  1186. * @param full_name Name of algorithm in the form "checksum,crypto"
  1187. * @return pointer to algorithm information, or NULL if not found
  1188. */
  1189. struct crypto_algo *image_get_crypto_algo(const char *full_name);
  1190. /**
  1191. * image_get_padding_algo() - Look up a padding algorithm
  1192. *
  1193. * @param name Name of padding algorithm
  1194. * @return pointer to algorithm information, or NULL if not found
  1195. */
  1196. struct padding_algo *image_get_padding_algo(const char *name);
  1197. #if IMAGE_ENABLE_FIT
  1198. /**
  1199. * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
  1200. *
  1201. * @fit: FIT to check
  1202. * @image_noffset: Offset of image node to check
  1203. * @data: Image data to check
  1204. * @size: Size of image data
  1205. * @sig_blob: FDT containing public keys
  1206. * @no_sigsp: Returns 1 if no signatures were required, and
  1207. * therefore nothing was checked. The caller may wish
  1208. * to fall back to other mechanisms, or refuse to
  1209. * boot.
  1210. * @return 0 if all verified ok, <0 on error
  1211. */
  1212. int fit_image_verify_required_sigs(const void *fit, int image_noffset,
  1213. const char *data, size_t size, const void *sig_blob,
  1214. int *no_sigsp);
  1215. /**
  1216. * fit_image_check_sig() - Check a single image signature node
  1217. *
  1218. * @fit: FIT to check
  1219. * @noffset: Offset of signature node to check
  1220. * @data: Image data to check
  1221. * @size: Size of image data
  1222. * @required_keynode: Offset in the control FDT of the required key node,
  1223. * if any. If this is given, then the image wil not
  1224. * pass verification unless that key is used. If this is
  1225. * -1 then any signature will do.
  1226. * @err_msgp: In the event of an error, this will be pointed to a
  1227. * help error string to display to the user.
  1228. * @return 0 if all verified ok, <0 on error
  1229. */
  1230. int fit_image_check_sig(const void *fit, int noffset, const void *data,
  1231. size_t size, int required_keynode, char **err_msgp);
  1232. int fit_image_decrypt_data(const void *fit,
  1233. int image_noffset, int cipher_noffset,
  1234. const void *data, size_t size,
  1235. void **data_unciphered, size_t *size_unciphered);
  1236. /**
  1237. * fit_region_make_list() - Make a list of regions to hash
  1238. *
  1239. * Given a list of FIT regions (offset, size) provided by libfdt, create
  1240. * a list of regions (void *, size) for use by the signature creationg
  1241. * and verification code.
  1242. *
  1243. * @fit: FIT image to process
  1244. * @fdt_regions: Regions as returned by libfdt
  1245. * @count: Number of regions returned by libfdt
  1246. * @region: Place to put list of regions (NULL to allocate it)
  1247. * @return pointer to list of regions, or NULL if out of memory
  1248. */
  1249. struct image_region *fit_region_make_list(const void *fit,
  1250. struct fdt_region *fdt_regions, int count,
  1251. struct image_region *region);
  1252. static inline int fit_image_check_target_arch(const void *fdt, int node)
  1253. {
  1254. #ifndef USE_HOSTCC
  1255. return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
  1256. #else
  1257. return 0;
  1258. #endif
  1259. }
  1260. /*
  1261. * At present we only support ciphering on the host, and unciphering on the
  1262. * device
  1263. */
  1264. #if defined(USE_HOSTCC)
  1265. # if defined(CONFIG_FIT_CIPHER)
  1266. # define IMAGE_ENABLE_ENCRYPT 1
  1267. # define IMAGE_ENABLE_DECRYPT 1
  1268. # include <openssl/evp.h>
  1269. # else
  1270. # define IMAGE_ENABLE_ENCRYPT 0
  1271. # define IMAGE_ENABLE_DECRYPT 0
  1272. # endif
  1273. #else
  1274. # define IMAGE_ENABLE_ENCRYPT 0
  1275. # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
  1276. #endif
  1277. /* Information passed to the ciphering routines */
  1278. struct image_cipher_info {
  1279. const char *keydir; /* Directory containing keys */
  1280. const char *keyname; /* Name of key to use */
  1281. const char *ivname; /* Name of IV to use */
  1282. const void *fit; /* Pointer to FIT blob */
  1283. int node_noffset; /* Offset of the cipher node */
  1284. const char *name; /* Algorithm name */
  1285. struct cipher_algo *cipher; /* Cipher algorithm information */
  1286. const void *fdt_blob; /* FDT containing key and IV */
  1287. const void *key; /* Value of the key */
  1288. const void *iv; /* Value of the IV */
  1289. size_t size_unciphered; /* Size of the unciphered data */
  1290. };
  1291. struct cipher_algo {
  1292. const char *name; /* Name of algorithm */
  1293. int key_len; /* Length of the key */
  1294. int iv_len; /* Length of the IV */
  1295. #if IMAGE_ENABLE_ENCRYPT
  1296. const EVP_CIPHER * (*calculate_type)(void);
  1297. #endif
  1298. int (*encrypt)(struct image_cipher_info *info,
  1299. const unsigned char *data, int data_len,
  1300. unsigned char **cipher, int *cipher_len);
  1301. int (*add_cipher_data)(struct image_cipher_info *info,
  1302. void *keydest, void *fit, int node_noffset);
  1303. int (*decrypt)(struct image_cipher_info *info,
  1304. const void *cipher, size_t cipher_len,
  1305. void **data, size_t *data_len);
  1306. };
  1307. int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
  1308. struct cipher_algo *image_get_cipher_algo(const char *full_name);
  1309. #ifdef CONFIG_FIT_VERBOSE
  1310. #define fit_unsupported(msg) printf("! %s:%d " \
  1311. "FIT images not supported for '%s'\n", \
  1312. __FILE__, __LINE__, (msg))
  1313. #define fit_unsupported_reset(msg) printf("! %s:%d " \
  1314. "FIT images not supported for '%s' " \
  1315. "- must reset board to recover!\n", \
  1316. __FILE__, __LINE__, (msg))
  1317. #else
  1318. #define fit_unsupported(msg)
  1319. #define fit_unsupported_reset(msg)
  1320. #endif /* CONFIG_FIT_VERBOSE */
  1321. #endif /* CONFIG_FIT */
  1322. #if !defined(USE_HOSTCC)
  1323. #if defined(CONFIG_ANDROID_BOOT_IMAGE)
  1324. struct andr_img_hdr;
  1325. int android_image_check_header(const struct andr_img_hdr *hdr);
  1326. int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
  1327. ulong *os_data, ulong *os_len);
  1328. int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
  1329. ulong *rd_data, ulong *rd_len);
  1330. int android_image_get_second(const struct andr_img_hdr *hdr,
  1331. ulong *second_data, ulong *second_len);
  1332. bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
  1333. bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
  1334. u32 *size);
  1335. ulong android_image_get_end(const struct andr_img_hdr *hdr);
  1336. ulong android_image_get_kload(const struct andr_img_hdr *hdr);
  1337. ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
  1338. void android_print_contents(const struct andr_img_hdr *hdr);
  1339. #if !defined(CONFIG_SPL_BUILD)
  1340. bool android_image_print_dtb_contents(ulong hdr_addr);
  1341. #endif
  1342. #endif /* CONFIG_ANDROID_BOOT_IMAGE */
  1343. #endif /* !USE_HOSTCC */
  1344. /**
  1345. * board_fit_config_name_match() - Check for a matching board name
  1346. *
  1347. * This is used when SPL loads a FIT containing multiple device tree files
  1348. * and wants to work out which one to use. The description of each one is
  1349. * passed to this function. The description comes from the 'description' field
  1350. * in each (FDT) image node.
  1351. *
  1352. * @name: Device tree description
  1353. * @return 0 if this device tree should be used, non-zero to try the next
  1354. */
  1355. int board_fit_config_name_match(const char *name);
  1356. /**
  1357. * board_fit_image_post_process() - Do any post-process on FIT binary data
  1358. *
  1359. * This is used to do any sort of image manipulation, verification, decryption
  1360. * etc. in a platform or board specific way. Obviously, anything done here would
  1361. * need to be comprehended in how the images were prepared before being injected
  1362. * into the FIT creation (i.e. the binary blobs would have been pre-processed
  1363. * before being added to the FIT image).
  1364. *
  1365. * @fit: pointer to fit image
  1366. * @node: offset of image node
  1367. * @image: pointer to the image start pointer
  1368. * @size: pointer to the image size
  1369. * @return no return value (failure should be handled internally)
  1370. */
  1371. void board_fit_image_post_process(const void *fit, int node, void **p_image,
  1372. size_t *p_size);
  1373. #define FDT_ERROR ((ulong)(-1))
  1374. ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
  1375. /**
  1376. * fit_find_config_node() - Find the node for the best DTB in a FIT image
  1377. *
  1378. * A FIT image contains one or more DTBs. This function parses the
  1379. * configurations described in the FIT images and returns the node of
  1380. * the first matching DTB. To check if a DTB matches a board, this function
  1381. * calls board_fit_config_name_match(). If no matching DTB is found, it returns
  1382. * the node described by the default configuration if it exists.
  1383. *
  1384. * @fdt: pointer to flat device tree
  1385. * @return the node if found, -ve otherwise
  1386. */
  1387. int fit_find_config_node(const void *fdt);
  1388. /**
  1389. * Mapping of image types to function handlers to be invoked on the associated
  1390. * loaded images
  1391. *
  1392. * @type: Type of image, I.E. IH_TYPE_*
  1393. * @handler: Function to call on loaded image
  1394. */
  1395. struct fit_loadable_tbl {
  1396. int type;
  1397. /**
  1398. * handler() - Process a loaded image
  1399. *
  1400. * @data: Pointer to start of loaded image data
  1401. * @size: Size of loaded image data
  1402. */
  1403. void (*handler)(ulong data, size_t size);
  1404. };
  1405. /*
  1406. * Define a FIT loadable image type handler
  1407. *
  1408. * _type is a valid uimage_type ID as defined in the "Image Type" enum above
  1409. * _handler is the handler function to call after this image type is loaded
  1410. */
  1411. #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
  1412. ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
  1413. .type = _type, \
  1414. .handler = _handler, \
  1415. }
  1416. /**
  1417. * fit_update - update storage with FIT image
  1418. * @fit: Pointer to FIT image
  1419. *
  1420. * Update firmware on storage using FIT image as input.
  1421. * The storage area to be update will be identified by the name
  1422. * in FIT and matching it to "dfu_alt_info" variable.
  1423. *
  1424. * Return: 0 on success, non-zero otherwise
  1425. */
  1426. int fit_update(const void *fit);
  1427. #endif /* __IMAGE_H__ */