README 3.04 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

Uwe Hermann's avatar
Uwe Hermann committed
14

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

37
To build flashrom you need to install the following packages or ports:
38

39
Linux et al:
40

41
 * pciutils / libpci
42
 * pciutils-devel / pciutils-dev / libpci-dev
43
 * zlib-devel / zlib1g-dev (only needed if libpci is static)
44

45 46
On FreeBSD, you need the following ports:

47 48 49 50 51 52 53 54 55 56
 * devel/gmake
 * devel/libpci

To compile on Linux, use:

 make

To compile on FreeBSD, use:

 gmake
57

58 59 60 61
To compile on Nexenta, use:

 make

62
To compile on Solaris, use:
63

64
 gmake LDFLAGS="-L$pathtolibpci" CC="gcc -I$pathtopciheaders" CFLAGS=-O2
65 66 67 68

To compile on DragonFly BSD, use:

 ln -s /usr/pkg/include/pciutils pci
69
 gmake CFLAGS=-I. LDFLAGS="-L/usr/pkg/lib"
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
Installation
------------

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

82
 make install
Uwe Hermann's avatar
Uwe Hermann committed
83 84 85

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

86 87 88 89
 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
90 91


92 93 94 95
Usage / Options
---------------

Please see the flashrom(8) manpage.
96 97


98 99
Exit status
-----------
Uwe Hermann's avatar
Uwe Hermann committed
100

101
Please see the flashrom(8) manpage.
102 103


Stefan Reinauer's avatar
Stefan Reinauer committed
104
coreboot Table and Mainboard Identification
105 106
--------------------------------------------

107
Please see the flashrom(8) manpage.
Uwe Hermann's avatar
Uwe Hermann committed
108

109

Uwe Hermann's avatar
Uwe Hermann committed
110
ROM Layout Support
111 112
------------------

113
Please see the flashrom(8) manpage.
114 115


116 117 118 119
Supported Flash Chips / Chipsets / Mainboards
---------------------------------------------

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

122

Joerg Mayer's avatar
Joerg Mayer committed
123
Contact
Uwe Hermann's avatar
Uwe Hermann committed
124 125 126 127
-------

The official flashrom website is:

128
  http://www.flashrom.org/
129

Joerg Mayer's avatar
Joerg Mayer committed
130 131 132 133 134 135 136
The IRC channel is

  #flashrom at irc.freenode.net

The Mailing list addess is

  flashrom@flashrom.org