Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / 10572fa08ae7819f06a087e89da6e1611beb7d46 / . / README
blob: 070acffba805fc45c6a3494fa09dbcdd8804d7eb [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
Carl-Daniel Hailfingera23041c2009-06-12 14:49:10 +0000[diff] [blame]18Packaging
19---------
20
21To package flashrom and remove dependencies on subversion, either use
22make export
23or
24make tarball
25
26make export will export all flashrom files from the subversion repository at
27revision BASE into a directory named $EXPORTDIR/flashrom-$VERSION-r$SVNREVISION
28and will additionally modify the Makefile in that directory to contain the svn
29revision of the exported tree.
30
31make tarball will simply tar up the result of make export and gzip compress it.
32
33The snapshot tarballs are the result of make tarball and require no further
34processing.
35
36
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000[diff] [blame]37Build Instructions
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]38------------------
39
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]40To build flashrom you need to install the following packages or ports:
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]41
Idwer Vollering5e410de2009-05-03 23:33:05 +0000[diff] [blame]42Linux et al:
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]43
44 * pciutils
45 * pciutils-devel / pciutils-dev / libpci-dev
Carl-Daniel Hailfinger10572fa2009-08-17 16:30:53 +0000[diff] [blame^]46 * zlib-devel / zlib1g-dev (only needed if libpci is static)
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]47
Idwer Vollering5e410de2009-05-03 23:33:05 +0000[diff] [blame]48On FreeBSD, you need the following ports:
Idwer Vollering5e410de2009-05-03 23:33:05 +0000[diff] [blame]49
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]50 * devel/gmake
51 * devel/libpci
Idwer Vollering5e410de2009-05-03 23:33:05 +0000[diff] [blame]52
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]53To compile on Linux, use:
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +0000[diff] [blame]54
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]55 make
56
57To compile on FreeBSD, use:
58
59 gmake
60
Carl-Daniel Hailfinger10572fa2009-08-17 16:30:53 +0000[diff] [blame^]61To compile on Nexenta, use:
62
63 make
64
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]65To compile on Solaris, use:
66
Carl-Daniel Hailfinger10572fa2009-08-17 16:30:53 +0000[diff] [blame^]67 gmake LDFLAGS="-L$pathtolibpci" CC="gcc -I$pathtopciheaders" CFLAGS=-O2
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]68
69To compile on DragonFly BSD, use:
70
71 ln -s /usr/pkg/include/pciutils pci
Carl-Daniel Hailfinger10572fa2009-08-17 16:30:53 +0000[diff] [blame^]72 gmake CFLAGS=-I. LDFLAGS="-L/usr/pkg/lib"
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +0000[diff] [blame]73
74To compile and run on Darwin/Mac OS X:
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]75
76 Install DirectIO from coresystems GmbH.
77 DirectIO is available at http://www.coresystems.de/en/directio.
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +0000[diff] [blame]78
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]79
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000[diff] [blame]80Installation
81------------
82
83In order to install flashrom and the manpage into /usr/local, type:
84
85 sudo make install
86
87For installation in a different directory use DESTDIR, e.g. like this:
88
89 sudo make DESTDIR=/usr install
90
91
Uwe Hermann3d5f96c2009-04-23 14:57:55 +0000[diff] [blame]92Usage / Options
93---------------
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000[diff] [blame]94
Uwe Hermann3d5f96c2009-04-23 14:57:55 +0000[diff] [blame]95Please see the flashrom(8) manpage.
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]96
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]97
Peter Stuge42688e52009-01-26 02:20:56 +0000[diff] [blame]98Exit status
99-----------
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000[diff] [blame]100
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]101Please see the flashrom(8) manpage.
Peter Stuge42688e52009-01-26 02:20:56 +0000[diff] [blame]102
103
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +0000[diff] [blame]104coreboot Table and Mainboard Identification
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]105--------------------------------------------
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +0000[diff] [blame]106
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]107Please see the flashrom(8) manpage.
Uwe Hermann67808fe2007-10-18 00:29:05 +0000[diff] [blame]108
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]109
Uwe Hermann2dc5f422006-11-20 20:32:35 +0000[diff] [blame]110ROM Layout Support
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]111------------------
112
Uwe Hermann87c07932009-05-05 16:15:46 +0000[diff] [blame]113Please see the flashrom(8) manpage.
Ollie Lho184a4042005-11-26 21:55:36 +0000[diff] [blame]114
115
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]116Supported Flash Chips / Chipsets / Mainboards
117---------------------------------------------
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]118
Uwe Hermannf8a49fe2008-06-22 18:50:25 +0000[diff] [blame]119Please check the output of 'flashrom -L' for the list of supported
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000[diff] [blame]120flash chips, chipsets/southbridges, mainboards, and flash programmers.
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]121
Uwe Hermann0ae5acc2009-06-04 18:53:03 +0000[diff] [blame]122
Uwe Hermanne94dbf22009-05-22 13:18:38 +0000[diff] [blame]123Website
124-------
125
126The official flashrom website is:
127
Stefan Reinauer22ea8cd2009-07-30 13:32:26 +0000[diff] [blame]128 http://www.flashrom.org/
Uwe Hermannb6d28322006-12-04 08:15:47 +0000[diff] [blame]129