2 i2c-dev.c - i2c-bus driver, char device interface
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>
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.
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.
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 */
23 /* The I2C_RDWR ioctl code is written by Kolja Waschk <waschk@telos.de> */
25 #include <linux/cdev.h>
26 #include <linux/device.h>
28 #include <linux/i2c-dev.h>
29 #include <linux/i2c.h>
30 #include <linux/init.h>
31 #include <linux/jiffies.h>
32 #include <linux/kernel.h>
33 #include <linux/list.h>
34 #include <linux/module.h>
35 #include <linux/notifier.h>
36 #include <linux/slab.h>
37 #include <linux/uaccess.h>
38 #include <linux/compat.h>
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.
45 * The list of i2c_dev structures is parallel to the i2c_adapter lists
46 * maintained by the driver model, and is updated using bus notifications.
49 struct list_head list
;
50 struct i2c_adapter
*adap
;
55 #define I2C_MINORS MINORMASK
56 static LIST_HEAD(i2c_dev_list
);
57 static DEFINE_SPINLOCK(i2c_dev_list_lock
);
59 static struct i2c_dev
*i2c_dev_get_by_minor(unsigned index
)
61 struct i2c_dev
*i2c_dev
;
63 spin_lock(&i2c_dev_list_lock
);
64 list_for_each_entry(i2c_dev
, &i2c_dev_list
, list
) {
65 if (i2c_dev
->adap
->nr
== index
)
70 spin_unlock(&i2c_dev_list_lock
);
74 static struct i2c_dev
*get_free_i2c_dev(struct i2c_adapter
*adap
)
76 struct i2c_dev
*i2c_dev
;
78 if (adap
->nr
>= I2C_MINORS
) {
79 printk(KERN_ERR
"i2c-dev: Out of device minors (%d)\n",
81 return ERR_PTR(-ENODEV
);
84 i2c_dev
= kzalloc(sizeof(*i2c_dev
), GFP_KERNEL
);
86 return ERR_PTR(-ENOMEM
);
89 spin_lock(&i2c_dev_list_lock
);
90 list_add_tail(&i2c_dev
->list
, &i2c_dev_list
);
91 spin_unlock(&i2c_dev_list_lock
);
95 static void put_i2c_dev(struct i2c_dev
*i2c_dev
, bool del_cdev
)
97 spin_lock(&i2c_dev_list_lock
);
98 list_del(&i2c_dev
->list
);
99 spin_unlock(&i2c_dev_list_lock
);
101 cdev_device_del(&i2c_dev
->cdev
, &i2c_dev
->dev
);
102 put_device(&i2c_dev
->dev
);
105 static ssize_t
name_show(struct device
*dev
,
106 struct device_attribute
*attr
, char *buf
)
108 struct i2c_dev
*i2c_dev
= i2c_dev_get_by_minor(MINOR(dev
->devt
));
112 return sprintf(buf
, "%s\n", i2c_dev
->adap
->name
);
114 static DEVICE_ATTR_RO(name
);
116 static struct attribute
*i2c_attrs
[] = {
120 ATTRIBUTE_GROUPS(i2c
);
122 /* ------------------------------------------------------------------------- */
125 * After opening an instance of this character special file, a file
126 * descriptor starts out associated only with an i2c_adapter (and bus).
128 * Using the I2C_RDWR ioctl(), you can then *immediately* issue i2c_msg
129 * traffic to any devices on the bus used by that adapter. That's because
130 * the i2c_msg vectors embed all the addressing information they need, and
131 * are submitted directly to an i2c_adapter. However, SMBus-only adapters
132 * don't support that interface.
134 * To use read()/write() system calls on that file descriptor, or to use
135 * SMBus interfaces (and work with SMBus-only hosts!), you must first issue
136 * an I2C_SLAVE (or I2C_SLAVE_FORCE) ioctl. That configures an anonymous
137 * (never registered) i2c_client so it holds the addressing information
138 * needed by those system calls and by this SMBus interface.
141 static ssize_t
i2cdev_read(struct file
*file
, char __user
*buf
, size_t count
,
147 struct i2c_client
*client
= file
->private_data
;
152 tmp
= kmalloc(count
, GFP_KERNEL
);
156 pr_debug("i2c-dev: i2c-%d reading %zu bytes.\n",
157 iminor(file_inode(file
)), count
);
159 ret
= i2c_master_recv(client
, tmp
, count
);
161 ret
= copy_to_user(buf
, tmp
, count
) ? -EFAULT
: ret
;
166 static ssize_t
i2cdev_write(struct file
*file
, const char __user
*buf
,
167 size_t count
, loff_t
*offset
)
171 struct i2c_client
*client
= file
->private_data
;
176 tmp
= memdup_user(buf
, count
);
180 pr_debug("i2c-dev: i2c-%d writing %zu bytes.\n",
181 iminor(file_inode(file
)), count
);
183 ret
= i2c_master_send(client
, tmp
, count
);
188 static int i2cdev_check(struct device
*dev
, void *addrp
)
190 struct i2c_client
*client
= i2c_verify_client(dev
);
192 if (!client
|| client
->addr
!= *(unsigned int *)addrp
)
195 return dev
->driver
? -EBUSY
: 0;
198 /* walk up mux tree */
199 static int i2cdev_check_mux_parents(struct i2c_adapter
*adapter
, int addr
)
201 struct i2c_adapter
*parent
= i2c_parent_is_i2c_adapter(adapter
);
204 result
= device_for_each_child(&adapter
->dev
, &addr
, i2cdev_check
);
205 if (!result
&& parent
)
206 result
= i2cdev_check_mux_parents(parent
, addr
);
211 /* recurse down mux tree */
212 static int i2cdev_check_mux_children(struct device
*dev
, void *addrp
)
216 if (dev
->type
== &i2c_adapter_type
)
217 result
= device_for_each_child(dev
, addrp
,
218 i2cdev_check_mux_children
);
220 result
= i2cdev_check(dev
, addrp
);
225 /* This address checking function differs from the one in i2c-core
226 in that it considers an address with a registered device, but no
227 driver bound to it, as NOT busy. */
228 static int i2cdev_check_addr(struct i2c_adapter
*adapter
, unsigned int addr
)
230 struct i2c_adapter
*parent
= i2c_parent_is_i2c_adapter(adapter
);
234 result
= i2cdev_check_mux_parents(parent
, addr
);
237 result
= device_for_each_child(&adapter
->dev
, &addr
,
238 i2cdev_check_mux_children
);
243 static noinline
int i2cdev_ioctl_rdwr(struct i2c_client
*client
,
244 unsigned nmsgs
, struct i2c_msg
*msgs
)
246 u8 __user
**data_ptrs
;
249 data_ptrs
= kmalloc_array(nmsgs
, sizeof(u8 __user
*), GFP_KERNEL
);
250 if (data_ptrs
== NULL
) {
256 for (i
= 0; i
< nmsgs
; i
++) {
257 /* Limit the size of the message to a sane amount */
258 if (msgs
[i
].len
> 8192) {
263 data_ptrs
[i
] = (u8 __user
*)msgs
[i
].buf
;
264 msgs
[i
].buf
= memdup_user(data_ptrs
[i
], msgs
[i
].len
);
265 if (IS_ERR(msgs
[i
].buf
)) {
266 res
= PTR_ERR(msgs
[i
].buf
);
269 /* memdup_user allocates with GFP_KERNEL, so DMA is ok */
270 msgs
[i
].flags
|= I2C_M_DMA_SAFE
;
273 * If the message length is received from the slave (similar
274 * to SMBus block read), we must ensure that the buffer will
275 * be large enough to cope with a message length of
276 * I2C_SMBUS_BLOCK_MAX as this is the maximum underlying bus
277 * drivers allow. The first byte in the buffer must be
278 * pre-filled with the number of extra bytes, which must be
279 * at least one to hold the message length, but can be
280 * greater (for example to account for a checksum byte at
281 * the end of the message.)
283 if (msgs
[i
].flags
& I2C_M_RECV_LEN
) {
284 if (!(msgs
[i
].flags
& I2C_M_RD
) ||
285 msgs
[i
].len
< 1 || msgs
[i
].buf
[0] < 1 ||
286 msgs
[i
].len
< msgs
[i
].buf
[0] +
287 I2C_SMBUS_BLOCK_MAX
) {
293 msgs
[i
].len
= msgs
[i
].buf
[0];
298 for (j
= 0; j
< i
; ++j
)
305 res
= i2c_transfer(client
->adapter
, msgs
, nmsgs
);
307 if (res
>= 0 && (msgs
[i
].flags
& I2C_M_RD
)) {
308 if (copy_to_user(data_ptrs
[i
], msgs
[i
].buf
,
319 static noinline
int i2cdev_ioctl_smbus(struct i2c_client
*client
,
320 u8 read_write
, u8 command
, u32 size
,
321 union i2c_smbus_data __user
*data
)
323 union i2c_smbus_data temp
= {};
326 if ((size
!= I2C_SMBUS_BYTE
) &&
327 (size
!= I2C_SMBUS_QUICK
) &&
328 (size
!= I2C_SMBUS_BYTE_DATA
) &&
329 (size
!= I2C_SMBUS_WORD_DATA
) &&
330 (size
!= I2C_SMBUS_PROC_CALL
) &&
331 (size
!= I2C_SMBUS_BLOCK_DATA
) &&
332 (size
!= I2C_SMBUS_I2C_BLOCK_BROKEN
) &&
333 (size
!= I2C_SMBUS_I2C_BLOCK_DATA
) &&
334 (size
!= I2C_SMBUS_BLOCK_PROC_CALL
)) {
335 dev_dbg(&client
->adapter
->dev
,
336 "size out of range (%x) in ioctl I2C_SMBUS.\n",
340 /* Note that I2C_SMBUS_READ and I2C_SMBUS_WRITE are 0 and 1,
341 so the check is valid if size==I2C_SMBUS_QUICK too. */
342 if ((read_write
!= I2C_SMBUS_READ
) &&
343 (read_write
!= I2C_SMBUS_WRITE
)) {
344 dev_dbg(&client
->adapter
->dev
,
345 "read_write out of range (%x) in ioctl I2C_SMBUS.\n",
350 /* Note that command values are always valid! */
352 if ((size
== I2C_SMBUS_QUICK
) ||
353 ((size
== I2C_SMBUS_BYTE
) &&
354 (read_write
== I2C_SMBUS_WRITE
)))
355 /* These are special: we do not use data */
356 return i2c_smbus_xfer(client
->adapter
, client
->addr
,
357 client
->flags
, read_write
,
358 command
, size
, NULL
);
361 dev_dbg(&client
->adapter
->dev
,
362 "data is NULL pointer in ioctl I2C_SMBUS.\n");
366 if ((size
== I2C_SMBUS_BYTE_DATA
) ||
367 (size
== I2C_SMBUS_BYTE
))
368 datasize
= sizeof(data
->byte
);
369 else if ((size
== I2C_SMBUS_WORD_DATA
) ||
370 (size
== I2C_SMBUS_PROC_CALL
))
371 datasize
= sizeof(data
->word
);
372 else /* size == smbus block, i2c block, or block proc. call */
373 datasize
= sizeof(data
->block
);
375 if ((size
== I2C_SMBUS_PROC_CALL
) ||
376 (size
== I2C_SMBUS_BLOCK_PROC_CALL
) ||
377 (size
== I2C_SMBUS_I2C_BLOCK_DATA
) ||
378 (read_write
== I2C_SMBUS_WRITE
)) {
379 if (copy_from_user(&temp
, data
, datasize
))
382 if (size
== I2C_SMBUS_I2C_BLOCK_BROKEN
) {
383 /* Convert old I2C block commands to the new
384 convention. This preserves binary compatibility. */
385 size
= I2C_SMBUS_I2C_BLOCK_DATA
;
386 if (read_write
== I2C_SMBUS_READ
)
387 temp
.block
[0] = I2C_SMBUS_BLOCK_MAX
;
389 res
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
390 read_write
, command
, size
, &temp
);
391 if (!res
&& ((size
== I2C_SMBUS_PROC_CALL
) ||
392 (size
== I2C_SMBUS_BLOCK_PROC_CALL
) ||
393 (read_write
== I2C_SMBUS_READ
))) {
394 if (copy_to_user(data
, &temp
, datasize
))
400 static long i2cdev_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
402 struct i2c_client
*client
= file
->private_data
;
405 dev_dbg(&client
->adapter
->dev
, "ioctl, cmd=0x%02x, arg=0x%02lx\n",
410 case I2C_SLAVE_FORCE
:
412 (((client
->flags
& I2C_M_TEN
) == 0) && arg
> 0x7f))
414 if (cmd
== I2C_SLAVE
&& i2cdev_check_addr(client
->adapter
, arg
))
416 /* REVISIT: address could become busy later */
421 client
->flags
|= I2C_M_TEN
;
423 client
->flags
&= ~I2C_M_TEN
;
427 * Setting the PEC flag here won't affect kernel drivers,
428 * which will be using the i2c_client node registered with
429 * the driver model core. Likewise, when that client has
430 * the PEC flag already set, the i2c-dev driver won't see
431 * (or use) this setting.
434 client
->flags
|= I2C_CLIENT_PEC
;
436 client
->flags
&= ~I2C_CLIENT_PEC
;
439 funcs
= i2c_get_functionality(client
->adapter
);
440 return put_user(funcs
, (unsigned long __user
*)arg
);
443 struct i2c_rdwr_ioctl_data rdwr_arg
;
444 struct i2c_msg
*rdwr_pa
;
446 if (copy_from_user(&rdwr_arg
,
447 (struct i2c_rdwr_ioctl_data __user
*)arg
,
451 /* Put an arbitrary limit on the number of messages that can
453 if (rdwr_arg
.nmsgs
> I2C_RDWR_IOCTL_MAX_MSGS
)
456 rdwr_pa
= memdup_user(rdwr_arg
.msgs
,
457 rdwr_arg
.nmsgs
* sizeof(struct i2c_msg
));
459 return PTR_ERR(rdwr_pa
);
461 return i2cdev_ioctl_rdwr(client
, rdwr_arg
.nmsgs
, rdwr_pa
);
465 struct i2c_smbus_ioctl_data data_arg
;
466 if (copy_from_user(&data_arg
,
467 (struct i2c_smbus_ioctl_data __user
*) arg
,
468 sizeof(struct i2c_smbus_ioctl_data
)))
470 return i2cdev_ioctl_smbus(client
, data_arg
.read_write
,
479 client
->adapter
->retries
= arg
;
485 /* For historical reasons, user-space sets the timeout
486 * value in units of 10 ms.
488 client
->adapter
->timeout
= msecs_to_jiffies(arg
* 10);
491 /* NOTE: returning a fault code here could cause trouble
492 * in buggy userspace code. Some old kernel bugs returned
493 * zero in this case, and userspace code might accidentally
494 * have depended on that bug.
503 struct i2c_smbus_ioctl_data32
{
507 compat_caddr_t data
; /* union i2c_smbus_data *data */
517 struct i2c_rdwr_ioctl_data32
{
518 compat_caddr_t msgs
; /* struct i2c_msg __user *msgs */
522 static long compat_i2cdev_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
524 struct i2c_client
*client
= file
->private_data
;
528 funcs
= i2c_get_functionality(client
->adapter
);
529 return put_user(funcs
, (compat_ulong_t __user
*)arg
);
531 struct i2c_rdwr_ioctl_data32 rdwr_arg
;
533 struct i2c_msg
*rdwr_pa
;
536 if (copy_from_user(&rdwr_arg
,
537 (struct i2c_rdwr_ioctl_data32 __user
*)arg
,
541 if (rdwr_arg
.nmsgs
> I2C_RDWR_IOCTL_MAX_MSGS
)
544 rdwr_pa
= kmalloc_array(rdwr_arg
.nmsgs
, sizeof(struct i2c_msg
),
549 p
= compat_ptr(rdwr_arg
.msgs
);
550 for (i
= 0; i
< rdwr_arg
.nmsgs
; i
++) {
551 struct i2c_msg32 umsg
;
552 if (copy_from_user(&umsg
, p
+ i
, sizeof(umsg
))) {
556 rdwr_pa
[i
] = (struct i2c_msg
) {
560 .buf
= compat_ptr(umsg
.buf
)
564 return i2cdev_ioctl_rdwr(client
, rdwr_arg
.nmsgs
, rdwr_pa
);
567 struct i2c_smbus_ioctl_data32 data32
;
568 if (copy_from_user(&data32
,
572 return i2cdev_ioctl_smbus(client
, data32
.read_write
,
575 compat_ptr(data32
.data
));
578 return i2cdev_ioctl(file
, cmd
, arg
);
582 #define compat_i2cdev_ioctl NULL
585 static int i2cdev_open(struct inode
*inode
, struct file
*file
)
587 unsigned int minor
= iminor(inode
);
588 struct i2c_client
*client
;
589 struct i2c_adapter
*adap
;
591 adap
= i2c_get_adapter(minor
);
595 /* This creates an anonymous i2c_client, which may later be
596 * pointed to some address using I2C_SLAVE or I2C_SLAVE_FORCE.
598 * This client is ** NEVER REGISTERED ** with the driver model
599 * or I2C core code!! It just holds private copies of addressing
600 * information and maybe a PEC flag.
602 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
604 i2c_put_adapter(adap
);
607 snprintf(client
->name
, I2C_NAME_SIZE
, "i2c-dev %d", adap
->nr
);
609 client
->adapter
= adap
;
610 file
->private_data
= client
;
615 static int i2cdev_release(struct inode
*inode
, struct file
*file
)
617 struct i2c_client
*client
= file
->private_data
;
619 i2c_put_adapter(client
->adapter
);
621 file
->private_data
= NULL
;
626 static const struct file_operations i2cdev_fops
= {
627 .owner
= THIS_MODULE
,
630 .write
= i2cdev_write
,
631 .unlocked_ioctl
= i2cdev_ioctl
,
632 .compat_ioctl
= compat_i2cdev_ioctl
,
634 .release
= i2cdev_release
,
637 /* ------------------------------------------------------------------------- */
639 static struct class *i2c_dev_class
;
641 static void i2cdev_dev_release(struct device
*dev
)
643 struct i2c_dev
*i2c_dev
;
645 i2c_dev
= container_of(dev
, struct i2c_dev
, dev
);
649 static int i2cdev_attach_adapter(struct device
*dev
, void *dummy
)
651 struct i2c_adapter
*adap
;
652 struct i2c_dev
*i2c_dev
;
655 if (dev
->type
!= &i2c_adapter_type
)
657 adap
= to_i2c_adapter(dev
);
659 i2c_dev
= get_free_i2c_dev(adap
);
661 return PTR_ERR(i2c_dev
);
663 cdev_init(&i2c_dev
->cdev
, &i2cdev_fops
);
664 i2c_dev
->cdev
.owner
= THIS_MODULE
;
666 device_initialize(&i2c_dev
->dev
);
667 i2c_dev
->dev
.devt
= MKDEV(I2C_MAJOR
, adap
->nr
);
668 i2c_dev
->dev
.class = i2c_dev_class
;
669 i2c_dev
->dev
.parent
= &adap
->dev
;
670 i2c_dev
->dev
.release
= i2cdev_dev_release
;
671 dev_set_name(&i2c_dev
->dev
, "i2c-%d", adap
->nr
);
673 res
= cdev_device_add(&i2c_dev
->cdev
, &i2c_dev
->dev
);
675 put_i2c_dev(i2c_dev
, false);
679 pr_debug("i2c-dev: adapter [%s] registered as minor %d\n",
680 adap
->name
, adap
->nr
);
684 static int i2cdev_detach_adapter(struct device
*dev
, void *dummy
)
686 struct i2c_adapter
*adap
;
687 struct i2c_dev
*i2c_dev
;
689 if (dev
->type
!= &i2c_adapter_type
)
691 adap
= to_i2c_adapter(dev
);
693 i2c_dev
= i2c_dev_get_by_minor(adap
->nr
);
694 if (!i2c_dev
) /* attach_adapter must have failed */
697 put_i2c_dev(i2c_dev
, true);
699 pr_debug("i2c-dev: adapter [%s] unregistered\n", adap
->name
);
703 static int i2cdev_notifier_call(struct notifier_block
*nb
, unsigned long action
,
706 struct device
*dev
= data
;
709 case BUS_NOTIFY_ADD_DEVICE
:
710 return i2cdev_attach_adapter(dev
, NULL
);
711 case BUS_NOTIFY_DEL_DEVICE
:
712 return i2cdev_detach_adapter(dev
, NULL
);
718 static struct notifier_block i2cdev_notifier
= {
719 .notifier_call
= i2cdev_notifier_call
,
722 /* ------------------------------------------------------------------------- */
725 * module load/unload record keeping
728 static int __init
i2c_dev_init(void)
732 printk(KERN_INFO
"i2c /dev entries driver\n");
734 res
= register_chrdev_region(MKDEV(I2C_MAJOR
, 0), I2C_MINORS
, "i2c");
738 i2c_dev_class
= class_create(THIS_MODULE
, "i2c-dev");
739 if (IS_ERR(i2c_dev_class
)) {
740 res
= PTR_ERR(i2c_dev_class
);
741 goto out_unreg_chrdev
;
743 i2c_dev_class
->dev_groups
= i2c_groups
;
745 /* Keep track of adapters which will be added or removed later */
746 res
= bus_register_notifier(&i2c_bus_type
, &i2cdev_notifier
);
748 goto out_unreg_class
;
750 /* Bind to already existing adapters right away */
751 i2c_for_each_dev(NULL
, i2cdev_attach_adapter
);
756 class_destroy(i2c_dev_class
);
758 unregister_chrdev_region(MKDEV(I2C_MAJOR
, 0), I2C_MINORS
);
760 printk(KERN_ERR
"%s: Driver Initialisation failed\n", __FILE__
);
764 static void __exit
i2c_dev_exit(void)
766 bus_unregister_notifier(&i2c_bus_type
, &i2cdev_notifier
);
767 i2c_for_each_dev(NULL
, i2cdev_detach_adapter
);
768 class_destroy(i2c_dev_class
);
769 unregister_chrdev_region(MKDEV(I2C_MAJOR
, 0), I2C_MINORS
);
772 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
773 "Simon G. Vogl <simon@tk.uni-linz.ac.at>");
774 MODULE_DESCRIPTION("I2C /dev entries driver");
775 MODULE_LICENSE("GPL");
777 module_init(i2c_dev_init
);
778 module_exit(i2c_dev_exit
);