3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/stdint.h>
28 #include <sys/stddef.h>
29 #include <sys/param.h>
30 #include <sys/queue.h>
31 #include <sys/types.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/condvar.h>
39 #include <sys/sysctl.h>
41 #include <sys/unistd.h>
42 #include <sys/callout.h>
43 #include <sys/malloc.h>
46 #include <sys/fcntl.h>
48 #include <dev/usb/usb.h>
49 #include <dev/usb/usbdi.h>
50 #include <dev/usb/usbdi_util.h>
51 #include <dev/usb/usb_ioctl.h>
59 #define USB_DEBUG_VAR usb_debug
61 #include <dev/usb/usb_core.h>
62 #include <dev/usb/usb_debug.h>
63 #include <dev/usb/usb_process.h>
64 #include <dev/usb/usb_device.h>
65 #include <dev/usb/usb_busdma.h>
66 #include <dev/usb/usb_transfer.h>
67 #include <dev/usb/usb_request.h>
68 #include <dev/usb/usb_dynamic.h>
69 #include <dev/usb/usb_hub.h>
70 #include <dev/usb/usb_util.h>
71 #include <dev/usb/usb_msctest.h>
73 #include <dev/usb/usb_dev.h>
74 #include <dev/usb/usb_generic.h>
77 #include <dev/usb/quirk/usb_quirk.h>
79 #include <dev/usb/usb_controller.h>
80 #include <dev/usb/usb_bus.h>
82 /* function prototypes */
84 static void usb_init_endpoint(struct usb_device *, uint8_t,
85 struct usb_endpoint_descriptor *,
86 struct usb_endpoint_ss_comp_descriptor *,
87 struct usb_endpoint *);
88 static void usb_unconfigure(struct usb_device *, uint8_t);
89 static void usb_detach_device_sub(struct usb_device *, device_t *,
91 static uint8_t usb_probe_and_attach_sub(struct usb_device *,
92 struct usb_attach_arg *);
93 static void usb_init_attach_arg(struct usb_device *,
94 struct usb_attach_arg *);
95 static void usb_suspend_resume_sub(struct usb_device *, device_t,
97 static usb_proc_callback_t usbd_clear_stall_proc;
98 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
99 static void usbd_set_device_strings(struct usb_device *);
101 static void usb_notify_addq(const char *type, struct usb_device *);
104 static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
105 static void usb_cdev_create(struct usb_device *);
106 static void usb_cdev_free(struct usb_device *);
109 /* This variable is global to allow easy access to it: */
111 int usb_template = 0;
113 TUNABLE_INT("hw.usb.usb_template", &usb_template);
114 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW | CTLFLAG_TUN,
115 &usb_template, 0, "Selected USB device side template");
117 /* English is default language */
119 static int usb_lang_id = 0x0009;
120 static int usb_lang_mask = 0x00FF;
122 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
123 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW | CTLFLAG_TUN,
124 &usb_lang_id, 0, "Preferred USB language ID");
126 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
127 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW | CTLFLAG_TUN,
128 &usb_lang_mask, 0, "Preferred USB language mask");
130 static const char* statestr[USB_STATE_MAX] = {
131 [USB_STATE_DETACHED] = "DETACHED",
132 [USB_STATE_ATTACHED] = "ATTACHED",
133 [USB_STATE_POWERED] = "POWERED",
134 [USB_STATE_ADDRESSED] = "ADDRESSED",
135 [USB_STATE_CONFIGURED] = "CONFIGURED",
139 usb_statestr(enum usb_dev_state state)
141 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
145 usb_get_manufacturer(struct usb_device *udev)
147 return (udev->manufacturer ? udev->manufacturer : "Unknown");
151 usb_get_product(struct usb_device *udev)
153 return (udev->product ? udev->product : "");
157 usb_get_serial(struct usb_device *udev)
159 return (udev->serial ? udev->serial : "");
162 /*------------------------------------------------------------------------*
163 * usbd_get_ep_by_addr
165 * This function searches for an USB ep by endpoint address and
171 *------------------------------------------------------------------------*/
172 struct usb_endpoint *
173 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
175 struct usb_endpoint *ep = udev->endpoints;
176 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
178 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
182 * According to the USB specification not all bits are used
183 * for the endpoint address. Keep defined bits only:
188 * Iterate accross all the USB endpoints searching for a match
189 * based on the endpoint address:
191 for (; ep != ep_end; ep++) {
193 if (ep->edesc == NULL) {
196 /* do the mask and check the value */
197 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
203 * The default endpoint is always present and is checked separately:
205 if ((udev->ctrl_ep.edesc) &&
206 ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
216 /*------------------------------------------------------------------------*
219 * This function searches for an USB endpoint based on the information
220 * given by the passed "struct usb_config" pointer.
224 * Else: Pointer to "struct usb_endpoint".
225 *------------------------------------------------------------------------*/
226 struct usb_endpoint *
227 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
228 const struct usb_config *setup)
230 struct usb_endpoint *ep = udev->endpoints;
231 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
232 uint8_t index = setup->ep_index;
238 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
239 "type=0x%x dir=0x%x index=%d\n",
240 udev, iface_index, setup->endpoint,
241 setup->type, setup->direction, setup->ep_index);
245 if (setup->usb_mode != USB_MODE_DUAL &&
246 udev->flags.usb_mode != setup->usb_mode) {
247 /* wrong mode - no endpoint */
251 /* setup expected endpoint direction mask and value */
253 if (setup->direction == UE_DIR_RX) {
254 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
255 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
256 UE_DIR_OUT : UE_DIR_IN;
257 } else if (setup->direction == UE_DIR_TX) {
258 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
259 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
260 UE_DIR_IN : UE_DIR_OUT;
261 } else if (setup->direction == UE_DIR_ANY) {
262 /* match any endpoint direction */
266 /* match the given endpoint direction */
267 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
268 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
271 /* setup expected endpoint address */
273 if (setup->endpoint == UE_ADDR_ANY) {
274 /* match any endpoint address */
276 /* match the given endpoint address */
278 ea_val |= (setup->endpoint & UE_ADDR);
281 /* setup expected endpoint type */
283 if (setup->type == UE_BULK_INTR) {
284 /* this will match BULK and INTERRUPT endpoints */
287 } else if (setup->type == UE_TYPE_ANY) {
288 /* match any endpoint type */
292 /* match the given endpoint type */
293 type_mask = UE_XFERTYPE;
294 type_val = (setup->type & UE_XFERTYPE);
298 * Iterate accross all the USB endpoints searching for a match
299 * based on the endpoint address. Note that we are searching
300 * the endpoints from the beginning of the "udev->endpoints" array.
302 for (; ep != ep_end; ep++) {
304 if ((ep->edesc == NULL) ||
305 (ep->iface_index != iface_index)) {
308 /* do the masks and check the values */
310 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
311 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
319 * Match against default endpoint last, so that "any endpoint", "any
320 * address" and "any direction" returns the first endpoint of the
321 * interface. "iface_index" and "direction" is ignored:
323 if ((udev->ctrl_ep.edesc) &&
324 ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
325 ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
336 /*------------------------------------------------------------------------*
337 * usbd_interface_count
339 * This function stores the number of USB interfaces excluding
340 * alternate settings, which the USB config descriptor reports into
341 * the unsigned 8-bit integer pointed to by "count".
346 *------------------------------------------------------------------------*/
348 usbd_interface_count(struct usb_device *udev, uint8_t *count)
350 if (udev->cdesc == NULL) {
352 return (USB_ERR_NOT_CONFIGURED);
354 *count = udev->ifaces_max;
355 return (USB_ERR_NORMAL_COMPLETION);
359 /*------------------------------------------------------------------------*
362 * This function will initialise the USB endpoint structure pointed to by
363 * the "endpoint" argument. The structure pointed to by "endpoint" must be
364 * zeroed before calling this function.
365 *------------------------------------------------------------------------*/
367 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
368 struct usb_endpoint_descriptor *edesc,
369 struct usb_endpoint_ss_comp_descriptor *ecomp,
370 struct usb_endpoint *ep)
372 struct usb_bus_methods *methods;
374 methods = udev->bus->methods;
376 (methods->endpoint_init) (udev, edesc, ep);
378 /* initialise USB endpoint structure */
381 ep->iface_index = iface_index;
382 TAILQ_INIT(&ep->endpoint_q.head);
383 ep->endpoint_q.command = &usbd_pipe_start;
385 /* the pipe is not supported by the hardware */
386 if (ep->methods == NULL)
389 /* clear stall, if any */
390 if (methods->clear_stall != NULL) {
391 USB_BUS_LOCK(udev->bus);
392 (methods->clear_stall) (udev, ep);
393 USB_BUS_UNLOCK(udev->bus);
397 /*-----------------------------------------------------------------------*
398 * usb_endpoint_foreach
400 * This function will iterate all the USB endpoints except the control
401 * endpoint. This function is NULL safe.
404 * NULL: End of USB endpoints
405 * Else: Pointer to next USB endpoint
406 *------------------------------------------------------------------------*/
407 struct usb_endpoint *
408 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
410 struct usb_endpoint *ep_end;
416 ep_end = udev->endpoints + udev->endpoints_max;
418 /* get next endpoint */
420 ep = udev->endpoints;
424 /* find next allocated ep */
425 while (ep != ep_end) {
426 if (ep->edesc != NULL)
433 /*------------------------------------------------------------------------*
434 * usb_wait_pending_refs
436 * This function will wait for any USB references to go away before
437 * returning. This function is used before freeing a USB device.
438 *------------------------------------------------------------------------*/
440 usb_wait_pending_refs(struct usb_device *udev)
443 DPRINTF("Refcount = %d\n", (int)udev->refcount);
445 mtx_lock(&usb_ref_lock);
448 /* wait for any pending references to go away */
449 if (udev->refcount == 0) {
450 /* prevent further refs being taken, if any */
451 udev->refcount = USB_DEV_REF_MAX;
454 cv_wait(&udev->ref_cv, &usb_ref_lock);
456 mtx_unlock(&usb_ref_lock);
460 /*------------------------------------------------------------------------*
463 * This function will free all USB interfaces and USB endpoints belonging
466 * Flag values, see "USB_UNCFG_FLAG_XXX".
467 *------------------------------------------------------------------------*/
469 usb_unconfigure(struct usb_device *udev, uint8_t flag)
473 /* Prevent re-enumeration */
474 do_unlock = usbd_enum_lock(udev);
476 /* detach all interface drivers */
477 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
480 /* free all FIFOs except control endpoint FIFOs */
481 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
484 * Free all cdev's, if any.
489 #if USB_HAVE_COMPAT_LINUX
490 /* free Linux compat device, if any */
491 if (udev->linux_endpoint_start) {
492 usb_linux_free_device(udev);
493 udev->linux_endpoint_start = NULL;
497 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
499 /* free "cdesc" after "ifaces" and "endpoints", if any */
500 if (udev->cdesc != NULL) {
501 if (udev->flags.usb_mode != USB_MODE_DEVICE)
502 free(udev->cdesc, M_USB);
505 /* set unconfigured state */
506 udev->curr_config_no = USB_UNCONFIG_NO;
507 udev->curr_config_index = USB_UNCONFIG_INDEX;
510 usbd_enum_unlock(udev);
513 /*------------------------------------------------------------------------*
514 * usbd_set_config_index
516 * This function selects configuration by index, independent of the
517 * actual configuration number. This function should not be used by
523 *------------------------------------------------------------------------*/
525 usbd_set_config_index(struct usb_device *udev, uint8_t index)
527 struct usb_status ds;
528 struct usb_config_descriptor *cdp;
535 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
537 /* Prevent re-enumeration */
538 do_unlock = usbd_enum_lock(udev);
540 usb_unconfigure(udev, 0);
542 if (index == USB_UNCONFIG_INDEX) {
544 * Leave unallocated when unconfiguring the
545 * device. "usb_unconfigure()" will also reset
546 * the current config number and index.
548 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
549 if (udev->state == USB_STATE_CONFIGURED)
550 usb_set_device_state(udev, USB_STATE_ADDRESSED);
553 /* get the full config descriptor */
554 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
555 /* save some memory */
556 err = usbd_req_get_descriptor_ptr(udev, &cdp,
557 (UDESC_CONFIG << 8) | index);
560 err = usbd_req_get_config_desc_full(udev,
561 NULL, &cdp, M_USB, index);
566 /* set the new config descriptor */
570 /* Figure out if the device is self or bus powered. */
572 if ((!udev->flags.uq_bus_powered) &&
573 (cdp->bmAttributes & UC_SELF_POWERED) &&
574 (udev->flags.usb_mode == USB_MODE_HOST)) {
575 /* May be self powered. */
576 if (cdp->bmAttributes & UC_BUS_POWERED) {
577 /* Must ask device. */
578 err = usbd_req_get_device_status(udev, NULL, &ds);
580 DPRINTFN(0, "could not read "
581 "device status: %s\n",
583 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
586 DPRINTF("status=0x%04x \n",
591 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
592 "selfpowered=%d, power=%d\n",
594 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
595 selfpowered, cdp->bMaxPower * 2);
597 /* Check if we have enough power. */
598 power = cdp->bMaxPower * 2;
600 if (udev->parent_hub) {
601 max_power = udev->parent_hub->hub->portpower;
603 max_power = USB_MAX_POWER;
606 if (power > max_power) {
607 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
608 err = USB_ERR_NO_POWER;
611 /* Only update "self_powered" in USB Host Mode */
612 if (udev->flags.usb_mode == USB_MODE_HOST) {
613 udev->flags.self_powered = selfpowered;
616 udev->curr_config_no = cdp->bConfigurationValue;
617 udev->curr_config_index = index;
618 usb_set_device_state(udev, USB_STATE_CONFIGURED);
620 /* Set the actual configuration value. */
621 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
626 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
631 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
637 /* create device nodes for each endpoint */
638 usb_cdev_create(udev);
642 DPRINTF("error=%s\n", usbd_errstr(err));
644 usb_unconfigure(udev, 0);
647 usbd_enum_unlock(udev);
651 /*------------------------------------------------------------------------*
654 * This function will allocate and free USB interfaces and USB endpoints,
655 * parse the USB configuration structure and initialise the USB endpoints
656 * and interfaces. If "iface_index" is not equal to
657 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
658 * alternate_setting to be selected for the given interface. Else the
659 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
660 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
661 * is typically called when setting the configuration or when setting
662 * an alternate interface.
667 *------------------------------------------------------------------------*/
669 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
671 struct usb_idesc_parse_state ips;
672 struct usb_interface_descriptor *id;
673 struct usb_endpoint_descriptor *ed;
674 struct usb_interface *iface;
675 struct usb_endpoint *ep;
683 if (iface_index != USB_IFACE_INDEX_ANY) {
684 /* parameter overload */
694 DPRINTFN(5, "iface_index=%d cmd=%d\n",
697 if (cmd == USB_CFG_FREE)
700 if (cmd == USB_CFG_INIT) {
701 sx_assert(&udev->enum_sx, SA_LOCKED);
703 /* check for in-use endpoints */
705 ep = udev->endpoints;
706 ep_max = udev->endpoints_max;
708 /* look for matching endpoints */
709 if ((iface_index == USB_IFACE_INDEX_ANY) ||
710 (iface_index == ep->iface_index)) {
711 if (ep->refcount_alloc != 0) {
713 * This typically indicates a
714 * more serious error.
716 err = USB_ERR_IN_USE;
719 memset(ep, 0, sizeof(*ep));
720 /* make sure we don't zero the endpoint again */
721 ep->iface_index = USB_IFACE_INDEX_ANY;
731 memset(&ips, 0, sizeof(ips));
736 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
738 /* check for interface overflow */
739 if (ips.iface_index == USB_IFACE_MAX)
742 iface = udev->ifaces + ips.iface_index;
744 /* check for specific interface match */
746 if (cmd == USB_CFG_INIT) {
747 if ((iface_index != USB_IFACE_INDEX_ANY) &&
748 (iface_index != ips.iface_index)) {
749 /* wrong interface */
751 } else if (alt_index != ips.iface_index_alt) {
752 /* wrong alternate setting */
755 /* initialise interface */
761 /* check for new interface */
762 if (ips.iface_index_alt == 0) {
763 /* update current number of endpoints */
768 /* setup the USB interface structure */
770 /* set alternate index */
771 iface->alt_index = alt_index;
772 /* set default interface parent */
773 if (iface_index == USB_IFACE_INDEX_ANY) {
774 iface->parent_iface_index =
779 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
781 ed = (struct usb_endpoint_descriptor *)id;
785 /* iterate all the endpoint descriptors */
786 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
788 if (temp == USB_EP_MAX)
791 ep = udev->endpoints + temp;
796 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
798 DPRINTFN(5, "Found endpoint companion descriptor\n");
800 usb_init_endpoint(udev,
801 ips.iface_index, ed, ecomp, ep);
806 /* find maximum number of endpoints */
811 id = (struct usb_interface_descriptor *)ed;
815 /* NOTE: It is valid to have no interfaces and no endpoints! */
817 if (cmd == USB_CFG_ALLOC) {
818 udev->ifaces_max = ips.iface_index;
820 if (udev->ifaces_max != 0) {
821 udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max,
822 M_USB, M_WAITOK | M_ZERO);
823 if (udev->ifaces == NULL) {
829 udev->endpoints = malloc(sizeof(*ep) * ep_max,
830 M_USB, M_WAITOK | M_ZERO);
831 if (udev->endpoints == NULL) {
836 udev->endpoints = NULL;
838 USB_BUS_LOCK(udev->bus);
839 udev->endpoints_max = ep_max;
840 /* reset any ongoing clear-stall */
841 udev->ep_curr = NULL;
842 USB_BUS_UNLOCK(udev->bus);
847 if (cmd == USB_CFG_ALLOC) {
849 USB_BUS_LOCK(udev->bus);
850 udev->endpoints_max = 0;
851 /* reset any ongoing clear-stall */
852 udev->ep_curr = NULL;
853 USB_BUS_UNLOCK(udev->bus);
856 if (udev->ifaces != NULL)
857 free(udev->ifaces, M_USB);
858 if (udev->endpoints != NULL)
859 free(udev->endpoints, M_USB);
862 udev->endpoints = NULL;
863 udev->ifaces_max = 0;
869 /*------------------------------------------------------------------------*
870 * usbd_set_alt_interface_index
872 * This function will select an alternate interface index for the
873 * given interface index. The interface should not be in use when this
874 * function is called. That means there should not be any open USB
875 * transfers. Else an error is returned. If the alternate setting is
876 * already set this function will simply return success. This function
877 * is called in Host mode and Device mode!
882 *------------------------------------------------------------------------*/
884 usbd_set_alt_interface_index(struct usb_device *udev,
885 uint8_t iface_index, uint8_t alt_index)
887 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
891 /* Prevent re-enumeration */
892 do_unlock = usbd_enum_lock(udev);
898 if (iface->alt_index == alt_index) {
900 * Optimise away duplicate setting of
901 * alternate setting in USB Host Mode!
908 * Free all generic FIFOs for this interface, except control
911 usb_fifo_free_wrap(udev, iface_index, 0);
914 err = usb_config_parse(udev, iface_index, alt_index);
918 if (iface->alt_index != alt_index) {
919 /* the alternate setting does not exist */
924 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
925 iface->idesc->bAlternateSetting);
929 usbd_enum_unlock(udev);
933 /*------------------------------------------------------------------------*
934 * usbd_set_endpoint_stall
936 * This function is used to make a BULK or INTERRUPT endpoint send
937 * STALL tokens in USB device mode.
942 *------------------------------------------------------------------------*/
944 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
947 struct usb_xfer *xfer;
953 DPRINTF("Cannot find endpoint\n");
955 * Pretend that the clear or set stall request is
956 * successful else some USB host stacks can do
957 * strange things, especially when a control endpoint
962 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
964 if ((et != UE_BULK) &&
965 (et != UE_INTERRUPT)) {
967 * Should not stall control
968 * nor isochronous endpoints.
970 DPRINTF("Invalid endpoint\n");
973 USB_BUS_LOCK(udev->bus);
975 /* store current stall state */
976 was_stalled = ep->is_stalled;
978 /* check for no change */
979 if (was_stalled && do_stall) {
980 /* if the endpoint is already stalled do nothing */
981 USB_BUS_UNLOCK(udev->bus);
982 DPRINTF("No change\n");
985 /* set stalled state */
988 if (do_stall || (!was_stalled)) {
990 /* lookup the current USB transfer, if any */
991 xfer = ep->endpoint_q.curr;
997 * If "xfer" is non-NULL the "set_stall" method will
998 * complete the USB transfer like in case of a timeout
999 * setting the error code "USB_ERR_STALLED".
1001 (udev->bus->methods->set_stall) (udev, xfer, ep, &do_stall);
1004 ep->toggle_next = 0; /* reset data toggle */
1005 ep->is_stalled = 0; /* clear stalled state */
1007 (udev->bus->methods->clear_stall) (udev, ep);
1009 /* start up the current or next transfer, if any */
1010 usb_command_wrapper(&ep->endpoint_q, ep->endpoint_q.curr);
1012 USB_BUS_UNLOCK(udev->bus);
1016 /*------------------------------------------------------------------------*
1017 * usb_reset_iface_endpoints - used in USB device side mode
1018 *------------------------------------------------------------------------*/
1020 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1022 struct usb_endpoint *ep;
1023 struct usb_endpoint *ep_end;
1025 ep = udev->endpoints;
1026 ep_end = udev->endpoints + udev->endpoints_max;
1028 for (; ep != ep_end; ep++) {
1030 if ((ep->edesc == NULL) ||
1031 (ep->iface_index != iface_index)) {
1034 /* simulate a clear stall from the peer */
1035 usbd_set_endpoint_stall(udev, ep, 0);
1040 /*------------------------------------------------------------------------*
1041 * usb_detach_device_sub
1043 * This function will try to detach an USB device. If it fails a panic
1046 * Flag values, see "USB_UNCFG_FLAG_XXX".
1047 *------------------------------------------------------------------------*/
1049 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1050 char **ppnpinfo, uint8_t flag)
1059 * NOTE: It is important to clear "*ppdev" before deleting
1060 * the child due to some device methods being called late
1061 * during the delete process !
1065 device_printf(dev, "at %s, port %d, addr %d "
1067 device_get_nameunit(udev->parent_dev),
1068 udev->port_no, udev->address);
1070 if (device_is_attached(dev)) {
1071 if (udev->flags.peer_suspended) {
1072 err = DEVICE_RESUME(dev);
1074 device_printf(dev, "Resume failed\n");
1077 if (device_detach(dev)) {
1081 if (device_delete_child(udev->parent_dev, dev)) {
1086 pnpinfo = *ppnpinfo;
1087 if (pnpinfo != NULL) {
1089 free(pnpinfo, M_USBDEV);
1094 /* Detach is not allowed to fail in the USB world */
1095 panic("usb_detach_device_sub: A USB driver would not detach\n");
1098 /*------------------------------------------------------------------------*
1101 * The following function will detach the matching interfaces.
1102 * This function is NULL safe.
1104 * Flag values, see "USB_UNCFG_FLAG_XXX".
1105 *------------------------------------------------------------------------*/
1107 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1110 struct usb_interface *iface;
1117 DPRINTFN(4, "udev=%p\n", udev);
1119 sx_assert(&udev->enum_sx, SA_LOCKED);
1122 * First detach the child to give the child's detach routine a
1123 * chance to detach the sub-devices in the correct order.
1124 * Then delete the child using "device_delete_child()" which
1125 * will detach all sub-devices from the bottom and upwards!
1127 if (iface_index != USB_IFACE_INDEX_ANY) {
1129 iface_index = i + 1;
1132 iface_index = USB_IFACE_MAX;
1137 for (; i != iface_index; i++) {
1139 iface = usbd_get_iface(udev, i);
1140 if (iface == NULL) {
1141 /* looks like the end of the USB interfaces */
1144 usb_detach_device_sub(udev, &iface->subdev,
1145 &iface->pnpinfo, flag);
1149 /*------------------------------------------------------------------------*
1150 * usb_probe_and_attach_sub
1155 *------------------------------------------------------------------------*/
1157 usb_probe_and_attach_sub(struct usb_device *udev,
1158 struct usb_attach_arg *uaa)
1160 struct usb_interface *iface;
1165 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1166 /* leave interface alone */
1169 dev = iface->subdev;
1172 /* clean up after module unload */
1174 if (device_is_attached(dev)) {
1175 /* already a device there */
1178 /* clear "iface->subdev" as early as possible */
1180 iface->subdev = NULL;
1182 if (device_delete_child(udev->parent_dev, dev)) {
1185 * Panic here, else one can get a double call
1186 * to device_detach(). USB devices should
1187 * never fail on detach!
1189 panic("device_delete_child() failed\n");
1192 if (uaa->temp_dev == NULL) {
1194 /* create a new child */
1195 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1196 if (uaa->temp_dev == NULL) {
1197 device_printf(udev->parent_dev,
1198 "Device creation failed\n");
1199 return (1); /* failure */
1201 device_set_ivars(uaa->temp_dev, uaa);
1202 device_quiet(uaa->temp_dev);
1205 * Set "subdev" before probe and attach so that "devd" gets
1206 * the information it needs.
1208 iface->subdev = uaa->temp_dev;
1210 if (device_probe_and_attach(iface->subdev) == 0) {
1212 * The USB attach arguments are only available during probe
1215 uaa->temp_dev = NULL;
1216 device_set_ivars(iface->subdev, NULL);
1218 if (udev->flags.peer_suspended) {
1219 err = DEVICE_SUSPEND(iface->subdev);
1221 device_printf(iface->subdev, "Suspend failed\n");
1223 return (0); /* success */
1225 /* No USB driver found */
1226 iface->subdev = NULL;
1228 return (1); /* failure */
1231 /*------------------------------------------------------------------------*
1232 * usbd_set_parent_iface
1234 * Using this function will lock the alternate interface setting on an
1235 * interface. It is typically used for multi interface drivers. In USB
1236 * device side mode it is assumed that the alternate interfaces all
1237 * have the same endpoint descriptors. The default parent index value
1238 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1240 *------------------------------------------------------------------------*/
1242 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1243 uint8_t parent_index)
1245 struct usb_interface *iface;
1251 iface = usbd_get_iface(udev, iface_index);
1253 iface->parent_iface_index = parent_index;
1257 usb_init_attach_arg(struct usb_device *udev,
1258 struct usb_attach_arg *uaa)
1260 memset(uaa, 0, sizeof(*uaa));
1263 uaa->usb_mode = udev->flags.usb_mode;
1264 uaa->port = udev->port_no;
1265 uaa->dev_state = UAA_DEV_READY;
1267 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1268 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1269 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1270 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1271 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1272 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1273 uaa->info.bConfigIndex = udev->curr_config_index;
1274 uaa->info.bConfigNum = udev->curr_config_no;
1277 /*------------------------------------------------------------------------*
1278 * usb_probe_and_attach
1280 * This function is called from "uhub_explore_sub()",
1281 * "usb_handle_set_config()" and "usb_handle_request()".
1285 * Else: A control transfer failed
1286 *------------------------------------------------------------------------*/
1288 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1290 struct usb_attach_arg uaa;
1291 struct usb_interface *iface;
1297 DPRINTF("udev == NULL\n");
1298 return (USB_ERR_INVAL);
1300 /* Prevent re-enumeration */
1301 do_unlock = usbd_enum_lock(udev);
1303 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1304 /* do nothing - no configuration has been set */
1307 /* setup USB attach arguments */
1309 usb_init_attach_arg(udev, &uaa);
1312 * If the whole USB device is targeted, invoke the USB event
1315 if (iface_index == USB_IFACE_INDEX_ANY) {
1317 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1319 if (uaa.dev_state != UAA_DEV_READY) {
1320 /* leave device unconfigured */
1321 usb_unconfigure(udev, 0);
1326 /* Check if only one interface should be probed: */
1327 if (iface_index != USB_IFACE_INDEX_ANY) {
1335 /* Do the probe and attach */
1336 for (; i != j; i++) {
1338 iface = usbd_get_iface(udev, i);
1339 if (iface == NULL) {
1341 * Looks like the end of the USB
1344 DPRINTFN(2, "end of interfaces "
1348 if (iface->idesc == NULL) {
1349 /* no interface descriptor */
1354 uaa.info.bInterfaceClass =
1355 iface->idesc->bInterfaceClass;
1356 uaa.info.bInterfaceSubClass =
1357 iface->idesc->bInterfaceSubClass;
1358 uaa.info.bInterfaceProtocol =
1359 iface->idesc->bInterfaceProtocol;
1360 uaa.info.bIfaceIndex = i;
1361 uaa.info.bIfaceNum =
1362 iface->idesc->bInterfaceNumber;
1363 uaa.driver_info = 0; /* reset driver_info */
1365 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1366 uaa.info.bInterfaceClass,
1367 uaa.info.bInterfaceSubClass,
1368 uaa.info.bInterfaceProtocol,
1369 uaa.info.bIfaceIndex,
1370 uaa.info.bIfaceNum);
1372 usb_probe_and_attach_sub(udev, &uaa);
1375 * Remove the leftover child, if any, to enforce that
1376 * a new nomatch devd event is generated for the next
1377 * interface if no driver is found:
1379 if (uaa.temp_dev == NULL)
1381 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1382 DPRINTFN(0, "device delete child failed\n");
1383 uaa.temp_dev = NULL;
1387 usbd_enum_unlock(udev);
1391 /*------------------------------------------------------------------------*
1392 * usb_suspend_resume_sub
1394 * This function is called when the suspend or resume methods should
1395 * be executed on an USB device.
1396 *------------------------------------------------------------------------*/
1398 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1405 if (!device_is_attached(dev)) {
1409 err = DEVICE_SUSPEND(dev);
1411 err = DEVICE_RESUME(dev);
1414 device_printf(dev, "%s failed\n",
1415 do_suspend ? "Suspend" : "Resume");
1419 /*------------------------------------------------------------------------*
1420 * usb_suspend_resume
1422 * The following function will suspend or resume the USB device.
1427 *------------------------------------------------------------------------*/
1429 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1431 struct usb_interface *iface;
1438 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1440 sx_assert(&udev->sr_sx, SA_LOCKED);
1442 USB_BUS_LOCK(udev->bus);
1443 /* filter the suspend events */
1444 if (udev->flags.peer_suspended == do_suspend) {
1445 USB_BUS_UNLOCK(udev->bus);
1449 udev->flags.peer_suspended = do_suspend;
1450 USB_BUS_UNLOCK(udev->bus);
1452 /* do the suspend or resume */
1454 for (i = 0; i != USB_IFACE_MAX; i++) {
1456 iface = usbd_get_iface(udev, i);
1457 if (iface == NULL) {
1458 /* looks like the end of the USB interfaces */
1461 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1466 /*------------------------------------------------------------------------*
1467 * usbd_clear_stall_proc
1469 * This function performs generic USB clear stall operations.
1470 *------------------------------------------------------------------------*/
1472 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1474 struct usb_udev_msg *pm = (void *)_pm;
1475 struct usb_device *udev = pm->udev;
1478 USB_BUS_UNLOCK(udev->bus);
1479 mtx_lock(&udev->device_mtx);
1481 /* Start clear stall callback */
1482 usbd_transfer_start(udev->ctrl_xfer[1]);
1485 mtx_unlock(&udev->device_mtx);
1486 USB_BUS_LOCK(udev->bus);
1489 /*------------------------------------------------------------------------*
1492 * This function allocates a new USB device. This function is called
1493 * when a new device has been put in the powered state, but not yet in
1494 * the addressed state. Get initial descriptor, set the address, get
1495 * full descriptor and get strings.
1500 *------------------------------------------------------------------------*/
1502 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1503 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1504 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1506 struct usb_attach_arg uaa;
1507 struct usb_device *udev;
1508 struct usb_device *adev;
1509 struct usb_device *hub;
1510 uint8_t *scratch_ptr;
1512 uint8_t device_index;
1513 uint8_t config_index;
1514 uint8_t config_quirk;
1515 uint8_t set_config_failed;
1518 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1519 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1520 parent_dev, bus, parent_hub, depth, port_index, port_no,
1524 * Find an unused device index. In USB Host mode this is the
1525 * same as the device address.
1527 * Device index zero is not used and device index 1 should
1528 * always be the root hub.
1530 for (device_index = USB_ROOT_HUB_ADDR;
1531 (device_index != bus->devices_max) &&
1532 (bus->devices[device_index] != NULL);
1533 device_index++) /* nop */;
1535 if (device_index == bus->devices_max) {
1536 device_printf(bus->bdev,
1537 "No free USB device index for new device\n");
1542 device_printf(bus->bdev,
1543 "Invalid device depth\n");
1546 udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1550 /* initialise our SX-lock */
1551 sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1552 sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS);
1553 sx_init_flags(&udev->ctrl_sx, "USB control transfer SX lock", SX_DUPOK);
1555 cv_init(&udev->ctrlreq_cv, "WCTRL");
1556 cv_init(&udev->ref_cv, "UGONE");
1558 /* initialise our mutex */
1559 mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF);
1561 /* initialise generic clear stall */
1562 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1563 udev->cs_msg[0].udev = udev;
1564 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1565 udev->cs_msg[1].udev = udev;
1567 /* initialise some USB device fields */
1568 udev->parent_hub = parent_hub;
1569 udev->parent_dev = parent_dev;
1570 udev->port_index = port_index;
1571 udev->port_no = port_no;
1572 udev->depth = depth;
1574 udev->address = USB_START_ADDR; /* default value */
1575 udev->plugtime = (usb_ticks_t)ticks;
1577 * We need to force the power mode to "on" because there are plenty
1578 * of USB devices out there that do not work very well with
1579 * automatic suspend and resume!
1581 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1582 udev->pwr_save.last_xfer_time = ticks;
1583 /* we are not ready yet */
1586 /* set up default endpoint descriptor */
1587 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1588 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1589 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1590 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1591 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1592 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1593 udev->ctrl_ep_desc.bInterval = 0;
1595 /* set up default endpoint companion descriptor */
1596 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1597 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1599 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1601 udev->speed = speed;
1602 udev->flags.usb_mode = mode;
1604 /* search for our High Speed USB HUB, if any */
1607 hub = udev->parent_hub;
1610 if (hub->speed == USB_SPEED_HIGH) {
1611 udev->hs_hub_addr = hub->address;
1612 udev->parent_hs_hub = hub;
1613 udev->hs_port_no = adev->port_no;
1617 hub = hub->parent_hub;
1620 /* init the default endpoint */
1621 usb_init_endpoint(udev, 0,
1622 &udev->ctrl_ep_desc,
1623 &udev->ctrl_ep_comp_desc,
1626 /* set device index */
1627 udev->device_index = device_index;
1630 /* Create ugen name */
1631 snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1632 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1634 LIST_INIT(&udev->pd_list);
1636 /* Create the control endpoint device */
1637 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1638 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1640 /* Create a link from /dev/ugenX.X to the default endpoint */
1641 if (udev->ctrl_dev != NULL)
1642 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1644 /* Initialise device */
1645 if (bus->methods->device_init != NULL) {
1646 err = (bus->methods->device_init) (udev);
1648 DPRINTFN(0, "device init %d failed "
1649 "(%s, ignored)\n", device_index,
1654 /* set powered device state after device init is complete */
1655 usb_set_device_state(udev, USB_STATE_POWERED);
1657 if (udev->flags.usb_mode == USB_MODE_HOST) {
1659 err = usbd_req_set_address(udev, NULL, device_index);
1662 * This is the new USB device address from now on, if
1663 * the set address request didn't set it already.
1665 if (udev->address == USB_START_ADDR)
1666 udev->address = device_index;
1669 * We ignore any set-address errors, hence there are
1670 * buggy USB devices out there that actually receive
1671 * the SETUP PID, but manage to set the address before
1672 * the STATUS stage is ACK'ed. If the device responds
1673 * to the subsequent get-descriptor at the new
1674 * address, then we know that the set-address command
1678 DPRINTFN(0, "set address %d failed "
1679 "(%s, ignored)\n", udev->address,
1683 /* We are not self powered */
1684 udev->flags.self_powered = 0;
1686 /* Set unconfigured state */
1687 udev->curr_config_no = USB_UNCONFIG_NO;
1688 udev->curr_config_index = USB_UNCONFIG_INDEX;
1690 /* Setup USB descriptors */
1691 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1693 DPRINTFN(0, "setting up USB template failed maybe the USB "
1694 "template module has not been loaded\n");
1698 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1700 /* setup the device descriptor and the initial "wMaxPacketSize" */
1701 err = usbd_setup_device_desc(udev, NULL);
1704 /* try to enumerate two more times */
1705 err = usbd_req_re_enumerate(udev, NULL);
1707 err = usbd_req_re_enumerate(udev, NULL);
1715 * Setup temporary USB attach args so that we can figure out some
1716 * basic quirks for this device.
1718 usb_init_attach_arg(udev, &uaa);
1720 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1721 udev->flags.uq_bus_powered = 1;
1723 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1724 udev->flags.no_strings = 1;
1727 * Workaround for buggy USB devices.
1729 * It appears that some string-less USB chips will crash and
1730 * disappear if any attempts are made to read any string
1733 * Try to detect such chips by checking the strings in the USB
1734 * device descriptor. If no strings are present there we
1735 * simply disable all USB strings.
1738 /* Protect scratch area */
1739 do_unlock = usbd_ctrl_lock(udev);
1741 scratch_ptr = udev->scratch.data;
1743 if (udev->flags.no_strings) {
1744 err = USB_ERR_INVAL;
1745 } else if (udev->ddesc.iManufacturer ||
1746 udev->ddesc.iProduct ||
1747 udev->ddesc.iSerialNumber) {
1748 /* read out the language ID string */
1749 err = usbd_req_get_string_desc(udev, NULL,
1750 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1752 err = USB_ERR_INVAL;
1755 if (err || (scratch_ptr[0] < 4)) {
1756 udev->flags.no_strings = 1;
1763 /* load preferred value and mask */
1765 mask = usb_lang_mask;
1767 /* align length correctly */
1768 scratch_ptr[0] &= ~1U;
1770 /* fix compiler warning */
1773 /* search for preferred language */
1774 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1775 langid = UGETW(scratch_ptr + x);
1776 if ((langid & mask) == pref)
1779 if (x >= scratch_ptr[0]) {
1780 /* pick the first language as the default */
1781 DPRINTFN(1, "Using first language\n");
1782 langid = UGETW(scratch_ptr + 2);
1785 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1786 udev->langid = langid;
1790 usbd_ctrl_unlock(udev);
1792 /* assume 100mA bus powered for now. Changed when configured. */
1793 udev->power = USB_MIN_POWER;
1794 /* fetch the vendor and product strings from the device */
1795 usbd_set_device_strings(udev);
1797 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1798 /* USB device mode setup is complete */
1804 * Most USB devices should attach to config index 0 by
1807 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1810 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1813 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1816 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1819 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1827 set_config_failed = 0;
1830 DPRINTF("setting config %u\n", config_index);
1832 /* get the USB device configured */
1833 err = usbd_set_config_index(udev, config_index);
1835 if (udev->ddesc.bNumConfigurations != 0) {
1836 if (!set_config_failed) {
1837 set_config_failed = 1;
1838 /* XXX try to re-enumerate the device */
1839 err = usbd_req_re_enumerate(udev, NULL);
1841 goto repeat_set_config;
1843 DPRINTFN(0, "Failure selecting configuration index %u:"
1844 "%s, port %u, addr %u (ignored)\n",
1845 config_index, usbd_errstr(err), udev->port_no,
1849 * Some USB devices do not have any configurations. Ignore any
1850 * set config failures!
1855 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1856 if ((udev->cdesc->bNumInterface < 2) &&
1857 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1858 DPRINTFN(0, "Found no endpoints, trying next config\n");
1860 goto repeat_set_config;
1862 if (config_index == 0) {
1864 * Try to figure out if we have an
1865 * auto-install disk there:
1867 if (usb_iface_is_cdrom(udev, 0)) {
1868 DPRINTFN(0, "Found possible auto-install "
1869 "disk (trying next config)\n");
1871 goto repeat_set_config;
1875 if (set_config_failed == 0 && config_index == 0 &&
1876 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1877 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1880 * Try to figure out if there are any MSC quirks we
1881 * should apply automatically:
1883 err = usb_msc_auto_quirk(udev, 0);
1886 set_config_failed = 1;
1887 goto repeat_set_config;
1892 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1893 udev->address, udev, udev->parent_hub);
1895 /* register our device - we are ready */
1896 usb_bus_port_set_device(bus, parent_hub ?
1897 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1900 /* Symlink the ugen device name */
1901 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1903 /* Announce device */
1904 printf("%s: <%s> at %s\n", udev->ugen_name,
1905 usb_get_manufacturer(udev),
1906 device_get_nameunit(udev->bus->bdev));
1910 usb_notify_addq("ATTACH", udev);
1915 * Free USB device and all subdevices, if any.
1917 usb_free_device(udev, 0);
1924 struct usb_fs_privdata *
1925 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1926 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1928 struct usb_fs_privdata* pd;
1931 /* Store information to locate ourselves again later */
1932 pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1934 pd->bus_index = device_get_unit(udev->bus->bdev);
1935 pd->dev_index = udev->device_index;
1937 pd->fifo_index = fi;
1940 /* Now, create the device itself */
1941 if (devname == NULL) {
1943 snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1944 pd->bus_index, pd->dev_index, pd->ep_addr);
1947 pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname);
1949 if (pd->cdev == NULL) {
1950 DPRINTFN(0, "Failed to create device %s\n", devname);
1955 /* XXX setting si_drv1 and creating the device is not atomic! */
1956 pd->cdev->si_drv1 = pd;
1962 usb_destroy_dev_sync(struct usb_fs_privdata *pd)
1964 DPRINTFN(1, "Destroying device at ugen%d.%d\n",
1965 pd->bus_index, pd->dev_index);
1968 * Destroy character device synchronously. After this
1969 * all system calls are returned. Can block.
1971 destroy_dev(pd->cdev);
1977 usb_destroy_dev(struct usb_fs_privdata *pd)
1979 struct usb_bus *bus;
1984 mtx_lock(&usb_ref_lock);
1985 bus = devclass_get_softc(usb_devclass_ptr, pd->bus_index);
1986 mtx_unlock(&usb_ref_lock);
1989 usb_destroy_dev_sync(pd);
1994 LIST_INSERT_HEAD(&bus->pd_cleanup_list, pd, pd_next);
1995 /* get cleanup going */
1996 usb_proc_msignal(&bus->explore_proc,
1997 &bus->cleanup_msg[0], &bus->cleanup_msg[1]);
1998 USB_BUS_UNLOCK(bus);
2002 usb_cdev_create(struct usb_device *udev)
2004 struct usb_config_descriptor *cd;
2005 struct usb_endpoint_descriptor *ed;
2006 struct usb_descriptor *desc;
2007 struct usb_fs_privdata* pd;
2008 int inmode, outmode, inmask, outmask, mode;
2011 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2013 DPRINTFN(2, "Creating device nodes\n");
2015 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2018 } else { /* USB_MODE_HOST */
2028 * Collect all used endpoint numbers instead of just
2029 * generating 16 static endpoints.
2031 cd = usbd_get_config_descriptor(udev);
2032 while ((desc = usb_desc_foreach(cd, desc))) {
2033 /* filter out all endpoint descriptors */
2034 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2035 (desc->bLength >= sizeof(*ed))) {
2036 ed = (struct usb_endpoint_descriptor *)desc;
2039 ep = ed->bEndpointAddress;
2040 if (UE_GET_DIR(ep) == UE_DIR_OUT)
2041 outmask |= 1 << UE_GET_ADDR(ep);
2043 inmask |= 1 << UE_GET_ADDR(ep);
2047 /* Create all available endpoints except EP0 */
2048 for (ep = 1; ep < 16; ep++) {
2049 mode = (inmask & (1 << ep)) ? inmode : 0;
2050 mode |= (outmask & (1 << ep)) ? outmode : 0;
2052 continue; /* no IN or OUT endpoint */
2054 pd = usb_make_dev(udev, NULL, ep, 0,
2055 mode, UID_ROOT, GID_OPERATOR, 0600);
2058 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2063 usb_cdev_free(struct usb_device *udev)
2065 struct usb_fs_privdata* pd;
2067 DPRINTFN(2, "Freeing device nodes\n");
2069 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2070 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2072 LIST_REMOVE(pd, pd_next);
2074 usb_destroy_dev(pd);
2079 /*------------------------------------------------------------------------*
2082 * This function is NULL safe and will free an USB device and its
2083 * children devices, if any.
2085 * Flag values: Reserved, set to zero.
2086 *------------------------------------------------------------------------*/
2088 usb_free_device(struct usb_device *udev, uint8_t flag)
2090 struct usb_bus *bus;
2093 return; /* already freed */
2095 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2099 /* set DETACHED state to prevent any further references */
2100 usb_set_device_state(udev, USB_STATE_DETACHED);
2103 usb_notify_addq("DETACH", udev);
2107 printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2108 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2110 /* Destroy UGEN symlink, if any */
2111 if (udev->ugen_symlink) {
2112 usb_free_symlink(udev->ugen_symlink);
2113 udev->ugen_symlink = NULL;
2116 usb_destroy_dev(udev->ctrl_dev);
2119 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2120 /* stop receiving any control transfers (Device Side Mode) */
2121 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2124 /* the following will get the device unconfigured in software */
2125 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2127 /* final device unregister after all character devices are closed */
2128 usb_bus_port_set_device(bus, udev->parent_hub ?
2129 udev->parent_hub->hub->ports + udev->port_index : NULL,
2130 NULL, USB_ROOT_HUB_ADDR);
2132 /* unsetup any leftover default USB transfers */
2133 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2135 /* template unsetup, if any */
2136 (usb_temp_unsetup_p) (udev);
2139 * Make sure that our clear-stall messages are not queued
2142 USB_BUS_LOCK(udev->bus);
2143 usb_proc_mwait(&udev->bus->non_giant_callback_proc,
2144 &udev->cs_msg[0], &udev->cs_msg[1]);
2145 USB_BUS_UNLOCK(udev->bus);
2147 /* wait for all references to go away */
2148 usb_wait_pending_refs(udev);
2150 sx_destroy(&udev->enum_sx);
2151 sx_destroy(&udev->sr_sx);
2152 sx_destroy(&udev->ctrl_sx);
2154 cv_destroy(&udev->ctrlreq_cv);
2155 cv_destroy(&udev->ref_cv);
2157 mtx_destroy(&udev->device_mtx);
2159 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2162 /* Uninitialise device */
2163 if (bus->methods->device_uninit != NULL)
2164 (bus->methods->device_uninit) (udev);
2167 free(udev->serial, M_USB);
2168 free(udev->manufacturer, M_USB);
2169 free(udev->product, M_USB);
2173 /*------------------------------------------------------------------------*
2176 * This function is the safe way to get the USB interface structure
2177 * pointer by interface index.
2180 * NULL: Interface not present.
2181 * Else: Pointer to USB interface structure.
2182 *------------------------------------------------------------------------*/
2183 struct usb_interface *
2184 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2186 struct usb_interface *iface = udev->ifaces + iface_index;
2188 if (iface_index >= udev->ifaces_max)
2193 /*------------------------------------------------------------------------*
2194 * usbd_find_descriptor
2196 * This function will lookup the first descriptor that matches the
2197 * criteria given by the arguments "type" and "subtype". Descriptors
2198 * will only be searched within the interface having the index
2199 * "iface_index". If the "id" argument points to an USB descriptor,
2200 * it will be skipped before the search is started. This allows
2201 * searching for multiple descriptors using the same criteria. Else
2202 * the search is started after the interface descriptor.
2205 * NULL: End of descriptors
2206 * Else: A descriptor matching the criteria
2207 *------------------------------------------------------------------------*/
2209 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2210 uint8_t type, uint8_t type_mask,
2211 uint8_t subtype, uint8_t subtype_mask)
2213 struct usb_descriptor *desc;
2214 struct usb_config_descriptor *cd;
2215 struct usb_interface *iface;
2217 cd = usbd_get_config_descriptor(udev);
2222 iface = usbd_get_iface(udev, iface_index);
2223 if (iface == NULL) {
2226 id = usbd_get_interface_descriptor(iface);
2233 while ((desc = usb_desc_foreach(cd, desc))) {
2235 if (desc->bDescriptorType == UDESC_INTERFACE) {
2238 if (((desc->bDescriptorType & type_mask) == type) &&
2239 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2246 /*------------------------------------------------------------------------*
2249 * This function will dump information from the device descriptor
2250 * belonging to the USB device pointed to by "udev", to the string
2251 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2252 * including the terminating zero.
2253 *------------------------------------------------------------------------*/
2255 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2257 struct usb_device_descriptor *udd = &udev->ddesc;
2261 bcdUSB = UGETW(udd->bcdUSB);
2262 bcdDevice = UGETW(udd->bcdDevice);
2264 if (udd->bDeviceClass != 0xFF) {
2265 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2267 usb_get_manufacturer(udev),
2268 usb_get_product(udev),
2269 udd->bDeviceClass, udd->bDeviceSubClass,
2270 (bcdUSB >> 8), bcdUSB & 0xFF,
2271 (bcdDevice >> 8), bcdDevice & 0xFF,
2274 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2276 usb_get_manufacturer(udev),
2277 usb_get_product(udev),
2278 (bcdUSB >> 8), bcdUSB & 0xFF,
2279 (bcdDevice >> 8), bcdDevice & 0xFF,
2286 * Descriptions of of known vendors and devices ("products").
2288 struct usb_knowndev {
2292 const char *vendorname;
2293 const char *productname;
2296 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2298 #include "usbdevs.h"
2299 #include "usbdevs_data.h"
2300 #endif /* USB_VERBOSE */
2303 usbd_set_device_strings(struct usb_device *udev)
2305 struct usb_device_descriptor *udd = &udev->ddesc;
2307 const struct usb_knowndev *kdp;
2312 uint16_t product_id;
2315 /* Protect scratch area */
2316 do_unlock = usbd_ctrl_lock(udev);
2318 temp_ptr = (char *)udev->scratch.data;
2319 temp_size = sizeof(udev->scratch.data);
2321 vendor_id = UGETW(udd->idVendor);
2322 product_id = UGETW(udd->idProduct);
2324 /* get serial number string */
2325 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2326 udev->ddesc.iSerialNumber);
2327 udev->serial = strdup(temp_ptr, M_USB);
2329 /* get manufacturer string */
2330 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2331 udev->ddesc.iManufacturer);
2332 usb_trim_spaces(temp_ptr);
2333 if (temp_ptr[0] != '\0')
2334 udev->manufacturer = strdup(temp_ptr, M_USB);
2336 /* get product string */
2337 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2338 udev->ddesc.iProduct);
2339 usb_trim_spaces(temp_ptr);
2340 if (temp_ptr[0] != '\0')
2341 udev->product = strdup(temp_ptr, M_USB);
2344 if (udev->manufacturer == NULL || udev->product == NULL) {
2345 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2346 if (kdp->vendor == vendor_id &&
2347 (kdp->product == product_id ||
2348 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2351 if (kdp->vendorname != NULL) {
2352 /* XXX should use pointer to knowndevs string */
2353 if (udev->manufacturer == NULL) {
2354 udev->manufacturer = strdup(kdp->vendorname,
2357 if (udev->product == NULL &&
2358 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2359 udev->product = strdup(kdp->productname,
2365 /* Provide default strings if none were found */
2366 if (udev->manufacturer == NULL) {
2367 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2368 udev->manufacturer = strdup(temp_ptr, M_USB);
2370 if (udev->product == NULL) {
2371 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2372 udev->product = strdup(temp_ptr, M_USB);
2376 usbd_ctrl_unlock(udev);
2384 usbd_get_mode(struct usb_device *udev)
2386 return (udev->flags.usb_mode);
2391 * See: USB_SPEED_XXX
2394 usbd_get_speed(struct usb_device *udev)
2396 return (udev->speed);
2400 usbd_get_isoc_fps(struct usb_device *udev)
2403 switch (udev->speed) {
2405 case USB_SPEED_FULL:
2412 struct usb_device_descriptor *
2413 usbd_get_device_descriptor(struct usb_device *udev)
2416 return (NULL); /* be NULL safe */
2417 return (&udev->ddesc);
2420 struct usb_config_descriptor *
2421 usbd_get_config_descriptor(struct usb_device *udev)
2424 return (NULL); /* be NULL safe */
2425 return (udev->cdesc);
2428 /*------------------------------------------------------------------------*
2429 * usb_test_quirk - test a device for a given quirk
2432 * 0: The USB device does not have the given quirk.
2433 * Else: The USB device has the given quirk.
2434 *------------------------------------------------------------------------*/
2436 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2441 if (quirk == UQ_NONE)
2444 /* search the automatic per device quirks first */
2446 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2447 if (uaa->device->autoQuirk[x] == quirk)
2451 /* search global quirk table, if any */
2453 found = (usb_test_quirk_p) (&uaa->info, quirk);
2458 struct usb_interface_descriptor *
2459 usbd_get_interface_descriptor(struct usb_interface *iface)
2462 return (NULL); /* be NULL safe */
2463 return (iface->idesc);
2467 usbd_get_interface_altindex(struct usb_interface *iface)
2469 return (iface->alt_index);
2473 usbd_get_bus_index(struct usb_device *udev)
2475 return ((uint8_t)device_get_unit(udev->bus->bdev));
2479 usbd_get_device_index(struct usb_device *udev)
2481 return (udev->device_index);
2485 /*------------------------------------------------------------------------*
2488 * This function will generate events for dev.
2489 *------------------------------------------------------------------------*/
2490 #ifndef BURN_BRIDGES
2492 usb_notify_addq_compat(const char *type, struct usb_device *udev)
2496 struct malloc_type *mt;
2497 const size_t buf_size = 512;
2499 /* Convert notify type */
2500 if (strcmp(type, "ATTACH") == 0)
2502 else if (strcmp(type, "DETACH") == 0)
2507 mtx_lock(&malloc_mtx);
2508 mt = malloc_desc2type("bus"); /* XXX M_BUS */
2509 mtx_unlock(&malloc_mtx);
2513 data = malloc(buf_size, mt, M_NOWAIT);
2517 /* String it all together. */
2518 snprintf(data, buf_size,
2527 "devsubclass=0x%02x "
2539 UGETW(udev->ddesc.idVendor),
2540 UGETW(udev->ddesc.idProduct),
2541 udev->ddesc.bDeviceClass,
2542 udev->ddesc.bDeviceSubClass,
2543 usb_get_serial(udev),
2544 UGETW(udev->ddesc.bcdDevice)
2546 , udev->parent_hub != NULL ?
2547 udev->parent_hub->ugen_name :
2548 device_get_nameunit(device_get_parent(udev->bus->bdev))
2552 devctl_queue_data(data);
2557 usb_notify_addq(const char *type, struct usb_device *udev)
2559 struct usb_interface *iface;
2563 #ifndef BURN_BRIDGES
2564 usb_notify_addq_compat(type, udev);
2567 /* announce the device */
2568 sb = sbuf_new_auto();
2577 "devsubclass=0x%02x "
2590 UGETW(udev->ddesc.idVendor),
2591 UGETW(udev->ddesc.idProduct),
2592 udev->ddesc.bDeviceClass,
2593 udev->ddesc.bDeviceSubClass,
2594 usb_get_serial(udev),
2595 UGETW(udev->ddesc.bcdDevice),
2596 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2599 , udev->parent_hub != NULL ?
2600 udev->parent_hub->ugen_name :
2601 device_get_nameunit(device_get_parent(udev->bus->bdev))
2605 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2608 /* announce each interface */
2609 for (i = 0; i < USB_IFACE_MAX; i++) {
2610 iface = usbd_get_iface(udev, i);
2612 break; /* end of interfaces */
2613 if (iface->idesc == NULL)
2614 continue; /* no interface descriptor */
2616 sb = sbuf_new_auto();
2625 "devsubclass=0x%02x "
2632 "intsubclass=0x%02x "
2633 "intprotocol=0x%02x",
2638 UGETW(udev->ddesc.idVendor),
2639 UGETW(udev->ddesc.idProduct),
2640 udev->ddesc.bDeviceClass,
2641 udev->ddesc.bDeviceSubClass,
2642 usb_get_serial(udev),
2643 UGETW(udev->ddesc.bcdDevice),
2644 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2645 iface->idesc->bInterfaceNumber,
2646 iface->idesc->bNumEndpoints,
2647 iface->idesc->bInterfaceClass,
2648 iface->idesc->bInterfaceSubClass,
2649 iface->idesc->bInterfaceProtocol);
2651 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2658 /*------------------------------------------------------------------------*
2659 * usb_fifo_free_wrap
2661 * This function will free the FIFOs.
2663 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2664 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2665 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2666 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2667 * control endpoint FIFOs. If "iface_index" is not set to
2668 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2669 *------------------------------------------------------------------------*/
2671 usb_fifo_free_wrap(struct usb_device *udev,
2672 uint8_t iface_index, uint8_t flag)
2678 * Free any USB FIFOs on the given interface:
2680 for (i = 0; i != USB_FIFO_MAX; i++) {
2685 /* Check if the interface index matches */
2686 if (iface_index == f->iface_index) {
2687 if (f->methods != &usb_ugen_methods) {
2689 * Don't free any non-generic FIFOs in
2694 if ((f->dev_ep_index == 0) &&
2695 (f->fs_xfer == NULL)) {
2696 /* no need to free this FIFO */
2699 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2700 if ((f->methods == &usb_ugen_methods) &&
2701 (f->dev_ep_index == 0) &&
2702 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2703 (f->fs_xfer == NULL)) {
2704 /* no need to free this FIFO */
2708 /* no need to free this FIFO */
2711 /* free this FIFO */
2717 /*------------------------------------------------------------------------*
2718 * usb_peer_can_wakeup
2721 * 0: Peer cannot do resume signalling.
2722 * Else: Peer can do resume signalling.
2723 *------------------------------------------------------------------------*/
2725 usb_peer_can_wakeup(struct usb_device *udev)
2727 const struct usb_config_descriptor *cdp;
2730 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2731 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2733 return (0); /* not supported */
2737 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2740 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2742 DPRINTF("udev %p state %s -> %s\n", udev,
2743 usb_statestr(udev->state), usb_statestr(state));
2746 mtx_lock(&usb_ref_lock);
2748 udev->state = state;
2750 mtx_unlock(&usb_ref_lock);
2752 if (udev->bus->methods->device_state_change != NULL)
2753 (udev->bus->methods->device_state_change) (udev);
2757 usb_get_device_state(struct usb_device *udev)
2760 return (USB_STATE_DETACHED);
2761 return (udev->state);
2765 usbd_device_attached(struct usb_device *udev)
2767 return (udev->state > USB_STATE_DETACHED);
2771 * The following function locks enumerating the given USB device. If
2772 * the lock is already grabbed this function returns zero. Else a
2773 * a value of one is returned.
2776 usbd_enum_lock(struct usb_device *udev)
2778 if (sx_xlocked(&udev->enum_sx))
2781 sx_xlock(&udev->enum_sx);
2782 sx_xlock(&udev->sr_sx);
2784 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2785 * are locked before locking Giant. Else the lock can be
2786 * locked multiple times.
2794 * This function is the same like usbd_enum_lock() except a value of
2795 * 255 is returned when a signal is pending:
2798 usbd_enum_lock_sig(struct usb_device *udev)
2800 if (sx_xlocked(&udev->enum_sx))
2802 if (sx_xlock_sig(&udev->enum_sx))
2804 if (sx_xlock_sig(&udev->sr_sx)) {
2805 sx_xunlock(&udev->enum_sx);
2813 /* The following function unlocks enumerating the given USB device. */
2816 usbd_enum_unlock(struct usb_device *udev)
2819 sx_xunlock(&udev->enum_sx);
2820 sx_xunlock(&udev->sr_sx);
2823 /* The following function locks suspend and resume. */
2826 usbd_sr_lock(struct usb_device *udev)
2828 sx_xlock(&udev->sr_sx);
2830 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2831 * are locked before locking Giant. Else the lock can be
2832 * locked multiple times.
2837 /* The following function unlocks suspend and resume. */
2840 usbd_sr_unlock(struct usb_device *udev)
2843 sx_xunlock(&udev->sr_sx);
2847 * The following function checks the enumerating lock for the given
2852 usbd_enum_is_locked(struct usb_device *udev)
2854 return (sx_xlocked(&udev->enum_sx));
2858 * The following function is used to serialize access to USB control
2859 * transfers and the USB scratch area. If the lock is already grabbed
2860 * this function returns zero. Else a value of one is returned.
2863 usbd_ctrl_lock(struct usb_device *udev)
2865 if (sx_xlocked(&udev->ctrl_sx))
2867 sx_xlock(&udev->ctrl_sx);
2870 * We need to allow suspend and resume at this point, else the
2871 * control transfer will timeout if the device is suspended!
2873 if (usbd_enum_is_locked(udev))
2874 usbd_sr_unlock(udev);
2879 usbd_ctrl_unlock(struct usb_device *udev)
2881 sx_xunlock(&udev->ctrl_sx);
2884 * Restore the suspend and resume lock after we have unlocked
2885 * the USB control transfer lock to avoid LOR:
2887 if (usbd_enum_is_locked(udev))
2892 * The following function is used to set the per-interface specific
2893 * plug and play information. The string referred to by the pnpinfo
2894 * argument can safely be freed after calling this function. The
2895 * pnpinfo of an interface will be reset at device detach or when
2896 * passing a NULL argument to this function. This function
2897 * returns zero on success, else a USB_ERR_XXX failure code.
2901 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2903 struct usb_interface *iface;
2905 iface = usbd_get_iface(udev, iface_index);
2907 return (USB_ERR_INVAL);
2909 if (iface->pnpinfo != NULL) {
2910 free(iface->pnpinfo, M_USBDEV);
2911 iface->pnpinfo = NULL;
2914 if (pnpinfo == NULL || pnpinfo[0] == 0)
2915 return (0); /* success */
2917 iface->pnpinfo = strdup(pnpinfo, M_USBDEV);
2918 if (iface->pnpinfo == NULL)
2919 return (USB_ERR_NOMEM);
2921 return (0); /* success */
2925 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2929 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2930 if (udev->autoQuirk[x] == 0 ||
2931 udev->autoQuirk[x] == quirk) {
2932 udev->autoQuirk[x] = quirk;
2933 return (0); /* success */
2936 return (USB_ERR_NOMEM);