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 void usbd_clear_stall_proc(struct usb_proc_msg *_pm);
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 /*------------------------------------------------------------------------*
436 * This function will free all USB interfaces and USB endpoints belonging
439 * Flag values, see "USB_UNCFG_FLAG_XXX".
440 *------------------------------------------------------------------------*/
442 usb_unconfigure(struct usb_device *udev, uint8_t flag)
446 /* automatic locking */
447 if (usbd_enum_is_locked(udev)) {
451 usbd_enum_lock(udev);
454 /* detach all interface drivers */
455 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
458 /* free all FIFOs except control endpoint FIFOs */
459 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
462 * Free all cdev's, if any.
467 #if USB_HAVE_COMPAT_LINUX
468 /* free Linux compat device, if any */
469 if (udev->linux_endpoint_start) {
470 usb_linux_free_device(udev);
471 udev->linux_endpoint_start = NULL;
475 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
477 /* free "cdesc" after "ifaces" and "endpoints", if any */
478 if (udev->cdesc != NULL) {
479 if (udev->flags.usb_mode != USB_MODE_DEVICE)
480 free(udev->cdesc, M_USB);
483 /* set unconfigured state */
484 udev->curr_config_no = USB_UNCONFIG_NO;
485 udev->curr_config_index = USB_UNCONFIG_INDEX;
488 usbd_enum_unlock(udev);
491 /*------------------------------------------------------------------------*
492 * usbd_set_config_index
494 * This function selects configuration by index, independent of the
495 * actual configuration number. This function should not be used by
501 *------------------------------------------------------------------------*/
503 usbd_set_config_index(struct usb_device *udev, uint8_t index)
505 struct usb_status ds;
506 struct usb_config_descriptor *cdp;
513 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
515 /* automatic locking */
516 if (usbd_enum_is_locked(udev)) {
520 usbd_enum_lock(udev);
523 usb_unconfigure(udev, 0);
525 if (index == USB_UNCONFIG_INDEX) {
527 * Leave unallocated when unconfiguring the
528 * device. "usb_unconfigure()" will also reset
529 * the current config number and index.
531 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
532 if (udev->state == USB_STATE_CONFIGURED)
533 usb_set_device_state(udev, USB_STATE_ADDRESSED);
536 /* get the full config descriptor */
537 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
538 /* save some memory */
539 err = usbd_req_get_descriptor_ptr(udev, &cdp,
540 (UDESC_CONFIG << 8) | index);
543 err = usbd_req_get_config_desc_full(udev,
544 NULL, &cdp, M_USB, index);
549 /* set the new config descriptor */
553 /* Figure out if the device is self or bus powered. */
555 if ((!udev->flags.uq_bus_powered) &&
556 (cdp->bmAttributes & UC_SELF_POWERED) &&
557 (udev->flags.usb_mode == USB_MODE_HOST)) {
558 /* May be self powered. */
559 if (cdp->bmAttributes & UC_BUS_POWERED) {
560 /* Must ask device. */
561 err = usbd_req_get_device_status(udev, NULL, &ds);
563 DPRINTFN(0, "could not read "
564 "device status: %s\n",
566 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
569 DPRINTF("status=0x%04x \n",
574 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
575 "selfpowered=%d, power=%d\n",
577 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
578 selfpowered, cdp->bMaxPower * 2);
580 /* Check if we have enough power. */
581 power = cdp->bMaxPower * 2;
583 if (udev->parent_hub) {
584 max_power = udev->parent_hub->hub->portpower;
586 max_power = USB_MAX_POWER;
589 if (power > max_power) {
590 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
591 err = USB_ERR_NO_POWER;
594 /* Only update "self_powered" in USB Host Mode */
595 if (udev->flags.usb_mode == USB_MODE_HOST) {
596 udev->flags.self_powered = selfpowered;
599 udev->curr_config_no = cdp->bConfigurationValue;
600 udev->curr_config_index = index;
601 usb_set_device_state(udev, USB_STATE_CONFIGURED);
603 /* Set the actual configuration value. */
604 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
609 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
614 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
620 /* create device nodes for each endpoint */
621 usb_cdev_create(udev);
625 DPRINTF("error=%s\n", usbd_errstr(err));
627 usb_unconfigure(udev, 0);
630 usbd_enum_unlock(udev);
634 /*------------------------------------------------------------------------*
637 * This function will allocate and free USB interfaces and USB endpoints,
638 * parse the USB configuration structure and initialise the USB endpoints
639 * and interfaces. If "iface_index" is not equal to
640 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
641 * alternate_setting to be selected for the given interface. Else the
642 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
643 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
644 * is typically called when setting the configuration or when setting
645 * an alternate interface.
650 *------------------------------------------------------------------------*/
652 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
654 struct usb_idesc_parse_state ips;
655 struct usb_interface_descriptor *id;
656 struct usb_endpoint_descriptor *ed;
657 struct usb_interface *iface;
658 struct usb_endpoint *ep;
666 if (iface_index != USB_IFACE_INDEX_ANY) {
667 /* parameter overload */
677 DPRINTFN(5, "iface_index=%d cmd=%d\n",
680 if (cmd == USB_CFG_FREE)
683 if (cmd == USB_CFG_INIT) {
684 sx_assert(&udev->enum_sx, SA_LOCKED);
686 /* check for in-use endpoints */
688 ep = udev->endpoints;
689 ep_max = udev->endpoints_max;
691 /* look for matching endpoints */
692 if ((iface_index == USB_IFACE_INDEX_ANY) ||
693 (iface_index == ep->iface_index)) {
694 if (ep->refcount_alloc != 0) {
696 * This typically indicates a
697 * more serious error.
699 err = USB_ERR_IN_USE;
702 memset(ep, 0, sizeof(*ep));
703 /* make sure we don't zero the endpoint again */
704 ep->iface_index = USB_IFACE_INDEX_ANY;
714 memset(&ips, 0, sizeof(ips));
719 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
721 /* check for interface overflow */
722 if (ips.iface_index == USB_IFACE_MAX)
725 iface = udev->ifaces + ips.iface_index;
727 /* check for specific interface match */
729 if (cmd == USB_CFG_INIT) {
730 if ((iface_index != USB_IFACE_INDEX_ANY) &&
731 (iface_index != ips.iface_index)) {
732 /* wrong interface */
734 } else if (alt_index != ips.iface_index_alt) {
735 /* wrong alternate setting */
738 /* initialise interface */
744 /* check for new interface */
745 if (ips.iface_index_alt == 0) {
746 /* update current number of endpoints */
751 /* setup the USB interface structure */
753 /* set alternate index */
754 iface->alt_index = alt_index;
755 /* set default interface parent */
756 if (iface_index == USB_IFACE_INDEX_ANY) {
757 iface->parent_iface_index =
762 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
764 ed = (struct usb_endpoint_descriptor *)id;
768 /* iterate all the endpoint descriptors */
769 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
771 if (temp == USB_EP_MAX)
774 ep = udev->endpoints + temp;
779 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
781 DPRINTFN(5, "Found endpoint companion descriptor\n");
783 usb_init_endpoint(udev,
784 ips.iface_index, ed, ecomp, ep);
789 /* find maximum number of endpoints */
794 id = (struct usb_interface_descriptor *)ed;
798 /* NOTE: It is valid to have no interfaces and no endpoints! */
800 if (cmd == USB_CFG_ALLOC) {
801 udev->ifaces_max = ips.iface_index;
803 if (udev->ifaces_max != 0) {
804 udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max,
805 M_USB, M_WAITOK | M_ZERO);
806 if (udev->ifaces == NULL) {
812 udev->endpoints = malloc(sizeof(*ep) * ep_max,
813 M_USB, M_WAITOK | M_ZERO);
814 if (udev->endpoints == NULL) {
819 udev->endpoints = NULL;
821 USB_BUS_LOCK(udev->bus);
822 udev->endpoints_max = ep_max;
823 /* reset any ongoing clear-stall */
824 udev->ep_curr = NULL;
825 USB_BUS_UNLOCK(udev->bus);
830 if (cmd == USB_CFG_ALLOC) {
832 USB_BUS_LOCK(udev->bus);
833 udev->endpoints_max = 0;
834 /* reset any ongoing clear-stall */
835 udev->ep_curr = NULL;
836 USB_BUS_UNLOCK(udev->bus);
839 if (udev->ifaces != NULL)
840 free(udev->ifaces, M_USB);
841 if (udev->endpoints != NULL)
842 free(udev->endpoints, M_USB);
845 udev->endpoints = NULL;
846 udev->ifaces_max = 0;
852 /*------------------------------------------------------------------------*
853 * usbd_set_alt_interface_index
855 * This function will select an alternate interface index for the
856 * given interface index. The interface should not be in use when this
857 * function is called. That means there should not be any open USB
858 * transfers. Else an error is returned. If the alternate setting is
859 * already set this function will simply return success. This function
860 * is called in Host mode and Device mode!
865 *------------------------------------------------------------------------*/
867 usbd_set_alt_interface_index(struct usb_device *udev,
868 uint8_t iface_index, uint8_t alt_index)
870 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
874 /* automatic locking */
875 if (usbd_enum_is_locked(udev)) {
879 usbd_enum_lock(udev);
885 if (iface->alt_index == alt_index) {
887 * Optimise away duplicate setting of
888 * alternate setting in USB Host Mode!
895 * Free all generic FIFOs for this interface, except control
898 usb_fifo_free_wrap(udev, iface_index, 0);
901 err = usb_config_parse(udev, iface_index, alt_index);
905 if (iface->alt_index != alt_index) {
906 /* the alternate setting does not exist */
911 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
912 iface->idesc->bAlternateSetting);
916 usbd_enum_unlock(udev);
921 /*------------------------------------------------------------------------*
922 * usbd_set_endpoint_stall
924 * This function is used to make a BULK or INTERRUPT endpoint send
925 * STALL tokens in USB device mode.
930 *------------------------------------------------------------------------*/
932 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
935 struct usb_xfer *xfer;
941 DPRINTF("Cannot find endpoint\n");
943 * Pretend that the clear or set stall request is
944 * successful else some USB host stacks can do
945 * strange things, especially when a control endpoint
950 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
952 if ((et != UE_BULK) &&
953 (et != UE_INTERRUPT)) {
955 * Should not stall control
956 * nor isochronous endpoints.
958 DPRINTF("Invalid endpoint\n");
961 USB_BUS_LOCK(udev->bus);
963 /* store current stall state */
964 was_stalled = ep->is_stalled;
966 /* check for no change */
967 if (was_stalled && do_stall) {
968 /* if the endpoint is already stalled do nothing */
969 USB_BUS_UNLOCK(udev->bus);
970 DPRINTF("No change\n");
973 /* set stalled state */
976 if (do_stall || (!was_stalled)) {
978 /* lookup the current USB transfer, if any */
979 xfer = ep->endpoint_q.curr;
985 * If "xfer" is non-NULL the "set_stall" method will
986 * complete the USB transfer like in case of a timeout
987 * setting the error code "USB_ERR_STALLED".
989 (udev->bus->methods->set_stall) (udev, xfer, ep, &do_stall);
992 ep->toggle_next = 0; /* reset data toggle */
993 ep->is_stalled = 0; /* clear stalled state */
995 (udev->bus->methods->clear_stall) (udev, ep);
997 /* start up the current or next transfer, if any */
998 usb_command_wrapper(&ep->endpoint_q, ep->endpoint_q.curr);
1000 USB_BUS_UNLOCK(udev->bus);
1004 /*------------------------------------------------------------------------*
1005 * usb_reset_iface_endpoints - used in USB device side mode
1006 *------------------------------------------------------------------------*/
1008 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1010 struct usb_endpoint *ep;
1011 struct usb_endpoint *ep_end;
1013 ep = udev->endpoints;
1014 ep_end = udev->endpoints + udev->endpoints_max;
1016 for (; ep != ep_end; ep++) {
1018 if ((ep->edesc == NULL) ||
1019 (ep->iface_index != iface_index)) {
1022 /* simulate a clear stall from the peer */
1023 usbd_set_endpoint_stall(udev, ep, 0);
1028 /*------------------------------------------------------------------------*
1029 * usb_detach_device_sub
1031 * This function will try to detach an USB device. If it fails a panic
1034 * Flag values, see "USB_UNCFG_FLAG_XXX".
1035 *------------------------------------------------------------------------*/
1037 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1038 char **ppnpinfo, uint8_t flag)
1047 * NOTE: It is important to clear "*ppdev" before deleting
1048 * the child due to some device methods being called late
1049 * during the delete process !
1053 device_printf(dev, "at %s, port %d, addr %d "
1055 device_get_nameunit(udev->parent_dev),
1056 udev->port_no, udev->address);
1058 if (device_is_attached(dev)) {
1059 if (udev->flags.peer_suspended) {
1060 err = DEVICE_RESUME(dev);
1062 device_printf(dev, "Resume failed\n");
1065 if (device_detach(dev)) {
1069 if (device_delete_child(udev->parent_dev, dev)) {
1074 pnpinfo = *ppnpinfo;
1075 if (pnpinfo != NULL) {
1077 free(pnpinfo, M_USBDEV);
1082 /* Detach is not allowed to fail in the USB world */
1083 panic("usb_detach_device_sub: A USB driver would not detach\n");
1086 /*------------------------------------------------------------------------*
1089 * The following function will detach the matching interfaces.
1090 * This function is NULL safe.
1092 * Flag values, see "USB_UNCFG_FLAG_XXX".
1093 *------------------------------------------------------------------------*/
1095 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1098 struct usb_interface *iface;
1105 DPRINTFN(4, "udev=%p\n", udev);
1107 sx_assert(&udev->enum_sx, SA_LOCKED);
1110 * First detach the child to give the child's detach routine a
1111 * chance to detach the sub-devices in the correct order.
1112 * Then delete the child using "device_delete_child()" which
1113 * will detach all sub-devices from the bottom and upwards!
1115 if (iface_index != USB_IFACE_INDEX_ANY) {
1117 iface_index = i + 1;
1120 iface_index = USB_IFACE_MAX;
1125 for (; i != iface_index; i++) {
1127 iface = usbd_get_iface(udev, i);
1128 if (iface == NULL) {
1129 /* looks like the end of the USB interfaces */
1132 usb_detach_device_sub(udev, &iface->subdev,
1133 &iface->pnpinfo, flag);
1137 /*------------------------------------------------------------------------*
1138 * usb_probe_and_attach_sub
1143 *------------------------------------------------------------------------*/
1145 usb_probe_and_attach_sub(struct usb_device *udev,
1146 struct usb_attach_arg *uaa)
1148 struct usb_interface *iface;
1153 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1154 /* leave interface alone */
1157 dev = iface->subdev;
1160 /* clean up after module unload */
1162 if (device_is_attached(dev)) {
1163 /* already a device there */
1166 /* clear "iface->subdev" as early as possible */
1168 iface->subdev = NULL;
1170 if (device_delete_child(udev->parent_dev, dev)) {
1173 * Panic here, else one can get a double call
1174 * to device_detach(). USB devices should
1175 * never fail on detach!
1177 panic("device_delete_child() failed\n");
1180 if (uaa->temp_dev == NULL) {
1182 /* create a new child */
1183 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1184 if (uaa->temp_dev == NULL) {
1185 device_printf(udev->parent_dev,
1186 "Device creation failed\n");
1187 return (1); /* failure */
1189 device_set_ivars(uaa->temp_dev, uaa);
1190 device_quiet(uaa->temp_dev);
1193 * Set "subdev" before probe and attach so that "devd" gets
1194 * the information it needs.
1196 iface->subdev = uaa->temp_dev;
1198 if (device_probe_and_attach(iface->subdev) == 0) {
1200 * The USB attach arguments are only available during probe
1203 uaa->temp_dev = NULL;
1204 device_set_ivars(iface->subdev, NULL);
1206 if (udev->flags.peer_suspended) {
1207 err = DEVICE_SUSPEND(iface->subdev);
1209 device_printf(iface->subdev, "Suspend failed\n");
1211 return (0); /* success */
1213 /* No USB driver found */
1214 iface->subdev = NULL;
1216 return (1); /* failure */
1219 /*------------------------------------------------------------------------*
1220 * usbd_set_parent_iface
1222 * Using this function will lock the alternate interface setting on an
1223 * interface. It is typically used for multi interface drivers. In USB
1224 * device side mode it is assumed that the alternate interfaces all
1225 * have the same endpoint descriptors. The default parent index value
1226 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1228 *------------------------------------------------------------------------*/
1230 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1231 uint8_t parent_index)
1233 struct usb_interface *iface;
1239 iface = usbd_get_iface(udev, iface_index);
1241 iface->parent_iface_index = parent_index;
1245 usb_init_attach_arg(struct usb_device *udev,
1246 struct usb_attach_arg *uaa)
1248 memset(uaa, 0, sizeof(*uaa));
1251 uaa->usb_mode = udev->flags.usb_mode;
1252 uaa->port = udev->port_no;
1253 uaa->dev_state = UAA_DEV_READY;
1255 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1256 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1257 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1258 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1259 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1260 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1261 uaa->info.bConfigIndex = udev->curr_config_index;
1262 uaa->info.bConfigNum = udev->curr_config_no;
1265 /*------------------------------------------------------------------------*
1266 * usb_probe_and_attach
1268 * This function is called from "uhub_explore_sub()",
1269 * "usb_handle_set_config()" and "usb_handle_request()".
1273 * Else: A control transfer failed
1274 *------------------------------------------------------------------------*/
1276 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1278 struct usb_attach_arg uaa;
1279 struct usb_interface *iface;
1285 DPRINTF("udev == NULL\n");
1286 return (USB_ERR_INVAL);
1288 /* automatic locking */
1289 if (usbd_enum_is_locked(udev)) {
1293 usbd_enum_lock(udev);
1296 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1297 /* do nothing - no configuration has been set */
1300 /* setup USB attach arguments */
1302 usb_init_attach_arg(udev, &uaa);
1305 * If the whole USB device is targeted, invoke the USB event
1308 if (iface_index == USB_IFACE_INDEX_ANY) {
1310 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1312 if (uaa.dev_state != UAA_DEV_READY) {
1313 /* leave device unconfigured */
1314 usb_unconfigure(udev, 0);
1319 /* Check if only one interface should be probed: */
1320 if (iface_index != USB_IFACE_INDEX_ANY) {
1328 /* Do the probe and attach */
1329 for (; i != j; i++) {
1331 iface = usbd_get_iface(udev, i);
1332 if (iface == NULL) {
1334 * Looks like the end of the USB
1337 DPRINTFN(2, "end of interfaces "
1341 if (iface->idesc == NULL) {
1342 /* no interface descriptor */
1347 uaa.info.bInterfaceClass =
1348 iface->idesc->bInterfaceClass;
1349 uaa.info.bInterfaceSubClass =
1350 iface->idesc->bInterfaceSubClass;
1351 uaa.info.bInterfaceProtocol =
1352 iface->idesc->bInterfaceProtocol;
1353 uaa.info.bIfaceIndex = i;
1354 uaa.info.bIfaceNum =
1355 iface->idesc->bInterfaceNumber;
1356 uaa.driver_info = 0; /* reset driver_info */
1358 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1359 uaa.info.bInterfaceClass,
1360 uaa.info.bInterfaceSubClass,
1361 uaa.info.bInterfaceProtocol,
1362 uaa.info.bIfaceIndex,
1363 uaa.info.bIfaceNum);
1365 usb_probe_and_attach_sub(udev, &uaa);
1368 * Remove the leftover child, if any, to enforce that
1369 * a new nomatch devd event is generated for the next
1370 * interface if no driver is found:
1372 if (uaa.temp_dev == NULL)
1374 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1375 DPRINTFN(0, "device delete child failed\n");
1376 uaa.temp_dev = NULL;
1380 usbd_enum_unlock(udev);
1385 /*------------------------------------------------------------------------*
1386 * usb_suspend_resume_sub
1388 * This function is called when the suspend or resume methods should
1389 * be executed on an USB device.
1390 *------------------------------------------------------------------------*/
1392 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1399 if (!device_is_attached(dev)) {
1403 err = DEVICE_SUSPEND(dev);
1405 err = DEVICE_RESUME(dev);
1408 device_printf(dev, "%s failed\n",
1409 do_suspend ? "Suspend" : "Resume");
1413 /*------------------------------------------------------------------------*
1414 * usb_suspend_resume
1416 * The following function will suspend or resume the USB device.
1421 *------------------------------------------------------------------------*/
1423 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1425 struct usb_interface *iface;
1432 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1434 sx_assert(&udev->sr_sx, SA_LOCKED);
1436 USB_BUS_LOCK(udev->bus);
1437 /* filter the suspend events */
1438 if (udev->flags.peer_suspended == do_suspend) {
1439 USB_BUS_UNLOCK(udev->bus);
1443 udev->flags.peer_suspended = do_suspend;
1444 USB_BUS_UNLOCK(udev->bus);
1446 /* do the suspend or resume */
1448 for (i = 0; i != USB_IFACE_MAX; i++) {
1450 iface = usbd_get_iface(udev, i);
1451 if (iface == NULL) {
1452 /* looks like the end of the USB interfaces */
1455 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1460 /*------------------------------------------------------------------------*
1461 * usbd_clear_stall_proc
1463 * This function performs generic USB clear stall operations.
1464 *------------------------------------------------------------------------*/
1466 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1468 struct usb_clear_stall_msg *pm = (void *)_pm;
1469 struct usb_device *udev = pm->udev;
1472 USB_BUS_UNLOCK(udev->bus);
1473 mtx_lock(&udev->device_mtx);
1475 /* Start clear stall callback */
1476 usbd_transfer_start(udev->ctrl_xfer[1]);
1479 mtx_unlock(&udev->device_mtx);
1480 USB_BUS_LOCK(udev->bus);
1483 /*------------------------------------------------------------------------*
1486 * This function allocates a new USB device. This function is called
1487 * when a new device has been put in the powered state, but not yet in
1488 * the addressed state. Get initial descriptor, set the address, get
1489 * full descriptor and get strings.
1494 *------------------------------------------------------------------------*/
1496 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1497 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1498 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1500 struct usb_attach_arg uaa;
1501 struct usb_device *udev;
1502 struct usb_device *adev;
1503 struct usb_device *hub;
1504 uint8_t *scratch_ptr;
1506 uint8_t device_index;
1507 uint8_t config_index;
1508 uint8_t config_quirk;
1509 uint8_t set_config_failed;
1511 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1512 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1513 parent_dev, bus, parent_hub, depth, port_index, port_no,
1517 * Find an unused device index. In USB Host mode this is the
1518 * same as the device address.
1520 * Device index zero is not used and device index 1 should
1521 * always be the root hub.
1523 for (device_index = USB_ROOT_HUB_ADDR;
1524 (device_index != bus->devices_max) &&
1525 (bus->devices[device_index] != NULL);
1526 device_index++) /* nop */;
1528 if (device_index == bus->devices_max) {
1529 device_printf(bus->bdev,
1530 "No free USB device index for new device\n");
1535 device_printf(bus->bdev,
1536 "Invalid device depth\n");
1539 udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1543 /* initialise our SX-lock */
1544 sx_init_flags(&udev->ctrl_sx, "USB device SX lock", SX_DUPOK);
1546 /* initialise our SX-lock */
1547 sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1548 sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS);
1550 cv_init(&udev->ctrlreq_cv, "WCTRL");
1551 cv_init(&udev->ref_cv, "UGONE");
1553 /* initialise our mutex */
1554 mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF);
1556 /* initialise generic clear stall */
1557 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1558 udev->cs_msg[0].udev = udev;
1559 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1560 udev->cs_msg[1].udev = udev;
1562 /* initialise some USB device fields */
1563 udev->parent_hub = parent_hub;
1564 udev->parent_dev = parent_dev;
1565 udev->port_index = port_index;
1566 udev->port_no = port_no;
1567 udev->depth = depth;
1569 udev->address = USB_START_ADDR; /* default value */
1570 udev->plugtime = (usb_ticks_t)ticks;
1572 * We need to force the power mode to "on" because there are plenty
1573 * of USB devices out there that do not work very well with
1574 * automatic suspend and resume!
1576 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1577 udev->pwr_save.last_xfer_time = ticks;
1578 /* we are not ready yet */
1581 /* set up default endpoint descriptor */
1582 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1583 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1584 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1585 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1586 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1587 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1588 udev->ctrl_ep_desc.bInterval = 0;
1590 /* set up default endpoint companion descriptor */
1591 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1592 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1594 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1596 udev->speed = speed;
1597 udev->flags.usb_mode = mode;
1599 /* search for our High Speed USB HUB, if any */
1602 hub = udev->parent_hub;
1605 if (hub->speed == USB_SPEED_HIGH) {
1606 udev->hs_hub_addr = hub->address;
1607 udev->parent_hs_hub = hub;
1608 udev->hs_port_no = adev->port_no;
1612 hub = hub->parent_hub;
1615 /* init the default endpoint */
1616 usb_init_endpoint(udev, 0,
1617 &udev->ctrl_ep_desc,
1618 &udev->ctrl_ep_comp_desc,
1621 /* set device index */
1622 udev->device_index = device_index;
1625 /* Create ugen name */
1626 snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1627 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1629 LIST_INIT(&udev->pd_list);
1631 /* Create the control endpoint device */
1632 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1633 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1635 /* Create a link from /dev/ugenX.X to the default endpoint */
1636 if (udev->ctrl_dev != NULL)
1637 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1639 /* Initialise device */
1640 if (bus->methods->device_init != NULL) {
1641 err = (bus->methods->device_init) (udev);
1643 DPRINTFN(0, "device init %d failed "
1644 "(%s, ignored)\n", device_index,
1649 /* set powered device state after device init is complete */
1650 usb_set_device_state(udev, USB_STATE_POWERED);
1652 if (udev->flags.usb_mode == USB_MODE_HOST) {
1654 err = usbd_req_set_address(udev, NULL, device_index);
1657 * This is the new USB device address from now on, if
1658 * the set address request didn't set it already.
1660 if (udev->address == USB_START_ADDR)
1661 udev->address = device_index;
1664 * We ignore any set-address errors, hence there are
1665 * buggy USB devices out there that actually receive
1666 * the SETUP PID, but manage to set the address before
1667 * the STATUS stage is ACK'ed. If the device responds
1668 * to the subsequent get-descriptor at the new
1669 * address, then we know that the set-address command
1673 DPRINTFN(0, "set address %d failed "
1674 "(%s, ignored)\n", udev->address,
1678 /* We are not self powered */
1679 udev->flags.self_powered = 0;
1681 /* Set unconfigured state */
1682 udev->curr_config_no = USB_UNCONFIG_NO;
1683 udev->curr_config_index = USB_UNCONFIG_INDEX;
1685 /* Setup USB descriptors */
1686 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1688 DPRINTFN(0, "setting up USB template failed maybe the USB "
1689 "template module has not been loaded\n");
1693 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1695 /* setup the device descriptor and the initial "wMaxPacketSize" */
1696 err = usbd_setup_device_desc(udev, NULL);
1699 /* XXX try to re-enumerate the device */
1700 err = usbd_req_re_enumerate(udev, NULL);
1706 * Setup temporary USB attach args so that we can figure out some
1707 * basic quirks for this device.
1709 usb_init_attach_arg(udev, &uaa);
1711 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1712 udev->flags.uq_bus_powered = 1;
1714 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1715 udev->flags.no_strings = 1;
1718 * Workaround for buggy USB devices.
1720 * It appears that some string-less USB chips will crash and
1721 * disappear if any attempts are made to read any string
1724 * Try to detect such chips by checking the strings in the USB
1725 * device descriptor. If no strings are present there we
1726 * simply disable all USB strings.
1728 scratch_ptr = udev->bus->scratch[0].data;
1730 if (udev->ddesc.iManufacturer ||
1731 udev->ddesc.iProduct ||
1732 udev->ddesc.iSerialNumber) {
1733 /* read out the language ID string */
1734 err = usbd_req_get_string_desc(udev, NULL,
1735 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1737 err = USB_ERR_INVAL;
1740 if (err || (scratch_ptr[0] < 4)) {
1741 udev->flags.no_strings = 1;
1748 /* load preferred value and mask */
1750 mask = usb_lang_mask;
1752 /* align length correctly */
1753 scratch_ptr[0] &= ~1;
1755 /* fix compiler warning */
1758 /* search for preferred language */
1759 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1760 langid = UGETW(scratch_ptr + x);
1761 if ((langid & mask) == pref)
1764 if (x >= scratch_ptr[0]) {
1765 /* pick the first language as the default */
1766 DPRINTFN(1, "Using first language\n");
1767 langid = UGETW(scratch_ptr + 2);
1770 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1771 udev->langid = langid;
1774 /* assume 100mA bus powered for now. Changed when configured. */
1775 udev->power = USB_MIN_POWER;
1776 /* fetch the vendor and product strings from the device */
1777 usbd_set_device_strings(udev);
1779 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1780 /* USB device mode setup is complete */
1786 * Most USB devices should attach to config index 0 by
1789 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1792 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1795 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1798 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1801 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1809 set_config_failed = 0;
1812 DPRINTF("setting config %u\n", config_index);
1814 /* get the USB device configured */
1815 err = usbd_set_config_index(udev, config_index);
1817 if (udev->ddesc.bNumConfigurations != 0) {
1818 if (!set_config_failed) {
1819 set_config_failed = 1;
1820 /* XXX try to re-enumerate the device */
1821 err = usbd_req_re_enumerate(udev, NULL);
1823 goto repeat_set_config;
1825 DPRINTFN(0, "Failure selecting configuration index %u:"
1826 "%s, port %u, addr %u (ignored)\n",
1827 config_index, usbd_errstr(err), udev->port_no,
1831 * Some USB devices do not have any configurations. Ignore any
1832 * set config failures!
1837 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1838 if ((udev->cdesc->bNumInterface < 2) &&
1839 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1840 DPRINTFN(0, "Found no endpoints, trying next config\n");
1842 goto repeat_set_config;
1844 if (config_index == 0) {
1846 * Try to figure out if we have an
1847 * auto-install disk there:
1849 if (usb_iface_is_cdrom(udev, 0)) {
1850 DPRINTFN(0, "Found possible auto-install "
1851 "disk (trying next config)\n");
1853 goto repeat_set_config;
1857 if (set_config_failed == 0 && config_index == 0 &&
1858 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1859 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1862 * Try to figure out if there are any MSC quirks we
1863 * should apply automatically:
1865 err = usb_msc_auto_quirk(udev, 0);
1868 set_config_failed = 1;
1869 goto repeat_set_config;
1874 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1875 udev->address, udev, udev->parent_hub);
1877 /* register our device - we are ready */
1878 usb_bus_port_set_device(bus, parent_hub ?
1879 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1882 /* Symlink the ugen device name */
1883 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1885 /* Announce device */
1886 printf("%s: <%s> at %s\n", udev->ugen_name,
1887 usb_get_manufacturer(udev),
1888 device_get_nameunit(udev->bus->bdev));
1892 usb_notify_addq("ATTACH", udev);
1897 * Free USB device and all subdevices, if any.
1899 usb_free_device(udev, 0);
1906 struct usb_fs_privdata *
1907 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1908 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1910 struct usb_fs_privdata* pd;
1913 /* Store information to locate ourselves again later */
1914 pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1916 pd->bus_index = device_get_unit(udev->bus->bdev);
1917 pd->dev_index = udev->device_index;
1919 pd->fifo_index = fi;
1922 /* Now, create the device itself */
1923 if (devname == NULL) {
1925 snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1926 pd->bus_index, pd->dev_index, pd->ep_addr);
1929 pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname);
1931 if (pd->cdev == NULL) {
1932 DPRINTFN(0, "Failed to create device %s\n", devname);
1937 /* XXX setting si_drv1 and creating the device is not atomic! */
1938 pd->cdev->si_drv1 = pd;
1944 usb_destroy_dev(struct usb_fs_privdata *pd)
1949 destroy_dev(pd->cdev);
1955 usb_cdev_create(struct usb_device *udev)
1957 struct usb_config_descriptor *cd;
1958 struct usb_endpoint_descriptor *ed;
1959 struct usb_descriptor *desc;
1960 struct usb_fs_privdata* pd;
1961 int inmode, outmode, inmask, outmask, mode;
1964 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
1966 DPRINTFN(2, "Creating device nodes\n");
1968 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
1971 } else { /* USB_MODE_HOST */
1981 * Collect all used endpoint numbers instead of just
1982 * generating 16 static endpoints.
1984 cd = usbd_get_config_descriptor(udev);
1985 while ((desc = usb_desc_foreach(cd, desc))) {
1986 /* filter out all endpoint descriptors */
1987 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1988 (desc->bLength >= sizeof(*ed))) {
1989 ed = (struct usb_endpoint_descriptor *)desc;
1992 ep = ed->bEndpointAddress;
1993 if (UE_GET_DIR(ep) == UE_DIR_OUT)
1994 outmask |= 1 << UE_GET_ADDR(ep);
1996 inmask |= 1 << UE_GET_ADDR(ep);
2000 /* Create all available endpoints except EP0 */
2001 for (ep = 1; ep < 16; ep++) {
2002 mode = (inmask & (1 << ep)) ? inmode : 0;
2003 mode |= (outmask & (1 << ep)) ? outmode : 0;
2005 continue; /* no IN or OUT endpoint */
2007 pd = usb_make_dev(udev, NULL, ep, 0,
2008 mode, UID_ROOT, GID_OPERATOR, 0600);
2011 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2016 usb_cdev_free(struct usb_device *udev)
2018 struct usb_fs_privdata* pd;
2020 DPRINTFN(2, "Freeing device nodes\n");
2022 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2023 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2025 LIST_REMOVE(pd, pd_next);
2027 usb_destroy_dev(pd);
2032 /*------------------------------------------------------------------------*
2035 * This function is NULL safe and will free an USB device and its
2036 * children devices, if any.
2038 * Flag values: Reserved, set to zero.
2039 *------------------------------------------------------------------------*/
2041 usb_free_device(struct usb_device *udev, uint8_t flag)
2043 struct usb_bus *bus;
2046 return; /* already freed */
2048 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2051 usb_set_device_state(udev, USB_STATE_DETACHED);
2054 usb_notify_addq("DETACH", udev);
2058 printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2059 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2061 /* Destroy UGEN symlink, if any */
2062 if (udev->ugen_symlink) {
2063 usb_free_symlink(udev->ugen_symlink);
2064 udev->ugen_symlink = NULL;
2068 * Unregister our device first which will prevent any further
2071 usb_bus_port_set_device(bus, udev->parent_hub ?
2072 udev->parent_hub->hub->ports + udev->port_index : NULL,
2073 NULL, USB_ROOT_HUB_ADDR);
2076 /* wait for all pending references to go away: */
2077 mtx_lock(&usb_ref_lock);
2079 while (udev->refcount != 0) {
2080 cv_wait(&udev->ref_cv, &usb_ref_lock);
2082 mtx_unlock(&usb_ref_lock);
2084 usb_destroy_dev(udev->ctrl_dev);
2087 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2088 /* stop receiving any control transfers (Device Side Mode) */
2089 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2092 /* the following will get the device unconfigured in software */
2093 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2095 /* unsetup any leftover default USB transfers */
2096 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2098 /* template unsetup, if any */
2099 (usb_temp_unsetup_p) (udev);
2102 * Make sure that our clear-stall messages are not queued
2105 USB_BUS_LOCK(udev->bus);
2106 usb_proc_mwait(&udev->bus->non_giant_callback_proc,
2107 &udev->cs_msg[0], &udev->cs_msg[1]);
2108 USB_BUS_UNLOCK(udev->bus);
2110 sx_destroy(&udev->ctrl_sx);
2111 sx_destroy(&udev->enum_sx);
2112 sx_destroy(&udev->sr_sx);
2114 cv_destroy(&udev->ctrlreq_cv);
2115 cv_destroy(&udev->ref_cv);
2117 mtx_destroy(&udev->device_mtx);
2119 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2122 /* Uninitialise device */
2123 if (bus->methods->device_uninit != NULL)
2124 (bus->methods->device_uninit) (udev);
2127 free(udev->serial, M_USB);
2128 free(udev->manufacturer, M_USB);
2129 free(udev->product, M_USB);
2133 /*------------------------------------------------------------------------*
2136 * This function is the safe way to get the USB interface structure
2137 * pointer by interface index.
2140 * NULL: Interface not present.
2141 * Else: Pointer to USB interface structure.
2142 *------------------------------------------------------------------------*/
2143 struct usb_interface *
2144 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2146 struct usb_interface *iface = udev->ifaces + iface_index;
2148 if (iface_index >= udev->ifaces_max)
2153 /*------------------------------------------------------------------------*
2154 * usbd_find_descriptor
2156 * This function will lookup the first descriptor that matches the
2157 * criteria given by the arguments "type" and "subtype". Descriptors
2158 * will only be searched within the interface having the index
2159 * "iface_index". If the "id" argument points to an USB descriptor,
2160 * it will be skipped before the search is started. This allows
2161 * searching for multiple descriptors using the same criteria. Else
2162 * the search is started after the interface descriptor.
2165 * NULL: End of descriptors
2166 * Else: A descriptor matching the criteria
2167 *------------------------------------------------------------------------*/
2169 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2170 uint8_t type, uint8_t type_mask,
2171 uint8_t subtype, uint8_t subtype_mask)
2173 struct usb_descriptor *desc;
2174 struct usb_config_descriptor *cd;
2175 struct usb_interface *iface;
2177 cd = usbd_get_config_descriptor(udev);
2182 iface = usbd_get_iface(udev, iface_index);
2183 if (iface == NULL) {
2186 id = usbd_get_interface_descriptor(iface);
2193 while ((desc = usb_desc_foreach(cd, desc))) {
2195 if (desc->bDescriptorType == UDESC_INTERFACE) {
2198 if (((desc->bDescriptorType & type_mask) == type) &&
2199 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2206 /*------------------------------------------------------------------------*
2209 * This function will dump information from the device descriptor
2210 * belonging to the USB device pointed to by "udev", to the string
2211 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2212 * including the terminating zero.
2213 *------------------------------------------------------------------------*/
2215 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2217 struct usb_device_descriptor *udd = &udev->ddesc;
2221 bcdUSB = UGETW(udd->bcdUSB);
2222 bcdDevice = UGETW(udd->bcdDevice);
2224 if (udd->bDeviceClass != 0xFF) {
2225 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2227 usb_get_manufacturer(udev),
2228 usb_get_product(udev),
2229 udd->bDeviceClass, udd->bDeviceSubClass,
2230 (bcdUSB >> 8), bcdUSB & 0xFF,
2231 (bcdDevice >> 8), bcdDevice & 0xFF,
2234 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2236 usb_get_manufacturer(udev),
2237 usb_get_product(udev),
2238 (bcdUSB >> 8), bcdUSB & 0xFF,
2239 (bcdDevice >> 8), bcdDevice & 0xFF,
2246 * Descriptions of of known vendors and devices ("products").
2248 struct usb_knowndev {
2252 const char *vendorname;
2253 const char *productname;
2256 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2258 #include "usbdevs.h"
2259 #include "usbdevs_data.h"
2260 #endif /* USB_VERBOSE */
2263 usbd_set_device_strings(struct usb_device *udev)
2265 struct usb_device_descriptor *udd = &udev->ddesc;
2267 const struct usb_knowndev *kdp;
2272 uint16_t product_id;
2274 temp_ptr = (char *)udev->bus->scratch[0].data;
2275 temp_size = sizeof(udev->bus->scratch[0].data);
2277 vendor_id = UGETW(udd->idVendor);
2278 product_id = UGETW(udd->idProduct);
2280 /* get serial number string */
2281 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2282 udev->ddesc.iSerialNumber);
2283 udev->serial = strdup(temp_ptr, M_USB);
2285 /* get manufacturer string */
2286 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2287 udev->ddesc.iManufacturer);
2288 usb_trim_spaces(temp_ptr);
2289 if (temp_ptr[0] != '\0')
2290 udev->manufacturer = strdup(temp_ptr, M_USB);
2292 /* get product string */
2293 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2294 udev->ddesc.iProduct);
2295 usb_trim_spaces(temp_ptr);
2296 if (temp_ptr[0] != '\0')
2297 udev->product = strdup(temp_ptr, M_USB);
2300 if (udev->manufacturer == NULL || udev->product == NULL) {
2301 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2302 if (kdp->vendor == vendor_id &&
2303 (kdp->product == product_id ||
2304 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2307 if (kdp->vendorname != NULL) {
2308 /* XXX should use pointer to knowndevs string */
2309 if (udev->manufacturer == NULL) {
2310 udev->manufacturer = strdup(kdp->vendorname,
2313 if (udev->product == NULL &&
2314 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2315 udev->product = strdup(kdp->productname,
2321 /* Provide default strings if none were found */
2322 if (udev->manufacturer == NULL) {
2323 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2324 udev->manufacturer = strdup(temp_ptr, M_USB);
2326 if (udev->product == NULL) {
2327 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2328 udev->product = strdup(temp_ptr, M_USB);
2337 usbd_get_mode(struct usb_device *udev)
2339 return (udev->flags.usb_mode);
2344 * See: USB_SPEED_XXX
2347 usbd_get_speed(struct usb_device *udev)
2349 return (udev->speed);
2353 usbd_get_isoc_fps(struct usb_device *udev)
2356 switch (udev->speed) {
2358 case USB_SPEED_FULL:
2365 struct usb_device_descriptor *
2366 usbd_get_device_descriptor(struct usb_device *udev)
2369 return (NULL); /* be NULL safe */
2370 return (&udev->ddesc);
2373 struct usb_config_descriptor *
2374 usbd_get_config_descriptor(struct usb_device *udev)
2377 return (NULL); /* be NULL safe */
2378 return (udev->cdesc);
2381 /*------------------------------------------------------------------------*
2382 * usb_test_quirk - test a device for a given quirk
2385 * 0: The USB device does not have the given quirk.
2386 * Else: The USB device has the given quirk.
2387 *------------------------------------------------------------------------*/
2389 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2394 if (quirk == UQ_NONE)
2397 /* search the automatic per device quirks first */
2399 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2400 if (uaa->device->autoQuirk[x] == quirk)
2404 /* search global quirk table, if any */
2406 found = (usb_test_quirk_p) (&uaa->info, quirk);
2411 struct usb_interface_descriptor *
2412 usbd_get_interface_descriptor(struct usb_interface *iface)
2415 return (NULL); /* be NULL safe */
2416 return (iface->idesc);
2420 usbd_get_interface_altindex(struct usb_interface *iface)
2422 return (iface->alt_index);
2426 usbd_get_bus_index(struct usb_device *udev)
2428 return ((uint8_t)device_get_unit(udev->bus->bdev));
2432 usbd_get_device_index(struct usb_device *udev)
2434 return (udev->device_index);
2439 usb_notify_addq(const char *type, struct usb_device *udev)
2441 struct usb_interface *iface;
2445 /* announce the device */
2446 sb = sbuf_new_auto();
2455 "devsubclass=0x%02x "
2468 UGETW(udev->ddesc.idVendor),
2469 UGETW(udev->ddesc.idProduct),
2470 udev->ddesc.bDeviceClass,
2471 udev->ddesc.bDeviceSubClass,
2472 usb_get_serial(udev),
2473 UGETW(udev->ddesc.bcdDevice),
2474 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2477 , udev->parent_hub != NULL ?
2478 udev->parent_hub->ugen_name :
2479 device_get_nameunit(device_get_parent(udev->bus->bdev))
2483 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2486 /* announce each interface */
2487 for (i = 0; i < USB_IFACE_MAX; i++) {
2488 iface = usbd_get_iface(udev, i);
2490 break; /* end of interfaces */
2491 if (iface->idesc == NULL)
2492 continue; /* no interface descriptor */
2494 sb = sbuf_new_auto();
2503 "devsubclass=0x%02x "
2510 "intsubclass=0x%02x "
2511 "intprotocol=0x%02x",
2516 UGETW(udev->ddesc.idVendor),
2517 UGETW(udev->ddesc.idProduct),
2518 udev->ddesc.bDeviceClass,
2519 udev->ddesc.bDeviceSubClass,
2520 usb_get_serial(udev),
2521 UGETW(udev->ddesc.bcdDevice),
2522 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2523 iface->idesc->bInterfaceNumber,
2524 iface->idesc->bNumEndpoints,
2525 iface->idesc->bInterfaceClass,
2526 iface->idesc->bInterfaceSubClass,
2527 iface->idesc->bInterfaceProtocol);
2529 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2536 /*------------------------------------------------------------------------*
2537 * usb_fifo_free_wrap
2539 * This function will free the FIFOs.
2541 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2542 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2543 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2544 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2545 * control endpoint FIFOs. If "iface_index" is not set to
2546 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2547 *------------------------------------------------------------------------*/
2549 usb_fifo_free_wrap(struct usb_device *udev,
2550 uint8_t iface_index, uint8_t flag)
2556 * Free any USB FIFOs on the given interface:
2558 for (i = 0; i != USB_FIFO_MAX; i++) {
2563 /* Check if the interface index matches */
2564 if (iface_index == f->iface_index) {
2565 if (f->methods != &usb_ugen_methods) {
2567 * Don't free any non-generic FIFOs in
2572 if ((f->dev_ep_index == 0) &&
2573 (f->fs_xfer == NULL)) {
2574 /* no need to free this FIFO */
2577 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2578 if ((f->methods == &usb_ugen_methods) &&
2579 (f->dev_ep_index == 0) &&
2580 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2581 (f->fs_xfer == NULL)) {
2582 /* no need to free this FIFO */
2586 /* no need to free this FIFO */
2589 /* free this FIFO */
2595 /*------------------------------------------------------------------------*
2596 * usb_peer_can_wakeup
2599 * 0: Peer cannot do resume signalling.
2600 * Else: Peer can do resume signalling.
2601 *------------------------------------------------------------------------*/
2603 usb_peer_can_wakeup(struct usb_device *udev)
2605 const struct usb_config_descriptor *cdp;
2608 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2609 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2611 return (0); /* not supported */
2615 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2618 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2620 DPRINTF("udev %p state %s -> %s\n", udev,
2621 usb_statestr(udev->state), usb_statestr(state));
2622 udev->state = state;
2624 if (udev->bus->methods->device_state_change != NULL)
2625 (udev->bus->methods->device_state_change) (udev);
2629 usb_get_device_state(struct usb_device *udev)
2632 return (USB_STATE_DETACHED);
2633 return (udev->state);
2637 usbd_device_attached(struct usb_device *udev)
2639 return (udev->state > USB_STATE_DETACHED);
2642 /* The following function locks enumerating the given USB device. */
2645 usbd_enum_lock(struct usb_device *udev)
2647 sx_xlock(&udev->enum_sx);
2648 sx_xlock(&udev->sr_sx);
2650 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2651 * are locked before locking Giant. Else the lock can be
2652 * locked multiple times.
2657 /* The following function unlocks enumerating the given USB device. */
2660 usbd_enum_unlock(struct usb_device *udev)
2663 sx_xunlock(&udev->enum_sx);
2664 sx_xunlock(&udev->sr_sx);
2667 /* The following function locks suspend and resume. */
2670 usbd_sr_lock(struct usb_device *udev)
2672 sx_xlock(&udev->sr_sx);
2674 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2675 * are locked before locking Giant. Else the lock can be
2676 * locked multiple times.
2681 /* The following function unlocks suspend and resume. */
2684 usbd_sr_unlock(struct usb_device *udev)
2687 sx_xunlock(&udev->sr_sx);
2691 * The following function checks the enumerating lock for the given
2696 usbd_enum_is_locked(struct usb_device *udev)
2698 return (sx_xlocked(&udev->enum_sx));
2702 * The following function is used to set the per-interface specific
2703 * plug and play information. The string referred to by the pnpinfo
2704 * argument can safely be freed after calling this function. The
2705 * pnpinfo of an interface will be reset at device detach or when
2706 * passing a NULL argument to this function. This function
2707 * returns zero on success, else a USB_ERR_XXX failure code.
2711 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2713 struct usb_interface *iface;
2715 iface = usbd_get_iface(udev, iface_index);
2717 return (USB_ERR_INVAL);
2719 if (iface->pnpinfo != NULL) {
2720 free(iface->pnpinfo, M_USBDEV);
2721 iface->pnpinfo = NULL;
2724 if (pnpinfo == NULL || pnpinfo[0] == 0)
2725 return (0); /* success */
2727 iface->pnpinfo = strdup(pnpinfo, M_USBDEV);
2728 if (iface->pnpinfo == NULL)
2729 return (USB_ERR_NOMEM);
2731 return (0); /* success */
2735 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2739 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2740 if (udev->autoQuirk[x] == 0 ||
2741 udev->autoQuirk[x] == quirk) {
2742 udev->autoQuirk[x] = quirk;
2743 return (0); /* success */
2746 return (USB_ERR_NOMEM);