Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / f78cff159bc77cb6dda03fcbff9b3cc2ce0968c1 / . / README
blob: f1029775a899314e3714e8de5a6005d905bbd884 [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 Stuge261cafa2009-05-01 14:52:50 +0000[diff] [blame]5flashrom is a utility for reading, writing, verifying and erasing flash ROM
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000[diff] [blame]6chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
7using a supported mainboard, but it also supports flashing of network
8cards (NICs), SATA controller cards, and other external devices which can
9program flash chips.
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]10
Uwe Hermannd42009c2009-04-11 13:59:00 +0000[diff] [blame]11It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and
12TSOP40 chips, which use various protocols such as LPC, FWH, parallel flash,
13or SPI.
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000[diff] [blame]14
15(see http://coreboot.org for details on coreboot)
16
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]17
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000[diff] [blame]18Build Instructions
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]19------------------
20
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]21To build flashrom you need to install the following packages or ports:
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]22
Idwer Vollering5e410de2009-05-03 23:33:05 +0000[diff] [blame]23Linux et al:
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]24
25 * pciutils
26 * pciutils-devel / pciutils-dev / libpci-dev
27 * zlib-devel / zlib1g-dev
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]28
Idwer Vollering5e410de2009-05-03 23:33:05 +0000[diff] [blame]29On FreeBSD, you need the following ports:
Idwer Vollering5e410de2009-05-03 23:33:05 +0000[diff] [blame]30
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]31 * devel/gmake
32 * devel/libpci
Idwer Vollering5e410de2009-05-03 23:33:05 +0000[diff] [blame]33
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]34To compile on Linux, use:
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +0000[diff] [blame]35
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]36 make
37
38To compile on FreeBSD, use:
39
40 gmake
41
42To compile on Solaris, use:
43
44 gmake LDFLAGS="-L$pathtolibpci -lpci -lz" CC="gcc -I$pathtopciheaders" \
45 CFLAGS=-O2
46
47To compile on DragonFly BSD, use:
48
49 ln -s /usr/pkg/include/pciutils pci
50 gmake CFLAGS=-I. LDFLAGS="-L/usr/pkg/lib -lpci -lz"
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +0000[diff] [blame]51
52To compile and run on Darwin/Mac OS X:
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]53
54 Install DirectIO from coresystems GmbH.
55 DirectIO is available at http://www.coresystems.de/en/directio.
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +0000[diff] [blame]56
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]57
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000[diff] [blame]58Installation
59------------
60
61In order to install flashrom and the manpage into /usr/local, type:
62
63 sudo make install
64
65For installation in a different directory use DESTDIR, e.g. like this:
66
67 sudo make DESTDIR=/usr install
68
69
Uwe Hermann3d5f96c2009-04-23 14:57:55 +0000[diff] [blame]70Usage / Options
71---------------
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]72
Uwe Hermann3d5f96c2009-04-23 14:57:55 +0000[diff] [blame]73Please see the flashrom(8) manpage.
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]74
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]75
Peter Stuge42688e52009-01-26 02:20:56 +0000[diff] [blame]76Exit status
77-----------
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]78
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]79Please see the flashrom(8) manpage.
Peter Stuge42688e52009-01-26 02:20:56 +0000[diff] [blame]80
81
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000[diff] [blame]82coreboot Table and Mainboard Identification
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]83--------------------------------------------
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]84
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]85Please see the flashrom(8) manpage.
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]86
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]87
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]88ROM Layout Support
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]89------------------
90
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]91Please see the flashrom(8) manpage.
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]92
93
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]94Supported Flash Chips / Chipsets / Mainboards
95---------------------------------------------
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]96
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]97Please check the output of 'flashrom -L' for the list of supported
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000[diff] [blame]98flash chips, chipsets/southbridges, mainboards, and flash programmers.
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]99
Uwe Hermann0ae5acc2009-06-04 18:53:03 +0000[diff] [blame]100
Uwe Hermanne94dbf22009-05-22 13:18:38 +0000[diff] [blame]101Website
102-------
103
104The official flashrom website is:
105
106 http://coreboot.org/Flashrom
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]107