summaryrefslogtreecommitdiff
path: root/doc/dfu-suffix.1.md
blob: 9bb4375827804dd07cdc0399b98c730da93d4446 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
% DFU-SUFFIX(1) dfu-util 0.11
% See AUTHORS file in source
% September 2021

# NAME
dfu-suffix - add, check, or remove DFU firmware file suffix

# SYNOPSIS
**dfu-suffix** [*options*] **\--add** *DFU_FILE*\
**dfu-suffix** **\--check** *DFU_FILE*\
**dfu-suffix** **\--delete** *DFU_FILE*\
**dfu-suffix** **\--help**\
**dfu-suffix** **\--version**

# DESCRIPTION
The program **dfu-suffix** can be used to add, check or remove a DFU firmware file suffix,
recommended for safely matching a firmware file and device.

Note that a suffix is recommended by the DFU standard, but not required.
A DFU host tool like dfu-util will recognize the suffix and use it to check
that the device is matching, but not transfer the suffix to the device.

# OPTIONS
-v, \--vid *vendorID*
: Specify USB vendor ID (hexadecimal)

-p, \--pid *productID*
: Specify USB product ID (hexadecimal)

-d, \--did *deviceID*
: Specify USB device ID (hexadecimal)

-S, \--spec *version*
: Specify DFU specification version (hexadecimal)

-h, \--help
: Displays a help message.

-V, \--version
: Displays the software version.

# EXAMPLES
**dfu-suffix** \--vid 0123 \--add firmware.dfu
: Adds a suffix matching vendor 0x0123 and product ID 0x4567.
Since product and device ID are not specified,
they will contain the wildcard value 0xFFFF.

**dfu-suffix** \--check firmware.dfu
: Checks the file firmware.dfu for a valid DFU suffix

**dfu-suffix** \--delete firmware.dfu
: Removes a valid DFU suffix from the file firmware.dfu

# EXIT VALUES
**0**
: Success (also if suffix is missing)

**-64**
: Usage error

# LIMITATIONS
**dfu-suffix** can not tell a broken DFU suffix (e.g. checksum mismatch)
from a non-existing suffix, so only a valid suffix can be removed.

# BUGS
https://sourceforge.net/p/dfu-util/tickets/

# COPYRIGHT
License GPLv2: GNU GPL version 2

# SEE ALSO
**dfu-prefix**(1), **dfu-util**(1)