Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 1 | .\" 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 |
| 4 | .el \ |
| 5 | . de MTO \\$2 \(la\\$1 \(ra\\$3 |
| 6 | . . |
| 7 | .\" Create wrappers for .MTO and .URL that print only text on systems w/o groff or if not outputting to a HTML |
| 8 | .\" device. To that end we need to distinguish HTML output on groff from other configurations first. |
| 9 | .nr groffhtml 0 |
| 10 | .if \n[.g] \ |
| 11 | . if "\*[.T]"html" \ |
| 12 | . nr groffhtml 1 |
| 13 | .\" For code reuse it would be nice to have a single wrapper that gets its target macro as parameter. |
| 14 | .\" However, this did not work out with NetBSD's and OpenBSD's groff... |
| 15 | .de URLB |
| 16 | . ie (\n[groffhtml]==1) \{\ |
| 17 | . URL \\$@ |
| 18 | . \} |
| 19 | . el \{\ |
| 20 | . ie "\\$2"" \{\ |
| 21 | . BR "\\$1" "\\$3" |
| 22 | . \} |
| 23 | . el \{\ |
| 24 | . RB "\\$2 \(la" "\\$1" "\(ra\\$3" |
| 25 | . \} |
| 26 | . \} |
| 27 | .. |
| 28 | .de MTOB |
| 29 | . ie (\n[groffhtml]==1) \{\ |
| 30 | . MTO \\$@ |
| 31 | . \} |
| 32 | . el \{\ |
| 33 | . ie "\\$2"" \{\ |
| 34 | . BR "\\$1" "\\$3" |
| 35 | . \} |
| 36 | . el \{\ |
| 37 | . RB "\\$2 \(la" "\\$1" "\(ra\\$3" |
| 38 | . \} |
| 39 | . \} |
| 40 | .. |
Joerg Mayer | a93d9dc | 2013-08-29 00:38:19 +0000 | [diff] [blame] | 41 | .TH FLASHROM 8 "" "" |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 42 | .SH NAME |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 43 | flashrom \- detect, read, write, verify and erase flash chips |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 44 | .SH SYNOPSIS |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 45 | .B flashrom \fR[\fB\-h\fR|\fB\-R\fR|\fB\-L\fR|\fB\-z\fR|\ |
| 46 | \fB\-p\fR <programmername>[:<parameters>] |
| 47 | [\fB\-E\fR|\fB\-r\fR <file>|\fB\-w\fR <file>|\fB\-v\fR <file>] \ |
| 48 | [\fB\-c\fR <chipname>] |
| 49 | [\fB\-l\fR <file> [\fB\-i\fR <image>]] [\fB\-n\fR] [\fB\-f\fR]] |
| 50 | [\fB\-V\fR[\fBV\fR[\fBV\fR]]] [\fB-o\fR <logfile>] |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 51 | .SH DESCRIPTION |
| 52 | .B flashrom |
Uwe Hermann | e8ba538 | 2009-05-22 11:37:27 +0000 | [diff] [blame] | 53 | is a utility for detecting, reading, writing, verifying and erasing flash |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 54 | chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system |
Uwe Hermann | 941a273 | 2011-07-25 21:12:57 +0000 | [diff] [blame] | 55 | using a supported mainboard. However, it also supports various external |
| 56 | PCI/USB/parallel-port/serial-port based devices which can program flash chips, |
| 57 | including some network cards (NICs), SATA/IDE controller cards, graphics cards, |
Ilya A. Volynets-Evenbakh | 2c714ab | 2012-09-26 00:47:09 +0000 | [diff] [blame] | 58 | the Bus Pirate device, various FTDI FT2232/FT4232H/FT232H based USB devices, and more. |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 59 | .PP |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 60 | It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40, |
Uwe Hermann | 941a273 | 2011-07-25 21:12:57 +0000 | [diff] [blame] | 61 | TSOP48, and BGA chips, which use various protocols such as LPC, FWH, |
| 62 | parallel flash, or SPI. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 63 | .SH OPTIONS |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 64 | .B IMPORTANT: |
Carl-Daniel Hailfinger | 5de9341 | 2009-05-01 10:53:49 +0000 | [diff] [blame] | 65 | Please note that the command line interface for flashrom will change before |
| 66 | 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] | 67 | 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] | 68 | .PP |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 69 | You can specify one of |
| 70 | .BR \-h ", " \-R ", " \-L ", " \-z ", " \-E ", " \-r ", " \-w ", " \-v |
| 71 | or no operation. |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 72 | 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] | 73 | recommended that if you try flashrom the first time on a system, you run it |
Uwe Hermann | 941a273 | 2011-07-25 21:12:57 +0000 | [diff] [blame] | 74 | in probe-only mode and check the output. Also you are advised to make a |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 75 | backup of your current ROM contents with |
| 76 | .B \-r |
Stefan Tauner | e34e3e8 | 2013-01-01 00:06:51 +0000 | [diff] [blame] | 77 | before you try to write a new image. All operations involving any chip access (probe/read/write/...) require the |
| 78 | .B -p/--programmer |
| 79 | option to be used (please see below). |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 80 | .TP |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 81 | .B "\-r, \-\-read <file>" |
| 82 | Read flash ROM contents and save them into the given |
| 83 | .BR <file> . |
Uwe Hermann | 941a273 | 2011-07-25 21:12:57 +0000 | [diff] [blame] | 84 | If the file already exists, it will be overwritten. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 85 | .TP |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 86 | .B "\-w, \-\-write <file>" |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 87 | Write |
| 88 | .B <file> |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 89 | into flash ROM. This will first automatically |
| 90 | .B erase |
| 91 | the chip, then write to it. |
Stefan Tauner | ac54fbe | 2011-07-21 19:52:00 +0000 | [diff] [blame] | 92 | .sp |
| 93 | In the process the chip is also read several times. First an in-memory backup |
| 94 | is made for disaster recovery and to be able to skip regions that are |
| 95 | already equal to the image file. This copy is updated along with the write |
| 96 | operation. In case of erase errors it is even re-read completely. After |
| 97 | writing has finished and if verification is enabled, the whole flash chip is |
| 98 | read out and compared with the input image. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 99 | .TP |
Uwe Hermann | ea07f62 | 2009-06-24 17:31:08 +0000 | [diff] [blame] | 100 | .B "\-n, \-\-noverify" |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 101 | Skip the automatic verification of flash ROM contents after writing. Using this |
Uwe Hermann | ea07f62 | 2009-06-24 17:31:08 +0000 | [diff] [blame] | 102 | option is |
| 103 | .B not |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 104 | 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] | 105 | feel that the time for verification takes too long. |
| 106 | .sp |
| 107 | Typical usage is: |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 108 | .B "flashrom \-p prog \-n \-w <file>" |
Uwe Hermann | ea07f62 | 2009-06-24 17:31:08 +0000 | [diff] [blame] | 109 | .sp |
| 110 | This option is only useful in combination with |
| 111 | .BR \-\-write . |
| 112 | .TP |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 113 | .B "\-v, \-\-verify <file>" |
| 114 | Verify the flash ROM contents against the given |
| 115 | .BR <file> . |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 116 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 117 | .B "\-E, \-\-erase" |
Uwe Hermann | e74b9f8 | 2009-04-10 14:41:29 +0000 | [diff] [blame] | 118 | Erase the flash ROM chip. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 119 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 120 | .B "\-V, \-\-verbose" |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 121 | More verbose output. This option can be supplied multiple times |
Stefan Tauner | eebeb53 | 2011-08-04 17:40:25 +0000 | [diff] [blame] | 122 | (max. 3 times, i.e. |
| 123 | .BR \-VVV ) |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 124 | for even more debug output. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 125 | .TP |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 126 | .B "\-c, \-\-chip" <chipname> |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 127 | Probe only for the specified flash ROM chip. This option takes the chip name as |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 128 | printed by |
| 129 | .B "flashrom \-L" |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 130 | without the vendor name as parameter. Please note that the chip name is |
| 131 | case sensitive. |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 132 | .TP |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 133 | .B "\-f, \-\-force" |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 134 | Force one or more of the following actions: |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 135 | .sp |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 136 | * Force chip read and pretend the chip is there. |
| 137 | .sp |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 138 | * Force chip access even if the chip is bigger than the maximum supported \ |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 139 | size for the flash bus. |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 140 | .sp |
| 141 | * Force erase even if erase is known bad. |
| 142 | .sp |
| 143 | * Force write even if write is known bad. |
Joerg Mayer | 645c6df | 2010-03-13 14:47:48 +0000 | [diff] [blame] | 144 | .TP |
| 145 | .B "\-l, \-\-layout <file>" |
| 146 | Read ROM layout from |
| 147 | .BR <file> . |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 148 | .sp |
| 149 | flashrom supports ROM layouts. This allows you to flash certain parts of |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 150 | the flash chip only. A ROM layout file contains multiple lines with the |
| 151 | following syntax: |
| 152 | .sp |
| 153 | .B " startaddr:endaddr imagename" |
| 154 | .sp |
| 155 | .BR "startaddr " "and " "endaddr " |
| 156 | are hexadecimal addresses within the ROM file and do not refer to any |
| 157 | physical address. Please note that using a 0x prefix for those hexadecimal |
| 158 | numbers is not necessary, but you can't specify decimal/octal numbers. |
| 159 | .BR "imagename " "is an arbitrary name for the region/image from" |
| 160 | .BR " startaddr " "to " "endaddr " "(both addresses included)." |
| 161 | .sp |
| 162 | Example: |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 163 | .sp |
| 164 | 00000000:00008fff gfxrom |
| 165 | 00009000:0003ffff normal |
| 166 | 00040000:0007ffff fallback |
| 167 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 168 | If you only want to update the image named |
| 169 | .BR "normal " "in a ROM based on the layout above, run" |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 170 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 171 | .B " flashrom \-p prog \-\-layout rom.layout \-\-image normal \-w some.rom" |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 172 | .sp |
Stefan Tauner | e34e3e8 | 2013-01-01 00:06:51 +0000 | [diff] [blame] | 173 | To update only the images named |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 174 | .BR "normal " "and " "fallback" ", run:" |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 175 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 176 | .B " flashrom \-p prog \-l rom.layout \-i normal -i fallback \-w some.rom" |
Uwe Hermann | 87c0793 | 2009-05-05 16:15:46 +0000 | [diff] [blame] | 177 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 178 | Overlapping sections are not supported. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 179 | .TP |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 180 | .B "\-i, \-\-image <imagename>" |
| 181 | Only flash region/image |
| 182 | .B <imagename> |
Uwe Hermann | 67808fe | 2007-10-18 00:29:05 +0000 | [diff] [blame] | 183 | from flash layout. |
Stefan Reinauer | de063bf | 2006-09-21 13:09:22 +0000 | [diff] [blame] | 184 | .TP |
Uwe Hermann | e5ac164 | 2008-03-12 11:54:51 +0000 | [diff] [blame] | 185 | .B "\-L, \-\-list\-supported" |
Uwe Hermann | 941a273 | 2011-07-25 21:12:57 +0000 | [diff] [blame] | 186 | List the flash chips, chipsets, mainboards, and external programmers |
| 187 | (including PCI, USB, parallel port, and serial port based devices) |
Uwe Hermann | e8ba538 | 2009-05-22 11:37:27 +0000 | [diff] [blame] | 188 | supported by flashrom. |
Uwe Hermann | e5ac164 | 2008-03-12 11:54:51 +0000 | [diff] [blame] | 189 | .sp |
Uwe Hermann | e8ba538 | 2009-05-22 11:37:27 +0000 | [diff] [blame] | 190 | There are many unlisted boards which will work out of the box, without |
| 191 | special support in flashrom. Please let us know if you can verify that |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 192 | other boards work or do not work out of the box. |
| 193 | .sp |
| 194 | .B IMPORTANT: |
| 195 | For verification you have |
Uwe Hermann | e8ba538 | 2009-05-22 11:37:27 +0000 | [diff] [blame] | 196 | to test an ERASE and/or WRITE operation, so make sure you only do that |
| 197 | if you have proper means to recover from failure! |
Uwe Hermann | e5ac164 | 2008-03-12 11:54:51 +0000 | [diff] [blame] | 198 | .TP |
Uwe Hermann | 20a293f | 2009-06-19 10:42:43 +0000 | [diff] [blame] | 199 | .B "\-z, \-\-list\-supported-wiki" |
| 200 | Same as |
| 201 | .BR \-\-list\-supported , |
| 202 | but outputs the supported hardware in MediaWiki syntax, so that it can be |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 203 | easily pasted into the |
| 204 | .URLB https://flashrom.org/Supported_hardware "supported hardware wiki page" . |
Uwe Hermann | 941a273 | 2011-07-25 21:12:57 +0000 | [diff] [blame] | 205 | Please note that MediaWiki output is not compiled in by default. |
Uwe Hermann | 20a293f | 2009-06-19 10:42:43 +0000 | [diff] [blame] | 206 | .TP |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 207 | .B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]" |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 208 | Specify the programmer device. This is mandatory for all operations |
| 209 | involving any chip access (probe/read/write/...). Currently supported are: |
Carl-Daniel Hailfinger | ce98677 | 2009-05-09 00:27:07 +0000 | [diff] [blame] | 210 | .sp |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 211 | .BR "* internal" " (default, for in-system flashing in the mainboard)" |
| 212 | .sp |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 213 | .BR "* dummy" " (virtual programmer for testing flashrom)" |
Uwe Hermann | c7e8a0c | 2009-05-19 14:14:21 +0000 | [diff] [blame] | 214 | .sp |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 215 | .BR "* nic3com" " (for flash ROMs on 3COM network cards)" |
| 216 | .sp |
Sergey Lichack | 98f4710 | 2012-08-27 01:24:15 +0000 | [diff] [blame] | 217 | .BR "* nicrealtek" " (for flash ROMs on Realtek and SMC 1211 network cards)" |
Uwe Hermann | 829ed84 | 2010-05-24 17:39:14 +0000 | [diff] [blame] | 218 | .sp |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 219 | .BR "* nicnatsemi" " (for flash ROMs on National Semiconductor DP838* network \ |
| 220 | cards)" |
| 221 | .sp |
Uwe Hermann | 314cfba | 2011-07-28 19:23:09 +0000 | [diff] [blame] | 222 | .BR "* nicintel" " (for parallel flash ROMs on Intel 10/100Mbit network cards) |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 223 | .sp |
Uwe Hermann | 2bc98f6 | 2009-09-30 18:29:55 +0000 | [diff] [blame] | 224 | .BR "* gfxnvidia" " (for flash ROMs on NVIDIA graphics cards)" |
| 225 | .sp |
TURBO J | b0912c0 | 2009-09-02 23:00:46 +0000 | [diff] [blame] | 226 | .BR "* drkaiser" " (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)" |
| 227 | .sp |
Uwe Hermann | c7e8a0c | 2009-05-19 14:14:21 +0000 | [diff] [blame] | 228 | .BR "* satasii" " (for flash ROMs on Silicon Image SATA/IDE controllers)" |
| 229 | .sp |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 230 | .BR "* satamv" " (for flash ROMs on Marvell SATA controllers)" |
| 231 | .sp |
Uwe Hermann | ddd5c9e | 2010-02-21 21:17:00 +0000 | [diff] [blame] | 232 | .BR "* atahpt" " (for flash ROMs on Highpoint ATA/RAID controllers)" |
| 233 | .sp |
Stefan Tauner | 4f09475 | 2014-06-01 22:36:30 +0000 | [diff] [blame] | 234 | .BR "* atavia" " (for flash ROMs on VIA VT6421A SATA controllers)" |
Jonathan Kollasch | 7f0f3fa | 2014-06-01 10:26:23 +0000 | [diff] [blame] | 235 | .sp |
Joseph C. Lehner | c2644a3 | 2016-01-16 23:45:25 +0000 | [diff] [blame] | 236 | .BR "* atapromise" " (for flash ROMs on Promise PDC2026x ATA/RAID controllers)" |
| 237 | .sp |
Kyösti Mälkki | 72d42f8 | 2014-06-01 23:48:31 +0000 | [diff] [blame] | 238 | .BR "* it8212" " (for flash ROMs on ITE IT8212F ATA/RAID controller)" |
| 239 | .sp |
Ilya A. Volynets-Evenbakh | 2c714ab | 2012-09-26 00:47:09 +0000 | [diff] [blame] | 240 | .BR "* ft2232_spi" " (for SPI flash ROMs attached to an FT2232/FT4232H/FT232H family \ |
Uwe Hermann | 314cfba | 2011-07-28 19:23:09 +0000 | [diff] [blame] | 241 | based USB SPI programmer), including the DLP Design DLP-USB1232H, \ |
| 242 | FTDI FT2232H Mini-Module, FTDI FT4232H Mini-Module, openbiosprog-spi, Amontec \ |
Steve Markgraf | 0528b7f | 2011-08-12 01:19:32 +0000 | [diff] [blame] | 243 | JTAGkey/JTAGkey-tiny/JTAGkey-2, Dangerous Prototypes Bus Blaster, \ |
Samir Ibradžić | 7189a5f | 2011-10-20 23:14:10 +0000 | [diff] [blame] | 244 | Olimex ARM-USB-TINY/-H, Olimex ARM-USB-OCD/-H, TIAO/DIYGADGET USB |
Todd Broch | 6800c95 | 2016-02-14 15:46:00 +0000 | [diff] [blame] | 245 | Multi-Protocol Adapter (TUMPA), TUMPA Lite, GOEPEL PicoTAP and Google Servo v1/v2. |
Paul Fox | 05dfbe6 | 2009-06-16 21:08:06 +0000 | [diff] [blame] | 246 | .sp |
Stefan Tauner | 72587f8 | 2016-01-04 03:05:15 +0000 | [diff] [blame] | 247 | .BR "* serprog" " (for flash ROMs attached to a programmer speaking serprog, \ |
| 248 | including Arduino-based devices as well as various programmers by Urja Rannikko, \ |
| 249 | Juhana Helovuo, Stefan Tauner and others)." |
Carl-Daniel Hailfinger | dfade10 | 2009-08-18 23:51:22 +0000 | [diff] [blame] | 250 | .sp |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 251 | .BR "* buspirate_spi" " (for SPI flash ROMs attached to a Bus Pirate)" |
Carl-Daniel Hailfinger | d5b28fa | 2009-11-24 18:27:10 +0000 | [diff] [blame] | 252 | .sp |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 253 | .BR "* dediprog" " (for SPI flash ROMs attached to a Dediprog SF100)" |
| 254 | .sp |
Kyösti Mälkki | 8b1bdf1 | 2013-10-02 01:21:45 +0000 | [diff] [blame] | 255 | .BR "* rayer_spi" " (for SPI flash ROMs attached to a parallel port by one of various cable types)" |
Carl-Daniel Hailfinger | e7fdd6e | 2010-07-21 10:26:01 +0000 | [diff] [blame] | 256 | .sp |
Michael Karcher | e544939 | 2012-05-05 20:53:59 +0000 | [diff] [blame] | 257 | .BR "* pony_spi" " (for SPI flash ROMs attached to a SI-Prog serial port " |
| 258 | bitbanging adapter) |
| 259 | .sp |
Uwe Hermann | 314cfba | 2011-07-28 19:23:09 +0000 | [diff] [blame] | 260 | .BR "* nicintel_spi" " (for SPI flash ROMs on Intel Gigabit network cards)" |
Idwer Vollering | 004f4b7 | 2010-09-03 18:21:21 +0000 | [diff] [blame] | 261 | .sp |
Uwe Hermann | 314cfba | 2011-07-28 19:23:09 +0000 | [diff] [blame] | 262 | .BR "* ogp_spi" " (for SPI flash ROMs on Open Graphics Project graphics card)" |
Mark Marshall | 90021f2 | 2010-12-03 14:48:11 +0000 | [diff] [blame] | 263 | .sp |
Carl-Daniel Hailfinger | 8541d23 | 2012-02-16 21:00:27 +0000 | [diff] [blame] | 264 | .BR "* linux_spi" " (for SPI flash ROMs accessible via /dev/spidevX.Y on Linux)" |
| 265 | .sp |
James Laird | c60de0e | 2013-03-27 13:00:23 +0000 | [diff] [blame] | 266 | .BR "* usbblaster_spi" " (for SPI flash ROMs attached to an Altera USB-Blaster compatible cable)" |
| 267 | .sp |
Ricardo Ribalda Delgado | 2a41f0a | 2014-07-28 20:35:21 +0000 | [diff] [blame] | 268 | .BR "* nicintel_eeprom" " (for SPI EEPROMs on Intel Gigabit network cards)" |
| 269 | .sp |
Alexandre Boeglin | 80e6471 | 2014-12-20 20:25:19 +0000 | [diff] [blame] | 270 | .BR "* mstarddc_spi" " (for SPI flash ROMs accessible through DDC in MSTAR-equipped displays)" |
| 271 | .sp |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 272 | .BR "* pickit2_spi" " (for SPI flash ROMs accessible via Microchip PICkit2)" |
| 273 | .sp |
Urja Rannikko | 0870b02 | 2016-01-31 22:10:29 +0000 | [diff] [blame] | 274 | .BR "* ch341a_spi" " (for SPI flash ROMs attached to WCH CH341A)" |
| 275 | .sp |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 276 | Some programmers have optional or mandatory parameters which are described |
| 277 | in detail in the |
Stefan Tauner | 6697f71 | 2014-08-06 15:09:15 +0000 | [diff] [blame] | 278 | .B PROGRAMMER-SPECIFIC INFORMATION |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 279 | section. Support for some programmers can be disabled at compile time. |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 280 | .B "flashrom \-h" |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 281 | lists all supported programmers. |
| 282 | .TP |
| 283 | .B "\-h, \-\-help" |
| 284 | Show a help text and exit. |
| 285 | .TP |
Carl-Daniel Hailfinger | 0b9af36 | 2012-07-21 16:56:04 +0000 | [diff] [blame] | 286 | .B "\-o, \-\-output <logfile>" |
| 287 | Save the full debug log to |
| 288 | .BR <logfile> . |
| 289 | If the file already exists, it will be overwritten. This is the recommended |
| 290 | way to gather logs from flashrom because they will be verbose even if the |
Stefan Tauner | 6697f71 | 2014-08-06 15:09:15 +0000 | [diff] [blame] | 291 | on-screen messages are not verbose and don't require output redirection. |
Carl-Daniel Hailfinger | 0b9af36 | 2012-07-21 16:56:04 +0000 | [diff] [blame] | 292 | .TP |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 293 | .B "\-R, \-\-version" |
| 294 | Show version information and exit. |
Stefan Tauner | 6697f71 | 2014-08-06 15:09:15 +0000 | [diff] [blame] | 295 | .SH PROGRAMMER-SPECIFIC INFORMATION |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 296 | Some programmer drivers accept further parameters to set programmer-specific |
Uwe Hermann | 4e3d0b3 | 2010-03-25 23:18:41 +0000 | [diff] [blame] | 297 | parameters. These parameters are separated from the programmer name by a |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 298 | colon. While some programmers take arguments at fixed positions, other |
| 299 | programmers use a key/value interface in which the key and value is separated |
| 300 | by an equal sign and different pairs are separated by a comma or a colon. |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 301 | .SS |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 302 | .BR "internal " programmer |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 303 | .TP |
| 304 | .B Board Enables |
| 305 | .sp |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 306 | Some mainboards require to run mainboard specific code to enable flash erase |
| 307 | and write support (and probe support on old systems with parallel flash). |
| 308 | The mainboard brand and model (if it requires specific code) is usually |
| 309 | autodetected using one of the following mechanisms: If your system is |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 310 | running coreboot, the mainboard type is determined from the coreboot table. |
| 311 | Otherwise, the mainboard is detected by examining the onboard PCI devices |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 312 | and possibly DMI info. If PCI and DMI do not contain information to uniquely |
Carl-Daniel Hailfinger | 2d927fb | 2012-01-04 00:48:27 +0000 | [diff] [blame] | 313 | identify the mainboard (which is the exception), or if you want to override |
| 314 | the detected mainboard model, you can specify the mainboard using the |
| 315 | .sp |
Stefan Tauner | b4e06bd | 2012-08-20 00:24:22 +0000 | [diff] [blame] | 316 | .B " flashrom \-p internal:mainboard=<vendor>:<board>" |
Carl-Daniel Hailfinger | 2d927fb | 2012-01-04 00:48:27 +0000 | [diff] [blame] | 317 | syntax. |
| 318 | .sp |
| 319 | See the 'Known boards' or 'Known laptops' section in the output |
| 320 | of 'flashrom \-L' for a list of boards which require the specification of |
| 321 | the board name, if no coreboot table is found. |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 322 | .sp |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 323 | Some of these board-specific flash enabling functions (called |
| 324 | .BR "board enables" ) |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 325 | in flashrom have not yet been tested. If your mainboard is detected needing |
| 326 | an untested board enable function, a warning message is printed and the |
| 327 | board enable is not executed, because a wrong board enable function might |
| 328 | cause the system to behave erratically, as board enable functions touch the |
| 329 | low-level internals of a mainboard. Not executing a board enable function |
| 330 | (if one is needed) might cause detection or erasing failure. If your board |
| 331 | protects only part of the flash (commonly the top end, called boot block), |
| 332 | flashrom might encounter an error only after erasing the unprotected part, |
| 333 | so running without the board-enable function might be dangerous for erase |
| 334 | and write (which includes erase). |
| 335 | .sp |
| 336 | The suggested procedure for a mainboard with untested board specific code is |
| 337 | to first try to probe the ROM (just invoke flashrom and check that it |
| 338 | detects your flash chip type) without running the board enable code (i.e. |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 339 | without any parameters). If it finds your chip, fine. Otherwise, retry |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 340 | probing your chip with the board-enable code running, using |
| 341 | .sp |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 342 | .B " flashrom \-p internal:boardenable=force" |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 343 | .sp |
| 344 | If your chip is still not detected, the board enable code seems to be broken |
| 345 | or the flash chip unsupported. Otherwise, make a backup of your current ROM |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 346 | contents (using |
| 347 | .BR \-r ) |
| 348 | and store it to a medium outside of your computer, like |
| 349 | a USB drive or a network share. If you needed to run the board enable code |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 350 | already for probing, use it for reading too. |
| 351 | If reading succeeds and the contens of the read file look legit you can try to write the new image. |
| 352 | You should enable the board enable code in any case now, as it |
Michael Karcher | 7f0c3ec | 2010-03-07 22:29:28 +0000 | [diff] [blame] | 353 | has been written because it is known that writing/erasing without the board |
| 354 | enable is going to fail. In any case (success or failure), please report to |
| 355 | the flashrom mailing list, see below. |
| 356 | .sp |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 357 | .TP |
| 358 | .B Coreboot |
| 359 | .sp |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 360 | On systems running coreboot, flashrom checks whether the desired image matches |
| 361 | your mainboard. This needs some special board ID to be present in the image. |
| 362 | If flashrom detects that the image you want to write and the current board |
| 363 | do not match, it will refuse to write the image unless you specify |
| 364 | .sp |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 365 | .B " flashrom \-p internal:boardmismatch=force" |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 366 | .TP |
| 367 | .B ITE IT87 Super I/O |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 368 | .sp |
Vadim Girlin | 4dd0f90 | 2013-08-24 12:18:17 +0000 | [diff] [blame] | 369 | If your mainboard is manufactured by GIGABYTE and supports DualBIOS it is very likely that it uses an |
| 370 | ITE IT87 series Super I/O to switch between the two flash chips. Only one of them can be accessed at a time |
| 371 | and you can manually select which one to use with the |
| 372 | .sp |
| 373 | .B " flashrom \-p internal:dualbiosindex=chip" |
| 374 | .sp |
| 375 | syntax where |
| 376 | .B chip |
| 377 | is the index of the chip to use (0 = main, 1 = backup). You can check which one is currently selected by |
| 378 | leaving out the |
| 379 | .B chip |
| 380 | parameter. |
| 381 | .sp |
Carl-Daniel Hailfinger | 01f3ef4 | 2010-03-25 02:50:40 +0000 | [diff] [blame] | 382 | If your mainboard uses an ITE IT87 series Super I/O for LPC<->SPI flash bus |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 383 | translation, flashrom should autodetect that configuration. If you want to |
| 384 | set the I/O base port of the IT87 series SPI controller manually instead of |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 385 | using the value provided by the BIOS, use the |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 386 | .sp |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 387 | .B " flashrom \-p internal:it87spiport=portnum" |
| 388 | .sp |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 389 | syntax where |
| 390 | .B portnum |
| 391 | is the I/O port number (must be a multiple of 8). In the unlikely case |
| 392 | flashrom doesn't detect an active IT87 LPC<->SPI bridge, please send a bug |
| 393 | report so we can diagnose the problem. |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 394 | .sp |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 395 | .TP |
Rudolf Marek | 70e1459 | 2013-07-25 22:58:56 +0000 | [diff] [blame] | 396 | .B AMD chipsets |
| 397 | .sp |
| 398 | Beginning with the SB700 chipset there is an integrated microcontroller (IMC) based on the 8051 embedded in |
| 399 | every AMD southbridge. Its firmware resides in the same flash chip as the host's which makes writing to the |
| 400 | flash risky if the IMC is active. Flashrom tries to temporarily disable the IMC but even then changing the |
| 401 | contents of the flash can have unwanted effects: when the IMC continues (at the latest after a reboot) it will |
| 402 | continue executing code from the flash. If the code was removed or changed in an unfortunate way it is |
| 403 | unpredictable what the IMC will do. Therefore, if flashrom detects an active IMC it will disable write support |
| 404 | unless the user forces it with the |
| 405 | .sp |
| 406 | .B " flashrom \-p internal:amd_imc_force=yes" |
| 407 | .sp |
| 408 | syntax. The user is responsible for supplying a suitable image or leaving out the IMC region with the help of |
| 409 | a layout file. This limitation might be removed in the future when we understand the details better and have |
| 410 | received enough feedback from users. Please report the outcome if you had to use this option to write a chip. |
| 411 | .sp |
Stefan Tauner | 21071b0 | 2014-05-16 21:39:48 +0000 | [diff] [blame] | 412 | An optional |
| 413 | .B spispeed |
| 414 | parameter specifies the frequency of the SPI bus where applicable (i.e.\& SB600 or later with an SPI flash chip |
| 415 | directly attached to the chipset). |
| 416 | Syntax is |
| 417 | .sp |
| 418 | .B " flashrom \-p internal:spispeed=frequency" |
| 419 | .sp |
| 420 | where |
| 421 | .B frequency |
| 422 | can be |
| 423 | .BR "'16.5\ MHz'" ", " "'22\ MHz'" ", " "'33\ MHz'" ", " "'66\ MHz'" ", " "'100\ MHZ'" ", or " "'800\ kHz'" "." |
| 424 | Support of individual frequencies depends on the generation of the chipset: |
| 425 | .sp |
| 426 | * SB6xx, SB7xx, SP5xxx: from 16.5 MHz up to and including 33 MHz |
| 427 | .sp |
| 428 | * SB8xx, SB9xx, Hudson: from 16.5 MHz up to and including 66 MHz |
| 429 | .sp |
| 430 | * Yangtze (with SPI 100 engine as found in Kabini and Tamesh): all of them |
| 431 | .sp |
| 432 | The default is to use 16.5 MHz and disable Fast Reads. |
Rudolf Marek | 70e1459 | 2013-07-25 22:58:56 +0000 | [diff] [blame] | 433 | .TP |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 434 | .B Intel chipsets |
| 435 | .sp |
Stefan Tauner | 50e7c60 | 2011-11-08 10:55:54 +0000 | [diff] [blame] | 436 | If you have an Intel chipset with an ICH8 or later southbridge with SPI flash |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 437 | attached, and if a valid descriptor was written to it (e.g.\& by the vendor), the |
Stefan Tauner | 50e7c60 | 2011-11-08 10:55:54 +0000 | [diff] [blame] | 438 | chipset provides an alternative way to access the flash chip(s) named |
| 439 | .BR "Hardware Sequencing" . |
| 440 | It is much simpler than the normal access method (called |
| 441 | .BR "Software Sequencing" ")," |
| 442 | but does not allow the software to choose the SPI commands to be sent. |
| 443 | You can use the |
| 444 | .sp |
| 445 | .B " flashrom \-p internal:ich_spi_mode=value" |
| 446 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 447 | syntax where |
| 448 | .BR "value " "can be" |
Stefan Tauner | 50e7c60 | 2011-11-08 10:55:54 +0000 | [diff] [blame] | 449 | .BR auto ", " swseq " or " hwseq . |
| 450 | By default |
| 451 | .RB "(or when setting " ich_spi_mode=auto ) |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 452 | the module tries to use swseq and only activates hwseq if need be (e.g.\& if |
Stefan Tauner | 50e7c60 | 2011-11-08 10:55:54 +0000 | [diff] [blame] | 453 | important opcodes are inaccessible due to lockdown; or if more than one flash |
| 454 | chip is attached). The other options (swseq, hwseq) select the respective mode |
| 455 | (if possible). |
| 456 | .sp |
Stefan Tauner | 5210e72 | 2012-02-16 01:13:00 +0000 | [diff] [blame] | 457 | ICH8 and later southbridges may also have locked address ranges of different |
| 458 | kinds if a valid descriptor was written to it. The flash address space is then |
| 459 | partitioned in multiple so called "Flash Regions" containing the host firmware, |
| 460 | the ME firmware and so on respectively. The flash descriptor can also specify up |
| 461 | to 5 so called "Protected Regions", which are freely chosen address ranges |
| 462 | independent from the aforementioned "Flash Regions". All of them can be write |
| 463 | and/or read protected individually. If flashrom detects such a lock it will |
| 464 | disable write support unless the user forces it with the |
| 465 | .sp |
| 466 | .B " flashrom \-p internal:ich_spi_force=yes" |
| 467 | .sp |
| 468 | syntax. If this leads to erase or write accesses to the flash it would most |
| 469 | probably bring it into an inconsistent and unbootable state and we will not |
| 470 | provide any support in such a case. |
| 471 | .sp |
Kyösti Mälkki | 88ee040 | 2013-09-14 23:37:01 +0000 | [diff] [blame] | 472 | If you have an Intel chipset with an ICH2 or later southbridge and if you want |
Carl-Daniel Hailfinger | 46fa068 | 2011-07-25 22:44:09 +0000 | [diff] [blame] | 473 | to set specific IDSEL values for a non-default flash chip or an embedded |
| 474 | controller (EC), you can use the |
| 475 | .sp |
| 476 | .B " flashrom \-p internal:fwh_idsel=value" |
| 477 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 478 | syntax where |
| 479 | .B value |
| 480 | is the 48-bit hexadecimal raw value to be written in the |
Carl-Daniel Hailfinger | 46fa068 | 2011-07-25 22:44:09 +0000 | [diff] [blame] | 481 | IDSEL registers of the Intel southbridge. The upper 32 bits use one hex digit |
| 482 | each per 512 kB range between 0xffc00000 and 0xffffffff, and the lower 16 bits |
| 483 | use one hex digit each per 1024 kB range between 0xff400000 and 0xff7fffff. |
| 484 | The rightmost hex digit corresponds with the lowest address range. All address |
| 485 | ranges have a corresponding sister range 4 MB below with identical IDSEL |
| 486 | settings. The default value for ICH7 is given in the example below. |
| 487 | .sp |
| 488 | Example: |
| 489 | .B "flashrom \-p internal:fwh_idsel=0x001122334567" |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 490 | .TP |
| 491 | .B Laptops |
Carl-Daniel Hailfinger | 46fa068 | 2011-07-25 22:44:09 +0000 | [diff] [blame] | 492 | .sp |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 493 | Using flashrom on laptops is dangerous and may easily make your hardware |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 494 | unusable (see also the |
| 495 | .B BUGS |
| 496 | section). The embedded controller (EC) in these |
| 497 | machines often interacts badly with flashing. |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 498 | More information is |
| 499 | .URLB https://flashrom.org/Laptops "in the wiki" . |
| 500 | For example the EC firmware sometimes resides on the same |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 501 | flash chip as the host firmware. While flashrom tries to change the contents of |
| 502 | that memory the EC might need to fetch new instructions or data from it and |
| 503 | could stop working correctly. Probing for and reading from the chip may also |
| 504 | irritate your EC and cause fan failure, backlight failure, sudden poweroff, and |
| 505 | other nasty effects. flashrom will attempt to detect if it is running on a |
| 506 | laptop and abort immediately for safety reasons if it clearly identifies the |
| 507 | host computer as one. If you want to proceed anyway at your own risk, use |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 508 | .sp |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 509 | .B " flashrom \-p internal:laptop=force_I_want_a_brick" |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 510 | .sp |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 511 | We will not help you if you force flashing on a laptop because this is a really |
| 512 | dumb idea. |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 513 | .sp |
| 514 | You have been warned. |
| 515 | .sp |
| 516 | Currently we rely on the chassis type encoded in the DMI/SMBIOS data to detect |
| 517 | laptops. Some vendors did not implement those bits correctly or set them to |
| 518 | generic and/or dummy values. flashrom will then issue a warning and bail out |
| 519 | like above. In this case you can use |
| 520 | .sp |
| 521 | .B " flashrom \-p internal:laptop=this_is_not_a_laptop" |
| 522 | .sp |
Stefan Tauner | 6697f71 | 2014-08-06 15:09:15 +0000 | [diff] [blame] | 523 | to tell flashrom (at your own risk) that it is not running on a laptop. |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 524 | .SS |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 525 | .BR "dummy " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 526 | .IP |
| 527 | The dummy programmer operates on a buffer in memory only. It provides a safe and fast way to test various |
| 528 | aspects of flashrom and is mainly used in development and while debugging. |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 529 | It is able to emulate some chips to a certain degree (basic |
| 530 | identify/read/erase/write operations work). |
| 531 | .sp |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 532 | An optional parameter specifies the bus types it |
Carl-Daniel Hailfinger | 3504b53 | 2009-06-01 00:02:11 +0000 | [diff] [blame] | 533 | should support. For that you have to use the |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 534 | .sp |
| 535 | .B " flashrom \-p dummy:bus=[type[+type[+type]]]" |
| 536 | .sp |
Carl-Daniel Hailfinger | 3504b53 | 2009-06-01 00:02:11 +0000 | [diff] [blame] | 537 | syntax where |
| 538 | .B type |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 539 | can be |
Carl-Daniel Hailfinger | 744132a | 2010-07-06 09:55:48 +0000 | [diff] [blame] | 540 | .BR parallel ", " lpc ", " fwh ", " spi |
| 541 | in any order. If you specify bus without type, all buses will be disabled. |
| 542 | If you do not specify bus, all buses will be enabled. |
Carl-Daniel Hailfinger | 3504b53 | 2009-06-01 00:02:11 +0000 | [diff] [blame] | 543 | .sp |
| 544 | Example: |
Carl-Daniel Hailfinger | 744132a | 2010-07-06 09:55:48 +0000 | [diff] [blame] | 545 | .B "flashrom \-p dummy:bus=lpc+fwh" |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 546 | .sp |
| 547 | The dummy programmer supports flash chip emulation for automated self-tests |
| 548 | without hardware access. If you want to emulate a flash chip, use the |
| 549 | .sp |
| 550 | .B " flashrom \-p dummy:emulate=chip" |
| 551 | .sp |
| 552 | syntax where |
| 553 | .B chip |
| 554 | is one of the following chips (please specify only the chip name, not the |
| 555 | vendor): |
| 556 | .sp |
Stefan Tauner | 23e10b8 | 2016-01-23 16:16:49 +0000 | [diff] [blame] | 557 | .RB "* ST " M25P10.RES " SPI flash chip (128 kB, RES, page write)" |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 558 | .sp |
Stefan Tauner | 23e10b8 | 2016-01-23 16:16:49 +0000 | [diff] [blame] | 559 | .RB "* SST " SST25VF040.REMS " SPI flash chip (512 kB, REMS, byte write)" |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 560 | .sp |
Stefan Tauner | 23e10b8 | 2016-01-23 16:16:49 +0000 | [diff] [blame] | 561 | .RB "* SST " SST25VF032B " SPI flash chip (4096 kB, RDID, AAI write)" |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 562 | .sp |
Stefan Tauner | 23e10b8 | 2016-01-23 16:16:49 +0000 | [diff] [blame] | 563 | .RB "* Macronix " MX25L6436 " SPI flash chip (8192 kB, RDID, SFDP)" |
Stefan Tauner | 0b9df97 | 2012-05-07 22:12:16 +0000 | [diff] [blame] | 564 | .sp |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 565 | Example: |
| 566 | .B "flashrom -p dummy:emulate=SST25VF040.REMS" |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 567 | .TP |
| 568 | .B Persistent images |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 569 | .sp |
| 570 | If you use flash chip emulation, flash image persistence is available as well |
| 571 | by using the |
| 572 | .sp |
| 573 | .B " flashrom \-p dummy:emulate=chip,image=image.rom" |
| 574 | .sp |
| 575 | syntax where |
| 576 | .B image.rom |
| 577 | is the file where the simulated chip contents are read on flashrom startup and |
| 578 | where the chip contents on flashrom shutdown are written to. |
| 579 | .sp |
| 580 | Example: |
| 581 | .B "flashrom -p dummy:emulate=M25P10.RES,image=dummy.bin" |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 582 | .TP |
| 583 | .B SPI write chunk size |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 584 | .sp |
| 585 | If you use SPI flash chip emulation for a chip which supports SPI page write |
| 586 | with the default opcode, you can set the maximum allowed write chunk size with |
| 587 | the |
| 588 | .sp |
| 589 | .B " flashrom \-p dummy:emulate=chip,spi_write_256_chunksize=size" |
| 590 | .sp |
| 591 | syntax where |
| 592 | .B size |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 593 | is the number of bytes (min.\& 1, max.\& 256). |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 594 | .sp |
| 595 | Example: |
| 596 | .sp |
| 597 | .B " flashrom -p dummy:emulate=M25P10.RES,spi_write_256_chunksize=5" |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 598 | .TP |
| 599 | .B SPI blacklist |
Carl-Daniel Hailfinger | 1b83be5 | 2012-02-08 23:28:54 +0000 | [diff] [blame] | 600 | .sp |
| 601 | To simulate a programmer which refuses to send certain SPI commands to the |
| 602 | flash chip, you can specify a blacklist of SPI commands with the |
| 603 | .sp |
| 604 | .B " flashrom -p dummy:spi_blacklist=commandlist" |
| 605 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 606 | syntax where |
| 607 | .B commandlist |
| 608 | is a list of two-digit hexadecimal representations of |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 609 | SPI commands. If commandlist is e.g.\& 0302, flashrom will behave as if the SPI |
Carl-Daniel Hailfinger | 1b83be5 | 2012-02-08 23:28:54 +0000 | [diff] [blame] | 610 | controller refuses to run command 0x03 (READ) and command 0x02 (WRITE). |
| 611 | commandlist may be up to 512 characters (256 commands) long. |
| 612 | Implementation note: flashrom will detect an error during command execution. |
| 613 | .sp |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 614 | .TP |
| 615 | .B SPI ignorelist |
| 616 | .sp |
Carl-Daniel Hailfinger | 1b83be5 | 2012-02-08 23:28:54 +0000 | [diff] [blame] | 617 | To simulate a flash chip which ignores (doesn't support) certain SPI commands, |
| 618 | you can specify an ignorelist of SPI commands with the |
| 619 | .sp |
| 620 | .B " flashrom -p dummy:spi_ignorelist=commandlist" |
| 621 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 622 | syntax where |
| 623 | .B commandlist |
| 624 | is a list of two-digit hexadecimal representations of |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 625 | SPI commands. If commandlist is e.g.\& 0302, the emulated flash chip will ignore |
Carl-Daniel Hailfinger | 1b83be5 | 2012-02-08 23:28:54 +0000 | [diff] [blame] | 626 | command 0x03 (READ) and command 0x02 (WRITE). commandlist may be up to 512 |
| 627 | characters (256 commands) long. |
| 628 | Implementation note: flashrom won't detect an error during command execution. |
Stefan Tauner | 5e695ab | 2012-05-06 17:03:40 +0000 | [diff] [blame] | 629 | .sp |
| 630 | .TP |
| 631 | .B SPI status register |
| 632 | .sp |
| 633 | You can specify the initial content of the chip's status register with the |
| 634 | .sp |
| 635 | .B " flashrom -p dummy:spi_status=content" |
| 636 | .sp |
Carl-Daniel Hailfinger | 4e3391f | 2012-07-22 12:01:43 +0000 | [diff] [blame] | 637 | syntax where |
| 638 | .B content |
| 639 | is an 8-bit hexadecimal value. |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 640 | .SS |
Ricardo Ribalda Delgado | 2a41f0a | 2014-07-28 20:35:21 +0000 | [diff] [blame] | 641 | .BR "nic3com" , " nicrealtek" , " nicnatsemi" , " nicintel", " nicintel_eeprom"\ |
Jonathan Kollasch | 7f0f3fa | 2014-06-01 10:26:23 +0000 | [diff] [blame] | 642 | , " nicintel_spi" , " gfxnvidia" , " ogp_spi" , " drkaiser" , " satasii"\ |
Joseph C. Lehner | c2644a3 | 2016-01-16 23:45:25 +0000 | [diff] [blame] | 643 | , " satamv" , " atahpt", " atavia ", " atapromise " and " it8212 " programmers |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 644 | .IP |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 645 | These programmers have an option to specify the PCI address of the card |
| 646 | your want to use, which must be specified if more than one card supported |
| 647 | by the selected programmer is installed in your system. The syntax is |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 648 | .sp |
| 649 | .BR " flashrom \-p xxxx:pci=bb:dd.f" , |
| 650 | .sp |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 651 | where |
Uwe Hermann | c7e8a0c | 2009-05-19 14:14:21 +0000 | [diff] [blame] | 652 | .B xxxx |
Stefan Tauner | c2eec2c | 2014-05-03 21:33:01 +0000 | [diff] [blame] | 653 | is the name of the programmer, |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 654 | .B bb |
| 655 | is the PCI bus number, |
| 656 | .B dd |
| 657 | is the PCI device number, and |
| 658 | .B f |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 659 | is the PCI function number of the desired device. |
Uwe Hermann | 530cb2d | 2009-05-14 22:58:21 +0000 | [diff] [blame] | 660 | .sp |
| 661 | Example: |
Carl-Daniel Hailfinger | 744132a | 2010-07-06 09:55:48 +0000 | [diff] [blame] | 662 | .B "flashrom \-p nic3com:pci=05:04.0" |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 663 | .SS |
Jonathan Kollasch | 7f0f3fa | 2014-06-01 10:26:23 +0000 | [diff] [blame] | 664 | .BR "atavia " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 665 | .IP |
Jonathan Kollasch | 7f0f3fa | 2014-06-01 10:26:23 +0000 | [diff] [blame] | 666 | Due to the mysterious address handling of the VIA VT6421A controller the user can specify an offset with the |
| 667 | .sp |
| 668 | .B " flashrom \-p atavia:offset=addr" |
| 669 | .sp |
| 670 | syntax where |
| 671 | .B addr |
| 672 | will be interpreted as usual (leading 0x (0) for hexadecimal (octal) values, or else decimal). |
| 673 | For more information please see |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 674 | .URLB https://flashrom.org/VT6421A "its wiki page" . |
Jonathan Kollasch | 7f0f3fa | 2014-06-01 10:26:23 +0000 | [diff] [blame] | 675 | .SS |
Joseph C. Lehner | c2644a3 | 2016-01-16 23:45:25 +0000 | [diff] [blame] | 676 | .BR "atapromise " programmer |
| 677 | .IP |
| 678 | This programmer is currently limited to 32 kB, regardless of the actual size of the flash chip. This stems |
| 679 | from the fact that, on the tested device (a Promise Ultra100), not all of the chip's address lines were |
| 680 | actually connected. You may use this programmer to flash firmware updates, since these are only 16 kB in |
| 681 | size (padding to 32 kB is required). |
| 682 | .SS |
Ricardo Ribalda Delgado | 2a41f0a | 2014-07-28 20:35:21 +0000 | [diff] [blame] | 683 | .BR "nicintel_eeprom " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 684 | .IP |
Ricardo Ribalda Delgado | 2a41f0a | 2014-07-28 20:35:21 +0000 | [diff] [blame] | 685 | This is the first programmer module in flashrom that does not provide access to NOR flash chips but EEPROMs |
| 686 | mounted on gigabit Ethernet cards based on Intel's 82580 NIC. Because EEPROMs normally do not announce their |
| 687 | size nor allow to be identified, the controller relies on correct size values written to predefined addresses |
| 688 | within the chip. Flashrom follows this scheme but assumes the minimum size of 16 kB (128 kb) if an unprogrammed |
| 689 | EEPROM/card is detected. Intel specifies following EEPROMs to be compatible: Atmel AT25128, AT25256, Micron (ST) |
| 690 | M95128, M95256 and OnSemi (Catalyst) CAT25CS128. |
| 691 | .SS |
Carl-Daniel Hailfinger | 7112772 | 2010-05-31 15:27:27 +0000 | [diff] [blame] | 692 | .BR "ft2232_spi " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 693 | .IP |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 694 | An optional parameter specifies the controller |
Stefan Tauner | fbc71ac | 2012-09-26 00:46:02 +0000 | [diff] [blame] | 695 | type and channel/interface/port it should support. For that you have to use the |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 696 | .sp |
Carl-Daniel Hailfinger | 744132a | 2010-07-06 09:55:48 +0000 | [diff] [blame] | 697 | .B " flashrom \-p ft2232_spi:type=model,port=interface" |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 698 | .sp |
Carl-Daniel Hailfinger | feea272 | 2009-07-01 00:02:23 +0000 | [diff] [blame] | 699 | syntax where |
| 700 | .B model |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 701 | can be |
Ilya A. Volynets-Evenbakh | 2c714ab | 2012-09-26 00:47:09 +0000 | [diff] [blame] | 702 | .BR 2232H ", " 4232H ", " 232H ", " jtagkey ", " busblaster ", " openmoko ", " \ |
Uwe Hermann | 836b26a | 2011-10-14 20:33:14 +0000 | [diff] [blame] | 703 | arm-usb-tiny ", " arm-usb-tiny-h ", " arm-usb-ocd ", " arm-usb-ocd-h \ |
Todd Broch | 6800c95 | 2016-02-14 15:46:00 +0000 | [diff] [blame] | 704 | ", " tumpa ", " tumpalite ", " picotap ", " google-servo ", " google-servo-v2 \ |
| 705 | " or " google-servo-v2-legacy |
Carl-Daniel Hailfinger | feea272 | 2009-07-01 00:02:23 +0000 | [diff] [blame] | 706 | and |
| 707 | .B interface |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 708 | can be |
Stefan Tauner | fbc71ac | 2012-09-26 00:46:02 +0000 | [diff] [blame] | 709 | .BR A ", " B ", " C ", or " D . |
Carl-Daniel Hailfinger | feea272 | 2009-07-01 00:02:23 +0000 | [diff] [blame] | 710 | The default model is |
| 711 | .B 4232H |
| 712 | and the default interface is |
Stefan Tauner | fbc71ac | 2012-09-26 00:46:02 +0000 | [diff] [blame] | 713 | .BR A . |
Samir Ibradžić | b482c6d | 2012-05-15 22:58:19 +0000 | [diff] [blame] | 714 | .sp |
Shik Chen | 14fbc4b | 2012-09-17 00:40:54 +0000 | [diff] [blame] | 715 | If there is more than one ft2232_spi-compatible device connected, you can select which one should be used by |
| 716 | specifying its serial number with the |
| 717 | .sp |
| 718 | .B " flashrom \-p ft2232_spi:serial=number" |
| 719 | .sp |
| 720 | syntax where |
| 721 | .B number |
| 722 | is the serial number of the device (which can be found for example in the output of lsusb -v). |
| 723 | .sp |
Samir Ibradžić | b482c6d | 2012-05-15 22:58:19 +0000 | [diff] [blame] | 724 | All models supported by the ft2232_spi driver can configure the SPI clock rate by setting a divisor. The |
Stefan Tauner | 0554ca5 | 2013-07-25 22:54:25 +0000 | [diff] [blame] | 725 | expressible divisors are all |
| 726 | .B even |
| 727 | numbers between 2 and 2^17 (=131072) resulting in SPI clock frequencies of |
Samir Ibradžić | b482c6d | 2012-05-15 22:58:19 +0000 | [diff] [blame] | 728 | 6 MHz down to about 92 Hz for 12 MHz inputs. The default divisor is set to 2, but you can use another one by |
| 729 | specifying the optional |
| 730 | .B divisor |
| 731 | parameter with the |
| 732 | .sp |
| 733 | .B " flashrom \-p ft2232_spi:divisor=div" |
| 734 | .sp |
| 735 | syntax. |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 736 | .SS |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 737 | .BR "serprog " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 738 | .IP |
Stefan Tauner | 72587f8 | 2016-01-04 03:05:15 +0000 | [diff] [blame] | 739 | A mandatory parameter specifies either a serial device (and baud rate) or an IP/port combination for |
| 740 | communicating with the programmer. |
| 741 | The device/baud combination has to start with |
| 742 | .B dev= |
| 743 | and separate the optional baud rate with a colon. |
| 744 | For example |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 745 | .sp |
Stefan Tauner | 72587f8 | 2016-01-04 03:05:15 +0000 | [diff] [blame] | 746 | .B " flashrom \-p serprog:dev=/dev/ttyS0:115200" |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 747 | .sp |
Stefan Tauner | 72587f8 | 2016-01-04 03:05:15 +0000 | [diff] [blame] | 748 | If no baud rate is given the default values by the operating system/hardware will be used. |
| 749 | For IP connections you have to use the |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 750 | .sp |
Carl-Daniel Hailfinger | 744132a | 2010-07-06 09:55:48 +0000 | [diff] [blame] | 751 | .B " flashrom \-p serprog:ip=ipaddr:port" |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 752 | .sp |
Stefan Tauner | 72587f8 | 2016-01-04 03:05:15 +0000 | [diff] [blame] | 753 | syntax. |
| 754 | In case the device supports it, you can set the SPI clock frequency with the optional |
Stefan Tauner | b98f6eb | 2012-08-13 16:33:04 +0000 | [diff] [blame] | 755 | .B spispeed |
Stefan Tauner | 0554ca5 | 2013-07-25 22:54:25 +0000 | [diff] [blame] | 756 | parameter. The frequency is parsed as hertz, unless an |
Stefan Tauner | b98f6eb | 2012-08-13 16:33:04 +0000 | [diff] [blame] | 757 | .BR M ", or " k |
| 758 | suffix is given, then megahertz or kilohertz are used respectively. |
| 759 | Example that sets the frequency to 2 MHz: |
| 760 | .sp |
Stefan Tauner | 0554ca5 | 2013-07-25 22:54:25 +0000 | [diff] [blame] | 761 | .B " flashrom \-p serprog:dev=/dev/device:baud,spispeed=2M" |
Stefan Tauner | b98f6eb | 2012-08-13 16:33:04 +0000 | [diff] [blame] | 762 | .sp |
| 763 | More information about serprog is available in |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 764 | .B serprog-protocol.txt |
| 765 | in the source distribution. |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 766 | .SS |
Carl-Daniel Hailfinger | 7112772 | 2010-05-31 15:27:27 +0000 | [diff] [blame] | 767 | .BR "buspirate_spi " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 768 | .IP |
Uwe Hermann | 9ff514d | 2010-06-07 19:41:25 +0000 | [diff] [blame] | 769 | A required |
| 770 | .B dev |
| 771 | parameter specifies the Bus Pirate device node and an optional |
| 772 | .B spispeed |
| 773 | parameter specifies the frequency of the SPI bus. The parameter |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 774 | delimiter is a comma. Syntax is |
Carl-Daniel Hailfinger | dfade10 | 2009-08-18 23:51:22 +0000 | [diff] [blame] | 775 | .sp |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 776 | .B " flashrom \-p buspirate_spi:dev=/dev/device,spispeed=frequency" |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 777 | .sp |
Carl-Daniel Hailfinger | d5b28fa | 2009-11-24 18:27:10 +0000 | [diff] [blame] | 778 | where |
| 779 | .B frequency |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 780 | can be |
| 781 | .BR 30k ", " 125k ", " 250k ", " 1M ", " 2M ", " 2.6M ", " 4M " or " 8M |
Michael Karcher | e5eafb2 | 2010-03-07 12:11:08 +0000 | [diff] [blame] | 782 | (in Hz). The default is the maximum frequency of 8 MHz. |
Brian Salcedo | 30dfdba | 2013-01-03 20:44:30 +0000 | [diff] [blame] | 783 | .sp |
| 784 | An optional pullups parameter specifies the use of the Bus Pirate internal pull-up resistors. This may be |
| 785 | needed if you are working with a flash ROM chip that you have physically removed from the board. Syntax is |
| 786 | .sp |
| 787 | .B " flashrom -p buspirate_spi:pullups=state" |
| 788 | .sp |
| 789 | where |
| 790 | .B state |
| 791 | can be |
| 792 | .BR on " or " off . |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 793 | More information about the Bus Pirate pull-up resistors and their purpose is available |
| 794 | .URLB "http://dangerousprototypes.com/docs/Practical_guide_to_Bus_Pirate_pull-up_resistors" \ |
| 795 | "in a guide by dangerousprototypes" . |
Brian Salcedo | 30dfdba | 2013-01-03 20:44:30 +0000 | [diff] [blame] | 796 | Only the external supply voltage (Vpu) is supported as of this writing. |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 797 | .SS |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 798 | .BR "pickit2_spi " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 799 | .IP |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 800 | An optional |
| 801 | .B voltage |
| 802 | parameter specifies the voltage the PICkit2 should use. The default unit is Volt if no unit is specified. |
| 803 | You can use |
| 804 | .BR mV ", " millivolt ", " V " or " Volt |
| 805 | as unit specifier. Syntax is |
| 806 | .sp |
| 807 | .B " flashrom \-p pickit2_spi:voltage=value" |
| 808 | .sp |
| 809 | where |
| 810 | .B value |
| 811 | can be |
| 812 | .BR 0V ", " 1.8V ", " 2.5V ", " 3.5V |
| 813 | or the equivalent in mV. |
| 814 | .sp |
| 815 | An optional |
| 816 | .B spispeed |
| 817 | parameter specifies the frequency of the SPI bus. Syntax is |
| 818 | .sp |
| 819 | .B " flashrom \-p pickit2_spi:spispeed=frequency" |
| 820 | .sp |
| 821 | where |
| 822 | .B frequency |
| 823 | can be |
| 824 | .BR 250k ", " 333k ", " 500k " or " 1M " |
| 825 | (in Hz). The default is a frequency of 1 MHz. |
| 826 | .SS |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 827 | .BR "dediprog " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 828 | .IP |
Carl-Daniel Hailfinger | c244138 | 2010-11-09 22:00:31 +0000 | [diff] [blame] | 829 | An optional |
| 830 | .B voltage |
| 831 | parameter specifies the voltage the Dediprog should use. The default unit is |
| 832 | Volt if no unit is specified. You can use |
| 833 | .BR mV ", " milliVolt ", " V " or " Volt |
| 834 | as unit specifier. Syntax is |
| 835 | .sp |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 836 | .B " flashrom \-p dediprog:voltage=value" |
Carl-Daniel Hailfinger | c244138 | 2010-11-09 22:00:31 +0000 | [diff] [blame] | 837 | .sp |
| 838 | where |
| 839 | .B value |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 840 | can be |
Carl-Daniel Hailfinger | c244138 | 2010-11-09 22:00:31 +0000 | [diff] [blame] | 841 | .BR 0V ", " 1.8V ", " 2.5V ", " 3.5V |
| 842 | or the equivalent in mV. |
Nathan Laredo | 21541a6 | 2012-12-24 22:07:36 +0000 | [diff] [blame] | 843 | .sp |
| 844 | An optional |
| 845 | .B device |
| 846 | parameter specifies which of multiple connected Dediprog devices should be used. |
| 847 | Please be aware that the order depends on libusb's usb_get_busses() function and that the numbering starts |
| 848 | at 0. |
| 849 | Usage example to select the second device: |
| 850 | .sp |
| 851 | .B " flashrom \-p dediprog:device=1" |
Nico Huber | 77fa67d | 2013-02-20 18:03:36 +0000 | [diff] [blame] | 852 | .sp |
| 853 | An optional |
| 854 | .B spispeed |
Patrick Georgi | efe2d43 | 2013-05-23 21:47:46 +0000 | [diff] [blame] | 855 | parameter specifies the frequency of the SPI bus. The firmware on the device needs to be 5.0.0 or newer. |
| 856 | Syntax is |
Nico Huber | 77fa67d | 2013-02-20 18:03:36 +0000 | [diff] [blame] | 857 | .sp |
| 858 | .B " flashrom \-p dediprog:spispeed=frequency" |
| 859 | .sp |
| 860 | where |
| 861 | .B frequency |
| 862 | can be |
| 863 | .BR 375k ", " 750k ", " 1.5M ", " 2.18M ", " 3M ", " 8M ", " 12M " or " 24M |
| 864 | (in Hz). The default is a frequency of 12 MHz. |
Stefan Tauner | e659d2d | 2013-05-03 21:58:28 +0000 | [diff] [blame] | 865 | .sp |
| 866 | An optional |
| 867 | .B target |
| 868 | parameter specifies which target chip should be used. Syntax is |
| 869 | .sp |
| 870 | .B " flashrom \-p dediprog:target=value" |
| 871 | .sp |
| 872 | where |
| 873 | .B value |
| 874 | can be |
| 875 | .BR 1 " or " 2 |
Stefan Tauner | 6697f71 | 2014-08-06 15:09:15 +0000 | [diff] [blame] | 876 | to select target chip 1 or 2 respectively. The default is target chip 1. |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 877 | .SS |
Carl-Daniel Hailfinger | e7fdd6e | 2010-07-21 10:26:01 +0000 | [diff] [blame] | 878 | .BR "rayer_spi " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 879 | .IP |
Carl-Daniel Hailfinger | 37c4252 | 2010-10-05 19:19:48 +0000 | [diff] [blame] | 880 | The default I/O base address used for the parallel port is 0x378 and you can use |
| 881 | the optional |
| 882 | .B iobase |
| 883 | parameter to specify an alternate base I/O address with the |
| 884 | .sp |
| 885 | .B " flashrom \-p rayer_spi:iobase=baseaddr" |
| 886 | .sp |
| 887 | syntax where |
| 888 | .B baseaddr |
| 889 | is base I/O port address of the parallel port, which must be a multiple of |
| 890 | four. Make sure to not forget the "0x" prefix for hexadecimal port addresses. |
| 891 | .sp |
Carl-Daniel Hailfinger | ae418d8 | 2011-09-12 06:17:06 +0000 | [diff] [blame] | 892 | The default cable type is the RayeR cable. You can use the optional |
| 893 | .B type |
| 894 | parameter to specify the cable type with the |
| 895 | .sp |
| 896 | .B " flashrom \-p rayer_spi:type=model" |
| 897 | .sp |
| 898 | syntax where |
| 899 | .B model |
| 900 | can be |
Maksim Kuleshov | 4dab5c1 | 2013-10-02 01:22:02 +0000 | [diff] [blame] | 901 | .BR rayer " for the RayeR cable, " byteblastermv " for the Altera ByteBlasterMV, " stk200 " for the Atmel \ |
Stefan Tauner | fdb1659 | 2016-02-28 17:04:38 +0000 | [diff] [blame] | 902 | STK200/300, " wiggler " for the Macraigor Wiggler, " xilinx " for the Xilinx Parallel Cable III (DLC 5), or" \ |
| 903 | " spi_tt" " for SPI Tiny Tools-compatible hardware. |
Carl-Daniel Hailfinger | ae418d8 | 2011-09-12 06:17:06 +0000 | [diff] [blame] | 904 | .sp |
| 905 | More information about the RayeR hardware is available at |
Stefan Tauner | 23e10b8 | 2016-01-23 16:16:49 +0000 | [diff] [blame] | 906 | .nh |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 907 | .URLB "http://rayer.g6.cz/elektro/spipgm.htm" "RayeR's website" . |
Maksim Kuleshov | 3647b2d | 2013-10-02 01:21:57 +0000 | [diff] [blame] | 908 | The Altera ByteBlasterMV datasheet can be obtained from |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 909 | .URLB "http://www.altera.co.jp/literature/ds/dsbytemv.pdf" Altera . |
Maksim Kuleshov | acba2ac | 2013-10-02 01:22:11 +0000 | [diff] [blame] | 910 | For more information about the Macraigor Wiggler see |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 911 | .URLB "http://www.macraigor.com/wiggler.htm" "their company homepage" . |
Kyösti Mälkki | 8b1bdf1 | 2013-10-02 01:21:45 +0000 | [diff] [blame] | 912 | The schematic of the Xilinx DLC 5 was published in |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 913 | .URLB "http://www.xilinx.com/support/documentation/user_guides/xtp029.pdf" "a Xilinx user guide" . |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 914 | .SS |
Michael Karcher | e544939 | 2012-05-05 20:53:59 +0000 | [diff] [blame] | 915 | .BR "pony_spi " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 916 | .IP |
Michael Karcher | e544939 | 2012-05-05 20:53:59 +0000 | [diff] [blame] | 917 | The serial port (like /dev/ttyS0, /dev/ttyUSB0 on Linux or COM3 on windows) is |
| 918 | specified using the mandatory |
Stefan Tauner | e34e3e8 | 2013-01-01 00:06:51 +0000 | [diff] [blame] | 919 | .B dev |
Michael Karcher | e544939 | 2012-05-05 20:53:59 +0000 | [diff] [blame] | 920 | parameter. The adapter type is selectable between SI-Prog (used for |
| 921 | SPI devices with PonyProg 2000) or a custom made serial bitbanging programmer |
| 922 | named "serbang". The optional |
Stefan Tauner | e34e3e8 | 2013-01-01 00:06:51 +0000 | [diff] [blame] | 923 | .B type |
Michael Karcher | e544939 | 2012-05-05 20:53:59 +0000 | [diff] [blame] | 924 | parameter accepts the values "si_prog" (default) or "serbang". |
| 925 | .sp |
| 926 | Information about the SI-Prog adapter can be found at |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 927 | .URLB "http://www.lancos.com/siprogsch.html" "its website" . |
Michael Karcher | e544939 | 2012-05-05 20:53:59 +0000 | [diff] [blame] | 928 | .sp |
| 929 | An example call to flashrom is |
| 930 | .sp |
| 931 | .B " flashrom \-p pony_spi:dev=/dev/ttyS0,type=serbang" |
| 932 | .sp |
| 933 | Please note that while USB-to-serial adapters work under certain circumstances, |
| 934 | this slows down operation considerably. |
| 935 | .SS |
Mark Marshall | 90021f2 | 2010-12-03 14:48:11 +0000 | [diff] [blame] | 936 | .BR "ogp_spi " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 937 | .IP |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 938 | The flash ROM chip to access must be specified with the |
Mark Marshall | 90021f2 | 2010-12-03 14:48:11 +0000 | [diff] [blame] | 939 | .B rom |
| 940 | parameter. |
| 941 | .sp |
| 942 | .B " flashrom \-p ogp_spi:rom=name" |
| 943 | .sp |
| 944 | Where |
| 945 | .B name |
| 946 | is either |
| 947 | .B cprom |
| 948 | or |
| 949 | .B s3 |
Stefan Tauner | e34e3e8 | 2013-01-01 00:06:51 +0000 | [diff] [blame] | 950 | for the configuration ROM and |
Mark Marshall | 90021f2 | 2010-12-03 14:48:11 +0000 | [diff] [blame] | 951 | .B bprom |
| 952 | or |
| 953 | .B bios |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 954 | for the BIOS ROM. If more than one card supported by the ogp_spi programmer |
Mark Marshall | 90021f2 | 2010-12-03 14:48:11 +0000 | [diff] [blame] | 955 | is installed in your system, you have to specify the PCI address of the card |
| 956 | you want to use with the |
| 957 | .B pci= |
| 958 | parameter as explained in the |
Stefan Tauner | e34e3e8 | 2013-01-01 00:06:51 +0000 | [diff] [blame] | 959 | .B nic3com et al.\& |
Mark Marshall | 90021f2 | 2010-12-03 14:48:11 +0000 | [diff] [blame] | 960 | section above. |
Carl-Daniel Hailfinger | 8541d23 | 2012-02-16 21:00:27 +0000 | [diff] [blame] | 961 | .SS |
| 962 | .BR "linux_spi " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 963 | .IP |
Carl-Daniel Hailfinger | 8541d23 | 2012-02-16 21:00:27 +0000 | [diff] [blame] | 964 | You have to specify the SPI controller to use with the |
| 965 | .sp |
| 966 | .B " flashrom \-p linux_spi:dev=/dev/spidevX.Y" |
| 967 | .sp |
| 968 | syntax where |
| 969 | .B /dev/spidevX.Y |
| 970 | is the Linux device node for your SPI controller. |
| 971 | .sp |
Stefan Tauner | 0554ca5 | 2013-07-25 22:54:25 +0000 | [diff] [blame] | 972 | In case the device supports it, you can set the SPI clock frequency with the optional |
| 973 | .B spispeed |
| 974 | parameter. The frequency is parsed as kilohertz. |
| 975 | Example that sets the frequency to 8 MHz: |
| 976 | .sp |
| 977 | .B " flashrom \-p linux_spi:dev=/dev/spidevX.Y,spispeed=8000" |
| 978 | .sp |
Carl-Daniel Hailfinger | 8541d23 | 2012-02-16 21:00:27 +0000 | [diff] [blame] | 979 | Please note that the linux_spi driver only works on Linux. |
Alexandre Boeglin | 80e6471 | 2014-12-20 20:25:19 +0000 | [diff] [blame] | 980 | .SS |
| 981 | .BR "mstarddc_spi " programmer |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 982 | .IP |
Alexandre Boeglin | 80e6471 | 2014-12-20 20:25:19 +0000 | [diff] [blame] | 983 | The Display Data Channel (DDC) is an I2C bus present on VGA and DVI connectors, that allows exchanging |
| 984 | informations between a computer and attached displays. Its most common uses are getting display capabilities |
| 985 | through EDID (at I2C address 0x50) and sending commands to the display using the DDC/CI protocol (at address |
| 986 | 0x37). On displays driven by MSTAR SoCs, it is also possible to access the SoC firmware flash (connected to |
| 987 | the Soc through another SPI bus) using an In-System Programming (ISP) port, usually at address 0x49. |
| 988 | This flashrom module allows the latter via Linux's I2C driver. |
| 989 | .sp |
| 990 | .B IMPORTANT: |
| 991 | Before using this programmer, the display |
| 992 | .B MUST |
| 993 | be in standby mode, and only connected to the computer that will run flashrom using a VGA cable, to an |
| 994 | inactive VGA output. It absolutely |
| 995 | .B MUST NOT |
| 996 | be used as a display during the procedure! |
| 997 | .sp |
| 998 | You have to specify the DDC/I2C controller and I2C address to use with the |
| 999 | .sp |
| 1000 | .B " flashrom \-p mstarddc_spi:dev=/dev/i2c-X:YY" |
| 1001 | .sp |
| 1002 | syntax where |
| 1003 | .B /dev/i2c-X |
| 1004 | is the Linux device node for your I2C controller connected to the display's DDC channel, and |
| 1005 | .B YY |
| 1006 | is the (hexadecimal) address of the MSTAR ISP port (address 0x49 is usually used). |
| 1007 | Example that uses I2C controller /dev/i2c-1 and address 0x49: |
| 1008 | .sp |
| 1009 | .B " flashrom \-p mstarddc_spi:dev=/dev/i2c-1:49 |
| 1010 | .sp |
| 1011 | It is also possible to inhibit the reset command that is normally sent to the display once the flashrom |
| 1012 | operation is completed using the optional |
| 1013 | .B noreset |
| 1014 | parameter. A value of 1 prevents flashrom from sending the reset command. |
| 1015 | Example that does not reset the display at the end of the operation: |
| 1016 | .sp |
| 1017 | .B " flashrom \-p mstarddc_spi:dev=/dev/i2c-1:49,noreset=1 |
| 1018 | .sp |
| 1019 | Please note that sending the reset command is also inhibited in the event an error occured during the operation. |
| 1020 | To send the reset command afterwards, you can simply run flashrom once more, in chip probe mode (not specifying |
| 1021 | an operation), without the |
| 1022 | .B noreset |
| 1023 | parameter, once the flash read/write operation you intended to perform has completed successfully. |
| 1024 | .sp |
| 1025 | Please also note that the mstarddc_spi driver only works on Linux. |
Urja Rannikko | 0870b02 | 2016-01-31 22:10:29 +0000 | [diff] [blame] | 1026 | .SS |
| 1027 | .BR "ch341a_spi " programmer |
| 1028 | The WCH CH341A programmer does not support any parameters currently. SPI frequency is fixed at 2 MHz, and CS0 is |
| 1029 | used as per the device. |
Carl-Daniel Hailfinger | 0b9af36 | 2012-07-21 16:56:04 +0000 | [diff] [blame] | 1030 | .SH EXAMPLES |
| 1031 | To back up and update your BIOS, run |
| 1032 | .sp |
| 1033 | .B flashrom -p internal -r backup.rom -o backuplog.txt |
| 1034 | .br |
| 1035 | .B flashrom -p internal -w newbios.rom -o writelog.txt |
| 1036 | .sp |
| 1037 | Please make sure to copy backup.rom to some external media before you try |
| 1038 | to write. That makes offline recovery easier. |
| 1039 | .br |
| 1040 | If writing fails and flashrom complains about the chip being in an unknown |
| 1041 | state, you can try to restore the backup by running |
| 1042 | .sp |
| 1043 | .B flashrom -p internal -w backup.rom -o restorelog.txt |
| 1044 | .sp |
| 1045 | If you encounter any problems, please contact us and supply |
| 1046 | backuplog.txt, writelog.txt and restorelog.txt. See section |
| 1047 | .B BUGS |
| 1048 | for contact info. |
Peter Stuge | 42688e5 | 2009-01-26 02:20:56 +0000 | [diff] [blame] | 1049 | .SH EXIT STATUS |
Niklas Söderlund | 2d8b7ef | 2013-09-13 19:19:25 +0000 | [diff] [blame] | 1050 | flashrom exits with 0 on success, 1 on most failures but with 3 if a call to mmap() fails. |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1051 | .SH REQUIREMENTS |
| 1052 | flashrom needs different access permissions for different programmers. |
| 1053 | .sp |
| 1054 | .B internal |
| 1055 | needs raw memory access, PCI configuration space access, raw I/O port |
| 1056 | access (x86) and MSR access (x86). |
| 1057 | .sp |
Jonathan Kollasch | 7f0f3fa | 2014-06-01 10:26:23 +0000 | [diff] [blame] | 1058 | .B atavia |
| 1059 | needs PCI configuration space access. |
| 1060 | .sp |
Sergey Lichack | 98f4710 | 2012-08-27 01:24:15 +0000 | [diff] [blame] | 1061 | .BR nic3com ", " nicrealtek " and " nicnatsemi " |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1062 | need PCI configuration space read access and raw I/O port access. |
| 1063 | .sp |
| 1064 | .B atahpt |
| 1065 | needs PCI configuration space access and raw I/O port access. |
| 1066 | .sp |
Kyösti Mälkki | 72d42f8 | 2014-06-01 23:48:31 +0000 | [diff] [blame] | 1067 | .BR gfxnvidia ", " drkaiser " and " it8212 |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1068 | need PCI configuration space access and raw memory access. |
| 1069 | .sp |
Carl-Daniel Hailfinger | e7fdd6e | 2010-07-21 10:26:01 +0000 | [diff] [blame] | 1070 | .B rayer_spi |
| 1071 | needs raw I/O port access. |
| 1072 | .sp |
Ricardo Ribalda Delgado | 2a41f0a | 2014-07-28 20:35:21 +0000 | [diff] [blame] | 1073 | .BR satasii ", " nicintel ", " nicintel_eeprom " and " nicintel_spi |
| 1074 | need PCI configuration space read access and raw memory access. |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1075 | .sp |
Joseph C. Lehner | c2644a3 | 2016-01-16 23:45:25 +0000 | [diff] [blame] | 1076 | .BR satamv " and " atapromise |
| 1077 | need PCI configuration space read access, raw I/O port access and raw memory |
Carl-Daniel Hailfinger | 9321f06 | 2011-07-24 18:41:13 +0000 | [diff] [blame] | 1078 | access. |
| 1079 | .sp |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1080 | .B serprog |
| 1081 | needs TCP access to the network or userspace access to a serial port. |
| 1082 | .sp |
| 1083 | .B buspirate_spi |
| 1084 | needs userspace access to a serial port. |
| 1085 | .sp |
Nico Huber | d99a2bd | 2016-02-18 21:42:49 +0000 | [diff] [blame] | 1086 | .BR ft2232_spi ", " usbblaster_spi " and " pickit2_spi |
Stefan Tauner | e49edbb | 2016-01-31 22:10:14 +0000 | [diff] [blame] | 1087 | need access to the respective USB device via libusb API version 0.1. |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1088 | .sp |
Nico Huber | d99a2bd | 2016-02-18 21:42:49 +0000 | [diff] [blame] | 1089 | .BR ch341a_spi " and " dediprog |
| 1090 | need access to the respective USB device via libusb API version 1.0. |
Urja Rannikko | 0870b02 | 2016-01-31 22:10:29 +0000 | [diff] [blame] | 1091 | .sp |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1092 | .B dummy |
| 1093 | needs no access permissions at all. |
| 1094 | .sp |
Sergey Lichack | 98f4710 | 2012-08-27 01:24:15 +0000 | [diff] [blame] | 1095 | .BR internal ", " nic3com ", " nicrealtek ", " nicnatsemi ", " |
Joseph C. Lehner | c2644a3 | 2016-01-16 23:45:25 +0000 | [diff] [blame] | 1096 | .BR gfxnvidia ", " drkaiser ", " satasii ", " satamv ", " atahpt ", " atavia " and " atapromise |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1097 | have to be run as superuser/root, and need additional raw access permission. |
| 1098 | .sp |
Urja Rannikko | 0870b02 | 2016-01-31 22:10:29 +0000 | [diff] [blame] | 1099 | .BR serprog ", " buspirate_spi ", " dediprog ", " usbblaster_spi ", " ft2232_spi ", " pickit2_spi " and " \ |
| 1100 | ch341a_spi |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1101 | can be run as normal user on most operating systems if appropriate device |
| 1102 | permissions are set. |
| 1103 | .sp |
Mark Marshall | 90021f2 | 2010-12-03 14:48:11 +0000 | [diff] [blame] | 1104 | .B ogp |
| 1105 | needs PCI configuration space read access and raw memory access. |
| 1106 | .sp |
Carl-Daniel Hailfinger | b63b067 | 2010-07-02 17:12:50 +0000 | [diff] [blame] | 1107 | On OpenBSD, you can obtain raw access permission by setting |
Uwe Hermann | 941a273 | 2011-07-25 21:12:57 +0000 | [diff] [blame] | 1108 | .B "securelevel=-1" |
| 1109 | in |
| 1110 | .B "/etc/rc.securelevel" |
| 1111 | and rebooting, or rebooting into single user mode. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 1112 | .SH BUGS |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 1113 | Please report any bugs to the |
| 1114 | .MTOB "flashrom@flashrom.org" "flashrom mailing list" . |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1115 | .sp |
| 1116 | We recommend to subscribe first at |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 1117 | .URLB "https://flashrom.org/mailman/listinfo/flashrom" "" . |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 1118 | .sp |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 1119 | Many of the developers communicate via the |
| 1120 | .B "#flashrom" |
| 1121 | IRC channel on |
| 1122 | .BR chat.freenode.net . |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 1123 | If you don't have an IRC client, you can use the |
| 1124 | .URLB http://webchat.freenode.net/?channels=flashrom "freenode webchat" . |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 1125 | You are welcome to join and ask questions, send us bug and success reports there |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 1126 | too. Please provide a way to contact you later (e.g.\& a mail address) and be |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 1127 | patient if there is no immediate reaction. Also, we provide a |
| 1128 | .URLB https://paste.flashrom.org "pastebin service" |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 1129 | that is very useful when you want to share logs etc.\& without spamming the |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 1130 | channel. |
| 1131 | .SS |
| 1132 | .B Laptops |
| 1133 | .sp |
Carl-Daniel Hailfinger | 2702376 | 2010-04-28 15:22:14 +0000 | [diff] [blame] | 1134 | Using flashrom on laptops is dangerous and may easily make your hardware |
Stefan Tauner | 9e9f684 | 2012-02-16 20:55:27 +0000 | [diff] [blame] | 1135 | unusable. flashrom will attempt to detect if it is running on a laptop and abort |
| 1136 | immediately for safety reasons. Please see the detailed discussion of this topic |
| 1137 | and associated flashrom options in the |
| 1138 | .B Laptops |
| 1139 | paragraph in the |
| 1140 | .B internal programmer |
| 1141 | subsection of the |
Stefan Tauner | 6697f71 | 2014-08-06 15:09:15 +0000 | [diff] [blame] | 1142 | .B PROGRAMMER-SPECIFIC INFORMATION |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 1143 | section and the information |
| 1144 | .URLB "https://flashrom.org/Laptops" "in our wiki" . |
Daniel Lenski | 65922a3 | 2012-02-15 23:40:23 +0000 | [diff] [blame] | 1145 | .SS |
| 1146 | One-time programmable (OTP) memory and unique IDs |
| 1147 | .sp |
| 1148 | Some flash chips contain OTP memory often denoted as "security registers". |
| 1149 | They usually have a capacity in the range of some bytes to a few hundred |
Stefan Tauner | eb58257 | 2012-09-21 12:52:50 +0000 | [diff] [blame] | 1150 | bytes and can be used to give devices unique IDs etc. flashrom is not able |
Daniel Lenski | 65922a3 | 2012-02-15 23:40:23 +0000 | [diff] [blame] | 1151 | to read or write these memories and may therefore not be able to duplicate a |
| 1152 | chip completely. For chip types known to include OTP memories a warning is |
| 1153 | printed when they are detected. |
| 1154 | .sp |
| 1155 | Similar to OTP memories are unique, factory programmed, unforgeable IDs. |
| 1156 | They are not modifiable by the user at all. |
Stefan Tauner | ac54fbe | 2011-07-21 19:52:00 +0000 | [diff] [blame] | 1157 | .SH LICENSE |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 1158 | .B flashrom |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1159 | is covered by the GNU General Public License (GPL), version 2. Some files are |
Stefan Tauner | 23e10b8 | 2016-01-23 16:16:49 +0000 | [diff] [blame] | 1160 | additionally available under any later version of the GPL. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 1161 | .SH COPYRIGHT |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 1162 | .br |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1163 | Please see the individual files. |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 1164 | .SH AUTHORS |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1165 | Andrew Morgan |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1166 | .br |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1167 | Carl-Daniel Hailfinger |
| 1168 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1169 | Claus Gindhart |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1170 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1171 | David Borg |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1172 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1173 | David Hendricks |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1174 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1175 | Dominik Geyer |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1176 | .br |
Stefan Reinauer | edc6188 | 2010-01-03 14:40:30 +0000 | [diff] [blame] | 1177 | Eric Biederman |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1178 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1179 | Giampiero Giancipoli |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1180 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1181 | Helge Wagner |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1182 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1183 | Idwer Vollering |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1184 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1185 | Joe Bao |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1186 | .br |
Stefan Tauner | c0aaf95 | 2011-05-19 02:58:17 +0000 | [diff] [blame] | 1187 | Joerg Fischer |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1188 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1189 | Joshua Roys |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1190 | .br |
Stefan Tauner | 5c316f9 | 2015-02-08 21:57:52 +0000 | [diff] [blame] | 1191 | Ky\[:o]sti M\[:a]lkki |
| 1192 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1193 | Luc Verhaegen |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1194 | .br |
Carl-Daniel Hailfinger | 451dc80 | 2009-05-01 11:00:39 +0000 | [diff] [blame] | 1195 | Li-Ta Lo |
| 1196 | .br |
Mark Marshall | 90021f2 | 2010-12-03 14:48:11 +0000 | [diff] [blame] | 1197 | Mark Marshall |
| 1198 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1199 | Markus Boas |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1200 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1201 | Mattias Mattsson |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1202 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1203 | Michael Karcher |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 1204 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1205 | Nikolay Petukhov |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1206 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1207 | Patrick Georgi |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1208 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1209 | Peter Lemenkov |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1210 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1211 | Peter Stuge |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1212 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1213 | Reinder E.N. de Haan |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1214 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1215 | Ronald G. Minnich |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1216 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1217 | Ronald Hoogenboom |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 1218 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1219 | Sean Nelson |
Carl-Daniel Hailfinger | 8841d3e | 2010-05-15 15:04:37 +0000 | [diff] [blame] | 1220 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1221 | Stefan Reinauer |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 1222 | .br |
Uwe Hermann | 68b9cca | 2011-06-15 23:44:52 +0000 | [diff] [blame] | 1223 | Stefan Tauner |
| 1224 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1225 | Stefan Wildemann |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1226 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1227 | Stephan Guilloux |
Carl-Daniel Hailfinger | 3e85442 | 2010-10-06 23:03:21 +0000 | [diff] [blame] | 1228 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1229 | Steven James |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1230 | .br |
Stefan Tauner | 23e10b8 | 2016-01-23 16:16:49 +0000 | [diff] [blame] | 1231 | Urja Rannikko |
| 1232 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1233 | Uwe Hermann |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1234 | .br |
Stefan Reinauer | edc6188 | 2010-01-03 14:40:30 +0000 | [diff] [blame] | 1235 | Wang Qingpei |
Carl-Daniel Hailfinger | 851ecf2 | 2009-01-08 04:56:59 +0000 | [diff] [blame] | 1236 | .br |
Stefan Reinauer | edc6188 | 2010-01-03 14:40:30 +0000 | [diff] [blame] | 1237 | Yinghai Lu |
Stefan Reinauer | f8337dd | 2006-08-03 10:49:09 +0000 | [diff] [blame] | 1238 | .br |
Carl-Daniel Hailfinger | ef69783 | 2010-10-07 22:21:45 +0000 | [diff] [blame] | 1239 | some others, please see the flashrom svn changelog for details. |
| 1240 | .br |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 1241 | All still active authors can be reached via |
| 1242 | .MTOB "flashrom@flashrom.org" "the mailing list" . |
Stefan Reinauer | 261144c | 2006-07-27 23:29:02 +0000 | [diff] [blame] | 1243 | .PP |
Stefan Tauner | 4c72315 | 2016-01-14 22:47:55 +0000 | [diff] [blame] | 1244 | This manual page was written by |
| 1245 | .MTOB "uwe@hermann-uwe.de" "Uwe Hermann" , |
| 1246 | Carl-Daniel Hailfinger, Stefan Tauner and others. |
Uwe Hermann | 42eb17f | 2008-01-18 17:48:51 +0000 | [diff] [blame] | 1247 | It is licensed under the terms of the GNU GPL (version 2 or later). |