3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifdef USB_GLOBAL_INCLUDE_FILE
30 #include USB_GLOBAL_INCLUDE_FILE
32 #include <sys/stdint.h>
33 #include <sys/stddef.h>
34 #include <sys/param.h>
35 #include <sys/queue.h>
36 #include <sys/types.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
40 #include <sys/module.h>
42 #include <sys/mutex.h>
43 #include <sys/condvar.h>
44 #include <sys/sysctl.h>
46 #include <sys/unistd.h>
47 #include <sys/callout.h>
48 #include <sys/malloc.h>
51 #include <dev/usb/usb.h>
52 #include <dev/usb/usbdi.h>
54 #include <dev/usb/usb_core.h>
55 #include <dev/usb/usb_debug.h>
56 #include <dev/usb/usb_process.h>
57 #include <dev/usb/usb_device.h>
58 #include <dev/usb/usb_busdma.h>
59 #include <dev/usb/usb_transfer.h>
62 #include <ddb/db_sym.h>
63 #endif /* USB_GLOBAL_INCLUDE_FILE */
66 * Define this unconditionally in case a kernel module is loaded that
67 * has been compiled with debugging options.
71 SYSCTL_NODE(_hw, OID_AUTO, usb, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
73 SYSCTL_INT(_hw_usb, OID_AUTO, debug, CTLFLAG_RWTUN,
74 &usb_debug, 0, "Debug level");
78 * Sysctls to modify timings/delays
80 static SYSCTL_NODE(_hw_usb, OID_AUTO, timings, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
82 static int usb_timings_sysctl_handler(SYSCTL_HANDLER_ARGS);
84 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_reset_delay,
85 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &usb_port_reset_delay,
86 sizeof(usb_port_reset_delay), usb_timings_sysctl_handler, "IU",
88 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_root_reset_delay,
89 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
90 &usb_port_root_reset_delay, sizeof(usb_port_root_reset_delay),
91 usb_timings_sysctl_handler, "IU",
92 "Root Port Reset Delay");
93 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_reset_recovery,
94 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
95 &usb_port_reset_recovery, sizeof(usb_port_reset_recovery),
96 usb_timings_sysctl_handler, "IU",
97 "Port Reset Recovery");
98 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_powerup_delay,
99 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &usb_port_powerup_delay,
100 sizeof(usb_port_powerup_delay), usb_timings_sysctl_handler, "IU",
101 "Port PowerUp Delay");
102 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, port_resume_delay,
103 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &usb_port_resume_delay,
104 sizeof(usb_port_resume_delay), usb_timings_sysctl_handler, "IU",
105 "Port Resume Delay");
106 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, set_address_settle,
107 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &usb_set_address_settle,
108 sizeof(usb_set_address_settle), usb_timings_sysctl_handler, "IU",
109 "Set Address Settle");
110 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, resume_delay,
111 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &usb_resume_delay,
112 sizeof(usb_resume_delay), usb_timings_sysctl_handler, "IU",
114 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, resume_wait,
115 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &usb_resume_wait,
116 sizeof(usb_resume_wait), usb_timings_sysctl_handler, "IU",
118 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, resume_recovery,
119 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &usb_resume_recovery,
120 sizeof(usb_resume_recovery), usb_timings_sysctl_handler, "IU",
122 SYSCTL_PROC(_hw_usb_timings, OID_AUTO, extra_power_up_time,
123 CTLTYPE_UINT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, &usb_extra_power_up_time,
124 sizeof(usb_extra_power_up_time), usb_timings_sysctl_handler, "IU",
125 "Extra PowerUp Time");
128 /*------------------------------------------------------------------------*
131 * This function dumps information about an USB interface.
132 *------------------------------------------------------------------------*/
134 usb_dump_iface(struct usb_interface *iface)
136 printf("usb_dump_iface: iface=%p\n", iface);
140 printf(" iface=%p idesc=%p altindex=%d\n",
141 iface, iface->idesc, iface->alt_index);
144 /*------------------------------------------------------------------------*
147 * This function dumps information about an USB device.
148 *------------------------------------------------------------------------*/
150 usb_dump_device(struct usb_device *udev)
152 printf("usb_dump_device: dev=%p\n", udev);
157 " address=%d config=%d depth=%d speed=%d self_powered=%d\n"
158 " power=%d langid=%d\n",
160 udev->address, udev->curr_config_no, udev->depth, udev->speed,
161 udev->flags.self_powered, udev->power, udev->langid);
164 /*------------------------------------------------------------------------*
167 * This function dumps the USB transfer that are queued up on an USB endpoint.
168 *------------------------------------------------------------------------*/
170 usb_dump_queue(struct usb_endpoint *ep)
172 struct usb_xfer *xfer;
175 printf("usb_dump_queue: endpoint=%p xfer: ", ep);
176 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
177 TAILQ_FOREACH(xfer, &ep->endpoint_q[x].head, wait_entry)
183 /*------------------------------------------------------------------------*
186 * This function dumps information about an USB endpoint.
187 *------------------------------------------------------------------------*/
189 usb_dump_endpoint(struct usb_endpoint *ep)
192 printf("usb_dump_endpoint: endpoint=%p", ep);
194 printf(" edesc=%p isoc_next=%d toggle_next=%d",
195 ep->edesc, ep->isoc_next, ep->toggle_next);
198 printf(" bEndpointAddress=0x%02x",
199 ep->edesc->bEndpointAddress);
204 printf("usb_dump_endpoint: endpoint=NULL\n");
208 /*------------------------------------------------------------------------*
211 * This function dumps information about an USB transfer.
212 *------------------------------------------------------------------------*/
214 usb_dump_xfer(struct usb_xfer *xfer)
216 struct usb_device *udev;
217 printf("usb_dump_xfer: xfer=%p\n", xfer);
221 if (xfer->endpoint == NULL) {
222 printf("xfer %p: endpoint=NULL\n",
226 udev = xfer->xroot->udev;
227 printf("xfer %p: udev=%p vid=0x%04x pid=0x%04x addr=%d "
228 "endpoint=%p ep=0x%02x attr=0x%02x\n",
230 UGETW(udev->ddesc.idVendor),
231 UGETW(udev->ddesc.idProduct),
232 udev->address, xfer->endpoint,
233 xfer->endpoint->edesc->bEndpointAddress,
234 xfer->endpoint->edesc->bmAttributes);
238 unsigned int usb_port_reset_delay = USB_PORT_RESET_DELAY;
239 unsigned int usb_port_root_reset_delay = USB_PORT_ROOT_RESET_DELAY;
240 unsigned int usb_port_reset_recovery = USB_PORT_RESET_RECOVERY;
241 unsigned int usb_port_powerup_delay = USB_PORT_POWERUP_DELAY;
242 unsigned int usb_port_resume_delay = USB_PORT_RESUME_DELAY;
243 unsigned int usb_set_address_settle = USB_SET_ADDRESS_SETTLE;
244 unsigned int usb_resume_delay = USB_RESUME_DELAY;
245 unsigned int usb_resume_wait = USB_RESUME_WAIT;
246 unsigned int usb_resume_recovery = USB_RESUME_RECOVERY;
247 unsigned int usb_extra_power_up_time = USB_EXTRA_POWER_UP_TIME;
249 /*------------------------------------------------------------------------*
250 * usb_timings_sysctl_handler
252 * This function updates timings variables, adjusting them where necessary.
253 *------------------------------------------------------------------------*/
254 static int usb_timings_sysctl_handler(SYSCTL_HANDLER_ARGS)
260 * Attempt to get a coherent snapshot by making a copy of the data.
263 val = *(unsigned int *)arg1;
266 error = SYSCTL_OUT(req, &val, sizeof(int));
267 if (error || !req->newptr)
273 error = SYSCTL_IN(req, &val, sizeof(unsigned int));
278 * Now make sure the values are decent, and certainly no lower than
279 * what the USB spec prescribes.
281 unsigned int *p = (unsigned int *)arg1;
282 if (p == &usb_port_reset_delay) {
283 if (val < USB_PORT_RESET_DELAY_SPEC)
285 } else if (p == &usb_port_root_reset_delay) {
286 if (val < USB_PORT_ROOT_RESET_DELAY_SPEC)
288 } else if (p == &usb_port_reset_recovery) {
289 if (val < USB_PORT_RESET_RECOVERY_SPEC)
291 } else if (p == &usb_port_powerup_delay) {
292 if (val < USB_PORT_POWERUP_DELAY_SPEC)
294 } else if (p == &usb_port_resume_delay) {
295 if (val < USB_PORT_RESUME_DELAY_SPEC)
297 } else if (p == &usb_set_address_settle) {
298 if (val < USB_SET_ADDRESS_SETTLE_SPEC)
300 } else if (p == &usb_resume_delay) {
301 if (val < USB_RESUME_DELAY_SPEC)
303 } else if (p == &usb_resume_wait) {
304 if (val < USB_RESUME_WAIT_SPEC)
306 } else if (p == &usb_resume_recovery) {
307 if (val < USB_RESUME_RECOVERY_SPEC)
309 } else if (p == &usb_extra_power_up_time) {
310 if (val < USB_EXTRA_POWER_UP_TIME_SPEC)