summaryrefslogtreecommitdiff
path: root/doc/dfu-prefix.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/dfu-prefix.1')
-rw-r--r--doc/dfu-prefix.184
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/dfu-prefix.1 b/doc/dfu-prefix.1
new file mode 100644
index 0000000..a135dec
--- /dev/null
+++ b/doc/dfu-prefix.1
@@ -0,0 +1,84 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "DFU\-PREFIX" "1" "September 2021" "dfu\-util 0.11" ""
+.hy
+.SH NAME
+.PP
+dfu\-prefix \- add, check, or remove special firmware file prefix
+.SH SYNOPSIS
+.PP
+\f[B]dfu\-prefix\f[R] [ \f[B]\-s\f[R] \f[I]address\f[R] | \f[B]\-L\f[R]
+] \f[B]\-\-add\f[R] \f[I]DFU_FILE\f[R]
+.PD 0
+.P
+.PD
+\f[B]dfu\-prefix\f[R] [ \f[B]\-T\f[R] | \f[B]\-L\f[R] ]
+\f[B]\-\-check\f[R] \f[I]DFU_FILE\f[R]
+.PD 0
+.P
+.PD
+\f[B]dfu\-prefix\f[R] [ \f[B]\-T\f[R] | \f[B]\-L\f[R] ]
+\f[B]\-\-delete\f[R] \f[I]DFU_FILE\f[R]
+.PD 0
+.P
+.PD
+\f[B]dfu\-prefix\f[R] \f[B]\-\-help\f[R]
+.PD 0
+.P
+.PD
+\f[B]dfu\-prefix\f[R] \f[B]\-\-version\f[R]
+.SH DESCRIPTION
+.PP
+The program \f[B]dfu\-prefix\f[R] can be used to add, check or remove a
+prefix used by certain hardware manufacturers.
+The Stellaris format from TI and the LPC format from NXP is supported.
+.PP
+Note that a standard DFU firmware file has no concept of a prefix, and a
+DFU host tool like dfu\-util passes the prefix on to the device as part
+of the normal firmware payload.
+.SH OPTIONS
+.TP
+.B \-s, \-\-stellaris\-address \f[I]address\f[R]
+(in combination with \-\-add) Add TI Stellaris address prefix to file
+.TP
+.B \-T, \-\-stellaris
+(in combination with \-\-delete or \-\-check) Act on TI Stellaris
+address prefix of file
+.TP
+.B \-L, \-\-lpc\-prefix
+(in combination with \-\-add or \-\-delete or \-\-check) Use NXP LPC DFU
+prefix format
+.TP
+.B \-h, \-\-help
+Displays a help message.
+.TP
+.B \-V, \-\-version
+Displays the software version.
+.SH EXAMPLES
+.TP
+.B \f[B]dfu\-prefix\f[R] \-\-stellaris\-address 0x0100 \-\-add firmware.dfu
+Adds a Stellaris prefix with load address 0x0100
+.TP
+.B \f[B]dfu\-prefix\f[R] \-\-stellaris \-\-check firmware.dfu
+Checks the file firmware.dfu for a Stellaris prefix
+.TP
+.B \f[B]dfu\-prefix\f[R] \-\-lpc\-prefix \-\-delete firmware.dfu
+Removes a LPC prefix from the file firmware.dfu
+.SH EXIT VALUES
+.TP
+.B \f[B]0\f[R]
+Success (also if prefix is missing)
+.TP
+.B \f[B]\-64\f[R]
+Usage error
+.SH BUGS
+.PP
+https://sourceforge.net/p/dfu\-util/tickets/
+.SH COPYRIGHT
+.PP
+License GPLv2: GNU GPL version 2
+.SH SEE ALSO
+.PP
+\f[B]dfu\-suffix\f[R](1), \f[B]dfu\-util\f[R](1)
+.SH AUTHORS
+See AUTHORS file in source.