blob: 667e06bcbf400acc0708a572492bf8cd3b041d32 [file] [log] [blame]
Uwe Hermann9ff514d2010-06-07 19:41:25 +00001.TH FLASHROM 8 "Jun 06, 2010"
Stefan Reinauer261144c2006-07-27 23:29:02 +00002.SH NAME
Uwe Hermann530cb2d2009-05-14 22:58:21 +00003flashrom \- detect, read, write, verify and erase flash chips
Stefan Reinauer261144c2006-07-27 23:29:02 +00004.SH SYNOPSIS
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00005.B flashrom \fR[\fB\-n\fR] [\fB\-V\fR] [\fB\-f\fR] [\fB\-h\fR|\fB\-R\fR|\
6\fB\-L\fR|\fB\-z\fR|\fB\-E\fR|\fB\-r\fR <file>|\fB\-w\fR <file>|\
7\fB\-v\fR <file>]
Uwe Hermann9ff514d2010-06-07 19:41:25 +00008 [\fB\-c\fR <chipname>] [\fB\-m\fR [<vendor>:]<board>] \
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +00009[\fB\-l\fR <file>]
10 [\fB\-i\fR <image>] [\fB\-p\fR <programmername>[:<parameters>]]
Stefan Reinauer261144c2006-07-27 23:29:02 +000011.SH DESCRIPTION
12.B flashrom
Uwe Hermanne8ba5382009-05-22 11:37:27 +000013is a utility for detecting, reading, writing, verifying and erasing flash
Uwe Hermann530cb2d2009-05-14 22:58:21 +000014chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
15using a supported mainboard, but it also supports flashing of network cards
16(NICs), SATA controller cards, and other external devices which can program
17flash chips.
Uwe Hermanne74b9f82009-04-10 14:41:29 +000018.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000019It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40,
20and TSOP48 chips, which use various protocols such as LPC, FWH, parallel flash,
Uwe Hermannd42009c2009-04-11 13:59:00 +000021or SPI.
Stefan Reinauer261144c2006-07-27 23:29:02 +000022.SH OPTIONS
Uwe Hermann9ff514d2010-06-07 19:41:25 +000023.B IMPORTANT:
Carl-Daniel Hailfinger5de93412009-05-01 10:53:49 +000024Please note that the command line interface for flashrom will change before
25flashrom 1.0. Do not use flashrom in scripts or other automated tools without
Uwe Hermanne8ba5382009-05-22 11:37:27 +000026checking that your flashrom version won't interpret options in a different way.
Carl-Daniel Hailfinger5de93412009-05-01 10:53:49 +000027.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000028You can specify one of
29.BR \-h ", " \-R ", " \-L ", " \-z ", " \-E ", " \-r ", " \-w ", " \-v
30or no operation.
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000031If no operation is specified, flashrom will only probe for flash chips. It is
Michael Karcher31fd8252010-03-12 06:41:39 +000032recommended that if you try flashrom the first time on a system, you run it
33in probe only mode and check the output. Also you are advised to make a
Uwe Hermann9ff514d2010-06-07 19:41:25 +000034backup of your current ROM contents with
35.B \-r
36before you try to write a new image.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000037.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000038.B "\-r, \-\-read <file>"
39Read flash ROM contents and save them into the given
40.BR <file> .
Stefan Reinauerde063bf2006-09-21 13:09:22 +000041.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000042.B "\-w, \-\-write <file>"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000043Write
44.B <file>
Uwe Hermann9ff514d2010-06-07 19:41:25 +000045into flash ROM. This will first automatically
46.B erase
47the chip, then write to it.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000048.TP
Uwe Hermannea07f622009-06-24 17:31:08 +000049.B "\-n, \-\-noverify"
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000050Skip the automatic verification of flash ROM contents after writing. Using this
Uwe Hermannea07f622009-06-24 17:31:08 +000051option is
52.B not
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +000053recommended, you should only use it if you know what you are doing and if you
Uwe Hermannea07f622009-06-24 17:31:08 +000054feel that the time for verification takes too long.
55.sp
56Typical usage is:
Uwe Hermann9ff514d2010-06-07 19:41:25 +000057.B "flashrom \-n \-w <file>"
Uwe Hermannea07f622009-06-24 17:31:08 +000058.sp
59This option is only useful in combination with
60.BR \-\-write .
61.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +000062.B "\-v, \-\-verify <file>"
63Verify the flash ROM contents against the given
64.BR <file> .
Stefan Reinauerde063bf2006-09-21 13:09:22 +000065.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +000066.B "\-E, \-\-erase"
Uwe Hermanne74b9f82009-04-10 14:41:29 +000067Erase the flash ROM chip.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000068.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +000069.B "\-V, \-\-verbose"
Uwe Hermann9ff514d2010-06-07 19:41:25 +000070More verbose output. This option can be supplied multiple times
71(max. 2 times, i.e.
72.BR \-VV )
73for even more debug output.
Stefan Reinauerde063bf2006-09-21 13:09:22 +000074.TP
Stefan Reinauer261144c2006-07-27 23:29:02 +000075.B "\-c, \-\-chip" <chipname>
Uwe Hermann9ff514d2010-06-07 19:41:25 +000076Probe only for the specified flash ROM chip. This option takes the chip name as
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +000077printed by
78.B "flashrom \-L"
Uwe Hermann9ff514d2010-06-07 19:41:25 +000079without the vendor name as parameter. Please note that the chip name is
80case sensitive.
Joerg Mayer645c6df2010-03-13 14:47:48 +000081.TP
Uwe Hermann9ff514d2010-06-07 19:41:25 +000082.B "\-m, \-\-mainboard" [<vendor>:]<board>
Joerg Mayer645c6df2010-03-13 14:47:48 +000083Override mainboard settings.
84.sp
85flashrom reads the coreboot table to determine the current mainboard. If no
86coreboot table could be read or if you want to override these values, you can
87specify \-m, e.g.:
88.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +000089.B " flashrom \-\-mainboard AGAMI:ARUMA \-w agami_aruma.rom"
Joerg Mayer645c6df2010-03-13 14:47:48 +000090.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +000091See the 'Known boards' or 'Known laptops' section in the output
92of 'flashrom \-L' for a list of boards which require the specification of
93the board name, if no coreboot table is found.
Joerg Mayer645c6df2010-03-13 14:47:48 +000094.TP
95.B "\-f, \-\-force"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +000096Force one or more of the following actions:
Joerg Mayer645c6df2010-03-13 14:47:48 +000097.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +000098* Force chip read and pretend the chip is there.
99.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000100* Force chip access even if the chip is bigger than the maximum supported \
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000101size for the flash bus.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000102.sp
103* Force erase even if erase is known bad.
104.sp
105* Force write even if write is known bad.
Joerg Mayer645c6df2010-03-13 14:47:48 +0000106.TP
107.B "\-l, \-\-layout <file>"
108Read ROM layout from
109.BR <file> .
Uwe Hermann87c07932009-05-05 16:15:46 +0000110.sp
111flashrom supports ROM layouts. This allows you to flash certain parts of
112the flash chip only. A ROM layout file looks like follows:
113.sp
114 00000000:00008fff gfxrom
115 00009000:0003ffff normal
116 00040000:0007ffff fallback
117.sp
118 i.e.:
119 startaddr:endaddr name
120.sp
121All addresses are offsets within the file, not absolute addresses!
122If you only want to update the normal image in a ROM you can say:
123.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000124.B " flashrom \-\-layout rom.layout \-\-image normal \-w agami_aruma.rom"
Uwe Hermann87c07932009-05-05 16:15:46 +0000125.sp
126To update normal and fallback but leave the VGA BIOS alone, say:
127.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000128.B " flashrom \-l rom.layout \-i normal \"
Uwe Hermann87c07932009-05-05 16:15:46 +0000129.br
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000130.B " \-i fallback \-w agami_aruma.rom"
Uwe Hermann87c07932009-05-05 16:15:46 +0000131.sp
132Currently overlapping sections are not supported.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000133.TP
Uwe Hermanne74b9f82009-04-10 14:41:29 +0000134.B "\-i, \-\-image <name>"
Uwe Hermann67808fe2007-10-18 00:29:05 +0000135Only flash image
136.B <name>
137from flash layout.
Stefan Reinauerde063bf2006-09-21 13:09:22 +0000138.TP
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000139.B "\-L, \-\-list\-supported"
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000140List the flash chips, chipsets, mainboards, and PCI card "programmers"
141supported by flashrom.
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000142.sp
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000143There are many unlisted boards which will work out of the box, without
144special support in flashrom. Please let us know if you can verify that
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000145other boards work or do not work out of the box.
146.sp
147.B IMPORTANT:
148For verification you have
Uwe Hermanne8ba5382009-05-22 11:37:27 +0000149to test an ERASE and/or WRITE operation, so make sure you only do that
150if you have proper means to recover from failure!
Uwe Hermanne5ac1642008-03-12 11:54:51 +0000151.TP
Uwe Hermann20a293f2009-06-19 10:42:43 +0000152.B "\-z, \-\-list\-supported-wiki"
153Same as
154.BR \-\-list\-supported ,
155but outputs the supported hardware in MediaWiki syntax, so that it can be
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000156easily pasted into the wiki page at http://www.flashrom.org/. Please note
157that MediaWiki output is not compiled in by default.
Uwe Hermann20a293f2009-06-19 10:42:43 +0000158.TP
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000159.B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]"
Carl-Daniel Hailfingerce986772009-05-09 00:27:07 +0000160Specify the programmer device. Currently supported are:
161.sp
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000162.BR "* internal" " (default, for in-system flashing in the mainboard)"
163.sp
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000164.BR "* dummy" " (just prints all operations and accesses)"
165.sp
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000166.BR "* nic3com" " (for flash ROMs on 3COM network cards)"
167.sp
Uwe Hermann829ed842010-05-24 17:39:14 +0000168.BR "* nicrealtek" " (for flash ROMs on Realtek network cards)"
169.sp
170.BR "* nicsmc1211" " (for flash ROMs on RTL8139-compatible SMC2 network cards)"
171.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000172.BR "* nicnatsemi" " (for flash ROMs on National Semiconductor DP838* network \
173cards)"
174.sp
Uwe Hermann2bc98f62009-09-30 18:29:55 +0000175.BR "* gfxnvidia" " (for flash ROMs on NVIDIA graphics cards)"
176.sp
TURBO Jb0912c02009-09-02 23:00:46 +0000177.BR "* drkaiser" " (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)"
178.sp
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000179.BR "* satasii" " (for flash ROMs on Silicon Image SATA/IDE controllers)"
180.sp
Uwe Hermannddd5c9e2010-02-21 21:17:00 +0000181.BR "* atahpt" " (for flash ROMs on Highpoint ATA/RAID controllers)"
182.sp
Jรถrg Fischer6529b9f2010-07-29 15:54:53 +0000183.BR "* it87spi" " (for flash ROMs behind an ITE IT87xx Super I/O LPC/SPI \
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000184translation unit)"
Carl-Daniel Hailfingerb8afecd2009-05-31 18:00:57 +0000185.sp
Jรถrg Fischer6529b9f2010-07-29 15:54:53 +0000186.BR "* ft2232_spi" " (for SPI flash ROMs attached to a FT2232H/FT4232H/JTAGkey \
187based USB SPI programmer)"
Paul Fox05dfbe62009-06-16 21:08:06 +0000188.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000189.BR "* serprog" " (for flash ROMs attached to a programmer speaking serprog)"
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000190.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000191.BR "* buspirate_spi" " (for SPI flash ROMs attached to a Bus Pirate)"
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000192.sp
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000193.BR "* dediprog" " (for SPI flash ROMs attached to a Dediprog SF100)"
194.sp
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000195.BR "* rayer_spi" " (for SPI flash ROMs attached to a RayeR parport \
196based programmer)"
197.sp
Idwer Vollering004f4b72010-09-03 18:21:21 +0000198.BR "* nicintel_spi" " (for SPI flash ROMs attached to an Intel Gigabit \
199network cards)"
200.sp
Michael Karchere5eafb22010-03-07 12:11:08 +0000201Some programmers have optional or mandatory parameters which are described
202in detail in the
203.B PROGRAMMER SPECIFIC INFO
204section. Support for some programmers can be disabled at compile time.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000205.B "flashrom \-h"
Michael Karchere5eafb22010-03-07 12:11:08 +0000206lists all supported programmers.
207.TP
208.B "\-h, \-\-help"
209Show a help text and exit.
210.TP
211.B "\-R, \-\-version"
212Show version information and exit.
213.SH PROGRAMMER SPECIFIC INFO
214Some programmer drivers accept further parameters to set programmer-specific
Uwe Hermann4e3d0b32010-03-25 23:18:41 +0000215parameters. These parameters are separated from the programmer name by a
Michael Karchere5eafb22010-03-07 12:11:08 +0000216colon. While some programmers take arguments at fixed positions, other
217programmers use a key/value interface in which the key and value is separated
218by an equal sign and different pairs are separated by a comma or a colon.
219.TP
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000220.BR "internal " programmer
221Some mainboards require to run mainboard specific code to enable flash erase
222and write support (and probe support on old systems with parallel flash).
223The mainboard brand and model (if it requires specific code) is usually
224autodetected using one of the following mechanisms: If your system is
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000225running coreboot, the mainboard type is determined from the coreboot table.
226Otherwise, the mainboard is detected by examining the onboard PCI devices
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000227and possibly DMI info. If PCI and DMI do not contain information to uniquely
228identify the mainboard (which is the exception), it might be necessary to
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000229specify the mainboard using the
230.B \-m
231switch (see above).
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000232.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000233Some of these board-specific flash enabling functions (called
234.BR "board enables" )
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000235in flashrom have not yet been tested. If your mainboard is detected needing
236an untested board enable function, a warning message is printed and the
237board enable is not executed, because a wrong board enable function might
238cause the system to behave erratically, as board enable functions touch the
239low-level internals of a mainboard. Not executing a board enable function
240(if one is needed) might cause detection or erasing failure. If your board
241protects only part of the flash (commonly the top end, called boot block),
242flashrom might encounter an error only after erasing the unprotected part,
243so running without the board-enable function might be dangerous for erase
244and write (which includes erase).
245.sp
246The suggested procedure for a mainboard with untested board specific code is
247to first try to probe the ROM (just invoke flashrom and check that it
248detects your flash chip type) without running the board enable code (i.e.
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000249without any parameters). If it finds your chip, fine. Otherwise, retry
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000250probing your chip with the board-enable code running, using
251.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000252.B " flashrom \-p internal:boardenable=force"
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000253.sp
254If your chip is still not detected, the board enable code seems to be broken
255or the flash chip unsupported. Otherwise, make a backup of your current ROM
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000256contents (using
257.BR \-r )
258and store it to a medium outside of your computer, like
259a USB drive or a network share. If you needed to run the board enable code
Michael Karcher7f0c3ec2010-03-07 22:29:28 +0000260already for probing, use it for reading too. Now you can try to write the
261new image. You should enable the board enable code in any case now, as it
262has been written because it is known that writing/erasing without the board
263enable is going to fail. In any case (success or failure), please report to
264the flashrom mailing list, see below.
265.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000266On systems running coreboot, flashrom checks whether the desired image matches
267your mainboard. This needs some special board ID to be present in the image.
268If flashrom detects that the image you want to write and the current board
269do not match, it will refuse to write the image unless you specify
270.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000271.B " flashrom \-p internal:boardmismatch=force"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000272.sp
Carl-Daniel Hailfinger01f3ef42010-03-25 02:50:40 +0000273If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000274translation, flashrom should autodetect that configuration. You can use the
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000275.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000276.B " flashrom \-p internal:it87spiport=portnum"
277.sp
Carl-Daniel Hailfinger01f3ef42010-03-25 02:50:40 +0000278syntax as explained in the
279.B it87spi
280programmer section to use a non-default port for controlling the IT87 series
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000281Super I/O. In the unlikely case flashrom doesn't detect an active
282IT87 LPC<->SPI bridge, you can try to force recognition by using the
283.B it87spi
284programmer.
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000285.sp
286Using flashrom on laptops is dangerous and may easily make your hardware
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000287unusable (see also the
288.B BUGS
289section). The embedded controller (EC) in these
290machines often interacts badly with flashing.
291.B http://www.flashrom.org/Laptops
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000292has more information. If flash is shared with the EC, erase is guaranteed to
293brick your laptop and write is very likely to brick your laptop.
294Chip read and probe may irritate your EC and cause fan failure, backlight
295failure, sudden poweroff, and other nasty effects.
296flashrom will attempt to detect laptops and abort immediately for safety
297reasons.
298If you want to proceed anyway at your own risk, use
299.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000300.B " flashrom \-p internal:laptop=force_I_want_a_brick"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000301.sp
302You have been warned.
303.sp
304We will not help you if you force flashing on a laptop because this is a really
305dumb idea.
Carl-Daniel Hailfinger01f3ef42010-03-25 02:50:40 +0000306.TP
Michael Karchere5eafb22010-03-07 12:11:08 +0000307.BR "dummy " programmer
308An optional parameter specifies the bus types it
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000309should support. For that you have to use the
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000310.B "flashrom \-p dummy:bus=[type[+type[+type]]]"
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000311syntax where
312.B type
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000313can be any of
314.BR parallel ", " lpc ", " fwh ", " spi
315in any order. If you specify bus without type, all buses will be disabled.
316If you do not specify bus, all buses will be enabled.
Carl-Daniel Hailfinger3504b532009-06-01 00:02:11 +0000317.sp
318Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000319.B "flashrom \-p dummy:bus=lpc+fwh"
Michael Karchere5eafb22010-03-07 12:11:08 +0000320.TP
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000321.BR "nic3com" , " nicrealtek" , " nicsmc1211" , " nicnatsemi" , " gfxnvidia\
322" , " satasii " and " atahpt " programmers
Michael Karchere5eafb22010-03-07 12:11:08 +0000323These programmers have an option to specify the PCI address of the card
324your want to use, which must be specified if more than one card supported
325by the selected programmer is installed in your system. The syntax is
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000326.BR "flashrom \-p xxxx:pci=bb:dd.f" ,
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000327where
Uwe Hermannc7e8a0c2009-05-19 14:14:21 +0000328.B xxxx
329is the name of the programmer
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000330.B bb
331is the PCI bus number,
332.B dd
333is the PCI device number, and
334.B f
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000335is the PCI function number of the desired device.
Uwe Hermann530cb2d2009-05-14 22:58:21 +0000336.sp
337Example:
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000338.B "flashrom \-p nic3com:pci=05:04.0"
Michael Karchere5eafb22010-03-07 12:11:08 +0000339.TP
340.BR "it87spi " programmer
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000341An optional
342.B it87spiport
343parameter sets the I/O base port of the IT87 series SPI controller
Michael Karchere5eafb22010-03-07 12:11:08 +0000344interface to the port specified in the parameter instead of using the port
345address set by the BIOS. For that you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000346.sp
347.B " flashrom \-p it87spi:it87spiport=portnum"
348.sp
Carl-Daniel Hailfingerbb297f72009-07-11 18:05:42 +0000349syntax where
350.B portnum
351is an I/O port number which must be a multiple of 8.
Michael Karchere5eafb22010-03-07 12:11:08 +0000352.TP
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000353.BR "ft2232_spi " programmer
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000354An optional parameter specifies the controller
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000355type and interface/port it should support. For that you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000356.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000357.B " flashrom \-p ft2232_spi:type=model,port=interface"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000358.sp
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000359syntax where
360.B model
361can be any of
Uwe Hermann48ec1b12010-08-08 17:01:18 +0000362.BR 2232H ", " JTAGkey ", or " 4232H
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000363and
364.B interface
365can be any of
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000366.BR A ", or " B .
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +0000367The default model is
368.B 4232H
369and the default interface is
370.BR B .
Michael Karchere5eafb22010-03-07 12:11:08 +0000371.TP
372.BR "serprog " programmer
373A mandatory parameter specifies either a serial
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000374device/baud combination or an IP/port combination for communication with the
Michael Karchere5eafb22010-03-07 12:11:08 +0000375programmer. In the device/baud combination, the device has to start with a
376slash. For serial, you have to use the
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000377.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000378.B " flashrom \-p serprog:dev=/dev/device:baud"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000379.sp
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000380syntax and for IP, you have to use
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000381.sp
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000382.B " flashrom \-p serprog:ip=ipaddr:port"
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000383.sp
384instead. More information about serprog is available in
385.B serprog-protocol.txt
386in the source distribution.
Michael Karchere5eafb22010-03-07 12:11:08 +0000387.TP
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +0000388.BR "buspirate_spi " programmer
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000389A required
390.B dev
391parameter specifies the Bus Pirate device node and an optional
392.B spispeed
393parameter specifies the frequency of the SPI bus. The parameter
Michael Karchere5eafb22010-03-07 12:11:08 +0000394delimiter is a comma. Syntax is
Carl-Daniel Hailfingerdfade102009-08-18 23:51:22 +0000395.sp
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000396.B "flashrom \-p buspirate_spi:dev=/dev/device,spispeed=frequency"
Michael Karchere5eafb22010-03-07 12:11:08 +0000397.sp
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000398where
399.B frequency
400can be any of
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000401.BR 30k ", " 125k ", " 250k ", " 1M ", " 2M ", " 2.6M ", " 4M ", " 8M
Michael Karchere5eafb22010-03-07 12:11:08 +0000402(in Hz). The default is the maximum frequency of 8 MHz.
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000403.TP
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000404.BR "dediprog " programmer
405No parameters defined yet.
406.TP
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000407.BR "rayer_spi " programmer
Carl-Daniel Hailfinger37c42522010-10-05 19:19:48 +0000408The default I/O base address used for the parallel port is 0x378 and you can use
409the optional
410.B iobase
411parameter to specify an alternate base I/O address with the
412.sp
413.B " flashrom \-p rayer_spi:iobase=baseaddr"
414.sp
415syntax where
416.B baseaddr
417is base I/O port address of the parallel port, which must be a multiple of
418four. Make sure to not forget the "0x" prefix for hexadecimal port addresses.
419.sp
420More information about the hardware is available at
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000421http://rayer.ic.cz/elektro/spipgm.htm
Peter Stuge42688e52009-01-26 02:20:56 +0000422.SH EXIT STATUS
423flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
424(/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000425.SH REQUIREMENTS
426flashrom needs different access permissions for different programmers.
427.sp
428.B internal
429needs raw memory access, PCI configuration space access, raw I/O port
430access (x86) and MSR access (x86).
431.sp
432.B it87spi
433needs raw I/O port access (x86).
434.sp
435.BR nic3com ", " nicrealtek ", " nicsmc1211 " and " nicnatsemi "
436need PCI configuration space read access and raw I/O port access.
437.sp
438.B atahpt
439needs PCI configuration space access and raw I/O port access.
440.sp
441.BR gfxnvidia " and " drkaiser
442need PCI configuration space access and raw memory access.
443.sp
Carl-Daniel Hailfingere7fdd6e2010-07-21 10:26:01 +0000444.B rayer_spi
445needs raw I/O port access.
446.sp
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000447.B satasii
448needs PCI configuration space read access and raw memory access.
449.sp
450.B serprog
451needs TCP access to the network or userspace access to a serial port.
452.sp
453.B buspirate_spi
454needs userspace access to a serial port.
455.sp
456.BR dediprog " and " ft2232_spi
457need access to the USB device via libusb.
458.sp
459.B dummy
460needs no access permissions at all.
461.sp
462.BR internal ", " it87spi ", " nic3com ", " nicrealtek ", " nicsmc1211 ", "
463.BR nicnatsemi ", " "gfxnvidia" ", " drkaiser ", " satasii " and " atahpt
464have to be run as superuser/root, and need additional raw access permission.
465.sp
466.BR serprog ", " buspirate_spi ", " dediprog " and " ft2232_spi
467can be run as normal user on most operating systems if appropriate device
468permissions are set.
469.sp
470On OpenBSD, you can obtain raw access permission by setting
471securelevel=-1 in /etc/rc.securelevel and rebooting, or rebooting into single
472user mode.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000473.SH BUGS
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000474Please report any bugs at
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000475.sp
476.B " http://www.flashrom.org/trac/flashrom/newticket"
477.sp
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000478or on the flashrom mailing list at
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000479.B "<flashrom@flashrom.org>"
480.sp
481We recommend to subscribe first at
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000482.sp
483.B " http://www.flashrom.org/mailman/listinfo/flashrom"
Carl-Daniel Hailfinger27023762010-04-28 15:22:14 +0000484.sp
485Using flashrom on laptops is dangerous and may easily make your hardware
486unusable unless you can desolder the flash chip and have a full flash chip
487backup. This is caused by the embedded controller (EC) present in many laptops,
488which interacts badly with any flash attempts. This is a hardware limitation
489and flashrom will attempt to detect it and abort immediately for safety reasons.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000490.SH LICENCE
491.B flashrom
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000492is covered by the GNU General Public License (GPL), version 2. Some files are
493additionally available under the GPL (version 2, or any later version).
Stefan Reinauer261144c2006-07-27 23:29:02 +0000494.SH COPYRIGHT
Stefan Reinauer261144c2006-07-27 23:29:02 +0000495.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000496Please see the individual files.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000497.SH AUTHORS
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000498Andrew Morgan
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000499.br
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000500Carl-Daniel Hailfinger
501.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000502Claus Gindhart
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000503.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000504David Borg
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000505.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000506David Hendricks
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000507.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000508Dominik Geyer
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000509.br
Stefan Reinaueredc61882010-01-03 14:40:30 +0000510Eric Biederman
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000511.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000512Giampiero Giancipoli
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000513.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000514Helge Wagner
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000515.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000516Idwer Vollering
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000517.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000518Joe Bao
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000519.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000520Jรถrg Fischer
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000521.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000522Joshua Roys
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000523.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000524Luc Verhaegen
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000525.br
Carl-Daniel Hailfinger451dc802009-05-01 11:00:39 +0000526Li-Ta Lo
527.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000528Markus Boas
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000529.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000530Mattias Mattsson
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000531.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000532Michael Karcher
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000533.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000534Nikolay Petukhov
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000535.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000536Patrick Georgi
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000537.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000538Peter Lemenkov
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000539.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000540Peter Stuge
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000541.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000542Reinder E.N. de Haan
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000543.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000544Ronald G. Minnich
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000545.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000546Ronald Hoogenboom
Stefan Reinauer261144c2006-07-27 23:29:02 +0000547.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000548Sean Nelson
Carl-Daniel Hailfinger8841d3e2010-05-15 15:04:37 +0000549.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000550Stefan Reinauer
Stefan Reinauer261144c2006-07-27 23:29:02 +0000551.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000552Stefan Wildemann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000553.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000554Stephan Guilloux
Carl-Daniel Hailfinger3e854422010-10-06 23:03:21 +0000555.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000556Steven James
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000557.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000558Uwe Hermann
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000559.br
Stefan Reinaueredc61882010-01-03 14:40:30 +0000560Wang Qingpei
Carl-Daniel Hailfinger851ecf22009-01-08 04:56:59 +0000561.br
Stefan Reinaueredc61882010-01-03 14:40:30 +0000562Yinghai Lu
Stefan Reinauerf8337dd2006-08-03 10:49:09 +0000563.br
Carl-Daniel Hailfingeref697832010-10-07 22:21:45 +0000564some others, please see the flashrom svn changelog for details.
565.br
566All authors can be reached via e-mail at <flashrom@flashrom.org>.
Stefan Reinauer261144c2006-07-27 23:29:02 +0000567.PP
Uwe Hermann9ff514d2010-06-07 19:41:25 +0000568This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>
569and Carl-Daniel Hailfinger.
Uwe Hermann42eb17f2008-01-18 17:48:51 +0000570It is licensed under the terms of the GNU GPL (version 2 or later).