Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 1 | .TH FLASHROM 8 "Apr 29, 2010" |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 2 | .SH NAME |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 3 | flashrom \- detect, read, write, verify and erase flash chips |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 4 | .SH SYNOPSIS |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 5 | .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>] |
| 8 | [\fB\-c\fR <chipname>] [\fB\-m\fR [<vendor>:]<part>] \ |
| 9 | [\fB\-l\fR <file>] |
| 10 | [\fB\-i\fR <image>] [\fB\-p\fR <programmername>[:<parameters>]] |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 11 | .SH DESCRIPTION |
| 12 | .B flashrom |
Uwe Hermann | e8ba538 | 2009-05-22 11:37:27 +0000 | [diff] [blame] | 13 | is a utility for detecting, reading, writing, verifying and erasing flash |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 14 | chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system |
| 15 | using a supported mainboard, but it also supports flashing of network cards |
| 16 | (NICs), SATA controller cards, and other external devices which can program |
| 17 | flash chips. |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 18 | .PP |
Uwe Hermann | d42009c | 2009-04-11 13:59:00 +0000 | [diff] [blame] | 19 | It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and |
| 20 | TSOP40 chips, which use various protocols such as LPC, FWH, parallel flash, |
| 21 | or SPI. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 22 | .SH OPTIONS |
Carl-Daniel Hailfinger | 5de9341 | 2009-05-01 10:53:49 +0000 | [diff] [blame] | 23 | Please note that the command line interface for flashrom will change before |
| 24 | flashrom 1.0. Do not use flashrom in scripts or other automated tools without |
Uwe Hermann | e8ba538 | 2009-05-22 11:37:27 +0000 | [diff] [blame] | 25 | checking that your flashrom version won't interpret options in a different way. |
Carl-Daniel Hailfinger | 5de9341 | 2009-05-01 10:53:49 +0000 | [diff] [blame] | 26 | .PP |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 27 | You can specify one of \-h, \-R, \-L, \-z, \-E, \-r, \-w, \-v or no operation. |
| 28 | If no operation is specified, flashrom will only probe for flash chips. It is |
Michael Karcher | 31fd825 | 2010-03-12 06:41:39 +0000 | [diff] [blame] | 29 | recommended that if you try flashrom the first time on a system, you run it |
| 30 | in probe only mode and check the output. Also you are advised to make a |
| 31 | backup of your current ROM contents with \-r before you try to write a new |
| 32 | image. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 33 | .TP |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 34 | .B "\-r, \-\-read <file>" |
| 35 | Read flash ROM contents and save them into the given |
| 36 | .BR <file> . |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 37 | .TP |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 38 | .B "\-w, \-\-write <file>" |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 39 | Write |
| 40 | .B <file> |
| 41 | into flash ROM. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 42 | .TP |
Uwe Hermann | ea07f62 | 2009-06-24 17:31:08 +0000 | [diff] [blame] | 43 | .B "\-n, \-\-noverify" |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 44 | Skip the automatic verification of flash ROM contents after writing. Using this |
Uwe Hermann | ea07f62 | 2009-06-24 17:31:08 +0000 | [diff] [blame] | 45 | option is |
| 46 | .B not |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 47 | recommended, you should only use it if you know what you are doing and if you |
Uwe Hermann | ea07f62 | 2009-06-24 17:31:08 +0000 | [diff] [blame] | 48 | feel that the time for verification takes too long. |
| 49 | .sp |
| 50 | Typical usage is: |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 51 | .B "flashrom -n -w file" |
Uwe Hermann | ea07f62 | 2009-06-24 17:31:08 +0000 | [diff] [blame] | 52 | .sp |
| 53 | This option is only useful in combination with |
| 54 | .BR \-\-write . |
| 55 | .TP |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 56 | .B "\-v, \-\-verify <file>" |
| 57 | Verify the flash ROM contents against the given |
| 58 | .BR <file> . |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 59 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 60 | .B "\-E, \-\-erase" |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 61 | Erase the flash ROM chip. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 62 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 63 | .B "\-V, \-\-verbose" |
| 64 | More verbose output. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 65 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 66 | .B "\-c, \-\-chip" <chipname> |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 67 | Probe only for specified flash ROM chip. This option takes the chip name as |
| 68 | printed by |
| 69 | .B "flashrom \-L" |
| 70 | without the vendor name. Please note that the chip name is case sensitive. |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 71 | .TP |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 72 | .B "\-m, \-\-mainboard" [<vendor>:]<part> |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 73 | Override mainboard settings. |
| 74 | .sp |
| 75 | flashrom reads the coreboot table to determine the current mainboard. If no |
| 76 | coreboot table could be read or if you want to override these values, you can |
| 77 | specify \-m, e.g.: |
| 78 | .sp |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 79 | .B " flashrom --mainboard AGAMI:ARUMA -w agami_aruma.rom" |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 80 | .sp |
| 81 | See the 'Supported mainboards' section in the output of 'flashrom \-L' for |
| 82 | a list of boards which require the specification of the board name, if no |
| 83 | coreboot table is found. |
| 84 | .TP |
| 85 | .B "\-f, \-\-force" |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 86 | Force one or more of the following actions: |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 87 | .sp |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 88 | * Force chip read and pretend the chip is there. |
| 89 | .sp |
| 90 | * Force chip access even if the chip is bigger than max decode size for\ |
| 91 | the flash bus. |
| 92 | .sp |
| 93 | * Force erase even if erase is known bad. |
| 94 | .sp |
| 95 | * Force write even if write is known bad. |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 96 | .TP |
| 97 | .B "\-l, \-\-layout <file>" |
| 98 | Read ROM layout from |
| 99 | .BR <file> . |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 100 | .sp |
| 101 | flashrom supports ROM layouts. This allows you to flash certain parts of |
| 102 | the flash chip only. A ROM layout file looks like follows: |
| 103 | .sp |
| 104 | 00000000:00008fff gfxrom |
| 105 | 00009000:0003ffff normal |
| 106 | 00040000:0007ffff fallback |
| 107 | .sp |
| 108 | i.e.: |
| 109 | startaddr:endaddr name |
| 110 | .sp |
| 111 | All addresses are offsets within the file, not absolute addresses! |
| 112 | If you only want to update the normal image in a ROM you can say: |
| 113 | .sp |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 114 | .B " flashrom --layout rom.layout --image normal -w agami_aruma.rom" |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 115 | .sp |
| 116 | To update normal and fallback but leave the VGA BIOS alone, say: |
| 117 | .sp |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 118 | .B " flashrom -l rom.layout -i normal \" |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 119 | .br |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 120 | .B " -i fallback -w agami_aruma.rom" |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 121 | .sp |
| 122 | Currently overlapping sections are not supported. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 123 | .TP |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 124 | .B "\-i, \-\-image <name>" |
Uwe Hermann | 67808fe | 2007-10-18 00:29:05 +0000 | [diff] [blame] | 125 | Only flash image |
| 126 | .B <name> |
| 127 | from flash layout. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 128 | .TP |
Uwe Hermann | e5ac164 | 2008-03-12 11:54:51 +0000 | [diff] [blame] | 129 | .B "\-L, \-\-list\-supported" |
Uwe Hermann | e8ba538 | 2009-05-22 11:37:27 +0000 | [diff] [blame] | 130 | List the flash chips, chipsets, mainboards, and PCI card "programmers" |
| 131 | supported by flashrom. |
Uwe Hermann | e5ac164 | 2008-03-12 11:54:51 +0000 | [diff] [blame] | 132 | .sp |
Uwe Hermann | e8ba538 | 2009-05-22 11:37:27 +0000 | [diff] [blame] | 133 | There are many unlisted boards which will work out of the box, without |
| 134 | special support in flashrom. Please let us know if you can verify that |
| 135 | other boards work or do not work out of the box. For verification you have |
| 136 | to test an ERASE and/or WRITE operation, so make sure you only do that |
| 137 | if you have proper means to recover from failure! |
Uwe Hermann | e5ac164 | 2008-03-12 11:54:51 +0000 | [diff] [blame] | 138 | .TP |
Uwe Hermann | 20a293f | 2009-06-19 10:42:43 +0000 | [diff] [blame] | 139 | .B "\-z, \-\-list\-supported-wiki" |
| 140 | Same as |
| 141 | .BR \-\-list\-supported , |
| 142 | but outputs the supported hardware in MediaWiki syntax, so that it can be |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 143 | easily pasted into the wiki page at http://www.flashrom.org/. Please note |
| 144 | that MediaWiki output is not compiled in by default. |
Uwe Hermann | 20a293f | 2009-06-19 10:42:43 +0000 | [diff] [blame] | 145 | .TP |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 146 | .B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]" |
Carl-Daniel Hailfinger | ce98677 | 2009-05-09 00:27:07 +0000 | [diff] [blame] | 147 | Specify the programmer device. Currently supported are: |
| 148 | .sp |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 149 | .BR "* internal" " (default, for in-system flashing in the mainboard)" |
| 150 | .sp |
Uwe Hermann | c7e8a0c | 2009-05-19 14:14:21 +0000 | [diff] [blame] | 151 | .BR "* dummy" " (just prints all operations and accesses)" |
| 152 | .sp |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 153 | .BR "* nic3com" " (for flash ROMs on 3COM network cards)" |
| 154 | .sp |
Uwe Hermann | 829ed84 | 2010-05-24 17:39:14 +0000 | [diff] [blame] | 155 | .BR "* nicrealtek" " (for flash ROMs on Realtek network cards)" |
| 156 | .sp |
| 157 | .BR "* nicsmc1211" " (for flash ROMs on RTL8139-compatible SMC2 network cards)" |
| 158 | .sp |
Uwe Hermann | 2bc98f6 | 2009-09-30 18:29:55 +0000 | [diff] [blame] | 159 | .BR "* gfxnvidia" " (for flash ROMs on NVIDIA graphics cards)" |
| 160 | .sp |
TURBO J | b0912c0 | 2009-09-02 23:00:46 +0000 | [diff] [blame] | 161 | .BR "* drkaiser" " (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)" |
| 162 | .sp |
Uwe Hermann | c7e8a0c | 2009-05-19 14:14:21 +0000 | [diff] [blame] | 163 | .BR "* satasii" " (for flash ROMs on Silicon Image SATA/IDE controllers)" |
| 164 | .sp |
Uwe Hermann | ddd5c9e | 2010-02-21 21:17:00 +0000 | [diff] [blame] | 165 | .BR "* atahpt" " (for flash ROMs on Highpoint ATA/RAID controllers)" |
| 166 | .sp |
Uwe Hermann | e9d04d4 | 2009-06-02 19:54:22 +0000 | [diff] [blame] | 167 | .BR "* it87spi" " (for flash ROMs behind an ITE IT87xx Super I/O LPC/SPI translation unit)" |
Carl-Daniel Hailfinger | b8afecd | 2009-05-31 18:00:57 +0000 | [diff] [blame] | 168 | .sp |
Carl-Daniel Hailfinger | 7112772 | 2010-05-31 15:27:27 +0000 | [diff] [blame] | 169 | .BR "* ft2232_spi" " (for flash ROMs attached to a FT2232H/FT4232H based USB SPI programmer)" |
Paul Fox | 05dfbe6 | 2009-06-16 21:08:06 +0000 | [diff] [blame] | 170 | .sp |
Carl-Daniel Hailfinger | dfade10 | 2009-08-18 23:51:22 +0000 | [diff] [blame] | 171 | .BR "* serprog" " (for flash ROMs attached to Urja's AVR programmer)" |
| 172 | .sp |
Carl-Daniel Hailfinger | 7112772 | 2010-05-31 15:27:27 +0000 | [diff] [blame] | 173 | .BR "* buspirate_spi" " (for flash ROMs attached to a Bus Pirate)" |
Carl-Daniel Hailfinger | d5b28fa | 2009-11-24 18:27:10 +0000 | [diff] [blame] | 174 | .sp |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 175 | Some programmers have optional or mandatory parameters which are described |
| 176 | in detail in the |
| 177 | .B PROGRAMMER SPECIFIC INFO |
| 178 | section. Support for some programmers can be disabled at compile time. |
| 179 | .B "flashrom -h" |
| 180 | lists all supported programmers. |
| 181 | .TP |
| 182 | .B "\-h, \-\-help" |
| 183 | Show a help text and exit. |
| 184 | .TP |
| 185 | .B "\-R, \-\-version" |
| 186 | Show version information and exit. |
| 187 | .SH PROGRAMMER SPECIFIC INFO |
| 188 | Some programmer drivers accept further parameters to set programmer-specific |
Uwe Hermann | 4e3d0b3 | 2010-03-25 23:18:41 +0000 | [diff] [blame] | 189 | parameters. These parameters are separated from the programmer name by a |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 190 | colon. While some programmers take arguments at fixed positions, other |
| 191 | programmers use a key/value interface in which the key and value is separated |
| 192 | by an equal sign and different pairs are separated by a comma or a colon. |
| 193 | .TP |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 194 | .BR "internal " programmer |
| 195 | Some mainboards require to run mainboard specific code to enable flash erase |
| 196 | and write support (and probe support on old systems with parallel flash). |
| 197 | The mainboard brand and model (if it requires specific code) is usually |
| 198 | autodetected using one of the following mechanisms: If your system is |
| 199 | running coreboot, the mainboard type is determined from the coreboot table, |
| 200 | otherwise, the mainboard is detected by examining the onboard PCI devices |
| 201 | and possibly DMI info. If PCI and DMI do not contain information to uniquely |
| 202 | identify the mainboard (which is the exception), it might be necessary to |
| 203 | specify the mainboard using the \-m switch (see above). |
| 204 | .sp |
| 205 | Some of these board-specific flash enabling functions (called board enables) |
| 206 | in flashrom have not yet been tested. If your mainboard is detected needing |
| 207 | an untested board enable function, a warning message is printed and the |
| 208 | board enable is not executed, because a wrong board enable function might |
| 209 | cause the system to behave erratically, as board enable functions touch the |
| 210 | low-level internals of a mainboard. Not executing a board enable function |
| 211 | (if one is needed) might cause detection or erasing failure. If your board |
| 212 | protects only part of the flash (commonly the top end, called boot block), |
| 213 | flashrom might encounter an error only after erasing the unprotected part, |
| 214 | so running without the board-enable function might be dangerous for erase |
| 215 | and write (which includes erase). |
| 216 | .sp |
| 217 | The suggested procedure for a mainboard with untested board specific code is |
| 218 | to first try to probe the ROM (just invoke flashrom and check that it |
| 219 | detects your flash chip type) without running the board enable code (i.e. |
| 220 | without any parameters). If it finds your chip, fine, otherwise, retry |
| 221 | probing your chip with the board-enable code running, using |
| 222 | .sp |
| 223 | .B "flashrom -p internal:boardenable=force" |
| 224 | .sp |
| 225 | If your chip is still not detected, the board enable code seems to be broken |
| 226 | or the flash chip unsupported. Otherwise, make a backup of your current ROM |
| 227 | contents (using \-r) and store it to a medium outside of your computer, like |
| 228 | an USB drive or a network share. If you needed to run the board enable code |
| 229 | already for probing, use it for reading too. Now you can try to write the |
| 230 | new image. You should enable the board enable code in any case now, as it |
| 231 | has been written because it is known that writing/erasing without the board |
| 232 | enable is going to fail. In any case (success or failure), please report to |
| 233 | the flashrom mailing list, see below. |
| 234 | .sp |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 235 | On systems running coreboot, flashrom checks whether the desired image matches |
| 236 | your mainboard. This needs some special board ID to be present in the image. |
| 237 | If flashrom detects that the image you want to write and the current board |
| 238 | do not match, it will refuse to write the image unless you specify |
| 239 | .sp |
| 240 | .B "flashrom -p internal:boardmismatch=force" |
| 241 | .sp |
Carl-Daniel Hailfinger | 01f3ef4 | 2010-03-25 02:50:40 +0000 | [diff] [blame] | 242 | If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus |
| 243 | translation, flashrom should autodetect that configuration. You can use |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 244 | .sp |
Carl-Daniel Hailfinger | 01f3ef4 | 2010-03-25 02:50:40 +0000 | [diff] [blame] | 245 | .B "flashrom -p internal:it87spiport=portnum" |
| 246 | syntax as explained in the |
| 247 | .B it87spi |
| 248 | programmer section to use a non-default port for controlling the IT87 series |
| 249 | Super I/O. In the unlikely case flashrom doesn't detect an active IT87 LPC<->SPI |
| 250 | bridge, you can try to force recognition by using the it87spi programmer. |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 251 | .sp |
| 252 | Using flashrom on laptops is dangerous and may easily make your hardware |
| 253 | unusable (see also the BUGS section). The embedded controller (EC) in these |
| 254 | machines often interacts badly with flashing. http://www.flashrom.org/Laptops |
| 255 | has more information. If flash is shared with the EC, erase is guaranteed to |
| 256 | brick your laptop and write is very likely to brick your laptop. |
| 257 | Chip read and probe may irritate your EC and cause fan failure, backlight |
| 258 | failure, sudden poweroff, and other nasty effects. |
| 259 | flashrom will attempt to detect laptops and abort immediately for safety |
| 260 | reasons. |
| 261 | If you want to proceed anyway at your own risk, use |
| 262 | .sp |
| 263 | .B "flashrom -p internal:laptop=force_I_want_a_brick" |
| 264 | .sp |
| 265 | You have been warned. |
| 266 | .sp |
| 267 | We will not help you if you force flashing on a laptop because this is a really |
| 268 | dumb idea. |
Carl-Daniel Hailfinger | 01f3ef4 | 2010-03-25 02:50:40 +0000 | [diff] [blame] | 269 | .TP |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 270 | .BR "dummy " programmer |
| 271 | An optional parameter specifies the bus types it |
Carl-Daniel Hailfinger | 3504b53 | 2009-06-01 00:02:11 +0000 | [diff] [blame] | 272 | should support. For that you have to use the |
Carl-Daniel Hailfinger | 664e7ad | 2009-08-19 15:03:28 +0000 | [diff] [blame] | 273 | .B "flashrom -p dummy:type" |
Carl-Daniel Hailfinger | 3504b53 | 2009-06-01 00:02:11 +0000 | [diff] [blame] | 274 | syntax where |
| 275 | .B type |
| 276 | can be any comma-separated combination of |
| 277 | .B parallel lpc fwh spi all |
| 278 | in any order. |
| 279 | .sp |
| 280 | Example: |
Carl-Daniel Hailfinger | 664e7ad | 2009-08-19 15:03:28 +0000 | [diff] [blame] | 281 | .B "flashrom -p dummy:lpc,fwh" |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 282 | .TP |
Uwe Hermann | 829ed84 | 2010-05-24 17:39:14 +0000 | [diff] [blame] | 283 | .BR "nic3com" , " nicrealtek" , " nicsmc1211" , " gfxnvidia" , " satasii " and " atahpt " programmers |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 284 | These programmers have an option to specify the PCI address of the card |
| 285 | your want to use, which must be specified if more than one card supported |
| 286 | by the selected programmer is installed in your system. The syntax is |
Carl-Daniel Hailfinger | 664e7ad | 2009-08-19 15:03:28 +0000 | [diff] [blame] | 287 | .B "flashrom -p xxxx:bb:dd.f" |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 288 | , where |
Uwe Hermann | c7e8a0c | 2009-05-19 14:14:21 +0000 | [diff] [blame] | 289 | .B xxxx |
| 290 | is the name of the programmer |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 291 | .B bb |
| 292 | is the PCI bus number, |
| 293 | .B dd |
| 294 | is the PCI device number, and |
| 295 | .B f |
| 296 | is the PCI function number of the desired NIC. |
| 297 | .sp |
| 298 | Example: |
Carl-Daniel Hailfinger | 664e7ad | 2009-08-19 15:03:28 +0000 | [diff] [blame] | 299 | .B "flashrom -p nic3com:05:04.0" |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 300 | .TP |
| 301 | .BR "it87spi " programmer |
| 302 | An optional parameter sets the I/O base port of the IT87* SPI controller |
| 303 | interface to the port specified in the parameter instead of using the port |
| 304 | address set by the BIOS. For that you have to use the |
Carl-Daniel Hailfinger | 01f3ef4 | 2010-03-25 02:50:40 +0000 | [diff] [blame] | 305 | .B "flashrom -p it87spi:it87spiport=portnum" |
Carl-Daniel Hailfinger | bb297f7 | 2009-07-11 18:05:42 +0000 | [diff] [blame] | 306 | syntax where |
| 307 | .B portnum |
| 308 | is an I/O port number which must be a multiple of 8. |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 309 | .TP |
Carl-Daniel Hailfinger | 7112772 | 2010-05-31 15:27:27 +0000 | [diff] [blame] | 310 | .BR "ft2232_spi " programmer |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 311 | An optional parameter species the controller |
Carl-Daniel Hailfinger | dfade10 | 2009-08-18 23:51:22 +0000 | [diff] [blame] | 312 | type and interface/port it should support. For that you have to use the |
Carl-Daniel Hailfinger | 7112772 | 2010-05-31 15:27:27 +0000 | [diff] [blame] | 313 | .B "flashrom -p ft2232_spi:model,port=interface" |
Carl-Daniel Hailfinger | feea272 | 2009-07-01 00:02:23 +0000 | [diff] [blame] | 314 | syntax where |
| 315 | .B model |
| 316 | can be any of |
| 317 | .B 2232H 4232H |
| 318 | and |
| 319 | .B interface |
| 320 | can be any of |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 321 | .BR "A B" . |
Carl-Daniel Hailfinger | feea272 | 2009-07-01 00:02:23 +0000 | [diff] [blame] | 322 | The default model is |
| 323 | .B 4232H |
| 324 | and the default interface is |
| 325 | .BR B . |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 326 | .TP |
| 327 | .BR "serprog " programmer |
| 328 | A mandatory parameter specifies either a serial |
Carl-Daniel Hailfinger | dfade10 | 2009-08-18 23:51:22 +0000 | [diff] [blame] | 329 | device/baud combination or an IP/port combination for communication with the |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 330 | programmer. In the device/baud combination, the device has to start with a |
| 331 | slash. For serial, you have to use the |
Carl-Daniel Hailfinger | 664e7ad | 2009-08-19 15:03:28 +0000 | [diff] [blame] | 332 | .B "flashrom -p serprog:/dev/device:baud" |
Carl-Daniel Hailfinger | dfade10 | 2009-08-18 23:51:22 +0000 | [diff] [blame] | 333 | syntax and for IP, you have to use |
Carl-Daniel Hailfinger | 664e7ad | 2009-08-19 15:03:28 +0000 | [diff] [blame] | 334 | .B "flashrom -p serprog:ip:port" |
Carl-Daniel Hailfinger | dfade10 | 2009-08-18 23:51:22 +0000 | [diff] [blame] | 335 | instead. More information about serprog is available in serprog-protocol.txt in |
| 336 | the source distribution. |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 337 | .TP |
Carl-Daniel Hailfinger | 7112772 | 2010-05-31 15:27:27 +0000 | [diff] [blame] | 338 | .BR "buspirate_spi " programmer |
Uwe Hermann | 4e3d0b3 | 2010-03-25 23:18:41 +0000 | [diff] [blame] | 339 | A required dev parameter specifies the Bus Pirate device node and an optional |
| 340 | spispeed parameter specifies the frequency of the SPI bus. The parameter |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 341 | delimiter is a comma. Syntax is |
Carl-Daniel Hailfinger | dfade10 | 2009-08-18 23:51:22 +0000 | [diff] [blame] | 342 | .sp |
Carl-Daniel Hailfinger | 7112772 | 2010-05-31 15:27:27 +0000 | [diff] [blame] | 343 | .B "flashrom -p buspirate_spi:dev=/dev/device,spispeed=frequency" |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 344 | .sp |
Carl-Daniel Hailfinger | d5b28fa | 2009-11-24 18:27:10 +0000 | [diff] [blame] | 345 | where |
| 346 | .B frequency |
| 347 | can be any of |
| 348 | .B 30k 125k 250k 1M 2M 2.6M 4M 8M |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 349 | (in Hz). The default is the maximum frequency of 8 MHz. |
Peter Stuge | 42688e5 | 2009-01-26 02:20:56 +0000 | [diff] [blame] | 350 | .SH EXIT STATUS |
| 351 | flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem |
| 352 | (/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 353 | .SH BUGS |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 354 | Please report any bugs at |
Stefan Reinauer | 22ea8cd | 2009-07-30 13:32:26 +0000 | [diff] [blame] | 355 | .BR http://www.flashrom.org/trac/flashrom/newticket "," |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 356 | or on the flashrom mailing list at |
| 357 | .BR http://www.flashrom.org/mailman/listinfo/flashrom "." |
| 358 | .sp |
| 359 | Using flashrom on laptops is dangerous and may easily make your hardware |
| 360 | unusable unless you can desolder the flash chip and have a full flash chip |
| 361 | backup. This is caused by the embedded controller (EC) present in many laptops, |
| 362 | which interacts badly with any flash attempts. This is a hardware limitation |
| 363 | and flashrom will attempt to detect it and abort immediately for safety reasons. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 364 | .SH LICENCE |
| 365 | .B flashrom |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 366 | is covered by the GNU General Public License (GPL), version 2. Some files are |
| 367 | additionally available under the GPL (version 2, or any later version). |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 368 | .SH COPYRIGHT |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 369 | .br |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 370 | Please see the individual files. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 371 | .SH AUTHORS |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 372 | Carl-Daniel Hailfinger |
| 373 | .br |
| 374 | Claus Gindhart <claus.gindhart@kontron.com> |
| 375 | .br |
| 376 | Dominik Geyer <dominik.geyer@kontron.com> |
| 377 | .br |
Stefan Reinauer | edc6188 | 2010-01-03 14:40:30 +0000 | [diff] [blame] | 378 | Eric Biederman |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 379 | .br |
| 380 | Giampiero Giancipoli <gianci@email.it> |
| 381 | .br |
| 382 | Joe Bao <Zheng.Bao@amd.com> |
| 383 | .br |
| 384 | Luc Verhaegen <libv@skynet.be> |
| 385 | .br |
Carl-Daniel Hailfinger | 451dc80 | 2009-05-01 11:00:39 +0000 | [diff] [blame] | 386 | Li-Ta Lo |
| 387 | .br |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 388 | Markus Boas <ryven@ryven.de> |
| 389 | .br |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 390 | Michael Karcher <flashrom@mkarcher.dialup.fu-berlin.de> |
| 391 | .br |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 392 | Nikolay Petukhov <nikolay.petukhov@gmail.com> |
| 393 | .br |
| 394 | Peter Stuge <peter@stuge.se> |
| 395 | .br |
| 396 | Reinder E.N. de Haan <lb_reha@mveas.com> |
| 397 | .br |
| 398 | Ronald G. Minnich <rminnich@gmail.com> |
| 399 | .br |
| 400 | Ronald Hoogenboom <ronald@zonnet.nl> |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 401 | .br |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 402 | Sean Nelson <audiohacked@gmail.com> |
| 403 | .br |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 404 | Stefan Reinauer <stepan@coresystems.de> |
| 405 | .br |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 406 | Stefan Wildemann <stefan.wildemann@kontron.com> |
| 407 | .br |
| 408 | Steven James <pyro@linuxlabs.com> |
| 409 | .br |
| 410 | Uwe Hermann <uwe@hermann-uwe.de> |
| 411 | .br |
Stefan Reinauer | edc6188 | 2010-01-03 14:40:30 +0000 | [diff] [blame] | 412 | Wang Qingpei |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 413 | .br |
Stefan Reinauer | edc6188 | 2010-01-03 14:40:30 +0000 | [diff] [blame] | 414 | Yinghai Lu |
Stefan Reinauer | f8337dd | 2006-08-03 10:49:09 +0000 | [diff] [blame] | 415 | .br |
| 416 | some others |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 417 | .PP |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 418 | This manual page was written by Uwe Hermann <uwe@hermann-uwe.de> and Carl-Daniel |
| 419 | Hailfinger. |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 420 | It is licensed under the terms of the GNU GPL (version 2 or later). |