flashrom: Document the newly supported IBM x3455 board and the
[coreboot.git] / util / flashrom / README
1 -------------------------------------------------------------------------------
2 Flashrom README
3 -------------------------------------------------------------------------------
4
5 This is the universal (LinuxBIOS) flash utility.
6
7 Build Requirements
8 ------------------
9
10 To build the flashrom utility you need to have the following packages
11 installed on your Linux system:
12
13 * pciutils
14 * pciutils-devel / pciutils-dev
15 * zlib-devel / zlib1g-dev
16
17
18 Usage
19 -----
20
21 usage: ./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
32    -m | --mainboard <vendor:part>: override mainboard settings
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
36
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.
39
40
41 LinuxBIOS Table and Mainboard Identification
42 --------------------------------------------
43
44 Flashrom reads the LinuxBIOS table to determine the current mainboard.
45 (Parse DMI as well in future?) If no LinuxBIOS table could be read
46 or if you want to override these values, you can specify -m, e.g.:
47
48   flashrom -w --mainboard ISLAND:ARUMA island_aruma.rom
49
50 The following boards require the specification of the board name, if
51 no LinuxBIOS table is found:
52
53 * IWILL DK8-HTX: use -m iwill:dk8_htx
54 * Agami Aruma: use -m AGAMI:ARUMA
55 * ASUS P5A: use -m asus:p5a
56 * IBM x3455: use -m ibm:x3455
57
58
59 ROM Layout Support
60 ------------------
61
62 Flashrom supports ROM layouts. This allows to flash certain parts of
63 the flash chip only. A ROM layout file looks like follows:
64
65   00000000:00008fff gfxrom
66   00009000:0003ffff normal
67   00040000:0007ffff fallback
68
69   i.e.:
70   startaddr:endaddr name
71
72   all addresses are offsets within the file, not absolute addresses!
73   
74 If you only want to update the normal image in a ROM you can say:
75
76      flashrom -w --layout rom.layout --image normal island_aruma.rom
77      
78 To update normal and fallback but leave the VGA BIOS alone, say:
79
80      flashrom -w -l rom.layout -i normal -i fallback island_aruma.rom
81  
82 Currently overlapping sections are not supported.
83
84 ROM layouts should replace the -s and -e option since they are more 
85 flexible and they should lead to a ROM update file format with the 
86 ROM layout and the ROM image in one file (cpio, zip or something?)
87
88
89 DOC support
90 -----------
91
92 DISK on Chip support is currently disabled since it is considered unstable. 
93 Change CFLAGS in the Makefile to enable it: Remove -DDISABLE_DOC from CFLAGS.
94
95
96 Supported Flash Chips
97 ---------------------
98
99 AMD AM-29F040B
100 AMD AM-29F016D
101 ASD AE49F2008
102 Atmel AT-29C040A
103 Atmel AT-29C020
104 EMST F49B002UA
105 Intel 82802AB (Firmware Hub) 
106 Intel 82802AC (Firmware Hub) 
107 M-Systems MD-2802 (unsupported, disabled by default)
108 MX MX-29F002
109 PMC PMC-49FL002
110 PMC PMC-49FL004
111 Sharp LHF-00L04
112 SST SST-29EE020A
113 SST SST-28SF040A
114 SST SST-39SF010A
115 SST SST-39SF020A
116 SST SST-39SF040
117 SST SST-39VF020
118 SST SST-49LF040B
119 SST SST-49LF040
120 SST SST-49LF020A
121 SST SST-49LF080A
122 SST SST-49LF160C
123 SST SST-49LF002A/B
124 SST SST-49LF003A/B
125 SST SST-49LF004A/B
126 SST SST-49LF008A
127 SST SST-49LF004C
128 SST SST-49LF008C
129 SST SST-49LF016C
130 ST ST-M29F002B
131 ST ST-M29F002T
132 ST ST-M29F002NT
133 ST ST-M29F400BT
134 ST ST-M29F040B
135 SyncMOS S29C51001T/B
136 SyncMOS S29C51002T/B
137 SyncMOS S29C51004T/B
138 SyncMOS S29C31004T
139 Winbond W29C011
140 Winbond W29C020C
141 Winbond W49F002U
142 Winbond W49V002A
143 Winbond W49V002FA
144 Winbond W39V040FA
145 Winbond W39V040A
146 Winbond W39V040B
147 Winbond W39V080A
148
149
150 Supported Southbridges
151 ----------------------
152
153 AMD CS5530
154 AMD Geode SC1100
155 AMD AMD-8111
156 ATI SB400
157 Broadcom HT-1000
158 Intel ICH0-ICH8 (all variations)
159 Intel PIIX4/PIIX4E/PIIX4M
160 NVIDIA CK804
161 NVIDIA MCP51
162 NVIDIA MCP55
163 SiS 630
164 SiS 5595
165 VIA CX700
166 VIA VT8231
167 VIA VT8235
168 VIA VT8237
169 VIA VT82C686
170