blob: 3f7b9af111379a9d54d0315be121b52e919de9a9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
David Brownell438d6c22006-12-10 21:21:31 +01002 i2c-dev.c - i2c-bus driver, char device interface
Linus Torvalds1da177e2005-04-16 15:20:36 -07003
4 Copyright (C) 1995-97 Simon G. Vogl
5 Copyright (C) 1998-99 Frodo Looijaard <frodol@dds.nl>
6 Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070017*/
18
19/* Note that this is a complete rewrite of Simon Vogl's i2c-dev module.
20 But I have used so much of his original code and ideas that it seems
21 only fair to recognize him as co-author -- Frodo */
22
23/* The I2C_RDWR ioctl code is written by Kolja Waschk <waschk@telos.de> */
24
Erico Nunesd6760b12016-05-03 15:45:43 -030025#include <linux/cdev.h>
Jean Delvare9ea3e942011-03-20 14:50:52 +010026#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/i2c-dev.h>
Wolfram Sanga8766072016-02-20 23:33:38 +010029#include <linux/i2c.h>
30#include <linux/init.h>
Jean Delvarecd97f392009-02-24 19:19:49 +010031#include <linux/jiffies.h>
Wolfram Sanga8766072016-02-20 23:33:38 +010032#include <linux/kernel.h>
33#include <linux/list.h>
34#include <linux/module.h>
35#include <linux/notifier.h>
36#include <linux/slab.h>
Farid Hammaneae5624f2010-05-21 18:40:59 +020037#include <linux/uaccess.h>
Al Viro7d5cb452017-09-20 01:02:27 -040038#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
David Brownell907135a2007-11-15 19:24:01 +010040/*
41 * An i2c_dev represents an i2c_adapter ... an I2C or SMBus master, not a
42 * slave (i2c_client) with which messages will be exchanged. It's coupled
43 * with a character special file which is accessed by user mode drivers.
44 *
45 * The list of i2c_dev structures is parallel to the i2c_adapter lists
Jean Delvare9ea3e942011-03-20 14:50:52 +010046 * maintained by the driver model, and is updated using bus notifications.
David Brownell907135a2007-11-15 19:24:01 +010047 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048struct i2c_dev {
Jean Delvaref3b3aad2006-07-01 17:17:38 +020049 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 struct i2c_adapter *adap;
Greg Kroah-Hartmanac11d062006-07-03 13:46:24 -070051 struct device *dev;
Erico Nunesd6760b12016-05-03 15:45:43 -030052 struct cdev cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053};
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Chengguang Xu8a6d5082019-02-12 14:06:57 +080055#define I2C_MINORS (MINORMASK + 1)
Jean Delvaref3b3aad2006-07-01 17:17:38 +020056static LIST_HEAD(i2c_dev_list);
57static DEFINE_SPINLOCK(i2c_dev_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59static struct i2c_dev *i2c_dev_get_by_minor(unsigned index)
60{
61 struct i2c_dev *i2c_dev;
62
Jean Delvaref3b3aad2006-07-01 17:17:38 +020063 spin_lock(&i2c_dev_list_lock);
64 list_for_each_entry(i2c_dev, &i2c_dev_list, list) {
65 if (i2c_dev->adap->nr == index)
66 goto found;
67 }
68 i2c_dev = NULL;
69found:
70 spin_unlock(&i2c_dev_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 return i2c_dev;
72}
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074static struct i2c_dev *get_free_i2c_dev(struct i2c_adapter *adap)
75{
76 struct i2c_dev *i2c_dev;
77
Jean Delvaref3b3aad2006-07-01 17:17:38 +020078 if (adap->nr >= I2C_MINORS) {
79 printk(KERN_ERR "i2c-dev: Out of device minors (%d)\n",
80 adap->nr);
81 return ERR_PTR(-ENODEV);
82 }
83
Deepak Saxena5263ebb2005-10-17 23:09:43 +020084 i2c_dev = kzalloc(sizeof(*i2c_dev), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 if (!i2c_dev)
86 return ERR_PTR(-ENOMEM);
Jean Delvare9455e4c2006-07-01 17:16:57 +020087 i2c_dev->adap = adap;
Jean Delvaref3b3aad2006-07-01 17:17:38 +020088
89 spin_lock(&i2c_dev_list_lock);
90 list_add_tail(&i2c_dev->list, &i2c_dev_list);
91 spin_unlock(&i2c_dev_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 return i2c_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093}
94
Wolfram Sang72a71f82016-05-27 13:13:01 +020095static void put_i2c_dev(struct i2c_dev *i2c_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096{
Jean Delvaref3b3aad2006-07-01 17:17:38 +020097 spin_lock(&i2c_dev_list_lock);
98 list_del(&i2c_dev->list);
99 spin_unlock(&i2c_dev_list_lock);
Jean Delvare07125ab2006-12-10 21:21:33 +0100100 kfree(i2c_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101}
102
Guenter Roeck45f176a2013-09-26 19:36:11 -0700103static ssize_t name_show(struct device *dev,
104 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
Greg Kroah-Hartmanac11d062006-07-03 13:46:24 -0700106 struct i2c_dev *i2c_dev = i2c_dev_get_by_minor(MINOR(dev->devt));
Greg Kroah-Hartman794721322005-12-06 15:33:15 -0800107
108 if (!i2c_dev)
109 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 return sprintf(buf, "%s\n", i2c_dev->adap->name);
111}
Guenter Roeck45f176a2013-09-26 19:36:11 -0700112static DEVICE_ATTR_RO(name);
113
114static struct attribute *i2c_attrs[] = {
115 &dev_attr_name.attr,
116 NULL,
117};
118ATTRIBUTE_GROUPS(i2c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
David Brownell907135a2007-11-15 19:24:01 +0100120/* ------------------------------------------------------------------------- */
121
122/*
123 * After opening an instance of this character special file, a file
124 * descriptor starts out associated only with an i2c_adapter (and bus).
125 *
126 * Using the I2C_RDWR ioctl(), you can then *immediately* issue i2c_msg
127 * traffic to any devices on the bus used by that adapter. That's because
128 * the i2c_msg vectors embed all the addressing information they need, and
129 * are submitted directly to an i2c_adapter. However, SMBus-only adapters
130 * don't support that interface.
131 *
132 * To use read()/write() system calls on that file descriptor, or to use
133 * SMBus interfaces (and work with SMBus-only hosts!), you must first issue
134 * an I2C_SLAVE (or I2C_SLAVE_FORCE) ioctl. That configures an anonymous
135 * (never registered) i2c_client so it holds the addressing information
136 * needed by those system calls and by this SMBus interface.
137 */
138
Farid Hammaneae5624f2010-05-21 18:40:59 +0200139static ssize_t i2cdev_read(struct file *file, char __user *buf, size_t count,
140 loff_t *offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141{
142 char *tmp;
143 int ret;
144
H Hartley Sweeten0be16c32010-05-21 18:40:57 +0200145 struct i2c_client *client = file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147 if (count > 8192)
148 count = 8192;
149
Farid Hammaneae5624f2010-05-21 18:40:59 +0200150 tmp = kmalloc(count, GFP_KERNEL);
151 if (tmp == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 return -ENOMEM;
153
David Brownell2ce5b342008-08-10 22:56:16 +0200154 pr_debug("i2c-dev: i2c-%d reading %zu bytes.\n",
Al Viro496ad9a2013-01-23 17:07:38 -0500155 iminor(file_inode(file)), count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Farid Hammaneae5624f2010-05-21 18:40:59 +0200157 ret = i2c_master_recv(client, tmp, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 if (ret >= 0)
Farid Hammaneae5624f2010-05-21 18:40:59 +0200159 ret = copy_to_user(buf, tmp, count) ? -EFAULT : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 kfree(tmp);
161 return ret;
162}
163
Farid Hammaneae5624f2010-05-21 18:40:59 +0200164static ssize_t i2cdev_write(struct file *file, const char __user *buf,
165 size_t count, loff_t *offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
167 int ret;
168 char *tmp;
H Hartley Sweeten0be16c32010-05-21 18:40:57 +0200169 struct i2c_client *client = file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171 if (count > 8192)
172 count = 8192;
173
Julia Lawallf1c2e332010-08-11 18:20:55 +0200174 tmp = memdup_user(buf, count);
175 if (IS_ERR(tmp))
176 return PTR_ERR(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
David Brownell2ce5b342008-08-10 22:56:16 +0200178 pr_debug("i2c-dev: i2c-%d writing %zu bytes.\n",
Al Viro496ad9a2013-01-23 17:07:38 -0500179 iminor(file_inode(file)), count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Farid Hammaneae5624f2010-05-21 18:40:59 +0200181 ret = i2c_master_send(client, tmp, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 kfree(tmp);
183 return ret;
184}
185
David Brownell9b766b82008-01-27 18:14:51 +0100186static int i2cdev_check(struct device *dev, void *addrp)
187{
188 struct i2c_client *client = i2c_verify_client(dev);
189
190 if (!client || client->addr != *(unsigned int *)addrp)
191 return 0;
192
193 return dev->driver ? -EBUSY : 0;
194}
195
Michael Lawnick08263742010-08-11 18:21:02 +0200196/* walk up mux tree */
197static int i2cdev_check_mux_parents(struct i2c_adapter *adapter, int addr)
198{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200199 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200200 int result;
201
202 result = device_for_each_child(&adapter->dev, &addr, i2cdev_check);
Jean Delvare97cc4d42010-10-24 18:16:57 +0200203 if (!result && parent)
204 result = i2cdev_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200205
206 return result;
207}
208
209/* recurse down mux tree */
210static int i2cdev_check_mux_children(struct device *dev, void *addrp)
211{
212 int result;
213
214 if (dev->type == &i2c_adapter_type)
215 result = device_for_each_child(dev, addrp,
216 i2cdev_check_mux_children);
217 else
218 result = i2cdev_check(dev, addrp);
219
220 return result;
221}
222
Jean Delvarebd4217d2007-11-15 19:24:01 +0100223/* This address checking function differs from the one in i2c-core
224 in that it considers an address with a registered device, but no
David Brownell9b766b82008-01-27 18:14:51 +0100225 driver bound to it, as NOT busy. */
Jean Delvarebd4217d2007-11-15 19:24:01 +0100226static int i2cdev_check_addr(struct i2c_adapter *adapter, unsigned int addr)
227{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200228 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200229 int result = 0;
230
Jean Delvare97cc4d42010-10-24 18:16:57 +0200231 if (parent)
232 result = i2cdev_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200233
234 if (!result)
235 result = device_for_each_child(&adapter->dev, &addr,
236 i2cdev_check_mux_children);
237
238 return result;
Jean Delvarebd4217d2007-11-15 19:24:01 +0100239}
240
Jean Delvarec57d3e72015-09-08 11:05:49 +0200241static noinline int i2cdev_ioctl_rdwr(struct i2c_client *client,
Al Viro7d5cb452017-09-20 01:02:27 -0400242 unsigned nmsgs, struct i2c_msg *msgs)
Jean Delvaredba79972008-04-22 22:16:47 +0200243{
Jean Delvaredba79972008-04-22 22:16:47 +0200244 u8 __user **data_ptrs;
245 int i, res;
246
Kees Cook6da2ec52018-06-12 13:55:00 -0700247 data_ptrs = kmalloc_array(nmsgs, sizeof(u8 __user *), GFP_KERNEL);
Jean Delvaredba79972008-04-22 22:16:47 +0200248 if (data_ptrs == NULL) {
Al Viro7d5cb452017-09-20 01:02:27 -0400249 kfree(msgs);
Jean Delvaredba79972008-04-22 22:16:47 +0200250 return -ENOMEM;
251 }
252
253 res = 0;
Al Viro7d5cb452017-09-20 01:02:27 -0400254 for (i = 0; i < nmsgs; i++) {
Jean Delvare838bfa62012-05-30 10:55:34 +0200255 /* Limit the size of the message to a sane amount */
Al Viro7d5cb452017-09-20 01:02:27 -0400256 if (msgs[i].len > 8192) {
Jean Delvaredba79972008-04-22 22:16:47 +0200257 res = -EINVAL;
258 break;
259 }
Jean Delvare838bfa62012-05-30 10:55:34 +0200260
Al Viro7d5cb452017-09-20 01:02:27 -0400261 data_ptrs[i] = (u8 __user *)msgs[i].buf;
262 msgs[i].buf = memdup_user(data_ptrs[i], msgs[i].len);
263 if (IS_ERR(msgs[i].buf)) {
264 res = PTR_ERR(msgs[i].buf);
Jean Delvaredba79972008-04-22 22:16:47 +0200265 break;
266 }
Wolfram Sang978336d2017-11-04 21:20:03 +0100267 /* memdup_user allocates with GFP_KERNEL, so DMA is ok */
268 msgs[i].flags |= I2C_M_DMA_SAFE;
Jean Delvare838bfa62012-05-30 10:55:34 +0200269
270 /*
271 * If the message length is received from the slave (similar
272 * to SMBus block read), we must ensure that the buffer will
273 * be large enough to cope with a message length of
274 * I2C_SMBUS_BLOCK_MAX as this is the maximum underlying bus
275 * drivers allow. The first byte in the buffer must be
276 * pre-filled with the number of extra bytes, which must be
277 * at least one to hold the message length, but can be
278 * greater (for example to account for a checksum byte at
279 * the end of the message.)
280 */
Al Viro7d5cb452017-09-20 01:02:27 -0400281 if (msgs[i].flags & I2C_M_RECV_LEN) {
282 if (!(msgs[i].flags & I2C_M_RD) ||
Alexander Popov23a27722018-04-19 15:29:22 +0300283 msgs[i].len < 1 || msgs[i].buf[0] < 1 ||
Al Viro7d5cb452017-09-20 01:02:27 -0400284 msgs[i].len < msgs[i].buf[0] +
Jean Delvare838bfa62012-05-30 10:55:34 +0200285 I2C_SMBUS_BLOCK_MAX) {
286 res = -EINVAL;
287 break;
288 }
289
Al Viro7d5cb452017-09-20 01:02:27 -0400290 msgs[i].len = msgs[i].buf[0];
Jean Delvare838bfa62012-05-30 10:55:34 +0200291 }
Jean Delvaredba79972008-04-22 22:16:47 +0200292 }
293 if (res < 0) {
294 int j;
295 for (j = 0; j < i; ++j)
Al Viro7d5cb452017-09-20 01:02:27 -0400296 kfree(msgs[j].buf);
Jean Delvaredba79972008-04-22 22:16:47 +0200297 kfree(data_ptrs);
Al Viro7d5cb452017-09-20 01:02:27 -0400298 kfree(msgs);
Jean Delvaredba79972008-04-22 22:16:47 +0200299 return res;
300 }
301
Al Viro7d5cb452017-09-20 01:02:27 -0400302 res = i2c_transfer(client->adapter, msgs, nmsgs);
Jean Delvaredba79972008-04-22 22:16:47 +0200303 while (i-- > 0) {
Al Viro7d5cb452017-09-20 01:02:27 -0400304 if (res >= 0 && (msgs[i].flags & I2C_M_RD)) {
305 if (copy_to_user(data_ptrs[i], msgs[i].buf,
306 msgs[i].len))
Jean Delvaredba79972008-04-22 22:16:47 +0200307 res = -EFAULT;
308 }
Al Viro7d5cb452017-09-20 01:02:27 -0400309 kfree(msgs[i].buf);
Jean Delvaredba79972008-04-22 22:16:47 +0200310 }
311 kfree(data_ptrs);
Al Viro7d5cb452017-09-20 01:02:27 -0400312 kfree(msgs);
Jean Delvaredba79972008-04-22 22:16:47 +0200313 return res;
314}
315
316static noinline int i2cdev_ioctl_smbus(struct i2c_client *client,
Al Viro7d5cb452017-09-20 01:02:27 -0400317 u8 read_write, u8 command, u32 size,
318 union i2c_smbus_data __user *data)
Jean Delvaredba79972008-04-22 22:16:47 +0200319{
Vlad Tsyrklevich30f939f2017-01-09 22:53:36 +0700320 union i2c_smbus_data temp = {};
Jean Delvaredba79972008-04-22 22:16:47 +0200321 int datasize, res;
322
Al Viro7d5cb452017-09-20 01:02:27 -0400323 if ((size != I2C_SMBUS_BYTE) &&
324 (size != I2C_SMBUS_QUICK) &&
325 (size != I2C_SMBUS_BYTE_DATA) &&
326 (size != I2C_SMBUS_WORD_DATA) &&
327 (size != I2C_SMBUS_PROC_CALL) &&
328 (size != I2C_SMBUS_BLOCK_DATA) &&
329 (size != I2C_SMBUS_I2C_BLOCK_BROKEN) &&
330 (size != I2C_SMBUS_I2C_BLOCK_DATA) &&
331 (size != I2C_SMBUS_BLOCK_PROC_CALL)) {
Jean Delvaredba79972008-04-22 22:16:47 +0200332 dev_dbg(&client->adapter->dev,
333 "size out of range (%x) in ioctl I2C_SMBUS.\n",
Al Viro7d5cb452017-09-20 01:02:27 -0400334 size);
Jean Delvaredba79972008-04-22 22:16:47 +0200335 return -EINVAL;
336 }
337 /* Note that I2C_SMBUS_READ and I2C_SMBUS_WRITE are 0 and 1,
338 so the check is valid if size==I2C_SMBUS_QUICK too. */
Al Viro7d5cb452017-09-20 01:02:27 -0400339 if ((read_write != I2C_SMBUS_READ) &&
340 (read_write != I2C_SMBUS_WRITE)) {
Jean Delvaredba79972008-04-22 22:16:47 +0200341 dev_dbg(&client->adapter->dev,
342 "read_write out of range (%x) in ioctl I2C_SMBUS.\n",
Al Viro7d5cb452017-09-20 01:02:27 -0400343 read_write);
Jean Delvaredba79972008-04-22 22:16:47 +0200344 return -EINVAL;
345 }
346
347 /* Note that command values are always valid! */
348
Al Viro7d5cb452017-09-20 01:02:27 -0400349 if ((size == I2C_SMBUS_QUICK) ||
350 ((size == I2C_SMBUS_BYTE) &&
351 (read_write == I2C_SMBUS_WRITE)))
Jean Delvaredba79972008-04-22 22:16:47 +0200352 /* These are special: we do not use data */
353 return i2c_smbus_xfer(client->adapter, client->addr,
Al Viro7d5cb452017-09-20 01:02:27 -0400354 client->flags, read_write,
355 command, size, NULL);
Jean Delvaredba79972008-04-22 22:16:47 +0200356
Al Viro7d5cb452017-09-20 01:02:27 -0400357 if (data == NULL) {
Jean Delvaredba79972008-04-22 22:16:47 +0200358 dev_dbg(&client->adapter->dev,
359 "data is NULL pointer in ioctl I2C_SMBUS.\n");
360 return -EINVAL;
361 }
362
Al Viro7d5cb452017-09-20 01:02:27 -0400363 if ((size == I2C_SMBUS_BYTE_DATA) ||
364 (size == I2C_SMBUS_BYTE))
365 datasize = sizeof(data->byte);
366 else if ((size == I2C_SMBUS_WORD_DATA) ||
367 (size == I2C_SMBUS_PROC_CALL))
368 datasize = sizeof(data->word);
Jean Delvaredba79972008-04-22 22:16:47 +0200369 else /* size == smbus block, i2c block, or block proc. call */
Al Viro7d5cb452017-09-20 01:02:27 -0400370 datasize = sizeof(data->block);
Jean Delvaredba79972008-04-22 22:16:47 +0200371
Al Viro7d5cb452017-09-20 01:02:27 -0400372 if ((size == I2C_SMBUS_PROC_CALL) ||
373 (size == I2C_SMBUS_BLOCK_PROC_CALL) ||
374 (size == I2C_SMBUS_I2C_BLOCK_DATA) ||
375 (read_write == I2C_SMBUS_WRITE)) {
376 if (copy_from_user(&temp, data, datasize))
Jean Delvaredba79972008-04-22 22:16:47 +0200377 return -EFAULT;
378 }
Al Viro7d5cb452017-09-20 01:02:27 -0400379 if (size == I2C_SMBUS_I2C_BLOCK_BROKEN) {
Jean Delvaredba79972008-04-22 22:16:47 +0200380 /* Convert old I2C block commands to the new
381 convention. This preserves binary compatibility. */
Al Viro7d5cb452017-09-20 01:02:27 -0400382 size = I2C_SMBUS_I2C_BLOCK_DATA;
383 if (read_write == I2C_SMBUS_READ)
Jean Delvaredba79972008-04-22 22:16:47 +0200384 temp.block[0] = I2C_SMBUS_BLOCK_MAX;
385 }
386 res = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
Al Viro7d5cb452017-09-20 01:02:27 -0400387 read_write, command, size, &temp);
388 if (!res && ((size == I2C_SMBUS_PROC_CALL) ||
389 (size == I2C_SMBUS_BLOCK_PROC_CALL) ||
390 (read_write == I2C_SMBUS_READ))) {
391 if (copy_to_user(data, &temp, datasize))
Jean Delvaredba79972008-04-22 22:16:47 +0200392 return -EFAULT;
393 }
394 return res;
395}
396
Alan Cox77e38bf2008-07-14 22:38:27 +0200397static long i2cdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
H Hartley Sweeten0be16c32010-05-21 18:40:57 +0200399 struct i2c_client *client = file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 unsigned long funcs;
401
Jean Delvaree8aafcb2005-10-07 23:06:27 +0200402 dev_dbg(&client->adapter->dev, "ioctl, cmd=0x%02x, arg=0x%02lx\n",
403 cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
Farid Hammaneae5624f2010-05-21 18:40:59 +0200405 switch (cmd) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 case I2C_SLAVE:
407 case I2C_SLAVE_FORCE:
David Brownell438d6c22006-12-10 21:21:31 +0100408 if ((arg > 0x3ff) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 (((client->flags & I2C_M_TEN) == 0) && arg > 0x7f))
410 return -EINVAL;
Jean Delvarebd4217d2007-11-15 19:24:01 +0100411 if (cmd == I2C_SLAVE && i2cdev_check_addr(client->adapter, arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 return -EBUSY;
Jean Delvarebd4217d2007-11-15 19:24:01 +0100413 /* REVISIT: address could become busy later */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 client->addr = arg;
415 return 0;
416 case I2C_TENBIT:
417 if (arg)
418 client->flags |= I2C_M_TEN;
419 else
420 client->flags &= ~I2C_M_TEN;
421 return 0;
422 case I2C_PEC:
Jean Delvare9e685c82015-09-11 11:27:18 +0200423 /*
424 * Setting the PEC flag here won't affect kernel drivers,
425 * which will be using the i2c_client node registered with
426 * the driver model core. Likewise, when that client has
427 * the PEC flag already set, the i2c-dev driver won't see
428 * (or use) this setting.
429 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 if (arg)
431 client->flags |= I2C_CLIENT_PEC;
432 else
433 client->flags &= ~I2C_CLIENT_PEC;
434 return 0;
435 case I2C_FUNCS:
436 funcs = i2c_get_functionality(client->adapter);
Jean Delvare2c003e82006-12-10 21:21:30 +0100437 return put_user(funcs, (unsigned long __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
Al Viro7d5cb452017-09-20 01:02:27 -0400439 case I2C_RDWR: {
440 struct i2c_rdwr_ioctl_data rdwr_arg;
441 struct i2c_msg *rdwr_pa;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Al Viro7d5cb452017-09-20 01:02:27 -0400443 if (copy_from_user(&rdwr_arg,
444 (struct i2c_rdwr_ioctl_data __user *)arg,
445 sizeof(rdwr_arg)))
446 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Al Viro7d5cb452017-09-20 01:02:27 -0400448 /* Put an arbitrary limit on the number of messages that can
449 * be sent at once */
450 if (rdwr_arg.nmsgs > I2C_RDWR_IOCTL_MAX_MSGS)
451 return -EINVAL;
452
453 rdwr_pa = memdup_user(rdwr_arg.msgs,
454 rdwr_arg.nmsgs * sizeof(struct i2c_msg));
455 if (IS_ERR(rdwr_pa))
456 return PTR_ERR(rdwr_pa);
457
458 return i2cdev_ioctl_rdwr(client, rdwr_arg.nmsgs, rdwr_pa);
459 }
460
461 case I2C_SMBUS: {
462 struct i2c_smbus_ioctl_data data_arg;
463 if (copy_from_user(&data_arg,
464 (struct i2c_smbus_ioctl_data __user *) arg,
465 sizeof(struct i2c_smbus_ioctl_data)))
466 return -EFAULT;
467 return i2cdev_ioctl_smbus(client, data_arg.read_write,
468 data_arg.command,
469 data_arg.size,
470 data_arg.data);
471 }
David Brownell53be7952007-10-13 23:56:32 +0200472 case I2C_RETRIES:
Yi Zeng6ebec9612019-01-09 15:33:07 +0800473 if (arg > INT_MAX)
474 return -EINVAL;
475
David Brownell53be7952007-10-13 23:56:32 +0200476 client->adapter->retries = arg;
477 break;
478 case I2C_TIMEOUT:
Yi Zeng6ebec9612019-01-09 15:33:07 +0800479 if (arg > INT_MAX)
480 return -EINVAL;
481
Jean Delvarecd97f392009-02-24 19:19:49 +0100482 /* For historical reasons, user-space sets the timeout
483 * value in units of 10 ms.
484 */
485 client->adapter->timeout = msecs_to_jiffies(arg * 10);
David Brownell53be7952007-10-13 23:56:32 +0200486 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 default:
David Brownell53be7952007-10-13 23:56:32 +0200488 /* NOTE: returning a fault code here could cause trouble
489 * in buggy userspace code. Some old kernel bugs returned
490 * zero in this case, and userspace code might accidentally
491 * have depended on that bug.
492 */
493 return -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 }
495 return 0;
496}
497
Al Viro7d5cb452017-09-20 01:02:27 -0400498#ifdef CONFIG_COMPAT
499
500struct i2c_smbus_ioctl_data32 {
501 u8 read_write;
502 u8 command;
503 u32 size;
504 compat_caddr_t data; /* union i2c_smbus_data *data */
505};
506
507struct i2c_msg32 {
508 u16 addr;
509 u16 flags;
510 u16 len;
511 compat_caddr_t buf;
512};
513
514struct i2c_rdwr_ioctl_data32 {
515 compat_caddr_t msgs; /* struct i2c_msg __user *msgs */
516 u32 nmsgs;
517};
518
519static long compat_i2cdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
520{
521 struct i2c_client *client = file->private_data;
522 unsigned long funcs;
523 switch (cmd) {
524 case I2C_FUNCS:
525 funcs = i2c_get_functionality(client->adapter);
526 return put_user(funcs, (compat_ulong_t __user *)arg);
527 case I2C_RDWR: {
528 struct i2c_rdwr_ioctl_data32 rdwr_arg;
529 struct i2c_msg32 *p;
530 struct i2c_msg *rdwr_pa;
531 int i;
532
533 if (copy_from_user(&rdwr_arg,
534 (struct i2c_rdwr_ioctl_data32 __user *)arg,
535 sizeof(rdwr_arg)))
536 return -EFAULT;
537
538 if (rdwr_arg.nmsgs > I2C_RDWR_IOCTL_MAX_MSGS)
539 return -EINVAL;
540
541 rdwr_pa = kmalloc_array(rdwr_arg.nmsgs, sizeof(struct i2c_msg),
542 GFP_KERNEL);
543 if (!rdwr_pa)
544 return -ENOMEM;
545
546 p = compat_ptr(rdwr_arg.msgs);
547 for (i = 0; i < rdwr_arg.nmsgs; i++) {
548 struct i2c_msg32 umsg;
549 if (copy_from_user(&umsg, p + i, sizeof(umsg))) {
550 kfree(rdwr_pa);
551 return -EFAULT;
552 }
553 rdwr_pa[i] = (struct i2c_msg) {
554 .addr = umsg.addr,
555 .flags = umsg.flags,
556 .len = umsg.len,
557 .buf = compat_ptr(umsg.buf)
558 };
559 }
560
561 return i2cdev_ioctl_rdwr(client, rdwr_arg.nmsgs, rdwr_pa);
562 }
563 case I2C_SMBUS: {
564 struct i2c_smbus_ioctl_data32 data32;
565 if (copy_from_user(&data32,
566 (void __user *) arg,
567 sizeof(data32)))
568 return -EFAULT;
569 return i2cdev_ioctl_smbus(client, data32.read_write,
570 data32.command,
571 data32.size,
572 compat_ptr(data32.data));
573 }
574 default:
575 return i2cdev_ioctl(file, cmd, arg);
576 }
577}
578#else
579#define compat_i2cdev_ioctl NULL
580#endif
581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582static int i2cdev_open(struct inode *inode, struct file *file)
583{
584 unsigned int minor = iminor(inode);
585 struct i2c_client *client;
586 struct i2c_adapter *adap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
viresh kumar5136ed42016-07-05 19:57:06 -0700588 adap = i2c_get_adapter(minor);
Vincent Sanders9669f542009-12-06 17:06:26 +0100589 if (!adap)
590 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
David Brownell907135a2007-11-15 19:24:01 +0100592 /* This creates an anonymous i2c_client, which may later be
593 * pointed to some address using I2C_SLAVE or I2C_SLAVE_FORCE.
594 *
595 * This client is ** NEVER REGISTERED ** with the driver model
596 * or I2C core code!! It just holds private copies of addressing
597 * information and maybe a PEC flag.
598 */
Jean Delvare22f76e72006-07-01 17:20:57 +0200599 client = kzalloc(sizeof(*client), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 if (!client) {
601 i2c_put_adapter(adap);
Vincent Sanders9669f542009-12-06 17:06:26 +0100602 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 }
Jean Delvare22f76e72006-07-01 17:20:57 +0200604 snprintf(client->name, I2C_NAME_SIZE, "i2c-dev %d", adap->nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 client->adapter = adap;
607 file->private_data = client;
608
Vincent Sanders9669f542009-12-06 17:06:26 +0100609 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610}
611
612static int i2cdev_release(struct inode *inode, struct file *file)
613{
614 struct i2c_client *client = file->private_data;
615
616 i2c_put_adapter(client->adapter);
617 kfree(client);
618 file->private_data = NULL;
619
620 return 0;
621}
622
Arjan van de Ven2b8693c2007-02-12 00:55:32 -0800623static const struct file_operations i2cdev_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 .owner = THIS_MODULE,
625 .llseek = no_llseek,
626 .read = i2cdev_read,
627 .write = i2cdev_write,
Alan Cox77e38bf2008-07-14 22:38:27 +0200628 .unlocked_ioctl = i2cdev_ioctl,
Al Viro7d5cb452017-09-20 01:02:27 -0400629 .compat_ioctl = compat_i2cdev_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 .open = i2cdev_open,
631 .release = i2cdev_release,
632};
633
David Brownell907135a2007-11-15 19:24:01 +0100634/* ------------------------------------------------------------------------- */
635
Greg Kroah-Hartman794721322005-12-06 15:33:15 -0800636static struct class *i2c_dev_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Jean Delvare9ea3e942011-03-20 14:50:52 +0100638static int i2cdev_attach_adapter(struct device *dev, void *dummy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639{
Jean Delvare9ea3e942011-03-20 14:50:52 +0100640 struct i2c_adapter *adap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 struct i2c_dev *i2c_dev;
Jean Delvaredefcb462006-08-15 18:30:24 +0200642 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Jean Delvare9ea3e942011-03-20 14:50:52 +0100644 if (dev->type != &i2c_adapter_type)
645 return 0;
646 adap = to_i2c_adapter(dev);
647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 i2c_dev = get_free_i2c_dev(adap);
649 if (IS_ERR(i2c_dev))
650 return PTR_ERR(i2c_dev);
651
Erico Nunesd6760b12016-05-03 15:45:43 -0300652 cdev_init(&i2c_dev->cdev, &i2cdev_fops);
653 i2c_dev->cdev.owner = THIS_MODULE;
654 res = cdev_add(&i2c_dev->cdev, MKDEV(I2C_MAJOR, adap->nr), 1);
655 if (res)
656 goto error_cdev;
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 /* register this i2c device with the driver core */
Greg Kroah-Hartmana9b12612008-07-21 20:03:34 -0700659 i2c_dev->dev = device_create(i2c_dev_class, &adap->dev,
660 MKDEV(I2C_MAJOR, adap->nr), NULL,
661 "i2c-%d", adap->nr);
Akinobu Mita3bacb362006-12-10 21:21:33 +0100662 if (IS_ERR(i2c_dev->dev)) {
663 res = PTR_ERR(i2c_dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 goto error;
Jean Delvaredefcb462006-08-15 18:30:24 +0200665 }
Jean Delvareb32d20d2006-09-03 22:19:25 +0200666
667 pr_debug("i2c-dev: adapter [%s] registered as minor %d\n",
668 adap->name, adap->nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 return 0;
670error:
Erico Nunesd6760b12016-05-03 15:45:43 -0300671 cdev_del(&i2c_dev->cdev);
672error_cdev:
Wolfram Sang72a71f82016-05-27 13:13:01 +0200673 put_i2c_dev(i2c_dev);
Jean Delvaredefcb462006-08-15 18:30:24 +0200674 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675}
676
Jean Delvare9ea3e942011-03-20 14:50:52 +0100677static int i2cdev_detach_adapter(struct device *dev, void *dummy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678{
Jean Delvare9ea3e942011-03-20 14:50:52 +0100679 struct i2c_adapter *adap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 struct i2c_dev *i2c_dev;
681
Jean Delvare9ea3e942011-03-20 14:50:52 +0100682 if (dev->type != &i2c_adapter_type)
683 return 0;
684 adap = to_i2c_adapter(dev);
685
Jean Delvare9455e4c2006-07-01 17:16:57 +0200686 i2c_dev = i2c_dev_get_by_minor(adap->nr);
Jean Delvareb32d20d2006-09-03 22:19:25 +0200687 if (!i2c_dev) /* attach_adapter must have failed */
688 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
Dan Carpentere6be18f2016-05-28 08:01:46 +0300690 cdev_del(&i2c_dev->cdev);
Wolfram Sang72a71f82016-05-27 13:13:01 +0200691 put_i2c_dev(i2c_dev);
Greg Kroah-Hartmanac11d062006-07-03 13:46:24 -0700692 device_destroy(i2c_dev_class, MKDEV(I2C_MAJOR, adap->nr));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200694 pr_debug("i2c-dev: adapter [%s] unregistered\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 return 0;
696}
697
Shubhrajyoti Deff245c2011-11-23 11:33:07 +0100698static int i2cdev_notifier_call(struct notifier_block *nb, unsigned long action,
Jean Delvare9ea3e942011-03-20 14:50:52 +0100699 void *data)
700{
701 struct device *dev = data;
702
703 switch (action) {
704 case BUS_NOTIFY_ADD_DEVICE:
705 return i2cdev_attach_adapter(dev, NULL);
706 case BUS_NOTIFY_DEL_DEVICE:
707 return i2cdev_detach_adapter(dev, NULL);
708 }
709
710 return 0;
711}
712
713static struct notifier_block i2cdev_notifier = {
714 .notifier_call = i2cdev_notifier_call,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715};
716
David Brownell907135a2007-11-15 19:24:01 +0100717/* ------------------------------------------------------------------------- */
718
719/*
720 * module load/unload record keeping
721 */
722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723static int __init i2c_dev_init(void)
724{
725 int res;
726
727 printk(KERN_INFO "i2c /dev entries driver\n");
728
Erico Nunesd6760b12016-05-03 15:45:43 -0300729 res = register_chrdev_region(MKDEV(I2C_MAJOR, 0), I2C_MINORS, "i2c");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 if (res)
731 goto out;
732
Greg Kroah-Hartman794721322005-12-06 15:33:15 -0800733 i2c_dev_class = class_create(THIS_MODULE, "i2c-dev");
Sven Wegenere74783e2008-09-24 13:39:21 +0200734 if (IS_ERR(i2c_dev_class)) {
735 res = PTR_ERR(i2c_dev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 goto out_unreg_chrdev;
Sven Wegenere74783e2008-09-24 13:39:21 +0200737 }
Guenter Roeck45f176a2013-09-26 19:36:11 -0700738 i2c_dev_class->dev_groups = i2c_groups;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Jean Delvare9ea3e942011-03-20 14:50:52 +0100740 /* Keep track of adapters which will be added or removed later */
741 res = bus_register_notifier(&i2c_bus_type, &i2cdev_notifier);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 if (res)
743 goto out_unreg_class;
744
Jean Delvare9ea3e942011-03-20 14:50:52 +0100745 /* Bind to already existing adapters right away */
746 i2c_for_each_dev(NULL, i2cdev_attach_adapter);
747
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 return 0;
749
750out_unreg_class:
Greg Kroah-Hartman794721322005-12-06 15:33:15 -0800751 class_destroy(i2c_dev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752out_unreg_chrdev:
Erico Nunesd6760b12016-05-03 15:45:43 -0300753 unregister_chrdev_region(MKDEV(I2C_MAJOR, 0), I2C_MINORS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754out:
755 printk(KERN_ERR "%s: Driver Initialisation failed\n", __FILE__);
756 return res;
757}
758
759static void __exit i2c_dev_exit(void)
760{
Jean Delvare9ea3e942011-03-20 14:50:52 +0100761 bus_unregister_notifier(&i2c_bus_type, &i2cdev_notifier);
762 i2c_for_each_dev(NULL, i2cdev_detach_adapter);
Greg Kroah-Hartman794721322005-12-06 15:33:15 -0800763 class_destroy(i2c_dev_class);
Erico Nunesd6760b12016-05-03 15:45:43 -0300764 unregister_chrdev_region(MKDEV(I2C_MAJOR, 0), I2C_MINORS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765}
766
767MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
768 "Simon G. Vogl <simon@tk.uni-linz.ac.at>");
769MODULE_DESCRIPTION("I2C /dev entries driver");
770MODULE_LICENSE("GPL");
771
772module_init(i2c_dev_init);
773module_exit(i2c_dev_exit);