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