table of contents
other versions
- wheezy 0.9.5.2+r1546-1
- jessie 0.9.7+r1782-1
- jessie-backports 0.9.7+r1782-1~bpo7+1
- testing 0.9.9+r1954-1+b1
- unstable 0.9.9+r1954-1+b1
| FLASHROM(8) | System Manager's Manual | FLASHROM(8) |
NAME¶
flashrom - detect, read, write, verify and erase flash chipsSYNOPSIS¶
flashrom [-n] [-V] [-f] [-h|-R|-L|-z|-E|-r <file>|-w <file>| -v <file>][ -c <chipname>] [-l <file>]
[ -i <image>] [-p <programmername>[:<parameters>]]
DESCRIPTION¶
flashrom is a utility for detecting, reading, writing, verifying and erasing flash chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system using a supported mainboard. However, it also supports various external PCI/USB/parallel-port/serial-port based devices which can program flash chips, including some network cards (NICs), SATA/IDE controller cards, graphics cards, the Bus Pirate device, various FTDI FT2232/FT4232H based USB devices, and more. It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40, TSOP48, and BGA chips, which use various protocols such as LPC, FWH, parallel flash, or SPI.OPTIONS¶
IMPORTANT: Please note that the command line interface for flashrom will change before flashrom 1.0. Do not use flashrom in scripts or other automated tools without checking that your flashrom version won't interpret options in a different way. You can specify one of -h, -R, -L, -z, -E, -r, -w, -v or no operation. If no operation is specified, flashrom will only probe for flash chips. It is recommended that if you try flashrom the first time on a system, you run it in probe-only mode and check the output. Also you are advised to make a backup of your current ROM contents with -r before you try to write a new image.- -r, --read <file>
- Read flash ROM contents and save them into the given <file>. If the file already exists, it will be overwritten.
- -w, --write <file>
- Write <file> into flash ROM. This will first
automatically erase the chip, then write to it.
In the process the chip is also read several times. First an in-memory backup is made for disaster recovery and to be able to skip regions that are already equal to the image file. This copy is updated along with the write operation. In case of erase errors it is even re-read completely. After writing has finished and if verification is enabled, the whole flash chip is read out and compared with the input image.
- -n, --noverify
- Skip the automatic verification of flash ROM contents after
writing. Using this option is not recommended, you should only use
it if you know what you are doing and if you feel that the time for
verification takes too long.
Typical usage is: flashrom -n -w <file>This option is only useful in combination with --write.
- -v, --verify <file>
- Verify the flash ROM contents against the given <file>.
- -E, --erase
- Erase the flash ROM chip.
- -V, --verbose
- More verbose output. This option can be supplied multiple times (max. 3 times, i.e. -VVV) for even more debug output.
- -c, --chip <chipname>
- Probe only for the specified flash ROM chip. This option takes the chip name as printed by flashrom -L without the vendor name as parameter. Please note that the chip name is case sensitive.
- -f, --force
- Force one or more of the following actions:
* Force chip read and pretend the chip is there.* Force chip access even if the chip is bigger than the maximum supported size for the flash bus.* Force erase even if erase is known bad.* Force write even if write is known bad.
- -l, --layout <file>
- Read ROM layout from <file>.
flashrom supports ROM layouts. This allows you to flash certain parts of the flash chip only. A ROM layout file looks like follows:
00000000:00008fff gfxrom
00009000:0003ffff normal
00040000:0007ffff fallback
i.e.:
startaddr:endaddr nameAll addresses are offsets within the file, not absolute addresses! If you only want to update the normal image in a ROM you can say:flashrom --layout rom.layout --image normal -w agami_aruma.romTo update normal and fallback but leave the VGA BIOS alone, say:flashrom -l rom.layout -i normal-i fallback -w agami_aruma.romCurrently overlapping sections are not supported.
- -i, --image <name>
- Only flash image <name> from flash layout.
- -L, --list-supported
- List the flash chips, chipsets, mainboards, and external
programmers (including PCI, USB, parallel port, and serial port based
devices) supported by flashrom.
There are many unlisted boards which will work out of the box, without special support in flashrom. Please let us know if you can verify that other boards work or do not work out of the box.IMPORTANT: For verification you have to test an ERASE and/or WRITE operation, so make sure you only do that if you have proper means to recover from failure!
- -z, --list-supported-wiki
- Same as --list-supported, but outputs the supported hardware in MediaWiki syntax, so that it can be easily pasted into the wiki page at http://www.flashrom.org/. Please note that MediaWiki output is not compiled in by default.
- -p, --programmer <name>[:parameter[,parameter[,parameter]]]
- Specify the programmer device. Currently supported are:
* internal (default, for in-system flashing in the mainboard)* dummy (virtual programmer for testing flashrom)* nic3com (for flash ROMs on 3COM network cards)* nicrealtek (for flash ROMs on Realtek network cards)* nicsmc1211 (for flash ROMs on RTL8139-compatible SMC2 network cards)* nicnatsemi (for flash ROMs on National Semiconductor DP838* network cards)* nicintel (for parallel flash ROMs on Intel 10/100Mbit network cards)* gfxnvidia (for flash ROMs on NVIDIA graphics cards)* drkaiser (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)* satasii (for flash ROMs on Silicon Image SATA/IDE controllers)* satamv (for flash ROMs on Marvell SATA controllers)* atahpt (for flash ROMs on Highpoint ATA/RAID controllers)* ft2232_spi (for SPI flash ROMs attached to an FT2232/FT4232H family based USB SPI programmer), including the DLP Design DLP-USB1232H, FTDI FT2232H Mini-Module, FTDI FT4232H Mini-Module, openbiosprog-spi, Amontec JTAGkey/JTAGkey-tiny/JTAGkey-2, Dangerous Prototypes Bus Blaster, Olimex ARM-USB-TINY/-H, Olimex ARM-USB-OCD/-H, TIAO/DIYGADGET USB Multi-Protocol Adapter (TUMPA), and GOEPEL PicoTAP.* serprog (for flash ROMs attached to a programmer speaking serprog), including AVR flasher by Urja Rannikko, AVR flasher by eightdot, Arduino Mega flasher by fritz, InSystemFlasher by Juhana Helovuo, and atmegaXXu2-flasher by Stefan Tauner.* buspirate_spi (for SPI flash ROMs attached to a Bus Pirate)* dediprog (for SPI flash ROMs attached to a Dediprog SF100)* rayer_spi (for SPI flash ROMs attached to a RayeR parport or Xilinx DLC5 compatible cable)* pony_spi (for SPI flash ROMs attached to a SI-Prog serial port bitbanging adapter)* nicintel_spi (for SPI flash ROMs on Intel Gigabit network cards)* ogp_spi (for SPI flash ROMs on Open Graphics Project graphics card)* linux_spi (for SPI flash ROMs accessible via /dev/spidevX.Y on Linux)Some programmers have optional or mandatory parameters which are described in detail in the PROGRAMMER SPECIFIC INFO section. Support for some programmers can be disabled at compile time. flashrom -h lists all supported programmers.
- -h, --help
- Show a help text and exit.
- -R, --version
- Show version information and exit.
PROGRAMMER SPECIFIC INFO¶
Some programmer drivers accept further parameters to set programmer-specific parameters. These parameters are separated from the programmer name by a colon. While some programmers take arguments at fixed positions, other programmers use a key/value interface in which the key and value is separated by an equal sign and different pairs are separated by a comma or a colon.internal programmer¶
- Board Enables
-
Some mainboards require to run mainboard specific code to enable flash erase and write support (and probe support on old systems with parallel flash). The mainboard brand and model (if it requires specific code) is usually autodetected using one of the following mechanisms: If your system is running coreboot, the mainboard type is determined from the coreboot table. Otherwise, the mainboard is detected by examining the onboard PCI devices and possibly DMI info. If PCI and DMI do not contain information to uniquely identify the mainboard (which is the exception), or if you want to override the detected mainboard model, you can specify the mainboard using theflashrom -p internal:mainboard=[<vendor>:]<board> syntax.See the 'Known boards' or 'Known laptops' section in the output of 'flashrom -L' for a list of boards which require the specification of the board name, if no coreboot table is found.Some of these board-specific flash enabling functions (called board enables) in flashrom have not yet been tested. If your mainboard is detected needing an untested board enable function, a warning message is printed and the board enable is not executed, because a wrong board enable function might cause the system to behave erratically, as board enable functions touch the low-level internals of a mainboard. Not executing a board enable function (if one is needed) might cause detection or erasing failure. If your board protects only part of the flash (commonly the top end, called boot block), flashrom might encounter an error only after erasing the unprotected part, so running without the board-enable function might be dangerous for erase and write (which includes erase).The suggested procedure for a mainboard with untested board specific code is to first try to probe the ROM (just invoke flashrom and check that it detects your flash chip type) without running the board enable code (i.e. without any parameters). If it finds your chip, fine. Otherwise, retry probing your chip with the board-enable code running, usingflashrom -p internal:boardenable=forceIf your chip is still not detected, the board enable code seems to be broken or the flash chip unsupported. Otherwise, make a backup of your current ROM contents (using -r) and store it to a medium outside of your computer, like a USB drive or a network share. If you needed to run the board enable code already for probing, use it for reading too. Now you can try to write the new image. You should enable the board enable code in any case now, as it has been written because it is known that writing/erasing without the board enable is going to fail. In any case (success or failure), please report to the flashrom mailing list, see below.
- Coreboot
-
On systems running coreboot, flashrom checks whether the desired image matches your mainboard. This needs some special board ID to be present in the image. If flashrom detects that the image you want to write and the current board do not match, it will refuse to write the image unless you specifyflashrom -p internal:boardmismatch=force
- ITE IT87 Super I/O
-
If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus translation, flashrom should autodetect that configuration. If you want to set the I/O base port of the IT87 series SPI controller manually instead of using the value provided by the BIOS, use theflashrom -p internal:it87spiport=portnumsyntax where portnum is the I/O port number (must be a multiple of 8). In the unlikely case flashrom doesn't detect an active IT87 LPC<->SPI bridge, please send a bug report so we can diagnose the problem.
- Intel chipsets
-
If you have an Intel chipset with an ICH8 or later southbridge with SPI flash attached, and if a valid descriptor was written to it (e.g. by the vendor), the chipset provides an alternative way to access the flash chip(s) named Hardware Sequencing. It is much simpler than the normal access method (called Software Sequencing), but does not allow the software to choose the SPI commands to be sent. You can use theflashrom -p internal:ich_spi_mode=valuesyntax where value can be auto, swseq or hwseq. By default (or when setting ich_spi_mode=auto) the module tries to use swseq and only activates hwseq if need be (e.g. if important opcodes are inaccessible due to lockdown; or if more than one flash chip is attached). The other options (swseq, hwseq) select the respective mode (if possible).ICH8 and later southbridges may also have locked address ranges of different kinds if a valid descriptor was written to it. The flash address space is then partitioned in multiple so called "Flash Regions" containing the host firmware, the ME firmware and so on respectively. The flash descriptor can also specify up to 5 so called "Protected Regions", which are freely chosen address ranges independent from the aforementioned "Flash Regions". All of them can be write and/or read protected individually. If flashrom detects such a lock it will disable write support unless the user forces it with theflashrom -p internal:ich_spi_force=yessyntax. If this leads to erase or write accesses to the flash it would most probably bring it into an inconsistent and unbootable state and we will not provide any support in such a case.If you have an Intel chipset with an ICH6 or later southbridge and if you want to set specific IDSEL values for a non-default flash chip or an embedded controller (EC), you can use theflashrom -p internal:fwh_idsel=valuesyntax where value is the 48-bit hexadecimal raw value to be written in the IDSEL registers of the Intel southbridge. The upper 32 bits use one hex digit each per 512 kB range between 0xffc00000 and 0xffffffff, and the lower 16 bits use one hex digit each per 1024 kB range between 0xff400000 and 0xff7fffff. The rightmost hex digit corresponds with the lowest address range. All address ranges have a corresponding sister range 4 MB below with identical IDSEL settings. The default value for ICH7 is given in the example below.Example: flashrom -p internal:fwh_idsel=0x001122334567
- Laptops
-
Using flashrom on laptops is dangerous and may easily make your hardware unusable (see also the BUGS section). The embedded controller (EC) in these machines often interacts badly with flashing. http://www.flashrom.org/Laptops has more information. For example the EC firmware sometimes resides on the same flash chip as the host firmware. While flashrom tries to change the contents of that memory the EC might need to fetch new instructions or data from it and could stop working correctly. Probing for and reading from the chip may also irritate your EC and cause fan failure, backlight failure, sudden poweroff, and other nasty effects. flashrom will attempt to detect if it is running on a laptop and abort immediately for safety reasons if it clearly identifies the host computer as one. If you want to proceed anyway at your own risk, useflashrom -p internal:laptop=force_I_want_a_brickWe will not help you if you force flashing on a laptop because this is a really dumb idea.You have been warned.Currently we rely on the chassis type encoded in the DMI/SMBIOS data to detect laptops. Some vendors did not implement those bits correctly or set them to generic and/or dummy values. flashrom will then issue a warning and bail out like above. In this case you can useflashrom -p internal:laptop=this_is_not_a_laptopto tell flashrom (at your own risk) that it does not running on a laptop.
dummy programmer¶
The dummy programmer operates on a buffer in memory only. It provides a safe and fast way to test various aspects of flashrom and is mainly used in development and while debugging.- Persistent images
-
If you use flash chip emulation, flash image persistence is available as well by using theflashrom -p dummy:emulate=chip,image=image.romsyntax where image.rom is the file where the simulated chip contents are read on flashrom startup and where the chip contents on flashrom shutdown are written to.Example: flashrom -p dummy:emulate=M25P10.RES,image=dummy.bin
- SPI write chunk size
-
If you use SPI flash chip emulation for a chip which supports SPI page write with the default opcode, you can set the maximum allowed write chunk size with theflashrom -p dummy:emulate=chip,spi_write_256_chunksize=sizesyntax where size is the number of bytes (min. 1, max. 256).Example:flashrom -p dummy:emulate=M25P10.RES,spi_write_256_chunksize=5
- SPI blacklist
-
To simulate a programmer which refuses to send certain SPI commands to the flash chip, you can specify a blacklist of SPI commands with theflashrom -p dummy:spi_blacklist=commandlistsyntax where commandlist is a list of two-digit hexadecimal representations of SPI commands. If commandlist is e.g. 0302, flashrom will behave as if the SPI controller refuses to run command 0x03 (READ) and command 0x02 (WRITE). commandlist may be up to 512 characters (256 commands) long. Implementation note: flashrom will detect an error during command execution.
- SPI ignorelist
-
To simulate a flash chip which ignores (doesn't support) certain SPI commands, you can specify an ignorelist of SPI commands with theflashrom -p dummy:spi_ignorelist=commandlistsyntax where commandlist is a list of two-digit hexadecimal representations of SPI commands. If commandlist is e.g. 0302, the emulated flash chip will ignore command 0x03 (READ) and command 0x02 (WRITE). commandlist may be up to 512 characters (256 commands) long. Implementation note: flashrom won't detect an error during command execution.
- SPI status register
-
You can specify the initial content of the chip's status register with theflashrom -p dummy:spi_status=contentsyntax where content is an 8-bit hexadecimal value.
nic3com, nicrealtek, nicsmc1211, nicnatsemi, nicintel, nicintel_spi, gfxnvidia, ogp_spi, drkaiser, satasii, satamv, and atahpt programmers¶
These programmers have an option to specify the PCI address of the card your want to use, which must be specified if more than one card supported by the selected programmer is installed in your system. The syntax isft2232_spi programmer¶
An optional parameter specifies the controller type and interface/port it should support. For that you have to use theserprog programmer¶
A mandatory parameter specifies either a serial device/baud combination or an IP/port combination for communication with the programmer. In the device/baud combination, the device has to start with a slash. For serial, you have to use thebuspirate_spi programmer¶
A required dev parameter specifies the Bus Pirate device node and an optional spispeed parameter specifies the frequency of the SPI bus. The parameter delimiter is a comma. Syntax isdediprog programmer¶
An optional voltage parameter specifies the voltage the Dediprog should use. The default unit is Volt if no unit is specified. You can use mV, milliVolt, V or Volt as unit specifier. Syntax israyer_spi programmer¶
The default I/O base address used for the parallel port is 0x378 and you can use the optional iobase parameter to specify an alternate base I/O address with thepony_spi programmer¶
The serial port (like /dev/ttyS0, /dev/ttyUSB0 on Linux or COM3 on windows) is specified using the mandatory dev parameter. The adapter type is selectable between SI-Prog (used for SPI devices with PonyProg 2000) or a custom made serial bitbanging programmer named "serbang". The optional type parameter accepts the values "si_prog" (default) or "serbang".ogp_spi programmer¶
The flash ROM chip to access must be specified with the rom parameter.linux_spi programmer¶
You have to specify the SPI controller to use with theEXIT STATUS¶
flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem (/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.REQUIREMENTS¶
flashrom needs different access permissions for different programmers.BUGS¶
Please report any bugs to the flashrom mailing list at <flashrom@flashrom.org>Laptops¶
Using flashrom on laptops is dangerous and may easily make your hardware unusable. flashrom will attempt to detect if it is running on a laptop and abort immediately for safety reasons. Please see the detailed discussion of this topic and associated flashrom options in the Laptops paragraph in the internal programmer subsection of the PROGRAMMER SPECIFIC INFO section. http://www.flashrom.org/LaptopsOne-time programmable (OTP) memory and unique IDs¶
Some flash chips contain OTP memory often denoted as "security registers". They usually have a capacity in the range of some bytes to a few hundred bytes and can be used to give devices unique IDs etc. flashrom is not able to read or write these memories and may therefore not be able to duplicate a chip completely. For chip types known to include OTP memories a warning is printed when they are detected.LICENSE¶
flashrom is covered by the GNU General Public License (GPL), version 2. Some files are additionally available under the GPL (version 2, or any later version).COPYRIGHT¶
Please see the individual files.AUTHORS¶
Andrew Morgan| February 15, 2012 |