README 4.51 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 48 49
To build flashrom you need to install the following software:

 * pciutils+libpci (if you want support for mainboard or PCI device flashing)
 * libusb (if you want FT2232 or Dediprog support)
 * libftdi (if you want FT2232 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 71 72 73
To compile on Linux, use:

 make

To compile on FreeBSD, use:

 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

Jonathan A. Kollasch's avatar
Jonathan A. Kollasch committed
83
To compile on NetBSD or DragonFly BSD, use:
84 85

 ln -s /usr/pkg/include/pciutils pci
86 87
 gmake CPPFLAGS="-I. -I/usr/pkg/include" \
       LDFLAGS="-L/usr/pkg/lib -Wl,-rpath-link,/usr/pkg/lib"
88

Carl-Daniel Hailfinger's avatar
Carl-Daniel Hailfinger committed
89 90 91 92
To compile on OpenBSD, use:

 gmake

93
To compile and run on Darwin/Mac OS X:
94

95 96
 Install DirectHW from coresystems GmbH.
 DirectHW is available at http://www.coresystems.de/en/directhw .
97

98 99 100 101 102
To cross-compile on Linux for DOS:

 Get RPMs of the cross compiler from the DJGPP site and install them:
 djcross-binutils-2.19.1-10ap.i386.rpm
 djcross-gcc-4.3.2-8ap.i686.rpm
103
 djcrx-2.04pre_20090725-13ap.i386.rpm
104 105 106 107 108 109 110 111 112 113 114
 Download pciutils 3.1.5 and apply http://assembler.cz/flashrom/pciutils.patch
 Download and compile http://assembler.cz/flashrom/libgetopt/
 Compile pciutils, see README.DJGPP for instructions.
 Enter the flashrom directory.
 ../libpci should contain pciutils source and binaries.
 ../libgetopt should contain getopt.a from libgetopt.
 Run either (change settings where appropriate)
 make CC=i586-pc-msdosdjgpp-gcc STRIP=i586-pc-msdosdjgpp-strip OS_ARCH=DOS
 or (above settings hardcoded)
 make djgpp-dos
 You might have to add WARNERROR=no to the make command line.
115 116 117
 To run flashrom.exe, download and unpack
 http://homer.rice.edu/~sandmann/cwsdpmi/csdpmi7b.zip and make sure
 CWSDPMI.EXE is in the current directory.
118

119 120 121 122 123 124 125 126 127 128 129 130
Processor architecture dependent features:

 On non-x86 architectures you have to disable a few programmers because they
 use port-based I/O which is not directly available on non-x86. Please add
 CONFIG_RAYER_SPI=no CONFIG_NIC3COM=no CONFIG_ATAHPT=no CONFIG_NICREALTEK=no \
 CONFIG_NICNATSEMI=no
 as parameters to the "make" invocation.
 Besides that, the internal programmer is only supported on x86 and MIPS. On
 other architectures, please add
 CONFIG_INTERNAL=no
 as parameter to the "make" invocation.

Uwe Hermann's avatar
Uwe Hermann committed
131 132 133 134 135
Installation
------------

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

136
 make install
Uwe Hermann's avatar
Uwe Hermann committed
137 138 139

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

140 141 142 143
 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
144 145


Joerg Mayer's avatar
Joerg Mayer committed
146
Contact
Uwe Hermann's avatar
Uwe Hermann committed
147 148 149 150
-------

The official flashrom website is:

151
  http://www.flashrom.org/
152

Joerg Mayer's avatar
Joerg Mayer committed
153 154 155 156
The IRC channel is

  #flashrom at irc.freenode.net

157
The mailing list address is
Joerg Mayer's avatar
Joerg Mayer committed
158 159

  flashrom@flashrom.org