blob: feb70d6961290b35b56fc630fa2c0ab0dc4a9f6d [file] [log] [blame]
Nathan Laredo21541a62012-12-24 22:07:36 +00001.TH FLASHROM 8 "Dec, 2012"
Stefan Reinauer261144c2006-07-27 23:29:02 +00002.SH NAME
Uwe Hermann530cb2d2009-05-14 22:58:21 +00003flashrom \- detect, read, write, verify and erase flash chips
Stefan Reinauer261144c2006-07-27 23:29:02 +00004.SH SYNOPSIS
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +00005.B flashrom \fR[\fB\-h\fR|\fB\-R\fR|\fB\-L\fR|\fB\-z\fR|\
6\fB\-p\fR <programmername>[:<parameters>]
7 [\fB\-E\fR|\fB\-r\fR <file>|\fB\-w\fR <file>|\fB\-v\fR <file>] \
8[\fB\-c\fR <chipname>]
9 [\fB\-l\fR <file> [\fB\-i\fR <image>]] [\fB\-n\fR] [\fB\-f\fR]]
10 [\fB\-V\fR[\fBV\fR[\fBV\fR]]] [\fB-o\fR <logfile>]
Stefan Reinauer261144c2006-07-27 23:29:02 +000011.SH DESCRIPTION
12.B flashrom
Uwe Hermanne8ba5382009-05-22 11:37:27 +000013is a utility for detecting, reading, writing, verifying and erasing flash
Uwe Hermann530cb2d2009-05-14 22:58:21 +000014chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
Uwe Hermann941a2732011-07-25 21:12:57 +000015using a supported mainboard. However, it also supports various external
16PCI/USB/parallel-port/serial-port based devices which can program flash chips,
17including some network cards (NICs), SATA/IDE controller cards, graphics cards,
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000018the Bus Pirate device, various FTDI FT2232/FT4232H/FT232H based USB devices, and more.
Uwe Hermanne74b9f82009-04-10 14:41:29 +000019.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000020It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40,
Uwe Hermann941a2732011-07-25 21:12:57 +000021TSOP48, and BGA chips, which use various protocols such as LPC, FWH,
22parallel flash, or SPI.
Stefan Reinauer261144c2006-07-27 23:29:02 +000023.SH OPTIONS
Uwe Hermann9ff514d2010-06-07 19:41:25 +000024.B IMPORTANT:
Carl-Daniel Hailfinger5de93412009-05-01 10:53:49 +000025Please note that the command line interface for flashrom will change before
26flashrom 1.0. Do not use flashrom in scripts or other automated tools without
Uwe Hermanne8ba5382009-05-22 11:37:27 +000027checking that your flashrom version won't interpret options in a different way.
Carl-Daniel Hailfinger5de93412009-05-01 10:53:49 +000028.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000029You can specify one of
30.BR \-h ", " \-R ", " \-L ", " \-z ", " \-E ", " \-r ", " \-w ", " \-v
31or no operation.
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000032If no operation is specified, flashrom will only probe for flash chips. It is
Michael Karcher31fd8252010-03-12 06:41:39 +000033recommended that if you try flashrom the first time on a system, you run it
Uwe Hermann941a2732011-07-25 21:12:57 +000034in probe-only mode and check the output. Also you are advised to make a
Uwe Hermann9ff514d2010-06-07 19:41:25 +000035backup of your current ROM contents with
36.B \-r
Stefan Taunere34e3e82013-01-01 00:06:51 +000037before you try to write a new image. All operations involving any chip access (probe/read/write/...) require the
38.B -p/--programmer
39option to be used (please see below).
Stefan Reinauerde063bf2006-09-21 13:09:22 +000040.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000041.B "\-r, \-\-read <file>"
42Read flash ROM contents and save them into the given
43.BR <file> .
Uwe Hermann941a2732011-07-25 21:12:57 +000044If the file already exists, it will be overwritten.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000045.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000046.B "\-w, \-\-write <file>"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000047Write
48.B <file>
Uwe Hermann9ff514d2010-06-07 19:41:25 +000049into flash ROM. This will first automatically
50.B erase
51the chip, then write to it.
Stefan Taunerac54fbe2011-07-21 19:52:00 +000052.sp
53In the process the chip is also read several times. First an in-memory backup
54is made for disaster recovery and to be able to skip regions that are
55already equal to the image file. This copy is updated along with the write
56operation. In case of erase errors it is even re-read completely. After
57writing has finished and if verification is enabled, the whole flash chip is
58read out and compared with the input image.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000059.TP
Uwe Hermannea07f622009-06-24 17:31:08 +000060.B "\-n, \-\-noverify"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000061Skip the automatic verification of flash ROM contents after writing. Using this
Uwe Hermannea07f622009-06-24 17:31:08 +000062option is
63.B not
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000064recommended, you should only use it if you know what you are doing and if you
Uwe Hermannea07f622009-06-24 17:31:08 +000065feel that the time for verification takes too long.
66.sp
67Typical usage is:
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +000068.B "flashrom \-p prog \-n \-w <file>"
Uwe Hermannea07f622009-06-24 17:31:08 +000069.sp
70This option is only useful in combination with
71.BR \-\-write .
72.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000073.B "\-v, \-\-verify <file>"
74Verify the flash ROM contents against the given
75.BR <file> .
Stefan Reinauerde063bf2006-09-21 13:09:22 +000076.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +000077.B "\-E, \-\-erase"
Uwe Hermanne74b9f82009-04-10 14:41:29 +000078Erase the flash ROM chip.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000079.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +000080.B "\-V, \-\-verbose"
Uwe Hermann9ff514d2010-06-07 19:41:25 +000081More verbose output. This option can be supplied multiple times
Stefan Taunereebeb532011-08-04 17:40:25 +000082(max. 3 times, i.e.
83.BR \-VVV )
Uwe Hermann9ff514d2010-06-07 19:41:25 +000084for even more debug output.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000085.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +000086.B "\-c, \-\-chip" <chipname>
Uwe Hermann9ff514d2010-06-07 19:41:25 +000087Probe only for the specified flash ROM chip. This option takes the chip name as
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +000088printed by
89.B "flashrom \-L"
Uwe Hermann9ff514d2010-06-07 19:41:25 +000090without the vendor name as parameter. Please note that the chip name is
91case sensitive.
Joerg Mayer645c6df2010-03-13 14:47:48 +000092.TP
Joerg Mayer645c6df2010-03-13 14:47:48 +000093.B "\-f, \-\-force"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +000094Force one or more of the following actions:
Joerg Mayer645c6df2010-03-13 14:47:48 +000095.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +000096* Force chip read and pretend the chip is there.
97.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +000098* Force chip access even if the chip is bigger than the maximum supported \
Uwe Hermann9ff514d2010-06-07 19:41:25 +000099size for the flash bus.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000100.sp
101* Force erase even if erase is known bad.
102.sp
103* Force write even if write is known bad.
Joerg Mayer645c6df2010-03-13 14:47:48 +0000104.TP
105.B "\-l, \-\-layout <file>"
106Read ROM layout from
107.BR <file> .
Uwe Hermann87c07932009-05-05 16:15:46 +0000108.sp
109flashrom supports ROM layouts. This allows you to flash certain parts of
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000110the flash chip only. A ROM layout file contains multiple lines with the
111following syntax:
112.sp
113.B " startaddr:endaddr imagename"
114.sp
115.BR "startaddr " "and " "endaddr "
116are hexadecimal addresses within the ROM file and do not refer to any
117physical address. Please note that using a 0x prefix for those hexadecimal
118numbers is not necessary, but you can't specify decimal/octal numbers.
119.BR "imagename " "is an arbitrary name for the region/image from"
120.BR " startaddr " "to " "endaddr " "(both addresses included)."
121.sp
122Example:
Uwe Hermann87c07932009-05-05 16:15:46 +0000123.sp
124 00000000:00008fff gfxrom
125 00009000:0003ffff normal
126 00040000:0007ffff fallback
127.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000128If you only want to update the image named
129.BR "normal " "in a ROM based on the layout above, run"
Uwe Hermann87c07932009-05-05 16:15:46 +0000130.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000131.B " flashrom \-p prog \-\-layout rom.layout \-\-image normal \-w some.rom"
Uwe Hermann87c07932009-05-05 16:15:46 +0000132.sp
Stefan Taunere34e3e82013-01-01 00:06:51 +0000133To update only the images named
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000134.BR "normal " "and " "fallback" ", run:"
Uwe Hermann87c07932009-05-05 16:15:46 +0000135.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000136.B " flashrom \-p prog \-l rom.layout \-i normal -i fallback \-w some.rom"
Uwe Hermann87c07932009-05-05 16:15:46 +0000137.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000138Overlapping sections are not supported.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000139.TP
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000140.B "\-i, \-\-image <imagename>"
141Only flash region/image
142.B <imagename>
Uwe Hermann67808fe2007-10-18 00:29:05 +0000143from flash layout.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000144.TP
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000145.B "\-L, \-\-list\-supported"
Uwe Hermann941a2732011-07-25 21:12:57 +0000146List the flash chips, chipsets, mainboards, and external programmers
147(including PCI, USB, parallel port, and serial port based devices)
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000148supported by flashrom.
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000149.sp
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000150There are many unlisted boards which will work out of the box, without
151special support in flashrom. Please let us know if you can verify that
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000152other boards work or do not work out of the box.
153.sp
154.B IMPORTANT:
155For verification you have
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000156to test an ERASE and/or WRITE operation, so make sure you only do that
157if you have proper means to recover from failure!
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000158.TP
Uwe Hermann20a293f2009-06-19 10:42:43 +0000159.B "\-z, \-\-list\-supported-wiki"
160Same as
161.BR \-\-list\-supported ,
162but outputs the supported hardware in MediaWiki syntax, so that it can be
Uwe Hermann941a2732011-07-25 21:12:57 +0000163easily pasted into the wiki page at
Stefan Tauner352e50b2013-02-22 15:58:45 +0000164.nh
Uwe Hermann941a2732011-07-25 21:12:57 +0000165.BR http://www.flashrom.org/ .
166Please note that MediaWiki output is not compiled in by default.
Uwe Hermann20a293f2009-06-19 10:42:43 +0000167.TP
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000168.B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]"
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000169Specify the programmer device. This is mandatory for all operations
170involving any chip access (probe/read/write/...). Currently supported are:
Carl-Daniel Hailfingerce986772009-05-09 00:27:07 +0000171.sp
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000172.BR "* internal" " (default, for in-system flashing in the mainboard)"
173.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000174.BR "* dummy" " (virtual programmer for testing flashrom)"
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000175.sp
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000176.BR "* nic3com" " (for flash ROMs on 3COM network cards)"
177.sp
Sergey Lichack98f47102012-08-27 01:24:15 +0000178.BR "* nicrealtek" " (for flash ROMs on Realtek and SMC 1211 network cards)"
Uwe Hermann829ed842010-05-24 17:39:14 +0000179.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000180.BR "* nicnatsemi" " (for flash ROMs on National Semiconductor DP838* network \
181cards)"
182.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000183.BR "* nicintel" " (for parallel flash ROMs on Intel 10/100Mbit network cards)
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000184.sp
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000185.BR "* gfxnvidia" " (for flash ROMs on NVIDIA graphics cards)"
186.sp
TURBO Jb0912c02009-09-02 23:00:46 +0000187.BR "* drkaiser" " (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)"
188.sp
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000189.BR "* satasii" " (for flash ROMs on Silicon Image SATA/IDE controllers)"
190.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000191.BR "* satamv" " (for flash ROMs on Marvell SATA controllers)"
192.sp
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000193.BR "* atahpt" " (for flash ROMs on Highpoint ATA/RAID controllers)"
194.sp
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000195.BR "* ft2232_spi" " (for SPI flash ROMs attached to an FT2232/FT4232H/FT232H family \
Uwe Hermann314cfba2011-07-28 19:23:09 +0000196based USB SPI programmer), including the DLP Design DLP-USB1232H, \
197FTDI FT2232H Mini-Module, FTDI FT4232H Mini-Module, openbiosprog-spi, Amontec \
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000198JTAGkey/JTAGkey-tiny/JTAGkey-2, Dangerous Prototypes Bus Blaster, \
Samir Ibradžić7189a5f2011-10-20 23:14:10 +0000199Olimex ARM-USB-TINY/-H, Olimex ARM-USB-OCD/-H, TIAO/DIYGADGET USB
200Multi-Protocol Adapter (TUMPA), and GOEPEL PicoTAP.
Paul Fox05dfbe62009-06-16 21:08:06 +0000201.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000202.BR "* serprog" " (for flash ROMs attached to a programmer speaking serprog), \
203including AVR flasher by Urja Rannikko, AVR flasher by eightdot, \
204Arduino Mega flasher by fritz, InSystemFlasher by Juhana Helovuo, and \
205atmegaXXu2-flasher by Stefan Tauner."
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000206.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000207.BR "* buspirate_spi" " (for SPI flash ROMs attached to a Bus Pirate)"
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000208.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000209.BR "* dediprog" " (for SPI flash ROMs attached to a Dediprog SF100)"
210.sp
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000211.BR "* rayer_spi" " (for SPI flash ROMs attached to a RayeR parport "
212or Xilinx DLC5 compatible cable)
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000213.sp
Michael Karchere5449392012-05-05 20:53:59 +0000214.BR "* pony_spi" " (for SPI flash ROMs attached to a SI-Prog serial port "
215bitbanging adapter)
216.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000217.BR "* nicintel_spi" " (for SPI flash ROMs on Intel Gigabit network cards)"
Idwer Vollering004f4b72010-09-03 18:21:21 +0000218.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000219.BR "* ogp_spi" " (for SPI flash ROMs on Open Graphics Project graphics card)"
Mark Marshall90021f22010-12-03 14:48:11 +0000220.sp
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +0000221.BR "* linux_spi" " (for SPI flash ROMs accessible via /dev/spidevX.Y on Linux)"
222.sp
James Lairdc60de0e2013-03-27 13:00:23 +0000223.BR "* usbblaster_spi" " (for SPI flash ROMs attached to an Altera USB-Blaster compatible cable)"
224.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000225Some programmers have optional or mandatory parameters which are described
226in detail in the
227.B PROGRAMMER SPECIFIC INFO
228section. Support for some programmers can be disabled at compile time.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000229.B "flashrom \-h"
Michael Karchere5eafb22010-03-07 12:11:08 +0000230lists all supported programmers.
231.TP
232.B "\-h, \-\-help"
233Show a help text and exit.
234.TP
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +0000235.B "\-o, \-\-output <logfile>"
236Save the full debug log to
237.BR <logfile> .
238If the file already exists, it will be overwritten. This is the recommended
239way to gather logs from flashrom because they will be verbose even if the
240on-screen messages are not verbose.
241.TP
Michael Karchere5eafb22010-03-07 12:11:08 +0000242.B "\-R, \-\-version"
243Show version information and exit.
244.SH PROGRAMMER SPECIFIC INFO
245Some programmer drivers accept further parameters to set programmer-specific
Uwe Hermann4e3d0b32010-03-25 23:18:41 +0000246parameters. These parameters are separated from the programmer name by a
Michael Karchere5eafb22010-03-07 12:11:08 +0000247colon. While some programmers take arguments at fixed positions, other
248programmers use a key/value interface in which the key and value is separated
249by an equal sign and different pairs are separated by a comma or a colon.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000250.SS
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000251.BR "internal " programmer
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000252.TP
253.B Board Enables
254.sp
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000255Some mainboards require to run mainboard specific code to enable flash erase
256and write support (and probe support on old systems with parallel flash).
257The mainboard brand and model (if it requires specific code) is usually
258autodetected using one of the following mechanisms: If your system is
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000259running coreboot, the mainboard type is determined from the coreboot table.
260Otherwise, the mainboard is detected by examining the onboard PCI devices
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000261and possibly DMI info. If PCI and DMI do not contain information to uniquely
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000262identify the mainboard (which is the exception), or if you want to override
263the detected mainboard model, you can specify the mainboard using the
264.sp
Stefan Taunerb4e06bd2012-08-20 00:24:22 +0000265.B " flashrom \-p internal:mainboard=<vendor>:<board>"
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000266syntax.
267.sp
268See the 'Known boards' or 'Known laptops' section in the output
269of 'flashrom \-L' for a list of boards which require the specification of
270the board name, if no coreboot table is found.
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000271.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000272Some of these board-specific flash enabling functions (called
273.BR "board enables" )
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000274in flashrom have not yet been tested. If your mainboard is detected needing
275an untested board enable function, a warning message is printed and the
276board enable is not executed, because a wrong board enable function might
277cause the system to behave erratically, as board enable functions touch the
278low-level internals of a mainboard. Not executing a board enable function
279(if one is needed) might cause detection or erasing failure. If your board
280protects only part of the flash (commonly the top end, called boot block),
281flashrom might encounter an error only after erasing the unprotected part,
282so running without the board-enable function might be dangerous for erase
283and write (which includes erase).
284.sp
285The suggested procedure for a mainboard with untested board specific code is
286to first try to probe the ROM (just invoke flashrom and check that it
287detects your flash chip type) without running the board enable code (i.e.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000288without any parameters). If it finds your chip, fine. Otherwise, retry
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000289probing your chip with the board-enable code running, using
290.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000291.B " flashrom \-p internal:boardenable=force"
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000292.sp
293If your chip is still not detected, the board enable code seems to be broken
294or the flash chip unsupported. Otherwise, make a backup of your current ROM
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000295contents (using
296.BR \-r )
297and store it to a medium outside of your computer, like
298a USB drive or a network share. If you needed to run the board enable code
Stefan Taunereb582572012-09-21 12:52:50 +0000299already for probing, use it for reading too.
300If reading succeeds and the contens of the read file look legit you can try to write the new image.
301You should enable the board enable code in any case now, as it
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000302has been written because it is known that writing/erasing without the board
303enable is going to fail. In any case (success or failure), please report to
304the flashrom mailing list, see below.
305.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000306.TP
307.B Coreboot
308.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000309On systems running coreboot, flashrom checks whether the desired image matches
310your mainboard. This needs some special board ID to be present in the image.
311If flashrom detects that the image you want to write and the current board
312do not match, it will refuse to write the image unless you specify
313.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000314.B " flashrom \-p internal:boardmismatch=force"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000315.TP
316.B ITE IT87 Super I/O
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000317.sp
Carl-Daniel Hailfinger01f3ef42010-03-25 02:50:40 +0000318If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000319translation, flashrom should autodetect that configuration. If you want to
320set the I/O base port of the IT87 series SPI controller manually instead of
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000321using the value provided by the BIOS, use the
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000322.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000323.B " flashrom \-p internal:it87spiport=portnum"
324.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000325syntax where
326.B portnum
327is the I/O port number (must be a multiple of 8). In the unlikely case
328flashrom doesn't detect an active IT87 LPC<->SPI bridge, please send a bug
329report so we can diagnose the problem.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000330.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000331.TP
332.B Intel chipsets
333.sp
Stefan Tauner50e7c602011-11-08 10:55:54 +0000334If you have an Intel chipset with an ICH8 or later southbridge with SPI flash
Stefan Taunereb582572012-09-21 12:52:50 +0000335attached, and if a valid descriptor was written to it (e.g.\& by the vendor), the
Stefan Tauner50e7c602011-11-08 10:55:54 +0000336chipset provides an alternative way to access the flash chip(s) named
337.BR "Hardware Sequencing" .
338It is much simpler than the normal access method (called
339.BR "Software Sequencing" "),"
340but does not allow the software to choose the SPI commands to be sent.
341You can use the
342.sp
343.B " flashrom \-p internal:ich_spi_mode=value"
344.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000345syntax where
346.BR "value " "can be"
Stefan Tauner50e7c602011-11-08 10:55:54 +0000347.BR auto ", " swseq " or " hwseq .
348By default
349.RB "(or when setting " ich_spi_mode=auto )
Stefan Taunereb582572012-09-21 12:52:50 +0000350the module tries to use swseq and only activates hwseq if need be (e.g.\& if
Stefan Tauner50e7c602011-11-08 10:55:54 +0000351important opcodes are inaccessible due to lockdown; or if more than one flash
352chip is attached). The other options (swseq, hwseq) select the respective mode
353(if possible).
354.sp
Stefan Tauner5210e722012-02-16 01:13:00 +0000355ICH8 and later southbridges may also have locked address ranges of different
356kinds if a valid descriptor was written to it. The flash address space is then
357partitioned in multiple so called "Flash Regions" containing the host firmware,
358the ME firmware and so on respectively. The flash descriptor can also specify up
359to 5 so called "Protected Regions", which are freely chosen address ranges
360independent from the aforementioned "Flash Regions". All of them can be write
361and/or read protected individually. If flashrom detects such a lock it will
362disable write support unless the user forces it with the
363.sp
364.B " flashrom \-p internal:ich_spi_force=yes"
365.sp
366syntax. If this leads to erase or write accesses to the flash it would most
367probably bring it into an inconsistent and unbootable state and we will not
368provide any support in such a case.
369.sp
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000370If you have an Intel chipset with an ICH6 or later southbridge and if you want
371to set specific IDSEL values for a non-default flash chip or an embedded
372controller (EC), you can use the
373.sp
374.B " flashrom \-p internal:fwh_idsel=value"
375.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000376syntax where
377.B value
378is the 48-bit hexadecimal raw value to be written in the
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000379IDSEL registers of the Intel southbridge. The upper 32 bits use one hex digit
380each per 512 kB range between 0xffc00000 and 0xffffffff, and the lower 16 bits
381use one hex digit each per 1024 kB range between 0xff400000 and 0xff7fffff.
382The rightmost hex digit corresponds with the lowest address range. All address
383ranges have a corresponding sister range 4 MB below with identical IDSEL
384settings. The default value for ICH7 is given in the example below.
385.sp
386Example:
387.B "flashrom \-p internal:fwh_idsel=0x001122334567"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000388.TP
389.B Laptops
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000390.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000391Using flashrom on laptops is dangerous and may easily make your hardware
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000392unusable (see also the
393.B BUGS
394section). The embedded controller (EC) in these
395machines often interacts badly with flashing.
Stefan Tauner352e50b2013-02-22 15:58:45 +0000396.nh
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000397.B http://www.flashrom.org/Laptops
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000398has more information. For example the EC firmware sometimes resides on the same
399flash chip as the host firmware. While flashrom tries to change the contents of
400that memory the EC might need to fetch new instructions or data from it and
401could stop working correctly. Probing for and reading from the chip may also
402irritate your EC and cause fan failure, backlight failure, sudden poweroff, and
403other nasty effects. flashrom will attempt to detect if it is running on a
404laptop and abort immediately for safety reasons if it clearly identifies the
405host computer as one. If you want to proceed anyway at your own risk, use
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000406.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000407.B " flashrom \-p internal:laptop=force_I_want_a_brick"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000408.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000409We will not help you if you force flashing on a laptop because this is a really
410dumb idea.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000411.sp
412You have been warned.
413.sp
414Currently we rely on the chassis type encoded in the DMI/SMBIOS data to detect
415laptops. Some vendors did not implement those bits correctly or set them to
416generic and/or dummy values. flashrom will then issue a warning and bail out
417like above. In this case you can use
418.sp
419.B " flashrom \-p internal:laptop=this_is_not_a_laptop"
420.sp
421to tell flashrom (at your own risk) that it does not running on a laptop.
422.SS
Michael Karchere5eafb22010-03-07 12:11:08 +0000423.BR "dummy " programmer
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000424The dummy programmer operates on a buffer in memory only. It provides a safe
425and fast way to test various aspects of flashrom and is mainly used in
426development and while debugging.
427.sp
428It is able to emulate some chips to a certain degree (basic
429identify/read/erase/write operations work).
430.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000431An optional parameter specifies the bus types it
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000432should support. For that you have to use the
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000433.sp
434.B " flashrom \-p dummy:bus=[type[+type[+type]]]"
435.sp
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000436syntax where
437.B type
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000438can be
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000439.BR parallel ", " lpc ", " fwh ", " spi
440in any order. If you specify bus without type, all buses will be disabled.
441If you do not specify bus, all buses will be enabled.
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000442.sp
443Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000444.B "flashrom \-p dummy:bus=lpc+fwh"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000445.sp
446The dummy programmer supports flash chip emulation for automated self-tests
447without hardware access. If you want to emulate a flash chip, use the
448.sp
449.B " flashrom \-p dummy:emulate=chip"
450.sp
451syntax where
452.B chip
453is one of the following chips (please specify only the chip name, not the
454vendor):
455.sp
456.RB "* ST " M25P10.RES " SPI flash chip (RES, page write)"
457.sp
458.RB "* SST " SST25VF040.REMS " SPI flash chip (REMS, byte write)"
459.sp
460.RB "* SST " SST25VF032B " SPI flash chip (RDID, AAI write)"
461.sp
Stefan Tauner0b9df972012-05-07 22:12:16 +0000462.RB "* Macronix " MX25L6436 " SPI flash chip (RDID, SFDP)"
463.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000464Example:
465.B "flashrom -p dummy:emulate=SST25VF040.REMS"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000466.TP
467.B Persistent images
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000468.sp
469If you use flash chip emulation, flash image persistence is available as well
470by using the
471.sp
472.B " flashrom \-p dummy:emulate=chip,image=image.rom"
473.sp
474syntax where
475.B image.rom
476is the file where the simulated chip contents are read on flashrom startup and
477where the chip contents on flashrom shutdown are written to.
478.sp
479Example:
480.B "flashrom -p dummy:emulate=M25P10.RES,image=dummy.bin"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000481.TP
482.B SPI write chunk size
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000483.sp
484If you use SPI flash chip emulation for a chip which supports SPI page write
485with the default opcode, you can set the maximum allowed write chunk size with
486the
487.sp
488.B " flashrom \-p dummy:emulate=chip,spi_write_256_chunksize=size"
489.sp
490syntax where
491.B size
Stefan Taunereb582572012-09-21 12:52:50 +0000492is the number of bytes (min.\& 1, max.\& 256).
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000493.sp
494Example:
495.sp
496.B " flashrom -p dummy:emulate=M25P10.RES,spi_write_256_chunksize=5"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000497.TP
498.B SPI blacklist
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000499.sp
500To simulate a programmer which refuses to send certain SPI commands to the
501flash chip, you can specify a blacklist of SPI commands with the
502.sp
503.B " flashrom -p dummy:spi_blacklist=commandlist"
504.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000505syntax where
506.B commandlist
507is a list of two-digit hexadecimal representations of
Stefan Taunereb582572012-09-21 12:52:50 +0000508SPI commands. If commandlist is e.g.\& 0302, flashrom will behave as if the SPI
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000509controller refuses to run command 0x03 (READ) and command 0x02 (WRITE).
510commandlist may be up to 512 characters (256 commands) long.
511Implementation note: flashrom will detect an error during command execution.
512.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000513.TP
514.B SPI ignorelist
515.sp
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000516To simulate a flash chip which ignores (doesn't support) certain SPI commands,
517you can specify an ignorelist of SPI commands with the
518.sp
519.B " flashrom -p dummy:spi_ignorelist=commandlist"
520.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000521syntax where
522.B commandlist
523is a list of two-digit hexadecimal representations of
Stefan Taunereb582572012-09-21 12:52:50 +0000524SPI commands. If commandlist is e.g.\& 0302, the emulated flash chip will ignore
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000525command 0x03 (READ) and command 0x02 (WRITE). commandlist may be up to 512
526characters (256 commands) long.
527Implementation note: flashrom won't detect an error during command execution.
Stefan Tauner5e695ab2012-05-06 17:03:40 +0000528.sp
529.TP
530.B SPI status register
531.sp
532You can specify the initial content of the chip's status register with the
533.sp
534.B " flashrom -p dummy:spi_status=content"
535.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000536syntax where
537.B content
538is an 8-bit hexadecimal value.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000539.SS
Sergey Lichack98f47102012-08-27 01:24:15 +0000540.BR "nic3com" , " nicrealtek" , " nicnatsemi" , " nicintel\
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000541" , " nicintel_spi" , " gfxnvidia" , " ogp_spi" , " drkaiser" , " satasii\
542" , " satamv" ", and " atahpt " programmers
Michael Karchere5eafb22010-03-07 12:11:08 +0000543These programmers have an option to specify the PCI address of the card
544your want to use, which must be specified if more than one card supported
545by the selected programmer is installed in your system. The syntax is
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000546.sp
547.BR " flashrom \-p xxxx:pci=bb:dd.f" ,
548.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000549where
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000550.B xxxx
551is the name of the programmer
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000552.B bb
553is the PCI bus number,
554.B dd
555is the PCI device number, and
556.B f
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000557is the PCI function number of the desired device.
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000558.sp
559Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000560.B "flashrom \-p nic3com:pci=05:04.0"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000561.SS
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000562.BR "ft2232_spi " programmer
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000563An optional parameter specifies the controller
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000564type and channel/interface/port it should support. For that you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000565.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000566.B " flashrom \-p ft2232_spi:type=model,port=interface"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000567.sp
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000568syntax where
569.B model
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000570can be
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000571.BR 2232H ", " 4232H ", " 232H ", " jtagkey ", " busblaster ", " openmoko ", " \
Uwe Hermann836b26a2011-10-14 20:33:14 +0000572arm-usb-tiny ", " arm-usb-tiny-h ", " arm-usb-ocd ", " arm-usb-ocd-h \
Samir Ibradžić7189a5f2011-10-20 23:14:10 +0000573", " tumpa ", or " picotap
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000574and
575.B interface
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000576can be
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000577.BR A ", " B ", " C ", or " D .
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000578The default model is
579.B 4232H
580and the default interface is
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000581.BR A .
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000582.sp
Shik Chen14fbc4b2012-09-17 00:40:54 +0000583If there is more than one ft2232_spi-compatible device connected, you can select which one should be used by
584specifying its serial number with the
585.sp
586.B " flashrom \-p ft2232_spi:serial=number"
587.sp
588syntax where
589.B number
590is the serial number of the device (which can be found for example in the output of lsusb -v).
591.sp
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000592All models supported by the ft2232_spi driver can configure the SPI clock rate by setting a divisor. The
593expressible divisors are all even numbers between 2 and 2^17 (=131072) resulting in SPI clock frequencies of
5946 MHz down to about 92 Hz for 12 MHz inputs. The default divisor is set to 2, but you can use another one by
595specifying the optional
596.B divisor
597parameter with the
598.sp
599.B " flashrom \-p ft2232_spi:divisor=div"
600.sp
601syntax.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000602.SS
Michael Karchere5eafb22010-03-07 12:11:08 +0000603.BR "serprog " programmer
604A mandatory parameter specifies either a serial
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000605device/baud combination or an IP/port combination for communication with the
Michael Karchere5eafb22010-03-07 12:11:08 +0000606programmer. In the device/baud combination, the device has to start with a
607slash. For serial, you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000608.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000609.B " flashrom \-p serprog:dev=/dev/device:baud"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000610.sp
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000611syntax and for IP, you have to use
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000612.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000613.B " flashrom \-p serprog:ip=ipaddr:port"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000614.sp
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000615instead. In case the device supports it, you can set the SPI clock frequency
616with the optional
617.B spispeed
618parameter. The frequency is parsed as Hertz, unless an
619.BR M ", or " k
620suffix is given, then megahertz or kilohertz are used respectively.
621Example that sets the frequency to 2 MHz:
622.sp
623.B "flashrom \-p serprog:dev=/dev/device:baud,spispeed=2M"
624.sp
625More information about serprog is available in
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000626.B serprog-protocol.txt
627in the source distribution.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000628.SS
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000629.BR "buspirate_spi " programmer
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000630A required
631.B dev
632parameter specifies the Bus Pirate device node and an optional
633.B spispeed
634parameter specifies the frequency of the SPI bus. The parameter
Michael Karchere5eafb22010-03-07 12:11:08 +0000635delimiter is a comma. Syntax is
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000636.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000637.B " flashrom \-p buspirate_spi:dev=/dev/device,spispeed=frequency"
Michael Karchere5eafb22010-03-07 12:11:08 +0000638.sp
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000639where
640.B frequency
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000641can be
642.BR 30k ", " 125k ", " 250k ", " 1M ", " 2M ", " 2.6M ", " 4M " or " 8M
Michael Karchere5eafb22010-03-07 12:11:08 +0000643(in Hz). The default is the maximum frequency of 8 MHz.
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000644.sp
645An optional pullups parameter specifies the use of the Bus Pirate internal pull-up resistors. This may be
646needed if you are working with a flash ROM chip that you have physically removed from the board. Syntax is
647.sp
648.B " flashrom -p buspirate_spi:pullups=state"
649.sp
650where
651.B state
652can be
653.BR on " or " off .
654More information about the Bus Pirate pull-up resistors and their purpose is available at
655.nh
656.BR "http://dangerousprototypes.com/docs/Practical_guide_to_Bus_Pirate_pull-up_resistors " .
657Only the external supply voltage (Vpu) is supported as of this writing.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000658.SS
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000659.BR "dediprog " programmer
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000660An optional
661.B voltage
662parameter specifies the voltage the Dediprog should use. The default unit is
663Volt if no unit is specified. You can use
664.BR mV ", " milliVolt ", " V " or " Volt
665as unit specifier. Syntax is
666.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000667.B " flashrom \-p dediprog:voltage=value"
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000668.sp
669where
670.B value
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000671can be
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000672.BR 0V ", " 1.8V ", " 2.5V ", " 3.5V
673or the equivalent in mV.
Nathan Laredo21541a62012-12-24 22:07:36 +0000674.sp
675An optional
676.B device
677parameter specifies which of multiple connected Dediprog devices should be used.
678Please be aware that the order depends on libusb's usb_get_busses() function and that the numbering starts
679at 0.
680Usage example to select the second device:
681.sp
682.B " flashrom \-p dediprog:device=1"
Nico Huber77fa67d2013-02-20 18:03:36 +0000683.sp
684An optional
685.B spispeed
686parameter specifies the frequency of the SPI bus. Syntax is
687.sp
688.B " flashrom \-p dediprog:spispeed=frequency"
689.sp
690where
691.B frequency
692can be
693.BR 375k ", " 750k ", " 1.5M ", " 2.18M ", " 3M ", " 8M ", " 12M " or " 24M
694(in Hz). The default is a frequency of 12 MHz.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000695.SS
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000696.BR "rayer_spi " programmer
Carl-Daniel Hailfinger37c42522010-10-05 19:19:48 +0000697The default I/O base address used for the parallel port is 0x378 and you can use
698the optional
699.B iobase
700parameter to specify an alternate base I/O address with the
701.sp
702.B " flashrom \-p rayer_spi:iobase=baseaddr"
703.sp
704syntax where
705.B baseaddr
706is base I/O port address of the parallel port, which must be a multiple of
707four. Make sure to not forget the "0x" prefix for hexadecimal port addresses.
708.sp
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000709The default cable type is the RayeR cable. You can use the optional
710.B type
711parameter to specify the cable type with the
712.sp
713.B " flashrom \-p rayer_spi:type=model"
714.sp
715syntax where
716.B model
717can be
718.BR rayer " for the RayeR cable or " xilinx " for the Xilinx Parallel Cable III
719(DLC 5).
720.sp
721More information about the RayeR hardware is available at
Stefan Tauner352e50b2013-02-22 15:58:45 +0000722.nh
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000723.BR "http://rayer.ic.cz/elektro/spipgm.htm " .
724The schematic of the Xilinx DLC 5 was published at
Stefan Tauner352e50b2013-02-22 15:58:45 +0000725.nh
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000726.BR "http://www.xilinx.com/itp/xilinx4/data/docs/pac/appendixb.html " .
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000727.SS
Michael Karchere5449392012-05-05 20:53:59 +0000728.BR "pony_spi " programmer
729The serial port (like /dev/ttyS0, /dev/ttyUSB0 on Linux or COM3 on windows) is
730specified using the mandatory
Stefan Taunere34e3e82013-01-01 00:06:51 +0000731.B dev
Michael Karchere5449392012-05-05 20:53:59 +0000732parameter. The adapter type is selectable between SI-Prog (used for
733SPI devices with PonyProg 2000) or a custom made serial bitbanging programmer
734named "serbang". The optional
Stefan Taunere34e3e82013-01-01 00:06:51 +0000735.B type
Michael Karchere5449392012-05-05 20:53:59 +0000736parameter accepts the values "si_prog" (default) or "serbang".
737.sp
738Information about the SI-Prog adapter can be found at
Stefan Tauner352e50b2013-02-22 15:58:45 +0000739.nh
Michael Karchere5449392012-05-05 20:53:59 +0000740.BR "http://www.lancos.com/siprogsch.html " .
741.sp
742An example call to flashrom is
743.sp
744.B " flashrom \-p pony_spi:dev=/dev/ttyS0,type=serbang"
745.sp
746Please note that while USB-to-serial adapters work under certain circumstances,
747this slows down operation considerably.
748.SS
Mark Marshall90021f22010-12-03 14:48:11 +0000749.BR "ogp_spi " programmer
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000750The flash ROM chip to access must be specified with the
Mark Marshall90021f22010-12-03 14:48:11 +0000751.B rom
752parameter.
753.sp
754.B " flashrom \-p ogp_spi:rom=name"
755.sp
756Where
757.B name
758is either
759.B cprom
760or
761.B s3
Stefan Taunere34e3e82013-01-01 00:06:51 +0000762for the configuration ROM and
Mark Marshall90021f22010-12-03 14:48:11 +0000763.B bprom
764or
765.B bios
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000766for the BIOS ROM. If more than one card supported by the ogp_spi programmer
Mark Marshall90021f22010-12-03 14:48:11 +0000767is installed in your system, you have to specify the PCI address of the card
768you want to use with the
769.B pci=
770parameter as explained in the
Stefan Taunere34e3e82013-01-01 00:06:51 +0000771.B nic3com et al.\&
Mark Marshall90021f22010-12-03 14:48:11 +0000772section above.
773.sp
774More information about the hardware is available at
Stefan Tauner352e50b2013-02-22 15:58:45 +0000775.nh
Uwe Hermann941a2732011-07-25 21:12:57 +0000776.BR http://wiki.opengraphics.org .
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +0000777.SS
778.BR "linux_spi " programmer
779You have to specify the SPI controller to use with the
780.sp
781.B " flashrom \-p linux_spi:dev=/dev/spidevX.Y"
782.sp
783syntax where
784.B /dev/spidevX.Y
785is the Linux device node for your SPI controller.
786.sp
787Please note that the linux_spi driver only works on Linux.
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +0000788.SH EXAMPLES
789To back up and update your BIOS, run
790.sp
791.B flashrom -p internal -r backup.rom -o backuplog.txt
792.br
793.B flashrom -p internal -w newbios.rom -o writelog.txt
794.sp
795Please make sure to copy backup.rom to some external media before you try
796to write. That makes offline recovery easier.
797.br
798If writing fails and flashrom complains about the chip being in an unknown
799state, you can try to restore the backup by running
800.sp
801.B flashrom -p internal -w backup.rom -o restorelog.txt
802.sp
803If you encounter any problems, please contact us and supply
804backuplog.txt, writelog.txt and restorelog.txt. See section
805.B BUGS
806for contact info.
Peter Stuge42688e52009-01-26 02:20:56 +0000807.SH EXIT STATUS
808flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
809(/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000810.SH REQUIREMENTS
811flashrom needs different access permissions for different programmers.
812.sp
813.B internal
814needs raw memory access, PCI configuration space access, raw I/O port
815access (x86) and MSR access (x86).
816.sp
Sergey Lichack98f47102012-08-27 01:24:15 +0000817.BR nic3com ", " nicrealtek " and " nicnatsemi "
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000818need PCI configuration space read access and raw I/O port access.
819.sp
820.B atahpt
821needs PCI configuration space access and raw I/O port access.
822.sp
823.BR gfxnvidia " and " drkaiser
824need PCI configuration space access and raw memory access.
825.sp
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000826.B rayer_spi
827needs raw I/O port access.
828.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000829.B satasii
830needs PCI configuration space read access and raw memory access.
831.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000832.B satamv
833needs PCI configuration space read access, raw I/O port access and raw memory
834access.
835.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000836.B serprog
837needs TCP access to the network or userspace access to a serial port.
838.sp
839.B buspirate_spi
840needs userspace access to a serial port.
841.sp
James Lairdc60de0e2013-03-27 13:00:23 +0000842.BR dediprog ", " ft2232_spi " and " usbblaster_spi
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000843need access to the USB device via libusb.
844.sp
845.B dummy
846needs no access permissions at all.
847.sp
Sergey Lichack98f47102012-08-27 01:24:15 +0000848.BR internal ", " nic3com ", " nicrealtek ", " nicnatsemi ", "
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000849.BR gfxnvidia ", " drkaiser ", " satasii ", " satamv " and " atahpt
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000850have to be run as superuser/root, and need additional raw access permission.
851.sp
James Lairdc60de0e2013-03-27 13:00:23 +0000852.BR serprog ", " buspirate_spi ", " dediprog ", " usbblaster_spi " and " ft2232_spi
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000853can be run as normal user on most operating systems if appropriate device
854permissions are set.
855.sp
Mark Marshall90021f22010-12-03 14:48:11 +0000856.B ogp
857needs PCI configuration space read access and raw memory access.
858.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000859On OpenBSD, you can obtain raw access permission by setting
Uwe Hermann941a2732011-07-25 21:12:57 +0000860.B "securelevel=-1"
861in
862.B "/etc/rc.securelevel"
863and rebooting, or rebooting into single user mode.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000864.SH BUGS
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000865Please report any bugs to the flashrom mailing list at
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000866.B "<flashrom@flashrom.org>"
867.sp
868We recommend to subscribe first at
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000869.sp
870.B " http://www.flashrom.org/mailman/listinfo/flashrom"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000871.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000872Many of the developers communicate via the
873.B "#flashrom"
874IRC channel on
875.BR chat.freenode.net .
876You are welcome to join and ask questions, send us bug and success reports there
Stefan Taunereb582572012-09-21 12:52:50 +0000877too. Please provide a way to contact you later (e.g.\& a mail address) and be
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000878patient if there is no immediate reaction. Also, we provide a pastebin service
879at
Stefan Tauner352e50b2013-02-22 15:58:45 +0000880.nh
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000881.B http://paste.flashrom.org
Stefan Taunereb582572012-09-21 12:52:50 +0000882that is very useful when you want to share logs etc.\& without spamming the
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000883channel.
884.SS
885.B Laptops
886.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000887Using flashrom on laptops is dangerous and may easily make your hardware
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000888unusable. flashrom will attempt to detect if it is running on a laptop and abort
889immediately for safety reasons. Please see the detailed discussion of this topic
890and associated flashrom options in the
891.B Laptops
892paragraph in the
893.B internal programmer
894subsection of the
895.B PROGRAMMER SPECIFIC INFO
Stefan Tauner352e50b2013-02-22 15:58:45 +0000896section and the information in our wiki at
897.BR "http://www.flashrom.org/Laptops " .
Daniel Lenski65922a32012-02-15 23:40:23 +0000898.SS
899One-time programmable (OTP) memory and unique IDs
900.sp
901Some flash chips contain OTP memory often denoted as "security registers".
902They usually have a capacity in the range of some bytes to a few hundred
Stefan Taunereb582572012-09-21 12:52:50 +0000903bytes and can be used to give devices unique IDs etc. flashrom is not able
Daniel Lenski65922a32012-02-15 23:40:23 +0000904to read or write these memories and may therefore not be able to duplicate a
905chip completely. For chip types known to include OTP memories a warning is
906printed when they are detected.
907.sp
908Similar to OTP memories are unique, factory programmed, unforgeable IDs.
909They are not modifiable by the user at all.
Stefan Taunerac54fbe2011-07-21 19:52:00 +0000910.SH LICENSE
Stefan Reinauer261144c2006-07-27 23:29:02 +0000911.B flashrom
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000912is covered by the GNU General Public License (GPL), version 2. Some files are
913additionally available under the GPL (version 2, or any later version).
Stefan Reinauer261144c2006-07-27 23:29:02 +0000914.SH COPYRIGHT
Stefan Reinauer261144c2006-07-27 23:29:02 +0000915.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000916Please see the individual files.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000917.SH AUTHORS
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000918Andrew Morgan
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000919.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000920Carl-Daniel Hailfinger
921.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000922Claus Gindhart
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000923.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000924David Borg
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000925.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000926David Hendricks
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000927.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000928Dominik Geyer
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000929.br
Stefan Reinaueredc61882010-01-03 14:40:30 +0000930Eric Biederman
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000931.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000932Giampiero Giancipoli
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000933.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000934Helge Wagner
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000935.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000936Idwer Vollering
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000937.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000938Joe Bao
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000939.br
Stefan Taunerc0aaf952011-05-19 02:58:17 +0000940Joerg Fischer
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000941.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000942Joshua Roys
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000943.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000944Luc Verhaegen
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000945.br
Carl-Daniel Hailfinger451dc802009-05-01 11:00:39 +0000946Li-Ta Lo
947.br
Mark Marshall90021f22010-12-03 14:48:11 +0000948Mark Marshall
949.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000950Markus Boas
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000951.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000952Mattias Mattsson
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000953.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000954Michael Karcher
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000955.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000956Nikolay Petukhov
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000957.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000958Patrick Georgi
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000959.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000960Peter Lemenkov
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000961.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000962Peter Stuge
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000963.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000964Reinder E.N. de Haan
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000965.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000966Ronald G. Minnich
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000967.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000968Ronald Hoogenboom
Stefan Reinauer261144c2006-07-27 23:29:02 +0000969.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000970Sean Nelson
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000971.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000972Stefan Reinauer
Stefan Reinauer261144c2006-07-27 23:29:02 +0000973.br
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000974Stefan Tauner
975.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000976Stefan Wildemann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000977.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000978Stephan Guilloux
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000979.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000980Steven James
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000981.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000982Uwe Hermann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000983.br
Stefan Reinaueredc61882010-01-03 14:40:30 +0000984Wang Qingpei
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000985.br
Stefan Reinaueredc61882010-01-03 14:40:30 +0000986Yinghai Lu
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000987.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000988some others, please see the flashrom svn changelog for details.
989.br
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000990All authors can be reached via email at <flashrom@flashrom.org>.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000991.PP
Stefan Taunerac54fbe2011-07-21 19:52:00 +0000992This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>,
993Carl-Daniel Hailfinger and others.
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000994It is licensed under the terms of the GNU GPL (version 2 or later).