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