doc/mkimage.1

   1 .TH MKIMAGE 1 "2022-02-07"
   2
   3 .SH NAME
   4 mkimage \- Generate image for U-Boot
   5 .SH SYNOPSIS
   6 .B mkimage
   7 .RB [ \-T " \fItype\fP] " \-l " [\fIuimage file name\fP]"
   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 .TP
  51 .BI "\-T [" "image type" "]"
  52 Parse image file as type.
  53 Pass \-h as the image to see the list of supported image type.
  54 Without this option image type is autodetected.
  55
  56 .P
  57 .B Create old legacy image:
  58
  59 .TP
  60 .BI "\-A [" "architecture" "]"
  61 Set architecture. Pass \-h as the architecture to see the list of supported architectures.
  62
  63 .TP
  64 .BI "\-O [" "os" "]"
  65 Set operating system. bootm command of u-boot changes boot method by os type.
  66 Pass \-h as the OS to see the list of supported OS.
  67
  68 .TP
  69 .BI "\-T [" "image type" "]"
  70 Set image type.
  71 Pass \-h as the image to see the list of supported image type.
  72
  73 .TP
  74 .BI "\-C [" "compression type" "]"
  75 Set compression type.
  76 Pass \-h as the compression to see the list of supported compression type.
  77
  78 .TP
  79 .BI "\-a [" "load address" "]"
  80 Set load address with a hex number.
  81
  82 .TP
  83 .BI "\-e [" "entry point" "]"
  84 Set entry point with a hex number.
  85
  86 .TP
  87 .BI "\-l"
  88 List the contents of an image.
  89
  90 .TP
  91 .BI "\-n [" "image name" "]"
  92 Set image name to 'image name'.
  93
  94 .TP
  95 .BI "\-d [" "image data file" "]"
  96 Use image data from 'image data file'.
  97
  98 .TP
  99 .BI "\-x"
 100 Set XIP (execute in place) flag.
 101
 102 .P
 103 .B Create FIT image:
 104
 105 .TP
 106 .BI "\-b [" "device tree file" "]
 107 Appends the device tree binary file (.dtb) to the FIT.
 108
 109 .TP
 110 .BI "\-c [" "comment" "]"
 111 Specifies a comment to be added when signing. This is typically a useful
 112 message which describes how the image was signed or some other useful
 113 information.
 114
 115 .TP
 116 .BI "\-D [" "dtc options" "]"
 117 Provide special options to the device tree compiler that is used to
 118 create the image.
 119
 120 .TP
 121 .BI "\-E
 122 After processing, move the image data outside the FIT and store a data offset
 123 in the FIT. Images will be placed one after the other immediately after the
 124 FIT, with each one aligned to a 4-byte boundary. The existing 'data' property
 125 in each image will be replaced with 'data-offset' and 'data-size' properties.
 126 A 'data-offset' of 0 indicates that it starts in the first (4-byte aligned)
 127 byte after the FIT.
 128
 129 .TP
 130 .BI "\-f [" "image tree source file" " | " "auto" "]"
 131 Image tree source file that describes the structure and contents of the
 132 FIT image.
 133
 134 This can be automatically generated for some simple cases.
 135 Use "-f auto" for this. In that case the arguments -d, -A, -O, -T, -C, -a
 136 and -e are used to specify the image to include in the FIT and its attributes.
 137 No .its file is required.
 138
 139 .TP
 140 .BI "\-F"
 141 Indicates that an existing FIT image should be modified. No dtc
 142 compilation is performed and the \-f flag should not be given.
 143 This can be used to sign images with additional keys after initial image
 144 creation.
 145
 146 .TP
 147 .BI "\-i [" "ramdisk_file" "]"
 148 Appends the ramdisk file to the FIT.
 149
 150 .TP
 151 .BI "\-k [" "key_directory" "]"
 152 Specifies the directory containing keys to use for signing. This directory
 153 should contain a private key file <name>.key for use with signing and a
 154 certificate <name>.crt (containing the public key) for use with verification.
 155
 156 .TP
 157 .BI "\-K [" "key_destination" "]"
 158 Specifies a compiled device tree binary file (typically .dtb) to write
 159 public key information into. When a private key is used to sign an image,
 160 the corresponding public key is written into this file for for run-time
 161 verification. Typically the file here is the device tree binary used by
 162 CONFIG_OF_CONTROL in U-Boot.
 163
 164 .TP
 165 .BI "\-o [" "signing algorithm" "]"
 166 Specifies the algorithm to be used for signing a FIT image. The default is
 167 taken from the signature node's 'algo' property.
 168
 169 .TP
 170 .BI "\-p [" "external position" "]"
 171 Place external data at a static external position. See \-E. Instead of writing
 172 a 'data-offset' property defining the offset from the end of the FIT, \-p will
 173 use 'data-position' as the absolute position from the base of the FIT.
 174
 175 .TP
 176 .BI "\-r
 177 Specifies that keys used to sign the FIT are required. This means that they
 178 must be verified for the image to boot. Without this option, the verification
 179 will be optional (useful for testing but not for release).
 180
 181 .TP
 182 .BI "\-t
 183 Update the timestamp in the FIT.
 184
 185 Normally the FIT timestamp is created the first time mkimage is run on a FIT,
 186 when converting the source .its to the binary .fit file. This corresponds to
 187 using the -f flag. But if the original input to mkimage is a binary file
 188 (already compiled) then the timestamp is assumed to have been set previously.
 189
 190 .SH EXAMPLES
 191
 192 List image information:
 193 .nf
 194 .B mkimage -l uImage
 195 .fi
 196 .P
 197 Create legacy image with compressed PowerPC Linux kernel:
 198 .nf
 199 .B mkimage -A powerpc -O linux -T kernel -C gzip \\\\
 200 .br
 201 .B -a 0 -e 0 -n Linux -d vmlinux.gz uImage
 202 .fi
 203 .P
 204 Create FIT image with compressed PowerPC Linux kernel:
 205 .nf
 206 .B mkimage -f kernel.its kernel.itb
 207 .fi
 208 .P
 209 Create FIT image with compressed kernel and sign it with keys in the
 210 /public/signing-keys directory. Add corresponding public keys into u-boot.dtb,
 211 skipping those for which keys cannot be found. Also add a comment.
 212 .nf
 213 .B mkimage -f kernel.its -k /public/signing-keys -K u-boot.dtb \\\\
 214 .br
 215 .B -c """Kernel 3.8 image for production devices""" kernel.itb
 216 .fi
 217
 218 .P
 219 Update an existing FIT image, signing it with additional keys.
 220 Add corresponding public keys into u-boot.dtb. This will resign all images
 221 with keys that are available in the new directory. Images that request signing
 222 with unavailable keys are skipped.
 223 .nf
 224 .B mkimage -F -k /secret/signing-keys -K u-boot.dtb \\\\
 225 .br
 226 .B -c """Kernel 3.8 image for production devices""" kernel.itb
 227 .fi
 228
 229 .P
 230 Create a FIT image containing a kernel, using automatic mode. No .its file
 231 is required.
 232 .nf
 233 .B mkimage -f auto -A arm -O linux -T kernel -C none -a 43e00000 -e 0 \\\\
 234 .br
 235 .B -c """Kernel 4.4 image for production devices""" -d vmlinuz kernel.itb
 236 .fi
 237 .P
 238 Create a FIT image containing a kernel and some device tree files, using
 239 automatic mode. No .its file is required.
 240 .nf
 241 .B mkimage -f auto -A arm -O linux -T kernel -C none -a 43e00000 -e 0 \\\\
 242 .br
 243 .B -c """Kernel 4.4 image for production devices""" -d vmlinuz \\\\
 244 .B -b /path/to/rk3288-firefly.dtb -b /path/to/rk3288-jerry.dtb kernel.itb
 245 .fi
 246
 247 .SH HOMEPAGE
 248 http://www.denx.de/wiki/U-Boot/WebHome
 249 .PP
 250 .SH AUTHOR
 251 This manual page was written by Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
 252 and Wolfgang Denk <wd@denx.de>. It was updated for image signing by
 253 Simon Glass <sjg@chromium.org>.