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 MECHANTABILITY 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
) &&
334 /*------------------------------------------------------------------------*
335 * usbd_interface_count
337 * This function stores the number of USB interfaces excluding
338 * alternate settings, which the USB config descriptor reports into
339 * the unsigned 8-bit integer pointed to by "count".
344 *------------------------------------------------------------------------*/
346 usbd_interface_count(struct usb_device
*udev
, uint8_t *count
)
348 if (udev
->cdesc
== NULL
) {
350 return (USB_ERR_NOT_CONFIGURED
);
352 *count
= udev
->ifaces_max
;
353 return (USB_ERR_NORMAL_COMPLETION
);
356 /*------------------------------------------------------------------------*
359 * This function will initialise the USB endpoint structure pointed to by
360 * the "endpoint" argument. The structure pointed to by "endpoint" must be
361 * zeroed before calling this function.
362 *------------------------------------------------------------------------*/
364 usb_init_endpoint(struct usb_device
*udev
, uint8_t iface_index
,
365 struct usb_endpoint_descriptor
*edesc
,
366 struct usb_endpoint_ss_comp_descriptor
*ecomp
,
367 struct usb_endpoint
*ep
)
369 struct usb_bus_methods
*methods
;
372 methods
= udev
->bus
->methods
;
374 (methods
->endpoint_init
) (udev
, edesc
, ep
);
376 /* initialise USB endpoint structure */
379 ep
->iface_index
= iface_index
;
381 for (x
= 0; x
!= USB_MAX_EP_STREAMS
; x
++) {
382 TAILQ_INIT(&ep
->endpoint_q
[x
].head
);
383 ep
->endpoint_q
[x
].command
= &usbd_pipe_start
;
386 /* the pipe is not supported by the hardware */
387 if (ep
->methods
== NULL
)
390 /* check for SUPER-speed streams mode endpoint */
391 if (udev
->speed
== USB_SPEED_SUPER
&& ecomp
!= NULL
&&
392 (edesc
->bmAttributes
& UE_XFERTYPE
) == UE_BULK
&&
393 (UE_GET_BULK_STREAMS(ecomp
->bmAttributes
) != 0)) {
394 usbd_set_endpoint_mode(udev
, ep
, USB_EP_MODE_STREAMS
);
396 usbd_set_endpoint_mode(udev
, ep
, USB_EP_MODE_DEFAULT
);
399 /* clear stall, if any */
400 if (methods
->clear_stall
!= NULL
) {
401 USB_BUS_LOCK(udev
->bus
);
402 (methods
->clear_stall
) (udev
, ep
);
403 USB_BUS_UNLOCK(udev
->bus
);
407 /*-----------------------------------------------------------------------*
408 * usb_endpoint_foreach
410 * This function will iterate all the USB endpoints except the control
411 * endpoint. This function is NULL safe.
414 * NULL: End of USB endpoints
415 * Else: Pointer to next USB endpoint
416 *------------------------------------------------------------------------*/
417 struct usb_endpoint
*
418 usb_endpoint_foreach(struct usb_device
*udev
, struct usb_endpoint
*ep
)
420 struct usb_endpoint
*ep_end
;
426 ep_end
= udev
->endpoints
+ udev
->endpoints_max
;
428 /* get next endpoint */
430 ep
= udev
->endpoints
;
434 /* find next allocated ep */
435 while (ep
!= ep_end
) {
436 if (ep
->edesc
!= NULL
)
443 /*------------------------------------------------------------------------*
446 * This function will free all USB interfaces and USB endpoints belonging
449 * Flag values, see "USB_UNCFG_FLAG_XXX".
450 *------------------------------------------------------------------------*/
452 usb_unconfigure(struct usb_device
*udev
, uint8_t flag
)
456 /* automatic locking */
457 if (usbd_enum_is_locked(udev
)) {
461 usbd_enum_lock(udev
);
464 /* detach all interface drivers */
465 usb_detach_device(udev
, USB_IFACE_INDEX_ANY
, flag
);
468 /* free all FIFOs except control endpoint FIFOs */
469 usb_fifo_free_wrap(udev
, USB_IFACE_INDEX_ANY
, flag
);
472 * Free all cdev's, if any.
477 #if USB_HAVE_COMPAT_LINUX
478 /* free Linux compat device, if any */
479 if (udev
->linux_endpoint_start
) {
480 usb_linux_free_device(udev
);
481 udev
->linux_endpoint_start
= NULL
;
485 usb_config_parse(udev
, USB_IFACE_INDEX_ANY
, USB_CFG_FREE
);
487 /* free "cdesc" after "ifaces" and "endpoints", if any */
488 if (udev
->cdesc
!= NULL
) {
489 if (udev
->flags
.usb_mode
!= USB_MODE_DEVICE
)
490 kfree(udev
->cdesc
, M_USB
);
493 /* set unconfigured state */
494 udev
->curr_config_no
= USB_UNCONFIG_NO
;
495 udev
->curr_config_index
= USB_UNCONFIG_INDEX
;
498 usbd_enum_unlock(udev
);
501 /*------------------------------------------------------------------------*
502 * usbd_set_config_index
504 * This function selects configuration by index, independent of the
505 * actual configuration number. This function should not be used by
511 *------------------------------------------------------------------------*/
513 usbd_set_config_index(struct usb_device
*udev
, uint8_t index
)
515 struct usb_status ds
;
516 struct usb_config_descriptor
*cdp
;
523 DPRINTFN(6, "udev=%p index=%d\n", udev
, index
);
525 /* automatic locking */
526 if (usbd_enum_is_locked(udev
)) {
530 usbd_enum_lock(udev
);
533 usb_unconfigure(udev
, 0);
535 if (index
== USB_UNCONFIG_INDEX
) {
537 * Leave unallocated when unconfiguring the
538 * device. "usb_unconfigure()" will also reset
539 * the current config number and index.
541 err
= usbd_req_set_config(udev
, NULL
, USB_UNCONFIG_NO
);
542 if (udev
->state
== USB_STATE_CONFIGURED
)
543 usb_set_device_state(udev
, USB_STATE_ADDRESSED
);
546 /* get the full config descriptor */
547 if (udev
->flags
.usb_mode
== USB_MODE_DEVICE
) {
548 /* save some memory */
549 err
= usbd_req_get_descriptor_ptr(udev
, &cdp
,
550 (UDESC_CONFIG
<< 8) | index
);
553 err
= usbd_req_get_config_desc_full(udev
,
554 NULL
, &cdp
, M_USB
, index
);
559 /* set the new config descriptor */
563 /* Figure out if the device is self or bus powered. */
565 if ((!udev
->flags
.uq_bus_powered
) &&
566 (cdp
->bmAttributes
& UC_SELF_POWERED
) &&
567 (udev
->flags
.usb_mode
== USB_MODE_HOST
)) {
568 /* May be self powered. */
569 if (cdp
->bmAttributes
& UC_BUS_POWERED
) {
570 /* Must ask device. */
571 err
= usbd_req_get_device_status(udev
, NULL
, &ds
);
573 DPRINTFN(0, "could not read "
574 "device status: %s\n",
576 } else if (UGETW(ds
.wStatus
) & UDS_SELF_POWERED
) {
579 DPRINTF("status=0x%04x \n",
584 DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
585 "selfpowered=%d, power=%d\n",
587 udev
->address
, cdp
->bConfigurationValue
, cdp
->bmAttributes
,
588 selfpowered
, cdp
->bMaxPower
* 2);
590 /* Check if we have enough power. */
591 power
= cdp
->bMaxPower
* 2;
593 if (udev
->parent_hub
) {
594 max_power
= udev
->parent_hub
->hub
->portpower
;
596 max_power
= USB_MAX_POWER
;
599 if (power
> max_power
) {
600 DPRINTFN(0, "power exceeded %d > %d\n", power
, max_power
);
601 err
= USB_ERR_NO_POWER
;
604 /* Only update "self_powered" in USB Host Mode */
605 if (udev
->flags
.usb_mode
== USB_MODE_HOST
) {
606 udev
->flags
.self_powered
= selfpowered
;
609 udev
->curr_config_no
= cdp
->bConfigurationValue
;
610 udev
->curr_config_index
= index
;
611 usb_set_device_state(udev
, USB_STATE_CONFIGURED
);
613 /* Set the actual configuration value. */
614 err
= usbd_req_set_config(udev
, NULL
, cdp
->bConfigurationValue
);
619 err
= usb_config_parse(udev
, USB_IFACE_INDEX_ANY
, USB_CFG_ALLOC
);
624 err
= usb_config_parse(udev
, USB_IFACE_INDEX_ANY
, USB_CFG_INIT
);
630 /* create device nodes for each endpoint */
631 usb_cdev_create(udev
);
635 DPRINTF("error=%s\n", usbd_errstr(err
));
637 usb_unconfigure(udev
, 0);
640 usbd_enum_unlock(udev
);
644 /*------------------------------------------------------------------------*
647 * This function will allocate and free USB interfaces and USB endpoints,
648 * parse the USB configuration structure and initialise the USB endpoints
649 * and interfaces. If "iface_index" is not equal to
650 * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
651 * alternate_setting to be selected for the given interface. Else the
652 * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
653 * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
654 * is typically called when setting the configuration or when setting
655 * an alternate interface.
660 *------------------------------------------------------------------------*/
662 usb_config_parse(struct usb_device
*udev
, uint8_t iface_index
, uint8_t cmd
)
664 struct usb_idesc_parse_state ips
;
665 struct usb_interface_descriptor
*id
;
666 struct usb_endpoint_descriptor
*ed
;
667 struct usb_interface
*iface
;
668 struct usb_endpoint
*ep
;
676 if (iface_index
!= USB_IFACE_INDEX_ANY
) {
677 /* parameter overload */
687 DPRINTFN(5, "iface_index=%d cmd=%d\n",
690 if (cmd
== USB_CFG_FREE
)
693 if (cmd
== USB_CFG_INIT
) {
694 KKASSERT(lockowned(&udev
->enum_lock
));
696 /* check for in-use endpoints */
698 ep
= udev
->endpoints
;
699 ep_max
= udev
->endpoints_max
;
701 /* look for matching endpoints */
702 if ((iface_index
== USB_IFACE_INDEX_ANY
) ||
703 (iface_index
== ep
->iface_index
)) {
704 if (ep
->refcount_alloc
!= 0) {
706 * This typically indicates a
707 * more serious error.
709 err
= USB_ERR_IN_USE
;
712 memset(ep
, 0, sizeof(*ep
));
713 /* make sure we don't zero the endpoint again */
714 ep
->iface_index
= USB_IFACE_INDEX_ANY
;
724 memset(&ips
, 0, sizeof(ips
));
729 while ((id
= usb_idesc_foreach(udev
->cdesc
, &ips
))) {
731 /* check for interface overflow */
732 if (ips
.iface_index
== USB_IFACE_MAX
)
735 iface
= udev
->ifaces
+ ips
.iface_index
;
737 /* check for specific interface match */
739 if (cmd
== USB_CFG_INIT
) {
740 if ((iface_index
!= USB_IFACE_INDEX_ANY
) &&
741 (iface_index
!= ips
.iface_index
)) {
742 /* wrong interface */
744 } else if (alt_index
!= ips
.iface_index_alt
) {
745 /* wrong alternate setting */
748 /* initialise interface */
754 /* check for new interface */
755 if (ips
.iface_index_alt
== 0) {
756 /* update current number of endpoints */
761 /* setup the USB interface structure */
763 /* set alternate index */
764 iface
->alt_index
= alt_index
;
765 /* set default interface parent */
766 if (iface_index
== USB_IFACE_INDEX_ANY
) {
767 iface
->parent_iface_index
=
772 DPRINTFN(5, "found idesc nendpt=%d\n", id
->bNumEndpoints
);
774 ed
= (struct usb_endpoint_descriptor
*)id
;
778 /* iterate all the endpoint descriptors */
779 while ((ed
= usb_edesc_foreach(udev
->cdesc
, ed
))) {
781 if (temp
== USB_EP_MAX
)
784 ep
= udev
->endpoints
+ temp
;
789 ecomp
= usb_ed_comp_foreach(udev
->cdesc
, (void *)ed
);
791 DPRINTFN(5, "Found endpoint companion descriptor\n");
793 usb_init_endpoint(udev
,
794 ips
.iface_index
, ed
, ecomp
, ep
);
799 /* find maximum number of endpoints */
804 id
= (struct usb_interface_descriptor
*)ed
;
808 /* NOTE: It is valid to have no interfaces and no endpoints! */
810 if (cmd
== USB_CFG_ALLOC
) {
811 udev
->ifaces_max
= ips
.iface_index
;
813 if (udev
->ifaces_max
!= 0) {
814 udev
->ifaces
= kmalloc(sizeof(*iface
) * udev
->ifaces_max
,
815 M_USB
, M_WAITOK
| M_ZERO
);
816 if (udev
->ifaces
== NULL
) {
822 udev
->endpoints
= kmalloc(sizeof(*ep
) * ep_max
,
823 M_USB
, M_WAITOK
| M_ZERO
);
824 if (udev
->endpoints
== NULL
) {
829 udev
->endpoints
= NULL
;
831 USB_BUS_LOCK(udev
->bus
);
832 udev
->endpoints_max
= ep_max
;
833 /* reset any ongoing clear-stall */
834 udev
->ep_curr
= NULL
;
835 USB_BUS_UNLOCK(udev
->bus
);
840 if (cmd
== USB_CFG_ALLOC
) {
842 USB_BUS_LOCK(udev
->bus
);
843 udev
->endpoints_max
= 0;
844 /* reset any ongoing clear-stall */
845 udev
->ep_curr
= NULL
;
846 USB_BUS_UNLOCK(udev
->bus
);
849 if (udev
->ifaces
!= NULL
)
850 kfree(udev
->ifaces
, M_USB
);
851 if (udev
->endpoints
!= NULL
)
852 kfree(udev
->endpoints
, M_USB
);
855 udev
->endpoints
= NULL
;
856 udev
->ifaces_max
= 0;
862 /*------------------------------------------------------------------------*
863 * usbd_set_alt_interface_index
865 * This function will select an alternate interface index for the
866 * given interface index. The interface should not be in use when this
867 * function is called. That means there should not be any open USB
868 * transfers. Else an error is returned. If the alternate setting is
869 * already set this function will simply return success. This function
870 * is called in Host mode and Device mode!
875 *------------------------------------------------------------------------*/
877 usbd_set_alt_interface_index(struct usb_device
*udev
,
878 uint8_t iface_index
, uint8_t alt_index
)
880 struct usb_interface
*iface
= usbd_get_iface(udev
, iface_index
);
884 /* automatic locking */
885 if (usbd_enum_is_locked(udev
)) {
889 usbd_enum_lock(udev
);
895 if (iface
->alt_index
== alt_index
) {
897 * Optimise away duplicate setting of
898 * alternate setting in USB Host Mode!
905 * Free all generic FIFOs for this interface, except control
908 usb_fifo_free_wrap(udev
, iface_index
, 0);
911 err
= usb_config_parse(udev
, iface_index
, alt_index
);
915 if (iface
->alt_index
!= alt_index
) {
916 /* the alternate setting does not exist */
921 err
= usbd_req_set_alt_interface_no(udev
, NULL
, iface_index
,
922 iface
->idesc
->bAlternateSetting
);
926 usbd_enum_unlock(udev
);
931 /*------------------------------------------------------------------------*
932 * usbd_set_endpoint_stall
934 * This function is used to make a BULK or INTERRUPT endpoint send
935 * STALL tokens in USB device mode.
940 *------------------------------------------------------------------------*/
942 usbd_set_endpoint_stall(struct usb_device
*udev
, struct usb_endpoint
*ep
,
945 struct usb_xfer
*xfer
;
952 DPRINTF("Cannot find endpoint\n");
954 * Pretend that the clear or set stall request is
955 * successful else some USB host stacks can do
956 * strange things, especially when a control endpoint
961 et
= (ep
->edesc
->bmAttributes
& UE_XFERTYPE
);
963 if ((et
!= UE_BULK
) &&
964 (et
!= UE_INTERRUPT
)) {
966 * Should not stall control
967 * nor isochronous endpoints.
969 DPRINTF("Invalid endpoint\n");
972 USB_BUS_LOCK(udev
->bus
);
974 /* store current stall state */
975 was_stalled
= ep
->is_stalled
;
977 /* check for no change */
978 if (was_stalled
&& do_stall
) {
979 /* if the endpoint is already stalled do nothing */
980 USB_BUS_UNLOCK(udev
->bus
);
981 DPRINTF("No change\n");
984 /* set stalled state */
987 if (do_stall
|| (!was_stalled
)) {
989 for (x
= 0; x
!= USB_MAX_EP_STREAMS
; x
++) {
990 /* lookup the current USB transfer, if any */
991 xfer
= ep
->endpoint_q
[x
].curr
;
994 * The "xfer_stall" method
995 * will complete the USB
996 * transfer like in case of a
997 * timeout setting the error
998 * code "USB_ERR_STALLED".
1000 (udev
->bus
->methods
->xfer_stall
) (xfer
);
1004 (udev
->bus
->methods
->set_stall
) (udev
, ep
, &do_stall
);
1007 ep
->toggle_next
= 0; /* reset data toggle */
1008 ep
->is_stalled
= 0; /* clear stalled state */
1010 (udev
->bus
->methods
->clear_stall
) (udev
, ep
);
1012 /* start the current or next transfer, if any */
1013 for (x
= 0; x
!= USB_MAX_EP_STREAMS
; x
++) {
1014 usb_command_wrapper(&ep
->endpoint_q
[x
],
1015 ep
->endpoint_q
[x
].curr
);
1018 USB_BUS_UNLOCK(udev
->bus
);
1022 /*------------------------------------------------------------------------*
1023 * usb_reset_iface_endpoints - used in USB device side mode
1024 *------------------------------------------------------------------------*/
1026 usb_reset_iface_endpoints(struct usb_device
*udev
, uint8_t iface_index
)
1028 struct usb_endpoint
*ep
;
1029 struct usb_endpoint
*ep_end
;
1031 ep
= udev
->endpoints
;
1032 ep_end
= udev
->endpoints
+ udev
->endpoints_max
;
1034 for (; ep
!= ep_end
; ep
++) {
1036 if ((ep
->edesc
== NULL
) ||
1037 (ep
->iface_index
!= iface_index
)) {
1040 /* simulate a clear stall from the peer */
1041 usbd_set_endpoint_stall(udev
, ep
, 0);
1046 /*------------------------------------------------------------------------*
1047 * usb_detach_device_sub
1049 * This function will try to detach an USB device. If it fails a panic
1052 * Flag values, see "USB_UNCFG_FLAG_XXX".
1053 *------------------------------------------------------------------------*/
1055 usb_detach_device_sub(struct usb_device
*udev
, device_t
*ppdev
,
1056 char **ppnpinfo
, uint8_t flag
)
1065 * NOTE: It is important to clear "*ppdev" before deleting
1066 * the child due to some device methods being called late
1067 * during the delete process !
1071 device_printf(dev
, "at %s, port %d, addr %d "
1073 device_get_nameunit(udev
->parent_dev
),
1074 udev
->port_no
, udev
->address
);
1076 if (device_is_attached(dev
)) {
1077 if (udev
->flags
.peer_suspended
) {
1078 err
= DEVICE_RESUME(dev
);
1080 device_printf(dev
, "Resume failed\n");
1083 if (device_detach(dev
)) {
1087 if (device_delete_child(udev
->parent_dev
, dev
)) {
1092 pnpinfo
= *ppnpinfo
;
1093 if (pnpinfo
!= NULL
) {
1095 kfree(pnpinfo
, M_USBDEV
);
1100 /* Detach is not allowed to fail in the USB world */
1101 panic("usb_detach_device_sub: A USB driver would not detach\n");
1104 /*------------------------------------------------------------------------*
1107 * The following function will detach the matching interfaces.
1108 * This function is NULL safe.
1110 * Flag values, see "USB_UNCFG_FLAG_XXX".
1111 *------------------------------------------------------------------------*/
1113 usb_detach_device(struct usb_device
*udev
, uint8_t iface_index
,
1116 struct usb_interface
*iface
;
1123 DPRINTFN(4, "udev=%p\n", udev
);
1126 sx_assert(&udev
->enum_sx
, SA_LOCKED
);
1130 * First detach the child to give the child's detach routine a
1131 * chance to detach the sub-devices in the correct order.
1132 * Then delete the child using "device_delete_child()" which
1133 * will detach all sub-devices from the bottom and upwards!
1135 if (iface_index
!= USB_IFACE_INDEX_ANY
) {
1137 iface_index
= i
+ 1;
1140 iface_index
= USB_IFACE_MAX
;
1145 for (; i
!= iface_index
; i
++) {
1147 iface
= usbd_get_iface(udev
, i
);
1148 if (iface
== NULL
) {
1149 /* looks like the end of the USB interfaces */
1152 usb_detach_device_sub(udev
, &iface
->subdev
,
1153 &iface
->pnpinfo
, flag
);
1157 /*------------------------------------------------------------------------*
1158 * usb_probe_and_attach_sub
1163 *------------------------------------------------------------------------*/
1165 usb_probe_and_attach_sub(struct usb_device
*udev
,
1166 struct usb_attach_arg
*uaa
)
1168 struct usb_interface
*iface
;
1173 if (iface
->parent_iface_index
!= USB_IFACE_INDEX_ANY
) {
1174 /* leave interface alone */
1177 dev
= iface
->subdev
;
1180 /* clean up after module unload */
1182 if (device_is_attached(dev
)) {
1183 /* already a device there */
1186 /* clear "iface->subdev" as early as possible */
1188 iface
->subdev
= NULL
;
1190 if (device_delete_child(udev
->parent_dev
, dev
)) {
1193 * Panic here, else one can get a double call
1194 * to device_detach(). USB devices should
1195 * never fail on detach!
1197 panic("device_delete_child() failed\n");
1200 if (uaa
->temp_dev
== NULL
) {
1202 /* create a new child */
1203 uaa
->temp_dev
= device_add_child(udev
->parent_dev
, NULL
, -1);
1204 if (uaa
->temp_dev
== NULL
) {
1205 device_printf(udev
->parent_dev
,
1206 "Device creation failed\n");
1207 return (1); /* failure */
1209 device_set_ivars(uaa
->temp_dev
, uaa
);
1210 device_quiet(uaa
->temp_dev
);
1213 * Set "subdev" before probe and attach so that "devd" gets
1214 * the information it needs.
1216 iface
->subdev
= uaa
->temp_dev
;
1218 if (device_probe_and_attach(iface
->subdev
) == 0) {
1220 * The USB attach arguments are only available during probe
1223 uaa
->temp_dev
= NULL
;
1224 device_set_ivars(iface
->subdev
, NULL
);
1226 if (udev
->flags
.peer_suspended
) {
1227 err
= DEVICE_SUSPEND(iface
->subdev
);
1229 device_printf(iface
->subdev
, "Suspend failed\n");
1231 return (0); /* success */
1233 /* No USB driver found */
1234 iface
->subdev
= NULL
;
1236 return (1); /* failure */
1239 /*------------------------------------------------------------------------*
1240 * usbd_set_parent_iface
1242 * Using this function will lock the alternate interface setting on an
1243 * interface. It is typically used for multi interface drivers. In USB
1244 * device side mode it is assumed that the alternate interfaces all
1245 * have the same endpoint descriptors. The default parent index value
1246 * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1248 *------------------------------------------------------------------------*/
1250 usbd_set_parent_iface(struct usb_device
*udev
, uint8_t iface_index
,
1251 uint8_t parent_index
)
1253 struct usb_interface
*iface
;
1259 iface
= usbd_get_iface(udev
, iface_index
);
1261 iface
->parent_iface_index
= parent_index
;
1266 usb_init_attach_arg(struct usb_device
*udev
,
1267 struct usb_attach_arg
*uaa
)
1269 memset(uaa
, 0, sizeof(*uaa
));
1272 uaa
->usb_mode
= udev
->flags
.usb_mode
;
1273 uaa
->port
= udev
->port_no
;
1274 uaa
->dev_state
= UAA_DEV_READY
;
1276 uaa
->info
.idVendor
= UGETW(udev
->ddesc
.idVendor
);
1277 uaa
->info
.idProduct
= UGETW(udev
->ddesc
.idProduct
);
1278 uaa
->info
.bcdDevice
= UGETW(udev
->ddesc
.bcdDevice
);
1279 uaa
->info
.bDeviceClass
= udev
->ddesc
.bDeviceClass
;
1280 uaa
->info
.bDeviceSubClass
= udev
->ddesc
.bDeviceSubClass
;
1281 uaa
->info
.bDeviceProtocol
= udev
->ddesc
.bDeviceProtocol
;
1282 uaa
->info
.bConfigIndex
= udev
->curr_config_index
;
1283 uaa
->info
.bConfigNum
= udev
->curr_config_no
;
1286 /*------------------------------------------------------------------------*
1287 * usb_probe_and_attach
1289 * This function is called from "uhub_explore_sub()",
1290 * "usb_handle_set_config()" and "usb_handle_request()".
1294 * Else: A control transfer failed
1295 *------------------------------------------------------------------------*/
1297 usb_probe_and_attach(struct usb_device
*udev
, uint8_t iface_index
)
1299 struct usb_attach_arg uaa
;
1300 struct usb_interface
*iface
;
1306 DPRINTF("udev == NULL\n");
1307 return (USB_ERR_INVAL
);
1309 /* automatic locking */
1310 if (usbd_enum_is_locked(udev
)) {
1314 usbd_enum_lock(udev
);
1317 if (udev
->curr_config_index
== USB_UNCONFIG_INDEX
) {
1318 /* do nothing - no configuration has been set */
1321 /* setup USB attach arguments */
1323 usb_init_attach_arg(udev
, &uaa
);
1326 * If the whole USB device is targeted, invoke the USB event
1329 if (iface_index
== USB_IFACE_INDEX_ANY
) {
1331 EVENTHANDLER_INVOKE(usb_dev_configured
, udev
, &uaa
);
1333 if (uaa
.dev_state
!= UAA_DEV_READY
) {
1334 /* leave device unconfigured */
1335 usb_unconfigure(udev
, 0);
1340 /* Check if only one interface should be probed: */
1341 if (iface_index
!= USB_IFACE_INDEX_ANY
) {
1349 /* Do the probe and attach */
1350 for (; i
!= j
; i
++) {
1352 iface
= usbd_get_iface(udev
, i
);
1353 if (iface
== NULL
) {
1355 * Looks like the end of the USB
1358 DPRINTFN(2, "end of interfaces "
1362 if (iface
->idesc
== NULL
) {
1363 /* no interface descriptor */
1368 uaa
.info
.bInterfaceClass
=
1369 iface
->idesc
->bInterfaceClass
;
1370 uaa
.info
.bInterfaceSubClass
=
1371 iface
->idesc
->bInterfaceSubClass
;
1372 uaa
.info
.bInterfaceProtocol
=
1373 iface
->idesc
->bInterfaceProtocol
;
1374 uaa
.info
.bIfaceIndex
= i
;
1375 uaa
.info
.bIfaceNum
=
1376 iface
->idesc
->bInterfaceNumber
;
1377 uaa
.driver_info
= 0; /* reset driver_info */
1379 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1380 uaa
.info
.bInterfaceClass
,
1381 uaa
.info
.bInterfaceSubClass
,
1382 uaa
.info
.bInterfaceProtocol
,
1383 uaa
.info
.bIfaceIndex
,
1384 uaa
.info
.bIfaceNum
);
1386 usb_probe_and_attach_sub(udev
, &uaa
);
1389 * Remove the leftover child, if any, to enforce that
1390 * a new nomatch devd event is generated for the next
1391 * interface if no driver is found:
1393 if (uaa
.temp_dev
== NULL
)
1395 if (device_delete_child(udev
->parent_dev
, uaa
.temp_dev
))
1396 DPRINTFN(0, "device delete child failed\n");
1397 uaa
.temp_dev
= NULL
;
1401 usbd_enum_unlock(udev
);
1406 /*------------------------------------------------------------------------*
1407 * usb_suspend_resume_sub
1409 * This function is called when the suspend or resume methods should
1410 * be executed on an USB device.
1411 *------------------------------------------------------------------------*/
1413 usb_suspend_resume_sub(struct usb_device
*udev
, device_t dev
, uint8_t do_suspend
)
1420 if (!device_is_attached(dev
)) {
1424 err
= DEVICE_SUSPEND(dev
);
1426 err
= DEVICE_RESUME(dev
);
1429 device_printf(dev
, "%s failed\n",
1430 do_suspend
? "Suspend" : "Resume");
1434 /*------------------------------------------------------------------------*
1435 * usb_suspend_resume
1437 * The following function will suspend or resume the USB device.
1442 *------------------------------------------------------------------------*/
1444 usb_suspend_resume(struct usb_device
*udev
, uint8_t do_suspend
)
1446 struct usb_interface
*iface
;
1453 DPRINTFN(4, "udev=%p do_suspend=%d\n", udev
, do_suspend
);
1456 sx_assert(&udev
->sr_sx
, SA_LOCKED
);
1459 USB_BUS_LOCK(udev
->bus
);
1460 /* filter the suspend events */
1461 if (udev
->flags
.peer_suspended
== do_suspend
) {
1462 USB_BUS_UNLOCK(udev
->bus
);
1466 udev
->flags
.peer_suspended
= do_suspend
;
1467 USB_BUS_UNLOCK(udev
->bus
);
1469 /* do the suspend or resume */
1471 for (i
= 0; i
!= USB_IFACE_MAX
; i
++) {
1473 iface
= usbd_get_iface(udev
, i
);
1474 if (iface
== NULL
) {
1475 /* looks like the end of the USB interfaces */
1478 usb_suspend_resume_sub(udev
, iface
->subdev
, do_suspend
);
1483 /*------------------------------------------------------------------------*
1484 * usbd_clear_stall_proc
1486 * This function performs generic USB clear stall operations.
1487 *------------------------------------------------------------------------*/
1489 usbd_clear_stall_proc(struct usb_proc_msg
*_pm
)
1491 struct usb_clear_stall_msg
*pm
= (void *)_pm
;
1492 struct usb_device
*udev
= pm
->udev
;
1495 USB_BUS_UNLOCK(udev
->bus
);
1496 lockmgr(&udev
->device_lock
, LK_EXCLUSIVE
);
1498 /* Start clear stall callback */
1499 usbd_transfer_start(udev
->ctrl_xfer
[1]);
1502 lockmgr(&udev
->device_lock
, LK_RELEASE
);
1503 USB_BUS_LOCK(udev
->bus
);
1506 /*------------------------------------------------------------------------*
1509 * This function allocates a new USB device. This function is called
1510 * when a new device has been put in the powered state, but not yet in
1511 * the addressed state. Get initial descriptor, set the address, get
1512 * full descriptor and get strings.
1517 *------------------------------------------------------------------------*/
1519 usb_alloc_device(device_t parent_dev
, struct usb_bus
*bus
,
1520 struct usb_device
*parent_hub
, uint8_t depth
, uint8_t port_index
,
1521 uint8_t port_no
, enum usb_dev_speed speed
, enum usb_hc_mode mode
)
1523 struct usb_attach_arg uaa
;
1524 struct usb_device
*udev
;
1525 struct usb_device
*adev
;
1526 struct usb_device
*hub
;
1527 uint8_t *scratch_ptr
;
1528 size_t scratch_size
;
1530 uint8_t device_index
;
1531 uint8_t config_index
;
1532 uint8_t config_quirk
;
1533 uint8_t set_config_failed
;
1535 DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1536 "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1537 parent_dev
, bus
, parent_hub
, depth
, port_index
, port_no
,
1541 * Find an unused device index. In USB Host mode this is the
1542 * same as the device address.
1544 * Device index zero is not used and device index 1 should
1545 * always be the root hub.
1547 for (device_index
= USB_ROOT_HUB_ADDR
;
1548 (device_index
!= bus
->devices_max
) &&
1549 (bus
->devices
[device_index
] != NULL
);
1550 device_index
++) /* nop */;
1552 if (device_index
== bus
->devices_max
) {
1553 device_printf(bus
->bdev
,
1554 "No free USB device index for new device\n");
1559 device_printf(bus
->bdev
,
1560 "Invalid device depth\n");
1563 udev
= kmalloc(sizeof(*udev
), M_USB
, M_WAITOK
| M_ZERO
);
1566 device_printf(bus
->bdev
,
1567 "Allocation of usb device memory failed\n");
1571 /* initialise our SX-lock */
1572 sx_init_flags(&udev
->ctrl_sx
, "USB device SX lock", SX_DUPOK
);
1573 /* initialise our SX-lock */
1574 sx_init_flags(&udev
->enum_sx
, "USB config SX lock", SX_DUPOK
);
1575 sx_init_flags(&udev
->sr_sx
, "USB suspend and resume SX lock", SX_NOWITNESS
);
1577 lockinit(&udev
->ctrl_lock
, "USB device SX lock", 0, LK_CANRECURSE
);
1578 lockinit(&udev
->enum_lock
, "USB config SX lock", 0, LK_CANRECURSE
);
1579 lockinit(&udev
->sr_lock
, "USB suspend and resume SX lock", 0, 0);
1581 cv_init(&udev
->ctrlreq_cv
, "WCTRL");
1582 cv_init(&udev
->ref_cv
, "UGONE");
1584 /* initialise our mutex */
1585 lockinit(&udev
->device_lock
, "USB device mutex", 0, 0);
1587 /* initialise generic clear stall */
1588 udev
->cs_msg
[0].hdr
.pm_callback
= &usbd_clear_stall_proc
;
1589 udev
->cs_msg
[0].udev
= udev
;
1590 udev
->cs_msg
[1].hdr
.pm_callback
= &usbd_clear_stall_proc
;
1591 udev
->cs_msg
[1].udev
= udev
;
1593 /* initialise some USB device fields */
1594 udev
->parent_hub
= parent_hub
;
1595 udev
->parent_dev
= parent_dev
;
1596 udev
->port_index
= port_index
;
1597 udev
->port_no
= port_no
;
1598 udev
->depth
= depth
;
1600 udev
->address
= USB_START_ADDR
; /* default value */
1601 udev
->plugtime
= (usb_ticks_t
)ticks
;
1603 * We need to force the power mode to "on" because there are plenty
1604 * of USB devices out there that do not work very well with
1605 * automatic suspend and resume!
1607 udev
->power_mode
= usbd_filter_power_mode(udev
, USB_POWER_MODE_ON
);
1608 udev
->pwr_save
.last_xfer_time
= ticks
;
1609 /* we are not ready yet */
1612 /* set up default endpoint descriptor */
1613 udev
->ctrl_ep_desc
.bLength
= sizeof(udev
->ctrl_ep_desc
);
1614 udev
->ctrl_ep_desc
.bDescriptorType
= UDESC_ENDPOINT
;
1615 udev
->ctrl_ep_desc
.bEndpointAddress
= USB_CONTROL_ENDPOINT
;
1616 udev
->ctrl_ep_desc
.bmAttributes
= UE_CONTROL
;
1617 udev
->ctrl_ep_desc
.wMaxPacketSize
[0] = USB_MAX_IPACKET
;
1618 udev
->ctrl_ep_desc
.wMaxPacketSize
[1] = 0;
1619 udev
->ctrl_ep_desc
.bInterval
= 0;
1621 /* set up default endpoint companion descriptor */
1622 udev
->ctrl_ep_comp_desc
.bLength
= sizeof(udev
->ctrl_ep_comp_desc
);
1623 udev
->ctrl_ep_comp_desc
.bDescriptorType
= UDESC_ENDPOINT_SS_COMP
;
1625 udev
->ddesc
.bMaxPacketSize
= USB_MAX_IPACKET
;
1627 udev
->speed
= speed
;
1628 udev
->flags
.usb_mode
= mode
;
1630 /* search for our High Speed USB HUB, if any */
1633 hub
= udev
->parent_hub
;
1636 if (hub
->speed
== USB_SPEED_HIGH
) {
1637 udev
->hs_hub_addr
= hub
->address
;
1638 udev
->parent_hs_hub
= hub
;
1639 udev
->hs_port_no
= adev
->port_no
;
1643 hub
= hub
->parent_hub
;
1646 /* init the default endpoint */
1647 usb_init_endpoint(udev
, 0,
1648 &udev
->ctrl_ep_desc
,
1649 &udev
->ctrl_ep_comp_desc
,
1652 /* set device index */
1653 udev
->device_index
= device_index
;
1656 /* Create ugen name */
1657 ksnprintf(udev
->ugen_name
, sizeof(udev
->ugen_name
),
1658 USB_GENERIC_NAME
"%u.%u", device_get_unit(bus
->bdev
),
1660 LIST_INIT(&udev
->pd_list
);
1662 /* Create the control endpoint device */
1663 udev
->ctrl_dev
= usb_make_dev(udev
, NULL
, 0, 0,
1664 FREAD
|FWRITE
, UID_ROOT
, GID_OPERATOR
, 0600);
1666 /* Create a link from /dev/ugenX.X to the default endpoint */
1667 if (udev
->ctrl_dev
!= NULL
)
1668 make_dev_alias(udev
->ctrl_dev
->cdev
, "%s", udev
->ugen_name
);
1670 /* Initialise device */
1671 if (bus
->methods
->device_init
!= NULL
) {
1672 err
= (bus
->methods
->device_init
) (udev
);
1674 DPRINTFN(0, "device init %d failed "
1675 "(%s, ignored)\n", device_index
,
1680 /* set powered device state after device init is complete */
1681 usb_set_device_state(udev
, USB_STATE_POWERED
);
1683 if (udev
->flags
.usb_mode
== USB_MODE_HOST
) {
1685 err
= usbd_req_set_address(udev
, NULL
, device_index
);
1688 * This is the new USB device address from now on, if
1689 * the set address request didn't set it already.
1691 if (udev
->address
== USB_START_ADDR
)
1692 udev
->address
= device_index
;
1695 * We ignore any set-address errors, hence there are
1696 * buggy USB devices out there that actually receive
1697 * the SETUP PID, but manage to set the address before
1698 * the STATUS stage is ACK'ed. If the device responds
1699 * to the subsequent get-descriptor at the new
1700 * address, then we know that the set-address command
1704 DPRINTFN(0, "set address %d failed "
1705 "(%s, ignored)\n", udev
->address
,
1709 /* We are not self powered */
1710 udev
->flags
.self_powered
= 0;
1712 /* Set unconfigured state */
1713 udev
->curr_config_no
= USB_UNCONFIG_NO
;
1714 udev
->curr_config_index
= USB_UNCONFIG_INDEX
;
1716 /* Setup USB descriptors */
1717 err
= (usb_temp_setup_by_index_p
) (udev
, usb_template
);
1719 DPRINTFN(0, "setting up USB template failed maybe the USB "
1720 "template module has not been loaded\n");
1724 usb_set_device_state(udev
, USB_STATE_ADDRESSED
);
1726 /* setup the device descriptor and the initial "wMaxPacketSize" */
1727 err
= usbd_setup_device_desc(udev
, NULL
);
1730 /* XXX try to re-enumerate the device */
1731 err
= usbd_req_re_enumerate(udev
, NULL
);
1737 * Setup temporary USB attach args so that we can figure out some
1738 * basic quirks for this device.
1740 usb_init_attach_arg(udev
, &uaa
);
1742 if (usb_test_quirk(&uaa
, UQ_BUS_POWERED
)) {
1743 udev
->flags
.uq_bus_powered
= 1;
1745 if (usb_test_quirk(&uaa
, UQ_NO_STRINGS
)) {
1746 udev
->flags
.no_strings
= 1;
1749 * Workaround for buggy USB devices.
1751 * It appears that some string-less USB chips will crash and
1752 * disappear if any attempts are made to read any string
1755 * Try to detect such chips by checking the strings in the USB
1756 * device descriptor. If no strings are present there we
1757 * simply disable all USB strings.
1759 scratch_ptr
= udev
->bus
->scratch
[0].data
;
1760 scratch_size
= sizeof(udev
->bus
->scratch
[0].data
);
1762 if (udev
->ddesc
.iManufacturer
||
1763 udev
->ddesc
.iProduct
||
1764 udev
->ddesc
.iSerialNumber
) {
1765 /* read out the language ID string */
1766 err
= usbd_req_get_string_desc(udev
, NULL
,
1767 (char *)scratch_ptr
, 4, 0, USB_LANGUAGE_TABLE
);
1769 err
= USB_ERR_INVAL
;
1772 if (err
|| (scratch_ptr
[0] < 4)) {
1773 udev
->flags
.no_strings
= 1;
1780 /* load preferred value and mask */
1782 mask
= usb_lang_mask
;
1784 /* align length correctly */
1785 scratch_ptr
[0] &= ~1;
1787 /* fix compiler warning */
1790 /* search for preferred language */
1791 for (x
= 2; (x
< scratch_ptr
[0]); x
+= 2) {
1792 langid
= UGETW(scratch_ptr
+ x
);
1793 if ((langid
& mask
) == pref
)
1796 if (x
>= scratch_ptr
[0]) {
1797 /* pick the first language as the default */
1798 DPRINTFN(1, "Using first language\n");
1799 langid
= UGETW(scratch_ptr
+ 2);
1802 DPRINTFN(1, "Language selected: 0x%04x\n", langid
);
1803 udev
->langid
= langid
;
1806 /* assume 100mA bus powered for now. Changed when configured. */
1807 udev
->power
= USB_MIN_POWER
;
1808 /* fetch the vendor and product strings from the device */
1809 usbd_set_device_strings(udev
);
1811 if (udev
->flags
.usb_mode
== USB_MODE_DEVICE
) {
1812 /* USB device mode setup is complete */
1818 * Most USB devices should attach to config index 0 by
1821 if (usb_test_quirk(&uaa
, UQ_CFG_INDEX_0
)) {
1824 } else if (usb_test_quirk(&uaa
, UQ_CFG_INDEX_1
)) {
1827 } else if (usb_test_quirk(&uaa
, UQ_CFG_INDEX_2
)) {
1830 } else if (usb_test_quirk(&uaa
, UQ_CFG_INDEX_3
)) {
1833 } else if (usb_test_quirk(&uaa
, UQ_CFG_INDEX_4
)) {
1841 set_config_failed
= 0;
1844 DPRINTF("setting config %u\n", config_index
);
1846 /* get the USB device configured */
1847 err
= usbd_set_config_index(udev
, config_index
);
1849 if (udev
->ddesc
.bNumConfigurations
!= 0) {
1850 if (!set_config_failed
) {
1851 set_config_failed
= 1;
1852 /* XXX try to re-enumerate the device */
1853 err
= usbd_req_re_enumerate(udev
, NULL
);
1855 goto repeat_set_config
;
1857 DPRINTFN(0, "Failure selecting configuration index %u:"
1858 "%s, port %u, addr %u (ignored)\n",
1859 config_index
, usbd_errstr(err
), udev
->port_no
,
1863 * Some USB devices do not have any configurations. Ignore any
1864 * set config failures!
1869 if (!config_quirk
&& config_index
+ 1 < udev
->ddesc
.bNumConfigurations
) {
1870 if ((udev
->cdesc
->bNumInterface
< 2) &&
1871 usbd_get_no_descriptors(udev
->cdesc
, UDESC_ENDPOINT
) == 0) {
1872 DPRINTFN(0, "Found no endpoints, trying next config\n");
1874 goto repeat_set_config
;
1876 if (config_index
== 0) {
1878 * Try to figure out if we have an
1879 * auto-install disk there:
1881 if (usb_iface_is_cdrom(udev
, 0)) {
1882 DPRINTFN(0, "Found possible auto-install "
1883 "disk (trying next config)\n");
1885 goto repeat_set_config
;
1889 if (set_config_failed
== 0 && config_index
== 0 &&
1890 usb_test_quirk(&uaa
, UQ_MSC_NO_SYNC_CACHE
) == 0 &&
1891 usb_test_quirk(&uaa
, UQ_MSC_NO_GETMAXLUN
) == 0) {
1894 * Try to figure out if there are any MSC quirks we
1895 * should apply automatically:
1897 err
= usb_msc_auto_quirk(udev
, 0);
1900 set_config_failed
= 1;
1901 goto repeat_set_config
;
1906 DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1907 udev
->address
, udev
, udev
->parent_hub
);
1909 /* register our device - we are ready */
1910 usb_bus_port_set_device(bus
, parent_hub
?
1911 parent_hub
->hub
->ports
+ port_index
: NULL
, udev
, device_index
);
1914 /* Symlink the ugen device name */
1915 udev
->ugen_symlink
= usb_alloc_symlink(udev
->ugen_name
);
1917 /* Announce device */
1918 kprintf("%s: <%s> at %s\n", udev
->ugen_name
,
1919 usb_get_manufacturer(udev
),
1920 device_get_nameunit(udev
->bus
->bdev
));
1924 usb_notify_addq("ATTACH", udev
);
1929 * Free USB device and all subdevices, if any.
1931 device_printf(bus
->bdev
,
1932 "Error during allocation of usb device\n");
1933 usb_free_device(udev
, 0);
1940 struct usb_fs_privdata
*
1941 usb_make_dev(struct usb_device
*udev
, const char *devname
, int ep
,
1942 int fi
, int rwmode
, uid_t uid
, gid_t gid
, int mode
)
1944 struct usb_fs_privdata
* pd
;
1947 /* Store information to locate ourselves again later */
1948 pd
= kmalloc(sizeof(struct usb_fs_privdata
), M_USBDEV
,
1950 pd
->bus_index
= device_get_unit(udev
->bus
->bdev
);
1951 pd
->dev_index
= udev
->device_index
;
1953 pd
->fifo_index
= fi
;
1956 /* Now, create the device itself */
1957 if (devname
== NULL
) {
1959 ksnprintf(buffer
, sizeof(buffer
), USB_DEVICE_DIR
"/%u.%u.%u",
1960 pd
->bus_index
, pd
->dev_index
, pd
->ep_addr
);
1963 pd
->cdev
= make_dev(&usb_ops
, 0, uid
, gid
, mode
, "%s", devname
);
1965 if (pd
->cdev
== NULL
) {
1966 DPRINTFN(0, "Failed to create device %s\n", devname
);
1967 kfree(pd
, M_USBDEV
);
1971 /* XXX setting si_drv1 and creating the device is not atomic! */
1972 pd
->cdev
->si_drv1
= pd
;
1978 usb_destroy_dev(struct usb_fs_privdata
*pd
)
1983 destroy_dev(pd
->cdev
);
1985 kfree(pd
, M_USBDEV
);
1989 usb_cdev_create(struct usb_device
*udev
)
1991 struct usb_config_descriptor
*cd
;
1992 struct usb_endpoint_descriptor
*ed
;
1993 struct usb_descriptor
*desc
;
1994 struct usb_fs_privdata
* pd
;
1995 int inmode
, outmode
, inmask
, outmask
, mode
;
1998 KASSERT(LIST_FIRST(&udev
->pd_list
) == NULL
, ("stale cdev entries"));
2000 DPRINTFN(2, "Creating device nodes\n");
2002 if (usbd_get_mode(udev
) == USB_MODE_DEVICE
) {
2005 } else { /* USB_MODE_HOST */
2015 * Collect all used endpoint numbers instead of just
2016 * generating 16 static endpoints.
2018 cd
= usbd_get_config_descriptor(udev
);
2019 while ((desc
= usb_desc_foreach(cd
, desc
))) {
2020 /* filter out all endpoint descriptors */
2021 if ((desc
->bDescriptorType
== UDESC_ENDPOINT
) &&
2022 (desc
->bLength
>= sizeof(*ed
))) {
2023 ed
= (struct usb_endpoint_descriptor
*)desc
;
2026 ep
= ed
->bEndpointAddress
;
2027 if (UE_GET_DIR(ep
) == UE_DIR_OUT
)
2028 outmask
|= 1 << UE_GET_ADDR(ep
);
2030 inmask
|= 1 << UE_GET_ADDR(ep
);
2034 /* Create all available endpoints except EP0 */
2035 for (ep
= 1; ep
< 16; ep
++) {
2036 mode
= (inmask
& (1 << ep
)) ? inmode
: 0;
2037 mode
|= (outmask
& (1 << ep
)) ? outmode
: 0;
2039 continue; /* no IN or OUT endpoint */
2041 pd
= usb_make_dev(udev
, NULL
, ep
, 0,
2042 mode
, UID_ROOT
, GID_OPERATOR
, 0600);
2045 LIST_INSERT_HEAD(&udev
->pd_list
, pd
, pd_next
);
2050 usb_cdev_free(struct usb_device
*udev
)
2052 struct usb_fs_privdata
* pd
;
2054 DPRINTFN(2, "Freeing device nodes\n");
2056 while ((pd
= LIST_FIRST(&udev
->pd_list
)) != NULL
) {
2057 KASSERT(pd
->cdev
->si_drv1
== pd
, ("privdata corrupt"));
2059 LIST_REMOVE(pd
, pd_next
);
2061 usb_destroy_dev(pd
);
2066 /*------------------------------------------------------------------------*
2069 * This function is NULL safe and will free an USB device and its
2070 * children devices, if any.
2072 * Flag values: Reserved, set to zero.
2073 *------------------------------------------------------------------------*/
2075 usb_free_device(struct usb_device
*udev
, uint8_t flag
)
2077 struct usb_bus
*bus
;
2080 return; /* already freed */
2082 DPRINTFN(4, "udev=%p port=%d\n", udev
, udev
->port_no
);
2085 usb_set_device_state(udev
, USB_STATE_DETACHED
);
2088 usb_notify_addq("DETACH", udev
);
2092 kprintf("%s: <%s> at %s (disconnected)\n", udev
->ugen_name
,
2093 usb_get_manufacturer(udev
), device_get_nameunit(bus
->bdev
));
2095 /* Destroy UGEN symlink, if any */
2096 if (udev
->ugen_symlink
) {
2097 usb_free_symlink(udev
->ugen_symlink
);
2098 udev
->ugen_symlink
= NULL
;
2102 * Unregister our device first which will prevent any further
2105 usb_bus_port_set_device(bus
, udev
->parent_hub
?
2106 udev
->parent_hub
->hub
->ports
+ udev
->port_index
: NULL
,
2107 NULL
, USB_ROOT_HUB_ADDR
);
2110 /* wait for all pending references to go away: */
2111 lockmgr(&usb_ref_lock
, LK_EXCLUSIVE
);
2113 while (udev
->refcount
!= 0) {
2114 cv_wait(&udev
->ref_cv
, &usb_ref_lock
);
2116 lockmgr(&usb_ref_lock
, LK_RELEASE
);
2118 usb_destroy_dev(udev
->ctrl_dev
);
2121 if (udev
->flags
.usb_mode
== USB_MODE_DEVICE
) {
2122 /* stop receiving any control transfers (Device Side Mode) */
2123 usbd_transfer_unsetup(udev
->ctrl_xfer
, USB_CTRL_XFER_MAX
);
2126 /* the following will get the device unconfigured in software */
2127 usb_unconfigure(udev
, USB_UNCFG_FLAG_FREE_EP0
);
2129 /* unsetup any leftover default USB transfers */
2130 usbd_transfer_unsetup(udev
->ctrl_xfer
, USB_CTRL_XFER_MAX
);
2132 /* template unsetup, if any */
2133 (usb_temp_unsetup_p
) (udev
);
2136 * Make sure that our clear-stall messages are not queued
2139 USB_BUS_LOCK(udev
->bus
);
2140 usb_proc_mwait(&udev
->bus
->non_giant_callback_proc
,
2141 &udev
->cs_msg
[0], &udev
->cs_msg
[1]);
2142 USB_BUS_UNLOCK(udev
->bus
);
2144 lockuninit(&udev
->ctrl_lock
);
2145 lockuninit(&udev
->enum_lock
);
2146 lockuninit(&udev
->sr_lock
);
2148 cv_destroy(&udev
->ctrlreq_cv
);
2149 cv_destroy(&udev
->ref_cv
);
2151 lockuninit(&udev
->device_lock
);
2153 KASSERT(LIST_FIRST(&udev
->pd_list
) == NULL
, ("leaked cdev entries"));
2156 /* Uninitialise device */
2157 if (bus
->methods
->device_uninit
!= NULL
)
2158 (bus
->methods
->device_uninit
) (udev
);
2162 kfree(udev
->serial
, M_USB
);
2163 if(udev
->manufacturer
)
2164 kfree(udev
->manufacturer
, M_USB
);
2166 kfree(udev
->product
, M_USB
);
2170 /*------------------------------------------------------------------------*
2173 * This function is the safe way to get the USB interface structure
2174 * pointer by interface index.
2177 * NULL: Interface not present.
2178 * Else: Pointer to USB interface structure.
2179 *------------------------------------------------------------------------*/
2180 struct usb_interface
*
2181 usbd_get_iface(struct usb_device
*udev
, uint8_t iface_index
)
2183 struct usb_interface
*iface
= udev
->ifaces
+ iface_index
;
2185 if (iface_index
>= udev
->ifaces_max
)
2190 /*------------------------------------------------------------------------*
2191 * usbd_find_descriptor
2193 * This function will lookup the first descriptor that matches the
2194 * criteria given by the arguments "type" and "subtype". Descriptors
2195 * will only be searched within the interface having the index
2196 * "iface_index". If the "id" argument points to an USB descriptor,
2197 * it will be skipped before the search is started. This allows
2198 * searching for multiple descriptors using the same criteria. Else
2199 * the search is started after the interface descriptor.
2202 * NULL: End of descriptors
2203 * Else: A descriptor matching the criteria
2204 *------------------------------------------------------------------------*/
2206 usbd_find_descriptor(struct usb_device
*udev
, void *id
, uint8_t iface_index
,
2207 uint8_t type
, uint8_t type_mask
,
2208 uint8_t subtype
, uint8_t subtype_mask
)
2210 struct usb_descriptor
*desc
;
2211 struct usb_config_descriptor
*cd
;
2212 struct usb_interface
*iface
;
2214 cd
= usbd_get_config_descriptor(udev
);
2219 iface
= usbd_get_iface(udev
, iface_index
);
2220 if (iface
== NULL
) {
2223 id
= usbd_get_interface_descriptor(iface
);
2230 while ((desc
= usb_desc_foreach(cd
, desc
))) {
2232 if (desc
->bDescriptorType
== UDESC_INTERFACE
) {
2235 if (((desc
->bDescriptorType
& type_mask
) == type
) &&
2236 ((desc
->bDescriptorSubtype
& subtype_mask
) == subtype
)) {
2243 /*------------------------------------------------------------------------*
2246 * This function will dump information from the device descriptor
2247 * belonging to the USB device pointed to by "udev", to the string
2248 * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2249 * including the terminating zero.
2250 *------------------------------------------------------------------------*/
2252 usb_devinfo(struct usb_device
*udev
, char *dst_ptr
, uint16_t dst_len
)
2254 struct usb_device_descriptor
*udd
= &udev
->ddesc
;
2258 bcdUSB
= UGETW(udd
->bcdUSB
);
2259 bcdDevice
= UGETW(udd
->bcdDevice
);
2261 if (udd
->bDeviceClass
!= 0xFF) {
2262 ksnprintf(dst_ptr
, dst_len
, "%s %s, class %d/%d, rev %x.%02x/"
2264 usb_get_manufacturer(udev
),
2265 usb_get_product(udev
),
2266 udd
->bDeviceClass
, udd
->bDeviceSubClass
,
2267 (bcdUSB
>> 8), bcdUSB
& 0xFF,
2268 (bcdDevice
>> 8), bcdDevice
& 0xFF,
2271 ksnprintf(dst_ptr
, dst_len
, "%s %s, rev %x.%02x/"
2273 usb_get_manufacturer(udev
),
2274 usb_get_product(udev
),
2275 (bcdUSB
>> 8), bcdUSB
& 0xFF,
2276 (bcdDevice
>> 8), bcdDevice
& 0xFF,
2283 * Descriptions of of known vendors and devices ("products").
2285 struct usb_knowndev
{
2289 const char *vendorname
;
2290 const char *productname
;
2293 #define USB_KNOWNDEV_NOPROD 0x01 /* match on vendor only */
2295 #include "usbdevs.h"
2296 #include "usbdevs_data.h"
2297 #endif /* USB_VERBOSE */
2300 usbd_set_device_strings(struct usb_device
*udev
)
2302 struct usb_device_descriptor
*udd
= &udev
->ddesc
;
2304 const struct usb_knowndev
*kdp
;
2309 uint16_t product_id
;
2311 temp_ptr
= (char *)udev
->bus
->scratch
[0].data
;
2312 temp_size
= sizeof(udev
->bus
->scratch
[0].data
);
2314 vendor_id
= UGETW(udd
->idVendor
);
2315 product_id
= UGETW(udd
->idProduct
);
2317 /* get serial number string */
2318 usbd_req_get_string_any(udev
, NULL
, temp_ptr
, temp_size
,
2319 udev
->ddesc
.iSerialNumber
);
2320 udev
->serial
= kstrdup(temp_ptr
, M_USB
);
2322 /* get manufacturer string */
2323 usbd_req_get_string_any(udev
, NULL
, temp_ptr
, temp_size
,
2324 udev
->ddesc
.iManufacturer
);
2325 usb_trim_spaces(temp_ptr
);
2326 if (temp_ptr
[0] != '\0')
2327 udev
->manufacturer
= kstrdup(temp_ptr
, M_USB
);
2329 /* get product string */
2330 usbd_req_get_string_any(udev
, NULL
, temp_ptr
, temp_size
,
2331 udev
->ddesc
.iProduct
);
2332 usb_trim_spaces(temp_ptr
);
2333 if (temp_ptr
[0] != '\0')
2334 udev
->product
= kstrdup(temp_ptr
, M_USB
);
2337 if (udev
->manufacturer
== NULL
|| udev
->product
== NULL
) {
2338 for (kdp
= usb_knowndevs
; kdp
->vendorname
!= NULL
; kdp
++) {
2339 if (kdp
->vendor
== vendor_id
&&
2340 (kdp
->product
== product_id
||
2341 (kdp
->flags
& USB_KNOWNDEV_NOPROD
) != 0))
2344 if (kdp
->vendorname
!= NULL
) {
2345 /* XXX should use pointer to knowndevs string */
2346 if (udev
->manufacturer
== NULL
) {
2347 udev
->manufacturer
= kstrdup(kdp
->vendorname
,
2350 if (udev
->product
== NULL
&&
2351 (kdp
->flags
& USB_KNOWNDEV_NOPROD
) == 0) {
2352 udev
->product
= kstrdup(kdp
->productname
,
2358 /* Provide default strings if none were found */
2359 if (udev
->manufacturer
== NULL
) {
2360 ksnprintf(temp_ptr
, temp_size
, "vendor 0x%04x", vendor_id
);
2361 udev
->manufacturer
= kstrdup(temp_ptr
, M_USB
);
2363 if (udev
->product
== NULL
) {
2364 ksnprintf(temp_ptr
, temp_size
, "product 0x%04x", product_id
);
2365 udev
->product
= kstrdup(temp_ptr
, M_USB
);
2374 usbd_get_mode(struct usb_device
*udev
)
2376 return (udev
->flags
.usb_mode
);
2381 * See: USB_SPEED_XXX
2384 usbd_get_speed(struct usb_device
*udev
)
2386 return (udev
->speed
);
2390 usbd_get_isoc_fps(struct usb_device
*udev
)
2393 switch (udev
->speed
) {
2395 case USB_SPEED_FULL
:
2402 struct usb_device_descriptor
*
2403 usbd_get_device_descriptor(struct usb_device
*udev
)
2406 return (NULL
); /* be NULL safe */
2407 return (&udev
->ddesc
);
2410 struct usb_config_descriptor
*
2411 usbd_get_config_descriptor(struct usb_device
*udev
)
2414 return (NULL
); /* be NULL safe */
2415 return (udev
->cdesc
);
2418 /*------------------------------------------------------------------------*
2419 * usb_test_quirk - test a device for a given quirk
2422 * 0: The USB device does not have the given quirk.
2423 * Else: The USB device has the given quirk.
2424 *------------------------------------------------------------------------*/
2426 usb_test_quirk(const struct usb_attach_arg
*uaa
, uint16_t quirk
)
2431 if (quirk
== UQ_NONE
)
2434 /* search the automatic per device quirks first */
2436 for (x
= 0; x
!= USB_MAX_AUTO_QUIRK
; x
++) {
2437 if (uaa
->device
->autoQuirk
[x
] == quirk
)
2441 /* search global quirk table, if any */
2443 found
= (usb_test_quirk_p
) (&uaa
->info
, quirk
);
2448 struct usb_interface_descriptor
*
2449 usbd_get_interface_descriptor(struct usb_interface
*iface
)
2452 return (NULL
); /* be NULL safe */
2453 return (iface
->idesc
);
2457 usbd_get_interface_altindex(struct usb_interface
*iface
)
2459 return (iface
->alt_index
);
2463 usbd_get_bus_index(struct usb_device
*udev
)
2465 return ((uint8_t)device_get_unit(udev
->bus
->bdev
));
2469 usbd_get_device_index(struct usb_device
*udev
)
2471 return (udev
->device_index
);
2476 usb_notify_addq(const char *type
, struct usb_device
*udev
)
2478 struct usb_interface
*iface
;
2482 /* announce the device */
2483 sb
= sbuf_new(NULL
, NULL
, 4096, SBUF_AUTOEXTEND
);
2492 "devsubclass=0x%02x "
2505 UGETW(udev
->ddesc
.idVendor
),
2506 UGETW(udev
->ddesc
.idProduct
),
2507 udev
->ddesc
.bDeviceClass
,
2508 udev
->ddesc
.bDeviceSubClass
,
2509 usb_get_serial(udev
),
2510 UGETW(udev
->ddesc
.bcdDevice
),
2511 (udev
->flags
.usb_mode
== USB_MODE_HOST
) ? "host" : "device",
2514 , udev
->parent_hub
!= NULL
?
2515 udev
->parent_hub
->ugen_name
:
2516 device_get_nameunit(device_get_parent(udev
->bus
->bdev
))
2520 devctl_notify("USB", "DEVICE", type
, sbuf_data(sb
));
2523 /* announce each interface */
2524 for (i
= 0; i
< USB_IFACE_MAX
; i
++) {
2525 iface
= usbd_get_iface(udev
, i
);
2527 break; /* end of interfaces */
2528 if (iface
->idesc
== NULL
)
2529 continue; /* no interface descriptor */
2532 sb
= sbuf_new(NULL
, NULL
, 4096, SBUF_AUTOEXTEND
);
2541 "devsubclass=0x%02x "
2548 "intsubclass=0x%02x "
2549 "intprotocol=0x%02x",
2554 UGETW(udev
->ddesc
.idVendor
),
2555 UGETW(udev
->ddesc
.idProduct
),
2556 udev
->ddesc
.bDeviceClass
,
2557 udev
->ddesc
.bDeviceSubClass
,
2558 usb_get_serial(udev
),
2559 UGETW(udev
->ddesc
.bcdDevice
),
2560 (udev
->flags
.usb_mode
== USB_MODE_HOST
) ? "host" : "device",
2561 iface
->idesc
->bInterfaceNumber
,
2562 iface
->idesc
->bNumEndpoints
,
2563 iface
->idesc
->bInterfaceClass
,
2564 iface
->idesc
->bInterfaceSubClass
,
2565 iface
->idesc
->bInterfaceProtocol
);
2567 devctl_notify("USB", "INTERFACE", type
, sbuf_data(sb
));
2574 /*------------------------------------------------------------------------*
2575 * usb_fifo_free_wrap
2577 * This function will free the FIFOs.
2579 * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2580 * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2581 * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2582 * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2583 * control endpoint FIFOs. If "iface_index" is not set to
2584 * "USB_IFACE_INDEX_ANY" the flag has no effect.
2585 *------------------------------------------------------------------------*/
2587 usb_fifo_free_wrap(struct usb_device
*udev
,
2588 uint8_t iface_index
, uint8_t flag
)
2594 * Free any USB FIFOs on the given interface:
2596 for (i
= 0; i
!= USB_FIFO_MAX
; i
++) {
2601 /* Check if the interface index matches */
2602 if (iface_index
== f
->iface_index
) {
2603 if (f
->methods
!= &usb_ugen_methods
) {
2605 * Don't free any non-generic FIFOs in
2610 if ((f
->dev_ep_index
== 0) &&
2611 (f
->fs_xfer
== NULL
)) {
2612 /* no need to free this FIFO */
2615 } else if (iface_index
== USB_IFACE_INDEX_ANY
) {
2616 if ((f
->methods
== &usb_ugen_methods
) &&
2617 (f
->dev_ep_index
== 0) &&
2618 (!(flag
& USB_UNCFG_FLAG_FREE_EP0
)) &&
2619 (f
->fs_xfer
== NULL
)) {
2620 /* no need to free this FIFO */
2624 /* no need to free this FIFO */
2627 /* free this FIFO */
2633 /*------------------------------------------------------------------------*
2634 * usb_peer_can_wakeup
2637 * 0: Peer cannot do resume signalling.
2638 * Else: Peer can do resume signalling.
2639 *------------------------------------------------------------------------*/
2641 usb_peer_can_wakeup(struct usb_device
*udev
)
2643 const struct usb_config_descriptor
*cdp
;
2646 if ((cdp
!= NULL
) && (udev
->flags
.usb_mode
== USB_MODE_HOST
)) {
2647 return (cdp
->bmAttributes
& UC_REMOTE_WAKEUP
);
2649 return (0); /* not supported */
2653 usb_set_device_state(struct usb_device
*udev
, enum usb_dev_state state
)
2656 KASSERT(state
< USB_STATE_MAX
, ("invalid udev state"));
2658 DPRINTF("udev %p state %s -> %s\n", udev
,
2659 usb_statestr(udev
->state
), usb_statestr(state
));
2660 udev
->state
= state
;
2662 if (udev
->bus
->methods
->device_state_change
!= NULL
)
2663 (udev
->bus
->methods
->device_state_change
) (udev
);
2667 usb_get_device_state(struct usb_device
*udev
)
2670 return (USB_STATE_DETACHED
);
2671 return (udev
->state
);
2675 usbd_device_attached(struct usb_device
*udev
)
2677 return (udev
->state
> USB_STATE_DETACHED
);
2680 /* The following function locks enumerating the given USB device. */
2683 usbd_enum_lock(struct usb_device
*udev
)
2685 lockmgr(&udev
->enum_lock
, LK_EXCLUSIVE
);
2686 lockmgr(&udev
->sr_lock
, LK_EXCLUSIVE
);
2688 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2689 * are locked before locking Giant. Else the lock can be
2690 * locked multiple times.
2697 /* The following function unlocks enumerating the given USB device. */
2700 usbd_enum_unlock(struct usb_device
*udev
)
2705 lockmgr(&udev
->enum_lock
, LK_RELEASE
);
2706 lockmgr(&udev
->sr_lock
, LK_RELEASE
);
2709 /* The following function locks suspend and resume. */
2712 usbd_sr_lock(struct usb_device
*udev
)
2714 lockmgr(&udev
->sr_lock
, LK_EXCLUSIVE
);
2716 * NEWBUS LOCK NOTE: We should check if any parent SX locks
2717 * are locked before locking Giant. Else the lock can be
2718 * locked multiple times.
2725 /* The following function unlocks suspend and resume. */
2728 usbd_sr_unlock(struct usb_device
*udev
)
2733 lockmgr(&udev
->sr_lock
, LK_RELEASE
);
2737 * The following function checks the enumerating lock for the given
2742 usbd_enum_is_locked(struct usb_device
*udev
)
2744 /* XXX: Make sure that we return a correct value here */
2745 return (lockowned(&udev
->enum_lock
));
2749 * The following function is used to set the per-interface specific
2750 * plug and play information. The string referred to by the pnpinfo
2751 * argument can safely be freed after calling this function. The
2752 * pnpinfo of an interface will be reset at device detach or when
2753 * passing a NULL argument to this function. This function
2754 * returns zero on success, else a USB_ERR_XXX failure code.
2758 usbd_set_pnpinfo(struct usb_device
*udev
, uint8_t iface_index
, const char *pnpinfo
)
2760 struct usb_interface
*iface
;
2762 iface
= usbd_get_iface(udev
, iface_index
);
2764 return (USB_ERR_INVAL
);
2766 if (iface
->pnpinfo
!= NULL
) {
2767 kfree(iface
->pnpinfo
, M_USBDEV
);
2768 iface
->pnpinfo
= NULL
;
2771 if (pnpinfo
== NULL
|| pnpinfo
[0] == 0)
2772 return (0); /* success */
2774 iface
->pnpinfo
= kstrdup(pnpinfo
, M_USBDEV
);
2775 if (iface
->pnpinfo
== NULL
)
2776 return (USB_ERR_NOMEM
);
2778 return (0); /* success */
2782 usbd_add_dynamic_quirk(struct usb_device
*udev
, uint16_t quirk
)
2786 for (x
= 0; x
!= USB_MAX_AUTO_QUIRK
; x
++) {
2787 if (udev
->autoQuirk
[x
] == 0 ||
2788 udev
->autoQuirk
[x
] == quirk
) {
2789 udev
->autoQuirk
[x
] = quirk
;
2790 return (0); /* success */
2793 return (USB_ERR_NOMEM
);
2797 * The following function is used to select the endpoint mode. It
2798 * should not be called outside enumeration context.
2802 usbd_set_endpoint_mode(struct usb_device
*udev
, struct usb_endpoint
*ep
,
2808 /* automatic locking */
2809 if (usbd_enum_is_locked(udev
)) {
2813 usbd_enum_lock(udev
);
2816 if (udev
->bus
->methods
->set_endpoint_mode
!= NULL
) {
2817 error
= (udev
->bus
->methods
->set_endpoint_mode
) (
2819 } else if (ep_mode
!= USB_EP_MODE_DEFAULT
) {
2820 error
= USB_ERR_INVAL
;
2825 /* only set new mode regardless of error */
2826 ep
->ep_mode
= ep_mode
;
2829 usbd_enum_unlock(udev
);
2835 usbd_get_endpoint_mode(struct usb_device
*udev
, struct usb_endpoint
*ep
)
2837 return (ep
->ep_mode
);