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