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.
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., 51 Franklin Street, Fifth Floor, Boston,
24 /* Note that this is a complete rewrite of Simon Vogl's i2c-dev module.
25 But I have used so much of his original code and ideas that it seems
26 only fair to recognize him as co-author -- Frodo */
28 /* The I2C_RDWR ioctl code is written by Kolja Waschk <waschk@telos.de> */
30 #include <linux/kernel.h>
31 #include <linux/module.h>
32 #include <linux/device.h>
33 #include <linux/notifier.h>
35 #include <linux/slab.h>
36 #include <linux/init.h>
37 #include <linux/list.h>
38 #include <linux/i2c.h>
39 #include <linux/i2c-dev.h>
40 #include <linux/jiffies.h>
41 #include <linux/uaccess.h>
44 * An i2c_dev represents an i2c_adapter ... an I2C or SMBus master, not a
45 * slave (i2c_client) with which messages will be exchanged. It's coupled
46 * with a character special file which is accessed by user mode drivers.
48 * The list of i2c_dev structures is parallel to the i2c_adapter lists
49 * maintained by the driver model, and is updated using bus notifications.
52 struct list_head list
;
53 struct i2c_adapter
*adap
;
57 #define I2C_MINORS 256
58 static LIST_HEAD(i2c_dev_list
);
59 static DEFINE_SPINLOCK(i2c_dev_list_lock
);
61 static struct i2c_dev
*i2c_dev_get_by_minor(unsigned index
)
63 struct i2c_dev
*i2c_dev
;
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
)
72 spin_unlock(&i2c_dev_list_lock
);
76 static struct i2c_dev
*get_free_i2c_dev(struct i2c_adapter
*adap
)
78 struct i2c_dev
*i2c_dev
;
80 if (adap
->nr
>= I2C_MINORS
) {
81 printk(KERN_ERR
"i2c-dev: Out of device minors (%d)\n",
83 return ERR_PTR(-ENODEV
);
86 i2c_dev
= kzalloc(sizeof(*i2c_dev
), GFP_KERNEL
);
88 return ERR_PTR(-ENOMEM
);
91 spin_lock(&i2c_dev_list_lock
);
92 list_add_tail(&i2c_dev
->list
, &i2c_dev_list
);
93 spin_unlock(&i2c_dev_list_lock
);
97 static void return_i2c_dev(struct i2c_dev
*i2c_dev
)
99 spin_lock(&i2c_dev_list_lock
);
100 list_del(&i2c_dev
->list
);
101 spin_unlock(&i2c_dev_list_lock
);
105 static ssize_t
show_adapter_name(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(name
, S_IRUGO
, show_adapter_name
, NULL
);
116 /* ------------------------------------------------------------------------- */
119 * After opening an instance of this character special file, a file
120 * descriptor starts out associated only with an i2c_adapter (and bus).
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.
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.
135 static ssize_t
i2cdev_read(struct file
*file
, char __user
*buf
, size_t count
,
141 struct i2c_client
*client
= file
->private_data
;
146 tmp
= kmalloc(count
, GFP_KERNEL
);
150 pr_debug("i2c-dev: i2c-%d reading %zu bytes.\n",
151 iminor(file_inode(file
)), count
);
153 ret
= i2c_master_recv(client
, tmp
, count
);
155 ret
= copy_to_user(buf
, tmp
, count
) ? -EFAULT
: ret
;
160 static ssize_t
i2cdev_write(struct file
*file
, const char __user
*buf
,
161 size_t count
, loff_t
*offset
)
165 struct i2c_client
*client
= file
->private_data
;
170 tmp
= memdup_user(buf
, count
);
174 pr_debug("i2c-dev: i2c-%d writing %zu bytes.\n",
175 iminor(file_inode(file
)), count
);
177 ret
= i2c_master_send(client
, tmp
, count
);
182 static int i2cdev_check(struct device
*dev
, void *addrp
)
184 struct i2c_client
*client
= i2c_verify_client(dev
);
186 if (!client
|| client
->addr
!= *(unsigned int *)addrp
)
189 return dev
->driver
? -EBUSY
: 0;
192 /* walk up mux tree */
193 static int i2cdev_check_mux_parents(struct i2c_adapter
*adapter
, int addr
)
195 struct i2c_adapter
*parent
= i2c_parent_is_i2c_adapter(adapter
);
198 result
= device_for_each_child(&adapter
->dev
, &addr
, i2cdev_check
);
199 if (!result
&& parent
)
200 result
= i2cdev_check_mux_parents(parent
, addr
);
205 /* recurse down mux tree */
206 static int i2cdev_check_mux_children(struct device
*dev
, void *addrp
)
210 if (dev
->type
== &i2c_adapter_type
)
211 result
= device_for_each_child(dev
, addrp
,
212 i2cdev_check_mux_children
);
214 result
= i2cdev_check(dev
, addrp
);
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
)
224 struct i2c_adapter
*parent
= i2c_parent_is_i2c_adapter(adapter
);
228 result
= i2cdev_check_mux_parents(parent
, addr
);
231 result
= device_for_each_child(&adapter
->dev
, &addr
,
232 i2cdev_check_mux_children
);
237 static noinline
int i2cdev_ioctl_rdrw(struct i2c_client
*client
,
240 struct i2c_rdwr_ioctl_data rdwr_arg
;
241 struct i2c_msg
*rdwr_pa
;
242 u8 __user
**data_ptrs
;
245 if (copy_from_user(&rdwr_arg
,
246 (struct i2c_rdwr_ioctl_data __user
*)arg
,
250 /* Put an arbitrary limit on the number of messages that can
252 if (rdwr_arg
.nmsgs
> I2C_RDRW_IOCTL_MAX_MSGS
)
255 rdwr_pa
= memdup_user(rdwr_arg
.msgs
,
256 rdwr_arg
.nmsgs
* sizeof(struct i2c_msg
));
258 return PTR_ERR(rdwr_pa
);
260 data_ptrs
= kmalloc(rdwr_arg
.nmsgs
* sizeof(u8 __user
*), GFP_KERNEL
);
261 if (data_ptrs
== NULL
) {
267 for (i
= 0; i
< rdwr_arg
.nmsgs
; i
++) {
268 /* Limit the size of the message to a sane amount */
269 if (rdwr_pa
[i
].len
> 8192) {
274 data_ptrs
[i
] = (u8 __user
*)rdwr_pa
[i
].buf
;
275 rdwr_pa
[i
].buf
= memdup_user(data_ptrs
[i
], rdwr_pa
[i
].len
);
276 if (IS_ERR(rdwr_pa
[i
].buf
)) {
277 res
= PTR_ERR(rdwr_pa
[i
].buf
);
282 * If the message length is received from the slave (similar
283 * to SMBus block read), we must ensure that the buffer will
284 * be large enough to cope with a message length of
285 * I2C_SMBUS_BLOCK_MAX as this is the maximum underlying bus
286 * drivers allow. The first byte in the buffer must be
287 * pre-filled with the number of extra bytes, which must be
288 * at least one to hold the message length, but can be
289 * greater (for example to account for a checksum byte at
290 * the end of the message.)
292 if (rdwr_pa
[i
].flags
& I2C_M_RECV_LEN
) {
293 if (!(rdwr_pa
[i
].flags
& I2C_M_RD
) ||
294 rdwr_pa
[i
].buf
[0] < 1 ||
295 rdwr_pa
[i
].len
< rdwr_pa
[i
].buf
[0] +
296 I2C_SMBUS_BLOCK_MAX
) {
301 rdwr_pa
[i
].len
= rdwr_pa
[i
].buf
[0];
306 for (j
= 0; j
< i
; ++j
)
307 kfree(rdwr_pa
[j
].buf
);
313 res
= i2c_transfer(client
->adapter
, rdwr_pa
, rdwr_arg
.nmsgs
);
315 if (res
>= 0 && (rdwr_pa
[i
].flags
& I2C_M_RD
)) {
316 if (copy_to_user(data_ptrs
[i
], rdwr_pa
[i
].buf
,
320 kfree(rdwr_pa
[i
].buf
);
327 static noinline
int i2cdev_ioctl_smbus(struct i2c_client
*client
,
330 struct i2c_smbus_ioctl_data data_arg
;
331 union i2c_smbus_data temp
;
334 if (copy_from_user(&data_arg
,
335 (struct i2c_smbus_ioctl_data __user
*) arg
,
336 sizeof(struct i2c_smbus_ioctl_data
)))
338 if ((data_arg
.size
!= I2C_SMBUS_BYTE
) &&
339 (data_arg
.size
!= I2C_SMBUS_QUICK
) &&
340 (data_arg
.size
!= I2C_SMBUS_BYTE_DATA
) &&
341 (data_arg
.size
!= I2C_SMBUS_WORD_DATA
) &&
342 (data_arg
.size
!= I2C_SMBUS_PROC_CALL
) &&
343 (data_arg
.size
!= I2C_SMBUS_BLOCK_DATA
) &&
344 (data_arg
.size
!= I2C_SMBUS_I2C_BLOCK_BROKEN
) &&
345 (data_arg
.size
!= I2C_SMBUS_I2C_BLOCK_DATA
) &&
346 (data_arg
.size
!= I2C_SMBUS_BLOCK_PROC_CALL
)) {
347 dev_dbg(&client
->adapter
->dev
,
348 "size out of range (%x) in ioctl I2C_SMBUS.\n",
352 /* Note that I2C_SMBUS_READ and I2C_SMBUS_WRITE are 0 and 1,
353 so the check is valid if size==I2C_SMBUS_QUICK too. */
354 if ((data_arg
.read_write
!= I2C_SMBUS_READ
) &&
355 (data_arg
.read_write
!= I2C_SMBUS_WRITE
)) {
356 dev_dbg(&client
->adapter
->dev
,
357 "read_write out of range (%x) in ioctl I2C_SMBUS.\n",
358 data_arg
.read_write
);
362 /* Note that command values are always valid! */
364 if ((data_arg
.size
== I2C_SMBUS_QUICK
) ||
365 ((data_arg
.size
== I2C_SMBUS_BYTE
) &&
366 (data_arg
.read_write
== I2C_SMBUS_WRITE
)))
367 /* These are special: we do not use data */
368 return i2c_smbus_xfer(client
->adapter
, client
->addr
,
369 client
->flags
, data_arg
.read_write
,
370 data_arg
.command
, data_arg
.size
, NULL
);
372 if (data_arg
.data
== NULL
) {
373 dev_dbg(&client
->adapter
->dev
,
374 "data is NULL pointer in ioctl I2C_SMBUS.\n");
378 if ((data_arg
.size
== I2C_SMBUS_BYTE_DATA
) ||
379 (data_arg
.size
== I2C_SMBUS_BYTE
))
380 datasize
= sizeof(data_arg
.data
->byte
);
381 else if ((data_arg
.size
== I2C_SMBUS_WORD_DATA
) ||
382 (data_arg
.size
== I2C_SMBUS_PROC_CALL
))
383 datasize
= sizeof(data_arg
.data
->word
);
384 else /* size == smbus block, i2c block, or block proc. call */
385 datasize
= sizeof(data_arg
.data
->block
);
387 if ((data_arg
.size
== I2C_SMBUS_PROC_CALL
) ||
388 (data_arg
.size
== I2C_SMBUS_BLOCK_PROC_CALL
) ||
389 (data_arg
.size
== I2C_SMBUS_I2C_BLOCK_DATA
) ||
390 (data_arg
.read_write
== I2C_SMBUS_WRITE
)) {
391 if (copy_from_user(&temp
, data_arg
.data
, datasize
))
394 if (data_arg
.size
== I2C_SMBUS_I2C_BLOCK_BROKEN
) {
395 /* Convert old I2C block commands to the new
396 convention. This preserves binary compatibility. */
397 data_arg
.size
= I2C_SMBUS_I2C_BLOCK_DATA
;
398 if (data_arg
.read_write
== I2C_SMBUS_READ
)
399 temp
.block
[0] = I2C_SMBUS_BLOCK_MAX
;
401 res
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
402 data_arg
.read_write
, data_arg
.command
, data_arg
.size
, &temp
);
403 if (!res
&& ((data_arg
.size
== I2C_SMBUS_PROC_CALL
) ||
404 (data_arg
.size
== I2C_SMBUS_BLOCK_PROC_CALL
) ||
405 (data_arg
.read_write
== I2C_SMBUS_READ
))) {
406 if (copy_to_user(data_arg
.data
, &temp
, datasize
))
412 static long i2cdev_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
414 struct i2c_client
*client
= file
->private_data
;
417 dev_dbg(&client
->adapter
->dev
, "ioctl, cmd=0x%02x, arg=0x%02lx\n",
422 case I2C_SLAVE_FORCE
:
423 /* NOTE: devices set up to work with "new style" drivers
424 * can't use I2C_SLAVE, even when the device node is not
425 * bound to a driver. Only I2C_SLAVE_FORCE will work.
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_M_TEN
) == 0) && arg
> 0x7f))
436 if (cmd
== I2C_SLAVE
&& i2cdev_check_addr(client
->adapter
, arg
))
438 /* REVISIT: address could become busy later */
443 client
->flags
|= I2C_M_TEN
;
445 client
->flags
&= ~I2C_M_TEN
;
449 client
->flags
|= I2C_CLIENT_PEC
;
451 client
->flags
&= ~I2C_CLIENT_PEC
;
454 funcs
= i2c_get_functionality(client
->adapter
);
455 return put_user(funcs
, (unsigned long __user
*)arg
);
458 return i2cdev_ioctl_rdrw(client
, arg
);
461 return i2cdev_ioctl_smbus(client
, arg
);
464 client
->adapter
->retries
= arg
;
467 /* For historical reasons, user-space sets the timeout
468 * value in units of 10 ms.
470 client
->adapter
->timeout
= msecs_to_jiffies(arg
* 10);
473 /* NOTE: returning a fault code here could cause trouble
474 * in buggy userspace code. Some old kernel bugs returned
475 * zero in this case, and userspace code might accidentally
476 * have depended on that bug.
483 static int i2cdev_open(struct inode
*inode
, struct file
*file
)
485 unsigned int minor
= iminor(inode
);
486 struct i2c_client
*client
;
487 struct i2c_adapter
*adap
;
488 struct i2c_dev
*i2c_dev
;
490 i2c_dev
= i2c_dev_get_by_minor(minor
);
494 adap
= i2c_get_adapter(i2c_dev
->adap
->nr
);
498 /* This creates an anonymous i2c_client, which may later be
499 * pointed to some address using I2C_SLAVE or I2C_SLAVE_FORCE.
501 * This client is ** NEVER REGISTERED ** with the driver model
502 * or I2C core code!! It just holds private copies of addressing
503 * information and maybe a PEC flag.
505 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
507 i2c_put_adapter(adap
);
510 snprintf(client
->name
, I2C_NAME_SIZE
, "i2c-dev %d", adap
->nr
);
512 client
->adapter
= adap
;
513 file
->private_data
= client
;
518 static int i2cdev_release(struct inode
*inode
, struct file
*file
)
520 struct i2c_client
*client
= file
->private_data
;
522 i2c_put_adapter(client
->adapter
);
524 file
->private_data
= NULL
;
529 static const struct file_operations i2cdev_fops
= {
530 .owner
= THIS_MODULE
,
533 .write
= i2cdev_write
,
534 .unlocked_ioctl
= i2cdev_ioctl
,
536 .release
= i2cdev_release
,
539 /* ------------------------------------------------------------------------- */
541 static struct class *i2c_dev_class
;
543 static int i2cdev_attach_adapter(struct device
*dev
, void *dummy
)
545 struct i2c_adapter
*adap
;
546 struct i2c_dev
*i2c_dev
;
549 if (dev
->type
!= &i2c_adapter_type
)
551 adap
= to_i2c_adapter(dev
);
553 i2c_dev
= get_free_i2c_dev(adap
);
555 return PTR_ERR(i2c_dev
);
557 /* register this i2c device with the driver core */
558 i2c_dev
->dev
= device_create(i2c_dev_class
, &adap
->dev
,
559 MKDEV(I2C_MAJOR
, adap
->nr
), NULL
,
561 if (IS_ERR(i2c_dev
->dev
)) {
562 res
= PTR_ERR(i2c_dev
->dev
);
565 res
= device_create_file(i2c_dev
->dev
, &dev_attr_name
);
569 pr_debug("i2c-dev: adapter [%s] registered as minor %d\n",
570 adap
->name
, adap
->nr
);
573 device_destroy(i2c_dev_class
, MKDEV(I2C_MAJOR
, adap
->nr
));
575 return_i2c_dev(i2c_dev
);
579 static int i2cdev_detach_adapter(struct device
*dev
, void *dummy
)
581 struct i2c_adapter
*adap
;
582 struct i2c_dev
*i2c_dev
;
584 if (dev
->type
!= &i2c_adapter_type
)
586 adap
= to_i2c_adapter(dev
);
588 i2c_dev
= i2c_dev_get_by_minor(adap
->nr
);
589 if (!i2c_dev
) /* attach_adapter must have failed */
592 device_remove_file(i2c_dev
->dev
, &dev_attr_name
);
593 return_i2c_dev(i2c_dev
);
594 device_destroy(i2c_dev_class
, MKDEV(I2C_MAJOR
, adap
->nr
));
596 pr_debug("i2c-dev: adapter [%s] unregistered\n", adap
->name
);
600 static int i2cdev_notifier_call(struct notifier_block
*nb
, unsigned long action
,
603 struct device
*dev
= data
;
606 case BUS_NOTIFY_ADD_DEVICE
:
607 return i2cdev_attach_adapter(dev
, NULL
);
608 case BUS_NOTIFY_DEL_DEVICE
:
609 return i2cdev_detach_adapter(dev
, NULL
);
615 static struct notifier_block i2cdev_notifier
= {
616 .notifier_call
= i2cdev_notifier_call
,
619 /* ------------------------------------------------------------------------- */
622 * module load/unload record keeping
625 static int __init
i2c_dev_init(void)
629 printk(KERN_INFO
"i2c /dev entries driver\n");
631 res
= register_chrdev(I2C_MAJOR
, "i2c", &i2cdev_fops
);
635 i2c_dev_class
= class_create(THIS_MODULE
, "i2c-dev");
636 if (IS_ERR(i2c_dev_class
)) {
637 res
= PTR_ERR(i2c_dev_class
);
638 goto out_unreg_chrdev
;
641 /* Keep track of adapters which will be added or removed later */
642 res
= bus_register_notifier(&i2c_bus_type
, &i2cdev_notifier
);
644 goto out_unreg_class
;
646 /* Bind to already existing adapters right away */
647 i2c_for_each_dev(NULL
, i2cdev_attach_adapter
);
652 class_destroy(i2c_dev_class
);
654 unregister_chrdev(I2C_MAJOR
, "i2c");
656 printk(KERN_ERR
"%s: Driver Initialisation failed\n", __FILE__
);
660 static void __exit
i2c_dev_exit(void)
662 bus_unregister_notifier(&i2c_bus_type
, &i2cdev_notifier
);
663 i2c_for_each_dev(NULL
, i2cdev_detach_adapter
);
664 class_destroy(i2c_dev_class
);
665 unregister_chrdev(I2C_MAJOR
, "i2c");
668 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
669 "Simon G. Vogl <simon@tk.uni-linz.ac.at>");
670 MODULE_DESCRIPTION("I2C /dev entries driver");
671 MODULE_LICENSE("GPL");
673 module_init(i2c_dev_init
);
674 module_exit(i2c_dev_exit
);