Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / d110764ccdd75bb3621d97c613eea392634696f2 / . / README
blob: 12be20dcf9c82bb414dfdcc1b0a21c00ed4d57d7 [file] [log] [blame]
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]1-------------------------------------------------------------------------------
2Flashrom README
3-------------------------------------------------------------------------------
Ronald G. Minnich1e5003f2002-04-10 18:02:07 +0000[diff] [blame]4
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]5This is the universal (LinuxBIOS) flash utility.
6
7Build Requirements
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]8------------------
9
10To build the flashrom utility you need to have the following packages
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]11installed on your Linux system:
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]12
13* pciutils
Uwe Hermann83f0db22006-12-20 14:53:22 +0000[diff] [blame]14* pciutils-devel / pciutils-dev
15* zlib-devel / zlib1g-dev
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]16
17
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]18Usage
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]19-----
20
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000[diff] [blame]21usage: ./flashrom [-rwvEVfh] [-c chipname] [-s exclude_start]
22 [-e exclude_end] [-m vendor:part] [-l file.layout] [-i imagename] [file]
23 -r | --read: read flash and save into file
24 -w | --write: write file into flash (default when
25 file is specified)
26 -v | --verify: verify flash against file
27 -E | --erase: erase flash device
28 -V | --verbose: more verbose output
29 -c | --chip <chipname>: probe only for specified flash chip
30 -s | --estart <addr>: exclude start position
31 -e | --eend <addr>: exclude end postion
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]32 -m | --mainboard <vendor:part>: override mainboard settings
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000[diff] [blame]33 -f | --force: force write without checking image
34 -l | --layout <file.layout>: read rom layout from file
35 -i | --image <name>: only flash image name from flash layout
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]36
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]37 If no file is specified, then all that happens
38 is that flash info is dumped and the flash chip is set to writable.
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]39
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]40
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]41LinuxBIOS Table and Mainboard Identification
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]42--------------------------------------------
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]43
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]44Flashrom reads the LinuxBIOS table to determine the current mainboard.
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]45(Parse DMI as well in future?) If no LinuxBIOS table could be read
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]46or if you want to override these values, you can specify -m, e.g.:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]47
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]48 flashrom -w --mainboard ISLAND:ARUMA island_aruma.rom
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]49
Mondrian Nuessleaef1c7c2007-05-03 10:09:23 +0000[diff] [blame]50The following boards require the specification of the board name, if
51no LinuxBIOS table is found:
52
53* IWILL DK8-HTX: use -m iwill:dk8_htx
Luc Verhaegen6b141752007-05-20 16:16:13 +0000[diff] [blame]54* Agami Aruma: use -m AGAMI:ARUMA
55* ASUS P5A: use -m asus:p5a
Uwe Hermanne823ee02007-06-05 15:02:18 +0000[diff] [blame]56* IBM x3455: use -m ibm:x3455
Luc Verhaegenfdd0c582007-08-11 16:59:11 +0000[diff] [blame]57* EPoX EP-BX3: use -m epox:ep-bx3
Mondrian Nuessleaef1c7c2007-05-03 10:09:23 +0000[diff] [blame]58
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]59
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]60ROM Layout Support
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]61------------------
62
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]63Flashrom supports ROM layouts. This allows to flash certain parts of
64the flash chip only. A ROM layout file looks like follows:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]65
66 00000000:00008fff gfxrom
67 00009000:0003ffff normal
68 00040000:0007ffff fallback
69
70 i.e.:
71 startaddr:endaddr name
72
73 all addresses are offsets within the file, not absolute addresses!
74
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]75If you only want to update the normal image in a ROM you can say:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]76
77 flashrom -w --layout rom.layout --image normal island_aruma.rom
78
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]79To update normal and fallback but leave the VGA BIOS alone, say:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]80
81 flashrom -w -l rom.layout -i normal -i fallback island_aruma.rom
82
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]83Currently overlapping sections are not supported.
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]84
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]85ROM layouts should replace the -s and -e option since they are more
86flexible and they should lead to a ROM update file format with the
87ROM layout and the ROM image in one file (cpio, zip or something?)
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]88
89
90DOC support
91-----------
92
93DISK on Chip support is currently disabled since it is considered unstable.
Stefan Reinauercbc55d02006-08-25 19:21:42 +0000[diff] [blame]94Change CFLAGS in the Makefile to enable it: Remove -DDISABLE_DOC from CFLAGS.
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]95
96
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]97Supported Flash Chips
98---------------------
99
100AMD AM-29F040B
101AMD AM-29F016D
Uwe Hermannc22f5422006-12-04 08:20:40 +0000[diff] [blame]102ASD AE49F2008
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]103Atmel AT-29C040A
Uwe Hermannd7f48062007-04-28 02:22:59 +0000[diff] [blame]104Atmel AT-29C020
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]105EMST F49B002UA
106Intel 82802AB (Firmware Hub)
107Intel 82802AC (Firmware Hub)
108M-Systems MD-2802 (unsupported, disabled by default)
109MX MX-29F002
110PMC PMC-49FL002
111PMC PMC-49FL004
112Sharp LHF-00L04
113SST SST-29EE020A
114SST SST-28SF040A
115SST SST-39SF010A
116SST SST-39SF020A
117SST SST-39SF040
118SST SST-39VF020
119SST SST-49LF040B
120SST SST-49LF040
121SST SST-49LF020A
122SST SST-49LF080A
Alan Carvalho de Assis474230a2007-01-27 13:39:06 +0000[diff] [blame]123SST SST-49LF160C
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]124SST SST-49LF002A/B
125SST SST-49LF003A/B
126SST SST-49LF004A/B
127SST SST-49LF008A
Yinghai Luca782972007-01-22 20:21:17 +0000[diff] [blame]128SST SST-49LF004C
129SST SST-49LF008C
130SST SST-49LF016C
Uwe Hermann627505b2007-07-27 03:32:45 +0000[diff] [blame]131ST ST-M50FLW040A
132ST ST-M50FLW040B
133ST ST-M50FLW080A
134ST ST-M50FLW080B
135ST ST-M50FW040
136ST ST-M50FW080
137ST ST-M50FW016
138ST ST-M50LPW116
Uwe Hermannd7f48062007-04-28 02:22:59 +0000[diff] [blame]139ST ST-M29F002B
140ST ST-M29F002T
141ST ST-M29F002NT
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]142ST ST-M29F400BT
143ST ST-M29F040B
Uwe Hermann627505b2007-07-27 03:32:45 +0000[diff] [blame]144ST ST-M29W010B
145ST ST-M29W040B
Uwe Hermannc22f5422006-12-04 08:20:40 +0000[diff] [blame]146SyncMOS S29C51001T/B
147SyncMOS S29C51002T/B
148SyncMOS S29C51004T/B
149SyncMOS S29C31004T
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]150Winbond W29C011
151Winbond W29C020C
152Winbond W49F002U
153Winbond W49V002A
154Winbond W49V002FA
Uwe Hermannbc1f1a02007-05-21 21:39:08 +0000[diff] [blame]155Winbond W39V040FA
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]156Winbond W39V040A
157Winbond W39V040B
David Hendricks71437d02007-03-02 02:25:36 +0000[diff] [blame]158Winbond W39V080A
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]159
160
161Supported Southbridges
162----------------------
163
Uwe Hermannf4a673b2007-06-06 21:35:45 +0000[diff] [blame]164AMD CS5530/CS5530A
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]165AMD Geode SC1100
166AMD AMD-8111
167ATI SB400
Uwe Hermanne823ee02007-06-05 15:02:18 +0000[diff] [blame]168Broadcom HT-1000
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]169Intel ICH0-ICH8 (all variations)
170Intel PIIX4/PIIX4E/PIIX4M
171NVIDIA CK804
172NVIDIA MCP51
Yinghai Luca782972007-01-22 20:21:17 +0000[diff] [blame]173NVIDIA MCP55
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]174SiS 630
175SiS 5595
Uwe Hermanna4c63c22007-04-09 22:59:22 +0000[diff] [blame]176VIA CX700
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]177VIA VT8231
178VIA VT8235
179VIA VT8237
180VIA VT82C686
181