sys/dev/usb/usb_util.c

   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_delete_all_children - delete all children of a device
  62  *------------------------------------------------------------------------*/
  63 #ifndef device_delete_all_children
  64 int
  65 device_delete_all_children(device_t dev)
  66 {
  67         device_t *devlist;
  68         int devcount;
  69         int error;
  70
  71         error = device_get_children(dev, &devlist, &devcount);
  72         if (error == 0) {
  73                 while (devcount-- > 0) {
  74                         error = device_delete_child(dev, devlist[devcount]);
  75                         if (error) {
  76                                 break;
  77                         }
  78                 }
  79                 free(devlist, M_TEMP);
  80         }
  81         return (error);
  82 }
  83 #endif
  84
  85 /*------------------------------------------------------------------------*
  86  *      device_set_usb_desc
  87  *
  88  * This function can be called at probe or attach to set the USB
  89  * device supplied textual description for the given device.
  90  *------------------------------------------------------------------------*/
  91 void
  92 device_set_usb_desc(device_t dev)
  93 {
  94         struct usb_attach_arg *uaa;
  95         struct usb_device *udev;
  96         struct usb_interface *iface;
  97         char *temp_p;
  98         usb_error_t err;
  99         uint8_t do_unlock;
 100
 101         if (dev == NULL) {
 102                 /* should not happen */
 103                 return;
 104         }
 105         uaa = device_get_ivars(dev);
 106         if (uaa == NULL) {
 107                 /* can happen if called at the wrong time */
 108                 return;
 109         }
 110         udev = uaa->device;
 111         iface = uaa->iface;
 112
 113         if ((iface == NULL) ||
 114             (iface->idesc == NULL) ||
 115             (iface->idesc->iInterface == 0)) {
 116                 err = USB_ERR_INVAL;
 117         } else {
 118                 err = 0;
 119         }
 120
 121         /* Protect scratch area */
 122         do_unlock = usbd_ctrl_lock(udev);
 123
 124         temp_p = (char *)udev->scratch.data;
 125
 126         if (err == 0) {
 127                 /* try to get the interface string ! */
 128                 err = usbd_req_get_string_any(udev, NULL, temp_p,
 129                     sizeof(udev->scratch.data),
 130                     iface->idesc->iInterface);
 131         }
 132         if (err != 0) {
 133                 /* use default description */
 134                 usb_devinfo(udev, temp_p,
 135                     sizeof(udev->scratch.data));
 136         }
 137
 138         if (do_unlock)
 139                 usbd_ctrl_unlock(udev);
 140
 141         device_set_desc_copy(dev, temp_p);
 142         device_printf(dev, "<%s> on %s\n", temp_p,
 143             device_get_nameunit(udev->bus->bdev));
 144 }
 145
 146 /*------------------------------------------------------------------------*
 147  *       usb_pause_mtx - factored out code
 148  *
 149  * This function will delay the code by the passed number of system
 150  * ticks. The passed mutex "mtx" will be dropped while waiting, if
 151  * "mtx" is not NULL.
 152  *------------------------------------------------------------------------*/
 153 void
 154 usb_pause_mtx(struct mtx *mtx, int _ticks)
 155 {
 156         if (mtx != NULL)
 157                 mtx_unlock(mtx);
 158
 159         if (cold) {
 160                 /* convert to milliseconds */
 161                 _ticks = (_ticks * 1000) / hz;
 162                 /* convert to microseconds, rounded up */
 163                 _ticks = (_ticks + 1) * 1000;
 164                 DELAY(_ticks);
 165
 166         } else {
 167
 168                 /*
 169                  * Add one to the number of ticks so that we don't return
 170                  * too early!
 171                  */
 172                 _ticks++;
 173
 174                 if (pause("USBWAIT", _ticks)) {
 175                         /* ignore */
 176                 }
 177         }
 178         if (mtx != NULL)
 179                 mtx_lock(mtx);
 180 }
 181
 182 /*------------------------------------------------------------------------*
 183  *      usb_printbcd
 184  *
 185  * This function will print the version number "bcd" to the string
 186  * pointed to by "p" having a maximum length of "p_len" bytes
 187  * including the terminating zero.
 188  *------------------------------------------------------------------------*/
 189 void
 190 usb_printbcd(char *p, uint16_t p_len, uint16_t bcd)
 191 {
 192         if (snprintf(p, p_len, "%x.%02x", bcd >> 8, bcd & 0xff)) {
 193                 /* ignore any errors */
 194         }
 195 }
 196
 197 /*------------------------------------------------------------------------*
 198  *      usb_trim_spaces
 199  *
 200  * This function removes spaces at the beginning and the end of the string
 201  * pointed to by the "p" argument.
 202  *------------------------------------------------------------------------*/
 203 void
 204 usb_trim_spaces(char *p)
 205 {
 206         char *q;
 207         char *e;
 208
 209         if (p == NULL)
 210                 return;
 211         q = e = p;
 212         while (*q == ' ')               /* skip leading spaces */
 213                 q++;
 214         while ((*p = *q++))             /* copy string */
 215                 if (*p++ != ' ')        /* remember last non-space */
 216                         e = p;
 217         *e = 0;                         /* kill trailing spaces */
 218 }
 219
 220 /*------------------------------------------------------------------------*
 221  *      usb_make_str_desc - convert an ASCII string into a UNICODE string
 222  *------------------------------------------------------------------------*/
 223 uint8_t
 224 usb_make_str_desc(void *ptr, uint16_t max_len, const char *s)
 225 {
 226         struct usb_string_descriptor *p = ptr;
 227         uint8_t totlen;
 228         int j;
 229
 230         if (max_len < 2) {
 231                 /* invalid length */
 232                 return (0);
 233         }
 234         max_len = ((max_len / 2) - 1);
 235
 236         j = strlen(s);
 237
 238         if (j < 0) {
 239                 j = 0;
 240         }
 241         if (j > 126) {
 242                 j = 126;
 243         }
 244         if (max_len > j) {
 245                 max_len = j;
 246         }
 247         totlen = (max_len + 1) * 2;
 248
 249         p->bLength = totlen;
 250         p->bDescriptorType = UDESC_STRING;
 251
 252         while (max_len--) {
 253                 USETW2(p->bString[max_len], 0, s[max_len]);
 254         }
 255         return (totlen);
 256 }