3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/stdint.h>
28 #include <sys/param.h>
29 #include <sys/queue.h>
30 #include <sys/types.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
34 #include <sys/module.h>
36 #include <sys/mutex.h>
37 #include <sys/condvar.h>
38 #include <sys/sysctl.h>
39 #include <sys/unistd.h>
40 #include <sys/callout.h>
41 #include <sys/malloc.h>
44 #include <sys/fcntl.h>
45 #include <sys/devfs.h>
47 #include <bus/u4b/usb.h>
48 #include <bus/u4b/usbdi.h>
49 #include <bus/u4b/usbdi_util.h>
50 #include <bus/u4b/usb_ioctl.h>
58 #define USB_DEBUG_VAR usb_debug
60 #include <bus/u4b/usb_core.h>
61 #include <bus/u4b/usb_debug.h>
62 #include <bus/u4b/usb_process.h>
63 #include <bus/u4b/usb_device.h>
64 #include <bus/u4b/usb_busdma.h>
65 #include <bus/u4b/usb_transfer.h>
66 #include <bus/u4b/usb_request.h>
67 #include <bus/u4b/usb_dynamic.h>
68 #include <bus/u4b/usb_hub.h>
69 #include <bus/u4b/usb_util.h>
70 #include <bus/u4b/usb_msctest.h>
72 #include <bus/u4b/usb_dev.h>
73 #include <bus/u4b/usb_generic.h>
76 #include <bus/u4b/quirk/usb_quirk.h>
78 #include <bus/u4b/usb_controller.h>
79 #include <bus/u4b/usb_bus.h>
81 /* function prototypes */
83 static void usb_init_endpoint(struct usb_device *, uint8_t,
84 struct usb_endpoint_descriptor *,
85 struct usb_endpoint_ss_comp_descriptor *,
86 struct usb_endpoint *);
87 static void usb_unconfigure(struct usb_device *, uint8_t);
88 static void usb_detach_device_sub(struct usb_device *, device_t *,
90 static uint8_t usb_probe_and_attach_sub(struct usb_device *,
91 struct usb_attach_arg *);
92 static void usb_init_attach_arg(struct usb_device *,
93 struct usb_attach_arg *);
94 static void usb_suspend_resume_sub(struct usb_device *, device_t,
96 static void usbd_clear_stall_proc(struct usb_proc_msg *_pm);
97 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
98 static void usbd_set_device_strings(struct usb_device *);
100 static void usb_notify_addq(const char *type, struct usb_device *);
103 static void usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
104 static void usb_cdev_create(struct usb_device *);
105 static void usb_cdev_free(struct usb_device *);
108 /* This variable is global to allow easy access to it: */
110 int usb_template = 0;
112 TUNABLE_INT("hw.usb.usb_template", &usb_template);
113 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW,
114 &usb_template, 0, "Selected USB device side template");
116 /* English is default language */
118 static int usb_lang_id = 0x0009;
119 static int usb_lang_mask = 0x00FF;
121 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
122 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW,
123 &usb_lang_id, 0, "Preferred USB language ID");
125 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
126 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW,
127 &usb_lang_mask, 0, "Preferred USB language mask");
129 static const char* statestr[USB_STATE_MAX] = {
130 [USB_STATE_DETACHED] = "DETACHED",
131 [USB_STATE_ATTACHED] = "ATTACHED",
132 [USB_STATE_POWERED] = "POWERED",
133 [USB_STATE_ADDRESSED] = "ADDRESSED",
134 [USB_STATE_CONFIGURED] = "CONFIGURED",
138 usb_statestr(enum usb_dev_state state)
140 return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
144 usb_get_manufacturer(struct usb_device *udev)
146 return (udev->manufacturer ? udev->manufacturer : "Unknown");
150 usb_get_product(struct usb_device *udev)
152 return (udev->product ? udev->product : "");
156 usb_get_serial(struct usb_device *udev)
158 return (udev->serial ? udev->serial : "");
161 /*------------------------------------------------------------------------*
162 * usbd_get_ep_by_addr
164 * This function searches for an USB ep by endpoint address and
170 *------------------------------------------------------------------------*/
171 struct usb_endpoint *
172 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
174 struct usb_endpoint *ep = udev->endpoints;
175 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
177 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
181 * According to the USB specification not all bits are used
182 * for the endpoint address. Keep defined bits only:
187 * Iterate accross all the USB endpoints searching for a match
188 * based on the endpoint address:
190 for (; ep != ep_end; ep++) {
192 if (ep->edesc == NULL) {
195 /* do the mask and check the value */
196 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
202 * The default endpoint is always present and is checked separately:
204 if ((udev->ctrl_ep.edesc) &&
205 ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
215 /*------------------------------------------------------------------------*
218 * This function searches for an USB endpoint based on the information
219 * given by the passed "struct usb_config" pointer.
223 * Else: Pointer to "struct usb_endpoint".
224 *------------------------------------------------------------------------*/
225 struct usb_endpoint *
226 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
227 const struct usb_config *setup)
229 struct usb_endpoint *ep = udev->endpoints;
230 struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
231 uint8_t index = setup->ep_index;
237 DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
238 "type=0x%x dir=0x%x index=%d\n",
239 udev, iface_index, setup->endpoint,
240 setup->type, setup->direction, setup->ep_index);
244 if (setup->usb_mode != USB_MODE_DUAL &&
245 udev->flags.usb_mode != setup->usb_mode) {
246 /* wrong mode - no endpoint */
250 /* setup expected endpoint direction mask and value */
252 if (setup->direction == UE_DIR_RX) {
253 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
254 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
255 UE_DIR_OUT : UE_DIR_IN;
256 } else if (setup->direction == UE_DIR_TX) {
257 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
258 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
259 UE_DIR_IN : UE_DIR_OUT;
260 } else if (setup->direction == UE_DIR_ANY) {
261 /* match any endpoint direction */
265 /* match the given endpoint direction */
266 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
267 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
270 /* setup expected endpoint address */
272 if (setup->endpoint == UE_ADDR_ANY) {
273 /* match any endpoint address */
275 /* match the given endpoint address */
277 ea_val |= (setup->endpoint & UE_ADDR);
280 /* setup expected endpoint type */
282 if (setup->type == UE_BULK_INTR) {
283 /* this will match BULK and INTERRUPT endpoints */
286 } else if (setup->type == UE_TYPE_ANY) {
287 /* match any endpoint type */
291 /* match the given endpoint type */
292 type_mask = UE_XFERTYPE;
293 type_val = (setup->type & UE_XFERTYPE);
297 * Iterate accross all the USB endpoints searching for a match
298 * based on the endpoint address. Note that we are searching
299 * the endpoints from the beginning of the "udev->endpoints" array.
301 for (; ep != ep_end; ep++) {
303 if ((ep->edesc == NULL) ||
304 (ep->iface_index != iface_index)) {
307 /* do the masks and check the values */
309 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
310 ((ep->edesc->bmAttributes & type_mask) == type_val)) {
318 * Match against default endpoint last, so that "any endpoint", "any
319 * address" and "any direction" returns the first endpoint of the
320 * interface. "iface_index" and "direction" is ignored:
322 if ((udev->ctrl_ep.edesc != NULL) &&
323 ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
324 ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
335 /*------------------------------------------------------------------------*
336 * usbd_interface_count
338 * This function stores the number of USB interfaces excluding
339 * alternate settings, which the USB config descriptor reports into
340 * the unsigned 8-bit integer pointed to by "count".
345 *------------------------------------------------------------------------*/
347 usbd_interface_count(struct usb_device *udev, uint8_t *count)
349 if (udev->cdesc == NULL) {
351 return (USB_ERR_NOT_CONFIGURED);
353 *count = udev->ifaces_max;
354 return (USB_ERR_NORMAL_COMPLETION);
357 /*------------------------------------------------------------------------*
360 * This function will initialise the USB endpoint structure pointed to by
361 * the "endpoint" argument. The structure pointed to by "endpoint" must be
362 * zeroed before calling this function.
363 *------------------------------------------------------------------------*/
365 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
366 struct usb_endpoint_descriptor *edesc,
367 struct usb_endpoint_ss_comp_descriptor *ecomp,
368 struct usb_endpoint *ep)
370 struct usb_bus_methods *methods;
373 methods = udev->bus->methods;
375 (methods->endpoint_init) (udev, edesc, ep);
377 /* initialise USB endpoint structure */
380 ep->iface_index = iface_index;
382 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
383 TAILQ_INIT(&ep->endpoint_q[x].head);
384 ep->endpoint_q[x].command = &usbd_pipe_start;
387 /* the pipe is not supported by the hardware */
388 if (ep->methods == NULL)
391 /* check for SUPER-speed streams mode endpoint */
392 if (udev->speed == USB_SPEED_SUPER && ecomp != NULL &&
393 (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK &&
394 (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) {
395 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS);
397 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT);
400 /* clear stall, if any */
401 if (methods->clear_stall != NULL) {
402 USB_BUS_LOCK(udev->bus);
403 (methods->clear_stall) (udev, ep);
404 USB_BUS_UNLOCK(udev->bus);
408 /*-----------------------------------------------------------------------*
409 * usb_endpoint_foreach
411 * This function will iterate all the USB endpoints except the control
412 * endpoint. This function is NULL safe.
415 * NULL: End of USB endpoints
416 * Else: Pointer to next USB endpoint
417 *------------------------------------------------------------------------*/
418 struct usb_endpoint *
419 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
421 struct usb_endpoint *ep_end;
427 ep_end = udev->endpoints + udev->endpoints_max;
429 /* get next endpoint */
431 ep = udev->endpoints;
435 /* find next allocated ep */
436 while (ep != ep_end) {
437 if (ep->edesc != NULL)
444 /*------------------------------------------------------------------------*
447 * This function will free all USB interfaces and USB endpoints belonging
450 * Flag values, see "USB_UNCFG_FLAG_XXX".
451 *------------------------------------------------------------------------*/
453 usb_unconfigure(struct usb_device *udev, uint8_t flag)
457 /* automatic locking */
458 if (usbd_enum_is_locked(udev)) {
462 usbd_enum_lock(udev);
465 /* detach all interface drivers */
466 usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
469 /* free all FIFOs except control endpoint FIFOs */
470 usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
473 * Free all cdev's, if any.
478 #if USB_HAVE_COMPAT_LINUX
479 /* free Linux compat device, if any */
480 if (udev->linux_endpoint_start) {
481 usb_linux_free_device(udev);
482 udev->linux_endpoint_start = NULL;
486 usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
488 /* free "cdesc" after "ifaces" and "endpoints", if any */
489 if (udev->cdesc != NULL) {
490 if (udev->flags.usb_mode != USB_MODE_DEVICE)
491 kfree(udev->cdesc, M_USB);
494 /* set unconfigured state */
495 udev->curr_config_no = USB_UNCONFIG_NO;
496 udev->curr_config_index = USB_UNCONFIG_INDEX;
499 usbd_enum_unlock(udev);
502 /*------------------------------------------------------------------------*
503 * usbd_set_config_index
505 * This function selects configuration by index, independent of the
506 * actual configuration number. This function should not be used by
512 *------------------------------------------------------------------------*/
514 usbd_set_config_index(struct usb_device *udev, uint8_t index)
516 struct usb_status ds;
517 struct usb_config_descriptor *cdp;
524 DPRINTFN(6, "udev=%p index=%d\n", udev, index);
526 /* automatic locking */
527 if (usbd_enum_is_locked(udev)) {
531 usbd_enum_lock(udev);
534 usb_unconfigure(udev, 0);
536 if (index == USB_UNCONFIG_INDEX) {
538 * Leave unallocated when unconfiguring the
539 * device. "usb_unconfigure()" will also reset
540 * the current config number and index.
542 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
543 if (udev->state == USB_STATE_CONFIGURED)
544 usb_set_device_state(udev, USB_STATE_ADDRESSED);
547 /* get the full config descriptor */
548 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
549 /* save some memory */
550 err = usbd_req_get_descriptor_ptr(udev, &cdp,
551 (UDESC_CONFIG << 8) | index);
554 err = usbd_req_get_config_desc_full(udev,
555 NULL, &cdp, M_USB, index);
560 /* set the new config descriptor */
564 /* Figure out if the device is self or bus powered. */
566 if ((!udev->flags.uq_bus_powered) &&
567 (cdp->bmAttributes & UC_SELF_POWERED) &&
568 (udev->flags.usb_mode == USB_MODE_HOST)) {
569 /* May be self powered. */
570 if (cdp->bmAttributes & UC_BUS_POWERED) {
571 /* Must ask device. */
572 err = usbd_req_get_device_status(udev, NULL, &ds);
574 DPRINTFN(0, "could not read "
575 "device status: %s\n",
577 } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
580 DPRINTF("status=0x%04x \n",
585 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
586 "selfpowered=%d, power=%d\n",
588 udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
589 selfpowered, cdp->bMaxPower * 2);
591 /* Check if we have enough power. */
592 power = cdp->bMaxPower * 2;
594 if (udev->parent_hub) {
595 max_power = udev->parent_hub->hub->portpower;
597 max_power = USB_MAX_POWER;
600 if (power > max_power) {
601 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
602 err = USB_ERR_NO_POWER;
605 /* Only update "self_powered" in USB Host Mode */
606 if (udev->flags.usb_mode == USB_MODE_HOST) {
607 udev->flags.self_powered = selfpowered;
610 udev->curr_config_no = cdp->bConfigurationValue;
611 udev->curr_config_index = index;
612 usb_set_device_state(udev, USB_STATE_CONFIGURED);
614 /* Set the actual configuration value. */
615 err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
620 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
625 err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
631 /* create device nodes for each endpoint */
632 usb_cdev_create(udev);
636 DPRINTF("error=%s\n", usbd_errstr(err));
638 usb_unconfigure(udev, 0);
641 usbd_enum_unlock(udev);
645 /*------------------------------------------------------------------------*
648 * This function will allocate and free USB interfaces and USB endpoints,
649 * parse the USB configuration structure and initialise the USB endpoints
650 * and interfaces. If "iface_index" is not equal to
651 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
652 * alternate_setting to be selected for the given interface. Else the
653 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
654 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
655 * is typically called when setting the configuration or when setting
656 * an alternate interface.
661 *------------------------------------------------------------------------*/
663 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
665 struct usb_idesc_parse_state ips;
666 struct usb_interface_descriptor *id;
667 struct usb_endpoint_descriptor *ed;
668 struct usb_interface *iface;
669 struct usb_endpoint *ep;
677 if (iface_index != USB_IFACE_INDEX_ANY) {
678 /* parameter overload */
688 DPRINTFN(5, "iface_index=%d cmd=%d\n",
691 if (cmd == USB_CFG_FREE)
694 if (cmd == USB_CFG_INIT) {
695 KKASSERT(lockowned(&udev->enum_lock));
697 /* check for in-use endpoints */
699 ep = udev->endpoints;
700 ep_max = udev->endpoints_max;
702 /* look for matching endpoints */
703 if ((iface_index == USB_IFACE_INDEX_ANY) ||
704 (iface_index == ep->iface_index)) {
705 if (ep->refcount_alloc != 0) {
707 * This typically indicates a
708 * more serious error.
710 err = USB_ERR_IN_USE;
713 memset(ep, 0, sizeof(*ep));
714 /* make sure we don't zero the endpoint again */
715 ep->iface_index = USB_IFACE_INDEX_ANY;
725 memset(&ips, 0, sizeof(ips));
730 while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
732 /* check for interface overflow */
733 if (ips.iface_index == USB_IFACE_MAX)
736 iface = udev->ifaces + ips.iface_index;
738 /* check for specific interface match */
740 if (cmd == USB_CFG_INIT) {
741 if ((iface_index != USB_IFACE_INDEX_ANY) &&
742 (iface_index != ips.iface_index)) {
743 /* wrong interface */
745 } else if (alt_index != ips.iface_index_alt) {
746 /* wrong alternate setting */
749 /* initialise interface */
755 /* check for new interface */
756 if (ips.iface_index_alt == 0) {
757 /* update current number of endpoints */
762 /* setup the USB interface structure */
764 /* set alternate index */
765 iface->alt_index = alt_index;
766 /* set default interface parent */
767 if (iface_index == USB_IFACE_INDEX_ANY) {
768 iface->parent_iface_index =
773 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
775 ed = (struct usb_endpoint_descriptor *)id;
779 /* iterate all the endpoint descriptors */
780 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
782 if (temp == USB_EP_MAX)
785 ep = udev->endpoints + temp;
790 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
792 DPRINTFN(5, "Found endpoint companion descriptor\n");
794 usb_init_endpoint(udev,
795 ips.iface_index, ed, ecomp, ep);
800 /* find maximum number of endpoints */
805 id = (struct usb_interface_descriptor *)ed;
809 /* NOTE: It is valid to have no interfaces and no endpoints! */
811 if (cmd == USB_CFG_ALLOC) {
812 udev->ifaces_max = ips.iface_index;
814 if (udev->ifaces_max != 0) {
815 udev->ifaces = kmalloc(sizeof(*iface) * udev->ifaces_max,
816 M_USB, M_WAITOK | M_ZERO);
817 if (udev->ifaces == NULL) {
823 udev->endpoints = kmalloc(sizeof(*ep) * ep_max,
824 M_USB, M_WAITOK | M_ZERO);
825 if (udev->endpoints == NULL) {
830 udev->endpoints = NULL;
832 USB_BUS_LOCK(udev->bus);
833 udev->endpoints_max = ep_max;
834 /* reset any ongoing clear-stall */
835 udev->ep_curr = NULL;
836 USB_BUS_UNLOCK(udev->bus);
841 if (cmd == USB_CFG_ALLOC) {
843 USB_BUS_LOCK(udev->bus);
844 udev->endpoints_max = 0;
845 /* reset any ongoing clear-stall */
846 udev->ep_curr = NULL;
847 USB_BUS_UNLOCK(udev->bus);
850 if (udev->ifaces != NULL)
851 kfree(udev->ifaces, M_USB);
852 if (udev->endpoints != NULL)
853 kfree(udev->endpoints, M_USB);
856 udev->endpoints = NULL;
857 udev->ifaces_max = 0;
863 /*------------------------------------------------------------------------*
864 * usbd_set_alt_interface_index
866 * This function will select an alternate interface index for the
867 * given interface index. The interface should not be in use when this
868 * function is called. That means there should not be any open USB
869 * transfers. Else an error is returned. If the alternate setting is
870 * already set this function will simply return success. This function
871 * is called in Host mode and Device mode!
876 *------------------------------------------------------------------------*/
878 usbd_set_alt_interface_index(struct usb_device *udev,
879 uint8_t iface_index, uint8_t alt_index)
881 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
885 /* automatic locking */
886 if (usbd_enum_is_locked(udev)) {
890 usbd_enum_lock(udev);
896 if (iface->alt_index == alt_index) {
898 * Optimise away duplicate setting of
899 * alternate setting in USB Host Mode!
906 * Free all generic FIFOs for this interface, except control
909 usb_fifo_free_wrap(udev, iface_index, 0);
912 err = usb_config_parse(udev, iface_index, alt_index);
916 if (iface->alt_index != alt_index) {
917 /* the alternate setting does not exist */
922 err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
923 iface->idesc->bAlternateSetting);
927 usbd_enum_unlock(udev);
932 /*------------------------------------------------------------------------*
933 * usbd_set_endpoint_stall
935 * This function is used to make a BULK or INTERRUPT endpoint send
936 * STALL tokens in USB device mode.
941 *------------------------------------------------------------------------*/
943 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
946 struct usb_xfer *xfer;
953 DPRINTF("Cannot find endpoint\n");
955 * Pretend that the clear or set stall request is
956 * successful else some USB host stacks can do
957 * strange things, especially when a control endpoint
962 et = (ep->edesc->bmAttributes & UE_XFERTYPE);
964 if ((et != UE_BULK) &&
965 (et != UE_INTERRUPT)) {
967 * Should not stall control
968 * nor isochronous endpoints.
970 DPRINTF("Invalid endpoint\n");
973 USB_BUS_LOCK(udev->bus);
975 /* store current stall state */
976 was_stalled = ep->is_stalled;
978 /* check for no change */
979 if (was_stalled && do_stall) {
980 /* if the endpoint is already stalled do nothing */
981 USB_BUS_UNLOCK(udev->bus);
982 DPRINTF("No change\n");
985 /* set stalled state */
988 if (do_stall || (!was_stalled)) {
990 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
991 /* lookup the current USB transfer, if any */
992 xfer = ep->endpoint_q[x].curr;
995 * The "xfer_stall" method
996 * will complete the USB
997 * transfer like in case of a
998 * timeout setting the error
999 * code "USB_ERR_STALLED".
1001 (udev->bus->methods->xfer_stall) (xfer);
1005 (udev->bus->methods->set_stall) (udev, ep, &do_stall);
1008 ep->toggle_next = 0; /* reset data toggle */
1009 ep->is_stalled = 0; /* clear stalled state */
1011 (udev->bus->methods->clear_stall) (udev, ep);
1013 /* start the current or next transfer, if any */
1014 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1015 usb_command_wrapper(&ep->endpoint_q[x],
1016 ep->endpoint_q[x].curr);
1019 USB_BUS_UNLOCK(udev->bus);
1023 /*------------------------------------------------------------------------*
1024 * usb_reset_iface_endpoints - used in USB device side mode
1025 *------------------------------------------------------------------------*/
1027 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1029 struct usb_endpoint *ep;
1030 struct usb_endpoint *ep_end;
1032 ep = udev->endpoints;
1033 ep_end = udev->endpoints + udev->endpoints_max;
1035 for (; ep != ep_end; ep++) {
1037 if ((ep->edesc == NULL) ||
1038 (ep->iface_index != iface_index)) {
1041 /* simulate a clear stall from the peer */
1042 usbd_set_endpoint_stall(udev, ep, 0);
1047 /*------------------------------------------------------------------------*
1048 * usb_detach_device_sub
1050 * This function will try to detach an USB device. If it fails a panic
1053 * Flag values, see "USB_UNCFG_FLAG_XXX".
1054 *------------------------------------------------------------------------*/
1056 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1057 char **ppnpinfo, uint8_t flag)
1066 * NOTE: It is important to clear "*ppdev" before deleting
1067 * the child due to some device methods being called late
1068 * during the delete process !
1072 device_printf(dev, "at %s, port %d, addr %d "
1074 device_get_nameunit(udev->parent_dev),
1075 udev->port_no, udev->address);
1077 if (device_is_attached(dev)) {
1078 if (udev->flags.peer_suspended) {
1079 err = DEVICE_RESUME(dev);
1081 device_printf(dev, "Resume failed\n");
1084 if (device_detach(dev)) {
1088 if (device_delete_child(udev->parent_dev, dev)) {
1093 pnpinfo = *ppnpinfo;
1094 if (pnpinfo != NULL) {
1096 kfree(pnpinfo, M_USBDEV);
1101 /* Detach is not allowed to fail in the USB world */
1102 panic("usb_detach_device_sub: A USB driver would not detach\n");
1105 /*------------------------------------------------------------------------*
1108 * The following function will detach the matching interfaces.
1109 * This function is NULL safe.
1111 * Flag values, see "USB_UNCFG_FLAG_XXX".
1112 *------------------------------------------------------------------------*/
1114 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1117 struct usb_interface *iface;
1124 DPRINTFN(4, "udev=%p\n", udev);
1127 sx_assert(&udev->enum_sx, SA_LOCKED);
1131 * First detach the child to give the child's detach routine a
1132 * chance to detach the sub-devices in the correct order.
1133 * Then delete the child using "device_delete_child()" which
1134 * will detach all sub-devices from the bottom and upwards!
1136 if (iface_index != USB_IFACE_INDEX_ANY) {
1138 iface_index = i + 1;
1141 iface_index = USB_IFACE_MAX;
1146 for (; i != iface_index; i++) {
1148 iface = usbd_get_iface(udev, i);
1149 if (iface == NULL) {
1150 /* looks like the end of the USB interfaces */
1153 usb_detach_device_sub(udev, &iface->subdev,
1154 &iface->pnpinfo, flag);
1158 /*------------------------------------------------------------------------*
1159 * usb_probe_and_attach_sub
1164 *------------------------------------------------------------------------*/
1166 usb_probe_and_attach_sub(struct usb_device *udev,
1167 struct usb_attach_arg *uaa)
1169 struct usb_interface *iface;
1174 if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1175 /* leave interface alone */
1178 dev = iface->subdev;
1181 /* clean up after module unload */
1183 if (device_is_attached(dev)) {
1184 /* already a device there */
1187 /* clear "iface->subdev" as early as possible */
1189 iface->subdev = NULL;
1191 if (device_delete_child(udev->parent_dev, dev)) {
1194 * Panic here, else one can get a double call
1195 * to device_detach(). USB devices should
1196 * never fail on detach!
1198 panic("device_delete_child() failed\n");
1201 if (uaa->temp_dev == NULL) {
1203 /* create a new child */
1204 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1205 if (uaa->temp_dev == NULL) {
1206 device_printf(udev->parent_dev,
1207 "Device creation failed\n");
1208 return (1); /* failure */
1210 device_set_ivars(uaa->temp_dev, uaa);
1211 device_quiet(uaa->temp_dev);
1214 * Set "subdev" before probe and attach so that "devd" gets
1215 * the information it needs.
1217 iface->subdev = uaa->temp_dev;
1219 if (device_probe_and_attach(iface->subdev) == 0) {
1221 * The USB attach arguments are only available during probe
1224 uaa->temp_dev = NULL;
1225 device_set_ivars(iface->subdev, NULL);
1227 if (udev->flags.peer_suspended) {
1228 err = DEVICE_SUSPEND(iface->subdev);
1230 device_printf(iface->subdev, "Suspend failed\n");
1232 return (0); /* success */
1234 /* No USB driver found */
1235 iface->subdev = NULL;
1237 return (1); /* failure */
1240 /*------------------------------------------------------------------------*
1241 * usbd_set_parent_iface
1243 * Using this function will lock the alternate interface setting on an
1244 * interface. It is typically used for multi interface drivers. In USB
1245 * device side mode it is assumed that the alternate interfaces all
1246 * have the same endpoint descriptors. The default parent index value
1247 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1249 *------------------------------------------------------------------------*/
1251 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1252 uint8_t parent_index)
1254 struct usb_interface *iface;
1260 iface = usbd_get_iface(udev, iface_index);
1262 iface->parent_iface_index = parent_index;
1267 usb_init_attach_arg(struct usb_device *udev,
1268 struct usb_attach_arg *uaa)
1270 memset(uaa, 0, sizeof(*uaa));
1273 uaa->usb_mode = udev->flags.usb_mode;
1274 uaa->port = udev->port_no;
1275 uaa->dev_state = UAA_DEV_READY;
1277 uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1278 uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1279 uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1280 uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1281 uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1282 uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1283 uaa->info.bConfigIndex = udev->curr_config_index;
1284 uaa->info.bConfigNum = udev->curr_config_no;
1287 /*------------------------------------------------------------------------*
1288 * usb_probe_and_attach
1290 * This function is called from "uhub_explore_sub()",
1291 * "usb_handle_set_config()" and "usb_handle_request()".
1295 * Else: A control transfer failed
1296 *------------------------------------------------------------------------*/
1298 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1300 struct usb_attach_arg uaa;
1301 struct usb_interface *iface;
1307 DPRINTF("udev == NULL\n");
1308 return (USB_ERR_INVAL);
1310 /* automatic locking */
1311 if (usbd_enum_is_locked(udev)) {
1315 usbd_enum_lock(udev);
1318 if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1319 /* do nothing - no configuration has been set */
1322 /* setup USB attach arguments */
1324 usb_init_attach_arg(udev, &uaa);
1327 * If the whole USB device is targeted, invoke the USB event
1330 if (iface_index == USB_IFACE_INDEX_ANY) {
1332 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1334 if (uaa.dev_state != UAA_DEV_READY) {
1335 /* leave device unconfigured */
1336 usb_unconfigure(udev, 0);
1341 /* Check if only one interface should be probed: */
1342 if (iface_index != USB_IFACE_INDEX_ANY) {
1350 /* Do the probe and attach */
1351 for (; i != j; i++) {
1353 iface = usbd_get_iface(udev, i);
1354 if (iface == NULL) {
1356 * Looks like the end of the USB
1359 DPRINTFN(2, "end of interfaces "
1363 if (iface->idesc == NULL) {
1364 /* no interface descriptor */
1369 uaa.info.bInterfaceClass =
1370 iface->idesc->bInterfaceClass;
1371 uaa.info.bInterfaceSubClass =
1372 iface->idesc->bInterfaceSubClass;
1373 uaa.info.bInterfaceProtocol =
1374 iface->idesc->bInterfaceProtocol;
1375 uaa.info.bIfaceIndex = i;
1376 uaa.info.bIfaceNum =
1377 iface->idesc->bInterfaceNumber;
1378 uaa.driver_info = 0; /* reset driver_info */
1380 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1381 uaa.info.bInterfaceClass,
1382 uaa.info.bInterfaceSubClass,
1383 uaa.info.bInterfaceProtocol,
1384 uaa.info.bIfaceIndex,
1385 uaa.info.bIfaceNum);
1387 usb_probe_and_attach_sub(udev, &uaa);
1390 * Remove the leftover child, if any, to enforce that
1391 * a new nomatch devd event is generated for the next
1392 * interface if no driver is found:
1394 if (uaa.temp_dev == NULL)
1396 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1397 DPRINTFN(0, "device delete child failed\n");
1398 uaa.temp_dev = NULL;
1402 usbd_enum_unlock(udev);
1407 /*------------------------------------------------------------------------*
1408 * usb_suspend_resume_sub
1410 * This function is called when the suspend or resume methods should
1411 * be executed on an USB device.
1412 *------------------------------------------------------------------------*/
1414 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1421 if (!device_is_attached(dev)) {
1425 err = DEVICE_SUSPEND(dev);
1427 err = DEVICE_RESUME(dev);
1430 device_printf(dev, "%s failed\n",
1431 do_suspend ? "Suspend" : "Resume");
1435 /*------------------------------------------------------------------------*
1436 * usb_suspend_resume
1438 * The following function will suspend or resume the USB device.
1443 *------------------------------------------------------------------------*/
1445 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1447 struct usb_interface *iface;
1454 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1457 sx_assert(&udev->sr_sx, SA_LOCKED);
1460 USB_BUS_LOCK(udev->bus);
1461 /* filter the suspend events */
1462 if (udev->flags.peer_suspended == do_suspend) {
1463 USB_BUS_UNLOCK(udev->bus);
1467 udev->flags.peer_suspended = do_suspend;
1468 USB_BUS_UNLOCK(udev->bus);
1470 /* do the suspend or resume */
1472 for (i = 0; i != USB_IFACE_MAX; i++) {
1474 iface = usbd_get_iface(udev, i);
1475 if (iface == NULL) {
1476 /* looks like the end of the USB interfaces */
1479 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1484 /*------------------------------------------------------------------------*
1485 * usbd_clear_stall_proc
1487 * This function performs generic USB clear stall operations.
1488 *------------------------------------------------------------------------*/
1490 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1492 struct usb_clear_stall_msg *pm = (void *)_pm;
1493 struct usb_device *udev = pm->udev;
1496 USB_BUS_UNLOCK(udev->bus);
1497 lockmgr(&udev->device_lock, LK_EXCLUSIVE);
1499 /* Start clear stall callback */
1500 usbd_transfer_start(udev->ctrl_xfer[1]);
1503 lockmgr(&udev->device_lock, LK_RELEASE);
1504 USB_BUS_LOCK(udev->bus);
1507 /*------------------------------------------------------------------------*
1510 * This function allocates a new USB device. This function is called
1511 * when a new device has been put in the powered state, but not yet in
1512 * the addressed state. Get initial descriptor, set the address, get
1513 * full descriptor and get strings.
1518 *------------------------------------------------------------------------*/
1520 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1521 struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1522 uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1524 struct usb_attach_arg uaa;
1525 struct usb_device *udev;
1526 struct usb_device *adev;
1527 struct usb_device *hub;
1528 uint8_t *scratch_ptr;
1529 size_t scratch_size;
1531 uint8_t device_index;
1532 uint8_t config_index;
1533 uint8_t config_quirk;
1534 uint8_t set_config_failed;
1536 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1537 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1538 parent_dev, bus, parent_hub, depth, port_index, port_no,
1542 * Find an unused device index. In USB Host mode this is the
1543 * same as the device address.
1545 * Device index zero is not used and device index 1 should
1546 * always be the root hub.
1548 for (device_index = USB_ROOT_HUB_ADDR;
1549 (device_index != bus->devices_max) &&
1550 (bus->devices[device_index] != NULL);
1551 device_index++) /* nop */;
1553 if (device_index == bus->devices_max) {
1554 device_printf(bus->bdev,
1555 "No free USB device index for new device\n");
1560 device_printf(bus->bdev,
1561 "Invalid device depth\n");
1564 udev = kmalloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1567 device_printf(bus->bdev,
1568 "Allocation of usb device memory failed\n");
1572 /* initialise our SX-lock */
1573 sx_init_flags(&udev->ctrl_sx, "USB device SX lock", SX_DUPOK);
1574 /* initialise our SX-lock */
1575 sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1576 sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS);
1578 lockinit(&udev->ctrl_lock, "USB device SX lock", 0, LK_CANRECURSE);
1579 lockinit(&udev->enum_lock, "USB config SX lock", 0, LK_CANRECURSE);
1580 lockinit(&udev->sr_lock, "USB suspend and resume SX lock", 0, 0);
1582 cv_init(&udev->ctrlreq_cv, "WCTRL");
1583 cv_init(&udev->ref_cv, "UGONE");
1585 /* initialise our mutex */
1586 lockinit(&udev->device_lock, "USB device mutex", 0, 0);
1588 /* initialise generic clear stall */
1589 udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1590 udev->cs_msg[0].udev = udev;
1591 udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1592 udev->cs_msg[1].udev = udev;
1594 /* initialise some USB device fields */
1595 udev->parent_hub = parent_hub;
1596 udev->parent_dev = parent_dev;
1597 udev->port_index = port_index;
1598 udev->port_no = port_no;
1599 udev->depth = depth;
1601 udev->address = USB_START_ADDR; /* default value */
1602 udev->plugtime = (usb_ticks_t)ticks;
1604 * We need to force the power mode to "on" because there are plenty
1605 * of USB devices out there that do not work very well with
1606 * automatic suspend and resume!
1608 udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1609 udev->pwr_save.last_xfer_time = ticks;
1610 /* we are not ready yet */
1613 /* set up default endpoint descriptor */
1614 udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1615 udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1616 udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1617 udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1618 udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1619 udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1620 udev->ctrl_ep_desc.bInterval = 0;
1622 /* set up default endpoint companion descriptor */
1623 udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1624 udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1626 udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1628 udev->speed = speed;
1629 udev->flags.usb_mode = mode;
1631 /* search for our High Speed USB HUB, if any */
1634 hub = udev->parent_hub;
1637 if (hub->speed == USB_SPEED_HIGH) {
1638 udev->hs_hub_addr = hub->address;
1639 udev->parent_hs_hub = hub;
1640 udev->hs_port_no = adev->port_no;
1644 hub = hub->parent_hub;
1647 /* init the default endpoint */
1648 usb_init_endpoint(udev, 0,
1649 &udev->ctrl_ep_desc,
1650 &udev->ctrl_ep_comp_desc,
1653 /* set device index */
1654 udev->device_index = device_index;
1657 /* Create ugen name */
1658 ksnprintf(udev->ugen_name, sizeof(udev->ugen_name),
1659 USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1661 LIST_INIT(&udev->pd_list);
1663 /* Create the control endpoint device */
1664 udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1665 FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1667 /* Create a link from /dev/ugenX.X to the default endpoint */
1668 if (udev->ctrl_dev != NULL)
1669 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1671 /* Initialise device */
1672 if (bus->methods->device_init != NULL) {
1673 err = (bus->methods->device_init) (udev);
1675 DPRINTFN(0, "device init %d failed "
1676 "(%s, ignored)\n", device_index,
1681 /* set powered device state after device init is complete */
1682 usb_set_device_state(udev, USB_STATE_POWERED);
1684 if (udev->flags.usb_mode == USB_MODE_HOST) {
1686 err = usbd_req_set_address(udev, NULL, device_index);
1689 * This is the new USB device address from now on, if
1690 * the set address request didn't set it already.
1692 if (udev->address == USB_START_ADDR)
1693 udev->address = device_index;
1696 * We ignore any set-address errors, hence there are
1697 * buggy USB devices out there that actually receive
1698 * the SETUP PID, but manage to set the address before
1699 * the STATUS stage is ACK'ed. If the device responds
1700 * to the subsequent get-descriptor at the new
1701 * address, then we know that the set-address command
1705 DPRINTFN(0, "set address %d failed "
1706 "(%s, ignored)\n", udev->address,
1710 /* We are not self powered */
1711 udev->flags.self_powered = 0;
1713 /* Set unconfigured state */
1714 udev->curr_config_no = USB_UNCONFIG_NO;
1715 udev->curr_config_index = USB_UNCONFIG_INDEX;
1717 /* Setup USB descriptors */
1718 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1720 DPRINTFN(0, "setting up USB template failed maybe the USB "
1721 "template module has not been loaded\n");
1725 usb_set_device_state(udev, USB_STATE_ADDRESSED);
1727 /* setup the device descriptor and the initial "wMaxPacketSize" */
1728 err = usbd_setup_device_desc(udev, NULL);
1731 /* XXX try to re-enumerate the device */
1732 err = usbd_req_re_enumerate(udev, NULL);
1738 * Setup temporary USB attach args so that we can figure out some
1739 * basic quirks for this device.
1741 usb_init_attach_arg(udev, &uaa);
1743 if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1744 udev->flags.uq_bus_powered = 1;
1746 if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1747 udev->flags.no_strings = 1;
1750 * Workaround for buggy USB devices.
1752 * It appears that some string-less USB chips will crash and
1753 * disappear if any attempts are made to read any string
1756 * Try to detect such chips by checking the strings in the USB
1757 * device descriptor. If no strings are present there we
1758 * simply disable all USB strings.
1760 scratch_ptr = udev->bus->scratch[0].data;
1761 scratch_size = sizeof(udev->bus->scratch[0].data);
1763 if (udev->ddesc.iManufacturer ||
1764 udev->ddesc.iProduct ||
1765 udev->ddesc.iSerialNumber) {
1766 /* read out the language ID string */
1767 err = usbd_req_get_string_desc(udev, NULL,
1768 (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1770 err = USB_ERR_INVAL;
1773 if (err || (scratch_ptr[0] < 4)) {
1774 udev->flags.no_strings = 1;
1781 /* load preferred value and mask */
1783 mask = usb_lang_mask;
1785 /* align length correctly */
1786 scratch_ptr[0] &= ~1;
1788 /* fix compiler warning */
1791 /* search for preferred language */
1792 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1793 langid = UGETW(scratch_ptr + x);
1794 if ((langid & mask) == pref)
1797 if (x >= scratch_ptr[0]) {
1798 /* pick the first language as the default */
1799 DPRINTFN(1, "Using first language\n");
1800 langid = UGETW(scratch_ptr + 2);
1803 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1804 udev->langid = langid;
1807 /* assume 100mA bus powered for now. Changed when configured. */
1808 udev->power = USB_MIN_POWER;
1809 /* fetch the vendor and product strings from the device */
1810 usbd_set_device_strings(udev);
1812 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1813 /* USB device mode setup is complete */
1819 * Most USB devices should attach to config index 0 by
1822 if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1825 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1828 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1831 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1834 } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1842 set_config_failed = 0;
1845 DPRINTF("setting config %u\n", config_index);
1847 /* get the USB device configured */
1848 err = usbd_set_config_index(udev, config_index);
1850 if (udev->ddesc.bNumConfigurations != 0) {
1851 if (!set_config_failed) {
1852 set_config_failed = 1;
1853 /* XXX try to re-enumerate the device */
1854 err = usbd_req_re_enumerate(udev, NULL);
1856 goto repeat_set_config;
1858 DPRINTFN(0, "Failure selecting configuration index %u:"
1859 "%s, port %u, addr %u (ignored)\n",
1860 config_index, usbd_errstr(err), udev->port_no,
1864 * Some USB devices do not have any configurations. Ignore any
1865 * set config failures!
1870 if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1871 if ((udev->cdesc->bNumInterface < 2) &&
1872 usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1873 DPRINTFN(0, "Found no endpoints, trying next config\n");
1875 goto repeat_set_config;
1877 if (config_index == 0) {
1879 * Try to figure out if we have an
1880 * auto-install disk there:
1882 if (usb_iface_is_cdrom(udev, 0)) {
1883 DPRINTFN(0, "Found possible auto-install "
1884 "disk (trying next config)\n");
1886 goto repeat_set_config;
1890 if (set_config_failed == 0 && config_index == 0 &&
1891 usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1892 usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1895 * Try to figure out if there are any MSC quirks we
1896 * should apply automatically:
1898 err = usb_msc_auto_quirk(udev, 0);
1901 set_config_failed = 1;
1902 goto repeat_set_config;
1907 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1908 udev->address, udev, udev->parent_hub);
1910 /* register our device - we are ready */
1911 usb_bus_port_set_device(bus, parent_hub ?
1912 parent_hub->hub->ports + port_index : NULL, udev, device_index);
1915 /* Symlink the ugen device name */
1916 udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1918 /* Announce device */
1919 kprintf("%s: <%s> at %s\n", udev->ugen_name,
1920 usb_get_manufacturer(udev),
1921 device_get_nameunit(udev->bus->bdev));
1925 usb_notify_addq("ATTACH", udev);
1930 * Free USB device and all subdevices, if any.
1932 device_printf(bus->bdev,
1933 "Error during allocation of usb device\n");
1934 usb_free_device(udev, 0);
1941 struct usb_fs_privdata *
1942 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
1943 int fi, int rwmode, uid_t uid, gid_t gid, int mode)
1945 struct usb_fs_privdata* pd;
1948 /* Store information to locate ourselves again later */
1949 pd = kmalloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1951 pd->bus_index = device_get_unit(udev->bus->bdev);
1952 pd->dev_index = udev->device_index;
1954 pd->fifo_index = fi;
1957 /* Now, create the device itself */
1958 if (devname == NULL) {
1960 ksnprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
1961 pd->bus_index, pd->dev_index, pd->ep_addr);
1964 pd->cdev = make_dev(&usb_ops, 0, uid, gid, mode, "%s", devname);
1966 if (pd->cdev == NULL) {
1967 DPRINTFN(0, "Failed to create device %s\n", devname);
1968 kfree(pd, M_USBDEV);
1972 /* XXX setting si_drv1 and creating the device is not atomic! */
1973 pd->cdev->si_drv1 = pd;
1979 usb_destroy_dev(struct usb_fs_privdata *pd)
1984 destroy_dev(pd->cdev);
1986 kfree(pd, M_USBDEV);
1990 usb_cdev_create(struct usb_device *udev)
1992 struct usb_config_descriptor *cd;
1993 struct usb_endpoint_descriptor *ed;
1994 struct usb_descriptor *desc;
1995 struct usb_fs_privdata* pd;
1996 int inmode, outmode, inmask, outmask, mode;
1999 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2001 DPRINTFN(2, "Creating device nodes\n");
2003 if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2006 } else { /* USB_MODE_HOST */
2016 * Collect all used endpoint numbers instead of just
2017 * generating 16 static endpoints.
2019 cd = usbd_get_config_descriptor(udev);
2020 while ((desc = usb_desc_foreach(cd, desc))) {
2021 /* filter out all endpoint descriptors */
2022 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2023 (desc->bLength >= sizeof(*ed))) {
2024 ed = (struct usb_endpoint_descriptor *)desc;
2027 ep = ed->bEndpointAddress;
2028 if (UE_GET_DIR(ep) == UE_DIR_OUT)
2029 outmask |= 1 << UE_GET_ADDR(ep);
2031 inmask |= 1 << UE_GET_ADDR(ep);
2035 /* Create all available endpoints except EP0 */
2036 for (ep = 1; ep < 16; ep++) {
2037 mode = (inmask & (1 << ep)) ? inmode : 0;
2038 mode |= (outmask & (1 << ep)) ? outmode : 0;
2040 continue; /* no IN or OUT endpoint */
2042 pd = usb_make_dev(udev, NULL, ep, 0,
2043 mode, UID_ROOT, GID_OPERATOR, 0600);
2046 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2051 usb_cdev_free(struct usb_device *udev)
2053 struct usb_fs_privdata* pd;
2055 DPRINTFN(2, "Freeing device nodes\n");
2057 while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2058 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2060 LIST_REMOVE(pd, pd_next);
2062 usb_destroy_dev(pd);
2067 /*------------------------------------------------------------------------*
2070 * This function is NULL safe and will free an USB device and its
2071 * children devices, if any.
2073 * Flag values: Reserved, set to zero.
2074 *------------------------------------------------------------------------*/
2076 usb_free_device(struct usb_device *udev, uint8_t flag)
2078 struct usb_bus *bus;
2081 return; /* already freed */
2083 DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2086 usb_set_device_state(udev, USB_STATE_DETACHED);
2089 usb_notify_addq("DETACH", udev);
2093 kprintf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2094 usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2096 /* Destroy UGEN symlink, if any */
2097 if (udev->ugen_symlink) {
2098 usb_free_symlink(udev->ugen_symlink);
2099 udev->ugen_symlink = NULL;
2103 * Unregister our device first which will prevent any further
2106 usb_bus_port_set_device(bus, udev->parent_hub ?
2107 udev->parent_hub->hub->ports + udev->port_index : NULL,
2108 NULL, USB_ROOT_HUB_ADDR);
2111 /* wait for all pending references to go away: */
2112 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
2114 while (udev->refcount != 0) {
2115 cv_wait(&udev->ref_cv, &usb_ref_lock);
2117 lockmgr(&usb_ref_lock, LK_RELEASE);
2119 usb_destroy_dev(udev->ctrl_dev);
2122 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2123 /* stop receiving any control transfers (Device Side Mode) */
2124 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2127 /* the following will get the device unconfigured in software */
2128 usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2130 /* unsetup any leftover default USB transfers */
2131 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2133 /* template unsetup, if any */
2134 (usb_temp_unsetup_p) (udev);
2137 * Make sure that our clear-stall messages are not queued
2140 USB_BUS_LOCK(udev->bus);
2141 usb_proc_mwait(&udev->bus->non_giant_callback_proc,
2142 &udev->cs_msg[0], &udev->cs_msg[1]);
2143 USB_BUS_UNLOCK(udev->bus);
2145 lockuninit(&udev->ctrl_lock);
2146 lockuninit(&udev->enum_lock);
2147 lockuninit(&udev->sr_lock);
2149 cv_destroy(&udev->ctrlreq_cv);
2150 cv_destroy(&udev->ref_cv);
2152 lockuninit(&udev->device_lock);
2154 KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2157 /* Uninitialise device */
2158 if (bus->methods->device_uninit != NULL)
2159 (bus->methods->device_uninit) (udev);
2163 kfree(udev->serial, M_USB);
2164 if(udev->manufacturer)
2165 kfree(udev->manufacturer, M_USB);
2167 kfree(udev->product, M_USB);
2171 /*------------------------------------------------------------------------*
2174 * This function is the safe way to get the USB interface structure
2175 * pointer by interface index.
2178 * NULL: Interface not present.
2179 * Else: Pointer to USB interface structure.
2180 *------------------------------------------------------------------------*/
2181 struct usb_interface *
2182 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2184 struct usb_interface *iface = udev->ifaces + iface_index;
2186 if (iface_index >= udev->ifaces_max)
2191 /*------------------------------------------------------------------------*
2192 * usbd_find_descriptor
2194 * This function will lookup the first descriptor that matches the
2195 * criteria given by the arguments "type" and "subtype". Descriptors
2196 * will only be searched within the interface having the index
2197 * "iface_index". If the "id" argument points to an USB descriptor,
2198 * it will be skipped before the search is started. This allows
2199 * searching for multiple descriptors using the same criteria. Else
2200 * the search is started after the interface descriptor.
2203 * NULL: End of descriptors
2204 * Else: A descriptor matching the criteria
2205 *------------------------------------------------------------------------*/
2207 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2208 uint8_t type, uint8_t type_mask,
2209 uint8_t subtype, uint8_t subtype_mask)
2211 struct usb_descriptor *desc;
2212 struct usb_config_descriptor *cd;
2213 struct usb_interface *iface;
2215 cd = usbd_get_config_descriptor(udev);
2220 iface = usbd_get_iface(udev, iface_index);
2221 if (iface == NULL) {
2224 id = usbd_get_interface_descriptor(iface);
2231 while ((desc = usb_desc_foreach(cd, desc))) {
2233 if (desc->bDescriptorType == UDESC_INTERFACE) {
2236 if (((desc->bDescriptorType & type_mask) == type) &&
2237 ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2244 /*------------------------------------------------------------------------*
2247 * This function will dump information from the device descriptor
2248 * belonging to the USB device pointed to by "udev", to the string
2249 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2250 * including the terminating zero.
2251 *------------------------------------------------------------------------*/
2253 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2255 struct usb_device_descriptor *udd = &udev->ddesc;
2259 bcdUSB = UGETW(udd->bcdUSB);
2260 bcdDevice = UGETW(udd->bcdDevice);
2262 if (udd->bDeviceClass != 0xFF) {
2263 ksnprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2265 usb_get_manufacturer(udev),
2266 usb_get_product(udev),
2267 udd->bDeviceClass, udd->bDeviceSubClass,
2268 (bcdUSB >> 8), bcdUSB & 0xFF,
2269 (bcdDevice >> 8), bcdDevice & 0xFF,
2272 ksnprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2274 usb_get_manufacturer(udev),
2275 usb_get_product(udev),
2276 (bcdUSB >> 8), bcdUSB & 0xFF,
2277 (bcdDevice >> 8), bcdDevice & 0xFF,
2284 * Descriptions of of known vendors and devices ("products").
2286 struct usb_knowndev {
2290 const char *vendorname;
2291 const char *productname;
2294 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2296 #include "usbdevs.h"
2297 #include "usbdevs_data.h"
2298 #endif /* USB_VERBOSE */
2301 usbd_set_device_strings(struct usb_device *udev)
2303 struct usb_device_descriptor *udd = &udev->ddesc;
2305 const struct usb_knowndev *kdp;
2310 uint16_t product_id;
2312 temp_ptr = (char *)udev->bus->scratch[0].data;
2313 temp_size = sizeof(udev->bus->scratch[0].data);
2315 vendor_id = UGETW(udd->idVendor);
2316 product_id = UGETW(udd->idProduct);
2318 /* get serial number string */
2319 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2320 udev->ddesc.iSerialNumber);
2321 udev->serial = kstrdup(temp_ptr, M_USB);
2323 /* get manufacturer string */
2324 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2325 udev->ddesc.iManufacturer);
2326 usb_trim_spaces(temp_ptr);
2327 if (temp_ptr[0] != '\0')
2328 udev->manufacturer = kstrdup(temp_ptr, M_USB);
2330 /* get product string */
2331 usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2332 udev->ddesc.iProduct);
2333 usb_trim_spaces(temp_ptr);
2334 if (temp_ptr[0] != '\0')
2335 udev->product = kstrdup(temp_ptr, M_USB);
2338 if (udev->manufacturer == NULL || udev->product == NULL) {
2339 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2340 if (kdp->vendor == vendor_id &&
2341 (kdp->product == product_id ||
2342 (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2345 if (kdp->vendorname != NULL) {
2346 /* XXX should use pointer to knowndevs string */
2347 if (udev->manufacturer == NULL) {
2348 udev->manufacturer = kstrdup(kdp->vendorname,
2351 if (udev->product == NULL &&
2352 (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2353 udev->product = kstrdup(kdp->productname,
2359 /* Provide default strings if none were found */
2360 if (udev->manufacturer == NULL) {
2361 ksnprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2362 udev->manufacturer = kstrdup(temp_ptr, M_USB);
2364 if (udev->product == NULL) {
2365 ksnprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2366 udev->product = kstrdup(temp_ptr, M_USB);
2375 usbd_get_mode(struct usb_device *udev)
2377 return (udev->flags.usb_mode);
2382 * See: USB_SPEED_XXX
2385 usbd_get_speed(struct usb_device *udev)
2387 return (udev->speed);
2391 usbd_get_isoc_fps(struct usb_device *udev)
2394 switch (udev->speed) {
2396 case USB_SPEED_FULL:
2403 struct usb_device_descriptor *
2404 usbd_get_device_descriptor(struct usb_device *udev)
2407 return (NULL); /* be NULL safe */
2408 return (&udev->ddesc);
2411 struct usb_config_descriptor *
2412 usbd_get_config_descriptor(struct usb_device *udev)
2415 return (NULL); /* be NULL safe */
2416 return (udev->cdesc);
2419 /*------------------------------------------------------------------------*
2420 * usb_test_quirk - test a device for a given quirk
2423 * 0: The USB device does not have the given quirk.
2424 * Else: The USB device has the given quirk.
2425 *------------------------------------------------------------------------*/
2427 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2432 if (quirk == UQ_NONE)
2435 /* search the automatic per device quirks first */
2437 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2438 if (uaa->device->autoQuirk[x] == quirk)
2442 /* search global quirk table, if any */
2444 found = (usb_test_quirk_p) (&uaa->info, quirk);
2449 struct usb_interface_descriptor *
2450 usbd_get_interface_descriptor(struct usb_interface *iface)
2453 return (NULL); /* be NULL safe */
2454 return (iface->idesc);
2458 usbd_get_interface_altindex(struct usb_interface *iface)
2460 return (iface->alt_index);
2464 usbd_get_bus_index(struct usb_device *udev)
2466 return ((uint8_t)device_get_unit(udev->bus->bdev));
2470 usbd_get_device_index(struct usb_device *udev)
2472 return (udev->device_index);
2477 usb_notify_addq(const char *type, struct usb_device *udev)
2479 struct usb_interface *iface;
2483 /* announce the device */
2484 sb = sbuf_new(NULL, NULL, 4096, SBUF_AUTOEXTEND);
2493 "devsubclass=0x%02x "
2506 UGETW(udev->ddesc.idVendor),
2507 UGETW(udev->ddesc.idProduct),
2508 udev->ddesc.bDeviceClass,
2509 udev->ddesc.bDeviceSubClass,
2510 usb_get_serial(udev),
2511 UGETW(udev->ddesc.bcdDevice),
2512 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2515 , udev->parent_hub != NULL ?
2516 udev->parent_hub->ugen_name :
2517 device_get_nameunit(device_get_parent(udev->bus->bdev))
2521 devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2524 /* announce each interface */
2525 for (i = 0; i < USB_IFACE_MAX; i++) {
2526 iface = usbd_get_iface(udev, i);
2528 break; /* end of interfaces */
2529 if (iface->idesc == NULL)
2530 continue; /* no interface descriptor */
2533 sb = sbuf_new(NULL, NULL, 4096, SBUF_AUTOEXTEND);
2542 "devsubclass=0x%02x "
2549 "intsubclass=0x%02x "
2550 "intprotocol=0x%02x",
2555 UGETW(udev->ddesc.idVendor),
2556 UGETW(udev->ddesc.idProduct),
2557 udev->ddesc.bDeviceClass,
2558 udev->ddesc.bDeviceSubClass,
2559 usb_get_serial(udev),
2560 UGETW(udev->ddesc.bcdDevice),
2561 (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2562 iface->idesc->bInterfaceNumber,
2563 iface->idesc->bNumEndpoints,
2564 iface->idesc->bInterfaceClass,
2565 iface->idesc->bInterfaceSubClass,
2566 iface->idesc->bInterfaceProtocol);
2568 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2575 /*------------------------------------------------------------------------*
2576 * usb_fifo_free_wrap
2578 * This function will free the FIFOs.
2580 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2581 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2582 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2583 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2584 * control endpoint FIFOs. If "iface_index" is not set to
2585 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2586 *------------------------------------------------------------------------*/
2588 usb_fifo_free_wrap(struct usb_device *udev,
2589 uint8_t iface_index, uint8_t flag)
2595 * Free any USB FIFOs on the given interface:
2597 for (i = 0; i != USB_FIFO_MAX; i++) {
2602 /* Check if the interface index matches */
2603 if (iface_index == f->iface_index) {
2604 if (f->methods != &usb_ugen_methods) {
2606 * Don't free any non-generic FIFOs in
2611 if ((f->dev_ep_index == 0) &&
2612 (f->fs_xfer == NULL)) {
2613 /* no need to free this FIFO */
2616 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2617 if ((f->methods == &usb_ugen_methods) &&
2618 (f->dev_ep_index == 0) &&
2619 (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2620 (f->fs_xfer == NULL)) {
2621 /* no need to free this FIFO */
2625 /* no need to free this FIFO */
2628 /* free this FIFO */
2634 /*------------------------------------------------------------------------*
2635 * usb_peer_can_wakeup
2638 * 0: Peer cannot do resume signalling.
2639 * Else: Peer can do resume signalling.
2640 *------------------------------------------------------------------------*/
2642 usb_peer_can_wakeup(struct usb_device *udev)
2644 const struct usb_config_descriptor *cdp;
2647 if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2648 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2650 return (0); /* not supported */
2654 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2657 KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2659 DPRINTF("udev %p state %s -> %s\n", udev,
2660 usb_statestr(udev->state), usb_statestr(state));
2661 udev->state = state;
2663 if (udev->bus->methods->device_state_change != NULL)
2664 (udev->bus->methods->device_state_change) (udev);
2668 usb_get_device_state(struct usb_device *udev)
2671 return (USB_STATE_DETACHED);
2672 return (udev->state);
2676 usbd_device_attached(struct usb_device *udev)
2678 return (udev->state > USB_STATE_DETACHED);
2681 /* The following function locks enumerating the given USB device. */
2684 usbd_enum_lock(struct usb_device *udev)
2686 lockmgr(&udev->enum_lock, LK_EXCLUSIVE);
2687 lockmgr(&udev->sr_lock, LK_EXCLUSIVE);
2689 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2690 * are locked before locking Giant. Else the lock can be
2691 * locked multiple times.
2698 /* The following function unlocks enumerating the given USB device. */
2701 usbd_enum_unlock(struct usb_device *udev)
2706 lockmgr(&udev->enum_lock, LK_RELEASE);
2707 lockmgr(&udev->sr_lock, LK_RELEASE);
2710 /* The following function locks suspend and resume. */
2713 usbd_sr_lock(struct usb_device *udev)
2715 lockmgr(&udev->sr_lock, LK_EXCLUSIVE);
2717 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2718 * are locked before locking Giant. Else the lock can be
2719 * locked multiple times.
2726 /* The following function unlocks suspend and resume. */
2729 usbd_sr_unlock(struct usb_device *udev)
2734 lockmgr(&udev->sr_lock, LK_RELEASE);
2738 * The following function checks the enumerating lock for the given
2743 usbd_enum_is_locked(struct usb_device *udev)
2745 /* XXX: Make sure that we return a correct value here */
2746 return (lockowned(&udev->enum_lock));
2750 * The following function is used to set the per-interface specific
2751 * plug and play information. The string referred to by the pnpinfo
2752 * argument can safely be freed after calling this function. The
2753 * pnpinfo of an interface will be reset at device detach or when
2754 * passing a NULL argument to this function. This function
2755 * returns zero on success, else a USB_ERR_XXX failure code.
2759 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2761 struct usb_interface *iface;
2763 iface = usbd_get_iface(udev, iface_index);
2765 return (USB_ERR_INVAL);
2767 if (iface->pnpinfo != NULL) {
2768 kfree(iface->pnpinfo, M_USBDEV);
2769 iface->pnpinfo = NULL;
2772 if (pnpinfo == NULL || pnpinfo[0] == 0)
2773 return (0); /* success */
2775 iface->pnpinfo = kstrdup(pnpinfo, M_USBDEV);
2776 if (iface->pnpinfo == NULL)
2777 return (USB_ERR_NOMEM);
2779 return (0); /* success */
2783 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2787 for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2788 if (udev->autoQuirk[x] == 0 ||
2789 udev->autoQuirk[x] == quirk) {
2790 udev->autoQuirk[x] = quirk;
2791 return (0); /* success */
2794 return (USB_ERR_NOMEM);
2798 * The following function is used to select the endpoint mode. It
2799 * should not be called outside enumeration context.
2803 usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep,
2809 /* automatic locking */
2810 if (usbd_enum_is_locked(udev)) {
2814 usbd_enum_lock(udev);
2817 if (udev->bus->methods->set_endpoint_mode != NULL) {
2818 error = (udev->bus->methods->set_endpoint_mode) (
2820 } else if (ep_mode != USB_EP_MODE_DEFAULT) {
2821 error = USB_ERR_INVAL;
2826 /* only set new mode regardless of error */
2827 ep->ep_mode = ep_mode;
2830 usbd_enum_unlock(udev);
2836 usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep)
2838 return (ep->ep_mode);