From ee5558f72ea3a3a78f910a87d96cdd798ba2297d Mon Sep 17 00:00:00 2001 From: brd Date: Fri, 4 Aug 2017 08:56:31 +0000 Subject: [PATCH] Document usb verbosity levels Submitted by: Tom Jones Approved by: hselasky MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D11850 --- share/man/man4/ehci.4 | 35 ++++++++++++++++++++++++----------- share/man/man4/ohci.4 | 15 ++++++++++++++- share/man/man4/ucom.4 | 17 ++++++++++++++++- share/man/man4/ugen.4 | 15 ++++++++++++++- share/man/man4/uhci.4 | 15 ++++++++++++++- share/man/man4/uhid.4 | 15 ++++++++++++++- share/man/man4/ukbd.4 | 15 ++++++++++++++- share/man/man4/ums.4 | 15 ++++++++++++++- share/man/man4/uplcom.4 | 15 ++++++++++++++- share/man/man4/usb.4 | 15 ++++++++++++++- share/man/man4/xhci.4 | 15 ++++++++++++++- 11 files changed, 166 insertions(+), 21 deletions(-) diff --git a/share/man/man4/ehci.4 b/share/man/man4/ehci.4 index 7aa18d871575..6763d2276f9f 100644 --- a/share/man/man4/ehci.4 +++ b/share/man/man4/ehci.4 @@ -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 . diff --git a/share/man/man4/ohci.4 b/share/man/man4/ohci.4 index f68afc1cc19f..8349a1ac9645 100644 --- a/share/man/man4/ohci.4 +++ b/share/man/man4/ohci.4 @@ -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 , diff --git a/share/man/man4/ucom.4 b/share/man/man4/ucom.4 index 8dc34360c1db..f96bc1263e37 100644 --- a/share/man/man4/ucom.4 +++ b/share/man/man4/ucom.4 @@ -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 diff --git a/share/man/man4/ugen.4 b/share/man/man4/ugen.4 index 875abb48f283..0dbce4965cba 100644 --- a/share/man/man4/ugen.4 +++ b/share/man/man4/ugen.4 @@ -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 diff --git a/share/man/man4/uhci.4 b/share/man/man4/uhci.4 index 90458cea9b35..148d95d8fb2c 100644 --- a/share/man/man4/uhci.4 +++ b/share/man/man4/uhci.4 @@ -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 , diff --git a/share/man/man4/uhid.4 b/share/man/man4/uhid.4 index fc90fff40350..4ff485b2a233 100644 --- a/share/man/man4/uhid.4 +++ b/share/man/man4/uhid.4 @@ -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? diff --git a/share/man/man4/ukbd.4 b/share/man/man4/ukbd.4 index 1fade2ad5755..7dcce3075406 100644 --- a/share/man/man4/ukbd.4 +++ b/share/man/man4/ukbd.4 @@ -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* diff --git a/share/man/man4/ums.4 b/share/man/man4/ums.4 index 83aeeda7ad61..319d8e1e103b 100644 --- a/share/man/man4/ums.4 +++ b/share/man/man4/ums.4 @@ -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 diff --git a/share/man/man4/uplcom.4 b/share/man/man4/uplcom.4 index b3f1fbb3ff18..2ef02123e107 100644 --- a/share/man/man4/uplcom.4 +++ b/share/man/man4/uplcom.4 @@ -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* diff --git a/share/man/man4/usb.4 b/share/man/man4/usb.4 index 20370b1f4799..fdb1c157afac 100644 --- a/share/man/man4/usb.4 +++ b/share/man/man4/usb.4 @@ -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 diff --git a/share/man/man4/xhci.4 b/share/man/man4/xhci.4 index 69e944a9f444..ce69cb097ce4 100644 --- a/share/man/man4/xhci.4 +++ b/share/man/man4/xhci.4 @@ -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 ,