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 #ifdef USB_GLOBAL_INCLUDE_FILE
28 #include USB_GLOBAL_INCLUDE_FILE
30 #include <sys/stdint.h>
31 #include <sys/stddef.h>
32 #include <sys/param.h>
33 #include <sys/queue.h>
34 #include <sys/types.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
38 #include <sys/module.h>
40 #include <sys/mutex.h>
41 #include <sys/condvar.h>
42 #include <sys/sysctl.h>
44 #include <sys/unistd.h>
45 #include <sys/callout.h>
46 #include <sys/malloc.h>
49 #include <sys/fcntl.h>
51 #include <dev/usb/usb.h>
52 #include <dev/usb/usbdi.h>
53 #include <dev/usb/usbdi_util.h>
54 #include <dev/usb/usb_ioctl.h>
62 #define USB_DEBUG_VAR usb_debug
64 #include <dev/usb/usb_core.h>
65 #include <dev/usb/usb_debug.h>
66 #include <dev/usb/usb_process.h>
67 #include <dev/usb/usb_device.h>
68 #include <dev/usb/usb_busdma.h>
69 #include <dev/usb/usb_transfer.h>
70 #include <dev/usb/usb_request.h>
71 #include <dev/usb/usb_dynamic.h>
72 #include <dev/usb/usb_hub.h>
73 #include <dev/usb/usb_util.h>
74 #include <dev/usb/usb_msctest.h>
76 #include <dev/usb/usb_dev.h>
77 #include <dev/usb/usb_generic.h>
80 #include <dev/usb/quirk/usb_quirk.h>
82 #include <dev/usb/usb_controller.h>
83 #include <dev/usb/usb_bus.h>
84 #endif /* USB_GLOBAL_INCLUDE_FILE */
86 /* function prototypes */
88 static void usb_init_endpoint(struct usb_device *, uint8_t,
89 struct usb_endpoint_descriptor *,
90 struct usb_endpoint_ss_comp_descriptor *,
91 struct usb_endpoint *);
92 static void usb_unconfigure(struct usb_device *, uint8_t);
93 static void usb_detach_device_sub(struct usb_device *, device_t *,
95 static uint8_t usb_probe_and_attach_sub(struct usb_device *,
96 struct usb_attach_arg *);
97 static void usb_init_attach_arg(struct usb_device *,
98 struct usb_attach_arg *);
99 static void usb_suspend_resume_sub(struct usb_device *, device_t,
101 static usb_proc_callback_t usbd_clear_stall_proc;
102 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
103 static void usbd_set_device_strings(struct usb_device *);
105 static void usb_notify_addq(const char *type, struct usb_device *);
108 static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
109 static void usb_cdev_create(struct usb_device *);
110 static void usb_cdev_free(struct usb_device *);
113 /* This variable is global to allow easy access to it: */
116 int usb_template = USB_TEMPLATE;
121 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RWTUN,
122 &usb_template, 0, "Selected USB device side template");
124 /* English is default language */
126 static int usb_lang_id = 0x0009;
127 static int usb_lang_mask = 0x00FF;
129 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RWTUN,
130 &usb_lang_id, 0, "Preferred USB language ID");
132 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RWTUN,
133 &usb_lang_mask, 0, "Preferred USB language mask");
135 static const char* statestr[USB_STATE_MAX] = {
136 [USB_STATE_DETACHED] = "DETACHED",
137 [USB_STATE_ATTACHED] = "ATTACHED",
138 [USB_STATE_POWERED] = "POWERED",
139 [USB_STATE_ADDRESSED] = "ADDRESSED",
140 [USB_STATE_CONFIGURED] = "CONFIGURED",
144 usb_statestr(enum usb_dev_state state)
146 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
150 usb_get_manufacturer(struct usb_device *udev)
152 return (udev->manufacturer ? udev->manufacturer : "Unknown");
156 usb_get_product(struct usb_device *udev)
158 return (udev->product ? udev->product : "");
162 usb_get_serial(struct usb_device *udev)
164 return (udev->serial ? udev->serial : "");
167 /*------------------------------------------------------------------------*
168 * usbd_get_ep_by_addr
170 * This function searches for an USB ep by endpoint address and
176 *------------------------------------------------------------------------*/
177 struct usb_endpoint *
178 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
180 struct usb_endpoint *ep = udev->endpoints;
181 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
183 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
187 * According to the USB specification not all bits are used
188 * for the endpoint address. Keep defined bits only:
193 * Iterate accross all the USB endpoints searching for a match
194 * based on the endpoint address:
196 for (; ep != ep_end; ep++) {
198 if (ep->edesc == NULL) {
201 /* do the mask and check the value */
202 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
208 * The default endpoint is always present and is checked separately:
210 if ((udev->ctrl_ep.edesc != NULL) &&
211 ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
221 /*------------------------------------------------------------------------*
224 * This function searches for an USB endpoint based on the information
225 * given by the passed "struct usb_config" pointer.
229 * Else: Pointer to "struct usb_endpoint".
230 *------------------------------------------------------------------------*/
231 struct usb_endpoint *
232 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
233 const struct usb_config *setup)
235 struct usb_endpoint *ep = udev->endpoints;
236 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
237 uint8_t index = setup->ep_index;
243 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
244 "type=0x%x dir=0x%x index=%d\n",
245 udev, iface_index, setup->endpoint,
246 setup->type, setup->direction, setup->ep_index);
250 if (setup->usb_mode != USB_MODE_DUAL &&
251 udev->flags.usb_mode != setup->usb_mode) {
252 /* wrong mode - no endpoint */
256 /* setup expected endpoint direction mask and value */
258 if (setup->direction == UE_DIR_RX) {
259 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
260 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
261 UE_DIR_OUT : UE_DIR_IN;
262 } else if (setup->direction == UE_DIR_TX) {
263 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
264 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
265 UE_DIR_IN : UE_DIR_OUT;
266 } else if (setup->direction == UE_DIR_ANY) {
267 /* match any endpoint direction */
271 /* match the given endpoint direction */
272 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
273 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
276 /* setup expected endpoint address */
278 if (setup->endpoint == UE_ADDR_ANY) {
279 /* match any endpoint address */
281 /* match the given endpoint address */
283 ea_val |= (setup->endpoint & UE_ADDR);
286 /* setup expected endpoint type */
288 if (setup->type == UE_BULK_INTR) {
289 /* this will match BULK and INTERRUPT endpoints */
292 } else if (setup->type == UE_TYPE_ANY) {
293 /* match any endpoint type */
297 /* match the given endpoint type */
298 type_mask = UE_XFERTYPE;
299 type_val = (setup->type & UE_XFERTYPE);
303 * Iterate accross all the USB endpoints searching for a match
304 * based on the endpoint address. Note that we are searching
305 * the endpoints from the beginning of the "udev->endpoints" array.
307 for (; ep != ep_end; ep++) {
309 if ((ep->edesc == NULL) ||
310 (ep->iface_index != iface_index)) {
313 /* do the masks and check the values */
315 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
316 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
324 * Match against default endpoint last, so that "any endpoint", "any
325 * address" and "any direction" returns the first endpoint of the
326 * interface. "iface_index" and "direction" is ignored:
328 if ((udev->ctrl_ep.edesc != NULL) &&
329 ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
330 ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
341 /*------------------------------------------------------------------------*
342 * usbd_interface_count
344 * This function stores the number of USB interfaces excluding
345 * alternate settings, which the USB config descriptor reports into
346 * the unsigned 8-bit integer pointed to by "count".
351 *------------------------------------------------------------------------*/
353 usbd_interface_count(struct usb_device *udev, uint8_t *count)
355 if (udev->cdesc == NULL) {
357 return (USB_ERR_NOT_CONFIGURED);
359 *count = udev->ifaces_max;
360 return (USB_ERR_NORMAL_COMPLETION);
363 /*------------------------------------------------------------------------*
366 * This function will initialise the USB endpoint structure pointed to by
367 * the "endpoint" argument. The structure pointed to by "endpoint" must be
368 * zeroed before calling this function.
369 *------------------------------------------------------------------------*/
371 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
372 struct usb_endpoint_descriptor *edesc,
373 struct usb_endpoint_ss_comp_descriptor *ecomp,
374 struct usb_endpoint *ep)
376 const struct usb_bus_methods *methods;
379 methods = udev->bus->methods;
381 (methods->endpoint_init) (udev, edesc, ep);
383 /* initialise USB endpoint structure */
386 ep->iface_index = iface_index;
388 /* setup USB stream queues */
389 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
390 TAILQ_INIT(&ep->endpoint_q[x].head);
391 ep->endpoint_q[x].command = &usbd_pipe_start;
394 /* the pipe is not supported by the hardware */
395 if (ep->methods == NULL)
398 /* check for SUPER-speed streams mode endpoint */
399 if (udev->speed == USB_SPEED_SUPER && ecomp != NULL &&
400 (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK &&
401 (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) {
402 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS);
404 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT);
407 /* clear stall, if any */
408 if (methods->clear_stall != NULL) {
409 USB_BUS_LOCK(udev->bus);
410 (methods->clear_stall) (udev, ep);
411 USB_BUS_UNLOCK(udev->bus);
415 /*-----------------------------------------------------------------------*
416 * usb_endpoint_foreach
418 * This function will iterate all the USB endpoints except the control
419 * endpoint. This function is NULL safe.
422 * NULL: End of USB endpoints
423 * Else: Pointer to next USB endpoint
424 *------------------------------------------------------------------------*/
425 struct usb_endpoint *
426 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
428 struct usb_endpoint *ep_end;
434 ep_end = udev->endpoints + udev->endpoints_max;
436 /* get next endpoint */
438 ep = udev->endpoints;
442 /* find next allocated ep */
443 while (ep != ep_end) {
444 if (ep->edesc != NULL)
451 /*------------------------------------------------------------------------*
452 * usb_wait_pending_refs
454 * This function will wait for any USB references to go away before
455 * returning. This function is used before freeing a USB device.
456 *------------------------------------------------------------------------*/
458 usb_wait_pending_refs(struct usb_device *udev)
461 DPRINTF("Refcount = %d\n", (int)udev->refcount);
463 mtx_lock(&usb_ref_lock);
466 /* wait for any pending references to go away */
467 if (udev->refcount == 0) {
468 /* prevent further refs being taken, if any */
469 udev->refcount = USB_DEV_REF_MAX;
472 cv_wait(&udev->ref_cv, &usb_ref_lock);
474 mtx_unlock(&usb_ref_lock);
478 /*------------------------------------------------------------------------*
481 * This function will free all USB interfaces and USB endpoints belonging
484 * Flag values, see "USB_UNCFG_FLAG_XXX".
485 *------------------------------------------------------------------------*/
487 usb_unconfigure(struct usb_device *udev, uint8_t flag)
491 /* Prevent re-enumeration */
492 do_unlock = usbd_enum_lock(udev);
494 /* detach all interface drivers */
495 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
498 /* free all FIFOs except control endpoint FIFOs */
499 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
502 * Free all cdev's, if any.
507 #if USB_HAVE_COMPAT_LINUX
508 /* free Linux compat device, if any */
509 if (udev->linux_endpoint_start != NULL) {
510 usb_linux_free_device_p(udev);
511 udev->linux_endpoint_start = NULL;
515 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
517 /* free "cdesc" after "ifaces" and "endpoints", if any */
518 if (udev->cdesc != NULL) {
519 if (udev->flags.usb_mode != USB_MODE_DEVICE)
520 usbd_free_config_desc(udev, udev->cdesc);
523 /* set unconfigured state */
524 udev->curr_config_no = USB_UNCONFIG_NO;
525 udev->curr_config_index = USB_UNCONFIG_INDEX;
528 usbd_enum_unlock(udev);
531 /*------------------------------------------------------------------------*
532 * usbd_set_config_index
534 * This function selects configuration by index, independent of the
535 * actual configuration number. This function should not be used by
541 *------------------------------------------------------------------------*/
543 usbd_set_config_index(struct usb_device *udev, uint8_t index)
545 struct usb_status ds;
546 struct usb_config_descriptor *cdp;
553 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
555 /* Prevent re-enumeration */
556 do_unlock = usbd_enum_lock(udev);
558 usb_unconfigure(udev, 0);
560 if (index == USB_UNCONFIG_INDEX) {
562 * Leave unallocated when unconfiguring the
563 * device. "usb_unconfigure()" will also reset
564 * the current config number and index.
566 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
567 if (udev->state == USB_STATE_CONFIGURED)
568 usb_set_device_state(udev, USB_STATE_ADDRESSED);
571 /* get the full config descriptor */
572 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
573 /* save some memory */
574 err = usbd_req_get_descriptor_ptr(udev, &cdp,
575 (UDESC_CONFIG << 8) | index);
578 err = usbd_req_get_config_desc_full(udev,
584 /* set the new config descriptor */
588 /* Figure out if the device is self or bus powered. */
590 if ((!udev->flags.uq_bus_powered) &&
591 (cdp->bmAttributes & UC_SELF_POWERED) &&
592 (udev->flags.usb_mode == USB_MODE_HOST)) {
593 /* May be self powered. */
594 if (cdp->bmAttributes & UC_BUS_POWERED) {
595 /* Must ask device. */
596 err = usbd_req_get_device_status(udev, NULL, &ds);
598 DPRINTFN(0, "could not read "
599 "device status: %s\n",
601 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
604 DPRINTF("status=0x%04x \n",
609 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
610 "selfpowered=%d, power=%d\n",
612 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
613 selfpowered, cdp->bMaxPower * 2);
615 /* Check if we have enough power. */
616 power = cdp->bMaxPower * 2;
618 if (udev->parent_hub) {
619 max_power = udev->parent_hub->hub->portpower;
621 max_power = USB_MAX_POWER;
624 if (power > max_power) {
625 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
626 err = USB_ERR_NO_POWER;
629 /* Only update "self_powered" in USB Host Mode */
630 if (udev->flags.usb_mode == USB_MODE_HOST) {
631 udev->flags.self_powered = selfpowered;
634 udev->curr_config_no = cdp->bConfigurationValue;
635 udev->curr_config_index = index;
636 usb_set_device_state(udev, USB_STATE_CONFIGURED);
638 /* Set the actual configuration value. */
639 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
644 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
649 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
655 /* create device nodes for each endpoint */
656 usb_cdev_create(udev);
660 DPRINTF("error=%s\n", usbd_errstr(err));
662 usb_unconfigure(udev, 0);
665 usbd_enum_unlock(udev);
669 /*------------------------------------------------------------------------*
672 * This function will allocate and free USB interfaces and USB endpoints,
673 * parse the USB configuration structure and initialise the USB endpoints
674 * and interfaces. If "iface_index" is not equal to
675 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
676 * alternate_setting to be selected for the given interface. Else the
677 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
678 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
679 * is typically called when setting the configuration or when setting
680 * an alternate interface.
685 *------------------------------------------------------------------------*/
687 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
689 struct usb_idesc_parse_state ips;
690 struct usb_interface_descriptor *id;
691 struct usb_endpoint_descriptor *ed;
692 struct usb_interface *iface;
693 struct usb_endpoint *ep;
701 if (iface_index != USB_IFACE_INDEX_ANY) {
702 /* parameter overload */
712 DPRINTFN(5, "iface_index=%d cmd=%d\n",
715 if (cmd == USB_CFG_FREE)
718 if (cmd == USB_CFG_INIT) {
719 sx_assert(&udev->enum_sx, SA_LOCKED);
721 /* check for in-use endpoints */
723 ep = udev->endpoints;
724 ep_max = udev->endpoints_max;
726 /* look for matching endpoints */
727 if ((iface_index == USB_IFACE_INDEX_ANY) ||
728 (iface_index == ep->iface_index)) {
729 if (ep->refcount_alloc != 0) {
731 * This typically indicates a
732 * more serious error.
734 err = USB_ERR_IN_USE;
737 memset(ep, 0, sizeof(*ep));
738 /* make sure we don't zero the endpoint again */
739 ep->iface_index = USB_IFACE_INDEX_ANY;
749 memset(&ips, 0, sizeof(ips));
754 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
756 iface = udev->ifaces + ips.iface_index;
758 /* check for specific interface match */
760 if (cmd == USB_CFG_INIT) {
761 if ((iface_index != USB_IFACE_INDEX_ANY) &&
762 (iface_index != ips.iface_index)) {
763 /* wrong interface */
765 } else if (alt_index != ips.iface_index_alt) {
766 /* wrong alternate setting */
769 /* initialise interface */
775 /* check for new interface */
776 if (ips.iface_index_alt == 0) {
777 /* update current number of endpoints */
782 /* setup the USB interface structure */
784 /* set alternate index */
785 iface->alt_index = alt_index;
786 /* set default interface parent */
787 if (iface_index == USB_IFACE_INDEX_ANY) {
788 iface->parent_iface_index =
793 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
795 ed = (struct usb_endpoint_descriptor *)id;
799 /* iterate all the endpoint descriptors */
800 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
802 /* check if endpoint limit has been reached */
803 if (temp >= USB_MAX_EP_UNITS) {
804 DPRINTF("Endpoint limit reached\n");
808 ep = udev->endpoints + temp;
813 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
815 DPRINTFN(5, "Found endpoint companion descriptor\n");
817 usb_init_endpoint(udev,
818 ips.iface_index, ed, ecomp, ep);
823 /* find maximum number of endpoints */
829 /* NOTE: It is valid to have no interfaces and no endpoints! */
831 if (cmd == USB_CFG_ALLOC) {
832 udev->ifaces_max = ips.iface_index;
833 #if (USB_HAVE_FIXED_IFACE == 0)
835 if (udev->ifaces_max != 0) {
836 udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max,
837 M_USB, M_WAITOK | M_ZERO);
838 if (udev->ifaces == NULL) {
844 #if (USB_HAVE_FIXED_ENDPOINT == 0)
846 udev->endpoints = malloc(sizeof(*ep) * ep_max,
847 M_USB, M_WAITOK | M_ZERO);
848 if (udev->endpoints == NULL) {
853 udev->endpoints = NULL;
856 USB_BUS_LOCK(udev->bus);
857 udev->endpoints_max = ep_max;
858 /* reset any ongoing clear-stall */
859 udev->ep_curr = NULL;
860 USB_BUS_UNLOCK(udev->bus);
862 #if (USB_HAVE_FIXED_IFACE == 0) || (USB_HAVE_FIXED_ENDPOINT == 0)
866 if (cmd == USB_CFG_ALLOC) {
868 USB_BUS_LOCK(udev->bus);
869 udev->endpoints_max = 0;
870 /* reset any ongoing clear-stall */
871 udev->ep_curr = NULL;
872 USB_BUS_UNLOCK(udev->bus);
874 #if (USB_HAVE_FIXED_IFACE == 0)
875 free(udev->ifaces, M_USB);
878 #if (USB_HAVE_FIXED_ENDPOINT == 0)
879 free(udev->endpoints, M_USB);
880 udev->endpoints = NULL;
882 udev->ifaces_max = 0;
888 /*------------------------------------------------------------------------*
889 * usbd_set_alt_interface_index
891 * This function will select an alternate interface index for the
892 * given interface index. The interface should not be in use when this
893 * function is called. That means there should not be any open USB
894 * transfers. Else an error is returned. If the alternate setting is
895 * already set this function will simply return success. This function
896 * is called in Host mode and Device mode!
901 *------------------------------------------------------------------------*/
903 usbd_set_alt_interface_index(struct usb_device *udev,
904 uint8_t iface_index, uint8_t alt_index)
906 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
910 /* Prevent re-enumeration */
911 do_unlock = usbd_enum_lock(udev);
917 if (iface->alt_index == alt_index) {
919 * Optimise away duplicate setting of
920 * alternate setting in USB Host Mode!
927 * Free all generic FIFOs for this interface, except control
930 usb_fifo_free_wrap(udev, iface_index, 0);
933 err = usb_config_parse(udev, iface_index, alt_index);
937 if (iface->alt_index != alt_index) {
938 /* the alternate setting does not exist */
943 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
944 iface->idesc->bAlternateSetting);
948 usbd_enum_unlock(udev);
952 /*------------------------------------------------------------------------*
953 * usbd_set_endpoint_stall
955 * This function is used to make a BULK or INTERRUPT endpoint send
956 * STALL tokens in USB device mode.
961 *------------------------------------------------------------------------*/
963 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
966 struct usb_xfer *xfer;
973 DPRINTF("Cannot find endpoint\n");
975 * Pretend that the clear or set stall request is
976 * successful else some USB host stacks can do
977 * strange things, especially when a control endpoint
982 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
984 if ((et != UE_BULK) &&
985 (et != UE_INTERRUPT)) {
987 * Should not stall control
988 * nor isochronous endpoints.
990 DPRINTF("Invalid endpoint\n");
993 USB_BUS_LOCK(udev->bus);
995 /* store current stall state */
996 was_stalled = ep->is_stalled;
998 /* check for no change */
999 if (was_stalled && do_stall) {
1000 /* if the endpoint is already stalled do nothing */
1001 USB_BUS_UNLOCK(udev->bus);
1002 DPRINTF("No change\n");
1005 /* set stalled state */
1008 if (do_stall || (!was_stalled)) {
1010 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1011 /* lookup the current USB transfer, if any */
1012 xfer = ep->endpoint_q[x].curr;
1015 * The "xfer_stall" method
1016 * will complete the USB
1017 * transfer like in case of a
1018 * timeout setting the error
1019 * code "USB_ERR_STALLED".
1021 (udev->bus->methods->xfer_stall) (xfer);
1025 (udev->bus->methods->set_stall) (udev, ep, &do_stall);
1028 ep->toggle_next = 0; /* reset data toggle */
1029 ep->is_stalled = 0; /* clear stalled state */
1031 (udev->bus->methods->clear_stall) (udev, ep);
1033 /* start the current or next transfer, if any */
1034 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1035 usb_command_wrapper(&ep->endpoint_q[x],
1036 ep->endpoint_q[x].curr);
1039 USB_BUS_UNLOCK(udev->bus);
1043 /*------------------------------------------------------------------------*
1044 * usb_reset_iface_endpoints - used in USB device side mode
1045 *------------------------------------------------------------------------*/
1047 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1049 struct usb_endpoint *ep;
1050 struct usb_endpoint *ep_end;
1052 ep = udev->endpoints;
1053 ep_end = udev->endpoints + udev->endpoints_max;
1055 for (; ep != ep_end; ep++) {
1057 if ((ep->edesc == NULL) ||
1058 (ep->iface_index != iface_index)) {
1061 /* simulate a clear stall from the peer */
1062 usbd_set_endpoint_stall(udev, ep, 0);
1067 /*------------------------------------------------------------------------*
1068 * usb_detach_device_sub
1070 * This function will try to detach an USB device. If it fails a panic
1073 * Flag values, see "USB_UNCFG_FLAG_XXX".
1074 *------------------------------------------------------------------------*/
1076 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1077 char **ppnpinfo, uint8_t flag)
1086 * NOTE: It is important to clear "*ppdev" before deleting
1087 * the child due to some device methods being called late
1088 * during the delete process !
1093 device_printf(dev, "at %s, port %d, addr %d "
1095 device_get_nameunit(udev->parent_dev),
1096 udev->port_no, udev->address);
1099 if (device_is_attached(dev)) {
1100 if (udev->flags.peer_suspended) {
1101 err = DEVICE_RESUME(dev);
1103 device_printf(dev, "Resume failed\n");
1106 if (device_detach(dev)) {
1110 if (device_delete_child(udev->parent_dev, dev)) {
1115 pnpinfo = *ppnpinfo;
1116 if (pnpinfo != NULL) {
1118 free(pnpinfo, M_USBDEV);
1123 /* Detach is not allowed to fail in the USB world */
1124 panic("usb_detach_device_sub: A USB driver would not detach\n");
1127 /*------------------------------------------------------------------------*
1130 * The following function will detach the matching interfaces.
1131 * This function is NULL safe.
1133 * Flag values, see "USB_UNCFG_FLAG_XXX".
1134 *------------------------------------------------------------------------*/
1136 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1139 struct usb_interface *iface;
1146 DPRINTFN(4, "udev=%p\n", udev);
1148 sx_assert(&udev->enum_sx, SA_LOCKED);
1151 * First detach the child to give the child's detach routine a
1152 * chance to detach the sub-devices in the correct order.
1153 * Then delete the child using "device_delete_child()" which
1154 * will detach all sub-devices from the bottom and upwards!
1156 if (iface_index != USB_IFACE_INDEX_ANY) {
1158 iface_index = i + 1;
1161 iface_index = USB_IFACE_MAX;
1166 for (; i != iface_index; i++) {
1168 iface = usbd_get_iface(udev, i);
1169 if (iface == NULL) {
1170 /* looks like the end of the USB interfaces */
1173 usb_detach_device_sub(udev, &iface->subdev,
1174 &iface->pnpinfo, flag);
1178 /*------------------------------------------------------------------------*
1179 * usb_probe_and_attach_sub
1184 *------------------------------------------------------------------------*/
1186 usb_probe_and_attach_sub(struct usb_device *udev,
1187 struct usb_attach_arg *uaa)
1189 struct usb_interface *iface;
1194 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1195 /* leave interface alone */
1198 dev = iface->subdev;
1201 /* clean up after module unload */
1203 if (device_is_attached(dev)) {
1204 /* already a device there */
1207 /* clear "iface->subdev" as early as possible */
1209 iface->subdev = NULL;
1211 if (device_delete_child(udev->parent_dev, dev)) {
1214 * Panic here, else one can get a double call
1215 * to device_detach(). USB devices should
1216 * never fail on detach!
1218 panic("device_delete_child() failed\n");
1221 if (uaa->temp_dev == NULL) {
1223 /* create a new child */
1224 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1225 if (uaa->temp_dev == NULL) {
1226 device_printf(udev->parent_dev,
1227 "Device creation failed\n");
1228 return (1); /* failure */
1230 device_set_ivars(uaa->temp_dev, uaa);
1231 device_quiet(uaa->temp_dev);
1234 * Set "subdev" before probe and attach so that "devd" gets
1235 * the information it needs.
1237 iface->subdev = uaa->temp_dev;
1239 if (device_probe_and_attach(iface->subdev) == 0) {
1241 * The USB attach arguments are only available during probe
1244 uaa->temp_dev = NULL;
1245 device_set_ivars(iface->subdev, NULL);
1247 if (udev->flags.peer_suspended) {
1248 err = DEVICE_SUSPEND(iface->subdev);
1250 device_printf(iface->subdev, "Suspend failed\n");
1252 return (0); /* success */
1254 /* No USB driver found */
1255 iface->subdev = NULL;
1257 return (1); /* failure */
1260 /*------------------------------------------------------------------------*
1261 * usbd_set_parent_iface
1263 * Using this function will lock the alternate interface setting on an
1264 * interface. It is typically used for multi interface drivers. In USB
1265 * device side mode it is assumed that the alternate interfaces all
1266 * have the same endpoint descriptors. The default parent index value
1267 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1269 *------------------------------------------------------------------------*/
1271 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1272 uint8_t parent_index)
1274 struct usb_interface *iface;
1280 iface = usbd_get_iface(udev, iface_index);
1282 iface->parent_iface_index = parent_index;
1286 usb_init_attach_arg(struct usb_device *udev,
1287 struct usb_attach_arg *uaa)
1289 memset(uaa, 0, sizeof(*uaa));
1292 uaa->usb_mode = udev->flags.usb_mode;
1293 uaa->port = udev->port_no;
1294 uaa->dev_state = UAA_DEV_READY;
1296 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1297 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1298 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1299 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1300 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1301 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1302 uaa->info.bConfigIndex = udev->curr_config_index;
1303 uaa->info.bConfigNum = udev->curr_config_no;
1306 /*------------------------------------------------------------------------*
1307 * usb_probe_and_attach
1309 * This function is called from "uhub_explore_sub()",
1310 * "usb_handle_set_config()" and "usb_handle_request()".
1314 * Else: A control transfer failed
1315 *------------------------------------------------------------------------*/
1317 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1319 struct usb_attach_arg uaa;
1320 struct usb_interface *iface;
1326 DPRINTF("udev == NULL\n");
1327 return (USB_ERR_INVAL);
1329 /* Prevent re-enumeration */
1330 do_unlock = usbd_enum_lock(udev);
1332 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1333 /* do nothing - no configuration has been set */
1336 /* setup USB attach arguments */
1338 usb_init_attach_arg(udev, &uaa);
1341 * If the whole USB device is targeted, invoke the USB event
1344 if (iface_index == USB_IFACE_INDEX_ANY) {
1346 if (usb_test_quirk(&uaa, UQ_MSC_DYMO_EJECT) != 0 &&
1347 usb_dymo_eject(udev, 0) == 0) {
1348 /* success, mark the udev as disappearing */
1349 uaa.dev_state = UAA_DEV_EJECTING;
1352 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1354 if (uaa.dev_state != UAA_DEV_READY) {
1355 /* leave device unconfigured */
1356 usb_unconfigure(udev, 0);
1361 /* Check if only one interface should be probed: */
1362 if (iface_index != USB_IFACE_INDEX_ANY) {
1370 /* Do the probe and attach */
1371 for (; i != j; i++) {
1373 iface = usbd_get_iface(udev, i);
1374 if (iface == NULL) {
1376 * Looks like the end of the USB
1379 DPRINTFN(2, "end of interfaces "
1383 if (iface->idesc == NULL) {
1384 /* no interface descriptor */
1389 uaa.info.bInterfaceClass =
1390 iface->idesc->bInterfaceClass;
1391 uaa.info.bInterfaceSubClass =
1392 iface->idesc->bInterfaceSubClass;
1393 uaa.info.bInterfaceProtocol =
1394 iface->idesc->bInterfaceProtocol;
1395 uaa.info.bIfaceIndex = i;
1396 uaa.info.bIfaceNum =
1397 iface->idesc->bInterfaceNumber;
1398 uaa.driver_info = 0; /* reset driver_info */
1400 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1401 uaa.info.bInterfaceClass,
1402 uaa.info.bInterfaceSubClass,
1403 uaa.info.bInterfaceProtocol,
1404 uaa.info.bIfaceIndex,
1405 uaa.info.bIfaceNum);
1407 usb_probe_and_attach_sub(udev, &uaa);
1410 * Remove the leftover child, if any, to enforce that
1411 * a new nomatch devd event is generated for the next
1412 * interface if no driver is found:
1414 if (uaa.temp_dev == NULL)
1416 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1417 DPRINTFN(0, "device delete child failed\n");
1418 uaa.temp_dev = NULL;
1422 usbd_enum_unlock(udev);
1426 /*------------------------------------------------------------------------*
1427 * usb_suspend_resume_sub
1429 * This function is called when the suspend or resume methods should
1430 * be executed on an USB device.
1431 *------------------------------------------------------------------------*/
1433 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1440 if (!device_is_attached(dev)) {
1444 err = DEVICE_SUSPEND(dev);
1446 err = DEVICE_RESUME(dev);
1449 device_printf(dev, "%s failed\n",
1450 do_suspend ? "Suspend" : "Resume");
1454 /*------------------------------------------------------------------------*
1455 * usb_suspend_resume
1457 * The following function will suspend or resume the USB device.
1462 *------------------------------------------------------------------------*/
1464 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1466 struct usb_interface *iface;
1473 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1475 sx_assert(&udev->sr_sx, SA_LOCKED);
1477 USB_BUS_LOCK(udev->bus);
1478 /* filter the suspend events */
1479 if (udev->flags.peer_suspended == do_suspend) {
1480 USB_BUS_UNLOCK(udev->bus);
1484 udev->flags.peer_suspended = do_suspend;
1485 USB_BUS_UNLOCK(udev->bus);
1487 /* do the suspend or resume */
1489 for (i = 0; i != USB_IFACE_MAX; i++) {
1491 iface = usbd_get_iface(udev, i);
1492 if (iface == NULL) {
1493 /* looks like the end of the USB interfaces */
1496 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1501 /*------------------------------------------------------------------------*
1502 * usbd_clear_stall_proc
1504 * This function performs generic USB clear stall operations.
1505 *------------------------------------------------------------------------*/
1507 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1509 struct usb_udev_msg *pm = (void *)_pm;
1510 struct usb_device *udev = pm->udev;
1513 USB_BUS_UNLOCK(udev->bus);
1514 mtx_lock(&udev->device_mtx);
1516 /* Start clear stall callback */
1517 usbd_transfer_start(udev->ctrl_xfer[1]);
1520 mtx_unlock(&udev->device_mtx);
1521 USB_BUS_LOCK(udev->bus);
1524 /*------------------------------------------------------------------------*
1527 * This function allocates a new USB device. This function is called
1528 * when a new device has been put in the powered state, but not yet in
1529 * the addressed state. Get initial descriptor, set the address, get
1530 * full descriptor and get strings.
1535 *------------------------------------------------------------------------*/
1537 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1538 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1539 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1541 struct usb_attach_arg uaa;
1542 struct usb_device *udev;
1543 struct usb_device *adev;
1544 struct usb_device *hub;
1545 uint8_t *scratch_ptr;
1547 uint8_t device_index;
1548 uint8_t config_index;
1549 uint8_t config_quirk;
1550 uint8_t set_config_failed;
1553 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1554 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1555 parent_dev, bus, parent_hub, depth, port_index, port_no,
1559 * Find an unused device index. In USB Host mode this is the
1560 * same as the device address.
1562 * Device index zero is not used and device index 1 should
1563 * always be the root hub.
1565 for (device_index = USB_ROOT_HUB_ADDR;
1566 (device_index != bus->devices_max) &&
1567 (bus->devices[device_index] != NULL);
1568 device_index++) /* nop */;
1570 if (device_index == bus->devices_max) {
1571 device_printf(bus->bdev,
1572 "No free USB device index for new device\n");
1577 device_printf(bus->bdev,
1578 "Invalid device depth\n");
1581 udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1585 /* initialise our SX-lock */
1586 sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1587 sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS);
1589 cv_init(&udev->ctrlreq_cv, "WCTRL");
1590 cv_init(&udev->ref_cv, "UGONE");
1592 /* initialise our mutex */
1593 mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF);
1595 /* initialise generic clear stall */
1596 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1597 udev->cs_msg[0].udev = udev;
1598 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1599 udev->cs_msg[1].udev = udev;
1601 /* initialise some USB device fields */
1602 udev->parent_hub = parent_hub;
1603 udev->parent_dev = parent_dev;
1604 udev->port_index = port_index;
1605 udev->port_no = port_no;
1606 udev->depth = depth;
1608 udev->address = USB_START_ADDR; /* default value */
1609 udev->plugtime = (usb_ticks_t)ticks;
1611 * We need to force the power mode to "on" because there are plenty
1612 * of USB devices out there that do not work very well with
1613 * automatic suspend and resume!
1615 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1616 udev->pwr_save.last_xfer_time = ticks;
1617 /* we are not ready yet */
1620 /* set up default endpoint descriptor */
1621 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1622 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1623 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1624 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1625 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1626 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1627 udev->ctrl_ep_desc.bInterval = 0;
1629 /* set up default endpoint companion descriptor */
1630 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1631 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1633 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1635 udev->speed = speed;
1636 udev->flags.usb_mode = mode;
1638 /* search for our High Speed USB HUB, if any */
1641 hub = udev->parent_hub;
1644 if (hub->speed == USB_SPEED_HIGH) {
1645 udev->hs_hub_addr = hub->address;
1646 udev->parent_hs_hub = hub;
1647 udev->hs_port_no = adev->port_no;
1651 hub = hub->parent_hub;
1654 /* init the default endpoint */
1655 usb_init_endpoint(udev, 0,
1656 &udev->ctrl_ep_desc,
1657 &udev->ctrl_ep_comp_desc,
1660 /* set device index */
1661 udev->device_index = device_index;
1664 /* Create ugen name */
1665 snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1666 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1668 LIST_INIT(&udev->pd_list);
1670 /* Create the control endpoint device */
1671 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1672 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1674 /* Create a link from /dev/ugenX.X to the default endpoint */
1675 if (udev->ctrl_dev != NULL)
1676 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1678 /* Initialise device */
1679 if (bus->methods->device_init != NULL) {
1680 err = (bus->methods->device_init) (udev);
1682 DPRINTFN(0, "device init %d failed "
1683 "(%s, ignored)\n", device_index,
1688 /* set powered device state after device init is complete */
1689 usb_set_device_state(udev, USB_STATE_POWERED);
1691 if (udev->flags.usb_mode == USB_MODE_HOST) {
1693 err = usbd_req_set_address(udev, NULL, device_index);
1696 * This is the new USB device address from now on, if
1697 * the set address request didn't set it already.
1699 if (udev->address == USB_START_ADDR)
1700 udev->address = device_index;
1703 * We ignore any set-address errors, hence there are
1704 * buggy USB devices out there that actually receive
1705 * the SETUP PID, but manage to set the address before
1706 * the STATUS stage is ACK'ed. If the device responds
1707 * to the subsequent get-descriptor at the new
1708 * address, then we know that the set-address command
1712 DPRINTFN(0, "set address %d failed "
1713 "(%s, ignored)\n", udev->address,
1717 /* We are not self powered */
1718 udev->flags.self_powered = 0;
1720 /* Set unconfigured state */
1721 udev->curr_config_no = USB_UNCONFIG_NO;
1722 udev->curr_config_index = USB_UNCONFIG_INDEX;
1724 /* Setup USB descriptors */
1725 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1727 DPRINTFN(0, "setting up USB template failed maybe the USB "
1728 "template module has not been loaded\n");
1732 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1734 /* setup the device descriptor and the initial "wMaxPacketSize" */
1735 err = usbd_setup_device_desc(udev, NULL);
1738 /* try to enumerate two more times */
1739 err = usbd_req_re_enumerate(udev, NULL);
1741 err = usbd_req_re_enumerate(udev, NULL);
1749 * Setup temporary USB attach args so that we can figure out some
1750 * basic quirks for this device.
1752 usb_init_attach_arg(udev, &uaa);
1754 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1755 udev->flags.uq_bus_powered = 1;
1757 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1758 udev->flags.no_strings = 1;
1761 * Workaround for buggy USB devices.
1763 * It appears that some string-less USB chips will crash and
1764 * disappear if any attempts are made to read any string
1767 * Try to detect such chips by checking the strings in the USB
1768 * device descriptor. If no strings are present there we
1769 * simply disable all USB strings.
1772 /* Protect scratch area */
1773 do_unlock = usbd_enum_lock(udev);
1775 scratch_ptr = udev->scratch.data;
1777 if (udev->ddesc.iManufacturer ||
1778 udev->ddesc.iProduct ||
1779 udev->ddesc.iSerialNumber) {
1780 /* read out the language ID string */
1781 err = usbd_req_get_string_desc(udev, NULL,
1782 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1784 err = USB_ERR_INVAL;
1787 if (err || (scratch_ptr[0] < 4)) {
1788 udev->flags.no_strings = 1;
1795 /* load preferred value and mask */
1797 mask = usb_lang_mask;
1799 /* align length correctly */
1800 scratch_ptr[0] &= ~1U;
1802 /* fix compiler warning */
1805 /* search for preferred language */
1806 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1807 langid = UGETW(scratch_ptr + x);
1808 if ((langid & mask) == pref)
1811 if (x >= scratch_ptr[0]) {
1812 /* pick the first language as the default */
1813 DPRINTFN(1, "Using first language\n");
1814 langid = UGETW(scratch_ptr + 2);
1817 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1818 udev->langid = langid;
1822 usbd_enum_unlock(udev);
1824 /* assume 100mA bus powered for now. Changed when configured. */
1825 udev->power = USB_MIN_POWER;
1826 /* fetch the vendor and product strings from the device */
1827 usbd_set_device_strings(udev);
1829 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1830 /* USB device mode setup is complete */
1836 * Most USB devices should attach to config index 0 by
1839 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1842 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1845 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1848 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1851 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1859 set_config_failed = 0;
1862 DPRINTF("setting config %u\n", config_index);
1864 /* get the USB device configured */
1865 err = usbd_set_config_index(udev, config_index);
1867 if (udev->ddesc.bNumConfigurations != 0) {
1868 if (!set_config_failed) {
1869 set_config_failed = 1;
1870 /* XXX try to re-enumerate the device */
1871 err = usbd_req_re_enumerate(udev, NULL);
1873 goto repeat_set_config;
1875 DPRINTFN(0, "Failure selecting configuration index %u:"
1876 "%s, port %u, addr %u (ignored)\n",
1877 config_index, usbd_errstr(err), udev->port_no,
1881 * Some USB devices do not have any configurations. Ignore any
1882 * set config failures!
1887 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1888 if ((udev->cdesc->bNumInterface < 2) &&
1889 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1890 DPRINTFN(0, "Found no endpoints, trying next config\n");
1892 goto repeat_set_config;
1894 #if USB_HAVE_MSCTEST
1895 if (config_index == 0) {
1897 * Try to figure out if we have an
1898 * auto-install disk there:
1900 if (usb_iface_is_cdrom(udev, 0)) {
1901 DPRINTFN(0, "Found possible auto-install "
1902 "disk (trying next config)\n");
1904 goto repeat_set_config;
1909 #if USB_HAVE_MSCTEST
1910 if (set_config_failed == 0 && config_index == 0 &&
1911 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1912 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1915 * Try to figure out if there are any MSC quirks we
1916 * should apply automatically:
1918 err = usb_msc_auto_quirk(udev, 0);
1921 set_config_failed = 1;
1922 goto repeat_set_config;
1928 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1929 udev->address, udev, udev->parent_hub);
1931 /* register our device - we are ready */
1932 usb_bus_port_set_device(bus, parent_hub ?
1933 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1936 /* Symlink the ugen device name */
1937 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1939 /* Announce device */
1940 printf("%s: <%s> at %s\n", udev->ugen_name,
1941 usb_get_manufacturer(udev),
1942 device_get_nameunit(udev->bus->bdev));
1946 usb_notify_addq("ATTACH", udev);
1951 * Free USB device and all subdevices, if any.
1953 usb_free_device(udev, 0);
1960 struct usb_fs_privdata *
1961 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1962 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1964 struct usb_fs_privdata* pd;
1967 /* Store information to locate ourselves again later */
1968 pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1970 pd->bus_index = device_get_unit(udev->bus->bdev);
1971 pd->dev_index = udev->device_index;
1973 pd->fifo_index = fi;
1976 /* Now, create the device itself */
1977 if (devname == NULL) {
1979 snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1980 pd->bus_index, pd->dev_index, pd->ep_addr);
1983 pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname);
1985 if (pd->cdev == NULL) {
1986 DPRINTFN(0, "Failed to create device %s\n", devname);
1991 /* XXX setting si_drv1 and creating the device is not atomic! */
1992 pd->cdev->si_drv1 = pd;
1998 usb_destroy_dev_sync(struct usb_fs_privdata *pd)
2000 DPRINTFN(1, "Destroying device at ugen%d.%d\n",
2001 pd->bus_index, pd->dev_index);
2004 * Destroy character device synchronously. After this
2005 * all system calls are returned. Can block.
2007 destroy_dev(pd->cdev);
2013 usb_destroy_dev(struct usb_fs_privdata *pd)
2015 struct usb_bus *bus;
2020 mtx_lock(&usb_ref_lock);
2021 bus = devclass_get_softc(usb_devclass_ptr, pd->bus_index);
2022 mtx_unlock(&usb_ref_lock);
2025 usb_destroy_dev_sync(pd);
2029 /* make sure we can re-use the device name */
2030 delist_dev(pd->cdev);
2033 LIST_INSERT_HEAD(&bus->pd_cleanup_list, pd, pd_next);
2034 /* get cleanup going */
2035 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
2036 &bus->cleanup_msg[0], &bus->cleanup_msg[1]);
2037 USB_BUS_UNLOCK(bus);
2041 usb_cdev_create(struct usb_device *udev)
2043 struct usb_config_descriptor *cd;
2044 struct usb_endpoint_descriptor *ed;
2045 struct usb_descriptor *desc;
2046 struct usb_fs_privdata* pd;
2047 int inmode, outmode, inmask, outmask, mode;
2050 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2052 DPRINTFN(2, "Creating device nodes\n");
2054 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2057 } else { /* USB_MODE_HOST */
2067 * Collect all used endpoint numbers instead of just
2068 * generating 16 static endpoints.
2070 cd = usbd_get_config_descriptor(udev);
2071 while ((desc = usb_desc_foreach(cd, desc))) {
2072 /* filter out all endpoint descriptors */
2073 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2074 (desc->bLength >= sizeof(*ed))) {
2075 ed = (struct usb_endpoint_descriptor *)desc;
2078 ep = ed->bEndpointAddress;
2079 if (UE_GET_DIR(ep) == UE_DIR_OUT)
2080 outmask |= 1 << UE_GET_ADDR(ep);
2082 inmask |= 1 << UE_GET_ADDR(ep);
2086 /* Create all available endpoints except EP0 */
2087 for (ep = 1; ep < 16; ep++) {
2088 mode = (inmask & (1 << ep)) ? inmode : 0;
2089 mode |= (outmask & (1 << ep)) ? outmode : 0;
2091 continue; /* no IN or OUT endpoint */
2093 pd = usb_make_dev(udev, NULL, ep, 0,
2094 mode, UID_ROOT, GID_OPERATOR, 0600);
2097 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2102 usb_cdev_free(struct usb_device *udev)
2104 struct usb_fs_privdata* pd;
2106 DPRINTFN(2, "Freeing device nodes\n");
2108 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2109 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2111 LIST_REMOVE(pd, pd_next);
2113 usb_destroy_dev(pd);
2118 /*------------------------------------------------------------------------*
2121 * This function is NULL safe and will free an USB device and its
2122 * children devices, if any.
2124 * Flag values: Reserved, set to zero.
2125 *------------------------------------------------------------------------*/
2127 usb_free_device(struct usb_device *udev, uint8_t flag)
2129 struct usb_bus *bus;
2132 return; /* already freed */
2134 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2138 /* set DETACHED state to prevent any further references */
2139 usb_set_device_state(udev, USB_STATE_DETACHED);
2142 usb_notify_addq("DETACH", udev);
2147 printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2148 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2151 /* Destroy UGEN symlink, if any */
2152 if (udev->ugen_symlink) {
2153 usb_free_symlink(udev->ugen_symlink);
2154 udev->ugen_symlink = NULL;
2157 usb_destroy_dev(udev->ctrl_dev);
2160 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2161 /* stop receiving any control transfers (Device Side Mode) */
2162 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2165 /* the following will get the device unconfigured in software */
2166 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2168 /* final device unregister after all character devices are closed */
2169 usb_bus_port_set_device(bus, udev->parent_hub ?
2170 udev->parent_hub->hub->ports + udev->port_index : NULL,
2171 NULL, USB_ROOT_HUB_ADDR);
2173 /* unsetup any leftover default USB transfers */
2174 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2176 /* template unsetup, if any */
2177 (usb_temp_unsetup_p) (udev);
2180 * Make sure that our clear-stall messages are not queued
2183 USB_BUS_LOCK(udev->bus);
2184 usb_proc_mwait(USB_BUS_CS_PROC(udev->bus),
2185 &udev->cs_msg[0], &udev->cs_msg[1]);
2186 USB_BUS_UNLOCK(udev->bus);
2188 /* wait for all references to go away */
2189 usb_wait_pending_refs(udev);
2191 sx_destroy(&udev->enum_sx);
2192 sx_destroy(&udev->sr_sx);
2194 cv_destroy(&udev->ctrlreq_cv);
2195 cv_destroy(&udev->ref_cv);
2197 mtx_destroy(&udev->device_mtx);
2199 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2202 /* Uninitialise device */
2203 if (bus->methods->device_uninit != NULL)
2204 (bus->methods->device_uninit) (udev);
2207 free(udev->serial, M_USB);
2208 free(udev->manufacturer, M_USB);
2209 free(udev->product, M_USB);
2213 /*------------------------------------------------------------------------*
2216 * This function is the safe way to get the USB interface structure
2217 * pointer by interface index.
2220 * NULL: Interface not present.
2221 * Else: Pointer to USB interface structure.
2222 *------------------------------------------------------------------------*/
2223 struct usb_interface *
2224 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2226 struct usb_interface *iface = udev->ifaces + iface_index;
2228 if (iface_index >= udev->ifaces_max)
2233 /*------------------------------------------------------------------------*
2234 * usbd_find_descriptor
2236 * This function will lookup the first descriptor that matches the
2237 * criteria given by the arguments "type" and "subtype". Descriptors
2238 * will only be searched within the interface having the index
2239 * "iface_index". If the "id" argument points to an USB descriptor,
2240 * it will be skipped before the search is started. This allows
2241 * searching for multiple descriptors using the same criteria. Else
2242 * the search is started after the interface descriptor.
2245 * NULL: End of descriptors
2246 * Else: A descriptor matching the criteria
2247 *------------------------------------------------------------------------*/
2249 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2250 uint8_t type, uint8_t type_mask,
2251 uint8_t subtype, uint8_t subtype_mask)
2253 struct usb_descriptor *desc;
2254 struct usb_config_descriptor *cd;
2255 struct usb_interface *iface;
2257 cd = usbd_get_config_descriptor(udev);
2262 iface = usbd_get_iface(udev, iface_index);
2263 if (iface == NULL) {
2266 id = usbd_get_interface_descriptor(iface);
2273 while ((desc = usb_desc_foreach(cd, desc))) {
2275 if (desc->bDescriptorType == UDESC_INTERFACE) {
2278 if (((desc->bDescriptorType & type_mask) == type) &&
2279 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2286 /*------------------------------------------------------------------------*
2289 * This function will dump information from the device descriptor
2290 * belonging to the USB device pointed to by "udev", to the string
2291 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2292 * including the terminating zero.
2293 *------------------------------------------------------------------------*/
2295 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2297 struct usb_device_descriptor *udd = &udev->ddesc;
2301 bcdUSB = UGETW(udd->bcdUSB);
2302 bcdDevice = UGETW(udd->bcdDevice);
2304 if (udd->bDeviceClass != 0xFF) {
2305 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2307 usb_get_manufacturer(udev),
2308 usb_get_product(udev),
2309 udd->bDeviceClass, udd->bDeviceSubClass,
2310 (bcdUSB >> 8), bcdUSB & 0xFF,
2311 (bcdDevice >> 8), bcdDevice & 0xFF,
2314 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2316 usb_get_manufacturer(udev),
2317 usb_get_product(udev),
2318 (bcdUSB >> 8), bcdUSB & 0xFF,
2319 (bcdDevice >> 8), bcdDevice & 0xFF,
2326 * Descriptions of of known vendors and devices ("products").
2328 struct usb_knowndev {
2332 const char *vendorname;
2333 const char *productname;
2336 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2338 #include "usbdevs.h"
2339 #include "usbdevs_data.h"
2340 #endif /* USB_VERBOSE */
2343 usbd_set_device_strings(struct usb_device *udev)
2345 struct usb_device_descriptor *udd = &udev->ddesc;
2347 const struct usb_knowndev *kdp;
2352 uint16_t product_id;
2355 /* Protect scratch area */
2356 do_unlock = usbd_enum_lock(udev);
2358 temp_ptr = (char *)udev->scratch.data;
2359 temp_size = sizeof(udev->scratch.data);
2361 vendor_id = UGETW(udd->idVendor);
2362 product_id = UGETW(udd->idProduct);
2364 /* get serial number string */
2365 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2366 udev->ddesc.iSerialNumber);
2367 udev->serial = strdup(temp_ptr, M_USB);
2369 /* get manufacturer string */
2370 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2371 udev->ddesc.iManufacturer);
2372 usb_trim_spaces(temp_ptr);
2373 if (temp_ptr[0] != '\0')
2374 udev->manufacturer = strdup(temp_ptr, M_USB);
2376 /* get product string */
2377 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2378 udev->ddesc.iProduct);
2379 usb_trim_spaces(temp_ptr);
2380 if (temp_ptr[0] != '\0')
2381 udev->product = strdup(temp_ptr, M_USB);
2384 if (udev->manufacturer == NULL || udev->product == NULL) {
2385 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2386 if (kdp->vendor == vendor_id &&
2387 (kdp->product == product_id ||
2388 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2391 if (kdp->vendorname != NULL) {
2392 /* XXX should use pointer to knowndevs string */
2393 if (udev->manufacturer == NULL) {
2394 udev->manufacturer = strdup(kdp->vendorname,
2397 if (udev->product == NULL &&
2398 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2399 udev->product = strdup(kdp->productname,
2405 /* Provide default strings if none were found */
2406 if (udev->manufacturer == NULL) {
2407 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2408 udev->manufacturer = strdup(temp_ptr, M_USB);
2410 if (udev->product == NULL) {
2411 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2412 udev->product = strdup(temp_ptr, M_USB);
2416 usbd_enum_unlock(udev);
2424 usbd_get_mode(struct usb_device *udev)
2426 return (udev->flags.usb_mode);
2431 * See: USB_SPEED_XXX
2434 usbd_get_speed(struct usb_device *udev)
2436 return (udev->speed);
2440 usbd_get_isoc_fps(struct usb_device *udev)
2443 switch (udev->speed) {
2445 case USB_SPEED_FULL:
2452 struct usb_device_descriptor *
2453 usbd_get_device_descriptor(struct usb_device *udev)
2456 return (NULL); /* be NULL safe */
2457 return (&udev->ddesc);
2460 struct usb_config_descriptor *
2461 usbd_get_config_descriptor(struct usb_device *udev)
2464 return (NULL); /* be NULL safe */
2465 return (udev->cdesc);
2468 /*------------------------------------------------------------------------*
2469 * usb_test_quirk - test a device for a given quirk
2472 * 0: The USB device does not have the given quirk.
2473 * Else: The USB device has the given quirk.
2474 *------------------------------------------------------------------------*/
2476 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2481 if (quirk == UQ_NONE)
2484 /* search the automatic per device quirks first */
2486 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2487 if (uaa->device->autoQuirk[x] == quirk)
2491 /* search global quirk table, if any */
2493 found = (usb_test_quirk_p) (&uaa->info, quirk);
2498 struct usb_interface_descriptor *
2499 usbd_get_interface_descriptor(struct usb_interface *iface)
2502 return (NULL); /* be NULL safe */
2503 return (iface->idesc);
2507 usbd_get_interface_altindex(struct usb_interface *iface)
2509 return (iface->alt_index);
2513 usbd_get_bus_index(struct usb_device *udev)
2515 return ((uint8_t)device_get_unit(udev->bus->bdev));
2519 usbd_get_device_index(struct usb_device *udev)
2521 return (udev->device_index);
2526 usb_notify_addq(const char *type, struct usb_device *udev)
2528 struct usb_interface *iface;
2532 /* announce the device */
2533 sb = sbuf_new_auto();
2542 "devsubclass=0x%02x "
2555 UGETW(udev->ddesc.idVendor),
2556 UGETW(udev->ddesc.idProduct),
2557 udev->ddesc.bDeviceClass,
2558 udev->ddesc.bDeviceSubClass,
2559 usb_get_serial(udev),
2560 UGETW(udev->ddesc.bcdDevice),
2561 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2564 , udev->parent_hub != NULL ?
2565 udev->parent_hub->ugen_name :
2566 device_get_nameunit(device_get_parent(udev->bus->bdev))
2570 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2573 /* announce each interface */
2574 for (i = 0; i < USB_IFACE_MAX; i++) {
2575 iface = usbd_get_iface(udev, i);
2577 break; /* end of interfaces */
2578 if (iface->idesc == NULL)
2579 continue; /* no interface descriptor */
2581 sb = sbuf_new_auto();
2590 "devsubclass=0x%02x "
2597 "intsubclass=0x%02x "
2598 "intprotocol=0x%02x",
2603 UGETW(udev->ddesc.idVendor),
2604 UGETW(udev->ddesc.idProduct),
2605 udev->ddesc.bDeviceClass,
2606 udev->ddesc.bDeviceSubClass,
2607 usb_get_serial(udev),
2608 UGETW(udev->ddesc.bcdDevice),
2609 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2610 iface->idesc->bInterfaceNumber,
2611 iface->idesc->bNumEndpoints,
2612 iface->idesc->bInterfaceClass,
2613 iface->idesc->bInterfaceSubClass,
2614 iface->idesc->bInterfaceProtocol);
2616 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2623 /*------------------------------------------------------------------------*
2624 * usb_fifo_free_wrap
2626 * This function will free the FIFOs.
2628 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2629 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2630 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2631 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2632 * control endpoint FIFOs. If "iface_index" is not set to
2633 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2634 *------------------------------------------------------------------------*/
2636 usb_fifo_free_wrap(struct usb_device *udev,
2637 uint8_t iface_index, uint8_t flag)
2643 * Free any USB FIFOs on the given interface:
2645 for (i = 0; i != USB_FIFO_MAX; i++) {
2650 /* Check if the interface index matches */
2651 if (iface_index == f->iface_index) {
2652 if (f->methods != &usb_ugen_methods) {
2654 * Don't free any non-generic FIFOs in
2659 if ((f->dev_ep_index == 0) &&
2660 (f->fs_xfer == NULL)) {
2661 /* no need to free this FIFO */
2664 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2665 if ((f->methods == &usb_ugen_methods) &&
2666 (f->dev_ep_index == 0) &&
2667 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2668 (f->fs_xfer == NULL)) {
2669 /* no need to free this FIFO */
2673 /* no need to free this FIFO */
2676 /* free this FIFO */
2682 /*------------------------------------------------------------------------*
2683 * usb_peer_can_wakeup
2686 * 0: Peer cannot do resume signalling.
2687 * Else: Peer can do resume signalling.
2688 *------------------------------------------------------------------------*/
2690 usb_peer_can_wakeup(struct usb_device *udev)
2692 const struct usb_config_descriptor *cdp;
2695 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2696 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2698 return (0); /* not supported */
2702 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2705 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2707 DPRINTF("udev %p state %s -> %s\n", udev,
2708 usb_statestr(udev->state), usb_statestr(state));
2711 mtx_lock(&usb_ref_lock);
2713 udev->state = state;
2715 mtx_unlock(&usb_ref_lock);
2717 if (udev->bus->methods->device_state_change != NULL)
2718 (udev->bus->methods->device_state_change) (udev);
2722 usb_get_device_state(struct usb_device *udev)
2725 return (USB_STATE_DETACHED);
2726 return (udev->state);
2730 usbd_device_attached(struct usb_device *udev)
2732 return (udev->state > USB_STATE_DETACHED);
2736 * The following function locks enumerating the given USB device. If
2737 * the lock is already grabbed this function returns zero. Else a
2738 * non-zero value is returned.
2741 usbd_enum_lock(struct usb_device *udev)
2743 if (sx_xlocked(&udev->enum_sx))
2746 sx_xlock(&udev->enum_sx);
2747 sx_xlock(&udev->sr_sx);
2749 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2750 * are locked before locking Giant. Else the lock can be
2751 * locked multiple times.
2757 /* The following function unlocks enumerating the given USB device. */
2760 usbd_enum_unlock(struct usb_device *udev)
2763 sx_xunlock(&udev->enum_sx);
2764 sx_xunlock(&udev->sr_sx);
2767 /* The following function locks suspend and resume. */
2770 usbd_sr_lock(struct usb_device *udev)
2772 sx_xlock(&udev->sr_sx);
2774 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2775 * are locked before locking Giant. Else the lock can be
2776 * locked multiple times.
2781 /* The following function unlocks suspend and resume. */
2784 usbd_sr_unlock(struct usb_device *udev)
2787 sx_xunlock(&udev->sr_sx);
2791 * The following function checks the enumerating lock for the given
2796 usbd_enum_is_locked(struct usb_device *udev)
2798 return (sx_xlocked(&udev->enum_sx));
2802 * The following function is used to set the per-interface specific
2803 * plug and play information. The string referred to by the pnpinfo
2804 * argument can safely be freed after calling this function. The
2805 * pnpinfo of an interface will be reset at device detach or when
2806 * passing a NULL argument to this function. This function
2807 * returns zero on success, else a USB_ERR_XXX failure code.
2811 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2813 struct usb_interface *iface;
2815 iface = usbd_get_iface(udev, iface_index);
2817 return (USB_ERR_INVAL);
2819 if (iface->pnpinfo != NULL) {
2820 free(iface->pnpinfo, M_USBDEV);
2821 iface->pnpinfo = NULL;
2824 if (pnpinfo == NULL || pnpinfo[0] == 0)
2825 return (0); /* success */
2827 iface->pnpinfo = strdup(pnpinfo, M_USBDEV);
2828 if (iface->pnpinfo == NULL)
2829 return (USB_ERR_NOMEM);
2831 return (0); /* success */
2835 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2839 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2840 if (udev->autoQuirk[x] == 0 ||
2841 udev->autoQuirk[x] == quirk) {
2842 udev->autoQuirk[x] = quirk;
2843 return (0); /* success */
2846 return (USB_ERR_NOMEM);
2850 * The following function is used to select the endpoint mode. It
2851 * should not be called outside enumeration context.
2855 usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep,
2861 /* Prevent re-enumeration */
2862 do_unlock = usbd_enum_lock(udev);
2864 if (udev->bus->methods->set_endpoint_mode != NULL) {
2865 error = (udev->bus->methods->set_endpoint_mode) (
2867 } else if (ep_mode != USB_EP_MODE_DEFAULT) {
2868 error = USB_ERR_INVAL;
2873 /* only set new mode regardless of error */
2874 ep->ep_mode = ep_mode;
2877 usbd_enum_unlock(udev);
2882 usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep)
2884 return (ep->ep_mode);