Improve usbconfig(8) manual page by adding descriptions for subcommands.
Reviewed by: hselasky MFC after: 2 weeks Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D13445
This commit is contained in:
trasz
parent
e75b16052d
commit
00dd5de004
@ -23,7 +23,7 @@
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.Dd January 6, 2010
|
||||
.Dd December 30, 2017
|
||||
.Dt USBCONFIG 8
|
||||
.Os
|
||||
.Sh NAME
|
||||
@ -56,45 +56,124 @@ The unit and address coordinates may be prefixed by the lowercased word "ugen".
|
||||
Show help and available commands.
|
||||
.El
|
||||
.Pp
|
||||
When called without options,
|
||||
The following commands may be used with
|
||||
.Nm :
|
||||
.Bl -tag -width indent
|
||||
.It Cm set_config Ar cfg_index
|
||||
Choose the configuration for the USB device.
|
||||
Valid values range from zero to the number reported as the
|
||||
.Ar bNumConfigurations
|
||||
in
|
||||
.Cm dump_device_desc
|
||||
output.
|
||||
The special value of 255 unconfigures the device, detaching
|
||||
the interface drivers and reducing the power consumption to minimum,
|
||||
but without going into power saving mode or detaching from the bus.
|
||||
In some cases, it prevents the device from charging.
|
||||
.It Cm set_alt Ar alt_index
|
||||
Choose the alternate interface for the USB device.
|
||||
Alternative settings for the current configuration are available as the
|
||||
.Ar bAlternateSetting
|
||||
in
|
||||
.Cm dump_curr_config_desc
|
||||
output.
|
||||
Usually there is no need to adjust this setting.
|
||||
.It Cm set_template Ar template
|
||||
Set the global USB device side template.
|
||||
See
|
||||
.Xr usb_template 4
|
||||
for more information.
|
||||
.It Cm get_template
|
||||
Get the current USB device side template.
|
||||
.It Cm add_dev_quirk_vplh Ar vid Ar pid Ar lo_rev Ar hi_rev Ar quirk_name
|
||||
Add a quirk by specifying the Vendor ID, Product ID, low and high
|
||||
revision numbers, and the quirk name.
|
||||
See
|
||||
.Xr usb_quirk 4
|
||||
for more information.
|
||||
.It Cm remove_dev_quirk_vplh Ar vid Ar pid Ar lo_rev Ar hi_rev Ar quirk_name
|
||||
Remove a quirk.
|
||||
.It Cm add_quirk Ar quirk_name
|
||||
Add quirk for the currently selected USB device.
|
||||
.It Cm remove_quirk Ar quirk_name
|
||||
Remove a quirk for the currently selected USB device.
|
||||
.It Cm dump_quirk_names
|
||||
Display the list of supported quirk names.
|
||||
.It Cm dump_device_quirks
|
||||
Display the list of current device quirks.
|
||||
.It Cm dump_device_desc
|
||||
Display the device descriptor.
|
||||
.It Cm dump_curr_config_desc
|
||||
Display current configuration descriptor.
|
||||
.It Cm dump_all_config_desc
|
||||
Display all the configuration descriptors.
|
||||
.It Cm dump_string Ar index
|
||||
Display string descriptor at selected index.
|
||||
.It Cm dump_info
|
||||
Display summary information about the device.
|
||||
.It Cm show_ifdrv
|
||||
Display the list of interface drivers (such as
|
||||
.Xr ukbd 4
|
||||
or
|
||||
.Xr u3g 4 )
|
||||
currently attached to the device.
|
||||
.It Cm suspend
|
||||
Force the device to suspend.
|
||||
.It Cm resume
|
||||
Force the device to resume.
|
||||
.It Cm power_off
|
||||
Turn the device off.
|
||||
.It Cm power_save
|
||||
Turn the automatic suspend and resume on.
|
||||
This is the default for USB hubs.
|
||||
.It Cm power_on
|
||||
Turn the device on and disable automatic suspend and resume.
|
||||
This is the default for non-hub devices.
|
||||
.It Cm reset
|
||||
Reset the device.
|
||||
This forces the USB stack to reenumerate the bus.
|
||||
.It Cm list
|
||||
List all available USB devices.
|
||||
This is the default if
|
||||
.Nm
|
||||
prints a list of all available USB devices.
|
||||
is called without specifying a command.
|
||||
.It Cm do_request Ar bmReqTyp Ar bReq Ar wVal Ar wIdx Ar wLen Ar data...
|
||||
Perform a synchronous control request on the specified device.
|
||||
See
|
||||
.Xr libusb20_dev_request_sync 3
|
||||
for more information.
|
||||
.El
|
||||
.Sh EXAMPLES
|
||||
.Pp
|
||||
Show information about the device on USB bus 1 at address 2:
|
||||
.Pp
|
||||
.Dl usbconfig -u 1 -a 2 dump_info
|
||||
.Dl usbconfig -d ugen1.2 dump_info
|
||||
.Pp
|
||||
Dump HID descriptor for device on USB bus 1 at address 2:
|
||||
.Pp
|
||||
.Dl usbconfig -u 1 -a 2 do_request 0x81 0x06 0x2200 0 0x100
|
||||
.Dl usbconfig -d ugen1.2 do_request 0x81 0x06 0x2200 0 0x100
|
||||
.Pp
|
||||
Dump string descriptor at index Z for device on USB bus 1 at address 2:
|
||||
.Pp
|
||||
.Dl usbconfig -u 1 -a 2 dump_string Z
|
||||
.Dl usbconfig -d ugen1.2 dump_string Z
|
||||
.Pp
|
||||
Dump current configuration descriptor for device on USB bus 1 at address 2:
|
||||
.Pp
|
||||
.Dl usbconfig -u 1 -a 2 dump_curr_config_desc
|
||||
.Dl usbconfig -d ugen1.2 dump_curr_config_desc
|
||||
.Pp
|
||||
Dump device descriptor for device on USB bus 1 at address 2:
|
||||
.Pp
|
||||
.Dl usbconfig -u 1 -a 2 dump_device_desc
|
||||
.Dl usbconfig -d ugen1.2 dump_device_desc
|
||||
.Pp
|
||||
Program the device on USB bus 1 at address 2 to suspend, resume, power off, go into power save, or power on:
|
||||
.Pp
|
||||
.Dl usbconfig -u 1 -a 2 suspend
|
||||
.Dl usbconfig -u 1 -a 2 resume
|
||||
.Dl usbconfig -u 1 -a 2 power_off
|
||||
.Dl usbconfig -u 1 -a 2 power_save
|
||||
.Dl usbconfig -u 1 -a 2 power_on
|
||||
.Dl usbconfig -d ugen1.2 suspend
|
||||
.Dl usbconfig -d ugen1.2 resume
|
||||
.Dl usbconfig -d ugen1.2 power_off
|
||||
.Dl usbconfig -d ugen1.2 power_save
|
||||
.Dl usbconfig -d ugen1.2 power_on
|
||||
.Pp
|
||||
Display a list of available quirk names:
|
||||
.Pp
|
||||
.Dl usbconfig dump_quirk_names
|
||||
.Pp
|
||||
See
|
||||
.Xr usb_quirk 4
|
||||
for more information on quirks.
|
||||
.Sh SEE ALSO
|
||||
.Xr usb 4 ,
|
||||
.Xr usb_quirk 4
|
||||
.Xr usb_quirk 4 ,
|
||||
.Xr usb_template 4
|
||||
|
||||
Loading…
Reference in New Issue
Block a user