Blame - README - flashprog

blob: b6a07921001f7c01ee577cb85a422392014c8931 [file] [log] [blame]

Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	1	-------------------------------------------------------------------------------
Peter Stuge	44dd304	2009-04-20 12:34:30 +0000	[diff] [blame]	2	flashrom README
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	3	-------------------------------------------------------------------------------
Ronald G. Minnich	1e5003f	2002-04-10 18:02:07 +0000	[diff] [blame]	4
Carl-Daniel Hailfinger	1ebf845	2009-08-18 23:50:14 +0000	[diff] [blame]	5	flashrom is a utility for detecting, reading, writing, verifying and erasing
				6	flash chips. It is often used to flash BIOS/EFI/coreboot/firmware images
				7	in-system using a supported mainboard, but it also supports flashing of network
Uwe Hermann	c7e8a0c	2009-05-19 14:14:21 +0000	[diff] [blame]	8	cards (NICs), SATA controller cards, and other external devices which can
				9	program flash chips.
Uwe Hermann	e74b9f8	2009-04-10 14:41:29 +0000	[diff] [blame]	10
Carl-Daniel Hailfinger	1ebf845	2009-08-18 23:50:14 +0000	[diff] [blame]	11	It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and TSOP40
				12	chips, which use various protocols such as LPC, FWH, parallel flash, or SPI.
Uwe Hermann	42eb17f	2008-01-18 17:48:51 +0000	[diff] [blame]	13
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	14
Carl-Daniel Hailfinger	a23041c	2009-06-12 14:49:10 +0000	[diff] [blame]	15	Packaging
				16	---------
				17
				18	To package flashrom and remove dependencies on subversion, either use
				19	make export
				20	or
				21	make tarball
				22
				23	make export will export all flashrom files from the subversion repository at
				24	revision BASE into a directory named $EXPORTDIR/flashrom-$VERSION-r$SVNREVISION
				25	and will additionally modify the Makefile in that directory to contain the svn
				26	revision of the exported tree.
				27
				28	make tarball will simply tar up the result of make export and gzip compress it.
				29
				30	The snapshot tarballs are the result of make tarball and require no further
				31	processing.
				32
				33
Uwe Hermann	d1129ac	2009-05-28 15:07:42 +0000	[diff] [blame]	34	Build Instructions
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	35	------------------
				36
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	37	To build flashrom you need to install the following packages or ports:
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	38
Idwer Vollering	5e410de	2009-05-03 23:33:05 +0000	[diff] [blame]	39	Linux et al:
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	40
				41	* pciutils
				42	* pciutils-devel / pciutils-dev / libpci-dev
Carl-Daniel Hailfinger	10572fa	2009-08-17 16:30:53 +0000	[diff] [blame]	43	* zlib-devel / zlib1g-dev (only needed if libpci is static)
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	44
Idwer Vollering	5e410de	2009-05-03 23:33:05 +0000	[diff] [blame]	45	On FreeBSD, you need the following ports:
Idwer Vollering	5e410de	2009-05-03 23:33:05 +0000	[diff] [blame]	46
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	47	* devel/gmake
				48	* devel/libpci
Idwer Vollering	5e410de	2009-05-03 23:33:05 +0000	[diff] [blame]	49
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	50	To compile on Linux, use:
Carl-Daniel Hailfinger	9abf529	2009-05-01 16:34:32 +0000	[diff] [blame]	51
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	52	make
				53
				54	To compile on FreeBSD, use:
				55
				56	gmake
				57
Carl-Daniel Hailfinger	10572fa	2009-08-17 16:30:53 +0000	[diff] [blame]	58	To compile on Nexenta, use:
				59
				60	make
				61
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	62	To compile on Solaris, use:
				63
Carl-Daniel Hailfinger	10572fa	2009-08-17 16:30:53 +0000	[diff] [blame]	64	gmake LDFLAGS="-L$pathtolibpci" CC="gcc -I$pathtopciheaders" CFLAGS=-O2
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	65
				66	To compile on DragonFly BSD, use:
				67
				68	ln -s /usr/pkg/include/pciutils pci
Carl-Daniel Hailfinger	10572fa	2009-08-17 16:30:53 +0000	[diff] [blame]	69	gmake CFLAGS=-I. LDFLAGS="-L/usr/pkg/lib"
Carl-Daniel Hailfinger	9abf529	2009-05-01 16:34:32 +0000	[diff] [blame]	70
				71	To compile and run on Darwin/Mac OS X:
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	72
				73	Install DirectIO from coresystems GmbH.
				74	DirectIO is available at http://www.coresystems.de/en/directio.
Carl-Daniel Hailfinger	9abf529	2009-05-01 16:34:32 +0000	[diff] [blame]	75
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	76
Uwe Hermann	d1129ac	2009-05-28 15:07:42 +0000	[diff] [blame]	77	Installation
				78	------------
				79
				80	In order to install flashrom and the manpage into /usr/local, type:
				81
				82	sudo make install
				83
				84	For installation in a different directory use DESTDIR, e.g. like this:
				85
				86	sudo make DESTDIR=/usr install
				87
				88
Uwe Hermann	3d5f96c	2009-04-23 14:57:55 +0000	[diff] [blame]	89	Usage / Options
				90	---------------
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	91
Uwe Hermann	3d5f96c	2009-04-23 14:57:55 +0000	[diff] [blame]	92	Please see the flashrom(8) manpage.
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	93
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	94
Peter Stuge	42688e5	2009-01-26 02:20:56 +0000	[diff] [blame]	95	Exit status
				96	-----------
Uwe Hermann	e74b9f8	2009-04-10 14:41:29 +0000	[diff] [blame]	97
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	98	Please see the flashrom(8) manpage.
Peter Stuge	42688e5	2009-01-26 02:20:56 +0000	[diff] [blame]	99
				100
Stefan Reinauer	e3f3e2e	2008-01-18 15:33:10 +0000	[diff] [blame]	101	coreboot Table and Mainboard Identification
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	102	--------------------------------------------
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	103
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	104	Please see the flashrom(8) manpage.
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	105
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	106
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	107	ROM Layout Support
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	108	------------------
				109
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	110	Please see the flashrom(8) manpage.
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	111
				112
Uwe Hermann	f8a49fe	2008-06-22 18:50:25 +0000	[diff] [blame]	113	Supported Flash Chips / Chipsets / Mainboards
				114	---------------------------------------------
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	115
Uwe Hermann	f8a49fe	2008-06-22 18:50:25 +0000	[diff] [blame]	116	Please check the output of 'flashrom -L' for the list of supported
Uwe Hermann	c7e8a0c	2009-05-19 14:14:21 +0000	[diff] [blame]	117	flash chips, chipsets/southbridges, mainboards, and flash programmers.
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	118
Uwe Hermann	0ae5acc	2009-06-04 18:53:03 +0000	[diff] [blame]	119
Joerg Mayer	7221d5f	2009-08-24 13:24:52 +0000	[diff] [blame]	120	Contact
Uwe Hermann	e94dbf2	2009-05-22 13:18:38 +0000	[diff] [blame]	121	-------
				122
				123	The official flashrom website is:
				124
Stefan Reinauer	22ea8cd	2009-07-30 13:32:26 +0000	[diff] [blame]	125	http://www.flashrom.org/
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	126
Joerg Mayer	7221d5f	2009-08-24 13:24:52 +0000	[diff] [blame]	127	The IRC channel is
				128
				129	#flashrom at irc.freenode.net
				130
				131	The Mailing list addess is
				132
				133	flashrom@flashrom.org