blob: eb7fdec454ff9c720a75ccc942eea8634904cdbc [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
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +100047.B flashrom \fR[\fB\-h\fR|\fB\-R\fR|\fB\-L\fR|\fB\-z\fR|
48 \fB\-p\fR <programmername>[:<parameters>] [\fB\-c\fR <chipname>]
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +100049 (\fB\-\-flash\-name\fR|\fB\-\-flash\-size\fR|
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +100050 [\fB\-E\fR|\fB\-r\fR <file>|\fB\-w\fR <file>|\fB\-v\fR <file>]
51 [(\fB\-l\fR <file>|\fB\-\-ifd|\fB \-\-fmap\fR|\fB\-\-fmap-file\fR <file>) [\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
Arthur Heymansc82900b2018-01-10 12:48:16 +0100198.B "\-\-fmap"
199Read layout from fmap in flash chip.
200.sp
201flashrom supports the fmap binary format which is commonly used by coreboot
202for partitioning a flash chip. The on-chip fmap will be read and used to generate
203the layout.
204.sp
205If you only want to update the
206.BR "COREBOOT"
207region defined in the fmap, run
208.sp
209.B " flashrom -p prog \-\-fmap \-\-image COREBOOT \-w some.rom"
210.TP
211.B "\-\-fmap-file <file>"
212Read layout from a
213.BR <file>
214containing binary fmap (e.g. coreboot roms).
215.sp
216flashrom supports the fmap binary format which is commonly used by coreboot
217for partitioning a flash chip. The fmap in the specified file will be read and
218used to generate the layout.
219.sp
220If you only want to update the
221.BR "COREBOOT"
222region defined in the binary fmap file, run
223.sp
224.B " flashrom \-p prog \-\-fmap-file some.rom \-\-image COREBOOT \-w some.rom"
225.TP
Nico Huber305f4172013-06-14 11:55:26 +0200226.B "\-\-ifd"
227Read ROM layout from Intel Firmware Descriptor.
228.sp
229flashrom supports ROM layouts given by an Intel Firmware Descriptor
230(IFD). The on-chip descriptor will be read and used to generate the
231layout. If you need to change the layout, you have to update the IFD
232only first.
233.sp
234The following ROM images may be present in an IFD:
235.sp
236 fd the IFD itself
237 bios the host firmware aka. BIOS
238 me Intel Management Engine firmware
239 gbe gigabit ethernet firmware
240 pd platform specific data
241.TP
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000242.B "\-i, \-\-image <imagename>"
243Only flash region/image
244.B <imagename>
Uwe Hermann67808fe2007-10-18 00:29:05 +0000245from flash layout.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000246.TP
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +1000247.B "\-\-flash\-name"
248Prints out the detected flash chips name.
249.TP
Edward O'Callaghan7d6b5262019-09-23 22:53:14 +1000250.B "\-\-flash\-size"
251Prints out the detected flash chips size.
252.TP
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000253.B "\-L, \-\-list\-supported"
Uwe Hermann941a2732011-07-25 21:12:57 +0000254List the flash chips, chipsets, mainboards, and external programmers
255(including PCI, USB, parallel port, and serial port based devices)
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000256supported by flashrom.
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000257.sp
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000258There are many unlisted boards which will work out of the box, without
259special support in flashrom. Please let us know if you can verify that
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000260other boards work or do not work out of the box.
261.sp
262.B IMPORTANT:
263For verification you have
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000264to test an ERASE and/or WRITE operation, so make sure you only do that
265if you have proper means to recover from failure!
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000266.TP
Uwe Hermann20a293f2009-06-19 10:42:43 +0000267.B "\-z, \-\-list\-supported-wiki"
268Same as
269.BR \-\-list\-supported ,
270but outputs the supported hardware in MediaWiki syntax, so that it can be
Stefan Tauner4c723152016-01-14 22:47:55 +0000271easily pasted into the
272.URLB https://flashrom.org/Supported_hardware "supported hardware wiki page" .
Uwe Hermann941a2732011-07-25 21:12:57 +0000273Please note that MediaWiki output is not compiled in by default.
Uwe Hermann20a293f2009-06-19 10:42:43 +0000274.TP
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000275.B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]"
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000276Specify the programmer device. This is mandatory for all operations
277involving any chip access (probe/read/write/...). Currently supported are:
Carl-Daniel Hailfingerce986772009-05-09 00:27:07 +0000278.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +0000279.BR "* internal" " (for in-system flashing in the mainboard)"
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000280.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000281.BR "* dummy" " (virtual programmer for testing flashrom)"
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000282.sp
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000283.BR "* nic3com" " (for flash ROMs on 3COM network cards)"
284.sp
Sergey Lichack98f47102012-08-27 01:24:15 +0000285.BR "* nicrealtek" " (for flash ROMs on Realtek and SMC 1211 network cards)"
Uwe Hermann829ed842010-05-24 17:39:14 +0000286.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000287.BR "* nicnatsemi" " (for flash ROMs on National Semiconductor DP838* network \
288cards)"
289.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000290.BR "* nicintel" " (for parallel flash ROMs on Intel 10/100Mbit network cards)
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000291.sp
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000292.BR "* gfxnvidia" " (for flash ROMs on NVIDIA graphics cards)"
293.sp
TURBO Jb0912c02009-09-02 23:00:46 +0000294.BR "* drkaiser" " (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)"
295.sp
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000296.BR "* satasii" " (for flash ROMs on Silicon Image SATA/IDE controllers)"
297.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000298.BR "* satamv" " (for flash ROMs on Marvell SATA controllers)"
299.sp
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000300.BR "* atahpt" " (for flash ROMs on Highpoint ATA/RAID controllers)"
301.sp
Stefan Tauner4f094752014-06-01 22:36:30 +0000302.BR "* atavia" " (for flash ROMs on VIA VT6421A SATA controllers)"
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000303.sp
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000304.BR "* atapromise" " (for flash ROMs on Promise PDC2026x ATA/RAID controllers)"
305.sp
Kyösti Mälkki72d42f82014-06-01 23:48:31 +0000306.BR "* it8212" " (for flash ROMs on ITE IT8212F ATA/RAID controller)"
307.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +0000308.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 +0000309.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000310.BR "* serprog" " (for flash ROMs attached to a programmer speaking serprog, \
Stefan Tauner0be072c2016-03-13 15:16:30 +0000311including some Arduino-based devices)."
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000312.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000313.BR "* buspirate_spi" " (for SPI flash ROMs attached to a Bus Pirate)"
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000314.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000315.BR "* dediprog" " (for SPI flash ROMs attached to a Dediprog SF100)"
316.sp
Kyösti Mälkki8b1bdf12013-10-02 01:21:45 +0000317.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 +0000318.sp
Michael Karchere5449392012-05-05 20:53:59 +0000319.BR "* pony_spi" " (for SPI flash ROMs attached to a SI-Prog serial port "
320bitbanging adapter)
321.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000322.BR "* nicintel_spi" " (for SPI flash ROMs on Intel Gigabit network cards)"
Idwer Vollering004f4b72010-09-03 18:21:21 +0000323.sp
Uwe Hermann314cfba2011-07-28 19:23:09 +0000324.BR "* ogp_spi" " (for SPI flash ROMs on Open Graphics Project graphics card)"
Mark Marshall90021f22010-12-03 14:48:11 +0000325.sp
David Hendricksf9a30552015-05-23 20:30:30 -0700326.BR "* linux_mtd" " (for SPI flash ROMs accessible via /dev/mtdX on Linux)"
327.sp
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +0000328.BR "* linux_spi" " (for SPI flash ROMs accessible via /dev/spidevX.Y on Linux)"
329.sp
James Lairdc60de0e2013-03-27 13:00:23 +0000330.BR "* usbblaster_spi" " (for SPI flash ROMs attached to an Altera USB-Blaster compatible cable)"
331.sp
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000332.BR "* nicintel_eeprom" " (for SPI EEPROMs on Intel Gigabit network cards)"
333.sp
Alexandre Boeglin80e64712014-12-20 20:25:19 +0000334.BR "* mstarddc_spi" " (for SPI flash ROMs accessible through DDC in MSTAR-equipped displays)"
335.sp
Justin Chevrier66e554b2015-02-08 21:58:10 +0000336.BR "* pickit2_spi" " (for SPI flash ROMs accessible via Microchip PICkit2)"
337.sp
Urja Rannikko0870b022016-01-31 22:10:29 +0000338.BR "* ch341a_spi" " (for SPI flash ROMs attached to WCH CH341A)"
339.sp
Lubomir Rintelb2154e82018-01-14 17:35:33 +0100340.BR "* digilent_spi" " (for SPI flash ROMs attached to iCEblink40 development boards)"
341.sp
Marc Schink3578ec62016-03-17 16:23:03 +0100342.BR "* jlink_spi" " (for SPI flash ROMs attached to SEGGER J-Link and compatible devices)"
343.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000344Some programmers have optional or mandatory parameters which are described
345in detail in the
Stefan Tauner6697f712014-08-06 15:09:15 +0000346.B PROGRAMMER-SPECIFIC INFORMATION
Michael Karchere5eafb22010-03-07 12:11:08 +0000347section. Support for some programmers can be disabled at compile time.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000348.B "flashrom \-h"
Michael Karchere5eafb22010-03-07 12:11:08 +0000349lists all supported programmers.
350.TP
351.B "\-h, \-\-help"
352Show a help text and exit.
353.TP
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +0000354.B "\-o, \-\-output <logfile>"
355Save the full debug log to
356.BR <logfile> .
357If the file already exists, it will be overwritten. This is the recommended
358way to gather logs from flashrom because they will be verbose even if the
Stefan Tauner6697f712014-08-06 15:09:15 +0000359on-screen messages are not verbose and don't require output redirection.
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +0000360.TP
Michael Karchere5eafb22010-03-07 12:11:08 +0000361.B "\-R, \-\-version"
362Show version information and exit.
Stefan Tauner6697f712014-08-06 15:09:15 +0000363.SH PROGRAMMER-SPECIFIC INFORMATION
Michael Karchere5eafb22010-03-07 12:11:08 +0000364Some programmer drivers accept further parameters to set programmer-specific
Uwe Hermann4e3d0b32010-03-25 23:18:41 +0000365parameters. These parameters are separated from the programmer name by a
Michael Karchere5eafb22010-03-07 12:11:08 +0000366colon. While some programmers take arguments at fixed positions, other
367programmers use a key/value interface in which the key and value is separated
368by an equal sign and different pairs are separated by a comma or a colon.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000369.SS
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000370.BR "internal " programmer
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000371.TP
372.B Board Enables
373.sp
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000374Some mainboards require to run mainboard specific code to enable flash erase
375and write support (and probe support on old systems with parallel flash).
376The mainboard brand and model (if it requires specific code) is usually
377autodetected using one of the following mechanisms: If your system is
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000378running coreboot, the mainboard type is determined from the coreboot table.
379Otherwise, the mainboard is detected by examining the onboard PCI devices
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000380and possibly DMI info. If PCI and DMI do not contain information to uniquely
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000381identify the mainboard (which is the exception), or if you want to override
382the detected mainboard model, you can specify the mainboard using the
383.sp
Stefan Taunerb4e06bd2012-08-20 00:24:22 +0000384.B " flashrom \-p internal:mainboard=<vendor>:<board>"
Carl-Daniel Hailfinger2d927fb2012-01-04 00:48:27 +0000385syntax.
386.sp
387See the 'Known boards' or 'Known laptops' section in the output
388of 'flashrom \-L' for a list of boards which require the specification of
389the board name, if no coreboot table is found.
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000390.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000391Some of these board-specific flash enabling functions (called
392.BR "board enables" )
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000393in flashrom have not yet been tested. If your mainboard is detected needing
394an untested board enable function, a warning message is printed and the
395board enable is not executed, because a wrong board enable function might
396cause the system to behave erratically, as board enable functions touch the
397low-level internals of a mainboard. Not executing a board enable function
398(if one is needed) might cause detection or erasing failure. If your board
399protects only part of the flash (commonly the top end, called boot block),
400flashrom might encounter an error only after erasing the unprotected part,
401so running without the board-enable function might be dangerous for erase
402and write (which includes erase).
403.sp
404The suggested procedure for a mainboard with untested board specific code is
405to first try to probe the ROM (just invoke flashrom and check that it
406detects your flash chip type) without running the board enable code (i.e.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000407without any parameters). If it finds your chip, fine. Otherwise, retry
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000408probing your chip with the board-enable code running, using
409.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000410.B " flashrom \-p internal:boardenable=force"
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000411.sp
412If your chip is still not detected, the board enable code seems to be broken
413or the flash chip unsupported. Otherwise, make a backup of your current ROM
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000414contents (using
415.BR \-r )
416and store it to a medium outside of your computer, like
417a USB drive or a network share. If you needed to run the board enable code
Stefan Taunereb582572012-09-21 12:52:50 +0000418already for probing, use it for reading too.
419If reading succeeds and the contens of the read file look legit you can try to write the new image.
420You should enable the board enable code in any case now, as it
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000421has been written because it is known that writing/erasing without the board
422enable is going to fail. In any case (success or failure), please report to
423the flashrom mailing list, see below.
424.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000425.TP
426.B Coreboot
427.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000428On systems running coreboot, flashrom checks whether the desired image matches
429your mainboard. This needs some special board ID to be present in the image.
430If flashrom detects that the image you want to write and the current board
431do not match, it will refuse to write the image unless you specify
432.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000433.B " flashrom \-p internal:boardmismatch=force"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000434.TP
435.B ITE IT87 Super I/O
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000436.sp
Vadim Girlin4dd0f902013-08-24 12:18:17 +0000437If your mainboard is manufactured by GIGABYTE and supports DualBIOS it is very likely that it uses an
438ITE IT87 series Super I/O to switch between the two flash chips. Only one of them can be accessed at a time
439and you can manually select which one to use with the
440.sp
441.B " flashrom \-p internal:dualbiosindex=chip"
442.sp
443syntax where
444.B chip
445is the index of the chip to use (0 = main, 1 = backup). You can check which one is currently selected by
446leaving out the
447.B chip
448parameter.
449.sp
Carl-Daniel Hailfinger01f3ef42010-03-25 02:50:40 +0000450If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000451translation, flashrom should autodetect that configuration. If you want to
452set the I/O base port of the IT87 series SPI controller manually instead of
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000453using the value provided by the BIOS, use the
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000454.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000455.B " flashrom \-p internal:it87spiport=portnum"
456.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000457syntax where
458.B portnum
459is the I/O port number (must be a multiple of 8). In the unlikely case
460flashrom doesn't detect an active IT87 LPC<->SPI bridge, please send a bug
461report so we can diagnose the problem.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000462.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000463.TP
Rudolf Marek70e14592013-07-25 22:58:56 +0000464.B AMD chipsets
465.sp
466Beginning with the SB700 chipset there is an integrated microcontroller (IMC) based on the 8051 embedded in
467every AMD southbridge. Its firmware resides in the same flash chip as the host's which makes writing to the
468flash risky if the IMC is active. Flashrom tries to temporarily disable the IMC but even then changing the
469contents of the flash can have unwanted effects: when the IMC continues (at the latest after a reboot) it will
470continue executing code from the flash. If the code was removed or changed in an unfortunate way it is
471unpredictable what the IMC will do. Therefore, if flashrom detects an active IMC it will disable write support
472unless the user forces it with the
473.sp
474.B " flashrom \-p internal:amd_imc_force=yes"
475.sp
476syntax. The user is responsible for supplying a suitable image or leaving out the IMC region with the help of
477a layout file. This limitation might be removed in the future when we understand the details better and have
478received enough feedback from users. Please report the outcome if you had to use this option to write a chip.
479.sp
Stefan Tauner21071b02014-05-16 21:39:48 +0000480An optional
481.B spispeed
482parameter specifies the frequency of the SPI bus where applicable (i.e.\& SB600 or later with an SPI flash chip
483directly attached to the chipset).
484Syntax is
485.sp
486.B " flashrom \-p internal:spispeed=frequency"
487.sp
488where
489.B frequency
490can be
491.BR "'16.5\ MHz'" ", " "'22\ MHz'" ", " "'33\ MHz'" ", " "'66\ MHz'" ", " "'100\ MHZ'" ", or " "'800\ kHz'" "."
492Support of individual frequencies depends on the generation of the chipset:
493.sp
494* SB6xx, SB7xx, SP5xxx: from 16.5 MHz up to and including 33 MHz
495.sp
496* SB8xx, SB9xx, Hudson: from 16.5 MHz up to and including 66 MHz
497.sp
498* Yangtze (with SPI 100 engine as found in Kabini and Tamesh): all of them
499.sp
500The default is to use 16.5 MHz and disable Fast Reads.
Rudolf Marek70e14592013-07-25 22:58:56 +0000501.TP
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000502.B Intel chipsets
503.sp
Stefan Tauner50e7c602011-11-08 10:55:54 +0000504If you have an Intel chipset with an ICH8 or later southbridge with SPI flash
Stefan Taunereb582572012-09-21 12:52:50 +0000505attached, and if a valid descriptor was written to it (e.g.\& by the vendor), the
Stefan Tauner50e7c602011-11-08 10:55:54 +0000506chipset provides an alternative way to access the flash chip(s) named
507.BR "Hardware Sequencing" .
508It is much simpler than the normal access method (called
509.BR "Software Sequencing" "),"
510but does not allow the software to choose the SPI commands to be sent.
511You can use the
512.sp
513.B " flashrom \-p internal:ich_spi_mode=value"
514.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000515syntax where
516.BR "value " "can be"
Stefan Tauner50e7c602011-11-08 10:55:54 +0000517.BR auto ", " swseq " or " hwseq .
518By default
519.RB "(or when setting " ich_spi_mode=auto )
Stefan Taunereb582572012-09-21 12:52:50 +0000520the module tries to use swseq and only activates hwseq if need be (e.g.\& if
Stefan Tauner50e7c602011-11-08 10:55:54 +0000521important opcodes are inaccessible due to lockdown; or if more than one flash
522chip is attached). The other options (swseq, hwseq) select the respective mode
523(if possible).
524.sp
Stefan Tauner5210e722012-02-16 01:13:00 +0000525ICH8 and later southbridges may also have locked address ranges of different
526kinds if a valid descriptor was written to it. The flash address space is then
527partitioned in multiple so called "Flash Regions" containing the host firmware,
528the ME firmware and so on respectively. The flash descriptor can also specify up
529to 5 so called "Protected Regions", which are freely chosen address ranges
530independent from the aforementioned "Flash Regions". All of them can be write
Nico Huber7590d1a2016-05-03 13:38:28 +0200531and/or read protected individually.
Stefan Tauner5210e722012-02-16 01:13:00 +0000532.sp
Kyösti Mälkki88ee0402013-09-14 23:37:01 +0000533If you have an Intel chipset with an ICH2 or later southbridge and if you want
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000534to set specific IDSEL values for a non-default flash chip or an embedded
535controller (EC), you can use the
536.sp
537.B " flashrom \-p internal:fwh_idsel=value"
538.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000539syntax where
540.B value
541is the 48-bit hexadecimal raw value to be written in the
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000542IDSEL registers of the Intel southbridge. The upper 32 bits use one hex digit
543each per 512 kB range between 0xffc00000 and 0xffffffff, and the lower 16 bits
544use one hex digit each per 1024 kB range between 0xff400000 and 0xff7fffff.
545The rightmost hex digit corresponds with the lowest address range. All address
546ranges have a corresponding sister range 4 MB below with identical IDSEL
547settings. The default value for ICH7 is given in the example below.
548.sp
549Example:
550.B "flashrom \-p internal:fwh_idsel=0x001122334567"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000551.TP
552.B Laptops
Carl-Daniel Hailfinger46fa0682011-07-25 22:44:09 +0000553.sp
Nico Huber2e50cdc2018-09-23 20:20:26 +0200554Using flashrom on older laptops that don't boot from the SPI bus is
555dangerous and may easily make your hardware unusable (see also the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000556.B BUGS
Nico Huber2e50cdc2018-09-23 20:20:26 +0200557section). The embedded controller (EC) in some
558machines may interact badly with flashing.
Stefan Tauner4c723152016-01-14 22:47:55 +0000559More information is
560.URLB https://flashrom.org/Laptops "in the wiki" .
Nico Huber2e50cdc2018-09-23 20:20:26 +0200561Problems occur when the flash chip is shared between BIOS
562and EC firmware, and the latter does not expect flashrom
563to access the chip. While flashrom tries to change the contents of
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000564that memory the EC might need to fetch new instructions or data from it and
565could stop working correctly. Probing for and reading from the chip may also
566irritate your EC and cause fan failure, backlight failure, sudden poweroff, and
Nico Huber2e50cdc2018-09-23 20:20:26 +0200567other nasty effects. flashrom will attempt to detect if it is running on such a
568laptop and limit probing to SPI buses. If you want to probe the LPC bus
569anyway at your own risk, use
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000570.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000571.B " flashrom \-p internal:laptop=force_I_want_a_brick"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000572.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000573We will not help you if you force flashing on a laptop because this is a really
574dumb idea.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000575.sp
576You have been warned.
577.sp
578Currently we rely on the chassis type encoded in the DMI/SMBIOS data to detect
579laptops. Some vendors did not implement those bits correctly or set them to
Nico Huber2e50cdc2018-09-23 20:20:26 +0200580generic and/or dummy values. flashrom will then issue a warning and restrict
581buses like above. In this case you can use
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000582.sp
583.B " flashrom \-p internal:laptop=this_is_not_a_laptop"
584.sp
Stefan Tauner6697f712014-08-06 15:09:15 +0000585to tell flashrom (at your own risk) that it is not running on a laptop.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000586.SS
Michael Karchere5eafb22010-03-07 12:11:08 +0000587.BR "dummy " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000588.IP
589The dummy programmer operates on a buffer in memory only. It provides a safe and fast way to test various
590aspects of flashrom and is mainly used in development and while debugging.
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000591It is able to emulate some chips to a certain degree (basic
592identify/read/erase/write operations work).
593.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000594An optional parameter specifies the bus types it
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000595should support. For that you have to use the
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000596.sp
597.B " flashrom \-p dummy:bus=[type[+type[+type]]]"
598.sp
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000599syntax where
600.B type
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000601can be
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000602.BR parallel ", " lpc ", " fwh ", " spi
603in any order. If you specify bus without type, all buses will be disabled.
604If you do not specify bus, all buses will be enabled.
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000605.sp
606Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000607.B "flashrom \-p dummy:bus=lpc+fwh"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000608.sp
609The dummy programmer supports flash chip emulation for automated self-tests
610without hardware access. If you want to emulate a flash chip, use the
611.sp
612.B " flashrom \-p dummy:emulate=chip"
613.sp
614syntax where
615.B chip
616is one of the following chips (please specify only the chip name, not the
617vendor):
618.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000619.RB "* ST " M25P10.RES " SPI flash chip (128 kB, RES, page write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000620.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000621.RB "* SST " SST25VF040.REMS " SPI flash chip (512 kB, REMS, byte write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000622.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000623.RB "* SST " SST25VF032B " SPI flash chip (4096 kB, RDID, AAI write)"
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000624.sp
Stefan Tauner23e10b82016-01-23 16:16:49 +0000625.RB "* Macronix " MX25L6436 " SPI flash chip (8192 kB, RDID, SFDP)"
Stefan Tauner0b9df972012-05-07 22:12:16 +0000626.sp
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000627Example:
628.B "flashrom -p dummy:emulate=SST25VF040.REMS"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000629.TP
630.B Persistent images
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000631.sp
632If you use flash chip emulation, flash image persistence is available as well
633by using the
634.sp
635.B " flashrom \-p dummy:emulate=chip,image=image.rom"
636.sp
637syntax where
638.B image.rom
639is the file where the simulated chip contents are read on flashrom startup and
640where the chip contents on flashrom shutdown are written to.
641.sp
642Example:
643.B "flashrom -p dummy:emulate=M25P10.RES,image=dummy.bin"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000644.TP
645.B SPI write chunk size
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000646.sp
647If you use SPI flash chip emulation for a chip which supports SPI page write
648with the default opcode, you can set the maximum allowed write chunk size with
649the
650.sp
651.B " flashrom \-p dummy:emulate=chip,spi_write_256_chunksize=size"
652.sp
653syntax where
654.B size
Stefan Taunereb582572012-09-21 12:52:50 +0000655is the number of bytes (min.\& 1, max.\& 256).
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000656.sp
657Example:
658.sp
659.B " flashrom -p dummy:emulate=M25P10.RES,spi_write_256_chunksize=5"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000660.TP
661.B SPI blacklist
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000662.sp
663To simulate a programmer which refuses to send certain SPI commands to the
664flash chip, you can specify a blacklist of SPI commands with the
665.sp
666.B " flashrom -p dummy:spi_blacklist=commandlist"
667.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000668syntax where
669.B commandlist
670is a list of two-digit hexadecimal representations of
Stefan Taunereb582572012-09-21 12:52:50 +0000671SPI commands. If commandlist is e.g.\& 0302, flashrom will behave as if the SPI
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000672controller refuses to run command 0x03 (READ) and command 0x02 (WRITE).
673commandlist may be up to 512 characters (256 commands) long.
674Implementation note: flashrom will detect an error during command execution.
675.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000676.TP
677.B SPI ignorelist
678.sp
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000679To simulate a flash chip which ignores (doesn't support) certain SPI commands,
680you can specify an ignorelist of SPI commands with the
681.sp
682.B " flashrom -p dummy:spi_ignorelist=commandlist"
683.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000684syntax where
685.B commandlist
686is a list of two-digit hexadecimal representations of
Stefan Taunereb582572012-09-21 12:52:50 +0000687SPI commands. If commandlist is e.g.\& 0302, the emulated flash chip will ignore
Carl-Daniel Hailfinger1b83be52012-02-08 23:28:54 +0000688command 0x03 (READ) and command 0x02 (WRITE). commandlist may be up to 512
689characters (256 commands) long.
690Implementation note: flashrom won't detect an error during command execution.
Stefan Tauner5e695ab2012-05-06 17:03:40 +0000691.sp
692.TP
693.B SPI status register
694.sp
695You can specify the initial content of the chip's status register with the
696.sp
697.B " flashrom -p dummy:spi_status=content"
698.sp
Carl-Daniel Hailfinger4e3391f2012-07-22 12:01:43 +0000699syntax where
700.B content
701is an 8-bit hexadecimal value.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000702.SS
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000703.BR "nic3com" , " nicrealtek" , " nicnatsemi" , " nicintel", " nicintel_eeprom"\
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000704, " nicintel_spi" , " gfxnvidia" , " ogp_spi" , " drkaiser" , " satasii"\
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000705, " satamv" , " atahpt", " atavia ", " atapromise " and " it8212 " programmers
Stefan Tauner4c723152016-01-14 22:47:55 +0000706.IP
Michael Karchere5eafb22010-03-07 12:11:08 +0000707These programmers have an option to specify the PCI address of the card
708your want to use, which must be specified if more than one card supported
709by the selected programmer is installed in your system. The syntax is
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +0000710.sp
711.BR " flashrom \-p xxxx:pci=bb:dd.f" ,
712.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000713where
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000714.B xxxx
Stefan Taunerc2eec2c2014-05-03 21:33:01 +0000715is the name of the programmer,
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000716.B bb
717is the PCI bus number,
718.B dd
719is the PCI device number, and
720.B f
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000721is the PCI function number of the desired device.
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000722.sp
723Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000724.B "flashrom \-p nic3com:pci=05:04.0"
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000725.SS
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000726.BR "atavia " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000727.IP
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000728Due to the mysterious address handling of the VIA VT6421A controller the user can specify an offset with the
729.sp
730.B " flashrom \-p atavia:offset=addr"
731.sp
732syntax where
733.B addr
734will be interpreted as usual (leading 0x (0) for hexadecimal (octal) values, or else decimal).
735For more information please see
Stefan Tauner4c723152016-01-14 22:47:55 +0000736.URLB https://flashrom.org/VT6421A "its wiki page" .
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +0000737.SS
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +0000738.BR "atapromise " programmer
739.IP
740This programmer is currently limited to 32 kB, regardless of the actual size of the flash chip. This stems
741from the fact that, on the tested device (a Promise Ultra100), not all of the chip's address lines were
742actually connected. You may use this programmer to flash firmware updates, since these are only 16 kB in
743size (padding to 32 kB is required).
744.SS
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000745.BR "nicintel_eeprom " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000746.IP
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000747This is the first programmer module in flashrom that does not provide access to NOR flash chips but EEPROMs
748mounted on gigabit Ethernet cards based on Intel's 82580 NIC. Because EEPROMs normally do not announce their
Stefan Tauner0be072c2016-03-13 15:16:30 +0000749size nor allow themselves to be identified, the controller relies on correct size values written to predefined
750addresses within the chip. Flashrom follows this scheme but assumes the minimum size of 16 kB (128 kb) if an
751unprogrammed EEPROM/card is detected. Intel specifies following EEPROMs to be compatible:
752Atmel AT25128, AT25256, Micron (ST) M95128, M95256 and OnSemi (Catalyst) CAT25CS128.
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +0000753.SS
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000754.BR "ft2232_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000755.IP
Stefan Tauner0be072c2016-03-13 15:16:30 +0000756This module supports various programmers based on FTDI FT2232/FT4232H/FT232H chips including the DLP Design
757DLP-USB1232H, openbiosprog-spi, Amontec JTAGkey/JTAGkey-tiny/JTAGkey-2, Dangerous Prototypes Bus Blaster,
758Olimex ARM-USB-TINY/-H, Olimex ARM-USB-OCD/-H, OpenMoko Neo1973 Debug board (V2+), TIAO/DIYGADGET USB
759Multi-Protocol Adapter (TUMPA), TUMPA Lite, GOEPEL PicoTAP and Google Servo v1/v2.
760.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000761An optional parameter specifies the controller
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300762type, 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 +0000763.sp
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300764.B " flashrom \-p ft2232_spi:type=model,port=interface,csgpiol=gpio"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000765.sp
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000766syntax where
767.B model
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000768can be
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000769.BR 2232H ", " 4232H ", " 232H ", " jtagkey ", " busblaster ", " openmoko ", " \
Uwe Hermann836b26a2011-10-14 20:33:14 +0000770arm-usb-tiny ", " arm-usb-tiny-h ", " arm-usb-ocd ", " arm-usb-ocd-h \
Todd Broch6800c952016-02-14 15:46:00 +0000771", " tumpa ", " tumpalite ", " picotap ", " google-servo ", " google-servo-v2 \
772" or " google-servo-v2-legacy
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000773.B interface
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000774can be
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300775.BR A ", " B ", " C ", or " D
776and
777.B csgpiol
778can be a number between 0 and 3, denoting GPIOL0-GPIOL3 correspondingly.
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000779The default model is
780.B 4232H
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300781the default interface is
782.BR A
783and GPIO is not used by default.
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000784.sp
Shik Chen14fbc4b2012-09-17 00:40:54 +0000785If there is more than one ft2232_spi-compatible device connected, you can select which one should be used by
786specifying its serial number with the
787.sp
788.B " flashrom \-p ft2232_spi:serial=number"
789.sp
790syntax where
791.B number
792is the serial number of the device (which can be found for example in the output of lsusb -v).
793.sp
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000794All 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 +0000795expressible divisors are all
796.B even
797numbers between 2 and 2^17 (=131072) resulting in SPI clock frequencies of
Samir Ibradžićb482c6d2012-05-15 22:58:19 +00007986 MHz down to about 92 Hz for 12 MHz inputs. The default divisor is set to 2, but you can use another one by
799specifying the optional
800.B divisor
801parameter with the
802.sp
803.B " flashrom \-p ft2232_spi:divisor=div"
804.sp
805syntax.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000806.SS
Michael Karchere5eafb22010-03-07 12:11:08 +0000807.BR "serprog " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000808.IP
Stefan Tauner0be072c2016-03-13 15:16:30 +0000809This module supports all programmers speaking the serprog protocol. This includes some Arduino-based devices
810as well as various programmers by Urja Rannikko, Juhana Helovuo, Stefan Tauner, Chi Zhang and many others.
811.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000812A mandatory parameter specifies either a serial device (and baud rate) or an IP/port combination for
813communicating with the programmer.
814The device/baud combination has to start with
815.B dev=
816and separate the optional baud rate with a colon.
817For example
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000818.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000819.B " flashrom \-p serprog:dev=/dev/ttyS0:115200"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000820.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000821If no baud rate is given the default values by the operating system/hardware will be used.
822For IP connections you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000823.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000824.B " flashrom \-p serprog:ip=ipaddr:port"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000825.sp
Stefan Tauner72587f82016-01-04 03:05:15 +0000826syntax.
827In case the device supports it, you can set the SPI clock frequency with the optional
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000828.B spispeed
Stefan Tauner0554ca52013-07-25 22:54:25 +0000829parameter. The frequency is parsed as hertz, unless an
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000830.BR M ", or " k
831suffix is given, then megahertz or kilohertz are used respectively.
832Example that sets the frequency to 2 MHz:
833.sp
Stefan Tauner0554ca52013-07-25 22:54:25 +0000834.B " flashrom \-p serprog:dev=/dev/device:baud,spispeed=2M"
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000835.sp
836More information about serprog is available in
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000837.B serprog-protocol.txt
838in the source distribution.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000839.SS
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000840.BR "buspirate_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000841.IP
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000842A required
843.B dev
844parameter specifies the Bus Pirate device node and an optional
845.B spispeed
846parameter specifies the frequency of the SPI bus. The parameter
Michael Karchere5eafb22010-03-07 12:11:08 +0000847delimiter is a comma. Syntax is
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000848.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000849.B " flashrom \-p buspirate_spi:dev=/dev/device,spispeed=frequency"
Michael Karchere5eafb22010-03-07 12:11:08 +0000850.sp
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000851where
852.B frequency
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000853can be
854.BR 30k ", " 125k ", " 250k ", " 1M ", " 2M ", " 2.6M ", " 4M " or " 8M
Michael Karchere5eafb22010-03-07 12:11:08 +0000855(in Hz). The default is the maximum frequency of 8 MHz.
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000856.sp
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600857The baud rate for communication between the host and the Bus Pirate can be specified with the optional
858.B serialspeed
859parameter. Syntax is
860.sp
861.B " flashrom -p buspirate_spi:serialspeed=baud
862.sp
863where
864.B baud
865can be
866.BR 115200 ", " 230400 ", " 250000 " or " 2000000 " (" 2M ")."
867The default is 2M baud for Bus Pirate hardware version 3.0 and greater, and 115200 otherwise.
868.sp
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000869An optional pullups parameter specifies the use of the Bus Pirate internal pull-up resistors. This may be
870needed if you are working with a flash ROM chip that you have physically removed from the board. Syntax is
871.sp
872.B " flashrom -p buspirate_spi:pullups=state"
873.sp
874where
875.B state
876can be
877.BR on " or " off .
Stefan Tauner4c723152016-01-14 22:47:55 +0000878More information about the Bus Pirate pull-up resistors and their purpose is available
879.URLB "http://dangerousprototypes.com/docs/Practical_guide_to_Bus_Pirate_pull-up_resistors" \
880"in a guide by dangerousprototypes" .
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000881Only the external supply voltage (Vpu) is supported as of this writing.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000882.SS
Justin Chevrier66e554b2015-02-08 21:58:10 +0000883.BR "pickit2_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000884.IP
Justin Chevrier66e554b2015-02-08 21:58:10 +0000885An optional
886.B voltage
887parameter specifies the voltage the PICkit2 should use. The default unit is Volt if no unit is specified.
888You can use
889.BR mV ", " millivolt ", " V " or " Volt
890as unit specifier. Syntax is
891.sp
892.B " flashrom \-p pickit2_spi:voltage=value"
893.sp
894where
895.B value
896can be
897.BR 0V ", " 1.8V ", " 2.5V ", " 3.5V
898or the equivalent in mV.
899.sp
900An optional
901.B spispeed
902parameter specifies the frequency of the SPI bus. Syntax is
903.sp
904.B " flashrom \-p pickit2_spi:spispeed=frequency"
905.sp
906where
907.B frequency
908can be
909.BR 250k ", " 333k ", " 500k " or " 1M "
910(in Hz). The default is a frequency of 1 MHz.
911.SS
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000912.BR "dediprog " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000913.IP
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000914An optional
915.B voltage
916parameter specifies the voltage the Dediprog should use. The default unit is
917Volt if no unit is specified. You can use
918.BR mV ", " milliVolt ", " V " or " Volt
919as unit specifier. Syntax is
920.sp
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000921.B " flashrom \-p dediprog:voltage=value"
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000922.sp
923where
924.B value
Uwe Hermann68b9cca2011-06-15 23:44:52 +0000925can be
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000926.BR 0V ", " 1.8V ", " 2.5V ", " 3.5V
927or the equivalent in mV.
Nathan Laredo21541a62012-12-24 22:07:36 +0000928.sp
929An optional
930.B device
931parameter specifies which of multiple connected Dediprog devices should be used.
932Please be aware that the order depends on libusb's usb_get_busses() function and that the numbering starts
933at 0.
934Usage example to select the second device:
935.sp
936.B " flashrom \-p dediprog:device=1"
Nico Huber77fa67d2013-02-20 18:03:36 +0000937.sp
938An optional
939.B spispeed
Patrick Georgiefe2d432013-05-23 21:47:46 +0000940parameter specifies the frequency of the SPI bus. The firmware on the device needs to be 5.0.0 or newer.
941Syntax is
Nico Huber77fa67d2013-02-20 18:03:36 +0000942.sp
943.B " flashrom \-p dediprog:spispeed=frequency"
944.sp
945where
946.B frequency
947can be
948.BR 375k ", " 750k ", " 1.5M ", " 2.18M ", " 3M ", " 8M ", " 12M " or " 24M
949(in Hz). The default is a frequency of 12 MHz.
Stefan Taunere659d2d2013-05-03 21:58:28 +0000950.sp
951An optional
952.B target
953parameter specifies which target chip should be used. Syntax is
954.sp
955.B " flashrom \-p dediprog:target=value"
956.sp
957where
958.B value
959can be
960.BR 1 " or " 2
Stefan Tauner6697f712014-08-06 15:09:15 +0000961to select target chip 1 or 2 respectively. The default is target chip 1.
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000962.SS
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000963.BR "rayer_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +0000964.IP
Carl-Daniel Hailfinger37c42522010-10-05 19:19:48 +0000965The default I/O base address used for the parallel port is 0x378 and you can use
966the optional
967.B iobase
968parameter to specify an alternate base I/O address with the
969.sp
970.B " flashrom \-p rayer_spi:iobase=baseaddr"
971.sp
972syntax where
973.B baseaddr
974is base I/O port address of the parallel port, which must be a multiple of
975four. Make sure to not forget the "0x" prefix for hexadecimal port addresses.
976.sp
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000977The default cable type is the RayeR cable. You can use the optional
978.B type
979parameter to specify the cable type with the
980.sp
981.B " flashrom \-p rayer_spi:type=model"
982.sp
983syntax where
984.B model
985can be
Maksim Kuleshov4dab5c12013-10-02 01:22:02 +0000986.BR rayer " for the RayeR cable, " byteblastermv " for the Altera ByteBlasterMV, " stk200 " for the Atmel \
Stefan Taunerfdb16592016-02-28 17:04:38 +0000987STK200/300, " wiggler " for the Macraigor Wiggler, " xilinx " for the Xilinx Parallel Cable III (DLC 5), or" \
988" spi_tt" " for SPI Tiny Tools-compatible hardware.
Carl-Daniel Hailfingerae418d82011-09-12 06:17:06 +0000989.sp
990More information about the RayeR hardware is available at
Stefan Tauner23e10b82016-01-23 16:16:49 +0000991.nh
Stefan Tauner4c723152016-01-14 22:47:55 +0000992.URLB "http://rayer.g6.cz/elektro/spipgm.htm" "RayeR's website" .
Maksim Kuleshov3647b2d2013-10-02 01:21:57 +0000993The Altera ByteBlasterMV datasheet can be obtained from
Stefan Tauner4c723152016-01-14 22:47:55 +0000994.URLB "http://www.altera.co.jp/literature/ds/dsbytemv.pdf" Altera .
Maksim Kuleshovacba2ac2013-10-02 01:22:11 +0000995For more information about the Macraigor Wiggler see
Stefan Tauner4c723152016-01-14 22:47:55 +0000996.URLB "http://www.macraigor.com/wiggler.htm" "their company homepage" .
Kyösti Mälkki8b1bdf12013-10-02 01:21:45 +0000997The schematic of the Xilinx DLC 5 was published in
Stefan Tauner4c723152016-01-14 22:47:55 +0000998.URLB "http://www.xilinx.com/support/documentation/user_guides/xtp029.pdf" "a Xilinx user guide" .
Stefan Tauner9e9f6842012-02-16 20:55:27 +0000999.SS
Michael Karchere5449392012-05-05 20:53:59 +00001000.BR "pony_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001001.IP
Michael Karchere5449392012-05-05 20:53:59 +00001002The serial port (like /dev/ttyS0, /dev/ttyUSB0 on Linux or COM3 on windows) is
1003specified using the mandatory
Stefan Taunere34e3e82013-01-01 00:06:51 +00001004.B dev
Michael Karchere5449392012-05-05 20:53:59 +00001005parameter. The adapter type is selectable between SI-Prog (used for
1006SPI devices with PonyProg 2000) or a custom made serial bitbanging programmer
1007named "serbang". The optional
Stefan Taunere34e3e82013-01-01 00:06:51 +00001008.B type
Michael Karchere5449392012-05-05 20:53:59 +00001009parameter accepts the values "si_prog" (default) or "serbang".
1010.sp
1011Information about the SI-Prog adapter can be found at
Stefan Tauner4c723152016-01-14 22:47:55 +00001012.URLB "http://www.lancos.com/siprogsch.html" "its website" .
Michael Karchere5449392012-05-05 20:53:59 +00001013.sp
1014An example call to flashrom is
1015.sp
1016.B " flashrom \-p pony_spi:dev=/dev/ttyS0,type=serbang"
1017.sp
1018Please note that while USB-to-serial adapters work under certain circumstances,
1019this slows down operation considerably.
1020.SS
Mark Marshall90021f22010-12-03 14:48:11 +00001021.BR "ogp_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001022.IP
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001023The flash ROM chip to access must be specified with the
Mark Marshall90021f22010-12-03 14:48:11 +00001024.B rom
1025parameter.
1026.sp
1027.B " flashrom \-p ogp_spi:rom=name"
1028.sp
1029Where
1030.B name
1031is either
1032.B cprom
1033or
1034.B s3
Stefan Taunere34e3e82013-01-01 00:06:51 +00001035for the configuration ROM and
Mark Marshall90021f22010-12-03 14:48:11 +00001036.B bprom
1037or
1038.B bios
Uwe Hermann68b9cca2011-06-15 23:44:52 +00001039for the BIOS ROM. If more than one card supported by the ogp_spi programmer
Mark Marshall90021f22010-12-03 14:48:11 +00001040is installed in your system, you have to specify the PCI address of the card
1041you want to use with the
1042.B pci=
1043parameter as explained in the
Stefan Taunere34e3e82013-01-01 00:06:51 +00001044.B nic3com et al.\&
Mark Marshall90021f22010-12-03 14:48:11 +00001045section above.
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001046.SS
David Hendricksf9a30552015-05-23 20:30:30 -07001047.BR "linux_mtd " programmer
1048.IP
1049You may specify the MTD device to use with the
1050.sp
1051.B " flashrom \-p linux_mtd:dev=/dev/mtdX"
1052.sp
1053syntax where
1054.B /dev/mtdX
1055is the Linux device node for your MTD device. If left unspecified the first MTD
1056device found (e.g. /dev/mtd0) will be used by default.
1057.sp
1058Please note that the linux_mtd driver only works on Linux.
1059.SS
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001060.BR "linux_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001061.IP
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001062You have to specify the SPI controller to use with the
1063.sp
1064.B " flashrom \-p linux_spi:dev=/dev/spidevX.Y"
1065.sp
1066syntax where
1067.B /dev/spidevX.Y
1068is the Linux device node for your SPI controller.
1069.sp
Stefan Tauner0554ca52013-07-25 22:54:25 +00001070In case the device supports it, you can set the SPI clock frequency with the optional
1071.B spispeed
1072parameter. The frequency is parsed as kilohertz.
1073Example that sets the frequency to 8 MHz:
1074.sp
1075.B " flashrom \-p linux_spi:dev=/dev/spidevX.Y,spispeed=8000"
1076.sp
Carl-Daniel Hailfinger8541d232012-02-16 21:00:27 +00001077Please note that the linux_spi driver only works on Linux.
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001078.SS
1079.BR "mstarddc_spi " programmer
Stefan Tauner4c723152016-01-14 22:47:55 +00001080.IP
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001081The Display Data Channel (DDC) is an I2C bus present on VGA and DVI connectors, that allows exchanging
Stefan Tauner0be072c2016-03-13 15:16:30 +00001082information between a computer and attached displays. Its most common uses are getting display capabilities
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001083through EDID (at I2C address 0x50) and sending commands to the display using the DDC/CI protocol (at address
10840x37). On displays driven by MSTAR SoCs, it is also possible to access the SoC firmware flash (connected to
1085the Soc through another SPI bus) using an In-System Programming (ISP) port, usually at address 0x49.
1086This flashrom module allows the latter via Linux's I2C driver.
1087.sp
1088.B IMPORTANT:
1089Before using this programmer, the display
1090.B MUST
1091be in standby mode, and only connected to the computer that will run flashrom using a VGA cable, to an
1092inactive VGA output. It absolutely
1093.B MUST NOT
1094be used as a display during the procedure!
1095.sp
1096You have to specify the DDC/I2C controller and I2C address to use with the
1097.sp
1098.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-X:YY"
1099.sp
1100syntax where
1101.B /dev/i2c-X
1102is the Linux device node for your I2C controller connected to the display's DDC channel, and
1103.B YY
1104is the (hexadecimal) address of the MSTAR ISP port (address 0x49 is usually used).
1105Example that uses I2C controller /dev/i2c-1 and address 0x49:
1106.sp
1107.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-1:49
1108.sp
1109It is also possible to inhibit the reset command that is normally sent to the display once the flashrom
1110operation is completed using the optional
1111.B noreset
1112parameter. A value of 1 prevents flashrom from sending the reset command.
1113Example that does not reset the display at the end of the operation:
1114.sp
1115.B " flashrom \-p mstarddc_spi:dev=/dev/i2c-1:49,noreset=1
1116.sp
Stefan Tauner0be072c2016-03-13 15:16:30 +00001117Please note that sending the reset command is also inhibited if an error occurred during the operation.
Alexandre Boeglin80e64712014-12-20 20:25:19 +00001118To send the reset command afterwards, you can simply run flashrom once more, in chip probe mode (not specifying
1119an operation), without the
1120.B noreset
1121parameter, once the flash read/write operation you intended to perform has completed successfully.
1122.sp
1123Please also note that the mstarddc_spi driver only works on Linux.
Urja Rannikko0870b022016-01-31 22:10:29 +00001124.SS
1125.BR "ch341a_spi " programmer
1126The WCH CH341A programmer does not support any parameters currently. SPI frequency is fixed at 2 MHz, and CS0 is
1127used as per the device.
Lubomir Rintelb2154e82018-01-14 17:35:33 +01001128.SS
1129.BR "digilent_spi " programmer
1130.IP
1131An optional
1132.B spispeed
1133parameter specifies the frequency of the SPI bus.
1134Syntax is
1135.sp
1136.B " flashrom \-p digilent_spi:spispeed=frequency"
1137.sp
1138where
1139.B frequency
1140can be
1141.BR 62.5k ", " 125k ", " 250k ", " 500k ", " 1M ", " 2M " or " 4M
1142(in Hz). The default is a frequency of 4 MHz.
1143.sp
1144.SS
Marc Schink3578ec62016-03-17 16:23:03 +01001145.BR "jlink_spi " programmer
1146.IP
1147This module supports SEGGER J-Link and compatible devices.
1148
1149The \fBMOSI\fP signal of the flash chip must be attached to \fBTDI\fP pin of
1150the programmer, \fBMISO\fP to \fBTDO\fP and \fBSCK\fP to \fBTCK\fP.
1151The chip select (\fBCS\fP) signal of the flash chip can be attached to
1152different pins of the programmer which can be selected with the
1153.sp
1154.B " flashrom \-p jlink_spi:cs=pin"
1155.sp
1156syntax where \fBpin\fP can be either \fBTRST\fP or \fBRESET\fP.
1157The default pin for chip select is \fBRESET\fP.
1158Note that, when using \fBRESET\fP, it is normal that the indicator LED blinks
1159orange or red.
1160.br
1161Additionally, the \fBVTref\fP pin of the programmer must be attached to the
1162logic level of the flash chip.
1163The programmer measures the voltage on this pin and generates the reference
1164voltage for its input comparators and adapts its output voltages to it.
1165.sp
1166Pinout for devices with 20-pin JTAG connector:
1167.sp
1168 +-------+
1169 | 1 2 | 1: VTref 2:
1170 | 3 4 | 3: TRST 4: GND
1171 | 5 6 | 5: TDI 6: GND
1172 +-+ 7 8 | 7: 8: GND
1173 | 9 10 | 9: TCK 10: GND
1174 | 11 12 | 11: 12: GND
1175 +-+ 13 14 | 13: TDO 14:
1176 | 15 16 | 15: RESET 16:
1177 | 17 18 | 17: 18:
1178 | 19 20 | 19: PWR_5V 20:
1179 +-------+
1180.sp
1181If there is more than one compatible device connected, you can select which one
1182should be used by specifying its serial number with the
1183.sp
1184.B " flashrom \-p jlink_spi:serial=number"
1185.sp
1186syntax where
1187.B number
1188is the serial number of the device (which can be found for example in the
1189output of lsusb -v).
1190.sp
1191The SPI speed can be selected by using the
1192.sp
1193.B " flashrom \-p jlink_spi:spispeed=frequency"
1194.sp
1195syntax where \fBfrequency\fP is the SPI clock frequency in kHz.
1196The maximum speed depends on the device in use.
1197.SS
1198
Carl-Daniel Hailfinger0b9af362012-07-21 16:56:04 +00001199.SH EXAMPLES
1200To back up and update your BIOS, run
1201.sp
1202.B flashrom -p internal -r backup.rom -o backuplog.txt
1203.br
1204.B flashrom -p internal -w newbios.rom -o writelog.txt
1205.sp
1206Please make sure to copy backup.rom to some external media before you try
1207to write. That makes offline recovery easier.
1208.br
1209If writing fails and flashrom complains about the chip being in an unknown
1210state, you can try to restore the backup by running
1211.sp
1212.B flashrom -p internal -w backup.rom -o restorelog.txt
1213.sp
1214If you encounter any problems, please contact us and supply
1215backuplog.txt, writelog.txt and restorelog.txt. See section
1216.B BUGS
1217for contact info.
Peter Stuge42688e52009-01-26 02:20:56 +00001218.SH EXIT STATUS
Niklas Söderlund2d8b7ef2013-09-13 19:19:25 +00001219flashrom 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 +00001220.SH REQUIREMENTS
1221flashrom needs different access permissions for different programmers.
1222.sp
1223.B internal
1224needs raw memory access, PCI configuration space access, raw I/O port
1225access (x86) and MSR access (x86).
1226.sp
Jonathan Kollasch7f0f3fa2014-06-01 10:26:23 +00001227.B atavia
1228needs PCI configuration space access.
1229.sp
Sergey Lichack98f47102012-08-27 01:24:15 +00001230.BR nic3com ", " nicrealtek " and " nicnatsemi "
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001231need PCI configuration space read access and raw I/O port access.
1232.sp
1233.B atahpt
1234needs PCI configuration space access and raw I/O port access.
1235.sp
Kyösti Mälkki72d42f82014-06-01 23:48:31 +00001236.BR gfxnvidia ", " drkaiser " and " it8212
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001237need PCI configuration space access and raw memory access.
1238.sp
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +00001239.B rayer_spi
1240needs raw I/O port access.
1241.sp
Ricardo Ribalda Delgado2a41f0a2014-07-28 20:35:21 +00001242.BR satasii ", " nicintel ", " nicintel_eeprom " and " nicintel_spi
1243need PCI configuration space read access and raw memory access.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001244.sp
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +00001245.BR satamv " and " atapromise
1246need PCI configuration space read access, raw I/O port access and raw memory
Carl-Daniel Hailfinger9321f062011-07-24 18:41:13 +00001247access.
1248.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001249.B serprog
1250needs TCP access to the network or userspace access to a serial port.
1251.sp
1252.B buspirate_spi
1253needs userspace access to a serial port.
1254.sp
Nico Huberd99a2bd2016-02-18 21:42:49 +00001255.BR ft2232_spi ", " usbblaster_spi " and " pickit2_spi
Stefan Taunere49edbb2016-01-31 22:10:14 +00001256need access to the respective USB device via libusb API version 0.1.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001257.sp
Nico Huberd99a2bd2016-02-18 21:42:49 +00001258.BR ch341a_spi " and " dediprog
1259need access to the respective USB device via libusb API version 1.0.
Urja Rannikko0870b022016-01-31 22:10:29 +00001260.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001261.B dummy
1262needs no access permissions at all.
1263.sp
Sergey Lichack98f47102012-08-27 01:24:15 +00001264.BR internal ", " nic3com ", " nicrealtek ", " nicnatsemi ", "
Joseph C. Lehnerc2644a32016-01-16 23:45:25 +00001265.BR gfxnvidia ", " drkaiser ", " satasii ", " satamv ", " atahpt ", " atavia " and " atapromise
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001266have to be run as superuser/root, and need additional raw access permission.
1267.sp
Lubomir Rintelb2154e82018-01-14 17:35:33 +01001268.BR serprog ", " buspirate_spi ", " dediprog ", " usbblaster_spi ", " ft2232_spi ", " pickit2_spi ", " \
1269ch341a_spi " and " digilent_spi
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001270can be run as normal user on most operating systems if appropriate device
1271permissions are set.
1272.sp
Mark Marshall90021f22010-12-03 14:48:11 +00001273.B ogp
1274needs PCI configuration space read access and raw memory access.
1275.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +00001276On OpenBSD, you can obtain raw access permission by setting
Uwe Hermann941a2732011-07-25 21:12:57 +00001277.B "securelevel=-1"
1278in
1279.B "/etc/rc.securelevel"
1280and rebooting, or rebooting into single user mode.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001281.SH BUGS
Stefan Tauner4c723152016-01-14 22:47:55 +00001282Please report any bugs to the
1283.MTOB "flashrom@flashrom.org" "flashrom mailing list" .
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001284.sp
1285We recommend to subscribe first at
Stefan Tauner4c723152016-01-14 22:47:55 +00001286.URLB "https://flashrom.org/mailman/listinfo/flashrom" "" .
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +00001287.sp
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001288Many of the developers communicate via the
1289.B "#flashrom"
1290IRC channel on
1291.BR chat.freenode.net .
Stefan Tauner4c723152016-01-14 22:47:55 +00001292If you don't have an IRC client, you can use the
1293.URLB http://webchat.freenode.net/?channels=flashrom "freenode webchat" .
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001294You are welcome to join and ask questions, send us bug and success reports there
Stefan Taunereb582572012-09-21 12:52:50 +00001295too. Please provide a way to contact you later (e.g.\& a mail address) and be
Stefan Tauner4c723152016-01-14 22:47:55 +00001296patient if there is no immediate reaction. Also, we provide a
1297.URLB https://paste.flashrom.org "pastebin service"
Stefan Taunereb582572012-09-21 12:52:50 +00001298that is very useful when you want to share logs etc.\& without spamming the
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001299channel.
1300.SS
1301.B Laptops
1302.sp
Nico Huber2e50cdc2018-09-23 20:20:26 +02001303Using flashrom on older laptops is dangerous and may easily make your hardware
1304unusable. flashrom will attempt to detect if it is running on a susceptible
1305laptop and restrict flash-chip probing for safety reasons. Please see the
1306detailed discussion of this topic and associated flashrom options in the
Stefan Tauner9e9f6842012-02-16 20:55:27 +00001307.B Laptops
1308paragraph in the
1309.B internal programmer
1310subsection of the
Stefan Tauner6697f712014-08-06 15:09:15 +00001311.B PROGRAMMER-SPECIFIC INFORMATION
Stefan Tauner4c723152016-01-14 22:47:55 +00001312section and the information
1313.URLB "https://flashrom.org/Laptops" "in our wiki" .
Daniel Lenski65922a32012-02-15 23:40:23 +00001314.SS
1315One-time programmable (OTP) memory and unique IDs
1316.sp
1317Some flash chips contain OTP memory often denoted as "security registers".
1318They usually have a capacity in the range of some bytes to a few hundred
Stefan Taunereb582572012-09-21 12:52:50 +00001319bytes and can be used to give devices unique IDs etc. flashrom is not able
Daniel Lenski65922a32012-02-15 23:40:23 +00001320to read or write these memories and may therefore not be able to duplicate a
1321chip completely. For chip types known to include OTP memories a warning is
1322printed when they are detected.
1323.sp
1324Similar to OTP memories are unique, factory programmed, unforgeable IDs.
1325They are not modifiable by the user at all.
Stefan Taunerac54fbe2011-07-21 19:52:00 +00001326.SH LICENSE
Stefan Reinauer261144c2006-07-27 23:29:02 +00001327.B flashrom
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001328is covered by the GNU General Public License (GPL), version 2. Some files are
Stefan Tauner23e10b82016-01-23 16:16:49 +00001329additionally available under any later version of the GPL.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001330.SH COPYRIGHT
Stefan Reinauer261144c2006-07-27 23:29:02 +00001331.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001332Please see the individual files.
Stefan Reinauer261144c2006-07-27 23:29:02 +00001333.SH AUTHORS
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001334Andrew Morgan
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001335.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001336Carl-Daniel Hailfinger
1337.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001338Claus Gindhart
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001339.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001340David Borg
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001341.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001342David Hendricks
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001343.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001344Dominik Geyer
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001345.br
Edward O'Callaghan0cd11d82019-09-23 22:46:12 +10001346Edward O'Callaghan
1347.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001348Eric Biederman
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001349.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001350Giampiero Giancipoli
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001351.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001352Helge Wagner
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001353.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001354Idwer Vollering
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001355.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001356Joe Bao
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001357.br
Stefan Taunerc0aaf952011-05-19 02:58:17 +00001358Joerg Fischer
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001359.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001360Joshua Roys
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001361.br
Stefan Tauner5c316f92015-02-08 21:57:52 +00001362Ky\[:o]sti M\[:a]lkki
1363.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001364Luc Verhaegen
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001365.br
Carl-Daniel Hailfinger451dc802009-05-01 11:00:39 +00001366Li-Ta Lo
1367.br
Mark Marshall90021f22010-12-03 14:48:11 +00001368Mark Marshall
1369.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001370Markus Boas
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001371.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001372Mattias Mattsson
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001373.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001374Michael Karcher
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001375.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001376Nikolay Petukhov
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001377.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001378Patrick Georgi
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001379.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001380Peter Lemenkov
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001381.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001382Peter Stuge
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001383.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001384Reinder E.N. de Haan
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001385.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001386Ronald G. Minnich
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001387.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001388Ronald Hoogenboom
Stefan Reinauer261144c2006-07-27 23:29:02 +00001389.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001390Sean Nelson
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00001391.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001392Stefan Reinauer
Stefan Reinauer261144c2006-07-27 23:29:02 +00001393.br
Uwe Hermann68b9cca2011-06-15 23:44:52 +00001394Stefan Tauner
1395.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001396Stefan Wildemann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001397.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001398Stephan Guilloux
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +00001399.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001400Steven James
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001401.br
Stefan Tauner23e10b82016-01-23 16:16:49 +00001402Urja Rannikko
1403.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001404Uwe Hermann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001405.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001406Wang Qingpei
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +00001407.br
Stefan Reinaueredc61882010-01-03 14:40:30 +00001408Yinghai Lu
Stefan Reinauerf8337dd2006-08-03 10:49:09 +00001409.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +00001410some others, please see the flashrom svn changelog for details.
1411.br
Stefan Tauner4c723152016-01-14 22:47:55 +00001412All still active authors can be reached via
1413.MTOB "flashrom@flashrom.org" "the mailing list" .
Stefan Reinauer261144c2006-07-27 23:29:02 +00001414.PP
Stefan Tauner4c723152016-01-14 22:47:55 +00001415This manual page was written by
1416.MTOB "uwe@hermann-uwe.de" "Uwe Hermann" ,
1417Carl-Daniel Hailfinger, Stefan Tauner and others.
Uwe Hermann42eb17f2008-01-18 17:48:51 +00001418It is licensed under the terms of the GNU GPL (version 2 or later).