include/image.h

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