Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/ide-2.6
[pandora-kernel.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 /* walk up mux tree */
193 static int i2cdev_check_mux_parents(struct i2c_adapter *adapter, int addr)
194 {
195         struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
196         int result;
197
198         result = device_for_each_child(&adapter->dev, &addr, i2cdev_check);
199         if (!result && parent)
200                 result = i2cdev_check_mux_parents(parent, addr);
201
202         return result;
203 }
204
205 /* recurse down mux tree */
206 static int i2cdev_check_mux_children(struct device *dev, void *addrp)
207 {
208         int result;
209
210         if (dev->type == &i2c_adapter_type)
211                 result = device_for_each_child(dev, addrp,
212                                                 i2cdev_check_mux_children);
213         else
214                 result = i2cdev_check(dev, addrp);
215
216         return result;
217 }
218
219 /* This address checking function differs from the one in i2c-core
220    in that it considers an address with a registered device, but no
221    driver bound to it, as NOT busy. */
222 static int i2cdev_check_addr(struct i2c_adapter *adapter, unsigned int addr)
223 {
224         struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
225         int result = 0;
226
227         if (parent)
228                 result = i2cdev_check_mux_parents(parent, addr);
229
230         if (!result)
231                 result = device_for_each_child(&adapter->dev, &addr,
232                                                 i2cdev_check_mux_children);
233
234         return result;
235 }
236
237 static noinline int i2cdev_ioctl_rdrw(struct i2c_client *client,
238                 unsigned long arg)
239 {
240         struct i2c_rdwr_ioctl_data rdwr_arg;
241         struct i2c_msg *rdwr_pa;
242         u8 __user **data_ptrs;
243         int i, res;
244
245         if (copy_from_user(&rdwr_arg,
246                            (struct i2c_rdwr_ioctl_data __user *)arg,
247                            sizeof(rdwr_arg)))
248                 return -EFAULT;
249
250         /* Put an arbitrary limit on the number of messages that can
251          * be sent at once */
252         if (rdwr_arg.nmsgs > I2C_RDRW_IOCTL_MAX_MSGS)
253                 return -EINVAL;
254
255         rdwr_pa = kmalloc(rdwr_arg.nmsgs * sizeof(struct i2c_msg), GFP_KERNEL);
256         if (!rdwr_pa)
257                 return -ENOMEM;
258
259         if (copy_from_user(rdwr_pa, rdwr_arg.msgs,
260                            rdwr_arg.nmsgs * sizeof(struct i2c_msg))) {
261                 kfree(rdwr_pa);
262                 return -EFAULT;
263         }
264
265         data_ptrs = kmalloc(rdwr_arg.nmsgs * sizeof(u8 __user *), GFP_KERNEL);
266         if (data_ptrs == NULL) {
267                 kfree(rdwr_pa);
268                 return -ENOMEM;
269         }
270
271         res = 0;
272         for (i = 0; i < rdwr_arg.nmsgs; i++) {
273                 /* Limit the size of the message to a sane amount;
274                  * and don't let length change either. */
275                 if ((rdwr_pa[i].len > 8192) ||
276                     (rdwr_pa[i].flags & I2C_M_RECV_LEN)) {
277                         res = -EINVAL;
278                         break;
279                 }
280                 data_ptrs[i] = (u8 __user *)rdwr_pa[i].buf;
281                 rdwr_pa[i].buf = memdup_user(data_ptrs[i], rdwr_pa[i].len);
282                 if (IS_ERR(rdwr_pa[i].buf)) {
283                         res = PTR_ERR(rdwr_pa[i].buf);
284                         break;
285                 }
286         }
287         if (res < 0) {
288                 int j;
289                 for (j = 0; j < i; ++j)
290                         kfree(rdwr_pa[j].buf);
291                 kfree(data_ptrs);
292                 kfree(rdwr_pa);
293                 return res;
294         }
295
296         res = i2c_transfer(client->adapter, rdwr_pa, rdwr_arg.nmsgs);
297         while (i-- > 0) {
298                 if (res >= 0 && (rdwr_pa[i].flags & I2C_M_RD)) {
299                         if (copy_to_user(data_ptrs[i], rdwr_pa[i].buf,
300                                          rdwr_pa[i].len))
301                                 res = -EFAULT;
302                 }
303                 kfree(rdwr_pa[i].buf);
304         }
305         kfree(data_ptrs);
306         kfree(rdwr_pa);
307         return res;
308 }
309
310 static noinline int i2cdev_ioctl_smbus(struct i2c_client *client,
311                 unsigned long arg)
312 {
313         struct i2c_smbus_ioctl_data data_arg;
314         union i2c_smbus_data temp;
315         int datasize, res;
316
317         if (copy_from_user(&data_arg,
318                            (struct i2c_smbus_ioctl_data __user *) arg,
319                            sizeof(struct i2c_smbus_ioctl_data)))
320                 return -EFAULT;
321         if ((data_arg.size != I2C_SMBUS_BYTE) &&
322             (data_arg.size != I2C_SMBUS_QUICK) &&
323             (data_arg.size != I2C_SMBUS_BYTE_DATA) &&
324             (data_arg.size != I2C_SMBUS_WORD_DATA) &&
325             (data_arg.size != I2C_SMBUS_PROC_CALL) &&
326             (data_arg.size != I2C_SMBUS_BLOCK_DATA) &&
327             (data_arg.size != I2C_SMBUS_I2C_BLOCK_BROKEN) &&
328             (data_arg.size != I2C_SMBUS_I2C_BLOCK_DATA) &&
329             (data_arg.size != I2C_SMBUS_BLOCK_PROC_CALL)) {
330                 dev_dbg(&client->adapter->dev,
331                         "size out of range (%x) in ioctl I2C_SMBUS.\n",
332                         data_arg.size);
333                 return -EINVAL;
334         }
335         /* Note that I2C_SMBUS_READ and I2C_SMBUS_WRITE are 0 and 1,
336            so the check is valid if size==I2C_SMBUS_QUICK too. */
337         if ((data_arg.read_write != I2C_SMBUS_READ) &&
338             (data_arg.read_write != I2C_SMBUS_WRITE)) {
339                 dev_dbg(&client->adapter->dev,
340                         "read_write out of range (%x) in ioctl I2C_SMBUS.\n",
341                         data_arg.read_write);
342                 return -EINVAL;
343         }
344
345         /* Note that command values are always valid! */
346
347         if ((data_arg.size == I2C_SMBUS_QUICK) ||
348             ((data_arg.size == I2C_SMBUS_BYTE) &&
349             (data_arg.read_write == I2C_SMBUS_WRITE)))
350                 /* These are special: we do not use data */
351                 return i2c_smbus_xfer(client->adapter, client->addr,
352                                       client->flags, data_arg.read_write,
353                                       data_arg.command, data_arg.size, NULL);
354
355         if (data_arg.data == NULL) {
356                 dev_dbg(&client->adapter->dev,
357                         "data is NULL pointer in ioctl I2C_SMBUS.\n");
358                 return -EINVAL;
359         }
360
361         if ((data_arg.size == I2C_SMBUS_BYTE_DATA) ||
362             (data_arg.size == I2C_SMBUS_BYTE))
363                 datasize = sizeof(data_arg.data->byte);
364         else if ((data_arg.size == I2C_SMBUS_WORD_DATA) ||
365                  (data_arg.size == I2C_SMBUS_PROC_CALL))
366                 datasize = sizeof(data_arg.data->word);
367         else /* size == smbus block, i2c block, or block proc. call */
368                 datasize = sizeof(data_arg.data->block);
369
370         if ((data_arg.size == I2C_SMBUS_PROC_CALL) ||
371             (data_arg.size == I2C_SMBUS_BLOCK_PROC_CALL) ||
372             (data_arg.size == I2C_SMBUS_I2C_BLOCK_DATA) ||
373             (data_arg.read_write == I2C_SMBUS_WRITE)) {
374                 if (copy_from_user(&temp, data_arg.data, datasize))
375                         return -EFAULT;
376         }
377         if (data_arg.size == I2C_SMBUS_I2C_BLOCK_BROKEN) {
378                 /* Convert old I2C block commands to the new
379                    convention. This preserves binary compatibility. */
380                 data_arg.size = I2C_SMBUS_I2C_BLOCK_DATA;
381                 if (data_arg.read_write == I2C_SMBUS_READ)
382                         temp.block[0] = I2C_SMBUS_BLOCK_MAX;
383         }
384         res = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
385               data_arg.read_write, data_arg.command, data_arg.size, &temp);
386         if (!res && ((data_arg.size == I2C_SMBUS_PROC_CALL) ||
387                      (data_arg.size == I2C_SMBUS_BLOCK_PROC_CALL) ||
388                      (data_arg.read_write == I2C_SMBUS_READ))) {
389                 if (copy_to_user(data_arg.data, &temp, datasize))
390                         return -EFAULT;
391         }
392         return res;
393 }
394
395 static long i2cdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
396 {
397         struct i2c_client *client = file->private_data;
398         unsigned long funcs;
399
400         dev_dbg(&client->adapter->dev, "ioctl, cmd=0x%02x, arg=0x%02lx\n",
401                 cmd, arg);
402
403         switch (cmd) {
404         case I2C_SLAVE:
405         case I2C_SLAVE_FORCE:
406                 /* NOTE:  devices set up to work with "new style" drivers
407                  * can't use I2C_SLAVE, even when the device node is not
408                  * bound to a driver.  Only I2C_SLAVE_FORCE will work.
409                  *
410                  * Setting the PEC flag here won't affect kernel drivers,
411                  * which will be using the i2c_client node registered with
412                  * the driver model core.  Likewise, when that client has
413                  * the PEC flag already set, the i2c-dev driver won't see
414                  * (or use) this setting.
415                  */
416                 if ((arg > 0x3ff) ||
417                     (((client->flags & I2C_M_TEN) == 0) && arg > 0x7f))
418                         return -EINVAL;
419                 if (cmd == I2C_SLAVE && i2cdev_check_addr(client->adapter, arg))
420                         return -EBUSY;
421                 /* REVISIT: address could become busy later */
422                 client->addr = arg;
423                 return 0;
424         case I2C_TENBIT:
425                 if (arg)
426                         client->flags |= I2C_M_TEN;
427                 else
428                         client->flags &= ~I2C_M_TEN;
429                 return 0;
430         case I2C_PEC:
431                 if (arg)
432                         client->flags |= I2C_CLIENT_PEC;
433                 else
434                         client->flags &= ~I2C_CLIENT_PEC;
435                 return 0;
436         case I2C_FUNCS:
437                 funcs = i2c_get_functionality(client->adapter);
438                 return put_user(funcs, (unsigned long __user *)arg);
439
440         case I2C_RDWR:
441                 return i2cdev_ioctl_rdrw(client, arg);
442
443         case I2C_SMBUS:
444                 return i2cdev_ioctl_smbus(client, arg);
445
446         case I2C_RETRIES:
447                 client->adapter->retries = arg;
448                 break;
449         case I2C_TIMEOUT:
450                 /* For historical reasons, user-space sets the timeout
451                  * value in units of 10 ms.
452                  */
453                 client->adapter->timeout = msecs_to_jiffies(arg * 10);
454                 break;
455         default:
456                 /* NOTE:  returning a fault code here could cause trouble
457                  * in buggy userspace code.  Some old kernel bugs returned
458                  * zero in this case, and userspace code might accidentally
459                  * have depended on that bug.
460                  */
461                 return -ENOTTY;
462         }
463         return 0;
464 }
465
466 static int i2cdev_open(struct inode *inode, struct file *file)
467 {
468         unsigned int minor = iminor(inode);
469         struct i2c_client *client;
470         struct i2c_adapter *adap;
471         struct i2c_dev *i2c_dev;
472
473         i2c_dev = i2c_dev_get_by_minor(minor);
474         if (!i2c_dev)
475                 return -ENODEV;
476
477         adap = i2c_get_adapter(i2c_dev->adap->nr);
478         if (!adap)
479                 return -ENODEV;
480
481         /* This creates an anonymous i2c_client, which may later be
482          * pointed to some address using I2C_SLAVE or I2C_SLAVE_FORCE.
483          *
484          * This client is ** NEVER REGISTERED ** with the driver model
485          * or I2C core code!!  It just holds private copies of addressing
486          * information and maybe a PEC flag.
487          */
488         client = kzalloc(sizeof(*client), GFP_KERNEL);
489         if (!client) {
490                 i2c_put_adapter(adap);
491                 return -ENOMEM;
492         }
493         snprintf(client->name, I2C_NAME_SIZE, "i2c-dev %d", adap->nr);
494         client->driver = &i2cdev_driver;
495
496         client->adapter = adap;
497         file->private_data = client;
498
499         return 0;
500 }
501
502 static int i2cdev_release(struct inode *inode, struct file *file)
503 {
504         struct i2c_client *client = file->private_data;
505
506         i2c_put_adapter(client->adapter);
507         kfree(client);
508         file->private_data = NULL;
509
510         return 0;
511 }
512
513 static const struct file_operations i2cdev_fops = {
514         .owner          = THIS_MODULE,
515         .llseek         = no_llseek,
516         .read           = i2cdev_read,
517         .write          = i2cdev_write,
518         .unlocked_ioctl = i2cdev_ioctl,
519         .open           = i2cdev_open,
520         .release        = i2cdev_release,
521 };
522
523 /* ------------------------------------------------------------------------- */
524
525 /*
526  * The legacy "i2cdev_driver" is used primarily to get notifications when
527  * I2C adapters are added or removed, so that each one gets an i2c_dev
528  * and is thus made available to userspace driver code.
529  */
530
531 static struct class *i2c_dev_class;
532
533 static int i2cdev_attach_adapter(struct i2c_adapter *adap)
534 {
535         struct i2c_dev *i2c_dev;
536         int res;
537
538         i2c_dev = get_free_i2c_dev(adap);
539         if (IS_ERR(i2c_dev))
540                 return PTR_ERR(i2c_dev);
541
542         /* register this i2c device with the driver core */
543         i2c_dev->dev = device_create(i2c_dev_class, &adap->dev,
544                                      MKDEV(I2C_MAJOR, adap->nr), NULL,
545                                      "i2c-%d", adap->nr);
546         if (IS_ERR(i2c_dev->dev)) {
547                 res = PTR_ERR(i2c_dev->dev);
548                 goto error;
549         }
550         res = device_create_file(i2c_dev->dev, &dev_attr_name);
551         if (res)
552                 goto error_destroy;
553
554         pr_debug("i2c-dev: adapter [%s] registered as minor %d\n",
555                  adap->name, adap->nr);
556         return 0;
557 error_destroy:
558         device_destroy(i2c_dev_class, MKDEV(I2C_MAJOR, adap->nr));
559 error:
560         return_i2c_dev(i2c_dev);
561         return res;
562 }
563
564 static int i2cdev_detach_adapter(struct i2c_adapter *adap)
565 {
566         struct i2c_dev *i2c_dev;
567
568         i2c_dev = i2c_dev_get_by_minor(adap->nr);
569         if (!i2c_dev) /* attach_adapter must have failed */
570                 return 0;
571
572         device_remove_file(i2c_dev->dev, &dev_attr_name);
573         return_i2c_dev(i2c_dev);
574         device_destroy(i2c_dev_class, MKDEV(I2C_MAJOR, adap->nr));
575
576         pr_debug("i2c-dev: adapter [%s] unregistered\n", adap->name);
577         return 0;
578 }
579
580 static struct i2c_driver i2cdev_driver = {
581         .driver = {
582                 .name   = "dev_driver",
583         },
584         .attach_adapter = i2cdev_attach_adapter,
585         .detach_adapter = i2cdev_detach_adapter,
586 };
587
588 /* ------------------------------------------------------------------------- */
589
590 /*
591  * module load/unload record keeping
592  */
593
594 static int __init i2c_dev_init(void)
595 {
596         int res;
597
598         printk(KERN_INFO "i2c /dev entries driver\n");
599
600         res = register_chrdev(I2C_MAJOR, "i2c", &i2cdev_fops);
601         if (res)
602                 goto out;
603
604         i2c_dev_class = class_create(THIS_MODULE, "i2c-dev");
605         if (IS_ERR(i2c_dev_class)) {
606                 res = PTR_ERR(i2c_dev_class);
607                 goto out_unreg_chrdev;
608         }
609
610         res = i2c_add_driver(&i2cdev_driver);
611         if (res)
612                 goto out_unreg_class;
613
614         return 0;
615
616 out_unreg_class:
617         class_destroy(i2c_dev_class);
618 out_unreg_chrdev:
619         unregister_chrdev(I2C_MAJOR, "i2c");
620 out:
621         printk(KERN_ERR "%s: Driver Initialisation failed\n", __FILE__);
622         return res;
623 }
624
625 static void __exit i2c_dev_exit(void)
626 {
627         i2c_del_driver(&i2cdev_driver);
628         class_destroy(i2c_dev_class);
629         unregister_chrdev(I2C_MAJOR, "i2c");
630 }
631
632 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
633                 "Simon G. Vogl <simon@tk.uni-linz.ac.at>");
634 MODULE_DESCRIPTION("I2C /dev entries driver");
635 MODULE_LICENSE("GPL");
636
637 module_init(i2c_dev_init);
638 module_exit(i2c_dev_exit);