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 TUNABLE_INT("hw.usb.usb_template", &usb_template);
122 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW | CTLFLAG_TUN,
123 &usb_template, 0, "Selected USB device side template");
125 /* English is default language */
127 static int usb_lang_id = 0x0009;
128 static int usb_lang_mask = 0x00FF;
130 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
131 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW | CTLFLAG_TUN,
132 &usb_lang_id, 0, "Preferred USB language ID");
134 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
135 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW | CTLFLAG_TUN,
136 &usb_lang_mask, 0, "Preferred USB language mask");
138 static const char* statestr[USB_STATE_MAX] = {
139 [USB_STATE_DETACHED] = "DETACHED",
140 [USB_STATE_ATTACHED] = "ATTACHED",
141 [USB_STATE_POWERED] = "POWERED",
142 [USB_STATE_ADDRESSED] = "ADDRESSED",
143 [USB_STATE_CONFIGURED] = "CONFIGURED",
147 usb_statestr(enum usb_dev_state state)
149 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
153 usb_get_manufacturer(struct usb_device *udev)
155 return (udev->manufacturer ? udev->manufacturer : "Unknown");
159 usb_get_product(struct usb_device *udev)
161 return (udev->product ? udev->product : "");
165 usb_get_serial(struct usb_device *udev)
167 return (udev->serial ? udev->serial : "");
170 /*------------------------------------------------------------------------*
171 * usbd_get_ep_by_addr
173 * This function searches for an USB ep by endpoint address and
179 *------------------------------------------------------------------------*/
180 struct usb_endpoint *
181 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
183 struct usb_endpoint *ep = udev->endpoints;
184 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
186 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
190 * According to the USB specification not all bits are used
191 * for the endpoint address. Keep defined bits only:
196 * Iterate accross all the USB endpoints searching for a match
197 * based on the endpoint address:
199 for (; ep != ep_end; ep++) {
201 if (ep->edesc == NULL) {
204 /* do the mask and check the value */
205 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
211 * The default endpoint is always present and is checked separately:
213 if ((udev->ctrl_ep.edesc != NULL) &&
214 ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
224 /*------------------------------------------------------------------------*
227 * This function searches for an USB endpoint based on the information
228 * given by the passed "struct usb_config" pointer.
232 * Else: Pointer to "struct usb_endpoint".
233 *------------------------------------------------------------------------*/
234 struct usb_endpoint *
235 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
236 const struct usb_config *setup)
238 struct usb_endpoint *ep = udev->endpoints;
239 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
240 uint8_t index = setup->ep_index;
246 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
247 "type=0x%x dir=0x%x index=%d\n",
248 udev, iface_index, setup->endpoint,
249 setup->type, setup->direction, setup->ep_index);
253 if (setup->usb_mode != USB_MODE_DUAL &&
254 udev->flags.usb_mode != setup->usb_mode) {
255 /* wrong mode - no endpoint */
259 /* setup expected endpoint direction mask and value */
261 if (setup->direction == UE_DIR_RX) {
262 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
263 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
264 UE_DIR_OUT : UE_DIR_IN;
265 } else if (setup->direction == UE_DIR_TX) {
266 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
267 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
268 UE_DIR_IN : UE_DIR_OUT;
269 } else if (setup->direction == UE_DIR_ANY) {
270 /* match any endpoint direction */
274 /* match the given endpoint direction */
275 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
276 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
279 /* setup expected endpoint address */
281 if (setup->endpoint == UE_ADDR_ANY) {
282 /* match any endpoint address */
284 /* match the given endpoint address */
286 ea_val |= (setup->endpoint & UE_ADDR);
289 /* setup expected endpoint type */
291 if (setup->type == UE_BULK_INTR) {
292 /* this will match BULK and INTERRUPT endpoints */
295 } else if (setup->type == UE_TYPE_ANY) {
296 /* match any endpoint type */
300 /* match the given endpoint type */
301 type_mask = UE_XFERTYPE;
302 type_val = (setup->type & UE_XFERTYPE);
306 * Iterate accross all the USB endpoints searching for a match
307 * based on the endpoint address. Note that we are searching
308 * the endpoints from the beginning of the "udev->endpoints" array.
310 for (; ep != ep_end; ep++) {
312 if ((ep->edesc == NULL) ||
313 (ep->iface_index != iface_index)) {
316 /* do the masks and check the values */
318 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
319 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
327 * Match against default endpoint last, so that "any endpoint", "any
328 * address" and "any direction" returns the first endpoint of the
329 * interface. "iface_index" and "direction" is ignored:
331 if ((udev->ctrl_ep.edesc != NULL) &&
332 ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
333 ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
344 /*------------------------------------------------------------------------*
345 * usbd_interface_count
347 * This function stores the number of USB interfaces excluding
348 * alternate settings, which the USB config descriptor reports into
349 * the unsigned 8-bit integer pointed to by "count".
354 *------------------------------------------------------------------------*/
356 usbd_interface_count(struct usb_device *udev, uint8_t *count)
358 if (udev->cdesc == NULL) {
360 return (USB_ERR_NOT_CONFIGURED);
362 *count = udev->ifaces_max;
363 return (USB_ERR_NORMAL_COMPLETION);
366 /*------------------------------------------------------------------------*
369 * This function will initialise the USB endpoint structure pointed to by
370 * the "endpoint" argument. The structure pointed to by "endpoint" must be
371 * zeroed before calling this function.
372 *------------------------------------------------------------------------*/
374 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
375 struct usb_endpoint_descriptor *edesc,
376 struct usb_endpoint_ss_comp_descriptor *ecomp,
377 struct usb_endpoint *ep)
379 struct usb_bus_methods *methods;
382 methods = udev->bus->methods;
384 (methods->endpoint_init) (udev, edesc, ep);
386 /* initialise USB endpoint structure */
389 ep->iface_index = iface_index;
391 /* setup USB stream queues */
392 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
393 TAILQ_INIT(&ep->endpoint_q[x].head);
394 ep->endpoint_q[x].command = &usbd_pipe_start;
397 /* the pipe is not supported by the hardware */
398 if (ep->methods == NULL)
401 /* check for SUPER-speed streams mode endpoint */
402 if (udev->speed == USB_SPEED_SUPER && ecomp != NULL &&
403 (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK &&
404 (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) {
405 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS);
407 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT);
410 /* clear stall, if any */
411 if (methods->clear_stall != NULL) {
412 USB_BUS_LOCK(udev->bus);
413 (methods->clear_stall) (udev, ep);
414 USB_BUS_UNLOCK(udev->bus);
418 /*-----------------------------------------------------------------------*
419 * usb_endpoint_foreach
421 * This function will iterate all the USB endpoints except the control
422 * endpoint. This function is NULL safe.
425 * NULL: End of USB endpoints
426 * Else: Pointer to next USB endpoint
427 *------------------------------------------------------------------------*/
428 struct usb_endpoint *
429 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
431 struct usb_endpoint *ep_end;
437 ep_end = udev->endpoints + udev->endpoints_max;
439 /* get next endpoint */
441 ep = udev->endpoints;
445 /* find next allocated ep */
446 while (ep != ep_end) {
447 if (ep->edesc != NULL)
454 /*------------------------------------------------------------------------*
455 * usb_wait_pending_refs
457 * This function will wait for any USB references to go away before
458 * returning. This function is used before freeing a USB device.
459 *------------------------------------------------------------------------*/
461 usb_wait_pending_refs(struct usb_device *udev)
464 DPRINTF("Refcount = %d\n", (int)udev->refcount);
466 mtx_lock(&usb_ref_lock);
469 /* wait for any pending references to go away */
470 if (udev->refcount == 0) {
471 /* prevent further refs being taken, if any */
472 udev->refcount = USB_DEV_REF_MAX;
475 cv_wait(&udev->ref_cv, &usb_ref_lock);
477 mtx_unlock(&usb_ref_lock);
481 /*------------------------------------------------------------------------*
484 * This function will free all USB interfaces and USB endpoints belonging
487 * Flag values, see "USB_UNCFG_FLAG_XXX".
488 *------------------------------------------------------------------------*/
490 usb_unconfigure(struct usb_device *udev, uint8_t flag)
494 /* Prevent re-enumeration */
495 do_unlock = usbd_enum_lock(udev);
497 /* detach all interface drivers */
498 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
501 /* free all FIFOs except control endpoint FIFOs */
502 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
505 * Free all cdev's, if any.
510 #if USB_HAVE_COMPAT_LINUX
511 /* free Linux compat device, if any */
512 if (udev->linux_endpoint_start) {
513 usb_linux_free_device(udev);
514 udev->linux_endpoint_start = NULL;
518 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
520 /* free "cdesc" after "ifaces" and "endpoints", if any */
521 if (udev->cdesc != NULL) {
522 if (udev->flags.usb_mode != USB_MODE_DEVICE)
523 usbd_free_config_desc(udev, udev->cdesc);
526 /* set unconfigured state */
527 udev->curr_config_no = USB_UNCONFIG_NO;
528 udev->curr_config_index = USB_UNCONFIG_INDEX;
531 usbd_enum_unlock(udev);
534 /*------------------------------------------------------------------------*
535 * usbd_set_config_index
537 * This function selects configuration by index, independent of the
538 * actual configuration number. This function should not be used by
544 *------------------------------------------------------------------------*/
546 usbd_set_config_index(struct usb_device *udev, uint8_t index)
548 struct usb_status ds;
549 struct usb_config_descriptor *cdp;
556 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
558 /* Prevent re-enumeration */
559 do_unlock = usbd_enum_lock(udev);
561 usb_unconfigure(udev, 0);
563 if (index == USB_UNCONFIG_INDEX) {
565 * Leave unallocated when unconfiguring the
566 * device. "usb_unconfigure()" will also reset
567 * the current config number and index.
569 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
570 if (udev->state == USB_STATE_CONFIGURED)
571 usb_set_device_state(udev, USB_STATE_ADDRESSED);
574 /* get the full config descriptor */
575 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
576 /* save some memory */
577 err = usbd_req_get_descriptor_ptr(udev, &cdp,
578 (UDESC_CONFIG << 8) | index);
581 err = usbd_req_get_config_desc_full(udev,
587 /* set the new config descriptor */
591 /* Figure out if the device is self or bus powered. */
593 if ((!udev->flags.uq_bus_powered) &&
594 (cdp->bmAttributes & UC_SELF_POWERED) &&
595 (udev->flags.usb_mode == USB_MODE_HOST)) {
596 /* May be self powered. */
597 if (cdp->bmAttributes & UC_BUS_POWERED) {
598 /* Must ask device. */
599 err = usbd_req_get_device_status(udev, NULL, &ds);
601 DPRINTFN(0, "could not read "
602 "device status: %s\n",
604 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
607 DPRINTF("status=0x%04x \n",
612 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
613 "selfpowered=%d, power=%d\n",
615 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
616 selfpowered, cdp->bMaxPower * 2);
618 /* Check if we have enough power. */
619 power = cdp->bMaxPower * 2;
621 if (udev->parent_hub) {
622 max_power = udev->parent_hub->hub->portpower;
624 max_power = USB_MAX_POWER;
627 if (power > max_power) {
628 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
629 err = USB_ERR_NO_POWER;
632 /* Only update "self_powered" in USB Host Mode */
633 if (udev->flags.usb_mode == USB_MODE_HOST) {
634 udev->flags.self_powered = selfpowered;
637 udev->curr_config_no = cdp->bConfigurationValue;
638 udev->curr_config_index = index;
639 usb_set_device_state(udev, USB_STATE_CONFIGURED);
641 /* Set the actual configuration value. */
642 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
647 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
652 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
658 /* create device nodes for each endpoint */
659 usb_cdev_create(udev);
663 DPRINTF("error=%s\n", usbd_errstr(err));
665 usb_unconfigure(udev, 0);
668 usbd_enum_unlock(udev);
672 /*------------------------------------------------------------------------*
675 * This function will allocate and free USB interfaces and USB endpoints,
676 * parse the USB configuration structure and initialise the USB endpoints
677 * and interfaces. If "iface_index" is not equal to
678 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
679 * alternate_setting to be selected for the given interface. Else the
680 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
681 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
682 * is typically called when setting the configuration or when setting
683 * an alternate interface.
688 *------------------------------------------------------------------------*/
690 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
692 struct usb_idesc_parse_state ips;
693 struct usb_interface_descriptor *id;
694 struct usb_endpoint_descriptor *ed;
695 struct usb_interface *iface;
696 struct usb_endpoint *ep;
704 if (iface_index != USB_IFACE_INDEX_ANY) {
705 /* parameter overload */
715 DPRINTFN(5, "iface_index=%d cmd=%d\n",
718 if (cmd == USB_CFG_FREE)
721 if (cmd == USB_CFG_INIT) {
722 sx_assert(&udev->enum_sx, SA_LOCKED);
724 /* check for in-use endpoints */
726 ep = udev->endpoints;
727 ep_max = udev->endpoints_max;
729 /* look for matching endpoints */
730 if ((iface_index == USB_IFACE_INDEX_ANY) ||
731 (iface_index == ep->iface_index)) {
732 if (ep->refcount_alloc != 0) {
734 * This typically indicates a
735 * more serious error.
737 err = USB_ERR_IN_USE;
740 memset(ep, 0, sizeof(*ep));
741 /* make sure we don't zero the endpoint again */
742 ep->iface_index = USB_IFACE_INDEX_ANY;
752 memset(&ips, 0, sizeof(ips));
757 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
759 iface = udev->ifaces + ips.iface_index;
761 /* check for specific interface match */
763 if (cmd == USB_CFG_INIT) {
764 if ((iface_index != USB_IFACE_INDEX_ANY) &&
765 (iface_index != ips.iface_index)) {
766 /* wrong interface */
768 } else if (alt_index != ips.iface_index_alt) {
769 /* wrong alternate setting */
772 /* initialise interface */
778 /* check for new interface */
779 if (ips.iface_index_alt == 0) {
780 /* update current number of endpoints */
785 /* setup the USB interface structure */
787 /* set alternate index */
788 iface->alt_index = alt_index;
789 /* set default interface parent */
790 if (iface_index == USB_IFACE_INDEX_ANY) {
791 iface->parent_iface_index =
796 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
798 ed = (struct usb_endpoint_descriptor *)id;
802 /* iterate all the endpoint descriptors */
803 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
805 /* check if endpoint limit has been reached */
806 if (temp >= USB_MAX_EP_UNITS) {
807 DPRINTF("Endpoint limit reached\n");
811 ep = udev->endpoints + temp;
816 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
818 DPRINTFN(5, "Found endpoint companion descriptor\n");
820 usb_init_endpoint(udev,
821 ips.iface_index, ed, ecomp, ep);
826 /* find maximum number of endpoints */
832 /* NOTE: It is valid to have no interfaces and no endpoints! */
834 if (cmd == USB_CFG_ALLOC) {
835 udev->ifaces_max = ips.iface_index;
836 #if (USB_HAVE_FIXED_IFACE == 0)
838 if (udev->ifaces_max != 0) {
839 udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max,
840 M_USB, M_WAITOK | M_ZERO);
841 if (udev->ifaces == NULL) {
847 #if (USB_HAVE_FIXED_ENDPOINT == 0)
849 udev->endpoints = malloc(sizeof(*ep) * ep_max,
850 M_USB, M_WAITOK | M_ZERO);
851 if (udev->endpoints == NULL) {
856 udev->endpoints = NULL;
859 USB_BUS_LOCK(udev->bus);
860 udev->endpoints_max = ep_max;
861 /* reset any ongoing clear-stall */
862 udev->ep_curr = NULL;
863 USB_BUS_UNLOCK(udev->bus);
865 #if (USB_HAVE_FIXED_IFACE == 0) || (USB_HAVE_FIXED_ENDPOINT == 0)
869 if (cmd == USB_CFG_ALLOC) {
871 USB_BUS_LOCK(udev->bus);
872 udev->endpoints_max = 0;
873 /* reset any ongoing clear-stall */
874 udev->ep_curr = NULL;
875 USB_BUS_UNLOCK(udev->bus);
877 #if (USB_HAVE_FIXED_IFACE == 0)
878 free(udev->ifaces, M_USB);
881 #if (USB_HAVE_FIXED_ENDPOINT == 0)
882 free(udev->endpoints, M_USB);
883 udev->endpoints = NULL;
885 udev->ifaces_max = 0;
891 /*------------------------------------------------------------------------*
892 * usbd_set_alt_interface_index
894 * This function will select an alternate interface index for the
895 * given interface index. The interface should not be in use when this
896 * function is called. That means there should not be any open USB
897 * transfers. Else an error is returned. If the alternate setting is
898 * already set this function will simply return success. This function
899 * is called in Host mode and Device mode!
904 *------------------------------------------------------------------------*/
906 usbd_set_alt_interface_index(struct usb_device *udev,
907 uint8_t iface_index, uint8_t alt_index)
909 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
913 /* Prevent re-enumeration */
914 do_unlock = usbd_enum_lock(udev);
920 if (iface->alt_index == alt_index) {
922 * Optimise away duplicate setting of
923 * alternate setting in USB Host Mode!
930 * Free all generic FIFOs for this interface, except control
933 usb_fifo_free_wrap(udev, iface_index, 0);
936 err = usb_config_parse(udev, iface_index, alt_index);
940 if (iface->alt_index != alt_index) {
941 /* the alternate setting does not exist */
946 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
947 iface->idesc->bAlternateSetting);
951 usbd_enum_unlock(udev);
955 /*------------------------------------------------------------------------*
956 * usbd_set_endpoint_stall
958 * This function is used to make a BULK or INTERRUPT endpoint send
959 * STALL tokens in USB device mode.
964 *------------------------------------------------------------------------*/
966 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
969 struct usb_xfer *xfer;
976 DPRINTF("Cannot find endpoint\n");
978 * Pretend that the clear or set stall request is
979 * successful else some USB host stacks can do
980 * strange things, especially when a control endpoint
985 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
987 if ((et != UE_BULK) &&
988 (et != UE_INTERRUPT)) {
990 * Should not stall control
991 * nor isochronous endpoints.
993 DPRINTF("Invalid endpoint\n");
996 USB_BUS_LOCK(udev->bus);
998 /* store current stall state */
999 was_stalled = ep->is_stalled;
1001 /* check for no change */
1002 if (was_stalled && do_stall) {
1003 /* if the endpoint is already stalled do nothing */
1004 USB_BUS_UNLOCK(udev->bus);
1005 DPRINTF("No change\n");
1008 /* set stalled state */
1011 if (do_stall || (!was_stalled)) {
1013 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1014 /* lookup the current USB transfer, if any */
1015 xfer = ep->endpoint_q[x].curr;
1018 * The "xfer_stall" method
1019 * will complete the USB
1020 * transfer like in case of a
1021 * timeout setting the error
1022 * code "USB_ERR_STALLED".
1024 (udev->bus->methods->xfer_stall) (xfer);
1028 (udev->bus->methods->set_stall) (udev, ep, &do_stall);
1031 ep->toggle_next = 0; /* reset data toggle */
1032 ep->is_stalled = 0; /* clear stalled state */
1034 (udev->bus->methods->clear_stall) (udev, ep);
1036 /* start the current or next transfer, if any */
1037 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1038 usb_command_wrapper(&ep->endpoint_q[x],
1039 ep->endpoint_q[x].curr);
1042 USB_BUS_UNLOCK(udev->bus);
1046 /*------------------------------------------------------------------------*
1047 * usb_reset_iface_endpoints - used in USB device side mode
1048 *------------------------------------------------------------------------*/
1050 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1052 struct usb_endpoint *ep;
1053 struct usb_endpoint *ep_end;
1055 ep = udev->endpoints;
1056 ep_end = udev->endpoints + udev->endpoints_max;
1058 for (; ep != ep_end; ep++) {
1060 if ((ep->edesc == NULL) ||
1061 (ep->iface_index != iface_index)) {
1064 /* simulate a clear stall from the peer */
1065 usbd_set_endpoint_stall(udev, ep, 0);
1070 /*------------------------------------------------------------------------*
1071 * usb_detach_device_sub
1073 * This function will try to detach an USB device. If it fails a panic
1076 * Flag values, see "USB_UNCFG_FLAG_XXX".
1077 *------------------------------------------------------------------------*/
1079 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1080 char **ppnpinfo, uint8_t flag)
1089 * NOTE: It is important to clear "*ppdev" before deleting
1090 * the child due to some device methods being called late
1091 * during the delete process !
1096 device_printf(dev, "at %s, port %d, addr %d "
1098 device_get_nameunit(udev->parent_dev),
1099 udev->port_no, udev->address);
1102 if (device_is_attached(dev)) {
1103 if (udev->flags.peer_suspended) {
1104 err = DEVICE_RESUME(dev);
1106 device_printf(dev, "Resume failed\n");
1109 if (device_detach(dev)) {
1113 if (device_delete_child(udev->parent_dev, dev)) {
1118 pnpinfo = *ppnpinfo;
1119 if (pnpinfo != NULL) {
1121 free(pnpinfo, M_USBDEV);
1126 /* Detach is not allowed to fail in the USB world */
1127 panic("usb_detach_device_sub: A USB driver would not detach\n");
1130 /*------------------------------------------------------------------------*
1133 * The following function will detach the matching interfaces.
1134 * This function is NULL safe.
1136 * Flag values, see "USB_UNCFG_FLAG_XXX".
1137 *------------------------------------------------------------------------*/
1139 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1142 struct usb_interface *iface;
1149 DPRINTFN(4, "udev=%p\n", udev);
1151 sx_assert(&udev->enum_sx, SA_LOCKED);
1154 * First detach the child to give the child's detach routine a
1155 * chance to detach the sub-devices in the correct order.
1156 * Then delete the child using "device_delete_child()" which
1157 * will detach all sub-devices from the bottom and upwards!
1159 if (iface_index != USB_IFACE_INDEX_ANY) {
1161 iface_index = i + 1;
1164 iface_index = USB_IFACE_MAX;
1169 for (; i != iface_index; i++) {
1171 iface = usbd_get_iface(udev, i);
1172 if (iface == NULL) {
1173 /* looks like the end of the USB interfaces */
1176 usb_detach_device_sub(udev, &iface->subdev,
1177 &iface->pnpinfo, flag);
1181 /*------------------------------------------------------------------------*
1182 * usb_probe_and_attach_sub
1187 *------------------------------------------------------------------------*/
1189 usb_probe_and_attach_sub(struct usb_device *udev,
1190 struct usb_attach_arg *uaa)
1192 struct usb_interface *iface;
1197 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1198 /* leave interface alone */
1201 dev = iface->subdev;
1204 /* clean up after module unload */
1206 if (device_is_attached(dev)) {
1207 /* already a device there */
1210 /* clear "iface->subdev" as early as possible */
1212 iface->subdev = NULL;
1214 if (device_delete_child(udev->parent_dev, dev)) {
1217 * Panic here, else one can get a double call
1218 * to device_detach(). USB devices should
1219 * never fail on detach!
1221 panic("device_delete_child() failed\n");
1224 if (uaa->temp_dev == NULL) {
1226 /* create a new child */
1227 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1228 if (uaa->temp_dev == NULL) {
1229 device_printf(udev->parent_dev,
1230 "Device creation failed\n");
1231 return (1); /* failure */
1233 device_set_ivars(uaa->temp_dev, uaa);
1234 device_quiet(uaa->temp_dev);
1237 * Set "subdev" before probe and attach so that "devd" gets
1238 * the information it needs.
1240 iface->subdev = uaa->temp_dev;
1242 if (device_probe_and_attach(iface->subdev) == 0) {
1244 * The USB attach arguments are only available during probe
1247 uaa->temp_dev = NULL;
1248 device_set_ivars(iface->subdev, NULL);
1250 if (udev->flags.peer_suspended) {
1251 err = DEVICE_SUSPEND(iface->subdev);
1253 device_printf(iface->subdev, "Suspend failed\n");
1255 return (0); /* success */
1257 /* No USB driver found */
1258 iface->subdev = NULL;
1260 return (1); /* failure */
1263 /*------------------------------------------------------------------------*
1264 * usbd_set_parent_iface
1266 * Using this function will lock the alternate interface setting on an
1267 * interface. It is typically used for multi interface drivers. In USB
1268 * device side mode it is assumed that the alternate interfaces all
1269 * have the same endpoint descriptors. The default parent index value
1270 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1272 *------------------------------------------------------------------------*/
1274 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1275 uint8_t parent_index)
1277 struct usb_interface *iface;
1283 iface = usbd_get_iface(udev, iface_index);
1285 iface->parent_iface_index = parent_index;
1289 usb_init_attach_arg(struct usb_device *udev,
1290 struct usb_attach_arg *uaa)
1292 memset(uaa, 0, sizeof(*uaa));
1295 uaa->usb_mode = udev->flags.usb_mode;
1296 uaa->port = udev->port_no;
1297 uaa->dev_state = UAA_DEV_READY;
1299 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1300 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1301 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1302 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1303 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1304 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1305 uaa->info.bConfigIndex = udev->curr_config_index;
1306 uaa->info.bConfigNum = udev->curr_config_no;
1309 /*------------------------------------------------------------------------*
1310 * usb_probe_and_attach
1312 * This function is called from "uhub_explore_sub()",
1313 * "usb_handle_set_config()" and "usb_handle_request()".
1317 * Else: A control transfer failed
1318 *------------------------------------------------------------------------*/
1320 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1322 struct usb_attach_arg uaa;
1323 struct usb_interface *iface;
1329 DPRINTF("udev == NULL\n");
1330 return (USB_ERR_INVAL);
1332 /* Prevent re-enumeration */
1333 do_unlock = usbd_enum_lock(udev);
1335 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1336 /* do nothing - no configuration has been set */
1339 /* setup USB attach arguments */
1341 usb_init_attach_arg(udev, &uaa);
1344 * If the whole USB device is targeted, invoke the USB event
1347 if (iface_index == USB_IFACE_INDEX_ANY) {
1349 if (usb_test_quirk(&uaa, UQ_MSC_DYMO_EJECT) != 0 &&
1350 usb_dymo_eject(udev, 0) == 0) {
1351 /* success, mark the udev as disappearing */
1352 uaa.dev_state = UAA_DEV_EJECTING;
1355 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1357 if (uaa.dev_state != UAA_DEV_READY) {
1358 /* leave device unconfigured */
1359 usb_unconfigure(udev, 0);
1364 /* Check if only one interface should be probed: */
1365 if (iface_index != USB_IFACE_INDEX_ANY) {
1373 /* Do the probe and attach */
1374 for (; i != j; i++) {
1376 iface = usbd_get_iface(udev, i);
1377 if (iface == NULL) {
1379 * Looks like the end of the USB
1382 DPRINTFN(2, "end of interfaces "
1386 if (iface->idesc == NULL) {
1387 /* no interface descriptor */
1392 uaa.info.bInterfaceClass =
1393 iface->idesc->bInterfaceClass;
1394 uaa.info.bInterfaceSubClass =
1395 iface->idesc->bInterfaceSubClass;
1396 uaa.info.bInterfaceProtocol =
1397 iface->idesc->bInterfaceProtocol;
1398 uaa.info.bIfaceIndex = i;
1399 uaa.info.bIfaceNum =
1400 iface->idesc->bInterfaceNumber;
1401 uaa.driver_info = 0; /* reset driver_info */
1403 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1404 uaa.info.bInterfaceClass,
1405 uaa.info.bInterfaceSubClass,
1406 uaa.info.bInterfaceProtocol,
1407 uaa.info.bIfaceIndex,
1408 uaa.info.bIfaceNum);
1410 usb_probe_and_attach_sub(udev, &uaa);
1413 * Remove the leftover child, if any, to enforce that
1414 * a new nomatch devd event is generated for the next
1415 * interface if no driver is found:
1417 if (uaa.temp_dev == NULL)
1419 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1420 DPRINTFN(0, "device delete child failed\n");
1421 uaa.temp_dev = NULL;
1425 usbd_enum_unlock(udev);
1429 /*------------------------------------------------------------------------*
1430 * usb_suspend_resume_sub
1432 * This function is called when the suspend or resume methods should
1433 * be executed on an USB device.
1434 *------------------------------------------------------------------------*/
1436 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1443 if (!device_is_attached(dev)) {
1447 err = DEVICE_SUSPEND(dev);
1449 err = DEVICE_RESUME(dev);
1452 device_printf(dev, "%s failed\n",
1453 do_suspend ? "Suspend" : "Resume");
1457 /*------------------------------------------------------------------------*
1458 * usb_suspend_resume
1460 * The following function will suspend or resume the USB device.
1465 *------------------------------------------------------------------------*/
1467 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1469 struct usb_interface *iface;
1476 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1478 sx_assert(&udev->sr_sx, SA_LOCKED);
1480 USB_BUS_LOCK(udev->bus);
1481 /* filter the suspend events */
1482 if (udev->flags.peer_suspended == do_suspend) {
1483 USB_BUS_UNLOCK(udev->bus);
1487 udev->flags.peer_suspended = do_suspend;
1488 USB_BUS_UNLOCK(udev->bus);
1490 /* do the suspend or resume */
1492 for (i = 0; i != USB_IFACE_MAX; i++) {
1494 iface = usbd_get_iface(udev, i);
1495 if (iface == NULL) {
1496 /* looks like the end of the USB interfaces */
1499 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1504 /*------------------------------------------------------------------------*
1505 * usbd_clear_stall_proc
1507 * This function performs generic USB clear stall operations.
1508 *------------------------------------------------------------------------*/
1510 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1512 struct usb_udev_msg *pm = (void *)_pm;
1513 struct usb_device *udev = pm->udev;
1516 USB_BUS_UNLOCK(udev->bus);
1517 mtx_lock(&udev->device_mtx);
1519 /* Start clear stall callback */
1520 usbd_transfer_start(udev->ctrl_xfer[1]);
1523 mtx_unlock(&udev->device_mtx);
1524 USB_BUS_LOCK(udev->bus);
1527 /*------------------------------------------------------------------------*
1530 * This function allocates a new USB device. This function is called
1531 * when a new device has been put in the powered state, but not yet in
1532 * the addressed state. Get initial descriptor, set the address, get
1533 * full descriptor and get strings.
1538 *------------------------------------------------------------------------*/
1540 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1541 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1542 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1544 struct usb_attach_arg uaa;
1545 struct usb_device *udev;
1546 struct usb_device *adev;
1547 struct usb_device *hub;
1548 uint8_t *scratch_ptr;
1550 uint8_t device_index;
1551 uint8_t config_index;
1552 uint8_t config_quirk;
1553 uint8_t set_config_failed;
1556 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1557 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1558 parent_dev, bus, parent_hub, depth, port_index, port_no,
1562 * Find an unused device index. In USB Host mode this is the
1563 * same as the device address.
1565 * Device index zero is not used and device index 1 should
1566 * always be the root hub.
1568 for (device_index = USB_ROOT_HUB_ADDR;
1569 (device_index != bus->devices_max) &&
1570 (bus->devices[device_index] != NULL);
1571 device_index++) /* nop */;
1573 if (device_index == bus->devices_max) {
1574 device_printf(bus->bdev,
1575 "No free USB device index for new device\n");
1580 device_printf(bus->bdev,
1581 "Invalid device depth\n");
1584 udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1588 /* initialise our SX-lock */
1589 sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1590 sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS);
1592 cv_init(&udev->ctrlreq_cv, "WCTRL");
1593 cv_init(&udev->ref_cv, "UGONE");
1595 /* initialise our mutex */
1596 mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF);
1598 /* initialise generic clear stall */
1599 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1600 udev->cs_msg[0].udev = udev;
1601 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1602 udev->cs_msg[1].udev = udev;
1604 /* initialise some USB device fields */
1605 udev->parent_hub = parent_hub;
1606 udev->parent_dev = parent_dev;
1607 udev->port_index = port_index;
1608 udev->port_no = port_no;
1609 udev->depth = depth;
1611 udev->address = USB_START_ADDR; /* default value */
1612 udev->plugtime = (usb_ticks_t)ticks;
1614 * We need to force the power mode to "on" because there are plenty
1615 * of USB devices out there that do not work very well with
1616 * automatic suspend and resume!
1618 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1619 udev->pwr_save.last_xfer_time = ticks;
1620 /* we are not ready yet */
1623 /* set up default endpoint descriptor */
1624 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1625 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1626 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1627 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1628 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1629 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1630 udev->ctrl_ep_desc.bInterval = 0;
1632 /* set up default endpoint companion descriptor */
1633 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1634 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1636 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1638 udev->speed = speed;
1639 udev->flags.usb_mode = mode;
1641 /* search for our High Speed USB HUB, if any */
1644 hub = udev->parent_hub;
1647 if (hub->speed == USB_SPEED_HIGH) {
1648 udev->hs_hub_addr = hub->address;
1649 udev->parent_hs_hub = hub;
1650 udev->hs_port_no = adev->port_no;
1654 hub = hub->parent_hub;
1657 /* init the default endpoint */
1658 usb_init_endpoint(udev, 0,
1659 &udev->ctrl_ep_desc,
1660 &udev->ctrl_ep_comp_desc,
1663 /* set device index */
1664 udev->device_index = device_index;
1667 /* Create ugen name */
1668 snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1669 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1671 LIST_INIT(&udev->pd_list);
1673 /* Create the control endpoint device */
1674 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1675 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1677 /* Create a link from /dev/ugenX.X to the default endpoint */
1678 if (udev->ctrl_dev != NULL)
1679 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1681 /* Initialise device */
1682 if (bus->methods->device_init != NULL) {
1683 err = (bus->methods->device_init) (udev);
1685 DPRINTFN(0, "device init %d failed "
1686 "(%s, ignored)\n", device_index,
1691 /* set powered device state after device init is complete */
1692 usb_set_device_state(udev, USB_STATE_POWERED);
1694 if (udev->flags.usb_mode == USB_MODE_HOST) {
1696 err = usbd_req_set_address(udev, NULL, device_index);
1699 * This is the new USB device address from now on, if
1700 * the set address request didn't set it already.
1702 if (udev->address == USB_START_ADDR)
1703 udev->address = device_index;
1706 * We ignore any set-address errors, hence there are
1707 * buggy USB devices out there that actually receive
1708 * the SETUP PID, but manage to set the address before
1709 * the STATUS stage is ACK'ed. If the device responds
1710 * to the subsequent get-descriptor at the new
1711 * address, then we know that the set-address command
1715 DPRINTFN(0, "set address %d failed "
1716 "(%s, ignored)\n", udev->address,
1720 /* We are not self powered */
1721 udev->flags.self_powered = 0;
1723 /* Set unconfigured state */
1724 udev->curr_config_no = USB_UNCONFIG_NO;
1725 udev->curr_config_index = USB_UNCONFIG_INDEX;
1727 /* Setup USB descriptors */
1728 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1730 DPRINTFN(0, "setting up USB template failed maybe the USB "
1731 "template module has not been loaded\n");
1735 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1737 /* setup the device descriptor and the initial "wMaxPacketSize" */
1738 err = usbd_setup_device_desc(udev, NULL);
1741 /* try to enumerate two more times */
1742 err = usbd_req_re_enumerate(udev, NULL);
1744 err = usbd_req_re_enumerate(udev, NULL);
1752 * Setup temporary USB attach args so that we can figure out some
1753 * basic quirks for this device.
1755 usb_init_attach_arg(udev, &uaa);
1757 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1758 udev->flags.uq_bus_powered = 1;
1760 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1761 udev->flags.no_strings = 1;
1764 * Workaround for buggy USB devices.
1766 * It appears that some string-less USB chips will crash and
1767 * disappear if any attempts are made to read any string
1770 * Try to detect such chips by checking the strings in the USB
1771 * device descriptor. If no strings are present there we
1772 * simply disable all USB strings.
1775 /* Protect scratch area */
1776 do_unlock = usbd_enum_lock(udev);
1778 scratch_ptr = udev->scratch.data;
1780 if (udev->flags.no_strings) {
1781 err = USB_ERR_INVAL;
1782 } else if (udev->ddesc.iManufacturer ||
1783 udev->ddesc.iProduct ||
1784 udev->ddesc.iSerialNumber) {
1785 /* read out the language ID string */
1786 err = usbd_req_get_string_desc(udev, NULL,
1787 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1789 err = USB_ERR_INVAL;
1792 if (err || (scratch_ptr[0] < 4)) {
1793 udev->flags.no_strings = 1;
1800 /* load preferred value and mask */
1802 mask = usb_lang_mask;
1804 /* align length correctly */
1805 scratch_ptr[0] &= ~1U;
1807 /* fix compiler warning */
1810 /* search for preferred language */
1811 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1812 langid = UGETW(scratch_ptr + x);
1813 if ((langid & mask) == pref)
1816 if (x >= scratch_ptr[0]) {
1817 /* pick the first language as the default */
1818 DPRINTFN(1, "Using first language\n");
1819 langid = UGETW(scratch_ptr + 2);
1822 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1823 udev->langid = langid;
1827 usbd_enum_unlock(udev);
1829 /* assume 100mA bus powered for now. Changed when configured. */
1830 udev->power = USB_MIN_POWER;
1831 /* fetch the vendor and product strings from the device */
1832 usbd_set_device_strings(udev);
1834 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1835 /* USB device mode setup is complete */
1841 * Most USB devices should attach to config index 0 by
1844 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1847 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1850 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1853 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1856 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1864 set_config_failed = 0;
1867 DPRINTF("setting config %u\n", config_index);
1869 /* get the USB device configured */
1870 err = usbd_set_config_index(udev, config_index);
1872 if (udev->ddesc.bNumConfigurations != 0) {
1873 if (!set_config_failed) {
1874 set_config_failed = 1;
1875 /* XXX try to re-enumerate the device */
1876 err = usbd_req_re_enumerate(udev, NULL);
1878 goto repeat_set_config;
1880 DPRINTFN(0, "Failure selecting configuration index %u:"
1881 "%s, port %u, addr %u (ignored)\n",
1882 config_index, usbd_errstr(err), udev->port_no,
1886 * Some USB devices do not have any configurations. Ignore any
1887 * set config failures!
1892 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1893 if ((udev->cdesc->bNumInterface < 2) &&
1894 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1895 DPRINTFN(0, "Found no endpoints, trying next config\n");
1897 goto repeat_set_config;
1899 #if USB_HAVE_MSCTEST
1900 if (config_index == 0) {
1902 * Try to figure out if we have an
1903 * auto-install disk there:
1905 if (usb_iface_is_cdrom(udev, 0)) {
1906 DPRINTFN(0, "Found possible auto-install "
1907 "disk (trying next config)\n");
1909 goto repeat_set_config;
1914 #if USB_HAVE_MSCTEST
1915 if (set_config_failed == 0 && config_index == 0 &&
1916 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1917 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1920 * Try to figure out if there are any MSC quirks we
1921 * should apply automatically:
1923 err = usb_msc_auto_quirk(udev, 0);
1926 set_config_failed = 1;
1927 goto repeat_set_config;
1933 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1934 udev->address, udev, udev->parent_hub);
1936 /* register our device - we are ready */
1937 usb_bus_port_set_device(bus, parent_hub ?
1938 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1941 /* Symlink the ugen device name */
1942 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1944 /* Announce device */
1945 printf("%s: <%s> at %s\n", udev->ugen_name,
1946 usb_get_manufacturer(udev),
1947 device_get_nameunit(udev->bus->bdev));
1951 usb_notify_addq("ATTACH", udev);
1956 * Free USB device and all subdevices, if any.
1958 usb_free_device(udev, 0);
1965 struct usb_fs_privdata *
1966 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1967 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1969 struct usb_fs_privdata* pd;
1972 /* Store information to locate ourselves again later */
1973 pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1975 pd->bus_index = device_get_unit(udev->bus->bdev);
1976 pd->dev_index = udev->device_index;
1978 pd->fifo_index = fi;
1981 /* Now, create the device itself */
1982 if (devname == NULL) {
1984 snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1985 pd->bus_index, pd->dev_index, pd->ep_addr);
1988 pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname);
1990 if (pd->cdev == NULL) {
1991 DPRINTFN(0, "Failed to create device %s\n", devname);
1996 /* XXX setting si_drv1 and creating the device is not atomic! */
1997 pd->cdev->si_drv1 = pd;
2003 usb_destroy_dev_sync(struct usb_fs_privdata *pd)
2005 DPRINTFN(1, "Destroying device at ugen%d.%d\n",
2006 pd->bus_index, pd->dev_index);
2009 * Destroy character device synchronously. After this
2010 * all system calls are returned. Can block.
2012 destroy_dev(pd->cdev);
2018 usb_destroy_dev(struct usb_fs_privdata *pd)
2020 struct usb_bus *bus;
2025 mtx_lock(&usb_ref_lock);
2026 bus = devclass_get_softc(usb_devclass_ptr, pd->bus_index);
2027 mtx_unlock(&usb_ref_lock);
2030 usb_destroy_dev_sync(pd);
2034 /* make sure we can re-use the device name */
2035 delist_dev(pd->cdev);
2038 LIST_INSERT_HEAD(&bus->pd_cleanup_list, pd, pd_next);
2039 /* get cleanup going */
2040 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
2041 &bus->cleanup_msg[0], &bus->cleanup_msg[1]);
2042 USB_BUS_UNLOCK(bus);
2046 usb_cdev_create(struct usb_device *udev)
2048 struct usb_config_descriptor *cd;
2049 struct usb_endpoint_descriptor *ed;
2050 struct usb_descriptor *desc;
2051 struct usb_fs_privdata* pd;
2052 int inmode, outmode, inmask, outmask, mode;
2055 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2057 DPRINTFN(2, "Creating device nodes\n");
2059 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2062 } else { /* USB_MODE_HOST */
2072 * Collect all used endpoint numbers instead of just
2073 * generating 16 static endpoints.
2075 cd = usbd_get_config_descriptor(udev);
2076 while ((desc = usb_desc_foreach(cd, desc))) {
2077 /* filter out all endpoint descriptors */
2078 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2079 (desc->bLength >= sizeof(*ed))) {
2080 ed = (struct usb_endpoint_descriptor *)desc;
2083 ep = ed->bEndpointAddress;
2084 if (UE_GET_DIR(ep) == UE_DIR_OUT)
2085 outmask |= 1 << UE_GET_ADDR(ep);
2087 inmask |= 1 << UE_GET_ADDR(ep);
2091 /* Create all available endpoints except EP0 */
2092 for (ep = 1; ep < 16; ep++) {
2093 mode = (inmask & (1 << ep)) ? inmode : 0;
2094 mode |= (outmask & (1 << ep)) ? outmode : 0;
2096 continue; /* no IN or OUT endpoint */
2098 pd = usb_make_dev(udev, NULL, ep, 0,
2099 mode, UID_ROOT, GID_OPERATOR, 0600);
2102 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2107 usb_cdev_free(struct usb_device *udev)
2109 struct usb_fs_privdata* pd;
2111 DPRINTFN(2, "Freeing device nodes\n");
2113 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2114 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2116 LIST_REMOVE(pd, pd_next);
2118 usb_destroy_dev(pd);
2123 /*------------------------------------------------------------------------*
2126 * This function is NULL safe and will free an USB device and its
2127 * children devices, if any.
2129 * Flag values: Reserved, set to zero.
2130 *------------------------------------------------------------------------*/
2132 usb_free_device(struct usb_device *udev, uint8_t flag)
2134 struct usb_bus *bus;
2137 return; /* already freed */
2139 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2143 /* set DETACHED state to prevent any further references */
2144 usb_set_device_state(udev, USB_STATE_DETACHED);
2147 usb_notify_addq("DETACH", udev);
2152 printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2153 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2156 /* Destroy UGEN symlink, if any */
2157 if (udev->ugen_symlink) {
2158 usb_free_symlink(udev->ugen_symlink);
2159 udev->ugen_symlink = NULL;
2162 usb_destroy_dev(udev->ctrl_dev);
2165 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2166 /* stop receiving any control transfers (Device Side Mode) */
2167 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2170 /* the following will get the device unconfigured in software */
2171 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2173 /* final device unregister after all character devices are closed */
2174 usb_bus_port_set_device(bus, udev->parent_hub ?
2175 udev->parent_hub->hub->ports + udev->port_index : NULL,
2176 NULL, USB_ROOT_HUB_ADDR);
2178 /* unsetup any leftover default USB transfers */
2179 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2181 /* template unsetup, if any */
2182 (usb_temp_unsetup_p) (udev);
2185 * Make sure that our clear-stall messages are not queued
2188 USB_BUS_LOCK(udev->bus);
2189 usb_proc_mwait(USB_BUS_CS_PROC(udev->bus),
2190 &udev->cs_msg[0], &udev->cs_msg[1]);
2191 USB_BUS_UNLOCK(udev->bus);
2193 /* wait for all references to go away */
2194 usb_wait_pending_refs(udev);
2196 sx_destroy(&udev->enum_sx);
2197 sx_destroy(&udev->sr_sx);
2199 cv_destroy(&udev->ctrlreq_cv);
2200 cv_destroy(&udev->ref_cv);
2202 mtx_destroy(&udev->device_mtx);
2204 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2207 /* Uninitialise device */
2208 if (bus->methods->device_uninit != NULL)
2209 (bus->methods->device_uninit) (udev);
2212 free(udev->serial, M_USB);
2213 free(udev->manufacturer, M_USB);
2214 free(udev->product, M_USB);
2218 /*------------------------------------------------------------------------*
2221 * This function is the safe way to get the USB interface structure
2222 * pointer by interface index.
2225 * NULL: Interface not present.
2226 * Else: Pointer to USB interface structure.
2227 *------------------------------------------------------------------------*/
2228 struct usb_interface *
2229 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2231 struct usb_interface *iface = udev->ifaces + iface_index;
2233 if (iface_index >= udev->ifaces_max)
2238 /*------------------------------------------------------------------------*
2239 * usbd_find_descriptor
2241 * This function will lookup the first descriptor that matches the
2242 * criteria given by the arguments "type" and "subtype". Descriptors
2243 * will only be searched within the interface having the index
2244 * "iface_index". If the "id" argument points to an USB descriptor,
2245 * it will be skipped before the search is started. This allows
2246 * searching for multiple descriptors using the same criteria. Else
2247 * the search is started after the interface descriptor.
2250 * NULL: End of descriptors
2251 * Else: A descriptor matching the criteria
2252 *------------------------------------------------------------------------*/
2254 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2255 uint8_t type, uint8_t type_mask,
2256 uint8_t subtype, uint8_t subtype_mask)
2258 struct usb_descriptor *desc;
2259 struct usb_config_descriptor *cd;
2260 struct usb_interface *iface;
2262 cd = usbd_get_config_descriptor(udev);
2267 iface = usbd_get_iface(udev, iface_index);
2268 if (iface == NULL) {
2271 id = usbd_get_interface_descriptor(iface);
2278 while ((desc = usb_desc_foreach(cd, desc))) {
2280 if (desc->bDescriptorType == UDESC_INTERFACE) {
2283 if (((desc->bDescriptorType & type_mask) == type) &&
2284 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2291 /*------------------------------------------------------------------------*
2294 * This function will dump information from the device descriptor
2295 * belonging to the USB device pointed to by "udev", to the string
2296 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2297 * including the terminating zero.
2298 *------------------------------------------------------------------------*/
2300 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2302 struct usb_device_descriptor *udd = &udev->ddesc;
2306 bcdUSB = UGETW(udd->bcdUSB);
2307 bcdDevice = UGETW(udd->bcdDevice);
2309 if (udd->bDeviceClass != 0xFF) {
2310 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2312 usb_get_manufacturer(udev),
2313 usb_get_product(udev),
2314 udd->bDeviceClass, udd->bDeviceSubClass,
2315 (bcdUSB >> 8), bcdUSB & 0xFF,
2316 (bcdDevice >> 8), bcdDevice & 0xFF,
2319 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2321 usb_get_manufacturer(udev),
2322 usb_get_product(udev),
2323 (bcdUSB >> 8), bcdUSB & 0xFF,
2324 (bcdDevice >> 8), bcdDevice & 0xFF,
2331 * Descriptions of of known vendors and devices ("products").
2333 struct usb_knowndev {
2337 const char *vendorname;
2338 const char *productname;
2341 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2343 #include "usbdevs.h"
2344 #include "usbdevs_data.h"
2345 #endif /* USB_VERBOSE */
2348 usbd_set_device_strings(struct usb_device *udev)
2350 struct usb_device_descriptor *udd = &udev->ddesc;
2352 const struct usb_knowndev *kdp;
2357 uint16_t product_id;
2360 /* Protect scratch area */
2361 do_unlock = usbd_enum_lock(udev);
2363 temp_ptr = (char *)udev->scratch.data;
2364 temp_size = sizeof(udev->scratch.data);
2366 vendor_id = UGETW(udd->idVendor);
2367 product_id = UGETW(udd->idProduct);
2369 /* get serial number string */
2370 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2371 udev->ddesc.iSerialNumber);
2372 udev->serial = strdup(temp_ptr, M_USB);
2374 /* get manufacturer string */
2375 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2376 udev->ddesc.iManufacturer);
2377 usb_trim_spaces(temp_ptr);
2378 if (temp_ptr[0] != '\0')
2379 udev->manufacturer = strdup(temp_ptr, M_USB);
2381 /* get product string */
2382 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2383 udev->ddesc.iProduct);
2384 usb_trim_spaces(temp_ptr);
2385 if (temp_ptr[0] != '\0')
2386 udev->product = strdup(temp_ptr, M_USB);
2389 if (udev->manufacturer == NULL || udev->product == NULL) {
2390 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2391 if (kdp->vendor == vendor_id &&
2392 (kdp->product == product_id ||
2393 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2396 if (kdp->vendorname != NULL) {
2397 /* XXX should use pointer to knowndevs string */
2398 if (udev->manufacturer == NULL) {
2399 udev->manufacturer = strdup(kdp->vendorname,
2402 if (udev->product == NULL &&
2403 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2404 udev->product = strdup(kdp->productname,
2410 /* Provide default strings if none were found */
2411 if (udev->manufacturer == NULL) {
2412 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2413 udev->manufacturer = strdup(temp_ptr, M_USB);
2415 if (udev->product == NULL) {
2416 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2417 udev->product = strdup(temp_ptr, M_USB);
2421 usbd_enum_unlock(udev);
2429 usbd_get_mode(struct usb_device *udev)
2431 return (udev->flags.usb_mode);
2436 * See: USB_SPEED_XXX
2439 usbd_get_speed(struct usb_device *udev)
2441 return (udev->speed);
2445 usbd_get_isoc_fps(struct usb_device *udev)
2448 switch (udev->speed) {
2450 case USB_SPEED_FULL:
2457 struct usb_device_descriptor *
2458 usbd_get_device_descriptor(struct usb_device *udev)
2461 return (NULL); /* be NULL safe */
2462 return (&udev->ddesc);
2465 struct usb_config_descriptor *
2466 usbd_get_config_descriptor(struct usb_device *udev)
2469 return (NULL); /* be NULL safe */
2470 return (udev->cdesc);
2473 /*------------------------------------------------------------------------*
2474 * usb_test_quirk - test a device for a given quirk
2477 * 0: The USB device does not have the given quirk.
2478 * Else: The USB device has the given quirk.
2479 *------------------------------------------------------------------------*/
2481 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2486 if (quirk == UQ_NONE)
2489 /* search the automatic per device quirks first */
2491 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2492 if (uaa->device->autoQuirk[x] == quirk)
2496 /* search global quirk table, if any */
2498 found = (usb_test_quirk_p) (&uaa->info, quirk);
2503 struct usb_interface_descriptor *
2504 usbd_get_interface_descriptor(struct usb_interface *iface)
2507 return (NULL); /* be NULL safe */
2508 return (iface->idesc);
2512 usbd_get_interface_altindex(struct usb_interface *iface)
2514 return (iface->alt_index);
2518 usbd_get_bus_index(struct usb_device *udev)
2520 return ((uint8_t)device_get_unit(udev->bus->bdev));
2524 usbd_get_device_index(struct usb_device *udev)
2526 return (udev->device_index);
2531 usb_notify_addq(const char *type, struct usb_device *udev)
2533 struct usb_interface *iface;
2537 /* announce the device */
2538 sb = sbuf_new_auto();
2547 "devsubclass=0x%02x "
2560 UGETW(udev->ddesc.idVendor),
2561 UGETW(udev->ddesc.idProduct),
2562 udev->ddesc.bDeviceClass,
2563 udev->ddesc.bDeviceSubClass,
2564 usb_get_serial(udev),
2565 UGETW(udev->ddesc.bcdDevice),
2566 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2569 , udev->parent_hub != NULL ?
2570 udev->parent_hub->ugen_name :
2571 device_get_nameunit(device_get_parent(udev->bus->bdev))
2575 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2578 /* announce each interface */
2579 for (i = 0; i < USB_IFACE_MAX; i++) {
2580 iface = usbd_get_iface(udev, i);
2582 break; /* end of interfaces */
2583 if (iface->idesc == NULL)
2584 continue; /* no interface descriptor */
2586 sb = sbuf_new_auto();
2595 "devsubclass=0x%02x "
2602 "intsubclass=0x%02x "
2603 "intprotocol=0x%02x",
2608 UGETW(udev->ddesc.idVendor),
2609 UGETW(udev->ddesc.idProduct),
2610 udev->ddesc.bDeviceClass,
2611 udev->ddesc.bDeviceSubClass,
2612 usb_get_serial(udev),
2613 UGETW(udev->ddesc.bcdDevice),
2614 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2615 iface->idesc->bInterfaceNumber,
2616 iface->idesc->bNumEndpoints,
2617 iface->idesc->bInterfaceClass,
2618 iface->idesc->bInterfaceSubClass,
2619 iface->idesc->bInterfaceProtocol);
2621 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2628 /*------------------------------------------------------------------------*
2629 * usb_fifo_free_wrap
2631 * This function will free the FIFOs.
2633 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2634 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2635 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2636 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2637 * control endpoint FIFOs. If "iface_index" is not set to
2638 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2639 *------------------------------------------------------------------------*/
2641 usb_fifo_free_wrap(struct usb_device *udev,
2642 uint8_t iface_index, uint8_t flag)
2648 * Free any USB FIFOs on the given interface:
2650 for (i = 0; i != USB_FIFO_MAX; i++) {
2655 /* Check if the interface index matches */
2656 if (iface_index == f->iface_index) {
2657 if (f->methods != &usb_ugen_methods) {
2659 * Don't free any non-generic FIFOs in
2664 if ((f->dev_ep_index == 0) &&
2665 (f->fs_xfer == NULL)) {
2666 /* no need to free this FIFO */
2669 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2670 if ((f->methods == &usb_ugen_methods) &&
2671 (f->dev_ep_index == 0) &&
2672 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2673 (f->fs_xfer == NULL)) {
2674 /* no need to free this FIFO */
2678 /* no need to free this FIFO */
2681 /* free this FIFO */
2687 /*------------------------------------------------------------------------*
2688 * usb_peer_can_wakeup
2691 * 0: Peer cannot do resume signalling.
2692 * Else: Peer can do resume signalling.
2693 *------------------------------------------------------------------------*/
2695 usb_peer_can_wakeup(struct usb_device *udev)
2697 const struct usb_config_descriptor *cdp;
2700 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2701 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2703 return (0); /* not supported */
2707 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2710 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2712 DPRINTF("udev %p state %s -> %s\n", udev,
2713 usb_statestr(udev->state), usb_statestr(state));
2716 mtx_lock(&usb_ref_lock);
2718 udev->state = state;
2720 mtx_unlock(&usb_ref_lock);
2722 if (udev->bus->methods->device_state_change != NULL)
2723 (udev->bus->methods->device_state_change) (udev);
2727 usb_get_device_state(struct usb_device *udev)
2730 return (USB_STATE_DETACHED);
2731 return (udev->state);
2735 usbd_device_attached(struct usb_device *udev)
2737 return (udev->state > USB_STATE_DETACHED);
2741 * The following function locks enumerating the given USB device. If
2742 * the lock is already grabbed this function returns zero. Else a
2743 * a value of one is returned.
2746 usbd_enum_lock(struct usb_device *udev)
2748 if (sx_xlocked(&udev->enum_sx))
2751 sx_xlock(&udev->enum_sx);
2752 sx_xlock(&udev->sr_sx);
2754 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2755 * are locked before locking Giant. Else the lock can be
2756 * locked multiple times.
2764 * This function is the same like usbd_enum_lock() except a value of
2765 * 255 is returned when a signal is pending:
2768 usbd_enum_lock_sig(struct usb_device *udev)
2770 if (sx_xlocked(&udev->enum_sx))
2772 if (sx_xlock_sig(&udev->enum_sx))
2774 if (sx_xlock_sig(&udev->sr_sx)) {
2775 sx_xunlock(&udev->enum_sx);
2783 /* The following function unlocks enumerating the given USB device. */
2786 usbd_enum_unlock(struct usb_device *udev)
2789 sx_xunlock(&udev->enum_sx);
2790 sx_xunlock(&udev->sr_sx);
2793 /* The following function locks suspend and resume. */
2796 usbd_sr_lock(struct usb_device *udev)
2798 sx_xlock(&udev->sr_sx);
2800 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2801 * are locked before locking Giant. Else the lock can be
2802 * locked multiple times.
2807 /* The following function unlocks suspend and resume. */
2810 usbd_sr_unlock(struct usb_device *udev)
2813 sx_xunlock(&udev->sr_sx);
2817 * The following function checks the enumerating lock for the given
2822 usbd_enum_is_locked(struct usb_device *udev)
2824 return (sx_xlocked(&udev->enum_sx));
2828 * The following function is used to set the per-interface specific
2829 * plug and play information. The string referred to by the pnpinfo
2830 * argument can safely be freed after calling this function. The
2831 * pnpinfo of an interface will be reset at device detach or when
2832 * passing a NULL argument to this function. This function
2833 * returns zero on success, else a USB_ERR_XXX failure code.
2837 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2839 struct usb_interface *iface;
2841 iface = usbd_get_iface(udev, iface_index);
2843 return (USB_ERR_INVAL);
2845 if (iface->pnpinfo != NULL) {
2846 free(iface->pnpinfo, M_USBDEV);
2847 iface->pnpinfo = NULL;
2850 if (pnpinfo == NULL || pnpinfo[0] == 0)
2851 return (0); /* success */
2853 iface->pnpinfo = strdup(pnpinfo, M_USBDEV);
2854 if (iface->pnpinfo == NULL)
2855 return (USB_ERR_NOMEM);
2857 return (0); /* success */
2861 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2865 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2866 if (udev->autoQuirk[x] == 0 ||
2867 udev->autoQuirk[x] == quirk) {
2868 udev->autoQuirk[x] = quirk;
2869 return (0); /* success */
2872 return (USB_ERR_NOMEM);
2876 * The following function is used to select the endpoint mode. It
2877 * should not be called outside enumeration context.
2881 usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep,
2887 /* Prevent re-enumeration */
2888 do_unlock = usbd_enum_lock(udev);
2890 if (udev->bus->methods->set_endpoint_mode != NULL) {
2891 error = (udev->bus->methods->set_endpoint_mode) (
2893 } else if (ep_mode != USB_EP_MODE_DEFAULT) {
2894 error = USB_ERR_INVAL;
2899 /* only set new mode regardless of error */
2900 ep->ep_mode = ep_mode;
2903 usbd_enum_unlock(udev);
2908 usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep)
2910 return (ep->ep_mode);