]> oss.titaniummirror.com Git - cp210x.git/blobdiff - src/cp210x.c.karmic
Fix version information for karmic and lucid sources broken in last commit.
[cp210x.git] / src / cp210x.c.karmic
index 6188b8a47d01f794794ac35cdd8c35f7f4546a48..a181b1973cf698492c0f5d33123fbcb7623a461f 100644 (file)
@@ -28,7 +28,7 @@
 /*
  * Version Information
  */
-#define DRIVER_VERSION "vxxPKGVERxxtmi"
+#define DRIVER_VERSION "vxxDEBVERxx"
 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
 
 /*
@@ -151,10 +151,6 @@ static struct usb_serial_driver cp210x_device = {
        .disconnect             = cp210x_disconnect,
 };
 
-/* Config request types */
-#define REQTYPE_HOST_TO_DEVICE 0x41
-#define REQTYPE_DEVICE_TO_HOST 0xc1
-
 /* Config request codes */
 #define CP210X_IFC_ENABLE      0x00
 #define CP210X_SET_BAUDDIV     0x01
@@ -228,37 +224,94 @@ static struct usb_serial_driver cp210x_device = {
 #define CP210x_PART_CP2102     0x02
 #define CP210x_PART_CP2103     0x03
 
-/* Helper to make usb string size */
-#define USBSTRLEN(x)           (x * 2 + 2)
+/* Taken from drivers/usb/gadget/usbstring.c */
+static int utf8_to_utf16le(const char *s, __le16 *cp, unsigned len)
+{
+       int     count = 0;
+       u8      c;
+       u16     uchar;
+
+       /* this insists on correct encodings, though not minimal ones.
+        * BUT it currently rejects legit 4-byte UTF-8 code points,
+        * which need surrogate pairs.  (Unicode 3.1 can use them.)
+        */
+       while (len != 0 && (c = (u8) *s++) != 0) {
+               if (unlikely(c & 0x80)) {
+                       // 2-byte sequence:
+                       // 00000yyyyyxxxxxx = 110yyyyy 10xxxxxx
+                       if ((c & 0xe0) == 0xc0) {
+                               uchar = (c & 0x1f) << 6;
+
+                               c = (u8) *s++;
+                               if ((c & 0xc0) != 0x80)
+                                       goto fail;
+                               c &= 0x3f;
+                               uchar |= c;
+
+                       // 3-byte sequence (most CJKV characters):
+                       // zzzzyyyyyyxxxxxx = 1110zzzz 10yyyyyy 10xxxxxx
+                       } else if ((c & 0xf0) == 0xe0) {
+                               uchar = (c & 0x0f) << 12;
+
+                               c = (u8) *s++;
+                               if ((c & 0xc0) != 0x80)
+                                       goto fail;
+                               c &= 0x3f;
+                               uchar |= c << 6;
+
+                               c = (u8) *s++;
+                               if ((c & 0xc0) != 0x80)
+                                       goto fail;
+                               c &= 0x3f;
+                               uchar |= c;
+
+                               /* no bogus surrogates */
+                               if (0xd800 <= uchar && uchar <= 0xdfff)
+                                       goto fail;
+
+                       // 4-byte sequence (surrogate pairs, currently rare):
+                       // 11101110wwwwzzzzyy + 110111yyyyxxxxxx
+                       //     = 11110uuu 10uuzzzz 10yyyyyy 10xxxxxx
+                       // (uuuuu = wwww + 1)
+                       // FIXME accept the surrogate code points (only)
+
+                       } else
+                               goto fail;
+               } else
+                       uchar = c;
+               *cp++ = uchar;
+               count++;
+               len--;
+       }
+       return count;
+fail:
+       return -1;
+}
+
 
-/* Populates usbstr with: (len) + (0x03) + unicode(str).  Each char in str
- * takes two bytes in unicode format.
- * Returns the resulting length of the string in usbstr.
+/*
+ * make_usb_string
+ * Populates usbstr with: (len) + (USB_DT_STRING) + unicode(str).  Each char in
+ * usbstr consumes two bytes in unicode (__le16) format.
+ * Returns the resulting length of usbstr in bytes.
  * This function can accept overlapping usbstr and str as long as the overlap
  * does not cause data written to usbstr to overwrite data not yet read from
  * str.
  */
-static int make_usb_string(char *usbstr, size_t usblen, char *src,
+static int make_usb_string(__le16* usbstr, size_t usblen, const char *src,
                size_t srclen)
 {
-       int len = 0;
-
-       if (usbstr && usblen >= 2 && src && *src && srclen) {
-               char *p;
-
-               if (usblen > 255)
-                       usblen = 255;
-
-               p = usbstr + 1;
-               *p++ = 0x03;
-               len = 2;
-               while (srclen && len < usblen) {
-                       *p++ = *src++;
-                       *p++ = 0;
-                       len += 2;
-                       srclen--;
-               }
-               *usbstr = (char)len;
+       int len;
+
+       /* string descriptors have length, type, then UTF16-LE text */
+       if (usblen > 254)
+               usblen = 254;
+       len = min(usblen / 2 - 1, srclen);
+       len = utf8_to_utf16le(src, usbstr + 1, len);
+       if (len >= 0) {
+               len = (len + 1) * 2;
+               ((u8 *)usbstr)[0] = len;
+               ((u8 *)usbstr)[1] = USB_DT_STRING;
        }
        return len;
 }
@@ -269,34 +322,24 @@ static int make_usb_string(char *usbstr, size_t usblen, char *src,
  * is the size of the buffer at kbuf.
  * Returns the number of bytes used in kbuf.
  */
-static size_t cp210x_usbstr_from_user(char *kbuf, unsigned long ubuf, size_t klen)
+static size_t cp210x_usbstr_from_user(__le16 *kbuf,
+               struct cp210x_buffer __user *ubuf, size_t klen)
 {
        struct cp210x_buffer t;
-       char* str;
-
-       if (!kbuf || !ubuf || !klen)
-               return 0;
-       if (copy_from_user(&t, (struct cp210x_buffer __user *)ubuf, sizeof(t)))
-               return 0;
-       if (!t.buf || !t.len)
-               return 0;
-       if (t.len < klen)
-               klen = t.len;
-       str = kbuf + klen - t.len;
-       if (copy_from_user(kbuf + klen - t.len, (u8 __user *)t.buf, klen))
-               return 0;
-       return make_usb_string(kbuf, klen, str, t.len);
-}
-
-/* cp210x_has_setmfg
- * Returns 1 if the CP210X part includes firmware that allows setting the
- * USB MFG descriptor, else 0.  As of this writing, no CP210X firmware allows
- * this.  SiLabs has suggested this may change in future firmware versions or
- * parts.
- */
-static inline int cp210x_has_setmfg(void)
-{
-       return 0;
+       char *str;
+       size_t slen;
+
+       if (copy_from_user(&t, ubuf, sizeof(t)))
+               return -EINVAL;
+       slen = klen / 2 - 1;
+       if (!t.buf || !t.len || t.len > slen)
+               return -EINVAL;
+       if (t.len < slen)
+               slen = t.len;
+       str = (char *)kbuf + klen - slen;
+       if (copy_from_user(str, (__u8 __user *)t.buf, slen))
+               return -EINVAL;
+       return make_usb_string(kbuf, klen, str, slen);
 }
 
 /*
@@ -312,9 +355,10 @@ static int cp210x_ctlmsg(struct usb_serial_port *port, u8 request,
        u8 *tbuf;
        int ret;
 
-       if (!(tbuf = kmalloc(size, GFP_KERNEL)))
+       tbuf = kmalloc(size, GFP_KERNEL);
+       if (!tbuf)
                return -ENOMEM;
-       if (requestype & 0x80) {
+       if (requestype & USB_DIR_IN) {
                ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
                                requestype, value, index, tbuf, size, 300);
                if (ret > 0 && size)
@@ -327,8 +371,9 @@ static int cp210x_ctlmsg(struct usb_serial_port *port, u8 request,
        }
        kfree(tbuf);
        if (ret < 0 && ret != -EPIPE) {
-               dev_printk(KERN_DEBUG, &dev->dev, "cp210x: control failed cmd rqt %u "
-                               "rq %u len %u ret %d\n", requestype, request, size, ret);
+               dev_printk(KERN_DEBUG, &dev->dev,
+                       "cp210x: ctl failed cmd rqt %u rq %u len %u ret %d\n",
+                       requestype, request, size, ret);
        }
        return ret;
 }
@@ -337,16 +382,11 @@ static int cp210x_reset(struct usb_serial_port *port)
 {
        dbg("%s", __func__);
 
-#if 1
-       /* Is this better than usb_device_reset?  It may be.  Once a client issues
-        * the reset ioctl, it must disconnect and reconnect, since the USB
-        * connections are torn down.  We also ignore the error return, since
-        * the part resets and doesn't send one...
+       /* Instructing the CP210X to reset seems to work more reliably than
+        * calling usb_reset_device().
         */
-       cp210x_ctlmsg(port, 0xff, 0x40, 0x0008, 0x00, NULL, 0);
-#else
-       usb_reset_device(port->serial->dev);
-#endif
+       cp210x_ctlmsg(port, 0xff, USB_TYPE_VENDOR,
+                       0x0008, 0x00, NULL, 0);
        return 0;
 }
 
@@ -363,8 +403,9 @@ static int cp210x_get_partnum(struct usb_serial_port *port)
                        _partnum = CP210x_PART_CP2101;
                else if (addr == 0x01) {
                        /* Must query part to determine part number */
-                       if (cp210x_ctlmsg(port, 0xff, 0xc0, 0x370b, 0x00,
-                                       &_partnum, 1) != 1)
+                       if (cp210x_ctlmsg(port, 0xff,
+                                       USB_DIR_IN|USB_TYPE_VENDOR,
+                                       0x370b, 0x00, &_partnum, 1) != 1)
                                _partnum = CP210x_PART_UNKNOWN;
                }
        }
@@ -375,8 +416,8 @@ static int cp210x_get_partnum(struct usb_serial_port *port)
 static inline int cp210x_setu16(struct usb_serial_port *port, int cmd,
                unsigned int value)
 {
-       return cp210x_ctlmsg(port, 0xff, 0x40, 0x3700 | (cmd & 0xff),
-                       value, NULL, 0);
+       return cp210x_ctlmsg(port, 0xff, USB_TYPE_VENDOR,
+                       0x3700 | (cmd & 0xff), value, NULL, 0);
 }
 
 /*
@@ -385,11 +426,11 @@ static inline int cp210x_setu16(struct usb_serial_port *port, int cmd,
  * Set a USB string descriptor using proprietary cp210x control messages.
  * Return the number of characters actually written.
  */
-static int cp210x_setstr(struct usb_serial_port *port, int cmd, char *usbstr)
+static int cp210x_setstr(struct usb_serial_port *port, int cmd, __le16 *usbstr)
 {
-       unsigned len = usbstr[0];
-       int ret = cp210x_ctlmsg(port, 0xff, 0x40, 0x3700 | (cmd & 0xff), 0,
-                       usbstr, len);
+       int len = ((u8 *)usbstr)[0];
+       int ret = cp210x_ctlmsg(port, 0xff, USB_TYPE_VENDOR,
+                       0x3700 | (cmd & 0xff), 0, usbstr, len);
        dbg("%s - cmd 0x%02x len %d ret %d", __func__, cmd, len, ret);
        return ret;
 }
@@ -399,8 +440,8 @@ static int cp210x_gpioset(struct usb_serial_port *port, u8 gpio)
 {
        dbg("%s - port %d, gpio = 0x%.2x", __func__, port->number, gpio);
 
-       return cp210x_ctlmsg(port, 0xff, 0x40, 0x37e1,
-                       ((uint16_t)gpio << 8) | GPIO_MASK, NULL, 0);
+       return cp210x_ctlmsg(port, 0xff, USB_TYPE_VENDOR,
+                       0x37e1, ((uint16_t)gpio << 8) | GPIO_MASK, NULL, 0);
 }
 
 /* Set select gpio bits */
@@ -428,8 +469,8 @@ static int cp210x_gpiosetb(struct usb_serial_port *port, u8 set, u8 clear)
 
        dbg("%s - port %d, gpiob = 0x%.4x", __func__, port->number, gpio);
 
-       /* FIXME: how about REQTYPE_HOST_TO_DEVICE instead of 0x40? */
-       return cp210x_ctlmsg(port, 0xff, 0x40, 0x37e1, gpio, NULL, 0);
+       return cp210x_ctlmsg(port, 0xff, USB_TYPE_VENDOR,
+                       0x37e1, gpio, NULL, 0);
 }
 
 static int cp210x_gpioget(struct usb_serial_port *port, u8 *gpio)
@@ -438,8 +479,8 @@ static int cp210x_gpioget(struct usb_serial_port *port, u8 *gpio)
 
        dbg("%s - port %d", __func__, port->number);
 
-       /* FIXME: how about REQTYPE_DEVICE_TO_HOST instead of 0xc0? */
-       ret = cp210x_ctlmsg(port, 0xff, 0xc0, 0x00c2, 0, gpio, 1);
+       ret = cp210x_ctlmsg(port, 0xff, USB_DIR_IN|USB_TYPE_VENDOR,
+                       0x00c2, 0, gpio, 1);
 
        dbg("%s - gpio = 0x%.2x (%d)", __func__, *gpio, ret);
 
@@ -456,21 +497,17 @@ static int cp210x_portconfset(struct usb_serial_port *port,
 
        memcpy(&lconfig, config, sizeof(lconfig));
 
-       /* Words from cp2103 are MSB */
+       /* Words from cp210x are MSB */
        lconfig.reset.mode = cpu_to_be16(config->reset.mode);
        lconfig.reset.latch = cpu_to_be16(config->reset.latch);
        lconfig.suspend.mode = cpu_to_be16(config->suspend.mode);
        lconfig.suspend.latch = cpu_to_be16(config->suspend.latch);
-#if 0 /* apparently not implemented by CP210X firmware */
-       lconfig.reset.lowPower = cpu_to_be16(config->reset.lowPower);
-       lconfig.suspend.lowPower = cpu_to_be16(config->suspend.lowPower);
-#else
+       /* apparently not implemented by CP210X firmware */
        lconfig.suspend.lowPower = 0;
        lconfig.reset.lowPower = 0;
-#endif
 
-       ret = cp210x_ctlmsg(port, 0xff, 0x40, 0x370c, 0, &lconfig,
-                       sizeof(struct cp210x_port_config));
+       ret = cp210x_ctlmsg(port, 0xff, USB_TYPE_VENDOR, 0x370c,
+                       0, &lconfig, sizeof(struct cp210x_port_config));
        if (ret == sizeof(struct cp210x_port_config))
                return 0;
        else if (ret >= 0)
@@ -486,10 +523,10 @@ static int cp210x_portconfget(struct usb_serial_port *port,
 
        dbg("%s", __func__);
 
-       ret = cp210x_ctlmsg(port, 0xff, 0xc0, 0x370c, 0, config,
-                       sizeof(struct cp210x_port_config));
+       ret = cp210x_ctlmsg(port, 0xff, USB_DIR_IN|USB_TYPE_VENDOR,
+                       0x370c, 0, config, sizeof(struct cp210x_port_config));
        if (ret == sizeof(struct cp210x_port_config)) {
-               /* Words from cp2103 are MSB */
+               /* Words from cp210x are MSB */
                config->reset.mode = be16_to_cpu(config->reset.mode);
                config->reset.lowPower = be16_to_cpu(config->reset.lowPower);
                config->reset.latch = be16_to_cpu(config->reset.latch);
@@ -535,8 +572,9 @@ static int cp210x_get_config(struct usb_serial_port *port, u8 request,
 
        /* Issue the request, attempting to read 'size' bytes */
        result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
-                               request, REQTYPE_DEVICE_TO_HOST, 0x0000,
-                               0, buf, size, 300);
+                               request,
+                               USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
+                               0x0000, 0, buf, size, 300);
 
        /* Convert data into an array of integers */
        for (i = 0; i < length; i++)
@@ -583,13 +621,13 @@ static int cp210x_set_config(struct usb_serial_port *port, u8 request,
 
        if (size > 2) {
                result = usb_control_msg(serial->dev,
-                               usb_sndctrlpipe(serial->dev, 0),
-                               request, REQTYPE_HOST_TO_DEVICE, 0x0000,
+                               usb_sndctrlpipe(serial->dev, 0), request,
+                               USB_TYPE_VENDOR|USB_RECIP_INTERFACE, 0x0000,
                                0, buf, size, 300);
        } else {
                result = usb_control_msg(serial->dev,
-                               usb_sndctrlpipe(serial->dev, 0),
-                               request, REQTYPE_HOST_TO_DEVICE, data[0],
+                               usb_sndctrlpipe(serial->dev, 0), request,
+                               USB_TYPE_VENDOR|USB_RECIP_INTERFACE, data[0],
                                0, NULL, 0, 300);
        }
 
@@ -755,44 +793,46 @@ static int cp210x_ioctl(struct tty_struct *tty, struct file *file,
                        return -EFAULT;
 
                /* this looks wrong: TIOCMSET isn't going to work right */
-               if (cp210x_tiocmset(tty, file, cmd==TIOCMBIC ? 0 : val,
-                                       cmd==TIOCMBIC ? val : 0))
+               if (cp210x_tiocmset(tty, file, (cmd == TIOCMBIC) ? 0 : val,
+                                       (cmd == TIOCMBIC) ? val : 0))
                        return -EFAULT;
                return 0;
        }
        break;
 
-       case IOCTL_GPIOGET:
+       case CP210x_IOCTL_GPIOGET:
        if (cp210x_get_partnum(port) == CP210x_PART_CP2103) {
                u8 gpio = 0;
                if (!cp210x_gpioget(port, &gpio) && !copy_to_user(
-                                       (u8 __user *)arg, &gpio, sizeof(gpio)))
+                                       (__u8 __user *)arg, &gpio,
+                                       sizeof(gpio)))
                        return 0;
        }
        return -EFAULT;
        break;
 
-       case IOCTL_GPIOSET:
+       case CP210x_IOCTL_GPIOSET:
        if (cp210x_get_partnum(port) == CP210x_PART_CP2103 &&
                        !cp210x_gpioset(port, arg))
                return 0;
        return -EFAULT;
        break;
 
-       case IOCTL_GPIOBIC:
-       case IOCTL_GPIOBIS:
+       case CP210x_IOCTL_GPIOBIC:
+       case CP210x_IOCTL_GPIOBIS:
        if (cp210x_get_partnum(port) == CP210x_PART_CP2103 &&
-                       !cp210x_gpiosetb(port, (cmd==IOCTL_GPIOBIC) ?  0 : arg,
-                       (cmd==IOCTL_GPIOBIC) ? arg : 0))
+                       !cp210x_gpiosetb(port,
+                               (cmd == CP210x_IOCTL_GPIOBIC) ?  0 : arg,
+                               (cmd == CP210x_IOCTL_GPIOBIC) ? arg : 0))
                return 0;
        return -EFAULT;
        break;
 
-       case IOCTL_DEVICERESET:
+       case CP210x_IOCTL_DEVICERESET:
        return cp210x_reset(port);
        break;
 
-       case IOCTL_PORTCONFGET:
+       case CP210x_IOCTL_PORTCONFGET:
        {
                struct cp210x_port_config config;
                if (!cp210x_portconfget(port, &config) && !copy_to_user(
@@ -803,7 +843,7 @@ static int cp210x_ioctl(struct tty_struct *tty, struct file *file,
        return -EFAULT;
        break;
 
-       case IOCTL_PORTCONFSET:
+       case CP210x_IOCTL_PORTCONFSET:
        {
        struct cp210x_port_config config;
        if (!copy_from_user(&config, (struct cp210x_port_config __user *)arg,
@@ -814,7 +854,7 @@ static int cp210x_ioctl(struct tty_struct *tty, struct file *file,
        }
        break;
 
-       case IOCTL_SETVID:
+       case CP210x_IOCTL_SETVID:
        {
                unsigned int vid;
                if (!copy_from_user(&vid, (unsigned int __user *)arg,
@@ -825,7 +865,7 @@ static int cp210x_ioctl(struct tty_struct *tty, struct file *file,
        }
        break;
 
-       case IOCTL_SETPID:
+       case CP210x_IOCTL_SETPID:
        {
                unsigned int pid;
                if (!copy_from_user(&pid, (unsigned int __user *)arg,
@@ -836,40 +876,31 @@ static int cp210x_ioctl(struct tty_struct *tty, struct file *file,
        }
        break;
 
-       case IOCTL_SETMFG:
-       if (cp210x_has_setmfg()) {
-               char usbstr[USBSTRLEN(CP210x_MAX_MFG_STRLEN)];
-               size_t len = cp210x_usbstr_from_user(usbstr, arg,
-                               sizeof(usbstr));
-               if (len && cp210x_setstr(port, 0x00, usbstr) == len)
-                       return 0;
-       }
-       return -EFAULT;
-       break;
-
-       case IOCTL_SETPRODUCT:
+       case CP210x_IOCTL_SETPRODUCT:
        {
-               char usbstr[USBSTRLEN(CP210x_MAX_PRODUCT_STRLEN)];
-               size_t len = cp210x_usbstr_from_user(usbstr, arg,
+               __le16 usbstr[CP210x_MAX_PRODUCT_STRLEN + 1];
+               size_t len = cp210x_usbstr_from_user(usbstr,
+                               (struct cp210x_buffer __user *)arg,
                                sizeof(usbstr));
-               if (len && cp210x_setstr(port, 0x03, usbstr) == len)
+               if (len > 0 && cp210x_setstr(port, 0x03, usbstr) == len)
                        return 0;
                return -EFAULT;
        }
        break;
 
-       case IOCTL_SETSERIAL:
+       case CP210x_IOCTL_SETSERIAL:
        {
-               char usbstr[USBSTRLEN(CP210x_MAX_SERIAL_STRLEN)];
-               size_t len = cp210x_usbstr_from_user(usbstr, arg,
+               __le16 usbstr[CP210x_MAX_SERIAL_STRLEN + 1];
+               size_t len = cp210x_usbstr_from_user(usbstr,
+                               (struct cp210x_buffer __user *)arg,
                                sizeof(usbstr));
-               if (len && cp210x_setstr(port, 0x04, usbstr) == len)
+               if (len > 0 && cp210x_setstr(port, 0x04, usbstr) == len)
                        return 0;
                return -EFAULT;
        }
        break;
 
-       case IOCTL_SETDEVVER:
+       case CP210x_IOCTL_SETDEVVER:
        {
                unsigned int ver;
                if (!copy_from_user(&ver, (unsigned int __user *)arg,