2 .\" Copyright (c) 2010 Weongyo Jeong.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd "dump traffic on USB host controller"
44 utility provides a way to dump USB packets on host controllers.
46 The following options are accepted:
47 .Bl -tag -width ".Fl f Ar file"
49 Listen on USB bus interface
52 Read the raw packets from
57 bytes from each packet.
59 Enable debugging messages.
60 When defined multiple times the verbosity level increases.
62 Write the raw packets to
66 Capture the USB raw packets on usbus2:
68 .Dl "usbdump -i usbus2 -s 256 -v"
70 Dump the USB raw packets of usbus2 into the file without packet
73 .Dl "usbdump -i usbus2 -s 0 -w /tmp/dump_pkts"
75 Read and display the USB raw packets from previous file:
77 .Dl "usbdump -r /tmp/dump_pkts -v"
83 .Dl "<time> <bus>.<addr> <ep> <xfertype> <S/D> (<frames>/<length>) <...>"
85 The meaning of the output format elements is as follows:
86 .Bl -tag -width "<xfertype>"
88 A timestamp preceding all output lines.
89 The timestamp has the format "hh:mm:ss.frac" and is as accurate as
92 The USB host controller's bus unit number.
94 The unique number of the USB device as allocated by the host controller driver.
96 The USB endpoint address that indicates whether the address is
101 The USB transfer type.
109 `S' indicates a USB submit.
110 `D' indicates a USB transfer done.
112 Numbers of frames in this packets.
113 If this is a USB submit, its value is
115 which means how many frames are acceptable or registered to transfer.
116 If this is a USB done,
118 is the actual number of frames.
121 If this is a USB submit, its value is
123 If this is a USB done, its value is
126 Optional field used for printing an error string if the packet is from USB done.
132 .Aq weongyo@FreeBSD.org