blob: 7df2f5e7b941ac33f5236c391ac75837e3ad91c4 [file] [log] [blame]
Uwe Hermann2dc5f422006-11-20 20:32:35 +00001-------------------------------------------------------------------------------
Peter Stuge44dd3042009-04-20 12:34:30 +00002flashrom README
Uwe Hermann2dc5f422006-11-20 20:32:35 +00003-------------------------------------------------------------------------------
Ronald G. Minnich1e5003f2002-04-10 18:02:07 +00004
Peter Stuge261cafa2009-05-01 14:52:50 +00005flashrom is a utility for reading, writing, verifying and erasing flash ROM
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +00006chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
7using a supported mainboard, but it also supports flashing of network
8cards (NICs), SATA controller cards, and other external devices which can
9program flash chips.
Uwe Hermanne74b9f82009-04-10 14:41:29 +000010
Uwe Hermannd42009c2009-04-11 13:59:00 +000011It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and
12TSOP40 chips, which use various protocols such as LPC, FWH, parallel flash,
13or SPI.
Uwe Hermann42eb17f2008-01-18 17:48:51 +000014
15(see http://coreboot.org for details on coreboot)
16
Uwe Hermann2dc5f422006-11-20 20:32:35 +000017
18Build Requirements
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +000019------------------
20
Uwe Hermann87c07932009-05-05 16:15:46 +000021To build flashrom you need to install the following packages or ports:
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +000022
Idwer Vollering5e410de2009-05-03 23:33:05 +000023Linux et al:
Uwe Hermann87c07932009-05-05 16:15:46 +000024
25 * pciutils
26 * pciutils-devel / pciutils-dev / libpci-dev
27 * zlib-devel / zlib1g-dev
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +000028
Idwer Vollering5e410de2009-05-03 23:33:05 +000029On FreeBSD, you need the following ports:
Idwer Vollering5e410de2009-05-03 23:33:05 +000030
Uwe Hermann87c07932009-05-05 16:15:46 +000031 * devel/gmake
32 * devel/libpci
Idwer Vollering5e410de2009-05-03 23:33:05 +000033
Uwe Hermann87c07932009-05-05 16:15:46 +000034To compile on Linux, use:
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000035
Uwe Hermann87c07932009-05-05 16:15:46 +000036 make
37
38To compile on FreeBSD, use:
39
40 gmake
41
42To compile on Solaris, use:
43
44 gmake LDFLAGS="-L$pathtolibpci -lpci -lz" CC="gcc -I$pathtopciheaders" \
45 CFLAGS=-O2
46
47To compile on DragonFly BSD, use:
48
49 ln -s /usr/pkg/include/pciutils pci
50 gmake CFLAGS=-I. LDFLAGS="-L/usr/pkg/lib -lpci -lz"
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000051
52To compile and run on Darwin/Mac OS X:
Uwe Hermann87c07932009-05-05 16:15:46 +000053
54 Install DirectIO from coresystems GmbH.
55 DirectIO is available at http://www.coresystems.de/en/directio.
Carl-Daniel Hailfinger9abf5292009-05-01 16:34:32 +000056
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +000057
Uwe Hermann3d5f96c2009-04-23 14:57:55 +000058Usage / Options
59---------------
Stefan Reinauer06b2c4d2005-12-01 10:51:08 +000060
Uwe Hermann3d5f96c2009-04-23 14:57:55 +000061Please see the flashrom(8) manpage.
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000062
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000063
Peter Stuge42688e52009-01-26 02:20:56 +000064Exit status
65-----------
Uwe Hermanne74b9f82009-04-10 14:41:29 +000066
Uwe Hermann87c07932009-05-05 16:15:46 +000067Please see the flashrom(8) manpage.
Peter Stuge42688e52009-01-26 02:20:56 +000068
69
Stefan Reinauere3f3e2e2008-01-18 15:33:10 +000070coreboot Table and Mainboard Identification
Ollie Lho184a4042005-11-26 21:55:36 +000071--------------------------------------------
Ronald G. Minnich5e5f75e2002-01-29 18:21:41 +000072
Uwe Hermann87c07932009-05-05 16:15:46 +000073Please see the flashrom(8) manpage.
Uwe Hermann67808fe2007-10-18 00:29:05 +000074
Ollie Lho184a4042005-11-26 21:55:36 +000075
Uwe Hermann2dc5f422006-11-20 20:32:35 +000076ROM Layout Support
Ollie Lho184a4042005-11-26 21:55:36 +000077------------------
78
Uwe Hermann87c07932009-05-05 16:15:46 +000079Please see the flashrom(8) manpage.
Ollie Lho184a4042005-11-26 21:55:36 +000080
81
Uwe Hermannf8a49fe2008-06-22 18:50:25 +000082Supported Flash Chips / Chipsets / Mainboards
83---------------------------------------------
Uwe Hermannb6d28322006-12-04 08:15:47 +000084
Uwe Hermannf8a49fe2008-06-22 18:50:25 +000085Please check the output of 'flashrom -L' for the list of supported
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +000086flash chips, chipsets/southbridges, mainboards, and flash programmers.
Uwe Hermannb6d28322006-12-04 08:15:47 +000087
Uwe Hermanne94dbf22009-05-22 13:18:38 +000088Website
89-------
90
91The official flashrom website is:
92
93 http://coreboot.org/Flashrom
Uwe Hermannb6d28322006-12-04 08:15:47 +000094