^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Driver for RobotFuzz OSIF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (c) 2013 Andrew Lunn <andrew@lunn.ch>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (c) 2007 Barry Carter <Barry.Carter@robotfuzz.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * Based on the i2c-tiny-usb by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * Copyright (C) 2006 Til Harbaum (Till@Harbaum.org)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/errno.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/i2c.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <linux/usb.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #define OSIFI2C_READ 20
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define OSIFI2C_WRITE 21
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define OSIFI2C_STOP 22
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define OSIFI2C_STATUS 23
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) #define OSIFI2C_SET_BIT_RATE 24
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define STATUS_ADDRESS_ACK 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define STATUS_ADDRESS_NAK 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) struct osif_priv {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) struct usb_device *usb_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) struct usb_interface *interface;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) struct i2c_adapter adapter;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) unsigned char status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) static int osif_usb_read(struct i2c_adapter *adapter, int cmd,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) int value, int index, void *data, int len)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) struct osif_priv *priv = adapter->algo_data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) return usb_control_msg(priv->usb_dev, usb_rcvctrlpipe(priv->usb_dev, 0),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) cmd, USB_TYPE_VENDOR | USB_RECIP_INTERFACE |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) USB_DIR_IN, value, index, data, len, 2000);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) static int osif_usb_write(struct i2c_adapter *adapter, int cmd,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) int value, int index, void *data, int len)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) struct osif_priv *priv = adapter->algo_data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) return usb_control_msg(priv->usb_dev, usb_sndctrlpipe(priv->usb_dev, 0),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) cmd, USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) value, index, data, len, 2000);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) static int osif_xfer(struct i2c_adapter *adapter, struct i2c_msg *msgs,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) int num)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) struct osif_priv *priv = adapter->algo_data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) struct i2c_msg *pmsg;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) for (i = 0; i < num; i++) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) pmsg = &msgs[i];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) if (pmsg->flags & I2C_M_RD) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) ret = osif_usb_read(adapter, OSIFI2C_READ,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) pmsg->flags, pmsg->addr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) pmsg->buf, pmsg->len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) if (ret != pmsg->len) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) dev_err(&adapter->dev, "failure reading data\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) return -EREMOTEIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) ret = osif_usb_write(adapter, OSIFI2C_WRITE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) pmsg->flags, pmsg->addr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) pmsg->buf, pmsg->len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) if (ret != pmsg->len) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) dev_err(&adapter->dev, "failure writing data\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) return -EREMOTEIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) ret = osif_usb_write(adapter, OSIFI2C_STOP, 0, 0, NULL, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) if (ret) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) dev_err(&adapter->dev, "failure sending STOP\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) return -EREMOTEIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) /* read status */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) ret = osif_usb_read(adapter, OSIFI2C_STATUS, 0, 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) &priv->status, 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) if (ret != 1) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) dev_err(&adapter->dev, "failure reading status\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) return -EREMOTEIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) if (priv->status != STATUS_ADDRESS_ACK) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) dev_dbg(&adapter->dev, "status = %d\n", priv->status);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) return -EREMOTEIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) return i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) static u32 osif_func(struct i2c_adapter *adapter)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) static const struct i2c_algorithm osif_algorithm = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) .master_xfer = osif_xfer,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) .functionality = osif_func,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) #define USB_OSIF_VENDOR_ID 0x1964
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) #define USB_OSIF_PRODUCT_ID 0x0001
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) static const struct usb_device_id osif_table[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) { USB_DEVICE(USB_OSIF_VENDOR_ID, USB_OSIF_PRODUCT_ID) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) { }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) MODULE_DEVICE_TABLE(usb, osif_table);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) static int osif_probe(struct usb_interface *interface,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) const struct usb_device_id *id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) struct osif_priv *priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) u16 version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) priv = devm_kzalloc(&interface->dev, sizeof(*priv), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) if (!priv)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) priv->usb_dev = usb_get_dev(interface_to_usbdev(interface));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) priv->interface = interface;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) usb_set_intfdata(interface, priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) priv->adapter.owner = THIS_MODULE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) priv->adapter.class = I2C_CLASS_HWMON;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) priv->adapter.algo = &osif_algorithm;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) priv->adapter.algo_data = priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) snprintf(priv->adapter.name, sizeof(priv->adapter.name),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) "OSIF at bus %03d device %03d",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) priv->usb_dev->bus->busnum, priv->usb_dev->devnum);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) * Set bus frequency. The frequency is:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) * 120,000,000 / ( 16 + 2 * div * 4^prescale).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) * Using dev = 52, prescale = 0 give 100KHz */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) ret = osif_usb_write(&priv->adapter, OSIFI2C_SET_BIT_RATE, 52, 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) NULL, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) if (ret) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) dev_err(&interface->dev, "failure sending bit rate");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) usb_put_dev(priv->usb_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) i2c_add_adapter(&(priv->adapter));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) version = le16_to_cpu(priv->usb_dev->descriptor.bcdDevice);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) dev_info(&interface->dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) "version %x.%02x found at bus %03d address %03d",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) version >> 8, version & 0xff,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) priv->usb_dev->bus->busnum, priv->usb_dev->devnum);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) static void osif_disconnect(struct usb_interface *interface)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) struct osif_priv *priv = usb_get_intfdata(interface);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) i2c_del_adapter(&(priv->adapter));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) usb_set_intfdata(interface, NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) usb_put_dev(priv->usb_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) static struct usb_driver osif_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) .name = "RobotFuzz Open Source InterFace, OSIF",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) .probe = osif_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) .disconnect = osif_disconnect,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) .id_table = osif_table,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) module_usb_driver(osif_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) MODULE_AUTHOR("Andrew Lunn <andrew@lunn.ch>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) MODULE_AUTHOR("Barry Carter <barry.carter@robotfuzz.com>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) MODULE_DESCRIPTION("RobotFuzz OSIF driver");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) MODULE_LICENSE("GPL v2");