Blame - README - flashprog

blob: 312304b5b468fc17913c34dca87aa510d71de983 [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]
				26	[-m vendor:part] [-l file.layout] [-i imagename] [file]
Stefan Reinauer	f8337dd	2006-08-03 10:49:09 +0000	[diff] [blame]	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
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	36	-m \| --mainboard <vendor:part>: override mainboard settings
Stefan Reinauer	f8337dd	2006-08-03 10:49:09 +0000	[diff] [blame]	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
Uwe Hermann	42eb17f	2008-01-18 17:48:51 +0000	[diff] [blame]	101	Disk on Chip support is currently disabled since it is considered unstable.
Stefan Reinauer	cbc55d0	2006-08-25 19:21:42 +0000	[diff] [blame]	102	Change CFLAGS in the Makefile to enable it: Remove -DDISABLE_DOC from CFLAGS.
Ollie Lho	184a404	2005-11-26 21:55:36 +0000	[diff] [blame]	103
				104
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	105	Supported Flash Chips
				106	---------------------
				107
				108	AMD AM-29F040B
				109	AMD AM-29F016D
Uwe Hermann	c22f542	2006-12-04 08:20:40 +0000	[diff] [blame]	110	ASD AE49F2008
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	111	Atmel AT-29C040A
Uwe Hermann	d7f4806	2007-04-28 02:22:59 +0000	[diff] [blame]	112	Atmel AT-29C020
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	113	EMST F49B002UA
				114	Intel 82802AB (Firmware Hub)
				115	Intel 82802AC (Firmware Hub)
				116	M-Systems MD-2802 (unsupported, disabled by default)
				117	MX MX-29F002
				118	PMC PMC-49FL002
				119	PMC PMC-49FL004
				120	Sharp LHF-00L04
Peter Stuge	79fd6d2	2008-01-27 07:17:14 +0000	[diff] [blame^]	121	Spansion S25FL016A
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	122	SST SST-29EE020A
				123	SST SST-28SF040A
				124	SST SST-39SF010A
				125	SST SST-39SF020A
				126	SST SST-39SF040
				127	SST SST-39VF020
				128	SST SST-49LF040B
				129	SST SST-49LF040
				130	SST SST-49LF020A
				131	SST SST-49LF080A
Alan Carvalho de Assis	474230a	2007-01-27 13:39:06 +0000	[diff] [blame]	132	SST SST-49LF160C
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	133	SST SST-49LF002A/B
				134	SST SST-49LF003A/B
				135	SST SST-49LF004A/B
				136	SST SST-49LF008A
Yinghai Lu	ca78297	2007-01-22 20:21:17 +0000	[diff] [blame]	137	SST SST-49LF004C
				138	SST SST-49LF008C
				139	SST SST-49LF016C
Uwe Hermann	627505b	2007-07-27 03:32:45 +0000	[diff] [blame]	140	ST ST-M50FLW040A
				141	ST ST-M50FLW040B
				142	ST ST-M50FLW080A
				143	ST ST-M50FLW080B
				144	ST ST-M50FW040
				145	ST ST-M50FW080
				146	ST ST-M50FW016
				147	ST ST-M50LPW116
Uwe Hermann	d7f4806	2007-04-28 02:22:59 +0000	[diff] [blame]	148	ST ST-M29F002B
				149	ST ST-M29F002T
				150	ST ST-M29F002NT
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	151	ST ST-M29F400BT
				152	ST ST-M29F040B
Uwe Hermann	627505b	2007-07-27 03:32:45 +0000	[diff] [blame]	153	ST ST-M29W010B
				154	ST ST-M29W040B
Uwe Hermann	c22f542	2006-12-04 08:20:40 +0000	[diff] [blame]	155	SyncMOS S29C51001T/B
				156	SyncMOS S29C51002T/B
				157	SyncMOS S29C51004T/B
				158	SyncMOS S29C31004T
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	159	Winbond W29C011
				160	Winbond W29C020C
Markus Boas	05e7f45	2007-08-30 10:11:08 +0000	[diff] [blame]	161	Winbond W29C040P
Markus Boas	d2ac6fc	2007-08-30 10:17:50 +0000	[diff] [blame]	162	Winbond W29EE011
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	163	Winbond W49F002U
				164	Winbond W49V002A
				165	Winbond W49V002FA
Uwe Hermann	bc1f1a0	2007-05-21 21:39:08 +0000	[diff] [blame]	166	Winbond W39V040FA
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	167	Winbond W39V040A
				168	Winbond W39V040B
David Hendricks	71437d0	2007-03-02 02:25:36 +0000	[diff] [blame]	169	Winbond W39V080A
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	170
				171
				172	Supported Southbridges
				173	----------------------
				174
Uwe Hermann	f4a673b	2007-06-06 21:35:45 +0000	[diff] [blame]	175	AMD CS5530/CS5530A
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	176	AMD Geode SC1100
				177	AMD AMD-8111
				178	ATI SB400
Uwe Hermann	e823ee0	2007-06-05 15:02:18 +0000	[diff] [blame]	179	Broadcom HT-1000
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	180	Intel ICH0-ICH8 (all variations)
				181	Intel PIIX4/PIIX4E/PIIX4M
				182	NVIDIA CK804
				183	NVIDIA MCP51
Yinghai Lu	ca78297	2007-01-22 20:21:17 +0000	[diff] [blame]	184	NVIDIA MCP55
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	185	SiS 630
				186	SiS 5595
Uwe Hermann	a4c63c2	2007-04-09 22:59:22 +0000	[diff] [blame]	187	VIA CX700
Uwe Hermann	b6d2832	2006-12-04 08:15:47 +0000	[diff] [blame]	188	VIA VT8231
				189	VIA VT8235
				190	VIA VT8237
				191	VIA VT82C686
				192