2 * hid-cp2112.c - Silicon Labs HID USB to SMBus master bridge
3 * Copyright (c) 2013,2014 Uplogix, Inc.
4 * David Barksdale <dbarksdale@uplogix.com>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * The Silicon Labs CP2112 chip is a USB HID device which provides an
18 * SMBus controller for talking to slave devices and 8 GPIO pins. The
19 * host communicates with the CP2112 via raw HID reports.
22 * http://www.silabs.com/Support%20Documents/TechnicalDocs/CP2112.pdf
23 * Programming Interface Specification:
24 * http://www.silabs.com/Support%20Documents/TechnicalDocs/AN495.pdf
27 #include <linux/gpio.h>
28 #include <linux/gpio/driver.h>
29 #include <linux/hid.h>
30 #include <linux/hidraw.h>
31 #include <linux/i2c.h>
32 #include <linux/module.h>
33 #include <linux/nls.h>
34 #include <linux/usb/ch9.h>
37 #define CP2112_REPORT_MAX_LENGTH 64
38 #define CP2112_GPIO_CONFIG_LENGTH 5
39 #define CP2112_GPIO_GET_LENGTH 2
40 #define CP2112_GPIO_SET_LENGTH 3
43 CP2112_GPIO_CONFIG = 0x02,
44 CP2112_GPIO_GET = 0x03,
45 CP2112_GPIO_SET = 0x04,
46 CP2112_GET_VERSION_INFO = 0x05,
47 CP2112_SMBUS_CONFIG = 0x06,
48 CP2112_DATA_READ_REQUEST = 0x10,
49 CP2112_DATA_WRITE_READ_REQUEST = 0x11,
50 CP2112_DATA_READ_FORCE_SEND = 0x12,
51 CP2112_DATA_READ_RESPONSE = 0x13,
52 CP2112_DATA_WRITE_REQUEST = 0x14,
53 CP2112_TRANSFER_STATUS_REQUEST = 0x15,
54 CP2112_TRANSFER_STATUS_RESPONSE = 0x16,
55 CP2112_CANCEL_TRANSFER = 0x17,
56 CP2112_LOCK_BYTE = 0x20,
57 CP2112_USB_CONFIG = 0x21,
58 CP2112_MANUFACTURER_STRING = 0x22,
59 CP2112_PRODUCT_STRING = 0x23,
60 CP2112_SERIAL_STRING = 0x24,
66 STATUS0_COMPLETE = 0x02,
71 STATUS1_TIMEOUT_NACK = 0x00,
72 STATUS1_TIMEOUT_BUS = 0x01,
73 STATUS1_ARBITRATION_LOST = 0x02,
74 STATUS1_READ_INCOMPLETE = 0x03,
75 STATUS1_WRITE_INCOMPLETE = 0x04,
76 STATUS1_SUCCESS = 0x05,
79 struct cp2112_smbus_config_report {
80 u8 report; /* CP2112_SMBUS_CONFIG */
81 __be32 clock_speed; /* Hz */
82 u8 device_address; /* Stored in the upper 7 bits */
83 u8 auto_send_read; /* 1 = enabled, 0 = disabled */
84 __be16 write_timeout; /* ms, 0 = no timeout */
85 __be16 read_timeout; /* ms, 0 = no timeout */
86 u8 scl_low_timeout; /* 1 = enabled, 0 = disabled */
87 __be16 retry_time; /* # of retries, 0 = no limit */
90 struct cp2112_usb_config_report {
91 u8 report; /* CP2112_USB_CONFIG */
92 __le16 vid; /* Vendor ID */
93 __le16 pid; /* Product ID */
94 u8 max_power; /* Power requested in 2mA units */
95 u8 power_mode; /* 0x00 = bus powered
96 0x01 = self powered & regulator off
97 0x02 = self powered & regulator on */
100 u8 mask; /* What fields to program */
103 struct cp2112_read_req_report {
104 u8 report; /* CP2112_DATA_READ_REQUEST */
109 struct cp2112_write_read_req_report {
110 u8 report; /* CP2112_DATA_WRITE_READ_REQUEST */
113 u8 target_address_length;
114 u8 target_address[16];
117 struct cp2112_write_req_report {
118 u8 report; /* CP2112_DATA_WRITE_REQUEST */
124 struct cp2112_force_read_report {
125 u8 report; /* CP2112_DATA_READ_FORCE_SEND */
129 struct cp2112_xfer_status_report {
130 u8 report; /* CP2112_TRANSFER_STATUS_RESPONSE */
131 u8 status0; /* STATUS0_* */
132 u8 status1; /* STATUS1_* */
137 struct cp2112_string_report {
138 u8 dummy; /* force .string to be aligned */
139 u8 report; /* CP2112_*_STRING */
140 u8 length; /* length in bytes of everyting after .report */
141 u8 type; /* USB_DT_STRING */
142 wchar_t string[30]; /* UTF16_LITTLE_ENDIAN string */
145 /* Number of times to request transfer status before giving up waiting for a
146 transfer to complete. This may need to be changed if SMBUS clock, retries,
147 or read/write/scl_low timeout settings are changed. */
148 static const int XFER_STATUS_RETRIES = 10;
150 /* Time in ms to wait for a CP2112_DATA_READ_RESPONSE or
151 CP2112_TRANSFER_STATUS_RESPONSE. */
152 static const int RESPONSE_TIMEOUT = 50;
154 static const struct hid_device_id cp2112_devices[] = {
155 { HID_USB_DEVICE(USB_VENDOR_ID_CYGNAL, USB_DEVICE_ID_CYGNAL_CP2112) },
158 MODULE_DEVICE_TABLE(hid, cp2112_devices);
160 struct cp2112_device {
161 struct i2c_adapter adap;
162 struct hid_device *hdev;
163 wait_queue_head_t wait;
174 struct gpio_desc *desc[8];
176 struct delayed_work gpio_poll_worker;
177 unsigned long irq_mask;
181 static int gpio_push_pull = 0xFF;
182 module_param(gpio_push_pull, int, S_IRUGO | S_IWUSR);
183 MODULE_PARM_DESC(gpio_push_pull, "GPIO push-pull configuration bitmask");
185 static int cp2112_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
187 struct cp2112_device *dev = gpiochip_get_data(chip);
188 struct hid_device *hdev = dev->hdev;
189 u8 *buf = dev->in_out_buffer;
192 mutex_lock(&dev->lock);
194 ret = hid_hw_raw_request(hdev, CP2112_GPIO_CONFIG, buf,
195 CP2112_GPIO_CONFIG_LENGTH, HID_FEATURE_REPORT,
197 if (ret != CP2112_GPIO_CONFIG_LENGTH) {
198 hid_err(hdev, "error requesting GPIO config: %d\n", ret);
202 buf[1] &= ~(1 << offset);
203 buf[2] = gpio_push_pull;
205 ret = hid_hw_raw_request(hdev, CP2112_GPIO_CONFIG, buf,
206 CP2112_GPIO_CONFIG_LENGTH, HID_FEATURE_REPORT,
209 hid_err(hdev, "error setting GPIO config: %d\n", ret);
216 mutex_unlock(&dev->lock);
217 return ret < 0 ? ret : -EIO;
220 static void cp2112_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
222 struct cp2112_device *dev = gpiochip_get_data(chip);
223 struct hid_device *hdev = dev->hdev;
224 u8 *buf = dev->in_out_buffer;
227 mutex_lock(&dev->lock);
229 buf[0] = CP2112_GPIO_SET;
230 buf[1] = value ? 0xff : 0;
231 buf[2] = 1 << offset;
233 ret = hid_hw_raw_request(hdev, CP2112_GPIO_SET, buf,
234 CP2112_GPIO_SET_LENGTH, HID_FEATURE_REPORT,
237 hid_err(hdev, "error setting GPIO values: %d\n", ret);
239 mutex_unlock(&dev->lock);
242 static int cp2112_gpio_get_all(struct gpio_chip *chip)
244 struct cp2112_device *dev = gpiochip_get_data(chip);
245 struct hid_device *hdev = dev->hdev;
246 u8 *buf = dev->in_out_buffer;
249 mutex_lock(&dev->lock);
251 ret = hid_hw_raw_request(hdev, CP2112_GPIO_GET, buf,
252 CP2112_GPIO_GET_LENGTH, HID_FEATURE_REPORT,
254 if (ret != CP2112_GPIO_GET_LENGTH) {
255 hid_err(hdev, "error requesting GPIO values: %d\n", ret);
256 ret = ret < 0 ? ret : -EIO;
263 mutex_unlock(&dev->lock);
268 static int cp2112_gpio_get(struct gpio_chip *chip, unsigned int offset)
272 ret = cp2112_gpio_get_all(chip);
276 return (ret >> offset) & 1;
279 static int cp2112_gpio_direction_output(struct gpio_chip *chip,
280 unsigned offset, int value)
282 struct cp2112_device *dev = gpiochip_get_data(chip);
283 struct hid_device *hdev = dev->hdev;
284 u8 *buf = dev->in_out_buffer;
287 mutex_lock(&dev->lock);
289 ret = hid_hw_raw_request(hdev, CP2112_GPIO_CONFIG, buf,
290 CP2112_GPIO_CONFIG_LENGTH, HID_FEATURE_REPORT,
292 if (ret != CP2112_GPIO_CONFIG_LENGTH) {
293 hid_err(hdev, "error requesting GPIO config: %d\n", ret);
297 buf[1] |= 1 << offset;
298 buf[2] = gpio_push_pull;
300 ret = hid_hw_raw_request(hdev, CP2112_GPIO_CONFIG, buf,
301 CP2112_GPIO_CONFIG_LENGTH, HID_FEATURE_REPORT,
304 hid_err(hdev, "error setting GPIO config: %d\n", ret);
308 mutex_unlock(&dev->lock);
311 * Set gpio value when output direction is already set,
312 * as specified in AN495, Rev. 0.2, cpt. 4.4
314 cp2112_gpio_set(chip, offset, value);
319 mutex_unlock(&dev->lock);
320 return ret < 0 ? ret : -EIO;
323 static int cp2112_hid_get(struct hid_device *hdev, unsigned char report_number,
324 u8 *data, size_t count, unsigned char report_type)
329 buf = kmalloc(count, GFP_KERNEL);
333 ret = hid_hw_raw_request(hdev, report_number, buf, count,
334 report_type, HID_REQ_GET_REPORT);
335 memcpy(data, buf, count);
340 static int cp2112_hid_output(struct hid_device *hdev, u8 *data, size_t count,
341 unsigned char report_type)
346 buf = kmemdup(data, count, GFP_KERNEL);
350 if (report_type == HID_OUTPUT_REPORT)
351 ret = hid_hw_output_report(hdev, buf, count);
353 ret = hid_hw_raw_request(hdev, buf[0], buf, count, report_type,
360 static int cp2112_wait(struct cp2112_device *dev, atomic_t *avail)
364 /* We have sent either a CP2112_TRANSFER_STATUS_REQUEST or a
365 * CP2112_DATA_READ_FORCE_SEND and we are waiting for the response to
366 * come in cp2112_raw_event or timeout. There will only be one of these
367 * in flight at any one time. The timeout is extremely large and is a
368 * last resort if the CP2112 has died. If we do timeout we don't expect
369 * to receive the response which would cause data races, it's not like
370 * we can do anything about it anyway.
372 ret = wait_event_interruptible_timeout(dev->wait,
373 atomic_read(avail), msecs_to_jiffies(RESPONSE_TIMEOUT));
374 if (-ERESTARTSYS == ret)
379 atomic_set(avail, 0);
383 static int cp2112_xfer_status(struct cp2112_device *dev)
385 struct hid_device *hdev = dev->hdev;
389 buf[0] = CP2112_TRANSFER_STATUS_REQUEST;
391 atomic_set(&dev->xfer_avail, 0);
393 ret = cp2112_hid_output(hdev, buf, 2, HID_OUTPUT_REPORT);
395 hid_warn(hdev, "Error requesting status: %d\n", ret);
399 ret = cp2112_wait(dev, &dev->xfer_avail);
403 return dev->xfer_status;
406 static int cp2112_read(struct cp2112_device *dev, u8 *data, size_t size)
408 struct hid_device *hdev = dev->hdev;
409 struct cp2112_force_read_report report;
412 if (size > sizeof(dev->read_data))
413 size = sizeof(dev->read_data);
414 report.report = CP2112_DATA_READ_FORCE_SEND;
415 report.length = cpu_to_be16(size);
417 atomic_set(&dev->read_avail, 0);
419 ret = cp2112_hid_output(hdev, &report.report, sizeof(report),
422 hid_warn(hdev, "Error requesting data: %d\n", ret);
426 ret = cp2112_wait(dev, &dev->read_avail);
430 hid_dbg(hdev, "read %d of %zd bytes requested\n",
431 dev->read_length, size);
433 if (size > dev->read_length)
434 size = dev->read_length;
436 memcpy(data, dev->read_data, size);
437 return dev->read_length;
440 static int cp2112_read_req(void *buf, u8 slave_address, u16 length)
442 struct cp2112_read_req_report *report = buf;
444 if (length < 1 || length > 512)
447 report->report = CP2112_DATA_READ_REQUEST;
448 report->slave_address = slave_address << 1;
449 report->length = cpu_to_be16(length);
450 return sizeof(*report);
453 static int cp2112_write_read_req(void *buf, u8 slave_address, u16 length,
454 u8 command, u8 *data, u8 data_length)
456 struct cp2112_write_read_req_report *report = buf;
458 if (length < 1 || length > 512
459 || data_length > sizeof(report->target_address) - 1)
462 report->report = CP2112_DATA_WRITE_READ_REQUEST;
463 report->slave_address = slave_address << 1;
464 report->length = cpu_to_be16(length);
465 report->target_address_length = data_length + 1;
466 report->target_address[0] = command;
467 memcpy(&report->target_address[1], data, data_length);
468 return data_length + 6;
471 static int cp2112_write_req(void *buf, u8 slave_address, u8 command, u8 *data,
474 struct cp2112_write_req_report *report = buf;
476 if (data_length > sizeof(report->data) - 1)
479 report->report = CP2112_DATA_WRITE_REQUEST;
480 report->slave_address = slave_address << 1;
481 report->length = data_length + 1;
482 report->data[0] = command;
483 memcpy(&report->data[1], data, data_length);
484 return data_length + 4;
487 static int cp2112_i2c_write_req(void *buf, u8 slave_address, u8 *data,
490 struct cp2112_write_req_report *report = buf;
492 if (data_length > sizeof(report->data))
495 report->report = CP2112_DATA_WRITE_REQUEST;
496 report->slave_address = slave_address << 1;
497 report->length = data_length;
498 memcpy(report->data, data, data_length);
499 return data_length + 3;
502 static int cp2112_i2c_write_read_req(void *buf, u8 slave_address,
503 u8 *addr, int addr_length,
506 struct cp2112_write_read_req_report *report = buf;
508 if (read_length < 1 || read_length > 512 ||
509 addr_length > sizeof(report->target_address))
512 report->report = CP2112_DATA_WRITE_READ_REQUEST;
513 report->slave_address = slave_address << 1;
514 report->length = cpu_to_be16(read_length);
515 report->target_address_length = addr_length;
516 memcpy(report->target_address, addr, addr_length);
517 return addr_length + 5;
520 static int cp2112_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
523 struct cp2112_device *dev = (struct cp2112_device *)adap->algo_data;
524 struct hid_device *hdev = dev->hdev;
527 ssize_t read_length = 0;
529 unsigned int retries;
532 hid_dbg(hdev, "I2C %d messages\n", num);
535 if (msgs->flags & I2C_M_RD) {
536 hid_dbg(hdev, "I2C read %#04x len %d\n",
537 msgs->addr, msgs->len);
538 read_length = msgs->len;
539 read_buf = msgs->buf;
540 count = cp2112_read_req(buf, msgs->addr, msgs->len);
542 hid_dbg(hdev, "I2C write %#04x len %d\n",
543 msgs->addr, msgs->len);
544 count = cp2112_i2c_write_req(buf, msgs->addr,
545 msgs->buf, msgs->len);
549 } else if (dev->hwversion > 1 && /* no repeated start in rev 1 */
551 msgs[0].addr == msgs[1].addr &&
552 !(msgs[0].flags & I2C_M_RD) && (msgs[1].flags & I2C_M_RD)) {
553 hid_dbg(hdev, "I2C write-read %#04x wlen %d rlen %d\n",
554 msgs[0].addr, msgs[0].len, msgs[1].len);
555 read_length = msgs[1].len;
556 read_buf = msgs[1].buf;
557 count = cp2112_i2c_write_read_req(buf, msgs[0].addr,
558 msgs[0].buf, msgs[0].len, msgs[1].len);
563 "Multi-message I2C transactions not supported\n");
567 ret = hid_hw_power(hdev, PM_HINT_FULLON);
569 hid_err(hdev, "power management error: %d\n", ret);
573 ret = cp2112_hid_output(hdev, buf, count, HID_OUTPUT_REPORT);
575 hid_warn(hdev, "Error starting transaction: %d\n", ret);
579 for (retries = 0; retries < XFER_STATUS_RETRIES; ++retries) {
580 ret = cp2112_xfer_status(dev);
588 if (XFER_STATUS_RETRIES <= retries) {
589 hid_warn(hdev, "Transfer timed out, cancelling.\n");
590 buf[0] = CP2112_CANCEL_TRANSFER;
593 ret = cp2112_hid_output(hdev, buf, 2, HID_OUTPUT_REPORT);
595 hid_warn(hdev, "Error cancelling transaction: %d\n",
602 for (count = 0; count < read_length;) {
603 ret = cp2112_read(dev, read_buf + count, read_length - count);
607 hid_err(hdev, "read returned 0\n");
612 if (count > read_length) {
614 * The hardware returned too much data.
615 * This is mostly harmless because cp2112_read()
616 * has a limit check so didn't overrun our
617 * buffer. Nevertheless, we return an error
618 * because something is seriously wrong and
619 * it shouldn't go unnoticed.
621 hid_err(hdev, "long read: %d > %zd\n",
622 ret, read_length - count + ret);
628 /* return the number of transferred messages */
632 hid_hw_power(hdev, PM_HINT_NORMAL);
633 hid_dbg(hdev, "I2C transfer finished: %d\n", ret);
637 static int cp2112_xfer(struct i2c_adapter *adap, u16 addr,
638 unsigned short flags, char read_write, u8 command,
639 int size, union i2c_smbus_data *data)
641 struct cp2112_device *dev = (struct cp2112_device *)adap->algo_data;
642 struct hid_device *hdev = dev->hdev;
646 size_t read_length = 0;
647 unsigned int retries;
650 hid_dbg(hdev, "%s addr 0x%x flags 0x%x cmd 0x%x size %d\n",
651 read_write == I2C_SMBUS_WRITE ? "write" : "read",
652 addr, flags, command, size);
658 if (I2C_SMBUS_READ == read_write)
659 count = cp2112_read_req(buf, addr, read_length);
661 count = cp2112_write_req(buf, addr, command, NULL,
664 case I2C_SMBUS_BYTE_DATA:
667 if (I2C_SMBUS_READ == read_write)
668 count = cp2112_write_read_req(buf, addr, read_length,
671 count = cp2112_write_req(buf, addr, command,
674 case I2C_SMBUS_WORD_DATA:
676 word = cpu_to_le16(data->word);
678 if (I2C_SMBUS_READ == read_write)
679 count = cp2112_write_read_req(buf, addr, read_length,
682 count = cp2112_write_req(buf, addr, command,
685 case I2C_SMBUS_PROC_CALL:
686 size = I2C_SMBUS_WORD_DATA;
687 read_write = I2C_SMBUS_READ;
689 word = cpu_to_le16(data->word);
691 count = cp2112_write_read_req(buf, addr, read_length, command,
694 case I2C_SMBUS_I2C_BLOCK_DATA:
695 size = I2C_SMBUS_BLOCK_DATA;
697 case I2C_SMBUS_BLOCK_DATA:
698 if (I2C_SMBUS_READ == read_write) {
699 count = cp2112_write_read_req(buf, addr,
703 count = cp2112_write_req(buf, addr, command,
708 case I2C_SMBUS_BLOCK_PROC_CALL:
709 size = I2C_SMBUS_BLOCK_DATA;
710 read_write = I2C_SMBUS_READ;
712 count = cp2112_write_read_req(buf, addr, I2C_SMBUS_BLOCK_MAX,
713 command, data->block,
717 hid_warn(hdev, "Unsupported transaction %d\n", size);
724 ret = hid_hw_power(hdev, PM_HINT_FULLON);
726 hid_err(hdev, "power management error: %d\n", ret);
730 ret = cp2112_hid_output(hdev, buf, count, HID_OUTPUT_REPORT);
732 hid_warn(hdev, "Error starting transaction: %d\n", ret);
736 for (retries = 0; retries < XFER_STATUS_RETRIES; ++retries) {
737 ret = cp2112_xfer_status(dev);
745 if (XFER_STATUS_RETRIES <= retries) {
746 hid_warn(hdev, "Transfer timed out, cancelling.\n");
747 buf[0] = CP2112_CANCEL_TRANSFER;
750 ret = cp2112_hid_output(hdev, buf, 2, HID_OUTPUT_REPORT);
752 hid_warn(hdev, "Error cancelling transaction: %d\n",
759 if (I2C_SMBUS_WRITE == read_write) {
764 if (I2C_SMBUS_BLOCK_DATA == size)
767 ret = cp2112_read(dev, buf, read_length);
770 if (ret != read_length) {
771 hid_warn(hdev, "short read: %d < %zd\n", ret, read_length);
778 case I2C_SMBUS_BYTE_DATA:
781 case I2C_SMBUS_WORD_DATA:
782 data->word = le16_to_cpup((__le16 *)buf);
784 case I2C_SMBUS_BLOCK_DATA:
785 if (read_length > I2C_SMBUS_BLOCK_MAX) {
790 memcpy(data->block, buf, read_length);
796 hid_hw_power(hdev, PM_HINT_NORMAL);
797 hid_dbg(hdev, "transfer finished: %d\n", ret);
801 static u32 cp2112_functionality(struct i2c_adapter *adap)
803 return I2C_FUNC_I2C |
804 I2C_FUNC_SMBUS_BYTE |
805 I2C_FUNC_SMBUS_BYTE_DATA |
806 I2C_FUNC_SMBUS_WORD_DATA |
807 I2C_FUNC_SMBUS_BLOCK_DATA |
808 I2C_FUNC_SMBUS_I2C_BLOCK |
809 I2C_FUNC_SMBUS_PROC_CALL |
810 I2C_FUNC_SMBUS_BLOCK_PROC_CALL;
813 static const struct i2c_algorithm smbus_algorithm = {
814 .master_xfer = cp2112_i2c_xfer,
815 .smbus_xfer = cp2112_xfer,
816 .functionality = cp2112_functionality,
819 static int cp2112_get_usb_config(struct hid_device *hdev,
820 struct cp2112_usb_config_report *cfg)
824 ret = cp2112_hid_get(hdev, CP2112_USB_CONFIG, (u8 *)cfg, sizeof(*cfg),
826 if (ret != sizeof(*cfg)) {
827 hid_err(hdev, "error reading usb config: %d\n", ret);
836 static int cp2112_set_usb_config(struct hid_device *hdev,
837 struct cp2112_usb_config_report *cfg)
841 BUG_ON(cfg->report != CP2112_USB_CONFIG);
843 ret = cp2112_hid_output(hdev, (u8 *)cfg, sizeof(*cfg),
845 if (ret != sizeof(*cfg)) {
846 hid_err(hdev, "error writing usb config: %d\n", ret);
855 static void chmod_sysfs_attrs(struct hid_device *hdev);
857 #define CP2112_CONFIG_ATTR(name, store, format, ...) \
858 static ssize_t name##_store(struct device *kdev, \
859 struct device_attribute *attr, const char *buf, \
862 struct hid_device *hdev = to_hid_device(kdev); \
863 struct cp2112_usb_config_report cfg; \
864 int ret = cp2112_get_usb_config(hdev, &cfg); \
868 ret = cp2112_set_usb_config(hdev, &cfg); \
871 chmod_sysfs_attrs(hdev); \
874 static ssize_t name##_show(struct device *kdev, \
875 struct device_attribute *attr, char *buf) \
877 struct hid_device *hdev = to_hid_device(kdev); \
878 struct cp2112_usb_config_report cfg; \
879 int ret = cp2112_get_usb_config(hdev, &cfg); \
882 return scnprintf(buf, PAGE_SIZE, format, ##__VA_ARGS__); \
884 static DEVICE_ATTR_RW(name);
886 CP2112_CONFIG_ATTR(vendor_id, ({
889 if (sscanf(buf, "%hi", &vid) != 1)
892 cfg.vid = cpu_to_le16(vid);
894 }), "0x%04x\n", le16_to_cpu(cfg.vid));
896 CP2112_CONFIG_ATTR(product_id, ({
899 if (sscanf(buf, "%hi", &pid) != 1)
902 cfg.pid = cpu_to_le16(pid);
904 }), "0x%04x\n", le16_to_cpu(cfg.pid));
906 CP2112_CONFIG_ATTR(max_power, ({
909 if (sscanf(buf, "%i", &mA) != 1)
912 cfg.max_power = (mA + 1) / 2;
914 }), "%u mA\n", cfg.max_power * 2);
916 CP2112_CONFIG_ATTR(power_mode, ({
917 if (sscanf(buf, "%hhi", &cfg.power_mode) != 1)
921 }), "%u\n", cfg.power_mode);
923 CP2112_CONFIG_ATTR(release_version, ({
924 if (sscanf(buf, "%hhi.%hhi", &cfg.release_major, &cfg.release_minor)
929 }), "%u.%u\n", cfg.release_major, cfg.release_minor);
931 #undef CP2112_CONFIG_ATTR
933 struct cp2112_pstring_attribute {
934 struct device_attribute attr;
935 unsigned char report;
938 static ssize_t pstr_store(struct device *kdev,
939 struct device_attribute *kattr, const char *buf,
942 struct hid_device *hdev = to_hid_device(kdev);
943 struct cp2112_pstring_attribute *attr =
944 container_of(kattr, struct cp2112_pstring_attribute, attr);
945 struct cp2112_string_report report;
948 memset(&report, 0, sizeof(report));
950 ret = utf8s_to_utf16s(buf, count, UTF16_LITTLE_ENDIAN,
951 report.string, ARRAY_SIZE(report.string));
952 report.report = attr->report;
953 report.length = ret * sizeof(report.string[0]) + 2;
954 report.type = USB_DT_STRING;
956 ret = cp2112_hid_output(hdev, &report.report, report.length + 1,
958 if (ret != report.length + 1) {
959 hid_err(hdev, "error writing %s string: %d\n", kattr->attr.name,
966 chmod_sysfs_attrs(hdev);
970 static ssize_t pstr_show(struct device *kdev,
971 struct device_attribute *kattr, char *buf)
973 struct hid_device *hdev = to_hid_device(kdev);
974 struct cp2112_pstring_attribute *attr =
975 container_of(kattr, struct cp2112_pstring_attribute, attr);
976 struct cp2112_string_report report;
980 ret = cp2112_hid_get(hdev, attr->report, &report.report,
981 sizeof(report) - 1, HID_FEATURE_REPORT);
983 hid_err(hdev, "error reading %s string: %d\n", kattr->attr.name,
990 if (report.length < 2) {
991 hid_err(hdev, "invalid %s string length: %d\n",
992 kattr->attr.name, report.length);
996 length = report.length > ret - 1 ? ret - 1 : report.length;
997 length = (length - 2) / sizeof(report.string[0]);
998 ret = utf16s_to_utf8s(report.string, length, UTF16_LITTLE_ENDIAN, buf,
1004 #define CP2112_PSTR_ATTR(name, _report) \
1005 static struct cp2112_pstring_attribute dev_attr_##name = { \
1006 .attr = __ATTR(name, (S_IWUSR | S_IRUGO), pstr_show, pstr_store), \
1007 .report = _report, \
1010 CP2112_PSTR_ATTR(manufacturer, CP2112_MANUFACTURER_STRING);
1011 CP2112_PSTR_ATTR(product, CP2112_PRODUCT_STRING);
1012 CP2112_PSTR_ATTR(serial, CP2112_SERIAL_STRING);
1014 #undef CP2112_PSTR_ATTR
1016 static const struct attribute_group cp2112_attr_group = {
1017 .attrs = (struct attribute *[]){
1018 &dev_attr_vendor_id.attr,
1019 &dev_attr_product_id.attr,
1020 &dev_attr_max_power.attr,
1021 &dev_attr_power_mode.attr,
1022 &dev_attr_release_version.attr,
1023 &dev_attr_manufacturer.attr.attr,
1024 &dev_attr_product.attr.attr,
1025 &dev_attr_serial.attr.attr,
1030 /* Chmoding our sysfs attributes is simply a way to expose which fields in the
1031 * PROM have already been programmed. We do not depend on this preventing
1032 * writing to these attributes since the CP2112 will simply ignore writes to
1033 * already-programmed fields. This is why there is no sense in fixing this
1036 static void chmod_sysfs_attrs(struct hid_device *hdev)
1038 struct attribute **attr;
1042 ret = cp2112_hid_get(hdev, CP2112_LOCK_BYTE, buf, sizeof(buf),
1043 HID_FEATURE_REPORT);
1044 if (ret != sizeof(buf)) {
1045 hid_err(hdev, "error reading lock byte: %d\n", ret);
1049 for (attr = cp2112_attr_group.attrs; *attr; ++attr) {
1050 umode_t mode = (buf[1] & 1) ? S_IWUSR | S_IRUGO : S_IRUGO;
1051 ret = sysfs_chmod_file(&hdev->dev.kobj, *attr, mode);
1053 hid_err(hdev, "error chmoding sysfs file %s\n",
1059 static void cp2112_gpio_irq_ack(struct irq_data *d)
1063 static void cp2112_gpio_irq_mask(struct irq_data *d)
1065 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1066 struct cp2112_device *dev = gpiochip_get_data(gc);
1068 __clear_bit(d->hwirq, &dev->irq_mask);
1071 static void cp2112_gpio_irq_unmask(struct irq_data *d)
1073 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1074 struct cp2112_device *dev = gpiochip_get_data(gc);
1076 __set_bit(d->hwirq, &dev->irq_mask);
1079 static void cp2112_gpio_poll_callback(struct work_struct *work)
1081 struct cp2112_device *dev = container_of(work, struct cp2112_device,
1082 gpio_poll_worker.work);
1085 u8 virqs = (u8)dev->irq_mask;
1089 ret = cp2112_gpio_get_all(&dev->gc);
1090 if (ret == -ENODEV) /* the hardware has been disconnected */
1098 virq = ffs(virqs) - 1;
1099 virqs &= ~BIT(virq);
1101 if (!dev->gc.to_irq)
1104 irq = dev->gc.to_irq(&dev->gc, virq);
1106 d = irq_get_irq_data(irq);
1110 irq_type = irqd_get_trigger_type(d);
1112 if (gpio_mask & BIT(virq)) {
1115 if (irq_type & IRQ_TYPE_LEVEL_HIGH)
1116 handle_nested_irq(irq);
1118 if ((irq_type & IRQ_TYPE_EDGE_RISING) &&
1119 !(dev->gpio_prev_state & BIT(virq)))
1120 handle_nested_irq(irq);
1124 if (irq_type & IRQ_TYPE_LEVEL_LOW)
1125 handle_nested_irq(irq);
1127 if ((irq_type & IRQ_TYPE_EDGE_FALLING) &&
1128 (dev->gpio_prev_state & BIT(virq)))
1129 handle_nested_irq(irq);
1133 dev->gpio_prev_state = gpio_mask;
1137 schedule_delayed_work(&dev->gpio_poll_worker, 10);
1141 static unsigned int cp2112_gpio_irq_startup(struct irq_data *d)
1143 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1144 struct cp2112_device *dev = gpiochip_get_data(gc);
1146 INIT_DELAYED_WORK(&dev->gpio_poll_worker, cp2112_gpio_poll_callback);
1148 cp2112_gpio_direction_input(gc, d->hwirq);
1150 if (!dev->gpio_poll) {
1151 dev->gpio_poll = true;
1152 schedule_delayed_work(&dev->gpio_poll_worker, 0);
1155 cp2112_gpio_irq_unmask(d);
1159 static void cp2112_gpio_irq_shutdown(struct irq_data *d)
1161 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1162 struct cp2112_device *dev = gpiochip_get_data(gc);
1164 cancel_delayed_work_sync(&dev->gpio_poll_worker);
1167 static int cp2112_gpio_irq_type(struct irq_data *d, unsigned int type)
1172 static struct irq_chip cp2112_gpio_irqchip = {
1173 .name = "cp2112-gpio",
1174 .irq_startup = cp2112_gpio_irq_startup,
1175 .irq_shutdown = cp2112_gpio_irq_shutdown,
1176 .irq_ack = cp2112_gpio_irq_ack,
1177 .irq_mask = cp2112_gpio_irq_mask,
1178 .irq_unmask = cp2112_gpio_irq_unmask,
1179 .irq_set_type = cp2112_gpio_irq_type,
1182 static int __maybe_unused cp2112_allocate_irq(struct cp2112_device *dev,
1190 dev->desc[pin] = gpiochip_request_own_desc(&dev->gc, pin,
1192 if (IS_ERR(dev->desc[pin])) {
1193 dev_err(dev->gc.parent, "Failed to request GPIO\n");
1194 return PTR_ERR(dev->desc[pin]);
1197 ret = gpiochip_lock_as_irq(&dev->gc, pin);
1199 dev_err(dev->gc.parent, "Failed to lock GPIO as interrupt\n");
1203 ret = gpiod_to_irq(dev->desc[pin]);
1205 dev_err(dev->gc.parent, "Failed to translate GPIO to IRQ\n");
1212 gpiochip_unlock_as_irq(&dev->gc, pin);
1214 gpiochip_free_own_desc(dev->desc[pin]);
1215 dev->desc[pin] = NULL;
1219 static int cp2112_probe(struct hid_device *hdev, const struct hid_device_id *id)
1221 struct cp2112_device *dev;
1223 struct cp2112_smbus_config_report config;
1226 dev = devm_kzalloc(&hdev->dev, sizeof(*dev), GFP_KERNEL);
1230 dev->in_out_buffer = devm_kzalloc(&hdev->dev, CP2112_REPORT_MAX_LENGTH,
1232 if (!dev->in_out_buffer)
1235 mutex_init(&dev->lock);
1237 ret = hid_parse(hdev);
1239 hid_err(hdev, "parse failed\n");
1243 ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
1245 hid_err(hdev, "hw start failed\n");
1249 ret = hid_hw_open(hdev);
1251 hid_err(hdev, "hw open failed\n");
1255 ret = hid_hw_power(hdev, PM_HINT_FULLON);
1257 hid_err(hdev, "power management error: %d\n", ret);
1261 ret = cp2112_hid_get(hdev, CP2112_GET_VERSION_INFO, buf, sizeof(buf),
1262 HID_FEATURE_REPORT);
1263 if (ret != sizeof(buf)) {
1264 hid_err(hdev, "error requesting version\n");
1267 goto err_power_normal;
1270 hid_info(hdev, "Part Number: 0x%02X Device Version: 0x%02X\n",
1273 ret = cp2112_hid_get(hdev, CP2112_SMBUS_CONFIG, (u8 *)&config,
1274 sizeof(config), HID_FEATURE_REPORT);
1275 if (ret != sizeof(config)) {
1276 hid_err(hdev, "error requesting SMBus config\n");
1279 goto err_power_normal;
1282 config.retry_time = cpu_to_be16(1);
1284 ret = cp2112_hid_output(hdev, (u8 *)&config, sizeof(config),
1285 HID_FEATURE_REPORT);
1286 if (ret != sizeof(config)) {
1287 hid_err(hdev, "error setting SMBus config\n");
1290 goto err_power_normal;
1293 hid_set_drvdata(hdev, (void *)dev);
1295 dev->adap.owner = THIS_MODULE;
1296 dev->adap.class = I2C_CLASS_HWMON;
1297 dev->adap.algo = &smbus_algorithm;
1298 dev->adap.algo_data = dev;
1299 dev->adap.dev.parent = &hdev->dev;
1300 snprintf(dev->adap.name, sizeof(dev->adap.name),
1301 "CP2112 SMBus Bridge on hidraw%d",
1302 ((struct hidraw *)hdev->hidraw)->minor);
1303 dev->hwversion = buf[2];
1304 init_waitqueue_head(&dev->wait);
1306 hid_device_io_start(hdev);
1307 ret = i2c_add_adapter(&dev->adap);
1308 hid_device_io_stop(hdev);
1311 hid_err(hdev, "error registering i2c adapter\n");
1312 goto err_power_normal;
1315 hid_dbg(hdev, "adapter registered\n");
1317 dev->gc.label = "cp2112_gpio";
1318 dev->gc.direction_input = cp2112_gpio_direction_input;
1319 dev->gc.direction_output = cp2112_gpio_direction_output;
1320 dev->gc.set = cp2112_gpio_set;
1321 dev->gc.get = cp2112_gpio_get;
1324 dev->gc.can_sleep = 1;
1325 dev->gc.parent = &hdev->dev;
1327 ret = gpiochip_add_data(&dev->gc, dev);
1329 hid_err(hdev, "error registering gpio chip\n");
1333 ret = sysfs_create_group(&hdev->dev.kobj, &cp2112_attr_group);
1335 hid_err(hdev, "error creating sysfs attrs\n");
1336 goto err_gpiochip_remove;
1339 chmod_sysfs_attrs(hdev);
1340 hid_hw_power(hdev, PM_HINT_NORMAL);
1342 ret = gpiochip_irqchip_add(&dev->gc, &cp2112_gpio_irqchip, 0,
1343 handle_simple_irq, IRQ_TYPE_NONE);
1345 dev_err(dev->gc.parent, "failed to add IRQ chip\n");
1346 goto err_sysfs_remove;
1352 sysfs_remove_group(&hdev->dev.kobj, &cp2112_attr_group);
1353 err_gpiochip_remove:
1354 gpiochip_remove(&dev->gc);
1356 i2c_del_adapter(&dev->adap);
1358 hid_hw_power(hdev, PM_HINT_NORMAL);
1366 static void cp2112_remove(struct hid_device *hdev)
1368 struct cp2112_device *dev = hid_get_drvdata(hdev);
1371 sysfs_remove_group(&hdev->dev.kobj, &cp2112_attr_group);
1372 i2c_del_adapter(&dev->adap);
1374 if (dev->gpio_poll) {
1375 dev->gpio_poll = false;
1376 cancel_delayed_work_sync(&dev->gpio_poll_worker);
1379 for (i = 0; i < ARRAY_SIZE(dev->desc); i++) {
1380 gpiochip_unlock_as_irq(&dev->gc, i);
1381 gpiochip_free_own_desc(dev->desc[i]);
1384 gpiochip_remove(&dev->gc);
1385 /* i2c_del_adapter has finished removing all i2c devices from our
1386 * adapter. Well behaved devices should no longer call our cp2112_xfer
1387 * and should have waited for any pending calls to finish. It has also
1388 * waited for device_unregister(&adap->dev) to complete. Therefore we
1389 * can safely free our struct cp2112_device.
1395 static int cp2112_raw_event(struct hid_device *hdev, struct hid_report *report,
1398 struct cp2112_device *dev = hid_get_drvdata(hdev);
1399 struct cp2112_xfer_status_report *xfer = (void *)data;
1402 case CP2112_TRANSFER_STATUS_RESPONSE:
1403 hid_dbg(hdev, "xfer status: %02x %02x %04x %04x\n",
1404 xfer->status0, xfer->status1,
1405 be16_to_cpu(xfer->retries), be16_to_cpu(xfer->length));
1407 switch (xfer->status0) {
1409 dev->xfer_status = -EAGAIN;
1412 dev->xfer_status = -EBUSY;
1414 case STATUS0_COMPLETE:
1415 dev->xfer_status = be16_to_cpu(xfer->length);
1418 switch (xfer->status1) {
1419 case STATUS1_TIMEOUT_NACK:
1420 case STATUS1_TIMEOUT_BUS:
1421 dev->xfer_status = -ETIMEDOUT;
1424 dev->xfer_status = -EIO;
1429 dev->xfer_status = -EINVAL;
1433 atomic_set(&dev->xfer_avail, 1);
1435 case CP2112_DATA_READ_RESPONSE:
1436 hid_dbg(hdev, "read response: %02x %02x\n", data[1], data[2]);
1438 dev->read_length = data[2];
1439 if (dev->read_length > sizeof(dev->read_data))
1440 dev->read_length = sizeof(dev->read_data);
1442 memcpy(dev->read_data, &data[3], dev->read_length);
1443 atomic_set(&dev->read_avail, 1);
1446 hid_err(hdev, "unknown report\n");
1451 wake_up_interruptible(&dev->wait);
1455 static struct hid_driver cp2112_driver = {
1457 .id_table = cp2112_devices,
1458 .probe = cp2112_probe,
1459 .remove = cp2112_remove,
1460 .raw_event = cp2112_raw_event,
1463 module_hid_driver(cp2112_driver);
1464 MODULE_DESCRIPTION("Silicon Labs HID USB to SMBus master bridge");
1465 MODULE_AUTHOR("David Barksdale <dbarksdale@uplogix.com>");
1466 MODULE_LICENSE("GPL");