usbconfig.8 (ae450e6de96b5ec65f425a52b08dc859576ab8d0) usbconfig.8 (cae1884d4791726f5acf5d64bba9a3583b63e38b)
1.\" $FreeBSD$
2.\"
3.\" Copyright (c) 2008-2019 Hans Petter Selasky. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright

--- 9 unchanged lines hidden (view full) ---

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
24.\" SUCH DAMAGE.
25.\"
1.\" $FreeBSD$
2.\"
3.\" Copyright (c) 2008-2019 Hans Petter Selasky. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright

--- 9 unchanged lines hidden (view full) ---

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
24.\" SUCH DAMAGE.
25.\"
26.Dd December 27, 2019
26.Dd December 20, 2021
27.Dt USBCONFIG 8
28.Os
29.Sh NAME
30.Nm usbconfig
31.Nd configure the USB subsystem
32.Sh SYNOPSIS
33.Nm
34.Op Fl u Ar unit
35.Op Fl a Ar addr
27.Dt USBCONFIG 8
28.Os
29.Sh NAME
30.Nm usbconfig
31.Nd configure the USB subsystem
32.Sh SYNOPSIS
33.Nm
34.Op Fl u Ar unit
35.Op Fl a Ar addr
36.Op Fl i Ar interface_index
36.Op cmds...
37.Nm
37.Op cmds...
38.Nm
38.Op Oo Fl d Oc Ar [ugen]<unit>.<addr>
39.Fl d Ar [[/dev/]ugen]<unit>.<addr>
40.Op Fl i Ar interface_index
39.Op cmds...
40.Sh DESCRIPTION
41The
42.Nm
43utility is used to configure and dump information about the USB subsystem.
44.Pp
45The options are as follows:
46.Bl -tag -width " "
47.It Fl u Ar unit
48Limit device range to USB devices connected to the given USBUS unit.
49.It Fl a Ar addr
50Limit device range to the given USB device index.
51Should only be used in conjunction with the unit argument.
41.Op cmds...
42.Sh DESCRIPTION
43The
44.Nm
45utility is used to configure and dump information about the USB subsystem.
46.Pp
47The options are as follows:
48.Bl -tag -width " "
49.It Fl u Ar unit
50Limit device range to USB devices connected to the given USBUS unit.
51.It Fl a Ar addr
52Limit device range to the given USB device index.
53Should only be used in conjunction with the unit argument.
52.It Fl d Ar [ugen]<unit>.<addr>
54.It Fl d Ar [[/dev/]ugen]<unit>.<addr>
53Limit device range to USB devices connected to the given unit and address.
54The unit and address coordinates may be prefixed by the lowercased word "ugen",
55or the full path name
56.Pa /dev/ugen .
57.It Fl i Ar interface_index
58Specify interface index as indicated by the command description.
59If this argument is not specified a value of zero will be used for the interface index.
60.It Fl h

--- 17 unchanged lines hidden (view full) ---

78.It Cm set_alt Ar alt_index
79Choose the alternate interface for the selected interface and USB device.
80Alternative settings for the current configuration are available as the
81.Ar bAlternateSetting
82in
83.Cm dump_curr_config_desc
84output.
85Usually there is no need to adjust this setting.
55Limit device range to USB devices connected to the given unit and address.
56The unit and address coordinates may be prefixed by the lowercased word "ugen",
57or the full path name
58.Pa /dev/ugen .
59.It Fl i Ar interface_index
60Specify interface index as indicated by the command description.
61If this argument is not specified a value of zero will be used for the interface index.
62.It Fl h

--- 17 unchanged lines hidden (view full) ---

80.It Cm set_alt Ar alt_index
81Choose the alternate interface for the selected interface and USB device.
82Alternative settings for the current configuration are available as the
83.Ar bAlternateSetting
84in
85.Cm dump_curr_config_desc
86output.
87Usually there is no need to adjust this setting.
88This command uses the
89.Fl i Ar interface_index
90option.
86.It Cm set_template Ar template
87Set the global USB device side template.
88See
89.Xr usb_template 4
90for more information.
91.It Cm get_template
92Get the current USB device side template.
93.It Cm add_dev_quirk_vplh Ar vid Ar pid Ar lo_rev Ar hi_rev Ar quirk_name

--- 29 unchanged lines hidden (view full) ---

123.It Cm show_ifdrv
124Display the list of interface drivers (such as
125.Xr ukbd 4
126or
127.Xr u3g 4 )
128currently attached to the device.
129.It Cm detach_kernel_driver
130Detach kernel driver for the selected interface and USB device.
91.It Cm set_template Ar template
92Set the global USB device side template.
93See
94.Xr usb_template 4
95for more information.
96.It Cm get_template
97Get the current USB device side template.
98.It Cm add_dev_quirk_vplh Ar vid Ar pid Ar lo_rev Ar hi_rev Ar quirk_name

--- 29 unchanged lines hidden (view full) ---

128.It Cm show_ifdrv
129Display the list of interface drivers (such as
130.Xr ukbd 4
131or
132.Xr u3g 4 )
133currently attached to the device.
134.It Cm detach_kernel_driver
135Detach kernel driver for the selected interface and USB device.
136This command uses the
137.Fl i Ar interface_index
138option.
131.It Cm suspend
132Force the device to suspend.
133.It Cm resume
134Force the device to resume.
135.It Cm power_off
136Turn the device off.
137.It Cm power_save
138Turn the automatic suspend and resume on.

--- 38 unchanged lines hidden ---
139.It Cm suspend
140Force the device to suspend.
141.It Cm resume
142Force the device to resume.
143.It Cm power_off
144Turn the device off.
145.It Cm power_save
146Turn the automatic suspend and resume on.

--- 38 unchanged lines hidden ---