blob: c1a228be747f730dbc398a465e03d904efacdc68 [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
Arthur Heymansc82900b2018-01-10 12:48:16 +010047.B flashrom \fR[\fB\-h\fR|\fB\-R\fR|\fB\-L\fR|\fB\-z\fR|\fB\-p\fR <programmername>[:<parameters>]
48 [\fB\-E\fR|\fB\-r\fR <file>|\fB\-w\fR <file>|\fB\-v\fR <file>] [\fB\-c\fR <chipname>]
49 [(\fB\-l\fR <file>|\fB\-\-ifd|\fB \-\-fmap\fR|\fB\-\-fmap-file\fR <file>) [\fB\-i\fR <image>]]
50 [\fB\-n\fR] [\fB\-N\fR] [\fB\-f\fR]]
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +000051 [\fB\-V\fR[\fBV\fR[\fBV\fR]]] [\fB-o\fR <logfile>]
Stefan Reinauer261144c2006-07-27 23:29:02 +000052.SH DESCRIPTION
53.B flashrom
Uwe Hermanne8ba5382009-05-22 11:37:27 +000054is a utility for detecting, reading, writing, verifying and erasing flash
Uwe Hermann530cb2d2009-05-14 22:58:21 +000055chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
Uwe Hermann941a2732011-07-25 21:12:57 +000056using a supported mainboard. However, it also supports various external
57PCI/USB/parallel-port/serial-port based devices which can program flash chips,
58including some network cards (NICs), SATA/IDE controller cards, graphics cards,
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000059the Bus Pirate device, various FTDI FT2232/FT4232H/FT232H based USB devices, and more.
Uwe Hermanne74b9f82009-04-10 14:41:29 +000060.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000061It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40,
Uwe Hermann941a2732011-07-25 21:12:57 +000062TSOP48, and BGA chips, which use various protocols such as LPC, FWH,
63parallel flash, or SPI.
Stefan Reinauer261144c2006-07-27 23:29:02 +000064.SH OPTIONS
Uwe Hermann9ff514d2010-06-07 19:41:25 +000065.B IMPORTANT:
Carl-Daniel Hailfinger5de93412009-05-01 10:53:49 +000066Please note that the command line interface for flashrom will change before
67flashrom 1.0. Do not use flashrom in scripts or other automated tools without
Uwe Hermanne8ba5382009-05-22 11:37:27 +000068checking that your flashrom version won't interpret options in a different way.
Carl-Daniel Hailfinger5de93412009-05-01 10:53:49 +000069.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000070You can specify one of
71.BR \-h ", " \-R ", " \-L ", " \-z ", " \-E ", " \-r ", " \-w ", " \-v
72or no operation.
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000073If no operation is specified, flashrom will only probe for flash chips. It is
Michael Karcher31fd8252010-03-12 06:41:39 +000074recommended that if you try flashrom the first time on a system, you run it
Uwe Hermann941a2732011-07-25 21:12:57 +000075in probe-only mode and check the output. Also you are advised to make a
Uwe Hermann9ff514d2010-06-07 19:41:25 +000076backup of your current ROM contents with
77.B \-r
Stefan Taunere34e3e82013-01-01 00:06:51 +000078before you try to write a new image. All operations involving any chip access (probe/read/write/...) require the
79.B -p/--programmer
80option to be used (please see below).
Stefan Reinauerde063bf2006-09-21 13:09:22 +000081.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000082.B "\-r, \-\-read <file>"
83Read flash ROM contents and save them into the given
84.BR <file> .
Uwe Hermann941a2732011-07-25 21:12:57 +000085If the file already exists, it will be overwritten.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000086.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000087.B "\-w, \-\-write <file>"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000088Write
89.B <file>
Uwe Hermann9ff514d2010-06-07 19:41:25 +000090into flash ROM. This will first automatically
91.B erase
92the chip, then write to it.
Stefan Taunerac54fbe2011-07-21 19:52:00 +000093.sp
94In the process the chip is also read several times. First an in-memory backup
95is made for disaster recovery and to be able to skip regions that are
96already equal to the image file. This copy is updated along with the write
97operation. In case of erase errors it is even re-read completely. After
98writing has finished and if verification is enabled, the whole flash chip is
99read out and compared with the input image.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000100.TP
Uwe Hermannea07f622009-06-24 17:31:08 +0000101.B "\-n, \-\-noverify"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000102Skip the automatic verification of flash ROM contents after writing. Using this
Uwe Hermannea07f622009-06-24 17:31:08 +0000103option is
104.B not
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000105recommended, you should only use it if you know what you are doing and if you
Uwe Hermannea07f622009-06-24 17:31:08 +0000106feel that the time for verification takes too long.
107.sp
108Typical usage is:
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000109.B "flashrom \-p prog \-n \-w <file>"
Uwe Hermannea07f622009-06-24 17:31:08 +0000110.sp
111This option is only useful in combination with
112.BR \-\-write .
113.TP
Nico Huber99d15952016-05-02 16:54:24 +0200114.B "\-N, \-\-noverify-all"
115Skip not included regions during automatic verification after writing (cf.
116.BR "\-l " "and " "\-i" ).
117You should only use this option if you are sure that communication with
118the flash chip is reliable (e.g. when using the
119.BR internal
120programmer). Even if flashrom is instructed not to touch parts of the
121flash chip, their contents could be damaged (e.g. due to misunderstood
122erase commands).
123.sp
124This option is required to flash an Intel system with locked ME flash
125region using the
126.BR internal
127programmer. It may be enabled by default in this case in the future.
128.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000129.B "\-v, \-\-verify <file>"
130Verify the flash ROM contents against the given
131.BR <file> .
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000132.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000133.B "\-E, \-\-erase"
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000134Erase the flash ROM chip.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000135.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000136.B "\-V, \-\-verbose"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000137More verbose output. This option can be supplied multiple times
Stefan Taunereebeb532011-08-04 17:40:25 +0000138(max. 3 times, i.e.
139.BR \-VVV )
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000140for even more debug output.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000141.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +0000142.B "\-c, \-\-chip" <chipname>
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000143Probe only for the specified flash ROM chip. This option takes the chip name as
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000144printed by
145.B "flashrom \-L"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000146without the vendor name as parameter. Please note that the chip name is
147case sensitive.
Joerg Mayer645c6df2010-03-13 14:47:48 +0000148.TP
Joerg Mayer645c6df2010-03-13 14:47:48 +0000149.B "\-f, \-\-force"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000150Force one or more of the following actions:
Joerg Mayer645c6df2010-03-13 14:47:48 +0000151.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000152* Force chip read and pretend the chip is there.
153.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000154* Force chip access even if the chip is bigger than the maximum supported \
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000155size for the flash bus.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000156.sp
157* Force erase even if erase is known bad.
158.sp
159* Force write even if write is known bad.
Joerg Mayer645c6df2010-03-13 14:47:48 +0000160.TP
161.B "\-l, \-\-layout <file>"
162Read ROM layout from
163.BR <file> .
Uwe Hermann87c07932009-05-05 16:15:46 +0000164.sp
165flashrom supports ROM layouts. This allows you to flash certain parts of
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000166the flash chip only. A ROM layout file contains multiple lines with the
167following syntax:
168.sp
169.B " startaddr:endaddr imagename"
170.sp
171.BR "startaddr " "and " "endaddr "
172are hexadecimal addresses within the ROM file and do not refer to any
173physical address. Please note that using a 0x prefix for those hexadecimal
174numbers is not necessary, but you can't specify decimal/octal numbers.
175.BR "imagename " "is an arbitrary name for the region/image from"
176.BR " startaddr " "to " "endaddr " "(both addresses included)."
177.sp
178Example:
Uwe Hermann87c07932009-05-05 16:15:46 +0000179.sp
180 00000000:00008fff gfxrom
181 00009000:0003ffff normal
182 00040000:0007ffff fallback
183.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000184If you only want to update the image named
185.BR "normal " "in a ROM based on the layout above, run"
Uwe Hermann87c07932009-05-05 16:15:46 +0000186.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000187.B " flashrom \-p prog \-\-layout rom.layout \-\-image normal \-w some.rom"
Uwe Hermann87c07932009-05-05 16:15:46 +0000188.sp
Stefan Taunere34e3e82013-01-01 00:06:51 +0000189To update only the images named
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000190.BR "normal " "and " "fallback" ", run:"
Uwe Hermann87c07932009-05-05 16:15:46 +0000191.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000192.B " flashrom \-p prog \-l rom.layout \-i normal -i fallback \-w some.rom"
Uwe Hermann87c07932009-05-05 16:15:46 +0000193.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000194Overlapping sections are not supported.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000195.TP
Arthur Heymansc82900b2018-01-10 12:48:16 +0100196.B "\-\-fmap"
197Read layout from fmap in flash chip.
198.sp
199flashrom supports the fmap binary format which is commonly used by coreboot
200for partitioning a flash chip. The on-chip fmap will be read and used to generate
201the layout.
202.sp
203If you only want to update the
204.BR "COREBOOT"
205region defined in the fmap, run
206.sp
207.B " flashrom -p prog \-\-fmap \-\-image COREBOOT \-w some.rom"
208.TP
209.B "\-\-fmap-file <file>"
210Read layout from a
211.BR <file>
212containing binary fmap (e.g. coreboot roms).
213.sp
214flashrom supports the fmap binary format which is commonly used by coreboot
215for partitioning a flash chip. The fmap in the specified file will be read and
216used to generate the layout.
217.sp
218If you only want to update the
219.BR "COREBOOT"
220region defined in the binary fmap file, run
221.sp
222.B " flashrom \-p prog \-\-fmap-file some.rom \-\-image COREBOOT \-w some.rom"
223.TP
Nico Huber305f4172013-06-14 11:55:26 +0200224.B "\-\-ifd"
225Read ROM layout from Intel Firmware Descriptor.
226.sp
227flashrom supports ROM layouts given by an Intel Firmware Descriptor
228(IFD). The on-chip descriptor will be read and used to generate the
229layout. If you need to change the layout, you have to update the IFD
230only first.
231.sp
232The following ROM images may be present in an IFD:
233.sp
234 fd the IFD itself
235 bios the host firmware aka. BIOS
236 me Intel Management Engine firmware
237 gbe gigabit ethernet firmware
238 pd platform specific data
239.TP
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000240.B "\-i, \-\-image <imagename>"
241Only flash region/image
242.B <imagename>
Uwe Hermann67808fe2007-10-18 00:29:05 +0000243from flash layout.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000244.TP
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000245.B "\-L, \-\-list\-supported"
Uwe Hermann941a2732011-07-25 21:12:57 +0000246List the flash chips, chipsets, mainboards, and external programmers
247(including PCI, USB, parallel port, and serial port based devices)
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000248supported by flashrom.
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000249.sp
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000250There are many unlisted boards which will work out of the box, without
251special support in flashrom. Please let us know if you can verify that
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000252other boards work or do not work out of the box.
253.sp
254.B IMPORTANT:
255For verification you have
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000256to test an ERASE and/or WRITE operation, so make sure you only do that
257if you have proper means to recover from failure!
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000258.TP
Uwe Hermann20a293f2009-06-19 10:42:43 +0000259.B "\-z, \-\-list\-supported-wiki"
260Same as
261.BR \-\-list\-supported ,
262but outputs the supported hardware in MediaWiki syntax, so that it can be
Stefan Tauner4c723152016-01-14 22:47:55 +0000263easily pasted into the
264.URLB https://flashrom.org/Supported_hardware "supported hardware wiki page" .
Uwe Hermann941a2732011-07-25 21:12:57 +0000265Please note that MediaWiki output is not compiled in by default.
Uwe Hermann20a293f2009-06-19 10:42:43 +0000266.TP
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000267.B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]"
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000268Specify the programmer device. This is mandatory for all operations
269involving any chip access (probe/read/write/...). Currently supported are:
Carl-Daniel Hailfingerce986772009-05-09 00:27:07 +0000270.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +0000271.BR "* internal" " (for in-system flashing in the mainboard)"
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000272.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000273.BR "* dummy" " (virtual programmer for testing flashrom)"
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000274.sp
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000275.BR "* nic3com" " (for flash ROMs on 3COM network cards)"
276.sp
Sergey Lichack98f47102012-08-27 01:24:15 +0000277.BR "* nicrealtek" " (for flash ROMs on Realtek and SMC 1211 network cards)"
Uwe Hermann829ed842010-05-24 17:39:14 +0000278.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000279.BR "* nicnatsemi" " (for flash ROMs on National Semiconductor DP838* network \
280cards)"
281.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000282.BR "* nicintel" " (for parallel flash ROMs on Intel 10/100Mbit network cards)
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000283.sp
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000284.BR "* gfxnvidia" " (for flash ROMs on NVIDIA graphics cards)"
285.sp
TURBO Jb0912c02009-09-02 23:00:46 +0000286.BR "* drkaiser" " (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)"
287.sp
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000288.BR "* satasii" " (for flash ROMs on Silicon Image SATA/IDE controllers)"
289.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000290.BR "* satamv" " (for flash ROMs on Marvell SATA controllers)"
291.sp
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000292.BR "* atahpt" " (for flash ROMs on Highpoint ATA/RAID controllers)"
293.sp
Stefan Tauner4f094752014-06-01 22:36:30 +0000294.BR "* atavia" " (for flash ROMs on VIA VT6421A SATA controllers)"
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000295.sp
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000296.BR "* atapromise" " (for flash ROMs on Promise PDC2026x ATA/RAID controllers)"
297.sp
Kyösti Mälkki72d42f82014-06-01 23:48:31 +0000298.BR "* it8212" " (for flash ROMs on ITE IT8212F ATA/RAID controller)"
299.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +0000300.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 +0000301.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000302.BR "* serprog" " (for flash ROMs attached to a programmer speaking serprog, \
Stefan Tauner0be072c2016-03-13 15:16:30 +0000303including some Arduino-based devices)."
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000304.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000305.BR "* buspirate_spi" " (for SPI flash ROMs attached to a Bus Pirate)"
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000306.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000307.BR "* dediprog" " (for SPI flash ROMs attached to a Dediprog SF100)"
308.sp
Kyösti Mälkki8b1bdf12013-10-02 01:21:45 +0000309.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 +0000310.sp
Michael Karchere5449392012-05-05 20:53:59 +0000311.BR "* pony_spi" " (for SPI flash ROMs attached to a SI-Prog serial port "
312bitbanging adapter)
313.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000314.BR "* nicintel_spi" " (for SPI flash ROMs on Intel Gigabit network cards)"
Idwer Vollering004f4b72010-09-03 18:21:21 +0000315.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000316.BR "* ogp_spi" " (for SPI flash ROMs on Open Graphics Project graphics card)"
Mark Marshall90021f22010-12-03 14:48:11 +0000317.sp
David Hendricksf9a30552015-05-23 20:30:30 -0700318.BR "* linux_mtd" " (for SPI flash ROMs accessible via /dev/mtdX on Linux)"
319.sp
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +0000320.BR "* linux_spi" " (for SPI flash ROMs accessible via /dev/spidevX.Y on Linux)"
321.sp
James Lairdc60de0e2013-03-27 13:00:23 +0000322.BR "* usbblaster_spi" " (for SPI flash ROMs attached to an Altera USB-Blaster compatible cable)"
323.sp
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000324.BR "* nicintel_eeprom" " (for SPI EEPROMs on Intel Gigabit network cards)"
325.sp
Alexandre Boeglin80e64712014-12-20 20:25:19 +0000326.BR "* mstarddc_spi" " (for SPI flash ROMs accessible through DDC in MSTAR-equipped displays)"
327.sp
Justin Chevrier66e554b2015-02-08 21:58:10 +0000328.BR "* pickit2_spi" " (for SPI flash ROMs accessible via Microchip PICkit2)"
329.sp
Urja Rannikko0870b022016-01-31 22:10:29 +0000330.BR "* ch341a_spi" " (for SPI flash ROMs attached to WCH CH341A)"
331.sp
Lubomir Rintelb2154e82018-01-14 17:35:33 +0100332.BR "* digilent_spi" " (for SPI flash ROMs attached to iCEblink40 development boards)"
333.sp
Marc Schink3578ec62016-03-17 16:23:03 +0100334.BR "* jlink_spi" " (for SPI flash ROMs attached to SEGGER J-Link and compatible devices)"
335.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000336Some programmers have optional or mandatory parameters which are described
337in detail in the
Stefan Tauner6697f712014-08-06 15:09:15 +0000338.B PROGRAMMER-SPECIFIC INFORMATION
Michael Karchere5eafb22010-03-07 12:11:08 +0000339section. Support for some programmers can be disabled at compile time.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000340.B "flashrom \-h"
Michael Karchere5eafb22010-03-07 12:11:08 +0000341lists all supported programmers.
342.TP
343.B "\-h, \-\-help"
344Show a help text and exit.
345.TP
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +0000346.B "\-o, \-\-output <logfile>"
347Save the full debug log to
348.BR <logfile> .
349If the file already exists, it will be overwritten. This is the recommended
350way to gather logs from flashrom because they will be verbose even if the
Stefan Tauner6697f712014-08-06 15:09:15 +0000351on-screen messages are not verbose and don't require output redirection.
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +0000352.TP
Michael Karchere5eafb22010-03-07 12:11:08 +0000353.B "\-R, \-\-version"
354Show version information and exit.
Stefan Tauner6697f712014-08-06 15:09:15 +0000355.SH PROGRAMMER-SPECIFIC INFORMATION
Michael Karchere5eafb22010-03-07 12:11:08 +0000356Some programmer drivers accept further parameters to set programmer-specific
Uwe Hermann4e3d0b32010-03-25 23:18:41 +0000357parameters. These parameters are separated from the programmer name by a
Michael Karchere5eafb22010-03-07 12:11:08 +0000358colon. While some programmers take arguments at fixed positions, other
359programmers use a key/value interface in which the key and value is separated
360by an equal sign and different pairs are separated by a comma or a colon.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000361.SS
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000362.BR "internal " programmer
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000363.TP
364.B Board Enables
365.sp
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000366Some mainboards require to run mainboard specific code to enable flash erase
367and write support (and probe support on old systems with parallel flash).
368The mainboard brand and model (if it requires specific code) is usually
369autodetected using one of the following mechanisms: If your system is
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000370running coreboot, the mainboard type is determined from the coreboot table.
371Otherwise, the mainboard is detected by examining the onboard PCI devices
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000372and possibly DMI info. If PCI and DMI do not contain information to uniquely
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000373identify the mainboard (which is the exception), or if you want to override
374the detected mainboard model, you can specify the mainboard using the
375.sp
Stefan Taunerb4e06bd2012-08-20 00:24:22 +0000376.B " flashrom \-p internal:mainboard=<vendor>:<board>"
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000377syntax.
378.sp
379See the 'Known boards' or 'Known laptops' section in the output
380of 'flashrom \-L' for a list of boards which require the specification of
381the board name, if no coreboot table is found.
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000382.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000383Some of these board-specific flash enabling functions (called
384.BR "board enables" )
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000385in flashrom have not yet been tested. If your mainboard is detected needing
386an untested board enable function, a warning message is printed and the
387board enable is not executed, because a wrong board enable function might
388cause the system to behave erratically, as board enable functions touch the
389low-level internals of a mainboard. Not executing a board enable function
390(if one is needed) might cause detection or erasing failure. If your board
391protects only part of the flash (commonly the top end, called boot block),
392flashrom might encounter an error only after erasing the unprotected part,
393so running without the board-enable function might be dangerous for erase
394and write (which includes erase).
395.sp
396The suggested procedure for a mainboard with untested board specific code is
397to first try to probe the ROM (just invoke flashrom and check that it
398detects your flash chip type) without running the board enable code (i.e.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000399without any parameters). If it finds your chip, fine. Otherwise, retry
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000400probing your chip with the board-enable code running, using
401.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000402.B " flashrom \-p internal:boardenable=force"
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000403.sp
404If your chip is still not detected, the board enable code seems to be broken
405or the flash chip unsupported. Otherwise, make a backup of your current ROM
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000406contents (using
407.BR \-r )
408and store it to a medium outside of your computer, like
409a USB drive or a network share. If you needed to run the board enable code
Stefan Taunereb582572012-09-21 12:52:50 +0000410already for probing, use it for reading too.
411If reading succeeds and the contens of the read file look legit you can try to write the new image.
412You should enable the board enable code in any case now, as it
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000413has been written because it is known that writing/erasing without the board
414enable is going to fail. In any case (success or failure), please report to
415the flashrom mailing list, see below.
416.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000417.TP
418.B Coreboot
419.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000420On systems running coreboot, flashrom checks whether the desired image matches
421your mainboard. This needs some special board ID to be present in the image.
422If flashrom detects that the image you want to write and the current board
423do not match, it will refuse to write the image unless you specify
424.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000425.B " flashrom \-p internal:boardmismatch=force"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000426.TP
427.B ITE IT87 Super I/O
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000428.sp
Vadim Girlin4dd0f902013-08-24 12:18:17 +0000429If your mainboard is manufactured by GIGABYTE and supports DualBIOS it is very likely that it uses an
430ITE IT87 series Super I/O to switch between the two flash chips. Only one of them can be accessed at a time
431and you can manually select which one to use with the
432.sp
433.B " flashrom \-p internal:dualbiosindex=chip"
434.sp
435syntax where
436.B chip
437is the index of the chip to use (0 = main, 1 = backup). You can check which one is currently selected by
438leaving out the
439.B chip
440parameter.
441.sp
Carl-Daniel Hailfinger01f3ef42010-03-25 02:50:40 +0000442If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000443translation, flashrom should autodetect that configuration. If you want to
444set the I/O base port of the IT87 series SPI controller manually instead of
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000445using the value provided by the BIOS, use the
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000446.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000447.B " flashrom \-p internal:it87spiport=portnum"
448.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000449syntax where
450.B portnum
451is the I/O port number (must be a multiple of 8). In the unlikely case
452flashrom doesn't detect an active IT87 LPC<->SPI bridge, please send a bug
453report so we can diagnose the problem.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000454.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000455.TP
Rudolf Marek70e14592013-07-25 22:58:56 +0000456.B AMD chipsets
457.sp
458Beginning with the SB700 chipset there is an integrated microcontroller (IMC) based on the 8051 embedded in
459every AMD southbridge. Its firmware resides in the same flash chip as the host's which makes writing to the
460flash risky if the IMC is active. Flashrom tries to temporarily disable the IMC but even then changing the
461contents of the flash can have unwanted effects: when the IMC continues (at the latest after a reboot) it will
462continue executing code from the flash. If the code was removed or changed in an unfortunate way it is
463unpredictable what the IMC will do. Therefore, if flashrom detects an active IMC it will disable write support
464unless the user forces it with the
465.sp
466.B " flashrom \-p internal:amd_imc_force=yes"
467.sp
468syntax. The user is responsible for supplying a suitable image or leaving out the IMC region with the help of
469a layout file. This limitation might be removed in the future when we understand the details better and have
470received enough feedback from users. Please report the outcome if you had to use this option to write a chip.
471.sp
Stefan Tauner21071b02014-05-16 21:39:48 +0000472An optional
473.B spispeed
474parameter specifies the frequency of the SPI bus where applicable (i.e.\& SB600 or later with an SPI flash chip
475directly attached to the chipset).
476Syntax is
477.sp
478.B " flashrom \-p internal:spispeed=frequency"
479.sp
480where
481.B frequency
482can be
483.BR "'16.5\ MHz'" ", " "'22\ MHz'" ", " "'33\ MHz'" ", " "'66\ MHz'" ", " "'100\ MHZ'" ", or " "'800\ kHz'" "."
484Support of individual frequencies depends on the generation of the chipset:
485.sp
486* SB6xx, SB7xx, SP5xxx: from 16.5 MHz up to and including 33 MHz
487.sp
488* SB8xx, SB9xx, Hudson: from 16.5 MHz up to and including 66 MHz
489.sp
490* Yangtze (with SPI 100 engine as found in Kabini and Tamesh): all of them
491.sp
492The default is to use 16.5 MHz and disable Fast Reads.
Rudolf Marek70e14592013-07-25 22:58:56 +0000493.TP
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000494.B Intel chipsets
495.sp
Stefan Tauner50e7c602011-11-08 10:55:54 +0000496If you have an Intel chipset with an ICH8 or later southbridge with SPI flash
Stefan Taunereb582572012-09-21 12:52:50 +0000497attached, and if a valid descriptor was written to it (e.g.\& by the vendor), the
Stefan Tauner50e7c602011-11-08 10:55:54 +0000498chipset provides an alternative way to access the flash chip(s) named
499.BR "Hardware Sequencing" .
500It is much simpler than the normal access method (called
501.BR "Software Sequencing" "),"
502but does not allow the software to choose the SPI commands to be sent.
503You can use the
504.sp
505.B " flashrom \-p internal:ich_spi_mode=value"
506.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000507syntax where
508.BR "value " "can be"
Stefan Tauner50e7c602011-11-08 10:55:54 +0000509.BR auto ", " swseq " or " hwseq .
510By default
511.RB "(or when setting " ich_spi_mode=auto )
Stefan Taunereb582572012-09-21 12:52:50 +0000512the module tries to use swseq and only activates hwseq if need be (e.g.\& if
Stefan Tauner50e7c602011-11-08 10:55:54 +0000513important opcodes are inaccessible due to lockdown; or if more than one flash
514chip is attached). The other options (swseq, hwseq) select the respective mode
515(if possible).
516.sp
Stefan Tauner5210e722012-02-16 01:13:00 +0000517ICH8 and later southbridges may also have locked address ranges of different
518kinds if a valid descriptor was written to it. The flash address space is then
519partitioned in multiple so called "Flash Regions" containing the host firmware,
520the ME firmware and so on respectively. The flash descriptor can also specify up
521to 5 so called "Protected Regions", which are freely chosen address ranges
522independent from the aforementioned "Flash Regions". All of them can be write
Nico Huber7590d1a2016-05-03 13:38:28 +0200523and/or read protected individually.
Stefan Tauner5210e722012-02-16 01:13:00 +0000524.sp
Kyösti Mälkki88ee0402013-09-14 23:37:01 +0000525If you have an Intel chipset with an ICH2 or later southbridge and if you want
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000526to set specific IDSEL values for a non-default flash chip or an embedded
527controller (EC), you can use the
528.sp
529.B " flashrom \-p internal:fwh_idsel=value"
530.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000531syntax where
532.B value
533is the 48-bit hexadecimal raw value to be written in the
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000534IDSEL registers of the Intel southbridge. The upper 32 bits use one hex digit
535each per 512 kB range between 0xffc00000 and 0xffffffff, and the lower 16 bits
536use one hex digit each per 1024 kB range between 0xff400000 and 0xff7fffff.
537The rightmost hex digit corresponds with the lowest address range. All address
538ranges have a corresponding sister range 4 MB below with identical IDSEL
539settings. The default value for ICH7 is given in the example below.
540.sp
541Example:
542.B "flashrom \-p internal:fwh_idsel=0x001122334567"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000543.TP
544.B Laptops
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000545.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000546Using flashrom on laptops is dangerous and may easily make your hardware
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000547unusable (see also the
548.B BUGS
549section). The embedded controller (EC) in these
550machines often interacts badly with flashing.
Stefan Tauner4c723152016-01-14 22:47:55 +0000551More information is
552.URLB https://flashrom.org/Laptops "in the wiki" .
553For example the EC firmware sometimes resides on the same
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000554flash chip as the host firmware. While flashrom tries to change the contents of
555that memory the EC might need to fetch new instructions or data from it and
556could stop working correctly. Probing for and reading from the chip may also
557irritate your EC and cause fan failure, backlight failure, sudden poweroff, and
558other nasty effects. flashrom will attempt to detect if it is running on a
559laptop and abort immediately for safety reasons if it clearly identifies the
560host computer as one. If you want to proceed anyway at your own risk, use
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000561.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000562.B " flashrom \-p internal:laptop=force_I_want_a_brick"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000563.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000564We will not help you if you force flashing on a laptop because this is a really
565dumb idea.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000566.sp
567You have been warned.
568.sp
569Currently we rely on the chassis type encoded in the DMI/SMBIOS data to detect
570laptops. Some vendors did not implement those bits correctly or set them to
571generic and/or dummy values. flashrom will then issue a warning and bail out
572like above. In this case you can use
573.sp
574.B " flashrom \-p internal:laptop=this_is_not_a_laptop"
575.sp
Stefan Tauner6697f712014-08-06 15:09:15 +0000576to tell flashrom (at your own risk) that it is not running on a laptop.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000577.SS
Michael Karchere5eafb22010-03-07 12:11:08 +0000578.BR "dummy " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000579.IP
580The dummy programmer operates on a buffer in memory only. It provides a safe and fast way to test various
581aspects of flashrom and is mainly used in development and while debugging.
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000582It is able to emulate some chips to a certain degree (basic
583identify/read/erase/write operations work).
584.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000585An optional parameter specifies the bus types it
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000586should support. For that you have to use the
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000587.sp
588.B " flashrom \-p dummy:bus=[type[+type[+type]]]"
589.sp
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000590syntax where
591.B type
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000592can be
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000593.BR parallel ", " lpc ", " fwh ", " spi
594in any order. If you specify bus without type, all buses will be disabled.
595If you do not specify bus, all buses will be enabled.
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000596.sp
597Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000598.B "flashrom \-p dummy:bus=lpc+fwh"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000599.sp
600The dummy programmer supports flash chip emulation for automated self-tests
601without hardware access. If you want to emulate a flash chip, use the
602.sp
603.B " flashrom \-p dummy:emulate=chip"
604.sp
605syntax where
606.B chip
607is one of the following chips (please specify only the chip name, not the
608vendor):
609.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000610.RB "* ST " M25P10.RES " SPI flash chip (128 kB, RES, page write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000611.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000612.RB "* SST " SST25VF040.REMS " SPI flash chip (512 kB, REMS, byte write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000613.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000614.RB "* SST " SST25VF032B " SPI flash chip (4096 kB, RDID, AAI write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000615.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000616.RB "* Macronix " MX25L6436 " SPI flash chip (8192 kB, RDID, SFDP)"
Stefan Tauner0b9df972012-05-07 22:12:16 +0000617.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000618Example:
619.B "flashrom -p dummy:emulate=SST25VF040.REMS"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000620.TP
621.B Persistent images
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000622.sp
623If you use flash chip emulation, flash image persistence is available as well
624by using the
625.sp
626.B " flashrom \-p dummy:emulate=chip,image=image.rom"
627.sp
628syntax where
629.B image.rom
630is the file where the simulated chip contents are read on flashrom startup and
631where the chip contents on flashrom shutdown are written to.
632.sp
633Example:
634.B "flashrom -p dummy:emulate=M25P10.RES,image=dummy.bin"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000635.TP
636.B SPI write chunk size
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000637.sp
638If you use SPI flash chip emulation for a chip which supports SPI page write
639with the default opcode, you can set the maximum allowed write chunk size with
640the
641.sp
642.B " flashrom \-p dummy:emulate=chip,spi_write_256_chunksize=size"
643.sp
644syntax where
645.B size
Stefan Taunereb582572012-09-21 12:52:50 +0000646is the number of bytes (min.\& 1, max.\& 256).
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000647.sp
648Example:
649.sp
650.B " flashrom -p dummy:emulate=M25P10.RES,spi_write_256_chunksize=5"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000651.TP
652.B SPI blacklist
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000653.sp
654To simulate a programmer which refuses to send certain SPI commands to the
655flash chip, you can specify a blacklist of SPI commands with the
656.sp
657.B " flashrom -p dummy:spi_blacklist=commandlist"
658.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000659syntax where
660.B commandlist
661is a list of two-digit hexadecimal representations of
Stefan Taunereb582572012-09-21 12:52:50 +0000662SPI commands. If commandlist is e.g.\& 0302, flashrom will behave as if the SPI
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000663controller refuses to run command 0x03 (READ) and command 0x02 (WRITE).
664commandlist may be up to 512 characters (256 commands) long.
665Implementation note: flashrom will detect an error during command execution.
666.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000667.TP
668.B SPI ignorelist
669.sp
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000670To simulate a flash chip which ignores (doesn't support) certain SPI commands,
671you can specify an ignorelist of SPI commands with the
672.sp
673.B " flashrom -p dummy:spi_ignorelist=commandlist"
674.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000675syntax where
676.B commandlist
677is a list of two-digit hexadecimal representations of
Stefan Taunereb582572012-09-21 12:52:50 +0000678SPI commands. If commandlist is e.g.\& 0302, the emulated flash chip will ignore
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000679command 0x03 (READ) and command 0x02 (WRITE). commandlist may be up to 512
680characters (256 commands) long.
681Implementation note: flashrom won't detect an error during command execution.
Stefan Tauner5e695ab2012-05-06 17:03:40 +0000682.sp
683.TP
684.B SPI status register
685.sp
686You can specify the initial content of the chip's status register with the
687.sp
688.B " flashrom -p dummy:spi_status=content"
689.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000690syntax where
691.B content
692is an 8-bit hexadecimal value.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000693.SS
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000694.BR "nic3com" , " nicrealtek" , " nicnatsemi" , " nicintel", " nicintel_eeprom"\
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000695, " nicintel_spi" , " gfxnvidia" , " ogp_spi" , " drkaiser" , " satasii"\
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000696, " satamv" , " atahpt", " atavia ", " atapromise " and " it8212 " programmers
Stefan Tauner4c723152016-01-14 22:47:55 +0000697.IP
Michael Karchere5eafb22010-03-07 12:11:08 +0000698These programmers have an option to specify the PCI address of the card
699your want to use, which must be specified if more than one card supported
700by the selected programmer is installed in your system. The syntax is
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000701.sp
702.BR " flashrom \-p xxxx:pci=bb:dd.f" ,
703.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000704where
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000705.B xxxx
Stefan Taunerc2eec2c2014-05-03 21:33:01 +0000706is the name of the programmer,
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000707.B bb
708is the PCI bus number,
709.B dd
710is the PCI device number, and
711.B f
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000712is the PCI function number of the desired device.
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000713.sp
714Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000715.B "flashrom \-p nic3com:pci=05:04.0"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000716.SS
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000717.BR "atavia " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000718.IP
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000719Due to the mysterious address handling of the VIA VT6421A controller the user can specify an offset with the
720.sp
721.B " flashrom \-p atavia:offset=addr"
722.sp
723syntax where
724.B addr
725will be interpreted as usual (leading 0x (0) for hexadecimal (octal) values, or else decimal).
726For more information please see
Stefan Tauner4c723152016-01-14 22:47:55 +0000727.URLB https://flashrom.org/VT6421A "its wiki page" .
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000728.SS
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000729.BR "atapromise " programmer
730.IP
731This programmer is currently limited to 32 kB, regardless of the actual size of the flash chip. This stems
732from the fact that, on the tested device (a Promise Ultra100), not all of the chip's address lines were
733actually connected. You may use this programmer to flash firmware updates, since these are only 16 kB in
734size (padding to 32 kB is required).
735.SS
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000736.BR "nicintel_eeprom " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000737.IP
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000738This is the first programmer module in flashrom that does not provide access to NOR flash chips but EEPROMs
739mounted on gigabit Ethernet cards based on Intel's 82580 NIC. Because EEPROMs normally do not announce their
Stefan Tauner0be072c2016-03-13 15:16:30 +0000740size nor allow themselves to be identified, the controller relies on correct size values written to predefined
741addresses within the chip. Flashrom follows this scheme but assumes the minimum size of 16 kB (128 kb) if an
742unprogrammed EEPROM/card is detected. Intel specifies following EEPROMs to be compatible:
743Atmel AT25128, AT25256, Micron (ST) M95128, M95256 and OnSemi (Catalyst) CAT25CS128.
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000744.SS
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000745.BR "ft2232_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000746.IP
Stefan Tauner0be072c2016-03-13 15:16:30 +0000747This module supports various programmers based on FTDI FT2232/FT4232H/FT232H chips including the DLP Design
748DLP-USB1232H, openbiosprog-spi, Amontec JTAGkey/JTAGkey-tiny/JTAGkey-2, Dangerous Prototypes Bus Blaster,
749Olimex ARM-USB-TINY/-H, Olimex ARM-USB-OCD/-H, OpenMoko Neo1973 Debug board (V2+), TIAO/DIYGADGET USB
750Multi-Protocol Adapter (TUMPA), TUMPA Lite, GOEPEL PicoTAP and Google Servo v1/v2.
751.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000752An optional parameter specifies the controller
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300753type, channel/interface/port and GPIO-based chip select it should support. For that you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000754.sp
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300755.B " flashrom \-p ft2232_spi:type=model,port=interface,csgpiol=gpio"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000756.sp
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000757syntax where
758.B model
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000759can be
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000760.BR 2232H ", " 4232H ", " 232H ", " jtagkey ", " busblaster ", " openmoko ", " \
Uwe Hermann836b26a2011-10-14 20:33:14 +0000761arm-usb-tiny ", " arm-usb-tiny-h ", " arm-usb-ocd ", " arm-usb-ocd-h \
Todd Broch6800c952016-02-14 15:46:00 +0000762", " tumpa ", " tumpalite ", " picotap ", " google-servo ", " google-servo-v2 \
763" or " google-servo-v2-legacy
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000764.B interface
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000765can be
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300766.BR A ", " B ", " C ", or " D
767and
768.B csgpiol
769can be a number between 0 and 3, denoting GPIOL0-GPIOL3 correspondingly.
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000770The default model is
771.B 4232H
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300772the default interface is
773.BR A
774and GPIO is not used by default.
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000775.sp
Shik Chen14fbc4b2012-09-17 00:40:54 +0000776If there is more than one ft2232_spi-compatible device connected, you can select which one should be used by
777specifying its serial number with the
778.sp
779.B " flashrom \-p ft2232_spi:serial=number"
780.sp
781syntax where
782.B number
783is the serial number of the device (which can be found for example in the output of lsusb -v).
784.sp
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000785All 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 +0000786expressible divisors are all
787.B even
788numbers between 2 and 2^17 (=131072) resulting in SPI clock frequencies of
Samir Ibradžićb482c6d2012-05-15 22:58:19 +00007896 MHz down to about 92 Hz for 12 MHz inputs. The default divisor is set to 2, but you can use another one by
790specifying the optional
791.B divisor
792parameter with the
793.sp
794.B " flashrom \-p ft2232_spi:divisor=div"
795.sp
796syntax.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000797.SS
Michael Karchere5eafb22010-03-07 12:11:08 +0000798.BR "serprog " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000799.IP
Stefan Tauner0be072c2016-03-13 15:16:30 +0000800This module supports all programmers speaking the serprog protocol. This includes some Arduino-based devices
801as well as various programmers by Urja Rannikko, Juhana Helovuo, Stefan Tauner, Chi Zhang and many others.
802.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000803A mandatory parameter specifies either a serial device (and baud rate) or an IP/port combination for
804communicating with the programmer.
805The device/baud combination has to start with
806.B dev=
807and separate the optional baud rate with a colon.
808For example
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000809.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000810.B " flashrom \-p serprog:dev=/dev/ttyS0:115200"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000811.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000812If no baud rate is given the default values by the operating system/hardware will be used.
813For IP connections you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000814.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000815.B " flashrom \-p serprog:ip=ipaddr:port"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000816.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000817syntax.
818In case the device supports it, you can set the SPI clock frequency with the optional
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000819.B spispeed
Stefan Tauner0554ca52013-07-25 22:54:25 +0000820parameter. The frequency is parsed as hertz, unless an
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000821.BR M ", or " k
822suffix is given, then megahertz or kilohertz are used respectively.
823Example that sets the frequency to 2 MHz:
824.sp
Stefan Tauner0554ca52013-07-25 22:54:25 +0000825.B " flashrom \-p serprog:dev=/dev/device:baud,spispeed=2M"
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000826.sp
827More information about serprog is available in
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000828.B serprog-protocol.txt
829in the source distribution.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000830.SS
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000831.BR "buspirate_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000832.IP
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000833A required
834.B dev
835parameter specifies the Bus Pirate device node and an optional
836.B spispeed
837parameter specifies the frequency of the SPI bus. The parameter
Michael Karchere5eafb22010-03-07 12:11:08 +0000838delimiter is a comma. Syntax is
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000839.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000840.B " flashrom \-p buspirate_spi:dev=/dev/device,spispeed=frequency"
Michael Karchere5eafb22010-03-07 12:11:08 +0000841.sp
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000842where
843.B frequency
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000844can be
845.BR 30k ", " 125k ", " 250k ", " 1M ", " 2M ", " 2.6M ", " 4M " or " 8M
Michael Karchere5eafb22010-03-07 12:11:08 +0000846(in Hz). The default is the maximum frequency of 8 MHz.
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000847.sp
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600848The baud rate for communication between the host and the Bus Pirate can be specified with the optional
849.B serialspeed
850parameter. Syntax is
851.sp
852.B " flashrom -p buspirate_spi:serialspeed=baud
853.sp
854where
855.B baud
856can be
857.BR 115200 ", " 230400 ", " 250000 " or " 2000000 " (" 2M ")."
858The default is 2M baud for Bus Pirate hardware version 3.0 and greater, and 115200 otherwise.
859.sp
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000860An optional pullups parameter specifies the use of the Bus Pirate internal pull-up resistors. This may be
861needed if you are working with a flash ROM chip that you have physically removed from the board. Syntax is
862.sp
863.B " flashrom -p buspirate_spi:pullups=state"
864.sp
865where
866.B state
867can be
868.BR on " or " off .
Stefan Tauner4c723152016-01-14 22:47:55 +0000869More information about the Bus Pirate pull-up resistors and their purpose is available
870.URLB "http://dangerousprototypes.com/docs/Practical_guide_to_Bus_Pirate_pull-up_resistors" \
871"in a guide by dangerousprototypes" .
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000872Only the external supply voltage (Vpu) is supported as of this writing.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000873.SS
Justin Chevrier66e554b2015-02-08 21:58:10 +0000874.BR "pickit2_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000875.IP
Justin Chevrier66e554b2015-02-08 21:58:10 +0000876An optional
877.B voltage
878parameter specifies the voltage the PICkit2 should use. The default unit is Volt if no unit is specified.
879You can use
880.BR mV ", " millivolt ", " V " or " Volt
881as unit specifier. Syntax is
882.sp
883.B " flashrom \-p pickit2_spi:voltage=value"
884.sp
885where
886.B value
887can be
888.BR 0V ", " 1.8V ", " 2.5V ", " 3.5V
889or the equivalent in mV.
890.sp
891An optional
892.B spispeed
893parameter specifies the frequency of the SPI bus. Syntax is
894.sp
895.B " flashrom \-p pickit2_spi:spispeed=frequency"
896.sp
897where
898.B frequency
899can be
900.BR 250k ", " 333k ", " 500k " or " 1M "
901(in Hz). The default is a frequency of 1 MHz.
902.SS
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000903.BR "dediprog " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000904.IP
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000905An optional
906.B voltage
907parameter specifies the voltage the Dediprog should use. The default unit is
908Volt if no unit is specified. You can use
909.BR mV ", " milliVolt ", " V " or " Volt
910as unit specifier. Syntax is
911.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000912.B " flashrom \-p dediprog:voltage=value"
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000913.sp
914where
915.B value
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000916can be
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000917.BR 0V ", " 1.8V ", " 2.5V ", " 3.5V
918or the equivalent in mV.
Nathan Laredo21541a62012-12-24 22:07:36 +0000919.sp
920An optional
921.B device
922parameter specifies which of multiple connected Dediprog devices should be used.
923Please be aware that the order depends on libusb's usb_get_busses() function and that the numbering starts
924at 0.
925Usage example to select the second device:
926.sp
927.B " flashrom \-p dediprog:device=1"
Nico Huber77fa67d2013-02-20 18:03:36 +0000928.sp
929An optional
930.B spispeed
Patrick Georgiefe2d432013-05-23 21:47:46 +0000931parameter specifies the frequency of the SPI bus. The firmware on the device needs to be 5.0.0 or newer.
932Syntax is
Nico Huber77fa67d2013-02-20 18:03:36 +0000933.sp
934.B " flashrom \-p dediprog:spispeed=frequency"
935.sp
936where
937.B frequency
938can be
939.BR 375k ", " 750k ", " 1.5M ", " 2.18M ", " 3M ", " 8M ", " 12M " or " 24M
940(in Hz). The default is a frequency of 12 MHz.
Stefan Taunere659d2d2013-05-03 21:58:28 +0000941.sp
942An optional
943.B target
944parameter specifies which target chip should be used. Syntax is
945.sp
946.B " flashrom \-p dediprog:target=value"
947.sp
948where
949.B value
950can be
951.BR 1 " or " 2
Stefan Tauner6697f712014-08-06 15:09:15 +0000952to select target chip 1 or 2 respectively. The default is target chip 1.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000953.SS
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000954.BR "rayer_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000955.IP
Carl-Daniel Hailfinger37c42522010-10-05 19:19:48 +0000956The default I/O base address used for the parallel port is 0x378 and you can use
957the optional
958.B iobase
959parameter to specify an alternate base I/O address with the
960.sp
961.B " flashrom \-p rayer_spi:iobase=baseaddr"
962.sp
963syntax where
964.B baseaddr
965is base I/O port address of the parallel port, which must be a multiple of
966four. Make sure to not forget the "0x" prefix for hexadecimal port addresses.
967.sp
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000968The default cable type is the RayeR cable. You can use the optional
969.B type
970parameter to specify the cable type with the
971.sp
972.B " flashrom \-p rayer_spi:type=model"
973.sp
974syntax where
975.B model
976can be
Maksim Kuleshov4dab5c12013-10-02 01:22:02 +0000977.BR rayer " for the RayeR cable, " byteblastermv " for the Altera ByteBlasterMV, " stk200 " for the Atmel \
Stefan Taunerfdb16592016-02-28 17:04:38 +0000978STK200/300, " wiggler " for the Macraigor Wiggler, " xilinx " for the Xilinx Parallel Cable III (DLC 5), or" \
979" spi_tt" " for SPI Tiny Tools-compatible hardware.
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000980.sp
981More information about the RayeR hardware is available at
Stefan Tauner23e10b82016-01-23 16:16:49 +0000982.nh
Stefan Tauner4c723152016-01-14 22:47:55 +0000983.URLB "http://rayer.g6.cz/elektro/spipgm.htm" "RayeR's website" .
Maksim Kuleshov3647b2d2013-10-02 01:21:57 +0000984The Altera ByteBlasterMV datasheet can be obtained from
Stefan Tauner4c723152016-01-14 22:47:55 +0000985.URLB "http://www.altera.co.jp/literature/ds/dsbytemv.pdf" Altera .
Maksim Kuleshovacba2ac2013-10-02 01:22:11 +0000986For more information about the Macraigor Wiggler see
Stefan Tauner4c723152016-01-14 22:47:55 +0000987.URLB "http://www.macraigor.com/wiggler.htm" "their company homepage" .
Kyösti Mälkki8b1bdf12013-10-02 01:21:45 +0000988The schematic of the Xilinx DLC 5 was published in
Stefan Tauner4c723152016-01-14 22:47:55 +0000989.URLB "http://www.xilinx.com/support/documentation/user_guides/xtp029.pdf" "a Xilinx user guide" .
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000990.SS
Michael Karchere5449392012-05-05 20:53:59 +0000991.BR "pony_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000992.IP
Michael Karchere5449392012-05-05 20:53:59 +0000993The serial port (like /dev/ttyS0, /dev/ttyUSB0 on Linux or COM3 on windows) is
994specified using the mandatory
Stefan Taunere34e3e82013-01-01 00:06:51 +0000995.B dev
Michael Karchere5449392012-05-05 20:53:59 +0000996parameter. The adapter type is selectable between SI-Prog (used for
997SPI devices with PonyProg 2000) or a custom made serial bitbanging programmer
998named "serbang". The optional
Stefan Taunere34e3e82013-01-01 00:06:51 +0000999.B type
Michael Karchere5449392012-05-05 20:53:59 +00001000parameter accepts the values "si_prog" (default) or "serbang".
1001.sp
1002Information about the SI-Prog adapter can be found at
Stefan Tauner4c723152016-01-14 22:47:55 +00001003.URLB "http://www.lancos.com/siprogsch.html" "its website" .
Michael Karchere5449392012-05-05 20:53:59 +00001004.sp
1005An example call to flashrom is
1006.sp
1007.B " flashrom \-p pony_spi:dev=/dev/ttyS0,type=serbang"
1008.sp
1009Please note that while USB-to-serial adapters work under certain circumstances,
1010this slows down operation considerably.
1011.SS
Mark Marshall90021f22010-12-03 14:48:11 +00001012.BR "ogp_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001013.IP
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001014The flash ROM chip to access must be specified with the
Mark Marshall90021f22010-12-03 14:48:11 +00001015.B rom
1016parameter.
1017.sp
1018.B " flashrom \-p ogp_spi:rom=name"
1019.sp
1020Where
1021.B name
1022is either
1023.B cprom
1024or
1025.B s3
Stefan Taunere34e3e82013-01-01 00:06:51 +00001026for the configuration ROM and
Mark Marshall90021f22010-12-03 14:48:11 +00001027.B bprom
1028or
1029.B bios
Uwe Hermann68b9cca2011-06-15 23:44:52 +00001030for the BIOS ROM. If more than one card supported by the ogp_spi programmer
Mark Marshall90021f22010-12-03 14:48:11 +00001031is installed in your system, you have to specify the PCI address of the card
1032you want to use with the
1033.B pci=
1034parameter as explained in the
Stefan Taunere34e3e82013-01-01 00:06:51 +00001035.B nic3com et al.\&
Mark Marshall90021f22010-12-03 14:48:11 +00001036section above.
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001037.SS
David Hendricksf9a30552015-05-23 20:30:30 -07001038.BR "linux_mtd " programmer
1039.IP
1040You may specify the MTD device to use with the
1041.sp
1042.B " flashrom \-p linux_mtd:dev=/dev/mtdX"
1043.sp
1044syntax where
1045.B /dev/mtdX
1046is the Linux device node for your MTD device. If left unspecified the first MTD
1047device found (e.g. /dev/mtd0) will be used by default.
1048.sp
1049Please note that the linux_mtd driver only works on Linux.
1050.SS
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001051.BR "linux_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001052.IP
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001053You have to specify the SPI controller to use with the
1054.sp
1055.B " flashrom \-p linux_spi:dev=/dev/spidevX.Y"
1056.sp
1057syntax where
1058.B /dev/spidevX.Y
1059is the Linux device node for your SPI controller.
1060.sp
Stefan Tauner0554ca52013-07-25 22:54:25 +00001061In case the device supports it, you can set the SPI clock frequency with the optional
1062.B spispeed
1063parameter. The frequency is parsed as kilohertz.
1064Example that sets the frequency to 8 MHz:
1065.sp
1066.B " flashrom \-p linux_spi:dev=/dev/spidevX.Y,spispeed=8000"
1067.sp
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001068Please note that the linux_spi driver only works on Linux.
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001069.SS
1070.BR "mstarddc_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001071.IP
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001072The Display Data Channel (DDC) is an I2C bus present on VGA and DVI connectors, that allows exchanging
Stefan Tauner0be072c2016-03-13 15:16:30 +00001073information between a computer and attached displays. Its most common uses are getting display capabilities
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001074through EDID (at I2C address 0x50) and sending commands to the display using the DDC/CI protocol (at address
10750x37). On displays driven by MSTAR SoCs, it is also possible to access the SoC firmware flash (connected to
1076the Soc through another SPI bus) using an In-System Programming (ISP) port, usually at address 0x49.
1077This flashrom module allows the latter via Linux's I2C driver.
1078.sp
1079.B IMPORTANT:
1080Before using this programmer, the display
1081.B MUST
1082be in standby mode, and only connected to the computer that will run flashrom using a VGA cable, to an
1083inactive VGA output. It absolutely
1084.B MUST NOT
1085be used as a display during the procedure!
1086.sp
1087You have to specify the DDC/I2C controller and I2C address to use with the
1088.sp
1089.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-X:YY"
1090.sp
1091syntax where
1092.B /dev/i2c-X
1093is the Linux device node for your I2C controller connected to the display's DDC channel, and
1094.B YY
1095is the (hexadecimal) address of the MSTAR ISP port (address 0x49 is usually used).
1096Example that uses I2C controller /dev/i2c-1 and address 0x49:
1097.sp
1098.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-1:49
1099.sp
1100It is also possible to inhibit the reset command that is normally sent to the display once the flashrom
1101operation is completed using the optional
1102.B noreset
1103parameter. A value of 1 prevents flashrom from sending the reset command.
1104Example that does not reset the display at the end of the operation:
1105.sp
1106.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-1:49,noreset=1
1107.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +00001108Please note that sending the reset command is also inhibited if an error occurred during the operation.
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001109To send the reset command afterwards, you can simply run flashrom once more, in chip probe mode (not specifying
1110an operation), without the
1111.B noreset
1112parameter, once the flash read/write operation you intended to perform has completed successfully.
1113.sp
1114Please also note that the mstarddc_spi driver only works on Linux.
Urja Rannikko0870b022016-01-31 22:10:29 +00001115.SS
1116.BR "ch341a_spi " programmer
1117The WCH CH341A programmer does not support any parameters currently. SPI frequency is fixed at 2 MHz, and CS0 is
1118used as per the device.
Lubomir Rintelb2154e82018-01-14 17:35:33 +01001119.SS
1120.BR "digilent_spi " programmer
1121.IP
1122An optional
1123.B spispeed
1124parameter specifies the frequency of the SPI bus.
1125Syntax is
1126.sp
1127.B " flashrom \-p digilent_spi:spispeed=frequency"
1128.sp
1129where
1130.B frequency
1131can be
1132.BR 62.5k ", " 125k ", " 250k ", " 500k ", " 1M ", " 2M " or " 4M
1133(in Hz). The default is a frequency of 4 MHz.
1134.sp
1135.SS
Marc Schink3578ec62016-03-17 16:23:03 +01001136.BR "jlink_spi " programmer
1137.IP
1138This module supports SEGGER J-Link and compatible devices.
1139
1140The \fBMOSI\fP signal of the flash chip must be attached to \fBTDI\fP pin of
1141the programmer, \fBMISO\fP to \fBTDO\fP and \fBSCK\fP to \fBTCK\fP.
1142The chip select (\fBCS\fP) signal of the flash chip can be attached to
1143different pins of the programmer which can be selected with the
1144.sp
1145.B " flashrom \-p jlink_spi:cs=pin"
1146.sp
1147syntax where \fBpin\fP can be either \fBTRST\fP or \fBRESET\fP.
1148The default pin for chip select is \fBRESET\fP.
1149Note that, when using \fBRESET\fP, it is normal that the indicator LED blinks
1150orange or red.
1151.br
1152Additionally, the \fBVTref\fP pin of the programmer must be attached to the
1153logic level of the flash chip.
1154The programmer measures the voltage on this pin and generates the reference
1155voltage for its input comparators and adapts its output voltages to it.
1156.sp
1157Pinout for devices with 20-pin JTAG connector:
1158.sp
1159 +-------+
1160 | 1 2 | 1: VTref 2:
1161 | 3 4 | 3: TRST 4: GND
1162 | 5 6 | 5: TDI 6: GND
1163 +-+ 7 8 | 7: 8: GND
1164 | 9 10 | 9: TCK 10: GND
1165 | 11 12 | 11: 12: GND
1166 +-+ 13 14 | 13: TDO 14:
1167 | 15 16 | 15: RESET 16:
1168 | 17 18 | 17: 18:
1169 | 19 20 | 19: PWR_5V 20:
1170 +-------+
1171.sp
1172If there is more than one compatible device connected, you can select which one
1173should be used by specifying its serial number with the
1174.sp
1175.B " flashrom \-p jlink_spi:serial=number"
1176.sp
1177syntax where
1178.B number
1179is the serial number of the device (which can be found for example in the
1180output of lsusb -v).
1181.sp
1182The SPI speed can be selected by using the
1183.sp
1184.B " flashrom \-p jlink_spi:spispeed=frequency"
1185.sp
1186syntax where \fBfrequency\fP is the SPI clock frequency in kHz.
1187The maximum speed depends on the device in use.
1188.SS
1189
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +00001190.SH EXAMPLES
1191To back up and update your BIOS, run
1192.sp
1193.B flashrom -p internal -r backup.rom -o backuplog.txt
1194.br
1195.B flashrom -p internal -w newbios.rom -o writelog.txt
1196.sp
1197Please make sure to copy backup.rom to some external media before you try
1198to write. That makes offline recovery easier.
1199.br
1200If writing fails and flashrom complains about the chip being in an unknown
1201state, you can try to restore the backup by running
1202.sp
1203.B flashrom -p internal -w backup.rom -o restorelog.txt
1204.sp
1205If you encounter any problems, please contact us and supply
1206backuplog.txt, writelog.txt and restorelog.txt. See section
1207.B BUGS
1208for contact info.
Peter Stuge42688e52009-01-26 02:20:56 +00001209.SH EXIT STATUS
Niklas Söderlund2d8b7ef2013-09-13 19:19:25 +00001210flashrom 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 +00001211.SH REQUIREMENTS
1212flashrom needs different access permissions for different programmers.
1213.sp
1214.B internal
1215needs raw memory access, PCI configuration space access, raw I/O port
1216access (x86) and MSR access (x86).
1217.sp
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +00001218.B atavia
1219needs PCI configuration space access.
1220.sp
Sergey Lichack98f47102012-08-27 01:24:15 +00001221.BR nic3com ", " nicrealtek " and " nicnatsemi "
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001222need PCI configuration space read access and raw I/O port access.
1223.sp
1224.B atahpt
1225needs PCI configuration space access and raw I/O port access.
1226.sp
Kyösti Mälkki72d42f82014-06-01 23:48:31 +00001227.BR gfxnvidia ", " drkaiser " and " it8212
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001228need PCI configuration space access and raw memory access.
1229.sp
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +00001230.B rayer_spi
1231needs raw I/O port access.
1232.sp
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +00001233.BR satasii ", " nicintel ", " nicintel_eeprom " and " nicintel_spi
1234need PCI configuration space read access and raw memory access.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001235.sp
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +00001236.BR satamv " and " atapromise
1237need PCI configuration space read access, raw I/O port access and raw memory
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +00001238access.
1239.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001240.B serprog
1241needs TCP access to the network or userspace access to a serial port.
1242.sp
1243.B buspirate_spi
1244needs userspace access to a serial port.
1245.sp
Nico Huberd99a2bd2016-02-18 21:42:49 +00001246.BR ft2232_spi ", " usbblaster_spi " and " pickit2_spi
Stefan Taunere49edbb2016-01-31 22:10:14 +00001247need access to the respective USB device via libusb API version 0.1.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001248.sp
Nico Huberd99a2bd2016-02-18 21:42:49 +00001249.BR ch341a_spi " and " dediprog
1250need access to the respective USB device via libusb API version 1.0.
Urja Rannikko0870b022016-01-31 22:10:29 +00001251.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001252.B dummy
1253needs no access permissions at all.
1254.sp
Sergey Lichack98f47102012-08-27 01:24:15 +00001255.BR internal ", " nic3com ", " nicrealtek ", " nicnatsemi ", "
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +00001256.BR gfxnvidia ", " drkaiser ", " satasii ", " satamv ", " atahpt ", " atavia " and " atapromise
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001257have to be run as superuser/root, and need additional raw access permission.
1258.sp
Lubomir Rintelb2154e82018-01-14 17:35:33 +01001259.BR serprog ", " buspirate_spi ", " dediprog ", " usbblaster_spi ", " ft2232_spi ", " pickit2_spi ", " \
1260ch341a_spi " and " digilent_spi
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001261can be run as normal user on most operating systems if appropriate device
1262permissions are set.
1263.sp
Mark Marshall90021f22010-12-03 14:48:11 +00001264.B ogp
1265needs PCI configuration space read access and raw memory access.
1266.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001267On OpenBSD, you can obtain raw access permission by setting
Uwe Hermann941a2732011-07-25 21:12:57 +00001268.B "securelevel=-1"
1269in
1270.B "/etc/rc.securelevel"
1271and rebooting, or rebooting into single user mode.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001272.SH BUGS
Stefan Tauner4c723152016-01-14 22:47:55 +00001273Please report any bugs to the
1274.MTOB "flashrom@flashrom.org" "flashrom mailing list" .
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001275.sp
1276We recommend to subscribe first at
Stefan Tauner4c723152016-01-14 22:47:55 +00001277.URLB "https://flashrom.org/mailman/listinfo/flashrom" "" .
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +00001278.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001279Many of the developers communicate via the
1280.B "#flashrom"
1281IRC channel on
1282.BR chat.freenode.net .
Stefan Tauner4c723152016-01-14 22:47:55 +00001283If you don't have an IRC client, you can use the
1284.URLB http://webchat.freenode.net/?channels=flashrom "freenode webchat" .
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001285You are welcome to join and ask questions, send us bug and success reports there
Stefan Taunereb582572012-09-21 12:52:50 +00001286too. Please provide a way to contact you later (e.g.\& a mail address) and be
Stefan Tauner4c723152016-01-14 22:47:55 +00001287patient if there is no immediate reaction. Also, we provide a
1288.URLB https://paste.flashrom.org "pastebin service"
Stefan Taunereb582572012-09-21 12:52:50 +00001289that is very useful when you want to share logs etc.\& without spamming the
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001290channel.
1291.SS
1292.B Laptops
1293.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +00001294Using flashrom on laptops is dangerous and may easily make your hardware
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001295unusable. flashrom will attempt to detect if it is running on a laptop and abort
1296immediately for safety reasons. Please see the detailed discussion of this topic
1297and associated flashrom options in the
1298.B Laptops
1299paragraph in the
1300.B internal programmer
1301subsection of the
Stefan Tauner6697f712014-08-06 15:09:15 +00001302.B PROGRAMMER-SPECIFIC INFORMATION
Stefan Tauner4c723152016-01-14 22:47:55 +00001303section and the information
1304.URLB "https://flashrom.org/Laptops" "in our wiki" .
Daniel Lenski65922a32012-02-15 23:40:23 +00001305.SS
1306One-time programmable (OTP) memory and unique IDs
1307.sp
1308Some flash chips contain OTP memory often denoted as "security registers".
1309They usually have a capacity in the range of some bytes to a few hundred
Stefan Taunereb582572012-09-21 12:52:50 +00001310bytes and can be used to give devices unique IDs etc. flashrom is not able
Daniel Lenski65922a32012-02-15 23:40:23 +00001311to read or write these memories and may therefore not be able to duplicate a
1312chip completely. For chip types known to include OTP memories a warning is
1313printed when they are detected.
1314.sp
1315Similar to OTP memories are unique, factory programmed, unforgeable IDs.
1316They are not modifiable by the user at all.
Stefan Taunerac54fbe2011-07-21 19:52:00 +00001317.SH LICENSE
Stefan Reinauer261144c2006-07-27 23:29:02 +00001318.B flashrom
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001319is covered by the GNU General Public License (GPL), version 2. Some files are
Stefan Tauner23e10b82016-01-23 16:16:49 +00001320additionally available under any later version of the GPL.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001321.SH COPYRIGHT
Stefan Reinauer261144c2006-07-27 23:29:02 +00001322.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001323Please see the individual files.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001324.SH AUTHORS
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001325Andrew Morgan
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001326.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001327Carl-Daniel Hailfinger
1328.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001329Claus Gindhart
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001330.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001331David Borg
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001332.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001333David Hendricks
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001334.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001335Dominik Geyer
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001336.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001337Eric Biederman
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001338.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001339Giampiero Giancipoli
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001340.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001341Helge Wagner
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001342.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001343Idwer Vollering
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001344.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001345Joe Bao
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001346.br
Stefan Taunerc0aaf952011-05-19 02:58:17 +00001347Joerg Fischer
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001348.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001349Joshua Roys
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001350.br
Stefan Tauner5c316f92015-02-08 21:57:52 +00001351Ky\[:o]sti M\[:a]lkki
1352.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001353Luc Verhaegen
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001354.br
Carl-Daniel Hailfinger451dc802009-05-01 11:00:39 +00001355Li-Ta Lo
1356.br
Mark Marshall90021f22010-12-03 14:48:11 +00001357Mark Marshall
1358.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001359Markus Boas
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001360.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001361Mattias Mattsson
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001362.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001363Michael Karcher
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001364.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001365Nikolay Petukhov
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001366.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001367Patrick Georgi
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001368.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001369Peter Lemenkov
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001370.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001371Peter Stuge
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001372.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001373Reinder E.N. de Haan
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001374.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001375Ronald G. Minnich
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001376.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001377Ronald Hoogenboom
Stefan Reinauer261144c2006-07-27 23:29:02 +00001378.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001379Sean Nelson
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001380.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001381Stefan Reinauer
Stefan Reinauer261144c2006-07-27 23:29:02 +00001382.br
Uwe Hermann68b9cca2011-06-15 23:44:52 +00001383Stefan Tauner
1384.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001385Stefan Wildemann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001386.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001387Stephan Guilloux
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001388.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001389Steven James
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001390.br
Stefan Tauner23e10b82016-01-23 16:16:49 +00001391Urja Rannikko
1392.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001393Uwe Hermann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001394.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001395Wang Qingpei
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001396.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001397Yinghai Lu
Stefan Reinauerf8337dd2006-08-03 10:49:09 +00001398.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001399some others, please see the flashrom svn changelog for details.
1400.br
Stefan Tauner4c723152016-01-14 22:47:55 +00001401All still active authors can be reached via
1402.MTOB "flashrom@flashrom.org" "the mailing list" .
Stefan Reinauer261144c2006-07-27 23:29:02 +00001403.PP
Stefan Tauner4c723152016-01-14 22:47:55 +00001404This manual page was written by
1405.MTOB "uwe@hermann-uwe.de" "Uwe Hermann" ,
1406Carl-Daniel Hailfinger, Stefan Tauner and others.
Uwe Hermann42eb17f2008-01-18 17:48:51 +00001407It is licensed under the terms of the GNU GPL (version 2 or later).