#include <linux/usb.h>
#include <asm/uaccess.h>
#include <linux/usb/serial.h>
+#include "cp210x.h"
/*
* Version Information
#define CONTROL_WRITE_DTR 0x0100
#define CONTROL_WRITE_RTS 0x0200
-/* CP2103 ioctls */
-#define IOCTL_GPIOGET 0x8000 /* Get gpio bits */
-#define IOCTL_GPIOSET 0x8001 /* Set gpio bits */
-#define IOCTL_GPIOBIC 0x8002 /* Clear specific gpio bit(s) */
-#define IOCTL_GPIOBIS 0x8003 /* Set specific gpio bit(s) */
-
-/* CP210x ioctls principally used during initial device configuration */
-#define IOCTL_DEVICERESET 0x8004 /* Reset the cp210x */
-#define IOCTL_PORTCONFGET 0x8005 /* Get port configuration */
-#define IOCTL_PORTCONFSET 0x8006 /* Set port configuration */
-#define IOCTL_SETVID 0x8007 /* Set vendor id */
-#define IOCTL_SETPID 0x8008 /* Set product id */
-#define IOCTL_SETMFG 0x8009 /* Set manufacturer string */
-#define IOCTL_SETPRODUCT 0x800a /* Set product string */
-#define IOCTL_SETSERIAL 0x800b /* Set serial number string */
-#define IOCTL_SETDEVVER 0x800c /* set device version id */
-/* FIXME: where is IOCTL_SETMFG? */
-
-/* CP2103 GPIO */
-#define GPIO_0 0x01
-#define GPIO_1 0x02
-#define GPIO_2 0x04
-#define GPIO_3 0x08
-#define GPIO_MASK (GPIO_0|GPIO_1|GPIO_2|GPIO_3)
-
-/* GetDeviceVersion() return codes */
-#define CP210x_CP2101_VERSION 0x01
-#define CP210x_CP2102_VERSION 0x02
-#define CP210x_CP2103_VERSION 0x03
-
-/* Return codes */
-#define CP210x_SUCCESS 0x00
-#define CP210x_DEVICE_NOT_FOUND 0xFF
-#define CP210x_INVALID_HANDLE 0x01
-#define CP210x_INVALID_PARAMETER 0x02
-#define CP210x_DEVICE_IO_FAILED 0x03
-#define CP210x_FUNCTION_NOT_SUPPORTED 0x04
-#define CP210x_GLOBAL_DATA_ERROR 0x05
-#define CP210x_FILE_ERROR 0x06
-#define CP210x_COMMAND_FAILED 0x08
-#define CP210x_INVALID_ACCESS_TYPE 0x09
-
-/* USB descriptor sizes */
-#define CP210x_MAX_DEVICE_STRLEN 256
-#define CP210x_MAX_PRODUCT_STRLEN 126
-#define CP210x_MAX_SERIAL_STRLEN 63
-#define CP210x_MAX_MAXPOWER 250
-
-/* Used to pass variable sized buffers between user and kernel space (ioctls) */
-typedef struct {
- char *buf;
- size_t len;
-} cp210x_buffer_t;
-
-/* Port config definitions */
-typedef struct {
- uint16_t mode; /* Push-pull = 1, Open-drain = 0 */
- uint16_t lowPower;
- uint16_t latch; /* Logic high = 1, Logic low = 0 */
-} cp210x_port_state_t;
-
-typedef struct {
- cp210x_port_state_t reset;
- cp210x_port_state_t suspend;
- uint8_t enhancedFxn;
-} cp210x_port_config_t;
-
-#define PORT_CONFIG_LEN 13 /* Because sizeof() will pad to full words */
+/* cp210x_get_partnum() return codes */
+#define CP210x_PART_UNKNOWN 0x00
+#define CP210x_PART_CP2101 0x01
+#define CP210x_PART_CP2102 0x02
+#define CP210x_PART_CP2103 0x03
+
+/* Helper to make usb string size */
+#define USBSTRLEN(x) (x * 2 + 2)
+
+/* 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.
+ * 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,
+ 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;
+ }
+ return len;
+}
/*
- * cp210x_buf_from_user
- * Copy a buffer from user space, returning the number of bytes copied
- * from ubuf.buf into kbuf. klen is the size of the buffer at kbuf.
+ * cp210x_usbstr_from_user
+ * Populate kbuf with a usb string derived from a user space variable. klen
+ * is the size of the buffer at kbuf.
+ * Returns the number of bytes used in kbuf.
*/
-static size_t copy_buf_from_user(char *kbuf, unsigned long ubuf, size_t klen)
+static size_t cp210x_usbstr_from_user(char *kbuf, unsigned long ubuf, size_t klen)
{
- cp210x_buffer_t t;
+ struct cp210x_buffer t;
+ char* str;
+ size_t slen;
- if (!kbuf || !ubuf || !klen ||
- copy_from_user(&t, (cp210x_buffer_t __user *)ubuf,
- sizeof(t)))
+ if (!kbuf || !ubuf || !klen)
return 0;
- if (t.len < klen)
- klen = t.len;
- if (!t.buf || !t.len ||
- copy_from_user(kbuf, (char __user *)t.buf, klen))
+ if (copy_from_user(&t, (struct cp210x_buffer __user *)ubuf, sizeof(t)))
return 0;
- return klen;
+ if (!t.buf || !t.len || USBSTRLEN(t.len) > klen)
+ return 0;
+ slen = (klen - 2) / 2;
+ if (t.len < slen)
+ slen = t.len;
+ str = kbuf + klen - slen;
+ if (copy_from_user(str, (u8 __user *)t.buf, slen))
+ return 0;
+ return make_usb_string(kbuf, klen, str, slen);
+}
+
+/* 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;
}
/*
dbg("%s", __FUNCTION__);
#if 1
- /* Is this better than usb_device_reset? It may be. Once a client issues
+ /* 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...
static int cp210x_get_partnum(struct usb_serial_port *port)
{
- static u8 _partnum = 0;
- int ret = CP210x_SUCCESS;
- if (!_partnum) {
+ static u8 _partnum = CP210x_PART_UNKNOWN;
+
+ if (_partnum == CP210x_PART_UNKNOWN) {
u8 addr = port->serial->dev->actconfig->interface[0]->
cur_altsetting->endpoint[0].desc.bEndpointAddress &
USB_ENDPOINT_NUMBER_MASK;
- if (addr == 0x03 || addr == 0x02) /* The part is a cp2101 */
- _partnum = 0x01;
+ if (addr == 0x03 || addr == 0x02)
+ _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)
- ret = CP210x_DEVICE_IO_FAILED;
- } else
- ret = CP210x_DEVICE_IO_FAILED;
+ _partnum = CP210x_PART_UNKNOWN;
+ }
}
- dbg("%s - partnum %u err %d", __FUNCTION__, _partnum, ret);
- return (ret == CP210x_SUCCESS) ? _partnum : 0;
+ dbg("%s - partnum %u", __FUNCTION__, _partnum);
+ return _partnum;
}
static inline int cp210x_setu16(struct usb_serial_port *port, int cmd,
value, NULL, 0);
}
-/* Populates usbstr with: (len) + (0x03) + unicode(str). Each char in str
- * takes up two bytes in unicode format, so the resulting len(usbstr) is
- * 2 * len(str) + 2.
- * Returns the resulting length of the string in usbstr.
- * 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,
- size_t srclen)
-{
- int len = 0;
-
- if (usbstr && usblen >= 2 && src && *src && srclen) {
- char *p;
-
- /* The usb string format uses first byte as length */
- if (usblen > 256)
- usblen = 256;
-
- p = usbstr + 1;
- *p++ = 0x03;
- len = 2;
- while (srclen && len < usblen) {
- *p++ = *src++;
- *p++ = 0;
- len += 2;
- srclen--;
- }
- *usbstr = (char)len;
- }
- return len;
-}
-
/*
* cp210x_setstr
*
}
static int cp210x_portconfset(struct usb_serial_port *port,
- cp210x_port_config_t *config)
+ struct cp210x_port_config *config)
{
- cp210x_port_config_t lconfig;
+ struct cp210x_port_config lconfig;
int ret;
dbg("%s", __FUNCTION__);
memcpy(&lconfig, config, sizeof(lconfig));
- /* apparently not implemented yet */
- lconfig.suspend.lowPower = 0;
- lconfig.reset.lowPower = 0;
-
/* Words from cp2103 are MSB */
lconfig.reset.mode = cpu_to_be16(config->reset.mode);
- /* lconfig.reset.lowPower = cpu_to_be16(config->reset.lowPower); */
lconfig.reset.latch = cpu_to_be16(config->reset.latch);
lconfig.suspend.mode = cpu_to_be16(config->suspend.mode);
- /* lconfig.suspend.lowPower = cpu_to_be16(config->suspend.lowPower); */
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
+ lconfig.suspend.lowPower = 0;
+ lconfig.reset.lowPower = 0;
+#endif
ret = cp210x_ctlmsg(port, 0xff, 0x40, 0x370c, 0, &lconfig,
- PORT_CONFIG_LEN);
- if (ret == PORT_CONFIG_LEN)
+ sizeof(struct cp210x_port_config));
+ if (ret == sizeof(struct cp210x_port_config))
return 0;
else if (ret >= 0)
return -1;
}
static int cp210x_portconfget(struct usb_serial_port *port,
- cp210x_port_config_t *config)
+ struct cp210x_port_config *config)
{
int ret;
dbg("%s", __FUNCTION__);
ret = cp210x_ctlmsg(port, 0xff, 0xc0, 0x370c, 0, config,
- PORT_CONFIG_LEN);
- if (ret == PORT_CONFIG_LEN) {
+ sizeof(struct cp210x_port_config));
+ if (ret == sizeof(struct cp210x_port_config)) {
/* Words from cp2103 are MSB */
config->reset.mode = be16_to_cpu(config->reset.mode);
config->reset.lowPower = be16_to_cpu(config->reset.lowPower);
}
break;
- case IOCTL_GPIOGET:
- if (cp210x_get_partnum(port) == CP210x_CP2103_VERSION) {
+ 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)))
return -EFAULT;
break;
- case IOCTL_GPIOSET:
- if (cp210x_get_partnum(port) == CP210x_CP2103_VERSION &&
+ 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:
- if (cp210x_get_partnum(port) == CP210x_CP2103_VERSION &&
- !cp210x_gpiosetb(port, (cmd==IOCTL_GPIOBIC) ? 0 : arg,
- (cmd==IOCTL_GPIOBIC) ? arg : 0))
+ case CP210x_IOCTL_GPIOBIC:
+ case CP210x_IOCTL_GPIOBIS:
+ if (cp210x_get_partnum(port) == CP210x_PART_CP2103 &&
+ !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:
{
- cp210x_port_config_t config;
+ struct cp210x_port_config config;
if (!cp210x_portconfget(port, &config) && !copy_to_user(
- (cp210x_port_config_t __user *)arg,
+ (struct cp210x_port_config __user *)arg,
&config, sizeof(config)))
return 0;
}
return -EFAULT;
break;
- case IOCTL_PORTCONFSET:
+ case CP210x_IOCTL_PORTCONFSET:
{
- cp210x_port_config_t config;
- if (!copy_from_user(&config, (cp210x_port_config_t __user *)arg,
+ struct cp210x_port_config config;
+ if (!copy_from_user(&config, (struct cp210x_port_config __user *)arg,
sizeof(config)) &&
!cp210x_portconfset(port, &config))
return 0;
}
break;
- case IOCTL_SETVID:
+ case CP210x_IOCTL_SETVID:
{
unsigned int vid;
if (!copy_from_user(&vid, (unsigned int __user *)arg,
}
break;
- case IOCTL_SETPID:
+ case CP210x_IOCTL_SETPID:
{
unsigned int pid;
if (!copy_from_user(&pid, (unsigned int __user *)arg,
}
break;
- case IOCTL_SETMFG:
-#if 0 /* Silicon Labs apparently doesn't provide for setting of mfg desc */
- {
- char usbstr[CP210x_MAX_MFG_STRLEN * 2 + 2];
- size_t len = copy_buf_from_user(usbstr + sizeof(usbstr) -
- CP210x_MAX_MFG_STRLEN, arg,
- CP210x_MAX_MFG_STRLEN);
- len = make_usb_string(usbstr, sizeof(usbstr), str, len);
+ case CP210x_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;
}
-#endif
+ return -EFAULT;
break;
- case IOCTL_SETPRODUCT:
+ case CP210x_IOCTL_SETPRODUCT:
{
- char usbstr[CP210x_MAX_PRODUCT_STRLEN * 2 + 2];
- char *str = usbstr + sizeof(usbstr) - CP210x_MAX_PRODUCT_STRLEN;
- size_t len = copy_buf_from_user(str, arg,
- CP210x_MAX_PRODUCT_STRLEN);
- len = make_usb_string(usbstr, sizeof(usbstr), str, len);
+ char usbstr[USBSTRLEN(CP210x_MAX_PRODUCT_STRLEN)];
+ size_t len = cp210x_usbstr_from_user(usbstr, arg,
+ sizeof(usbstr));
if (len && cp210x_setstr(port, 0x03, usbstr) == len)
return 0;
return -EFAULT;
}
break;
- case IOCTL_SETSERIAL:
+ case CP210x_IOCTL_SETSERIAL:
{
- char usbstr[CP210x_MAX_SERIAL_STRLEN * 2 + 2];
- char *str = usbstr + sizeof(usbstr) - CP210x_MAX_SERIAL_STRLEN;
- size_t len = copy_buf_from_user(str, arg,
- CP210x_MAX_SERIAL_STRLEN);
- len = make_usb_string(usbstr, sizeof(usbstr), str, len);
+ char usbstr[USBSTRLEN(CP210x_MAX_SERIAL_STRLEN)];
+ size_t len = cp210x_usbstr_from_user(usbstr, arg,
+ sizeof(usbstr));
if (len && 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,