Blame - README - flashprog

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