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