diff options
Diffstat (limited to 'doc/dfu-util.1')
| -rw-r--r-- | doc/dfu-util.1 | 51 |
1 files changed, 38 insertions, 13 deletions
diff --git a/doc/dfu-util.1 b/doc/dfu-util.1 index 4d1705f..3ef65e8 100644 --- a/doc/dfu-util.1 +++ b/doc/dfu-util.1 @@ -1,4 +1,4 @@ -.TH DFU-UTIL 1 "September 23, 2012" +.TH "DFU\-UTIL" "1" "September 2021" "dfu\-util 0.11" "" .SH NAME dfu-util \- Device firmware update (DFU) USB programmer .SH SYNOPSIS @@ -39,6 +39,7 @@ dfu-util \- Device firmware update (DFU) USB programmer .IR size \|] .RB [\| \-Z .IR size \|] +.RB [\| \-w \|] .RB [\| \-s .IR address \|] .RB [\| \-R \|] @@ -136,6 +137,7 @@ Specify the DFU interface number. Specify the altsetting of the DFU interface by name or by number. .TP .BR "\-S, \-\-serial" " [\fIRun-Time SERIAL\fP][,[\fIDFU Mode SERIAL\fP]]" +.RS Specify the run-time and DFU mode serial numbers used to further restrict device matches. If multiple, identical DFU devices are simultaneously connected to a system then vendor and product ID will be insufficient for @@ -145,14 +147,16 @@ parameter to specify a serial number which also must match. If only a single serial number is specified, then the same serial number is used in both run-time and DFU mode. An empty serial number will match any serial number in the corresponding mode. +.RE .TP -.B "\-t, \-\-transfer-size" " SIZE" +.BR "\-t, \-\-transfer-size" " SIZE" Specify the number of bytes per USB transfer. The optimal value is usually determined automatically so this option is rarely useful. If you need to use this option for a device, please report it as a bug. .TP -.B "\-Z, \-\-upload-size" " SIZE" -Specify the expected upload size, in bytes. +.BR "\-Z, \-\-upload-size" " SIZE" +Specify the expected upload size, in bytes. Note that the value is only used +for scaling the progress bar, the actual upload size is determined by the device. .TP .BR "\-U, \-\-upload" " FILE" Read firmware from device into @@ -161,23 +165,44 @@ Read firmware from device into .BR "\-D, \-\-download" " FILE" Write firmware from .B FILE -into device. When FILE is \-, the firmware is read from stdin. +into device. When +.B FILE +is \-, the firmware is read from stdin. .TP .B "\-R, \-\-reset" Issue USB reset signalling after upload or download has finished. .TP -.BR "\-s, \-\-dfuse-address" " address" +.B "\-e, \-\-detach" +Request that the device re-enumerate out of run-time mode and into DFU mode as +when uploading or downloading, but exit immediately after sending the request. +.TP +.BR "\-E, \-\-detach-delay" " SECONDS" +When uploading or downloading, wait +.B SECONDS +seconds for the device to re-enumerate after sending the detach request before +giving up. Defaults to 5 seconds. This option has no effect with \fB-e\fP, +since that causes dfu-util to immediately exit after sending the detach request. +.TP +.B "\-w, \-\-wait" +Wait until matching device appears on the USB bus. +.TP +.BR "\-s, \-\-dfuse-address" " [\fIADDRESS\fP][:\fILENGTH\fP][:\fIMODIFIERS\fP]" Specify target address for raw binary download/upload on DfuSe devices. Do .B not -use this for downloading DfuSe (.dfu) files. Modifiers can be added -to the address, separated by a colon, to perform special DfuSE commands such -as "leave" DFU mode, "unprotect" and "mass-erase" flash memory. +use this option for downloading DfuSe (.dfu) files. +A length can be specified for uploads. Modifiers can be added after the +address, separated by a colon, to perform special DfuSE commands such as +"leave" DFU mode, "unprotect" and "mass-erase" flash memory. +If the device can be expected to reset itself after the operation, "will-reset" +should be added. The "force" modifier will override some sanity checks, and is +also needed for the "unprotect" and "mass-erase" operations. .TP .B "\-v, \-\-verbose" Print more information about dfu-util's operation. A second .B -v -will turn on verbose logging of USB requests. Repeat this option to further -increase verbosity. +adds more details. A third +.B -v +activates verbose logging of USB requests (libusb debug output). .TP .B "\-h, \-\-help" Show a help text and exit. @@ -215,7 +240,7 @@ Flashing a .B .dfu (special DfuSe format) file to the device: .br -.B " $ dfu-util -a 0 -D /path/to/dfuse-image.dfu" +.B " $ dfu-util -D /path/to/dfuse-image.dfu" .PP Reading out 1 KB of flash starting at address 0x8000000: .br @@ -234,7 +259,7 @@ Please use the information in your bug report. .SH SEE ALSO The dfu-util home page is -.B http://sourceforge.net/p/dfu-util/ +.B http://dfu-util.sourceforge.net/ .SH HISTORY dfu-util was originally written for the OpenMoko project by Weston Schmidt <weston_schmidt@yahoo.com> and |