Bug 163646

On Tue, 27 Dec 2011, Momchil Ivanov wrote:

>
>> Description:
> The man page of ehci(4) mentions "LOADER TUNABLES" but they are only available after compiling the kernel with "options USB_DEBUG", which is not mentioned. The man page should make it clear that one needs to recompile the kernel with that option or these sysctls should be made availabe without "options USB_DEBUG". Probably the easiest way would be to update the man page and also mention that the sysctl hw.usb.ehci.lostintrbug is highly probable to solve problems with slow devices or ones that get stalled  regularly.
>
> For more information refer to the following thread [1].
>
> 1: http://lists.freebsd.org/pipermail/freebsd-usb/2011-December/010940.html

I think that the attached patch should suffice (inline for convenience, 
too, since it's short):
--- ehci.4.orig	2012-01-02 02:04:25.000000000 -0500
+++ ehci.4	2012-01-02 02:28:13.000000000 -0500
@@ -29,7 +29,7 @@
  .\"
  .\" $FreeBSD: head/share/man/man4/ehci.4 219004 2011-02-24 18:08:23Z hselasky $
  .\"
-.Dd February 24, 2011
+.Dd January 2, 2012
  .Dt EHCI 4
  .Os
  .Sh NAME
@@ -80,7 +80,11 @@
  device driver first appeared in
  .Fx 5.1 .
  .Sh LOADER TUNABLES
-Tunables can be set at the
+When the kernel has been compiled with
+.Cd options USB_DEBUG ,
+some tunables become available that affect the behavior of
+.Nm .
+These tunables can be set at the
  .Xr loader 8
  prompt before booting the kernel or stored in
  .Xr loader.conf 5 .



-Ben Kaduk

Comment 2 Eitan Adler 2012-02-06 04:42:08 UTC

Responsible Changed
From-To: freebsd-doc->eadler

I'll take it.

Comment 3 dfilter service 2012-03-04 16:26:59 UTC

Author: eadler
Date: Sun Mar  4 16:26:49 2012
New Revision: 232501
URL: http://svn.freebsd.org/changeset/base/232501

Log:
  ehci tunables are only available when kernel is compiled with USB_DEBUG
  
  PR:		docs/163646
  Reported by:	Momchil Ivanov <momchil@xaxo.eu>
  Submitted by:	Benjamin Kaduk <kaduk@mit.edu>
  Approved by:	cperciva
  MFC after:	1 week

Modified:
  head/share/man/man4/ehci.4

Modified: head/share/man/man4/ehci.4
==============================================================================
--- head/share/man/man4/ehci.4	Sun Mar  4 16:24:58 2012	(r232500)
+++ head/share/man/man4/ehci.4	Sun Mar  4 16:26:49 2012	(r232501)
@@ -80,7 +80,11 @@ The
 device driver first appeared in
 .Fx 5.1 .
 .Sh LOADER TUNABLES
-Tunables can be set at the
+When the kernel has been compiled with
+.Cd options USB_DEBUG ,
+some tunables become available that affect the behavior of
+.Nm .
+These tunables can be set at the
 .Xr loader 8
 prompt before booting the kernel or stored in
 .Xr loader.conf 5 .
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 4 Eitan Adler 2012-03-04 16:44:40 UTC

State Changed
From-To: open->patched

committed in 232501

Comment 5 dfilter service 2012-03-19 01:15:55 UTC

Author: eadler
Date: Mon Mar 19 01:15:36 2012
New Revision: 233141
URL: http://svn.freebsd.org/changeset/base/233141

Log:
  MFC r232501:
  	ehci tunables are only available when kernel is compiled with USB_DEBUG
  
  PR:		docs/163646
  Approved by:	cperciva

Modified:
  stable/9/share/man/man4/ehci.4
Directory Properties:
  stable/9/share/man/man4/   (props changed)

Modified: stable/9/share/man/man4/ehci.4
==============================================================================
--- stable/9/share/man/man4/ehci.4	Mon Mar 19 01:04:46 2012	(r233140)
+++ stable/9/share/man/man4/ehci.4	Mon Mar 19 01:15:36 2012	(r233141)
@@ -80,7 +80,11 @@ The
 device driver first appeared in
 .Fx 5.1 .
 .Sh LOADER TUNABLES
-Tunables can be set at the
+When the kernel has been compiled with
+.Cd options USB_DEBUG ,
+some tunables become available that affect the behavior of
+.Nm .
+These tunables can be set at the
 .Xr loader 8
 prompt before booting the kernel or stored in
 .Xr loader.conf 5 .
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 6 dfilter service 2012-03-19 01:16:20 UTC

Author: eadler
Date: Mon Mar 19 01:16:11 2012
New Revision: 233142
URL: http://svn.freebsd.org/changeset/base/233142

Log:
  MFC r232501:
  	ehci tunables are only available when kernel is compiled with USB_DEBUG
  
  PR:		docs/163646
  Approved by:	cperciva

Modified:
  stable/8/share/man/man4/ehci.4
Directory Properties:
  stable/8/share/man/man4/   (props changed)

Modified: stable/8/share/man/man4/ehci.4
==============================================================================
--- stable/8/share/man/man4/ehci.4	Mon Mar 19 01:15:36 2012	(r233141)
+++ stable/8/share/man/man4/ehci.4	Mon Mar 19 01:16:11 2012	(r233142)
@@ -87,7 +87,11 @@ The
 device driver first appeared in
 .Fx 5.1 .
 .Sh LOADER TUNABLES
-Tunables can be set at the
+When the kernel has been compiled with
+.Cd options USB_DEBUG ,
+some tunables become available that affect the behavior of
+.Nm .
+These tunables can be set at the
 .Xr loader 8
 prompt before booting the kernel or stored in
 .Xr loader.conf 5 .
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 7 Eitan Adler 2012-03-19 01:24:02 UTC

State Changed
From-To: patched->closed

Committed. Thanks!