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