3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/stdint.h>
28 #include <sys/stddef.h>
29 #include <sys/param.h>
30 #include <sys/queue.h>
31 #include <sys/types.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/condvar.h>
39 #include <sys/sysctl.h>
41 #include <sys/unistd.h>
42 #include <sys/callout.h>
43 #include <sys/malloc.h>
46 #include <sys/fcntl.h>
48 #include <dev/usb/usb.h>
49 #include <dev/usb/usbdi.h>
50 #include <dev/usb/usbdi_util.h>
51 #include <dev/usb/usb_ioctl.h>
59 #define USB_DEBUG_VAR usb_debug
61 #include <dev/usb/usb_core.h>
62 #include <dev/usb/usb_debug.h>
63 #include <dev/usb/usb_process.h>
64 #include <dev/usb/usb_device.h>
65 #include <dev/usb/usb_busdma.h>
66 #include <dev/usb/usb_transfer.h>
67 #include <dev/usb/usb_request.h>
68 #include <dev/usb/usb_dynamic.h>
69 #include <dev/usb/usb_hub.h>
70 #include <dev/usb/usb_util.h>
71 #include <dev/usb/usb_msctest.h>
73 #include <dev/usb/usb_dev.h>
74 #include <dev/usb/usb_generic.h>
77 #include <dev/usb/quirk/usb_quirk.h>
79 #include <dev/usb/usb_controller.h>
80 #include <dev/usb/usb_bus.h>
82 /* function prototypes */
84 static void usb_init_endpoint(struct usb_device *, uint8_t,
85 struct usb_endpoint_descriptor *,
86 struct usb_endpoint_ss_comp_descriptor *,
87 struct usb_endpoint *);
88 static void usb_unconfigure(struct usb_device *, uint8_t);
89 static void usb_detach_device_sub(struct usb_device *, device_t *,
91 static uint8_t usb_probe_and_attach_sub(struct usb_device *,
92 struct usb_attach_arg *);
93 static void usb_init_attach_arg(struct usb_device *,
94 struct usb_attach_arg *);
95 static void usb_suspend_resume_sub(struct usb_device *, device_t,
97 static usb_proc_callback_t usbd_clear_stall_proc;
98 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
99 static void usbd_set_device_strings(struct usb_device *);
101 static void usb_notify_addq(const char *type, struct usb_device *);
104 static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
105 static void usb_cdev_create(struct usb_device *);
106 static void usb_cdev_free(struct usb_device *);
109 /* This variable is global to allow easy access to it: */
111 int usb_template = 0;
113 TUNABLE_INT("hw.usb.usb_template", &usb_template);
114 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW | CTLFLAG_TUN,
115 &usb_template, 0, "Selected USB device side template");
117 /* English is default language */
119 static int usb_lang_id = 0x0009;
120 static int usb_lang_mask = 0x00FF;
122 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
123 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW | CTLFLAG_TUN,
124 &usb_lang_id, 0, "Preferred USB language ID");
126 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
127 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW | CTLFLAG_TUN,
128 &usb_lang_mask, 0, "Preferred USB language mask");
130 static const char* statestr[USB_STATE_MAX] = {
131 [USB_STATE_DETACHED] = "DETACHED",
132 [USB_STATE_ATTACHED] = "ATTACHED",
133 [USB_STATE_POWERED] = "POWERED",
134 [USB_STATE_ADDRESSED] = "ADDRESSED",
135 [USB_STATE_CONFIGURED] = "CONFIGURED",
139 usb_statestr(enum usb_dev_state state)
141 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
145 usb_get_manufacturer(struct usb_device *udev)
147 return (udev->manufacturer ? udev->manufacturer : "Unknown");
151 usb_get_product(struct usb_device *udev)
153 return (udev->product ? udev->product : "");
157 usb_get_serial(struct usb_device *udev)
159 return (udev->serial ? udev->serial : "");
162 /*------------------------------------------------------------------------*
163 * usbd_get_ep_by_addr
165 * This function searches for an USB ep by endpoint address and
171 *------------------------------------------------------------------------*/
172 struct usb_endpoint *
173 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
175 struct usb_endpoint *ep = udev->endpoints;
176 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
178 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
182 * According to the USB specification not all bits are used
183 * for the endpoint address. Keep defined bits only:
188 * Iterate accross all the USB endpoints searching for a match
189 * based on the endpoint address:
191 for (; ep != ep_end; ep++) {
193 if (ep->edesc == NULL) {
196 /* do the mask and check the value */
197 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
203 * The default endpoint is always present and is checked separately:
205 if ((udev->ctrl_ep.edesc) &&
206 ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
216 /*------------------------------------------------------------------------*
219 * This function searches for an USB endpoint based on the information
220 * given by the passed "struct usb_config" pointer.
224 * Else: Pointer to "struct usb_endpoint".
225 *------------------------------------------------------------------------*/
226 struct usb_endpoint *
227 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
228 const struct usb_config *setup)
230 struct usb_endpoint *ep = udev->endpoints;
231 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
232 uint8_t index = setup->ep_index;
238 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
239 "type=0x%x dir=0x%x index=%d\n",
240 udev, iface_index, setup->endpoint,
241 setup->type, setup->direction, setup->ep_index);
245 if (setup->usb_mode != USB_MODE_DUAL &&
246 udev->flags.usb_mode != setup->usb_mode) {
247 /* wrong mode - no endpoint */
251 /* setup expected endpoint direction mask and value */
253 if (setup->direction == UE_DIR_RX) {
254 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
255 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
256 UE_DIR_OUT : UE_DIR_IN;
257 } else if (setup->direction == UE_DIR_TX) {
258 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
259 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
260 UE_DIR_IN : UE_DIR_OUT;
261 } else if (setup->direction == UE_DIR_ANY) {
262 /* match any endpoint direction */
266 /* match the given endpoint direction */
267 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
268 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
271 /* setup expected endpoint address */
273 if (setup->endpoint == UE_ADDR_ANY) {
274 /* match any endpoint address */
276 /* match the given endpoint address */
278 ea_val |= (setup->endpoint & UE_ADDR);
281 /* setup expected endpoint type */
283 if (setup->type == UE_BULK_INTR) {
284 /* this will match BULK and INTERRUPT endpoints */
287 } else if (setup->type == UE_TYPE_ANY) {
288 /* match any endpoint type */
292 /* match the given endpoint type */
293 type_mask = UE_XFERTYPE;
294 type_val = (setup->type & UE_XFERTYPE);
298 * Iterate accross all the USB endpoints searching for a match
299 * based on the endpoint address. Note that we are searching
300 * the endpoints from the beginning of the "udev->endpoints" array.
302 for (; ep != ep_end; ep++) {
304 if ((ep->edesc == NULL) ||
305 (ep->iface_index != iface_index)) {
308 /* do the masks and check the values */
310 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
311 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
319 * Match against default endpoint last, so that "any endpoint", "any
320 * address" and "any direction" returns the first endpoint of the
321 * interface. "iface_index" and "direction" is ignored:
323 if ((udev->ctrl_ep.edesc) &&
324 ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
325 ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
336 /*------------------------------------------------------------------------*
337 * usbd_interface_count
339 * This function stores the number of USB interfaces excluding
340 * alternate settings, which the USB config descriptor reports into
341 * the unsigned 8-bit integer pointed to by "count".
346 *------------------------------------------------------------------------*/
348 usbd_interface_count(struct usb_device *udev, uint8_t *count)
350 if (udev->cdesc == NULL) {
352 return (USB_ERR_NOT_CONFIGURED);
354 *count = udev->ifaces_max;
355 return (USB_ERR_NORMAL_COMPLETION);
359 /*------------------------------------------------------------------------*
362 * This function will initialise the USB endpoint structure pointed to by
363 * the "endpoint" argument. The structure pointed to by "endpoint" must be
364 * zeroed before calling this function.
365 *------------------------------------------------------------------------*/
367 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
368 struct usb_endpoint_descriptor *edesc,
369 struct usb_endpoint_ss_comp_descriptor *ecomp,
370 struct usb_endpoint *ep)
372 struct usb_bus_methods *methods;
374 methods = udev->bus->methods;
376 (methods->endpoint_init) (udev, edesc, ep);
378 /* initialise USB endpoint structure */
381 ep->iface_index = iface_index;
382 TAILQ_INIT(&ep->endpoint_q.head);
383 ep->endpoint_q.command = &usbd_pipe_start;
385 /* the pipe is not supported by the hardware */
386 if (ep->methods == NULL)
389 /* clear stall, if any */
390 if (methods->clear_stall != NULL) {
391 USB_BUS_LOCK(udev->bus);
392 (methods->clear_stall) (udev, ep);
393 USB_BUS_UNLOCK(udev->bus);
397 /*-----------------------------------------------------------------------*
398 * usb_endpoint_foreach
400 * This function will iterate all the USB endpoints except the control
401 * endpoint. This function is NULL safe.
404 * NULL: End of USB endpoints
405 * Else: Pointer to next USB endpoint
406 *------------------------------------------------------------------------*/
407 struct usb_endpoint *
408 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
410 struct usb_endpoint *ep_end;
416 ep_end = udev->endpoints + udev->endpoints_max;
418 /* get next endpoint */
420 ep = udev->endpoints;
424 /* find next allocated ep */
425 while (ep != ep_end) {
426 if (ep->edesc != NULL)
433 /*------------------------------------------------------------------------*
434 * usb_wait_pending_refs
436 * This function will wait for any USB references to go away before
437 * returning. This function is used before freeing a USB device.
438 *------------------------------------------------------------------------*/
440 usb_wait_pending_refs(struct usb_device *udev)
443 DPRINTF("Refcount = %d\n", (int)udev->refcount);
445 mtx_lock(&usb_ref_lock);
448 /* wait for any pending references to go away */
449 if (udev->refcount == 0) {
450 /* prevent further refs being taken, if any */
451 udev->refcount = USB_DEV_REF_MAX;
454 cv_wait(&udev->ref_cv, &usb_ref_lock);
456 mtx_unlock(&usb_ref_lock);
460 /*------------------------------------------------------------------------*
463 * This function will free all USB interfaces and USB endpoints belonging
466 * Flag values, see "USB_UNCFG_FLAG_XXX".
467 *------------------------------------------------------------------------*/
469 usb_unconfigure(struct usb_device *udev, uint8_t flag)
473 /* Prevent re-enumeration */
474 do_unlock = usbd_enum_lock(udev);
476 /* detach all interface drivers */
477 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
480 /* free all FIFOs except control endpoint FIFOs */
481 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
484 * Free all cdev's, if any.
489 #if USB_HAVE_COMPAT_LINUX
490 /* free Linux compat device, if any */
491 if (udev->linux_endpoint_start) {
492 usb_linux_free_device(udev);
493 udev->linux_endpoint_start = NULL;
497 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
499 /* free "cdesc" after "ifaces" and "endpoints", if any */
500 if (udev->cdesc != NULL) {
501 if (udev->flags.usb_mode != USB_MODE_DEVICE)
502 free(udev->cdesc, M_USB);
505 /* set unconfigured state */
506 udev->curr_config_no = USB_UNCONFIG_NO;
507 udev->curr_config_index = USB_UNCONFIG_INDEX;
510 usbd_enum_unlock(udev);
513 /*------------------------------------------------------------------------*
514 * usbd_set_config_index
516 * This function selects configuration by index, independent of the
517 * actual configuration number. This function should not be used by
523 *------------------------------------------------------------------------*/
525 usbd_set_config_index(struct usb_device *udev, uint8_t index)
527 struct usb_status ds;
528 struct usb_config_descriptor *cdp;
535 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
537 /* Prevent re-enumeration */
538 do_unlock = usbd_enum_lock(udev);
540 usb_unconfigure(udev, 0);
542 if (index == USB_UNCONFIG_INDEX) {
544 * Leave unallocated when unconfiguring the
545 * device. "usb_unconfigure()" will also reset
546 * the current config number and index.
548 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
549 if (udev->state == USB_STATE_CONFIGURED)
550 usb_set_device_state(udev, USB_STATE_ADDRESSED);
553 /* get the full config descriptor */
554 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
555 /* save some memory */
556 err = usbd_req_get_descriptor_ptr(udev, &cdp,
557 (UDESC_CONFIG << 8) | index);
560 err = usbd_req_get_config_desc_full(udev,
561 NULL, &cdp, M_USB, index);
566 /* set the new config descriptor */
570 /* Figure out if the device is self or bus powered. */
572 if ((!udev->flags.uq_bus_powered) &&
573 (cdp->bmAttributes & UC_SELF_POWERED) &&
574 (udev->flags.usb_mode == USB_MODE_HOST)) {
575 /* May be self powered. */
576 if (cdp->bmAttributes & UC_BUS_POWERED) {
577 /* Must ask device. */
578 err = usbd_req_get_device_status(udev, NULL, &ds);
580 DPRINTFN(0, "could not read "
581 "device status: %s\n",
583 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
586 DPRINTF("status=0x%04x \n",
591 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
592 "selfpowered=%d, power=%d\n",
594 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
595 selfpowered, cdp->bMaxPower * 2);
597 /* Check if we have enough power. */
598 power = cdp->bMaxPower * 2;
600 if (udev->parent_hub) {
601 max_power = udev->parent_hub->hub->portpower;
603 max_power = USB_MAX_POWER;
606 if (power > max_power) {
607 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
608 err = USB_ERR_NO_POWER;
611 /* Only update "self_powered" in USB Host Mode */
612 if (udev->flags.usb_mode == USB_MODE_HOST) {
613 udev->flags.self_powered = selfpowered;
616 udev->curr_config_no = cdp->bConfigurationValue;
617 udev->curr_config_index = index;
618 usb_set_device_state(udev, USB_STATE_CONFIGURED);
620 /* Set the actual configuration value. */
621 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
626 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
631 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
637 /* create device nodes for each endpoint */
638 usb_cdev_create(udev);
642 DPRINTF("error=%s\n", usbd_errstr(err));
644 usb_unconfigure(udev, 0);
647 usbd_enum_unlock(udev);
651 /*------------------------------------------------------------------------*
654 * This function will allocate and free USB interfaces and USB endpoints,
655 * parse the USB configuration structure and initialise the USB endpoints
656 * and interfaces. If "iface_index" is not equal to
657 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
658 * alternate_setting to be selected for the given interface. Else the
659 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
660 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
661 * is typically called when setting the configuration or when setting
662 * an alternate interface.
667 *------------------------------------------------------------------------*/
669 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
671 struct usb_idesc_parse_state ips;
672 struct usb_interface_descriptor *id;
673 struct usb_endpoint_descriptor *ed;
674 struct usb_interface *iface;
675 struct usb_endpoint *ep;
683 if (iface_index != USB_IFACE_INDEX_ANY) {
684 /* parameter overload */
694 DPRINTFN(5, "iface_index=%d cmd=%d\n",
697 if (cmd == USB_CFG_FREE)
700 if (cmd == USB_CFG_INIT) {
701 sx_assert(&udev->enum_sx, SA_LOCKED);
703 /* check for in-use endpoints */
705 ep = udev->endpoints;
706 ep_max = udev->endpoints_max;
708 /* look for matching endpoints */
709 if ((iface_index == USB_IFACE_INDEX_ANY) ||
710 (iface_index == ep->iface_index)) {
711 if (ep->refcount_alloc != 0) {
713 * This typically indicates a
714 * more serious error.
716 err = USB_ERR_IN_USE;
719 memset(ep, 0, sizeof(*ep));
720 /* make sure we don't zero the endpoint again */
721 ep->iface_index = USB_IFACE_INDEX_ANY;
731 memset(&ips, 0, sizeof(ips));
736 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
738 /* check for interface overflow */
739 if (ips.iface_index == USB_IFACE_MAX)
742 iface = udev->ifaces + ips.iface_index;
744 /* check for specific interface match */
746 if (cmd == USB_CFG_INIT) {
747 if ((iface_index != USB_IFACE_INDEX_ANY) &&
748 (iface_index != ips.iface_index)) {
749 /* wrong interface */
751 } else if (alt_index != ips.iface_index_alt) {
752 /* wrong alternate setting */
755 /* initialise interface */
761 /* check for new interface */
762 if (ips.iface_index_alt == 0) {
763 /* update current number of endpoints */
768 /* setup the USB interface structure */
770 /* set alternate index */
771 iface->alt_index = alt_index;
772 /* set default interface parent */
773 if (iface_index == USB_IFACE_INDEX_ANY) {
774 iface->parent_iface_index =
779 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
781 ed = (struct usb_endpoint_descriptor *)id;
785 /* iterate all the endpoint descriptors */
786 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
788 if (temp == USB_EP_MAX)
791 ep = udev->endpoints + temp;
796 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
798 DPRINTFN(5, "Found endpoint companion descriptor\n");
800 usb_init_endpoint(udev,
801 ips.iface_index, ed, ecomp, ep);
806 /* find maximum number of endpoints */
812 /* NOTE: It is valid to have no interfaces and no endpoints! */
814 if (cmd == USB_CFG_ALLOC) {
815 udev->ifaces_max = ips.iface_index;
817 if (udev->ifaces_max != 0) {
818 udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max,
819 M_USB, M_WAITOK | M_ZERO);
820 if (udev->ifaces == NULL) {
826 udev->endpoints = malloc(sizeof(*ep) * ep_max,
827 M_USB, M_WAITOK | M_ZERO);
828 if (udev->endpoints == NULL) {
833 udev->endpoints = NULL;
835 USB_BUS_LOCK(udev->bus);
836 udev->endpoints_max = ep_max;
837 /* reset any ongoing clear-stall */
838 udev->ep_curr = NULL;
839 USB_BUS_UNLOCK(udev->bus);
844 if (cmd == USB_CFG_ALLOC) {
846 USB_BUS_LOCK(udev->bus);
847 udev->endpoints_max = 0;
848 /* reset any ongoing clear-stall */
849 udev->ep_curr = NULL;
850 USB_BUS_UNLOCK(udev->bus);
853 if (udev->ifaces != NULL)
854 free(udev->ifaces, M_USB);
855 if (udev->endpoints != NULL)
856 free(udev->endpoints, M_USB);
859 udev->endpoints = NULL;
860 udev->ifaces_max = 0;
866 /*------------------------------------------------------------------------*
867 * usbd_set_alt_interface_index
869 * This function will select an alternate interface index for the
870 * given interface index. The interface should not be in use when this
871 * function is called. That means there should not be any open USB
872 * transfers. Else an error is returned. If the alternate setting is
873 * already set this function will simply return success. This function
874 * is called in Host mode and Device mode!
879 *------------------------------------------------------------------------*/
881 usbd_set_alt_interface_index(struct usb_device *udev,
882 uint8_t iface_index, uint8_t alt_index)
884 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
888 /* Prevent re-enumeration */
889 do_unlock = usbd_enum_lock(udev);
895 if (iface->alt_index == alt_index) {
897 * Optimise away duplicate setting of
898 * alternate setting in USB Host Mode!
905 * Free all generic FIFOs for this interface, except control
908 usb_fifo_free_wrap(udev, iface_index, 0);
911 err = usb_config_parse(udev, iface_index, alt_index);
915 if (iface->alt_index != alt_index) {
916 /* the alternate setting does not exist */
921 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
922 iface->idesc->bAlternateSetting);
926 usbd_enum_unlock(udev);
930 /*------------------------------------------------------------------------*
931 * usbd_set_endpoint_stall
933 * This function is used to make a BULK or INTERRUPT endpoint send
934 * STALL tokens in USB device mode.
939 *------------------------------------------------------------------------*/
941 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
944 struct usb_xfer *xfer;
950 DPRINTF("Cannot find endpoint\n");
952 * Pretend that the clear or set stall request is
953 * successful else some USB host stacks can do
954 * strange things, especially when a control endpoint
959 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
961 if ((et != UE_BULK) &&
962 (et != UE_INTERRUPT)) {
964 * Should not stall control
965 * nor isochronous endpoints.
967 DPRINTF("Invalid endpoint\n");
970 USB_BUS_LOCK(udev->bus);
972 /* store current stall state */
973 was_stalled = ep->is_stalled;
975 /* check for no change */
976 if (was_stalled && do_stall) {
977 /* if the endpoint is already stalled do nothing */
978 USB_BUS_UNLOCK(udev->bus);
979 DPRINTF("No change\n");
982 /* set stalled state */
985 if (do_stall || (!was_stalled)) {
987 /* lookup the current USB transfer, if any */
988 xfer = ep->endpoint_q.curr;
994 * If "xfer" is non-NULL the "set_stall" method will
995 * complete the USB transfer like in case of a timeout
996 * setting the error code "USB_ERR_STALLED".
998 (udev->bus->methods->set_stall) (udev, xfer, ep, &do_stall);
1001 ep->toggle_next = 0; /* reset data toggle */
1002 ep->is_stalled = 0; /* clear stalled state */
1004 (udev->bus->methods->clear_stall) (udev, ep);
1006 /* start up the current or next transfer, if any */
1007 usb_command_wrapper(&ep->endpoint_q, ep->endpoint_q.curr);
1009 USB_BUS_UNLOCK(udev->bus);
1013 /*------------------------------------------------------------------------*
1014 * usb_reset_iface_endpoints - used in USB device side mode
1015 *------------------------------------------------------------------------*/
1017 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1019 struct usb_endpoint *ep;
1020 struct usb_endpoint *ep_end;
1022 ep = udev->endpoints;
1023 ep_end = udev->endpoints + udev->endpoints_max;
1025 for (; ep != ep_end; ep++) {
1027 if ((ep->edesc == NULL) ||
1028 (ep->iface_index != iface_index)) {
1031 /* simulate a clear stall from the peer */
1032 usbd_set_endpoint_stall(udev, ep, 0);
1037 /*------------------------------------------------------------------------*
1038 * usb_detach_device_sub
1040 * This function will try to detach an USB device. If it fails a panic
1043 * Flag values, see "USB_UNCFG_FLAG_XXX".
1044 *------------------------------------------------------------------------*/
1046 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1047 char **ppnpinfo, uint8_t flag)
1056 * NOTE: It is important to clear "*ppdev" before deleting
1057 * the child due to some device methods being called late
1058 * during the delete process !
1063 device_printf(dev, "at %s, port %d, addr %d "
1065 device_get_nameunit(udev->parent_dev),
1066 udev->port_no, udev->address);
1069 if (device_is_attached(dev)) {
1070 if (udev->flags.peer_suspended) {
1071 err = DEVICE_RESUME(dev);
1073 device_printf(dev, "Resume failed\n");
1077 /* detach and delete child */
1078 if (device_delete_child(udev->parent_dev, dev)) {
1083 pnpinfo = *ppnpinfo;
1084 if (pnpinfo != NULL) {
1086 free(pnpinfo, M_USBDEV);
1091 /* Detach is not allowed to fail in the USB world */
1092 panic("usb_detach_device_sub: A USB driver would not detach\n");
1095 /*------------------------------------------------------------------------*
1098 * The following function will detach the matching interfaces.
1099 * This function is NULL safe.
1101 * Flag values, see "USB_UNCFG_FLAG_XXX".
1102 *------------------------------------------------------------------------*/
1104 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1107 struct usb_interface *iface;
1114 DPRINTFN(4, "udev=%p\n", udev);
1116 sx_assert(&udev->enum_sx, SA_LOCKED);
1119 * First detach the child to give the child's detach routine a
1120 * chance to detach the sub-devices in the correct order.
1121 * Then delete the child using "device_delete_child()" which
1122 * will detach all sub-devices from the bottom and upwards!
1124 if (iface_index != USB_IFACE_INDEX_ANY) {
1126 iface_index = i + 1;
1129 iface_index = USB_IFACE_MAX;
1134 for (; i != iface_index; i++) {
1136 iface = usbd_get_iface(udev, i);
1137 if (iface == NULL) {
1138 /* looks like the end of the USB interfaces */
1141 usb_detach_device_sub(udev, &iface->subdev,
1142 &iface->pnpinfo, flag);
1146 /*------------------------------------------------------------------------*
1147 * usb_probe_and_attach_sub
1152 *------------------------------------------------------------------------*/
1154 usb_probe_and_attach_sub(struct usb_device *udev,
1155 struct usb_attach_arg *uaa)
1157 struct usb_interface *iface;
1162 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1163 /* leave interface alone */
1166 dev = iface->subdev;
1169 /* clean up after module unload */
1171 if (device_is_attached(dev)) {
1172 /* already a device there */
1175 /* clear "iface->subdev" as early as possible */
1177 iface->subdev = NULL;
1179 if (device_delete_child(udev->parent_dev, dev)) {
1182 * Panic here, else one can get a double call
1183 * to device_detach(). USB devices should
1184 * never fail on detach!
1186 panic("device_delete_child() failed\n");
1189 if (uaa->temp_dev == NULL) {
1191 /* create a new child */
1192 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1193 if (uaa->temp_dev == NULL) {
1194 device_printf(udev->parent_dev,
1195 "Device creation failed\n");
1196 return (1); /* failure */
1198 device_set_ivars(uaa->temp_dev, uaa);
1199 device_quiet(uaa->temp_dev);
1202 * Set "subdev" before probe and attach so that "devd" gets
1203 * the information it needs.
1205 iface->subdev = uaa->temp_dev;
1207 if (device_probe_and_attach(iface->subdev) == 0) {
1209 * The USB attach arguments are only available during probe
1212 uaa->temp_dev = NULL;
1213 device_set_ivars(iface->subdev, NULL);
1215 if (udev->flags.peer_suspended) {
1216 err = DEVICE_SUSPEND(iface->subdev);
1218 device_printf(iface->subdev, "Suspend failed\n");
1220 return (0); /* success */
1222 /* No USB driver found */
1223 iface->subdev = NULL;
1225 return (1); /* failure */
1228 /*------------------------------------------------------------------------*
1229 * usbd_set_parent_iface
1231 * Using this function will lock the alternate interface setting on an
1232 * interface. It is typically used for multi interface drivers. In USB
1233 * device side mode it is assumed that the alternate interfaces all
1234 * have the same endpoint descriptors. The default parent index value
1235 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1237 *------------------------------------------------------------------------*/
1239 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1240 uint8_t parent_index)
1242 struct usb_interface *iface;
1248 iface = usbd_get_iface(udev, iface_index);
1250 iface->parent_iface_index = parent_index;
1254 usb_init_attach_arg(struct usb_device *udev,
1255 struct usb_attach_arg *uaa)
1257 memset(uaa, 0, sizeof(*uaa));
1260 uaa->usb_mode = udev->flags.usb_mode;
1261 uaa->port = udev->port_no;
1262 uaa->dev_state = UAA_DEV_READY;
1264 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1265 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1266 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1267 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1268 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1269 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1270 uaa->info.bConfigIndex = udev->curr_config_index;
1271 uaa->info.bConfigNum = udev->curr_config_no;
1274 /*------------------------------------------------------------------------*
1275 * usb_probe_and_attach
1277 * This function is called from "uhub_explore_sub()",
1278 * "usb_handle_set_config()" and "usb_handle_request()".
1282 * Else: A control transfer failed
1283 *------------------------------------------------------------------------*/
1285 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1287 struct usb_attach_arg uaa;
1288 struct usb_interface *iface;
1294 DPRINTF("udev == NULL\n");
1295 return (USB_ERR_INVAL);
1297 /* Prevent re-enumeration */
1298 do_unlock = usbd_enum_lock(udev);
1300 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1301 /* do nothing - no configuration has been set */
1304 /* setup USB attach arguments */
1306 usb_init_attach_arg(udev, &uaa);
1309 * If the whole USB device is targeted, invoke the USB event
1312 if (iface_index == USB_IFACE_INDEX_ANY) {
1314 if (usb_test_quirk(&uaa, UQ_MSC_DYMO_EJECT) != 0 &&
1315 usb_dymo_eject(udev, 0) == 0) {
1316 /* success, mark the udev as disappearing */
1317 uaa.dev_state = UAA_DEV_EJECTING;
1320 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1322 if (uaa.dev_state != UAA_DEV_READY) {
1323 /* leave device unconfigured */
1324 usb_unconfigure(udev, 0);
1329 /* Check if only one interface should be probed: */
1330 if (iface_index != USB_IFACE_INDEX_ANY) {
1338 /* Do the probe and attach */
1339 for (; i != j; i++) {
1341 iface = usbd_get_iface(udev, i);
1342 if (iface == NULL) {
1344 * Looks like the end of the USB
1347 DPRINTFN(2, "end of interfaces "
1351 if (iface->idesc == NULL) {
1352 /* no interface descriptor */
1357 uaa.info.bInterfaceClass =
1358 iface->idesc->bInterfaceClass;
1359 uaa.info.bInterfaceSubClass =
1360 iface->idesc->bInterfaceSubClass;
1361 uaa.info.bInterfaceProtocol =
1362 iface->idesc->bInterfaceProtocol;
1363 uaa.info.bIfaceIndex = i;
1364 uaa.info.bIfaceNum =
1365 iface->idesc->bInterfaceNumber;
1366 uaa.driver_info = 0; /* reset driver_info */
1368 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1369 uaa.info.bInterfaceClass,
1370 uaa.info.bInterfaceSubClass,
1371 uaa.info.bInterfaceProtocol,
1372 uaa.info.bIfaceIndex,
1373 uaa.info.bIfaceNum);
1375 usb_probe_and_attach_sub(udev, &uaa);
1378 * Remove the leftover child, if any, to enforce that
1379 * a new nomatch devd event is generated for the next
1380 * interface if no driver is found:
1382 if (uaa.temp_dev == NULL)
1384 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1385 DPRINTFN(0, "device delete child failed\n");
1386 uaa.temp_dev = NULL;
1390 usbd_enum_unlock(udev);
1394 /*------------------------------------------------------------------------*
1395 * usb_suspend_resume_sub
1397 * This function is called when the suspend or resume methods should
1398 * be executed on an USB device.
1399 *------------------------------------------------------------------------*/
1401 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1408 if (!device_is_attached(dev)) {
1412 err = DEVICE_SUSPEND(dev);
1414 err = DEVICE_RESUME(dev);
1417 device_printf(dev, "%s failed\n",
1418 do_suspend ? "Suspend" : "Resume");
1422 /*------------------------------------------------------------------------*
1423 * usb_suspend_resume
1425 * The following function will suspend or resume the USB device.
1430 *------------------------------------------------------------------------*/
1432 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1434 struct usb_interface *iface;
1441 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1443 sx_assert(&udev->sr_sx, SA_LOCKED);
1445 USB_BUS_LOCK(udev->bus);
1446 /* filter the suspend events */
1447 if (udev->flags.peer_suspended == do_suspend) {
1448 USB_BUS_UNLOCK(udev->bus);
1452 udev->flags.peer_suspended = do_suspend;
1453 USB_BUS_UNLOCK(udev->bus);
1455 /* do the suspend or resume */
1457 for (i = 0; i != USB_IFACE_MAX; i++) {
1459 iface = usbd_get_iface(udev, i);
1460 if (iface == NULL) {
1461 /* looks like the end of the USB interfaces */
1464 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1469 /*------------------------------------------------------------------------*
1470 * usbd_clear_stall_proc
1472 * This function performs generic USB clear stall operations.
1473 *------------------------------------------------------------------------*/
1475 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1477 struct usb_udev_msg *pm = (void *)_pm;
1478 struct usb_device *udev = pm->udev;
1481 USB_BUS_UNLOCK(udev->bus);
1482 mtx_lock(&udev->device_mtx);
1484 /* Start clear stall callback */
1485 usbd_transfer_start(udev->ctrl_xfer[1]);
1488 mtx_unlock(&udev->device_mtx);
1489 USB_BUS_LOCK(udev->bus);
1492 /*------------------------------------------------------------------------*
1495 * This function allocates a new USB device. This function is called
1496 * when a new device has been put in the powered state, but not yet in
1497 * the addressed state. Get initial descriptor, set the address, get
1498 * full descriptor and get strings.
1503 *------------------------------------------------------------------------*/
1505 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1506 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1507 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1509 struct usb_attach_arg uaa;
1510 struct usb_device *udev;
1511 struct usb_device *adev;
1512 struct usb_device *hub;
1513 uint8_t *scratch_ptr;
1515 uint8_t device_index;
1516 uint8_t config_index;
1517 uint8_t config_quirk;
1518 uint8_t set_config_failed;
1521 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1522 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1523 parent_dev, bus, parent_hub, depth, port_index, port_no,
1527 * Find an unused device index. In USB Host mode this is the
1528 * same as the device address.
1530 * Device index zero is not used and device index 1 should
1531 * always be the root hub.
1533 for (device_index = USB_ROOT_HUB_ADDR;
1534 (device_index != bus->devices_max) &&
1535 (bus->devices[device_index] != NULL);
1536 device_index++) /* nop */;
1538 if (device_index == bus->devices_max) {
1539 device_printf(bus->bdev,
1540 "No free USB device index for new device\n");
1545 device_printf(bus->bdev,
1546 "Invalid device depth\n");
1549 udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1553 /* initialise our SX-lock */
1554 sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1555 sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS);
1556 sx_init_flags(&udev->ctrl_sx, "USB control transfer SX lock", SX_DUPOK);
1558 cv_init(&udev->ctrlreq_cv, "WCTRL");
1559 cv_init(&udev->ref_cv, "UGONE");
1561 /* initialise our mutex */
1562 mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF);
1564 /* initialise generic clear stall */
1565 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1566 udev->cs_msg[0].udev = udev;
1567 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1568 udev->cs_msg[1].udev = udev;
1570 /* initialise some USB device fields */
1571 udev->parent_hub = parent_hub;
1572 udev->parent_dev = parent_dev;
1573 udev->port_index = port_index;
1574 udev->port_no = port_no;
1575 udev->depth = depth;
1577 udev->address = USB_START_ADDR; /* default value */
1578 udev->plugtime = (usb_ticks_t)ticks;
1580 * We need to force the power mode to "on" because there are plenty
1581 * of USB devices out there that do not work very well with
1582 * automatic suspend and resume!
1584 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1585 udev->pwr_save.last_xfer_time = ticks;
1586 /* we are not ready yet */
1589 /* set up default endpoint descriptor */
1590 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1591 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1592 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1593 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1594 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1595 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1596 udev->ctrl_ep_desc.bInterval = 0;
1598 /* set up default endpoint companion descriptor */
1599 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1600 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1602 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1604 udev->speed = speed;
1605 udev->flags.usb_mode = mode;
1607 /* search for our High Speed USB HUB, if any */
1610 hub = udev->parent_hub;
1613 if (hub->speed == USB_SPEED_HIGH) {
1614 udev->hs_hub_addr = hub->address;
1615 udev->parent_hs_hub = hub;
1616 udev->hs_port_no = adev->port_no;
1620 hub = hub->parent_hub;
1623 /* init the default endpoint */
1624 usb_init_endpoint(udev, 0,
1625 &udev->ctrl_ep_desc,
1626 &udev->ctrl_ep_comp_desc,
1629 /* set device index */
1630 udev->device_index = device_index;
1633 /* Create ugen name */
1634 snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1635 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1637 LIST_INIT(&udev->pd_list);
1639 /* Create the control endpoint device */
1640 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1641 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1643 /* Create a link from /dev/ugenX.X to the default endpoint */
1644 if (udev->ctrl_dev != NULL)
1645 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1647 /* Initialise device */
1648 if (bus->methods->device_init != NULL) {
1649 err = (bus->methods->device_init) (udev);
1651 DPRINTFN(0, "device init %d failed "
1652 "(%s, ignored)\n", device_index,
1657 /* set powered device state after device init is complete */
1658 usb_set_device_state(udev, USB_STATE_POWERED);
1660 if (udev->flags.usb_mode == USB_MODE_HOST) {
1662 err = usbd_req_set_address(udev, NULL, device_index);
1665 * This is the new USB device address from now on, if
1666 * the set address request didn't set it already.
1668 if (udev->address == USB_START_ADDR)
1669 udev->address = device_index;
1672 * We ignore any set-address errors, hence there are
1673 * buggy USB devices out there that actually receive
1674 * the SETUP PID, but manage to set the address before
1675 * the STATUS stage is ACK'ed. If the device responds
1676 * to the subsequent get-descriptor at the new
1677 * address, then we know that the set-address command
1681 DPRINTFN(0, "set address %d failed "
1682 "(%s, ignored)\n", udev->address,
1686 /* We are not self powered */
1687 udev->flags.self_powered = 0;
1689 /* Set unconfigured state */
1690 udev->curr_config_no = USB_UNCONFIG_NO;
1691 udev->curr_config_index = USB_UNCONFIG_INDEX;
1693 /* Setup USB descriptors */
1694 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1696 DPRINTFN(0, "setting up USB template failed maybe the USB "
1697 "template module has not been loaded\n");
1701 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1703 /* setup the device descriptor and the initial "wMaxPacketSize" */
1704 err = usbd_setup_device_desc(udev, NULL);
1707 /* try to enumerate two more times */
1708 err = usbd_req_re_enumerate(udev, NULL);
1710 err = usbd_req_re_enumerate(udev, NULL);
1718 * Setup temporary USB attach args so that we can figure out some
1719 * basic quirks for this device.
1721 usb_init_attach_arg(udev, &uaa);
1723 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1724 udev->flags.uq_bus_powered = 1;
1726 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1727 udev->flags.no_strings = 1;
1730 * Workaround for buggy USB devices.
1732 * It appears that some string-less USB chips will crash and
1733 * disappear if any attempts are made to read any string
1736 * Try to detect such chips by checking the strings in the USB
1737 * device descriptor. If no strings are present there we
1738 * simply disable all USB strings.
1741 /* Protect scratch area */
1742 do_unlock = usbd_ctrl_lock(udev);
1744 scratch_ptr = udev->scratch.data;
1746 if (udev->flags.no_strings) {
1747 err = USB_ERR_INVAL;
1748 } else if (udev->ddesc.iManufacturer ||
1749 udev->ddesc.iProduct ||
1750 udev->ddesc.iSerialNumber) {
1751 /* read out the language ID string */
1752 err = usbd_req_get_string_desc(udev, NULL,
1753 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1755 err = USB_ERR_INVAL;
1758 if (err || (scratch_ptr[0] < 4)) {
1759 udev->flags.no_strings = 1;
1766 /* load preferred value and mask */
1768 mask = usb_lang_mask;
1770 /* align length correctly */
1771 scratch_ptr[0] &= ~1U;
1773 /* fix compiler warning */
1776 /* search for preferred language */
1777 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1778 langid = UGETW(scratch_ptr + x);
1779 if ((langid & mask) == pref)
1782 if (x >= scratch_ptr[0]) {
1783 /* pick the first language as the default */
1784 DPRINTFN(1, "Using first language\n");
1785 langid = UGETW(scratch_ptr + 2);
1788 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1789 udev->langid = langid;
1793 usbd_ctrl_unlock(udev);
1795 /* assume 100mA bus powered for now. Changed when configured. */
1796 udev->power = USB_MIN_POWER;
1797 /* fetch the vendor and product strings from the device */
1798 usbd_set_device_strings(udev);
1800 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1801 /* USB device mode setup is complete */
1807 * Most USB devices should attach to config index 0 by
1810 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1813 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1816 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1819 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1822 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1830 set_config_failed = 0;
1833 DPRINTF("setting config %u\n", config_index);
1835 /* get the USB device configured */
1836 err = usbd_set_config_index(udev, config_index);
1838 if (udev->ddesc.bNumConfigurations != 0) {
1839 if (!set_config_failed) {
1840 set_config_failed = 1;
1841 /* XXX try to re-enumerate the device */
1842 err = usbd_req_re_enumerate(udev, NULL);
1844 goto repeat_set_config;
1846 DPRINTFN(0, "Failure selecting configuration index %u:"
1847 "%s, port %u, addr %u (ignored)\n",
1848 config_index, usbd_errstr(err), udev->port_no,
1852 * Some USB devices do not have any configurations. Ignore any
1853 * set config failures!
1858 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1859 if ((udev->cdesc->bNumInterface < 2) &&
1860 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1861 DPRINTFN(0, "Found no endpoints, trying next config\n");
1863 goto repeat_set_config;
1865 if (config_index == 0) {
1867 * Try to figure out if we have an
1868 * auto-install disk there:
1870 if (usb_iface_is_cdrom(udev, 0)) {
1871 DPRINTFN(0, "Found possible auto-install "
1872 "disk (trying next config)\n");
1874 goto repeat_set_config;
1878 if (set_config_failed == 0 && config_index == 0 &&
1879 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1880 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1883 * Try to figure out if there are any MSC quirks we
1884 * should apply automatically:
1886 err = usb_msc_auto_quirk(udev, 0);
1889 set_config_failed = 1;
1890 goto repeat_set_config;
1895 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1896 udev->address, udev, udev->parent_hub);
1898 /* register our device - we are ready */
1899 usb_bus_port_set_device(bus, parent_hub ?
1900 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1903 /* Symlink the ugen device name */
1904 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1906 /* Announce device */
1907 printf("%s: <%s> at %s\n", udev->ugen_name,
1908 usb_get_manufacturer(udev),
1909 device_get_nameunit(udev->bus->bdev));
1913 usb_notify_addq("ATTACH", udev);
1918 * Free USB device and all subdevices, if any.
1920 usb_free_device(udev, 0);
1927 struct usb_fs_privdata *
1928 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1929 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1931 struct usb_fs_privdata* pd;
1934 /* Store information to locate ourselves again later */
1935 pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1937 pd->bus_index = device_get_unit(udev->bus->bdev);
1938 pd->dev_index = udev->device_index;
1940 pd->fifo_index = fi;
1943 /* Now, create the device itself */
1944 if (devname == NULL) {
1946 snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1947 pd->bus_index, pd->dev_index, pd->ep_addr);
1950 pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname);
1952 if (pd->cdev == NULL) {
1953 DPRINTFN(0, "Failed to create device %s\n", devname);
1958 /* XXX setting si_drv1 and creating the device is not atomic! */
1959 pd->cdev->si_drv1 = pd;
1965 usb_destroy_dev_sync(struct usb_fs_privdata *pd)
1967 DPRINTFN(1, "Destroying device at ugen%d.%d\n",
1968 pd->bus_index, pd->dev_index);
1971 * Destroy character device synchronously. After this
1972 * all system calls are returned. Can block.
1974 destroy_dev(pd->cdev);
1980 usb_destroy_dev(struct usb_fs_privdata *pd)
1982 struct usb_bus *bus;
1987 mtx_lock(&usb_ref_lock);
1988 bus = devclass_get_softc(usb_devclass_ptr, pd->bus_index);
1989 mtx_unlock(&usb_ref_lock);
1992 usb_destroy_dev_sync(pd);
1996 /* make sure we can re-use the device name */
1997 delist_dev(pd->cdev);
2000 LIST_INSERT_HEAD(&bus->pd_cleanup_list, pd, pd_next);
2001 /* get cleanup going */
2002 usb_proc_msignal(&bus->explore_proc,
2003 &bus->cleanup_msg[0], &bus->cleanup_msg[1]);
2004 USB_BUS_UNLOCK(bus);
2008 usb_cdev_create(struct usb_device *udev)
2010 struct usb_config_descriptor *cd;
2011 struct usb_endpoint_descriptor *ed;
2012 struct usb_descriptor *desc;
2013 struct usb_fs_privdata* pd;
2014 int inmode, outmode, inmask, outmask, mode;
2017 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2019 DPRINTFN(2, "Creating device nodes\n");
2021 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2024 } else { /* USB_MODE_HOST */
2034 * Collect all used endpoint numbers instead of just
2035 * generating 16 static endpoints.
2037 cd = usbd_get_config_descriptor(udev);
2038 while ((desc = usb_desc_foreach(cd, desc))) {
2039 /* filter out all endpoint descriptors */
2040 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2041 (desc->bLength >= sizeof(*ed))) {
2042 ed = (struct usb_endpoint_descriptor *)desc;
2045 ep = ed->bEndpointAddress;
2046 if (UE_GET_DIR(ep) == UE_DIR_OUT)
2047 outmask |= 1 << UE_GET_ADDR(ep);
2049 inmask |= 1 << UE_GET_ADDR(ep);
2053 /* Create all available endpoints except EP0 */
2054 for (ep = 1; ep < 16; ep++) {
2055 mode = (inmask & (1 << ep)) ? inmode : 0;
2056 mode |= (outmask & (1 << ep)) ? outmode : 0;
2058 continue; /* no IN or OUT endpoint */
2060 pd = usb_make_dev(udev, NULL, ep, 0,
2061 mode, UID_ROOT, GID_OPERATOR, 0600);
2064 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2069 usb_cdev_free(struct usb_device *udev)
2071 struct usb_fs_privdata* pd;
2073 DPRINTFN(2, "Freeing device nodes\n");
2075 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2076 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2078 LIST_REMOVE(pd, pd_next);
2080 usb_destroy_dev(pd);
2085 /*------------------------------------------------------------------------*
2088 * This function is NULL safe and will free an USB device and its
2089 * children devices, if any.
2091 * Flag values: Reserved, set to zero.
2092 *------------------------------------------------------------------------*/
2094 usb_free_device(struct usb_device *udev, uint8_t flag)
2096 struct usb_bus *bus;
2099 return; /* already freed */
2101 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2105 /* set DETACHED state to prevent any further references */
2106 usb_set_device_state(udev, USB_STATE_DETACHED);
2109 usb_notify_addq("DETACH", udev);
2114 printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2115 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2118 /* Destroy UGEN symlink, if any */
2119 if (udev->ugen_symlink) {
2120 usb_free_symlink(udev->ugen_symlink);
2121 udev->ugen_symlink = NULL;
2124 usb_destroy_dev(udev->ctrl_dev);
2127 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2128 /* stop receiving any control transfers (Device Side Mode) */
2129 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2132 /* the following will get the device unconfigured in software */
2133 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2135 /* final device unregister after all character devices are closed */
2136 usb_bus_port_set_device(bus, udev->parent_hub ?
2137 udev->parent_hub->hub->ports + udev->port_index : NULL,
2138 NULL, USB_ROOT_HUB_ADDR);
2140 /* unsetup any leftover default USB transfers */
2141 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2143 /* template unsetup, if any */
2144 (usb_temp_unsetup_p) (udev);
2147 * Make sure that our clear-stall messages are not queued
2150 USB_BUS_LOCK(udev->bus);
2151 usb_proc_mwait(&udev->bus->non_giant_callback_proc,
2152 &udev->cs_msg[0], &udev->cs_msg[1]);
2153 USB_BUS_UNLOCK(udev->bus);
2155 /* wait for all references to go away */
2156 usb_wait_pending_refs(udev);
2158 sx_destroy(&udev->enum_sx);
2159 sx_destroy(&udev->sr_sx);
2160 sx_destroy(&udev->ctrl_sx);
2162 cv_destroy(&udev->ctrlreq_cv);
2163 cv_destroy(&udev->ref_cv);
2165 mtx_destroy(&udev->device_mtx);
2167 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2170 /* Uninitialise device */
2171 if (bus->methods->device_uninit != NULL)
2172 (bus->methods->device_uninit) (udev);
2175 free(udev->serial, M_USB);
2176 free(udev->manufacturer, M_USB);
2177 free(udev->product, M_USB);
2181 /*------------------------------------------------------------------------*
2184 * This function is the safe way to get the USB interface structure
2185 * pointer by interface index.
2188 * NULL: Interface not present.
2189 * Else: Pointer to USB interface structure.
2190 *------------------------------------------------------------------------*/
2191 struct usb_interface *
2192 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2194 struct usb_interface *iface = udev->ifaces + iface_index;
2196 if (iface_index >= udev->ifaces_max)
2201 /*------------------------------------------------------------------------*
2202 * usbd_find_descriptor
2204 * This function will lookup the first descriptor that matches the
2205 * criteria given by the arguments "type" and "subtype". Descriptors
2206 * will only be searched within the interface having the index
2207 * "iface_index". If the "id" argument points to an USB descriptor,
2208 * it will be skipped before the search is started. This allows
2209 * searching for multiple descriptors using the same criteria. Else
2210 * the search is started after the interface descriptor.
2213 * NULL: End of descriptors
2214 * Else: A descriptor matching the criteria
2215 *------------------------------------------------------------------------*/
2217 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2218 uint8_t type, uint8_t type_mask,
2219 uint8_t subtype, uint8_t subtype_mask)
2221 struct usb_descriptor *desc;
2222 struct usb_config_descriptor *cd;
2223 struct usb_interface *iface;
2225 cd = usbd_get_config_descriptor(udev);
2230 iface = usbd_get_iface(udev, iface_index);
2231 if (iface == NULL) {
2234 id = usbd_get_interface_descriptor(iface);
2241 while ((desc = usb_desc_foreach(cd, desc))) {
2243 if (desc->bDescriptorType == UDESC_INTERFACE) {
2246 if (((desc->bDescriptorType & type_mask) == type) &&
2247 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2254 /*------------------------------------------------------------------------*
2257 * This function will dump information from the device descriptor
2258 * belonging to the USB device pointed to by "udev", to the string
2259 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2260 * including the terminating zero.
2261 *------------------------------------------------------------------------*/
2263 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2265 struct usb_device_descriptor *udd = &udev->ddesc;
2269 bcdUSB = UGETW(udd->bcdUSB);
2270 bcdDevice = UGETW(udd->bcdDevice);
2272 if (udd->bDeviceClass != 0xFF) {
2273 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2275 usb_get_manufacturer(udev),
2276 usb_get_product(udev),
2277 udd->bDeviceClass, udd->bDeviceSubClass,
2278 (bcdUSB >> 8), bcdUSB & 0xFF,
2279 (bcdDevice >> 8), bcdDevice & 0xFF,
2282 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2284 usb_get_manufacturer(udev),
2285 usb_get_product(udev),
2286 (bcdUSB >> 8), bcdUSB & 0xFF,
2287 (bcdDevice >> 8), bcdDevice & 0xFF,
2294 * Descriptions of of known vendors and devices ("products").
2296 struct usb_knowndev {
2300 const char *vendorname;
2301 const char *productname;
2304 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2306 #include "usbdevs.h"
2307 #include "usbdevs_data.h"
2308 #endif /* USB_VERBOSE */
2311 usbd_set_device_strings(struct usb_device *udev)
2313 struct usb_device_descriptor *udd = &udev->ddesc;
2315 const struct usb_knowndev *kdp;
2320 uint16_t product_id;
2323 /* Protect scratch area */
2324 do_unlock = usbd_ctrl_lock(udev);
2326 temp_ptr = (char *)udev->scratch.data;
2327 temp_size = sizeof(udev->scratch.data);
2329 vendor_id = UGETW(udd->idVendor);
2330 product_id = UGETW(udd->idProduct);
2332 /* get serial number string */
2333 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2334 udev->ddesc.iSerialNumber);
2335 udev->serial = strdup(temp_ptr, M_USB);
2337 /* get manufacturer string */
2338 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2339 udev->ddesc.iManufacturer);
2340 usb_trim_spaces(temp_ptr);
2341 if (temp_ptr[0] != '\0')
2342 udev->manufacturer = strdup(temp_ptr, M_USB);
2344 /* get product string */
2345 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2346 udev->ddesc.iProduct);
2347 usb_trim_spaces(temp_ptr);
2348 if (temp_ptr[0] != '\0')
2349 udev->product = strdup(temp_ptr, M_USB);
2352 if (udev->manufacturer == NULL || udev->product == NULL) {
2353 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2354 if (kdp->vendor == vendor_id &&
2355 (kdp->product == product_id ||
2356 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2359 if (kdp->vendorname != NULL) {
2360 /* XXX should use pointer to knowndevs string */
2361 if (udev->manufacturer == NULL) {
2362 udev->manufacturer = strdup(kdp->vendorname,
2365 if (udev->product == NULL &&
2366 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2367 udev->product = strdup(kdp->productname,
2373 /* Provide default strings if none were found */
2374 if (udev->manufacturer == NULL) {
2375 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2376 udev->manufacturer = strdup(temp_ptr, M_USB);
2378 if (udev->product == NULL) {
2379 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2380 udev->product = strdup(temp_ptr, M_USB);
2384 usbd_ctrl_unlock(udev);
2392 usbd_get_mode(struct usb_device *udev)
2394 return (udev->flags.usb_mode);
2399 * See: USB_SPEED_XXX
2402 usbd_get_speed(struct usb_device *udev)
2404 return (udev->speed);
2408 usbd_get_isoc_fps(struct usb_device *udev)
2411 switch (udev->speed) {
2413 case USB_SPEED_FULL:
2420 struct usb_device_descriptor *
2421 usbd_get_device_descriptor(struct usb_device *udev)
2424 return (NULL); /* be NULL safe */
2425 return (&udev->ddesc);
2428 struct usb_config_descriptor *
2429 usbd_get_config_descriptor(struct usb_device *udev)
2432 return (NULL); /* be NULL safe */
2433 return (udev->cdesc);
2436 /*------------------------------------------------------------------------*
2437 * usb_test_quirk - test a device for a given quirk
2440 * 0: The USB device does not have the given quirk.
2441 * Else: The USB device has the given quirk.
2442 *------------------------------------------------------------------------*/
2444 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2449 if (quirk == UQ_NONE)
2452 /* search the automatic per device quirks first */
2454 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2455 if (uaa->device->autoQuirk[x] == quirk)
2459 /* search global quirk table, if any */
2461 found = (usb_test_quirk_p) (&uaa->info, quirk);
2466 struct usb_interface_descriptor *
2467 usbd_get_interface_descriptor(struct usb_interface *iface)
2470 return (NULL); /* be NULL safe */
2471 return (iface->idesc);
2475 usbd_get_interface_altindex(struct usb_interface *iface)
2477 return (iface->alt_index);
2481 usbd_get_bus_index(struct usb_device *udev)
2483 return ((uint8_t)device_get_unit(udev->bus->bdev));
2487 usbd_get_device_index(struct usb_device *udev)
2489 return (udev->device_index);
2494 usb_notify_addq(const char *type, struct usb_device *udev)
2496 struct usb_interface *iface;
2500 /* announce the device */
2501 sb = sbuf_new_auto();
2510 "devsubclass=0x%02x "
2523 UGETW(udev->ddesc.idVendor),
2524 UGETW(udev->ddesc.idProduct),
2525 udev->ddesc.bDeviceClass,
2526 udev->ddesc.bDeviceSubClass,
2527 usb_get_serial(udev),
2528 UGETW(udev->ddesc.bcdDevice),
2529 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2532 , udev->parent_hub != NULL ?
2533 udev->parent_hub->ugen_name :
2534 device_get_nameunit(device_get_parent(udev->bus->bdev))
2538 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2541 /* announce each interface */
2542 for (i = 0; i < USB_IFACE_MAX; i++) {
2543 iface = usbd_get_iface(udev, i);
2545 break; /* end of interfaces */
2546 if (iface->idesc == NULL)
2547 continue; /* no interface descriptor */
2549 sb = sbuf_new_auto();
2558 "devsubclass=0x%02x "
2565 "intsubclass=0x%02x "
2566 "intprotocol=0x%02x",
2571 UGETW(udev->ddesc.idVendor),
2572 UGETW(udev->ddesc.idProduct),
2573 udev->ddesc.bDeviceClass,
2574 udev->ddesc.bDeviceSubClass,
2575 usb_get_serial(udev),
2576 UGETW(udev->ddesc.bcdDevice),
2577 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2578 iface->idesc->bInterfaceNumber,
2579 iface->idesc->bNumEndpoints,
2580 iface->idesc->bInterfaceClass,
2581 iface->idesc->bInterfaceSubClass,
2582 iface->idesc->bInterfaceProtocol);
2584 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2591 /*------------------------------------------------------------------------*
2592 * usb_fifo_free_wrap
2594 * This function will free the FIFOs.
2596 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2597 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2598 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2599 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2600 * control endpoint FIFOs. If "iface_index" is not set to
2601 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2602 *------------------------------------------------------------------------*/
2604 usb_fifo_free_wrap(struct usb_device *udev,
2605 uint8_t iface_index, uint8_t flag)
2611 * Free any USB FIFOs on the given interface:
2613 for (i = 0; i != USB_FIFO_MAX; i++) {
2618 /* Check if the interface index matches */
2619 if (iface_index == f->iface_index) {
2620 if (f->methods != &usb_ugen_methods) {
2622 * Don't free any non-generic FIFOs in
2627 if ((f->dev_ep_index == 0) &&
2628 (f->fs_xfer == NULL)) {
2629 /* no need to free this FIFO */
2632 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2633 if ((f->methods == &usb_ugen_methods) &&
2634 (f->dev_ep_index == 0) &&
2635 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2636 (f->fs_xfer == NULL)) {
2637 /* no need to free this FIFO */
2641 /* no need to free this FIFO */
2644 /* free this FIFO */
2650 /*------------------------------------------------------------------------*
2651 * usb_peer_can_wakeup
2654 * 0: Peer cannot do resume signalling.
2655 * Else: Peer can do resume signalling.
2656 *------------------------------------------------------------------------*/
2658 usb_peer_can_wakeup(struct usb_device *udev)
2660 const struct usb_config_descriptor *cdp;
2663 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2664 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2666 return (0); /* not supported */
2670 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2673 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2675 DPRINTF("udev %p state %s -> %s\n", udev,
2676 usb_statestr(udev->state), usb_statestr(state));
2679 mtx_lock(&usb_ref_lock);
2681 udev->state = state;
2683 mtx_unlock(&usb_ref_lock);
2685 if (udev->bus->methods->device_state_change != NULL)
2686 (udev->bus->methods->device_state_change) (udev);
2690 usb_get_device_state(struct usb_device *udev)
2693 return (USB_STATE_DETACHED);
2694 return (udev->state);
2698 usbd_device_attached(struct usb_device *udev)
2700 return (udev->state > USB_STATE_DETACHED);
2704 * The following function locks enumerating the given USB device. If
2705 * the lock is already grabbed this function returns zero. Else a
2706 * a value of one is returned.
2709 usbd_enum_lock(struct usb_device *udev)
2711 if (sx_xlocked(&udev->enum_sx))
2714 sx_xlock(&udev->enum_sx);
2715 sx_xlock(&udev->sr_sx);
2717 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2718 * are locked before locking Giant. Else the lock can be
2719 * locked multiple times.
2727 * This function is the same like usbd_enum_lock() except a value of
2728 * 255 is returned when a signal is pending:
2731 usbd_enum_lock_sig(struct usb_device *udev)
2733 if (sx_xlocked(&udev->enum_sx))
2735 if (sx_xlock_sig(&udev->enum_sx))
2737 if (sx_xlock_sig(&udev->sr_sx)) {
2738 sx_xunlock(&udev->enum_sx);
2746 /* The following function unlocks enumerating the given USB device. */
2749 usbd_enum_unlock(struct usb_device *udev)
2752 sx_xunlock(&udev->enum_sx);
2753 sx_xunlock(&udev->sr_sx);
2756 /* The following function locks suspend and resume. */
2759 usbd_sr_lock(struct usb_device *udev)
2761 sx_xlock(&udev->sr_sx);
2763 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2764 * are locked before locking Giant. Else the lock can be
2765 * locked multiple times.
2770 /* The following function unlocks suspend and resume. */
2773 usbd_sr_unlock(struct usb_device *udev)
2776 sx_xunlock(&udev->sr_sx);
2780 * The following function checks the enumerating lock for the given
2785 usbd_enum_is_locked(struct usb_device *udev)
2787 return (sx_xlocked(&udev->enum_sx));
2791 * The following function is used to serialize access to USB control
2792 * transfers and the USB scratch area. If the lock is already grabbed
2793 * this function returns zero. Else a value of one is returned.
2796 usbd_ctrl_lock(struct usb_device *udev)
2798 if (sx_xlocked(&udev->ctrl_sx))
2800 sx_xlock(&udev->ctrl_sx);
2803 * We need to allow suspend and resume at this point, else the
2804 * control transfer will timeout if the device is suspended!
2806 if (usbd_enum_is_locked(udev))
2807 usbd_sr_unlock(udev);
2812 usbd_ctrl_unlock(struct usb_device *udev)
2814 sx_xunlock(&udev->ctrl_sx);
2817 * Restore the suspend and resume lock after we have unlocked
2818 * the USB control transfer lock to avoid LOR:
2820 if (usbd_enum_is_locked(udev))
2825 * The following function is used to set the per-interface specific
2826 * plug and play information. The string referred to by the pnpinfo
2827 * argument can safely be freed after calling this function. The
2828 * pnpinfo of an interface will be reset at device detach or when
2829 * passing a NULL argument to this function. This function
2830 * returns zero on success, else a USB_ERR_XXX failure code.
2834 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2836 struct usb_interface *iface;
2838 iface = usbd_get_iface(udev, iface_index);
2840 return (USB_ERR_INVAL);
2842 if (iface->pnpinfo != NULL) {
2843 free(iface->pnpinfo, M_USBDEV);
2844 iface->pnpinfo = NULL;
2847 if (pnpinfo == NULL || pnpinfo[0] == 0)
2848 return (0); /* success */
2850 iface->pnpinfo = strdup(pnpinfo, M_USBDEV);
2851 if (iface->pnpinfo == NULL)
2852 return (USB_ERR_NOMEM);
2854 return (0); /* success */
2858 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2862 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2863 if (udev->autoQuirk[x] == 0 ||
2864 udev->autoQuirk[x] == quirk) {
2865 udev->autoQuirk[x] = quirk;
2866 return (0); /* success */
2869 return (USB_ERR_NOMEM);