2
* Driver for the Diolan u2c-12 USB-I2C adapter
4
* Copyright (c) 2010-2011 Ericsson AB
8
* Copyright (C) 2006-2007 Till Harbaum (Till@Harbaum.org)
10
* This program is free software; you can redistribute it and/or
11
* modify it under the terms of the GNU General Public License as
12
* published by the Free Software Foundation, version 2.
15
#include <linux/kernel.h>
16
#include <linux/errno.h>
17
#include <linux/module.h>
18
#include <linux/types.h>
19
#include <linux/slab.h>
20
#include <linux/usb.h>
21
#include <linux/i2c.h>
23
#define DRIVER_NAME "i2c-diolan-u2c"
25
#define USB_VENDOR_ID_DIOLAN 0x0abf
26
#define USB_DEVICE_ID_DIOLAN_U2C 0x3370
28
#define DIOLAN_OUT_EP 0x02
29
#define DIOLAN_IN_EP 0x84
31
/* commands via USB, must match command ids in the firmware */
32
#define CMD_I2C_READ 0x01
33
#define CMD_I2C_WRITE 0x02
34
#define CMD_I2C_SCAN 0x03 /* Returns list of detected devices */
35
#define CMD_I2C_RELEASE_SDA 0x04
36
#define CMD_I2C_RELEASE_SCL 0x05
37
#define CMD_I2C_DROP_SDA 0x06
38
#define CMD_I2C_DROP_SCL 0x07
39
#define CMD_I2C_READ_SDA 0x08
40
#define CMD_I2C_READ_SCL 0x09
41
#define CMD_GET_FW_VERSION 0x0a
42
#define CMD_GET_SERIAL 0x0b
43
#define CMD_I2C_START 0x0c
44
#define CMD_I2C_STOP 0x0d
45
#define CMD_I2C_REPEATED_START 0x0e
46
#define CMD_I2C_PUT_BYTE 0x0f
47
#define CMD_I2C_GET_BYTE 0x10
48
#define CMD_I2C_PUT_ACK 0x11
49
#define CMD_I2C_GET_ACK 0x12
50
#define CMD_I2C_PUT_BYTE_ACK 0x13
51
#define CMD_I2C_GET_BYTE_ACK 0x14
52
#define CMD_I2C_SET_SPEED 0x1b
53
#define CMD_I2C_GET_SPEED 0x1c
54
#define CMD_I2C_SET_CLK_SYNC 0x24
55
#define CMD_I2C_GET_CLK_SYNC 0x25
56
#define CMD_I2C_SET_CLK_SYNC_TO 0x26
57
#define CMD_I2C_GET_CLK_SYNC_TO 0x27
60
#define RESP_FAILED 0x01
61
#define RESP_BAD_MEMADDR 0x04
62
#define RESP_DATA_ERR 0x05
63
#define RESP_NOT_IMPLEMENTED 0x06
64
#define RESP_NACK 0x07
65
#define RESP_TIMEOUT 0x09
67
#define U2C_I2C_SPEED_FAST 0 /* 400 kHz */
68
#define U2C_I2C_SPEED_STD 1 /* 100 kHz */
69
#define U2C_I2C_SPEED_2KHZ 242 /* 2 kHz, minimum speed */
70
#define U2C_I2C_SPEED(f) ((DIV_ROUND_UP(1000000, (f)) - 10) / 2 + 1)
72
#define U2C_I2C_FREQ_FAST 400000
73
#define U2C_I2C_FREQ_STD 100000
74
#define U2C_I2C_FREQ(s) (1000000 / (2 * (s - 1) + 10))
76
#define DIOLAN_USB_TIMEOUT 100 /* in ms */
77
#define DIOLAN_SYNC_TIMEOUT 20 /* in ms */
79
#define DIOLAN_OUTBUF_LEN 128
80
#define DIOLAN_FLUSH_LEN (DIOLAN_OUTBUF_LEN - 4)
81
#define DIOLAN_INBUF_LEN 256 /* Maximum supported receive length */
83
/* Structure to hold all of our device specific stuff */
84
struct i2c_diolan_u2c {
85
u8 obuffer[DIOLAN_OUTBUF_LEN]; /* output buffer */
86
u8 ibuffer[DIOLAN_INBUF_LEN]; /* input buffer */
87
struct usb_device *usb_dev; /* the usb device for this device */
88
struct usb_interface *interface;/* the interface for this device */
89
struct i2c_adapter adapter; /* i2c related things */
90
int olen; /* Output buffer length */
91
int ocount; /* Number of enqueued messages */
94
static uint frequency = U2C_I2C_FREQ_STD; /* I2C clock frequency in Hz */
96
module_param(frequency, uint, S_IRUGO | S_IWUSR);
97
MODULE_PARM_DESC(frequency, "I2C clock frequency in hertz");
101
/* Send command to device, and get response. */
102
static int diolan_usb_transfer(struct i2c_diolan_u2c *dev)
108
if (!dev->olen || !dev->ocount)
111
ret = usb_bulk_msg(dev->usb_dev,
112
usb_sndbulkpipe(dev->usb_dev, DIOLAN_OUT_EP),
113
dev->obuffer, dev->olen, &actual,
116
for (i = 0; i < dev->ocount; i++) {
119
tmpret = usb_bulk_msg(dev->usb_dev,
120
usb_rcvbulkpipe(dev->usb_dev,
123
sizeof(dev->ibuffer), &actual,
126
* Stop command processing if a previous command
128
* Note that we still need to retrieve all messages.
133
if (ret == 0 && actual > 0) {
134
switch (dev->ibuffer[actual - 1]) {
137
* Return ENXIO if NACK was received as
138
* response to the address phase,
141
ret = i == 1 ? -ENXIO : -EIO;
147
/* strip off return code */
162
static int diolan_write_cmd(struct i2c_diolan_u2c *dev, bool flush)
164
if (flush || dev->olen >= DIOLAN_FLUSH_LEN)
165
return diolan_usb_transfer(dev);
169
/* Send command (no data) */
170
static int diolan_usb_cmd(struct i2c_diolan_u2c *dev, u8 command, bool flush)
172
dev->obuffer[dev->olen++] = command;
174
return diolan_write_cmd(dev, flush);
177
/* Send command with one byte of data */
178
static int diolan_usb_cmd_data(struct i2c_diolan_u2c *dev, u8 command, u8 data,
181
dev->obuffer[dev->olen++] = command;
182
dev->obuffer[dev->olen++] = data;
184
return diolan_write_cmd(dev, flush);
187
/* Send command with two bytes of data */
188
static int diolan_usb_cmd_data2(struct i2c_diolan_u2c *dev, u8 command, u8 d1,
191
dev->obuffer[dev->olen++] = command;
192
dev->obuffer[dev->olen++] = d1;
193
dev->obuffer[dev->olen++] = d2;
195
return diolan_write_cmd(dev, flush);
200
* If we don't do this at startup and the controller has queued up
201
* messages which were not retrieved, it will stop responding
204
static void diolan_flush_input(struct i2c_diolan_u2c *dev)
208
for (i = 0; i < 10; i++) {
212
ret = usb_bulk_msg(dev->usb_dev,
213
usb_rcvbulkpipe(dev->usb_dev, DIOLAN_IN_EP),
214
dev->ibuffer, sizeof(dev->ibuffer), &actual,
216
if (ret < 0 || actual == 0)
220
dev_err(&dev->interface->dev, "Failed to flush input buffer\n");
223
static int diolan_i2c_start(struct i2c_diolan_u2c *dev)
225
return diolan_usb_cmd(dev, CMD_I2C_START, false);
228
static int diolan_i2c_repeated_start(struct i2c_diolan_u2c *dev)
230
return diolan_usb_cmd(dev, CMD_I2C_REPEATED_START, false);
233
static int diolan_i2c_stop(struct i2c_diolan_u2c *dev)
235
return diolan_usb_cmd(dev, CMD_I2C_STOP, true);
238
static int diolan_i2c_get_byte_ack(struct i2c_diolan_u2c *dev, bool ack,
243
ret = diolan_usb_cmd_data(dev, CMD_I2C_GET_BYTE_ACK, ack, true);
245
*byte = dev->ibuffer[0];
252
static int diolan_i2c_put_byte_ack(struct i2c_diolan_u2c *dev, u8 byte)
254
return diolan_usb_cmd_data(dev, CMD_I2C_PUT_BYTE_ACK, byte, false);
257
static int diolan_set_speed(struct i2c_diolan_u2c *dev, u8 speed)
259
return diolan_usb_cmd_data(dev, CMD_I2C_SET_SPEED, speed, true);
262
/* Enable or disable clock synchronization (stretching) */
263
static int diolan_set_clock_synch(struct i2c_diolan_u2c *dev, bool enable)
265
return diolan_usb_cmd_data(dev, CMD_I2C_SET_CLK_SYNC, enable, true);
268
/* Set clock synchronization timeout in ms */
269
static int diolan_set_clock_synch_timeout(struct i2c_diolan_u2c *dev, int ms)
271
int to_val = ms * 10;
273
return diolan_usb_cmd_data2(dev, CMD_I2C_SET_CLK_SYNC_TO,
274
to_val & 0xff, (to_val >> 8) & 0xff, true);
277
static void diolan_fw_version(struct i2c_diolan_u2c *dev)
281
ret = diolan_usb_cmd(dev, CMD_GET_FW_VERSION, true);
283
dev_info(&dev->interface->dev,
284
"Diolan U2C firmware version %u.%u\n",
285
(unsigned int)dev->ibuffer[0],
286
(unsigned int)dev->ibuffer[1]);
289
static void diolan_get_serial(struct i2c_diolan_u2c *dev)
294
ret = diolan_usb_cmd(dev, CMD_GET_SERIAL, true);
296
serial = le32_to_cpu(*(u32 *)dev->ibuffer);
297
dev_info(&dev->interface->dev,
298
"Diolan U2C serial number %u\n", serial);
302
static int diolan_init(struct i2c_diolan_u2c *dev)
306
if (frequency >= 200000) {
307
speed = U2C_I2C_SPEED_FAST;
308
frequency = U2C_I2C_FREQ_FAST;
309
} else if (frequency >= 100000 || frequency == 0) {
310
speed = U2C_I2C_SPEED_STD;
311
frequency = U2C_I2C_FREQ_STD;
313
speed = U2C_I2C_SPEED(frequency);
314
if (speed > U2C_I2C_SPEED_2KHZ)
315
speed = U2C_I2C_SPEED_2KHZ;
316
frequency = U2C_I2C_FREQ(speed);
319
dev_info(&dev->interface->dev,
320
"Diolan U2C at USB bus %03d address %03d speed %d Hz\n",
321
dev->usb_dev->bus->busnum, dev->usb_dev->devnum, frequency);
323
diolan_flush_input(dev);
324
diolan_fw_version(dev);
325
diolan_get_serial(dev);
328
ret = diolan_set_speed(dev, speed);
332
/* Configure I2C clock synchronization */
333
ret = diolan_set_clock_synch(dev, speed != U2C_I2C_SPEED_FAST);
337
if (speed != U2C_I2C_SPEED_FAST)
338
ret = diolan_set_clock_synch_timeout(dev, DIOLAN_SYNC_TIMEOUT);
345
static int diolan_usb_xfer(struct i2c_adapter *adapter, struct i2c_msg *msgs,
348
struct i2c_diolan_u2c *dev = i2c_get_adapdata(adapter);
349
struct i2c_msg *pmsg;
353
ret = diolan_i2c_start(dev);
357
for (i = 0; i < num; i++) {
360
ret = diolan_i2c_repeated_start(dev);
364
if (pmsg->flags & I2C_M_RD) {
366
diolan_i2c_put_byte_ack(dev, (pmsg->addr << 1) | 1);
369
for (j = 0; j < pmsg->len; j++) {
371
bool ack = j < pmsg->len - 1;
374
* Don't send NACK if this is the first byte
375
* of a SMBUS_BLOCK message.
377
if (j == 0 && (pmsg->flags & I2C_M_RECV_LEN))
380
ret = diolan_i2c_get_byte_ack(dev, ack, &byte);
384
* Adjust count if first received byte is length
386
if (j == 0 && (pmsg->flags & I2C_M_RECV_LEN)) {
388
|| byte > I2C_SMBUS_BLOCK_MAX) {
397
ret = diolan_i2c_put_byte_ack(dev, pmsg->addr << 1);
400
for (j = 0; j < pmsg->len; j++) {
401
ret = diolan_i2c_put_byte_ack(dev,
409
sret = diolan_i2c_stop(dev);
410
if (sret < 0 && ret >= 0)
416
* Return list of supported functionality.
418
static u32 diolan_usb_func(struct i2c_adapter *a)
420
return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
421
I2C_FUNC_SMBUS_READ_BLOCK_DATA | I2C_FUNC_SMBUS_BLOCK_PROC_CALL;
424
static const struct i2c_algorithm diolan_usb_algorithm = {
425
.master_xfer = diolan_usb_xfer,
426
.functionality = diolan_usb_func,
431
static const struct usb_device_id diolan_u2c_table[] = {
432
{ USB_DEVICE(USB_VENDOR_ID_DIOLAN, USB_DEVICE_ID_DIOLAN_U2C) },
436
MODULE_DEVICE_TABLE(usb, diolan_u2c_table);
438
static void diolan_u2c_free(struct i2c_diolan_u2c *dev)
440
usb_put_dev(dev->usb_dev);
444
static int diolan_u2c_probe(struct usb_interface *interface,
445
const struct usb_device_id *id)
447
struct i2c_diolan_u2c *dev;
450
/* allocate memory for our device state and initialize it */
451
dev = kzalloc(sizeof(*dev), GFP_KERNEL);
453
dev_err(&interface->dev, "no memory for device state\n");
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);
485
dev_err(&interface->dev, "failed to add I2C adapter\n");
489
dev_dbg(&interface->dev, "connected " DRIVER_NAME "\n");
494
usb_set_intfdata(interface, NULL);
495
diolan_u2c_free(dev);
500
static void diolan_u2c_disconnect(struct usb_interface *interface)
502
struct i2c_diolan_u2c *dev = usb_get_intfdata(interface);
504
i2c_del_adapter(&dev->adapter);
505
usb_set_intfdata(interface, NULL);
506
diolan_u2c_free(dev);
508
dev_dbg(&interface->dev, "disconnected\n");
511
static struct usb_driver diolan_u2c_driver = {
513
.probe = diolan_u2c_probe,
514
.disconnect = diolan_u2c_disconnect,
515
.id_table = diolan_u2c_table,
518
static int __init diolan_u2c_init(void)
520
/* register this driver with the USB subsystem */
521
return usb_register(&diolan_u2c_driver);
524
static void __exit diolan_u2c_exit(void)
526
/* deregister this driver with the USB subsystem */
527
usb_deregister(&diolan_u2c_driver);
530
module_init(diolan_u2c_init);
531
module_exit(diolan_u2c_exit);
533
MODULE_AUTHOR("Guenter Roeck <guenter.roeck@ericsson.com>");
534
MODULE_DESCRIPTION(DRIVER_NAME " driver");
535
MODULE_LICENSE("GPL");