blob: f27da6b98bb95ef89abbc53d9c2f07d1cc195f5a [file] [log] [blame]
Nobuhiro Iwamatsucd153552010-06-16 10:38:24 +09001.TH MKIMAGE 1 "2010-05-16"
2
3.SH NAME
4mkimage \- Generate image for U-Boot
5.SH SYNOPSIS
6.B mkimage
7.RB [\fIoptions\fP]
8.SH "DESCRIPTION"
9The
10.B mkimage
11command is used to create images for use with the U-Boot boot loader.
12Thes eimages can contain the linux kernel, device tree blob, root file
13system image, firmware images etc., either separate or combined.
14
15.B mkimage
16supports two different formats:
17
18The old,
19.I legacy image
20format concatenates the individual parts (for example, kernel image,
21device tree blob and ramdisk image) and adds a 64 bytes header
22containing information about target architecture, operating system,
23image type, compression method, entry points, time stamp, checksums,
24etc.
25
26The new,
27.I FIT (Flattened Image Tree) format
28allows for more flexibility in handling images of various and also
29enhances integrity protection of images with stronger checksums.
30
31.SH "OPTIONS"
32
33.B List image information:
34
35.TP
36.BI "\-l [" "uimage file name" "]"
37mkimage lists the information contained in the header of an existing U-Boot image.
38
39.P
40.B Create old legacy image:
41
42.TP
43.BI "\-A [" "architecture" "]"
Loïc Minier3f1266d2011-01-04 02:32:36 +010044Set architecture. Pass \-h as the architecture to see the list of supported architectures.
Nobuhiro Iwamatsucd153552010-06-16 10:38:24 +090045
46.TP
47.BI "\-O [" "os" "]"
48Set operating system. bootm command of u-boot changes boot method by os type.
Loïc Minier3f1266d2011-01-04 02:32:36 +010049Pass \-h as the OS to see the list of supported OS.
Nobuhiro Iwamatsucd153552010-06-16 10:38:24 +090050
51.TP
52.BI "\-T [" "image type" "]"
53Set image type.
Loïc Minier3f1266d2011-01-04 02:32:36 +010054Pass \-h as the image to see the list of supported image type.
Nobuhiro Iwamatsucd153552010-06-16 10:38:24 +090055
56.TP
57.BI "\-C [" "compression type" "]"
58Set compression type.
Loïc Minier3f1266d2011-01-04 02:32:36 +010059Pass \-h as the compression to see the list of supported compression type.
Nobuhiro Iwamatsucd153552010-06-16 10:38:24 +090060
61.TP
62.BI "\-a [" "load addess" "]"
63Set load address with a hex number.
64
65.TP
66.BI "\-e [" "entry point" "]"
67Set entry point with a hex number.
68
69.TP
70.BI "\-n [" "image name" "]"
71Set image name to 'image name'.
72
73.TP
74.BI "\-d [" "image data file" "]"
75Use image data from 'image data file'.
76
77.TP
78.BI "\-x"
79Set XIP (execute in place) flag.
80
81.P
82.B Create FIT image:
83
84.TP
85.BI "\-D "dtc option"
86Provide special options to the device tree compiler that is used to
87create the image.
88
89.TP
90.BI "\-f "fit-image.its"
91Image tree source fine that descbres the structure and contents of the
92FIT image.
93
94.SH EXMAPLES
95
96List image information:
97.nf
98.B mkimage -l uImage
99.fi
100.P
101Create legacy image with compressed PowerPC Linux kernel:
102.nf
103.B mkimage -A powerpc -O linux -T kernel -C gzip \\\\
104.br
105.B -a 0 -e 0 -n Linux -d vmlinux.gz uImage
106.fi
107.P
108Create FIT image with compressed PowerPC Linux kernel:
109.nf
110.B mkimage -f kernel.its kernel.itb
111.fi
112
113.SH HOMEPAGE
114http://www.denx.de/wiki/U-Boot/WebHome
115.PP
116.SH AUTHOR
117This manual page was written by Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
118and Wolfgang Denk <wd@denx.de>