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