3 .\" Copyright (c) 2008-2019 Hans Petter Selasky. 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
31 .Nd configure the USB subsystem
36 .Op Fl i Ar interface_index
42 .Oo Oo Cm /dev/ Oc Cm ugen Oc Ar unit Cm \&. Ar addr
45 .Op Fl i Ar interface_index
50 utility is used to configure and dump information about the USB subsystem.
52 The options are as follows:
53 .Bl -tag -width "-u unit"
55 Limit device range to the given USB device index.
56 Should only be used in conjunction with the unit argument.
60 .Oo Oo Cm /dev/ Oc Cm ugen Oc Ar unit Cm \&. Ar addr
63 Limit device range to USB devices connected to the given unit and address.
64 The unit and address coordinates may be prefixed by the lowercased word
69 Show help and available commands.
70 .It Fl i Ar interface_index
71 Specify interface index as indicated by the command description.
72 If this argument is not specified
73 a value of zero will be used for the interface index.
75 Limit device range to USB devices connected to the given USBUS unit.
78 .Cm dump_device_desc ,
79 .Cm dump_curr_config_desc ,
86 The following commands may be used with
88 .Bl -tag -width indent
89 .It Cm set_config Ar cfg_index
90 Choose the configuration for the USB device.
91 Valid values range from zero to the number reported as the
92 .Ar bNumConfigurations
96 The special value of 255 unconfigures the device, detaching
97 the interface drivers and reducing the power consumption to minimum,
98 but without going into power saving mode or detaching from the bus.
99 In some cases, it prevents the device from charging.
100 .It Cm set_alt Ar alt_index
101 Choose the alternate interface for the selected interface and USB device.
102 Alternative settings for the current configuration are available as the
103 .Ar bAlternateSetting
105 .Cm dump_curr_config_desc
107 Usually there is no need to adjust this setting.
108 This command uses the
109 .Fl i Ar interface_index
111 .It Cm set_template Ar template
112 Set the global USB device side template.
115 for more information.
117 Get the current USB device side template.
118 .It Cm add_dev_quirk_vplh Ar vid Ar pid Ar lo_rev Ar hi_rev Ar quirk_name
119 Add a quirk by specifying the Vendor ID, Product ID, low and high
120 revision numbers, and the quirk name.
123 for more information.
124 .It Cm remove_dev_quirk_vplh Ar vid Ar pid Ar lo_rev Ar hi_rev Ar quirk_name
126 .It Cm add_quirk Ar quirk_name
127 Add quirk for the currently selected USB device.
128 .It Cm remove_quirk Ar quirk_name
129 Remove a quirk for the currently selected USB device.
131 Display the device and configuration descriptors.
132 .It Cm dump_quirk_names
133 Display the list of supported quirk names.
134 .It Cm dump_device_quirks
135 Display the list of current device quirks.
136 .It Cm dump_device_desc
137 Display the device descriptor.
138 .It Cm dump_curr_config_desc
139 Display current configuration descriptor.
140 .It Cm dump_all_config_desc
141 Display all the configuration descriptors.
142 .It Cm dump_string Ar index
143 Display string descriptor at selected index.
145 Display summary information about the device.
147 Display USB transfer statistics.
149 Display the list of interface drivers (such as
153 currently attached to the device.
154 .It Cm detach_kernel_driver
155 Detach kernel driver for the selected interface and USB device.
156 This command uses the
157 .Fl i Ar interface_index
160 Force the device to suspend.
162 Force the device to resume.
166 Turn the automatic suspend and resume on.
167 This is the default for USB hubs.
169 Turn the device on and disable automatic suspend and resume.
170 This is the default for non-hub devices.
173 This forces the USB stack to reenumerate the bus.
175 List all available USB devices.
176 This is the default if
178 is called without specifying a command.
179 .It Cm do_request Ar bmReqTyp Ar bReq Ar wVal Ar wIdx Ar wLen Ar data...
180 Perform a synchronous control request on the specified device.
182 .Xr libusb20_dev_request_sync 3
183 for more information.
186 List all connected USB devices and their attached interface drivers:
188 .Dl usbconfig show_ifdrv
190 Dump device and configuration descriptors for device on USB bus 1 at address 2:
192 .Dl usbconfig -d ugen1.2 dump_all_desc
194 Dump HID descriptor for device on USB bus 1 at address 2:
196 .Dl usbconfig -d ugen1.2 do_request 0x81 0x06 0x2200 0 0x100
198 Power off the device on USB bus 1 at address 2:
200 .Dl usbconfig -d ugen1.2 power_off