usb_subr.c revision 1.265.2.1 1 /* $NetBSD: usb_subr.c,v 1.265.2.1 2021/08/04 23:07:57 thorpej Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/usb_subr.c,v 1.18 1999/11/17 22:33:47 n_hibma Exp $ */
3
4 /*
5 * Copyright (c) 1998, 2004 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart (at) augustsson.net) at
10 * Carlstedt Research & Technology.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #include <sys/cdefs.h>
35 __KERNEL_RCSID(0, "$NetBSD: usb_subr.c,v 1.265.2.1 2021/08/04 23:07:57 thorpej Exp $");
36
37 #ifdef _KERNEL_OPT
38 #include "opt_compat_netbsd.h"
39 #include "opt_usb.h"
40 #include "opt_usbverbose.h"
41 #endif
42
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/kmem.h>
47 #include <sys/device.h>
48 #include <sys/select.h>
49 #include <sys/proc.h>
50
51 #include <sys/bus.h>
52 #include <sys/module.h>
53
54 #include <dev/usb/usb.h>
55
56 #include <dev/usb/usbdi.h>
57 #include <dev/usb/usbdi_util.h>
58 #include <dev/usb/usbdivar.h>
59 #include <dev/usb/usbdevs.h>
60 #include <dev/usb/usb_quirks.h>
61 #include <dev/usb/usb_verbose.h>
62 #include <dev/usb/usbhist.h>
63
64 #include "locators.h"
65
66 #define DPRINTF(FMT,A,B,C,D) USBHIST_LOG(usbdebug,FMT,A,B,C,D)
67 #define DPRINTFN(N,FMT,A,B,C,D) USBHIST_LOGN(usbdebug,N,FMT,A,B,C,D)
68
69 Static void usbd_devinfo(struct usbd_device *, int, char *, size_t);
70 Static int usbd_getnewaddr(struct usbd_bus *);
71 Static int usbd_print(void *, const char *);
72 Static int usbd_ifprint(void *, const char *);
73 Static void usbd_free_iface_data(struct usbd_device *, int);
74
75 uint32_t usb_cookie_no = 0;
76
77 Static const char * const usbd_error_strs[] = {
78 "NORMAL_COMPLETION",
79 "IN_PROGRESS",
80 "PENDING_REQUESTS",
81 "NOT_STARTED",
82 "INVAL",
83 "NOMEM",
84 "CANCELLED",
85 "BAD_ADDRESS",
86 "IN_USE",
87 "NO_ADDR",
88 "SET_ADDR_FAILED",
89 "NO_POWER",
90 "TOO_DEEP",
91 "IOERROR",
92 "NOT_CONFIGURED",
93 "TIMEOUT",
94 "SHORT_XFER",
95 "STALLED",
96 "INTERRUPTED",
97 "XXX",
98 };
99
100 DEV_VERBOSE_DEFINE(usb);
101
102 const char *
103 usbd_errstr(usbd_status err)
104 {
105 static char buffer[5];
106
107 if (err < USBD_ERROR_MAX) {
108 return usbd_error_strs[err];
109 } else {
110 snprintf(buffer, sizeof(buffer), "%d", err);
111 return buffer;
112 }
113 }
114
115 static void
116 usbd_trim_spaces(char *p)
117 {
118 char *q, *e;
119
120 q = e = p;
121 while (*q == ' ') /* skip leading spaces */
122 q++;
123 while ((*p = *q++)) /* copy string */
124 if (*p++ != ' ') /* remember last non-space */
125 e = p;
126 *e = '\0'; /* kill trailing spaces */
127 }
128
129 static void
130 usbd_get_device_string(struct usbd_device *ud, uByte index, char **buf)
131 {
132 char *b;
133 usbd_status err;
134
135 b = kmem_alloc(USB_MAX_ENCODED_STRING_LEN, KM_SLEEP);
136 err = usbd_get_string0(ud, index, b, true);
137 if (err != USBD_NORMAL_COMPLETION) {
138 kmem_free(b, USB_MAX_ENCODED_STRING_LEN);
139 b = NULL;
140 } else {
141 usbd_trim_spaces(b);
142 }
143
144 *buf = b;
145 }
146
147 void
148 usbd_get_device_strings(struct usbd_device *ud)
149 {
150 usb_device_descriptor_t *udd = &ud->ud_ddesc;
151
152 usbd_get_device_string(ud, udd->iManufacturer, &ud->ud_vendor);
153 usbd_get_device_string(ud, udd->iProduct, &ud->ud_product);
154 usbd_get_device_string(ud, udd->iSerialNumber, &ud->ud_serial);
155 }
156
157
158 void
159 usbd_devinfo_vp(struct usbd_device *dev, char *v, size_t vl, char *p,
160 size_t pl, int usedev, int useencoded)
161 {
162 usb_device_descriptor_t *udd = &dev->ud_ddesc;
163 if (dev == NULL)
164 return;
165
166 v[0] = p[0] = '\0';
167
168 if (usedev) {
169 if (usbd_get_string0(dev, udd->iManufacturer, v, useencoded) ==
170 USBD_NORMAL_COMPLETION)
171 usbd_trim_spaces(v);
172 if (usbd_get_string0(dev, udd->iProduct, p, useencoded) ==
173 USBD_NORMAL_COMPLETION)
174 usbd_trim_spaces(p);
175 } else {
176 if (dev->ud_vendor) {
177 strlcpy(v, dev->ud_vendor, vl);
178 }
179 if (dev->ud_product) {
180 strlcpy(p, dev->ud_product, pl);
181 }
182 }
183 if (v[0] == '\0')
184 usb_findvendor(v, vl, UGETW(udd->idVendor));
185 if (p[0] == '\0')
186 usb_findproduct(p, pl, UGETW(udd->idVendor),
187 UGETW(udd->idProduct));
188 }
189
190 int
191 usbd_printBCD(char *cp, size_t l, int bcd)
192 {
193 return snprintf(cp, l, "%x.%02x", bcd >> 8, bcd & 0xff);
194 }
195
196 Static void
197 usbd_devinfo(struct usbd_device *dev, int showclass, char *cp, size_t l)
198 {
199 usb_device_descriptor_t *udd = &dev->ud_ddesc;
200 char *vendor, *product;
201 int bcdDevice, bcdUSB;
202 char *ep;
203
204 vendor = kmem_alloc(USB_MAX_ENCODED_STRING_LEN * 2, KM_SLEEP);
205 product = &vendor[USB_MAX_ENCODED_STRING_LEN];
206
207 ep = cp + l;
208
209 usbd_devinfo_vp(dev, vendor, USB_MAX_ENCODED_STRING_LEN,
210 product, USB_MAX_ENCODED_STRING_LEN, 0, 1);
211 cp += snprintf(cp, ep - cp, "%s (0x%04x) %s (0x%04x)", vendor,
212 UGETW(udd->idVendor), product, UGETW(udd->idProduct));
213 if (showclass)
214 cp += snprintf(cp, ep - cp, ", class %d/%d",
215 udd->bDeviceClass, udd->bDeviceSubClass);
216 bcdUSB = UGETW(udd->bcdUSB);
217 bcdDevice = UGETW(udd->bcdDevice);
218 cp += snprintf(cp, ep - cp, ", rev ");
219 cp += usbd_printBCD(cp, ep - cp, bcdUSB);
220 *cp++ = '/';
221 cp += usbd_printBCD(cp, ep - cp, bcdDevice);
222 cp += snprintf(cp, ep - cp, ", addr %d", dev->ud_addr);
223 *cp = 0;
224 kmem_free(vendor, USB_MAX_ENCODED_STRING_LEN * 2);
225 }
226
227 char *
228 usbd_devinfo_alloc(struct usbd_device *dev, int showclass)
229 {
230 char *devinfop;
231
232 devinfop = kmem_alloc(DEVINFOSIZE, KM_SLEEP);
233 usbd_devinfo(dev, showclass, devinfop, DEVINFOSIZE);
234 return devinfop;
235 }
236
237 void
238 usbd_devinfo_free(char *devinfop)
239 {
240 kmem_free(devinfop, DEVINFOSIZE);
241 }
242
243 /* Delay for a certain number of ms */
244 void
245 usb_delay_ms_locked(struct usbd_bus *bus, u_int ms, kmutex_t *lock)
246 {
247 /* Wait at least two clock ticks so we know the time has passed. */
248 if (bus->ub_usepolling || cold)
249 delay((ms+1) * 1000);
250 else
251 kpause("usbdly", false, (ms*hz+999)/1000 + 1, lock);
252 }
253
254 void
255 usb_delay_ms(struct usbd_bus *bus, u_int ms)
256 {
257 usb_delay_ms_locked(bus, ms, NULL);
258 }
259
260 /* Delay given a device handle. */
261 void
262 usbd_delay_ms_locked(struct usbd_device *dev, u_int ms, kmutex_t *lock)
263 {
264 usb_delay_ms_locked(dev->ud_bus, ms, lock);
265 }
266
267 /* Delay given a device handle. */
268 void
269 usbd_delay_ms(struct usbd_device *dev, u_int ms)
270 {
271 usb_delay_ms_locked(dev->ud_bus, ms, NULL);
272 }
273
274 usbd_status
275 usbd_reset_port(struct usbd_device *dev, int port, usb_port_status_t *ps)
276 {
277 USBHIST_FUNC(); USBHIST_CALLARGS(usbdebug, "port %jd", port, 0, 0, 0);
278 usb_device_request_t req;
279 usbd_status err;
280 int n;
281
282 req.bmRequestType = UT_WRITE_CLASS_OTHER;
283 req.bRequest = UR_SET_FEATURE;
284 USETW(req.wValue, UHF_PORT_RESET);
285 USETW(req.wIndex, port);
286 USETW(req.wLength, 0);
287 err = usbd_do_request(dev, &req, 0);
288 DPRINTFN(1, "port %jd reset done, error=%jd", port, err, 0, 0);
289 if (err)
290 return err;
291 n = 10;
292 do {
293 /* Wait for device to recover from reset. */
294 usbd_delay_ms(dev, USB_PORT_RESET_DELAY);
295 err = usbd_get_port_status(dev, port, ps);
296 if (err) {
297 DPRINTF("get status failed %jd", err, 0, 0, 0);
298 return err;
299 }
300 /* If the device disappeared, just give up. */
301 if (!(UGETW(ps->wPortStatus) & UPS_CURRENT_CONNECT_STATUS))
302 return USBD_NORMAL_COMPLETION;
303 } while ((UGETW(ps->wPortChange) & UPS_C_PORT_RESET) == 0 && --n > 0);
304 if (n == 0)
305 return USBD_TIMEOUT;
306 err = usbd_clear_port_feature(dev, port, UHF_C_PORT_RESET);
307 #ifdef USB_DEBUG
308 if (err)
309 DPRINTF("clear port feature failed %jd", err, 0, 0, 0);
310 #endif
311
312 /* Wait for the device to recover from reset. */
313 usbd_delay_ms(dev, USB_PORT_RESET_RECOVERY);
314 return err;
315 }
316
317 usb_interface_descriptor_t *
318 usbd_find_idesc(usb_config_descriptor_t *cd, int ifaceidx, int altidx)
319 {
320 USBHIST_FUNC();
321 USBHIST_CALLARGS(usbdebug, "iface/alt idx %jd/%jd",
322 ifaceidx, altidx, 0, 0);
323 char *p = (char *)cd;
324 char *end = p + UGETW(cd->wTotalLength);
325 usb_descriptor_t *desc;
326 usb_interface_descriptor_t *idesc;
327 int curidx, lastidx, curaidx = 0;
328
329 for (curidx = lastidx = -1; p < end; ) {
330 desc = (usb_descriptor_t *)p;
331
332 DPRINTFN(4, "idx=%jd(%jd) altidx=%jd(%jd)", ifaceidx, curidx,
333 altidx, curaidx);
334 DPRINTFN(4, "len=%jd type=%jd", desc->bLength,
335 desc->bDescriptorType, 0, 0);
336
337 if (desc->bLength < USB_DESCRIPTOR_SIZE)
338 break;
339 p += desc->bLength;
340 if (p > end)
341 break;
342
343 if (desc->bDescriptorType != UDESC_INTERFACE)
344 continue;
345 idesc = (usb_interface_descriptor_t *)desc;
346 if (idesc->bLength < USB_INTERFACE_DESCRIPTOR_SIZE)
347 break;
348
349 if (idesc->bInterfaceNumber != lastidx) {
350 lastidx = idesc->bInterfaceNumber;
351 curidx++;
352 curaidx = 0;
353 } else {
354 curaidx++;
355 }
356 if (ifaceidx == curidx && altidx == curaidx)
357 return idesc;
358 }
359
360 return NULL;
361 }
362
363 usb_endpoint_descriptor_t *
364 usbd_find_edesc(usb_config_descriptor_t *cd, int ifaceidx, int altidx,
365 int endptidx)
366 {
367 char *p = (char *)cd;
368 char *end = p + UGETW(cd->wTotalLength);
369 usb_interface_descriptor_t *idesc;
370 usb_endpoint_descriptor_t *edesc;
371 usb_descriptor_t *desc;
372 int curidx;
373
374 idesc = usbd_find_idesc(cd, ifaceidx, altidx);
375 if (idesc == NULL)
376 return NULL;
377 if (endptidx >= idesc->bNumEndpoints) /* quick exit */
378 return NULL;
379
380 curidx = -1;
381 for (p = (char *)idesc + idesc->bLength; p < end; ) {
382 desc = (usb_descriptor_t *)p;
383
384 if (desc->bLength < USB_DESCRIPTOR_SIZE)
385 break;
386 p += desc->bLength;
387 if (p > end)
388 break;
389
390 if (desc->bDescriptorType == UDESC_INTERFACE)
391 break;
392 if (desc->bDescriptorType != UDESC_ENDPOINT)
393 continue;
394
395 edesc = (usb_endpoint_descriptor_t *)desc;
396 if (edesc->bLength < USB_ENDPOINT_DESCRIPTOR_SIZE)
397 break;
398
399 curidx++;
400 if (curidx == endptidx)
401 return edesc;
402 }
403 return NULL;
404 }
405
406 static void
407 usbd_iface_init(struct usbd_device *dev, int ifaceidx)
408 {
409 struct usbd_interface *ifc = &dev->ud_ifaces[ifaceidx];
410
411 memset(ifc, 0, sizeof(*ifc));
412
413 ifc->ui_dev = dev;
414 ifc->ui_idesc = NULL;
415 ifc->ui_index = 0;
416 ifc->ui_altindex = 0;
417 ifc->ui_endpoints = NULL;
418 ifc->ui_busy = 0;
419 }
420
421 static void
422 usbd_iface_fini(struct usbd_device *dev, int ifaceidx)
423 {
424 struct usbd_interface *ifc __diagused = &dev->ud_ifaces[ifaceidx];
425
426 KASSERT(ifc->ui_dev == dev);
427 KASSERT(ifc->ui_idesc == NULL);
428 KASSERT(ifc->ui_index == 0);
429 KASSERT(ifc->ui_altindex == 0);
430 KASSERT(ifc->ui_endpoints == NULL);
431 KASSERTMSG(ifc->ui_busy == 0, "%"PRId64, ifc->ui_busy);
432 }
433
434 /*
435 * usbd_iface_lock/locked/unlock, usbd_iface_piperef/pipeunref
436 *
437 * We lock the interface while we are setting it, and we acquire a
438 * reference to the interface for each pipe opened on it.
439 *
440 * Setting the interface while pipes are open is forbidden, and
441 * opening pipes while the interface is being set is forbidden.
442 */
443
444 bool
445 usbd_iface_locked(struct usbd_interface *iface)
446 {
447 bool locked;
448
449 mutex_enter(iface->ui_dev->ud_bus->ub_lock);
450 locked = (iface->ui_busy == -1);
451 mutex_exit(iface->ui_dev->ud_bus->ub_lock);
452
453 return locked;
454 }
455
456 static void
457 usbd_iface_exlock(struct usbd_interface *iface)
458 {
459
460 mutex_enter(iface->ui_dev->ud_bus->ub_lock);
461 KASSERTMSG(iface->ui_busy == 0, "interface is not idle,"
462 " busy=%"PRId64, iface->ui_busy);
463 iface->ui_busy = -1;
464 mutex_exit(iface->ui_dev->ud_bus->ub_lock);
465 }
466
467 usbd_status
468 usbd_iface_lock(struct usbd_interface *iface)
469 {
470 usbd_status err;
471
472 mutex_enter(iface->ui_dev->ud_bus->ub_lock);
473 KASSERTMSG(iface->ui_busy != -1, "interface is locked");
474 KASSERTMSG(iface->ui_busy >= 0, "%"PRId64, iface->ui_busy);
475 if (iface->ui_busy) {
476 err = USBD_IN_USE;
477 } else {
478 iface->ui_busy = -1;
479 err = 0;
480 }
481 mutex_exit(iface->ui_dev->ud_bus->ub_lock);
482
483 return err;
484 }
485
486 void
487 usbd_iface_unlock(struct usbd_interface *iface)
488 {
489
490 mutex_enter(iface->ui_dev->ud_bus->ub_lock);
491 KASSERTMSG(iface->ui_busy == -1, "interface is not locked,"
492 " busy=%"PRId64, iface->ui_busy);
493 iface->ui_busy = 0;
494 mutex_exit(iface->ui_dev->ud_bus->ub_lock);
495 }
496
497 usbd_status
498 usbd_iface_piperef(struct usbd_interface *iface)
499 {
500 usbd_status err;
501
502 mutex_enter(iface->ui_dev->ud_bus->ub_lock);
503 KASSERTMSG(iface->ui_busy >= -1, "%"PRId64, iface->ui_busy);
504 if (iface->ui_busy == -1) {
505 err = USBD_IN_USE;
506 } else {
507 iface->ui_busy++;
508 err = 0;
509 }
510 mutex_exit(iface->ui_dev->ud_bus->ub_lock);
511
512 return err;
513 }
514
515 void
516 usbd_iface_pipeunref(struct usbd_interface *iface)
517 {
518
519 mutex_enter(iface->ui_dev->ud_bus->ub_lock);
520 KASSERTMSG(iface->ui_busy != -1, "interface is locked");
521 KASSERTMSG(iface->ui_busy != 0, "interface not in use");
522 KASSERTMSG(iface->ui_busy >= 1, "%"PRId64, iface->ui_busy);
523 iface->ui_busy--;
524 mutex_exit(iface->ui_dev->ud_bus->ub_lock);
525 }
526
527 usbd_status
528 usbd_fill_iface_data(struct usbd_device *dev, int ifaceidx, int altidx)
529 {
530 USBHIST_FUNC();
531 USBHIST_CALLARGS(usbdebug, "ifaceidx=%jd altidx=%jd",
532 ifaceidx, altidx, 0, 0);
533 struct usbd_interface *ifc = &dev->ud_ifaces[ifaceidx];
534 usb_interface_descriptor_t *idesc;
535 struct usbd_endpoint *endpoints;
536 char *p, *end;
537 int endpt, nendpt;
538
539 KASSERT(ifc->ui_dev == dev);
540 KASSERT(usbd_iface_locked(ifc));
541
542 idesc = usbd_find_idesc(dev->ud_cdesc, ifaceidx, altidx);
543 if (idesc == NULL)
544 return USBD_INVAL;
545
546 nendpt = idesc->bNumEndpoints;
547 DPRINTFN(4, "found idesc nendpt=%jd", nendpt, 0, 0, 0);
548 if (nendpt != 0) {
549 endpoints = kmem_alloc(nendpt * sizeof(struct usbd_endpoint),
550 KM_SLEEP);
551 } else
552 endpoints = NULL;
553
554 p = (char *)idesc + idesc->bLength;
555 end = (char *)dev->ud_cdesc + UGETW(dev->ud_cdesc->wTotalLength);
556 #define ed ((usb_endpoint_descriptor_t *)p)
557 for (endpt = 0; endpt < nendpt; endpt++) {
558 DPRINTFN(10, "endpt=%jd", endpt, 0, 0, 0);
559 for (; p < end; p += ed->bLength) {
560 DPRINTFN(10, "p=%#jx end=%#jx len=%jd type=%jd",
561 (uintptr_t)p, (uintptr_t)end, ed->bLength,
562 ed->bDescriptorType);
563 if (p + ed->bLength <= end &&
564 ed->bLength >= USB_ENDPOINT_DESCRIPTOR_SIZE &&
565 ed->bDescriptorType == UDESC_ENDPOINT)
566 goto found;
567 if (ed->bLength == 0 ||
568 ed->bDescriptorType == UDESC_INTERFACE)
569 break;
570 }
571 /* passed end, or bad desc */
572 if (p < end) {
573 if (ed->bLength == 0) {
574 printf("%s: bad descriptor: 0 length\n",
575 __func__);
576 } else {
577 printf("%s: bad descriptor: iface desc\n",
578 __func__);
579 }
580 } else {
581 printf("%s: no desc found\n", __func__);
582 }
583 goto bad;
584 found:
585 endpoints[endpt].ue_edesc = ed;
586 if (dev->ud_speed == USB_SPEED_HIGH) {
587 u_int mps;
588 /* Control and bulk endpoints have max packet limits. */
589 switch (UE_GET_XFERTYPE(ed->bmAttributes)) {
590 case UE_CONTROL:
591 mps = USB_2_MAX_CTRL_PACKET;
592 goto check;
593 case UE_BULK:
594 mps = USB_2_MAX_BULK_PACKET;
595 check:
596 if (UGETW(ed->wMaxPacketSize) != mps) {
597 USETW(ed->wMaxPacketSize, mps);
598 #ifdef DIAGNOSTIC
599 printf("usbd_fill_iface_data: bad max "
600 "packet size\n");
601 #endif
602 }
603 break;
604 default:
605 break;
606 }
607 }
608 endpoints[endpt].ue_refcnt = 0;
609 endpoints[endpt].ue_toggle = 0;
610 p += ed->bLength;
611 }
612 #undef ed
613
614 /* Success! Free the old endpoints and commit the changes. */
615 if (ifc->ui_endpoints) {
616 kmem_free(ifc->ui_endpoints, (sizeof(ifc->ui_endpoints[0]) *
617 ifc->ui_idesc->bNumEndpoints));
618 }
619
620 ifc->ui_idesc = idesc;
621 ifc->ui_index = ifaceidx;
622 ifc->ui_altindex = altidx;
623 ifc->ui_endpoints = endpoints;
624
625 return USBD_NORMAL_COMPLETION;
626
627 bad:
628 if (endpoints)
629 kmem_free(endpoints, nendpt * sizeof(struct usbd_endpoint));
630 return USBD_INVAL;
631 }
632
633 Static void
634 usbd_free_iface_data(struct usbd_device *dev, int ifcno)
635 {
636 struct usbd_interface *ifc = &dev->ud_ifaces[ifcno];
637
638 KASSERT(ifc->ui_dev == dev);
639 KASSERT(ifc->ui_idesc != NULL);
640 KASSERT(usbd_iface_locked(ifc));
641
642 if (ifc->ui_endpoints) {
643 int nendpt = ifc->ui_idesc->bNumEndpoints;
644 size_t sz = nendpt * sizeof(struct usbd_endpoint);
645 kmem_free(ifc->ui_endpoints, sz);
646 ifc->ui_endpoints = NULL;
647 }
648
649 ifc->ui_altindex = 0;
650 ifc->ui_index = 0;
651 ifc->ui_idesc = NULL;
652 }
653
654 usbd_status
655 usbd_set_config_no(struct usbd_device *dev, int no, int msg)
656 {
657 USBHIST_FUNC(); USBHIST_CALLARGS(usbdebug, "%jd", no, 0, 0, 0);
658 usb_config_descriptor_t cd;
659 usbd_status err;
660 int index;
661
662 if (no == USB_UNCONFIG_NO)
663 return usbd_set_config_index(dev, USB_UNCONFIG_INDEX, msg);
664
665 /* Figure out what config index to use. */
666 for (index = 0; index < dev->ud_ddesc.bNumConfigurations; index++) {
667 err = usbd_get_config_desc(dev, index, &cd);
668 if (err)
669 return err;
670 if (cd.bConfigurationValue == no)
671 return usbd_set_config_index(dev, index, msg);
672 }
673 return USBD_INVAL;
674 }
675
676 usbd_status
677 usbd_set_config_index(struct usbd_device *dev, int index, int msg)
678 {
679 USBHIST_FUNC();
680 USBHIST_CALLARGS(usbdebug, "dev=%#jx index=%jd",
681 (uintptr_t)dev, index, 0, 0);
682 usb_config_descriptor_t cd, *cdp;
683 usb_bos_descriptor_t *bdp = NULL;
684 usbd_status err;
685 int i, ifcidx, nifc, len, selfpowered, power;
686
687
688 if (index >= dev->ud_ddesc.bNumConfigurations &&
689 index != USB_UNCONFIG_INDEX) {
690 /* panic? */
691 printf("usbd_set_config_index: illegal index\n");
692 return USBD_INVAL;
693 }
694
695 /* XXX check that all interfaces are idle */
696 if (dev->ud_config != USB_UNCONFIG_NO) {
697 DPRINTF("free old config", 0, 0, 0, 0);
698 /* Free all configuration data structures. */
699 nifc = dev->ud_cdesc->bNumInterface;
700 for (ifcidx = 0; ifcidx < nifc; ifcidx++) {
701 usbd_iface_exlock(&dev->ud_ifaces[ifcidx]);
702 usbd_free_iface_data(dev, ifcidx);
703 usbd_iface_unlock(&dev->ud_ifaces[ifcidx]);
704 usbd_iface_fini(dev, ifcidx);
705 }
706 kmem_free(dev->ud_ifaces, nifc * sizeof(struct usbd_interface));
707 kmem_free(dev->ud_cdesc, UGETW(dev->ud_cdesc->wTotalLength));
708 if (dev->ud_bdesc != NULL)
709 kmem_free(dev->ud_bdesc,
710 UGETW(dev->ud_bdesc->wTotalLength));
711 dev->ud_ifaces = NULL;
712 dev->ud_cdesc = NULL;
713 dev->ud_bdesc = NULL;
714 dev->ud_config = USB_UNCONFIG_NO;
715 }
716
717 if (index == USB_UNCONFIG_INDEX) {
718 /* We are unconfiguring the device, so leave unallocated. */
719 DPRINTF("set config 0", 0, 0, 0, 0);
720 err = usbd_set_config(dev, USB_UNCONFIG_NO);
721 if (err) {
722 DPRINTF("setting config=0 failed, err = %jd", err,
723 0, 0, 0);
724 }
725 return err;
726 }
727
728 /* Get the short descriptor. */
729 err = usbd_get_config_desc(dev, index, &cd);
730 if (err) {
731 DPRINTF("get_config_desc=%jd", err, 0, 0, 0);
732 return err;
733 }
734 len = UGETW(cd.wTotalLength);
735 if (len < USB_CONFIG_DESCRIPTOR_SIZE) {
736 DPRINTF("empty short descriptor", 0, 0, 0, 0);
737 return USBD_INVAL;
738 }
739 cdp = kmem_alloc(len, KM_SLEEP);
740
741 /* Get the full descriptor. Try a few times for slow devices. */
742 for (i = 0; i < 3; i++) {
743 err = usbd_get_desc(dev, UDESC_CONFIG, index, len, cdp);
744 if (!err)
745 break;
746 usbd_delay_ms(dev, 200);
747 }
748 if (err) {
749 DPRINTF("get_desc=%jd", err, 0, 0, 0);
750 goto bad;
751 }
752 if (cdp->bDescriptorType != UDESC_CONFIG) {
753 DPRINTF("bad desc %jd", cdp->bDescriptorType, 0, 0, 0);
754 err = USBD_INVAL;
755 goto bad;
756 }
757 if (UGETW(cdp->wTotalLength) != UGETW(cd.wTotalLength)) {
758 DPRINTF("bad len %jd", UGETW(cdp->wTotalLength), 0, 0, 0);
759 err = USBD_INVAL;
760 goto bad;
761 }
762
763 if (USB_IS_SS(dev->ud_speed)) {
764 usb_bos_descriptor_t bd;
765
766 /* get short bos desc */
767 err = usbd_get_bos_desc(dev, index, &bd);
768 if (!err) {
769 int blen = UGETW(bd.wTotalLength);
770 if (blen < USB_BOS_DESCRIPTOR_SIZE) {
771 DPRINTF("empty bos descriptor", 0, 0, 0, 0);
772 err = USBD_INVAL;
773 goto bad;
774 }
775 bdp = kmem_alloc(blen, KM_SLEEP);
776
777 /* Get the full desc */
778 for (i = 0; i < 3; i++) {
779 err = usbd_get_desc(dev, UDESC_BOS, index, blen,
780 bdp);
781 if (!err)
782 break;
783 usbd_delay_ms(dev, 200);
784 }
785 if (err || bdp->bDescriptorType != UDESC_BOS ||
786 UGETW(bdp->wTotalLength) != UGETW(bd.wTotalLength)) {
787 DPRINTF("error %jd or bad desc %jd", err,
788 bdp->bDescriptorType, 0, 0);
789 kmem_free(bdp, blen);
790 bdp = NULL;
791 }
792 }
793 }
794 dev->ud_bdesc = bdp;
795
796 /*
797 * Figure out if the device is self or bus powered.
798 */
799 #if 0 /* XXX various devices don't report the power state correctly */
800 selfpowered = 0;
801 err = usbd_get_device_status(dev, &ds);
802 if (!err && (UGETW(ds.wStatus) & UDS_SELF_POWERED))
803 selfpowered = 1;
804 #endif
805 /*
806 * Use the power state in the configuration we are going
807 * to set. This doesn't necessarily reflect the actual
808 * power state of the device; the driver can control this
809 * by choosing the appropriate configuration.
810 */
811 selfpowered = !!(cdp->bmAttributes & UC_SELF_POWERED);
812
813 DPRINTF("addr %jd cno=%jd attr=0x%02jx, selfpowered=%jd",
814 dev->ud_addr, cdp->bConfigurationValue, cdp->bmAttributes,
815 selfpowered);
816 DPRINTF("max power=%jd", cdp->bMaxPower * 2, 0, 0, 0);
817
818 /* Check if we have enough power. */
819 #if 0 /* this is a no-op, see above */
820 if ((cdp->bmAttributes & UC_SELF_POWERED) && !selfpowered) {
821 if (msg)
822 printf("%s: device addr %d (config %d): "
823 "can't set self powered configuration\n",
824 device_xname(dev->ud_bus->bdev), dev->ud_addr,
825 cdp->bConfigurationValue);
826 err = USBD_NO_POWER;
827 goto bad;
828 }
829 #endif
830 #ifdef USB_DEBUG
831 if (dev->ud_powersrc == NULL) {
832 DPRINTF("No power source?", 0, 0, 0, 0);
833 err = USBD_IOERROR;
834 goto bad;
835 }
836 #endif
837 power = cdp->bMaxPower * 2;
838 if (power > dev->ud_powersrc->up_power) {
839 DPRINTF("power exceeded %jd %jd", power,
840 dev->ud_powersrc->up_power, 0, 0);
841 /* XXX print nicer message. */
842 if (msg)
843 printf("%s: device addr %d (config %d) exceeds power "
844 "budget, %d mA > %d mA\n",
845 device_xname(dev->ud_bus->ub_usbctl), dev->ud_addr,
846 cdp->bConfigurationValue,
847 power, dev->ud_powersrc->up_power);
848 err = USBD_NO_POWER;
849 goto bad;
850 }
851 dev->ud_power = power;
852 dev->ud_selfpowered = selfpowered;
853
854 /* Set the actual configuration value. */
855 DPRINTF("set config %jd", cdp->bConfigurationValue, 0, 0, 0);
856 err = usbd_set_config(dev, cdp->bConfigurationValue);
857 if (err) {
858 DPRINTF("setting config=%jd failed, error=%jd",
859 cdp->bConfigurationValue, err, 0, 0);
860 goto bad;
861 }
862
863 /* Allocate and fill interface data. */
864 nifc = cdp->bNumInterface;
865 if (nifc == 0) {
866 DPRINTF("no interfaces", 0, 0, 0, 0);
867 err = USBD_INVAL;
868 goto bad;
869 }
870 dev->ud_ifaces = kmem_alloc(nifc * sizeof(struct usbd_interface),
871 KM_SLEEP);
872 DPRINTFN(5, "dev=%#jx cdesc=%#jx", (uintptr_t)dev, (uintptr_t)cdp,
873 0, 0);
874 dev->ud_cdesc = cdp;
875 dev->ud_config = cdp->bConfigurationValue;
876 for (ifcidx = 0; ifcidx < nifc; ifcidx++) {
877 usbd_iface_init(dev, ifcidx);
878 usbd_iface_exlock(&dev->ud_ifaces[ifcidx]);
879 err = usbd_fill_iface_data(dev, ifcidx, 0);
880 usbd_iface_unlock(&dev->ud_ifaces[ifcidx]);
881 if (err) {
882 while (--ifcidx >= 0) {
883 usbd_iface_exlock(&dev->ud_ifaces[ifcidx]);
884 usbd_free_iface_data(dev, ifcidx);
885 usbd_iface_unlock(&dev->ud_ifaces[ifcidx]);
886 usbd_iface_fini(dev, ifcidx);
887 }
888 kmem_free(dev->ud_ifaces,
889 nifc * sizeof(struct usbd_interface));
890 dev->ud_ifaces = NULL;
891 goto bad;
892 }
893 }
894
895 return USBD_NORMAL_COMPLETION;
896
897 bad:
898 /* XXX Use usbd_set_config() to reset the config? */
899 /* XXX Should we forbid USB_UNCONFIG_NO from bConfigurationValue? */
900 dev->ud_config = USB_UNCONFIG_NO;
901 kmem_free(cdp, len);
902 dev->ud_cdesc = NULL;
903 if (bdp != NULL) {
904 kmem_free(bdp, UGETW(bdp->wTotalLength));
905 dev->ud_bdesc = NULL;
906 }
907 return err;
908 }
909
910 /* XXX add function for alternate settings */
911
912 usbd_status
913 usbd_setup_pipe(struct usbd_device *dev, struct usbd_interface *iface,
914 struct usbd_endpoint *ep, int ival, struct usbd_pipe **pipe)
915 {
916 return usbd_setup_pipe_flags(dev, iface, ep, ival, pipe, 0);
917 }
918
919 usbd_status
920 usbd_setup_pipe_flags(struct usbd_device *dev, struct usbd_interface *iface,
921 struct usbd_endpoint *ep, int ival, struct usbd_pipe **pipe, uint8_t flags)
922 {
923 USBHIST_FUNC();
924 USBHIST_CALLARGS(usbdebug, "dev=%#jx addr=%jd iface=%#jx ep=%#jx",
925 (uintptr_t)dev, dev->ud_addr, (uintptr_t)iface, (uintptr_t)ep);
926 struct usbd_pipe *p = NULL;
927 bool ep_acquired = false;
928 usbd_status err;
929
930 /* Block exclusive use of the endpoint by later pipes. */
931 err = usbd_endpoint_acquire(dev, ep, flags & USBD_EXCLUSIVE_USE);
932 if (err)
933 goto out;
934 ep_acquired = true;
935
936 p = kmem_alloc(dev->ud_bus->ub_pipesize, KM_SLEEP);
937 DPRINTFN(1, "pipe=%#jx", (uintptr_t)p, 0, 0, 0);
938 p->up_dev = dev;
939 p->up_iface = iface;
940 p->up_endpoint = ep;
941 p->up_intrxfer = NULL;
942 p->up_running = 0;
943 p->up_aborting = 0;
944 p->up_serialise = true;
945 p->up_repeat = 0;
946 p->up_interval = ival;
947 p->up_flags = flags;
948 SIMPLEQ_INIT(&p->up_queue);
949
950 err = dev->ud_bus->ub_methods->ubm_open(p);
951 if (err) {
952 DPRINTF("endpoint=%#jx failed, error=%jd",
953 (uintptr_t)ep->ue_edesc->bEndpointAddress, err, 0, 0);
954 goto out;
955 }
956
957 KASSERT(p->up_methods->upm_start || p->up_serialise == false);
958
959 usb_init_task(&p->up_async_task, usbd_clear_endpoint_stall_task, p,
960 USB_TASKQ_MPSAFE);
961 DPRINTFN(1, "pipe=%#jx", (uintptr_t)p, 0, 0, 0);
962 *pipe = p;
963 p = NULL; /* handed off to caller */
964 ep_acquired = false; /* handed off to pipe */
965 err = USBD_NORMAL_COMPLETION;
966
967 out: if (p)
968 kmem_free(p, dev->ud_bus->ub_pipesize);
969 if (ep_acquired)
970 usbd_endpoint_release(dev, ep);
971 return err;
972 }
973
974 usbd_status
975 usbd_endpoint_acquire(struct usbd_device *dev, struct usbd_endpoint *ep,
976 int flags)
977 {
978 usbd_status err;
979
980 mutex_enter(dev->ud_bus->ub_lock);
981 if (ep->ue_refcnt == INT_MAX) {
982 err = USBD_IN_USE; /* XXX rule out or switch to 64-bit */
983 } else if ((flags & USBD_EXCLUSIVE_USE) && ep->ue_refcnt) {
984 err = USBD_IN_USE;
985 } else {
986 ep->ue_refcnt++;
987 err = 0;
988 }
989 mutex_exit(dev->ud_bus->ub_lock);
990
991 return err;
992 }
993
994 void
995 usbd_endpoint_release(struct usbd_device *dev, struct usbd_endpoint *ep)
996 {
997
998 mutex_enter(dev->ud_bus->ub_lock);
999 KASSERT(ep->ue_refcnt);
1000 ep->ue_refcnt--;
1001 mutex_exit(dev->ud_bus->ub_lock);
1002 }
1003
1004 /* Abort and close the device control pipe. */
1005 void
1006 usbd_kill_pipe(struct usbd_pipe *pipe)
1007 {
1008
1009 usbd_abort_pipe(pipe);
1010 usbd_close_pipe(pipe);
1011 }
1012
1013 int
1014 usbd_getnewaddr(struct usbd_bus *bus)
1015 {
1016 int addr;
1017
1018 for (addr = 1; addr < USB_MAX_DEVICES; addr++) {
1019 size_t dindex = usb_addr2dindex(addr);
1020 if (bus->ub_devices[dindex] == NULL)
1021 return addr;
1022 }
1023 return -1;
1024 }
1025
1026 usbd_status
1027 usbd_attach_roothub(device_t parent, struct usbd_device *dev)
1028 {
1029 struct usb_attach_arg uaa;
1030 usb_device_descriptor_t *dd = &dev->ud_ddesc;
1031 device_t dv;
1032
1033 uaa.uaa_device = dev;
1034 uaa.uaa_usegeneric = 0;
1035 uaa.uaa_port = 0;
1036 uaa.uaa_vendor = UGETW(dd->idVendor);
1037 uaa.uaa_product = UGETW(dd->idProduct);
1038 uaa.uaa_release = UGETW(dd->bcdDevice);
1039 uaa.uaa_class = dd->bDeviceClass;
1040 uaa.uaa_subclass = dd->bDeviceSubClass;
1041 uaa.uaa_proto = dd->bDeviceProtocol;
1042
1043 KERNEL_LOCK(1, curlwp);
1044 dv = config_found(parent, &uaa, NULL,
1045 CFARGS(.iattr = "usbroothubif"));
1046 KERNEL_UNLOCK_ONE(curlwp);
1047 if (dv) {
1048 dev->ud_subdevs = kmem_alloc(sizeof(dv), KM_SLEEP);
1049 dev->ud_subdevs[0] = dv;
1050 dev->ud_subdevlen = 1;
1051 }
1052 return USBD_NORMAL_COMPLETION;
1053 }
1054
1055 static void
1056 usbd_properties(device_t dv, struct usbd_device *dev)
1057 {
1058 usb_device_descriptor_t *dd = &dev->ud_ddesc;
1059 prop_dictionary_t dict = device_properties(dv);
1060 int class, subclass, release, proto, vendor, product;
1061
1062 class = dd->bDeviceClass;
1063 subclass = dd->bDeviceSubClass;
1064 release = UGETW(dd->bcdDevice);
1065 proto = dd->bDeviceProtocol;
1066 vendor = UGETW(dd->idVendor);
1067 product = UGETW(dd->idProduct);
1068
1069 prop_dictionary_set_uint8(dict, "class", class);
1070 prop_dictionary_set_uint8(dict, "subclass", subclass);
1071 prop_dictionary_set_uint16(dict, "release", release);
1072 prop_dictionary_set_uint8(dict, "proto", proto);
1073 prop_dictionary_set_uint16(dict, "vendor-id", vendor);
1074 prop_dictionary_set_uint16(dict, "product-id", product);
1075
1076 if (dev->ud_vendor) {
1077 prop_dictionary_set_string(dict,
1078 "vendor-string", dev->ud_vendor);
1079 }
1080 if (dev->ud_product) {
1081 prop_dictionary_set_string(dict,
1082 "product-string", dev->ud_product);
1083 }
1084 if (dev->ud_serial) {
1085 prop_dictionary_set_string(dict,
1086 "serialnumber", dev->ud_serial);
1087 }
1088 }
1089
1090 static usbd_status
1091 usbd_attachwholedevice(device_t parent, struct usbd_device *dev, int port,
1092 int usegeneric)
1093 {
1094 struct usb_attach_arg uaa;
1095 usb_device_descriptor_t *dd = &dev->ud_ddesc;
1096 device_t dv;
1097 int dlocs[USBDEVIFCF_NLOCS];
1098
1099 KASSERT(usb_in_event_thread(parent));
1100
1101 uaa.uaa_device = dev;
1102 uaa.uaa_usegeneric = usegeneric;
1103 uaa.uaa_port = port;
1104 uaa.uaa_vendor = UGETW(dd->idVendor);
1105 uaa.uaa_product = UGETW(dd->idProduct);
1106 uaa.uaa_release = UGETW(dd->bcdDevice);
1107 uaa.uaa_class = dd->bDeviceClass;
1108 uaa.uaa_subclass = dd->bDeviceSubClass;
1109 uaa.uaa_proto = dd->bDeviceProtocol;
1110
1111 dlocs[USBDEVIFCF_PORT] = uaa.uaa_port;
1112 dlocs[USBDEVIFCF_VENDOR] = uaa.uaa_vendor;
1113 dlocs[USBDEVIFCF_PRODUCT] = uaa.uaa_product;
1114 dlocs[USBDEVIFCF_RELEASE] = uaa.uaa_release;
1115 /* the rest is historical ballast */
1116 dlocs[USBDEVIFCF_CONFIGURATION] = -1;
1117 dlocs[USBDEVIFCF_INTERFACE] = -1;
1118
1119 KERNEL_LOCK(1, curlwp);
1120 config_pending_incr(parent);
1121 dv = config_found(parent, &uaa, usbd_print,
1122 CFARGS(.submatch = config_stdsubmatch,
1123 .iattr = "usbdevif",
1124 .locators = dlocs));
1125 KERNEL_UNLOCK_ONE(curlwp);
1126 if (dv) {
1127 dev->ud_subdevs = kmem_alloc(sizeof(dv), KM_SLEEP);
1128 dev->ud_subdevs[0] = dv;
1129 dev->ud_subdevlen = 1;
1130 dev->ud_nifaces_claimed = 1; /* XXX */
1131 usbd_properties(dv, dev);
1132 }
1133 config_pending_decr(parent);
1134 return USBD_NORMAL_COMPLETION;
1135 }
1136
1137 static usbd_status
1138 usbd_attachinterfaces(device_t parent, struct usbd_device *dev,
1139 int port, const int *locators)
1140 {
1141 USBHIST_FUNC(); USBHIST_CALLED(usbdebug);
1142 struct usbif_attach_arg uiaa;
1143 int ilocs[USBIFIFCF_NLOCS];
1144 usb_device_descriptor_t *dd = &dev->ud_ddesc;
1145 int nifaces;
1146 struct usbd_interface **ifaces;
1147 int i, j, loc;
1148 device_t dv;
1149
1150 KASSERT(usb_in_event_thread(parent));
1151
1152 nifaces = dev->ud_cdesc->bNumInterface;
1153 ifaces = kmem_zalloc(nifaces * sizeof(*ifaces), KM_SLEEP);
1154 for (i = 0; i < nifaces; i++) {
1155 if (!dev->ud_subdevs[i]) {
1156 ifaces[i] = &dev->ud_ifaces[i];
1157 }
1158 DPRINTF("interface %jd %#jx", i, (uintptr_t)ifaces[i], 0, 0);
1159 }
1160
1161
1162 uiaa.uiaa_device = dev;
1163 uiaa.uiaa_port = port;
1164 uiaa.uiaa_vendor = UGETW(dd->idVendor);
1165 uiaa.uiaa_product = UGETW(dd->idProduct);
1166 uiaa.uiaa_release = UGETW(dd->bcdDevice);
1167 uiaa.uiaa_configno = dev->ud_cdesc->bConfigurationValue;
1168 uiaa.uiaa_ifaces = ifaces;
1169 uiaa.uiaa_nifaces = nifaces;
1170 ilocs[USBIFIFCF_PORT] = uiaa.uiaa_port;
1171 ilocs[USBIFIFCF_VENDOR] = uiaa.uiaa_vendor;
1172 ilocs[USBIFIFCF_PRODUCT] = uiaa.uiaa_product;
1173 ilocs[USBIFIFCF_RELEASE] = uiaa.uiaa_release;
1174 ilocs[USBIFIFCF_CONFIGURATION] = uiaa.uiaa_configno;
1175
1176 for (i = 0; i < nifaces; i++) {
1177 if (!ifaces[i]) {
1178 DPRINTF("interface %jd claimed", i, 0, 0, 0);
1179 continue; /* interface already claimed */
1180 }
1181 uiaa.uiaa_iface = ifaces[i];
1182 uiaa.uiaa_class = ifaces[i]->ui_idesc->bInterfaceClass;
1183 uiaa.uiaa_subclass = ifaces[i]->ui_idesc->bInterfaceSubClass;
1184 uiaa.uiaa_proto = ifaces[i]->ui_idesc->bInterfaceProtocol;
1185 uiaa.uiaa_ifaceno = ifaces[i]->ui_idesc->bInterfaceNumber;
1186
1187 DPRINTF("searching for interface %jd...", i, 0, 0, 0);
1188 DPRINTF("class %jx subclass %jx proto %jx ifaceno %jd",
1189 uiaa.uiaa_class, uiaa.uiaa_subclass, uiaa.uiaa_proto,
1190 uiaa.uiaa_ifaceno);
1191 ilocs[USBIFIFCF_INTERFACE] = uiaa.uiaa_ifaceno;
1192 if (locators != NULL) {
1193 loc = locators[USBIFIFCF_CONFIGURATION];
1194 if (loc != USBIFIFCF_CONFIGURATION_DEFAULT &&
1195 loc != uiaa.uiaa_configno)
1196 continue;
1197 loc = locators[USBIFIFCF_INTERFACE];
1198 if (loc != USBIFIFCF_INTERFACE_DEFAULT &&
1199 loc != uiaa.uiaa_ifaceno)
1200 continue;
1201 }
1202 KERNEL_LOCK(1, curlwp);
1203 dv = config_found(parent, &uiaa, usbd_ifprint,
1204 CFARGS(.submatch = config_stdsubmatch,
1205 .iattr = "usbifif",
1206 .locators = ilocs));
1207 KERNEL_UNLOCK_ONE(curlwp);
1208 if (!dv)
1209 continue;
1210
1211 usbd_properties(dv, dev);
1212
1213 /* claim */
1214 ifaces[i] = NULL;
1215 /* account for ifaces claimed by the driver behind our back */
1216 for (j = 0; j < nifaces; j++) {
1217
1218 if (!ifaces[j] && !dev->ud_subdevs[j]) {
1219 DPRINTF("interface %jd claimed behind our back",
1220 j, 0, 0, 0);
1221 dev->ud_subdevs[j] = dv;
1222 dev->ud_nifaces_claimed++;
1223 }
1224 }
1225 }
1226
1227 kmem_free(ifaces, nifaces * sizeof(*ifaces));
1228 return USBD_NORMAL_COMPLETION;
1229 }
1230
1231 usbd_status
1232 usbd_probe_and_attach(device_t parent, struct usbd_device *dev,
1233 int port, int addr)
1234 {
1235 USBHIST_FUNC();
1236 USBHIST_CALLARGS(usbdebug, "trying device specific drivers", 0, 0, 0, 0);
1237 usb_device_descriptor_t *dd = &dev->ud_ddesc;
1238 int confi, nifaces;
1239 usbd_status err;
1240
1241 KASSERT(usb_in_event_thread(parent));
1242
1243 /* First try with device specific drivers. */
1244 err = usbd_attachwholedevice(parent, dev, port, 0);
1245 if (dev->ud_nifaces_claimed || err)
1246 return err;
1247 DPRINTF("no device specific driver found", 0, 0, 0, 0);
1248
1249 DPRINTF("looping over %jd configurations", dd->bNumConfigurations,
1250 0, 0, 0);
1251 for (confi = 0; confi < dd->bNumConfigurations; confi++) {
1252 DPRINTFN(1, "trying config idx=%jd", confi, 0, 0, 0);
1253 err = usbd_set_config_index(dev, confi, 1);
1254 if (err) {
1255 DPRINTF("port %jd, set config at addr %jd failed, "
1256 "error=%jd", port, addr, err, 0);
1257 printf("%s: port %d, set config at addr %d failed\n",
1258 device_xname(parent), port, addr);
1259 return err;
1260 }
1261 nifaces = dev->ud_cdesc->bNumInterface;
1262 dev->ud_subdevs = kmem_zalloc(nifaces * sizeof(device_t),
1263 KM_SLEEP);
1264 dev->ud_subdevlen = nifaces;
1265
1266 err = usbd_attachinterfaces(parent, dev, port, NULL);
1267
1268 if (dev->ud_subdevs && dev->ud_nifaces_claimed == 0) {
1269 kmem_free(dev->ud_subdevs,
1270 dev->ud_subdevlen * sizeof(device_t));
1271 dev->ud_subdevs = 0;
1272 dev->ud_subdevlen = 0;
1273 }
1274 if (dev->ud_nifaces_claimed || err)
1275 return err;
1276 }
1277 /* No interfaces were attached in any of the configurations. */
1278
1279 if (dd->bNumConfigurations > 1) /* don't change if only 1 config */
1280 usbd_set_config_index(dev, 0, 0);
1281
1282 DPRINTF("no interface drivers found", 0, 0, 0, 0);
1283
1284 /* Finally try the generic driver. */
1285 err = usbd_attachwholedevice(parent, dev, port, 1);
1286
1287 /*
1288 * The generic attach failed, but leave the device as it is.
1289 * We just did not find any drivers, that's all. The device is
1290 * fully operational and not harming anyone.
1291 */
1292 DPRINTF("generic attach failed", 0, 0, 0, 0);
1293
1294 return USBD_NORMAL_COMPLETION;
1295 }
1296
1297 /**
1298 * Called from uhub_rescan(). usbd_new_device() for the target dev must be
1299 * called before calling this.
1300 */
1301 usbd_status
1302 usbd_reattach_device(device_t parent, struct usbd_device *dev,
1303 int port, const int *locators)
1304 {
1305 int i, loc;
1306
1307 USBHIST_FUNC();
1308 USBHIST_CALLARGS(usbdebug, "uhub%jd port=%jd",
1309 device_unit(parent), port, 0, 0);
1310
1311 KASSERT(usb_in_event_thread(parent));
1312
1313 if (locators != NULL) {
1314 loc = locators[USBIFIFCF_PORT];
1315 if (loc != USBIFIFCF_PORT_DEFAULT && loc != port)
1316 return USBD_NORMAL_COMPLETION;
1317 loc = locators[USBIFIFCF_VENDOR];
1318 if (loc != USBIFIFCF_VENDOR_DEFAULT &&
1319 loc != UGETW(dev->ud_ddesc.idVendor))
1320 return USBD_NORMAL_COMPLETION;
1321 loc = locators[USBIFIFCF_PRODUCT];
1322 if (loc != USBIFIFCF_PRODUCT_DEFAULT &&
1323 loc != UGETW(dev->ud_ddesc.idProduct))
1324 return USBD_NORMAL_COMPLETION;
1325 loc = locators[USBIFIFCF_RELEASE];
1326 if (loc != USBIFIFCF_RELEASE_DEFAULT &&
1327 loc != UGETW(dev->ud_ddesc.bcdDevice))
1328 return USBD_NORMAL_COMPLETION;
1329 }
1330 if (dev->ud_subdevlen == 0) {
1331 /* XXX: check USBIFIFCF_CONFIGURATION and
1332 * USBIFIFCF_INTERFACE too */
1333 return usbd_probe_and_attach(parent, dev, port, dev->ud_addr);
1334 } else if (dev->ud_subdevlen != dev->ud_cdesc->bNumInterface) {
1335 /* device-specific or generic driver is already attached. */
1336 return USBD_NORMAL_COMPLETION;
1337 }
1338 /* Does the device have unconfigured interfaces? */
1339 for (i = 0; i < dev->ud_subdevlen; i++) {
1340 if (dev->ud_subdevs[i] == NULL) {
1341 break;
1342 }
1343 }
1344 if (i >= dev->ud_subdevlen)
1345 return USBD_NORMAL_COMPLETION;
1346 return usbd_attachinterfaces(parent, dev, port, locators);
1347 }
1348
1349 /*
1350 * Called when a new device has been put in the powered state,
1351 * but not yet in the addressed state.
1352 * Get initial descriptor, set the address, get full descriptor,
1353 * and attach a driver.
1354 */
1355 usbd_status
1356 usbd_new_device(device_t parent, struct usbd_bus *bus, int depth, int speed,
1357 int port, struct usbd_port *up)
1358 {
1359 USBHIST_FUNC();
1360 USBHIST_CALLARGS(usbdebug, "bus=%#jx port=%jd depth=%jd speed=%jd",
1361 (uintptr_t)bus, port, depth, speed);
1362 struct usbd_device *dev, *adev;
1363 struct usbd_device *hub;
1364 usb_device_descriptor_t *dd;
1365 usb_port_status_t ps;
1366 usbd_status err;
1367 int addr;
1368 int i;
1369 int p;
1370
1371 KASSERT(usb_in_event_thread(parent));
1372
1373 if (bus->ub_methods->ubm_newdev != NULL)
1374 return (bus->ub_methods->ubm_newdev)(parent, bus, depth, speed,
1375 port, up);
1376
1377 addr = usbd_getnewaddr(bus);
1378 if (addr < 0) {
1379 printf("%s: No free USB addresses, new device ignored.\n",
1380 device_xname(bus->ub_usbctl));
1381 return USBD_NO_ADDR;
1382 }
1383
1384 dev = kmem_zalloc(sizeof(*dev), KM_SLEEP);
1385 dev->ud_bus = bus;
1386
1387 /* Set up default endpoint handle. */
1388 dev->ud_ep0.ue_edesc = &dev->ud_ep0desc;
1389
1390 /* Set up default endpoint descriptor. */
1391 dev->ud_ep0desc.bLength = USB_ENDPOINT_DESCRIPTOR_SIZE;
1392 dev->ud_ep0desc.bDescriptorType = UDESC_ENDPOINT;
1393 dev->ud_ep0desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1394 dev->ud_ep0desc.bmAttributes = UE_CONTROL;
1395 /*
1396 * temporary, will be fixed after first descriptor fetch
1397 * (which uses 64 bytes so it shouldn't be less),
1398 * highspeed devices must support 64 byte packets anyway
1399 */
1400 if (speed == USB_SPEED_HIGH || speed == USB_SPEED_FULL)
1401 USETW(dev->ud_ep0desc.wMaxPacketSize, 64);
1402 else
1403 USETW(dev->ud_ep0desc.wMaxPacketSize, USB_MAX_IPACKET);
1404
1405 dev->ud_ep0desc.bInterval = 0;
1406
1407 /* doesn't matter, just don't leave it uninitialized */
1408 dev->ud_ep0.ue_toggle = 0;
1409
1410 dev->ud_quirks = &usbd_no_quirk;
1411 dev->ud_addr = USB_START_ADDR;
1412 dev->ud_ddesc.bMaxPacketSize = 0;
1413 dev->ud_depth = depth;
1414 dev->ud_powersrc = up;
1415 dev->ud_myhub = up->up_parent;
1416
1417 up->up_dev = dev;
1418
1419 /* Locate port on upstream high speed hub */
1420 for (adev = dev, hub = up->up_parent;
1421 hub != NULL && hub->ud_speed != USB_SPEED_HIGH;
1422 adev = hub, hub = hub->ud_myhub)
1423 ;
1424 if (hub) {
1425 for (p = 1; p <= hub->ud_hub->uh_hubdesc.bNbrPorts; p++) {
1426 if (hub->ud_hub->uh_ports[p - 1].up_dev == adev) {
1427 dev->ud_myhsport =
1428 &hub->ud_hub->uh_ports[p - 1];
1429 goto found;
1430 }
1431 }
1432 panic("usbd_new_device: cannot find HS port");
1433 found:
1434 DPRINTFN(1, "high speed port %jd", p, 0, 0, 0);
1435 } else {
1436 dev->ud_myhsport = NULL;
1437 }
1438 dev->ud_speed = speed;
1439 dev->ud_langid = USBD_NOLANG;
1440 dev->ud_cookie.cookie = ++usb_cookie_no;
1441
1442 /* Establish the default pipe. */
1443 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL,
1444 &dev->ud_pipe0, USBD_MPSAFE);
1445 if (err) {
1446 usbd_remove_device(dev, up);
1447 return err;
1448 }
1449
1450 dd = &dev->ud_ddesc;
1451 /* Try a few times in case the device is slow (i.e. outside specs.) */
1452 for (i = 0; i < 10; i++) {
1453 /* Get the first 8 bytes of the device descriptor. */
1454 err = usbd_get_initial_ddesc(dev, dd);
1455 if (!err)
1456 break;
1457 /*
1458 * The root hub can never fail to give the initial descriptor,
1459 * but assert it just in case.
1460 */
1461 KASSERT(up->up_parent);
1462 usbd_delay_ms(dev, 200);
1463 if ((i & 3) == 3)
1464 usbd_reset_port(up->up_parent, port, &ps);
1465 }
1466 if (err) {
1467 DPRINTF("addr=%jd, getting first desc failed: %jd", addr, err,
1468 0, 0);
1469 usbd_remove_device(dev, up);
1470 return err;
1471 }
1472
1473 /* Windows resets the port here, do likewise */
1474 if (up->up_parent)
1475 usbd_reset_port(up->up_parent, port, &ps);
1476
1477 if (speed == USB_SPEED_HIGH) {
1478 /* Max packet size must be 64 (sec 5.5.3). */
1479 if (dd->bMaxPacketSize != USB_2_MAX_CTRL_PACKET) {
1480 #ifdef DIAGNOSTIC
1481 printf("usbd_new_device: addr=%d bad max packet "
1482 "size=%d. adjusting to %d.\n",
1483 addr, dd->bMaxPacketSize, USB_2_MAX_CTRL_PACKET);
1484 #endif
1485 dd->bMaxPacketSize = USB_2_MAX_CTRL_PACKET;
1486 }
1487 }
1488
1489 DPRINTF("adding unit addr=%jd, rev=%02jx, class=%jd, subclass=%jd",
1490 addr, UGETW(dd->bcdUSB), dd->bDeviceClass, dd->bDeviceSubClass);
1491 DPRINTF("protocol=%jd, maxpacket=%jd, len=%jd, speed=%jd",
1492 dd->bDeviceProtocol, dd->bMaxPacketSize, dd->bLength, dev->ud_speed);
1493
1494 if (dd->bDescriptorType != UDESC_DEVICE) {
1495 /* Illegal device descriptor */
1496 DPRINTF("illegal descriptor %jd", dd->bDescriptorType, 0, 0, 0);
1497 usbd_remove_device(dev, up);
1498 return USBD_INVAL;
1499 }
1500
1501 if (dd->bLength < USB_DEVICE_DESCRIPTOR_SIZE) {
1502 DPRINTF("bad length %jd", dd->bLength, 0, 0, 0);
1503 usbd_remove_device(dev, up);
1504 return USBD_INVAL;
1505 }
1506
1507 USETW(dev->ud_ep0desc.wMaxPacketSize, dd->bMaxPacketSize);
1508
1509 /* Re-establish the default pipe with the new MPS. */
1510 usbd_kill_pipe(dev->ud_pipe0);
1511 dev->ud_pipe0 = NULL;
1512 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL,
1513 &dev->ud_pipe0, USBD_MPSAFE);
1514 if (err) {
1515 DPRINTF("setup default pipe failed err %jd", err, 0, 0, 0);
1516 usbd_remove_device(dev, up);
1517 return err;
1518 }
1519
1520 /* Set the address */
1521 DPRINTFN(5, "setting device address=%jd", addr, 0, 0, 0);
1522 err = usbd_set_address(dev, addr);
1523 if (err) {
1524 DPRINTF("set address %jd failed, err = %jd", addr, err, 0, 0);
1525 err = USBD_SET_ADDR_FAILED;
1526 usbd_remove_device(dev, up);
1527 return err;
1528 }
1529
1530 /* Allow device time to set new address */
1531 usbd_delay_ms(dev, USB_SET_ADDRESS_SETTLE);
1532 dev->ud_addr = addr; /* new device address now */
1533 bus->ub_devices[usb_addr2dindex(addr)] = dev;
1534
1535 /* Re-establish the default pipe with the new address. */
1536 usbd_kill_pipe(dev->ud_pipe0);
1537 dev->ud_pipe0 = NULL;
1538 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL,
1539 &dev->ud_pipe0, USBD_MPSAFE);
1540 if (err) {
1541 DPRINTF("setup default pipe failed, err = %jd", err, 0, 0, 0);
1542 usbd_remove_device(dev, up);
1543 return err;
1544 }
1545
1546 err = usbd_reload_device_desc(dev);
1547 if (err) {
1548 DPRINTF("addr=%jd, getting full desc failed, err = %jd", addr,
1549 err, 0, 0);
1550 usbd_remove_device(dev, up);
1551 return err;
1552 }
1553
1554 /* Assume 100mA bus powered for now. Changed when configured. */
1555 dev->ud_power = USB_MIN_POWER;
1556 dev->ud_selfpowered = 0;
1557
1558 DPRINTF("new dev (addr %jd), dev=%#jx, parent=%#jx",
1559 addr, (uintptr_t)dev, (uintptr_t)parent, 0);
1560
1561 usbd_get_device_strings(dev);
1562
1563 usbd_add_dev_event(USB_EVENT_DEVICE_ATTACH, dev);
1564
1565 if (port == 0) { /* root hub */
1566 KASSERT(addr == 1);
1567 usbd_attach_roothub(parent, dev);
1568 return USBD_NORMAL_COMPLETION;
1569 }
1570
1571 err = usbd_probe_and_attach(parent, dev, port, addr);
1572 if (err) {
1573 usbd_remove_device(dev, up);
1574 return err;
1575 }
1576
1577 return USBD_NORMAL_COMPLETION;
1578 }
1579
1580 usbd_status
1581 usbd_reload_device_desc(struct usbd_device *dev)
1582 {
1583 USBHIST_FUNC(); USBHIST_CALLED(usbdebug);
1584 usb_device_descriptor_t *udd = &dev->ud_ddesc;
1585 usbd_status err;
1586
1587 /* Get the full device descriptor. */
1588 err = usbd_get_device_desc(dev, udd);
1589 if (err)
1590 return err;
1591 if (udd->bDescriptorType != UDESC_DEVICE)
1592 return USBD_INVAL;
1593 if (udd->bLength < USB_DEVICE_DESCRIPTOR_SIZE)
1594 return USBD_INVAL;
1595
1596 DPRINTFN(15, "bLength %5ju", udd->bLength, 0, 0, 0);
1597 DPRINTFN(15, "bDescriptorType %5ju", udd->bDescriptorType, 0, 0, 0);
1598 DPRINTFN(15, "bcdUSB %2jx.%02jx", udd->bcdUSB[1],
1599 udd->bcdUSB[0], 0, 0);
1600 DPRINTFN(15, "bDeviceClass %5ju", udd->bDeviceClass, 0, 0, 0);
1601 DPRINTFN(15, "bDeviceSubClass %5ju", udd->bDeviceSubClass, 0, 0, 0);
1602 DPRINTFN(15, "bDeviceProtocol %5ju", udd->bDeviceProtocol, 0, 0, 0);
1603 DPRINTFN(15, "bMaxPacketSize0 %5ju", udd->bMaxPacketSize, 0, 0, 0);
1604 DPRINTFN(15, "idVendor 0x%02jx 0x%02jx",
1605 udd->idVendor[0],
1606 udd->idVendor[1], 0, 0);
1607 DPRINTFN(15, "idProduct 0x%02jx 0x%02jx",
1608 udd->idProduct[0],
1609 udd->idProduct[1], 0, 0);
1610 DPRINTFN(15, "bcdDevice %2jx.%02jx", udd->bcdDevice[1],
1611 udd->bcdDevice[0], 0, 0);
1612 DPRINTFN(15, "iManufacturer %5ju", udd->iManufacturer, 0, 0, 0);
1613 DPRINTFN(15, "iProduct %5ju", udd->iProduct, 0, 0, 0);
1614 DPRINTFN(15, "iSerial %5ju", udd->iSerialNumber, 0, 0, 0);
1615 DPRINTFN(15, "bNumConfigurations %5ju", udd->bNumConfigurations, 0, 0,
1616 0);
1617
1618 /* Figure out what's wrong with this device. */
1619 dev->ud_quirks = usbd_find_quirk(udd);
1620
1621 return USBD_NORMAL_COMPLETION;
1622 }
1623
1624 void
1625 usbd_remove_device(struct usbd_device *dev, struct usbd_port *up)
1626 {
1627
1628 USBHIST_FUNC();
1629 USBHIST_CALLARGS(usbdebug, "dev %#jx up %#jx",
1630 (uintptr_t)dev, (uintptr_t)up, 0, 0);
1631
1632 if (dev->ud_pipe0 != NULL)
1633 usbd_kill_pipe(dev->ud_pipe0);
1634 up->up_dev = NULL;
1635 dev->ud_bus->ub_devices[usb_addr2dindex(dev->ud_addr)] = NULL;
1636
1637 if (dev->ud_vendor != NULL) {
1638 kmem_free(dev->ud_vendor, USB_MAX_ENCODED_STRING_LEN);
1639 }
1640 if (dev->ud_product != NULL) {
1641 kmem_free(dev->ud_product, USB_MAX_ENCODED_STRING_LEN);
1642 }
1643 if (dev->ud_serial != NULL) {
1644 kmem_free(dev->ud_serial, USB_MAX_ENCODED_STRING_LEN);
1645 }
1646 kmem_free(dev, sizeof(*dev));
1647 }
1648
1649 int
1650 usbd_print(void *aux, const char *pnp)
1651 {
1652 struct usb_attach_arg *uaa = aux;
1653
1654 if (pnp) {
1655 #define USB_DEVINFO 1024
1656 char *devinfo;
1657 if (!uaa->uaa_usegeneric)
1658 return QUIET;
1659 devinfo = kmem_alloc(USB_DEVINFO, KM_SLEEP);
1660 usbd_devinfo(uaa->uaa_device, 1, devinfo, USB_DEVINFO);
1661 aprint_normal("%s, %s", devinfo, pnp);
1662 kmem_free(devinfo, USB_DEVINFO);
1663 }
1664 aprint_normal(" port %d", uaa->uaa_port);
1665 #if 0
1666 /*
1667 * It gets very crowded with these locators on the attach line.
1668 * They are not really needed since they are printed in the clear
1669 * by each driver.
1670 */
1671 if (uaa->uaa_vendor != UHUB_UNK_VENDOR)
1672 aprint_normal(" vendor 0x%04x", uaa->uaa_vendor);
1673 if (uaa->uaa_product != UHUB_UNK_PRODUCT)
1674 aprint_normal(" product 0x%04x", uaa->uaa_product);
1675 if (uaa->uaa_release != UHUB_UNK_RELEASE)
1676 aprint_normal(" release 0x%04x", uaa->uaa_release);
1677 #endif
1678 return UNCONF;
1679 }
1680
1681 int
1682 usbd_ifprint(void *aux, const char *pnp)
1683 {
1684 struct usbif_attach_arg *uiaa = aux;
1685
1686 if (pnp)
1687 return QUIET;
1688 aprint_normal(" port %d", uiaa->uiaa_port);
1689 aprint_normal(" configuration %d", uiaa->uiaa_configno);
1690 aprint_normal(" interface %d", uiaa->uiaa_ifaceno);
1691 #if 0
1692 /*
1693 * It gets very crowded with these locators on the attach line.
1694 * They are not really needed since they are printed in the clear
1695 * by each driver.
1696 */
1697 if (uaa->uaa_vendor != UHUB_UNK_VENDOR)
1698 aprint_normal(" vendor 0x%04x", uaa->uaa_vendor);
1699 if (uaa->uaa_product != UHUB_UNK_PRODUCT)
1700 aprint_normal(" product 0x%04x", uaa->uaa_product);
1701 if (uaa->uaa_release != UHUB_UNK_RELEASE)
1702 aprint_normal(" release 0x%04x", uaa->uaa_release);
1703 #endif
1704 return UNCONF;
1705 }
1706
1707 void
1708 usbd_fill_deviceinfo(struct usbd_device *dev, struct usb_device_info *di,
1709 int usedev)
1710 {
1711 struct usbd_port *p;
1712 int i, j, err;
1713
1714 di->udi_bus = device_unit(dev->ud_bus->ub_usbctl);
1715 di->udi_addr = dev->ud_addr;
1716 di->udi_cookie = dev->ud_cookie;
1717 usbd_devinfo_vp(dev, di->udi_vendor, sizeof(di->udi_vendor),
1718 di->udi_product, sizeof(di->udi_product), usedev, 1);
1719 usbd_printBCD(di->udi_release, sizeof(di->udi_release),
1720 UGETW(dev->ud_ddesc.bcdDevice));
1721 if (usedev) {
1722 usbd_status uerr = usbd_get_string(dev,
1723 dev->ud_ddesc.iSerialNumber, di->udi_serial);
1724 if (uerr != USBD_NORMAL_COMPLETION) {
1725 di->udi_serial[0] = '\0';
1726 } else {
1727 usbd_trim_spaces(di->udi_serial);
1728 }
1729 } else {
1730 di->udi_serial[0] = '\0';
1731 if (dev->ud_serial) {
1732 strlcpy(di->udi_serial, dev->ud_serial,
1733 sizeof(di->udi_serial));
1734 }
1735 }
1736
1737 di->udi_vendorNo = UGETW(dev->ud_ddesc.idVendor);
1738 di->udi_productNo = UGETW(dev->ud_ddesc.idProduct);
1739 di->udi_releaseNo = UGETW(dev->ud_ddesc.bcdDevice);
1740 di->udi_class = dev->ud_ddesc.bDeviceClass;
1741 di->udi_subclass = dev->ud_ddesc.bDeviceSubClass;
1742 di->udi_protocol = dev->ud_ddesc.bDeviceProtocol;
1743 di->udi_config = dev->ud_config;
1744 di->udi_power = dev->ud_selfpowered ? 0 : dev->ud_power;
1745 di->udi_speed = dev->ud_speed;
1746
1747 if (dev->ud_subdevlen > 0) {
1748 for (i = 0, j = 0; i < dev->ud_subdevlen &&
1749 j < USB_MAX_DEVNAMES; i++) {
1750 if (!dev->ud_subdevs[i])
1751 continue;
1752 strncpy(di->udi_devnames[j],
1753 device_xname(dev->ud_subdevs[i]), USB_MAX_DEVNAMELEN);
1754 di->udi_devnames[j][USB_MAX_DEVNAMELEN-1] = '\0';
1755 j++;
1756 }
1757 } else {
1758 j = 0;
1759 }
1760 for (/* j is set */; j < USB_MAX_DEVNAMES; j++)
1761 di->udi_devnames[j][0] = 0; /* empty */
1762
1763 if (!dev->ud_hub) {
1764 di->udi_nports = 0;
1765 return;
1766 }
1767
1768 const int nports = dev->ud_hub->uh_hubdesc.bNbrPorts;
1769 for (i = 1; i <= __arraycount(di->udi_ports) && i <= nports; i++) {
1770 p = &dev->ud_hub->uh_ports[i - 1];
1771 if (p->up_dev)
1772 err = p->up_dev->ud_addr;
1773 else {
1774 const int s = UGETW(p->up_status.wPortStatus);
1775 const bool sshub_p = USB_IS_SS(dev->ud_speed);
1776 if (s & UPS_PORT_ENABLED)
1777 err = USB_PORT_ENABLED;
1778 else if (s & UPS_SUSPEND)
1779 err = USB_PORT_SUSPENDED;
1780 /*
1781 * Note: UPS_PORT_POWER_SS is available only
1782 * on 3.x, and UPS_PORT_POWER is available
1783 * only on 2.0 or 1.1.
1784 */
1785 else if (sshub_p && (s & UPS_PORT_POWER_SS))
1786 err = USB_PORT_POWERED;
1787 else if (!sshub_p && (s & UPS_PORT_POWER))
1788 err = USB_PORT_POWERED;
1789 else
1790 err = USB_PORT_DISABLED;
1791 }
1792 di->udi_ports[i - 1] = err;
1793 }
1794 di->udi_nports = nports;
1795 }
1796
1797 void
1798 usb_free_device(struct usbd_device *dev)
1799 {
1800 int ifcidx, nifc;
1801
1802 if (dev->ud_pipe0 != NULL)
1803 usbd_kill_pipe(dev->ud_pipe0);
1804 if (dev->ud_ifaces != NULL) {
1805 nifc = dev->ud_cdesc->bNumInterface;
1806 for (ifcidx = 0; ifcidx < nifc; ifcidx++) {
1807 usbd_iface_exlock(&dev->ud_ifaces[ifcidx]);
1808 usbd_free_iface_data(dev, ifcidx);
1809 usbd_iface_unlock(&dev->ud_ifaces[ifcidx]);
1810 usbd_iface_fini(dev, ifcidx);
1811 }
1812 kmem_free(dev->ud_ifaces,
1813 nifc * sizeof(struct usbd_interface));
1814 }
1815 if (dev->ud_cdesc != NULL)
1816 kmem_free(dev->ud_cdesc, UGETW(dev->ud_cdesc->wTotalLength));
1817 if (dev->ud_bdesc != NULL)
1818 kmem_free(dev->ud_bdesc, UGETW(dev->ud_bdesc->wTotalLength));
1819 if (dev->ud_subdevlen > 0) {
1820 kmem_free(dev->ud_subdevs,
1821 dev->ud_subdevlen * sizeof(device_t));
1822 dev->ud_subdevlen = 0;
1823 }
1824 if (dev->ud_vendor) {
1825 kmem_free(dev->ud_vendor, USB_MAX_ENCODED_STRING_LEN);
1826 }
1827 if (dev->ud_product) {
1828 kmem_free(dev->ud_product, USB_MAX_ENCODED_STRING_LEN);
1829 }
1830 if (dev->ud_serial) {
1831 kmem_free(dev->ud_serial, USB_MAX_ENCODED_STRING_LEN);
1832 }
1833 kmem_free(dev, sizeof(*dev));
1834 }
1835
1836 /*
1837 * The general mechanism for detaching drivers works as follows: Each
1838 * driver is responsible for maintaining a reference count on the
1839 * number of outstanding references to its softc (e.g. from
1840 * processing hanging in a read or write). The detach method of the
1841 * driver decrements this counter and flags in the softc that the
1842 * driver is dying and then wakes any sleepers. It then sleeps on the
1843 * softc. Each place that can sleep must maintain the reference
1844 * count. When the reference count drops to -1 (0 is the normal value
1845 * of the reference count) then a wakeup on the softc is performed
1846 * signaling to the detach waiter that all references are gone.
1847 */
1848
1849 /*
1850 * Called from process context when we discover that a port has
1851 * been disconnected.
1852 */
1853 int
1854 usb_disconnect_port(struct usbd_port *up, device_t parent, int flags)
1855 {
1856 struct usbd_device *dev = up->up_dev;
1857 device_t subdev;
1858 char subdevname[16];
1859 const char *hubname = device_xname(parent);
1860 int i, rc;
1861
1862 USBHIST_FUNC();
1863 USBHIST_CALLARGS(usbdebug, "up=%#jx dev=%#jx port=%jd",
1864 (uintptr_t)up, (uintptr_t)dev, up->up_portno, 0);
1865
1866 if (dev == NULL) {
1867 return 0;
1868 }
1869
1870 if (dev->ud_subdevlen > 0) {
1871 DPRINTFN(3, "disconnect subdevs", 0, 0, 0, 0);
1872 for (i = 0; i < dev->ud_subdevlen; i++) {
1873 if ((subdev = dev->ud_subdevs[i]) == NULL)
1874 continue;
1875 strlcpy(subdevname, device_xname(subdev),
1876 sizeof(subdevname));
1877 KERNEL_LOCK(1, curlwp);
1878 rc = config_detach(subdev, flags);
1879 KERNEL_UNLOCK_ONE(curlwp);
1880 if (rc != 0)
1881 return rc;
1882 printf("%s: at %s", subdevname, hubname);
1883 if (up->up_portno != 0)
1884 printf(" port %d", up->up_portno);
1885 printf(" (addr %d) disconnected\n", dev->ud_addr);
1886 }
1887 KASSERT(!dev->ud_nifaces_claimed);
1888 }
1889
1890 mutex_enter(dev->ud_bus->ub_lock);
1891 dev->ud_bus->ub_devices[usb_addr2dindex(dev->ud_addr)] = NULL;
1892 up->up_dev = NULL;
1893 mutex_exit(dev->ud_bus->ub_lock);
1894
1895 usbd_add_dev_event(USB_EVENT_DEVICE_DETACH, dev);
1896
1897 usb_free_device(dev);
1898
1899 return 0;
1900 }
1901