Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / 3d5f96cdc8e45eede6d36d3379f852506a3c185c / . / flashrom.8
blob: cf6f5fd50eefdde710fa39a48b38ec814523ef3d [file] [log] [blame]
Uwe Hermannd42009c2009-04-11 13:59:00 +0000[diff] [blame]1.TH FLASHROM 8 "April 11, 2009"
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]2.SH NAME
Uwe Hermannd42009c2009-04-11 13:59:00 +0000[diff] [blame]3flashrom \- read, write, and erase BIOS/ROM/flash chips
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]4.SH SYNOPSIS
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000[diff] [blame]5.B flashrom \fR[\fB\-rwvEVfLhR\fR] [\fB\-c\fR chipname] [\fB\-s\fR exclude_start] [\fB\-e\fR exclude_end]
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000[diff] [blame]6 [\fB-m\fR vendor:part] [\fB-l\fR file.layout] [\fB-i\fR image_name] [file]
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]7.SH DESCRIPTION
8.B flashrom
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]9is a utility for reading, writing, and erasing flash ROM chips.
10It's often used to flash BIOS/coreboot/firmware images.
11.PP
Uwe Hermannd42009c2009-04-11 13:59:00 +0000[diff] [blame]12It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and
13TSOP40 chips, which use various protocols such as LPC, FWH, parallel flash,
14or SPI.
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]15.PP
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000[diff] [blame]16(see
17.B http://coreboot.org
18for details on coreboot)
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]19.SH OPTIONS
20If no file is specified, then all that happens
21is that flash info is dumped and the flash chip is set to writable.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]22.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]23.B "\-r, \-\-read <file>"
24Read flash ROM contents and save them into the given
25.BR <file> .
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]26.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]27.B "\-w, \-\-write <file>"
28Write file into flash ROM (default when
29.B <file>
30is specified).
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]31.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]32.B "\-v, \-\-verify <file>"
33Verify the flash ROM contents against the given
34.BR <file> .
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]35.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]36.B "\-E, \-\-erase"
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]37Erase the flash ROM chip.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]38.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]39.B "\-V, \-\-verbose"
40More verbose output.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]41.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]42.B "\-c, \-\-chip" <chipname>
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000[diff] [blame]43Probe only for specified flash ROM chip.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]44.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]45.B "\-s, \-\-estart" <addr>
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000[diff] [blame]46Exclude start position (obsolete).
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]47.TP
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000[diff] [blame]48.B "\-e, \-\-eend" <addr>
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000[diff] [blame]49Exclude end postion (obsolete).
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]50.TP
Peter Stuge6b53fed2008-01-27 16:21:21 +0000[diff] [blame]51.B "\-m, \-\-mainboard" <[vendor:]part>
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]52Override mainboard settings. This option is needed for some mainboards,
53see the
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]54.B "flashrom \-\-list\-supported"
55output for a list. The vendor is not required when the board name is unique.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]56.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]57.B "\-f, \-\-force"
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]58Force write without checking whether the ROM image file is really meant
59to be used on this board.
60.sp
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000[diff] [blame]61Note: This check only works while coreboot is running, and only for those
62boards where the coreboot code supports it.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]63.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]64.B "\-l, \-\-layout <file>"
65Read ROM layout from
66.BR <file> .
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]67.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]68.B "\-i, \-\-image <name>"
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]69Only flash image
70.B <name>
71from flash layout.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]72.TP
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000[diff] [blame]73.B "\-L, \-\-list\-supported"
74List the ROM chips, chipsets, and mainboards supported by flashrom.
75The list of mainboards consists of those boards which need a special
76ROM write-enable function for flashrom to work.
77.sp
78There are many other boards which will work out of the box, without such
79special support in flashrom. Some of the known-good/known-bad and tested ones
80are listed at
81.BR http://coreboot.org/Flashrom#Supported_mainboards ,
82but the list is not exhaustive, of course.
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]83.sp
84Please let us know if you can verify other boards to work or not work out
85of the box.
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000[diff] [blame]86.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]87.B "\-h, \-\-help"
88Show a help text and exit.
Bernhard Walle201bde32008-01-21 15:24:22 +0000[diff] [blame]89.TP
90.B "\-R, \-\-version"
91Show version information and exit.
Peter Stuge42688e52009-01-26 02:20:56 +0000[diff] [blame]92.SH EXIT STATUS
93flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
94(/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]95.SH BUGS
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000[diff] [blame]96Please report any bugs at
97.BR http://tracker.coreboot.org/trac/coreboot/newticket ","
98or on the coreboot mailing list
99.RB "(" http://coreboot.org/Mailinglist ")."
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]100.SH LICENCE
101.B flashrom
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000[diff] [blame]102is covered by the GNU General Public License (GPL), version 2. Some files are
103additionally available under the GPL (version 2, or any later version).
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]104.SH COPYRIGHT
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]105.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000[diff] [blame]106Please see the individual files.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]107.SH AUTHORS
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000[diff] [blame]108Carl-Daniel Hailfinger
109.br
110Claus Gindhart <claus.gindhart@kontron.com>
111.br
112Dominik Geyer <dominik.geyer@kontron.com>
113.br
114Eric Biederman <ebiederman@lnxi.com>
115.br
116Giampiero Giancipoli <gianci@email.it>
117.br
118Joe Bao <Zheng.Bao@amd.com>
119.br
120Luc Verhaegen <libv@skynet.be>
121.br
122Markus Boas <ryven@ryven.de>
123.br
124Nikolay Petukhov <nikolay.petukhov@gmail.com>
125.br
126Peter Stuge <peter@stuge.se>
127.br
128Reinder E.N. de Haan <lb_reha@mveas.com>
129.br
130Ronald G. Minnich <rminnich@gmail.com>
131.br
132Ronald Hoogenboom <ronald@zonnet.nl>
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]133.br
134Stefan Reinauer <stepan@coresystems.de>
135.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000[diff] [blame]136Stefan Wildemann <stefan.wildemann@kontron.com>
137.br
138Steven James <pyro@linuxlabs.com>
139.br
140Uwe Hermann <uwe@hermann-uwe.de>
141.br
142Wang Qingpei <Qingpei.Wang@amd.com>
143.br
144Yinghai Lu <yinghai.lu@amd.com>
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000[diff] [blame]145.br
146some others
Stefan Reinauer261144c2006-07-27 23:29:02 +0000[diff] [blame]147.PP
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000[diff] [blame]148This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>.
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000[diff] [blame]149It is licensed under the terms of the GNU GPL (version 2 or later).