Blame - README - flashprog

blob: a3a0143f8d5d5c4660bcf55327307023fe28433c [file] [log] [blame]

Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	1	-------------------------------------------------------------------------------
				2	Flashrom README
				3	-------------------------------------------------------------------------------
Ronald G. Minnich	1e5003f	2002-04-10 18:02:07 +0000	[diff] [blame]	4
Uwe Hermann	42eb17f	2008-01-18 17:48:51 +0000	[diff] [blame]	5	Flashrom is a universal flash programming utility for DIP, PLCC, or SPI
				6	flash ROM chips. It can be used to flash BIOS/coreboot/firmware images.
				7
				8	(see http://coreboot.org for details on coreboot)
				9
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	10
				11	Build Requirements
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	12	------------------
				13
				14	To build the flashrom utility you need to have the following packages
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	15	installed on your Linux system:
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	16
				17	* pciutils
Uwe Hermann	83f0db2	2006-12-20 14:53:22 +0000	[diff] [blame]	18	* pciutils-devel / pciutils-dev
				19	* zlib-devel / zlib1g-dev
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	20
				21
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	22	Usage
Stefan Reinauer	06b2c4d	2005-12-01 10:51:08 +0000	[diff] [blame]	23	-----
				24
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	25	$ flashrom [-rwvEVfh] [-c chipname] [-s exclude_start] [-e exclude_end]
Peter Stuge	6b53fed	2008-01-27 16:21:21 +0000	[diff] [blame]	26	[-m [vendor:]part] [-l file.layout] [-i imagename] [file]
				27	-r \| --read: read flash and save into file
				28	-w \| --write: write file into flash (default when
				29	file is specified)
				30	-v \| --verify: verify flash against file
				31	-E \| --erase: erase flash device
				32	-V \| --verbose: more verbose output
				33	-c \| --chip <chipname>: probe only for specified flash chip
				34	-s \| --estart <addr>: exclude start position
				35	-e \| --eend <addr>: exclude end postion
				36	-m \| --mainboard <[vendor:]part>: override mainboard settings
				37	-f \| --force: force write without checking image
				38	-l \| --layout <file.layout>: read rom layout from file
				39	-i \| --image <name>: only flash image name from flash layout
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	40
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	41	If no file is specified, then all that happens
				42	is that flash info is dumped and the flash chip is set to writable.
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	43
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	44
Stefan Reinauer	e3f3e2e	2008-01-18 15:33:10 +0000	[diff] [blame]	45	coreboot Table and Mainboard Identification
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	46	--------------------------------------------
Ronald G. Minnich	5e5f75e	2002-01-29 18:21:41 +0000	[diff] [blame]	47
Stefan Reinauer	e3f3e2e	2008-01-18 15:33:10 +0000	[diff] [blame]	48	Flashrom reads the coreboot table to determine the current mainboard
				49	(parse DMI as well in future?). If no coreboot table could be read
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	50	or if you want to override these values, you can specify -m, e.g.:
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	51
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	52	flashrom -w --mainboard AGAMI:ARUMA agami_aruma.rom
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	53
Mondrian Nuessle	aef1c7c	2007-05-03 10:09:23 +0000	[diff] [blame]	54	The following boards require the specification of the board name, if
Stefan Reinauer	e3f3e2e	2008-01-18 15:33:10 +0000	[diff] [blame]	55	no coreboot table is found:
Mondrian Nuessle	aef1c7c	2007-05-03 10:09:23 +0000	[diff] [blame]	56
				57	* IWILL DK8-HTX: use -m iwill:dk8_htx
Luc Verhaegen	6b14175	2007-05-20 16:16:13 +0000	[diff] [blame]	58	* Agami Aruma: use -m AGAMI:ARUMA
				59	* ASUS P5A: use -m asus:p5a
Uwe Hermann	e823ee0	2007-06-05 15:02:18 +0000	[diff] [blame]	60	* IBM x3455: use -m ibm:x3455
Luc Verhaegen	fdd0c58	2007-08-11 16:59:11 +0000	[diff] [blame]	61	* EPoX EP-BX3: use -m epox:ep-bx3
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	62	* GIGABYTE GA-M57SLI-S4 v2.0: use -m gigabyte:m57sli
				63	* GIGABYTE GA-M61P-S3: use -m gigabyte:m61p
				64	* MSI K8N Neo3: use -m msi:k8n-neo3
Jonathan A. Kollasch	c778556	2007-12-02 19:03:23 +0000	[diff] [blame]	65	* Acorp 6A815EPD: use -m acorp:6a815epd
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	66
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	67
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	68	ROM Layout Support
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	69	------------------
				70
Uwe Hermann	42eb17f	2008-01-18 17:48:51 +0000	[diff] [blame]	71	Flashrom supports ROM layouts. This allows you to flash certain parts of
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	72	the flash chip only. A ROM layout file looks like follows:
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	73
				74	00000000:00008fff gfxrom
				75	00009000:0003ffff normal
				76	00040000:0007ffff fallback
				77
				78	i.e.:
				79	startaddr:endaddr name
				80
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	81	All addresses are offsets within the file, not absolute addresses!
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	82
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	83	If you only want to update the normal image in a ROM you can say:
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	84
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	85	flashrom -w --layout rom.layout --image normal agami_aruma.rom
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	86
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	87	To update normal and fallback but leave the VGA BIOS alone, say:
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	88
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	89	flashrom -w -l rom.layout -i normal -i fallback agami_aruma.rom
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	90
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	91	Currently overlapping sections are not supported.
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	92
Uwe Hermann	2dc5f42	2006-11-20 20:32:35 +0000	[diff] [blame]	93	ROM layouts should replace the -s and -e option since they are more
				94	flexible and they should lead to a ROM update file format with the
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	95	ROM layout and the ROM image in one file (cpio, zip or something?).
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	96
				97
Uwe Hermann	67808fe	2007-10-18 00:29:05 +0000	[diff] [blame]	98	Disk on Chip support
				99	--------------------
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	100
Peter Stuge	db52c58	2008-06-22 17:06:41 +0000	[diff] [blame^]	101	Disk on Chip support was removed from flashrom in r3380. It had already
				102	been disabled by default in flashrom for several years because the code
				103	was considered unstable and incomplete. The products intended to work
				104	have been End-Of-Lifed by the manufacturer for a long time.
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	105
				106
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	107	Supported Flash Chips
				108	---------------------
				109
				110	AMD AM-29F040B
				111	AMD AM-29F016D
Uwe Hermann	c22f542	2006-12-04 08:20:40 +0000	[diff] [blame]	112	ASD AE49F2008
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	113	Atmel AT-29C040A
Uwe Hermann	d7f4806	2007-04-28 02:22:59 +0000	[diff] [blame]	114	Atmel AT-29C020
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	115	EMST F49B002UA
				116	Intel 82802AB (Firmware Hub)
				117	Intel 82802AC (Firmware Hub)
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	118	MX MX-29F002
				119	PMC PMC-49FL002
				120	PMC PMC-49FL004
				121	Sharp LHF-00L04
Peter Stuge	79fd6d2	2008-01-27 07:17:14 +0000	[diff] [blame]	122	Spansion S25FL016A
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	123	SST SST-29EE020A
				124	SST SST-28SF040A
				125	SST SST-39SF010A
				126	SST SST-39SF020A
				127	SST SST-39SF040
				128	SST SST-39VF020
				129	SST SST-49LF040B
				130	SST SST-49LF040
				131	SST SST-49LF020A
				132	SST SST-49LF080A
Alan Carvalho de Assis	474230a	2007-01-27 13:39:06 +0000	[diff] [blame]	133	SST SST-49LF160C
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	134	SST SST-49LF002A/B
				135	SST SST-49LF003A/B
				136	SST SST-49LF004A/B
				137	SST SST-49LF008A
Yinghai Lu	ca78297	2007-01-22 20:21:17 +0000	[diff] [blame]	138	SST SST-49LF004C
				139	SST SST-49LF008C
				140	SST SST-49LF016C
Uwe Hermann	627505b	2007-07-27 03:32:45 +0000	[diff] [blame]	141	ST ST-M50FLW040A
				142	ST ST-M50FLW040B
				143	ST ST-M50FLW080A
				144	ST ST-M50FLW080B
				145	ST ST-M50FW040
				146	ST ST-M50FW080
				147	ST ST-M50FW016
				148	ST ST-M50LPW116
Uwe Hermann	d7f4806	2007-04-28 02:22:59 +0000	[diff] [blame]	149	ST ST-M29F002B
				150	ST ST-M29F002T
				151	ST ST-M29F002NT
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	152	ST ST-M29F400BT
				153	ST ST-M29F040B
Uwe Hermann	627505b	2007-07-27 03:32:45 +0000	[diff] [blame]	154	ST ST-M29W010B
				155	ST ST-M29W040B
Uwe Hermann	c22f542	2006-12-04 08:20:40 +0000	[diff] [blame]	156	SyncMOS S29C51001T/B
				157	SyncMOS S29C51002T/B
				158	SyncMOS S29C51004T/B
				159	SyncMOS S29C31004T
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	160	Winbond W29C011
				161	Winbond W29C020C
Markus Boas	05e7f45	2007-08-30 10:11:08 +0000	[diff] [blame]	162	Winbond W29C040P
Markus Boas	d2ac6fc	2007-08-30 10:17:50 +0000	[diff] [blame]	163	Winbond W29EE011
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	164	Winbond W49F002U
				165	Winbond W49V002A
				166	Winbond W49V002FA
Uwe Hermann	bc1f1a0	2007-05-21 21:39:08 +0000	[diff] [blame]	167	Winbond W39V040FA
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	168	Winbond W39V040A
				169	Winbond W39V040B
David Hendricks	71437d0	2007-03-02 02:25:36 +0000	[diff] [blame]	170	Winbond W39V080A
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	171
				172
				173	Supported Southbridges
				174	----------------------
				175
Uwe Hermann	f4a673b	2007-06-06 21:35:45 +0000	[diff] [blame]	176	AMD CS5530/CS5530A
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	177	AMD Geode SC1100
				178	AMD AMD-8111
				179	ATI SB400
Uwe Hermann	e823ee0	2007-06-05 15:02:18 +0000	[diff] [blame]	180	Broadcom HT-1000
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	181	Intel ICH0-ICH8 (all variations)
				182	Intel PIIX4/PIIX4E/PIIX4M
				183	NVIDIA CK804
				184	NVIDIA MCP51
Yinghai Lu	ca78297	2007-01-22 20:21:17 +0000	[diff] [blame]	185	NVIDIA MCP55
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	186	SiS 630
				187	SiS 5595
Uwe Hermann	a4c63c2	2007-04-09 22:59:22 +0000	[diff] [blame]	188	VIA CX700
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	189	VIA VT8231
				190	VIA VT8235
				191	VIA VT8237
				192	VIA VT82C686
				193