README 5.16 KB
Newer Older
Uwe Hermann's avatar
Uwe Hermann committed
1
-------------------------------------------------------------------------------
2
flashrom README
Uwe Hermann's avatar
Uwe Hermann committed
3
-------------------------------------------------------------------------------
4

5 6 7
flashrom is a utility for detecting, reading, writing, verifying and erasing
flash chips. It is often used to flash BIOS/EFI/coreboot/firmware images
in-system using a supported mainboard, but it also supports flashing of network
8 9
cards (NICs), SATA controller cards, and other external devices which can
program flash chips.
Uwe Hermann's avatar
Uwe Hermann committed
10

11 12 13
It supports a wide range of flash chips (most commonly found in SOIC8, DIP8,
SOIC16, WSON8, PLCC32, DIP32, TSOP32, and TSOP40 packages), which use various
protocols such as LPC, FWH, parallel flash, or SPI.
14

15 16 17
Do not use flashrom on laptops (yet)! The embedded controller (EC) present in
many laptops might interact badly with any attempts to communicate with the
flash chip and may brick your laptop.
18 19 20

Please make a backup of your flash chip before writing to it.

21 22
Please see the flashrom(8) manpage.

Uwe Hermann's avatar
Uwe Hermann committed
23

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
Packaging
---------

To package flashrom and remove dependencies on subversion, either use
make export
or
make tarball

make export will export all flashrom files from the subversion repository at
revision BASE into a directory named $EXPORTDIR/flashrom-$VERSION-r$SVNREVISION
and will additionally modify the Makefile in that directory to contain the svn
revision of the exported tree.

make tarball will simply tar up the result of make export and gzip compress it.

The snapshot tarballs are the result of make tarball and require no further
processing.


Uwe Hermann's avatar
Uwe Hermann committed
43
Build Instructions
44 45
------------------

46 47 48
To build flashrom you need to install the following software:

 * pciutils+libpci (if you want support for mainboard or PCI device flashing)
49 50
 * libusb (if you want FT2232, Dediprog or USB-Blaster support)
 * libftdi (if you want FT2232 or USB-Blaster support)
51

52
Linux et al:
53

54
 * pciutils / libpci
55
 * pciutils-devel / pciutils-dev / libpci-dev
56
 * zlib-devel / zlib1g-dev (needed if libpci was compiled with libz support)
57

58 59
On FreeBSD, you need the following ports:

60 61 62
 * devel/gmake
 * devel/libpci

Carl-Daniel Hailfinger's avatar
Carl-Daniel Hailfinger committed
63 64 65 66 67
On OpenBSD, you need the following ports:

 * devel/gmake
 * sysutils/pciutils

68 69 70 71
To compile on Linux, use:

 make

Stefan Tauner's avatar
Stefan Tauner committed
72
To compile on FreeBSD, OpenBSD or DragonFly BSD, use:
73 74

 gmake
75

76 77 78 79
To compile on Nexenta, use:

 make

80
To compile on Solaris, use:
81

82
 gmake LDFLAGS="-L$pathtolibpci" CC="gcc -I$pathtopciheaders" CFLAGS=-O2
83

Stefan Tauner's avatar
Stefan Tauner committed
84
To compile on NetBSD (with pciutils, libftdi, libusb installed in /usr/pkg/), use:
Carl-Daniel Hailfinger's avatar
Carl-Daniel Hailfinger committed
85 86 87

 gmake

88
To compile and run on Darwin/Mac OS X:
89

90
 Install DirectHW from coresystems GmbH.
91
 DirectHW is available at http://www.coreboot.org/DirectHW .
92

93 94
To cross-compile on Linux for DOS:

95 96 97
 Get packages of the DJGPP cross compiler and install them:
 djgpp-filesystem djgpp-gcc djgpp-cpp djgpp-runtime djgpp-binutils
 As an alternative, the DJGPP web site offers packages for download as well:
98 99
 djcross-binutils-2.19.1-10ap.i386.rpm
 djcross-gcc-4.3.2-8ap.i686.rpm
100
 djcrx-2.04pre_20090725-13ap.i386.rpm
101 102
 The cross toolchain packages for your distribution may have slightly different
 names (look for packages named *djgpp*).
Stefan Tauner's avatar
Stefan Tauner committed
103 104 105

 You will need the following library source trees containing their compiled
 static libraries either in the parent directory of the flashrom source or
106
 specify the base folder on compile time with the LIBS_BASE parameter.
Stefan Tauner's avatar
Stefan Tauner committed
107
 The default as described above is equal to calling
108
   'make djgpp-dos LIBS_BASE=..'
Stefan Tauner's avatar
Stefan Tauner committed
109 110 111

 To get and build said libraries...
 Download pciutils 3.1.5 and apply http://flashrom.org/File:Pciutils.patch.gz
112
 Compile pciutils, see README.DJGPP for instructions.
Stefan Tauner's avatar
Stefan Tauner committed
113
 Download and compile http://flashrom.org/File:Libgetopt.tar.gz
114 115
 Enter the flashrom directory.
 Run either (change settings where appropriate)
116
 make CC=i586-pc-msdosdjgpp-gcc STRIP=i586-pc-msdosdjgpp-strip
117 118
 or (above settings hardcoded)
 make djgpp-dos
Stefan Tauner's avatar
Stefan Tauner committed
119 120
 To run flashrom.exe, download http://flashrom.org/File:Csdpmi7b.zip and
 unpack CWSDPMI.EXE into the current directory or one in PATH.
121

122 123 124 125 126 127 128 129 130 131 132
To cross-compile on Linux for Windows:

 Get packages of the MinGW cross compiler and install them:
 mingw32-filesystem mingw32-cross-cpp mingw32-cross-binutils mingw32-cross-gcc
 mingw32-runtime mingw32-headers
 The cross toolchain packages for your distribution may have slightly different
 names (look for packages named *mingw*).
 PCI-based programmers (internal etc.) are not supported on Windows.
 Run (change CC= and STRIP= settings where appropriate)
 make CC=i686-w64-mingw32-gcc STRIP=i686-w64-mingw32-strip

133 134
Processor architecture dependent features:

135 136 137
 On non-x86 architectures a few programmers don't work (yet) because they
 use port-based I/O which is not directly available on non-x86. Those
 programmers will be disabled automatically if you run "make".
138

Uwe Hermann's avatar
Uwe Hermann committed
139 140 141 142 143
Installation
------------

In order to install flashrom and the manpage into /usr/local, type:

144
 make install
Uwe Hermann's avatar
Uwe Hermann committed
145 146 147

For installation in a different directory use DESTDIR, e.g. like this:

148 149 150 151
 make DESTDIR=/usr install

If you have insufficient permissions for the destination directory, use sudo
by adding sudo in front of the commands above.
Uwe Hermann's avatar
Uwe Hermann committed
152 153


Joerg Mayer's avatar
Joerg Mayer committed
154
Contact
Uwe Hermann's avatar
Uwe Hermann committed
155 156 157 158
-------

The official flashrom website is:

159
  http://www.flashrom.org/
160

Joerg Mayer's avatar
Joerg Mayer committed
161 162 163 164
The IRC channel is

  #flashrom at irc.freenode.net

165
The mailing list address is
Joerg Mayer's avatar
Joerg Mayer committed
166 167

  flashrom@flashrom.org