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