1 /* $FreeBSD: head/sys/dev/usb/usb_device.c 269566 2014-08-05 06:38:21Z hselasky $ */
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/param.h>
29 #include <sys/queue.h>
30 #include <sys/types.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
34 #include <sys/module.h>
36 #include <sys/mutex.h>
37 #include <sys/condvar.h>
38 #include <sys/sysctl.h>
39 #include <sys/unistd.h>
40 #include <sys/callout.h>
41 #include <sys/malloc.h>
44 #include <sys/fcntl.h>
45 #include <sys/devfs.h>
47 #include <bus/u4b/usb.h>
48 #include <bus/u4b/usbdi.h>
49 #include <bus/u4b/usbdi_util.h>
50 #include <bus/u4b/usb_ioctl.h>
58 #define USB_DEBUG_VAR usb_debug
60 #include <bus/u4b/usb_core.h>
61 #include <bus/u4b/usb_debug.h>
62 #include <bus/u4b/usb_process.h>
63 #include <bus/u4b/usb_device.h>
64 #include <bus/u4b/usb_busdma.h>
65 #include <bus/u4b/usb_transfer.h>
66 #include <bus/u4b/usb_request.h>
67 #include <bus/u4b/usb_dynamic.h>
68 #include <bus/u4b/usb_hub.h>
69 #include <bus/u4b/usb_util.h>
70 #include <bus/u4b/usb_msctest.h>
72 #include <bus/u4b/usb_dev.h>
73 #include <bus/u4b/usb_generic.h>
76 #include <bus/u4b/quirk/usb_quirk.h>
78 #include <bus/u4b/usb_controller.h>
79 #include <bus/u4b/usb_bus.h>
81 /* function prototypes */
83 static void usb_init_endpoint(struct usb_device *, uint8_t,
84 struct usb_endpoint_descriptor *,
85 struct usb_endpoint_ss_comp_descriptor *,
86 struct usb_endpoint *);
87 static void usb_unconfigure(struct usb_device *, uint8_t);
88 static void usb_detach_device_sub(struct usb_device *, device_t *,
90 static uint8_t usb_probe_and_attach_sub(struct usb_device *,
91 struct usb_attach_arg *);
92 static void usb_init_attach_arg(struct usb_device *,
93 struct usb_attach_arg *);
94 static void usb_suspend_resume_sub(struct usb_device *, device_t,
96 static usb_proc_callback_t usbd_clear_stall_proc;
97 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
98 static void usbd_set_device_strings(struct usb_device *);
100 static void usb_notify_addq(const char *type, struct usb_device *);
103 static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
104 static void usb_cdev_create(struct usb_device *);
105 static void usb_cdev_free(struct usb_device *);
108 /* This variable is global to allow easy access to it: */
111 int usb_template = USB_TEMPLATE;
116 TUNABLE_INT("hw.usb.usb_template", &usb_template);
117 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW,
118 &usb_template, 0, "Selected USB device side template");
120 /* English is default language */
122 static int usb_lang_id = 0x0009;
123 static int usb_lang_mask = 0x00FF;
125 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
126 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW,
127 &usb_lang_id, 0, "Preferred USB language ID");
129 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
130 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW,
131 &usb_lang_mask, 0, "Preferred USB language mask");
133 static const char* statestr[USB_STATE_MAX] = {
134 [USB_STATE_DETACHED] = "DETACHED",
135 [USB_STATE_ATTACHED] = "ATTACHED",
136 [USB_STATE_POWERED] = "POWERED",
137 [USB_STATE_ADDRESSED] = "ADDRESSED",
138 [USB_STATE_CONFIGURED] = "CONFIGURED",
142 usb_statestr(enum usb_dev_state state)
144 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
148 usb_get_manufacturer(struct usb_device *udev)
150 return (udev->manufacturer ? udev->manufacturer : "Unknown");
154 usb_get_product(struct usb_device *udev)
156 return (udev->product ? udev->product : "");
160 usb_get_serial(struct usb_device *udev)
162 return (udev->serial ? udev->serial : "");
165 /*------------------------------------------------------------------------*
166 * usbd_get_ep_by_addr
168 * This function searches for an USB ep by endpoint address and
174 *------------------------------------------------------------------------*/
175 struct usb_endpoint *
176 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
178 struct usb_endpoint *ep = udev->endpoints;
179 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
181 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
185 * According to the USB specification not all bits are used
186 * for the endpoint address. Keep defined bits only:
191 * Iterate accross all the USB endpoints searching for a match
192 * based on the endpoint address:
194 for (; ep != ep_end; ep++) {
196 if (ep->edesc == NULL) {
199 /* do the mask and check the value */
200 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
206 * The default endpoint is always present and is checked separately:
208 if ((udev->ctrl_ep.edesc != NULL) &&
209 ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
219 /*------------------------------------------------------------------------*
222 * This function searches for an USB endpoint based on the information
223 * given by the passed "struct usb_config" pointer.
227 * Else: Pointer to "struct usb_endpoint".
228 *------------------------------------------------------------------------*/
229 struct usb_endpoint *
230 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
231 const struct usb_config *setup)
233 struct usb_endpoint *ep = udev->endpoints;
234 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
235 uint8_t index = setup->ep_index;
241 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
242 "type=0x%x dir=0x%x index=%d\n",
243 udev, iface_index, setup->endpoint,
244 setup->type, setup->direction, setup->ep_index);
248 if (setup->usb_mode != USB_MODE_DUAL &&
249 udev->flags.usb_mode != setup->usb_mode) {
250 /* wrong mode - no endpoint */
254 /* setup expected endpoint direction mask and value */
256 if (setup->direction == UE_DIR_RX) {
257 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
258 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
259 UE_DIR_OUT : UE_DIR_IN;
260 } else if (setup->direction == UE_DIR_TX) {
261 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
262 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
263 UE_DIR_IN : UE_DIR_OUT;
264 } else if (setup->direction == UE_DIR_ANY) {
265 /* match any endpoint direction */
269 /* match the given endpoint direction */
270 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
271 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
274 /* setup expected endpoint address */
276 if (setup->endpoint == UE_ADDR_ANY) {
277 /* match any endpoint address */
279 /* match the given endpoint address */
281 ea_val |= (setup->endpoint & UE_ADDR);
284 /* setup expected endpoint type */
286 if (setup->type == UE_BULK_INTR) {
287 /* this will match BULK and INTERRUPT endpoints */
290 } else if (setup->type == UE_TYPE_ANY) {
291 /* match any endpoint type */
295 /* match the given endpoint type */
296 type_mask = UE_XFERTYPE;
297 type_val = (setup->type & UE_XFERTYPE);
301 * Iterate accross all the USB endpoints searching for a match
302 * based on the endpoint address. Note that we are searching
303 * the endpoints from the beginning of the "udev->endpoints" array.
305 for (; ep != ep_end; ep++) {
307 if ((ep->edesc == NULL) ||
308 (ep->iface_index != iface_index)) {
311 /* do the masks and check the values */
313 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
314 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
322 * Match against default endpoint last, so that "any endpoint", "any
323 * address" and "any direction" returns the first endpoint of the
324 * interface. "iface_index" and "direction" is ignored:
326 if ((udev->ctrl_ep.edesc != NULL) &&
327 ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
328 ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
339 /*------------------------------------------------------------------------*
340 * usbd_interface_count
342 * This function stores the number of USB interfaces excluding
343 * alternate settings, which the USB config descriptor reports into
344 * the unsigned 8-bit integer pointed to by "count".
349 *------------------------------------------------------------------------*/
351 usbd_interface_count(struct usb_device *udev, uint8_t *count)
353 if (udev->cdesc == NULL) {
355 return (USB_ERR_NOT_CONFIGURED);
357 *count = udev->ifaces_max;
358 return (USB_ERR_NORMAL_COMPLETION);
361 /*------------------------------------------------------------------------*
364 * This function will initialise the USB endpoint structure pointed to by
365 * the "endpoint" argument. The structure pointed to by "endpoint" must be
366 * zeroed before calling this function.
367 *------------------------------------------------------------------------*/
369 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
370 struct usb_endpoint_descriptor *edesc,
371 struct usb_endpoint_ss_comp_descriptor *ecomp,
372 struct usb_endpoint *ep)
374 const struct usb_bus_methods *methods;
377 methods = udev->bus->methods;
379 (methods->endpoint_init) (udev, edesc, ep);
381 /* initialise USB endpoint structure */
384 ep->iface_index = iface_index;
386 /* setup USB stream queues */
387 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
388 TAILQ_INIT(&ep->endpoint_q[x].head);
389 ep->endpoint_q[x].command = &usbd_pipe_start;
392 /* the pipe is not supported by the hardware */
393 if (ep->methods == NULL)
396 /* check for SUPER-speed streams mode endpoint */
397 if (udev->speed == USB_SPEED_SUPER && ecomp != NULL &&
398 (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK &&
399 (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) {
400 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS);
402 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT);
405 /* clear stall, if any */
406 if (methods->clear_stall != NULL) {
407 USB_BUS_LOCK(udev->bus);
408 (methods->clear_stall) (udev, ep);
409 USB_BUS_UNLOCK(udev->bus);
413 /*-----------------------------------------------------------------------*
414 * usb_endpoint_foreach
416 * This function will iterate all the USB endpoints except the control
417 * endpoint. This function is NULL safe.
420 * NULL: End of USB endpoints
421 * Else: Pointer to next USB endpoint
422 *------------------------------------------------------------------------*/
423 struct usb_endpoint *
424 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
426 struct usb_endpoint *ep_end;
432 ep_end = udev->endpoints + udev->endpoints_max;
434 /* get next endpoint */
436 ep = udev->endpoints;
440 /* find next allocated ep */
441 while (ep != ep_end) {
442 if (ep->edesc != NULL)
449 /*------------------------------------------------------------------------*
450 * usb_wait_pending_refs
452 * This function will wait for any USB references to go away before
453 * returning. This function is used before freeing a USB device.
454 *------------------------------------------------------------------------*/
456 usb_wait_pending_refs(struct usb_device *udev)
459 DPRINTF("Refcount = %d\n", (int)udev->refcount);
461 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
464 /* wait for any pending references to go away */
465 if (udev->refcount == 0) {
466 /* prevent further refs being taken, if any */
467 udev->refcount = USB_DEV_REF_MAX;
470 cv_wait(&udev->ref_cv, &usb_ref_lock);
472 lockmgr(&usb_ref_lock, LK_RELEASE);
476 /*------------------------------------------------------------------------*
479 * This function will free all USB interfaces and USB endpoints belonging
482 * Flag values, see "USB_UNCFG_FLAG_XXX".
483 *------------------------------------------------------------------------*/
485 usb_unconfigure(struct usb_device *udev, uint8_t flag)
489 /* Prevent re-enumeration */
490 do_unlock = usbd_enum_lock(udev);
492 /* detach all interface drivers */
493 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
496 /* free all FIFOs except control endpoint FIFOs */
497 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
500 * Free all cdev's, if any.
505 #if USB_HAVE_COMPAT_LINUX
506 /* free Linux compat device, if any */
507 if (udev->linux_endpoint_start) {
508 usb_linux_free_device(udev);
509 udev->linux_endpoint_start = NULL;
513 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
515 /* free "cdesc" after "ifaces" and "endpoints", if any */
516 if (udev->cdesc != NULL) {
517 if (udev->flags.usb_mode != USB_MODE_DEVICE)
518 usbd_free_config_desc(udev, udev->cdesc);
521 /* set unconfigured state */
522 udev->curr_config_no = USB_UNCONFIG_NO;
523 udev->curr_config_index = USB_UNCONFIG_INDEX;
526 usbd_enum_unlock(udev);
529 /*------------------------------------------------------------------------*
530 * usbd_set_config_index
532 * This function selects configuration by index, independent of the
533 * actual configuration number. This function should not be used by
539 *------------------------------------------------------------------------*/
541 usbd_set_config_index(struct usb_device *udev, uint8_t index)
543 struct usb_status ds;
544 struct usb_config_descriptor *cdp;
551 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
553 /* Prevent re-enumeration */
554 do_unlock = usbd_enum_lock(udev);
556 usb_unconfigure(udev, 0);
558 if (index == USB_UNCONFIG_INDEX) {
560 * Leave unallocated when unconfiguring the
561 * device. "usb_unconfigure()" will also reset
562 * the current config number and index.
564 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
565 if (udev->state == USB_STATE_CONFIGURED)
566 usb_set_device_state(udev, USB_STATE_ADDRESSED);
569 /* get the full config descriptor */
570 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
571 /* save some memory */
572 err = usbd_req_get_descriptor_ptr(udev, &cdp,
573 (UDESC_CONFIG << 8) | index);
576 err = usbd_req_get_config_desc_full(udev,
582 /* set the new config descriptor */
586 /* Figure out if the device is self or bus powered. */
588 if ((!udev->flags.uq_bus_powered) &&
589 (cdp->bmAttributes & UC_SELF_POWERED) &&
590 (udev->flags.usb_mode == USB_MODE_HOST)) {
591 /* May be self powered. */
592 if (cdp->bmAttributes & UC_BUS_POWERED) {
593 /* Must ask device. */
594 err = usbd_req_get_device_status(udev, NULL, &ds);
596 DPRINTFN(0, "could not read "
597 "device status: %s\n",
599 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
602 DPRINTF("status=0x%04x \n",
607 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
608 "selfpowered=%d, power=%d\n",
610 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
611 selfpowered, cdp->bMaxPower * 2);
613 /* Check if we have enough power. */
614 power = cdp->bMaxPower * 2;
616 if (udev->parent_hub) {
617 max_power = udev->parent_hub->hub->portpower;
619 max_power = USB_MAX_POWER;
622 if (power > max_power) {
623 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
624 err = USB_ERR_NO_POWER;
627 /* Only update "self_powered" in USB Host Mode */
628 if (udev->flags.usb_mode == USB_MODE_HOST) {
629 udev->flags.self_powered = selfpowered;
632 udev->curr_config_no = cdp->bConfigurationValue;
633 udev->curr_config_index = index;
634 usb_set_device_state(udev, USB_STATE_CONFIGURED);
636 /* Set the actual configuration value. */
637 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
642 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
647 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
653 /* create device nodes for each endpoint */
654 usb_cdev_create(udev);
658 DPRINTF("error=%s\n", usbd_errstr(err));
660 usb_unconfigure(udev, 0);
663 usbd_enum_unlock(udev);
667 /*------------------------------------------------------------------------*
670 * This function will allocate and free USB interfaces and USB endpoints,
671 * parse the USB configuration structure and initialise the USB endpoints
672 * and interfaces. If "iface_index" is not equal to
673 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
674 * alternate_setting to be selected for the given interface. Else the
675 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
676 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
677 * is typically called when setting the configuration or when setting
678 * an alternate interface.
683 *------------------------------------------------------------------------*/
685 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
687 struct usb_idesc_parse_state ips;
688 struct usb_interface_descriptor *id;
689 struct usb_endpoint_descriptor *ed;
690 struct usb_interface *iface;
691 struct usb_endpoint *ep;
699 if (iface_index != USB_IFACE_INDEX_ANY) {
700 /* parameter overload */
710 DPRINTFN(5, "iface_index=%d cmd=%d\n",
713 if (cmd == USB_CFG_FREE)
716 if (cmd == USB_CFG_INIT) {
717 KKASSERT(lockowned(&udev->enum_lock));
719 /* check for in-use endpoints */
721 ep = udev->endpoints;
722 ep_max = udev->endpoints_max;
724 /* look for matching endpoints */
725 if ((iface_index == USB_IFACE_INDEX_ANY) ||
726 (iface_index == ep->iface_index)) {
727 if (ep->refcount_alloc != 0) {
729 * This typically indicates a
730 * more serious error.
732 err = USB_ERR_IN_USE;
735 memset(ep, 0, sizeof(*ep));
736 /* make sure we don't zero the endpoint again */
737 ep->iface_index = USB_IFACE_INDEX_ANY;
747 memset(&ips, 0, sizeof(ips));
752 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
754 iface = udev->ifaces + ips.iface_index;
756 /* check for specific interface match */
758 if (cmd == USB_CFG_INIT) {
759 if ((iface_index != USB_IFACE_INDEX_ANY) &&
760 (iface_index != ips.iface_index)) {
761 /* wrong interface */
763 } else if (alt_index != ips.iface_index_alt) {
764 /* wrong alternate setting */
767 /* initialise interface */
773 /* check for new interface */
774 if (ips.iface_index_alt == 0) {
775 /* update current number of endpoints */
780 /* setup the USB interface structure */
782 /* set alternate index */
783 iface->alt_index = alt_index;
784 /* set default interface parent */
785 if (iface_index == USB_IFACE_INDEX_ANY) {
786 iface->parent_iface_index =
791 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
793 ed = (struct usb_endpoint_descriptor *)id;
797 /* iterate all the endpoint descriptors */
798 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
800 /* check if endpoint limit has been reached */
801 if (temp >= USB_MAX_EP_UNITS) {
802 DPRINTF("Endpoint limit reached\n");
806 ep = udev->endpoints + temp;
811 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
813 DPRINTFN(5, "Found endpoint companion descriptor\n");
815 usb_init_endpoint(udev,
816 ips.iface_index, ed, ecomp, ep);
821 /* find maximum number of endpoints */
827 /* NOTE: It is valid to have no interfaces and no endpoints! */
829 if (cmd == USB_CFG_ALLOC) {
830 udev->ifaces_max = ips.iface_index;
831 #if (USB_HAVE_FIXED_IFACE == 0)
833 if (udev->ifaces_max != 0) {
834 udev->ifaces = kmalloc(sizeof(*iface) * udev->ifaces_max,
835 M_USB, M_WAITOK | M_ZERO);
836 if (udev->ifaces == NULL) {
842 #if (USB_HAVE_FIXED_ENDPOINT == 0)
844 udev->endpoints = kmalloc(sizeof(*ep) * ep_max,
845 M_USB, M_WAITOK | M_ZERO);
846 if (udev->endpoints == NULL) {
851 udev->endpoints = NULL;
854 USB_BUS_LOCK(udev->bus);
855 udev->endpoints_max = ep_max;
856 /* reset any ongoing clear-stall */
857 udev->ep_curr = NULL;
858 USB_BUS_UNLOCK(udev->bus);
860 #if (USB_HAVE_FIXED_IFACE == 0) || (USB_HAVE_FIXED_ENDPOINT == 0)
864 if (cmd == USB_CFG_ALLOC) {
866 USB_BUS_LOCK(udev->bus);
867 udev->endpoints_max = 0;
868 /* reset any ongoing clear-stall */
869 udev->ep_curr = NULL;
870 USB_BUS_UNLOCK(udev->bus);
872 #if (USB_HAVE_FIXED_IFACE == 0)
873 if(udev->ifaces != NULL) {
874 kfree(udev->ifaces, M_USB);
878 #if (USB_HAVE_FIXED_ENDPOINT == 0)
879 if(udev->endpoints != NULL) {
880 kfree(udev->endpoints, M_USB);
881 udev->endpoints = NULL;
884 udev->ifaces_max = 0;
890 /*------------------------------------------------------------------------*
891 * usbd_set_alt_interface_index
893 * This function will select an alternate interface index for the
894 * given interface index. The interface should not be in use when this
895 * function is called. That means there should not be any open USB
896 * transfers. Else an error is returned. If the alternate setting is
897 * already set this function will simply return success. This function
898 * is called in Host mode and Device mode!
903 *------------------------------------------------------------------------*/
905 usbd_set_alt_interface_index(struct usb_device *udev,
906 uint8_t iface_index, uint8_t alt_index)
908 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
912 /* Prevent re-enumeration */
913 do_unlock = usbd_enum_lock(udev);
919 if (iface->alt_index == alt_index) {
921 * Optimise away duplicate setting of
922 * alternate setting in USB Host Mode!
929 * Free all generic FIFOs for this interface, except control
932 usb_fifo_free_wrap(udev, iface_index, 0);
935 err = usb_config_parse(udev, iface_index, alt_index);
939 if (iface->alt_index != alt_index) {
940 /* the alternate setting does not exist */
945 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
946 iface->idesc->bAlternateSetting);
950 usbd_enum_unlock(udev);
954 /*------------------------------------------------------------------------*
955 * usbd_set_endpoint_stall
957 * This function is used to make a BULK or INTERRUPT endpoint send
958 * STALL tokens in USB device mode.
963 *------------------------------------------------------------------------*/
965 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
968 struct usb_xfer *xfer;
975 DPRINTF("Cannot find endpoint\n");
977 * Pretend that the clear or set stall request is
978 * successful else some USB host stacks can do
979 * strange things, especially when a control endpoint
984 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
986 if ((et != UE_BULK) &&
987 (et != UE_INTERRUPT)) {
989 * Should not stall control
990 * nor isochronous endpoints.
992 DPRINTF("Invalid endpoint\n");
995 USB_BUS_LOCK(udev->bus);
997 /* store current stall state */
998 was_stalled = ep->is_stalled;
1000 /* check for no change */
1001 if (was_stalled && do_stall) {
1002 /* if the endpoint is already stalled do nothing */
1003 USB_BUS_UNLOCK(udev->bus);
1004 DPRINTF("No change\n");
1007 /* set stalled state */
1010 if (do_stall || (!was_stalled)) {
1012 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1013 /* lookup the current USB transfer, if any */
1014 xfer = ep->endpoint_q[x].curr;
1017 * The "xfer_stall" method
1018 * will complete the USB
1019 * transfer like in case of a
1020 * timeout setting the error
1021 * code "USB_ERR_STALLED".
1023 (udev->bus->methods->xfer_stall) (xfer);
1027 (udev->bus->methods->set_stall) (udev, ep, &do_stall);
1030 ep->toggle_next = 0; /* reset data toggle */
1031 ep->is_stalled = 0; /* clear stalled state */
1033 (udev->bus->methods->clear_stall) (udev, ep);
1035 /* start the current or next transfer, if any */
1036 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1037 usb_command_wrapper(&ep->endpoint_q[x],
1038 ep->endpoint_q[x].curr);
1041 USB_BUS_UNLOCK(udev->bus);
1045 /*------------------------------------------------------------------------*
1046 * usb_reset_iface_endpoints - used in USB device side mode
1047 *------------------------------------------------------------------------*/
1049 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1051 struct usb_endpoint *ep;
1052 struct usb_endpoint *ep_end;
1054 ep = udev->endpoints;
1055 ep_end = udev->endpoints + udev->endpoints_max;
1057 for (; ep != ep_end; ep++) {
1059 if ((ep->edesc == NULL) ||
1060 (ep->iface_index != iface_index)) {
1063 /* simulate a clear stall from the peer */
1064 usbd_set_endpoint_stall(udev, ep, 0);
1069 /*------------------------------------------------------------------------*
1070 * usb_detach_device_sub
1072 * This function will try to detach an USB device. If it fails a panic
1075 * Flag values, see "USB_UNCFG_FLAG_XXX".
1076 *------------------------------------------------------------------------*/
1078 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1079 char **ppnpinfo, uint8_t flag)
1088 * NOTE: It is important to clear "*ppdev" before deleting
1089 * the child due to some device methods being called late
1090 * during the delete process !
1094 device_printf(dev, "at %s, port %d, addr %d "
1096 device_get_nameunit(udev->parent_dev),
1097 udev->port_no, udev->address);
1099 if (device_is_attached(dev)) {
1100 if (udev->flags.peer_suspended) {
1101 err = DEVICE_RESUME(dev);
1103 device_printf(dev, "Resume failed\n");
1106 if (device_detach(dev)) {
1110 if (device_delete_child(udev->parent_dev, dev)) {
1115 pnpinfo = *ppnpinfo;
1116 if (pnpinfo != NULL) {
1118 kfree(pnpinfo, M_USBDEV);
1123 /* Detach is not allowed to fail in the USB world */
1124 panic("usb_detach_device_sub: A USB driver would not detach\n");
1127 /*------------------------------------------------------------------------*
1130 * The following function will detach the matching interfaces.
1131 * This function is NULL safe.
1133 * Flag values, see "USB_UNCFG_FLAG_XXX".
1134 *------------------------------------------------------------------------*/
1136 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1139 struct usb_interface *iface;
1146 DPRINTFN(4, "udev=%p\n", udev);
1148 KKASSERT(lockowned(&udev->enum_lock));
1151 * First detach the child to give the child's detach routine a
1152 * chance to detach the sub-devices in the correct order.
1153 * Then delete the child using "device_delete_child()" which
1154 * will detach all sub-devices from the bottom and upwards!
1156 if (iface_index != USB_IFACE_INDEX_ANY) {
1158 iface_index = i + 1;
1161 iface_index = USB_IFACE_MAX;
1166 for (; i != iface_index; i++) {
1168 iface = usbd_get_iface(udev, i);
1169 if (iface == NULL) {
1170 /* looks like the end of the USB interfaces */
1173 usb_detach_device_sub(udev, &iface->subdev,
1174 &iface->pnpinfo, flag);
1178 /*------------------------------------------------------------------------*
1179 * usb_probe_and_attach_sub
1184 *------------------------------------------------------------------------*/
1186 usb_probe_and_attach_sub(struct usb_device *udev,
1187 struct usb_attach_arg *uaa)
1189 struct usb_interface *iface;
1194 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1195 /* leave interface alone */
1198 dev = iface->subdev;
1201 /* clean up after module unload */
1203 if (device_is_attached(dev)) {
1204 /* already a device there */
1207 /* clear "iface->subdev" as early as possible */
1209 iface->subdev = NULL;
1211 if (device_delete_child(udev->parent_dev, dev)) {
1214 * Panic here, else one can get a double call
1215 * to device_detach(). USB devices should
1216 * never fail on detach!
1218 panic("device_delete_child() failed\n");
1221 if (uaa->temp_dev == NULL) {
1223 /* create a new child */
1224 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1225 if (uaa->temp_dev == NULL) {
1226 device_printf(udev->parent_dev,
1227 "Device creation failed\n");
1228 return (1); /* failure */
1230 device_set_ivars(uaa->temp_dev, uaa);
1231 device_quiet(uaa->temp_dev);
1234 * Set "subdev" before probe and attach so that "devd" gets
1235 * the information it needs.
1237 iface->subdev = uaa->temp_dev;
1239 if (device_probe_and_attach(iface->subdev) == 0) {
1241 * The USB attach arguments are only available during probe
1244 uaa->temp_dev = NULL;
1245 device_set_ivars(iface->subdev, NULL);
1247 if (udev->flags.peer_suspended) {
1248 err = DEVICE_SUSPEND(iface->subdev);
1250 device_printf(iface->subdev, "Suspend failed\n");
1252 return (0); /* success */
1254 /* No USB driver found */
1255 iface->subdev = NULL;
1257 return (1); /* failure */
1260 /*------------------------------------------------------------------------*
1261 * usbd_set_parent_iface
1263 * Using this function will lock the alternate interface setting on an
1264 * interface. It is typically used for multi interface drivers. In USB
1265 * device side mode it is assumed that the alternate interfaces all
1266 * have the same endpoint descriptors. The default parent index value
1267 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1269 *------------------------------------------------------------------------*/
1271 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1272 uint8_t parent_index)
1274 struct usb_interface *iface;
1280 iface = usbd_get_iface(udev, iface_index);
1282 iface->parent_iface_index = parent_index;
1286 usb_init_attach_arg(struct usb_device *udev,
1287 struct usb_attach_arg *uaa)
1289 memset(uaa, 0, sizeof(*uaa));
1292 uaa->usb_mode = udev->flags.usb_mode;
1293 uaa->port = udev->port_no;
1294 uaa->dev_state = UAA_DEV_READY;
1296 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1297 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1298 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1299 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1300 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1301 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1302 uaa->info.bConfigIndex = udev->curr_config_index;
1303 uaa->info.bConfigNum = udev->curr_config_no;
1306 /*------------------------------------------------------------------------*
1307 * usb_probe_and_attach
1309 * This function is called from "uhub_explore_sub()",
1310 * "usb_handle_set_config()" and "usb_handle_request()".
1314 * Else: A control transfer failed
1315 *------------------------------------------------------------------------*/
1317 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1319 struct usb_attach_arg uaa;
1320 struct usb_interface *iface;
1326 DPRINTF("udev == NULL\n");
1327 return (USB_ERR_INVAL);
1329 /* Prevent re-enumeration */
1330 do_unlock = usbd_enum_lock(udev);
1332 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1333 /* do nothing - no configuration has been set */
1336 /* setup USB attach arguments */
1338 usb_init_attach_arg(udev, &uaa);
1341 * If the whole USB device is targeted, invoke the USB event
1344 if (iface_index == USB_IFACE_INDEX_ANY) {
1346 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1348 if (uaa.dev_state != UAA_DEV_READY) {
1349 /* leave device unconfigured */
1350 usb_unconfigure(udev, 0);
1355 /* Check if only one interface should be probed: */
1356 if (iface_index != USB_IFACE_INDEX_ANY) {
1364 /* Do the probe and attach */
1365 for (; i != j; i++) {
1367 iface = usbd_get_iface(udev, i);
1368 if (iface == NULL) {
1370 * Looks like the end of the USB
1373 DPRINTFN(2, "end of interfaces "
1377 if (iface->idesc == NULL) {
1378 /* no interface descriptor */
1383 uaa.info.bInterfaceClass =
1384 iface->idesc->bInterfaceClass;
1385 uaa.info.bInterfaceSubClass =
1386 iface->idesc->bInterfaceSubClass;
1387 uaa.info.bInterfaceProtocol =
1388 iface->idesc->bInterfaceProtocol;
1389 uaa.info.bIfaceIndex = i;
1390 uaa.info.bIfaceNum =
1391 iface->idesc->bInterfaceNumber;
1392 uaa.driver_info = 0; /* reset driver_info */
1394 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1395 uaa.info.bInterfaceClass,
1396 uaa.info.bInterfaceSubClass,
1397 uaa.info.bInterfaceProtocol,
1398 uaa.info.bIfaceIndex,
1399 uaa.info.bIfaceNum);
1401 usb_probe_and_attach_sub(udev, &uaa);
1404 * Remove the leftover child, if any, to enforce that
1405 * a new nomatch devd event is generated for the next
1406 * interface if no driver is found:
1408 if (uaa.temp_dev == NULL)
1410 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1411 DPRINTFN(0, "device delete child failed\n");
1412 uaa.temp_dev = NULL;
1416 usbd_enum_unlock(udev);
1420 /*------------------------------------------------------------------------*
1421 * usb_suspend_resume_sub
1423 * This function is called when the suspend or resume methods should
1424 * be executed on an USB device.
1425 *------------------------------------------------------------------------*/
1427 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1434 if (!device_is_attached(dev)) {
1438 err = DEVICE_SUSPEND(dev);
1440 err = DEVICE_RESUME(dev);
1443 device_printf(dev, "%s failed\n",
1444 do_suspend ? "Suspend" : "Resume");
1448 /*------------------------------------------------------------------------*
1449 * usb_suspend_resume
1451 * The following function will suspend or resume the USB device.
1456 *------------------------------------------------------------------------*/
1458 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1460 struct usb_interface *iface;
1467 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1469 KKASSERT(lockowned(&udev->sr_lock));
1471 USB_BUS_LOCK(udev->bus);
1472 /* filter the suspend events */
1473 if (udev->flags.peer_suspended == do_suspend) {
1474 USB_BUS_UNLOCK(udev->bus);
1478 udev->flags.peer_suspended = do_suspend;
1479 USB_BUS_UNLOCK(udev->bus);
1481 /* do the suspend or resume */
1483 for (i = 0; i != USB_IFACE_MAX; i++) {
1485 iface = usbd_get_iface(udev, i);
1486 if (iface == NULL) {
1487 /* looks like the end of the USB interfaces */
1490 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1495 /*------------------------------------------------------------------------*
1496 * usbd_clear_stall_proc
1498 * This function performs generic USB clear stall operations.
1499 *------------------------------------------------------------------------*/
1501 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1503 struct usb_udev_msg *pm = (void *)_pm;
1504 struct usb_device *udev = pm->udev;
1507 USB_BUS_UNLOCK(udev->bus);
1508 lockmgr(&udev->device_lock, LK_EXCLUSIVE);
1510 /* Start clear stall callback */
1511 usbd_transfer_start(udev->ctrl_xfer[1]);
1514 lockmgr(&udev->device_lock, LK_RELEASE);
1515 USB_BUS_LOCK(udev->bus);
1518 /*------------------------------------------------------------------------*
1521 * This function allocates a new USB device. This function is called
1522 * when a new device has been put in the powered state, but not yet in
1523 * the addressed state. Get initial descriptor, set the address, get
1524 * full descriptor and get strings.
1529 *------------------------------------------------------------------------*/
1531 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1532 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1533 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1535 struct usb_attach_arg uaa;
1536 struct usb_device *udev;
1537 struct usb_device *adev;
1538 struct usb_device *hub;
1539 uint8_t *scratch_ptr;
1541 uint8_t device_index;
1542 uint8_t config_index;
1543 uint8_t config_quirk;
1544 uint8_t set_config_failed;
1547 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1548 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1549 parent_dev, bus, parent_hub, depth, port_index, port_no,
1553 * Find an unused device index. In USB Host mode this is the
1554 * same as the device address.
1556 * Device index zero is not used and device index 1 should
1557 * always be the root hub.
1559 for (device_index = USB_ROOT_HUB_ADDR;
1560 (device_index != bus->devices_max) &&
1561 (bus->devices[device_index] != NULL);
1562 device_index++) /* nop */;
1564 if (device_index == bus->devices_max) {
1565 device_printf(bus->bdev,
1566 "No free USB device index for new device\n");
1571 device_printf(bus->bdev,
1572 "Invalid device depth\n");
1575 udev = kmalloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1580 /* Initialise SX-locks */
1581 lockinit(&udev->enum_lock, "USB config SX lock", 0, LK_CANRECURSE);
1582 /* XXX (mp) is this LK_CANRECURSE necessary? */
1583 lockinit(&udev->sr_lock, "USB suspend and resume SX lock", 0, LK_CANRECURSE);
1585 cv_init(&udev->ctrlreq_cv, "WCTRL");
1586 cv_init(&udev->ref_cv, "UGONE");
1588 /* initialise our mutex */
1589 lockinit(&udev->device_lock, "USB device mutex", 0, 0);
1591 /* initialise generic clear stall */
1592 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1593 udev->cs_msg[0].udev = udev;
1594 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1595 udev->cs_msg[1].udev = udev;
1597 /* initialise some USB device fields */
1598 udev->parent_hub = parent_hub;
1599 udev->parent_dev = parent_dev;
1600 udev->port_index = port_index;
1601 udev->port_no = port_no;
1602 udev->depth = depth;
1604 udev->address = USB_START_ADDR; /* default value */
1605 udev->plugtime = (usb_ticks_t)ticks;
1607 * We need to force the power mode to "on" because there are plenty
1608 * of USB devices out there that do not work very well with
1609 * automatic suspend and resume!
1611 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1612 udev->pwr_save.last_xfer_time = ticks;
1613 /* we are not ready yet */
1616 /* set up default endpoint descriptor */
1617 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1618 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1619 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1620 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1621 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1622 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1623 udev->ctrl_ep_desc.bInterval = 0;
1625 /* set up default endpoint companion descriptor */
1626 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1627 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1629 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1631 udev->speed = speed;
1632 udev->flags.usb_mode = mode;
1634 /* search for our High Speed USB HUB, if any */
1637 hub = udev->parent_hub;
1640 if (hub->speed == USB_SPEED_HIGH) {
1641 udev->hs_hub_addr = hub->address;
1642 udev->parent_hs_hub = hub;
1643 udev->hs_port_no = adev->port_no;
1647 hub = hub->parent_hub;
1650 /* init the default endpoint */
1651 usb_init_endpoint(udev, 0,
1652 &udev->ctrl_ep_desc,
1653 &udev->ctrl_ep_comp_desc,
1656 /* set device index */
1657 udev->device_index = device_index;
1660 /* Create ugen name */
1661 ksnprintf(udev->ugen_name, sizeof(udev->ugen_name),
1662 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1664 LIST_INIT(&udev->pd_list);
1666 /* Create the control endpoint device */
1667 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1668 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1670 /* Create a link from /dev/ugenX.X to the default endpoint */
1671 if (udev->ctrl_dev != NULL)
1672 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1674 /* Initialise device */
1675 if (bus->methods->device_init != NULL) {
1676 err = (bus->methods->device_init) (udev);
1678 DPRINTFN(0, "device init %d failed "
1679 "(%s, ignored)\n", device_index,
1684 /* set powered device state after device init is complete */
1685 usb_set_device_state(udev, USB_STATE_POWERED);
1687 if (udev->flags.usb_mode == USB_MODE_HOST) {
1689 err = usbd_req_set_address(udev, NULL, device_index);
1692 * This is the new USB device address from now on, if
1693 * the set address request didn't set it already.
1695 if (udev->address == USB_START_ADDR)
1696 udev->address = device_index;
1699 * We ignore any set-address errors, hence there are
1700 * buggy USB devices out there that actually receive
1701 * the SETUP PID, but manage to set the address before
1702 * the STATUS stage is ACK'ed. If the device responds
1703 * to the subsequent get-descriptor at the new
1704 * address, then we know that the set-address command
1708 DPRINTFN(0, "set address %d failed "
1709 "(%s, ignored)\n", udev->address,
1713 /* We are not self powered */
1714 udev->flags.self_powered = 0;
1716 /* Set unconfigured state */
1717 udev->curr_config_no = USB_UNCONFIG_NO;
1718 udev->curr_config_index = USB_UNCONFIG_INDEX;
1720 /* Setup USB descriptors */
1721 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1723 DPRINTFN(0, "setting up USB template failed maybe the USB "
1724 "template module has not been loaded\n");
1728 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1730 /* setup the device descriptor and the initial "wMaxPacketSize" */
1731 err = usbd_setup_device_desc(udev, NULL);
1734 /* try to enumerate two more times */
1735 err = usbd_req_re_enumerate(udev, NULL);
1737 err = usbd_req_re_enumerate(udev, NULL);
1745 * Setup temporary USB attach args so that we can figure out some
1746 * basic quirks for this device.
1748 usb_init_attach_arg(udev, &uaa);
1750 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1751 udev->flags.uq_bus_powered = 1;
1753 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1754 udev->flags.no_strings = 1;
1757 * Workaround for buggy USB devices.
1759 * It appears that some string-less USB chips will crash and
1760 * disappear if any attempts are made to read any string
1763 * Try to detect such chips by checking the strings in the USB
1764 * device descriptor. If no strings are present there we
1765 * simply disable all USB strings.
1768 /* Protect scratch area */
1769 do_unlock = usbd_enum_lock(udev);
1771 scratch_ptr = udev->scratch.data;
1773 if (udev->ddesc.iManufacturer ||
1774 udev->ddesc.iProduct ||
1775 udev->ddesc.iSerialNumber) {
1776 /* read out the language ID string */
1777 err = usbd_req_get_string_desc(udev, NULL,
1778 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1780 err = USB_ERR_INVAL;
1783 if (err || (scratch_ptr[0] < 4)) {
1784 udev->flags.no_strings = 1;
1791 /* load preferred value and mask */
1793 mask = usb_lang_mask;
1795 /* align length correctly */
1796 scratch_ptr[0] &= ~1U;
1798 /* fix compiler warning */
1801 /* search for preferred language */
1802 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1803 langid = UGETW(scratch_ptr + x);
1804 if ((langid & mask) == pref)
1807 if (x >= scratch_ptr[0]) {
1808 /* pick the first language as the default */
1809 DPRINTFN(1, "Using first language\n");
1810 langid = UGETW(scratch_ptr + 2);
1813 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1814 udev->langid = langid;
1818 usbd_enum_unlock(udev);
1820 /* assume 100mA bus powered for now. Changed when configured. */
1821 udev->power = USB_MIN_POWER;
1822 /* fetch the vendor and product strings from the device */
1823 usbd_set_device_strings(udev);
1825 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1826 /* USB device mode setup is complete */
1832 * Most USB devices should attach to config index 0 by
1835 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1838 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1841 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1844 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1847 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1855 set_config_failed = 0;
1858 DPRINTF("setting config %u\n", config_index);
1860 /* get the USB device configured */
1861 err = usbd_set_config_index(udev, config_index);
1863 if (udev->ddesc.bNumConfigurations != 0) {
1864 if (!set_config_failed) {
1865 set_config_failed = 1;
1866 /* XXX try to re-enumerate the device */
1867 err = usbd_req_re_enumerate(udev, NULL);
1869 goto repeat_set_config;
1871 DPRINTFN(0, "Failure selecting configuration index %u:"
1872 "%s, port %u, addr %u (ignored)\n",
1873 config_index, usbd_errstr(err), udev->port_no,
1877 * Some USB devices do not have any configurations. Ignore any
1878 * set config failures!
1883 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1884 if ((udev->cdesc->bNumInterface < 2) &&
1885 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1886 DPRINTFN(0, "Found no endpoints, trying next config\n");
1888 goto repeat_set_config;
1890 #if USB_HAVE_MSCTEST
1891 if (config_index == 0) {
1893 * Try to figure out if we have an
1894 * auto-install disk there:
1896 if (usb_iface_is_cdrom(udev, 0)) {
1897 DPRINTFN(0, "Found possible auto-install "
1898 "disk (trying next config)\n");
1900 goto repeat_set_config;
1905 #if USB_HAVE_MSCTEST
1906 if (set_config_failed == 0 && config_index == 0 &&
1907 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1908 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1911 * Try to figure out if there are any MSC quirks we
1912 * should apply automatically:
1914 err = usb_msc_auto_quirk(udev, 0);
1917 set_config_failed = 1;
1918 goto repeat_set_config;
1924 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1925 udev->address, udev, udev->parent_hub);
1927 /* register our device - we are ready */
1928 usb_bus_port_set_device(bus, parent_hub ?
1929 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1932 /* Symlink the ugen device name */
1933 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1935 /* Announce device */
1936 kprintf("%s: <%s> at %s\n", udev->ugen_name,
1937 usb_get_manufacturer(udev),
1938 device_get_nameunit(udev->bus->bdev));
1942 usb_notify_addq("ATTACH", udev);
1947 * Free USB device and all subdevices, if any.
1949 usb_free_device(udev, 0);
1956 struct usb_fs_privdata *
1957 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1958 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1960 struct usb_fs_privdata* pd;
1963 /* Store information to locate ourselves again later */
1964 pd = kmalloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1966 pd->bus_index = device_get_unit(udev->bus->bdev);
1967 pd->dev_index = udev->device_index;
1969 pd->fifo_index = fi;
1972 /* Now, create the device itself */
1973 if (devname == NULL) {
1975 ksnprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1976 pd->bus_index, pd->dev_index, pd->ep_addr);
1979 pd->cdev = make_dev(&usb_ops, 0, uid, gid, mode, "%s", devname);
1981 if (pd->cdev == NULL) {
1982 DPRINTFN(0, "Failed to create device %s\n", devname);
1983 kfree(pd, M_USBDEV);
1987 /* XXX setting si_drv1 and creating the device is not atomic! */
1988 pd->cdev->si_drv1 = pd;
1994 usb_destroy_dev_sync(struct usb_fs_privdata *pd)
1996 DPRINTFN(1, "Destroying device at ugen%d.%d\n",
1997 pd->bus_index, pd->dev_index);
2000 * Destroy character device synchronously. After this
2001 * all system calls are returned. Can block.
2003 destroy_dev(pd->cdev);
2005 kfree(pd, M_USBDEV);
2009 usb_destroy_dev(struct usb_fs_privdata *pd)
2011 struct usb_bus *bus;
2016 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
2017 bus = devclass_get_softc(usb_devclass_ptr, pd->bus_index);
2018 lockmgr(&usb_ref_lock, LK_RELEASE);
2021 usb_destroy_dev_sync(pd);
2026 /* XXX what is FreeBSD doing here? */
2027 /* make sure we can re-use the device name */
2028 delist_dev(pd->cdev);
2032 LIST_INSERT_HEAD(&bus->pd_cleanup_list, pd, pd_next);
2033 /* get cleanup going */
2034 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
2035 &bus->cleanup_msg[0], &bus->cleanup_msg[1]);
2036 USB_BUS_UNLOCK(bus);
2040 usb_cdev_create(struct usb_device *udev)
2042 struct usb_config_descriptor *cd;
2043 struct usb_endpoint_descriptor *ed;
2044 struct usb_descriptor *desc;
2045 struct usb_fs_privdata* pd;
2046 int inmode, outmode, inmask, outmask, mode;
2049 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2051 DPRINTFN(2, "Creating device nodes\n");
2053 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2056 } else { /* USB_MODE_HOST */
2066 * Collect all used endpoint numbers instead of just
2067 * generating 16 static endpoints.
2069 cd = usbd_get_config_descriptor(udev);
2070 while ((desc = usb_desc_foreach(cd, desc))) {
2071 /* filter out all endpoint descriptors */
2072 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2073 (desc->bLength >= sizeof(*ed))) {
2074 ed = (struct usb_endpoint_descriptor *)desc;
2077 ep = ed->bEndpointAddress;
2078 if (UE_GET_DIR(ep) == UE_DIR_OUT)
2079 outmask |= 1 << UE_GET_ADDR(ep);
2081 inmask |= 1 << UE_GET_ADDR(ep);
2085 /* Create all available endpoints except EP0 */
2086 for (ep = 1; ep < 16; ep++) {
2087 mode = (inmask & (1 << ep)) ? inmode : 0;
2088 mode |= (outmask & (1 << ep)) ? outmode : 0;
2090 continue; /* no IN or OUT endpoint */
2092 pd = usb_make_dev(udev, NULL, ep, 0,
2093 mode, UID_ROOT, GID_OPERATOR, 0600);
2096 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2101 usb_cdev_free(struct usb_device *udev)
2103 struct usb_fs_privdata* pd;
2105 DPRINTFN(2, "Freeing device nodes\n");
2107 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2108 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2110 LIST_REMOVE(pd, pd_next);
2112 usb_destroy_dev(pd);
2117 /*------------------------------------------------------------------------*
2120 * This function is NULL safe and will free an USB device and its
2121 * children devices, if any.
2123 * Flag values: Reserved, set to zero.
2124 *------------------------------------------------------------------------*/
2126 usb_free_device(struct usb_device *udev, uint8_t flag)
2128 struct usb_bus *bus;
2131 return; /* already freed */
2133 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2137 /* set DETACHED state to prevent any further references */
2138 usb_set_device_state(udev, USB_STATE_DETACHED);
2141 usb_notify_addq("DETACH", udev);
2145 kprintf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2146 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2148 /* Destroy UGEN symlink, if any */
2149 if (udev->ugen_symlink) {
2150 usb_free_symlink(udev->ugen_symlink);
2151 udev->ugen_symlink = NULL;
2154 usb_destroy_dev(udev->ctrl_dev);
2157 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2158 /* stop receiving any control transfers (Device Side Mode) */
2159 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2162 /* the following will get the device unconfigured in software */
2163 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2165 /* final device unregister after all character devices are closed */
2166 usb_bus_port_set_device(bus, udev->parent_hub ?
2167 udev->parent_hub->hub->ports + udev->port_index : NULL,
2168 NULL, USB_ROOT_HUB_ADDR);
2170 /* unsetup any leftover default USB transfers */
2171 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2173 /* template unsetup, if any */
2174 (usb_temp_unsetup_p) (udev);
2177 * Make sure that our clear-stall messages are not queued
2180 USB_BUS_LOCK(udev->bus);
2181 usb_proc_mwait(USB_BUS_NON_GIANT_PROC(udev->bus),
2182 &udev->cs_msg[0], &udev->cs_msg[1]);
2183 USB_BUS_UNLOCK(udev->bus);
2185 /* wait for all references to go away */
2186 usb_wait_pending_refs(udev);
2188 lockuninit(&udev->enum_lock);
2189 lockuninit(&udev->sr_lock);
2191 cv_destroy(&udev->ctrlreq_cv);
2192 cv_destroy(&udev->ref_cv);
2194 lockuninit(&udev->device_lock);
2196 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2199 /* Uninitialise device */
2200 if (bus->methods->device_uninit != NULL)
2201 (bus->methods->device_uninit) (udev);
2205 kfree(udev->serial, M_USB);
2206 if(udev->manufacturer)
2207 kfree(udev->manufacturer, M_USB);
2209 kfree(udev->product, M_USB);
2213 /*------------------------------------------------------------------------*
2216 * This function is the safe way to get the USB interface structure
2217 * pointer by interface index.
2220 * NULL: Interface not present.
2221 * Else: Pointer to USB interface structure.
2222 *------------------------------------------------------------------------*/
2223 struct usb_interface *
2224 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2226 struct usb_interface *iface = udev->ifaces + iface_index;
2228 if (iface_index >= udev->ifaces_max)
2233 /*------------------------------------------------------------------------*
2234 * usbd_find_descriptor
2236 * This function will lookup the first descriptor that matches the
2237 * criteria given by the arguments "type" and "subtype". Descriptors
2238 * will only be searched within the interface having the index
2239 * "iface_index". If the "id" argument points to an USB descriptor,
2240 * it will be skipped before the search is started. This allows
2241 * searching for multiple descriptors using the same criteria. Else
2242 * the search is started after the interface descriptor.
2245 * NULL: End of descriptors
2246 * Else: A descriptor matching the criteria
2247 *------------------------------------------------------------------------*/
2249 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2250 uint8_t type, uint8_t type_mask,
2251 uint8_t subtype, uint8_t subtype_mask)
2253 struct usb_descriptor *desc;
2254 struct usb_config_descriptor *cd;
2255 struct usb_interface *iface;
2257 cd = usbd_get_config_descriptor(udev);
2262 iface = usbd_get_iface(udev, iface_index);
2263 if (iface == NULL) {
2266 id = usbd_get_interface_descriptor(iface);
2273 while ((desc = usb_desc_foreach(cd, desc))) {
2275 if (desc->bDescriptorType == UDESC_INTERFACE) {
2278 if (((desc->bDescriptorType & type_mask) == type) &&
2279 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2286 /*------------------------------------------------------------------------*
2289 * This function will dump information from the device descriptor
2290 * belonging to the USB device pointed to by "udev", to the string
2291 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2292 * including the terminating zero.
2293 *------------------------------------------------------------------------*/
2295 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2297 struct usb_device_descriptor *udd = &udev->ddesc;
2301 bcdUSB = UGETW(udd->bcdUSB);
2302 bcdDevice = UGETW(udd->bcdDevice);
2304 if (udd->bDeviceClass != 0xFF) {
2305 ksnprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2307 usb_get_manufacturer(udev),
2308 usb_get_product(udev),
2309 udd->bDeviceClass, udd->bDeviceSubClass,
2310 (bcdUSB >> 8), bcdUSB & 0xFF,
2311 (bcdDevice >> 8), bcdDevice & 0xFF,
2314 ksnprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2316 usb_get_manufacturer(udev),
2317 usb_get_product(udev),
2318 (bcdUSB >> 8), bcdUSB & 0xFF,
2319 (bcdDevice >> 8), bcdDevice & 0xFF,
2326 * Descriptions of of known vendors and devices ("products").
2328 struct usb_knowndev {
2332 const char *vendorname;
2333 const char *productname;
2336 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2338 #include "usbdevs.h"
2339 #include "usbdevs_data.h"
2340 #endif /* USB_VERBOSE */
2343 usbd_set_device_strings(struct usb_device *udev)
2345 struct usb_device_descriptor *udd = &udev->ddesc;
2347 const struct usb_knowndev *kdp;
2352 uint16_t product_id;
2355 /* Protect scratch area */
2356 do_unlock = usbd_enum_lock(udev);
2358 temp_ptr = (char *)udev->scratch.data;
2359 temp_size = sizeof(udev->scratch.data);
2361 vendor_id = UGETW(udd->idVendor);
2362 product_id = UGETW(udd->idProduct);
2364 /* get serial number string */
2365 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2366 udev->ddesc.iSerialNumber);
2367 udev->serial = kstrdup(temp_ptr, M_USB);
2369 /* get manufacturer string */
2370 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2371 udev->ddesc.iManufacturer);
2372 usb_trim_spaces(temp_ptr);
2373 if (temp_ptr[0] != '\0')
2374 udev->manufacturer = kstrdup(temp_ptr, M_USB);
2376 /* get product string */
2377 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2378 udev->ddesc.iProduct);
2379 usb_trim_spaces(temp_ptr);
2380 if (temp_ptr[0] != '\0')
2381 udev->product = kstrdup(temp_ptr, M_USB);
2384 if (udev->manufacturer == NULL || udev->product == NULL) {
2385 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2386 if (kdp->vendor == vendor_id &&
2387 (kdp->product == product_id ||
2388 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2391 if (kdp->vendorname != NULL) {
2392 /* XXX should use pointer to knowndevs string */
2393 if (udev->manufacturer == NULL) {
2394 udev->manufacturer = kstrdup(kdp->vendorname,
2397 if (udev->product == NULL &&
2398 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2399 udev->product = kstrdup(kdp->productname,
2405 /* Provide default strings if none were found */
2406 if (udev->manufacturer == NULL) {
2407 ksnprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2408 udev->manufacturer = kstrdup(temp_ptr, M_USB);
2410 if (udev->product == NULL) {
2411 ksnprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2412 udev->product = kstrdup(temp_ptr, M_USB);
2416 usbd_enum_unlock(udev);
2424 usbd_get_mode(struct usb_device *udev)
2426 return (udev->flags.usb_mode);
2431 * See: USB_SPEED_XXX
2434 usbd_get_speed(struct usb_device *udev)
2436 return (udev->speed);
2440 usbd_get_isoc_fps(struct usb_device *udev)
2443 switch (udev->speed) {
2445 case USB_SPEED_FULL:
2452 struct usb_device_descriptor *
2453 usbd_get_device_descriptor(struct usb_device *udev)
2456 return (NULL); /* be NULL safe */
2457 return (&udev->ddesc);
2460 struct usb_config_descriptor *
2461 usbd_get_config_descriptor(struct usb_device *udev)
2464 return (NULL); /* be NULL safe */
2465 return (udev->cdesc);
2468 /*------------------------------------------------------------------------*
2469 * usb_test_quirk - test a device for a given quirk
2472 * 0: The USB device does not have the given quirk.
2473 * Else: The USB device has the given quirk.
2474 *------------------------------------------------------------------------*/
2476 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2481 if (quirk == UQ_NONE)
2484 /* search the automatic per device quirks first */
2486 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2487 if (uaa->device->autoQuirk[x] == quirk)
2491 /* search global quirk table, if any */
2493 found = (usb_test_quirk_p) (&uaa->info, quirk);
2498 struct usb_interface_descriptor *
2499 usbd_get_interface_descriptor(struct usb_interface *iface)
2502 return (NULL); /* be NULL safe */
2503 return (iface->idesc);
2507 usbd_get_interface_altindex(struct usb_interface *iface)
2509 return (iface->alt_index);
2513 usbd_get_bus_index(struct usb_device *udev)
2515 return ((uint8_t)device_get_unit(udev->bus->bdev));
2519 usbd_get_device_index(struct usb_device *udev)
2521 return (udev->device_index);
2526 usb_notify_addq(const char *type, struct usb_device *udev)
2528 struct usb_interface *iface;
2532 /* announce the device */
2533 sb = sbuf_new(NULL, NULL, 4096, SBUF_AUTOEXTEND);
2542 "devsubclass=0x%02x "
2555 UGETW(udev->ddesc.idVendor),
2556 UGETW(udev->ddesc.idProduct),
2557 udev->ddesc.bDeviceClass,
2558 udev->ddesc.bDeviceSubClass,
2559 usb_get_serial(udev),
2560 UGETW(udev->ddesc.bcdDevice),
2561 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2564 , udev->parent_hub != NULL ?
2565 udev->parent_hub->ugen_name :
2566 device_get_nameunit(device_get_parent(udev->bus->bdev))
2570 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2573 /* announce each interface */
2574 for (i = 0; i < USB_IFACE_MAX; i++) {
2575 iface = usbd_get_iface(udev, i);
2577 break; /* end of interfaces */
2578 if (iface->idesc == NULL)
2579 continue; /* no interface descriptor */
2582 sb = sbuf_new(NULL, NULL, 4096, SBUF_AUTOEXTEND);
2591 "devsubclass=0x%02x "
2598 "intsubclass=0x%02x "
2599 "intprotocol=0x%02x",
2604 UGETW(udev->ddesc.idVendor),
2605 UGETW(udev->ddesc.idProduct),
2606 udev->ddesc.bDeviceClass,
2607 udev->ddesc.bDeviceSubClass,
2608 usb_get_serial(udev),
2609 UGETW(udev->ddesc.bcdDevice),
2610 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2611 iface->idesc->bInterfaceNumber,
2612 iface->idesc->bNumEndpoints,
2613 iface->idesc->bInterfaceClass,
2614 iface->idesc->bInterfaceSubClass,
2615 iface->idesc->bInterfaceProtocol);
2617 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2624 /*------------------------------------------------------------------------*
2625 * usb_fifo_free_wrap
2627 * This function will free the FIFOs.
2629 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2630 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2631 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2632 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2633 * control endpoint FIFOs. If "iface_index" is not set to
2634 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2635 *------------------------------------------------------------------------*/
2637 usb_fifo_free_wrap(struct usb_device *udev,
2638 uint8_t iface_index, uint8_t flag)
2644 * Free any USB FIFOs on the given interface:
2646 for (i = 0; i != USB_FIFO_MAX; i++) {
2651 /* Check if the interface index matches */
2652 if (iface_index == f->iface_index) {
2653 if (f->methods != &usb_ugen_methods) {
2655 * Don't free any non-generic FIFOs in
2660 if ((f->dev_ep_index == 0) &&
2661 (f->fs_xfer == NULL)) {
2662 /* no need to free this FIFO */
2665 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2666 if ((f->methods == &usb_ugen_methods) &&
2667 (f->dev_ep_index == 0) &&
2668 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2669 (f->fs_xfer == NULL)) {
2670 /* no need to free this FIFO */
2674 /* no need to free this FIFO */
2677 /* free this FIFO */
2683 /*------------------------------------------------------------------------*
2684 * usb_peer_can_wakeup
2687 * 0: Peer cannot do resume signalling.
2688 * Else: Peer can do resume signalling.
2689 *------------------------------------------------------------------------*/
2691 usb_peer_can_wakeup(struct usb_device *udev)
2693 const struct usb_config_descriptor *cdp;
2696 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2697 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2699 return (0); /* not supported */
2703 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2706 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2708 DPRINTF("udev %p state %s -> %s\n", udev,
2709 usb_statestr(udev->state), usb_statestr(state));
2712 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
2714 udev->state = state;
2716 lockmgr(&usb_ref_lock, LK_RELEASE);
2718 if (udev->bus->methods->device_state_change != NULL)
2719 (udev->bus->methods->device_state_change) (udev);
2723 usb_get_device_state(struct usb_device *udev)
2726 return (USB_STATE_DETACHED);
2727 return (udev->state);
2731 usbd_device_attached(struct usb_device *udev)
2733 return (udev->state > USB_STATE_DETACHED);
2737 * The following function locks enumerating the given USB device. If
2738 * the lock is already grabbed this function returns zero. Else a
2739 * non-zero value is returned.
2742 usbd_enum_lock(struct usb_device *udev)
2744 if (lockstatus(&udev->enum_lock, curthread)==LK_EXCLUSIVE)
2747 lockmgr(&udev->enum_lock, LK_EXCLUSIVE);
2748 lockmgr(&udev->sr_lock, LK_EXCLUSIVE);
2750 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2751 * are locked before locking Giant. Else the lock can be
2752 * locked multiple times.
2757 /* The following function unlocks enumerating the given USB device. */
2760 usbd_enum_unlock(struct usb_device *udev)
2762 lockmgr(&udev->enum_lock, LK_RELEASE);
2763 lockmgr(&udev->sr_lock, LK_RELEASE);
2766 /* The following function locks suspend and resume. */
2769 usbd_sr_lock(struct usb_device *udev)
2771 lockmgr(&udev->sr_lock, LK_EXCLUSIVE);
2773 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2774 * are locked before locking Giant. Else the lock can be
2775 * locked multiple times.
2779 /* The following function unlocks suspend and resume. */
2782 usbd_sr_unlock(struct usb_device *udev)
2784 lockmgr(&udev->sr_lock, LK_RELEASE);
2788 * The following function checks the enumerating lock for the given
2793 usbd_enum_is_locked(struct usb_device *udev)
2795 /* XXX: Make sure that we return a correct value here */
2796 return (lockowned(&udev->enum_lock));
2800 * The following function is used to set the per-interface specific
2801 * plug and play information. The string referred to by the pnpinfo
2802 * argument can safely be freed after calling this function. The
2803 * pnpinfo of an interface will be reset at device detach or when
2804 * passing a NULL argument to this function. This function
2805 * returns zero on success, else a USB_ERR_XXX failure code.
2809 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2811 struct usb_interface *iface;
2813 iface = usbd_get_iface(udev, iface_index);
2815 return (USB_ERR_INVAL);
2817 if (iface->pnpinfo != NULL) {
2818 kfree(iface->pnpinfo, M_USBDEV);
2819 iface->pnpinfo = NULL;
2822 if (pnpinfo == NULL || pnpinfo[0] == 0)
2823 return (0); /* success */
2825 iface->pnpinfo = kstrdup(pnpinfo, M_USBDEV);
2826 if (iface->pnpinfo == NULL)
2827 return (USB_ERR_NOMEM);
2829 return (0); /* success */
2833 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2837 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2838 if (udev->autoQuirk[x] == 0 ||
2839 udev->autoQuirk[x] == quirk) {
2840 udev->autoQuirk[x] = quirk;
2841 return (0); /* success */
2844 return (USB_ERR_NOMEM);
2848 * The following function is used to select the endpoint mode. It
2849 * should not be called outside enumeration context.
2853 usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep,
2859 /* Prevent re-enumeration */
2860 do_unlock = usbd_enum_lock(udev);
2862 if (udev->bus->methods->set_endpoint_mode != NULL) {
2863 error = (udev->bus->methods->set_endpoint_mode) (
2865 } else if (ep_mode != USB_EP_MODE_DEFAULT) {
2866 error = USB_ERR_INVAL;
2871 /* only set new mode regardless of error */
2872 ep->ep_mode = ep_mode;
2875 usbd_enum_unlock(udev);
2880 usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep)
2882 return (ep->ep_mode);