1 /* $FreeBSD: head/sys/dev/usb/usb_device.c 269566 2014-08-05 06:38:21Z hselasky $ */
2 /*-
3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27 #include <sys/stdint.h>
28 #include <sys/param.h>
29 #include <sys/queue.h>
30 #include <sys/types.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/bus.h>
34 #include <sys/module.h>
35 #include <sys/lock.h>
36 #include <sys/condvar.h>
37 #include <sys/sysctl.h>
38 #include <sys/unistd.h>
39 #include <sys/callout.h>
40 #include <sys/malloc.h>
41 #include <sys/caps.h>
42 #include <sys/conf.h>
43 #include <sys/fcntl.h>
44 #include <sys/devfs.h>
45
46 #include <bus/u4b/usb.h>
47 #include <bus/u4b/usbdi.h>
48 #include <bus/u4b/usbdi_util.h>
49 #include <bus/u4b/usb_ioctl.h>
50
51 #if USB_HAVE_UGEN
52 #include <sys/sbuf.h>
53 #endif
54
55 #include "usbdevs.h"
56
57 #define USB_DEBUG_VAR usb_debug
58
59 #include <bus/u4b/usb_core.h>
60 #include <bus/u4b/usb_debug.h>
61 #include <bus/u4b/usb_process.h>
62 #include <bus/u4b/usb_device.h>
63 #include <bus/u4b/usb_busdma.h>
64 #include <bus/u4b/usb_transfer.h>
65 #include <bus/u4b/usb_request.h>
66 #include <bus/u4b/usb_dynamic.h>
67 #include <bus/u4b/usb_hub.h>
68 #include <bus/u4b/usb_util.h>
69 #include <bus/u4b/usb_msctest.h>
70 #if USB_HAVE_UGEN
71 #include <bus/u4b/usb_dev.h>
72 #include <bus/u4b/usb_generic.h>
73 #endif
74
75 #include <bus/u4b/quirk/usb_quirk.h>
76
77 #include <bus/u4b/usb_controller.h>
78 #include <bus/u4b/usb_bus.h>
79
80 /* function prototypes */
81
82 static void usb_init_endpoint(struct usb_device *, uint8_t,
83 struct usb_endpoint_descriptor *,
84 struct usb_endpoint_ss_comp_descriptor *,
85 struct usb_endpoint *);
86 static void usb_unconfigure(struct usb_device *, uint8_t);
87 static void usb_detach_device_sub(struct usb_device *, device_t *,
88 char **, uint8_t);
89 static uint8_t usb_probe_and_attach_sub(struct usb_device *,
90 struct usb_attach_arg *);
91 static void usb_init_attach_arg(struct usb_device *,
92 struct usb_attach_arg *);
93 static void usb_suspend_resume_sub(struct usb_device *, device_t,
94 uint8_t);
95 static usb_proc_callback_t usbd_clear_stall_proc;
96 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
97 static void usbd_set_device_strings(struct usb_device *);
98 #if USB_HAVE_DEVCTL
99 static void usb_notify_addq(const char *type, struct usb_device *);
100 #endif
101 #if USB_HAVE_UGEN
102 static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
103 static void usb_cdev_create(struct usb_device *);
104 static void usb_cdev_free(struct usb_device *);
105 #endif
106
107 /* This variable is global to allow easy access to it: */
108
109 #ifdef USB_TEMPLATE
110 int usb_template = USB_TEMPLATE;
111 #else
112 int usb_template;
113 #endif
114
115 TUNABLE_INT("hw.usb.usb_template", &usb_template);
116 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW,
117 &usb_template, 0, "Selected USB device side template");
118
119 /* English is default language */
120
121 static int usb_lang_id = 0x0009;
122 static int usb_lang_mask = 0x00FF;
123
124 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
125 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW,
126 &usb_lang_id, 0, "Preferred USB language ID");
127
128 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
129 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW,
130 &usb_lang_mask, 0, "Preferred USB language mask");
131
132 static const char* statestr[USB_STATE_MAX] = {
133 [USB_STATE_DETACHED] = "DETACHED",
134 [USB_STATE_ATTACHED] = "ATTACHED",
135 [USB_STATE_POWERED] = "POWERED",
136 [USB_STATE_ADDRESSED] = "ADDRESSED",
137 [USB_STATE_CONFIGURED] = "CONFIGURED",
138 };
139
140 const char *
usb_statestr(enum usb_dev_state state)141 usb_statestr(enum usb_dev_state state)
142 {
143 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
144 }
145
146 const char *
usb_get_manufacturer(struct usb_device * udev)147 usb_get_manufacturer(struct usb_device *udev)
148 {
149 return (udev->manufacturer ? udev->manufacturer : "Unknown");
150 }
151
152 const char *
usb_get_product(struct usb_device * udev)153 usb_get_product(struct usb_device *udev)
154 {
155 return (udev->product ? udev->product : "");
156 }
157
158 const char *
usb_get_serial(struct usb_device * udev)159 usb_get_serial(struct usb_device *udev)
160 {
161 return (udev->serial ? udev->serial : "");
162 }
163
164 /*------------------------------------------------------------------------*
165 * usbd_get_ep_by_addr
166 *
167 * This function searches for an USB ep by endpoint address and
168 * direction.
169 *
170 * Returns:
171 * NULL: Failure
172 * Else: Success
173 *------------------------------------------------------------------------*/
174 struct usb_endpoint *
usbd_get_ep_by_addr(struct usb_device * udev,uint8_t ea_val)175 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
176 {
177 struct usb_endpoint *ep = udev->endpoints;
178 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
179 enum {
180 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
181 };
182
183 /*
184 * According to the USB specification not all bits are used
185 * for the endpoint address. Keep defined bits only:
186 */
187 ea_val &= EA_MASK;
188
189 /*
190 * Iterate accross all the USB endpoints searching for a match
191 * based on the endpoint address:
192 */
193 for (; ep != ep_end; ep++) {
194
195 if (ep->edesc == NULL) {
196 continue;
197 }
198 /* do the mask and check the value */
199 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
200 goto found;
201 }
202 }
203
204 /*
205 * The default endpoint is always present and is checked separately:
206 */
207 if ((udev->ctrl_ep.edesc != NULL) &&
208 ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
209 ep = &udev->ctrl_ep;
210 goto found;
211 }
212 return (NULL);
213
214 found:
215 return (ep);
216 }
217
218 /*------------------------------------------------------------------------*
219 * usbd_get_endpoint
220 *
221 * This function searches for an USB endpoint based on the information
222 * given by the passed "struct usb_config" pointer.
223 *
224 * Return values:
225 * NULL: No match.
226 * Else: Pointer to "struct usb_endpoint".
227 *------------------------------------------------------------------------*/
228 struct usb_endpoint *
usbd_get_endpoint(struct usb_device * udev,uint8_t iface_index,const struct usb_config * setup)229 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
230 const struct usb_config *setup)
231 {
232 struct usb_endpoint *ep = udev->endpoints;
233 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
234 uint8_t index = setup->ep_index;
235 uint8_t ea_mask;
236 uint8_t ea_val;
237 uint8_t type_mask;
238 uint8_t type_val;
239
240 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
241 "type=0x%x dir=0x%x index=%d\n",
242 udev, iface_index, setup->endpoint,
243 setup->type, setup->direction, setup->ep_index);
244
245 /* check USB mode */
246
247 if (setup->usb_mode != USB_MODE_DUAL &&
248 udev->flags.usb_mode != setup->usb_mode) {
249 /* wrong mode - no endpoint */
250 return (NULL);
251 }
252
253 /* setup expected endpoint direction mask and value */
254
255 if (setup->direction == UE_DIR_RX) {
256 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
257 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
258 UE_DIR_OUT : UE_DIR_IN;
259 } else if (setup->direction == UE_DIR_TX) {
260 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
261 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
262 UE_DIR_IN : UE_DIR_OUT;
263 } else if (setup->direction == UE_DIR_ANY) {
264 /* match any endpoint direction */
265 ea_mask = 0;
266 ea_val = 0;
267 } else {
268 /* match the given endpoint direction */
269 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
270 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
271 }
272
273 /* setup expected endpoint address */
274
275 if (setup->endpoint == UE_ADDR_ANY) {
276 /* match any endpoint address */
277 } else {
278 /* match the given endpoint address */
279 ea_mask |= UE_ADDR;
280 ea_val |= (setup->endpoint & UE_ADDR);
281 }
282
283 /* setup expected endpoint type */
284
285 if (setup->type == UE_BULK_INTR) {
286 /* this will match BULK and INTERRUPT endpoints */
287 type_mask = 2;
288 type_val = 2;
289 } else if (setup->type == UE_TYPE_ANY) {
290 /* match any endpoint type */
291 type_mask = 0;
292 type_val = 0;
293 } else {
294 /* match the given endpoint type */
295 type_mask = UE_XFERTYPE;
296 type_val = (setup->type & UE_XFERTYPE);
297 }
298
299 /*
300 * Iterate accross all the USB endpoints searching for a match
301 * based on the endpoint address. Note that we are searching
302 * the endpoints from the beginning of the "udev->endpoints" array.
303 */
304 for (; ep != ep_end; ep++) {
305
306 if ((ep->edesc == NULL) ||
307 (ep->iface_index != iface_index)) {
308 continue;
309 }
310 /* do the masks and check the values */
311
312 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
313 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
314 if (!index--) {
315 goto found;
316 }
317 }
318 }
319
320 /*
321 * Match against default endpoint last, so that "any endpoint", "any
322 * address" and "any direction" returns the first endpoint of the
323 * interface. "iface_index" and "direction" is ignored:
324 */
325 if ((udev->ctrl_ep.edesc != NULL) &&
326 ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
327 ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
328 (!index)) {
329 ep = &udev->ctrl_ep;
330 goto found;
331 }
332 return (NULL);
333
334 found:
335 return (ep);
336 }
337
338 /*------------------------------------------------------------------------*
339 * usbd_interface_count
340 *
341 * This function stores the number of USB interfaces excluding
342 * alternate settings, which the USB config descriptor reports into
343 * the unsigned 8-bit integer pointed to by "count".
344 *
345 * Returns:
346 * 0: Success
347 * Else: Failure
348 *------------------------------------------------------------------------*/
349 usb_error_t
usbd_interface_count(struct usb_device * udev,uint8_t * count)350 usbd_interface_count(struct usb_device *udev, uint8_t *count)
351 {
352 if (udev->cdesc == NULL) {
353 *count = 0;
354 return (USB_ERR_NOT_CONFIGURED);
355 }
356 *count = udev->ifaces_max;
357 return (USB_ERR_NORMAL_COMPLETION);
358 }
359
360 /*------------------------------------------------------------------------*
361 * usb_init_endpoint
362 *
363 * This function will initialise the USB endpoint structure pointed to by
364 * the "endpoint" argument. The structure pointed to by "endpoint" must be
365 * zeroed before calling this function.
366 *------------------------------------------------------------------------*/
367 static void
usb_init_endpoint(struct usb_device * udev,uint8_t iface_index,struct usb_endpoint_descriptor * edesc,struct usb_endpoint_ss_comp_descriptor * ecomp,struct usb_endpoint * ep)368 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
369 struct usb_endpoint_descriptor *edesc,
370 struct usb_endpoint_ss_comp_descriptor *ecomp,
371 struct usb_endpoint *ep)
372 {
373 const struct usb_bus_methods *methods;
374 usb_stream_t x;
375
376 methods = udev->bus->methods;
377
378 (methods->endpoint_init) (udev, edesc, ep);
379
380 /* initialise USB endpoint structure */
381 ep->edesc = edesc;
382 ep->ecomp = ecomp;
383 ep->iface_index = iface_index;
384
385 /* setup USB stream queues */
386 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
387 TAILQ_INIT(&ep->endpoint_q[x].head);
388 ep->endpoint_q[x].command = &usbd_pipe_start;
389 }
390
391 /* the pipe is not supported by the hardware */
392 if (ep->methods == NULL)
393 return;
394
395 /* check for SUPER-speed streams mode endpoint */
396 if (udev->speed == USB_SPEED_SUPER && ecomp != NULL &&
397 (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK &&
398 (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) {
399 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS);
400 } else {
401 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT);
402 }
403
404 /* clear stall, if any */
405 if (methods->clear_stall != NULL) {
406 USB_BUS_LOCK(udev->bus);
407 (methods->clear_stall) (udev, ep);
408 USB_BUS_UNLOCK(udev->bus);
409 }
410 }
411
412 /*-----------------------------------------------------------------------*
413 * usb_endpoint_foreach
414 *
415 * This function will iterate all the USB endpoints except the control
416 * endpoint. This function is NULL safe.
417 *
418 * Return values:
419 * NULL: End of USB endpoints
420 * Else: Pointer to next USB endpoint
421 *------------------------------------------------------------------------*/
422 struct usb_endpoint *
usb_endpoint_foreach(struct usb_device * udev,struct usb_endpoint * ep)423 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
424 {
425 struct usb_endpoint *ep_end;
426
427 /* be NULL safe */
428 if (udev == NULL)
429 return (NULL);
430
431 ep_end = udev->endpoints + udev->endpoints_max;
432
433 /* get next endpoint */
434 if (ep == NULL)
435 ep = udev->endpoints;
436 else
437 ep++;
438
439 /* find next allocated ep */
440 while (ep != ep_end) {
441 if (ep->edesc != NULL)
442 return (ep);
443 ep++;
444 }
445 return (NULL);
446 }
447
448 /*------------------------------------------------------------------------*
449 * usb_wait_pending_refs
450 *
451 * This function will wait for any USB references to go away before
452 * returning. This function is used before freeing a USB device.
453 *------------------------------------------------------------------------*/
454 static void
usb_wait_pending_refs(struct usb_device * udev)455 usb_wait_pending_refs(struct usb_device *udev)
456 {
457 #if USB_HAVE_UGEN
458 DPRINTF("Refcount = %d\n", (int)udev->refcount);
459
460 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
461 udev->refcount--;
462 while (1) {
463 /* wait for any pending references to go away */
464 if (udev->refcount == 0) {
465 /* prevent further refs being taken, if any */
466 udev->refcount = USB_DEV_REF_MAX;
467 break;
468 }
469 cv_wait(&udev->ref_cv, &usb_ref_lock);
470 }
471 lockmgr(&usb_ref_lock, LK_RELEASE);
472 #endif
473 }
474
475 /*------------------------------------------------------------------------*
476 * usb_unconfigure
477 *
478 * This function will free all USB interfaces and USB endpoints belonging
479 * to an USB device.
480 *
481 * Flag values, see "USB_UNCFG_FLAG_XXX".
482 *------------------------------------------------------------------------*/
483 static void
usb_unconfigure(struct usb_device * udev,uint8_t flag)484 usb_unconfigure(struct usb_device *udev, uint8_t flag)
485 {
486 uint8_t do_unlock;
487
488 /* Prevent re-enumeration */
489 do_unlock = usbd_enum_lock(udev);
490
491 /* detach all interface drivers */
492 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
493
494 #if USB_HAVE_UGEN
495 /* free all FIFOs except control endpoint FIFOs */
496 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
497
498 /*
499 * Free all cdev's, if any.
500 */
501 usb_cdev_free(udev);
502 #endif
503
504 #if USB_HAVE_COMPAT_LINUX
505 /* free Linux compat device, if any */
506 if (udev->linux_endpoint_start) {
507 usb_linux_free_device(udev);
508 udev->linux_endpoint_start = NULL;
509 }
510 #endif
511
512 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
513
514 /* free "cdesc" after "ifaces" and "endpoints", if any */
515 if (udev->cdesc != NULL) {
516 if (udev->flags.usb_mode != USB_MODE_DEVICE)
517 usbd_free_config_desc(udev, udev->cdesc);
518 udev->cdesc = NULL;
519 }
520 /* set unconfigured state */
521 udev->curr_config_no = USB_UNCONFIG_NO;
522 udev->curr_config_index = USB_UNCONFIG_INDEX;
523
524 if (do_unlock)
525 usbd_enum_unlock(udev);
526 }
527
528 /*------------------------------------------------------------------------*
529 * usbd_set_config_index
530 *
531 * This function selects configuration by index, independent of the
532 * actual configuration number. This function should not be used by
533 * USB drivers.
534 *
535 * Returns:
536 * 0: Success
537 * Else: Failure
538 *------------------------------------------------------------------------*/
539 usb_error_t
usbd_set_config_index(struct usb_device * udev,uint8_t index)540 usbd_set_config_index(struct usb_device *udev, uint8_t index)
541 {
542 struct usb_status ds;
543 struct usb_config_descriptor *cdp;
544 uint16_t power;
545 uint16_t max_power;
546 uint8_t selfpowered;
547 uint8_t do_unlock;
548 usb_error_t err;
549
550 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
551
552 /* Prevent re-enumeration */
553 do_unlock = usbd_enum_lock(udev);
554
555 usb_unconfigure(udev, 0);
556
557 if (index == USB_UNCONFIG_INDEX) {
558 /*
559 * Leave unallocated when unconfiguring the
560 * device. "usb_unconfigure()" will also reset
561 * the current config number and index.
562 */
563 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
564 if (udev->state == USB_STATE_CONFIGURED)
565 usb_set_device_state(udev, USB_STATE_ADDRESSED);
566 goto done;
567 }
568 /* get the full config descriptor */
569 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
570 /* save some memory */
571 err = usbd_req_get_descriptor_ptr(udev, &cdp,
572 (UDESC_CONFIG << 8) | index);
573 } else {
574 /* normal request */
575 err = usbd_req_get_config_desc_full(udev,
576 NULL, &cdp, index);
577 }
578 if (err) {
579 goto done;
580 }
581 /* set the new config descriptor */
582
583 udev->cdesc = cdp;
584
585 /* Figure out if the device is self or bus powered. */
586 selfpowered = 0;
587 if ((!udev->flags.uq_bus_powered) &&
588 (cdp->bmAttributes & UC_SELF_POWERED) &&
589 (udev->flags.usb_mode == USB_MODE_HOST)) {
590 /* May be self powered. */
591 if (cdp->bmAttributes & UC_BUS_POWERED) {
592 /* Must ask device. */
593 err = usbd_req_get_device_status(udev, NULL, &ds);
594 if (err) {
595 DPRINTFN(0, "could not read "
596 "device status: %s\n",
597 usbd_errstr(err));
598 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
599 selfpowered = 1;
600 }
601 DPRINTF("status=0x%04x \n",
602 UGETW(ds.wStatus));
603 } else
604 selfpowered = 1;
605 }
606 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
607 "selfpowered=%d, power=%d\n",
608 udev, cdp,
609 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
610 selfpowered, cdp->bMaxPower * 2);
611
612 /* Check if we have enough power. */
613 power = cdp->bMaxPower * 2;
614
615 if (udev->parent_hub) {
616 max_power = udev->parent_hub->hub->portpower;
617 } else {
618 max_power = USB_MAX_POWER;
619 }
620
621 if (power > max_power) {
622 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
623 err = USB_ERR_NO_POWER;
624 goto done;
625 }
626 /* Only update "self_powered" in USB Host Mode */
627 if (udev->flags.usb_mode == USB_MODE_HOST) {
628 udev->flags.self_powered = selfpowered;
629 }
630 udev->power = power;
631 udev->curr_config_no = cdp->bConfigurationValue;
632 udev->curr_config_index = index;
633 usb_set_device_state(udev, USB_STATE_CONFIGURED);
634
635 /* Set the actual configuration value. */
636 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
637 if (err) {
638 goto done;
639 }
640
641 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
642 if (err) {
643 goto done;
644 }
645
646 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
647 if (err) {
648 goto done;
649 }
650
651 #if USB_HAVE_UGEN
652 /* create device nodes for each endpoint */
653 usb_cdev_create(udev);
654 #endif
655
656 done:
657 DPRINTF("error=%s\n", usbd_errstr(err));
658 if (err) {
659 usb_unconfigure(udev, 0);
660 }
661 if (do_unlock)
662 usbd_enum_unlock(udev);
663 return (err);
664 }
665
666 /*------------------------------------------------------------------------*
667 * usb_config_parse
668 *
669 * This function will allocate and free USB interfaces and USB endpoints,
670 * parse the USB configuration structure and initialise the USB endpoints
671 * and interfaces. If "iface_index" is not equal to
672 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
673 * alternate_setting to be selected for the given interface. Else the
674 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
675 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
676 * is typically called when setting the configuration or when setting
677 * an alternate interface.
678 *
679 * Returns:
680 * 0: Success
681 * Else: Failure
682 *------------------------------------------------------------------------*/
683 static usb_error_t
usb_config_parse(struct usb_device * udev,uint8_t iface_index,uint8_t cmd)684 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
685 {
686 struct usb_idesc_parse_state ips;
687 struct usb_interface_descriptor *id;
688 struct usb_endpoint_descriptor *ed;
689 struct usb_interface *iface;
690 struct usb_endpoint *ep;
691 usb_error_t err;
692 uint8_t ep_curr;
693 uint8_t ep_max;
694 uint8_t temp;
695 uint8_t do_init;
696 uint8_t alt_index;
697
698 if (iface_index != USB_IFACE_INDEX_ANY) {
699 /* parameter overload */
700 alt_index = cmd;
701 cmd = USB_CFG_INIT;
702 } else {
703 /* not used */
704 alt_index = 0;
705 }
706
707 err = 0;
708
709 DPRINTFN(5, "iface_index=%d cmd=%d\n",
710 iface_index, cmd);
711
712 if (cmd == USB_CFG_FREE)
713 goto cleanup;
714
715 if (cmd == USB_CFG_INIT) {
716 KKASSERT(lockowned(&udev->enum_lock));
717
718 /* check for in-use endpoints */
719
720 ep = udev->endpoints;
721 ep_max = udev->endpoints_max;
722 while (ep_max--) {
723 /* look for matching endpoints */
724 if ((iface_index == USB_IFACE_INDEX_ANY) ||
725 (iface_index == ep->iface_index)) {
726 if (ep->refcount_alloc != 0) {
727 /*
728 * This typically indicates a
729 * more serious error.
730 */
731 err = USB_ERR_IN_USE;
732 } else {
733 /* reset endpoint */
734 memset(ep, 0, sizeof(*ep));
735 /* make sure we don't zero the endpoint again */
736 ep->iface_index = USB_IFACE_INDEX_ANY;
737 }
738 }
739 ep++;
740 }
741
742 if (err)
743 return (err);
744 }
745
746 memset(&ips, 0, sizeof(ips));
747
748 ep_curr = 0;
749 ep_max = 0;
750
751 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
752
753 iface = udev->ifaces + ips.iface_index;
754
755 /* check for specific interface match */
756
757 if (cmd == USB_CFG_INIT) {
758 if ((iface_index != USB_IFACE_INDEX_ANY) &&
759 (iface_index != ips.iface_index)) {
760 /* wrong interface */
761 do_init = 0;
762 } else if (alt_index != ips.iface_index_alt) {
763 /* wrong alternate setting */
764 do_init = 0;
765 } else {
766 /* initialise interface */
767 do_init = 1;
768 }
769 } else
770 do_init = 0;
771
772 /* check for new interface */
773 if (ips.iface_index_alt == 0) {
774 /* update current number of endpoints */
775 ep_curr = ep_max;
776 }
777 /* check for init */
778 if (do_init) {
779 /* setup the USB interface structure */
780 iface->idesc = id;
781 /* set alternate index */
782 iface->alt_index = alt_index;
783 /* set default interface parent */
784 if (iface_index == USB_IFACE_INDEX_ANY) {
785 iface->parent_iface_index =
786 USB_IFACE_INDEX_ANY;
787 }
788 }
789
790 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
791
792 ed = (struct usb_endpoint_descriptor *)id;
793
794 temp = ep_curr;
795
796 /* iterate all the endpoint descriptors */
797 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
798
799 /* check if endpoint limit has been reached */
800 if (temp >= USB_MAX_EP_UNITS) {
801 DPRINTF("Endpoint limit reached\n");
802 break;
803 }
804
805 ep = udev->endpoints + temp;
806
807 if (do_init) {
808 void *ecomp;
809
810 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
811 if (ecomp != NULL)
812 DPRINTFN(5, "Found endpoint companion descriptor\n");
813
814 usb_init_endpoint(udev,
815 ips.iface_index, ed, ecomp, ep);
816 }
817
818 temp ++;
819
820 /* find maximum number of endpoints */
821 if (ep_max < temp)
822 ep_max = temp;
823 }
824 }
825
826 /* NOTE: It is valid to have no interfaces and no endpoints! */
827
828 if (cmd == USB_CFG_ALLOC) {
829 udev->ifaces_max = ips.iface_index;
830 #if (USB_HAVE_FIXED_IFACE == 0)
831 udev->ifaces = NULL;
832 if (udev->ifaces_max != 0) {
833 udev->ifaces = kmalloc(sizeof(*iface) * udev->ifaces_max,
834 M_USB, M_WAITOK | M_ZERO);
835 if (udev->ifaces == NULL) {
836 err = USB_ERR_NOMEM;
837 goto done;
838 }
839 }
840 #endif
841 #if (USB_HAVE_FIXED_ENDPOINT == 0)
842 if (ep_max != 0) {
843 udev->endpoints = kmalloc(sizeof(*ep) * ep_max,
844 M_USB, M_WAITOK | M_ZERO);
845 if (udev->endpoints == NULL) {
846 err = USB_ERR_NOMEM;
847 goto done;
848 }
849 } else {
850 udev->endpoints = NULL;
851 }
852 #endif
853 USB_BUS_LOCK(udev->bus);
854 udev->endpoints_max = ep_max;
855 /* reset any ongoing clear-stall */
856 udev->ep_curr = NULL;
857 USB_BUS_UNLOCK(udev->bus);
858 }
859 #if (USB_HAVE_FIXED_IFACE == 0) || (USB_HAVE_FIXED_ENDPOINT == 0)
860 done:
861 #endif
862 if (err) {
863 if (cmd == USB_CFG_ALLOC) {
864 cleanup:
865 USB_BUS_LOCK(udev->bus);
866 udev->endpoints_max = 0;
867 /* reset any ongoing clear-stall */
868 udev->ep_curr = NULL;
869 USB_BUS_UNLOCK(udev->bus);
870
871 #if (USB_HAVE_FIXED_IFACE == 0)
872 if(udev->ifaces != NULL) {
873 kfree(udev->ifaces, M_USB);
874 udev->ifaces = NULL;
875 }
876 #endif
877 #if (USB_HAVE_FIXED_ENDPOINT == 0)
878 if(udev->endpoints != NULL) {
879 kfree(udev->endpoints, M_USB);
880 udev->endpoints = NULL;
881 }
882 #endif
883 udev->ifaces_max = 0;
884 }
885 }
886 return (err);
887 }
888
889 /*------------------------------------------------------------------------*
890 * usbd_set_alt_interface_index
891 *
892 * This function will select an alternate interface index for the
893 * given interface index. The interface should not be in use when this
894 * function is called. That means there should not be any open USB
895 * transfers. Else an error is returned. If the alternate setting is
896 * already set this function will simply return success. This function
897 * is called in Host mode and Device mode!
898 *
899 * Returns:
900 * 0: Success
901 * Else: Failure
902 *------------------------------------------------------------------------*/
903 usb_error_t
usbd_set_alt_interface_index(struct usb_device * udev,uint8_t iface_index,uint8_t alt_index)904 usbd_set_alt_interface_index(struct usb_device *udev,
905 uint8_t iface_index, uint8_t alt_index)
906 {
907 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
908 usb_error_t err;
909 uint8_t do_unlock;
910
911 /* Prevent re-enumeration */
912 do_unlock = usbd_enum_lock(udev);
913
914 if (iface == NULL) {
915 err = USB_ERR_INVAL;
916 goto done;
917 }
918 if (iface->alt_index == alt_index) {
919 /*
920 * Optimise away duplicate setting of
921 * alternate setting in USB Host Mode!
922 */
923 err = 0;
924 goto done;
925 }
926 #if USB_HAVE_UGEN
927 /*
928 * Free all generic FIFOs for this interface, except control
929 * endpoint FIFOs:
930 */
931 usb_fifo_free_wrap(udev, iface_index, 0);
932 #endif
933
934 err = usb_config_parse(udev, iface_index, alt_index);
935 if (err) {
936 goto done;
937 }
938 if (iface->alt_index != alt_index) {
939 /* the alternate setting does not exist */
940 err = USB_ERR_INVAL;
941 goto done;
942 }
943
944 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
945 iface->idesc->bAlternateSetting);
946
947 done:
948 if (do_unlock)
949 usbd_enum_unlock(udev);
950 return (err);
951 }
952
953 /*------------------------------------------------------------------------*
954 * usbd_set_endpoint_stall
955 *
956 * This function is used to make a BULK or INTERRUPT endpoint send
957 * STALL tokens in USB device mode.
958 *
959 * Returns:
960 * 0: Success
961 * Else: Failure
962 *------------------------------------------------------------------------*/
963 usb_error_t
usbd_set_endpoint_stall(struct usb_device * udev,struct usb_endpoint * ep,uint8_t do_stall)964 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
965 uint8_t do_stall)
966 {
967 struct usb_xfer *xfer;
968 usb_stream_t x;
969 uint8_t et;
970 uint8_t was_stalled;
971
972 if (ep == NULL) {
973 /* nothing to do */
974 DPRINTF("Cannot find endpoint\n");
975 /*
976 * Pretend that the clear or set stall request is
977 * successful else some USB host stacks can do
978 * strange things, especially when a control endpoint
979 * stalls.
980 */
981 return (0);
982 }
983 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
984
985 if ((et != UE_BULK) &&
986 (et != UE_INTERRUPT)) {
987 /*
988 * Should not stall control
989 * nor isochronous endpoints.
990 */
991 DPRINTF("Invalid endpoint\n");
992 return (0);
993 }
994 USB_BUS_LOCK(udev->bus);
995
996 /* store current stall state */
997 was_stalled = ep->is_stalled;
998
999 /* check for no change */
1000 if (was_stalled && do_stall) {
1001 /* if the endpoint is already stalled do nothing */
1002 USB_BUS_UNLOCK(udev->bus);
1003 DPRINTF("No change\n");
1004 return (0);
1005 }
1006 /* set stalled state */
1007 ep->is_stalled = 1;
1008
1009 if (do_stall || (!was_stalled)) {
1010 if (!was_stalled) {
1011 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1012 /* lookup the current USB transfer, if any */
1013 xfer = ep->endpoint_q[x].curr;
1014 if (xfer != NULL) {
1015 /*
1016 * The "xfer_stall" method
1017 * will complete the USB
1018 * transfer like in case of a
1019 * timeout setting the error
1020 * code "USB_ERR_STALLED".
1021 */
1022 (udev->bus->methods->xfer_stall) (xfer);
1023 }
1024 }
1025 }
1026 (udev->bus->methods->set_stall) (udev, ep, &do_stall);
1027 }
1028 if (!do_stall) {
1029 ep->toggle_next = 0; /* reset data toggle */
1030 ep->is_stalled = 0; /* clear stalled state */
1031
1032 (udev->bus->methods->clear_stall) (udev, ep);
1033
1034 /* start the current or next transfer, if any */
1035 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1036 usb_command_wrapper(&ep->endpoint_q[x],
1037 ep->endpoint_q[x].curr);
1038 }
1039 }
1040 USB_BUS_UNLOCK(udev->bus);
1041 return (0);
1042 }
1043
1044 /*------------------------------------------------------------------------*
1045 * usb_reset_iface_endpoints - used in USB device side mode
1046 *------------------------------------------------------------------------*/
1047 usb_error_t
usb_reset_iface_endpoints(struct usb_device * udev,uint8_t iface_index)1048 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1049 {
1050 struct usb_endpoint *ep;
1051 struct usb_endpoint *ep_end;
1052
1053 ep = udev->endpoints;
1054 ep_end = udev->endpoints + udev->endpoints_max;
1055
1056 for (; ep != ep_end; ep++) {
1057
1058 if ((ep->edesc == NULL) ||
1059 (ep->iface_index != iface_index)) {
1060 continue;
1061 }
1062 /* simulate a clear stall from the peer */
1063 usbd_set_endpoint_stall(udev, ep, 0);
1064 }
1065 return (0);
1066 }
1067
1068 /*------------------------------------------------------------------------*
1069 * usb_detach_device_sub
1070 *
1071 * This function will try to detach an USB device. If it fails a panic
1072 * will result.
1073 *
1074 * Flag values, see "USB_UNCFG_FLAG_XXX".
1075 *------------------------------------------------------------------------*/
1076 static void
usb_detach_device_sub(struct usb_device * udev,device_t * ppdev,char ** ppnpinfo,uint8_t flag)1077 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1078 char **ppnpinfo, uint8_t flag)
1079 {
1080 device_t dev;
1081 char *pnpinfo;
1082 int err;
1083
1084 dev = *ppdev;
1085 if (dev) {
1086 /*
1087 * NOTE: It is important to clear "*ppdev" before deleting
1088 * the child due to some device methods being called late
1089 * during the delete process !
1090 */
1091 *ppdev = NULL;
1092
1093 device_printf(dev, "at %s, port %d, addr %d "
1094 "(disconnected)\n",
1095 device_get_nameunit(udev->parent_dev),
1096 udev->port_no, udev->address);
1097
1098 if (device_is_attached(dev)) {
1099 if (udev->flags.peer_suspended) {
1100 err = DEVICE_RESUME(dev);
1101 if (err) {
1102 device_printf(dev, "Resume failed\n");
1103 }
1104 }
1105 if (device_detach(dev)) {
1106 goto error;
1107 }
1108 }
1109 if (device_delete_child(udev->parent_dev, dev)) {
1110 goto error;
1111 }
1112 }
1113
1114 pnpinfo = *ppnpinfo;
1115 if (pnpinfo != NULL) {
1116 *ppnpinfo = NULL;
1117 kfree(pnpinfo, M_USBDEV);
1118 }
1119 return;
1120
1121 error:
1122 /* Detach is not allowed to fail in the USB world */
1123 panic("usb_detach_device_sub: A USB driver would not detach\n");
1124 }
1125
1126 /*------------------------------------------------------------------------*
1127 * usb_detach_device
1128 *
1129 * The following function will detach the matching interfaces.
1130 * This function is NULL safe.
1131 *
1132 * Flag values, see "USB_UNCFG_FLAG_XXX".
1133 *------------------------------------------------------------------------*/
1134 void
usb_detach_device(struct usb_device * udev,uint8_t iface_index,uint8_t flag)1135 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1136 uint8_t flag)
1137 {
1138 struct usb_interface *iface;
1139 uint8_t i;
1140
1141 if (udev == NULL) {
1142 /* nothing to do */
1143 return;
1144 }
1145 DPRINTFN(4, "udev=%p\n", udev);
1146
1147 KKASSERT(lockowned(&udev->enum_lock));
1148
1149 /*
1150 * First detach the child to give the child's detach routine a
1151 * chance to detach the sub-devices in the correct order.
1152 * Then delete the child using "device_delete_child()" which
1153 * will detach all sub-devices from the bottom and upwards!
1154 */
1155 if (iface_index != USB_IFACE_INDEX_ANY) {
1156 i = iface_index;
1157 iface_index = i + 1;
1158 } else {
1159 i = 0;
1160 iface_index = USB_IFACE_MAX;
1161 }
1162
1163 /* do the detach */
1164
1165 for (; i != iface_index; i++) {
1166
1167 iface = usbd_get_iface(udev, i);
1168 if (iface == NULL) {
1169 /* looks like the end of the USB interfaces */
1170 break;
1171 }
1172 usb_detach_device_sub(udev, &iface->subdev,
1173 &iface->pnpinfo, flag);
1174 }
1175 }
1176
1177 /*------------------------------------------------------------------------*
1178 * usb_probe_and_attach_sub
1179 *
1180 * Returns:
1181 * 0: Success
1182 * Else: Failure
1183 *------------------------------------------------------------------------*/
1184 static uint8_t
usb_probe_and_attach_sub(struct usb_device * udev,struct usb_attach_arg * uaa)1185 usb_probe_and_attach_sub(struct usb_device *udev,
1186 struct usb_attach_arg *uaa)
1187 {
1188 struct usb_interface *iface;
1189 device_t dev;
1190 int err;
1191
1192 iface = uaa->iface;
1193 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1194 /* leave interface alone */
1195 return (0);
1196 }
1197 dev = iface->subdev;
1198 if (dev) {
1199
1200 /* clean up after module unload */
1201
1202 if (device_is_attached(dev)) {
1203 /* already a device there */
1204 return (0);
1205 }
1206 /* clear "iface->subdev" as early as possible */
1207
1208 iface->subdev = NULL;
1209
1210 if (device_delete_child(udev->parent_dev, dev)) {
1211
1212 /*
1213 * Panic here, else one can get a double call
1214 * to device_detach(). USB devices should
1215 * never fail on detach!
1216 */
1217 panic("device_delete_child() failed\n");
1218 }
1219 }
1220 if (uaa->temp_dev == NULL) {
1221
1222 /* create a new child */
1223 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1224 if (uaa->temp_dev == NULL) {
1225 device_printf(udev->parent_dev,
1226 "Device creation failed\n");
1227 return (1); /* failure */
1228 }
1229 device_set_ivars(uaa->temp_dev, uaa);
1230 device_quiet(uaa->temp_dev);
1231 }
1232 /*
1233 * Set "subdev" before probe and attach so that "devd" gets
1234 * the information it needs.
1235 */
1236 iface->subdev = uaa->temp_dev;
1237
1238 if (device_probe_and_attach(iface->subdev) == 0) {
1239 /*
1240 * The USB attach arguments are only available during probe
1241 * and attach !
1242 */
1243 uaa->temp_dev = NULL;
1244 device_set_ivars(iface->subdev, NULL);
1245
1246 if (udev->flags.peer_suspended) {
1247 err = DEVICE_SUSPEND(iface->subdev);
1248 if (err)
1249 device_printf(iface->subdev, "Suspend failed\n");
1250 }
1251 return (0); /* success */
1252 } else {
1253 /* No USB driver found */
1254 iface->subdev = NULL;
1255 }
1256 return (1); /* failure */
1257 }
1258
1259 /*------------------------------------------------------------------------*
1260 * usbd_set_parent_iface
1261 *
1262 * Using this function will lock the alternate interface setting on an
1263 * interface. It is typically used for multi interface drivers. In USB
1264 * device side mode it is assumed that the alternate interfaces all
1265 * have the same endpoint descriptors. The default parent index value
1266 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1267 * locked.
1268 *------------------------------------------------------------------------*/
1269 void
usbd_set_parent_iface(struct usb_device * udev,uint8_t iface_index,uint8_t parent_index)1270 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1271 uint8_t parent_index)
1272 {
1273 struct usb_interface *iface;
1274
1275 if (udev == NULL) {
1276 /* nothing to do */
1277 return;
1278 }
1279 iface = usbd_get_iface(udev, iface_index);
1280 if (iface != NULL)
1281 iface->parent_iface_index = parent_index;
1282 }
1283
1284 static void
usb_init_attach_arg(struct usb_device * udev,struct usb_attach_arg * uaa)1285 usb_init_attach_arg(struct usb_device *udev,
1286 struct usb_attach_arg *uaa)
1287 {
1288 memset(uaa, 0, sizeof(*uaa));
1289
1290 uaa->device = udev;
1291 uaa->usb_mode = udev->flags.usb_mode;
1292 uaa->port = udev->port_no;
1293 uaa->dev_state = UAA_DEV_READY;
1294
1295 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1296 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1297 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1298 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1299 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1300 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1301 uaa->info.bConfigIndex = udev->curr_config_index;
1302 uaa->info.bConfigNum = udev->curr_config_no;
1303 }
1304
1305 /*------------------------------------------------------------------------*
1306 * usb_probe_and_attach
1307 *
1308 * This function is called from "uhub_explore_sub()",
1309 * "usb_handle_set_config()" and "usb_handle_request()".
1310 *
1311 * Returns:
1312 * 0: Success
1313 * Else: A control transfer failed
1314 *------------------------------------------------------------------------*/
1315 usb_error_t
usb_probe_and_attach(struct usb_device * udev,uint8_t iface_index)1316 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1317 {
1318 struct usb_attach_arg uaa;
1319 struct usb_interface *iface;
1320 uint8_t i;
1321 uint8_t j;
1322 uint8_t do_unlock;
1323
1324 if (udev == NULL) {
1325 DPRINTF("udev == NULL\n");
1326 return (USB_ERR_INVAL);
1327 }
1328 /* Prevent re-enumeration */
1329 do_unlock = usbd_enum_lock(udev);
1330
1331 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1332 /* do nothing - no configuration has been set */
1333 goto done;
1334 }
1335 /* setup USB attach arguments */
1336
1337 usb_init_attach_arg(udev, &uaa);
1338
1339 /*
1340 * If the whole USB device is targeted, invoke the USB event
1341 * handler(s):
1342 */
1343 if (iface_index == USB_IFACE_INDEX_ANY) {
1344
1345 if (usb_test_quirk(&uaa, UQ_MSC_DYMO_EJECT) != 0 &&
1346 usb_dymo_eject(udev, 0) == 0) {
1347 /* success, mark the udev as disappearing */
1348 uaa.dev_state = UAA_DEV_EJECTING;
1349 }
1350
1351 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1352
1353 if (uaa.dev_state != UAA_DEV_READY) {
1354 /* leave device unconfigured */
1355 usb_unconfigure(udev, 0);
1356 goto done;
1357 }
1358 }
1359
1360 /* Check if only one interface should be probed: */
1361 if (iface_index != USB_IFACE_INDEX_ANY) {
1362 i = iface_index;
1363 j = i + 1;
1364 } else {
1365 i = 0;
1366 j = USB_IFACE_MAX;
1367 }
1368
1369 /* Do the probe and attach */
1370 for (; i != j; i++) {
1371
1372 iface = usbd_get_iface(udev, i);
1373 if (iface == NULL) {
1374 /*
1375 * Looks like the end of the USB
1376 * interfaces !
1377 */
1378 DPRINTFN(2, "end of interfaces "
1379 "at %u\n", i);
1380 break;
1381 }
1382 if (iface->idesc == NULL) {
1383 /* no interface descriptor */
1384 continue;
1385 }
1386 uaa.iface = iface;
1387
1388 uaa.info.bInterfaceClass =
1389 iface->idesc->bInterfaceClass;
1390 uaa.info.bInterfaceSubClass =
1391 iface->idesc->bInterfaceSubClass;
1392 uaa.info.bInterfaceProtocol =
1393 iface->idesc->bInterfaceProtocol;
1394 uaa.info.bIfaceIndex = i;
1395 uaa.info.bIfaceNum =
1396 iface->idesc->bInterfaceNumber;
1397 uaa.driver_info = 0; /* reset driver_info */
1398
1399 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1400 uaa.info.bInterfaceClass,
1401 uaa.info.bInterfaceSubClass,
1402 uaa.info.bInterfaceProtocol,
1403 uaa.info.bIfaceIndex,
1404 uaa.info.bIfaceNum);
1405
1406 usb_probe_and_attach_sub(udev, &uaa);
1407
1408 /*
1409 * Remove the leftover child, if any, to enforce that
1410 * a new nomatch devd event is generated for the next
1411 * interface if no driver is found:
1412 */
1413 if (uaa.temp_dev == NULL)
1414 continue;
1415 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1416 DPRINTFN(0, "device delete child failed\n");
1417 uaa.temp_dev = NULL;
1418 }
1419 done:
1420 if (do_unlock)
1421 usbd_enum_unlock(udev);
1422 return (0);
1423 }
1424
1425 /*------------------------------------------------------------------------*
1426 * usb_suspend_resume_sub
1427 *
1428 * This function is called when the suspend or resume methods should
1429 * be executed on an USB device.
1430 *------------------------------------------------------------------------*/
1431 static void
usb_suspend_resume_sub(struct usb_device * udev,device_t dev,uint8_t do_suspend)1432 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1433 {
1434 int err;
1435
1436 if (dev == NULL) {
1437 return;
1438 }
1439 if (!device_is_attached(dev)) {
1440 return;
1441 }
1442 if (do_suspend) {
1443 err = DEVICE_SUSPEND(dev);
1444 } else {
1445 err = DEVICE_RESUME(dev);
1446 }
1447 if (err) {
1448 device_printf(dev, "%s failed\n",
1449 do_suspend ? "Suspend" : "Resume");
1450 }
1451 }
1452
1453 /*------------------------------------------------------------------------*
1454 * usb_suspend_resume
1455 *
1456 * The following function will suspend or resume the USB device.
1457 *
1458 * Returns:
1459 * 0: Success
1460 * Else: Failure
1461 *------------------------------------------------------------------------*/
1462 usb_error_t
usb_suspend_resume(struct usb_device * udev,uint8_t do_suspend)1463 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1464 {
1465 struct usb_interface *iface;
1466 uint8_t i;
1467
1468 if (udev == NULL) {
1469 /* nothing to do */
1470 return (0);
1471 }
1472 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1473
1474 KKASSERT(lockowned(&udev->sr_lock));
1475
1476 USB_BUS_LOCK(udev->bus);
1477 /* filter the suspend events */
1478 if (udev->flags.peer_suspended == do_suspend) {
1479 USB_BUS_UNLOCK(udev->bus);
1480 /* nothing to do */
1481 return (0);
1482 }
1483 udev->flags.peer_suspended = do_suspend;
1484 USB_BUS_UNLOCK(udev->bus);
1485
1486 /* do the suspend or resume */
1487
1488 for (i = 0; i != USB_IFACE_MAX; i++) {
1489
1490 iface = usbd_get_iface(udev, i);
1491 if (iface == NULL) {
1492 /* looks like the end of the USB interfaces */
1493 break;
1494 }
1495 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1496 }
1497 return (0);
1498 }
1499
1500 /*------------------------------------------------------------------------*
1501 * usbd_clear_stall_proc
1502 *
1503 * This function performs generic USB clear stall operations.
1504 *------------------------------------------------------------------------*/
1505 static void
usbd_clear_stall_proc(struct usb_proc_msg * _pm)1506 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1507 {
1508 struct usb_udev_msg *pm = (void *)_pm;
1509 struct usb_device *udev = pm->udev;
1510
1511 /* Change lock */
1512 USB_BUS_UNLOCK(udev->bus);
1513 lockmgr(&udev->device_lock, LK_EXCLUSIVE);
1514
1515 /* Start clear stall callback */
1516 usbd_transfer_start(udev->ctrl_xfer[1]);
1517
1518 /* Change lock */
1519 lockmgr(&udev->device_lock, LK_RELEASE);
1520 USB_BUS_LOCK(udev->bus);
1521 }
1522
1523 /*------------------------------------------------------------------------*
1524 * usb_alloc_device
1525 *
1526 * This function allocates a new USB device. This function is called
1527 * when a new device has been put in the powered state, but not yet in
1528 * the addressed state. Get initial descriptor, set the address, get
1529 * full descriptor and get strings.
1530 *
1531 * Return values:
1532 * 0: Failure
1533 * Else: Success
1534 *------------------------------------------------------------------------*/
1535 struct usb_device *
usb_alloc_device(device_t parent_dev,struct usb_bus * bus,struct usb_device * parent_hub,uint8_t depth,uint8_t port_index,uint8_t port_no,enum usb_dev_speed speed,enum usb_hc_mode mode)1536 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1537 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1538 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1539 {
1540 struct usb_attach_arg uaa;
1541 struct usb_device *udev;
1542 struct usb_device *adev;
1543 struct usb_device *hub;
1544 uint8_t *scratch_ptr;
1545 usb_error_t err;
1546 uint8_t device_index;
1547 uint8_t config_index;
1548 uint8_t config_quirk;
1549 uint8_t set_config_failed;
1550 uint8_t do_unlock;
1551
1552 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1553 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1554 parent_dev, bus, parent_hub, depth, port_index, port_no,
1555 speed, mode);
1556
1557 /*
1558 * Find an unused device index. In USB Host mode this is the
1559 * same as the device address.
1560 *
1561 * Device index zero is not used and device index 1 should
1562 * always be the root hub.
1563 */
1564 for (device_index = USB_ROOT_HUB_ADDR;
1565 (device_index != bus->devices_max) &&
1566 (bus->devices[device_index] != NULL);
1567 device_index++) /* nop */;
1568
1569 if (device_index == bus->devices_max) {
1570 device_printf(bus->bdev,
1571 "No free USB device index for new device\n");
1572 return (NULL);
1573 }
1574
1575 if (depth > 0x10) {
1576 device_printf(bus->bdev,
1577 "Invalid device depth\n");
1578 return (NULL);
1579 }
1580 udev = kmalloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1581
1582 if (udev == NULL) {
1583 return (NULL);
1584 }
1585 /* Initialise SX-locks */
1586 lockinit(&udev->enum_lock, "USB config SX lock", 0, LK_CANRECURSE);
1587 /* XXX (mp) is this LK_CANRECURSE necessary? */
1588 lockinit(&udev->sr_lock, "USB suspend and resume SX lock", 0, LK_CANRECURSE);
1589
1590 cv_init(&udev->ctrlreq_cv, "WCTRL");
1591 cv_init(&udev->ref_cv, "UGONE");
1592
1593 /* initialise our mutex */
1594 lockinit(&udev->device_lock, "USB device mutex", 0, 0);
1595
1596 /* initialise generic clear stall */
1597 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1598 udev->cs_msg[0].udev = udev;
1599 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1600 udev->cs_msg[1].udev = udev;
1601
1602 /* initialise some USB device fields */
1603 udev->parent_hub = parent_hub;
1604 udev->parent_dev = parent_dev;
1605 udev->port_index = port_index;
1606 udev->port_no = port_no;
1607 udev->depth = depth;
1608 udev->bus = bus;
1609 udev->address = USB_START_ADDR; /* default value */
1610 udev->plugtime = (usb_ticks_t)ticks;
1611 /*
1612 * We need to force the power mode to "on" because there are plenty
1613 * of USB devices out there that do not work very well with
1614 * automatic suspend and resume!
1615 */
1616 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1617 udev->pwr_save.last_xfer_time = ticks;
1618 /* we are not ready yet */
1619 udev->refcount = 1;
1620
1621 /* set up default endpoint descriptor */
1622 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1623 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1624 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1625 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1626 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1627 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1628 udev->ctrl_ep_desc.bInterval = 0;
1629
1630 /* set up default endpoint companion descriptor */
1631 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1632 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1633
1634 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1635
1636 udev->speed = speed;
1637 udev->flags.usb_mode = mode;
1638
1639 /* search for our High Speed USB HUB, if any */
1640
1641 adev = udev;
1642 hub = udev->parent_hub;
1643
1644 while (hub) {
1645 if (hub->speed == USB_SPEED_HIGH) {
1646 udev->hs_hub_addr = hub->address;
1647 udev->parent_hs_hub = hub;
1648 udev->hs_port_no = adev->port_no;
1649 break;
1650 }
1651 adev = hub;
1652 hub = hub->parent_hub;
1653 }
1654
1655 /* init the default endpoint */
1656 usb_init_endpoint(udev, 0,
1657 &udev->ctrl_ep_desc,
1658 &udev->ctrl_ep_comp_desc,
1659 &udev->ctrl_ep);
1660
1661 /* set device index */
1662 udev->device_index = device_index;
1663
1664 #if USB_HAVE_UGEN
1665 /* Create ugen name */
1666 ksnprintf(udev->ugen_name, sizeof(udev->ugen_name),
1667 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1668 device_index);
1669 LIST_INIT(&udev->pd_list);
1670
1671 /* Create the control endpoint device */
1672 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1673 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1674
1675 /* Create a link from /dev/ugenX.X to the default endpoint */
1676 if (udev->ctrl_dev != NULL)
1677 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1678 #endif
1679 /* Initialise device */
1680 if (bus->methods->device_init != NULL) {
1681 err = (bus->methods->device_init) (udev);
1682 if (err != 0) {
1683 DPRINTFN(0, "device init %d failed "
1684 "(%s, ignored)\n", device_index,
1685 usbd_errstr(err));
1686 goto done;
1687 }
1688 }
1689 /* set powered device state after device init is complete */
1690 usb_set_device_state(udev, USB_STATE_POWERED);
1691
1692 if (udev->flags.usb_mode == USB_MODE_HOST) {
1693
1694 err = usbd_req_set_address(udev, NULL, device_index);
1695
1696 /*
1697 * This is the new USB device address from now on, if
1698 * the set address request didn't set it already.
1699 */
1700 if (udev->address == USB_START_ADDR)
1701 udev->address = device_index;
1702
1703 /*
1704 * We ignore any set-address errors, hence there are
1705 * buggy USB devices out there that actually receive
1706 * the SETUP PID, but manage to set the address before
1707 * the STATUS stage is ACK'ed. If the device responds
1708 * to the subsequent get-descriptor at the new
1709 * address, then we know that the set-address command
1710 * was successful.
1711 */
1712 if (err) {
1713 DPRINTFN(0, "set address %d failed "
1714 "(%s, ignored)\n", udev->address,
1715 usbd_errstr(err));
1716 }
1717 } else {
1718 /* We are not self powered */
1719 udev->flags.self_powered = 0;
1720
1721 /* Set unconfigured state */
1722 udev->curr_config_no = USB_UNCONFIG_NO;
1723 udev->curr_config_index = USB_UNCONFIG_INDEX;
1724
1725 /* Setup USB descriptors */
1726 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1727 if (err) {
1728 DPRINTFN(0, "setting up USB template failed maybe the USB "
1729 "template module has not been loaded\n");
1730 goto done;
1731 }
1732 }
1733 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1734
1735 /* setup the device descriptor and the initial "wMaxPacketSize" */
1736 err = usbd_setup_device_desc(udev, NULL);
1737
1738 if (err != 0) {
1739 /* try to enumerate two more times */
1740 err = usbd_req_re_enumerate(udev, NULL);
1741 if (err != 0) {
1742 err = usbd_req_re_enumerate(udev, NULL);
1743 if (err != 0) {
1744 goto done;
1745 }
1746 }
1747 }
1748
1749 /*
1750 * Setup temporary USB attach args so that we can figure out some
1751 * basic quirks for this device.
1752 */
1753 usb_init_attach_arg(udev, &uaa);
1754
1755 if (usb_test_quirk(&uaa, UQ_BUS_POWERED))
1756 udev->flags.uq_bus_powered = 1;
1757 if (usb_test_quirk(&uaa, UQ_NO_STRINGS))
1758 udev->flags.no_strings = 1;
1759 if (usb_test_quirk(&uaa, UQ_KBD_DELAY_INIT))
1760 udev->flags.uq_delay_init = 1;
1761 if (usb_test_quirk(&uaa, UQ_KBD_DELAY_CTRL_MSG))
1762 udev->flags.uq_delay_ctrl = 1;
1763 /*
1764 * Workaround for buggy USB devices.
1765 *
1766 * It appears that some string-less USB chips will crash and
1767 * disappear if any attempts are made to read any string
1768 * descriptors.
1769 *
1770 * Try to detect such chips by checking the strings in the USB
1771 * device descriptor. If no strings are present there we
1772 * simply disable all USB strings.
1773 */
1774
1775 /* Protect scratch area */
1776 do_unlock = usbd_enum_lock(udev);
1777
1778 scratch_ptr = udev->scratch.data;
1779
1780 if (udev->ddesc.iManufacturer ||
1781 udev->ddesc.iProduct ||
1782 udev->ddesc.iSerialNumber) {
1783 /* read out the language ID string */
1784 err = usbd_req_get_string_desc(udev, NULL,
1785 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1786 } else {
1787 err = USB_ERR_INVAL;
1788 }
1789
1790 if (err || (scratch_ptr[0] < 4)) {
1791 udev->flags.no_strings = 1;
1792 } else {
1793 uint16_t langid;
1794 uint16_t pref;
1795 uint16_t mask;
1796 uint8_t x;
1797
1798 /* load preferred value and mask */
1799 pref = usb_lang_id;
1800 mask = usb_lang_mask;
1801
1802 /* align length correctly */
1803 scratch_ptr[0] &= ~1U;
1804
1805 /* fix compiler warning */
1806 langid = 0;
1807
1808 /* search for preferred language */
1809 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1810 langid = UGETW(scratch_ptr + x);
1811 if ((langid & mask) == pref)
1812 break;
1813 }
1814 if (x >= scratch_ptr[0]) {
1815 /* pick the first language as the default */
1816 DPRINTFN(1, "Using first language\n");
1817 langid = UGETW(scratch_ptr + 2);
1818 }
1819
1820 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1821 udev->langid = langid;
1822 }
1823
1824 if (do_unlock)
1825 usbd_enum_unlock(udev);
1826
1827 /* assume 100mA bus powered for now. Changed when configured. */
1828 udev->power = USB_MIN_POWER;
1829 /* fetch the vendor and product strings from the device */
1830 usbd_set_device_strings(udev);
1831
1832 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1833 /* USB device mode setup is complete */
1834 err = 0;
1835 goto config_done;
1836 }
1837
1838 /*
1839 * Most USB devices should attach to config index 0 by
1840 * default
1841 */
1842 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1843 config_index = 0;
1844 config_quirk = 1;
1845 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1846 config_index = 1;
1847 config_quirk = 1;
1848 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1849 config_index = 2;
1850 config_quirk = 1;
1851 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1852 config_index = 3;
1853 config_quirk = 1;
1854 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1855 config_index = 4;
1856 config_quirk = 1;
1857 } else {
1858 config_index = 0;
1859 config_quirk = 0;
1860 }
1861
1862 set_config_failed = 0;
1863 repeat_set_config:
1864
1865 DPRINTF("setting config %u\n", config_index);
1866
1867 /* get the USB device configured */
1868 err = usbd_set_config_index(udev, config_index);
1869 if (err) {
1870 if (udev->ddesc.bNumConfigurations != 0) {
1871 if (!set_config_failed) {
1872 set_config_failed = 1;
1873 /* XXX try to re-enumerate the device */
1874 err = usbd_req_re_enumerate(udev, NULL);
1875 if (err == 0)
1876 goto repeat_set_config;
1877 }
1878 DPRINTFN(0, "Failure selecting configuration index %u:"
1879 "%s, port %u, addr %u (ignored)\n",
1880 config_index, usbd_errstr(err), udev->port_no,
1881 udev->address);
1882 }
1883 /*
1884 * Some USB devices do not have any configurations. Ignore any
1885 * set config failures!
1886 */
1887 err = 0;
1888 goto config_done;
1889 }
1890 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1891 if ((udev->cdesc->bNumInterface < 2) &&
1892 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1893 DPRINTFN(0, "Found no endpoints, trying next config\n");
1894 config_index++;
1895 goto repeat_set_config;
1896 }
1897 #if USB_HAVE_MSCTEST
1898 if (config_index == 0) {
1899 /*
1900 * Try to figure out if we have an
1901 * auto-install disk there:
1902 */
1903 if (usb_iface_is_cdrom(udev, 0)) {
1904 DPRINTFN(0, "Found possible auto-install "
1905 "disk (trying next config)\n");
1906 config_index++;
1907 goto repeat_set_config;
1908 }
1909 }
1910 #endif
1911 }
1912 #if USB_HAVE_MSCTEST
1913 if (set_config_failed == 0 && config_index == 0 &&
1914 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1915 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1916
1917 /*
1918 * Try to figure out if there are any MSC quirks we
1919 * should apply automatically:
1920 */
1921 err = usb_msc_auto_quirk(udev, 0);
1922
1923 if (err != 0) {
1924 set_config_failed = 1;
1925 goto repeat_set_config;
1926 }
1927 }
1928 #endif
1929
1930 config_done:
1931 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1932 udev->address, udev, udev->parent_hub);
1933
1934 /* register our device - we are ready */
1935 usb_bus_port_set_device(bus, parent_hub ?
1936 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1937
1938 #if USB_HAVE_UGEN
1939 /* Symlink the ugen device name */
1940 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1941
1942 /* Announce device */
1943 kprintf("%s: <%s> at %s\n", udev->ugen_name,
1944 usb_get_manufacturer(udev),
1945 device_get_nameunit(udev->bus->bdev));
1946 #endif
1947
1948 #if USB_HAVE_DEVCTL
1949 usb_notify_addq("ATTACH", udev);
1950 #endif
1951 done:
1952 if (err) {
1953 /*
1954 * Free USB device and all subdevices, if any.
1955 */
1956 usb_free_device(udev, 0);
1957 udev = NULL;
1958 }
1959 return (udev);
1960 }
1961
1962 #if USB_HAVE_UGEN
1963 struct usb_fs_privdata *
usb_make_dev(struct usb_device * udev,const char * devname,int ep,int fi,int rwmode,uid_t uid,gid_t gid,int mode)1964 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1965 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1966 {
1967 struct usb_fs_privdata* pd;
1968 char buffer[32];
1969
1970 /* Store information to locate ourselves again later */
1971 pd = kmalloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1972 M_WAITOK | M_ZERO);
1973 pd->bus_index = device_get_unit(udev->bus->bdev);
1974 pd->dev_index = udev->device_index;
1975 pd->ep_addr = ep;
1976 pd->fifo_index = fi;
1977 pd->mode = rwmode;
1978
1979 /* Now, create the device itself */
1980 if (devname == NULL) {
1981 devname = buffer;
1982 ksnprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1983 pd->bus_index, pd->dev_index, pd->ep_addr);
1984 }
1985
1986 pd->cdev = make_dev(&usb_ops, 0, uid, gid, mode, "%s", devname);
1987
1988 if (pd->cdev == NULL) {
1989 DPRINTFN(0, "Failed to create device %s\n", devname);
1990 kfree(pd, M_USBDEV);
1991 return (NULL);
1992 }
1993
1994 /* XXX setting si_drv1 and creating the device is not atomic! */
1995 pd->cdev->si_drv1 = pd;
1996
1997 return (pd);
1998 }
1999
2000 void
usb_destroy_dev_sync(struct usb_fs_privdata * pd)2001 usb_destroy_dev_sync(struct usb_fs_privdata *pd)
2002 {
2003 DPRINTFN(1, "Destroying device at ugen%d.%d\n",
2004 pd->bus_index, pd->dev_index);
2005
2006 /*
2007 * Destroy character device synchronously. After this
2008 * all system calls are returned. Can block.
2009 */
2010 destroy_dev(pd->cdev);
2011
2012 kfree(pd, M_USBDEV);
2013 }
2014
2015 void
usb_destroy_dev(struct usb_fs_privdata * pd)2016 usb_destroy_dev(struct usb_fs_privdata *pd)
2017 {
2018 struct usb_bus *bus;
2019
2020 if (pd == NULL)
2021 return;
2022
2023 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
2024 bus = devclass_get_softc(usb_devclass_ptr, pd->bus_index);
2025 lockmgr(&usb_ref_lock, LK_RELEASE);
2026
2027 if (bus == NULL) {
2028 usb_destroy_dev_sync(pd);
2029 return;
2030 }
2031
2032 #if 0
2033 /* XXX what is FreeBSD doing here? */
2034 /* make sure we can re-use the device name */
2035 delist_dev(pd->cdev);
2036 #endif
2037
2038 USB_BUS_LOCK(bus);
2039 LIST_INSERT_HEAD(&bus->pd_cleanup_list, pd, pd_next);
2040 /* get cleanup going */
2041 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
2042 &bus->cleanup_msg[0], &bus->cleanup_msg[1]);
2043 USB_BUS_UNLOCK(bus);
2044 }
2045
2046 static void
usb_cdev_create(struct usb_device * udev)2047 usb_cdev_create(struct usb_device *udev)
2048 {
2049 struct usb_config_descriptor *cd;
2050 struct usb_endpoint_descriptor *ed;
2051 struct usb_descriptor *desc;
2052 struct usb_fs_privdata* pd;
2053 int inmode, outmode, inmask, outmask, mode;
2054 uint8_t ep;
2055
2056 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2057
2058 DPRINTFN(2, "Creating device nodes\n");
2059
2060 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2061 inmode = FWRITE;
2062 outmode = FREAD;
2063 } else { /* USB_MODE_HOST */
2064 inmode = FREAD;
2065 outmode = FWRITE;
2066 }
2067
2068 inmask = 0;
2069 outmask = 0;
2070 desc = NULL;
2071
2072 /*
2073 * Collect all used endpoint numbers instead of just
2074 * generating 16 static endpoints.
2075 */
2076 cd = usbd_get_config_descriptor(udev);
2077 while ((desc = usb_desc_foreach(cd, desc))) {
2078 /* filter out all endpoint descriptors */
2079 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2080 (desc->bLength >= sizeof(*ed))) {
2081 ed = (struct usb_endpoint_descriptor *)desc;
2082
2083 /* update masks */
2084 ep = ed->bEndpointAddress;
2085 if (UE_GET_DIR(ep) == UE_DIR_OUT)
2086 outmask |= 1 << UE_GET_ADDR(ep);
2087 else
2088 inmask |= 1 << UE_GET_ADDR(ep);
2089 }
2090 }
2091
2092 /* Create all available endpoints except EP0 */
2093 for (ep = 1; ep < 16; ep++) {
2094 mode = (inmask & (1 << ep)) ? inmode : 0;
2095 mode |= (outmask & (1 << ep)) ? outmode : 0;
2096 if (mode == 0)
2097 continue; /* no IN or OUT endpoint */
2098
2099 pd = usb_make_dev(udev, NULL, ep, 0,
2100 mode, UID_ROOT, GID_OPERATOR, 0600);
2101
2102 if (pd != NULL)
2103 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2104 }
2105 }
2106
2107 static void
usb_cdev_free(struct usb_device * udev)2108 usb_cdev_free(struct usb_device *udev)
2109 {
2110 struct usb_fs_privdata* pd;
2111
2112 DPRINTFN(2, "Freeing device nodes\n");
2113
2114 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2115 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2116
2117 LIST_REMOVE(pd, pd_next);
2118
2119 usb_destroy_dev(pd);
2120 }
2121 }
2122 #endif
2123
2124 /*------------------------------------------------------------------------*
2125 * usb_free_device
2126 *
2127 * This function is NULL safe and will free an USB device and its
2128 * children devices, if any.
2129 *
2130 * Flag values: Reserved, set to zero.
2131 *------------------------------------------------------------------------*/
2132 void
usb_free_device(struct usb_device * udev,uint8_t flag)2133 usb_free_device(struct usb_device *udev, uint8_t flag)
2134 {
2135 struct usb_bus *bus;
2136
2137 if (udev == NULL)
2138 return; /* already freed */
2139
2140 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2141
2142 bus = udev->bus;
2143
2144 /* set DETACHED state to prevent any further references */
2145 usb_set_device_state(udev, USB_STATE_DETACHED);
2146
2147 #if USB_HAVE_DEVCTL
2148 usb_notify_addq("DETACH", udev);
2149 #endif
2150
2151 #if USB_HAVE_UGEN
2152 kprintf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2153 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2154
2155 /* Destroy UGEN symlink, if any */
2156 if (udev->ugen_symlink) {
2157 usb_free_symlink(udev->ugen_symlink);
2158 udev->ugen_symlink = NULL;
2159 }
2160
2161 usb_destroy_dev(udev->ctrl_dev);
2162 #endif
2163
2164 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2165 /* stop receiving any control transfers (Device Side Mode) */
2166 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2167 }
2168
2169 /* the following will get the device unconfigured in software */
2170 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2171
2172 /* final device unregister after all character devices are closed */
2173 usb_bus_port_set_device(bus, udev->parent_hub ?
2174 udev->parent_hub->hub->ports + udev->port_index : NULL,
2175 NULL, USB_ROOT_HUB_ADDR);
2176
2177 /* unsetup any leftover default USB transfers */
2178 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2179
2180 /* template unsetup, if any */
2181 (usb_temp_unsetup_p) (udev);
2182
2183 /*
2184 * Make sure that our clear-stall messages are not queued
2185 * anywhere:
2186 */
2187 USB_BUS_LOCK(udev->bus);
2188 usb_proc_mwait(USB_BUS_NON_GIANT_PROC(udev->bus),
2189 &udev->cs_msg[0], &udev->cs_msg[1]);
2190 USB_BUS_UNLOCK(udev->bus);
2191
2192 /* wait for all references to go away */
2193 usb_wait_pending_refs(udev);
2194
2195 lockuninit(&udev->enum_lock);
2196 lockuninit(&udev->sr_lock);
2197
2198 cv_destroy(&udev->ctrlreq_cv);
2199 cv_destroy(&udev->ref_cv);
2200
2201 lockuninit(&udev->device_lock);
2202 #if USB_HAVE_UGEN
2203 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2204 #endif
2205
2206 /* Uninitialise device */
2207 if (bus->methods->device_uninit != NULL)
2208 (bus->methods->device_uninit) (udev);
2209
2210 /* free device */
2211 if(udev->serial)
2212 kfree(udev->serial, M_USB);
2213 if(udev->manufacturer)
2214 kfree(udev->manufacturer, M_USB);
2215 if(udev->product)
2216 kfree(udev->product, M_USB);
2217 kfree(udev, M_USB);
2218 }
2219
2220 /*------------------------------------------------------------------------*
2221 * usbd_get_iface
2222 *
2223 * This function is the safe way to get the USB interface structure
2224 * pointer by interface index.
2225 *
2226 * Return values:
2227 * NULL: Interface not present.
2228 * Else: Pointer to USB interface structure.
2229 *------------------------------------------------------------------------*/
2230 struct usb_interface *
usbd_get_iface(struct usb_device * udev,uint8_t iface_index)2231 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2232 {
2233 struct usb_interface *iface = udev->ifaces + iface_index;
2234
2235 if (iface_index >= udev->ifaces_max)
2236 return (NULL);
2237 return (iface);
2238 }
2239
2240 /*------------------------------------------------------------------------*
2241 * usbd_find_descriptor
2242 *
2243 * This function will lookup the first descriptor that matches the
2244 * criteria given by the arguments "type" and "subtype". Descriptors
2245 * will only be searched within the interface having the index
2246 * "iface_index". If the "id" argument points to an USB descriptor,
2247 * it will be skipped before the search is started. This allows
2248 * searching for multiple descriptors using the same criteria. Else
2249 * the search is started after the interface descriptor.
2250 *
2251 * Return values:
2252 * NULL: End of descriptors
2253 * Else: A descriptor matching the criteria
2254 *------------------------------------------------------------------------*/
2255 void *
usbd_find_descriptor(struct usb_device * udev,void * id,uint8_t iface_index,uint8_t type,uint8_t type_mask,uint8_t subtype,uint8_t subtype_mask)2256 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2257 uint8_t type, uint8_t type_mask,
2258 uint8_t subtype, uint8_t subtype_mask)
2259 {
2260 struct usb_descriptor *desc;
2261 struct usb_config_descriptor *cd;
2262 struct usb_interface *iface;
2263
2264 cd = usbd_get_config_descriptor(udev);
2265 if (cd == NULL) {
2266 return (NULL);
2267 }
2268 if (id == NULL) {
2269 iface = usbd_get_iface(udev, iface_index);
2270 if (iface == NULL) {
2271 return (NULL);
2272 }
2273 id = usbd_get_interface_descriptor(iface);
2274 if (id == NULL) {
2275 return (NULL);
2276 }
2277 }
2278 desc = (void *)id;
2279
2280 while ((desc = usb_desc_foreach(cd, desc))) {
2281
2282 if (desc->bDescriptorType == UDESC_INTERFACE) {
2283 break;
2284 }
2285 if (((desc->bDescriptorType & type_mask) == type) &&
2286 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2287 return (desc);
2288 }
2289 }
2290 return (NULL);
2291 }
2292
2293 /*------------------------------------------------------------------------*
2294 * usb_devinfo
2295 *
2296 * This function will dump information from the device descriptor
2297 * belonging to the USB device pointed to by "udev", to the string
2298 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2299 * including the terminating zero.
2300 *------------------------------------------------------------------------*/
2301 void
usb_devinfo(struct usb_device * udev,char * dst_ptr,uint16_t dst_len)2302 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2303 {
2304 struct usb_device_descriptor *udd = &udev->ddesc;
2305 uint16_t bcdDevice;
2306 uint16_t bcdUSB;
2307
2308 bcdUSB = UGETW(udd->bcdUSB);
2309 bcdDevice = UGETW(udd->bcdDevice);
2310
2311 if (udd->bDeviceClass != 0xFF) {
2312 ksnprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2313 "%x.%02x, addr %d",
2314 usb_get_manufacturer(udev),
2315 usb_get_product(udev),
2316 udd->bDeviceClass, udd->bDeviceSubClass,
2317 (bcdUSB >> 8), bcdUSB & 0xFF,
2318 (bcdDevice >> 8), bcdDevice & 0xFF,
2319 udev->address);
2320 } else {
2321 ksnprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2322 "%x.%02x, addr %d",
2323 usb_get_manufacturer(udev),
2324 usb_get_product(udev),
2325 (bcdUSB >> 8), bcdUSB & 0xFF,
2326 (bcdDevice >> 8), bcdDevice & 0xFF,
2327 udev->address);
2328 }
2329 }
2330
2331 #ifdef USB_VERBOSE
2332 /*
2333 * Descriptions of of known vendors and devices ("products").
2334 */
2335 struct usb_knowndev {
2336 uint16_t vendor;
2337 uint16_t product;
2338 uint32_t flags;
2339 const char *vendorname;
2340 const char *productname;
2341 };
2342
2343 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2344
2345 #include "usbdevs.h"
2346 #include "usbdevs_data.h"
2347 #endif /* USB_VERBOSE */
2348
2349 static void
usbd_set_device_strings(struct usb_device * udev)2350 usbd_set_device_strings(struct usb_device *udev)
2351 {
2352 struct usb_device_descriptor *udd = &udev->ddesc;
2353 #ifdef USB_VERBOSE
2354 const struct usb_knowndev *kdp;
2355 #endif
2356 char *temp_ptr;
2357 size_t temp_size;
2358 uint16_t vendor_id;
2359 uint16_t product_id;
2360 uint8_t do_unlock;
2361
2362 /* Protect scratch area */
2363 do_unlock = usbd_enum_lock(udev);
2364
2365 temp_ptr = (char *)udev->scratch.data;
2366 temp_size = sizeof(udev->scratch.data);
2367
2368 vendor_id = UGETW(udd->idVendor);
2369 product_id = UGETW(udd->idProduct);
2370
2371 /* get serial number string */
2372 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2373 udev->ddesc.iSerialNumber);
2374 udev->serial = kstrdup(temp_ptr, M_USB);
2375
2376 /* get manufacturer string */
2377 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2378 udev->ddesc.iManufacturer);
2379 usb_trim_spaces(temp_ptr);
2380 if (temp_ptr[0] != '\0')
2381 udev->manufacturer = kstrdup(temp_ptr, M_USB);
2382
2383 /* get product string */
2384 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2385 udev->ddesc.iProduct);
2386 usb_trim_spaces(temp_ptr);
2387 if (temp_ptr[0] != '\0')
2388 udev->product = kstrdup(temp_ptr, M_USB);
2389
2390 #ifdef USB_VERBOSE
2391 if (udev->manufacturer == NULL || udev->product == NULL) {
2392 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2393 if (kdp->vendor == vendor_id &&
2394 (kdp->product == product_id ||
2395 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2396 break;
2397 }
2398 if (kdp->vendorname != NULL) {
2399 /* XXX should use pointer to knowndevs string */
2400 if (udev->manufacturer == NULL) {
2401 udev->manufacturer = kstrdup(kdp->vendorname,
2402 M_USB);
2403 }
2404 if (udev->product == NULL &&
2405 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2406 udev->product = kstrdup(kdp->productname,
2407 M_USB);
2408 }
2409 }
2410 }
2411 #endif
2412 /* Provide default strings if none were found */
2413 if (udev->manufacturer == NULL) {
2414 ksnprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2415 udev->manufacturer = kstrdup(temp_ptr, M_USB);
2416 }
2417 if (udev->product == NULL) {
2418 ksnprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2419 udev->product = kstrdup(temp_ptr, M_USB);
2420 }
2421
2422 if (do_unlock)
2423 usbd_enum_unlock(udev);
2424 }
2425
2426 /*
2427 * Returns:
2428 * See: USB_MODE_XXX
2429 */
2430 enum usb_hc_mode
usbd_get_mode(struct usb_device * udev)2431 usbd_get_mode(struct usb_device *udev)
2432 {
2433 return (udev->flags.usb_mode);
2434 }
2435
2436 /*
2437 * Returns:
2438 * See: USB_SPEED_XXX
2439 */
2440 enum usb_dev_speed
usbd_get_speed(struct usb_device * udev)2441 usbd_get_speed(struct usb_device *udev)
2442 {
2443 return (udev->speed);
2444 }
2445
2446 uint32_t
usbd_get_isoc_fps(struct usb_device * udev)2447 usbd_get_isoc_fps(struct usb_device *udev)
2448 {
2449 ; /* indent fix */
2450 switch (udev->speed) {
2451 case USB_SPEED_LOW:
2452 case USB_SPEED_FULL:
2453 return (1000);
2454 default:
2455 return (8000);
2456 }
2457 }
2458
2459 struct usb_device_descriptor *
usbd_get_device_descriptor(struct usb_device * udev)2460 usbd_get_device_descriptor(struct usb_device *udev)
2461 {
2462 if (udev == NULL)
2463 return (NULL); /* be NULL safe */
2464 return (&udev->ddesc);
2465 }
2466
2467 struct usb_config_descriptor *
usbd_get_config_descriptor(struct usb_device * udev)2468 usbd_get_config_descriptor(struct usb_device *udev)
2469 {
2470 if (udev == NULL)
2471 return (NULL); /* be NULL safe */
2472 return (udev->cdesc);
2473 }
2474
2475 /*------------------------------------------------------------------------*
2476 * usb_test_quirk - test a device for a given quirk
2477 *
2478 * Return values:
2479 * 0: The USB device does not have the given quirk.
2480 * Else: The USB device has the given quirk.
2481 *------------------------------------------------------------------------*/
2482 uint8_t
usb_test_quirk(const struct usb_attach_arg * uaa,uint16_t quirk)2483 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2484 {
2485 uint8_t found;
2486 uint8_t x;
2487
2488 if (quirk == UQ_NONE)
2489 return (0);
2490
2491 /* search the automatic per device quirks first */
2492
2493 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2494 if (uaa->device->autoQuirk[x] == quirk)
2495 return (1);
2496 }
2497
2498 /* search global quirk table, if any */
2499
2500 found = (usb_test_quirk_p) (&uaa->info, quirk);
2501
2502 return (found);
2503 }
2504
2505 struct usb_interface_descriptor *
usbd_get_interface_descriptor(struct usb_interface * iface)2506 usbd_get_interface_descriptor(struct usb_interface *iface)
2507 {
2508 if (iface == NULL)
2509 return (NULL); /* be NULL safe */
2510 return (iface->idesc);
2511 }
2512
2513 uint8_t
usbd_get_interface_altindex(struct usb_interface * iface)2514 usbd_get_interface_altindex(struct usb_interface *iface)
2515 {
2516 return (iface->alt_index);
2517 }
2518
2519 uint8_t
usbd_get_bus_index(struct usb_device * udev)2520 usbd_get_bus_index(struct usb_device *udev)
2521 {
2522 return ((uint8_t)device_get_unit(udev->bus->bdev));
2523 }
2524
2525 uint8_t
usbd_get_device_index(struct usb_device * udev)2526 usbd_get_device_index(struct usb_device *udev)
2527 {
2528 return (udev->device_index);
2529 }
2530
2531 #if USB_HAVE_DEVCTL
2532 static void
usb_notify_addq(const char * type,struct usb_device * udev)2533 usb_notify_addq(const char *type, struct usb_device *udev)
2534 {
2535 struct usb_interface *iface;
2536 struct sbuf *sb;
2537 int i;
2538
2539 /* announce the device */
2540 sb = sbuf_new(NULL, NULL, 4096, SBUF_AUTOEXTEND);
2541 sbuf_printf(sb,
2542 #if USB_HAVE_UGEN
2543 "ugen=%s "
2544 "cdev=%s "
2545 #endif
2546 "vendor=0x%04x "
2547 "product=0x%04x "
2548 "devclass=0x%02x "
2549 "devsubclass=0x%02x "
2550 "sernum=\"%s\" "
2551 "release=0x%04x "
2552 "mode=%s "
2553 "port=%u "
2554 #if USB_HAVE_UGEN
2555 "parent=%s"
2556 #endif
2557 "",
2558 #if USB_HAVE_UGEN
2559 udev->ugen_name,
2560 udev->ugen_name,
2561 #endif
2562 UGETW(udev->ddesc.idVendor),
2563 UGETW(udev->ddesc.idProduct),
2564 udev->ddesc.bDeviceClass,
2565 udev->ddesc.bDeviceSubClass,
2566 usb_get_serial(udev),
2567 UGETW(udev->ddesc.bcdDevice),
2568 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2569 udev->port_no
2570 #if USB_HAVE_UGEN
2571 , udev->parent_hub != NULL ?
2572 udev->parent_hub->ugen_name :
2573 device_get_nameunit(device_get_parent(udev->bus->bdev))
2574 #endif
2575 );
2576 sbuf_finish(sb);
2577 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2578 sbuf_delete(sb);
2579
2580 /* announce each interface */
2581 for (i = 0; i < USB_IFACE_MAX; i++) {
2582 iface = usbd_get_iface(udev, i);
2583 if (iface == NULL)
2584 break; /* end of interfaces */
2585 if (iface->idesc == NULL)
2586 continue; /* no interface descriptor */
2587
2588 sb = NULL;
2589 sb = sbuf_new(NULL, NULL, 4096, SBUF_AUTOEXTEND);
2590 sbuf_printf(sb,
2591 #if USB_HAVE_UGEN
2592 "ugen=%s "
2593 "cdev=%s "
2594 #endif
2595 "vendor=0x%04x "
2596 "product=0x%04x "
2597 "devclass=0x%02x "
2598 "devsubclass=0x%02x "
2599 "sernum=\"%s\" "
2600 "release=0x%04x "
2601 "mode=%s "
2602 "interface=%d "
2603 "endpoints=%d "
2604 "intclass=0x%02x "
2605 "intsubclass=0x%02x "
2606 "intprotocol=0x%02x",
2607 #if USB_HAVE_UGEN
2608 udev->ugen_name,
2609 udev->ugen_name,
2610 #endif
2611 UGETW(udev->ddesc.idVendor),
2612 UGETW(udev->ddesc.idProduct),
2613 udev->ddesc.bDeviceClass,
2614 udev->ddesc.bDeviceSubClass,
2615 usb_get_serial(udev),
2616 UGETW(udev->ddesc.bcdDevice),
2617 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2618 iface->idesc->bInterfaceNumber,
2619 iface->idesc->bNumEndpoints,
2620 iface->idesc->bInterfaceClass,
2621 iface->idesc->bInterfaceSubClass,
2622 iface->idesc->bInterfaceProtocol);
2623 sbuf_finish(sb);
2624 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2625 sbuf_delete(sb);
2626 }
2627 }
2628 #endif
2629
2630 #if USB_HAVE_UGEN
2631 /*------------------------------------------------------------------------*
2632 * usb_fifo_free_wrap
2633 *
2634 * This function will free the FIFOs.
2635 *
2636 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2637 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2638 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2639 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2640 * control endpoint FIFOs. If "iface_index" is not set to
2641 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2642 *------------------------------------------------------------------------*/
2643 static void
usb_fifo_free_wrap(struct usb_device * udev,uint8_t iface_index,uint8_t flag)2644 usb_fifo_free_wrap(struct usb_device *udev,
2645 uint8_t iface_index, uint8_t flag)
2646 {
2647 struct usb_fifo *f;
2648 uint16_t i;
2649
2650 /*
2651 * Free any USB FIFOs on the given interface:
2652 */
2653 for (i = 0; i != USB_FIFO_MAX; i++) {
2654 f = udev->fifo[i];
2655 if (f == NULL) {
2656 continue;
2657 }
2658 /* Check if the interface index matches */
2659 if (iface_index == f->iface_index) {
2660 if (f->methods != &usb_ugen_methods) {
2661 /*
2662 * Don't free any non-generic FIFOs in
2663 * this case.
2664 */
2665 continue;
2666 }
2667 if ((f->dev_ep_index == 0) &&
2668 (f->fs_xfer == NULL)) {
2669 /* no need to free this FIFO */
2670 continue;
2671 }
2672 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2673 if ((f->methods == &usb_ugen_methods) &&
2674 (f->dev_ep_index == 0) &&
2675 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2676 (f->fs_xfer == NULL)) {
2677 /* no need to free this FIFO */
2678 continue;
2679 }
2680 } else {
2681 /* no need to free this FIFO */
2682 continue;
2683 }
2684 /* free this FIFO */
2685 usb_fifo_free(f);
2686 }
2687 }
2688 #endif
2689
2690 /*------------------------------------------------------------------------*
2691 * usb_peer_can_wakeup
2692 *
2693 * Return values:
2694 * 0: Peer cannot do resume signalling.
2695 * Else: Peer can do resume signalling.
2696 *------------------------------------------------------------------------*/
2697 uint8_t
usb_peer_can_wakeup(struct usb_device * udev)2698 usb_peer_can_wakeup(struct usb_device *udev)
2699 {
2700 const struct usb_config_descriptor *cdp;
2701
2702 cdp = udev->cdesc;
2703 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2704 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2705 }
2706 return (0); /* not supported */
2707 }
2708
2709 void
usb_set_device_state(struct usb_device * udev,enum usb_dev_state state)2710 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2711 {
2712
2713 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2714
2715 DPRINTF("udev %p state %s -> %s\n", udev,
2716 usb_statestr(udev->state), usb_statestr(state));
2717
2718 #if USB_HAVE_UGEN
2719 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
2720 #endif
2721 udev->state = state;
2722 #if USB_HAVE_UGEN
2723 lockmgr(&usb_ref_lock, LK_RELEASE);
2724 #endif
2725 if (udev->bus->methods->device_state_change != NULL)
2726 (udev->bus->methods->device_state_change) (udev);
2727 }
2728
2729 enum usb_dev_state
usb_get_device_state(struct usb_device * udev)2730 usb_get_device_state(struct usb_device *udev)
2731 {
2732 if (udev == NULL)
2733 return (USB_STATE_DETACHED);
2734 return (udev->state);
2735 }
2736
2737 uint8_t
usbd_device_attached(struct usb_device * udev)2738 usbd_device_attached(struct usb_device *udev)
2739 {
2740 return (udev->state > USB_STATE_DETACHED);
2741 }
2742
2743 /*
2744 * The following function locks enumerating the given USB device. If
2745 * the lock is already grabbed this function returns zero. Else a
2746 * non-zero value is returned.
2747 */
2748 uint8_t
usbd_enum_lock(struct usb_device * udev)2749 usbd_enum_lock(struct usb_device *udev)
2750 {
2751 if (lockstatus(&udev->enum_lock, curthread)==LK_EXCLUSIVE)
2752 return (0);
2753
2754 lockmgr(&udev->enum_lock, LK_EXCLUSIVE);
2755 lockmgr(&udev->sr_lock, LK_EXCLUSIVE);
2756 /*
2757 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2758 * are locked before locking Giant. Else the lock can be
2759 * locked multiple times.
2760 */
2761 return (1);
2762 }
2763
2764 /* The following function unlocks enumerating the given USB device. */
2765
2766 void
usbd_enum_unlock(struct usb_device * udev)2767 usbd_enum_unlock(struct usb_device *udev)
2768 {
2769 lockmgr(&udev->enum_lock, LK_RELEASE);
2770 lockmgr(&udev->sr_lock, LK_RELEASE);
2771 }
2772
2773 /* The following function locks suspend and resume. */
2774
2775 void
usbd_sr_lock(struct usb_device * udev)2776 usbd_sr_lock(struct usb_device *udev)
2777 {
2778 lockmgr(&udev->sr_lock, LK_EXCLUSIVE);
2779 /*
2780 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2781 * are locked before locking Giant. Else the lock can be
2782 * locked multiple times.
2783 */
2784 }
2785
2786 /* The following function unlocks suspend and resume. */
2787
2788 void
usbd_sr_unlock(struct usb_device * udev)2789 usbd_sr_unlock(struct usb_device *udev)
2790 {
2791 lockmgr(&udev->sr_lock, LK_RELEASE);
2792 }
2793
2794 /*
2795 * The following function checks the enumerating lock for the given
2796 * USB device.
2797 */
2798
2799 uint8_t
usbd_enum_is_locked(struct usb_device * udev)2800 usbd_enum_is_locked(struct usb_device *udev)
2801 {
2802 /* XXX: Make sure that we return a correct value here */
2803 return (lockowned(&udev->enum_lock));
2804 }
2805
2806 /*
2807 * The following function is used to set the per-interface specific
2808 * plug and play information. The string referred to by the pnpinfo
2809 * argument can safely be freed after calling this function. The
2810 * pnpinfo of an interface will be reset at device detach or when
2811 * passing a NULL argument to this function. This function
2812 * returns zero on success, else a USB_ERR_XXX failure code.
2813 */
2814
2815 usb_error_t
usbd_set_pnpinfo(struct usb_device * udev,uint8_t iface_index,const char * pnpinfo)2816 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2817 {
2818 struct usb_interface *iface;
2819
2820 iface = usbd_get_iface(udev, iface_index);
2821 if (iface == NULL)
2822 return (USB_ERR_INVAL);
2823
2824 if (iface->pnpinfo != NULL) {
2825 kfree(iface->pnpinfo, M_USBDEV);
2826 iface->pnpinfo = NULL;
2827 }
2828
2829 if (pnpinfo == NULL || pnpinfo[0] == 0)
2830 return (0); /* success */
2831
2832 iface->pnpinfo = kstrdup(pnpinfo, M_USBDEV);
2833 if (iface->pnpinfo == NULL)
2834 return (USB_ERR_NOMEM);
2835
2836 return (0); /* success */
2837 }
2838
2839 usb_error_t
usbd_add_dynamic_quirk(struct usb_device * udev,uint16_t quirk)2840 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2841 {
2842 uint8_t x;
2843
2844 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2845 if (udev->autoQuirk[x] == 0 ||
2846 udev->autoQuirk[x] == quirk) {
2847 udev->autoQuirk[x] = quirk;
2848 return (0); /* success */
2849 }
2850 }
2851 return (USB_ERR_NOMEM);
2852 }
2853
2854 /*
2855 * The following function is used to select the endpoint mode. It
2856 * should not be called outside enumeration context.
2857 */
2858
2859 usb_error_t
usbd_set_endpoint_mode(struct usb_device * udev,struct usb_endpoint * ep,uint8_t ep_mode)2860 usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep,
2861 uint8_t ep_mode)
2862 {
2863 usb_error_t error;
2864 uint8_t do_unlock;
2865
2866 /* Prevent re-enumeration */
2867 do_unlock = usbd_enum_lock(udev);
2868
2869 if (udev->bus->methods->set_endpoint_mode != NULL) {
2870 error = (udev->bus->methods->set_endpoint_mode) (
2871 udev, ep, ep_mode);
2872 } else if (ep_mode != USB_EP_MODE_DEFAULT) {
2873 error = USB_ERR_INVAL;
2874 } else {
2875 error = 0;
2876 }
2877
2878 /* only set new mode regardless of error */
2879 ep->ep_mode = ep_mode;
2880
2881 if (do_unlock)
2882 usbd_enum_unlock(udev);
2883 return (error);
2884 }
2885
2886 uint8_t
usbd_get_endpoint_mode(struct usb_device * udev,struct usb_endpoint * ep)2887 usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep)
2888 {
2889 return (ep->ep_mode);
2890 }
2891