mention build dependencies in Makefile.
[coreboot.git] / util / flashrom / README
1 This is the universal LinuxBIOS flash utility.
2
3 build requirements
4 ------------------
5
6 To build the flashrom utility you need to have the following packages
7 installed on your linux system:
8
9 * pciutils
10 * pciutils-devel
11
12
13 usage
14 -----
15
16 usage: ./flashrom [-rwvE] [-V] [-c chipname] 
17                            [-s exclude_start] [-e exclude_end] [file]
18
19    -r | --read:   read flash and save into file
20    -w | --write:  write file into flash (default when file is specified)
21    -v | --verify: verify flash against file
22    -E | --erase: Erase flash device
23    -V | --verbose: more verbose output
24
25    -c | --chip <chipname>: probe only for specified flash chip
26    -s | --estart <addr>: exclude start position
27    -e | --eend <addr>: exclude end postion
28    -m | --mainboard <vendor:part>: override mainboard settings
29    -l | --layout <file.layout>: read rom layout from file
30    -i | --image <name>: only flash image name from flash layout
31
32  If no file is specified, then all that happens
33  is that flash info is dumped and the flash chip is set to writable.
34
35
36 LinuxBIOS table and Mainboard identification
37 --------------------------------------------
38
39 flashrom reads the LinuxBIOS table to determine the current mainboard.
40 (Parse DMI as well in future?) If no LinuxBIOS table could be read
41 or if you want to override these values, you can to specify -m ie.:
42
43      flashrom -w --mainboard ISLAND:ARUMA island_aruma.rom
44
45
46 rom layout support
47 ------------------
48
49 flashrom supports rom layouts. This allows to flash certain parts of
50 the flash chip only. A rom layout file looks like follows:
51
52   00000000:00008fff gfxrom
53   00009000:0003ffff normal
54   00040000:0007ffff fallback
55
56   i.e.:
57   startaddr:endaddr name
58
59   all addresses are offsets within the file, not absolute addresses!
60   
61 If you only want to update the normal image in a rom you can say:
62
63      flashrom -w --layout rom.layout --image normal island_aruma.rom
64      
65 To update normal and fallback but leave the vga bios alone, say:
66
67      flashrom -w -l rom.layout -i normal -i fallback island_aruma.rom
68  
69 Currently overlapping sections are not spported.
70
71 rom layouts should replace the -s and -e option since they are more 
72 flexible and they should lead to a rom update file format with the 
73 rom layout and the rom image in one file (cpio, zip or something?)
74
75
76 DOC support
77 -----------
78
79 DISK on Chip support is currently disabled since it is considered unstable. 
80 Change CFLAGS in the Makefile to enable it.
81
82