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