1 // SPDX-License-Identifier: GPL-2.0-only
3 * Driver for the Diolan u2c-12 USB-I2C adapter
5 * Copyright (c) 2010-2011 Ericsson AB
9 * Copyright (C) 2006-2007 Till Harbaum (Till@Harbaum.org)
12 #include <linux/kernel.h>
13 #include <linux/errno.h>
14 #include <linux/module.h>
15 #include <linux/types.h>
16 #include <linux/slab.h>
17 #include <linux/usb.h>
18 #include <linux/i2c.h>
20 #define DRIVER_NAME "i2c-diolan-u2c"
22 #define USB_VENDOR_ID_DIOLAN 0x0abf
23 #define USB_DEVICE_ID_DIOLAN_U2C 0x3370
26 /* commands via USB, must match command ids in the firmware */
27 #define CMD_I2C_READ 0x01
28 #define CMD_I2C_WRITE 0x02
29 #define CMD_I2C_SCAN 0x03 /* Returns list of detected devices */
30 #define CMD_I2C_RELEASE_SDA 0x04
31 #define CMD_I2C_RELEASE_SCL 0x05
32 #define CMD_I2C_DROP_SDA 0x06
33 #define CMD_I2C_DROP_SCL 0x07
34 #define CMD_I2C_READ_SDA 0x08
35 #define CMD_I2C_READ_SCL 0x09
36 #define CMD_GET_FW_VERSION 0x0a
37 #define CMD_GET_SERIAL 0x0b
38 #define CMD_I2C_START 0x0c
39 #define CMD_I2C_STOP 0x0d
40 #define CMD_I2C_REPEATED_START 0x0e
41 #define CMD_I2C_PUT_BYTE 0x0f
42 #define CMD_I2C_GET_BYTE 0x10
43 #define CMD_I2C_PUT_ACK 0x11
44 #define CMD_I2C_GET_ACK 0x12
45 #define CMD_I2C_PUT_BYTE_ACK 0x13
46 #define CMD_I2C_GET_BYTE_ACK 0x14
47 #define CMD_I2C_SET_SPEED 0x1b
48 #define CMD_I2C_GET_SPEED 0x1c
49 #define CMD_I2C_SET_CLK_SYNC 0x24
50 #define CMD_I2C_GET_CLK_SYNC 0x25
51 #define CMD_I2C_SET_CLK_SYNC_TO 0x26
52 #define CMD_I2C_GET_CLK_SYNC_TO 0x27
55 #define RESP_FAILED 0x01
56 #define RESP_BAD_MEMADDR 0x04
57 #define RESP_DATA_ERR 0x05
58 #define RESP_NOT_IMPLEMENTED 0x06
59 #define RESP_NACK 0x07
60 #define RESP_TIMEOUT 0x09
62 #define U2C_I2C_SPEED_FAST 0 /* 400 kHz */
63 #define U2C_I2C_SPEED_STD 1 /* 100 kHz */
64 #define U2C_I2C_SPEED_2KHZ 242 /* 2 kHz, minimum speed */
65 #define U2C_I2C_SPEED(f) ((DIV_ROUND_UP(1000000, (f)) - 10) / 2 + 1)
67 #define U2C_I2C_FREQ_FAST 400000
68 #define U2C_I2C_FREQ_STD 100000
69 #define U2C_I2C_FREQ(s) (1000000 / (2 * (s - 1) + 10))
71 #define DIOLAN_USB_TIMEOUT 100 /* in ms */
72 #define DIOLAN_SYNC_TIMEOUT 20 /* in ms */
74 #define DIOLAN_OUTBUF_LEN 128
75 #define DIOLAN_FLUSH_LEN (DIOLAN_OUTBUF_LEN - 4)
76 #define DIOLAN_INBUF_LEN 256 /* Maximum supported receive length */
78 /* Structure to hold all of our device specific stuff */
79 struct i2c_diolan_u2c {
80 u8 obuffer[DIOLAN_OUTBUF_LEN]; /* output buffer */
81 u8 ibuffer[DIOLAN_INBUF_LEN]; /* input buffer */
82 int ep_in, ep_out; /* Endpoints */
83 struct usb_device *usb_dev; /* the usb device for this device */
84 struct usb_interface *interface;/* the interface for this device */
85 struct i2c_adapter adapter; /* i2c related things */
86 int olen; /* Output buffer length */
87 int ocount; /* Number of enqueued messages */
90 static uint frequency = U2C_I2C_FREQ_STD; /* I2C clock frequency in Hz */
92 module_param(frequency, uint, S_IRUGO | S_IWUSR);
93 MODULE_PARM_DESC(frequency, "I2C clock frequency in hertz");
97 /* Send command to device, and get response. */
98 static int diolan_usb_transfer(struct i2c_diolan_u2c *dev)
104 if (!dev->olen || !dev->ocount)
107 ret = usb_bulk_msg(dev->usb_dev,
108 usb_sndbulkpipe(dev->usb_dev, dev->ep_out),
109 dev->obuffer, dev->olen, &actual,
112 for (i = 0; i < dev->ocount; i++) {
115 tmpret = usb_bulk_msg(dev->usb_dev,
116 usb_rcvbulkpipe(dev->usb_dev,
119 sizeof(dev->ibuffer), &actual,
122 * Stop command processing if a previous command
124 * Note that we still need to retrieve all messages.
129 if (ret == 0 && actual > 0) {
130 switch (dev->ibuffer[actual - 1]) {
133 * Return ENXIO if NACK was received as
134 * response to the address phase,
137 ret = i == 1 ? -ENXIO : -EIO;
143 /* strip off return code */
158 static int diolan_write_cmd(struct i2c_diolan_u2c *dev, bool flush)
160 if (flush || dev->olen >= DIOLAN_FLUSH_LEN)
161 return diolan_usb_transfer(dev);
165 /* Send command (no data) */
166 static int diolan_usb_cmd(struct i2c_diolan_u2c *dev, u8 command, bool flush)
168 dev->obuffer[dev->olen++] = command;
170 return diolan_write_cmd(dev, flush);
173 /* Send command with one byte of data */
174 static int diolan_usb_cmd_data(struct i2c_diolan_u2c *dev, u8 command, u8 data,
177 dev->obuffer[dev->olen++] = command;
178 dev->obuffer[dev->olen++] = data;
180 return diolan_write_cmd(dev, flush);
183 /* Send command with two bytes of data */
184 static int diolan_usb_cmd_data2(struct i2c_diolan_u2c *dev, u8 command, u8 d1,
187 dev->obuffer[dev->olen++] = command;
188 dev->obuffer[dev->olen++] = d1;
189 dev->obuffer[dev->olen++] = d2;
191 return diolan_write_cmd(dev, flush);
196 * If we don't do this at startup and the controller has queued up
197 * messages which were not retrieved, it will stop responding
200 static void diolan_flush_input(struct i2c_diolan_u2c *dev)
204 for (i = 0; i < 10; i++) {
208 ret = usb_bulk_msg(dev->usb_dev,
209 usb_rcvbulkpipe(dev->usb_dev, dev->ep_in),
210 dev->ibuffer, sizeof(dev->ibuffer), &actual,
212 if (ret < 0 || actual == 0)
216 dev_err(&dev->interface->dev, "Failed to flush input buffer\n");
219 static int diolan_i2c_start(struct i2c_diolan_u2c *dev)
221 return diolan_usb_cmd(dev, CMD_I2C_START, false);
224 static int diolan_i2c_repeated_start(struct i2c_diolan_u2c *dev)
226 return diolan_usb_cmd(dev, CMD_I2C_REPEATED_START, false);
229 static int diolan_i2c_stop(struct i2c_diolan_u2c *dev)
231 return diolan_usb_cmd(dev, CMD_I2C_STOP, true);
234 static int diolan_i2c_get_byte_ack(struct i2c_diolan_u2c *dev, bool ack,
239 ret = diolan_usb_cmd_data(dev, CMD_I2C_GET_BYTE_ACK, ack, true);
241 *byte = dev->ibuffer[0];
248 static int diolan_i2c_put_byte_ack(struct i2c_diolan_u2c *dev, u8 byte)
250 return diolan_usb_cmd_data(dev, CMD_I2C_PUT_BYTE_ACK, byte, false);
253 static int diolan_set_speed(struct i2c_diolan_u2c *dev, u8 speed)
255 return diolan_usb_cmd_data(dev, CMD_I2C_SET_SPEED, speed, true);
258 /* Enable or disable clock synchronization (stretching) */
259 static int diolan_set_clock_synch(struct i2c_diolan_u2c *dev, bool enable)
261 return diolan_usb_cmd_data(dev, CMD_I2C_SET_CLK_SYNC, enable, true);
264 /* Set clock synchronization timeout in ms */
265 static int diolan_set_clock_synch_timeout(struct i2c_diolan_u2c *dev, int ms)
267 int to_val = ms * 10;
269 return diolan_usb_cmd_data2(dev, CMD_I2C_SET_CLK_SYNC_TO,
270 to_val & 0xff, (to_val >> 8) & 0xff, true);
273 static void diolan_fw_version(struct i2c_diolan_u2c *dev)
277 ret = diolan_usb_cmd(dev, CMD_GET_FW_VERSION, true);
279 dev_info(&dev->interface->dev,
280 "Diolan U2C firmware version %u.%u\n",
281 (unsigned int)dev->ibuffer[0],
282 (unsigned int)dev->ibuffer[1]);
285 static void diolan_get_serial(struct i2c_diolan_u2c *dev)
290 ret = diolan_usb_cmd(dev, CMD_GET_SERIAL, true);
292 serial = le32_to_cpu(*(u32 *)dev->ibuffer);
293 dev_info(&dev->interface->dev,
294 "Diolan U2C serial number %u\n", serial);
298 static int diolan_init(struct i2c_diolan_u2c *dev)
302 if (frequency >= 200000) {
303 speed = U2C_I2C_SPEED_FAST;
304 frequency = U2C_I2C_FREQ_FAST;
305 } else if (frequency >= 100000 || frequency == 0) {
306 speed = U2C_I2C_SPEED_STD;
307 frequency = U2C_I2C_FREQ_STD;
309 speed = U2C_I2C_SPEED(frequency);
310 if (speed > U2C_I2C_SPEED_2KHZ)
311 speed = U2C_I2C_SPEED_2KHZ;
312 frequency = U2C_I2C_FREQ(speed);
315 dev_info(&dev->interface->dev,
316 "Diolan U2C at USB bus %03d address %03d speed %d Hz\n",
317 dev->usb_dev->bus->busnum, dev->usb_dev->devnum, frequency);
319 diolan_flush_input(dev);
320 diolan_fw_version(dev);
321 diolan_get_serial(dev);
324 ret = diolan_set_speed(dev, speed);
328 /* Configure I2C clock synchronization */
329 ret = diolan_set_clock_synch(dev, speed != U2C_I2C_SPEED_FAST);
333 if (speed != U2C_I2C_SPEED_FAST)
334 ret = diolan_set_clock_synch_timeout(dev, DIOLAN_SYNC_TIMEOUT);
341 static int diolan_usb_xfer(struct i2c_adapter *adapter, struct i2c_msg *msgs,
344 struct i2c_diolan_u2c *dev = i2c_get_adapdata(adapter);
345 struct i2c_msg *pmsg;
349 ret = diolan_i2c_start(dev);
353 for (i = 0; i < num; i++) {
356 ret = diolan_i2c_repeated_start(dev);
360 ret = diolan_i2c_put_byte_ack(dev,
361 i2c_8bit_addr_from_msg(pmsg));
364 if (pmsg->flags & I2C_M_RD) {
365 for (j = 0; j < pmsg->len; j++) {
367 bool ack = j < pmsg->len - 1;
370 * Don't send NACK if this is the first byte
371 * of a SMBUS_BLOCK message.
373 if (j == 0 && (pmsg->flags & I2C_M_RECV_LEN))
376 ret = diolan_i2c_get_byte_ack(dev, ack, &byte);
380 * Adjust count if first received byte is length
382 if (j == 0 && (pmsg->flags & I2C_M_RECV_LEN)) {
384 || byte > I2C_SMBUS_BLOCK_MAX) {
393 for (j = 0; j < pmsg->len; j++) {
394 ret = diolan_i2c_put_byte_ack(dev,
403 sret = diolan_i2c_stop(dev);
404 if (sret < 0 && ret >= 0)
410 * Return list of supported functionality.
412 static u32 diolan_usb_func(struct i2c_adapter *a)
414 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
415 I2C_FUNC_SMBUS_READ_BLOCK_DATA | I2C_FUNC_SMBUS_BLOCK_PROC_CALL;
418 static const struct i2c_algorithm diolan_usb_algorithm = {
419 .master_xfer = diolan_usb_xfer,
420 .functionality = diolan_usb_func,
425 static const struct usb_device_id diolan_u2c_table[] = {
426 { USB_DEVICE(USB_VENDOR_ID_DIOLAN, USB_DEVICE_ID_DIOLAN_U2C) },
430 MODULE_DEVICE_TABLE(usb, diolan_u2c_table);
432 static void diolan_u2c_free(struct i2c_diolan_u2c *dev)
434 usb_put_dev(dev->usb_dev);
438 static int diolan_u2c_probe(struct usb_interface *interface,
439 const struct usb_device_id *id)
441 struct usb_host_interface *hostif = interface->cur_altsetting;
442 struct i2c_diolan_u2c *dev;
445 if (hostif->desc.bInterfaceNumber != 0
446 || hostif->desc.bNumEndpoints < 2)
449 /* allocate memory for our device state and initialize it */
450 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
455 dev->ep_out = hostif->endpoint[0].desc.bEndpointAddress;
456 dev->ep_in = hostif->endpoint[1].desc.bEndpointAddress;
458 dev->usb_dev = usb_get_dev(interface_to_usbdev(interface));
459 dev->interface = interface;
461 /* save our data pointer in this interface device */
462 usb_set_intfdata(interface, dev);
464 /* setup i2c adapter description */
465 dev->adapter.owner = THIS_MODULE;
466 dev->adapter.class = I2C_CLASS_HWMON;
467 dev->adapter.algo = &diolan_usb_algorithm;
468 i2c_set_adapdata(&dev->adapter, dev);
469 snprintf(dev->adapter.name, sizeof(dev->adapter.name),
470 DRIVER_NAME " at bus %03d device %03d",
471 dev->usb_dev->bus->busnum, dev->usb_dev->devnum);
473 dev->adapter.dev.parent = &dev->interface->dev;
475 /* initialize diolan i2c interface */
476 ret = diolan_init(dev);
478 dev_err(&interface->dev, "failed to initialize adapter\n");
482 /* and finally attach to i2c layer */
483 ret = i2c_add_adapter(&dev->adapter);
487 dev_dbg(&interface->dev, "connected " DRIVER_NAME "\n");
492 usb_set_intfdata(interface, NULL);
493 diolan_u2c_free(dev);
498 static void diolan_u2c_disconnect(struct usb_interface *interface)
500 struct i2c_diolan_u2c *dev = usb_get_intfdata(interface);
502 i2c_del_adapter(&dev->adapter);
503 usb_set_intfdata(interface, NULL);
504 diolan_u2c_free(dev);
506 dev_dbg(&interface->dev, "disconnected\n");
509 static struct usb_driver diolan_u2c_driver = {
511 .probe = diolan_u2c_probe,
512 .disconnect = diolan_u2c_disconnect,
513 .id_table = diolan_u2c_table,
516 module_usb_driver(diolan_u2c_driver);
518 MODULE_AUTHOR("Guenter Roeck <linux@roeck-us.net>");
519 MODULE_DESCRIPTION(DRIVER_NAME " driver");
520 MODULE_LICENSE("GPL");