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

5
flashrom is a utility for reading, writing, verifying and erasing flash ROM
6 7 8 9
chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
using a supported mainboard, but it also supports flashing of network
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 DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and
TSOP40 chips, which use various protocols such as LPC, FWH, parallel flash,
or SPI.
14 15 16

(see http://coreboot.org for details on coreboot)

Uwe Hermann's avatar
Uwe Hermann committed
17

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
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
37
Build Instructions
38 39
------------------

40
To build flashrom you need to install the following packages or ports:
41

42
Linux et al:
43 44 45 46

 * pciutils
 * pciutils-devel / pciutils-dev / libpci-dev
 * zlib-devel / zlib1g-dev
47

48 49
On FreeBSD, you need the following ports:

50 51 52 53 54 55 56 57 58 59
 * devel/gmake
 * devel/libpci

To compile on Linux, use:

 make

To compile on FreeBSD, use:

 gmake
60

61
To compile on Solaris, use:
62

63 64 65 66 67 68 69
 gmake LDFLAGS="-L$pathtolibpci -lpci -lz" CC="gcc -I$pathtopciheaders" \
       CFLAGS=-O2

To compile on DragonFly BSD, use:

 ln -s /usr/pkg/include/pciutils pci
 gmake CFLAGS=-I. LDFLAGS="-L/usr/pkg/lib -lpci -lz"
70 71

To compile and run on Darwin/Mac OS X:
72 73 74

 Install DirectIO from coresystems GmbH.
 DirectIO is available at http://www.coresystems.de/en/directio.
75

76

Uwe Hermann's avatar
Uwe Hermann committed
77 78 79 80 81 82 83 84 85 86 87 88
Installation
------------

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

 sudo make install

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

 sudo make DESTDIR=/usr install


89 90 91 92
Usage / Options
---------------

Please see the flashrom(8) manpage.
93 94


95 96
Exit status
-----------
Uwe Hermann's avatar
Uwe Hermann committed
97

98
Please see the flashrom(8) manpage.
99 100


Stefan Reinauer's avatar
Stefan Reinauer committed
101
coreboot Table and Mainboard Identification
102 103
--------------------------------------------

104
Please see the flashrom(8) manpage.
Uwe Hermann's avatar
Uwe Hermann committed
105

106

Uwe Hermann's avatar
Uwe Hermann committed
107
ROM Layout Support
108 109
------------------

110
Please see the flashrom(8) manpage.
111 112


113 114 115 116
Supported Flash Chips / Chipsets / Mainboards
---------------------------------------------

Please check the output of 'flashrom -L' for the list of supported
117
flash chips, chipsets/southbridges, mainboards, and flash programmers.
118

119

Uwe Hermann's avatar
Uwe Hermann committed
120 121 122 123 124 125
Website
-------

The official flashrom website is:

  http://coreboot.org/Flashrom
126