1 /* i2c-core.c - a device driver for the iic-bus interface */
2 /* ------------------------------------------------------------------------- */
3 /* Copyright (C) 1995-99 Simon G. Vogl
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
18 /* ------------------------------------------------------------------------- */
20 /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
21 All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
22 SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
23 Jean Delvare <khali@linux-fr.org> */
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/errno.h>
28 #include <linux/slab.h>
29 #include <linux/i2c.h>
30 #include <linux/init.h>
31 #include <linux/idr.h>
32 #include <linux/seq_file.h>
33 #include <linux/platform_device.h>
34 #include <linux/mutex.h>
35 #include <linux/completion.h>
36 #include <asm/uaccess.h>
41 static LIST_HEAD(adapters);
42 static LIST_HEAD(drivers);
43 static DEFINE_MUTEX(core_lists);
44 static DEFINE_IDR(i2c_adapter_idr);
46 #define is_newstyle_driver(d) ((d)->probe || (d)->remove)
48 /* ------------------------------------------------------------------------- */
50 static int i2c_device_match(struct device *dev, struct device_driver *drv)
52 struct i2c_client *client = to_i2c_client(dev);
53 struct i2c_driver *driver = to_i2c_driver(drv);
55 /* make legacy i2c drivers bypass driver model probing entirely;
56 * such drivers scan each i2c adapter/bus themselves.
58 if (!is_newstyle_driver(driver))
61 /* new style drivers use the same kind of driver matching policy
62 * as platform devices or SPI: compare device and driver IDs.
64 return strcmp(client->driver_name, drv->name) == 0;
69 /* uevent helps with hotplug: modprobe -q $(MODALIAS) */
70 static int i2c_device_uevent(struct device *dev, char **envp, int num_envp,
71 char *buffer, int buffer_size)
73 struct i2c_client *client = to_i2c_client(dev);
74 int i = 0, length = 0;
76 /* by definition, legacy drivers can't hotplug */
77 if (dev->driver || !client->driver_name)
80 if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &length,
81 "MODALIAS=%s", client->driver_name))
84 dev_dbg(dev, "uevent\n");
89 #define i2c_device_uevent NULL
90 #endif /* CONFIG_HOTPLUG */
92 static int i2c_device_probe(struct device *dev)
94 struct i2c_client *client = to_i2c_client(dev);
95 struct i2c_driver *driver = to_i2c_driver(dev->driver);
99 client->driver = driver;
100 dev_dbg(dev, "probe\n");
101 return driver->probe(client);
104 static int i2c_device_remove(struct device *dev)
106 struct i2c_client *client = to_i2c_client(dev);
107 struct i2c_driver *driver;
113 driver = to_i2c_driver(dev->driver);
114 if (driver->remove) {
115 dev_dbg(dev, "remove\n");
116 status = driver->remove(client);
122 client->driver = NULL;
126 static void i2c_device_shutdown(struct device *dev)
128 struct i2c_driver *driver;
132 driver = to_i2c_driver(dev->driver);
133 if (driver->shutdown)
134 driver->shutdown(to_i2c_client(dev));
137 static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
139 struct i2c_driver *driver;
143 driver = to_i2c_driver(dev->driver);
144 if (!driver->suspend)
146 return driver->suspend(to_i2c_client(dev), mesg);
149 static int i2c_device_resume(struct device * dev)
151 struct i2c_driver *driver;
155 driver = to_i2c_driver(dev->driver);
158 return driver->resume(to_i2c_client(dev));
161 static void i2c_client_release(struct device *dev)
163 struct i2c_client *client = to_i2c_client(dev);
164 complete(&client->released);
167 static void i2c_client_dev_release(struct device *dev)
169 kfree(to_i2c_client(dev));
172 static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
174 struct i2c_client *client = to_i2c_client(dev);
175 return sprintf(buf, "%s\n", client->name);
178 static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
180 struct i2c_client *client = to_i2c_client(dev);
181 return client->driver_name
182 ? sprintf(buf, "%s\n", client->driver_name)
186 static struct device_attribute i2c_dev_attrs[] = {
187 __ATTR(name, S_IRUGO, show_client_name, NULL),
188 /* modalias helps coldplug: modprobe $(cat .../modalias) */
189 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
193 struct bus_type i2c_bus_type = {
195 .dev_attrs = i2c_dev_attrs,
196 .match = i2c_device_match,
197 .uevent = i2c_device_uevent,
198 .probe = i2c_device_probe,
199 .remove = i2c_device_remove,
200 .shutdown = i2c_device_shutdown,
201 .suspend = i2c_device_suspend,
202 .resume = i2c_device_resume,
204 EXPORT_SYMBOL_GPL(i2c_bus_type);
207 * i2c_new_device - instantiate an i2c device for use with a new style driver
208 * @adap: the adapter managing the device
209 * @info: describes one I2C device; bus_num is ignored
211 * Create a device to work with a new style i2c driver, where binding is
212 * handled through driver model probe()/remove() methods. This call is not
213 * appropriate for use by mainboad initialization logic, which usually runs
214 * during an arch_initcall() long before any i2c_adapter could exist.
216 * This returns the new i2c client, which may be saved for later use with
217 * i2c_unregister_device(); or NULL to indicate an error.
220 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
222 struct i2c_client *client;
225 client = kzalloc(sizeof *client, GFP_KERNEL);
229 client->adapter = adap;
231 client->dev.platform_data = info->platform_data;
232 client->flags = info->flags;
233 client->addr = info->addr;
234 client->irq = info->irq;
236 strlcpy(client->driver_name, info->driver_name,
237 sizeof(client->driver_name));
238 strlcpy(client->name, info->type, sizeof(client->name));
240 /* a new style driver may be bound to this device when we
241 * return from this function, or any later moment (e.g. maybe
242 * hotplugging will load the driver module). and the device
243 * refcount model is the standard driver model one.
245 status = i2c_attach_client(client);
252 EXPORT_SYMBOL_GPL(i2c_new_device);
256 * i2c_unregister_device - reverse effect of i2c_new_device()
257 * @client: value returned from i2c_new_device()
259 void i2c_unregister_device(struct i2c_client *client)
261 struct i2c_adapter *adapter = client->adapter;
262 struct i2c_driver *driver = client->driver;
264 if (driver && !is_newstyle_driver(driver)) {
265 dev_err(&client->dev, "can't unregister devices "
266 "with legacy drivers\n");
271 mutex_lock(&adapter->clist_lock);
272 list_del(&client->list);
273 mutex_unlock(&adapter->clist_lock);
275 device_unregister(&client->dev);
277 EXPORT_SYMBOL_GPL(i2c_unregister_device);
280 /* ------------------------------------------------------------------------- */
282 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
284 void i2c_adapter_dev_release(struct device *dev)
286 struct i2c_adapter *adap = to_i2c_adapter(dev);
287 complete(&adap->dev_released);
289 EXPORT_SYMBOL_GPL(i2c_adapter_dev_release); /* exported to i2c-isa */
292 show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
294 struct i2c_adapter *adap = to_i2c_adapter(dev);
295 return sprintf(buf, "%s\n", adap->name);
298 static struct device_attribute i2c_adapter_attrs[] = {
299 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
303 struct class i2c_adapter_class = {
304 .owner = THIS_MODULE,
305 .name = "i2c-adapter",
306 .dev_attrs = i2c_adapter_attrs,
308 EXPORT_SYMBOL_GPL(i2c_adapter_class); /* exported to i2c-isa */
310 static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
312 struct i2c_devinfo *devinfo;
314 mutex_lock(&__i2c_board_lock);
315 list_for_each_entry(devinfo, &__i2c_board_list, list) {
316 if (devinfo->busnum == adapter->nr
317 && !i2c_new_device(adapter,
318 &devinfo->board_info))
319 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
320 i2c_adapter_id(adapter),
321 devinfo->board_info.addr);
323 mutex_unlock(&__i2c_board_lock);
326 static int i2c_register_adapter(struct i2c_adapter *adap)
329 struct list_head *item;
330 struct i2c_driver *driver;
332 mutex_init(&adap->bus_lock);
333 mutex_init(&adap->clist_lock);
334 INIT_LIST_HEAD(&adap->clients);
336 mutex_lock(&core_lists);
337 list_add_tail(&adap->list, &adapters);
339 /* Add the adapter to the driver core.
340 * If the parent pointer is not set up,
341 * we add this adapter to the host bus.
343 if (adap->dev.parent == NULL) {
344 adap->dev.parent = &platform_bus;
345 pr_debug("I2C adapter driver [%s] forgot to specify "
346 "physical device\n", adap->name);
348 sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
349 adap->dev.release = &i2c_adapter_dev_release;
350 adap->dev.class = &i2c_adapter_class;
351 res = device_register(&adap->dev);
355 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
357 /* create pre-declared device nodes for new-style drivers */
358 if (adap->nr < __i2c_first_dynamic_bus_num)
359 i2c_scan_static_board_info(adap);
361 /* let legacy drivers scan this bus for matching devices */
362 list_for_each(item,&drivers) {
363 driver = list_entry(item, struct i2c_driver, list);
364 if (driver->attach_adapter)
365 /* We ignore the return code; if it fails, too bad */
366 driver->attach_adapter(adap);
370 mutex_unlock(&core_lists);
374 list_del(&adap->list);
375 idr_remove(&i2c_adapter_idr, adap->nr);
380 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
381 * @adapter: the adapter to add
383 * This routine is used to declare an I2C adapter when its bus number
384 * doesn't matter. Examples: for I2C adapters dynamically added by
385 * USB links or PCI plugin cards.
387 * When this returns zero, a new bus number was allocated and stored
388 * in adap->nr, and the specified adapter became available for clients.
389 * Otherwise, a negative errno value is returned.
391 int i2c_add_adapter(struct i2c_adapter *adapter)
396 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
399 mutex_lock(&core_lists);
400 /* "above" here means "above or equal to", sigh */
401 res = idr_get_new_above(&i2c_adapter_idr, adapter,
402 __i2c_first_dynamic_bus_num, &id);
403 mutex_unlock(&core_lists);
412 return i2c_register_adapter(adapter);
414 EXPORT_SYMBOL(i2c_add_adapter);
417 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
418 * @adap: the adapter to register (with adap->nr initialized)
420 * This routine is used to declare an I2C adapter when its bus number
421 * matters. Example: for I2C adapters from system-on-chip CPUs, or
422 * otherwise built in to the system's mainboard, and where i2c_board_info
423 * is used to properly configure I2C devices.
425 * If no devices have pre-been declared for this bus, then be sure to
426 * register the adapter before any dynamically allocated ones. Otherwise
427 * the required bus ID may not be available.
429 * When this returns zero, the specified adapter became available for
430 * clients using the bus number provided in adap->nr. Also, the table
431 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
432 * and the appropriate driver model device nodes are created. Otherwise, a
433 * negative errno value is returned.
435 int i2c_add_numbered_adapter(struct i2c_adapter *adap)
440 if (adap->nr & ~MAX_ID_MASK)
444 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
447 mutex_lock(&core_lists);
448 /* "above" here means "above or equal to", sigh;
449 * we need the "equal to" result to force the result
451 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
452 if (status == 0 && id != adap->nr) {
454 idr_remove(&i2c_adapter_idr, id);
456 mutex_unlock(&core_lists);
457 if (status == -EAGAIN)
461 status = i2c_register_adapter(adap);
464 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
466 int i2c_del_adapter(struct i2c_adapter *adap)
468 struct list_head *item, *_n;
469 struct i2c_adapter *adap_from_list;
470 struct i2c_driver *driver;
471 struct i2c_client *client;
474 mutex_lock(&core_lists);
476 /* First make sure that this adapter was ever added */
477 list_for_each_entry(adap_from_list, &adapters, list) {
478 if (adap_from_list == adap)
481 if (adap_from_list != adap) {
482 pr_debug("i2c-core: attempting to delete unregistered "
483 "adapter [%s]\n", adap->name);
488 list_for_each(item,&drivers) {
489 driver = list_entry(item, struct i2c_driver, list);
490 if (driver->detach_adapter)
491 if ((res = driver->detach_adapter(adap))) {
492 dev_err(&adap->dev, "detach_adapter failed "
494 driver->driver.name);
499 /* detach any active clients. This must be done first, because
500 * it can fail; in which case we give up. */
501 list_for_each_safe(item, _n, &adap->clients) {
502 struct i2c_driver *driver;
504 client = list_entry(item, struct i2c_client, list);
505 driver = client->driver;
507 /* new style, follow standard driver model */
508 if (!driver || is_newstyle_driver(driver)) {
509 i2c_unregister_device(client);
513 /* legacy drivers create and remove clients themselves */
514 if ((res = driver->detach_client(client))) {
515 dev_err(&adap->dev, "detach_client failed for client "
516 "[%s] at address 0x%02x\n", client->name,
522 /* clean up the sysfs representation */
523 init_completion(&adap->dev_released);
524 device_unregister(&adap->dev);
525 list_del(&adap->list);
527 /* wait for sysfs to drop all references */
528 wait_for_completion(&adap->dev_released);
531 idr_remove(&i2c_adapter_idr, adap->nr);
533 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
536 mutex_unlock(&core_lists);
539 EXPORT_SYMBOL(i2c_del_adapter);
542 /* ------------------------------------------------------------------------- */
545 * An i2c_driver is used with one or more i2c_client (device) nodes to access
546 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
547 * are two models for binding the driver to its device: "new style" drivers
548 * follow the standard Linux driver model and just respond to probe() calls
549 * issued if the driver core sees they match(); "legacy" drivers create device
553 int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
557 /* new style driver methods can't mix with legacy ones */
558 if (is_newstyle_driver(driver)) {
559 if (driver->attach_adapter || driver->detach_adapter
560 || driver->detach_client) {
562 "i2c-core: driver [%s] is confused\n",
563 driver->driver.name);
568 /* add the driver to the list of i2c drivers in the driver core */
569 driver->driver.owner = owner;
570 driver->driver.bus = &i2c_bus_type;
572 /* for new style drivers, when registration returns the driver core
573 * will have called probe() for all matching-but-unbound devices.
575 res = driver_register(&driver->driver);
579 mutex_lock(&core_lists);
581 list_add_tail(&driver->list,&drivers);
582 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
584 /* legacy drivers scan i2c busses directly */
585 if (driver->attach_adapter) {
586 struct i2c_adapter *adapter;
588 list_for_each_entry(adapter, &adapters, list) {
589 driver->attach_adapter(adapter);
593 mutex_unlock(&core_lists);
596 EXPORT_SYMBOL(i2c_register_driver);
599 * i2c_del_driver - unregister I2C driver
600 * @driver: the driver being unregistered
602 void i2c_del_driver(struct i2c_driver *driver)
604 struct list_head *item1, *item2, *_n;
605 struct i2c_client *client;
606 struct i2c_adapter *adap;
608 mutex_lock(&core_lists);
610 /* new-style driver? */
611 if (is_newstyle_driver(driver))
614 /* Have a look at each adapter, if clients of this driver are still
615 * attached. If so, detach them to be able to kill the driver
618 list_for_each(item1,&adapters) {
619 adap = list_entry(item1, struct i2c_adapter, list);
620 if (driver->detach_adapter) {
621 if (driver->detach_adapter(adap)) {
622 dev_err(&adap->dev, "detach_adapter failed "
624 driver->driver.name);
627 list_for_each_safe(item2, _n, &adap->clients) {
628 client = list_entry(item2, struct i2c_client, list);
629 if (client->driver != driver)
631 dev_dbg(&adap->dev, "detaching client [%s] "
632 "at 0x%02x\n", client->name,
634 if (driver->detach_client(client)) {
635 dev_err(&adap->dev, "detach_client "
636 "failed for client [%s] at "
637 "0x%02x\n", client->name,
645 driver_unregister(&driver->driver);
646 list_del(&driver->list);
647 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
649 mutex_unlock(&core_lists);
651 EXPORT_SYMBOL(i2c_del_driver);
653 /* ------------------------------------------------------------------------- */
655 static int __i2c_check_addr(struct i2c_adapter *adapter, unsigned int addr)
657 struct list_head *item;
658 struct i2c_client *client;
660 list_for_each(item,&adapter->clients) {
661 client = list_entry(item, struct i2c_client, list);
662 if (client->addr == addr)
668 int i2c_check_addr(struct i2c_adapter *adapter, int addr)
672 mutex_lock(&adapter->clist_lock);
673 rval = __i2c_check_addr(adapter, addr);
674 mutex_unlock(&adapter->clist_lock);
678 EXPORT_SYMBOL(i2c_check_addr);
680 int i2c_attach_client(struct i2c_client *client)
682 struct i2c_adapter *adapter = client->adapter;
685 mutex_lock(&adapter->clist_lock);
686 if (__i2c_check_addr(client->adapter, client->addr)) {
690 list_add_tail(&client->list,&adapter->clients);
692 client->usage_count = 0;
694 client->dev.parent = &client->adapter->dev;
695 client->dev.bus = &i2c_bus_type;
698 client->dev.driver = &client->driver->driver;
700 if (client->driver && !is_newstyle_driver(client->driver))
701 client->dev.release = i2c_client_release;
703 client->dev.release = i2c_client_dev_release;
705 snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
706 "%d-%04x", i2c_adapter_id(adapter), client->addr);
707 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
708 client->name, client->dev.bus_id);
709 res = device_register(&client->dev);
712 mutex_unlock(&adapter->clist_lock);
714 if (adapter->client_register) {
715 if (adapter->client_register(client)) {
716 dev_dbg(&adapter->dev, "client_register "
717 "failed for client [%s] at 0x%02x\n",
718 client->name, client->addr);
725 list_del(&client->list);
726 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
727 "(%d)\n", client->name, client->addr, res);
729 mutex_unlock(&adapter->clist_lock);
732 EXPORT_SYMBOL(i2c_attach_client);
734 int i2c_detach_client(struct i2c_client *client)
736 struct i2c_adapter *adapter = client->adapter;
739 if (client->usage_count > 0) {
740 dev_warn(&client->dev, "Client [%s] still busy, "
741 "can't detach\n", client->name);
745 if (adapter->client_unregister) {
746 res = adapter->client_unregister(client);
748 dev_err(&client->dev,
749 "client_unregister [%s] failed, "
750 "client not detached\n", client->name);
755 mutex_lock(&adapter->clist_lock);
756 list_del(&client->list);
757 init_completion(&client->released);
758 device_unregister(&client->dev);
759 mutex_unlock(&adapter->clist_lock);
760 wait_for_completion(&client->released);
765 EXPORT_SYMBOL(i2c_detach_client);
767 static int i2c_inc_use_client(struct i2c_client *client)
770 if (!try_module_get(client->driver->driver.owner))
772 if (!try_module_get(client->adapter->owner)) {
773 module_put(client->driver->driver.owner);
780 static void i2c_dec_use_client(struct i2c_client *client)
782 module_put(client->driver->driver.owner);
783 module_put(client->adapter->owner);
786 int i2c_use_client(struct i2c_client *client)
790 ret = i2c_inc_use_client(client);
794 client->usage_count++;
798 EXPORT_SYMBOL(i2c_use_client);
800 int i2c_release_client(struct i2c_client *client)
802 if (!client->usage_count) {
803 pr_debug("i2c-core: %s used one too many times\n",
808 client->usage_count--;
809 i2c_dec_use_client(client);
813 EXPORT_SYMBOL(i2c_release_client);
815 void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
817 struct list_head *item;
818 struct i2c_client *client;
820 mutex_lock(&adap->clist_lock);
821 list_for_each(item,&adap->clients) {
822 client = list_entry(item, struct i2c_client, list);
823 if (!try_module_get(client->driver->driver.owner))
825 if (NULL != client->driver->command) {
826 mutex_unlock(&adap->clist_lock);
827 client->driver->command(client,cmd,arg);
828 mutex_lock(&adap->clist_lock);
830 module_put(client->driver->driver.owner);
832 mutex_unlock(&adap->clist_lock);
834 EXPORT_SYMBOL(i2c_clients_command);
836 static int __init i2c_init(void)
840 retval = bus_register(&i2c_bus_type);
843 return class_register(&i2c_adapter_class);
846 static void __exit i2c_exit(void)
848 class_unregister(&i2c_adapter_class);
849 bus_unregister(&i2c_bus_type);
852 subsys_initcall(i2c_init);
853 module_exit(i2c_exit);
855 /* ----------------------------------------------------
856 * the functional interface to the i2c busses.
857 * ----------------------------------------------------
860 int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
864 if (adap->algo->master_xfer) {
866 for (ret = 0; ret < num; ret++) {
867 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
868 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
869 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
870 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
874 mutex_lock_nested(&adap->bus_lock, adap->level);
875 ret = adap->algo->master_xfer(adap,msgs,num);
876 mutex_unlock(&adap->bus_lock);
880 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
884 EXPORT_SYMBOL(i2c_transfer);
886 int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
889 struct i2c_adapter *adap=client->adapter;
892 msg.addr = client->addr;
893 msg.flags = client->flags & I2C_M_TEN;
895 msg.buf = (char *)buf;
897 ret = i2c_transfer(adap, &msg, 1);
899 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
900 transmitted, else error code. */
901 return (ret == 1) ? count : ret;
903 EXPORT_SYMBOL(i2c_master_send);
905 int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
907 struct i2c_adapter *adap=client->adapter;
911 msg.addr = client->addr;
912 msg.flags = client->flags & I2C_M_TEN;
913 msg.flags |= I2C_M_RD;
917 ret = i2c_transfer(adap, &msg, 1);
919 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
920 transmitted, else error code. */
921 return (ret == 1) ? count : ret;
923 EXPORT_SYMBOL(i2c_master_recv);
925 int i2c_control(struct i2c_client *client,
926 unsigned int cmd, unsigned long arg)
929 struct i2c_adapter *adap = client->adapter;
931 dev_dbg(&client->adapter->dev, "i2c ioctl, cmd: 0x%x, arg: %#lx\n", cmd, arg);
940 if (adap->algo->algo_control!=NULL)
941 ret = adap->algo->algo_control(adap,cmd,arg);
945 EXPORT_SYMBOL(i2c_control);
947 /* ----------------------------------------------------
948 * the i2c address scanning function
949 * Will not work for 10-bit addresses!
950 * ----------------------------------------------------
952 static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
953 int (*found_proc) (struct i2c_adapter *, int, int))
957 /* Make sure the address is valid */
958 if (addr < 0x03 || addr > 0x77) {
959 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
964 /* Skip if already in use */
965 if (i2c_check_addr(adapter, addr))
968 /* Make sure there is something at this address, unless forced */
970 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
971 I2C_SMBUS_QUICK, NULL) < 0)
974 /* prevent 24RF08 corruption */
975 if ((addr & ~0x0f) == 0x50)
976 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
977 I2C_SMBUS_QUICK, NULL);
980 /* Finally call the custom detection function */
981 err = found_proc(adapter, addr, kind);
982 /* -ENODEV can be returned if there is a chip at the given address
983 but it isn't supported by this chip driver. We catch it here as
984 this isn't an error. */
989 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
994 int i2c_probe(struct i2c_adapter *adapter,
995 struct i2c_client_address_data *address_data,
996 int (*found_proc) (struct i2c_adapter *, int, int))
999 int adap_id = i2c_adapter_id(adapter);
1001 /* Force entries are done first, and are not affected by ignore
1003 if (address_data->forces) {
1004 unsigned short **forces = address_data->forces;
1007 for (kind = 0; forces[kind]; kind++) {
1008 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1010 if (forces[kind][i] == adap_id
1011 || forces[kind][i] == ANY_I2C_BUS) {
1012 dev_dbg(&adapter->dev, "found force "
1013 "parameter for adapter %d, "
1014 "addr 0x%02x, kind %d\n",
1015 adap_id, forces[kind][i + 1],
1017 err = i2c_probe_address(adapter,
1018 forces[kind][i + 1],
1027 /* Stop here if we can't use SMBUS_QUICK */
1028 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1029 if (address_data->probe[0] == I2C_CLIENT_END
1030 && address_data->normal_i2c[0] == I2C_CLIENT_END)
1033 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1034 "can't probe for chips\n");
1038 /* Probe entries are done second, and are not affected by ignore
1040 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1041 if (address_data->probe[i] == adap_id
1042 || address_data->probe[i] == ANY_I2C_BUS) {
1043 dev_dbg(&adapter->dev, "found probe parameter for "
1044 "adapter %d, addr 0x%02x\n", adap_id,
1045 address_data->probe[i + 1]);
1046 err = i2c_probe_address(adapter,
1047 address_data->probe[i + 1],
1054 /* Normal entries are done last, unless shadowed by an ignore entry */
1055 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1059 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1061 if ((address_data->ignore[j] == adap_id ||
1062 address_data->ignore[j] == ANY_I2C_BUS)
1063 && address_data->ignore[j + 1]
1064 == address_data->normal_i2c[i]) {
1065 dev_dbg(&adapter->dev, "found ignore "
1066 "parameter for adapter %d, "
1067 "addr 0x%02x\n", adap_id,
1068 address_data->ignore[j + 1]);
1076 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1077 "addr 0x%02x\n", adap_id,
1078 address_data->normal_i2c[i]);
1079 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1087 EXPORT_SYMBOL(i2c_probe);
1090 i2c_new_probed_device(struct i2c_adapter *adap,
1091 struct i2c_board_info *info,
1092 unsigned short const *addr_list)
1096 /* Stop here if the bus doesn't support probing */
1097 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1098 dev_err(&adap->dev, "Probing not supported\n");
1102 mutex_lock(&adap->clist_lock);
1103 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1104 /* Check address validity */
1105 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1106 dev_warn(&adap->dev, "Invalid 7-bit address "
1107 "0x%02x\n", addr_list[i]);
1111 /* Check address availability */
1112 if (__i2c_check_addr(adap, addr_list[i])) {
1113 dev_dbg(&adap->dev, "Address 0x%02x already in "
1114 "use, not probing\n", addr_list[i]);
1118 /* Test address responsiveness
1119 The default probe method is a quick write, but it is known
1120 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1121 and could also irreversibly write-protect some EEPROMs, so
1122 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1123 read instead. Also, some bus drivers don't implement
1124 quick write, so we fallback to a byte read it that case
1126 if ((addr_list[i] & ~0x07) == 0x30
1127 || (addr_list[i] & ~0x0f) == 0x50
1128 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1129 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1131 I2C_SMBUS_BYTE, NULL) >= 0)
1134 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1136 I2C_SMBUS_QUICK, NULL) >= 0)
1140 mutex_unlock(&adap->clist_lock);
1142 if (addr_list[i] == I2C_CLIENT_END) {
1143 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1147 info->addr = addr_list[i];
1148 return i2c_new_device(adap, info);
1150 EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1152 struct i2c_adapter* i2c_get_adapter(int id)
1154 struct i2c_adapter *adapter;
1156 mutex_lock(&core_lists);
1157 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1158 if (adapter && !try_module_get(adapter->owner))
1161 mutex_unlock(&core_lists);
1164 EXPORT_SYMBOL(i2c_get_adapter);
1166 void i2c_put_adapter(struct i2c_adapter *adap)
1168 module_put(adap->owner);
1170 EXPORT_SYMBOL(i2c_put_adapter);
1172 /* The SMBus parts */
1174 #define POLY (0x1070U << 3)
1180 for(i = 0; i < 8; i++) {
1185 return (u8)(data >> 8);
1188 /* Incremental CRC8 over count bytes in the array pointed to by p */
1189 static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1193 for(i = 0; i < count; i++)
1194 crc = crc8((crc ^ p[i]) << 8);
1198 /* Assume a 7-bit address, which is reasonable for SMBus */
1199 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1201 /* The address will be sent first */
1202 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1203 pec = i2c_smbus_pec(pec, &addr, 1);
1205 /* The data buffer follows */
1206 return i2c_smbus_pec(pec, msg->buf, msg->len);
1209 /* Used for write only transactions */
1210 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1212 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1216 /* Return <0 on CRC error
1217 If there was a write before this read (most cases) we need to take the
1218 partial CRC from the write part into account.
1219 Note that this function does modify the message (we need to decrease the
1220 message length to hide the CRC byte from the caller). */
1221 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1223 u8 rpec = msg->buf[--msg->len];
1224 cpec = i2c_smbus_msg_pec(cpec, msg);
1227 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1234 s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
1236 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1237 value,0,I2C_SMBUS_QUICK,NULL);
1239 EXPORT_SYMBOL(i2c_smbus_write_quick);
1241 s32 i2c_smbus_read_byte(struct i2c_client *client)
1243 union i2c_smbus_data data;
1244 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1245 I2C_SMBUS_READ,0,I2C_SMBUS_BYTE, &data))
1250 EXPORT_SYMBOL(i2c_smbus_read_byte);
1252 s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1254 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1255 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1257 EXPORT_SYMBOL(i2c_smbus_write_byte);
1259 s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1261 union i2c_smbus_data data;
1262 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1263 I2C_SMBUS_READ,command, I2C_SMBUS_BYTE_DATA,&data))
1268 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1270 s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1272 union i2c_smbus_data data;
1274 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1275 I2C_SMBUS_WRITE,command,
1276 I2C_SMBUS_BYTE_DATA,&data);
1278 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1280 s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1282 union i2c_smbus_data data;
1283 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1284 I2C_SMBUS_READ,command, I2C_SMBUS_WORD_DATA, &data))
1289 EXPORT_SYMBOL(i2c_smbus_read_word_data);
1291 s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1293 union i2c_smbus_data data;
1295 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1296 I2C_SMBUS_WRITE,command,
1297 I2C_SMBUS_WORD_DATA,&data);
1299 EXPORT_SYMBOL(i2c_smbus_write_word_data);
1301 s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1302 u8 length, const u8 *values)
1304 union i2c_smbus_data data;
1306 if (length > I2C_SMBUS_BLOCK_MAX)
1307 length = I2C_SMBUS_BLOCK_MAX;
1308 data.block[0] = length;
1309 memcpy(&data.block[1], values, length);
1310 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1311 I2C_SMBUS_WRITE,command,
1312 I2C_SMBUS_BLOCK_DATA,&data);
1314 EXPORT_SYMBOL(i2c_smbus_write_block_data);
1316 /* Returns the number of read bytes */
1317 s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command, u8 *values)
1319 union i2c_smbus_data data;
1321 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1322 I2C_SMBUS_READ,command,
1323 I2C_SMBUS_I2C_BLOCK_DATA,&data))
1326 memcpy(values, &data.block[1], data.block[0]);
1327 return data.block[0];
1329 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1331 s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1332 u8 length, const u8 *values)
1334 union i2c_smbus_data data;
1336 if (length > I2C_SMBUS_BLOCK_MAX)
1337 length = I2C_SMBUS_BLOCK_MAX;
1338 data.block[0] = length;
1339 memcpy(data.block + 1, values, length);
1340 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1341 I2C_SMBUS_WRITE, command,
1342 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1344 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1346 /* Simulate a SMBus command using the i2c protocol
1347 No checking of parameters is done! */
1348 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
1349 unsigned short flags,
1350 char read_write, u8 command, int size,
1351 union i2c_smbus_data * data)
1353 /* So we need to generate a series of msgs. In the case of writing, we
1354 need to use only one message; when reading, we need two. We initialize
1355 most things with sane defaults, to keep the code below somewhat
1357 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1358 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1359 int num = read_write == I2C_SMBUS_READ?2:1;
1360 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1361 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1366 msgbuf0[0] = command;
1368 case I2C_SMBUS_QUICK:
1370 /* Special case: The read/write field is used as data */
1371 msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
1374 case I2C_SMBUS_BYTE:
1375 if (read_write == I2C_SMBUS_READ) {
1376 /* Special case: only a read! */
1377 msg[0].flags = I2C_M_RD | flags;
1381 case I2C_SMBUS_BYTE_DATA:
1382 if (read_write == I2C_SMBUS_READ)
1386 msgbuf0[1] = data->byte;
1389 case I2C_SMBUS_WORD_DATA:
1390 if (read_write == I2C_SMBUS_READ)
1394 msgbuf0[1] = data->word & 0xff;
1395 msgbuf0[2] = data->word >> 8;
1398 case I2C_SMBUS_PROC_CALL:
1399 num = 2; /* Special case */
1400 read_write = I2C_SMBUS_READ;
1403 msgbuf0[1] = data->word & 0xff;
1404 msgbuf0[2] = data->word >> 8;
1406 case I2C_SMBUS_BLOCK_DATA:
1407 if (read_write == I2C_SMBUS_READ) {
1408 msg[1].flags |= I2C_M_RECV_LEN;
1409 msg[1].len = 1; /* block length will be added by
1410 the underlying bus driver */
1412 msg[0].len = data->block[0] + 2;
1413 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1414 dev_err(&adapter->dev, "smbus_access called with "
1415 "invalid block write size (%d)\n",
1419 for (i = 1; i < msg[0].len; i++)
1420 msgbuf0[i] = data->block[i-1];
1423 case I2C_SMBUS_BLOCK_PROC_CALL:
1424 num = 2; /* Another special case */
1425 read_write = I2C_SMBUS_READ;
1426 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1427 dev_err(&adapter->dev, "%s called with invalid "
1428 "block proc call size (%d)\n", __FUNCTION__,
1432 msg[0].len = data->block[0] + 2;
1433 for (i = 1; i < msg[0].len; i++)
1434 msgbuf0[i] = data->block[i-1];
1435 msg[1].flags |= I2C_M_RECV_LEN;
1436 msg[1].len = 1; /* block length will be added by
1437 the underlying bus driver */
1439 case I2C_SMBUS_I2C_BLOCK_DATA:
1440 if (read_write == I2C_SMBUS_READ) {
1441 msg[1].len = I2C_SMBUS_BLOCK_MAX;
1443 msg[0].len = data->block[0] + 1;
1444 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
1445 dev_err(&adapter->dev, "i2c_smbus_xfer_emulated called with "
1446 "invalid block write size (%d)\n",
1450 for (i = 1; i <= data->block[0]; i++)
1451 msgbuf0[i] = data->block[i];
1455 dev_err(&adapter->dev, "smbus_access called with invalid size (%d)\n",
1460 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1461 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1463 /* Compute PEC if first message is a write */
1464 if (!(msg[0].flags & I2C_M_RD)) {
1465 if (num == 1) /* Write only */
1466 i2c_smbus_add_pec(&msg[0]);
1467 else /* Write followed by read */
1468 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1470 /* Ask for PEC if last message is a read */
1471 if (msg[num-1].flags & I2C_M_RD)
1475 if (i2c_transfer(adapter, msg, num) < 0)
1478 /* Check PEC if last message is a read */
1479 if (i && (msg[num-1].flags & I2C_M_RD)) {
1480 if (i2c_smbus_check_pec(partial_pec, &msg[num-1]) < 0)
1484 if (read_write == I2C_SMBUS_READ)
1486 case I2C_SMBUS_BYTE:
1487 data->byte = msgbuf0[0];
1489 case I2C_SMBUS_BYTE_DATA:
1490 data->byte = msgbuf1[0];
1492 case I2C_SMBUS_WORD_DATA:
1493 case I2C_SMBUS_PROC_CALL:
1494 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1496 case I2C_SMBUS_I2C_BLOCK_DATA:
1497 /* fixed at 32 for now */
1498 data->block[0] = I2C_SMBUS_BLOCK_MAX;
1499 for (i = 0; i < I2C_SMBUS_BLOCK_MAX; i++)
1500 data->block[i+1] = msgbuf1[i];
1502 case I2C_SMBUS_BLOCK_DATA:
1503 case I2C_SMBUS_BLOCK_PROC_CALL:
1504 for (i = 0; i < msgbuf1[0] + 1; i++)
1505 data->block[i] = msgbuf1[i];
1512 s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
1513 char read_write, u8 command, int size,
1514 union i2c_smbus_data * data)
1518 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
1520 if (adapter->algo->smbus_xfer) {
1521 mutex_lock(&adapter->bus_lock);
1522 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
1524 mutex_unlock(&adapter->bus_lock);
1526 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
1531 EXPORT_SYMBOL(i2c_smbus_xfer);
1533 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1534 MODULE_DESCRIPTION("I2C-Bus main module");
1535 MODULE_LICENSE("GPL");