Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / 2fbe6247a9c328628d521b14eee90bd5be378685 / . / README
blob: 994a16380848491e08660fb052725ddf39ba6ce8 [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
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000[diff] [blame]5This is the universal (coreboot) flash utility.
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]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
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]21 $ flashrom [-rwvEVfh] [-c chipname] [-s exclude_start] [-e exclude_end]
22 [-m vendor:part] [-l file.layout] [-i imagename] [file]
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000[diff] [blame]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
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000[diff] [blame]41coreboot 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
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000[diff] [blame]44Flashrom reads the coreboot table to determine the current mainboard
45(parse DMI as well in future?). If no coreboot 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 Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]48 flashrom -w --mainboard AGAMI:ARUMA agami_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
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000[diff] [blame]51no coreboot table is found:
Mondrian Nuessleaef1c7c2007-05-03 10:09:23 +0000[diff] [blame]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
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]58* GIGABYTE GA-M57SLI-S4 v2.0: use -m gigabyte:m57sli
59* GIGABYTE GA-M61P-S3: use -m gigabyte:m61p
60* MSI K8N Neo3: use -m msi:k8n-neo3
Jonathan A. Kollaschc7785562007-12-02 19:03:23 +0000[diff] [blame]61* Acorp 6A815EPD: use -m acorp:6a815epd
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]62
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]63
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]64ROM Layout Support
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]65------------------
66
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]67Flashrom supports ROM layouts. This allows to flash certain parts of
68the flash chip only. A ROM layout file looks like follows:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]69
70 00000000:00008fff gfxrom
71 00009000:0003ffff normal
72 00040000:0007ffff fallback
73
74 i.e.:
75 startaddr:endaddr name
76
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]77 All addresses are offsets within the file, not absolute addresses!
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]78
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]79If you only want to update the normal image in a ROM you can say:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]80
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]81 flashrom -w --layout rom.layout --image normal agami_aruma.rom
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]82
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]83To update normal and fallback but leave the VGA BIOS alone, say:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]84
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]85 flashrom -w -l rom.layout -i normal -i fallback agami_aruma.rom
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]86
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]87Currently overlapping sections are not supported.
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]88
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]89ROM layouts should replace the -s and -e option since they are more
90flexible and they should lead to a ROM update file format with the
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]91ROM layout and the ROM image in one file (cpio, zip or something?).
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]92
93
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]94Disk on Chip support
95--------------------
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]96
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]97Disk on Chip support is currently disabled since it is considered unstable.
Stefan Reinauercbc55d02006-08-25 19:21:42 +0000[diff] [blame]98Change CFLAGS in the Makefile to enable it: Remove -DDISABLE_DOC from CFLAGS.
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]99
100
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]101Supported Flash Chips
102---------------------
103
104AMD AM-29F040B
105AMD AM-29F016D
Uwe Hermannc22f5422006-12-04 08:20:40 +0000[diff] [blame]106ASD AE49F2008
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]107Atmel AT-29C040A
Uwe Hermannd7f48062007-04-28 02:22:59 +0000[diff] [blame]108Atmel AT-29C020
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]109EMST F49B002UA
110Intel 82802AB (Firmware Hub)
111Intel 82802AC (Firmware Hub)
112M-Systems MD-2802 (unsupported, disabled by default)
113MX MX-29F002
114PMC PMC-49FL002
115PMC PMC-49FL004
116Sharp LHF-00L04
117SST SST-29EE020A
118SST SST-28SF040A
119SST SST-39SF010A
120SST SST-39SF020A
121SST SST-39SF040
122SST SST-39VF020
123SST SST-49LF040B
124SST SST-49LF040
125SST SST-49LF020A
126SST SST-49LF080A
Alan Carvalho de Assis474230a2007-01-27 13:39:06 +0000[diff] [blame]127SST SST-49LF160C
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]128SST SST-49LF002A/B
129SST SST-49LF003A/B
130SST SST-49LF004A/B
131SST SST-49LF008A
Yinghai Luca782972007-01-22 20:21:17 +0000[diff] [blame]132SST SST-49LF004C
133SST SST-49LF008C
134SST SST-49LF016C
Uwe Hermann627505b2007-07-27 03:32:45 +0000[diff] [blame]135ST ST-M50FLW040A
136ST ST-M50FLW040B
137ST ST-M50FLW080A
138ST ST-M50FLW080B
139ST ST-M50FW040
140ST ST-M50FW080
141ST ST-M50FW016
142ST ST-M50LPW116
Uwe Hermannd7f48062007-04-28 02:22:59 +0000[diff] [blame]143ST ST-M29F002B
144ST ST-M29F002T
145ST ST-M29F002NT
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]146ST ST-M29F400BT
147ST ST-M29F040B
Uwe Hermann627505b2007-07-27 03:32:45 +0000[diff] [blame]148ST ST-M29W010B
149ST ST-M29W040B
Uwe Hermannc22f5422006-12-04 08:20:40 +0000[diff] [blame]150SyncMOS S29C51001T/B
151SyncMOS S29C51002T/B
152SyncMOS S29C51004T/B
153SyncMOS S29C31004T
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]154Winbond W29C011
155Winbond W29C020C
Markus Boas05e7f452007-08-30 10:11:08 +0000[diff] [blame]156Winbond W29C040P
Markus Boasd2ac6fc2007-08-30 10:17:50 +0000[diff] [blame]157Winbond W29EE011
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]158Winbond W49F002U
159Winbond W49V002A
160Winbond W49V002FA
Uwe Hermannbc1f1a02007-05-21 21:39:08 +0000[diff] [blame]161Winbond W39V040FA
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]162Winbond W39V040A
163Winbond W39V040B
David Hendricks71437d02007-03-02 02:25:36 +0000[diff] [blame]164Winbond W39V080A
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]165
166
167Supported Southbridges
168----------------------
169
Uwe Hermannf4a673b2007-06-06 21:35:45 +0000[diff] [blame]170AMD CS5530/CS5530A
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]171AMD Geode SC1100
172AMD AMD-8111
173ATI SB400
Uwe Hermanne823ee02007-06-05 15:02:18 +0000[diff] [blame]174Broadcom HT-1000
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]175Intel ICH0-ICH8 (all variations)
176Intel PIIX4/PIIX4E/PIIX4M
177NVIDIA CK804
178NVIDIA MCP51
Yinghai Luca782972007-01-22 20:21:17 +0000[diff] [blame]179NVIDIA MCP55
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]180SiS 630
181SiS 5595
Uwe Hermanna4c63c22007-04-09 22:59:22 +0000[diff] [blame]182VIA CX700
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]183VIA VT8231
184VIA VT8235
185VIA VT8237
186VIA VT82C686
187