README 5.08 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
It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and TSOP40
chips, which use various protocols such as LPC, FWH, parallel flash, or SPI.
13

14 15 16 17 18 19
Do not use flashrom on laptops! The embedded controller (EC) present in many
laptops interacts badly with any flash attempts and can brick your laptop
permanently.

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

20 21
Please see the flashrom(8) manpage.

Uwe Hermann's avatar
Uwe Hermann committed
22

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
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
42
Build Instructions
43 44
------------------

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

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

51
Linux et al:
52

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

57 58
On FreeBSD, you need the following ports:

59 60 61
 * devel/gmake
 * devel/libpci

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

 * devel/gmake
 * sysutils/pciutils

67 68 69 70
To compile on Linux, use:

 make

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

 gmake
74

75 76 77 78
To compile on Nexenta, use:

 make

79
To compile on Solaris, use:
80

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

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

 gmake

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

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

92 93
To cross-compile on Linux for DOS:

94 95 96
 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:
97 98
 djcross-binutils-2.19.1-10ap.i386.rpm
 djcross-gcc-4.3.2-8ap.i686.rpm
99
 djcrx-2.04pre_20090725-13ap.i386.rpm
100 101
 The cross toolchain packages for your distribution may have slightly different
 names (look for packages named *djgpp*).
Stefan Tauner's avatar
Stefan Tauner committed
102 103 104

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

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

121 122 123 124 125 126 127 128 129 130 131
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

132 133
Processor architecture dependent features:

134 135 136
 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".
137

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

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

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

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

147 148 149 150
 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
151 152


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

The official flashrom website is:

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

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

  #flashrom at irc.freenode.net

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

  flashrom@flashrom.org