r4160 - in trunk/src/host/dfu-util: . doc

werner at sita.openmoko.org werner at sita.openmoko.org
Tue Mar 4 05:10:13 CET 2008

Author: werner
Date: 2008-03-04 05:10:10 +0100 (Tue, 04 Mar 2008)
New Revision: 4160

From: Uwe Hermann <uwe at hermann-uwe.de>

Here's a small manpage I've written for dfu-util.

Added: trunk/src/host/dfu-util/doc/dfu-util.1
--- trunk/src/host/dfu-util/doc/dfu-util.1	2008-03-04 03:56:36 UTC (rev 4159)
+++ trunk/src/host/dfu-util/doc/dfu-util.1	2008-03-04 04:10:10 UTC (rev 4160)
@@ -0,0 +1,115 @@
+.TH DFU-UTIL 1 "February 29, 2008"
+dfu-util \- Device firmware update (DFU) USB programmer
+.B dfu-util \fR[\fB\-ldpciatUDRhV\fR]
+.B dfu-util
+is a program that implements the host (PC) side of the USB DFU
+(Universal Serial Bus Device Firmware Upgrade) protocol.
+In the OpenMoko project (for example), this program is used to communicate
+with the specially enhanced u-boot boot loader, which implements the DFU
+device side.
+.B "\-l, \-\-list"
+List the currently attached DFU capable USB devices.
+.BR "\-d, \-\-device" " VENDOR:PRODUCT"
+Specify vendor/product ID of the DFU device. Both
+are hex-numbers which must start with
+.BR 0x .
+.B "  $ dfu-util --device 0x1457:0x5119"
+If you only have one standards-compliant DFU device attached to your PC,
+this is optional. However, as soon as you have multiple DFU devices,
+dfu-util will detect this and abort, asking you to specify which device
+it shall use.
+.BR "\-p, \-\-path" " BUS-PORT. ... .PORT"
+Specify the path to the DFU device.
+.BR "\-c, \-\-cfg" " CONFIG-NR"
+Specify the configuration of the DFU device.
+.BR "\-i, \-\-intf" " INTF-NR"
+Specify the DFU interface number.
+.BR "\-a, \-\-alt" " ALT"
+Specify the altsetting of the DFU interface by name or by number.
+.B "\-t, \-\-transfer-size"
+Specify the number of bytes per USB transfer. If you don't supply this
+option, the maximum possible size for your combination of host OS and
+USB device is chosen (for optimal performance).
+.BR "\-U, \-\-upload" " FILE"
+Read firmware from device into
+.B Note:
+Upload support is currently broken.
+.BR "\-D, \-\-download" " FILE"
+Write firmware from
+into device.
+.B "\-R, \-\-reset"
+Issue USB reset signalling once we're finished.
+.B "\-h, \-\-help"
+Show a help text and exit.
+.B "\-V, \-\-version"
+Show version information and exit.
+Here are some examples for the usage of dfu-util in the OpenMoko project
+(working with the Neo1973 hardware):
+Flashing the rootfs:
+.B "  $ dfu-util -a rootfs -R -D /path/to/openmoko-devel-image.jffs2"
+Flashing the kernel:
+.B "  $ dfu-util -a kernel -R -D /path/to/uImage"
+Flashing the bootloader:
+.B "  $ dfu-util -a u-boot -R -D /path/to/u-boot.bin"
+Copying a kernel into RAM:
+.B "  $ dfu-util -a 0 -R -D /path/to/uImage"
+Once this has finished, the kernel will be available at the default load
+address of 0x32000000 in Neo1973 RAM.
+.B Note:
+You cannot transfer more than 2MB of data into RAM using this method.
+Please see
+.B http://wiki.openmoko.org/wiki/Dfu-util
+for some limitations and bugs in the current dfu-util code.
+Please report any further bugs at
+.B http://bugzilla.openmoko.org
+or on the openmoko-kernel mailing list at
+.BR openmoko-kernel at lists.openmoko.org .
+.B dfu-util
+is covered by the GNU General Public License (GPL), version 2 or later.
+Weston Schmidt <weston_schmidt at yahoo.com>
+Harald Welte <hwelte at hmw-consulting.de>
+This manual page was written by Uwe Hermann <uwe at hermann-uwe.de>.
+It is licensed under the terms of the GNU GPL (version 2 or later).

More information about the commitlog mailing list