image.h 52 KB

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