Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / 3d5f96cdc8e45eede6d36d3379f852506a3c185c / . / README
blob: a27208047907d5cc7ed5416717a7bd2e57f8c7b6 [file] [log] [blame]
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]1-------------------------------------------------------------------------------
Peter Stuge44dd3042009-04-20 12:34:30 +0000[diff] [blame]2flashrom README
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]3-------------------------------------------------------------------------------
Ronald G. Minnich1e5003f2002-04-10 18:02:07 +0000[diff] [blame]4
Peter Stuge44dd3042009-04-20 12:34:30 +0000[diff] [blame]5flashrom is a utility for reading, writing, and erasing flash ROM chips.
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]6It's often used to flash BIOS/coreboot/firmware images.
7
Uwe Hermannd42009c2009-04-11 13:59:00 +0000[diff] [blame]8It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and
9TSOP40 chips, which use various protocols such as LPC, FWH, parallel flash,
10or SPI.
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000[diff] [blame]11
12(see http://coreboot.org for details on coreboot)
13
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]14
15Build Requirements
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]16------------------
17
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]18To build the flashrom utility you need to install the following packages:
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]19
20* pciutils
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]21* pciutils-devel / pciutils-dev / libpci-dev
Uwe Hermann83f0db22006-12-20 14:53:22 +0000[diff] [blame]22* zlib-devel / zlib1g-dev
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]23
24
Uwe Hermann3d5f96c2009-04-23 14:57:55 +0000[diff] [blame^]25Usage / Options
26---------------
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]27
Uwe Hermann3d5f96c2009-04-23 14:57:55 +0000[diff] [blame^]28Please see the flashrom(8) manpage.
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]29
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]30
Peter Stuge42688e52009-01-26 02:20:56 +0000[diff] [blame]31Exit status
32-----------
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]33
Peter Stuge44dd3042009-04-20 12:34:30 +0000[diff] [blame]34flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
Peter Stuge42688e52009-01-26 02:20:56 +0000[diff] [blame]35(/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.
36
37
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000[diff] [blame]38coreboot Table and Mainboard Identification
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]39--------------------------------------------
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]40
Peter Stuge44dd3042009-04-20 12:34:30 +0000[diff] [blame]41flashrom reads the coreboot table to determine the current mainboard. If no
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]42coreboot table could be read or if you want to override these values, you can
43specify -m, e.g.:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]44
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]45 $ flashrom -w --mainboard AGAMI:ARUMA agami_aruma.rom
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]46
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]47See the 'Supported mainboards' section in the output of 'flashrom -L' for
48a list of boards which require the specification of the board name, if no
49coreboot table is found.
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]50
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]51
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]52ROM Layout Support
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]53------------------
54
Peter Stuge44dd3042009-04-20 12:34:30 +0000[diff] [blame]55flashrom supports ROM layouts. This allows you to flash certain parts of
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]56the flash chip only. A ROM layout file looks like follows:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]57
58 00000000:00008fff gfxrom
59 00009000:0003ffff normal
60 00040000:0007ffff fallback
61
62 i.e.:
63 startaddr:endaddr name
64
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]65 All addresses are offsets within the file, not absolute addresses!
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]66
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]67If you only want to update the normal image in a ROM you can say:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]68
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]69 flashrom -w --layout rom.layout --image normal agami_aruma.rom
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]70
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]71To update normal and fallback but leave the VGA BIOS alone, say:
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]72
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]73 flashrom -w -l rom.layout -i normal -i fallback agami_aruma.rom
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]74
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]75Currently overlapping sections are not supported.
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]76
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]77ROM layouts should replace the -s and -e option since they are more
78flexible and they should lead to a ROM update file format with the
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]79ROM layout and the ROM image in one file (cpio, zip or something?).
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]80
81
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]82Supported Flash Chips / Chipsets / Mainboards
83---------------------------------------------
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]84
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]85Please check the output of 'flashrom -L' for the list of supported
86flash chips, chipsets/southbridges, and mainboards.
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]87
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]88See also http://coreboot.org/Flashrom for more details.
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]89