blob: 70af395f1a110af105e39b6464268e9f65e06b7c [file] [log] [blame]
Stefan Tauner4c723152016-01-14 22:47:55 +00001.\" Load the www device when using groff; provide a fallback for groff's MTO macro that formats email addresses.
2.ie \n[.g] \
3. mso www.tmac
Stefan Tauner0be072c2016-03-13 15:16:30 +00004.el \{
5. de MTO
6 \\$2 \(la\\$1 \(ra\\$3 \
Stefan Tauner4c723152016-01-14 22:47:55 +00007. .
Stefan Tauner0be072c2016-03-13 15:16:30 +00008.\}
Stefan Tauner4c723152016-01-14 22:47:55 +00009.\" Create wrappers for .MTO and .URL that print only text on systems w/o groff or if not outputting to a HTML
10.\" device. To that end we need to distinguish HTML output on groff from other configurations first.
11.nr groffhtml 0
12.if \n[.g] \
13. if "\*[.T]"html" \
14. nr groffhtml 1
15.\" For code reuse it would be nice to have a single wrapper that gets its target macro as parameter.
16.\" However, this did not work out with NetBSD's and OpenBSD's groff...
17.de URLB
18. ie (\n[groffhtml]==1) \{\
19. URL \\$@
20. \}
21. el \{\
22. ie "\\$2"" \{\
23. BR "\\$1" "\\$3"
24. \}
25. el \{\
26. RB "\\$2 \(la" "\\$1" "\(ra\\$3"
27. \}
28. \}
29..
30.de MTOB
31. ie (\n[groffhtml]==1) \{\
32. MTO \\$@
33. \}
34. el \{\
35. ie "\\$2"" \{\
36. BR "\\$1" "\\$3"
37. \}
38. el \{\
39. RB "\\$2 \(la" "\\$1" "\(ra\\$3"
40. \}
41. \}
42..
Joerg Mayera93d9dc2013-08-29 00:38:19 +000043.TH FLASHROM 8 "" ""
Stefan Reinauer261144c2006-07-27 23:29:02 +000044.SH NAME
Uwe Hermann530cb2d2009-05-14 22:58:21 +000045flashrom \- detect, read, write, verify and erase flash chips
Stefan Reinauer261144c2006-07-27 23:29:02 +000046.SH SYNOPSIS
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +000047.B flashrom \fR[\fB\-h\fR|\fB\-R\fR|\fB\-L\fR|\fB\-z\fR|\
48\fB\-p\fR <programmername>[:<parameters>]
49 [\fB\-E\fR|\fB\-r\fR <file>|\fB\-w\fR <file>|\fB\-v\fR <file>] \
50[\fB\-c\fR <chipname>]
Nico Huber305f4172013-06-14 11:55:26 +020051 [(\fB\-l\fR <file>|\fB\-\-ifd\fR) [\fB\-i\fR <image>]] \
52[\fB\-n\fR] [\fB\-N\fR] [\fB\-f\fR]]
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +000053 [\fB\-V\fR[\fBV\fR[\fBV\fR]]] [\fB-o\fR <logfile>]
Stefan Reinauer261144c2006-07-27 23:29:02 +000054.SH DESCRIPTION
55.B flashrom
Uwe Hermanne8ba5382009-05-22 11:37:27 +000056is a utility for detecting, reading, writing, verifying and erasing flash
Uwe Hermann530cb2d2009-05-14 22:58:21 +000057chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
Uwe Hermann941a2732011-07-25 21:12:57 +000058using a supported mainboard. However, it also supports various external
59PCI/USB/parallel-port/serial-port based devices which can program flash chips,
60including some network cards (NICs), SATA/IDE controller cards, graphics cards,
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000061the Bus Pirate device, various FTDI FT2232/FT4232H/FT232H based USB devices, and more.
Uwe Hermanne74b9f82009-04-10 14:41:29 +000062.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000063It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40,
Uwe Hermann941a2732011-07-25 21:12:57 +000064TSOP48, and BGA chips, which use various protocols such as LPC, FWH,
65parallel flash, or SPI.
Stefan Reinauer261144c2006-07-27 23:29:02 +000066.SH OPTIONS
Uwe Hermann9ff514d2010-06-07 19:41:25 +000067.B IMPORTANT:
Carl-Daniel Hailfinger5de93412009-05-01 10:53:49 +000068Please note that the command line interface for flashrom will change before
69flashrom 1.0. Do not use flashrom in scripts or other automated tools without
Uwe Hermanne8ba5382009-05-22 11:37:27 +000070checking that your flashrom version won't interpret options in a different way.
Carl-Daniel Hailfinger5de93412009-05-01 10:53:49 +000071.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000072You can specify one of
73.BR \-h ", " \-R ", " \-L ", " \-z ", " \-E ", " \-r ", " \-w ", " \-v
74or no operation.
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000075If no operation is specified, flashrom will only probe for flash chips. It is
Michael Karcher31fd8252010-03-12 06:41:39 +000076recommended that if you try flashrom the first time on a system, you run it
Uwe Hermann941a2732011-07-25 21:12:57 +000077in probe-only mode and check the output. Also you are advised to make a
Uwe Hermann9ff514d2010-06-07 19:41:25 +000078backup of your current ROM contents with
79.B \-r
Stefan Taunere34e3e82013-01-01 00:06:51 +000080before you try to write a new image. All operations involving any chip access (probe/read/write/...) require the
81.B -p/--programmer
82option to be used (please see below).
Stefan Reinauerde063bf2006-09-21 13:09:22 +000083.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000084.B "\-r, \-\-read <file>"
85Read flash ROM contents and save them into the given
86.BR <file> .
Uwe Hermann941a2732011-07-25 21:12:57 +000087If the file already exists, it will be overwritten.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000088.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000089.B "\-w, \-\-write <file>"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000090Write
91.B <file>
Uwe Hermann9ff514d2010-06-07 19:41:25 +000092into flash ROM. This will first automatically
93.B erase
94the chip, then write to it.
Stefan Taunerac54fbe2011-07-21 19:52:00 +000095.sp
96In the process the chip is also read several times. First an in-memory backup
97is made for disaster recovery and to be able to skip regions that are
98already equal to the image file. This copy is updated along with the write
99operation. In case of erase errors it is even re-read completely. After
100writing has finished and if verification is enabled, the whole flash chip is
101read out and compared with the input image.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000102.TP
Uwe Hermannea07f622009-06-24 17:31:08 +0000103.B "\-n, \-\-noverify"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000104Skip the automatic verification of flash ROM contents after writing. Using this
Uwe Hermannea07f622009-06-24 17:31:08 +0000105option is
106.B not
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000107recommended, you should only use it if you know what you are doing and if you
Uwe Hermannea07f622009-06-24 17:31:08 +0000108feel that the time for verification takes too long.
109.sp
110Typical usage is:
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000111.B "flashrom \-p prog \-n \-w <file>"
Uwe Hermannea07f622009-06-24 17:31:08 +0000112.sp
113This option is only useful in combination with
114.BR \-\-write .
115.TP
Nico Huber99d15952016-05-02 16:54:24 +0200116.B "\-N, \-\-noverify-all"
117Skip not included regions during automatic verification after writing (cf.
118.BR "\-l " "and " "\-i" ).
119You should only use this option if you are sure that communication with
120the flash chip is reliable (e.g. when using the
121.BR internal
122programmer). Even if flashrom is instructed not to touch parts of the
123flash chip, their contents could be damaged (e.g. due to misunderstood
124erase commands).
125.sp
126This option is required to flash an Intel system with locked ME flash
127region using the
128.BR internal
129programmer. It may be enabled by default in this case in the future.
130.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000131.B "\-v, \-\-verify <file>"
132Verify the flash ROM contents against the given
133.BR <file> .
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000134.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000135.B "\-E, \-\-erase"
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000136Erase the flash ROM chip.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000137.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000138.B "\-V, \-\-verbose"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000139More verbose output. This option can be supplied multiple times
Stefan Taunereebeb532011-08-04 17:40:25 +0000140(max. 3 times, i.e.
141.BR \-VVV )
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000142for even more debug output.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000143.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000144.B "\-c, \-\-chip" <chipname>
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000145Probe only for the specified flash ROM chip. This option takes the chip name as
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000146printed by
147.B "flashrom \-L"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000148without the vendor name as parameter. Please note that the chip name is
149case sensitive.
Joerg Mayer645c6df2010-03-13 14:47:48 +0000150.TP
Joerg Mayer645c6df2010-03-13 14:47:48 +0000151.B "\-f, \-\-force"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000152Force one or more of the following actions:
Joerg Mayer645c6df2010-03-13 14:47:48 +0000153.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000154* Force chip read and pretend the chip is there.
155.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000156* Force chip access even if the chip is bigger than the maximum supported \
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000157size for the flash bus.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000158.sp
159* Force erase even if erase is known bad.
160.sp
161* Force write even if write is known bad.
Joerg Mayer645c6df2010-03-13 14:47:48 +0000162.TP
163.B "\-l, \-\-layout <file>"
164Read ROM layout from
165.BR <file> .
Uwe Hermann87c07932009-05-05 16:15:46 +0000166.sp
167flashrom supports ROM layouts. This allows you to flash certain parts of
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000168the flash chip only. A ROM layout file contains multiple lines with the
169following syntax:
170.sp
171.B " startaddr:endaddr imagename"
172.sp
173.BR "startaddr " "and " "endaddr "
174are hexadecimal addresses within the ROM file and do not refer to any
175physical address. Please note that using a 0x prefix for those hexadecimal
176numbers is not necessary, but you can't specify decimal/octal numbers.
177.BR "imagename " "is an arbitrary name for the region/image from"
178.BR " startaddr " "to " "endaddr " "(both addresses included)."
179.sp
180Example:
Uwe Hermann87c07932009-05-05 16:15:46 +0000181.sp
182 00000000:00008fff gfxrom
183 00009000:0003ffff normal
184 00040000:0007ffff fallback
185.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000186If you only want to update the image named
187.BR "normal " "in a ROM based on the layout above, run"
Uwe Hermann87c07932009-05-05 16:15:46 +0000188.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000189.B " flashrom \-p prog \-\-layout rom.layout \-\-image normal \-w some.rom"
Uwe Hermann87c07932009-05-05 16:15:46 +0000190.sp
Stefan Taunere34e3e82013-01-01 00:06:51 +0000191To update only the images named
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000192.BR "normal " "and " "fallback" ", run:"
Uwe Hermann87c07932009-05-05 16:15:46 +0000193.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000194.B " flashrom \-p prog \-l rom.layout \-i normal -i fallback \-w some.rom"
Uwe Hermann87c07932009-05-05 16:15:46 +0000195.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000196Overlapping sections are not supported.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000197.TP
Nico Huber305f4172013-06-14 11:55:26 +0200198.B "\-\-ifd"
199Read ROM layout from Intel Firmware Descriptor.
200.sp
201flashrom supports ROM layouts given by an Intel Firmware Descriptor
202(IFD). The on-chip descriptor will be read and used to generate the
203layout. If you need to change the layout, you have to update the IFD
204only first.
205.sp
206The following ROM images may be present in an IFD:
207.sp
208 fd the IFD itself
209 bios the host firmware aka. BIOS
210 me Intel Management Engine firmware
211 gbe gigabit ethernet firmware
212 pd platform specific data
213.TP
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000214.B "\-i, \-\-image <imagename>"
215Only flash region/image
216.B <imagename>
Uwe Hermann67808fe2007-10-18 00:29:05 +0000217from flash layout.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000218.TP
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000219.B "\-L, \-\-list\-supported"
Uwe Hermann941a2732011-07-25 21:12:57 +0000220List the flash chips, chipsets, mainboards, and external programmers
221(including PCI, USB, parallel port, and serial port based devices)
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000222supported by flashrom.
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000223.sp
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000224There are many unlisted boards which will work out of the box, without
225special support in flashrom. Please let us know if you can verify that
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000226other boards work or do not work out of the box.
227.sp
228.B IMPORTANT:
229For verification you have
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000230to test an ERASE and/or WRITE operation, so make sure you only do that
231if you have proper means to recover from failure!
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000232.TP
Uwe Hermann20a293f2009-06-19 10:42:43 +0000233.B "\-z, \-\-list\-supported-wiki"
234Same as
235.BR \-\-list\-supported ,
236but outputs the supported hardware in MediaWiki syntax, so that it can be
Stefan Tauner4c723152016-01-14 22:47:55 +0000237easily pasted into the
238.URLB https://flashrom.org/Supported_hardware "supported hardware wiki page" .
Uwe Hermann941a2732011-07-25 21:12:57 +0000239Please note that MediaWiki output is not compiled in by default.
Uwe Hermann20a293f2009-06-19 10:42:43 +0000240.TP
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000241.B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]"
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000242Specify the programmer device. This is mandatory for all operations
243involving any chip access (probe/read/write/...). Currently supported are:
Carl-Daniel Hailfingerce986772009-05-09 00:27:07 +0000244.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +0000245.BR "* internal" " (for in-system flashing in the mainboard)"
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000246.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000247.BR "* dummy" " (virtual programmer for testing flashrom)"
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000248.sp
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000249.BR "* nic3com" " (for flash ROMs on 3COM network cards)"
250.sp
Sergey Lichack98f47102012-08-27 01:24:15 +0000251.BR "* nicrealtek" " (for flash ROMs on Realtek and SMC 1211 network cards)"
Uwe Hermann829ed842010-05-24 17:39:14 +0000252.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000253.BR "* nicnatsemi" " (for flash ROMs on National Semiconductor DP838* network \
254cards)"
255.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000256.BR "* nicintel" " (for parallel flash ROMs on Intel 10/100Mbit network cards)
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000257.sp
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000258.BR "* gfxnvidia" " (for flash ROMs on NVIDIA graphics cards)"
259.sp
TURBO Jb0912c02009-09-02 23:00:46 +0000260.BR "* drkaiser" " (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)"
261.sp
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000262.BR "* satasii" " (for flash ROMs on Silicon Image SATA/IDE controllers)"
263.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000264.BR "* satamv" " (for flash ROMs on Marvell SATA controllers)"
265.sp
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000266.BR "* atahpt" " (for flash ROMs on Highpoint ATA/RAID controllers)"
267.sp
Stefan Tauner4f094752014-06-01 22:36:30 +0000268.BR "* atavia" " (for flash ROMs on VIA VT6421A SATA controllers)"
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000269.sp
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000270.BR "* atapromise" " (for flash ROMs on Promise PDC2026x ATA/RAID controllers)"
271.sp
Kyösti Mälkki72d42f82014-06-01 23:48:31 +0000272.BR "* it8212" " (for flash ROMs on ITE IT8212F ATA/RAID controller)"
273.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +0000274.BR "* ft2232_spi" " (for SPI flash ROMs attached to an FT2232/FT4232H/FT232H family based USB SPI programmer).
Paul Fox05dfbe62009-06-16 21:08:06 +0000275.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000276.BR "* serprog" " (for flash ROMs attached to a programmer speaking serprog, \
Stefan Tauner0be072c2016-03-13 15:16:30 +0000277including some Arduino-based devices)."
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000278.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000279.BR "* buspirate_spi" " (for SPI flash ROMs attached to a Bus Pirate)"
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000280.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000281.BR "* dediprog" " (for SPI flash ROMs attached to a Dediprog SF100)"
282.sp
Kyösti Mälkki8b1bdf12013-10-02 01:21:45 +0000283.BR "* rayer_spi" " (for SPI flash ROMs attached to a parallel port by one of various cable types)"
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000284.sp
Michael Karchere5449392012-05-05 20:53:59 +0000285.BR "* pony_spi" " (for SPI flash ROMs attached to a SI-Prog serial port "
286bitbanging adapter)
287.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000288.BR "* nicintel_spi" " (for SPI flash ROMs on Intel Gigabit network cards)"
Idwer Vollering004f4b72010-09-03 18:21:21 +0000289.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000290.BR "* ogp_spi" " (for SPI flash ROMs on Open Graphics Project graphics card)"
Mark Marshall90021f22010-12-03 14:48:11 +0000291.sp
David Hendricksf9a30552015-05-23 20:30:30 -0700292.BR "* linux_mtd" " (for SPI flash ROMs accessible via /dev/mtdX on Linux)"
293.sp
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +0000294.BR "* linux_spi" " (for SPI flash ROMs accessible via /dev/spidevX.Y on Linux)"
295.sp
James Lairdc60de0e2013-03-27 13:00:23 +0000296.BR "* usbblaster_spi" " (for SPI flash ROMs attached to an Altera USB-Blaster compatible cable)"
297.sp
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000298.BR "* nicintel_eeprom" " (for SPI EEPROMs on Intel Gigabit network cards)"
299.sp
Alexandre Boeglin80e64712014-12-20 20:25:19 +0000300.BR "* mstarddc_spi" " (for SPI flash ROMs accessible through DDC in MSTAR-equipped displays)"
301.sp
Justin Chevrier66e554b2015-02-08 21:58:10 +0000302.BR "* pickit2_spi" " (for SPI flash ROMs accessible via Microchip PICkit2)"
303.sp
Urja Rannikko0870b022016-01-31 22:10:29 +0000304.BR "* ch341a_spi" " (for SPI flash ROMs attached to WCH CH341A)"
305.sp
Lubomir Rintelb2154e82018-01-14 17:35:33 +0100306.BR "* digilent_spi" " (for SPI flash ROMs attached to iCEblink40 development boards)"
307.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000308Some programmers have optional or mandatory parameters which are described
309in detail in the
Stefan Tauner6697f712014-08-06 15:09:15 +0000310.B PROGRAMMER-SPECIFIC INFORMATION
Michael Karchere5eafb22010-03-07 12:11:08 +0000311section. Support for some programmers can be disabled at compile time.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000312.B "flashrom \-h"
Michael Karchere5eafb22010-03-07 12:11:08 +0000313lists all supported programmers.
314.TP
315.B "\-h, \-\-help"
316Show a help text and exit.
317.TP
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +0000318.B "\-o, \-\-output <logfile>"
319Save the full debug log to
320.BR <logfile> .
321If the file already exists, it will be overwritten. This is the recommended
322way to gather logs from flashrom because they will be verbose even if the
Stefan Tauner6697f712014-08-06 15:09:15 +0000323on-screen messages are not verbose and don't require output redirection.
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +0000324.TP
Michael Karchere5eafb22010-03-07 12:11:08 +0000325.B "\-R, \-\-version"
326Show version information and exit.
Stefan Tauner6697f712014-08-06 15:09:15 +0000327.SH PROGRAMMER-SPECIFIC INFORMATION
Michael Karchere5eafb22010-03-07 12:11:08 +0000328Some programmer drivers accept further parameters to set programmer-specific
Uwe Hermann4e3d0b32010-03-25 23:18:41 +0000329parameters. These parameters are separated from the programmer name by a
Michael Karchere5eafb22010-03-07 12:11:08 +0000330colon. While some programmers take arguments at fixed positions, other
331programmers use a key/value interface in which the key and value is separated
332by an equal sign and different pairs are separated by a comma or a colon.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000333.SS
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000334.BR "internal " programmer
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000335.TP
336.B Board Enables
337.sp
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000338Some mainboards require to run mainboard specific code to enable flash erase
339and write support (and probe support on old systems with parallel flash).
340The mainboard brand and model (if it requires specific code) is usually
341autodetected using one of the following mechanisms: If your system is
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000342running coreboot, the mainboard type is determined from the coreboot table.
343Otherwise, the mainboard is detected by examining the onboard PCI devices
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000344and possibly DMI info. If PCI and DMI do not contain information to uniquely
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000345identify the mainboard (which is the exception), or if you want to override
346the detected mainboard model, you can specify the mainboard using the
347.sp
Stefan Taunerb4e06bd2012-08-20 00:24:22 +0000348.B " flashrom \-p internal:mainboard=<vendor>:<board>"
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000349syntax.
350.sp
351See the 'Known boards' or 'Known laptops' section in the output
352of 'flashrom \-L' for a list of boards which require the specification of
353the board name, if no coreboot table is found.
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000354.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000355Some of these board-specific flash enabling functions (called
356.BR "board enables" )
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000357in flashrom have not yet been tested. If your mainboard is detected needing
358an untested board enable function, a warning message is printed and the
359board enable is not executed, because a wrong board enable function might
360cause the system to behave erratically, as board enable functions touch the
361low-level internals of a mainboard. Not executing a board enable function
362(if one is needed) might cause detection or erasing failure. If your board
363protects only part of the flash (commonly the top end, called boot block),
364flashrom might encounter an error only after erasing the unprotected part,
365so running without the board-enable function might be dangerous for erase
366and write (which includes erase).
367.sp
368The suggested procedure for a mainboard with untested board specific code is
369to first try to probe the ROM (just invoke flashrom and check that it
370detects your flash chip type) without running the board enable code (i.e.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000371without any parameters). If it finds your chip, fine. Otherwise, retry
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000372probing your chip with the board-enable code running, using
373.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000374.B " flashrom \-p internal:boardenable=force"
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000375.sp
376If your chip is still not detected, the board enable code seems to be broken
377or the flash chip unsupported. Otherwise, make a backup of your current ROM
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000378contents (using
379.BR \-r )
380and store it to a medium outside of your computer, like
381a USB drive or a network share. If you needed to run the board enable code
Stefan Taunereb582572012-09-21 12:52:50 +0000382already for probing, use it for reading too.
383If reading succeeds and the contens of the read file look legit you can try to write the new image.
384You should enable the board enable code in any case now, as it
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000385has been written because it is known that writing/erasing without the board
386enable is going to fail. In any case (success or failure), please report to
387the flashrom mailing list, see below.
388.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000389.TP
390.B Coreboot
391.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000392On systems running coreboot, flashrom checks whether the desired image matches
393your mainboard. This needs some special board ID to be present in the image.
394If flashrom detects that the image you want to write and the current board
395do not match, it will refuse to write the image unless you specify
396.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000397.B " flashrom \-p internal:boardmismatch=force"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000398.TP
399.B ITE IT87 Super I/O
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000400.sp
Vadim Girlin4dd0f902013-08-24 12:18:17 +0000401If your mainboard is manufactured by GIGABYTE and supports DualBIOS it is very likely that it uses an
402ITE IT87 series Super I/O to switch between the two flash chips. Only one of them can be accessed at a time
403and you can manually select which one to use with the
404.sp
405.B " flashrom \-p internal:dualbiosindex=chip"
406.sp
407syntax where
408.B chip
409is the index of the chip to use (0 = main, 1 = backup). You can check which one is currently selected by
410leaving out the
411.B chip
412parameter.
413.sp
Carl-Daniel Hailfinger01f3ef42010-03-25 02:50:40 +0000414If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000415translation, flashrom should autodetect that configuration. If you want to
416set the I/O base port of the IT87 series SPI controller manually instead of
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000417using the value provided by the BIOS, use the
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000418.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000419.B " flashrom \-p internal:it87spiport=portnum"
420.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000421syntax where
422.B portnum
423is the I/O port number (must be a multiple of 8). In the unlikely case
424flashrom doesn't detect an active IT87 LPC<->SPI bridge, please send a bug
425report so we can diagnose the problem.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000426.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000427.TP
Rudolf Marek70e14592013-07-25 22:58:56 +0000428.B AMD chipsets
429.sp
430Beginning with the SB700 chipset there is an integrated microcontroller (IMC) based on the 8051 embedded in
431every AMD southbridge. Its firmware resides in the same flash chip as the host's which makes writing to the
432flash risky if the IMC is active. Flashrom tries to temporarily disable the IMC but even then changing the
433contents of the flash can have unwanted effects: when the IMC continues (at the latest after a reboot) it will
434continue executing code from the flash. If the code was removed or changed in an unfortunate way it is
435unpredictable what the IMC will do. Therefore, if flashrom detects an active IMC it will disable write support
436unless the user forces it with the
437.sp
438.B " flashrom \-p internal:amd_imc_force=yes"
439.sp
440syntax. The user is responsible for supplying a suitable image or leaving out the IMC region with the help of
441a layout file. This limitation might be removed in the future when we understand the details better and have
442received enough feedback from users. Please report the outcome if you had to use this option to write a chip.
443.sp
Stefan Tauner21071b02014-05-16 21:39:48 +0000444An optional
445.B spispeed
446parameter specifies the frequency of the SPI bus where applicable (i.e.\& SB600 or later with an SPI flash chip
447directly attached to the chipset).
448Syntax is
449.sp
450.B " flashrom \-p internal:spispeed=frequency"
451.sp
452where
453.B frequency
454can be
455.BR "'16.5\ MHz'" ", " "'22\ MHz'" ", " "'33\ MHz'" ", " "'66\ MHz'" ", " "'100\ MHZ'" ", or " "'800\ kHz'" "."
456Support of individual frequencies depends on the generation of the chipset:
457.sp
458* SB6xx, SB7xx, SP5xxx: from 16.5 MHz up to and including 33 MHz
459.sp
460* SB8xx, SB9xx, Hudson: from 16.5 MHz up to and including 66 MHz
461.sp
462* Yangtze (with SPI 100 engine as found in Kabini and Tamesh): all of them
463.sp
464The default is to use 16.5 MHz and disable Fast Reads.
Rudolf Marek70e14592013-07-25 22:58:56 +0000465.TP
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000466.B Intel chipsets
467.sp
Stefan Tauner50e7c602011-11-08 10:55:54 +0000468If you have an Intel chipset with an ICH8 or later southbridge with SPI flash
Stefan Taunereb582572012-09-21 12:52:50 +0000469attached, and if a valid descriptor was written to it (e.g.\& by the vendor), the
Stefan Tauner50e7c602011-11-08 10:55:54 +0000470chipset provides an alternative way to access the flash chip(s) named
471.BR "Hardware Sequencing" .
472It is much simpler than the normal access method (called
473.BR "Software Sequencing" "),"
474but does not allow the software to choose the SPI commands to be sent.
475You can use the
476.sp
477.B " flashrom \-p internal:ich_spi_mode=value"
478.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000479syntax where
480.BR "value " "can be"
Stefan Tauner50e7c602011-11-08 10:55:54 +0000481.BR auto ", " swseq " or " hwseq .
482By default
483.RB "(or when setting " ich_spi_mode=auto )
Stefan Taunereb582572012-09-21 12:52:50 +0000484the module tries to use swseq and only activates hwseq if need be (e.g.\& if
Stefan Tauner50e7c602011-11-08 10:55:54 +0000485important opcodes are inaccessible due to lockdown; or if more than one flash
486chip is attached). The other options (swseq, hwseq) select the respective mode
487(if possible).
488.sp
Stefan Tauner5210e722012-02-16 01:13:00 +0000489ICH8 and later southbridges may also have locked address ranges of different
490kinds if a valid descriptor was written to it. The flash address space is then
491partitioned in multiple so called "Flash Regions" containing the host firmware,
492the ME firmware and so on respectively. The flash descriptor can also specify up
493to 5 so called "Protected Regions", which are freely chosen address ranges
494independent from the aforementioned "Flash Regions". All of them can be write
Nico Huber7590d1a2016-05-03 13:38:28 +0200495and/or read protected individually.
Stefan Tauner5210e722012-02-16 01:13:00 +0000496.sp
Kyösti Mälkki88ee0402013-09-14 23:37:01 +0000497If you have an Intel chipset with an ICH2 or later southbridge and if you want
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000498to set specific IDSEL values for a non-default flash chip or an embedded
499controller (EC), you can use the
500.sp
501.B " flashrom \-p internal:fwh_idsel=value"
502.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000503syntax where
504.B value
505is the 48-bit hexadecimal raw value to be written in the
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000506IDSEL registers of the Intel southbridge. The upper 32 bits use one hex digit
507each per 512 kB range between 0xffc00000 and 0xffffffff, and the lower 16 bits
508use one hex digit each per 1024 kB range between 0xff400000 and 0xff7fffff.
509The rightmost hex digit corresponds with the lowest address range. All address
510ranges have a corresponding sister range 4 MB below with identical IDSEL
511settings. The default value for ICH7 is given in the example below.
512.sp
513Example:
514.B "flashrom \-p internal:fwh_idsel=0x001122334567"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000515.TP
516.B Laptops
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000517.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000518Using flashrom on laptops is dangerous and may easily make your hardware
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000519unusable (see also the
520.B BUGS
521section). The embedded controller (EC) in these
522machines often interacts badly with flashing.
Stefan Tauner4c723152016-01-14 22:47:55 +0000523More information is
524.URLB https://flashrom.org/Laptops "in the wiki" .
525For example the EC firmware sometimes resides on the same
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000526flash chip as the host firmware. While flashrom tries to change the contents of
527that memory the EC might need to fetch new instructions or data from it and
528could stop working correctly. Probing for and reading from the chip may also
529irritate your EC and cause fan failure, backlight failure, sudden poweroff, and
530other nasty effects. flashrom will attempt to detect if it is running on a
531laptop and abort immediately for safety reasons if it clearly identifies the
532host computer as one. If you want to proceed anyway at your own risk, use
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000533.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000534.B " flashrom \-p internal:laptop=force_I_want_a_brick"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000535.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000536We will not help you if you force flashing on a laptop because this is a really
537dumb idea.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000538.sp
539You have been warned.
540.sp
541Currently we rely on the chassis type encoded in the DMI/SMBIOS data to detect
542laptops. Some vendors did not implement those bits correctly or set them to
543generic and/or dummy values. flashrom will then issue a warning and bail out
544like above. In this case you can use
545.sp
546.B " flashrom \-p internal:laptop=this_is_not_a_laptop"
547.sp
Stefan Tauner6697f712014-08-06 15:09:15 +0000548to tell flashrom (at your own risk) that it is not running on a laptop.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000549.SS
Michael Karchere5eafb22010-03-07 12:11:08 +0000550.BR "dummy " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000551.IP
552The dummy programmer operates on a buffer in memory only. It provides a safe and fast way to test various
553aspects of flashrom and is mainly used in development and while debugging.
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000554It is able to emulate some chips to a certain degree (basic
555identify/read/erase/write operations work).
556.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000557An optional parameter specifies the bus types it
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000558should support. For that you have to use the
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000559.sp
560.B " flashrom \-p dummy:bus=[type[+type[+type]]]"
561.sp
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000562syntax where
563.B type
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000564can be
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000565.BR parallel ", " lpc ", " fwh ", " spi
566in any order. If you specify bus without type, all buses will be disabled.
567If you do not specify bus, all buses will be enabled.
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000568.sp
569Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000570.B "flashrom \-p dummy:bus=lpc+fwh"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000571.sp
572The dummy programmer supports flash chip emulation for automated self-tests
573without hardware access. If you want to emulate a flash chip, use the
574.sp
575.B " flashrom \-p dummy:emulate=chip"
576.sp
577syntax where
578.B chip
579is one of the following chips (please specify only the chip name, not the
580vendor):
581.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000582.RB "* ST " M25P10.RES " SPI flash chip (128 kB, RES, page write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000583.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000584.RB "* SST " SST25VF040.REMS " SPI flash chip (512 kB, REMS, byte write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000585.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000586.RB "* SST " SST25VF032B " SPI flash chip (4096 kB, RDID, AAI write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000587.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000588.RB "* Macronix " MX25L6436 " SPI flash chip (8192 kB, RDID, SFDP)"
Stefan Tauner0b9df972012-05-07 22:12:16 +0000589.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000590Example:
591.B "flashrom -p dummy:emulate=SST25VF040.REMS"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000592.TP
593.B Persistent images
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000594.sp
595If you use flash chip emulation, flash image persistence is available as well
596by using the
597.sp
598.B " flashrom \-p dummy:emulate=chip,image=image.rom"
599.sp
600syntax where
601.B image.rom
602is the file where the simulated chip contents are read on flashrom startup and
603where the chip contents on flashrom shutdown are written to.
604.sp
605Example:
606.B "flashrom -p dummy:emulate=M25P10.RES,image=dummy.bin"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000607.TP
608.B SPI write chunk size
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000609.sp
610If you use SPI flash chip emulation for a chip which supports SPI page write
611with the default opcode, you can set the maximum allowed write chunk size with
612the
613.sp
614.B " flashrom \-p dummy:emulate=chip,spi_write_256_chunksize=size"
615.sp
616syntax where
617.B size
Stefan Taunereb582572012-09-21 12:52:50 +0000618is the number of bytes (min.\& 1, max.\& 256).
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000619.sp
620Example:
621.sp
622.B " flashrom -p dummy:emulate=M25P10.RES,spi_write_256_chunksize=5"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000623.TP
624.B SPI blacklist
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000625.sp
626To simulate a programmer which refuses to send certain SPI commands to the
627flash chip, you can specify a blacklist of SPI commands with the
628.sp
629.B " flashrom -p dummy:spi_blacklist=commandlist"
630.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000631syntax where
632.B commandlist
633is a list of two-digit hexadecimal representations of
Stefan Taunereb582572012-09-21 12:52:50 +0000634SPI commands. If commandlist is e.g.\& 0302, flashrom will behave as if the SPI
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000635controller refuses to run command 0x03 (READ) and command 0x02 (WRITE).
636commandlist may be up to 512 characters (256 commands) long.
637Implementation note: flashrom will detect an error during command execution.
638.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000639.TP
640.B SPI ignorelist
641.sp
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000642To simulate a flash chip which ignores (doesn't support) certain SPI commands,
643you can specify an ignorelist of SPI commands with the
644.sp
645.B " flashrom -p dummy:spi_ignorelist=commandlist"
646.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000647syntax where
648.B commandlist
649is a list of two-digit hexadecimal representations of
Stefan Taunereb582572012-09-21 12:52:50 +0000650SPI commands. If commandlist is e.g.\& 0302, the emulated flash chip will ignore
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000651command 0x03 (READ) and command 0x02 (WRITE). commandlist may be up to 512
652characters (256 commands) long.
653Implementation note: flashrom won't detect an error during command execution.
Stefan Tauner5e695ab2012-05-06 17:03:40 +0000654.sp
655.TP
656.B SPI status register
657.sp
658You can specify the initial content of the chip's status register with the
659.sp
660.B " flashrom -p dummy:spi_status=content"
661.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000662syntax where
663.B content
664is an 8-bit hexadecimal value.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000665.SS
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000666.BR "nic3com" , " nicrealtek" , " nicnatsemi" , " nicintel", " nicintel_eeprom"\
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000667, " nicintel_spi" , " gfxnvidia" , " ogp_spi" , " drkaiser" , " satasii"\
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000668, " satamv" , " atahpt", " atavia ", " atapromise " and " it8212 " programmers
Stefan Tauner4c723152016-01-14 22:47:55 +0000669.IP
Michael Karchere5eafb22010-03-07 12:11:08 +0000670These programmers have an option to specify the PCI address of the card
671your want to use, which must be specified if more than one card supported
672by the selected programmer is installed in your system. The syntax is
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000673.sp
674.BR " flashrom \-p xxxx:pci=bb:dd.f" ,
675.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000676where
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000677.B xxxx
Stefan Taunerc2eec2c2014-05-03 21:33:01 +0000678is the name of the programmer,
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000679.B bb
680is the PCI bus number,
681.B dd
682is the PCI device number, and
683.B f
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000684is the PCI function number of the desired device.
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000685.sp
686Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000687.B "flashrom \-p nic3com:pci=05:04.0"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000688.SS
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000689.BR "atavia " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000690.IP
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000691Due to the mysterious address handling of the VIA VT6421A controller the user can specify an offset with the
692.sp
693.B " flashrom \-p atavia:offset=addr"
694.sp
695syntax where
696.B addr
697will be interpreted as usual (leading 0x (0) for hexadecimal (octal) values, or else decimal).
698For more information please see
Stefan Tauner4c723152016-01-14 22:47:55 +0000699.URLB https://flashrom.org/VT6421A "its wiki page" .
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000700.SS
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000701.BR "atapromise " programmer
702.IP
703This programmer is currently limited to 32 kB, regardless of the actual size of the flash chip. This stems
704from the fact that, on the tested device (a Promise Ultra100), not all of the chip's address lines were
705actually connected. You may use this programmer to flash firmware updates, since these are only 16 kB in
706size (padding to 32 kB is required).
707.SS
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000708.BR "nicintel_eeprom " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000709.IP
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000710This is the first programmer module in flashrom that does not provide access to NOR flash chips but EEPROMs
711mounted on gigabit Ethernet cards based on Intel's 82580 NIC. Because EEPROMs normally do not announce their
Stefan Tauner0be072c2016-03-13 15:16:30 +0000712size nor allow themselves to be identified, the controller relies on correct size values written to predefined
713addresses within the chip. Flashrom follows this scheme but assumes the minimum size of 16 kB (128 kb) if an
714unprogrammed EEPROM/card is detected. Intel specifies following EEPROMs to be compatible:
715Atmel AT25128, AT25256, Micron (ST) M95128, M95256 and OnSemi (Catalyst) CAT25CS128.
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000716.SS
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000717.BR "ft2232_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000718.IP
Stefan Tauner0be072c2016-03-13 15:16:30 +0000719This module supports various programmers based on FTDI FT2232/FT4232H/FT232H chips including the DLP Design
720DLP-USB1232H, openbiosprog-spi, Amontec JTAGkey/JTAGkey-tiny/JTAGkey-2, Dangerous Prototypes Bus Blaster,
721Olimex ARM-USB-TINY/-H, Olimex ARM-USB-OCD/-H, OpenMoko Neo1973 Debug board (V2+), TIAO/DIYGADGET USB
722Multi-Protocol Adapter (TUMPA), TUMPA Lite, GOEPEL PicoTAP and Google Servo v1/v2.
723.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000724An optional parameter specifies the controller
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000725type and channel/interface/port it should support. For that you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000726.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000727.B " flashrom \-p ft2232_spi:type=model,port=interface"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000728.sp
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000729syntax where
730.B model
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000731can be
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000732.BR 2232H ", " 4232H ", " 232H ", " jtagkey ", " busblaster ", " openmoko ", " \
Uwe Hermann836b26a2011-10-14 20:33:14 +0000733arm-usb-tiny ", " arm-usb-tiny-h ", " arm-usb-ocd ", " arm-usb-ocd-h \
Todd Broch6800c952016-02-14 15:46:00 +0000734", " tumpa ", " tumpalite ", " picotap ", " google-servo ", " google-servo-v2 \
735" or " google-servo-v2-legacy
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000736and
737.B interface
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000738can be
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000739.BR A ", " B ", " C ", or " D .
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000740The default model is
741.B 4232H
742and the default interface is
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000743.BR A .
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000744.sp
Shik Chen14fbc4b2012-09-17 00:40:54 +0000745If there is more than one ft2232_spi-compatible device connected, you can select which one should be used by
746specifying its serial number with the
747.sp
748.B " flashrom \-p ft2232_spi:serial=number"
749.sp
750syntax where
751.B number
752is the serial number of the device (which can be found for example in the output of lsusb -v).
753.sp
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000754All models supported by the ft2232_spi driver can configure the SPI clock rate by setting a divisor. The
Stefan Tauner0554ca52013-07-25 22:54:25 +0000755expressible divisors are all
756.B even
757numbers between 2 and 2^17 (=131072) resulting in SPI clock frequencies of
Samir Ibradžićb482c6d2012-05-15 22:58:19 +00007586 MHz down to about 92 Hz for 12 MHz inputs. The default divisor is set to 2, but you can use another one by
759specifying the optional
760.B divisor
761parameter with the
762.sp
763.B " flashrom \-p ft2232_spi:divisor=div"
764.sp
765syntax.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000766.SS
Michael Karchere5eafb22010-03-07 12:11:08 +0000767.BR "serprog " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000768.IP
Stefan Tauner0be072c2016-03-13 15:16:30 +0000769This module supports all programmers speaking the serprog protocol. This includes some Arduino-based devices
770as well as various programmers by Urja Rannikko, Juhana Helovuo, Stefan Tauner, Chi Zhang and many others.
771.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000772A mandatory parameter specifies either a serial device (and baud rate) or an IP/port combination for
773communicating with the programmer.
774The device/baud combination has to start with
775.B dev=
776and separate the optional baud rate with a colon.
777For example
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000778.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000779.B " flashrom \-p serprog:dev=/dev/ttyS0:115200"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000780.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000781If no baud rate is given the default values by the operating system/hardware will be used.
782For IP connections you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000783.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000784.B " flashrom \-p serprog:ip=ipaddr:port"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000785.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000786syntax.
787In case the device supports it, you can set the SPI clock frequency with the optional
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000788.B spispeed
Stefan Tauner0554ca52013-07-25 22:54:25 +0000789parameter. The frequency is parsed as hertz, unless an
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000790.BR M ", or " k
791suffix is given, then megahertz or kilohertz are used respectively.
792Example that sets the frequency to 2 MHz:
793.sp
Stefan Tauner0554ca52013-07-25 22:54:25 +0000794.B " flashrom \-p serprog:dev=/dev/device:baud,spispeed=2M"
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000795.sp
796More information about serprog is available in
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000797.B serprog-protocol.txt
798in the source distribution.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000799.SS
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000800.BR "buspirate_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000801.IP
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000802A required
803.B dev
804parameter specifies the Bus Pirate device node and an optional
805.B spispeed
806parameter specifies the frequency of the SPI bus. The parameter
Michael Karchere5eafb22010-03-07 12:11:08 +0000807delimiter is a comma. Syntax is
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000808.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000809.B " flashrom \-p buspirate_spi:dev=/dev/device,spispeed=frequency"
Michael Karchere5eafb22010-03-07 12:11:08 +0000810.sp
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000811where
812.B frequency
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000813can be
814.BR 30k ", " 125k ", " 250k ", " 1M ", " 2M ", " 2.6M ", " 4M " or " 8M
Michael Karchere5eafb22010-03-07 12:11:08 +0000815(in Hz). The default is the maximum frequency of 8 MHz.
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000816.sp
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600817The baud rate for communication between the host and the Bus Pirate can be specified with the optional
818.B serialspeed
819parameter. Syntax is
820.sp
821.B " flashrom -p buspirate_spi:serialspeed=baud
822.sp
823where
824.B baud
825can be
826.BR 115200 ", " 230400 ", " 250000 " or " 2000000 " (" 2M ")."
827The default is 2M baud for Bus Pirate hardware version 3.0 and greater, and 115200 otherwise.
828.sp
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000829An optional pullups parameter specifies the use of the Bus Pirate internal pull-up resistors. This may be
830needed if you are working with a flash ROM chip that you have physically removed from the board. Syntax is
831.sp
832.B " flashrom -p buspirate_spi:pullups=state"
833.sp
834where
835.B state
836can be
837.BR on " or " off .
Stefan Tauner4c723152016-01-14 22:47:55 +0000838More information about the Bus Pirate pull-up resistors and their purpose is available
839.URLB "http://dangerousprototypes.com/docs/Practical_guide_to_Bus_Pirate_pull-up_resistors" \
840"in a guide by dangerousprototypes" .
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000841Only the external supply voltage (Vpu) is supported as of this writing.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000842.SS
Justin Chevrier66e554b2015-02-08 21:58:10 +0000843.BR "pickit2_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000844.IP
Justin Chevrier66e554b2015-02-08 21:58:10 +0000845An optional
846.B voltage
847parameter specifies the voltage the PICkit2 should use. The default unit is Volt if no unit is specified.
848You can use
849.BR mV ", " millivolt ", " V " or " Volt
850as unit specifier. Syntax is
851.sp
852.B " flashrom \-p pickit2_spi:voltage=value"
853.sp
854where
855.B value
856can be
857.BR 0V ", " 1.8V ", " 2.5V ", " 3.5V
858or the equivalent in mV.
859.sp
860An optional
861.B spispeed
862parameter specifies the frequency of the SPI bus. Syntax is
863.sp
864.B " flashrom \-p pickit2_spi:spispeed=frequency"
865.sp
866where
867.B frequency
868can be
869.BR 250k ", " 333k ", " 500k " or " 1M "
870(in Hz). The default is a frequency of 1 MHz.
871.SS
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000872.BR "dediprog " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000873.IP
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000874An optional
875.B voltage
876parameter specifies the voltage the Dediprog should use. The default unit is
877Volt if no unit is specified. You can use
878.BR mV ", " milliVolt ", " V " or " Volt
879as unit specifier. Syntax is
880.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000881.B " flashrom \-p dediprog:voltage=value"
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000882.sp
883where
884.B value
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000885can be
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000886.BR 0V ", " 1.8V ", " 2.5V ", " 3.5V
887or the equivalent in mV.
Nathan Laredo21541a62012-12-24 22:07:36 +0000888.sp
889An optional
890.B device
891parameter specifies which of multiple connected Dediprog devices should be used.
892Please be aware that the order depends on libusb's usb_get_busses() function and that the numbering starts
893at 0.
894Usage example to select the second device:
895.sp
896.B " flashrom \-p dediprog:device=1"
Nico Huber77fa67d2013-02-20 18:03:36 +0000897.sp
898An optional
899.B spispeed
Patrick Georgiefe2d432013-05-23 21:47:46 +0000900parameter specifies the frequency of the SPI bus. The firmware on the device needs to be 5.0.0 or newer.
901Syntax is
Nico Huber77fa67d2013-02-20 18:03:36 +0000902.sp
903.B " flashrom \-p dediprog:spispeed=frequency"
904.sp
905where
906.B frequency
907can be
908.BR 375k ", " 750k ", " 1.5M ", " 2.18M ", " 3M ", " 8M ", " 12M " or " 24M
909(in Hz). The default is a frequency of 12 MHz.
Stefan Taunere659d2d2013-05-03 21:58:28 +0000910.sp
911An optional
912.B target
913parameter specifies which target chip should be used. Syntax is
914.sp
915.B " flashrom \-p dediprog:target=value"
916.sp
917where
918.B value
919can be
920.BR 1 " or " 2
Stefan Tauner6697f712014-08-06 15:09:15 +0000921to select target chip 1 or 2 respectively. The default is target chip 1.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000922.SS
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000923.BR "rayer_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000924.IP
Carl-Daniel Hailfinger37c42522010-10-05 19:19:48 +0000925The default I/O base address used for the parallel port is 0x378 and you can use
926the optional
927.B iobase
928parameter to specify an alternate base I/O address with the
929.sp
930.B " flashrom \-p rayer_spi:iobase=baseaddr"
931.sp
932syntax where
933.B baseaddr
934is base I/O port address of the parallel port, which must be a multiple of
935four. Make sure to not forget the "0x" prefix for hexadecimal port addresses.
936.sp
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000937The default cable type is the RayeR cable. You can use the optional
938.B type
939parameter to specify the cable type with the
940.sp
941.B " flashrom \-p rayer_spi:type=model"
942.sp
943syntax where
944.B model
945can be
Maksim Kuleshov4dab5c12013-10-02 01:22:02 +0000946.BR rayer " for the RayeR cable, " byteblastermv " for the Altera ByteBlasterMV, " stk200 " for the Atmel \
Stefan Taunerfdb16592016-02-28 17:04:38 +0000947STK200/300, " wiggler " for the Macraigor Wiggler, " xilinx " for the Xilinx Parallel Cable III (DLC 5), or" \
948" spi_tt" " for SPI Tiny Tools-compatible hardware.
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000949.sp
950More information about the RayeR hardware is available at
Stefan Tauner23e10b82016-01-23 16:16:49 +0000951.nh
Stefan Tauner4c723152016-01-14 22:47:55 +0000952.URLB "http://rayer.g6.cz/elektro/spipgm.htm" "RayeR's website" .
Maksim Kuleshov3647b2d2013-10-02 01:21:57 +0000953The Altera ByteBlasterMV datasheet can be obtained from
Stefan Tauner4c723152016-01-14 22:47:55 +0000954.URLB "http://www.altera.co.jp/literature/ds/dsbytemv.pdf" Altera .
Maksim Kuleshovacba2ac2013-10-02 01:22:11 +0000955For more information about the Macraigor Wiggler see
Stefan Tauner4c723152016-01-14 22:47:55 +0000956.URLB "http://www.macraigor.com/wiggler.htm" "their company homepage" .
Kyösti Mälkki8b1bdf12013-10-02 01:21:45 +0000957The schematic of the Xilinx DLC 5 was published in
Stefan Tauner4c723152016-01-14 22:47:55 +0000958.URLB "http://www.xilinx.com/support/documentation/user_guides/xtp029.pdf" "a Xilinx user guide" .
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000959.SS
Michael Karchere5449392012-05-05 20:53:59 +0000960.BR "pony_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000961.IP
Michael Karchere5449392012-05-05 20:53:59 +0000962The serial port (like /dev/ttyS0, /dev/ttyUSB0 on Linux or COM3 on windows) is
963specified using the mandatory
Stefan Taunere34e3e82013-01-01 00:06:51 +0000964.B dev
Michael Karchere5449392012-05-05 20:53:59 +0000965parameter. The adapter type is selectable between SI-Prog (used for
966SPI devices with PonyProg 2000) or a custom made serial bitbanging programmer
967named "serbang". The optional
Stefan Taunere34e3e82013-01-01 00:06:51 +0000968.B type
Michael Karchere5449392012-05-05 20:53:59 +0000969parameter accepts the values "si_prog" (default) or "serbang".
970.sp
971Information about the SI-Prog adapter can be found at
Stefan Tauner4c723152016-01-14 22:47:55 +0000972.URLB "http://www.lancos.com/siprogsch.html" "its website" .
Michael Karchere5449392012-05-05 20:53:59 +0000973.sp
974An example call to flashrom is
975.sp
976.B " flashrom \-p pony_spi:dev=/dev/ttyS0,type=serbang"
977.sp
978Please note that while USB-to-serial adapters work under certain circumstances,
979this slows down operation considerably.
980.SS
Mark Marshall90021f22010-12-03 14:48:11 +0000981.BR "ogp_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000982.IP
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000983The flash ROM chip to access must be specified with the
Mark Marshall90021f22010-12-03 14:48:11 +0000984.B rom
985parameter.
986.sp
987.B " flashrom \-p ogp_spi:rom=name"
988.sp
989Where
990.B name
991is either
992.B cprom
993or
994.B s3
Stefan Taunere34e3e82013-01-01 00:06:51 +0000995for the configuration ROM and
Mark Marshall90021f22010-12-03 14:48:11 +0000996.B bprom
997or
998.B bios
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000999for the BIOS ROM. If more than one card supported by the ogp_spi programmer
Mark Marshall90021f22010-12-03 14:48:11 +00001000is installed in your system, you have to specify the PCI address of the card
1001you want to use with the
1002.B pci=
1003parameter as explained in the
Stefan Taunere34e3e82013-01-01 00:06:51 +00001004.B nic3com et al.\&
Mark Marshall90021f22010-12-03 14:48:11 +00001005section above.
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001006.SS
David Hendricksf9a30552015-05-23 20:30:30 -07001007.BR "linux_mtd " programmer
1008.IP
1009You may specify the MTD device to use with the
1010.sp
1011.B " flashrom \-p linux_mtd:dev=/dev/mtdX"
1012.sp
1013syntax where
1014.B /dev/mtdX
1015is the Linux device node for your MTD device. If left unspecified the first MTD
1016device found (e.g. /dev/mtd0) will be used by default.
1017.sp
1018Please note that the linux_mtd driver only works on Linux.
1019.SS
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001020.BR "linux_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001021.IP
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001022You have to specify the SPI controller to use with the
1023.sp
1024.B " flashrom \-p linux_spi:dev=/dev/spidevX.Y"
1025.sp
1026syntax where
1027.B /dev/spidevX.Y
1028is the Linux device node for your SPI controller.
1029.sp
Stefan Tauner0554ca52013-07-25 22:54:25 +00001030In case the device supports it, you can set the SPI clock frequency with the optional
1031.B spispeed
1032parameter. The frequency is parsed as kilohertz.
1033Example that sets the frequency to 8 MHz:
1034.sp
1035.B " flashrom \-p linux_spi:dev=/dev/spidevX.Y,spispeed=8000"
1036.sp
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001037Please note that the linux_spi driver only works on Linux.
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001038.SS
1039.BR "mstarddc_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001040.IP
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001041The Display Data Channel (DDC) is an I2C bus present on VGA and DVI connectors, that allows exchanging
Stefan Tauner0be072c2016-03-13 15:16:30 +00001042information between a computer and attached displays. Its most common uses are getting display capabilities
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001043through EDID (at I2C address 0x50) and sending commands to the display using the DDC/CI protocol (at address
10440x37). On displays driven by MSTAR SoCs, it is also possible to access the SoC firmware flash (connected to
1045the Soc through another SPI bus) using an In-System Programming (ISP) port, usually at address 0x49.
1046This flashrom module allows the latter via Linux's I2C driver.
1047.sp
1048.B IMPORTANT:
1049Before using this programmer, the display
1050.B MUST
1051be in standby mode, and only connected to the computer that will run flashrom using a VGA cable, to an
1052inactive VGA output. It absolutely
1053.B MUST NOT
1054be used as a display during the procedure!
1055.sp
1056You have to specify the DDC/I2C controller and I2C address to use with the
1057.sp
1058.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-X:YY"
1059.sp
1060syntax where
1061.B /dev/i2c-X
1062is the Linux device node for your I2C controller connected to the display's DDC channel, and
1063.B YY
1064is the (hexadecimal) address of the MSTAR ISP port (address 0x49 is usually used).
1065Example that uses I2C controller /dev/i2c-1 and address 0x49:
1066.sp
1067.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-1:49
1068.sp
1069It is also possible to inhibit the reset command that is normally sent to the display once the flashrom
1070operation is completed using the optional
1071.B noreset
1072parameter. A value of 1 prevents flashrom from sending the reset command.
1073Example that does not reset the display at the end of the operation:
1074.sp
1075.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-1:49,noreset=1
1076.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +00001077Please note that sending the reset command is also inhibited if an error occurred during the operation.
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001078To send the reset command afterwards, you can simply run flashrom once more, in chip probe mode (not specifying
1079an operation), without the
1080.B noreset
1081parameter, once the flash read/write operation you intended to perform has completed successfully.
1082.sp
1083Please also note that the mstarddc_spi driver only works on Linux.
Urja Rannikko0870b022016-01-31 22:10:29 +00001084.SS
1085.BR "ch341a_spi " programmer
1086The WCH CH341A programmer does not support any parameters currently. SPI frequency is fixed at 2 MHz, and CS0 is
1087used as per the device.
Lubomir Rintelb2154e82018-01-14 17:35:33 +01001088.SS
1089.BR "digilent_spi " programmer
1090.IP
1091An optional
1092.B spispeed
1093parameter specifies the frequency of the SPI bus.
1094Syntax is
1095.sp
1096.B " flashrom \-p digilent_spi:spispeed=frequency"
1097.sp
1098where
1099.B frequency
1100can be
1101.BR 62.5k ", " 125k ", " 250k ", " 500k ", " 1M ", " 2M " or " 4M
1102(in Hz). The default is a frequency of 4 MHz.
1103.sp
1104.SS
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +00001105.SH EXAMPLES
1106To back up and update your BIOS, run
1107.sp
1108.B flashrom -p internal -r backup.rom -o backuplog.txt
1109.br
1110.B flashrom -p internal -w newbios.rom -o writelog.txt
1111.sp
1112Please make sure to copy backup.rom to some external media before you try
1113to write. That makes offline recovery easier.
1114.br
1115If writing fails and flashrom complains about the chip being in an unknown
1116state, you can try to restore the backup by running
1117.sp
1118.B flashrom -p internal -w backup.rom -o restorelog.txt
1119.sp
1120If you encounter any problems, please contact us and supply
1121backuplog.txt, writelog.txt and restorelog.txt. See section
1122.B BUGS
1123for contact info.
Peter Stuge42688e52009-01-26 02:20:56 +00001124.SH EXIT STATUS
Niklas Söderlund2d8b7ef2013-09-13 19:19:25 +00001125flashrom exits with 0 on success, 1 on most failures but with 3 if a call to mmap() fails.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001126.SH REQUIREMENTS
1127flashrom needs different access permissions for different programmers.
1128.sp
1129.B internal
1130needs raw memory access, PCI configuration space access, raw I/O port
1131access (x86) and MSR access (x86).
1132.sp
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +00001133.B atavia
1134needs PCI configuration space access.
1135.sp
Sergey Lichack98f47102012-08-27 01:24:15 +00001136.BR nic3com ", " nicrealtek " and " nicnatsemi "
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001137need PCI configuration space read access and raw I/O port access.
1138.sp
1139.B atahpt
1140needs PCI configuration space access and raw I/O port access.
1141.sp
Kyösti Mälkki72d42f82014-06-01 23:48:31 +00001142.BR gfxnvidia ", " drkaiser " and " it8212
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001143need PCI configuration space access and raw memory access.
1144.sp
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +00001145.B rayer_spi
1146needs raw I/O port access.
1147.sp
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +00001148.BR satasii ", " nicintel ", " nicintel_eeprom " and " nicintel_spi
1149need PCI configuration space read access and raw memory access.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001150.sp
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +00001151.BR satamv " and " atapromise
1152need PCI configuration space read access, raw I/O port access and raw memory
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +00001153access.
1154.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001155.B serprog
1156needs TCP access to the network or userspace access to a serial port.
1157.sp
1158.B buspirate_spi
1159needs userspace access to a serial port.
1160.sp
Nico Huberd99a2bd2016-02-18 21:42:49 +00001161.BR ft2232_spi ", " usbblaster_spi " and " pickit2_spi
Stefan Taunere49edbb2016-01-31 22:10:14 +00001162need access to the respective USB device via libusb API version 0.1.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001163.sp
Nico Huberd99a2bd2016-02-18 21:42:49 +00001164.BR ch341a_spi " and " dediprog
1165need access to the respective USB device via libusb API version 1.0.
Urja Rannikko0870b022016-01-31 22:10:29 +00001166.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001167.B dummy
1168needs no access permissions at all.
1169.sp
Sergey Lichack98f47102012-08-27 01:24:15 +00001170.BR internal ", " nic3com ", " nicrealtek ", " nicnatsemi ", "
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +00001171.BR gfxnvidia ", " drkaiser ", " satasii ", " satamv ", " atahpt ", " atavia " and " atapromise
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001172have to be run as superuser/root, and need additional raw access permission.
1173.sp
Lubomir Rintelb2154e82018-01-14 17:35:33 +01001174.BR serprog ", " buspirate_spi ", " dediprog ", " usbblaster_spi ", " ft2232_spi ", " pickit2_spi ", " \
1175ch341a_spi " and " digilent_spi
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001176can be run as normal user on most operating systems if appropriate device
1177permissions are set.
1178.sp
Mark Marshall90021f22010-12-03 14:48:11 +00001179.B ogp
1180needs PCI configuration space read access and raw memory access.
1181.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001182On OpenBSD, you can obtain raw access permission by setting
Uwe Hermann941a2732011-07-25 21:12:57 +00001183.B "securelevel=-1"
1184in
1185.B "/etc/rc.securelevel"
1186and rebooting, or rebooting into single user mode.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001187.SH BUGS
Stefan Tauner4c723152016-01-14 22:47:55 +00001188Please report any bugs to the
1189.MTOB "flashrom@flashrom.org" "flashrom mailing list" .
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001190.sp
1191We recommend to subscribe first at
Stefan Tauner4c723152016-01-14 22:47:55 +00001192.URLB "https://flashrom.org/mailman/listinfo/flashrom" "" .
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +00001193.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001194Many of the developers communicate via the
1195.B "#flashrom"
1196IRC channel on
1197.BR chat.freenode.net .
Stefan Tauner4c723152016-01-14 22:47:55 +00001198If you don't have an IRC client, you can use the
1199.URLB http://webchat.freenode.net/?channels=flashrom "freenode webchat" .
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001200You are welcome to join and ask questions, send us bug and success reports there
Stefan Taunereb582572012-09-21 12:52:50 +00001201too. Please provide a way to contact you later (e.g.\& a mail address) and be
Stefan Tauner4c723152016-01-14 22:47:55 +00001202patient if there is no immediate reaction. Also, we provide a
1203.URLB https://paste.flashrom.org "pastebin service"
Stefan Taunereb582572012-09-21 12:52:50 +00001204that is very useful when you want to share logs etc.\& without spamming the
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001205channel.
1206.SS
1207.B Laptops
1208.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +00001209Using flashrom on laptops is dangerous and may easily make your hardware
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001210unusable. flashrom will attempt to detect if it is running on a laptop and abort
1211immediately for safety reasons. Please see the detailed discussion of this topic
1212and associated flashrom options in the
1213.B Laptops
1214paragraph in the
1215.B internal programmer
1216subsection of the
Stefan Tauner6697f712014-08-06 15:09:15 +00001217.B PROGRAMMER-SPECIFIC INFORMATION
Stefan Tauner4c723152016-01-14 22:47:55 +00001218section and the information
1219.URLB "https://flashrom.org/Laptops" "in our wiki" .
Daniel Lenski65922a32012-02-15 23:40:23 +00001220.SS
1221One-time programmable (OTP) memory and unique IDs
1222.sp
1223Some flash chips contain OTP memory often denoted as "security registers".
1224They usually have a capacity in the range of some bytes to a few hundred
Stefan Taunereb582572012-09-21 12:52:50 +00001225bytes and can be used to give devices unique IDs etc. flashrom is not able
Daniel Lenski65922a32012-02-15 23:40:23 +00001226to read or write these memories and may therefore not be able to duplicate a
1227chip completely. For chip types known to include OTP memories a warning is
1228printed when they are detected.
1229.sp
1230Similar to OTP memories are unique, factory programmed, unforgeable IDs.
1231They are not modifiable by the user at all.
Stefan Taunerac54fbe2011-07-21 19:52:00 +00001232.SH LICENSE
Stefan Reinauer261144c2006-07-27 23:29:02 +00001233.B flashrom
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001234is covered by the GNU General Public License (GPL), version 2. Some files are
Stefan Tauner23e10b82016-01-23 16:16:49 +00001235additionally available under any later version of the GPL.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001236.SH COPYRIGHT
Stefan Reinauer261144c2006-07-27 23:29:02 +00001237.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001238Please see the individual files.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001239.SH AUTHORS
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001240Andrew Morgan
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001241.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001242Carl-Daniel Hailfinger
1243.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001244Claus Gindhart
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001245.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001246David Borg
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001247.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001248David Hendricks
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001249.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001250Dominik Geyer
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001251.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001252Eric Biederman
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001253.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001254Giampiero Giancipoli
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001255.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001256Helge Wagner
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001257.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001258Idwer Vollering
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001259.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001260Joe Bao
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001261.br
Stefan Taunerc0aaf952011-05-19 02:58:17 +00001262Joerg Fischer
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001263.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001264Joshua Roys
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001265.br
Stefan Tauner5c316f92015-02-08 21:57:52 +00001266Ky\[:o]sti M\[:a]lkki
1267.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001268Luc Verhaegen
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001269.br
Carl-Daniel Hailfinger451dc802009-05-01 11:00:39 +00001270Li-Ta Lo
1271.br
Mark Marshall90021f22010-12-03 14:48:11 +00001272Mark Marshall
1273.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001274Markus Boas
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001275.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001276Mattias Mattsson
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001277.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001278Michael Karcher
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001279.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001280Nikolay Petukhov
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001281.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001282Patrick Georgi
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001283.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001284Peter Lemenkov
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001285.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001286Peter Stuge
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001287.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001288Reinder E.N. de Haan
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001289.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001290Ronald G. Minnich
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001291.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001292Ronald Hoogenboom
Stefan Reinauer261144c2006-07-27 23:29:02 +00001293.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001294Sean Nelson
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001295.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001296Stefan Reinauer
Stefan Reinauer261144c2006-07-27 23:29:02 +00001297.br
Uwe Hermann68b9cca2011-06-15 23:44:52 +00001298Stefan Tauner
1299.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001300Stefan Wildemann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001301.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001302Stephan Guilloux
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001303.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001304Steven James
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001305.br
Stefan Tauner23e10b82016-01-23 16:16:49 +00001306Urja Rannikko
1307.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001308Uwe Hermann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001309.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001310Wang Qingpei
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001311.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001312Yinghai Lu
Stefan Reinauerf8337dd2006-08-03 10:49:09 +00001313.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001314some others, please see the flashrom svn changelog for details.
1315.br
Stefan Tauner4c723152016-01-14 22:47:55 +00001316All still active authors can be reached via
1317.MTOB "flashrom@flashrom.org" "the mailing list" .
Stefan Reinauer261144c2006-07-27 23:29:02 +00001318.PP
Stefan Tauner4c723152016-01-14 22:47:55 +00001319This manual page was written by
1320.MTOB "uwe@hermann-uwe.de" "Uwe Hermann" ,
1321Carl-Daniel Hailfinger, Stefan Tauner and others.
Uwe Hermann42eb17f2008-01-18 17:48:51 +00001322It is licensed under the terms of the GNU GPL (version 2 or later).