blob: b29784ce05f60487160b24c8b4fb01f83f424797 [file] [log] [blame]
Uwe Hermann2dc5f422006-11-20 20:32:35 +00001-------------------------------------------------------------------------------
Peter Stuge44dd3042009-04-20 12:34:30 +00002flashrom README
Uwe Hermann2dc5f422006-11-20 20:32:35 +00003-------------------------------------------------------------------------------
Ronald G. Minnich1e5003f2002-04-10 18:02:07 +00004
Carl-Daniel Hailfinger1ebf8452009-08-18 23:50:14 +00005flashrom is a utility for detecting, reading, writing, verifying and erasing
6flash chips. It is often used to flash BIOS/EFI/coreboot/firmware images
7in-system using a supported mainboard, but it also supports flashing of network
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +00008cards (NICs), SATA controller cards, and other external devices which can
9program flash chips.
Uwe Hermanne74b9f82009-04-10 14:41:29 +000010
Carl-Daniel Hailfinger1ebf8452009-08-18 23:50:14 +000011It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and TSOP40
12chips, which use various protocols such as LPC, FWH, parallel flash, or SPI.
Uwe Hermann42eb17f2008-01-18 17:48:51 +000013
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +000014Do not use flashrom on laptops! The embedded controller (EC) present in many
15laptops interacts badly with any flash attempts and can brick your laptop
16permanently.
17
18Please make a backup of your flash chip before writing to it.
19
Stefan Reinauer009c51b2010-01-03 23:50:28 +000020Please see the flashrom(8) manpage.
21
Uwe Hermann2dc5f422006-11-20 20:32:35 +000022
Carl-Daniel Hailfingera23041c2009-06-12 14:49:10 +000023Packaging
24---------
25
26To package flashrom and remove dependencies on subversion, either use
27make export
28or
29make tarball
30
31make export will export all flashrom files from the subversion repository at
32revision BASE into a directory named $EXPORTDIR/flashrom-$VERSION-r$SVNREVISION
33and will additionally modify the Makefile in that directory to contain the svn
34revision of the exported tree.
35
36make tarball will simply tar up the result of make export and gzip compress it.
37
38The snapshot tarballs are the result of make tarball and require no further
39processing.
40
41
Uwe Hermannd1129ac2009-05-28 15:07:42 +000042Build Instructions
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +000043------------------
44
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +000045To build flashrom you need to install the following software:
46
47 * pciutils+libpci (if you want support for mainboard or PCI device flashing)
James Lairdc60de0e2013-03-27 13:00:23 +000048 * libusb (if you want FT2232, Dediprog or USB-Blaster support)
49 * libftdi (if you want FT2232 or USB-Blaster support)
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +000050
Idwer Vollering5e410de2009-05-03 23:33:05 +000051Linux et al:
Uwe Hermann87c07932009-05-05 16:15:46 +000052
Carl-Daniel Hailfingera472b8b2009-10-03 17:08:02 +000053 * pciutils / libpci
Uwe Hermann87c07932009-05-05 16:15:46 +000054 * pciutils-devel / pciutils-dev / libpci-dev
Carl-Daniel Hailfinger50415d22010-03-21 14:54:57 +000055 * zlib-devel / zlib1g-dev (needed if libpci was compiled with libz support)
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +000056
Idwer Vollering5e410de2009-05-03 23:33:05 +000057On FreeBSD, you need the following ports:
Idwer Vollering5e410de2009-05-03 23:33:05 +000058
Uwe Hermann87c07932009-05-05 16:15:46 +000059 * devel/gmake
60 * devel/libpci
Idwer Vollering5e410de2009-05-03 23:33:05 +000061
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +000062On OpenBSD, you need the following ports:
63
64 * devel/gmake
65 * sysutils/pciutils
66
Uwe Hermann87c07932009-05-05 16:15:46 +000067To compile on Linux, use:
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000068
Uwe Hermann87c07932009-05-05 16:15:46 +000069 make
70
Stefan Tauner8d21ff12015-01-10 09:33:06 +000071To compile on FreeBSD, OpenBSD or DragonFly BSD, use:
Uwe Hermann87c07932009-05-05 16:15:46 +000072
73 gmake
74
Carl-Daniel Hailfinger10572fa2009-08-17 16:30:53 +000075To compile on Nexenta, use:
76
77 make
78
Uwe Hermann87c07932009-05-05 16:15:46 +000079To compile on Solaris, use:
80
Carl-Daniel Hailfinger10572fa2009-08-17 16:30:53 +000081 gmake LDFLAGS="-L$pathtolibpci" CC="gcc -I$pathtopciheaders" CFLAGS=-O2
Uwe Hermann87c07932009-05-05 16:15:46 +000082
Stefan Tauner8d21ff12015-01-10 09:33:06 +000083To compile on NetBSD (with pciutils, libftdi, libusb installed in /usr/pkg/), use:
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +000084
85 gmake
86
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000087To compile and run on Darwin/Mac OS X:
Uwe Hermann87c07932009-05-05 16:15:46 +000088
Carl-Daniel Hailfingerf992c192010-10-06 23:16:10 +000089 Install DirectHW from coresystems GmbH.
Carl-Daniel Hailfinger60d9bd22012-08-09 23:34:41 +000090 DirectHW is available at http://www.coreboot.org/DirectHW .
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000091
Carl-Daniel Hailfinger50415d22010-03-21 14:54:57 +000092To cross-compile on Linux for DOS:
93
Carl-Daniel Hailfinger60d9bd22012-08-09 23:34:41 +000094 Get packages of the DJGPP cross compiler and install them:
95 djgpp-filesystem djgpp-gcc djgpp-cpp djgpp-runtime djgpp-binutils
96 As an alternative, the DJGPP web site offers packages for download as well:
Carl-Daniel Hailfinger50415d22010-03-21 14:54:57 +000097 djcross-binutils-2.19.1-10ap.i386.rpm
Carl-Daniel Hailfinger50415d22010-03-21 14:54:57 +000098 djcross-gcc-4.3.2-8ap.i686.rpm
Idwer Vollering9c31b502010-10-05 13:31:12 +000099 djcrx-2.04pre_20090725-13ap.i386.rpm
Carl-Daniel Hailfinger60d9bd22012-08-09 23:34:41 +0000100 The cross toolchain packages for your distribution may have slightly different
101 names (look for packages named *djgpp*).
Stefan Tauner449abe22013-09-11 23:34:57 +0000102
103 You will need the following library source trees containing their compiled
104 static libraries either in the parent directory of the flashrom source or
Stefan Taunerbe62d3f2015-01-10 09:32:44 +0000105 specify the base folder on compile time with the LIBS_BASE parameter.
Stefan Tauner449abe22013-09-11 23:34:57 +0000106 The default as described above is equal to calling
Stefan Taunerbe62d3f2015-01-10 09:32:44 +0000107 'make djgpp-dos LIBS_BASE=..'
Stefan Tauner449abe22013-09-11 23:34:57 +0000108
109 To get and build said libraries...
110 Download pciutils 3.1.5 and apply http://flashrom.org/File:Pciutils.patch.gz
Carl-Daniel Hailfinger50415d22010-03-21 14:54:57 +0000111 Compile pciutils, see README.DJGPP for instructions.
Stefan Tauner449abe22013-09-11 23:34:57 +0000112 Download and compile http://flashrom.org/File:Libgetopt.tar.gz
Carl-Daniel Hailfinger50415d22010-03-21 14:54:57 +0000113 Enter the flashrom directory.
Carl-Daniel Hailfinger50415d22010-03-21 14:54:57 +0000114 Run either (change settings where appropriate)
Carl-Daniel Hailfinger60d9bd22012-08-09 23:34:41 +0000115 make CC=i586-pc-msdosdjgpp-gcc STRIP=i586-pc-msdosdjgpp-strip
Carl-Daniel Hailfinger50415d22010-03-21 14:54:57 +0000116 or (above settings hardcoded)
117 make djgpp-dos
Stefan Tauner449abe22013-09-11 23:34:57 +0000118 To run flashrom.exe, download http://flashrom.org/File:Csdpmi7b.zip and
119 unpack CWSDPMI.EXE into the current directory or one in PATH.
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +0000120
Carl-Daniel Hailfinger60d9bd22012-08-09 23:34:41 +0000121To cross-compile on Linux for Windows:
122
123 Get packages of the MinGW cross compiler and install them:
124 mingw32-filesystem mingw32-cross-cpp mingw32-cross-binutils mingw32-cross-gcc
125 mingw32-runtime mingw32-headers
126 The cross toolchain packages for your distribution may have slightly different
127 names (look for packages named *mingw*).
128 PCI-based programmers (internal etc.) are not supported on Windows.
129 Run (change CC= and STRIP= settings where appropriate)
130 make CC=i686-w64-mingw32-gcc STRIP=i686-w64-mingw32-strip
131
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000132Processor architecture dependent features:
133
Carl-Daniel Hailfinger60d9bd22012-08-09 23:34:41 +0000134 On non-x86 architectures a few programmers don't work (yet) because they
135 use port-based I/O which is not directly available on non-x86. Those
136 programmers will be disabled automatically if you run "make".
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000137
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000138Installation
139------------
140
141In order to install flashrom and the manpage into /usr/local, type:
142
Carl-Daniel Hailfingera472b8b2009-10-03 17:08:02 +0000143 make install
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000144
145For installation in a different directory use DESTDIR, e.g. like this:
146
Carl-Daniel Hailfingera472b8b2009-10-03 17:08:02 +0000147 make DESTDIR=/usr install
148
149If you have insufficient permissions for the destination directory, use sudo
150by adding sudo in front of the commands above.
Uwe Hermannd1129ac2009-05-28 15:07:42 +0000151
152
Joerg Mayer7221d5f2009-08-24 13:24:52 +0000153Contact
Uwe Hermanne94dbf22009-05-22 13:18:38 +0000154-------
155
156The official flashrom website is:
157
Stefan Reinauer22ea8cd2009-07-30 13:32:26 +0000158 http://www.flashrom.org/
Uwe Hermannb6d28322006-12-04 08:15:47 +0000159
Joerg Mayer7221d5f2009-08-24 13:24:52 +0000160The IRC channel is
161
162 #flashrom at irc.freenode.net
163
Uwe Hermann4e3d0b32010-03-25 23:18:41 +0000164The mailing list address is
Joerg Mayer7221d5f2009-08-24 13:24:52 +0000165
166 flashrom@flashrom.org