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/linker_set.h>
36 #include <sys/module.h>
38 #include <sys/mutex.h>
39 #include <sys/condvar.h>
40 #include <sys/sysctl.h>
42 #include <sys/unistd.h>
43 #include <sys/callout.h>
44 #include <sys/malloc.h>
47 #include <sys/fcntl.h>
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbdi.h>
51 #include <dev/usb/usbdi_util.h>
52 #include <dev/usb/usb_ioctl.h>
55 #define USB_DEBUG_VAR usb_debug
57 #include <dev/usb/usb_core.h>
58 #include <dev/usb/usb_debug.h>
59 #include <dev/usb/usb_process.h>
60 #include <dev/usb/usb_device.h>
61 #include <dev/usb/usb_busdma.h>
62 #include <dev/usb/usb_transfer.h>
63 #include <dev/usb/usb_request.h>
64 #include <dev/usb/usb_dynamic.h>
65 #include <dev/usb/usb_hub.h>
66 #include <dev/usb/usb_util.h>
67 #include <dev/usb/usb_msctest.h>
69 #include <dev/usb/usb_dev.h>
70 #include <dev/usb/usb_generic.h>
73 #include <dev/usb/quirk/usb_quirk.h>
75 #include <dev/usb/usb_controller.h>
76 #include <dev/usb/usb_bus.h>
78 /* function prototypes */
80 static void usb_init_endpoint(struct usb_device *, uint8_t,
81 struct usb_endpoint_descriptor *, struct usb_endpoint *);
82 static void usb_unconfigure(struct usb_device *, uint8_t);
83 static void usb_detach_device(struct usb_device *, uint8_t, uint8_t);
84 static void usb_detach_device_sub(struct usb_device *, device_t *,
86 static uint8_t usb_probe_and_attach_sub(struct usb_device *,
87 struct usb_attach_arg *);
88 static void usb_init_attach_arg(struct usb_device *,
89 struct usb_attach_arg *);
90 static void usb_suspend_resume_sub(struct usb_device *, device_t,
92 static void usbd_clear_stall_proc(struct usb_proc_msg *_pm);
93 usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
94 static void usbd_set_device_strings(struct usb_device *);
96 static void usb_notify_addq(const char *type, struct usb_device *);
97 static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
98 static struct cdev *usb_make_dev(struct usb_device *, int, int);
99 static void usb_cdev_create(struct usb_device *);
100 static void usb_cdev_free(struct usb_device *);
101 static void usb_cdev_cleanup(void *);
104 /* This variable is global to allow easy access to it: */
106 int usb_template = 0;
108 TUNABLE_INT("hw.usb.usb_template", &usb_template);
109 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW,
110 &usb_template, 0, "Selected USB device side template");
112 /* English is default language */
114 static int usb_lang_id = 0x0009;
115 static int usb_lang_mask = 0x00FF;
117 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
118 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW,
119 &usb_lang_id, 0, "Preferred USB language ID");
121 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
122 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW,
123 &usb_lang_mask, 0, "Preferred USB language mask");
125 static const char* statestr[USB_STATE_MAX] = {
126 [USB_STATE_DETACHED] = "DETACHED",
127 [USB_STATE_ATTACHED] = "ATTACHED",
128 [USB_STATE_POWERED] = "POWERED",
129 [USB_STATE_ADDRESSED] = "ADDRESSED",
130 [USB_STATE_CONFIGURED] = "CONFIGURED",
134 usb_statestr(enum usb_dev_state state)
136 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
139 /*------------------------------------------------------------------------*
140 * usbd_get_ep_by_addr
142 * This function searches for an USB ep by endpoint address and
148 *------------------------------------------------------------------------*/
149 struct usb_endpoint *
150 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
152 struct usb_endpoint *ep = udev->endpoints;
153 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
155 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
159 * According to the USB specification not all bits are used
160 * for the endpoint address. Keep defined bits only:
165 * Iterate accross all the USB endpoints searching for a match
166 * based on the endpoint address:
168 for (; ep != ep_end; ep++) {
170 if (ep->edesc == NULL) {
173 /* do the mask and check the value */
174 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
180 * The default endpoint is always present and is checked separately:
182 if ((udev->default_ep.edesc) &&
183 ((udev->default_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
184 ep = &udev->default_ep;
193 /*------------------------------------------------------------------------*
196 * This function searches for an USB endpoint based on the information
197 * given by the passed "struct usb_config" pointer.
201 * Else: Pointer to "struct usb_endpoint".
202 *------------------------------------------------------------------------*/
203 struct usb_endpoint *
204 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
205 const struct usb_config *setup)
207 struct usb_endpoint *ep = udev->endpoints;
208 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
209 uint8_t index = setup->ep_index;
215 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
216 "type=0x%x dir=0x%x index=%d\n",
217 udev, iface_index, setup->endpoint,
218 setup->type, setup->direction, setup->ep_index);
222 if (setup->usb_mode != USB_MODE_DUAL &&
223 udev->flags.usb_mode != setup->usb_mode) {
224 /* wrong mode - no endpoint */
228 /* setup expected endpoint direction mask and value */
230 if (setup->direction == UE_DIR_RX) {
231 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
232 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
233 UE_DIR_OUT : UE_DIR_IN;
234 } else if (setup->direction == UE_DIR_TX) {
235 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
236 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
237 UE_DIR_IN : UE_DIR_OUT;
238 } else if (setup->direction == UE_DIR_ANY) {
239 /* match any endpoint direction */
243 /* match the given endpoint direction */
244 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
245 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
248 /* setup expected endpoint address */
250 if (setup->endpoint == UE_ADDR_ANY) {
251 /* match any endpoint address */
253 /* match the given endpoint address */
255 ea_val |= (setup->endpoint & UE_ADDR);
258 /* setup expected endpoint type */
260 if (setup->type == UE_BULK_INTR) {
261 /* this will match BULK and INTERRUPT endpoints */
264 } else if (setup->type == UE_TYPE_ANY) {
265 /* match any endpoint type */
269 /* match the given endpoint type */
270 type_mask = UE_XFERTYPE;
271 type_val = (setup->type & UE_XFERTYPE);
275 * Iterate accross all the USB endpoints searching for a match
276 * based on the endpoint address. Note that we are searching
277 * the endpoints from the beginning of the "udev->endpoints" array.
279 for (; ep != ep_end; ep++) {
281 if ((ep->edesc == NULL) ||
282 (ep->iface_index != iface_index)) {
285 /* do the masks and check the values */
287 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
288 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
296 * Match against default endpoint last, so that "any endpoint", "any
297 * address" and "any direction" returns the first endpoint of the
298 * interface. "iface_index" and "direction" is ignored:
300 if ((udev->default_ep.edesc) &&
301 ((udev->default_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
302 ((udev->default_ep.edesc->bmAttributes & type_mask) == type_val) &&
304 ep = &udev->default_ep;
313 /*------------------------------------------------------------------------*
314 * usbd_interface_count
316 * This function stores the number of USB interfaces excluding
317 * alternate settings, which the USB config descriptor reports into
318 * the unsigned 8-bit integer pointed to by "count".
323 *------------------------------------------------------------------------*/
325 usbd_interface_count(struct usb_device *udev, uint8_t *count)
327 if (udev->cdesc == NULL) {
329 return (USB_ERR_NOT_CONFIGURED);
331 *count = udev->ifaces_max;
332 return (USB_ERR_NORMAL_COMPLETION);
336 /*------------------------------------------------------------------------*
339 * This function will initialise the USB endpoint structure pointed to by
340 * the "endpoint" argument. The structure pointed to by "endpoint" must be
341 * zeroed before calling this function.
342 *------------------------------------------------------------------------*/
344 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
345 struct usb_endpoint_descriptor *edesc, struct usb_endpoint *ep)
347 struct usb_bus_methods *methods;
349 methods = udev->bus->methods;
351 (methods->endpoint_init) (udev, edesc, ep);
353 /* initialise USB endpoint structure */
355 ep->iface_index = iface_index;
356 TAILQ_INIT(&ep->endpoint_q.head);
357 ep->endpoint_q.command = &usbd_pipe_start;
359 /* the pipe is not supported by the hardware */
360 if (ep->methods == NULL)
363 /* clear stall, if any */
364 if (methods->clear_stall != NULL) {
365 USB_BUS_LOCK(udev->bus);
366 (methods->clear_stall) (udev, ep);
367 USB_BUS_UNLOCK(udev->bus);
371 /*-----------------------------------------------------------------------*
372 * usb_endpoint_foreach
374 * This function will iterate all the USB endpoints except the control
375 * endpoint. This function is NULL safe.
378 * NULL: End of USB endpoints
379 * Else: Pointer to next USB endpoint
380 *------------------------------------------------------------------------*/
381 struct usb_endpoint *
382 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
384 struct usb_endpoint *ep_end;
390 ep_end = udev->endpoints + udev->endpoints_max;
392 /* get next endpoint */
394 ep = udev->endpoints;
398 /* find next allocated ep */
399 while (ep != ep_end) {
400 if (ep->edesc != NULL)
407 /*------------------------------------------------------------------------*
410 * This function will free all USB interfaces and USB endpoints belonging
413 * Flag values, see "USB_UNCFG_FLAG_XXX".
414 *------------------------------------------------------------------------*/
416 usb_unconfigure(struct usb_device *udev, uint8_t flag)
420 /* automatic locking */
421 if (usbd_enum_is_locked(udev)) {
425 usbd_enum_lock(udev);
428 /* detach all interface drivers */
429 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
432 /* free all FIFOs except control endpoint FIFOs */
433 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
436 * Free all cdev's, if any.
441 #if USB_HAVE_COMPAT_LINUX
442 /* free Linux compat device, if any */
443 if (udev->linux_endpoint_start) {
444 usb_linux_free_device(udev);
445 udev->linux_endpoint_start = NULL;
449 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
451 /* free "cdesc" after "ifaces" and "endpoints", if any */
452 if (udev->cdesc != NULL) {
453 if (udev->flags.usb_mode != USB_MODE_DEVICE)
454 free(udev->cdesc, M_USB);
457 /* set unconfigured state */
458 udev->curr_config_no = USB_UNCONFIG_NO;
459 udev->curr_config_index = USB_UNCONFIG_INDEX;
462 usbd_enum_unlock(udev);
465 /*------------------------------------------------------------------------*
466 * usbd_set_config_index
468 * This function selects configuration by index, independent of the
469 * actual configuration number. This function should not be used by
475 *------------------------------------------------------------------------*/
477 usbd_set_config_index(struct usb_device *udev, uint8_t index)
479 struct usb_status ds;
480 struct usb_config_descriptor *cdp;
487 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
489 /* automatic locking */
490 if (usbd_enum_is_locked(udev)) {
494 usbd_enum_lock(udev);
497 usb_unconfigure(udev, 0);
499 if (index == USB_UNCONFIG_INDEX) {
501 * Leave unallocated when unconfiguring the
502 * device. "usb_unconfigure()" will also reset
503 * the current config number and index.
505 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
506 if (udev->state == USB_STATE_CONFIGURED)
507 usb_set_device_state(udev, USB_STATE_ADDRESSED);
510 /* get the full config descriptor */
511 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
512 /* save some memory */
513 err = usbd_req_get_descriptor_ptr(udev, &cdp,
514 (UDESC_CONFIG << 8) | index);
517 err = usbd_req_get_config_desc_full(udev,
518 NULL, &cdp, M_USB, index);
523 /* set the new config descriptor */
527 /* Figure out if the device is self or bus powered. */
529 if ((!udev->flags.uq_bus_powered) &&
530 (cdp->bmAttributes & UC_SELF_POWERED) &&
531 (udev->flags.usb_mode == USB_MODE_HOST)) {
532 /* May be self powered. */
533 if (cdp->bmAttributes & UC_BUS_POWERED) {
534 /* Must ask device. */
535 err = usbd_req_get_device_status(udev, NULL, &ds);
537 DPRINTFN(0, "could not read "
538 "device status: %s\n",
540 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
543 DPRINTF("status=0x%04x \n",
548 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
549 "selfpowered=%d, power=%d\n",
551 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
552 selfpowered, cdp->bMaxPower * 2);
554 /* Check if we have enough power. */
555 power = cdp->bMaxPower * 2;
557 if (udev->parent_hub) {
558 max_power = udev->parent_hub->hub->portpower;
560 max_power = USB_MAX_POWER;
563 if (power > max_power) {
564 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
565 err = USB_ERR_NO_POWER;
568 /* Only update "self_powered" in USB Host Mode */
569 if (udev->flags.usb_mode == USB_MODE_HOST) {
570 udev->flags.self_powered = selfpowered;
573 udev->curr_config_no = cdp->bConfigurationValue;
574 udev->curr_config_index = index;
575 usb_set_device_state(udev, USB_STATE_CONFIGURED);
577 /* Set the actual configuration value. */
578 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
583 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
588 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
594 /* create device nodes for each endpoint */
595 usb_cdev_create(udev);
599 DPRINTF("error=%s\n", usbd_errstr(err));
601 usb_unconfigure(udev, 0);
604 usbd_enum_unlock(udev);
608 /*------------------------------------------------------------------------*
611 * This function will allocate and free USB interfaces and USB endpoints,
612 * parse the USB configuration structure and initialise the USB endpoints
613 * and interfaces. If "iface_index" is not equal to
614 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
615 * alternate_setting to be selected for the given interface. Else the
616 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
617 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
618 * is typically called when setting the configuration or when setting
619 * an alternate interface.
624 *------------------------------------------------------------------------*/
626 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
628 struct usb_idesc_parse_state ips;
629 struct usb_interface_descriptor *id;
630 struct usb_endpoint_descriptor *ed;
631 struct usb_interface *iface;
632 struct usb_endpoint *ep;
640 if (iface_index != USB_IFACE_INDEX_ANY) {
641 /* parameter overload */
651 DPRINTFN(5, "iface_index=%d cmd=%d\n",
654 if (cmd == USB_CFG_FREE)
657 if (cmd == USB_CFG_INIT) {
658 sx_assert(udev->default_sx + 1, SA_LOCKED);
660 /* check for in-use endpoints */
662 ep = udev->endpoints;
663 ep_max = udev->endpoints_max;
665 /* look for matching endpoints */
666 if ((iface_index == USB_IFACE_INDEX_ANY) ||
667 (iface_index == ep->iface_index)) {
668 if (ep->refcount_alloc != 0) {
670 * This typically indicates a
671 * more serious error.
673 err = USB_ERR_IN_USE;
676 memset(ep, 0, sizeof(*ep));
677 /* make sure we don't zero the endpoint again */
678 ep->iface_index = USB_IFACE_INDEX_ANY;
688 memset(&ips, 0, sizeof(ips));
693 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
695 /* check for interface overflow */
696 if (ips.iface_index == USB_IFACE_MAX)
699 iface = udev->ifaces + ips.iface_index;
701 /* check for specific interface match */
703 if (cmd == USB_CFG_INIT) {
704 if ((iface_index != USB_IFACE_INDEX_ANY) &&
705 (iface_index != ips.iface_index)) {
706 /* wrong interface */
708 } else if (alt_index != ips.iface_index_alt) {
709 /* wrong alternate setting */
712 /* initialise interface */
718 /* check for new interface */
719 if (ips.iface_index_alt == 0) {
720 /* update current number of endpoints */
725 /* setup the USB interface structure */
727 /* default setting */
728 iface->parent_iface_index = USB_IFACE_INDEX_ANY;
729 /* set alternate index */
730 iface->alt_index = alt_index;
733 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
735 ed = (struct usb_endpoint_descriptor *)id;
739 /* iterate all the endpoint descriptors */
740 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
742 if (temp == USB_EP_MAX)
745 ep = udev->endpoints + temp;
748 usb_init_endpoint(udev,
749 ips.iface_index, ed, ep);
754 /* find maximum number of endpoints */
759 id = (struct usb_interface_descriptor *)ed;
763 /* NOTE: It is valid to have no interfaces and no endpoints! */
765 if (cmd == USB_CFG_ALLOC) {
766 udev->ifaces_max = ips.iface_index;
768 if (udev->ifaces_max != 0) {
769 udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max,
770 M_USB, M_WAITOK | M_ZERO);
771 if (udev->ifaces == NULL) {
777 udev->endpoints = malloc(sizeof(*ep) * ep_max,
778 M_USB, M_WAITOK | M_ZERO);
779 if (udev->endpoints == NULL) {
784 udev->endpoints = NULL;
786 USB_BUS_LOCK(udev->bus);
787 udev->endpoints_max = ep_max;
788 /* reset any ongoing clear-stall */
789 udev->ep_curr = NULL;
790 USB_BUS_UNLOCK(udev->bus);
795 if (cmd == USB_CFG_ALLOC) {
797 USB_BUS_LOCK(udev->bus);
798 udev->endpoints_max = 0;
799 /* reset any ongoing clear-stall */
800 udev->ep_curr = NULL;
801 USB_BUS_UNLOCK(udev->bus);
804 if (udev->ifaces != NULL)
805 free(udev->ifaces, M_USB);
806 if (udev->endpoints != NULL)
807 free(udev->endpoints, M_USB);
810 udev->endpoints = NULL;
811 udev->ifaces_max = 0;
817 /*------------------------------------------------------------------------*
818 * usbd_set_alt_interface_index
820 * This function will select an alternate interface index for the
821 * given interface index. The interface should not be in use when this
822 * function is called. That means there should not be any open USB
823 * transfers. Else an error is returned. If the alternate setting is
824 * already set this function will simply return success. This function
825 * is called in Host mode and Device mode!
830 *------------------------------------------------------------------------*/
832 usbd_set_alt_interface_index(struct usb_device *udev,
833 uint8_t iface_index, uint8_t alt_index)
835 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
839 /* automatic locking */
840 if (usbd_enum_is_locked(udev)) {
844 usbd_enum_lock(udev);
850 if (iface->alt_index == alt_index) {
852 * Optimise away duplicate setting of
853 * alternate setting in USB Host Mode!
860 * Free all generic FIFOs for this interface, except control
863 usb_fifo_free_wrap(udev, iface_index, 0);
866 err = usb_config_parse(udev, iface_index, alt_index);
870 if (iface->alt_index != alt_index) {
871 /* the alternate setting does not exist */
876 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
877 iface->idesc->bAlternateSetting);
881 usbd_enum_unlock(udev);
886 /*------------------------------------------------------------------------*
887 * usbd_set_endpoint_stall
889 * This function is used to make a BULK or INTERRUPT endpoint
895 *------------------------------------------------------------------------*/
897 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
900 struct usb_xfer *xfer;
906 DPRINTF("Cannot find endpoint\n");
908 * Pretend that the clear or set stall request is
909 * successful else some USB host stacks can do
910 * strange things, especially when a control endpoint
915 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
917 if ((et != UE_BULK) &&
918 (et != UE_INTERRUPT)) {
920 * Should not stall control
921 * nor isochronous endpoints.
923 DPRINTF("Invalid endpoint\n");
926 USB_BUS_LOCK(udev->bus);
928 /* store current stall state */
929 was_stalled = ep->is_stalled;
931 /* check for no change */
932 if (was_stalled && do_stall) {
933 /* if the endpoint is already stalled do nothing */
934 USB_BUS_UNLOCK(udev->bus);
935 DPRINTF("No change\n");
938 /* set stalled state */
941 if (do_stall || (!was_stalled)) {
943 /* lookup the current USB transfer, if any */
944 xfer = ep->endpoint_q.curr;
950 * If "xfer" is non-NULL the "set_stall" method will
951 * complete the USB transfer like in case of a timeout
952 * setting the error code "USB_ERR_STALLED".
954 (udev->bus->methods->set_stall) (udev, xfer, ep, &do_stall);
957 ep->toggle_next = 0; /* reset data toggle */
958 ep->is_stalled = 0; /* clear stalled state */
960 (udev->bus->methods->clear_stall) (udev, ep);
962 /* start up the current or next transfer, if any */
963 usb_command_wrapper(&ep->endpoint_q, ep->endpoint_q.curr);
965 USB_BUS_UNLOCK(udev->bus);
969 /*------------------------------------------------------------------------*
970 * usb_reset_iface_endpoints - used in USB device side mode
971 *------------------------------------------------------------------------*/
973 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
975 struct usb_endpoint *ep;
976 struct usb_endpoint *ep_end;
978 ep = udev->endpoints;
979 ep_end = udev->endpoints + udev->endpoints_max;
981 for (; ep != ep_end; ep++) {
983 if ((ep->edesc == NULL) ||
984 (ep->iface_index != iface_index)) {
987 /* simulate a clear stall from the peer */
988 usbd_set_endpoint_stall(udev, ep, 0);
993 /*------------------------------------------------------------------------*
994 * usb_detach_device_sub
996 * This function will try to detach an USB device. If it fails a panic
999 * Flag values, see "USB_UNCFG_FLAG_XXX".
1000 *------------------------------------------------------------------------*/
1002 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1011 * NOTE: It is important to clear "*ppdev" before deleting
1012 * the child due to some device methods being called late
1013 * during the delete process !
1017 device_printf(dev, "at %s, port %d, addr %d "
1019 device_get_nameunit(udev->parent_dev),
1020 udev->port_no, udev->address);
1022 if (device_is_attached(dev)) {
1023 if (udev->flags.peer_suspended) {
1024 err = DEVICE_RESUME(dev);
1026 device_printf(dev, "Resume failed\n");
1029 if (device_detach(dev)) {
1033 if (device_delete_child(udev->parent_dev, dev)) {
1040 /* Detach is not allowed to fail in the USB world */
1041 panic("A USB driver would not detach\n");
1044 /*------------------------------------------------------------------------*
1047 * The following function will detach the matching interfaces.
1048 * This function is NULL safe.
1050 * Flag values, see "USB_UNCFG_FLAG_XXX".
1051 *------------------------------------------------------------------------*/
1053 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1056 struct usb_interface *iface;
1063 DPRINTFN(4, "udev=%p\n", udev);
1065 sx_assert(udev->default_sx + 1, SA_LOCKED);
1068 * First detach the child to give the child's detach routine a
1069 * chance to detach the sub-devices in the correct order.
1070 * Then delete the child using "device_delete_child()" which
1071 * will detach all sub-devices from the bottom and upwards!
1073 if (iface_index != USB_IFACE_INDEX_ANY) {
1075 iface_index = i + 1;
1078 iface_index = USB_IFACE_MAX;
1083 for (; i != iface_index; i++) {
1085 iface = usbd_get_iface(udev, i);
1086 if (iface == NULL) {
1087 /* looks like the end of the USB interfaces */
1090 usb_detach_device_sub(udev, &iface->subdev, flag);
1094 /*------------------------------------------------------------------------*
1095 * usb_probe_and_attach_sub
1100 *------------------------------------------------------------------------*/
1102 usb_probe_and_attach_sub(struct usb_device *udev,
1103 struct usb_attach_arg *uaa)
1105 struct usb_interface *iface;
1110 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1111 /* leave interface alone */
1114 dev = iface->subdev;
1117 /* clean up after module unload */
1119 if (device_is_attached(dev)) {
1120 /* already a device there */
1123 /* clear "iface->subdev" as early as possible */
1125 iface->subdev = NULL;
1127 if (device_delete_child(udev->parent_dev, dev)) {
1130 * Panic here, else one can get a double call
1131 * to device_detach(). USB devices should
1132 * never fail on detach!
1134 panic("device_delete_child() failed\n");
1137 if (uaa->temp_dev == NULL) {
1139 /* create a new child */
1140 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1141 if (uaa->temp_dev == NULL) {
1142 device_printf(udev->parent_dev,
1143 "Device creation failed\n");
1144 return (1); /* failure */
1146 device_set_ivars(uaa->temp_dev, uaa);
1147 device_quiet(uaa->temp_dev);
1150 * Set "subdev" before probe and attach so that "devd" gets
1151 * the information it needs.
1153 iface->subdev = uaa->temp_dev;
1155 if (device_probe_and_attach(iface->subdev) == 0) {
1157 * The USB attach arguments are only available during probe
1160 uaa->temp_dev = NULL;
1161 device_set_ivars(iface->subdev, NULL);
1163 if (udev->flags.peer_suspended) {
1164 err = DEVICE_SUSPEND(iface->subdev);
1166 device_printf(iface->subdev, "Suspend failed\n");
1168 return (0); /* success */
1170 /* No USB driver found */
1171 iface->subdev = NULL;
1173 return (1); /* failure */
1176 /*------------------------------------------------------------------------*
1177 * usbd_set_parent_iface
1179 * Using this function will lock the alternate interface setting on an
1180 * interface. It is typically used for multi interface drivers. In USB
1181 * device side mode it is assumed that the alternate interfaces all
1182 * have the same endpoint descriptors. The default parent index value
1183 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1185 *------------------------------------------------------------------------*/
1187 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1188 uint8_t parent_index)
1190 struct usb_interface *iface;
1192 iface = usbd_get_iface(udev, iface_index);
1194 iface->parent_iface_index = parent_index;
1199 usb_init_attach_arg(struct usb_device *udev,
1200 struct usb_attach_arg *uaa)
1202 bzero(uaa, sizeof(*uaa));
1205 uaa->usb_mode = udev->flags.usb_mode;
1206 uaa->port = udev->port_no;
1207 uaa->dev_state = UAA_DEV_READY;
1209 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1210 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1211 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1212 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1213 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1214 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1215 uaa->info.bConfigIndex = udev->curr_config_index;
1216 uaa->info.bConfigNum = udev->curr_config_no;
1219 /*------------------------------------------------------------------------*
1220 * usb_probe_and_attach
1222 * This function is called from "uhub_explore_sub()",
1223 * "usb_handle_set_config()" and "usb_handle_request()".
1227 * Else: A control transfer failed
1228 *------------------------------------------------------------------------*/
1230 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1232 struct usb_attach_arg uaa;
1233 struct usb_interface *iface;
1239 DPRINTF("udev == NULL\n");
1240 return (USB_ERR_INVAL);
1242 /* automatic locking */
1243 if (usbd_enum_is_locked(udev)) {
1247 usbd_enum_lock(udev);
1250 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1251 /* do nothing - no configuration has been set */
1254 /* setup USB attach arguments */
1256 usb_init_attach_arg(udev, &uaa);
1258 /* Check if only one interface should be probed: */
1259 if (iface_index != USB_IFACE_INDEX_ANY) {
1267 /* Do the probe and attach */
1268 for (; i != j; i++) {
1270 iface = usbd_get_iface(udev, i);
1271 if (iface == NULL) {
1273 * Looks like the end of the USB
1276 DPRINTFN(2, "end of interfaces "
1280 if (iface->idesc == NULL) {
1281 /* no interface descriptor */
1286 uaa.info.bInterfaceClass =
1287 iface->idesc->bInterfaceClass;
1288 uaa.info.bInterfaceSubClass =
1289 iface->idesc->bInterfaceSubClass;
1290 uaa.info.bInterfaceProtocol =
1291 iface->idesc->bInterfaceProtocol;
1292 uaa.info.bIfaceIndex = i;
1293 uaa.info.bIfaceNum =
1294 iface->idesc->bInterfaceNumber;
1295 uaa.use_generic = 0;
1296 uaa.driver_info = 0; /* reset driver_info */
1298 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1299 uaa.info.bInterfaceClass,
1300 uaa.info.bInterfaceSubClass,
1301 uaa.info.bInterfaceProtocol,
1302 uaa.info.bIfaceIndex,
1303 uaa.info.bIfaceNum);
1305 /* try specific interface drivers first */
1307 if (usb_probe_and_attach_sub(udev, &uaa)) {
1310 /* try generic interface drivers last */
1312 uaa.use_generic = 1;
1313 uaa.driver_info = 0; /* reset driver_info */
1315 if (usb_probe_and_attach_sub(udev, &uaa)) {
1321 /* remove the last created child; it is unused */
1323 if (device_delete_child(udev->parent_dev, uaa.temp_dev)) {
1324 DPRINTFN(0, "device delete child failed\n");
1329 usbd_enum_unlock(udev);
1334 /*------------------------------------------------------------------------*
1335 * usb_suspend_resume_sub
1337 * This function is called when the suspend or resume methods should
1338 * be executed on an USB device.
1339 *------------------------------------------------------------------------*/
1341 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1348 if (!device_is_attached(dev)) {
1352 err = DEVICE_SUSPEND(dev);
1354 err = DEVICE_RESUME(dev);
1357 device_printf(dev, "%s failed\n",
1358 do_suspend ? "Suspend" : "Resume");
1362 /*------------------------------------------------------------------------*
1363 * usb_suspend_resume
1365 * The following function will suspend or resume the USB device.
1370 *------------------------------------------------------------------------*/
1372 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1374 struct usb_interface *iface;
1381 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1383 sx_assert(udev->default_sx + 1, SA_LOCKED);
1385 USB_BUS_LOCK(udev->bus);
1386 /* filter the suspend events */
1387 if (udev->flags.peer_suspended == do_suspend) {
1388 USB_BUS_UNLOCK(udev->bus);
1392 udev->flags.peer_suspended = do_suspend;
1393 USB_BUS_UNLOCK(udev->bus);
1395 /* do the suspend or resume */
1397 for (i = 0; i != USB_IFACE_MAX; i++) {
1399 iface = usbd_get_iface(udev, i);
1400 if (iface == NULL) {
1401 /* looks like the end of the USB interfaces */
1404 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1409 /*------------------------------------------------------------------------*
1410 * usbd_clear_stall_proc
1412 * This function performs generic USB clear stall operations.
1413 *------------------------------------------------------------------------*/
1415 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1417 struct usb_clear_stall_msg *pm = (void *)_pm;
1418 struct usb_device *udev = pm->udev;
1421 USB_BUS_UNLOCK(udev->bus);
1422 mtx_lock(udev->default_mtx);
1424 /* Start clear stall callback */
1425 usbd_transfer_start(udev->default_xfer[1]);
1428 mtx_unlock(udev->default_mtx);
1429 USB_BUS_LOCK(udev->bus);
1432 /*------------------------------------------------------------------------*
1435 * This function allocates a new USB device. This function is called
1436 * when a new device has been put in the powered state, but not yet in
1437 * the addressed state. Get initial descriptor, set the address, get
1438 * full descriptor and get strings.
1443 *------------------------------------------------------------------------*/
1445 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1446 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1447 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1449 struct usb_attach_arg uaa;
1450 struct usb_device *udev;
1451 struct usb_device *adev;
1452 struct usb_device *hub;
1453 uint8_t *scratch_ptr;
1454 size_t scratch_size;
1456 uint8_t device_index;
1457 uint8_t config_index;
1458 uint8_t config_quirk;
1459 uint8_t set_config_failed;
1461 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1462 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1463 parent_dev, bus, parent_hub, depth, port_index, port_no,
1467 * Find an unused device index. In USB Host mode this is the
1468 * same as the device address.
1470 * Device index zero is not used and device index 1 should
1471 * always be the root hub.
1473 for (device_index = USB_ROOT_HUB_ADDR;
1474 (device_index != bus->devices_max) &&
1475 (bus->devices[device_index] != NULL);
1476 device_index++) /* nop */;
1478 if (device_index == bus->devices_max) {
1479 device_printf(bus->bdev,
1480 "No free USB device index for new device\n");
1485 device_printf(bus->bdev,
1486 "Invalid device depth\n");
1489 udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1493 /* initialise our SX-lock */
1494 sx_init(udev->default_sx, "0123456789ABCDEF - USB device SX lock" + depth);
1496 /* initialise our SX-lock */
1497 sx_init(udev->default_sx + 1, "0123456789ABCDEF - USB config SX lock" + depth);
1499 cv_init(udev->default_cv, "WCTRL");
1500 cv_init(udev->default_cv + 1, "UGONE");
1502 /* initialise our mutex */
1503 mtx_init(udev->default_mtx, "USB device mutex", NULL, MTX_DEF);
1505 /* initialise generic clear stall */
1506 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1507 udev->cs_msg[0].udev = udev;
1508 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1509 udev->cs_msg[1].udev = udev;
1511 /* initialise some USB device fields */
1512 udev->parent_hub = parent_hub;
1513 udev->parent_dev = parent_dev;
1514 udev->port_index = port_index;
1515 udev->port_no = port_no;
1516 udev->depth = depth;
1518 udev->address = USB_START_ADDR; /* default value */
1519 udev->plugtime = (usb_ticks_t)ticks;
1520 usb_set_device_state(udev, USB_STATE_POWERED);
1522 * We need to force the power mode to "on" because there are plenty
1523 * of USB devices out there that do not work very well with
1524 * automatic suspend and resume!
1526 udev->power_mode = USB_POWER_MODE_ON;
1527 udev->pwr_save.last_xfer_time = ticks;
1528 /* we are not ready yet */
1531 /* set up default endpoint descriptor */
1532 udev->default_ep_desc.bLength = sizeof(udev->default_ep_desc);
1533 udev->default_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1534 udev->default_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1535 udev->default_ep_desc.bmAttributes = UE_CONTROL;
1536 udev->default_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1537 udev->default_ep_desc.wMaxPacketSize[1] = 0;
1538 udev->default_ep_desc.bInterval = 0;
1539 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1541 udev->speed = speed;
1542 udev->flags.usb_mode = mode;
1544 /* search for our High Speed USB HUB, if any */
1547 hub = udev->parent_hub;
1550 if (hub->speed == USB_SPEED_HIGH) {
1551 udev->hs_hub_addr = hub->address;
1552 udev->parent_hs_hub = hub;
1553 udev->hs_port_no = adev->port_no;
1557 hub = hub->parent_hub;
1560 /* init the default endpoint */
1561 usb_init_endpoint(udev, 0,
1562 &udev->default_ep_desc,
1565 /* set device index */
1566 udev->device_index = device_index;
1569 /* Create ugen name */
1570 snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1571 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1573 LIST_INIT(&udev->pd_list);
1575 /* Create the control endpoint device */
1576 udev->default_dev = usb_make_dev(udev, 0, FREAD|FWRITE);
1578 /* Create a link from /dev/ugenX.X to the default endpoint */
1579 make_dev_alias(udev->default_dev, udev->ugen_name);
1581 if (udev->flags.usb_mode == USB_MODE_HOST) {
1583 err = usbd_req_set_address(udev, NULL, device_index);
1585 /* This is the new USB device address from now on */
1587 udev->address = device_index;
1590 * We ignore any set-address errors, hence there are
1591 * buggy USB devices out there that actually receive
1592 * the SETUP PID, but manage to set the address before
1593 * the STATUS stage is ACK'ed. If the device responds
1594 * to the subsequent get-descriptor at the new
1595 * address, then we know that the set-address command
1599 DPRINTFN(0, "set address %d failed "
1600 "(%s, ignored)\n", udev->address,
1603 /* allow device time to set new address */
1605 USB_MS_TO_TICKS(USB_SET_ADDRESS_SETTLE));
1607 /* We are not self powered */
1608 udev->flags.self_powered = 0;
1610 /* Set unconfigured state */
1611 udev->curr_config_no = USB_UNCONFIG_NO;
1612 udev->curr_config_index = USB_UNCONFIG_INDEX;
1614 /* Setup USB descriptors */
1615 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1617 DPRINTFN(0, "setting up USB template failed maybe the USB "
1618 "template module has not been loaded\n");
1622 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1625 * Get the first 8 bytes of the device descriptor !
1627 * NOTE: "usbd_do_request" will check the device descriptor
1628 * next time we do a request to see if the maximum packet size
1629 * changed! The 8 first bytes of the device descriptor
1630 * contains the maximum packet size to use on control endpoint
1631 * 0. If this value is different from "USB_MAX_IPACKET" a new
1632 * USB control request will be setup!
1634 err = usbd_req_get_desc(udev, NULL, NULL, &udev->ddesc,
1635 USB_MAX_IPACKET, USB_MAX_IPACKET, 0, UDESC_DEVICE, 0, 0);
1637 DPRINTFN(0, "getting device descriptor "
1638 "at addr %d failed, %s\n", udev->address,
1640 /* XXX try to re-enumerate the device */
1641 err = usbd_req_re_enumerate(udev, NULL);
1646 DPRINTF("adding unit addr=%d, rev=%02x, class=%d, "
1647 "subclass=%d, protocol=%d, maxpacket=%d, len=%d, speed=%d\n",
1648 udev->address, UGETW(udev->ddesc.bcdUSB),
1649 udev->ddesc.bDeviceClass,
1650 udev->ddesc.bDeviceSubClass,
1651 udev->ddesc.bDeviceProtocol,
1652 udev->ddesc.bMaxPacketSize,
1653 udev->ddesc.bLength,
1656 /* get the full device descriptor */
1657 err = usbd_req_get_device_desc(udev, NULL, &udev->ddesc);
1659 DPRINTF("addr=%d, getting full desc failed\n",
1664 * Setup temporary USB attach args so that we can figure out some
1665 * basic quirks for this device.
1667 usb_init_attach_arg(udev, &uaa);
1669 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1670 udev->flags.uq_bus_powered = 1;
1672 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1673 udev->flags.no_strings = 1;
1676 * Workaround for buggy USB devices.
1678 * It appears that some string-less USB chips will crash and
1679 * disappear if any attempts are made to read any string
1682 * Try to detect such chips by checking the strings in the USB
1683 * device descriptor. If no strings are present there we
1684 * simply disable all USB strings.
1686 scratch_ptr = udev->bus->scratch[0].data;
1687 scratch_size = sizeof(udev->bus->scratch[0].data);
1689 if (udev->ddesc.iManufacturer ||
1690 udev->ddesc.iProduct ||
1691 udev->ddesc.iSerialNumber) {
1692 /* read out the language ID string */
1693 err = usbd_req_get_string_desc(udev, NULL,
1694 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1696 err = USB_ERR_INVAL;
1699 if (err || (scratch_ptr[0] < 4)) {
1700 udev->flags.no_strings = 1;
1707 /* load preferred value and mask */
1709 mask = usb_lang_mask;
1711 /* align length correctly */
1712 scratch_ptr[0] &= ~1;
1714 /* fix compiler warning */
1717 /* search for preferred language */
1718 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1719 langid = UGETW(scratch_ptr + x);
1720 if ((langid & mask) == pref)
1723 if (x >= scratch_ptr[0]) {
1724 /* pick the first language as the default */
1725 DPRINTFN(1, "Using first language\n");
1726 langid = UGETW(scratch_ptr + 2);
1729 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1730 udev->langid = langid;
1733 /* assume 100mA bus powered for now. Changed when configured. */
1734 udev->power = USB_MIN_POWER;
1735 /* fetch the vendor and product strings from the device */
1736 usbd_set_device_strings(udev);
1738 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1739 /* USB device mode setup is complete */
1745 * Most USB devices should attach to config index 0 by
1748 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1751 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1754 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1757 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1760 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1768 set_config_failed = 0;
1771 DPRINTF("setting config %u\n", config_index);
1773 /* get the USB device configured */
1774 err = usbd_set_config_index(udev, config_index);
1776 if (udev->ddesc.bNumConfigurations != 0) {
1777 if (!set_config_failed) {
1778 set_config_failed = 1;
1779 /* XXX try to re-enumerate the device */
1780 err = usbd_req_re_enumerate(udev, NULL);
1782 goto repeat_set_config;
1784 DPRINTFN(0, "Failure selecting configuration index %u:"
1785 "%s, port %u, addr %u (ignored)\n",
1786 config_index, usbd_errstr(err), udev->port_no,
1790 * Some USB devices do not have any configurations. Ignore any
1791 * set config failures!
1796 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1797 if ((udev->cdesc->bNumInterface < 2) &&
1798 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1799 DPRINTFN(0, "Found no endpoints, trying next config\n");
1801 goto repeat_set_config;
1803 if (config_index == 0) {
1805 * Try to figure out if we have an
1806 * auto-install disk there:
1808 if (usb_test_autoinstall(udev, 0, 0) == 0) {
1809 DPRINTFN(0, "Found possible auto-install "
1810 "disk (trying next config)\n");
1812 goto repeat_set_config;
1816 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1817 if (uaa.dev_state != UAA_DEV_READY) {
1818 /* leave device unconfigured */
1819 usb_unconfigure(udev, 0);
1823 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1824 udev->address, udev, udev->parent_hub);
1826 /* register our device - we are ready */
1827 usb_bus_port_set_device(bus, parent_hub ?
1828 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1831 /* Symlink the ugen device name */
1832 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1834 /* Announce device */
1835 printf("%s: <%s> at %s\n", udev->ugen_name, udev->manufacturer,
1836 device_get_nameunit(udev->bus->bdev));
1838 usb_notify_addq("+", udev);
1843 * Free USB device and all subdevices, if any.
1845 usb_free_device(udev, 0);
1852 static struct cdev *
1853 usb_make_dev(struct usb_device *udev, int ep, int mode)
1855 struct usb_fs_privdata* pd;
1858 /* Store information to locate ourselves again later */
1859 pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1861 pd->bus_index = device_get_unit(udev->bus->bdev);
1862 pd->dev_index = udev->device_index;
1866 /* Now, create the device itself */
1867 snprintf(devname, sizeof(devname), "%u.%u.%u",
1868 pd->bus_index, pd->dev_index, pd->ep_addr);
1869 pd->cdev = make_dev(&usb_devsw, 0, UID_ROOT,
1870 GID_OPERATOR, 0600, USB_DEVICE_DIR "/%s", devname);
1871 pd->cdev->si_drv1 = pd;
1877 usb_cdev_create(struct usb_device *udev)
1879 struct usb_config_descriptor *cd;
1880 struct usb_endpoint_descriptor *ed;
1881 struct usb_descriptor *desc;
1882 struct usb_fs_privdata* pd;
1884 int inmode, outmode, inmask, outmask, mode;
1887 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
1889 DPRINTFN(2, "Creating device nodes\n");
1891 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
1894 } else { /* USB_MODE_HOST */
1904 * Collect all used endpoint numbers instead of just
1905 * generating 16 static endpoints.
1907 cd = usbd_get_config_descriptor(udev);
1908 while ((desc = usb_desc_foreach(cd, desc))) {
1909 /* filter out all endpoint descriptors */
1910 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1911 (desc->bLength >= sizeof(*ed))) {
1912 ed = (struct usb_endpoint_descriptor *)desc;
1915 ep = ed->bEndpointAddress;
1916 if (UE_GET_DIR(ep) == UE_DIR_OUT)
1917 outmask |= 1 << UE_GET_ADDR(ep);
1919 inmask |= 1 << UE_GET_ADDR(ep);
1923 /* Create all available endpoints except EP0 */
1924 for (ep = 1; ep < 16; ep++) {
1925 mode = inmask & (1 << ep) ? inmode : 0;
1926 mode |= outmask & (1 << ep) ? outmode : 0;
1928 continue; /* no IN or OUT endpoint */
1930 dev = usb_make_dev(udev, ep, mode);
1932 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
1937 usb_cdev_free(struct usb_device *udev)
1939 struct usb_fs_privdata* pd;
1942 DPRINTFN(2, "Freeing device nodes\n");
1944 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
1945 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
1949 LIST_REMOVE(pd, pd_next);
1951 destroy_dev_sched_cb(pcdev, usb_cdev_cleanup, pd);
1956 usb_cdev_cleanup(void* arg)
1958 free(arg, M_USBDEV);
1962 /*------------------------------------------------------------------------*
1965 * This function is NULL safe and will free an USB device and its
1966 * children devices, if any.
1968 * Flag values: Reserved, set to zero.
1969 *------------------------------------------------------------------------*/
1971 usb_free_device(struct usb_device *udev, uint8_t flag)
1973 struct usb_bus *bus;
1976 return; /* already freed */
1978 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
1981 usb_set_device_state(udev, USB_STATE_DETACHED);
1984 usb_notify_addq("-", udev);
1986 printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
1987 udev->manufacturer, device_get_nameunit(bus->bdev));
1989 /* Destroy UGEN symlink, if any */
1990 if (udev->ugen_symlink) {
1991 usb_free_symlink(udev->ugen_symlink);
1992 udev->ugen_symlink = NULL;
1996 * Unregister our device first which will prevent any further
1999 usb_bus_port_set_device(bus, udev->parent_hub ?
2000 udev->parent_hub->hub->ports + udev->port_index : NULL,
2001 NULL, USB_ROOT_HUB_ADDR);
2004 /* wait for all pending references to go away: */
2005 mtx_lock(&usb_ref_lock);
2007 while (udev->refcount != 0) {
2008 cv_wait(udev->default_cv + 1, &usb_ref_lock);
2010 mtx_unlock(&usb_ref_lock);
2012 destroy_dev_sched_cb(udev->default_dev, usb_cdev_cleanup,
2013 udev->default_dev->si_drv1);
2016 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2017 /* stop receiving any control transfers (Device Side Mode) */
2018 usbd_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX);
2021 /* the following will get the device unconfigured in software */
2022 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2024 /* unsetup any leftover default USB transfers */
2025 usbd_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX);
2027 /* template unsetup, if any */
2028 (usb_temp_unsetup_p) (udev);
2031 * Make sure that our clear-stall messages are not queued
2034 USB_BUS_LOCK(udev->bus);
2035 usb_proc_mwait(&udev->bus->non_giant_callback_proc,
2036 &udev->cs_msg[0], &udev->cs_msg[1]);
2037 USB_BUS_UNLOCK(udev->bus);
2039 sx_destroy(udev->default_sx);
2040 sx_destroy(udev->default_sx + 1);
2042 cv_destroy(udev->default_cv);
2043 cv_destroy(udev->default_cv + 1);
2045 mtx_destroy(udev->default_mtx);
2047 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2051 free(udev->serial, M_USB);
2052 free(udev->manufacturer, M_USB);
2053 free(udev->product, M_USB);
2057 /*------------------------------------------------------------------------*
2060 * This function is the safe way to get the USB interface structure
2061 * pointer by interface index.
2064 * NULL: Interface not present.
2065 * Else: Pointer to USB interface structure.
2066 *------------------------------------------------------------------------*/
2067 struct usb_interface *
2068 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2070 struct usb_interface *iface = udev->ifaces + iface_index;
2072 if (iface_index >= udev->ifaces_max)
2077 /*------------------------------------------------------------------------*
2078 * usbd_find_descriptor
2080 * This function will lookup the first descriptor that matches the
2081 * criteria given by the arguments "type" and "subtype". Descriptors
2082 * will only be searched within the interface having the index
2083 * "iface_index". If the "id" argument points to an USB descriptor,
2084 * it will be skipped before the search is started. This allows
2085 * searching for multiple descriptors using the same criteria. Else
2086 * the search is started after the interface descriptor.
2089 * NULL: End of descriptors
2090 * Else: A descriptor matching the criteria
2091 *------------------------------------------------------------------------*/
2093 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2094 uint8_t type, uint8_t type_mask,
2095 uint8_t subtype, uint8_t subtype_mask)
2097 struct usb_descriptor *desc;
2098 struct usb_config_descriptor *cd;
2099 struct usb_interface *iface;
2101 cd = usbd_get_config_descriptor(udev);
2106 iface = usbd_get_iface(udev, iface_index);
2107 if (iface == NULL) {
2110 id = usbd_get_interface_descriptor(iface);
2117 while ((desc = usb_desc_foreach(cd, desc))) {
2119 if (desc->bDescriptorType == UDESC_INTERFACE) {
2122 if (((desc->bDescriptorType & type_mask) == type) &&
2123 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2130 /*------------------------------------------------------------------------*
2133 * This function will dump information from the device descriptor
2134 * belonging to the USB device pointed to by "udev", to the string
2135 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2136 * including the terminating zero.
2137 *------------------------------------------------------------------------*/
2139 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2141 struct usb_device_descriptor *udd = &udev->ddesc;
2145 bcdUSB = UGETW(udd->bcdUSB);
2146 bcdDevice = UGETW(udd->bcdDevice);
2148 if (udd->bDeviceClass != 0xFF) {
2149 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2151 udev->manufacturer, udev->product,
2152 udd->bDeviceClass, udd->bDeviceSubClass,
2153 (bcdUSB >> 8), bcdUSB & 0xFF,
2154 (bcdDevice >> 8), bcdDevice & 0xFF,
2157 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2159 udev->manufacturer, udev->product,
2160 (bcdUSB >> 8), bcdUSB & 0xFF,
2161 (bcdDevice >> 8), bcdDevice & 0xFF,
2168 * Descriptions of of known vendors and devices ("products").
2170 struct usb_knowndev {
2174 const char *vendorname;
2175 const char *productname;
2178 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2180 #include "usbdevs.h"
2181 #include "usbdevs_data.h"
2182 #endif /* USB_VERBOSE */
2185 usbd_set_device_strings(struct usb_device *udev)
2187 struct usb_device_descriptor *udd = &udev->ddesc;
2189 const struct usb_knowndev *kdp;
2194 uint16_t product_id;
2196 temp_ptr = udev->bus->scratch[0].data;
2197 temp_size = sizeof(udev->bus->scratch[0].data);
2199 vendor_id = UGETW(udd->idVendor);
2200 product_id = UGETW(udd->idProduct);
2202 /* get serial number string */
2203 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2204 udev->ddesc.iSerialNumber);
2205 udev->serial = strdup(temp_ptr, M_USB);
2207 /* get manufacturer string */
2208 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2209 udev->ddesc.iManufacturer);
2210 usb_trim_spaces(temp_ptr);
2211 if (temp_ptr[0] != '\0')
2212 udev->manufacturer = strdup(temp_ptr, M_USB);
2214 /* get product string */
2215 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2216 udev->ddesc.iProduct);
2217 usb_trim_spaces(temp_ptr);
2218 if (temp_ptr[0] != '\0')
2219 udev->product = strdup(temp_ptr, M_USB);
2222 if (udev->manufacturer == NULL || udev->product == NULL) {
2223 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2224 if (kdp->vendor == vendor_id &&
2225 (kdp->product == product_id ||
2226 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2229 if (kdp->vendorname != NULL) {
2230 /* XXX should use pointer to knowndevs string */
2231 if (udev->manufacturer == NULL) {
2232 udev->manufacturer = strdup(kdp->vendorname,
2235 if (udev->product == NULL &&
2236 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2237 udev->product = strdup(kdp->productname,
2243 /* Provide default strings if none were found */
2244 if (udev->manufacturer == NULL) {
2245 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2246 udev->manufacturer = strdup(temp_ptr, M_USB);
2248 if (udev->product == NULL) {
2249 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2250 udev->product = strdup(temp_ptr, M_USB);
2259 usbd_get_mode(struct usb_device *udev)
2261 return (udev->flags.usb_mode);
2266 * See: USB_SPEED_XXX
2269 usbd_get_speed(struct usb_device *udev)
2271 return (udev->speed);
2275 usbd_get_isoc_fps(struct usb_device *udev)
2278 switch (udev->speed) {
2280 case USB_SPEED_FULL:
2287 struct usb_device_descriptor *
2288 usbd_get_device_descriptor(struct usb_device *udev)
2291 return (NULL); /* be NULL safe */
2292 return (&udev->ddesc);
2295 struct usb_config_descriptor *
2296 usbd_get_config_descriptor(struct usb_device *udev)
2299 return (NULL); /* be NULL safe */
2300 return (udev->cdesc);
2303 /*------------------------------------------------------------------------*
2304 * usb_test_quirk - test a device for a given quirk
2307 * 0: The USB device does not have the given quirk.
2308 * Else: The USB device has the given quirk.
2309 *------------------------------------------------------------------------*/
2311 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2315 found = (usb_test_quirk_p) (&uaa->info, quirk);
2319 struct usb_interface_descriptor *
2320 usbd_get_interface_descriptor(struct usb_interface *iface)
2323 return (NULL); /* be NULL safe */
2324 return (iface->idesc);
2328 usbd_get_interface_altindex(struct usb_interface *iface)
2330 return (iface->alt_index);
2334 usbd_get_bus_index(struct usb_device *udev)
2336 return ((uint8_t)device_get_unit(udev->bus->bdev));
2340 usbd_get_device_index(struct usb_device *udev)
2342 return (udev->device_index);
2346 /*------------------------------------------------------------------------*
2349 * This function will generate events for dev.
2350 *------------------------------------------------------------------------*/
2352 usb_notify_addq(const char *type, struct usb_device *udev)
2355 struct malloc_type *mt;
2356 const size_t buf_size = 512;
2358 mtx_lock(&malloc_mtx);
2359 mt = malloc_desc2type("bus"); /* XXX M_BUS */
2360 mtx_unlock(&malloc_mtx);
2364 data = malloc(buf_size, mt, M_NOWAIT);
2368 /* String it all together. */
2369 snprintf(data, buf_size,
2375 "devsubclass=0x%02x "
2384 UGETW(udev->ddesc.idVendor),
2385 UGETW(udev->ddesc.idProduct),
2386 udev->ddesc.bDeviceClass,
2387 udev->ddesc.bDeviceSubClass,
2389 UGETW(udev->ddesc.bcdDevice),
2391 udev->parent_hub != NULL ?
2392 udev->parent_hub->ugen_name :
2393 device_get_nameunit(device_get_parent(udev->bus->bdev)));
2395 devctl_queue_data(data);
2398 /*------------------------------------------------------------------------*
2399 * usb_fifo_free_wrap
2401 * This function will free the FIFOs.
2403 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2404 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2405 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2406 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2407 * control endpoint FIFOs. If "iface_index" is not set to
2408 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2409 *------------------------------------------------------------------------*/
2411 usb_fifo_free_wrap(struct usb_device *udev,
2412 uint8_t iface_index, uint8_t flag)
2418 * Free any USB FIFOs on the given interface:
2420 for (i = 0; i != USB_FIFO_MAX; i++) {
2425 /* Check if the interface index matches */
2426 if (iface_index == f->iface_index) {
2427 if (f->methods != &usb_ugen_methods) {
2429 * Don't free any non-generic FIFOs in
2434 if ((f->dev_ep_index == 0) &&
2435 (f->fs_xfer == NULL)) {
2436 /* no need to free this FIFO */
2439 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2440 if ((f->methods == &usb_ugen_methods) &&
2441 (f->dev_ep_index == 0) &&
2442 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2443 (f->fs_xfer == NULL)) {
2444 /* no need to free this FIFO */
2448 /* no need to free this FIFO */
2451 /* free this FIFO */
2457 /*------------------------------------------------------------------------*
2458 * usb_peer_can_wakeup
2461 * 0: Peer cannot do resume signalling.
2462 * Else: Peer can do resume signalling.
2463 *------------------------------------------------------------------------*/
2465 usb_peer_can_wakeup(struct usb_device *udev)
2467 const struct usb_config_descriptor *cdp;
2470 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2471 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2473 return (0); /* not supported */
2477 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2480 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2482 DPRINTF("udev %p state %s -> %s\n", udev,
2483 usb_statestr(udev->state), usb_statestr(state));
2484 udev->state = state;
2488 usbd_device_attached(struct usb_device *udev)
2490 return (udev->state > USB_STATE_DETACHED);
2493 /* The following function locks enumerating the given USB device. */
2496 usbd_enum_lock(struct usb_device *udev)
2498 sx_xlock(udev->default_sx + 1);
2500 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2501 * are locked before locking Giant. Else the lock can be
2502 * locked multiple times.
2507 /* The following function unlocks enumerating the given USB device. */
2510 usbd_enum_unlock(struct usb_device *udev)
2513 sx_xunlock(udev->default_sx + 1);
2517 * The following function checks the enumerating lock for the given
2522 usbd_enum_is_locked(struct usb_device *udev)
2524 return (sx_xlocked(udev->default_sx + 1));