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,
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,
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,
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 /* default setting */
754 iface->parent_iface_index = USB_IFACE_INDEX_ANY;
755 /* set alternate index */
756 iface->alt_index = alt_index;
759 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
761 ed = (struct usb_endpoint_descriptor *)id;
765 /* iterate all the endpoint descriptors */
766 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
768 if (temp == USB_EP_MAX)
771 ep = udev->endpoints + temp;
776 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
778 DPRINTFN(5, "Found endpoint companion descriptor\n");
780 usb_init_endpoint(udev,
781 ips.iface_index, ed, ecomp, ep);
786 /* find maximum number of endpoints */
791 id = (struct usb_interface_descriptor *)ed;
795 /* NOTE: It is valid to have no interfaces and no endpoints! */
797 if (cmd == USB_CFG_ALLOC) {
798 udev->ifaces_max = ips.iface_index;
800 if (udev->ifaces_max != 0) {
801 udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max,
802 M_USB, M_WAITOK | M_ZERO);
803 if (udev->ifaces == NULL) {
809 udev->endpoints = malloc(sizeof(*ep) * ep_max,
810 M_USB, M_WAITOK | M_ZERO);
811 if (udev->endpoints == NULL) {
816 udev->endpoints = NULL;
818 USB_BUS_LOCK(udev->bus);
819 udev->endpoints_max = ep_max;
820 /* reset any ongoing clear-stall */
821 udev->ep_curr = NULL;
822 USB_BUS_UNLOCK(udev->bus);
827 if (cmd == USB_CFG_ALLOC) {
829 USB_BUS_LOCK(udev->bus);
830 udev->endpoints_max = 0;
831 /* reset any ongoing clear-stall */
832 udev->ep_curr = NULL;
833 USB_BUS_UNLOCK(udev->bus);
836 if (udev->ifaces != NULL)
837 free(udev->ifaces, M_USB);
838 if (udev->endpoints != NULL)
839 free(udev->endpoints, M_USB);
842 udev->endpoints = NULL;
843 udev->ifaces_max = 0;
849 /*------------------------------------------------------------------------*
850 * usbd_set_alt_interface_index
852 * This function will select an alternate interface index for the
853 * given interface index. The interface should not be in use when this
854 * function is called. That means there should not be any open USB
855 * transfers. Else an error is returned. If the alternate setting is
856 * already set this function will simply return success. This function
857 * is called in Host mode and Device mode!
862 *------------------------------------------------------------------------*/
864 usbd_set_alt_interface_index(struct usb_device *udev,
865 uint8_t iface_index, uint8_t alt_index)
867 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
871 /* automatic locking */
872 if (usbd_enum_is_locked(udev)) {
876 usbd_enum_lock(udev);
882 if (iface->alt_index == alt_index) {
884 * Optimise away duplicate setting of
885 * alternate setting in USB Host Mode!
892 * Free all generic FIFOs for this interface, except control
895 usb_fifo_free_wrap(udev, iface_index, 0);
898 err = usb_config_parse(udev, iface_index, alt_index);
902 if (iface->alt_index != alt_index) {
903 /* the alternate setting does not exist */
908 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
909 iface->idesc->bAlternateSetting);
913 usbd_enum_unlock(udev);
918 /*------------------------------------------------------------------------*
919 * usbd_set_endpoint_stall
921 * This function is used to make a BULK or INTERRUPT endpoint send
922 * STALL tokens in USB device mode.
927 *------------------------------------------------------------------------*/
929 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
932 struct usb_xfer *xfer;
938 DPRINTF("Cannot find endpoint\n");
940 * Pretend that the clear or set stall request is
941 * successful else some USB host stacks can do
942 * strange things, especially when a control endpoint
947 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
949 if ((et != UE_BULK) &&
950 (et != UE_INTERRUPT)) {
952 * Should not stall control
953 * nor isochronous endpoints.
955 DPRINTF("Invalid endpoint\n");
958 USB_BUS_LOCK(udev->bus);
960 /* store current stall state */
961 was_stalled = ep->is_stalled;
963 /* check for no change */
964 if (was_stalled && do_stall) {
965 /* if the endpoint is already stalled do nothing */
966 USB_BUS_UNLOCK(udev->bus);
967 DPRINTF("No change\n");
970 /* set stalled state */
973 if (do_stall || (!was_stalled)) {
975 /* lookup the current USB transfer, if any */
976 xfer = ep->endpoint_q.curr;
982 * If "xfer" is non-NULL the "set_stall" method will
983 * complete the USB transfer like in case of a timeout
984 * setting the error code "USB_ERR_STALLED".
986 (udev->bus->methods->set_stall) (udev, xfer, ep, &do_stall);
989 ep->toggle_next = 0; /* reset data toggle */
990 ep->is_stalled = 0; /* clear stalled state */
992 (udev->bus->methods->clear_stall) (udev, ep);
994 /* start up the current or next transfer, if any */
995 usb_command_wrapper(&ep->endpoint_q, ep->endpoint_q.curr);
997 USB_BUS_UNLOCK(udev->bus);
1001 /*------------------------------------------------------------------------*
1002 * usb_reset_iface_endpoints - used in USB device side mode
1003 *------------------------------------------------------------------------*/
1005 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1007 struct usb_endpoint *ep;
1008 struct usb_endpoint *ep_end;
1010 ep = udev->endpoints;
1011 ep_end = udev->endpoints + udev->endpoints_max;
1013 for (; ep != ep_end; ep++) {
1015 if ((ep->edesc == NULL) ||
1016 (ep->iface_index != iface_index)) {
1019 /* simulate a clear stall from the peer */
1020 usbd_set_endpoint_stall(udev, ep, 0);
1025 /*------------------------------------------------------------------------*
1026 * usb_detach_device_sub
1028 * This function will try to detach an USB device. If it fails a panic
1031 * Flag values, see "USB_UNCFG_FLAG_XXX".
1032 *------------------------------------------------------------------------*/
1034 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1035 char **ppnpinfo, uint8_t flag)
1044 * NOTE: It is important to clear "*ppdev" before deleting
1045 * the child due to some device methods being called late
1046 * during the delete process !
1050 device_printf(dev, "at %s, port %d, addr %d "
1052 device_get_nameunit(udev->parent_dev),
1053 udev->port_no, udev->address);
1055 if (device_is_attached(dev)) {
1056 if (udev->flags.peer_suspended) {
1057 err = DEVICE_RESUME(dev);
1059 device_printf(dev, "Resume failed\n");
1062 if (device_detach(dev)) {
1066 if (device_delete_child(udev->parent_dev, dev)) {
1071 pnpinfo = *ppnpinfo;
1072 if (pnpinfo != NULL) {
1074 free(pnpinfo, M_USBDEV);
1079 /* Detach is not allowed to fail in the USB world */
1080 panic("usb_detach_device_sub: A USB driver would not detach\n");
1083 /*------------------------------------------------------------------------*
1086 * The following function will detach the matching interfaces.
1087 * This function is NULL safe.
1089 * Flag values, see "USB_UNCFG_FLAG_XXX".
1090 *------------------------------------------------------------------------*/
1092 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1095 struct usb_interface *iface;
1102 DPRINTFN(4, "udev=%p\n", udev);
1104 sx_assert(&udev->enum_sx, SA_LOCKED);
1107 * First detach the child to give the child's detach routine a
1108 * chance to detach the sub-devices in the correct order.
1109 * Then delete the child using "device_delete_child()" which
1110 * will detach all sub-devices from the bottom and upwards!
1112 if (iface_index != USB_IFACE_INDEX_ANY) {
1114 iface_index = i + 1;
1117 iface_index = USB_IFACE_MAX;
1122 for (; i != iface_index; i++) {
1124 iface = usbd_get_iface(udev, i);
1125 if (iface == NULL) {
1126 /* looks like the end of the USB interfaces */
1129 usb_detach_device_sub(udev, &iface->subdev,
1130 &iface->pnpinfo, flag);
1134 /*------------------------------------------------------------------------*
1135 * usb_probe_and_attach_sub
1140 *------------------------------------------------------------------------*/
1142 usb_probe_and_attach_sub(struct usb_device *udev,
1143 struct usb_attach_arg *uaa)
1145 struct usb_interface *iface;
1150 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1151 /* leave interface alone */
1154 dev = iface->subdev;
1157 /* clean up after module unload */
1159 if (device_is_attached(dev)) {
1160 /* already a device there */
1163 /* clear "iface->subdev" as early as possible */
1165 iface->subdev = NULL;
1167 if (device_delete_child(udev->parent_dev, dev)) {
1170 * Panic here, else one can get a double call
1171 * to device_detach(). USB devices should
1172 * never fail on detach!
1174 panic("device_delete_child() failed\n");
1177 if (uaa->temp_dev == NULL) {
1179 /* create a new child */
1180 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1181 if (uaa->temp_dev == NULL) {
1182 device_printf(udev->parent_dev,
1183 "Device creation failed\n");
1184 return (1); /* failure */
1186 device_set_ivars(uaa->temp_dev, uaa);
1187 device_quiet(uaa->temp_dev);
1190 * Set "subdev" before probe and attach so that "devd" gets
1191 * the information it needs.
1193 iface->subdev = uaa->temp_dev;
1195 if (device_probe_and_attach(iface->subdev) == 0) {
1197 * The USB attach arguments are only available during probe
1200 uaa->temp_dev = NULL;
1201 device_set_ivars(iface->subdev, NULL);
1203 if (udev->flags.peer_suspended) {
1204 err = DEVICE_SUSPEND(iface->subdev);
1206 device_printf(iface->subdev, "Suspend failed\n");
1208 return (0); /* success */
1210 /* No USB driver found */
1211 iface->subdev = NULL;
1213 return (1); /* failure */
1216 /*------------------------------------------------------------------------*
1217 * usbd_set_parent_iface
1219 * Using this function will lock the alternate interface setting on an
1220 * interface. It is typically used for multi interface drivers. In USB
1221 * device side mode it is assumed that the alternate interfaces all
1222 * have the same endpoint descriptors. The default parent index value
1223 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1225 *------------------------------------------------------------------------*/
1227 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1228 uint8_t parent_index)
1230 struct usb_interface *iface;
1232 iface = usbd_get_iface(udev, iface_index);
1234 iface->parent_iface_index = parent_index;
1239 usb_init_attach_arg(struct usb_device *udev,
1240 struct usb_attach_arg *uaa)
1242 memset(uaa, 0, sizeof(*uaa));
1245 uaa->usb_mode = udev->flags.usb_mode;
1246 uaa->port = udev->port_no;
1247 uaa->dev_state = UAA_DEV_READY;
1249 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1250 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1251 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1252 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1253 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1254 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1255 uaa->info.bConfigIndex = udev->curr_config_index;
1256 uaa->info.bConfigNum = udev->curr_config_no;
1259 /*------------------------------------------------------------------------*
1260 * usb_probe_and_attach
1262 * This function is called from "uhub_explore_sub()",
1263 * "usb_handle_set_config()" and "usb_handle_request()".
1267 * Else: A control transfer failed
1268 *------------------------------------------------------------------------*/
1270 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1272 struct usb_attach_arg uaa;
1273 struct usb_interface *iface;
1279 DPRINTF("udev == NULL\n");
1280 return (USB_ERR_INVAL);
1282 /* automatic locking */
1283 if (usbd_enum_is_locked(udev)) {
1287 usbd_enum_lock(udev);
1290 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1291 /* do nothing - no configuration has been set */
1294 /* setup USB attach arguments */
1296 usb_init_attach_arg(udev, &uaa);
1299 * If the whole USB device is targeted, invoke the USB event
1302 if (iface_index == USB_IFACE_INDEX_ANY) {
1304 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1306 if (uaa.dev_state != UAA_DEV_READY) {
1307 /* leave device unconfigured */
1308 usb_unconfigure(udev, 0);
1313 /* Check if only one interface should be probed: */
1314 if (iface_index != USB_IFACE_INDEX_ANY) {
1322 /* Do the probe and attach */
1323 for (; i != j; i++) {
1325 iface = usbd_get_iface(udev, i);
1326 if (iface == NULL) {
1328 * Looks like the end of the USB
1331 DPRINTFN(2, "end of interfaces "
1335 if (iface->idesc == NULL) {
1336 /* no interface descriptor */
1341 uaa.info.bInterfaceClass =
1342 iface->idesc->bInterfaceClass;
1343 uaa.info.bInterfaceSubClass =
1344 iface->idesc->bInterfaceSubClass;
1345 uaa.info.bInterfaceProtocol =
1346 iface->idesc->bInterfaceProtocol;
1347 uaa.info.bIfaceIndex = i;
1348 uaa.info.bIfaceNum =
1349 iface->idesc->bInterfaceNumber;
1350 uaa.driver_info = 0; /* reset driver_info */
1352 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1353 uaa.info.bInterfaceClass,
1354 uaa.info.bInterfaceSubClass,
1355 uaa.info.bInterfaceProtocol,
1356 uaa.info.bIfaceIndex,
1357 uaa.info.bIfaceNum);
1359 usb_probe_and_attach_sub(udev, &uaa);
1362 * Remove the leftover child, if any, to enforce that
1363 * a new nomatch devd event is generated for the next
1364 * interface if no driver is found:
1366 if (uaa.temp_dev == NULL)
1368 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1369 DPRINTFN(0, "device delete child failed\n");
1370 uaa.temp_dev = NULL;
1374 usbd_enum_unlock(udev);
1379 /*------------------------------------------------------------------------*
1380 * usb_suspend_resume_sub
1382 * This function is called when the suspend or resume methods should
1383 * be executed on an USB device.
1384 *------------------------------------------------------------------------*/
1386 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1393 if (!device_is_attached(dev)) {
1397 err = DEVICE_SUSPEND(dev);
1399 err = DEVICE_RESUME(dev);
1402 device_printf(dev, "%s failed\n",
1403 do_suspend ? "Suspend" : "Resume");
1407 /*------------------------------------------------------------------------*
1408 * usb_suspend_resume
1410 * The following function will suspend or resume the USB device.
1415 *------------------------------------------------------------------------*/
1417 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1419 struct usb_interface *iface;
1426 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1428 sx_assert(&udev->sr_sx, SA_LOCKED);
1430 USB_BUS_LOCK(udev->bus);
1431 /* filter the suspend events */
1432 if (udev->flags.peer_suspended == do_suspend) {
1433 USB_BUS_UNLOCK(udev->bus);
1437 udev->flags.peer_suspended = do_suspend;
1438 USB_BUS_UNLOCK(udev->bus);
1440 /* do the suspend or resume */
1442 for (i = 0; i != USB_IFACE_MAX; i++) {
1444 iface = usbd_get_iface(udev, i);
1445 if (iface == NULL) {
1446 /* looks like the end of the USB interfaces */
1449 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1454 /*------------------------------------------------------------------------*
1455 * usbd_clear_stall_proc
1457 * This function performs generic USB clear stall operations.
1458 *------------------------------------------------------------------------*/
1460 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1462 struct usb_clear_stall_msg *pm = (void *)_pm;
1463 struct usb_device *udev = pm->udev;
1466 USB_BUS_UNLOCK(udev->bus);
1467 mtx_lock(&udev->device_mtx);
1469 /* Start clear stall callback */
1470 usbd_transfer_start(udev->ctrl_xfer[1]);
1473 mtx_unlock(&udev->device_mtx);
1474 USB_BUS_LOCK(udev->bus);
1477 /*------------------------------------------------------------------------*
1480 * This function allocates a new USB device. This function is called
1481 * when a new device has been put in the powered state, but not yet in
1482 * the addressed state. Get initial descriptor, set the address, get
1483 * full descriptor and get strings.
1488 *------------------------------------------------------------------------*/
1490 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1491 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1492 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1494 struct usb_attach_arg uaa;
1495 struct usb_device *udev;
1496 struct usb_device *adev;
1497 struct usb_device *hub;
1498 uint8_t *scratch_ptr;
1499 size_t scratch_size;
1501 uint8_t device_index;
1502 uint8_t config_index;
1503 uint8_t config_quirk;
1504 uint8_t set_config_failed;
1506 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1507 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1508 parent_dev, bus, parent_hub, depth, port_index, port_no,
1512 * Find an unused device index. In USB Host mode this is the
1513 * same as the device address.
1515 * Device index zero is not used and device index 1 should
1516 * always be the root hub.
1518 for (device_index = USB_ROOT_HUB_ADDR;
1519 (device_index != bus->devices_max) &&
1520 (bus->devices[device_index] != NULL);
1521 device_index++) /* nop */;
1523 if (device_index == bus->devices_max) {
1524 device_printf(bus->bdev,
1525 "No free USB device index for new device\n");
1530 device_printf(bus->bdev,
1531 "Invalid device depth\n");
1534 udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1538 /* initialise our SX-lock */
1539 sx_init_flags(&udev->ctrl_sx, "USB device SX lock", SX_DUPOK);
1541 /* initialise our SX-lock */
1542 sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1543 sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS);
1545 cv_init(&udev->ctrlreq_cv, "WCTRL");
1546 cv_init(&udev->ref_cv, "UGONE");
1548 /* initialise our mutex */
1549 mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF);
1551 /* initialise generic clear stall */
1552 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1553 udev->cs_msg[0].udev = udev;
1554 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1555 udev->cs_msg[1].udev = udev;
1557 /* initialise some USB device fields */
1558 udev->parent_hub = parent_hub;
1559 udev->parent_dev = parent_dev;
1560 udev->port_index = port_index;
1561 udev->port_no = port_no;
1562 udev->depth = depth;
1564 udev->address = USB_START_ADDR; /* default value */
1565 udev->plugtime = (usb_ticks_t)ticks;
1567 * We need to force the power mode to "on" because there are plenty
1568 * of USB devices out there that do not work very well with
1569 * automatic suspend and resume!
1571 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1572 udev->pwr_save.last_xfer_time = ticks;
1573 /* we are not ready yet */
1576 /* set up default endpoint descriptor */
1577 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1578 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1579 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1580 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1581 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1582 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1583 udev->ctrl_ep_desc.bInterval = 0;
1585 /* set up default endpoint companion descriptor */
1586 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1587 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1589 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1591 udev->speed = speed;
1592 udev->flags.usb_mode = mode;
1594 /* search for our High Speed USB HUB, if any */
1597 hub = udev->parent_hub;
1600 if (hub->speed == USB_SPEED_HIGH) {
1601 udev->hs_hub_addr = hub->address;
1602 udev->parent_hs_hub = hub;
1603 udev->hs_port_no = adev->port_no;
1607 hub = hub->parent_hub;
1610 /* init the default endpoint */
1611 usb_init_endpoint(udev, 0,
1612 &udev->ctrl_ep_desc,
1613 &udev->ctrl_ep_comp_desc,
1616 /* set device index */
1617 udev->device_index = device_index;
1620 /* Create ugen name */
1621 snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1622 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1624 LIST_INIT(&udev->pd_list);
1626 /* Create the control endpoint device */
1627 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1628 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1630 /* Create a link from /dev/ugenX.X to the default endpoint */
1631 if (udev->ctrl_dev != NULL)
1632 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1634 /* Initialise device */
1635 if (bus->methods->device_init != NULL) {
1636 err = (bus->methods->device_init) (udev);
1638 DPRINTFN(0, "device init %d failed "
1639 "(%s, ignored)\n", device_index,
1644 /* set powered device state after device init is complete */
1645 usb_set_device_state(udev, USB_STATE_POWERED);
1647 if (udev->flags.usb_mode == USB_MODE_HOST) {
1649 err = usbd_req_set_address(udev, NULL, device_index);
1652 * This is the new USB device address from now on, if
1653 * the set address request didn't set it already.
1655 if (udev->address == USB_START_ADDR)
1656 udev->address = device_index;
1659 * We ignore any set-address errors, hence there are
1660 * buggy USB devices out there that actually receive
1661 * the SETUP PID, but manage to set the address before
1662 * the STATUS stage is ACK'ed. If the device responds
1663 * to the subsequent get-descriptor at the new
1664 * address, then we know that the set-address command
1668 DPRINTFN(0, "set address %d failed "
1669 "(%s, ignored)\n", udev->address,
1673 /* We are not self powered */
1674 udev->flags.self_powered = 0;
1676 /* Set unconfigured state */
1677 udev->curr_config_no = USB_UNCONFIG_NO;
1678 udev->curr_config_index = USB_UNCONFIG_INDEX;
1680 /* Setup USB descriptors */
1681 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1683 DPRINTFN(0, "setting up USB template failed maybe the USB "
1684 "template module has not been loaded\n");
1688 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1690 /* setup the device descriptor and the initial "wMaxPacketSize" */
1691 err = usbd_setup_device_desc(udev, NULL);
1694 /* XXX try to re-enumerate the device */
1695 err = usbd_req_re_enumerate(udev, NULL);
1701 * Setup temporary USB attach args so that we can figure out some
1702 * basic quirks for this device.
1704 usb_init_attach_arg(udev, &uaa);
1706 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1707 udev->flags.uq_bus_powered = 1;
1709 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1710 udev->flags.no_strings = 1;
1713 * Workaround for buggy USB devices.
1715 * It appears that some string-less USB chips will crash and
1716 * disappear if any attempts are made to read any string
1719 * Try to detect such chips by checking the strings in the USB
1720 * device descriptor. If no strings are present there we
1721 * simply disable all USB strings.
1723 scratch_ptr = udev->bus->scratch[0].data;
1724 scratch_size = sizeof(udev->bus->scratch[0].data);
1726 if (udev->ddesc.iManufacturer ||
1727 udev->ddesc.iProduct ||
1728 udev->ddesc.iSerialNumber) {
1729 /* read out the language ID string */
1730 err = usbd_req_get_string_desc(udev, NULL,
1731 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1733 err = USB_ERR_INVAL;
1736 if (err || (scratch_ptr[0] < 4)) {
1737 udev->flags.no_strings = 1;
1744 /* load preferred value and mask */
1746 mask = usb_lang_mask;
1748 /* align length correctly */
1749 scratch_ptr[0] &= ~1;
1751 /* fix compiler warning */
1754 /* search for preferred language */
1755 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1756 langid = UGETW(scratch_ptr + x);
1757 if ((langid & mask) == pref)
1760 if (x >= scratch_ptr[0]) {
1761 /* pick the first language as the default */
1762 DPRINTFN(1, "Using first language\n");
1763 langid = UGETW(scratch_ptr + 2);
1766 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1767 udev->langid = langid;
1770 /* assume 100mA bus powered for now. Changed when configured. */
1771 udev->power = USB_MIN_POWER;
1772 /* fetch the vendor and product strings from the device */
1773 usbd_set_device_strings(udev);
1775 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1776 /* USB device mode setup is complete */
1782 * Most USB devices should attach to config index 0 by
1785 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1788 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1791 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1794 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1797 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1805 set_config_failed = 0;
1808 DPRINTF("setting config %u\n", config_index);
1810 /* get the USB device configured */
1811 err = usbd_set_config_index(udev, config_index);
1813 if (udev->ddesc.bNumConfigurations != 0) {
1814 if (!set_config_failed) {
1815 set_config_failed = 1;
1816 /* XXX try to re-enumerate the device */
1817 err = usbd_req_re_enumerate(udev, NULL);
1819 goto repeat_set_config;
1821 DPRINTFN(0, "Failure selecting configuration index %u:"
1822 "%s, port %u, addr %u (ignored)\n",
1823 config_index, usbd_errstr(err), udev->port_no,
1827 * Some USB devices do not have any configurations. Ignore any
1828 * set config failures!
1833 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1834 if ((udev->cdesc->bNumInterface < 2) &&
1835 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1836 DPRINTFN(0, "Found no endpoints, trying next config\n");
1838 goto repeat_set_config;
1840 if (config_index == 0) {
1842 * Try to figure out if we have an
1843 * auto-install disk there:
1845 if (usb_iface_is_cdrom(udev, 0)) {
1846 DPRINTFN(0, "Found possible auto-install "
1847 "disk (trying next config)\n");
1849 goto repeat_set_config;
1853 if (set_config_failed == 0 && config_index == 0 &&
1854 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1855 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1858 * Try to figure out if there are any MSC quirks we
1859 * should apply automatically:
1861 err = usb_msc_auto_quirk(udev, 0);
1864 set_config_failed = 1;
1865 goto repeat_set_config;
1870 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1871 udev->address, udev, udev->parent_hub);
1873 /* register our device - we are ready */
1874 usb_bus_port_set_device(bus, parent_hub ?
1875 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1878 /* Symlink the ugen device name */
1879 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1881 /* Announce device */
1882 printf("%s: <%s> at %s\n", udev->ugen_name,
1883 usb_get_manufacturer(udev),
1884 device_get_nameunit(udev->bus->bdev));
1888 usb_notify_addq("ATTACH", udev);
1893 * Free USB device and all subdevices, if any.
1895 usb_free_device(udev, 0);
1902 struct usb_fs_privdata *
1903 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1904 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1906 struct usb_fs_privdata* pd;
1909 /* Store information to locate ourselves again later */
1910 pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1912 pd->bus_index = device_get_unit(udev->bus->bdev);
1913 pd->dev_index = udev->device_index;
1915 pd->fifo_index = fi;
1918 /* Now, create the device itself */
1919 if (devname == NULL) {
1921 snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1922 pd->bus_index, pd->dev_index, pd->ep_addr);
1925 pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname);
1927 if (pd->cdev == NULL) {
1928 DPRINTFN(0, "Failed to create device %s\n", devname);
1933 /* XXX setting si_drv1 and creating the device is not atomic! */
1934 pd->cdev->si_drv1 = pd;
1940 usb_destroy_dev(struct usb_fs_privdata *pd)
1945 destroy_dev(pd->cdev);
1951 usb_cdev_create(struct usb_device *udev)
1953 struct usb_config_descriptor *cd;
1954 struct usb_endpoint_descriptor *ed;
1955 struct usb_descriptor *desc;
1956 struct usb_fs_privdata* pd;
1957 int inmode, outmode, inmask, outmask, mode;
1960 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
1962 DPRINTFN(2, "Creating device nodes\n");
1964 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
1967 } else { /* USB_MODE_HOST */
1977 * Collect all used endpoint numbers instead of just
1978 * generating 16 static endpoints.
1980 cd = usbd_get_config_descriptor(udev);
1981 while ((desc = usb_desc_foreach(cd, desc))) {
1982 /* filter out all endpoint descriptors */
1983 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1984 (desc->bLength >= sizeof(*ed))) {
1985 ed = (struct usb_endpoint_descriptor *)desc;
1988 ep = ed->bEndpointAddress;
1989 if (UE_GET_DIR(ep) == UE_DIR_OUT)
1990 outmask |= 1 << UE_GET_ADDR(ep);
1992 inmask |= 1 << UE_GET_ADDR(ep);
1996 /* Create all available endpoints except EP0 */
1997 for (ep = 1; ep < 16; ep++) {
1998 mode = (inmask & (1 << ep)) ? inmode : 0;
1999 mode |= (outmask & (1 << ep)) ? outmode : 0;
2001 continue; /* no IN or OUT endpoint */
2003 pd = usb_make_dev(udev, NULL, ep, 0,
2004 mode, UID_ROOT, GID_OPERATOR, 0600);
2007 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2012 usb_cdev_free(struct usb_device *udev)
2014 struct usb_fs_privdata* pd;
2016 DPRINTFN(2, "Freeing device nodes\n");
2018 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2019 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2021 LIST_REMOVE(pd, pd_next);
2023 usb_destroy_dev(pd);
2028 /*------------------------------------------------------------------------*
2031 * This function is NULL safe and will free an USB device and its
2032 * children devices, if any.
2034 * Flag values: Reserved, set to zero.
2035 *------------------------------------------------------------------------*/
2037 usb_free_device(struct usb_device *udev, uint8_t flag)
2039 struct usb_bus *bus;
2042 return; /* already freed */
2044 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2047 usb_set_device_state(udev, USB_STATE_DETACHED);
2050 usb_notify_addq("DETACH", udev);
2054 printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2055 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2057 /* Destroy UGEN symlink, if any */
2058 if (udev->ugen_symlink) {
2059 usb_free_symlink(udev->ugen_symlink);
2060 udev->ugen_symlink = NULL;
2064 * Unregister our device first which will prevent any further
2067 usb_bus_port_set_device(bus, udev->parent_hub ?
2068 udev->parent_hub->hub->ports + udev->port_index : NULL,
2069 NULL, USB_ROOT_HUB_ADDR);
2072 /* wait for all pending references to go away: */
2073 mtx_lock(&usb_ref_lock);
2075 while (udev->refcount != 0) {
2076 cv_wait(&udev->ref_cv, &usb_ref_lock);
2078 mtx_unlock(&usb_ref_lock);
2080 usb_destroy_dev(udev->ctrl_dev);
2083 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2084 /* stop receiving any control transfers (Device Side Mode) */
2085 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2088 /* the following will get the device unconfigured in software */
2089 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2091 /* unsetup any leftover default USB transfers */
2092 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2094 /* template unsetup, if any */
2095 (usb_temp_unsetup_p) (udev);
2098 * Make sure that our clear-stall messages are not queued
2101 USB_BUS_LOCK(udev->bus);
2102 usb_proc_mwait(&udev->bus->non_giant_callback_proc,
2103 &udev->cs_msg[0], &udev->cs_msg[1]);
2104 USB_BUS_UNLOCK(udev->bus);
2106 sx_destroy(&udev->ctrl_sx);
2107 sx_destroy(&udev->enum_sx);
2108 sx_destroy(&udev->sr_sx);
2110 cv_destroy(&udev->ctrlreq_cv);
2111 cv_destroy(&udev->ref_cv);
2113 mtx_destroy(&udev->device_mtx);
2115 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2118 /* Uninitialise device */
2119 if (bus->methods->device_uninit != NULL)
2120 (bus->methods->device_uninit) (udev);
2123 free(udev->serial, M_USB);
2124 free(udev->manufacturer, M_USB);
2125 free(udev->product, M_USB);
2129 /*------------------------------------------------------------------------*
2132 * This function is the safe way to get the USB interface structure
2133 * pointer by interface index.
2136 * NULL: Interface not present.
2137 * Else: Pointer to USB interface structure.
2138 *------------------------------------------------------------------------*/
2139 struct usb_interface *
2140 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2142 struct usb_interface *iface = udev->ifaces + iface_index;
2144 if (iface_index >= udev->ifaces_max)
2149 /*------------------------------------------------------------------------*
2150 * usbd_find_descriptor
2152 * This function will lookup the first descriptor that matches the
2153 * criteria given by the arguments "type" and "subtype". Descriptors
2154 * will only be searched within the interface having the index
2155 * "iface_index". If the "id" argument points to an USB descriptor,
2156 * it will be skipped before the search is started. This allows
2157 * searching for multiple descriptors using the same criteria. Else
2158 * the search is started after the interface descriptor.
2161 * NULL: End of descriptors
2162 * Else: A descriptor matching the criteria
2163 *------------------------------------------------------------------------*/
2165 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2166 uint8_t type, uint8_t type_mask,
2167 uint8_t subtype, uint8_t subtype_mask)
2169 struct usb_descriptor *desc;
2170 struct usb_config_descriptor *cd;
2171 struct usb_interface *iface;
2173 cd = usbd_get_config_descriptor(udev);
2178 iface = usbd_get_iface(udev, iface_index);
2179 if (iface == NULL) {
2182 id = usbd_get_interface_descriptor(iface);
2189 while ((desc = usb_desc_foreach(cd, desc))) {
2191 if (desc->bDescriptorType == UDESC_INTERFACE) {
2194 if (((desc->bDescriptorType & type_mask) == type) &&
2195 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2202 /*------------------------------------------------------------------------*
2205 * This function will dump information from the device descriptor
2206 * belonging to the USB device pointed to by "udev", to the string
2207 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2208 * including the terminating zero.
2209 *------------------------------------------------------------------------*/
2211 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2213 struct usb_device_descriptor *udd = &udev->ddesc;
2217 bcdUSB = UGETW(udd->bcdUSB);
2218 bcdDevice = UGETW(udd->bcdDevice);
2220 if (udd->bDeviceClass != 0xFF) {
2221 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2223 usb_get_manufacturer(udev),
2224 usb_get_product(udev),
2225 udd->bDeviceClass, udd->bDeviceSubClass,
2226 (bcdUSB >> 8), bcdUSB & 0xFF,
2227 (bcdDevice >> 8), bcdDevice & 0xFF,
2230 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2232 usb_get_manufacturer(udev),
2233 usb_get_product(udev),
2234 (bcdUSB >> 8), bcdUSB & 0xFF,
2235 (bcdDevice >> 8), bcdDevice & 0xFF,
2242 * Descriptions of of known vendors and devices ("products").
2244 struct usb_knowndev {
2248 const char *vendorname;
2249 const char *productname;
2252 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2254 #include "usbdevs.h"
2255 #include "usbdevs_data.h"
2256 #endif /* USB_VERBOSE */
2259 usbd_set_device_strings(struct usb_device *udev)
2261 struct usb_device_descriptor *udd = &udev->ddesc;
2263 const struct usb_knowndev *kdp;
2268 uint16_t product_id;
2270 temp_ptr = (char *)udev->bus->scratch[0].data;
2271 temp_size = sizeof(udev->bus->scratch[0].data);
2273 vendor_id = UGETW(udd->idVendor);
2274 product_id = UGETW(udd->idProduct);
2276 /* get serial number string */
2277 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2278 udev->ddesc.iSerialNumber);
2279 udev->serial = strdup(temp_ptr, M_USB);
2281 /* get manufacturer string */
2282 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2283 udev->ddesc.iManufacturer);
2284 usb_trim_spaces(temp_ptr);
2285 if (temp_ptr[0] != '\0')
2286 udev->manufacturer = strdup(temp_ptr, M_USB);
2288 /* get product string */
2289 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2290 udev->ddesc.iProduct);
2291 usb_trim_spaces(temp_ptr);
2292 if (temp_ptr[0] != '\0')
2293 udev->product = strdup(temp_ptr, M_USB);
2296 if (udev->manufacturer == NULL || udev->product == NULL) {
2297 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2298 if (kdp->vendor == vendor_id &&
2299 (kdp->product == product_id ||
2300 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2303 if (kdp->vendorname != NULL) {
2304 /* XXX should use pointer to knowndevs string */
2305 if (udev->manufacturer == NULL) {
2306 udev->manufacturer = strdup(kdp->vendorname,
2309 if (udev->product == NULL &&
2310 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2311 udev->product = strdup(kdp->productname,
2317 /* Provide default strings if none were found */
2318 if (udev->manufacturer == NULL) {
2319 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2320 udev->manufacturer = strdup(temp_ptr, M_USB);
2322 if (udev->product == NULL) {
2323 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2324 udev->product = strdup(temp_ptr, M_USB);
2333 usbd_get_mode(struct usb_device *udev)
2335 return (udev->flags.usb_mode);
2340 * See: USB_SPEED_XXX
2343 usbd_get_speed(struct usb_device *udev)
2345 return (udev->speed);
2349 usbd_get_isoc_fps(struct usb_device *udev)
2352 switch (udev->speed) {
2354 case USB_SPEED_FULL:
2361 struct usb_device_descriptor *
2362 usbd_get_device_descriptor(struct usb_device *udev)
2365 return (NULL); /* be NULL safe */
2366 return (&udev->ddesc);
2369 struct usb_config_descriptor *
2370 usbd_get_config_descriptor(struct usb_device *udev)
2373 return (NULL); /* be NULL safe */
2374 return (udev->cdesc);
2377 /*------------------------------------------------------------------------*
2378 * usb_test_quirk - test a device for a given quirk
2381 * 0: The USB device does not have the given quirk.
2382 * Else: The USB device has the given quirk.
2383 *------------------------------------------------------------------------*/
2385 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2390 if (quirk == UQ_NONE)
2393 /* search the automatic per device quirks first */
2395 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2396 if (uaa->device->autoQuirk[x] == quirk)
2400 /* search global quirk table, if any */
2402 found = (usb_test_quirk_p) (&uaa->info, quirk);
2407 struct usb_interface_descriptor *
2408 usbd_get_interface_descriptor(struct usb_interface *iface)
2411 return (NULL); /* be NULL safe */
2412 return (iface->idesc);
2416 usbd_get_interface_altindex(struct usb_interface *iface)
2418 return (iface->alt_index);
2422 usbd_get_bus_index(struct usb_device *udev)
2424 return ((uint8_t)device_get_unit(udev->bus->bdev));
2428 usbd_get_device_index(struct usb_device *udev)
2430 return (udev->device_index);
2435 usb_notify_addq(const char *type, struct usb_device *udev)
2437 struct usb_interface *iface;
2441 /* announce the device */
2442 sb = sbuf_new_auto();
2451 "devsubclass=0x%02x "
2464 UGETW(udev->ddesc.idVendor),
2465 UGETW(udev->ddesc.idProduct),
2466 udev->ddesc.bDeviceClass,
2467 udev->ddesc.bDeviceSubClass,
2468 usb_get_serial(udev),
2469 UGETW(udev->ddesc.bcdDevice),
2470 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2473 , udev->parent_hub != NULL ?
2474 udev->parent_hub->ugen_name :
2475 device_get_nameunit(device_get_parent(udev->bus->bdev))
2479 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2482 /* announce each interface */
2483 for (i = 0; i < USB_IFACE_MAX; i++) {
2484 iface = usbd_get_iface(udev, i);
2486 break; /* end of interfaces */
2487 if (iface->idesc == NULL)
2488 continue; /* no interface descriptor */
2490 sb = sbuf_new_auto();
2499 "devsubclass=0x%02x "
2506 "intsubclass=0x%02x "
2507 "intprotocol=0x%02x",
2512 UGETW(udev->ddesc.idVendor),
2513 UGETW(udev->ddesc.idProduct),
2514 udev->ddesc.bDeviceClass,
2515 udev->ddesc.bDeviceSubClass,
2516 usb_get_serial(udev),
2517 UGETW(udev->ddesc.bcdDevice),
2518 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2519 iface->idesc->bInterfaceNumber,
2520 iface->idesc->bNumEndpoints,
2521 iface->idesc->bInterfaceClass,
2522 iface->idesc->bInterfaceSubClass,
2523 iface->idesc->bInterfaceProtocol);
2525 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2532 /*------------------------------------------------------------------------*
2533 * usb_fifo_free_wrap
2535 * This function will free the FIFOs.
2537 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2538 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2539 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2540 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2541 * control endpoint FIFOs. If "iface_index" is not set to
2542 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2543 *------------------------------------------------------------------------*/
2545 usb_fifo_free_wrap(struct usb_device *udev,
2546 uint8_t iface_index, uint8_t flag)
2552 * Free any USB FIFOs on the given interface:
2554 for (i = 0; i != USB_FIFO_MAX; i++) {
2559 /* Check if the interface index matches */
2560 if (iface_index == f->iface_index) {
2561 if (f->methods != &usb_ugen_methods) {
2563 * Don't free any non-generic FIFOs in
2568 if ((f->dev_ep_index == 0) &&
2569 (f->fs_xfer == NULL)) {
2570 /* no need to free this FIFO */
2573 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2574 if ((f->methods == &usb_ugen_methods) &&
2575 (f->dev_ep_index == 0) &&
2576 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2577 (f->fs_xfer == NULL)) {
2578 /* no need to free this FIFO */
2582 /* no need to free this FIFO */
2585 /* free this FIFO */
2591 /*------------------------------------------------------------------------*
2592 * usb_peer_can_wakeup
2595 * 0: Peer cannot do resume signalling.
2596 * Else: Peer can do resume signalling.
2597 *------------------------------------------------------------------------*/
2599 usb_peer_can_wakeup(struct usb_device *udev)
2601 const struct usb_config_descriptor *cdp;
2604 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2605 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2607 return (0); /* not supported */
2611 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2614 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2616 DPRINTF("udev %p state %s -> %s\n", udev,
2617 usb_statestr(udev->state), usb_statestr(state));
2618 udev->state = state;
2620 if (udev->bus->methods->device_state_change != NULL)
2621 (udev->bus->methods->device_state_change) (udev);
2625 usb_get_device_state(struct usb_device *udev)
2628 return (USB_STATE_DETACHED);
2629 return (udev->state);
2633 usbd_device_attached(struct usb_device *udev)
2635 return (udev->state > USB_STATE_DETACHED);
2638 /* The following function locks enumerating the given USB device. */
2641 usbd_enum_lock(struct usb_device *udev)
2643 sx_xlock(&udev->enum_sx);
2644 sx_xlock(&udev->sr_sx);
2646 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2647 * are locked before locking Giant. Else the lock can be
2648 * locked multiple times.
2653 /* The following function unlocks enumerating the given USB device. */
2656 usbd_enum_unlock(struct usb_device *udev)
2659 sx_xunlock(&udev->enum_sx);
2660 sx_xunlock(&udev->sr_sx);
2663 /* The following function locks suspend and resume. */
2666 usbd_sr_lock(struct usb_device *udev)
2668 sx_xlock(&udev->sr_sx);
2670 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2671 * are locked before locking Giant. Else the lock can be
2672 * locked multiple times.
2677 /* The following function unlocks suspend and resume. */
2680 usbd_sr_unlock(struct usb_device *udev)
2683 sx_xunlock(&udev->sr_sx);
2687 * The following function checks the enumerating lock for the given
2692 usbd_enum_is_locked(struct usb_device *udev)
2694 return (sx_xlocked(&udev->enum_sx));
2698 * The following function is used to set the per-interface specific
2699 * plug and play information. The string referred to by the pnpinfo
2700 * argument can safely be freed after calling this function. The
2701 * pnpinfo of an interface will be reset at device detach or when
2702 * passing a NULL argument to this function. This function
2703 * returns zero on success, else a USB_ERR_XXX failure code.
2707 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2709 struct usb_interface *iface;
2711 iface = usbd_get_iface(udev, iface_index);
2713 return (USB_ERR_INVAL);
2715 if (iface->pnpinfo != NULL) {
2716 free(iface->pnpinfo, M_USBDEV);
2717 iface->pnpinfo = NULL;
2720 if (pnpinfo == NULL || pnpinfo[0] == 0)
2721 return (0); /* success */
2723 iface->pnpinfo = strdup(pnpinfo, M_USBDEV);
2724 if (iface->pnpinfo == NULL)
2725 return (USB_ERR_NOMEM);
2727 return (0); /* success */
2731 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2735 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2736 if (udev->autoQuirk[x] == 0 ||
2737 udev->autoQuirk[x] == quirk) {
2738 udev->autoQuirk[x] = quirk;
2739 return (0); /* success */
2742 return (USB_ERR_NOMEM);