Copyright (c) 2010 Weongyo Jeong.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

$FreeBSD: stable/9/usr.sbin/usbdump/usbdump.8 222519 2011-05-31 07:13:07Z bcr $

.Dd May 31, 2011 .Dt USBDUMP 8 .Os .Sh NAME .Nm usbdump .Nd "dump traffic on USB host controller" .Sh SYNOPSIS .Nm .Op Fl i Ar ifname .Op Fl r Ar file .Op Fl s Ar snaplen .Op Fl v .Op Fl w Ar file .Sh DESCRIPTION The .Nm utility provides a way to dump USB packets on host controllers.

p The following options are accepted: l -tag -width ".Fl f Ar file" t Fl i Ar ifname Listen on USB bus interface .Ar ifname . t Fl r Ar file Read the raw packets from .Ar file . t Fl s Ar snaplen Snapshot .Ar snaplen bytes from each packet. t Fl v Enable debugging messages. When defined multiple times the verbosity level increases. t Fl w Ar file Write the raw packets to .Ar file . .El .Sh EXAMPLES Capture the USB raw packets on usbus2:

p .Dl "usbdump -i usbus2 -s 256 -v"

p Dump the USB raw packets of usbus2 into the file without packet size limit:

p .Dl "usbdump -i usbus2 -s 0 -w /tmp/dump_pkts"

p Read and display the USB raw packets from previous file:

p .Dl "usbdump -r /tmp/dump_pkts -v" .Sh OUTPUT FORMAT The output format of .Nm is as follows:

p .Dl "<time> <bus>.<addr> <ep> <xfertype> <S/D> (<frames>/<length>) <...>"

p The meaning of the output format elements is as follows: l -tag -width "<xfertype>" t <time> A timestamp preceding all output lines. The timestamp has the format "hh:mm:ss.frac" and is as accurate as the kernel's clock. t <bus> The USB host controller's bus unit number. t <addr> The unique number of the USB device as allocated by the host controller driver. t <ep> The USB endpoint address that indicates whether the address is .Dv OUT or .Dv IN . t <xfertype> The USB transfer type. Can be .Dv CTRL , .Dv ISOC , .Dv BULK or .Dv INTR . t <S/D> `S' indicates a USB submit. `D' indicates a USB transfer done. t <frames> Numbers of frames in this packets. If this is a USB submit, its value is .Li xfer->nframes which means how many frames are acceptable or registered to transfer. If this is a USB done, .Li xfer->aframes is the actual number of frames. t <length> Total packet size. If this is a USB submit, its value is .Li xfer->sumlen . If this is a USB done, its value is .Li xfer->actlen . t <...> Optional field used for printing an error string if the packet is from USB done. .El .Sh SEE ALSO .Xr usbconfig 8 .Sh AUTHORS .An Weongyo Jeong .Aq weongyo@FreeBSD.org