freebsd-skq/sys/dev/usb/usb_debug.c
Hans Petter Selasky 3750641271 Make several timing parameters of the USB enumeration sequence tuneable.
Also update the port reset time from 250ms to 50ms. Some USB devices
have a hard limit in hardware at 222ms for the port reset time and will
not enumerate unless this delay is closer to the usb.org defined value.
This patch can fix enumeration with some USB devices.

Tested by:	Guido van Rooij
Submitted by:	Nick Hibma
MFC after:	1 week
2012-10-24 07:23:29 +00:00

312 lines
11 KiB
C

/* $FreeBSD$ */
/*-
* Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/stdint.h>
#include <sys/stddef.h>
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/sysctl.h>
#include <sys/sx.h>
#include <sys/unistd.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/priv.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usb_core.h>
#include <dev/usb/usb_debug.h>
#include <dev/usb/usb_process.h>
#include <dev/usb/usb_device.h>
#include <dev/usb/usb_busdma.h>
#include <dev/usb/usb_transfer.h>
#include <ddb/ddb.h>
#include <ddb/db_sym.h>
/*
* Define this unconditionally in case a kernel module is loaded that
* has been compiled with debugging options.
*/
int usb_debug = 0;
SYSCTL_NODE(_hw, OID_AUTO, usb, CTLFLAG_RW, 0, "USB debugging");
SYSCTL_INT(_hw_usb, OID_AUTO, debug, CTLFLAG_RW,
&usb_debug, 0, "Debug level");
TUNABLE_INT("hw.usb.debug", &usb_debug);
#ifdef USB_DEBUG
/*
* Sysctls to modify timings/delays
*/
static SYSCTL_NODE(_hw_usb, OID_AUTO, timings, CTLFLAG_RW, 0, "Timings");
static int usb_timings_sysctl_handler(SYSCTL_HANDLER_ARGS);
TUNABLE_INT("hw.usb.timings.port_reset_delay", (int *)&usb_port_reset_delay);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_reset_delay, CTLTYPE_UINT | CTLFLAG_RW,
&usb_port_reset_delay, sizeof(usb_port_reset_delay),
usb_timings_sysctl_handler, "IU", "Port Reset Delay");
TUNABLE_INT("hw.usb.timings.port_root_reset_delay", (int *)&usb_port_root_reset_delay);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_root_reset_delay, CTLTYPE_UINT | CTLFLAG_RW,
&usb_port_root_reset_delay, sizeof(usb_port_root_reset_delay),
usb_timings_sysctl_handler, "IU", "Root Port Reset Delay");
TUNABLE_INT("hw.usb.timings.port_reset_recovery", (int *)&usb_port_reset_recovery);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_reset_recovery, CTLTYPE_UINT | CTLFLAG_RW,
&usb_port_reset_recovery, sizeof(usb_port_reset_recovery),
usb_timings_sysctl_handler, "IU", "Port Reset Recovery");
TUNABLE_INT("hw.usb.timings.port_powerup_delay", (int *)&usb_port_powerup_delay);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_powerup_delay, CTLTYPE_UINT | CTLFLAG_RW,
&usb_port_powerup_delay, sizeof(usb_port_powerup_delay),
usb_timings_sysctl_handler, "IU", "Port PowerUp Delay");
TUNABLE_INT("hw.usb.timings.port_resume_delay", (int *)&usb_port_resume_delay);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_resume_delay, CTLTYPE_UINT | CTLFLAG_RW,
&usb_port_resume_delay, sizeof(usb_port_resume_delay),
usb_timings_sysctl_handler, "IU", "Port Resume Delay");
TUNABLE_INT("hw.usb.timings.set_address_settle", (int *)&usb_set_address_settle);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, set_address_settle, CTLTYPE_UINT | CTLFLAG_RW,
&usb_set_address_settle, sizeof(usb_set_address_settle),
usb_timings_sysctl_handler, "IU", "Set Address Settle");
TUNABLE_INT("hw.usb.timings.resume_delay", (int *)&usb_resume_delay);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, resume_delay, CTLTYPE_UINT | CTLFLAG_RW,
&usb_resume_delay, sizeof(usb_resume_delay),
usb_timings_sysctl_handler, "IU", "Resume Delay");
TUNABLE_INT("hw.usb.timings.resume_wait", (int *)&usb_resume_wait);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, resume_wait, CTLTYPE_UINT | CTLFLAG_RW,
&usb_resume_wait, sizeof(usb_resume_wait),
usb_timings_sysctl_handler, "IU", "Resume Wait");
TUNABLE_INT("hw.usb.timings.resume_recovery", (int *)&usb_resume_recovery);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, resume_recovery, CTLTYPE_UINT | CTLFLAG_RW,
&usb_resume_recovery, sizeof(usb_resume_recovery),
usb_timings_sysctl_handler, "IU", "Resume Recovery");
TUNABLE_INT("hw.usb.timings.extra_power_up_time", (int *)&usb_extra_power_up_time);
SYSCTL_PROC(_hw_usb_timings, OID_AUTO, extra_power_up_time, CTLTYPE_UINT | CTLFLAG_RW,
&usb_extra_power_up_time, sizeof(usb_extra_power_up_time),
usb_timings_sysctl_handler, "IU", "Extra PowerUp Time");
#endif
/*------------------------------------------------------------------------*
* usb_dump_iface
*
* This function dumps information about an USB interface.
*------------------------------------------------------------------------*/
void
usb_dump_iface(struct usb_interface *iface)
{
printf("usb_dump_iface: iface=%p\n", iface);
if (iface == NULL) {
return;
}
printf(" iface=%p idesc=%p altindex=%d\n",
iface, iface->idesc, iface->alt_index);
}
/*------------------------------------------------------------------------*
* usb_dump_device
*
* This function dumps information about an USB device.
*------------------------------------------------------------------------*/
void
usb_dump_device(struct usb_device *udev)
{
printf("usb_dump_device: dev=%p\n", udev);
if (udev == NULL) {
return;
}
printf(" bus=%p \n"
" address=%d config=%d depth=%d speed=%d self_powered=%d\n"
" power=%d langid=%d\n",
udev->bus,
udev->address, udev->curr_config_no, udev->depth, udev->speed,
udev->flags.self_powered, udev->power, udev->langid);
}
/*------------------------------------------------------------------------*
* usb_dump_queue
*
* This function dumps the USB transfer that are queued up on an USB endpoint.
*------------------------------------------------------------------------*/
void
usb_dump_queue(struct usb_endpoint *ep)
{
struct usb_xfer *xfer;
usb_stream_t x;
printf("usb_dump_queue: endpoint=%p xfer: ", ep);
for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
TAILQ_FOREACH(xfer, &ep->endpoint_q[x].head, wait_entry)
printf(" %p", xfer);
}
printf("\n");
}
/*------------------------------------------------------------------------*
* usb_dump_endpoint
*
* This function dumps information about an USB endpoint.
*------------------------------------------------------------------------*/
void
usb_dump_endpoint(struct usb_endpoint *ep)
{
if (ep) {
printf("usb_dump_endpoint: endpoint=%p", ep);
printf(" edesc=%p isoc_next=%d toggle_next=%d",
ep->edesc, ep->isoc_next, ep->toggle_next);
if (ep->edesc) {
printf(" bEndpointAddress=0x%02x",
ep->edesc->bEndpointAddress);
}
printf("\n");
usb_dump_queue(ep);
} else {
printf("usb_dump_endpoint: endpoint=NULL\n");
}
}
/*------------------------------------------------------------------------*
* usb_dump_xfer
*
* This function dumps information about an USB transfer.
*------------------------------------------------------------------------*/
void
usb_dump_xfer(struct usb_xfer *xfer)
{
struct usb_device *udev;
printf("usb_dump_xfer: xfer=%p\n", xfer);
if (xfer == NULL) {
return;
}
if (xfer->endpoint == NULL) {
printf("xfer %p: endpoint=NULL\n",
xfer);
return;
}
udev = xfer->xroot->udev;
printf("xfer %p: udev=%p vid=0x%04x pid=0x%04x addr=%d "
"endpoint=%p ep=0x%02x attr=0x%02x\n",
xfer, udev,
UGETW(udev->ddesc.idVendor),
UGETW(udev->ddesc.idProduct),
udev->address, xfer->endpoint,
xfer->endpoint->edesc->bEndpointAddress,
xfer->endpoint->edesc->bmAttributes);
}
#ifdef USB_DEBUG
unsigned int usb_port_reset_delay = USB_PORT_RESET_DELAY;
unsigned int usb_port_root_reset_delay = USB_PORT_ROOT_RESET_DELAY;
unsigned int usb_port_reset_recovery = USB_PORT_RESET_RECOVERY;
unsigned int usb_port_powerup_delay = USB_PORT_POWERUP_DELAY;
unsigned int usb_port_resume_delay = USB_PORT_RESUME_DELAY;
unsigned int usb_set_address_settle = USB_SET_ADDRESS_SETTLE;
unsigned int usb_resume_delay = USB_RESUME_DELAY;
unsigned int usb_resume_wait = USB_RESUME_WAIT;
unsigned int usb_resume_recovery = USB_RESUME_RECOVERY;
unsigned int usb_extra_power_up_time = USB_EXTRA_POWER_UP_TIME;
/*------------------------------------------------------------------------*
* usb_timings_sysctl_handler
*
* This function updates timings variables, adjusting them where necessary.
*------------------------------------------------------------------------*/
static int usb_timings_sysctl_handler(SYSCTL_HANDLER_ARGS)
{
int error = 0;
unsigned int val;
/*
* Attempt to get a coherent snapshot by making a copy of the data.
*/
if (arg1)
val = *(unsigned int *)arg1;
else
val = arg2;
error = SYSCTL_OUT(req, &val, sizeof(int));
if (error || !req->newptr)
return (error);
if (!arg1)
return EPERM;
error = SYSCTL_IN(req, &val, sizeof(unsigned int));
if (error)
return (error);
/*
* Now make sure the values are decent, and certainly no lower than
* what the USB spec prescribes.
*/
unsigned int *p = (unsigned int *)arg1;
if (p == &usb_port_reset_delay) {
if (val < USB_PORT_RESET_DELAY_SPEC)
return (EINVAL);
} else if (p == &usb_port_root_reset_delay) {
if (val < USB_PORT_ROOT_RESET_DELAY_SPEC)
return (EINVAL);
} else if (p == &usb_port_reset_recovery) {
if (val < USB_PORT_RESET_RECOVERY_SPEC)
return (EINVAL);
} else if (p == &usb_port_powerup_delay) {
if (val < USB_PORT_POWERUP_DELAY_SPEC)
return (EINVAL);
} else if (p == &usb_port_resume_delay) {
if (val < USB_PORT_RESUME_DELAY_SPEC)
return (EINVAL);
} else if (p == &usb_set_address_settle) {
if (val < USB_SET_ADDRESS_SETTLE_SPEC)
return (EINVAL);
} else if (p == &usb_resume_delay) {
if (val < USB_RESUME_DELAY_SPEC)
return (EINVAL);
} else if (p == &usb_resume_wait) {
if (val < USB_RESUME_WAIT_SPEC)
return (EINVAL);
} else if (p == &usb_resume_recovery) {
if (val < USB_RESUME_RECOVERY_SPEC)
return (EINVAL);
} else if (p == &usb_extra_power_up_time) {
if (val < USB_EXTRA_POWER_UP_TIME_SPEC)
return (EINVAL);
} else {
/* noop */
}
*p = val;
return 0;
}
#endif