Blame - README - flashprog

blob: d72f225acc1dbea3544d6f2ed7f37abcd2983811 [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
Peter Stuge	261cafa	2009-05-01 14:52:50 +0000	[diff] [blame]	5	flashrom is a utility for reading, writing, verifying and erasing flash ROM
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	6	chips. It's often used to flash BIOS/coreboot/firmware images.
Uwe Hermann	e74b9f8	2009-04-10 14:41:29 +0000	[diff] [blame]	7
Uwe Hermann	d42009c	2009-04-11 13:59:00 +0000	[diff] [blame]	8	It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and
				9	TSOP40 chips, which use various protocols such as LPC, FWH, parallel flash,
				10	or SPI.
Uwe Hermann	42eb17f	2008-01-18 17:48:51 +0000	[diff] [blame]	11
				12	(see http://coreboot.org for details on coreboot)
				13
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	14
				15	Build Requirements
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	16	------------------
				17
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	18	To build flashrom you need to install the following packages or ports:
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	19
Idwer Vollering	5e410de	2009-05-03 23:33:05 +0000	[diff] [blame]	20	Linux et al:
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	21
				22	* pciutils
				23	* pciutils-devel / pciutils-dev / libpci-dev
				24	* zlib-devel / zlib1g-dev
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	25
Idwer Vollering	5e410de	2009-05-03 23:33:05 +0000	[diff] [blame]	26	On FreeBSD, you need the following ports:
Idwer Vollering	5e410de	2009-05-03 23:33:05 +0000	[diff] [blame]	27
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	28	* devel/gmake
				29	* devel/libpci
Idwer Vollering	5e410de	2009-05-03 23:33:05 +0000	[diff] [blame]	30
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	31	To compile on Linux, use:
Carl-Daniel Hailfinger	9abf529	2009-05-01 16:34:32 +0000	[diff] [blame]	32
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	33	make
				34
				35	To compile on FreeBSD, use:
				36
				37	gmake
				38
				39	To compile on Solaris, use:
				40
				41	gmake LDFLAGS="-L$pathtolibpci -lpci -lz" CC="gcc -I$pathtopciheaders" \
				42	CFLAGS=-O2
				43
				44	To compile on DragonFly BSD, use:
				45
				46	ln -s /usr/pkg/include/pciutils pci
				47	gmake CFLAGS=-I. LDFLAGS="-L/usr/pkg/lib -lpci -lz"
Carl-Daniel Hailfinger	9abf529	2009-05-01 16:34:32 +0000	[diff] [blame]	48
				49	To compile and run on Darwin/Mac OS X:
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	50
				51	Install DirectIO from coresystems GmbH.
				52	DirectIO is available at http://www.coresystems.de/en/directio.
Carl-Daniel Hailfinger	9abf529	2009-05-01 16:34:32 +0000	[diff] [blame]	53
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	54
Uwe Hermann	3d5f96c	2009-04-23 14:57:55 +0000	[diff] [blame]	55	Usage / Options
				56	---------------
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	57
Uwe Hermann	3d5f96c	2009-04-23 14:57:55 +0000	[diff] [blame]	58	Please see the flashrom(8) manpage.
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	59
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	60
Peter Stuge	42688e5	2009-01-26 02:20:56 +0000	[diff] [blame]	61	Exit status
				62	-----------
Uwe Hermann	e74b9f8	2009-04-10 14:41:29 +0000	[diff] [blame]	63
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	64	Please see the flashrom(8) manpage.
Peter Stuge	42688e5	2009-01-26 02:20:56 +0000	[diff] [blame]	65
				66
Stefan Reinauer	e3f3e2e	2008-01-18 15:33:10 +0000	[diff] [blame]	67	coreboot Table and Mainboard Identification
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	68	--------------------------------------------
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	69
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	70	Please see the flashrom(8) manpage.
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	71
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	72
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	73	ROM Layout Support
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	74	------------------
				75
Uwe Hermann	87c0793	2009-05-05 16:15:46 +0000	[diff] [blame]	76	Please see the flashrom(8) manpage.
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	77
				78
Uwe Hermann	f8a49fe	2008-06-22 18:50:25 +0000	[diff] [blame]	79	Supported Flash Chips / Chipsets / Mainboards
				80	---------------------------------------------
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	81
Uwe Hermann	f8a49fe	2008-06-22 18:50:25 +0000	[diff] [blame]	82	Please check the output of 'flashrom -L' for the list of supported
				83	flash chips, chipsets/southbridges, and mainboards.
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	84
Uwe Hermann	f8a49fe	2008-06-22 18:50:25 +0000	[diff] [blame]	85	See also http://coreboot.org/Flashrom for more details.
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	86