xref: /freebsd/usr.sbin/usbconfig/usbconfig.8 (revision 0ea0127a4db7e850a4d7f5ed08eb7078b82c95bb)
1eabe30fcSAlfred Perlstein.\" $FreeBSD$
2eabe30fcSAlfred Perlstein.\"
3cf109686SAndrew Thompson.\" Copyright (c) 2008-2010 Hans Petter Selasky. All rights reserved.
4eabe30fcSAlfred Perlstein.\"
5eabe30fcSAlfred Perlstein.\" Redistribution and use in source and binary forms, with or without
6eabe30fcSAlfred Perlstein.\" modification, are permitted provided that the following conditions
7eabe30fcSAlfred Perlstein.\" are met:
8eabe30fcSAlfred Perlstein.\" 1. Redistributions of source code must retain the above copyright
9eabe30fcSAlfred Perlstein.\"    notice, this list of conditions and the following disclaimer.
10eabe30fcSAlfred Perlstein.\" 2. Redistributions in binary form must reproduce the above copyright
11eabe30fcSAlfred Perlstein.\"    notice, this list of conditions and the following disclaimer in the
12eabe30fcSAlfred Perlstein.\"    documentation and/or other materials provided with the distribution.
13eabe30fcSAlfred Perlstein.\"
14eabe30fcSAlfred Perlstein.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15eabe30fcSAlfred Perlstein.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16eabe30fcSAlfred Perlstein.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17eabe30fcSAlfred Perlstein.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18eabe30fcSAlfred Perlstein.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19eabe30fcSAlfred Perlstein.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20eabe30fcSAlfred Perlstein.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21eabe30fcSAlfred Perlstein.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22eabe30fcSAlfred Perlstein.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23eabe30fcSAlfred Perlstein.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24eabe30fcSAlfred Perlstein.\" SUCH DAMAGE.
25eabe30fcSAlfred Perlstein.\"
26cf109686SAndrew Thompson.Dd January 6, 2010
27eabe30fcSAlfred Perlstein.Dt USBCONFIG 8
28eabe30fcSAlfred Perlstein.Os
29eabe30fcSAlfred Perlstein.Sh NAME
30eabe30fcSAlfred Perlstein.Nm usbconfig
31eabe30fcSAlfred Perlstein.Nd configure the USB subsystem
32eabe30fcSAlfred Perlstein.Sh SYNOPSIS
33eabe30fcSAlfred Perlstein.Nm
34eabe30fcSAlfred Perlstein.Op Fl u Ar unit
35eabe30fcSAlfred Perlstein.Op Fl a Ar addr
36eabe30fcSAlfred Perlstein.Op cmds...
37cf109686SAndrew Thompson.Nm
38cf109686SAndrew Thompson.Op Fl d Ar [ugen]<unit>.<addr>
39cf109686SAndrew Thompson.Op cmds...
40eabe30fcSAlfred Perlstein.Sh DESCRIPTION
41eabe30fcSAlfred PerlsteinThe
42eabe30fcSAlfred Perlstein.Nm
43eabe30fcSAlfred Perlsteinutility is used to configure and dump information about the USB subsystem.
44eabe30fcSAlfred Perlstein.Pp
45eabe30fcSAlfred PerlsteinThe options are as follows:
46eabe30fcSAlfred Perlstein.Bl -tag -width "        "
47eabe30fcSAlfred Perlstein.It Fl u Ar unit
48eabe30fcSAlfred PerlsteinLimit device range to USB devices connected to the given USBUS unit.
49eabe30fcSAlfred Perlstein.It Fl a Ar addr
50eabe30fcSAlfred PerlsteinLimit device range to the given USB device index.
51eabe30fcSAlfred PerlsteinShould only be used in conjunction with the unit argument.
52cf109686SAndrew Thompson.It Fl d Ar [ugen]<unit>.<addr>
53cf109686SAndrew ThompsonLimit device range to USB devices connected to the given unit and address.
54cf109686SAndrew ThompsonThe unit and address coordinates may be prefixed by the lowercased word "ugen".
55eabe30fcSAlfred Perlstein.It Fl h
56eabe30fcSAlfred PerlsteinShow help and available commands.
57eabe30fcSAlfred Perlstein.El
5894b7ebd7SChristian Brueffer.Pp
5994b7ebd7SChristian BruefferWhen called without options,
6094b7ebd7SChristian Brueffer.Nm
6194b7ebd7SChristian Bruefferprints a list of all available USB devices.
6294b7ebd7SChristian Brueffer.Sh EXAMPLES
6394b7ebd7SChristian BruefferShow information about the device on USB bus 1 at address 2:
6494b7ebd7SChristian Brueffer.Pp
6594b7ebd7SChristian Brueffer.Dl usbconfig -u 1 -a 2 dump_info
66cf109686SAndrew Thompson.Pp
67cf109686SAndrew ThompsonDump HID descriptor for device on USB bus 1 at address 2:
68cf109686SAndrew Thompson.Pp
69cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 do_request 0x81 0x06 0x2200 0 0x100
70cf109686SAndrew Thompson.Pp
71cf109686SAndrew ThompsonDump string descriptor at index Z for device on USB bus 1 at address 2:
72cf109686SAndrew Thompson.Pp
73cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 dump_string Z
74cf109686SAndrew Thompson.Pp
75cf109686SAndrew ThompsonDump current configuration descriptor for device on USB bus 1 at address 2:
76cf109686SAndrew Thompson.Pp
77cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 dump_curr_config_desc
78cf109686SAndrew Thompson.Pp
79cf109686SAndrew ThompsonDump device descriptor for device on USB bus 1 at address 2:
80cf109686SAndrew Thompson.Pp
81cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 dump_device_desc
82cf109686SAndrew Thompson.Pp
83cf109686SAndrew ThompsonProgram the device on USB bus 1 at address 2 to suspend, resume, power off, go into power save, or power on:
84cf109686SAndrew Thompson.Pp
85cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 suspend
86cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 resume
87cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 power_off
88cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 power_save
89cf109686SAndrew Thompson.Dl usbconfig -u 1 -a 2 power_on
90cf109686SAndrew Thompson.Pp
91cf109686SAndrew ThompsonDisplay a list of available quirk names:
92cf109686SAndrew Thompson.Pp
93cf109686SAndrew Thompson.Dl usbconfig dump_quirk_names
94cf109686SAndrew Thompson.Pp
95*0ea0127aSNick HibmaSee
96*0ea0127aSNick Hibma.Xr usb_quirk 4
97*0ea0127aSNick Hibmafor more information on quirks.
98eabe30fcSAlfred Perlstein.Sh SEE ALSO
99*0ea0127aSNick Hibma.Xr usb 4 ,
100*0ea0127aSNick Hibma.Xr usb_quirk 4
101