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 #ifdef USB_GLOBAL_INCLUDE_FILE
28 #include USB_GLOBAL_INCLUDE_FILE
30 #include <sys/stdint.h>
31 #include <sys/stddef.h>
32 #include <sys/param.h>
33 #include <sys/queue.h>
34 #include <sys/types.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
38 #include <sys/module.h>
40 #include <sys/mutex.h>
41 #include <sys/condvar.h>
42 #include <sys/sysctl.h>
44 #include <sys/unistd.h>
45 #include <sys/callout.h>
46 #include <sys/malloc.h>
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbdi.h>
51 #include <dev/usb/usbdi_util.h>
53 #include <dev/usb/usb_core.h>
54 #include <dev/usb/usb_util.h>
55 #include <dev/usb/usb_process.h>
56 #include <dev/usb/usb_device.h>
57 #include <dev/usb/usb_request.h>
58 #include <dev/usb/usb_busdma.h>
60 #include <dev/usb/usb_controller.h>
61 #include <dev/usb/usb_bus.h>
62 #endif /* USB_GLOBAL_INCLUDE_FILE */
64 /*------------------------------------------------------------------------*
67 * This function can be called at probe or attach to set the USB
68 * device supplied textual description for the given device.
69 *------------------------------------------------------------------------*/
71 device_set_usb_desc(device_t dev)
73 struct usb_attach_arg *uaa;
74 struct usb_device *udev;
75 struct usb_interface *iface;
81 /* should not happen */
84 uaa = device_get_ivars(dev);
86 /* can happen if called at the wrong time */
92 if ((iface == NULL) ||
93 (iface->idesc == NULL) ||
94 (iface->idesc->iInterface == 0)) {
100 /* Protect scratch area */
101 do_unlock = usbd_ctrl_lock(udev);
103 temp_p = (char *)udev->scratch.data;
106 /* try to get the interface string ! */
107 err = usbd_req_get_string_any(udev, NULL, temp_p,
108 sizeof(udev->scratch.data),
109 iface->idesc->iInterface);
112 /* use default description */
113 usb_devinfo(udev, temp_p,
114 sizeof(udev->scratch.data));
118 usbd_ctrl_unlock(udev);
120 device_set_desc_copy(dev, temp_p);
121 device_printf(dev, "<%s> on %s\n", temp_p,
122 device_get_nameunit(udev->bus->bdev));
125 /*------------------------------------------------------------------------*
126 * usb_pause_mtx - factored out code
128 * This function will delay the code by the passed number of system
129 * ticks. The passed mutex "mtx" will be dropped while waiting, if
130 * "mtx" is different from NULL.
131 *------------------------------------------------------------------------*/
133 usb_pause_mtx(struct mtx *mtx, int timo)
139 * Add one tick to the timeout so that we don't return too
140 * early! Note that pause() will assert that the passed
141 * timeout is positive and non-zero!
143 pause("USBWAIT", timo + 1);
149 /*------------------------------------------------------------------------*
152 * This function will print the version number "bcd" to the string
153 * pointed to by "p" having a maximum length of "p_len" bytes
154 * including the terminating zero.
155 *------------------------------------------------------------------------*/
157 usb_printbcd(char *p, uint16_t p_len, uint16_t bcd)
159 if (snprintf(p, p_len, "%x.%02x", bcd >> 8, bcd & 0xff)) {
160 /* ignore any errors */
164 /*------------------------------------------------------------------------*
167 * This function removes spaces at the beginning and the end of the string
168 * pointed to by the "p" argument.
169 *------------------------------------------------------------------------*/
171 usb_trim_spaces(char *p)
179 while (*q == ' ') /* skip leading spaces */
181 while ((*p = *q++)) /* copy string */
182 if (*p++ != ' ') /* remember last non-space */
184 *e = 0; /* kill trailing spaces */
187 /*------------------------------------------------------------------------*
188 * usb_make_str_desc - convert an ASCII string into a UNICODE string
189 *------------------------------------------------------------------------*/
191 usb_make_str_desc(void *ptr, uint16_t max_len, const char *s)
193 struct usb_string_descriptor *p = ptr;
201 max_len = ((max_len / 2) - 1);
214 totlen = (max_len + 1) * 2;
217 p->bDescriptorType = UDESC_STRING;
220 USETW2(p->bString[max_len], 0, s[max_len]);