Uwe Hermann | f8a49fe | 2008-06-22 18:50:25 +0000 | [diff] [blame] | 1 | .TH FLASHROM 8 "June 22, 2008" |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 2 | .SH NAME |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 3 | flashrom \- a universal BIOS/ROM/flash programming utility |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 4 | .SH SYNOPSIS |
Uwe Hermann | e5ac164 | 2008-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 Reinauer | f8337dd | 2006-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 Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 7 | .SH DESCRIPTION |
| 8 | .B flashrom |
Uwe Hermann | 67808fe | 2007-10-18 00:29:05 +0000 | [diff] [blame] | 9 | is a universal flash programming utility for DIP, PLCC, or SPI flash ROM |
Stefan Reinauer | e3f3e2e | 2008-01-18 15:33:10 +0000 | [diff] [blame] | 10 | chips. It can be used to flash BIOS/coreboot/firmware images, for example. |
Uwe Hermann | e5ac164 | 2008-03-12 11:54:51 +0000 | [diff] [blame] | 11 | .sp |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 12 | (see |
| 13 | .B http://coreboot.org |
| 14 | for details on coreboot) |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 15 | .SH OPTIONS |
| 16 | If no file is specified, then all that happens |
| 17 | is that flash info is dumped and the flash chip is set to writable. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 18 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 19 | .B "\-r, \-\-read" |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 20 | Read flash ROM contents and save them into the given file. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 21 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 22 | .B "\-w, \-\-write" |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 23 | Write file into flash ROM (default when file is specified). |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 24 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 25 | .B "\-v, \-\-verify" |
Uwe Hermann | 67808fe | 2007-10-18 00:29:05 +0000 | [diff] [blame] | 26 | Verify the flash ROM contents against the given file. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 27 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 28 | .B "\-E, \-\-erase" |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 29 | Erase the flash ROM device. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 30 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 31 | .B "\-V, \-\-verbose" |
| 32 | More verbose output. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 33 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 34 | .B "\-c, \-\-chip" <chipname> |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 35 | Probe only for specified flash ROM chip. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 36 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 37 | .B "\-s, \-\-estart" <addr> |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 38 | Exclude start position (obsolete). |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 39 | .TP |
Stefan Reinauer | f8337dd | 2006-08-03 10:49:09 +0000 | [diff] [blame] | 40 | .B "\-e, \-\-eend" <addr> |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 41 | Exclude end postion (obsolete). |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 42 | .TP |
Peter Stuge | 6b53fed | 2008-01-27 16:21:21 +0000 | [diff] [blame] | 43 | .B "\-m, \-\-mainboard" <[vendor:]part> |
Uwe Hermann | 67808fe | 2007-10-18 00:29:05 +0000 | [diff] [blame] | 44 | Override mainboard settings. This option is needed for some mainboards, |
| 45 | see the |
Uwe Hermann | f8a49fe | 2008-06-22 18:50:25 +0000 | [diff] [blame] | 46 | .B "flashrom \-\-list\-supported" |
| 47 | output for a list. The vendor is not required when the board name is unique. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 48 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 49 | .B "\-f, \-\-force" |
Uwe Hermann | 67808fe | 2007-10-18 00:29:05 +0000 | [diff] [blame] | 50 | Force write without checking whether the ROM image file is really meant |
| 51 | to be used on this board. |
| 52 | .sp |
Stefan Reinauer | e3f3e2e | 2008-01-18 15:33:10 +0000 | [diff] [blame] | 53 | Note: This check only works while coreboot is running, and only for those |
| 54 | boards where the coreboot code supports it. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 55 | .TP |
Stefan Reinauer | f8337dd | 2006-08-03 10:49:09 +0000 | [diff] [blame] | 56 | .B "\-l, \-\-layout" <layout.file> |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 57 | Read ROM layout from file. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 58 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 59 | .B "\-i, \-\-image" <name> |
Uwe Hermann | 67808fe | 2007-10-18 00:29:05 +0000 | [diff] [blame] | 60 | Only flash image |
| 61 | .B <name> |
| 62 | from flash layout. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 63 | .TP |
Uwe Hermann | e5ac164 | 2008-03-12 11:54:51 +0000 | [diff] [blame] | 64 | .B "\-L, \-\-list\-supported" |
| 65 | List the ROM chips, chipsets, and mainboards supported by flashrom. |
| 66 | The list of mainboards consists of those boards which need a special |
| 67 | ROM write-enable function for flashrom to work. |
| 68 | .sp |
| 69 | There are many other boards which will work out of the box, without such |
| 70 | special support in flashrom. Some of the known-good/known-bad and tested ones |
| 71 | are listed at |
| 72 | .BR http://coreboot.org/Flashrom#Supported_mainboards , |
| 73 | but the list is not exhaustive, of course. |
| 74 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 75 | .B "\-h, \-\-help" |
| 76 | Show a help text and exit. |
Bernhard Walle | 201bde3 | 2008-01-21 15:24:22 +0000 | [diff] [blame] | 77 | .TP |
| 78 | .B "\-R, \-\-version" |
| 79 | Show version information and exit. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 80 | .SH BUGS |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 81 | Please report any bugs at |
| 82 | .BR http://tracker.coreboot.org/trac/coreboot/newticket "," |
| 83 | or on the coreboot mailing list |
| 84 | .RB "(" http://coreboot.org/Mailinglist ")." |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 85 | .SH LICENCE |
| 86 | .B flashrom |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 87 | is covered by the GNU General Public License (GPL), version 2 or later. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 88 | .SH COPYRIGHT |
| 89 | 2000 Silicon Integrated System Corporation |
| 90 | .br |
Stefan Reinauer | f8337dd | 2006-08-03 10:49:09 +0000 | [diff] [blame] | 91 | 2003 Niki W. Waibel |
| 92 | .br |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 93 | 2004 Tyan Corp |
| 94 | .br |
Stefan Reinauer | 5380d51 | 2007-05-24 09:08:36 +0000 | [diff] [blame] | 95 | 2005-2007 coresystems GmbH |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 96 | .SH AUTHORS |
Stefan Reinauer | f8337dd | 2006-08-03 10:49:09 +0000 | [diff] [blame] | 97 | Yinghai Lu <yinghai.lu@amd.com> |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 98 | .br |
| 99 | Stefan Reinauer <stepan@coresystems.de> |
| 100 | .br |
| 101 | Niki W. Waibel <niki.waibel@gmx.net> |
Stefan Reinauer | f8337dd | 2006-08-03 10:49:09 +0000 | [diff] [blame] | 102 | .br |
| 103 | some others |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 104 | .PP |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 105 | This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>. |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 106 | It is licensed under the terms of the GNU GPL (version 2 or later). |