i2c-dev: Use memdup_user
[firefly-linux-kernel-4.4.55.git] / drivers / i2c / i2c-dev.c
1 /*
2     i2c-dev.c - i2c-bus driver, char device interface
3
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.
17
18     You should have received a copy of the GNU General Public License
19     along with this program; if not, write to the Free Software
20     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 /* Note that this is a complete rewrite of Simon Vogl's i2c-dev module.
24    But I have used so much of his original code and ideas that it seems
25    only fair to recognize him as co-author -- Frodo */
26
27 /* The I2C_RDWR ioctl code is written by Kolja Waschk <waschk@telos.de> */
28
29 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/fs.h>
32 #include <linux/slab.h>
33 #include <linux/init.h>
34 #include <linux/list.h>
35 #include <linux/i2c.h>
36 #include <linux/i2c-dev.h>
37 #include <linux/jiffies.h>
38 #include <linux/uaccess.h>
39
40 static struct i2c_driver i2cdev_driver;
41
42 /*
43  * An i2c_dev represents an i2c_adapter ... an I2C or SMBus master, not a
44  * slave (i2c_client) with which messages will be exchanged.  It's coupled
45  * with a character special file which is accessed by user mode drivers.
46  *
47  * The list of i2c_dev structures is parallel to the i2c_adapter lists
48  * maintained by the driver model, and is updated using notifications
49  * delivered to the i2cdev_driver.
50  */
51 struct i2c_dev {
52         struct list_head list;
53         struct i2c_adapter *adap;
54         struct device *dev;
55 };
56
57 #define I2C_MINORS      256
58 static LIST_HEAD(i2c_dev_list);
59 static DEFINE_SPINLOCK(i2c_dev_list_lock);
60
61 static struct i2c_dev *i2c_dev_get_by_minor(unsigned index)
62 {
63         struct i2c_dev *i2c_dev;
64
65         spin_lock(&i2c_dev_list_lock);
66         list_for_each_entry(i2c_dev, &i2c_dev_list, list) {
67                 if (i2c_dev->adap->nr == index)
68                         goto found;
69         }
70         i2c_dev = NULL;
71 found:
72         spin_unlock(&i2c_dev_list_lock);
73         return i2c_dev;
74 }
75
76 static struct i2c_dev *get_free_i2c_dev(struct i2c_adapter *adap)
77 {
78         struct i2c_dev *i2c_dev;
79
80         if (adap->nr >= I2C_MINORS) {
81                 printk(KERN_ERR "i2c-dev: Out of device minors (%d)\n",
82                        adap->nr);
83                 return ERR_PTR(-ENODEV);
84         }
85
86         i2c_dev = kzalloc(sizeof(*i2c_dev), GFP_KERNEL);
87         if (!i2c_dev)
88                 return ERR_PTR(-ENOMEM);
89         i2c_dev->adap = adap;
90
91         spin_lock(&i2c_dev_list_lock);
92         list_add_tail(&i2c_dev->list, &i2c_dev_list);
93         spin_unlock(&i2c_dev_list_lock);
94         return i2c_dev;
95 }
96
97 static void return_i2c_dev(struct i2c_dev *i2c_dev)
98 {
99         spin_lock(&i2c_dev_list_lock);
100         list_del(&i2c_dev->list);
101         spin_unlock(&i2c_dev_list_lock);
102         kfree(i2c_dev);
103 }
104
105 static ssize_t show_adapter_name(struct device *dev,
106                                  struct device_attribute *attr, char *buf)
107 {
108         struct i2c_dev *i2c_dev = i2c_dev_get_by_minor(MINOR(dev->devt));
109
110         if (!i2c_dev)
111                 return -ENODEV;
112         return sprintf(buf, "%s\n", i2c_dev->adap->name);
113 }
114 static DEVICE_ATTR(name, S_IRUGO, show_adapter_name, NULL);
115
116 /* ------------------------------------------------------------------------- */
117
118 /*
119  * After opening an instance of this character special file, a file
120  * descriptor starts out associated only with an i2c_adapter (and bus).
121  *
122  * Using the I2C_RDWR ioctl(), you can then *immediately* issue i2c_msg
123  * traffic to any devices on the bus used by that adapter.  That's because
124  * the i2c_msg vectors embed all the addressing information they need, and
125  * are submitted directly to an i2c_adapter.  However, SMBus-only adapters
126  * don't support that interface.
127  *
128  * To use read()/write() system calls on that file descriptor, or to use
129  * SMBus interfaces (and work with SMBus-only hosts!), you must first issue
130  * an I2C_SLAVE (or I2C_SLAVE_FORCE) ioctl.  That configures an anonymous
131  * (never registered) i2c_client so it holds the addressing information
132  * needed by those system calls and by this SMBus interface.
133  */
134
135 static ssize_t i2cdev_read(struct file *file, char __user *buf, size_t count,
136                 loff_t *offset)
137 {
138         char *tmp;
139         int ret;
140
141         struct i2c_client *client = file->private_data;
142
143         if (count > 8192)
144                 count = 8192;
145
146         tmp = kmalloc(count, GFP_KERNEL);
147         if (tmp == NULL)
148                 return -ENOMEM;
149
150         pr_debug("i2c-dev: i2c-%d reading %zu bytes.\n",
151                 iminor(file->f_path.dentry->d_inode), count);
152
153         ret = i2c_master_recv(client, tmp, count);
154         if (ret >= 0)
155                 ret = copy_to_user(buf, tmp, count) ? -EFAULT : ret;
156         kfree(tmp);
157         return ret;
158 }
159
160 static ssize_t i2cdev_write(struct file *file, const char __user *buf,
161                 size_t count, loff_t *offset)
162 {
163         int ret;
164         char *tmp;
165         struct i2c_client *client = file->private_data;
166
167         if (count > 8192)
168                 count = 8192;
169
170         tmp = memdup_user(buf, count);
171         if (IS_ERR(tmp))
172                 return PTR_ERR(tmp);
173
174         pr_debug("i2c-dev: i2c-%d writing %zu bytes.\n",
175                 iminor(file->f_path.dentry->d_inode), count);
176
177         ret = i2c_master_send(client, tmp, count);
178         kfree(tmp);
179         return ret;
180 }
181
182 static int i2cdev_check(struct device *dev, void *addrp)
183 {
184         struct i2c_client *client = i2c_verify_client(dev);
185
186         if (!client || client->addr != *(unsigned int *)addrp)
187                 return 0;
188
189         return dev->driver ? -EBUSY : 0;
190 }
191
192 /* This address checking function differs from the one in i2c-core
193    in that it considers an address with a registered device, but no
194    driver bound to it, as NOT busy. */
195 static int i2cdev_check_addr(struct i2c_adapter *adapter, unsigned int addr)
196 {
197         return device_for_each_child(&adapter->dev, &addr, i2cdev_check);
198 }
199
200 static noinline int i2cdev_ioctl_rdrw(struct i2c_client *client,
201                 unsigned long arg)
202 {
203         struct i2c_rdwr_ioctl_data rdwr_arg;
204         struct i2c_msg *rdwr_pa;
205         u8 __user **data_ptrs;
206         int i, res;
207
208         if (copy_from_user(&rdwr_arg,
209                            (struct i2c_rdwr_ioctl_data __user *)arg,
210                            sizeof(rdwr_arg)))
211                 return -EFAULT;
212
213         /* Put an arbitrary limit on the number of messages that can
214          * be sent at once */
215         if (rdwr_arg.nmsgs > I2C_RDRW_IOCTL_MAX_MSGS)
216                 return -EINVAL;
217
218         rdwr_pa = kmalloc(rdwr_arg.nmsgs * sizeof(struct i2c_msg), GFP_KERNEL);
219         if (!rdwr_pa)
220                 return -ENOMEM;
221
222         if (copy_from_user(rdwr_pa, rdwr_arg.msgs,
223                            rdwr_arg.nmsgs * sizeof(struct i2c_msg))) {
224                 kfree(rdwr_pa);
225                 return -EFAULT;
226         }
227
228         data_ptrs = kmalloc(rdwr_arg.nmsgs * sizeof(u8 __user *), GFP_KERNEL);
229         if (data_ptrs == NULL) {
230                 kfree(rdwr_pa);
231                 return -ENOMEM;
232         }
233
234         res = 0;
235         for (i = 0; i < rdwr_arg.nmsgs; i++) {
236                 /* Limit the size of the message to a sane amount;
237                  * and don't let length change either. */
238                 if ((rdwr_pa[i].len > 8192) ||
239                     (rdwr_pa[i].flags & I2C_M_RECV_LEN)) {
240                         res = -EINVAL;
241                         break;
242                 }
243                 data_ptrs[i] = (u8 __user *)rdwr_pa[i].buf;
244                 rdwr_pa[i].buf = memdup_user(data_ptrs[i], rdwr_pa[i].len);
245                 if (IS_ERR(rdwr_pa[i].buf)) {
246                         res = PTR_ERR(rdwr_pa[i].buf);
247                         break;
248                 }
249         }
250         if (res < 0) {
251                 int j;
252                 for (j = 0; j < i; ++j)
253                         kfree(rdwr_pa[j].buf);
254                 kfree(data_ptrs);
255                 kfree(rdwr_pa);
256                 return res;
257         }
258
259         res = i2c_transfer(client->adapter, rdwr_pa, rdwr_arg.nmsgs);
260         while (i-- > 0) {
261                 if (res >= 0 && (rdwr_pa[i].flags & I2C_M_RD)) {
262                         if (copy_to_user(data_ptrs[i], rdwr_pa[i].buf,
263                                          rdwr_pa[i].len))
264                                 res = -EFAULT;
265                 }
266                 kfree(rdwr_pa[i].buf);
267         }
268         kfree(data_ptrs);
269         kfree(rdwr_pa);
270         return res;
271 }
272
273 static noinline int i2cdev_ioctl_smbus(struct i2c_client *client,
274                 unsigned long arg)
275 {
276         struct i2c_smbus_ioctl_data data_arg;
277         union i2c_smbus_data temp;
278         int datasize, res;
279
280         if (copy_from_user(&data_arg,
281                            (struct i2c_smbus_ioctl_data __user *) arg,
282                            sizeof(struct i2c_smbus_ioctl_data)))
283                 return -EFAULT;
284         if ((data_arg.size != I2C_SMBUS_BYTE) &&
285             (data_arg.size != I2C_SMBUS_QUICK) &&
286             (data_arg.size != I2C_SMBUS_BYTE_DATA) &&
287             (data_arg.size != I2C_SMBUS_WORD_DATA) &&
288             (data_arg.size != I2C_SMBUS_PROC_CALL) &&
289             (data_arg.size != I2C_SMBUS_BLOCK_DATA) &&
290             (data_arg.size != I2C_SMBUS_I2C_BLOCK_BROKEN) &&
291             (data_arg.size != I2C_SMBUS_I2C_BLOCK_DATA) &&
292             (data_arg.size != I2C_SMBUS_BLOCK_PROC_CALL)) {
293                 dev_dbg(&client->adapter->dev,
294                         "size out of range (%x) in ioctl I2C_SMBUS.\n",
295                         data_arg.size);
296                 return -EINVAL;
297         }
298         /* Note that I2C_SMBUS_READ and I2C_SMBUS_WRITE are 0 and 1,
299            so the check is valid if size==I2C_SMBUS_QUICK too. */
300         if ((data_arg.read_write != I2C_SMBUS_READ) &&
301             (data_arg.read_write != I2C_SMBUS_WRITE)) {
302                 dev_dbg(&client->adapter->dev,
303                         "read_write out of range (%x) in ioctl I2C_SMBUS.\n",
304                         data_arg.read_write);
305                 return -EINVAL;
306         }
307
308         /* Note that command values are always valid! */
309
310         if ((data_arg.size == I2C_SMBUS_QUICK) ||
311             ((data_arg.size == I2C_SMBUS_BYTE) &&
312             (data_arg.read_write == I2C_SMBUS_WRITE)))
313                 /* These are special: we do not use data */
314                 return i2c_smbus_xfer(client->adapter, client->addr,
315                                       client->flags, data_arg.read_write,
316                                       data_arg.command, data_arg.size, NULL);
317
318         if (data_arg.data == NULL) {
319                 dev_dbg(&client->adapter->dev,
320                         "data is NULL pointer in ioctl I2C_SMBUS.\n");
321                 return -EINVAL;
322         }
323
324         if ((data_arg.size == I2C_SMBUS_BYTE_DATA) ||
325             (data_arg.size == I2C_SMBUS_BYTE))
326                 datasize = sizeof(data_arg.data->byte);
327         else if ((data_arg.size == I2C_SMBUS_WORD_DATA) ||
328                  (data_arg.size == I2C_SMBUS_PROC_CALL))
329                 datasize = sizeof(data_arg.data->word);
330         else /* size == smbus block, i2c block, or block proc. call */
331                 datasize = sizeof(data_arg.data->block);
332
333         if ((data_arg.size == I2C_SMBUS_PROC_CALL) ||
334             (data_arg.size == I2C_SMBUS_BLOCK_PROC_CALL) ||
335             (data_arg.size == I2C_SMBUS_I2C_BLOCK_DATA) ||
336             (data_arg.read_write == I2C_SMBUS_WRITE)) {
337                 if (copy_from_user(&temp, data_arg.data, datasize))
338                         return -EFAULT;
339         }
340         if (data_arg.size == I2C_SMBUS_I2C_BLOCK_BROKEN) {
341                 /* Convert old I2C block commands to the new
342                    convention. This preserves binary compatibility. */
343                 data_arg.size = I2C_SMBUS_I2C_BLOCK_DATA;
344                 if (data_arg.read_write == I2C_SMBUS_READ)
345                         temp.block[0] = I2C_SMBUS_BLOCK_MAX;
346         }
347         res = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
348               data_arg.read_write, data_arg.command, data_arg.size, &temp);
349         if (!res && ((data_arg.size == I2C_SMBUS_PROC_CALL) ||
350                      (data_arg.size == I2C_SMBUS_BLOCK_PROC_CALL) ||
351                      (data_arg.read_write == I2C_SMBUS_READ))) {
352                 if (copy_to_user(data_arg.data, &temp, datasize))
353                         return -EFAULT;
354         }
355         return res;
356 }
357
358 static long i2cdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
359 {
360         struct i2c_client *client = file->private_data;
361         unsigned long funcs;
362
363         dev_dbg(&client->adapter->dev, "ioctl, cmd=0x%02x, arg=0x%02lx\n",
364                 cmd, arg);
365
366         switch (cmd) {
367         case I2C_SLAVE:
368         case I2C_SLAVE_FORCE:
369                 /* NOTE:  devices set up to work with "new style" drivers
370                  * can't use I2C_SLAVE, even when the device node is not
371                  * bound to a driver.  Only I2C_SLAVE_FORCE will work.
372                  *
373                  * Setting the PEC flag here won't affect kernel drivers,
374                  * which will be using the i2c_client node registered with
375                  * the driver model core.  Likewise, when that client has
376                  * the PEC flag already set, the i2c-dev driver won't see
377                  * (or use) this setting.
378                  */
379                 if ((arg > 0x3ff) ||
380                     (((client->flags & I2C_M_TEN) == 0) && arg > 0x7f))
381                         return -EINVAL;
382                 if (cmd == I2C_SLAVE && i2cdev_check_addr(client->adapter, arg))
383                         return -EBUSY;
384                 /* REVISIT: address could become busy later */
385                 client->addr = arg;
386                 return 0;
387         case I2C_TENBIT:
388                 if (arg)
389                         client->flags |= I2C_M_TEN;
390                 else
391                         client->flags &= ~I2C_M_TEN;
392                 return 0;
393         case I2C_PEC:
394                 if (arg)
395                         client->flags |= I2C_CLIENT_PEC;
396                 else
397                         client->flags &= ~I2C_CLIENT_PEC;
398                 return 0;
399         case I2C_FUNCS:
400                 funcs = i2c_get_functionality(client->adapter);
401                 return put_user(funcs, (unsigned long __user *)arg);
402
403         case I2C_RDWR:
404                 return i2cdev_ioctl_rdrw(client, arg);
405
406         case I2C_SMBUS:
407                 return i2cdev_ioctl_smbus(client, arg);
408
409         case I2C_RETRIES:
410                 client->adapter->retries = arg;
411                 break;
412         case I2C_TIMEOUT:
413                 /* For historical reasons, user-space sets the timeout
414                  * value in units of 10 ms.
415                  */
416                 client->adapter->timeout = msecs_to_jiffies(arg * 10);
417                 break;
418         default:
419                 /* NOTE:  returning a fault code here could cause trouble
420                  * in buggy userspace code.  Some old kernel bugs returned
421                  * zero in this case, and userspace code might accidentally
422                  * have depended on that bug.
423                  */
424                 return -ENOTTY;
425         }
426         return 0;
427 }
428
429 static int i2cdev_open(struct inode *inode, struct file *file)
430 {
431         unsigned int minor = iminor(inode);
432         struct i2c_client *client;
433         struct i2c_adapter *adap;
434         struct i2c_dev *i2c_dev;
435
436         i2c_dev = i2c_dev_get_by_minor(minor);
437         if (!i2c_dev)
438                 return -ENODEV;
439
440         adap = i2c_get_adapter(i2c_dev->adap->nr);
441         if (!adap)
442                 return -ENODEV;
443
444         /* This creates an anonymous i2c_client, which may later be
445          * pointed to some address using I2C_SLAVE or I2C_SLAVE_FORCE.
446          *
447          * This client is ** NEVER REGISTERED ** with the driver model
448          * or I2C core code!!  It just holds private copies of addressing
449          * information and maybe a PEC flag.
450          */
451         client = kzalloc(sizeof(*client), GFP_KERNEL);
452         if (!client) {
453                 i2c_put_adapter(adap);
454                 return -ENOMEM;
455         }
456         snprintf(client->name, I2C_NAME_SIZE, "i2c-dev %d", adap->nr);
457         client->driver = &i2cdev_driver;
458
459         client->adapter = adap;
460         file->private_data = client;
461
462         return 0;
463 }
464
465 static int i2cdev_release(struct inode *inode, struct file *file)
466 {
467         struct i2c_client *client = file->private_data;
468
469         i2c_put_adapter(client->adapter);
470         kfree(client);
471         file->private_data = NULL;
472
473         return 0;
474 }
475
476 static const struct file_operations i2cdev_fops = {
477         .owner          = THIS_MODULE,
478         .llseek         = no_llseek,
479         .read           = i2cdev_read,
480         .write          = i2cdev_write,
481         .unlocked_ioctl = i2cdev_ioctl,
482         .open           = i2cdev_open,
483         .release        = i2cdev_release,
484 };
485
486 /* ------------------------------------------------------------------------- */
487
488 /*
489  * The legacy "i2cdev_driver" is used primarily to get notifications when
490  * I2C adapters are added or removed, so that each one gets an i2c_dev
491  * and is thus made available to userspace driver code.
492  */
493
494 static struct class *i2c_dev_class;
495
496 static int i2cdev_attach_adapter(struct i2c_adapter *adap)
497 {
498         struct i2c_dev *i2c_dev;
499         int res;
500
501         i2c_dev = get_free_i2c_dev(adap);
502         if (IS_ERR(i2c_dev))
503                 return PTR_ERR(i2c_dev);
504
505         /* register this i2c device with the driver core */
506         i2c_dev->dev = device_create(i2c_dev_class, &adap->dev,
507                                      MKDEV(I2C_MAJOR, adap->nr), NULL,
508                                      "i2c-%d", adap->nr);
509         if (IS_ERR(i2c_dev->dev)) {
510                 res = PTR_ERR(i2c_dev->dev);
511                 goto error;
512         }
513         res = device_create_file(i2c_dev->dev, &dev_attr_name);
514         if (res)
515                 goto error_destroy;
516
517         pr_debug("i2c-dev: adapter [%s] registered as minor %d\n",
518                  adap->name, adap->nr);
519         return 0;
520 error_destroy:
521         device_destroy(i2c_dev_class, MKDEV(I2C_MAJOR, adap->nr));
522 error:
523         return_i2c_dev(i2c_dev);
524         return res;
525 }
526
527 static int i2cdev_detach_adapter(struct i2c_adapter *adap)
528 {
529         struct i2c_dev *i2c_dev;
530
531         i2c_dev = i2c_dev_get_by_minor(adap->nr);
532         if (!i2c_dev) /* attach_adapter must have failed */
533                 return 0;
534
535         device_remove_file(i2c_dev->dev, &dev_attr_name);
536         return_i2c_dev(i2c_dev);
537         device_destroy(i2c_dev_class, MKDEV(I2C_MAJOR, adap->nr));
538
539         pr_debug("i2c-dev: adapter [%s] unregistered\n", adap->name);
540         return 0;
541 }
542
543 static struct i2c_driver i2cdev_driver = {
544         .driver = {
545                 .name   = "dev_driver",
546         },
547         .attach_adapter = i2cdev_attach_adapter,
548         .detach_adapter = i2cdev_detach_adapter,
549 };
550
551 /* ------------------------------------------------------------------------- */
552
553 /*
554  * module load/unload record keeping
555  */
556
557 static int __init i2c_dev_init(void)
558 {
559         int res;
560
561         printk(KERN_INFO "i2c /dev entries driver\n");
562
563         res = register_chrdev(I2C_MAJOR, "i2c", &i2cdev_fops);
564         if (res)
565                 goto out;
566
567         i2c_dev_class = class_create(THIS_MODULE, "i2c-dev");
568         if (IS_ERR(i2c_dev_class)) {
569                 res = PTR_ERR(i2c_dev_class);
570                 goto out_unreg_chrdev;
571         }
572
573         res = i2c_add_driver(&i2cdev_driver);
574         if (res)
575                 goto out_unreg_class;
576
577         return 0;
578
579 out_unreg_class:
580         class_destroy(i2c_dev_class);
581 out_unreg_chrdev:
582         unregister_chrdev(I2C_MAJOR, "i2c");
583 out:
584         printk(KERN_ERR "%s: Driver Initialisation failed\n", __FILE__);
585         return res;
586 }
587
588 static void __exit i2c_dev_exit(void)
589 {
590         i2c_del_driver(&i2cdev_driver);
591         class_destroy(i2c_dev_class);
592         unregister_chrdev(I2C_MAJOR, "i2c");
593 }
594
595 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
596                 "Simon G. Vogl <simon@tk.uni-linz.ac.at>");
597 MODULE_DESCRIPTION("I2C /dev entries driver");
598 MODULE_LICENSE("GPL");
599
600 module_init(i2c_dev_init);
601 module_exit(i2c_dev_exit);