[u-boot.git] / doc / mkimage.1

.TH MKIMAGE 1 "2010-05-16"

.SH NAME
mkimage \- Generate image for U-Boot
.SH SYNOPSIS
.B mkimage
.RB [\fIoptions\fP]
.SH "DESCRIPTION"
The
.B mkimage
command is used to create images for use with the U-Boot boot loader.
These images can contain the linux kernel, device tree blob, root file
system image, firmware images etc., either separate or combined.

.B mkimage
supports two different formats:

The old
.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.

The new
.I FIT (Flattened Image Tree) format
allows for more flexibility in handling images of various types and also
enhances integrity protection of images with stronger checksums.

.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" "]"
Set architecture. Pass \-h as the architecture to see the list of supported architectures.

.TP
.BI "\-O [" "os" "]"
Set operating system. bootm command of u-boot changes boot method by os type.
Pass \-h as the OS to see the list of supported OS.

.TP
.BI "\-T [" "image type" "]"
Set image type.
Pass \-h as the image to see the list of supported image type.

.TP
.BI "\-C [" "compression type" "]"
Set compression type.
Pass \-h as the compression to see the list of supported compression type.

.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
.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
.BI "\-D "dtc option"
Provide special options to the device tree compiler that is used to
create the image.

.TP
.BI "\-f "fit-image.its"
Image tree source file that describes the structure and contents of the
FIT image.

.SH EXAMPLES

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

.SH HOMEPAGE
http://www.denx.de/wiki/U-Boot/WebHome
.PP
.SH AUTHOR
This manual page was written by Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
and Wolfgang Denk <wd@denx.de>
Commit	Line	Data
cd153556 NI	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 [\fIoptions\fP]
	8	.SH "DESCRIPTION"
	9	The
	10	.B mkimage
	11	command is used to create images for use with the U-Boot boot loader.
7aecfdd0	12	These images can contain the linux kernel, device tree blob, root file
cd153556 NI	13	system image, firmware images etc., either separate or combined.
	14
	15	.B mkimage
	16	supports two different formats:
	17
7aecfdd0	18	The old
cd153556 NI	19	.I legacy image
	20	format concatenates the individual parts (for example, kernel image,
	21	device tree blob and ramdisk image) and adds a 64 bytes header
	22	containing information about target architecture, operating system,
	23	image type, compression method, entry points, time stamp, checksums,
	24	etc.
	25
7aecfdd0	26	The new
cd153556	27	.I FIT (Flattened Image Tree) format
7aecfdd0	28	allows for more flexibility in handling images of various types and also
cd153556 NI	29	enhances 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" "]"
	37	mkimage 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" "]"
3f1266d6	44	Set architecture. Pass \-h as the architecture to see the list of supported architectures.
cd153556 NI	45
	46	.TP
	47	.BI "\-O [" "os" "]"
	48	Set operating system. bootm command of u-boot changes boot method by os type.
3f1266d6	49	Pass \-h as the OS to see the list of supported OS.
cd153556 NI	50
	51	.TP
	52	.BI "\-T [" "image type" "]"
	53	Set image type.
3f1266d6	54	Pass \-h as the image to see the list of supported image type.
cd153556 NI	55
	56	.TP
	57	.BI "\-C [" "compression type" "]"
	58	Set compression type.
3f1266d6	59	Pass \-h as the compression to see the list of supported compression type.
cd153556 NI	60
	61	.TP
	62	.BI "\-a [" "load addess" "]"
	63	Set load address with a hex number.
	64
	65	.TP
	66	.BI "\-e [" "entry point" "]"
	67	Set entry point with a hex number.
	68
	69	.TP
	70	.BI "\-n [" "image name" "]"
	71	Set image name to 'image name'.
	72
	73	.TP
	74	.BI "\-d [" "image data file" "]"
	75	Use image data from 'image data file'.
	76
	77	.TP
	78	.BI "\-x"
	79	Set XIP (execute in place) flag.
	80
	81	.P
	82	.B Create FIT image:
	83
	84	.TP
	85	.BI "\-D "dtc option"
	86	Provide special options to the device tree compiler that is used to
	87	create the image.
	88
	89	.TP
	90	.BI "\-f "fit-image.its"
7aecfdd0	91	Image tree source file that describes the structure and contents of the
cd153556 NI	92	FIT image.
cd153556 NI	93
7aecfdd0	94	.SH EXAMPLES
cd153556 NI	95
	96	List image information:
	97	.nf
	98	.B mkimage -l uImage
	99	.fi
	100	.P
	101	Create 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
	108	Create FIT image with compressed PowerPC Linux kernel:
	109	.nf
	110	.B mkimage -f kernel.its kernel.itb
	111	.fi
	112
	113	.SH HOMEPAGE
	114	http://www.denx.de/wiki/U-Boot/WebHome
	115	.PP
	116	.SH AUTHOR
	117	This manual page was written by Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
	118	and Wolfgang Denk <wd@denx.de>