source: trunk/README @ 1203

Revision 1203, 4.5 KB checked in by hailfinger, 16 months ago (diff)

CONFIG_BITBANG_SPI was not selected if CONFIG_NICINTEL_SPI was on by
default.
Wiki output was missing all flash chips if CONFIG_INTERNAL was not
selected.
Use correct type for toupper()/tolower()/isspace() functions.
Specify software requirements in a generic way.
Non-x86 compilation does not work with the default programmer set, so
list the make parameters which result in a working build.

Signed-off-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@…>
Acked-by: Michael Karcher <flashrom@…>
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1-------------------------------------------------------------------------------
2flashrom README
3-------------------------------------------------------------------------------
4
5flashrom is a utility for detecting, reading, writing, verifying and erasing
6flash chips. It is often used to flash BIOS/EFI/coreboot/firmware images
7in-system using a supported mainboard, but it also supports flashing of network
8cards (NICs), SATA controller cards, and other external devices which can
9program flash chips.
10
11It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and TSOP40
12chips, which use various protocols such as LPC, FWH, parallel flash, or SPI.
13
14Do not use flashrom on laptops! The embedded controller (EC) present in many
15laptops interacts badly with any flash attempts and can brick your laptop
16permanently.
17
18Please make a backup of your flash chip before writing to it.
19
20Please see the flashrom(8) manpage.
21
22
23Packaging
24---------
25
26To package flashrom and remove dependencies on subversion, either use
27make export
28or
29make tarball
30
31make export will export all flashrom files from the subversion repository at
32revision BASE into a directory named $EXPORTDIR/flashrom-$VERSION-r$SVNREVISION
33and will additionally modify the Makefile in that directory to contain the svn
34revision of the exported tree.
35
36make tarball will simply tar up the result of make export and gzip compress it.
37
38The snapshot tarballs are the result of make tarball and require no further
39processing.
40
41
42Build Instructions
43------------------
44
45To build flashrom you need to install the following software:
46
47 * pciutils+libpci (if you want support for mainboard or PCI device flashing)
48 * libusb (if you want FT2232 or Dediprog support)
49 * libftdi (if you want FT2232 support)
50
51Linux 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
57On FreeBSD, you need the following ports:
58
59 * devel/gmake
60 * devel/libpci
61
62On OpenBSD, you need the following ports:
63
64 * devel/gmake
65 * sysutils/pciutils
66
67To compile on Linux, use:
68
69 make
70
71To compile on FreeBSD, use:
72
73 gmake
74
75To compile on Nexenta, use:
76
77 make
78
79To compile on Solaris, use:
80
81 gmake LDFLAGS="-L$pathtolibpci" CC="gcc -I$pathtopciheaders" CFLAGS=-O2
82
83To compile on NetBSD or DragonFly BSD, use:
84
85 ln -s /usr/pkg/include/pciutils pci
86 gmake CPPFLAGS=-I. LDFLAGS="-L/usr/pkg/lib -Wl,-rpath-link,/usr/pkg/lib"
87
88To compile on OpenBSD, use:
89
90 gmake
91
92To compile and run on Darwin/Mac OS X:
93
94 Install DirectHW from coresystems GmbH.
95 DirectHW is available at http://www.coresystems.de/en/directhw .
96
97To cross-compile on Linux for DOS:
98
99 Get RPMs of the cross compiler from the DJGPP site and install them:
100 djcross-binutils-2.19.1-10ap.i386.rpm
101 djcross-gcc-4.3.2-8ap.i686.rpm
102 djcrx-2.04pre_20090725-13ap.i386.rpm
103 Download pciutils 3.1.5 and apply http://assembler.cz/flashrom/pciutils.patch
104 Download and compile http://assembler.cz/flashrom/libgetopt/
105 Compile pciutils, see README.DJGPP for instructions.
106 Enter the flashrom directory.
107 ../libpci should contain pciutils source and binaries.
108 ../libgetopt should contain getopt.a from libgetopt.
109 Run either (change settings where appropriate)
110 make CC=i586-pc-msdosdjgpp-gcc STRIP=i586-pc-msdosdjgpp-strip OS_ARCH=DOS
111 or (above settings hardcoded)
112 make djgpp-dos
113 You might have to add WARNERROR=no to the make command line.
114 To run flashrom.exe, download and unpack
115 http://homer.rice.edu/~sandmann/cwsdpmi/csdpmi7b.zip and make sure
116 CWSDPMI.EXE is in the current directory.
117
118Processor architecture dependent features:
119
120 On non-x86 architectures you have to disable a few programmers because they
121 use port-based I/O which is not directly available on non-x86. Please add
122 CONFIG_RAYER_SPI=no CONFIG_NIC3COM=no CONFIG_ATAHPT=no CONFIG_NICREALTEK=no \
123 CONFIG_NICNATSEMI=no
124 as parameters to the "make" invocation.
125 Besides that, the internal programmer is only supported on x86 and MIPS. On
126 other architectures, please add
127 CONFIG_INTERNAL=no
128 as parameter to the "make" invocation.
129
130Installation
131------------
132
133In order to install flashrom and the manpage into /usr/local, type:
134
135 make install
136
137For installation in a different directory use DESTDIR, e.g. like this:
138
139 make DESTDIR=/usr install
140
141If you have insufficient permissions for the destination directory, use sudo
142by adding sudo in front of the commands above.
143
144
145Contact
146-------
147
148The official flashrom website is:
149
150  http://www.flashrom.org/
151
152The IRC channel is
153
154  #flashrom at irc.freenode.net
155
156The mailing list address is
157
158  flashrom@flashrom.org
Note: See TracBrowser for help on using the repository browser.