1 /* $FreeBSD$ */ 2 /*- 3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 */ 26 27 #ifdef USB_GLOBAL_INCLUDE_FILE 28 #include USB_GLOBAL_INCLUDE_FILE 29 #else 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> 37 #include <sys/bus.h> 38 #include <sys/module.h> 39 #include <sys/lock.h> 40 #include <sys/mutex.h> 41 #include <sys/condvar.h> 42 #include <sys/sysctl.h> 43 #include <sys/sx.h> 44 #include <sys/unistd.h> 45 #include <sys/callout.h> 46 #include <sys/malloc.h> 47 #include <sys/priv.h> 48 49 #include <dev/usb/usb.h> 50 #include <dev/usb/usbdi.h> 51 #include <dev/usb/usbdi_util.h> 52 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> 59 60 #include <dev/usb/usb_controller.h> 61 #include <dev/usb/usb_bus.h> 62 #endif /* USB_GLOBAL_INCLUDE_FILE */ 63 64 /*------------------------------------------------------------------------* 65 * device_set_usb_desc 66 * 67 * This function can be called at probe or attach to set the USB 68 * device supplied textual description for the given device. 69 *------------------------------------------------------------------------*/ 70 void 71 device_set_usb_desc(device_t dev) 72 { 73 struct usb_attach_arg *uaa; 74 struct usb_device *udev; 75 struct usb_interface *iface; 76 char *temp_p; 77 usb_error_t err; 78 79 if (dev == NULL) { 80 /* should not happen */ 81 return; 82 } 83 uaa = device_get_ivars(dev); 84 if (uaa == NULL) { 85 /* can happen if called at the wrong time */ 86 return; 87 } 88 udev = uaa->device; 89 iface = uaa->iface; 90 91 if ((iface == NULL) || 92 (iface->idesc == NULL) || 93 (iface->idesc->iInterface == 0)) { 94 err = USB_ERR_INVAL; 95 } else { 96 err = 0; 97 } 98 99 temp_p = (char *)udev->bus->scratch[0].data; 100 101 if (!err) { 102 /* try to get the interface string ! */ 103 err = usbd_req_get_string_any 104 (udev, NULL, temp_p, 105 sizeof(udev->bus->scratch), iface->idesc->iInterface); 106 } 107 if (err) { 108 /* use default description */ 109 usb_devinfo(udev, temp_p, 110 sizeof(udev->bus->scratch)); 111 } 112 device_set_desc_copy(dev, temp_p); 113 device_printf(dev, "<%s> on %s\n", temp_p, 114 device_get_nameunit(udev->bus->bdev)); 115 } 116 117 /*------------------------------------------------------------------------* 118 * usb_pause_mtx - factored out code 119 * 120 * This function will delay the code by the passed number of system 121 * ticks. The passed mutex "mtx" will be dropped while waiting, if 122 * "mtx" is different from NULL. 123 *------------------------------------------------------------------------*/ 124 void 125 usb_pause_mtx(struct mtx *mtx, int timo) 126 { 127 if (mtx != NULL) 128 mtx_unlock(mtx); 129 130 /* 131 * Add one tick to the timeout so that we don't return too 132 * early! Note that pause() will assert that the passed 133 * timeout is positive and non-zero! 134 */ 135 pause("USBWAIT", timo + 1); 136 137 if (mtx != NULL) 138 mtx_lock(mtx); 139 } 140 141 /*------------------------------------------------------------------------* 142 * usb_printbcd 143 * 144 * This function will print the version number "bcd" to the string 145 * pointed to by "p" having a maximum length of "p_len" bytes 146 * including the terminating zero. 147 *------------------------------------------------------------------------*/ 148 void 149 usb_printbcd(char *p, uint16_t p_len, uint16_t bcd) 150 { 151 if (snprintf(p, p_len, "%x.%02x", bcd >> 8, bcd & 0xff)) { 152 /* ignore any errors */ 153 } 154 } 155 156 /*------------------------------------------------------------------------* 157 * usb_trim_spaces 158 * 159 * This function removes spaces at the beginning and the end of the string 160 * pointed to by the "p" argument. 161 *------------------------------------------------------------------------*/ 162 void 163 usb_trim_spaces(char *p) 164 { 165 char *q; 166 char *e; 167 168 if (p == NULL) 169 return; 170 q = e = p; 171 while (*q == ' ') /* skip leading spaces */ 172 q++; 173 while ((*p = *q++)) /* copy string */ 174 if (*p++ != ' ') /* remember last non-space */ 175 e = p; 176 *e = 0; /* kill trailing spaces */ 177 } 178 179 /*------------------------------------------------------------------------* 180 * usb_make_str_desc - convert an ASCII string into a UNICODE string 181 *------------------------------------------------------------------------*/ 182 uint8_t 183 usb_make_str_desc(void *ptr, uint16_t max_len, const char *s) 184 { 185 struct usb_string_descriptor *p = ptr; 186 uint8_t totlen; 187 int j; 188 189 if (max_len < 2) { 190 /* invalid length */ 191 return (0); 192 } 193 max_len = ((max_len / 2) - 1); 194 195 j = strlen(s); 196 197 if (j < 0) { 198 j = 0; 199 } 200 if (j > 126) { 201 j = 126; 202 } 203 if (max_len > j) { 204 max_len = j; 205 } 206 totlen = (max_len + 1) * 2; 207 208 p->bLength = totlen; 209 p->bDescriptorType = UDESC_STRING; 210 211 while (max_len--) { 212 USETW2(p->bString[max_len], 0, s[max_len]); 213 } 214 return (totlen); 215 } 216