doc/mkimage.1

   1 .TH MKIMAGE 1 "2010-05-16"
   2
   3 .SH NAME
   4 mkimage \- Generate image for U-Boot
   5 .SH SYNOPSIS
   6 .B mkimage
   7 .RB "\-l [" "uimage file name" "]"
   8
   9 .B mkimage
  10 .RB [\fIoptions\fP] " \-f [" "image tree source file" "]" " [" "uimage file name" "]"
  11
  12 .B mkimage
  13 .RB [\fIoptions\fP] " (legacy mode)"
  14
  15 .SH "DESCRIPTION"
  16 The
  17 .B mkimage
  18 command is used to create images for use with the U-Boot boot loader.
  19 These images can contain the linux kernel, device tree blob, root file
  20 system image, firmware images etc., either separate or combined.
  21
  22 .B mkimage
  23 supports two different formats:
  24
  25 The old
  26 .I legacy image
  27 format concatenates the individual parts (for example, kernel image,
  28 device tree blob and ramdisk image) and adds a 64 bytes header
  29 containing information about target architecture, operating system,
  30 image type, compression method, entry points, time stamp, checksums,
  31 etc.
  32
  33 The new
  34 .I FIT (Flattened Image Tree) format
  35 allows for more flexibility in handling images of various types and also
  36 enhances integrity protection of images with stronger checksums. It also
  37 supports verified boot.
  38
  39 .SH "OPTIONS"
  40
  41 .B List image information:
  42
  43 .TP
  44 .BI "\-l [" "uimage file name" "]"
  45 mkimage lists the information contained in the header of an existing U-Boot image.
  46
  47 .P
  48 .B Create old legacy image:
  49
  50 .TP
  51 .BI "\-A [" "architecture" "]"
  52 Set architecture. Pass \-h as the architecture to see the list of supported architectures.
  53
  54 .TP
  55 .BI "\-O [" "os" "]"
  56 Set operating system. bootm command of u-boot changes boot method by os type.
  57 Pass \-h as the OS to see the list of supported OS.
  58
  59 .TP
  60 .BI "\-T [" "image type" "]"
  61 Set image type.
  62 Pass \-h as the image to see the list of supported image type.
  63
  64 .TP
  65 .BI "\-C [" "compression type" "]"
  66 Set compression type.
  67 Pass \-h as the compression to see the list of supported compression type.
  68
  69 .TP
  70 .BI "\-a [" "load addess" "]"
  71 Set load address with a hex number.
  72
  73 .TP
  74 .BI "\-e [" "entry point" "]"
  75 Set entry point with a hex number.
  76
  77 .TP
  78 .BI "\-l"
  79 List the contents of an image.
  80
  81 .TP
  82 .BI "\-n [" "image name" "]"
  83 Set image name to 'image name'.
  84
  85 .TP
  86 .BI "\-d [" "image data file" "]"
  87 Use image data from 'image data file'.
  88
  89 .TP
  90 .BI "\-x"
  91 Set XIP (execute in place) flag.
  92
  93 .P
  94 .B Create FIT image:
  95
  96 .TP
  97 .BI "\-D [" "dtc options" "]"
  98 Provide special options to the device tree compiler that is used to
  99 create the image.
 100
 101 .TP
 102 .BI "\-f [" "image tree source file" "]"
 103 Image tree source file that describes the structure and contents of the
 104 FIT image.
 105
 106 .TP
 107 .BI "\-k [" "key_directory" "]"
 108 Specifies the directory containing keys to use for signing. This directory
 109 should contain a private key file <name>.key for use with signing and a
 110 certificate <name>.crt (containing the public key) for use with verification.
 111
 112 .TP
 113 .BI "\-K [" "key_destination" "]"
 114 Specifies a compiled device tree binary file (typically .dtb) to write
 115 public key information into. When a private key is used to sign an image,
 116 the corresponding public key is written into this file for for run-time
 117 verification. Typically the file here is the device tree binary used by
 118 CONFIG_OF_CONTROL in U-Boot.
 119
 120 .SH EXAMPLES
 121
 122 List image information:
 123 .nf
 124 .B mkimage -l uImage
 125 .fi
 126 .P
 127 Create legacy image with compressed PowerPC Linux kernel:
 128 .nf
 129 .B mkimage -A powerpc -O linux -T kernel -C gzip \\\\
 130 .br
 131 .B -a 0 -e 0 -n Linux -d vmlinux.gz uImage
 132 .fi
 133 .P
 134 Create FIT image with compressed PowerPC Linux kernel:
 135 .nf
 136 .B mkimage -f kernel.its kernel.itb
 137 .fi
 138 .P
 139 Create FIT image with compressed kernel and sign it with keys in the
 140 /public/signing-keys directory. Add corresponding public keys into u-boot.dtb,
 141 skipping those for which keys cannot be found. Also add a comment.
 142 .nf
 143 .B mkimage -f kernel.its -k /public/signing-keys -K u-boot.dtb \\\\
 144 -c "Kernel 3.8 image for production devices" kernel.itb
 145 .fi
 146
 147 .SH HOMEPAGE
 148 http://www.denx.de/wiki/U-Boot/WebHome
 149 .PP
 150 .SH AUTHOR
 151 This manual page was written by Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
 152 and Wolfgang Denk <wd@denx.de>. It was updated for image signing by
 153 Simon Glass <sjg@chromium.org>.