Document usb verbosity levels

Submitted by:	Tom Jones <jones@sdf.org>
Approved by:	hselasky
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D11850
This commit is contained in:
brd 2017-08-04 08:56:31 +00:00
parent 590490023c
commit ee5558f72e
11 changed files with 166 additions and 21 deletions

View File

@ -29,7 +29,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd January 15, 2017
.Dd August 3, 2017
.Dt EHCI 4
.Os
.Sh NAME
@ -69,16 +69,6 @@ but can be noticed since
.Tn USB
2.0 devices plugged in to the same
connector appear to connect to different USB buses.
.Sh SEE ALSO
.Xr ohci 4 ,
.Xr uhci 4 ,
.Xr usb 4 ,
.Xr xhci 4
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 5.1 .
.Sh LOADER TUNABLES
When the kernel has been compiled with
.Cd options USB_DEBUG ,
@ -98,4 +88,27 @@ The default value is 0 (off).
.It Va hw.usb.ehci.no_hs
This tunable disables USB devices to attach like HIGH-speed ones and will force all attached devices to attach to the FULL- or LOW-speed companion controller.
The default value is 0 (off).
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.ehci
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.El
.Sh SEE ALSO
.Xr ohci 4 ,
.Xr uhci 4 ,
.Xr usb 4 ,
.Xr xhci 4
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 5.1 .

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd June 23, 2005
.Dd August 3, 2017
.Dt OHCI 4
.Os
.Sh NAME
@ -59,6 +59,19 @@ NVIDIA nForce3
.It
Sun PCIO-2 (RIO USB)
.El
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.ohci
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh SEE ALSO
.Xr ehci 4 ,
.Xr uhci 4 ,

View File

@ -29,7 +29,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd April 26, 2017
.Dd August 3, 2017
.Dt UCOM 4
.Os
.Sh NAME
@ -63,6 +63,21 @@ This means that normal programs such as
or
.Xr ppp 8
can be used to access the device.
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.ucom
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va pps_mode"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.It Va pps_mode
Enables and configure PPS capture mode as described below.
.Sh Pulse Per Second (PPS) Timing Interface
The
.Nm

View File

@ -29,7 +29,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd May 16, 2014
.Dd August 3, 2017
.Dt UGEN 4
.Os
.Sh NAME
@ -291,6 +291,19 @@ and
.Va alt_index
should be set to
.Dv USB_CURRENT_ALT_INDEX .
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.ugen
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh FILES
.Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E" -compact
.It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd April 20, 2005
.Dd August 3, 2017
.Dt UHCI 4
.Os
.Sh NAME
@ -49,6 +49,19 @@ Intel 82371SB (PIIX3)
.It
VIA 83C572
.El
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.uhci
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh SEE ALSO
.Xr ehci 4 ,
.Xr ohci 4 ,

View File

@ -29,7 +29,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd November 22, 2006
.Dd August 3, 2017
.Dt UHID 4
.Os
.Sh NAME
@ -127,6 +127,19 @@ Use
to send data to the device.
Data should be written in chunks of the
size prescribed by the report descriptor.
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.uhid
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh FILES
.Bl -tag -width ".Pa /dev/uhid?"
.It Pa /dev/uhid?

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd November 22, 2006
.Dd August 3, 2017
.Dt UKBD 4
.Os
.Sh NAME
@ -136,6 +136,19 @@ or
Do not allow the user to change the keymap.
Note that these options also affect the AT keyboard driver,
.Xr atkbd 4 .
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.ukbd
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh FILES
.Bl -tag -width ".Pa /dev/kbd*" -compact
.It Pa /dev/kbd*

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd November 27, 2006
.Dd August 3, 2017
.Dt UMS 4
.Os
.Sh NAME
@ -64,6 +64,19 @@ type device.
See
.Xr moused 8
for an explanation of these mouse types.
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.ums
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh FILES
.Bl -tag -width /dev/ums0 -compact
.It Pa /dev/ums0

View File

@ -29,7 +29,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd April 26, 2017
.Dd August 3, 2017
.Dt UPLCOM 4
.Os
.Sh NAME
@ -180,6 +180,19 @@ YC-Cable USB-Serial Adapter
.It
Zeagle N2iTion3 Diving Computer
.El
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.uplcom
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh FILES
.Bl -tag -width "/dev/ttyU*.init" -compact
.It Pa /dev/ttyU*

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd April 29, 2017
.Dd August 3, 2017
.Dt USB 4
.Os
.Sh NAME
@ -131,6 +131,19 @@ Any interface specific driver can attach to the device.
.It
If none is found, generic interface class drivers can attach.
.El
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh SEE ALSO
The
.Tn USB

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd May 17, 2011
.Dd August 3, 2017
.Dt XHCI 4
.Os
.Sh NAME
@ -56,6 +56,19 @@ driver supports
.Tn XHCI
compatible controllers having PCI class 12 (serial bus),
subclass 3 (USB) and programming interface 48 (XHCI).
.Sh MIB Variables
The
.Nm
driver exposes the following variables in the
.Va hw.usb.xhci
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va debug"
.It Va debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh SEE ALSO
.Xr ehci 4 ,
.Xr ohci 4 ,