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, struct kobj_uevent_env *env)
72 struct i2c_client *client = to_i2c_client(dev);
74 /* by definition, legacy drivers can't hotplug */
75 if (dev->driver || !client->driver_name)
78 if (add_uevent_var(env, "MODALIAS=%s", client->driver_name))
80 dev_dbg(dev, "uevent\n");
85 #define i2c_device_uevent NULL
86 #endif /* CONFIG_HOTPLUG */
88 static int i2c_device_probe(struct device *dev)
90 struct i2c_client *client = to_i2c_client(dev);
91 struct i2c_driver *driver = to_i2c_driver(dev->driver);
95 client->driver = driver;
96 dev_dbg(dev, "probe\n");
97 return driver->probe(client);
100 static int i2c_device_remove(struct device *dev)
102 struct i2c_client *client = to_i2c_client(dev);
103 struct i2c_driver *driver;
109 driver = to_i2c_driver(dev->driver);
110 if (driver->remove) {
111 dev_dbg(dev, "remove\n");
112 status = driver->remove(client);
118 client->driver = NULL;
122 static void i2c_device_shutdown(struct device *dev)
124 struct i2c_driver *driver;
128 driver = to_i2c_driver(dev->driver);
129 if (driver->shutdown)
130 driver->shutdown(to_i2c_client(dev));
133 static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
135 struct i2c_driver *driver;
139 driver = to_i2c_driver(dev->driver);
140 if (!driver->suspend)
142 return driver->suspend(to_i2c_client(dev), mesg);
145 static int i2c_device_resume(struct device * dev)
147 struct i2c_driver *driver;
151 driver = to_i2c_driver(dev->driver);
154 return driver->resume(to_i2c_client(dev));
157 static void i2c_client_release(struct device *dev)
159 struct i2c_client *client = to_i2c_client(dev);
160 complete(&client->released);
163 static void i2c_client_dev_release(struct device *dev)
165 kfree(to_i2c_client(dev));
168 static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
170 struct i2c_client *client = to_i2c_client(dev);
171 return sprintf(buf, "%s\n", client->name);
174 static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
176 struct i2c_client *client = to_i2c_client(dev);
177 return client->driver_name
178 ? sprintf(buf, "%s\n", client->driver_name)
182 static struct device_attribute i2c_dev_attrs[] = {
183 __ATTR(name, S_IRUGO, show_client_name, NULL),
184 /* modalias helps coldplug: modprobe $(cat .../modalias) */
185 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
189 struct bus_type i2c_bus_type = {
191 .dev_attrs = i2c_dev_attrs,
192 .match = i2c_device_match,
193 .uevent = i2c_device_uevent,
194 .probe = i2c_device_probe,
195 .remove = i2c_device_remove,
196 .shutdown = i2c_device_shutdown,
197 .suspend = i2c_device_suspend,
198 .resume = i2c_device_resume,
200 EXPORT_SYMBOL_GPL(i2c_bus_type);
203 * i2c_new_device - instantiate an i2c device for use with a new style driver
204 * @adap: the adapter managing the device
205 * @info: describes one I2C device; bus_num is ignored
208 * Create a device to work with a new style i2c driver, where binding is
209 * handled through driver model probe()/remove() methods. This call is not
210 * appropriate for use by mainboad initialization logic, which usually runs
211 * during an arch_initcall() long before any i2c_adapter could exist.
213 * This returns the new i2c client, which may be saved for later use with
214 * i2c_unregister_device(); or NULL to indicate an error.
217 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
219 struct i2c_client *client;
222 client = kzalloc(sizeof *client, GFP_KERNEL);
226 client->adapter = adap;
228 client->dev.platform_data = info->platform_data;
229 client->flags = info->flags;
230 client->addr = info->addr;
231 client->irq = info->irq;
233 strlcpy(client->driver_name, info->driver_name,
234 sizeof(client->driver_name));
235 strlcpy(client->name, info->type, sizeof(client->name));
237 /* a new style driver may be bound to this device when we
238 * return from this function, or any later moment (e.g. maybe
239 * hotplugging will load the driver module). and the device
240 * refcount model is the standard driver model one.
242 status = i2c_attach_client(client);
249 EXPORT_SYMBOL_GPL(i2c_new_device);
253 * i2c_unregister_device - reverse effect of i2c_new_device()
254 * @client: value returned from i2c_new_device()
257 void i2c_unregister_device(struct i2c_client *client)
259 struct i2c_adapter *adapter = client->adapter;
260 struct i2c_driver *driver = client->driver;
262 if (driver && !is_newstyle_driver(driver)) {
263 dev_err(&client->dev, "can't unregister devices "
264 "with legacy drivers\n");
269 mutex_lock(&adapter->clist_lock);
270 list_del(&client->list);
271 mutex_unlock(&adapter->clist_lock);
273 device_unregister(&client->dev);
275 EXPORT_SYMBOL_GPL(i2c_unregister_device);
278 /* ------------------------------------------------------------------------- */
280 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
282 void i2c_adapter_dev_release(struct device *dev)
284 struct i2c_adapter *adap = to_i2c_adapter(dev);
285 complete(&adap->dev_released);
289 show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
291 struct i2c_adapter *adap = to_i2c_adapter(dev);
292 return sprintf(buf, "%s\n", adap->name);
295 static struct device_attribute i2c_adapter_attrs[] = {
296 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
300 struct class i2c_adapter_class = {
301 .owner = THIS_MODULE,
302 .name = "i2c-adapter",
303 .dev_attrs = i2c_adapter_attrs,
306 static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
308 struct i2c_devinfo *devinfo;
310 mutex_lock(&__i2c_board_lock);
311 list_for_each_entry(devinfo, &__i2c_board_list, list) {
312 if (devinfo->busnum == adapter->nr
313 && !i2c_new_device(adapter,
314 &devinfo->board_info))
315 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
316 i2c_adapter_id(adapter),
317 devinfo->board_info.addr);
319 mutex_unlock(&__i2c_board_lock);
322 static int i2c_register_adapter(struct i2c_adapter *adap)
325 struct list_head *item;
326 struct i2c_driver *driver;
328 mutex_init(&adap->bus_lock);
329 mutex_init(&adap->clist_lock);
330 INIT_LIST_HEAD(&adap->clients);
332 mutex_lock(&core_lists);
333 list_add_tail(&adap->list, &adapters);
335 /* Add the adapter to the driver core.
336 * If the parent pointer is not set up,
337 * we add this adapter to the host bus.
339 if (adap->dev.parent == NULL) {
340 adap->dev.parent = &platform_bus;
341 pr_debug("I2C adapter driver [%s] forgot to specify "
342 "physical device\n", adap->name);
344 sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
345 adap->dev.release = &i2c_adapter_dev_release;
346 adap->dev.class = &i2c_adapter_class;
347 res = device_register(&adap->dev);
351 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
353 /* create pre-declared device nodes for new-style drivers */
354 if (adap->nr < __i2c_first_dynamic_bus_num)
355 i2c_scan_static_board_info(adap);
357 /* let legacy drivers scan this bus for matching devices */
358 list_for_each(item,&drivers) {
359 driver = list_entry(item, struct i2c_driver, list);
360 if (driver->attach_adapter)
361 /* We ignore the return code; if it fails, too bad */
362 driver->attach_adapter(adap);
366 mutex_unlock(&core_lists);
370 list_del(&adap->list);
371 idr_remove(&i2c_adapter_idr, adap->nr);
376 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
377 * @adapter: the adapter to add
380 * This routine is used to declare an I2C adapter when its bus number
381 * doesn't matter. Examples: for I2C adapters dynamically added by
382 * USB links or PCI plugin cards.
384 * When this returns zero, a new bus number was allocated and stored
385 * in adap->nr, and the specified adapter became available for clients.
386 * Otherwise, a negative errno value is returned.
388 int i2c_add_adapter(struct i2c_adapter *adapter)
393 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
396 mutex_lock(&core_lists);
397 /* "above" here means "above or equal to", sigh */
398 res = idr_get_new_above(&i2c_adapter_idr, adapter,
399 __i2c_first_dynamic_bus_num, &id);
400 mutex_unlock(&core_lists);
409 return i2c_register_adapter(adapter);
411 EXPORT_SYMBOL(i2c_add_adapter);
414 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
415 * @adap: the adapter to register (with adap->nr initialized)
418 * This routine is used to declare an I2C adapter when its bus number
419 * matters. Example: for I2C adapters from system-on-chip CPUs, or
420 * otherwise built in to the system's mainboard, and where i2c_board_info
421 * is used to properly configure I2C devices.
423 * If no devices have pre-been declared for this bus, then be sure to
424 * register the adapter before any dynamically allocated ones. Otherwise
425 * the required bus ID may not be available.
427 * When this returns zero, the specified adapter became available for
428 * clients using the bus number provided in adap->nr. Also, the table
429 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
430 * and the appropriate driver model device nodes are created. Otherwise, a
431 * negative errno value is returned.
433 int i2c_add_numbered_adapter(struct i2c_adapter *adap)
438 if (adap->nr & ~MAX_ID_MASK)
442 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
445 mutex_lock(&core_lists);
446 /* "above" here means "above or equal to", sigh;
447 * we need the "equal to" result to force the result
449 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
450 if (status == 0 && id != adap->nr) {
452 idr_remove(&i2c_adapter_idr, id);
454 mutex_unlock(&core_lists);
455 if (status == -EAGAIN)
459 status = i2c_register_adapter(adap);
462 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
465 * i2c_del_adapter - unregister I2C adapter
466 * @adap: the adapter being unregistered
469 * This unregisters an I2C adapter which was previously registered
470 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
472 int i2c_del_adapter(struct i2c_adapter *adap)
474 struct list_head *item, *_n;
475 struct i2c_adapter *adap_from_list;
476 struct i2c_driver *driver;
477 struct i2c_client *client;
480 mutex_lock(&core_lists);
482 /* First make sure that this adapter was ever added */
483 list_for_each_entry(adap_from_list, &adapters, list) {
484 if (adap_from_list == adap)
487 if (adap_from_list != adap) {
488 pr_debug("i2c-core: attempting to delete unregistered "
489 "adapter [%s]\n", adap->name);
494 list_for_each(item,&drivers) {
495 driver = list_entry(item, struct i2c_driver, list);
496 if (driver->detach_adapter)
497 if ((res = driver->detach_adapter(adap))) {
498 dev_err(&adap->dev, "detach_adapter failed "
500 driver->driver.name);
505 /* detach any active clients. This must be done first, because
506 * it can fail; in which case we give up. */
507 list_for_each_safe(item, _n, &adap->clients) {
508 struct i2c_driver *driver;
510 client = list_entry(item, struct i2c_client, list);
511 driver = client->driver;
513 /* new style, follow standard driver model */
514 if (!driver || is_newstyle_driver(driver)) {
515 i2c_unregister_device(client);
519 /* legacy drivers create and remove clients themselves */
520 if ((res = driver->detach_client(client))) {
521 dev_err(&adap->dev, "detach_client failed for client "
522 "[%s] at address 0x%02x\n", client->name,
528 /* clean up the sysfs representation */
529 init_completion(&adap->dev_released);
530 device_unregister(&adap->dev);
531 list_del(&adap->list);
533 /* wait for sysfs to drop all references */
534 wait_for_completion(&adap->dev_released);
537 idr_remove(&i2c_adapter_idr, adap->nr);
539 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
542 mutex_unlock(&core_lists);
545 EXPORT_SYMBOL(i2c_del_adapter);
548 /* ------------------------------------------------------------------------- */
551 * An i2c_driver is used with one or more i2c_client (device) nodes to access
552 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
553 * are two models for binding the driver to its device: "new style" drivers
554 * follow the standard Linux driver model and just respond to probe() calls
555 * issued if the driver core sees they match(); "legacy" drivers create device
559 int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
563 /* new style driver methods can't mix with legacy ones */
564 if (is_newstyle_driver(driver)) {
565 if (driver->attach_adapter || driver->detach_adapter
566 || driver->detach_client) {
568 "i2c-core: driver [%s] is confused\n",
569 driver->driver.name);
574 /* add the driver to the list of i2c drivers in the driver core */
575 driver->driver.owner = owner;
576 driver->driver.bus = &i2c_bus_type;
578 /* for new style drivers, when registration returns the driver core
579 * will have called probe() for all matching-but-unbound devices.
581 res = driver_register(&driver->driver);
585 mutex_lock(&core_lists);
587 list_add_tail(&driver->list,&drivers);
588 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
590 /* legacy drivers scan i2c busses directly */
591 if (driver->attach_adapter) {
592 struct i2c_adapter *adapter;
594 list_for_each_entry(adapter, &adapters, list) {
595 driver->attach_adapter(adapter);
599 mutex_unlock(&core_lists);
602 EXPORT_SYMBOL(i2c_register_driver);
605 * i2c_del_driver - unregister I2C driver
606 * @driver: the driver being unregistered
609 void i2c_del_driver(struct i2c_driver *driver)
611 struct list_head *item1, *item2, *_n;
612 struct i2c_client *client;
613 struct i2c_adapter *adap;
615 mutex_lock(&core_lists);
617 /* new-style driver? */
618 if (is_newstyle_driver(driver))
621 /* Have a look at each adapter, if clients of this driver are still
622 * attached. If so, detach them to be able to kill the driver
625 list_for_each(item1,&adapters) {
626 adap = list_entry(item1, struct i2c_adapter, list);
627 if (driver->detach_adapter) {
628 if (driver->detach_adapter(adap)) {
629 dev_err(&adap->dev, "detach_adapter failed "
631 driver->driver.name);
634 list_for_each_safe(item2, _n, &adap->clients) {
635 client = list_entry(item2, struct i2c_client, list);
636 if (client->driver != driver)
638 dev_dbg(&adap->dev, "detaching client [%s] "
639 "at 0x%02x\n", client->name,
641 if (driver->detach_client(client)) {
642 dev_err(&adap->dev, "detach_client "
643 "failed for client [%s] at "
644 "0x%02x\n", client->name,
652 driver_unregister(&driver->driver);
653 list_del(&driver->list);
654 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
656 mutex_unlock(&core_lists);
658 EXPORT_SYMBOL(i2c_del_driver);
660 /* ------------------------------------------------------------------------- */
662 static int __i2c_check_addr(struct i2c_adapter *adapter, unsigned int addr)
664 struct list_head *item;
665 struct i2c_client *client;
667 list_for_each(item,&adapter->clients) {
668 client = list_entry(item, struct i2c_client, list);
669 if (client->addr == addr)
675 int i2c_check_addr(struct i2c_adapter *adapter, int addr)
679 mutex_lock(&adapter->clist_lock);
680 rval = __i2c_check_addr(adapter, addr);
681 mutex_unlock(&adapter->clist_lock);
685 EXPORT_SYMBOL(i2c_check_addr);
687 int i2c_attach_client(struct i2c_client *client)
689 struct i2c_adapter *adapter = client->adapter;
692 mutex_lock(&adapter->clist_lock);
693 if (__i2c_check_addr(client->adapter, client->addr)) {
697 list_add_tail(&client->list,&adapter->clients);
699 client->usage_count = 0;
701 client->dev.parent = &client->adapter->dev;
702 client->dev.bus = &i2c_bus_type;
705 client->dev.driver = &client->driver->driver;
707 if (client->driver && !is_newstyle_driver(client->driver)) {
708 client->dev.release = i2c_client_release;
709 client->dev.uevent_suppress = 1;
711 client->dev.release = i2c_client_dev_release;
713 snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
714 "%d-%04x", i2c_adapter_id(adapter), client->addr);
715 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
716 client->name, client->dev.bus_id);
717 res = device_register(&client->dev);
720 mutex_unlock(&adapter->clist_lock);
722 if (adapter->client_register) {
723 if (adapter->client_register(client)) {
724 dev_dbg(&adapter->dev, "client_register "
725 "failed for client [%s] at 0x%02x\n",
726 client->name, client->addr);
733 list_del(&client->list);
734 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
735 "(%d)\n", client->name, client->addr, res);
737 mutex_unlock(&adapter->clist_lock);
740 EXPORT_SYMBOL(i2c_attach_client);
742 int i2c_detach_client(struct i2c_client *client)
744 struct i2c_adapter *adapter = client->adapter;
747 if (client->usage_count > 0) {
748 dev_warn(&client->dev, "Client [%s] still busy, "
749 "can't detach\n", client->name);
753 if (adapter->client_unregister) {
754 res = adapter->client_unregister(client);
756 dev_err(&client->dev,
757 "client_unregister [%s] failed, "
758 "client not detached\n", client->name);
763 mutex_lock(&adapter->clist_lock);
764 list_del(&client->list);
765 init_completion(&client->released);
766 device_unregister(&client->dev);
767 mutex_unlock(&adapter->clist_lock);
768 wait_for_completion(&client->released);
773 EXPORT_SYMBOL(i2c_detach_client);
775 static int i2c_inc_use_client(struct i2c_client *client)
778 if (!try_module_get(client->driver->driver.owner))
780 if (!try_module_get(client->adapter->owner)) {
781 module_put(client->driver->driver.owner);
788 static void i2c_dec_use_client(struct i2c_client *client)
790 module_put(client->driver->driver.owner);
791 module_put(client->adapter->owner);
794 int i2c_use_client(struct i2c_client *client)
798 ret = i2c_inc_use_client(client);
802 client->usage_count++;
806 EXPORT_SYMBOL(i2c_use_client);
808 int i2c_release_client(struct i2c_client *client)
810 if (!client->usage_count) {
811 pr_debug("i2c-core: %s used one too many times\n",
816 client->usage_count--;
817 i2c_dec_use_client(client);
821 EXPORT_SYMBOL(i2c_release_client);
823 void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
825 struct list_head *item;
826 struct i2c_client *client;
828 mutex_lock(&adap->clist_lock);
829 list_for_each(item,&adap->clients) {
830 client = list_entry(item, struct i2c_client, list);
831 if (!try_module_get(client->driver->driver.owner))
833 if (NULL != client->driver->command) {
834 mutex_unlock(&adap->clist_lock);
835 client->driver->command(client,cmd,arg);
836 mutex_lock(&adap->clist_lock);
838 module_put(client->driver->driver.owner);
840 mutex_unlock(&adap->clist_lock);
842 EXPORT_SYMBOL(i2c_clients_command);
844 static int __init i2c_init(void)
848 retval = bus_register(&i2c_bus_type);
851 return class_register(&i2c_adapter_class);
854 static void __exit i2c_exit(void)
856 class_unregister(&i2c_adapter_class);
857 bus_unregister(&i2c_bus_type);
860 subsys_initcall(i2c_init);
861 module_exit(i2c_exit);
863 /* ----------------------------------------------------
864 * the functional interface to the i2c busses.
865 * ----------------------------------------------------
868 int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
872 if (adap->algo->master_xfer) {
874 for (ret = 0; ret < num; ret++) {
875 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
876 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
877 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
878 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
882 mutex_lock_nested(&adap->bus_lock, adap->level);
883 ret = adap->algo->master_xfer(adap,msgs,num);
884 mutex_unlock(&adap->bus_lock);
888 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
892 EXPORT_SYMBOL(i2c_transfer);
894 int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
897 struct i2c_adapter *adap=client->adapter;
900 msg.addr = client->addr;
901 msg.flags = client->flags & I2C_M_TEN;
903 msg.buf = (char *)buf;
905 ret = i2c_transfer(adap, &msg, 1);
907 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
908 transmitted, else error code. */
909 return (ret == 1) ? count : ret;
911 EXPORT_SYMBOL(i2c_master_send);
913 int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
915 struct i2c_adapter *adap=client->adapter;
919 msg.addr = client->addr;
920 msg.flags = client->flags & I2C_M_TEN;
921 msg.flags |= I2C_M_RD;
925 ret = i2c_transfer(adap, &msg, 1);
927 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
928 transmitted, else error code. */
929 return (ret == 1) ? count : ret;
931 EXPORT_SYMBOL(i2c_master_recv);
933 int i2c_control(struct i2c_client *client,
934 unsigned int cmd, unsigned long arg)
937 struct i2c_adapter *adap = client->adapter;
939 dev_dbg(&client->adapter->dev, "i2c ioctl, cmd: 0x%x, arg: %#lx\n", cmd, arg);
948 if (adap->algo->algo_control!=NULL)
949 ret = adap->algo->algo_control(adap,cmd,arg);
953 EXPORT_SYMBOL(i2c_control);
955 /* ----------------------------------------------------
956 * the i2c address scanning function
957 * Will not work for 10-bit addresses!
958 * ----------------------------------------------------
960 static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
961 int (*found_proc) (struct i2c_adapter *, int, int))
965 /* Make sure the address is valid */
966 if (addr < 0x03 || addr > 0x77) {
967 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
972 /* Skip if already in use */
973 if (i2c_check_addr(adapter, addr))
976 /* Make sure there is something at this address, unless forced */
978 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
979 I2C_SMBUS_QUICK, NULL) < 0)
982 /* prevent 24RF08 corruption */
983 if ((addr & ~0x0f) == 0x50)
984 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
985 I2C_SMBUS_QUICK, NULL);
988 /* Finally call the custom detection function */
989 err = found_proc(adapter, addr, kind);
990 /* -ENODEV can be returned if there is a chip at the given address
991 but it isn't supported by this chip driver. We catch it here as
992 this isn't an error. */
997 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
1002 int i2c_probe(struct i2c_adapter *adapter,
1003 struct i2c_client_address_data *address_data,
1004 int (*found_proc) (struct i2c_adapter *, int, int))
1007 int adap_id = i2c_adapter_id(adapter);
1009 /* Force entries are done first, and are not affected by ignore
1011 if (address_data->forces) {
1012 unsigned short **forces = address_data->forces;
1015 for (kind = 0; forces[kind]; kind++) {
1016 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1018 if (forces[kind][i] == adap_id
1019 || forces[kind][i] == ANY_I2C_BUS) {
1020 dev_dbg(&adapter->dev, "found force "
1021 "parameter for adapter %d, "
1022 "addr 0x%02x, kind %d\n",
1023 adap_id, forces[kind][i + 1],
1025 err = i2c_probe_address(adapter,
1026 forces[kind][i + 1],
1035 /* Stop here if we can't use SMBUS_QUICK */
1036 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1037 if (address_data->probe[0] == I2C_CLIENT_END
1038 && address_data->normal_i2c[0] == I2C_CLIENT_END)
1041 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1042 "can't probe for chips\n");
1046 /* Probe entries are done second, and are not affected by ignore
1048 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1049 if (address_data->probe[i] == adap_id
1050 || address_data->probe[i] == ANY_I2C_BUS) {
1051 dev_dbg(&adapter->dev, "found probe parameter for "
1052 "adapter %d, addr 0x%02x\n", adap_id,
1053 address_data->probe[i + 1]);
1054 err = i2c_probe_address(adapter,
1055 address_data->probe[i + 1],
1062 /* Normal entries are done last, unless shadowed by an ignore entry */
1063 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1067 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1069 if ((address_data->ignore[j] == adap_id ||
1070 address_data->ignore[j] == ANY_I2C_BUS)
1071 && address_data->ignore[j + 1]
1072 == address_data->normal_i2c[i]) {
1073 dev_dbg(&adapter->dev, "found ignore "
1074 "parameter for adapter %d, "
1075 "addr 0x%02x\n", adap_id,
1076 address_data->ignore[j + 1]);
1084 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1085 "addr 0x%02x\n", adap_id,
1086 address_data->normal_i2c[i]);
1087 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1095 EXPORT_SYMBOL(i2c_probe);
1098 i2c_new_probed_device(struct i2c_adapter *adap,
1099 struct i2c_board_info *info,
1100 unsigned short const *addr_list)
1104 /* Stop here if the bus doesn't support probing */
1105 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1106 dev_err(&adap->dev, "Probing not supported\n");
1110 mutex_lock(&adap->clist_lock);
1111 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1112 /* Check address validity */
1113 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1114 dev_warn(&adap->dev, "Invalid 7-bit address "
1115 "0x%02x\n", addr_list[i]);
1119 /* Check address availability */
1120 if (__i2c_check_addr(adap, addr_list[i])) {
1121 dev_dbg(&adap->dev, "Address 0x%02x already in "
1122 "use, not probing\n", addr_list[i]);
1126 /* Test address responsiveness
1127 The default probe method is a quick write, but it is known
1128 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1129 and could also irreversibly write-protect some EEPROMs, so
1130 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1131 read instead. Also, some bus drivers don't implement
1132 quick write, so we fallback to a byte read it that case
1134 if ((addr_list[i] & ~0x07) == 0x30
1135 || (addr_list[i] & ~0x0f) == 0x50
1136 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1137 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1139 I2C_SMBUS_BYTE, NULL) >= 0)
1142 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1144 I2C_SMBUS_QUICK, NULL) >= 0)
1148 mutex_unlock(&adap->clist_lock);
1150 if (addr_list[i] == I2C_CLIENT_END) {
1151 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1155 info->addr = addr_list[i];
1156 return i2c_new_device(adap, info);
1158 EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1160 struct i2c_adapter* i2c_get_adapter(int id)
1162 struct i2c_adapter *adapter;
1164 mutex_lock(&core_lists);
1165 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1166 if (adapter && !try_module_get(adapter->owner))
1169 mutex_unlock(&core_lists);
1172 EXPORT_SYMBOL(i2c_get_adapter);
1174 void i2c_put_adapter(struct i2c_adapter *adap)
1176 module_put(adap->owner);
1178 EXPORT_SYMBOL(i2c_put_adapter);
1180 /* The SMBus parts */
1182 #define POLY (0x1070U << 3)
1188 for(i = 0; i < 8; i++) {
1193 return (u8)(data >> 8);
1196 /* Incremental CRC8 over count bytes in the array pointed to by p */
1197 static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1201 for(i = 0; i < count; i++)
1202 crc = crc8((crc ^ p[i]) << 8);
1206 /* Assume a 7-bit address, which is reasonable for SMBus */
1207 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1209 /* The address will be sent first */
1210 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1211 pec = i2c_smbus_pec(pec, &addr, 1);
1213 /* The data buffer follows */
1214 return i2c_smbus_pec(pec, msg->buf, msg->len);
1217 /* Used for write only transactions */
1218 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1220 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1224 /* Return <0 on CRC error
1225 If there was a write before this read (most cases) we need to take the
1226 partial CRC from the write part into account.
1227 Note that this function does modify the message (we need to decrease the
1228 message length to hide the CRC byte from the caller). */
1229 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1231 u8 rpec = msg->buf[--msg->len];
1232 cpec = i2c_smbus_msg_pec(cpec, msg);
1235 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1242 s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
1244 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1245 value,0,I2C_SMBUS_QUICK,NULL);
1247 EXPORT_SYMBOL(i2c_smbus_write_quick);
1249 s32 i2c_smbus_read_byte(struct i2c_client *client)
1251 union i2c_smbus_data data;
1252 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1253 I2C_SMBUS_READ,0,I2C_SMBUS_BYTE, &data))
1258 EXPORT_SYMBOL(i2c_smbus_read_byte);
1260 s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1262 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1263 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1265 EXPORT_SYMBOL(i2c_smbus_write_byte);
1267 s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1269 union i2c_smbus_data data;
1270 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1271 I2C_SMBUS_READ,command, I2C_SMBUS_BYTE_DATA,&data))
1276 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1278 s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1280 union i2c_smbus_data data;
1282 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1283 I2C_SMBUS_WRITE,command,
1284 I2C_SMBUS_BYTE_DATA,&data);
1286 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1288 s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1290 union i2c_smbus_data data;
1291 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1292 I2C_SMBUS_READ,command, I2C_SMBUS_WORD_DATA, &data))
1297 EXPORT_SYMBOL(i2c_smbus_read_word_data);
1299 s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1301 union i2c_smbus_data data;
1303 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1304 I2C_SMBUS_WRITE,command,
1305 I2C_SMBUS_WORD_DATA,&data);
1307 EXPORT_SYMBOL(i2c_smbus_write_word_data);
1309 /* Returns the number of read bytes */
1310 s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1313 union i2c_smbus_data data;
1315 if (i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1316 I2C_SMBUS_READ, command,
1317 I2C_SMBUS_BLOCK_DATA, &data))
1320 memcpy(values, &data.block[1], data.block[0]);
1321 return data.block[0];
1323 EXPORT_SYMBOL(i2c_smbus_read_block_data);
1325 s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1326 u8 length, const u8 *values)
1328 union i2c_smbus_data data;
1330 if (length > I2C_SMBUS_BLOCK_MAX)
1331 length = I2C_SMBUS_BLOCK_MAX;
1332 data.block[0] = length;
1333 memcpy(&data.block[1], values, length);
1334 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1335 I2C_SMBUS_WRITE,command,
1336 I2C_SMBUS_BLOCK_DATA,&data);
1338 EXPORT_SYMBOL(i2c_smbus_write_block_data);
1340 /* Returns the number of read bytes */
1341 s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1342 u8 length, u8 *values)
1344 union i2c_smbus_data data;
1346 if (length > I2C_SMBUS_BLOCK_MAX)
1347 length = I2C_SMBUS_BLOCK_MAX;
1348 data.block[0] = length;
1349 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1350 I2C_SMBUS_READ,command,
1351 I2C_SMBUS_I2C_BLOCK_DATA,&data))
1354 memcpy(values, &data.block[1], data.block[0]);
1355 return data.block[0];
1357 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1359 s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1360 u8 length, const u8 *values)
1362 union i2c_smbus_data data;
1364 if (length > I2C_SMBUS_BLOCK_MAX)
1365 length = I2C_SMBUS_BLOCK_MAX;
1366 data.block[0] = length;
1367 memcpy(data.block + 1, values, length);
1368 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1369 I2C_SMBUS_WRITE, command,
1370 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1372 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1374 /* Simulate a SMBus command using the i2c protocol
1375 No checking of parameters is done! */
1376 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
1377 unsigned short flags,
1378 char read_write, u8 command, int size,
1379 union i2c_smbus_data * data)
1381 /* So we need to generate a series of msgs. In the case of writing, we
1382 need to use only one message; when reading, we need two. We initialize
1383 most things with sane defaults, to keep the code below somewhat
1385 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1386 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1387 int num = read_write == I2C_SMBUS_READ?2:1;
1388 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1389 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1394 msgbuf0[0] = command;
1396 case I2C_SMBUS_QUICK:
1398 /* Special case: The read/write field is used as data */
1399 msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
1402 case I2C_SMBUS_BYTE:
1403 if (read_write == I2C_SMBUS_READ) {
1404 /* Special case: only a read! */
1405 msg[0].flags = I2C_M_RD | flags;
1409 case I2C_SMBUS_BYTE_DATA:
1410 if (read_write == I2C_SMBUS_READ)
1414 msgbuf0[1] = data->byte;
1417 case I2C_SMBUS_WORD_DATA:
1418 if (read_write == I2C_SMBUS_READ)
1422 msgbuf0[1] = data->word & 0xff;
1423 msgbuf0[2] = data->word >> 8;
1426 case I2C_SMBUS_PROC_CALL:
1427 num = 2; /* Special case */
1428 read_write = I2C_SMBUS_READ;
1431 msgbuf0[1] = data->word & 0xff;
1432 msgbuf0[2] = data->word >> 8;
1434 case I2C_SMBUS_BLOCK_DATA:
1435 if (read_write == I2C_SMBUS_READ) {
1436 msg[1].flags |= I2C_M_RECV_LEN;
1437 msg[1].len = 1; /* block length will be added by
1438 the underlying bus driver */
1440 msg[0].len = data->block[0] + 2;
1441 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1442 dev_err(&adapter->dev, "smbus_access called with "
1443 "invalid block write size (%d)\n",
1447 for (i = 1; i < msg[0].len; i++)
1448 msgbuf0[i] = data->block[i-1];
1451 case I2C_SMBUS_BLOCK_PROC_CALL:
1452 num = 2; /* Another special case */
1453 read_write = I2C_SMBUS_READ;
1454 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1455 dev_err(&adapter->dev, "%s called with invalid "
1456 "block proc call size (%d)\n", __FUNCTION__,
1460 msg[0].len = data->block[0] + 2;
1461 for (i = 1; i < msg[0].len; i++)
1462 msgbuf0[i] = data->block[i-1];
1463 msg[1].flags |= I2C_M_RECV_LEN;
1464 msg[1].len = 1; /* block length will be added by
1465 the underlying bus driver */
1467 case I2C_SMBUS_I2C_BLOCK_DATA:
1468 if (read_write == I2C_SMBUS_READ) {
1469 msg[1].len = data->block[0];
1471 msg[0].len = data->block[0] + 1;
1472 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
1473 dev_err(&adapter->dev, "i2c_smbus_xfer_emulated called with "
1474 "invalid block write size (%d)\n",
1478 for (i = 1; i <= data->block[0]; i++)
1479 msgbuf0[i] = data->block[i];
1483 dev_err(&adapter->dev, "smbus_access called with invalid size (%d)\n",
1488 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1489 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1491 /* Compute PEC if first message is a write */
1492 if (!(msg[0].flags & I2C_M_RD)) {
1493 if (num == 1) /* Write only */
1494 i2c_smbus_add_pec(&msg[0]);
1495 else /* Write followed by read */
1496 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1498 /* Ask for PEC if last message is a read */
1499 if (msg[num-1].flags & I2C_M_RD)
1503 if (i2c_transfer(adapter, msg, num) < 0)
1506 /* Check PEC if last message is a read */
1507 if (i && (msg[num-1].flags & I2C_M_RD)) {
1508 if (i2c_smbus_check_pec(partial_pec, &msg[num-1]) < 0)
1512 if (read_write == I2C_SMBUS_READ)
1514 case I2C_SMBUS_BYTE:
1515 data->byte = msgbuf0[0];
1517 case I2C_SMBUS_BYTE_DATA:
1518 data->byte = msgbuf1[0];
1520 case I2C_SMBUS_WORD_DATA:
1521 case I2C_SMBUS_PROC_CALL:
1522 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1524 case I2C_SMBUS_I2C_BLOCK_DATA:
1525 for (i = 0; i < data->block[0]; i++)
1526 data->block[i+1] = msgbuf1[i];
1528 case I2C_SMBUS_BLOCK_DATA:
1529 case I2C_SMBUS_BLOCK_PROC_CALL:
1530 for (i = 0; i < msgbuf1[0] + 1; i++)
1531 data->block[i] = msgbuf1[i];
1538 s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
1539 char read_write, u8 command, int size,
1540 union i2c_smbus_data * data)
1544 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
1546 if (adapter->algo->smbus_xfer) {
1547 mutex_lock(&adapter->bus_lock);
1548 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
1550 mutex_unlock(&adapter->bus_lock);
1552 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
1557 EXPORT_SYMBOL(i2c_smbus_xfer);
1559 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1560 MODULE_DESCRIPTION("I2C-Bus main module");
1561 MODULE_LICENSE("GPL");