Cosmetic fixes and typos (trivial).
[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
15
16
17 Usage
18 -----
19
20 usage: ./flashrom [-rwvEVfh] [-c chipname] [-s exclude_start]
21        [-e exclude_end] [-m vendor:part] [-l file.layout] [-i imagename] [file]
22    -r | --read:                    read flash and save into file
23    -w | --write:                   write file into flash (default when
24                                    file is specified)
25    -v | --verify:                  verify flash against file
26    -E | --erase:                   erase flash device
27    -V | --verbose:                 more verbose output
28    -c | --chip <chipname>:         probe only for specified flash chip
29    -s | --estart <addr>:           exclude start position
30    -e | --eend <addr>:             exclude end postion
31    -m | --mainboard <vendor:part>: override mainboard settings
32    -f | --force:                   force write without checking image
33    -l | --layout <file.layout>:    read rom layout from file
34    -i | --image <name>:            only flash image name from flash layout
35
36  If no file is specified, then all that happens
37  is that flash info is dumped and the flash chip is set to writable.
38
39
40 LinuxBIOS Table and Mainboard Identification
41 --------------------------------------------
42
43 Flashrom reads the LinuxBIOS table to determine the current mainboard.
44 (Parse DMI as well in future?) If no LinuxBIOS table could be read
45 or if you want to override these values, you can specify -m, e.g.:
46
47   flashrom -w --mainboard ISLAND:ARUMA island_aruma.rom
48
49
50 ROM Layout Support
51 ------------------
52
53 Flashrom supports ROM layouts. This allows to flash certain parts of
54 the flash chip only. A ROM layout file looks like follows:
55
56   00000000:00008fff gfxrom
57   00009000:0003ffff normal
58   00040000:0007ffff fallback
59
60   i.e.:
61   startaddr:endaddr name
62
63   all addresses are offsets within the file, not absolute addresses!
64   
65 If you only want to update the normal image in a ROM you can say:
66
67      flashrom -w --layout rom.layout --image normal island_aruma.rom
68      
69 To update normal and fallback but leave the VGA BIOS alone, say:
70
71      flashrom -w -l rom.layout -i normal -i fallback island_aruma.rom
72  
73 Currently overlapping sections are not supported.
74
75 ROM layouts should replace the -s and -e option since they are more 
76 flexible and they should lead to a ROM update file format with the 
77 ROM layout and the ROM image in one file (cpio, zip or something?)
78
79
80 DOC support
81 -----------
82
83 DISK on Chip support is currently disabled since it is considered unstable. 
84 Change CFLAGS in the Makefile to enable it: Remove -DDISABLE_DOC from CFLAGS.
85
86