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