flashrom: Remove dead M-Systems Disk on Chip code
[coreboot.git] / util / flashrom / README
1 -------------------------------------------------------------------------------
2 Flashrom README
3 -------------------------------------------------------------------------------
4
5 Flashrom is a universal flash programming utility for DIP, PLCC, or SPI
6 flash ROM chips. It can be used to flash BIOS/coreboot/firmware images.
7
8 (see http://coreboot.org for details on coreboot)
9
10
11 Build Requirements
12 ------------------
13
14 To build the flashrom utility you need to have the following packages
15 installed on your Linux system:
16
17 * pciutils
18 * pciutils-devel / pciutils-dev
19 * zlib-devel / zlib1g-dev
20
21
22 Usage
23 -----
24
25  $ flashrom [-rwvEVfh] [-c chipname] [-s exclude_start] [-e exclude_end]
26             [-m [vendor:]part] [-l file.layout] [-i imagename] [file]
27    -r | --read:                      read flash and save into file
28    -w | --write:                     write file into flash (default when
29                                      file is specified)
30    -v | --verify:                    verify flash against file
31    -E | --erase:                     erase flash device
32    -V | --verbose:                   more verbose output
33    -c | --chip <chipname>:           probe only for specified flash chip
34    -s | --estart <addr>:             exclude start position
35    -e | --eend <addr>:               exclude end postion
36    -m | --mainboard <[vendor:]part>: override mainboard settings
37    -f | --force:                     force write without checking image
38    -l | --layout <file.layout>:      read rom layout from file
39    -i | --image <name>:              only flash image name from flash layout
40
41  If no file is specified, then all that happens
42  is that flash info is dumped and the flash chip is set to writable.
43
44
45 coreboot Table and Mainboard Identification
46 --------------------------------------------
47
48 Flashrom reads the coreboot table to determine the current mainboard
49 (parse DMI as well in future?). If no coreboot table could be read
50 or if you want to override these values, you can specify -m, e.g.:
51
52   flashrom -w --mainboard AGAMI:ARUMA agami_aruma.rom
53
54 The following boards require the specification of the board name, if
55 no coreboot table is found:
56
57 * IWILL DK8-HTX: use -m iwill:dk8_htx
58 * Agami Aruma: use -m AGAMI:ARUMA
59 * ASUS P5A: use -m asus:p5a
60 * IBM x3455: use -m ibm:x3455
61 * EPoX EP-BX3: use -m epox:ep-bx3
62 * GIGABYTE GA-M57SLI-S4 v2.0: use -m gigabyte:m57sli
63 * GIGABYTE GA-M61P-S3: use -m gigabyte:m61p
64 * MSI K8N Neo3: use -m msi:k8n-neo3
65 * Acorp 6A815EPD: use -m acorp:6a815epd
66
67
68 ROM Layout Support
69 ------------------
70
71 Flashrom supports ROM layouts. This allows you to flash certain parts of
72 the flash chip only. A ROM layout file looks like follows:
73
74   00000000:00008fff gfxrom
75   00009000:0003ffff normal
76   00040000:0007ffff fallback
77
78   i.e.:
79   startaddr:endaddr name
80
81   All addresses are offsets within the file, not absolute addresses!
82   
83 If you only want to update the normal image in a ROM you can say:
84
85   flashrom -w --layout rom.layout --image normal agami_aruma.rom
86      
87 To update normal and fallback but leave the VGA BIOS alone, say:
88
89   flashrom -w -l rom.layout -i normal -i fallback agami_aruma.rom
90  
91 Currently overlapping sections are not supported.
92
93 ROM layouts should replace the -s and -e option since they are more 
94 flexible and they should lead to a ROM update file format with the 
95 ROM layout and the ROM image in one file (cpio, zip or something?).
96
97
98 Disk on Chip support
99 --------------------
100
101 Disk on Chip support was removed from flashrom in r3380. It had already
102 been disabled by default in flashrom for several years because the code
103 was considered unstable and incomplete. The products intended to work
104 have been End-Of-Lifed by the manufacturer for a long time.
105
106
107 Supported Flash Chips
108 ---------------------
109
110 AMD AM-29F040B
111 AMD AM-29F016D
112 ASD AE49F2008
113 Atmel AT-29C040A
114 Atmel AT-29C020
115 EMST F49B002UA
116 Intel 82802AB (Firmware Hub) 
117 Intel 82802AC (Firmware Hub) 
118 MX MX-29F002
119 PMC PMC-49FL002
120 PMC PMC-49FL004
121 Sharp LHF-00L04
122 Spansion S25FL016A
123 SST SST-29EE020A
124 SST SST-28SF040A
125 SST SST-39SF010A
126 SST SST-39SF020A
127 SST SST-39SF040
128 SST SST-39VF020
129 SST SST-49LF040B
130 SST SST-49LF040
131 SST SST-49LF020A
132 SST SST-49LF080A
133 SST SST-49LF160C
134 SST SST-49LF002A/B
135 SST SST-49LF003A/B
136 SST SST-49LF004A/B
137 SST SST-49LF008A
138 SST SST-49LF004C
139 SST SST-49LF008C
140 SST SST-49LF016C
141 ST ST-M50FLW040A
142 ST ST-M50FLW040B
143 ST ST-M50FLW080A
144 ST ST-M50FLW080B
145 ST ST-M50FW040
146 ST ST-M50FW080
147 ST ST-M50FW016
148 ST ST-M50LPW116
149 ST ST-M29F002B
150 ST ST-M29F002T
151 ST ST-M29F002NT
152 ST ST-M29F400BT
153 ST ST-M29F040B
154 ST ST-M29W010B
155 ST ST-M29W040B
156 SyncMOS S29C51001T/B
157 SyncMOS S29C51002T/B
158 SyncMOS S29C51004T/B
159 SyncMOS S29C31004T
160 Winbond W29C011
161 Winbond W29C020C
162 Winbond W29C040P
163 Winbond W29EE011
164 Winbond W49F002U
165 Winbond W49V002A
166 Winbond W49V002FA
167 Winbond W39V040FA
168 Winbond W39V040A
169 Winbond W39V040B
170 Winbond W39V080A
171
172
173 Supported Southbridges
174 ----------------------
175
176 AMD CS5530/CS5530A
177 AMD Geode SC1100
178 AMD AMD-8111
179 ATI SB400
180 Broadcom HT-1000
181 Intel ICH0-ICH8 (all variations)
182 Intel PIIX4/PIIX4E/PIIX4M
183 NVIDIA CK804
184 NVIDIA MCP51
185 NVIDIA MCP55
186 SiS 630
187 SiS 5595
188 VIA CX700
189 VIA VT8231
190 VIA VT8235
191 VIA VT8237
192 VIA VT82C686
193