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 * https://www.silabs.com/documents/public/application-notes/an495-cp2112-interface-specification.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);
204 buf[1] &= ~(1 << offset);
205 buf[2] = gpio_push_pull;
207 ret = hid_hw_raw_request(hdev, CP2112_GPIO_CONFIG, buf,
208 CP2112_GPIO_CONFIG_LENGTH, HID_FEATURE_REPORT,
210 if (ret != CP2112_GPIO_CONFIG_LENGTH) {
211 hid_err(hdev, "error setting GPIO config: %d\n", ret);
220 mutex_unlock(&dev->lock);
224 static void cp2112_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
226 struct cp2112_device *dev = gpiochip_get_data(chip);
227 struct hid_device *hdev = dev->hdev;
228 u8 *buf = dev->in_out_buffer;
231 mutex_lock(&dev->lock);
233 buf[0] = CP2112_GPIO_SET;
234 buf[1] = value ? 0xff : 0;
235 buf[2] = 1 << offset;
237 ret = hid_hw_raw_request(hdev, CP2112_GPIO_SET, buf,
238 CP2112_GPIO_SET_LENGTH, HID_FEATURE_REPORT,
241 hid_err(hdev, "error setting GPIO values: %d\n", ret);
243 mutex_unlock(&dev->lock);
246 static int cp2112_gpio_get_all(struct gpio_chip *chip)
248 struct cp2112_device *dev = gpiochip_get_data(chip);
249 struct hid_device *hdev = dev->hdev;
250 u8 *buf = dev->in_out_buffer;
253 mutex_lock(&dev->lock);
255 ret = hid_hw_raw_request(hdev, CP2112_GPIO_GET, buf,
256 CP2112_GPIO_GET_LENGTH, HID_FEATURE_REPORT,
258 if (ret != CP2112_GPIO_GET_LENGTH) {
259 hid_err(hdev, "error requesting GPIO values: %d\n", ret);
260 ret = ret < 0 ? ret : -EIO;
267 mutex_unlock(&dev->lock);
272 static int cp2112_gpio_get(struct gpio_chip *chip, unsigned int offset)
276 ret = cp2112_gpio_get_all(chip);
280 return (ret >> offset) & 1;
283 static int cp2112_gpio_direction_output(struct gpio_chip *chip,
284 unsigned offset, int value)
286 struct cp2112_device *dev = gpiochip_get_data(chip);
287 struct hid_device *hdev = dev->hdev;
288 u8 *buf = dev->in_out_buffer;
291 mutex_lock(&dev->lock);
293 ret = hid_hw_raw_request(hdev, CP2112_GPIO_CONFIG, buf,
294 CP2112_GPIO_CONFIG_LENGTH, HID_FEATURE_REPORT,
296 if (ret != CP2112_GPIO_CONFIG_LENGTH) {
297 hid_err(hdev, "error requesting GPIO config: %d\n", ret);
301 buf[1] |= 1 << offset;
302 buf[2] = gpio_push_pull;
304 ret = hid_hw_raw_request(hdev, CP2112_GPIO_CONFIG, buf,
305 CP2112_GPIO_CONFIG_LENGTH, HID_FEATURE_REPORT,
308 hid_err(hdev, "error setting GPIO config: %d\n", ret);
312 mutex_unlock(&dev->lock);
315 * Set gpio value when output direction is already set,
316 * as specified in AN495, Rev. 0.2, cpt. 4.4
318 cp2112_gpio_set(chip, offset, value);
323 mutex_unlock(&dev->lock);
324 return ret < 0 ? ret : -EIO;
327 static int cp2112_hid_get(struct hid_device *hdev, unsigned char report_number,
328 u8 *data, size_t count, unsigned char report_type)
333 buf = kmalloc(count, GFP_KERNEL);
337 ret = hid_hw_raw_request(hdev, report_number, buf, count,
338 report_type, HID_REQ_GET_REPORT);
339 memcpy(data, buf, count);
344 static int cp2112_hid_output(struct hid_device *hdev, u8 *data, size_t count,
345 unsigned char report_type)
350 buf = kmemdup(data, count, GFP_KERNEL);
354 if (report_type == HID_OUTPUT_REPORT)
355 ret = hid_hw_output_report(hdev, buf, count);
357 ret = hid_hw_raw_request(hdev, buf[0], buf, count, report_type,
364 static int cp2112_wait(struct cp2112_device *dev, atomic_t *avail)
368 /* We have sent either a CP2112_TRANSFER_STATUS_REQUEST or a
369 * CP2112_DATA_READ_FORCE_SEND and we are waiting for the response to
370 * come in cp2112_raw_event or timeout. There will only be one of these
371 * in flight at any one time. The timeout is extremely large and is a
372 * last resort if the CP2112 has died. If we do timeout we don't expect
373 * to receive the response which would cause data races, it's not like
374 * we can do anything about it anyway.
376 ret = wait_event_interruptible_timeout(dev->wait,
377 atomic_read(avail), msecs_to_jiffies(RESPONSE_TIMEOUT));
378 if (-ERESTARTSYS == ret)
383 atomic_set(avail, 0);
387 static int cp2112_xfer_status(struct cp2112_device *dev)
389 struct hid_device *hdev = dev->hdev;
393 buf[0] = CP2112_TRANSFER_STATUS_REQUEST;
395 atomic_set(&dev->xfer_avail, 0);
397 ret = cp2112_hid_output(hdev, buf, 2, HID_OUTPUT_REPORT);
399 hid_warn(hdev, "Error requesting status: %d\n", ret);
403 ret = cp2112_wait(dev, &dev->xfer_avail);
407 return dev->xfer_status;
410 static int cp2112_read(struct cp2112_device *dev, u8 *data, size_t size)
412 struct hid_device *hdev = dev->hdev;
413 struct cp2112_force_read_report report;
416 if (size > sizeof(dev->read_data))
417 size = sizeof(dev->read_data);
418 report.report = CP2112_DATA_READ_FORCE_SEND;
419 report.length = cpu_to_be16(size);
421 atomic_set(&dev->read_avail, 0);
423 ret = cp2112_hid_output(hdev, &report.report, sizeof(report),
426 hid_warn(hdev, "Error requesting data: %d\n", ret);
430 ret = cp2112_wait(dev, &dev->read_avail);
434 hid_dbg(hdev, "read %d of %zd bytes requested\n",
435 dev->read_length, size);
437 if (size > dev->read_length)
438 size = dev->read_length;
440 memcpy(data, dev->read_data, size);
441 return dev->read_length;
444 static int cp2112_read_req(void *buf, u8 slave_address, u16 length)
446 struct cp2112_read_req_report *report = buf;
448 if (length < 1 || length > 512)
451 report->report = CP2112_DATA_READ_REQUEST;
452 report->slave_address = slave_address << 1;
453 report->length = cpu_to_be16(length);
454 return sizeof(*report);
457 static int cp2112_write_read_req(void *buf, u8 slave_address, u16 length,
458 u8 command, u8 *data, u8 data_length)
460 struct cp2112_write_read_req_report *report = buf;
462 if (length < 1 || length > 512
463 || data_length > sizeof(report->target_address) - 1)
466 report->report = CP2112_DATA_WRITE_READ_REQUEST;
467 report->slave_address = slave_address << 1;
468 report->length = cpu_to_be16(length);
469 report->target_address_length = data_length + 1;
470 report->target_address[0] = command;
471 memcpy(&report->target_address[1], data, data_length);
472 return data_length + 6;
475 static int cp2112_write_req(void *buf, u8 slave_address, u8 command, u8 *data,
478 struct cp2112_write_req_report *report = buf;
480 if (data_length > sizeof(report->data) - 1)
483 report->report = CP2112_DATA_WRITE_REQUEST;
484 report->slave_address = slave_address << 1;
485 report->length = data_length + 1;
486 report->data[0] = command;
487 memcpy(&report->data[1], data, data_length);
488 return data_length + 4;
491 static int cp2112_i2c_write_req(void *buf, u8 slave_address, u8 *data,
494 struct cp2112_write_req_report *report = buf;
496 if (data_length > sizeof(report->data))
499 report->report = CP2112_DATA_WRITE_REQUEST;
500 report->slave_address = slave_address << 1;
501 report->length = data_length;
502 memcpy(report->data, data, data_length);
503 return data_length + 3;
506 static int cp2112_i2c_write_read_req(void *buf, u8 slave_address,
507 u8 *addr, int addr_length,
510 struct cp2112_write_read_req_report *report = buf;
512 if (read_length < 1 || read_length > 512 ||
513 addr_length > sizeof(report->target_address))
516 report->report = CP2112_DATA_WRITE_READ_REQUEST;
517 report->slave_address = slave_address << 1;
518 report->length = cpu_to_be16(read_length);
519 report->target_address_length = addr_length;
520 memcpy(report->target_address, addr, addr_length);
521 return addr_length + 5;
524 static int cp2112_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
527 struct cp2112_device *dev = (struct cp2112_device *)adap->algo_data;
528 struct hid_device *hdev = dev->hdev;
531 ssize_t read_length = 0;
533 unsigned int retries;
536 hid_dbg(hdev, "I2C %d messages\n", num);
539 if (msgs->flags & I2C_M_RD) {
540 hid_dbg(hdev, "I2C read %#04x len %d\n",
541 msgs->addr, msgs->len);
542 read_length = msgs->len;
543 read_buf = msgs->buf;
544 count = cp2112_read_req(buf, msgs->addr, msgs->len);
546 hid_dbg(hdev, "I2C write %#04x len %d\n",
547 msgs->addr, msgs->len);
548 count = cp2112_i2c_write_req(buf, msgs->addr,
549 msgs->buf, msgs->len);
553 } else if (dev->hwversion > 1 && /* no repeated start in rev 1 */
555 msgs[0].addr == msgs[1].addr &&
556 !(msgs[0].flags & I2C_M_RD) && (msgs[1].flags & I2C_M_RD)) {
557 hid_dbg(hdev, "I2C write-read %#04x wlen %d rlen %d\n",
558 msgs[0].addr, msgs[0].len, msgs[1].len);
559 read_length = msgs[1].len;
560 read_buf = msgs[1].buf;
561 count = cp2112_i2c_write_read_req(buf, msgs[0].addr,
562 msgs[0].buf, msgs[0].len, msgs[1].len);
567 "Multi-message I2C transactions not supported\n");
571 ret = hid_hw_power(hdev, PM_HINT_FULLON);
573 hid_err(hdev, "power management error: %d\n", ret);
577 ret = cp2112_hid_output(hdev, buf, count, HID_OUTPUT_REPORT);
579 hid_warn(hdev, "Error starting transaction: %d\n", ret);
583 for (retries = 0; retries < XFER_STATUS_RETRIES; ++retries) {
584 ret = cp2112_xfer_status(dev);
592 if (XFER_STATUS_RETRIES <= retries) {
593 hid_warn(hdev, "Transfer timed out, cancelling.\n");
594 buf[0] = CP2112_CANCEL_TRANSFER;
597 ret = cp2112_hid_output(hdev, buf, 2, HID_OUTPUT_REPORT);
599 hid_warn(hdev, "Error cancelling transaction: %d\n",
606 for (count = 0; count < read_length;) {
607 ret = cp2112_read(dev, read_buf + count, read_length - count);
611 hid_err(hdev, "read returned 0\n");
616 if (count > read_length) {
618 * The hardware returned too much data.
619 * This is mostly harmless because cp2112_read()
620 * has a limit check so didn't overrun our
621 * buffer. Nevertheless, we return an error
622 * because something is seriously wrong and
623 * it shouldn't go unnoticed.
625 hid_err(hdev, "long read: %d > %zd\n",
626 ret, read_length - count + ret);
632 /* return the number of transferred messages */
636 hid_hw_power(hdev, PM_HINT_NORMAL);
637 hid_dbg(hdev, "I2C transfer finished: %d\n", ret);
641 static int cp2112_xfer(struct i2c_adapter *adap, u16 addr,
642 unsigned short flags, char read_write, u8 command,
643 int size, union i2c_smbus_data *data)
645 struct cp2112_device *dev = (struct cp2112_device *)adap->algo_data;
646 struct hid_device *hdev = dev->hdev;
650 size_t read_length = 0;
651 unsigned int retries;
654 hid_dbg(hdev, "%s addr 0x%x flags 0x%x cmd 0x%x size %d\n",
655 read_write == I2C_SMBUS_WRITE ? "write" : "read",
656 addr, flags, command, size);
662 if (I2C_SMBUS_READ == read_write)
663 count = cp2112_read_req(buf, addr, read_length);
665 count = cp2112_write_req(buf, addr, command, NULL,
668 case I2C_SMBUS_BYTE_DATA:
671 if (I2C_SMBUS_READ == read_write)
672 count = cp2112_write_read_req(buf, addr, read_length,
675 count = cp2112_write_req(buf, addr, command,
678 case I2C_SMBUS_WORD_DATA:
680 word = cpu_to_le16(data->word);
682 if (I2C_SMBUS_READ == read_write)
683 count = cp2112_write_read_req(buf, addr, read_length,
686 count = cp2112_write_req(buf, addr, command,
689 case I2C_SMBUS_PROC_CALL:
690 size = I2C_SMBUS_WORD_DATA;
691 read_write = I2C_SMBUS_READ;
693 word = cpu_to_le16(data->word);
695 count = cp2112_write_read_req(buf, addr, read_length, command,
698 case I2C_SMBUS_I2C_BLOCK_DATA:
699 if (read_write == I2C_SMBUS_READ) {
700 read_length = data->block[0];
701 count = cp2112_write_read_req(buf, addr, read_length,
704 count = cp2112_write_req(buf, addr, command,
709 case I2C_SMBUS_BLOCK_DATA:
710 if (I2C_SMBUS_READ == read_write) {
711 count = cp2112_write_read_req(buf, addr,
715 count = cp2112_write_req(buf, addr, command,
720 case I2C_SMBUS_BLOCK_PROC_CALL:
721 size = I2C_SMBUS_BLOCK_DATA;
722 read_write = I2C_SMBUS_READ;
724 count = cp2112_write_read_req(buf, addr, I2C_SMBUS_BLOCK_MAX,
725 command, data->block,
729 hid_warn(hdev, "Unsupported transaction %d\n", size);
736 ret = hid_hw_power(hdev, PM_HINT_FULLON);
738 hid_err(hdev, "power management error: %d\n", ret);
742 ret = cp2112_hid_output(hdev, buf, count, HID_OUTPUT_REPORT);
744 hid_warn(hdev, "Error starting transaction: %d\n", ret);
748 for (retries = 0; retries < XFER_STATUS_RETRIES; ++retries) {
749 ret = cp2112_xfer_status(dev);
757 if (XFER_STATUS_RETRIES <= retries) {
758 hid_warn(hdev, "Transfer timed out, cancelling.\n");
759 buf[0] = CP2112_CANCEL_TRANSFER;
762 ret = cp2112_hid_output(hdev, buf, 2, HID_OUTPUT_REPORT);
764 hid_warn(hdev, "Error cancelling transaction: %d\n",
771 if (I2C_SMBUS_WRITE == read_write) {
776 if (I2C_SMBUS_BLOCK_DATA == size)
779 ret = cp2112_read(dev, buf, read_length);
782 if (ret != read_length) {
783 hid_warn(hdev, "short read: %d < %zd\n", ret, read_length);
790 case I2C_SMBUS_BYTE_DATA:
793 case I2C_SMBUS_WORD_DATA:
794 data->word = le16_to_cpup((__le16 *)buf);
796 case I2C_SMBUS_I2C_BLOCK_DATA:
797 memcpy(data->block + 1, buf, read_length);
799 case I2C_SMBUS_BLOCK_DATA:
800 if (read_length > I2C_SMBUS_BLOCK_MAX) {
805 memcpy(data->block, buf, read_length);
811 hid_hw_power(hdev, PM_HINT_NORMAL);
812 hid_dbg(hdev, "transfer finished: %d\n", ret);
816 static u32 cp2112_functionality(struct i2c_adapter *adap)
818 return I2C_FUNC_I2C |
819 I2C_FUNC_SMBUS_BYTE |
820 I2C_FUNC_SMBUS_BYTE_DATA |
821 I2C_FUNC_SMBUS_WORD_DATA |
822 I2C_FUNC_SMBUS_BLOCK_DATA |
823 I2C_FUNC_SMBUS_I2C_BLOCK |
824 I2C_FUNC_SMBUS_PROC_CALL |
825 I2C_FUNC_SMBUS_BLOCK_PROC_CALL;
828 static const struct i2c_algorithm smbus_algorithm = {
829 .master_xfer = cp2112_i2c_xfer,
830 .smbus_xfer = cp2112_xfer,
831 .functionality = cp2112_functionality,
834 static int cp2112_get_usb_config(struct hid_device *hdev,
835 struct cp2112_usb_config_report *cfg)
839 ret = cp2112_hid_get(hdev, CP2112_USB_CONFIG, (u8 *)cfg, sizeof(*cfg),
841 if (ret != sizeof(*cfg)) {
842 hid_err(hdev, "error reading usb config: %d\n", ret);
851 static int cp2112_set_usb_config(struct hid_device *hdev,
852 struct cp2112_usb_config_report *cfg)
856 BUG_ON(cfg->report != CP2112_USB_CONFIG);
858 ret = cp2112_hid_output(hdev, (u8 *)cfg, sizeof(*cfg),
860 if (ret != sizeof(*cfg)) {
861 hid_err(hdev, "error writing usb config: %d\n", ret);
870 static void chmod_sysfs_attrs(struct hid_device *hdev);
872 #define CP2112_CONFIG_ATTR(name, store, format, ...) \
873 static ssize_t name##_store(struct device *kdev, \
874 struct device_attribute *attr, const 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); \
883 ret = cp2112_set_usb_config(hdev, &cfg); \
886 chmod_sysfs_attrs(hdev); \
889 static ssize_t name##_show(struct device *kdev, \
890 struct device_attribute *attr, char *buf) \
892 struct hid_device *hdev = to_hid_device(kdev); \
893 struct cp2112_usb_config_report cfg; \
894 int ret = cp2112_get_usb_config(hdev, &cfg); \
897 return scnprintf(buf, PAGE_SIZE, format, ##__VA_ARGS__); \
899 static DEVICE_ATTR_RW(name);
901 CP2112_CONFIG_ATTR(vendor_id, ({
904 if (sscanf(buf, "%hi", &vid) != 1)
907 cfg.vid = cpu_to_le16(vid);
909 }), "0x%04x\n", le16_to_cpu(cfg.vid));
911 CP2112_CONFIG_ATTR(product_id, ({
914 if (sscanf(buf, "%hi", &pid) != 1)
917 cfg.pid = cpu_to_le16(pid);
919 }), "0x%04x\n", le16_to_cpu(cfg.pid));
921 CP2112_CONFIG_ATTR(max_power, ({
924 if (sscanf(buf, "%i", &mA) != 1)
927 cfg.max_power = (mA + 1) / 2;
929 }), "%u mA\n", cfg.max_power * 2);
931 CP2112_CONFIG_ATTR(power_mode, ({
932 if (sscanf(buf, "%hhi", &cfg.power_mode) != 1)
936 }), "%u\n", cfg.power_mode);
938 CP2112_CONFIG_ATTR(release_version, ({
939 if (sscanf(buf, "%hhi.%hhi", &cfg.release_major, &cfg.release_minor)
944 }), "%u.%u\n", cfg.release_major, cfg.release_minor);
946 #undef CP2112_CONFIG_ATTR
948 struct cp2112_pstring_attribute {
949 struct device_attribute attr;
950 unsigned char report;
953 static ssize_t pstr_store(struct device *kdev,
954 struct device_attribute *kattr, const char *buf,
957 struct hid_device *hdev = to_hid_device(kdev);
958 struct cp2112_pstring_attribute *attr =
959 container_of(kattr, struct cp2112_pstring_attribute, attr);
960 struct cp2112_string_report report;
963 memset(&report, 0, sizeof(report));
965 ret = utf8s_to_utf16s(buf, count, UTF16_LITTLE_ENDIAN,
966 report.string, ARRAY_SIZE(report.string));
967 report.report = attr->report;
968 report.length = ret * sizeof(report.string[0]) + 2;
969 report.type = USB_DT_STRING;
971 ret = cp2112_hid_output(hdev, &report.report, report.length + 1,
973 if (ret != report.length + 1) {
974 hid_err(hdev, "error writing %s string: %d\n", kattr->attr.name,
981 chmod_sysfs_attrs(hdev);
985 static ssize_t pstr_show(struct device *kdev,
986 struct device_attribute *kattr, char *buf)
988 struct hid_device *hdev = to_hid_device(kdev);
989 struct cp2112_pstring_attribute *attr =
990 container_of(kattr, struct cp2112_pstring_attribute, attr);
991 struct cp2112_string_report report;
995 ret = cp2112_hid_get(hdev, attr->report, &report.report,
996 sizeof(report) - 1, HID_FEATURE_REPORT);
998 hid_err(hdev, "error reading %s string: %d\n", kattr->attr.name,
1005 if (report.length < 2) {
1006 hid_err(hdev, "invalid %s string length: %d\n",
1007 kattr->attr.name, report.length);
1011 length = report.length > ret - 1 ? ret - 1 : report.length;
1012 length = (length - 2) / sizeof(report.string[0]);
1013 ret = utf16s_to_utf8s(report.string, length, UTF16_LITTLE_ENDIAN, buf,
1019 #define CP2112_PSTR_ATTR(name, _report) \
1020 static struct cp2112_pstring_attribute dev_attr_##name = { \
1021 .attr = __ATTR(name, (S_IWUSR | S_IRUGO), pstr_show, pstr_store), \
1022 .report = _report, \
1025 CP2112_PSTR_ATTR(manufacturer, CP2112_MANUFACTURER_STRING);
1026 CP2112_PSTR_ATTR(product, CP2112_PRODUCT_STRING);
1027 CP2112_PSTR_ATTR(serial, CP2112_SERIAL_STRING);
1029 #undef CP2112_PSTR_ATTR
1031 static const struct attribute_group cp2112_attr_group = {
1032 .attrs = (struct attribute *[]){
1033 &dev_attr_vendor_id.attr,
1034 &dev_attr_product_id.attr,
1035 &dev_attr_max_power.attr,
1036 &dev_attr_power_mode.attr,
1037 &dev_attr_release_version.attr,
1038 &dev_attr_manufacturer.attr.attr,
1039 &dev_attr_product.attr.attr,
1040 &dev_attr_serial.attr.attr,
1045 /* Chmoding our sysfs attributes is simply a way to expose which fields in the
1046 * PROM have already been programmed. We do not depend on this preventing
1047 * writing to these attributes since the CP2112 will simply ignore writes to
1048 * already-programmed fields. This is why there is no sense in fixing this
1051 static void chmod_sysfs_attrs(struct hid_device *hdev)
1053 struct attribute **attr;
1057 ret = cp2112_hid_get(hdev, CP2112_LOCK_BYTE, buf, sizeof(buf),
1058 HID_FEATURE_REPORT);
1059 if (ret != sizeof(buf)) {
1060 hid_err(hdev, "error reading lock byte: %d\n", ret);
1064 for (attr = cp2112_attr_group.attrs; *attr; ++attr) {
1065 umode_t mode = (buf[1] & 1) ? S_IWUSR | S_IRUGO : S_IRUGO;
1066 ret = sysfs_chmod_file(&hdev->dev.kobj, *attr, mode);
1068 hid_err(hdev, "error chmoding sysfs file %s\n",
1074 static void cp2112_gpio_irq_ack(struct irq_data *d)
1078 static void cp2112_gpio_irq_mask(struct irq_data *d)
1080 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1081 struct cp2112_device *dev = gpiochip_get_data(gc);
1083 __clear_bit(d->hwirq, &dev->irq_mask);
1086 static void cp2112_gpio_irq_unmask(struct irq_data *d)
1088 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1089 struct cp2112_device *dev = gpiochip_get_data(gc);
1091 __set_bit(d->hwirq, &dev->irq_mask);
1094 static void cp2112_gpio_poll_callback(struct work_struct *work)
1096 struct cp2112_device *dev = container_of(work, struct cp2112_device,
1097 gpio_poll_worker.work);
1100 u8 virqs = (u8)dev->irq_mask;
1104 ret = cp2112_gpio_get_all(&dev->gc);
1105 if (ret == -ENODEV) /* the hardware has been disconnected */
1113 virq = ffs(virqs) - 1;
1114 virqs &= ~BIT(virq);
1116 if (!dev->gc.to_irq)
1119 irq = dev->gc.to_irq(&dev->gc, virq);
1121 d = irq_get_irq_data(irq);
1125 irq_type = irqd_get_trigger_type(d);
1127 if (gpio_mask & BIT(virq)) {
1130 if (irq_type & IRQ_TYPE_LEVEL_HIGH)
1131 handle_nested_irq(irq);
1133 if ((irq_type & IRQ_TYPE_EDGE_RISING) &&
1134 !(dev->gpio_prev_state & BIT(virq)))
1135 handle_nested_irq(irq);
1139 if (irq_type & IRQ_TYPE_LEVEL_LOW)
1140 handle_nested_irq(irq);
1142 if ((irq_type & IRQ_TYPE_EDGE_FALLING) &&
1143 (dev->gpio_prev_state & BIT(virq)))
1144 handle_nested_irq(irq);
1148 dev->gpio_prev_state = gpio_mask;
1152 schedule_delayed_work(&dev->gpio_poll_worker, 10);
1156 static unsigned int cp2112_gpio_irq_startup(struct irq_data *d)
1158 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1159 struct cp2112_device *dev = gpiochip_get_data(gc);
1161 INIT_DELAYED_WORK(&dev->gpio_poll_worker, cp2112_gpio_poll_callback);
1163 cp2112_gpio_direction_input(gc, d->hwirq);
1165 if (!dev->gpio_poll) {
1166 dev->gpio_poll = true;
1167 schedule_delayed_work(&dev->gpio_poll_worker, 0);
1170 cp2112_gpio_irq_unmask(d);
1174 static void cp2112_gpio_irq_shutdown(struct irq_data *d)
1176 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1177 struct cp2112_device *dev = gpiochip_get_data(gc);
1179 cancel_delayed_work_sync(&dev->gpio_poll_worker);
1182 static int cp2112_gpio_irq_type(struct irq_data *d, unsigned int type)
1187 static struct irq_chip cp2112_gpio_irqchip = {
1188 .name = "cp2112-gpio",
1189 .irq_startup = cp2112_gpio_irq_startup,
1190 .irq_shutdown = cp2112_gpio_irq_shutdown,
1191 .irq_ack = cp2112_gpio_irq_ack,
1192 .irq_mask = cp2112_gpio_irq_mask,
1193 .irq_unmask = cp2112_gpio_irq_unmask,
1194 .irq_set_type = cp2112_gpio_irq_type,
1197 static int __maybe_unused cp2112_allocate_irq(struct cp2112_device *dev,
1205 dev->desc[pin] = gpiochip_request_own_desc(&dev->gc, pin,
1207 if (IS_ERR(dev->desc[pin])) {
1208 dev_err(dev->gc.parent, "Failed to request GPIO\n");
1209 return PTR_ERR(dev->desc[pin]);
1212 ret = gpiochip_lock_as_irq(&dev->gc, pin);
1214 dev_err(dev->gc.parent, "Failed to lock GPIO as interrupt\n");
1218 ret = gpiod_to_irq(dev->desc[pin]);
1220 dev_err(dev->gc.parent, "Failed to translate GPIO to IRQ\n");
1227 gpiochip_unlock_as_irq(&dev->gc, pin);
1229 gpiochip_free_own_desc(dev->desc[pin]);
1230 dev->desc[pin] = NULL;
1234 static int cp2112_probe(struct hid_device *hdev, const struct hid_device_id *id)
1236 struct cp2112_device *dev;
1238 struct cp2112_smbus_config_report config;
1241 dev = devm_kzalloc(&hdev->dev, sizeof(*dev), GFP_KERNEL);
1245 dev->in_out_buffer = devm_kzalloc(&hdev->dev, CP2112_REPORT_MAX_LENGTH,
1247 if (!dev->in_out_buffer)
1250 mutex_init(&dev->lock);
1252 ret = hid_parse(hdev);
1254 hid_err(hdev, "parse failed\n");
1258 ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
1260 hid_err(hdev, "hw start failed\n");
1264 ret = hid_hw_open(hdev);
1266 hid_err(hdev, "hw open failed\n");
1270 ret = hid_hw_power(hdev, PM_HINT_FULLON);
1272 hid_err(hdev, "power management error: %d\n", ret);
1276 ret = cp2112_hid_get(hdev, CP2112_GET_VERSION_INFO, buf, sizeof(buf),
1277 HID_FEATURE_REPORT);
1278 if (ret != sizeof(buf)) {
1279 hid_err(hdev, "error requesting version\n");
1282 goto err_power_normal;
1285 hid_info(hdev, "Part Number: 0x%02X Device Version: 0x%02X\n",
1288 ret = cp2112_hid_get(hdev, CP2112_SMBUS_CONFIG, (u8 *)&config,
1289 sizeof(config), HID_FEATURE_REPORT);
1290 if (ret != sizeof(config)) {
1291 hid_err(hdev, "error requesting SMBus config\n");
1294 goto err_power_normal;
1297 config.retry_time = cpu_to_be16(1);
1299 ret = cp2112_hid_output(hdev, (u8 *)&config, sizeof(config),
1300 HID_FEATURE_REPORT);
1301 if (ret != sizeof(config)) {
1302 hid_err(hdev, "error setting SMBus config\n");
1305 goto err_power_normal;
1308 hid_set_drvdata(hdev, (void *)dev);
1310 dev->adap.owner = THIS_MODULE;
1311 dev->adap.class = I2C_CLASS_HWMON;
1312 dev->adap.algo = &smbus_algorithm;
1313 dev->adap.algo_data = dev;
1314 dev->adap.dev.parent = &hdev->dev;
1315 snprintf(dev->adap.name, sizeof(dev->adap.name),
1316 "CP2112 SMBus Bridge on hidraw%d",
1317 ((struct hidraw *)hdev->hidraw)->minor);
1318 dev->hwversion = buf[2];
1319 init_waitqueue_head(&dev->wait);
1321 hid_device_io_start(hdev);
1322 ret = i2c_add_adapter(&dev->adap);
1323 hid_device_io_stop(hdev);
1326 hid_err(hdev, "error registering i2c adapter\n");
1327 goto err_power_normal;
1330 hid_dbg(hdev, "adapter registered\n");
1332 dev->gc.label = "cp2112_gpio";
1333 dev->gc.direction_input = cp2112_gpio_direction_input;
1334 dev->gc.direction_output = cp2112_gpio_direction_output;
1335 dev->gc.set = cp2112_gpio_set;
1336 dev->gc.get = cp2112_gpio_get;
1339 dev->gc.can_sleep = 1;
1340 dev->gc.parent = &hdev->dev;
1342 ret = gpiochip_add_data(&dev->gc, dev);
1344 hid_err(hdev, "error registering gpio chip\n");
1348 ret = sysfs_create_group(&hdev->dev.kobj, &cp2112_attr_group);
1350 hid_err(hdev, "error creating sysfs attrs\n");
1351 goto err_gpiochip_remove;
1354 chmod_sysfs_attrs(hdev);
1355 hid_hw_power(hdev, PM_HINT_NORMAL);
1357 ret = gpiochip_irqchip_add(&dev->gc, &cp2112_gpio_irqchip, 0,
1358 handle_simple_irq, IRQ_TYPE_NONE);
1360 dev_err(dev->gc.parent, "failed to add IRQ chip\n");
1361 goto err_sysfs_remove;
1367 sysfs_remove_group(&hdev->dev.kobj, &cp2112_attr_group);
1368 err_gpiochip_remove:
1369 gpiochip_remove(&dev->gc);
1371 i2c_del_adapter(&dev->adap);
1373 hid_hw_power(hdev, PM_HINT_NORMAL);
1381 static void cp2112_remove(struct hid_device *hdev)
1383 struct cp2112_device *dev = hid_get_drvdata(hdev);
1386 sysfs_remove_group(&hdev->dev.kobj, &cp2112_attr_group);
1387 i2c_del_adapter(&dev->adap);
1389 if (dev->gpio_poll) {
1390 dev->gpio_poll = false;
1391 cancel_delayed_work_sync(&dev->gpio_poll_worker);
1394 for (i = 0; i < ARRAY_SIZE(dev->desc); i++) {
1395 gpiochip_unlock_as_irq(&dev->gc, i);
1396 gpiochip_free_own_desc(dev->desc[i]);
1399 gpiochip_remove(&dev->gc);
1400 /* i2c_del_adapter has finished removing all i2c devices from our
1401 * adapter. Well behaved devices should no longer call our cp2112_xfer
1402 * and should have waited for any pending calls to finish. It has also
1403 * waited for device_unregister(&adap->dev) to complete. Therefore we
1404 * can safely free our struct cp2112_device.
1410 static int cp2112_raw_event(struct hid_device *hdev, struct hid_report *report,
1413 struct cp2112_device *dev = hid_get_drvdata(hdev);
1414 struct cp2112_xfer_status_report *xfer = (void *)data;
1417 case CP2112_TRANSFER_STATUS_RESPONSE:
1418 hid_dbg(hdev, "xfer status: %02x %02x %04x %04x\n",
1419 xfer->status0, xfer->status1,
1420 be16_to_cpu(xfer->retries), be16_to_cpu(xfer->length));
1422 switch (xfer->status0) {
1424 dev->xfer_status = -EAGAIN;
1427 dev->xfer_status = -EBUSY;
1429 case STATUS0_COMPLETE:
1430 dev->xfer_status = be16_to_cpu(xfer->length);
1433 switch (xfer->status1) {
1434 case STATUS1_TIMEOUT_NACK:
1435 case STATUS1_TIMEOUT_BUS:
1436 dev->xfer_status = -ETIMEDOUT;
1439 dev->xfer_status = -EIO;
1444 dev->xfer_status = -EINVAL;
1448 atomic_set(&dev->xfer_avail, 1);
1450 case CP2112_DATA_READ_RESPONSE:
1451 hid_dbg(hdev, "read response: %02x %02x\n", data[1], data[2]);
1453 dev->read_length = data[2];
1454 if (dev->read_length > sizeof(dev->read_data))
1455 dev->read_length = sizeof(dev->read_data);
1457 memcpy(dev->read_data, &data[3], dev->read_length);
1458 atomic_set(&dev->read_avail, 1);
1461 hid_err(hdev, "unknown report\n");
1466 wake_up_interruptible(&dev->wait);
1470 static struct hid_driver cp2112_driver = {
1472 .id_table = cp2112_devices,
1473 .probe = cp2112_probe,
1474 .remove = cp2112_remove,
1475 .raw_event = cp2112_raw_event,
1478 module_hid_driver(cp2112_driver);
1479 MODULE_DESCRIPTION("Silicon Labs HID USB to SMBus master bridge");
1480 MODULE_AUTHOR("David Barksdale <dbarksdale@uplogix.com>");
1481 MODULE_LICENSE("GPL");