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>
24 Mux support by Rodolfo Giometti <giometti@enneenne.com> and
25 Michael Lawnick <michael.lawnick.ext@nsn.com> */
27 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/errno.h>
30 #include <linux/slab.h>
31 #include <linux/i2c.h>
32 #include <linux/init.h>
33 #include <linux/idr.h>
34 #include <linux/mutex.h>
35 #include <linux/of_device.h>
36 #include <linux/completion.h>
37 #include <linux/hardirq.h>
38 #include <linux/irqflags.h>
39 #include <linux/rwsem.h>
40 #include <linux/pm_runtime.h>
41 #include <asm/uaccess.h>
46 /* core_lock protects i2c_adapter_idr, and guarantees
47 that device detection, deletion of detected devices, and attach_adapter
48 and detach_adapter calls are serialized */
49 static DEFINE_MUTEX(core_lock);
50 static DEFINE_IDR(i2c_adapter_idr);
52 static struct device_type i2c_client_type;
53 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
55 /* ------------------------------------------------------------------------- */
57 static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
58 const struct i2c_client *client)
61 if (strcmp(client->name, id->name) == 0)
68 static int i2c_device_match(struct device *dev, struct device_driver *drv)
70 struct i2c_client *client = i2c_verify_client(dev);
71 struct i2c_driver *driver;
76 /* Attempt an OF style match */
77 if (of_driver_match_device(dev, drv))
80 driver = to_i2c_driver(drv);
81 /* match on an id table if there is one */
83 return i2c_match_id(driver->id_table, client) != NULL;
90 /* uevent helps with hotplug: modprobe -q $(MODALIAS) */
91 static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
93 struct i2c_client *client = to_i2c_client(dev);
95 if (add_uevent_var(env, "MODALIAS=%s%s",
96 I2C_MODULE_PREFIX, client->name))
98 dev_dbg(dev, "uevent\n");
103 #define i2c_device_uevent NULL
104 #endif /* CONFIG_HOTPLUG */
106 static int i2c_device_probe(struct device *dev)
108 struct i2c_client *client = i2c_verify_client(dev);
109 struct i2c_driver *driver;
115 driver = to_i2c_driver(dev->driver);
116 if (!driver->probe || !driver->id_table)
118 client->driver = driver;
119 if (!device_can_wakeup(&client->dev))
120 device_init_wakeup(&client->dev,
121 client->flags & I2C_CLIENT_WAKE);
122 dev_dbg(dev, "probe\n");
124 status = driver->probe(client, i2c_match_id(driver->id_table, client));
126 client->driver = NULL;
127 i2c_set_clientdata(client, NULL);
132 static int i2c_device_remove(struct device *dev)
134 struct i2c_client *client = i2c_verify_client(dev);
135 struct i2c_driver *driver;
138 if (!client || !dev->driver)
141 driver = to_i2c_driver(dev->driver);
142 if (driver->remove) {
143 dev_dbg(dev, "remove\n");
144 status = driver->remove(client);
150 client->driver = NULL;
151 i2c_set_clientdata(client, NULL);
156 static void i2c_device_shutdown(struct device *dev)
158 struct i2c_client *client = i2c_verify_client(dev);
159 struct i2c_driver *driver;
161 if (!client || !dev->driver)
163 driver = to_i2c_driver(dev->driver);
164 if (driver->shutdown)
165 driver->shutdown(client);
168 #ifdef CONFIG_PM_SLEEP
169 static int i2c_legacy_suspend(struct device *dev, pm_message_t mesg)
171 struct i2c_client *client = i2c_verify_client(dev);
172 struct i2c_driver *driver;
174 if (!client || !dev->driver)
176 driver = to_i2c_driver(dev->driver);
177 if (!driver->suspend)
179 return driver->suspend(client, mesg);
182 static int i2c_legacy_resume(struct device *dev)
184 struct i2c_client *client = i2c_verify_client(dev);
185 struct i2c_driver *driver;
187 if (!client || !dev->driver)
189 driver = to_i2c_driver(dev->driver);
192 return driver->resume(client);
195 static int i2c_device_pm_suspend(struct device *dev)
197 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
200 if (pm_runtime_suspended(dev))
203 return pm->suspend ? pm->suspend(dev) : 0;
206 return i2c_legacy_suspend(dev, PMSG_SUSPEND);
209 static int i2c_device_pm_resume(struct device *dev)
211 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
215 ret = pm->resume ? pm->resume(dev) : 0;
217 ret = i2c_legacy_resume(dev);
222 static int i2c_device_pm_freeze(struct device *dev)
224 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
227 if (pm_runtime_suspended(dev))
230 return pm->freeze ? pm->freeze(dev) : 0;
233 return i2c_legacy_suspend(dev, PMSG_FREEZE);
236 static int i2c_device_pm_thaw(struct device *dev)
238 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
241 if (pm_runtime_suspended(dev))
244 return pm->thaw ? pm->thaw(dev) : 0;
247 return i2c_legacy_resume(dev);
250 static int i2c_device_pm_poweroff(struct device *dev)
252 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
255 if (pm_runtime_suspended(dev))
258 return pm->poweroff ? pm->poweroff(dev) : 0;
261 return i2c_legacy_suspend(dev, PMSG_HIBERNATE);
264 static int i2c_device_pm_restore(struct device *dev)
266 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
270 ret = pm->restore ? pm->restore(dev) : 0;
272 ret = i2c_legacy_resume(dev);
275 pm_runtime_disable(dev);
276 pm_runtime_set_active(dev);
277 pm_runtime_enable(dev);
282 #else /* !CONFIG_PM_SLEEP */
283 #define i2c_device_pm_suspend NULL
284 #define i2c_device_pm_resume NULL
285 #define i2c_device_pm_freeze NULL
286 #define i2c_device_pm_thaw NULL
287 #define i2c_device_pm_poweroff NULL
288 #define i2c_device_pm_restore NULL
289 #endif /* !CONFIG_PM_SLEEP */
291 static void i2c_client_dev_release(struct device *dev)
293 kfree(to_i2c_client(dev));
297 show_name(struct device *dev, struct device_attribute *attr, char *buf)
299 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
300 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
304 show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
306 struct i2c_client *client = to_i2c_client(dev);
307 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
310 static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
311 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
313 static struct attribute *i2c_dev_attrs[] = {
315 /* modalias helps coldplug: modprobe $(cat .../modalias) */
316 &dev_attr_modalias.attr,
320 static struct attribute_group i2c_dev_attr_group = {
321 .attrs = i2c_dev_attrs,
324 static const struct attribute_group *i2c_dev_attr_groups[] = {
329 static const struct dev_pm_ops i2c_device_pm_ops = {
330 .suspend = i2c_device_pm_suspend,
331 .resume = i2c_device_pm_resume,
332 .freeze = i2c_device_pm_freeze,
333 .thaw = i2c_device_pm_thaw,
334 .poweroff = i2c_device_pm_poweroff,
335 .restore = i2c_device_pm_restore,
337 pm_generic_runtime_suspend,
338 pm_generic_runtime_resume,
339 pm_generic_runtime_idle
343 struct bus_type i2c_bus_type = {
345 .match = i2c_device_match,
346 .probe = i2c_device_probe,
347 .remove = i2c_device_remove,
348 .shutdown = i2c_device_shutdown,
349 .pm = &i2c_device_pm_ops,
351 EXPORT_SYMBOL_GPL(i2c_bus_type);
353 static struct device_type i2c_client_type = {
354 .groups = i2c_dev_attr_groups,
355 .uevent = i2c_device_uevent,
356 .release = i2c_client_dev_release,
361 * i2c_verify_client - return parameter as i2c_client, or NULL
362 * @dev: device, probably from some driver model iterator
364 * When traversing the driver model tree, perhaps using driver model
365 * iterators like @device_for_each_child(), you can't assume very much
366 * about the nodes you find. Use this function to avoid oopses caused
367 * by wrongly treating some non-I2C device as an i2c_client.
369 struct i2c_client *i2c_verify_client(struct device *dev)
371 return (dev->type == &i2c_client_type)
375 EXPORT_SYMBOL(i2c_verify_client);
378 /* This is a permissive address validity check, I2C address map constraints
379 * are purposedly not enforced, except for the general call address. */
380 static int i2c_check_client_addr_validity(const struct i2c_client *client)
382 if (client->flags & I2C_CLIENT_TEN) {
383 /* 10-bit address, all values are valid */
384 if (client->addr > 0x3ff)
387 /* 7-bit address, reject the general call address */
388 if (client->addr == 0x00 || client->addr > 0x7f)
394 /* And this is a strict address validity check, used when probing. If a
395 * device uses a reserved address, then it shouldn't be probed. 7-bit
396 * addressing is assumed, 10-bit address devices are rare and should be
397 * explicitly enumerated. */
398 static int i2c_check_addr_validity(unsigned short addr)
401 * Reserved addresses per I2C specification:
402 * 0x00 General call address / START byte
404 * 0x02 Reserved for different bus format
405 * 0x03 Reserved for future purposes
406 * 0x04-0x07 Hs-mode master code
407 * 0x78-0x7b 10-bit slave addressing
408 * 0x7c-0x7f Reserved for future purposes
410 if (addr < 0x08 || addr > 0x77)
415 static int __i2c_check_addr_busy(struct device *dev, void *addrp)
417 struct i2c_client *client = i2c_verify_client(dev);
418 int addr = *(int *)addrp;
420 if (client && client->addr == addr)
425 /* walk up mux tree */
426 static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
428 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
431 result = device_for_each_child(&adapter->dev, &addr,
432 __i2c_check_addr_busy);
434 if (!result && parent)
435 result = i2c_check_mux_parents(parent, addr);
440 /* recurse down mux tree */
441 static int i2c_check_mux_children(struct device *dev, void *addrp)
445 if (dev->type == &i2c_adapter_type)
446 result = device_for_each_child(dev, addrp,
447 i2c_check_mux_children);
449 result = __i2c_check_addr_busy(dev, addrp);
454 static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
456 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
460 result = i2c_check_mux_parents(parent, addr);
463 result = device_for_each_child(&adapter->dev, &addr,
464 i2c_check_mux_children);
470 * i2c_lock_adapter - Get exclusive access to an I2C bus segment
471 * @adapter: Target I2C bus segment
473 void i2c_lock_adapter(struct i2c_adapter *adapter)
475 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
478 i2c_lock_adapter(parent);
480 rt_mutex_lock(&adapter->bus_lock);
482 EXPORT_SYMBOL_GPL(i2c_lock_adapter);
485 * i2c_trylock_adapter - Try to get exclusive access to an I2C bus segment
486 * @adapter: Target I2C bus segment
488 static int i2c_trylock_adapter(struct i2c_adapter *adapter)
490 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
493 return i2c_trylock_adapter(parent);
495 return rt_mutex_trylock(&adapter->bus_lock);
499 * i2c_unlock_adapter - Release exclusive access to an I2C bus segment
500 * @adapter: Target I2C bus segment
502 void i2c_unlock_adapter(struct i2c_adapter *adapter)
504 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
507 i2c_unlock_adapter(parent);
509 rt_mutex_unlock(&adapter->bus_lock);
511 EXPORT_SYMBOL_GPL(i2c_unlock_adapter);
514 * i2c_new_device - instantiate an i2c device
515 * @adap: the adapter managing the device
516 * @info: describes one I2C device; bus_num is ignored
519 * Create an i2c device. Binding is handled through driver model
520 * probe()/remove() methods. A driver may be bound to this device when we
521 * return from this function, or any later moment (e.g. maybe hotplugging will
522 * load the driver module). This call is not appropriate for use by mainboard
523 * initialization logic, which usually runs during an arch_initcall() long
524 * before any i2c_adapter could exist.
526 * This returns the new i2c client, which may be saved for later use with
527 * i2c_unregister_device(); or NULL to indicate an error.
530 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
532 struct i2c_client *client;
535 client = kzalloc(sizeof *client, GFP_KERNEL);
539 client->adapter = adap;
541 client->dev.platform_data = info->platform_data;
544 client->dev.archdata = *info->archdata;
546 client->flags = info->flags;
547 client->addr = info->addr;
548 client->irq = info->irq;
550 strlcpy(client->name, info->type, sizeof(client->name));
552 /* Check for address validity */
553 status = i2c_check_client_addr_validity(client);
555 dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
556 client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
560 /* Check for address business */
561 status = i2c_check_addr_busy(adap, client->addr);
565 client->dev.parent = &client->adapter->dev;
566 client->dev.bus = &i2c_bus_type;
567 client->dev.type = &i2c_client_type;
569 client->dev.of_node = info->of_node;
572 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
574 status = device_register(&client->dev);
578 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
579 client->name, dev_name(&client->dev));
584 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
585 "(%d)\n", client->name, client->addr, status);
590 EXPORT_SYMBOL_GPL(i2c_new_device);
594 * i2c_unregister_device - reverse effect of i2c_new_device()
595 * @client: value returned from i2c_new_device()
598 void i2c_unregister_device(struct i2c_client *client)
600 device_unregister(&client->dev);
602 EXPORT_SYMBOL_GPL(i2c_unregister_device);
605 static const struct i2c_device_id dummy_id[] = {
610 static int dummy_probe(struct i2c_client *client,
611 const struct i2c_device_id *id)
616 static int dummy_remove(struct i2c_client *client)
621 static struct i2c_driver dummy_driver = {
622 .driver.name = "dummy",
623 .probe = dummy_probe,
624 .remove = dummy_remove,
625 .id_table = dummy_id,
629 * i2c_new_dummy - return a new i2c device bound to a dummy driver
630 * @adapter: the adapter managing the device
631 * @address: seven bit address to be used
634 * This returns an I2C client bound to the "dummy" driver, intended for use
635 * with devices that consume multiple addresses. Examples of such chips
636 * include various EEPROMS (like 24c04 and 24c08 models).
638 * These dummy devices have two main uses. First, most I2C and SMBus calls
639 * except i2c_transfer() need a client handle; the dummy will be that handle.
640 * And second, this prevents the specified address from being bound to a
643 * This returns the new i2c client, which should be saved for later use with
644 * i2c_unregister_device(); or NULL to indicate an error.
646 struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
648 struct i2c_board_info info = {
649 I2C_BOARD_INFO("dummy", address),
652 return i2c_new_device(adapter, &info);
654 EXPORT_SYMBOL_GPL(i2c_new_dummy);
656 /* ------------------------------------------------------------------------- */
658 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
660 static void i2c_adapter_dev_release(struct device *dev)
662 struct i2c_adapter *adap = to_i2c_adapter(dev);
663 complete(&adap->dev_released);
667 * Let users instantiate I2C devices through sysfs. This can be used when
668 * platform initialization code doesn't contain the proper data for
669 * whatever reason. Also useful for drivers that do device detection and
670 * detection fails, either because the device uses an unexpected address,
671 * or this is a compatible device with different ID register values.
673 * Parameter checking may look overzealous, but we really don't want
674 * the user to provide incorrect parameters.
677 i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
678 const char *buf, size_t count)
680 struct i2c_adapter *adap = to_i2c_adapter(dev);
681 struct i2c_board_info info;
682 struct i2c_client *client;
686 memset(&info, 0, sizeof(struct i2c_board_info));
688 blank = strchr(buf, ' ');
690 dev_err(dev, "%s: Missing parameters\n", "new_device");
693 if (blank - buf > I2C_NAME_SIZE - 1) {
694 dev_err(dev, "%s: Invalid device name\n", "new_device");
697 memcpy(info.type, buf, blank - buf);
699 /* Parse remaining parameters, reject extra parameters */
700 res = sscanf(++blank, "%hi%c", &info.addr, &end);
702 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
705 if (res > 1 && end != '\n') {
706 dev_err(dev, "%s: Extra parameters\n", "new_device");
710 client = i2c_new_device(adap, &info);
714 /* Keep track of the added device */
715 mutex_lock(&adap->userspace_clients_lock);
716 list_add_tail(&client->detected, &adap->userspace_clients);
717 mutex_unlock(&adap->userspace_clients_lock);
718 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
719 info.type, info.addr);
725 * And of course let the users delete the devices they instantiated, if
726 * they got it wrong. This interface can only be used to delete devices
727 * instantiated by i2c_sysfs_new_device above. This guarantees that we
728 * don't delete devices to which some kernel code still has references.
730 * Parameter checking may look overzealous, but we really don't want
731 * the user to delete the wrong device.
734 i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
735 const char *buf, size_t count)
737 struct i2c_adapter *adap = to_i2c_adapter(dev);
738 struct i2c_client *client, *next;
743 /* Parse parameters, reject extra parameters */
744 res = sscanf(buf, "%hi%c", &addr, &end);
746 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
749 if (res > 1 && end != '\n') {
750 dev_err(dev, "%s: Extra parameters\n", "delete_device");
754 /* Make sure the device was added through sysfs */
756 mutex_lock(&adap->userspace_clients_lock);
757 list_for_each_entry_safe(client, next, &adap->userspace_clients,
759 if (client->addr == addr) {
760 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
761 "delete_device", client->name, client->addr);
763 list_del(&client->detected);
764 i2c_unregister_device(client);
769 mutex_unlock(&adap->userspace_clients_lock);
772 dev_err(dev, "%s: Can't find device in list\n",
777 static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
778 static DEVICE_ATTR(delete_device, S_IWUSR, NULL, i2c_sysfs_delete_device);
780 static struct attribute *i2c_adapter_attrs[] = {
782 &dev_attr_new_device.attr,
783 &dev_attr_delete_device.attr,
787 static struct attribute_group i2c_adapter_attr_group = {
788 .attrs = i2c_adapter_attrs,
791 static const struct attribute_group *i2c_adapter_attr_groups[] = {
792 &i2c_adapter_attr_group,
796 struct device_type i2c_adapter_type = {
797 .groups = i2c_adapter_attr_groups,
798 .release = i2c_adapter_dev_release,
800 EXPORT_SYMBOL_GPL(i2c_adapter_type);
802 #ifdef CONFIG_I2C_COMPAT
803 static struct class_compat *i2c_adapter_compat_class;
806 static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
808 struct i2c_devinfo *devinfo;
810 down_read(&__i2c_board_lock);
811 list_for_each_entry(devinfo, &__i2c_board_list, list) {
812 if (devinfo->busnum == adapter->nr
813 && !i2c_new_device(adapter,
814 &devinfo->board_info))
815 dev_err(&adapter->dev,
816 "Can't create device at 0x%02x\n",
817 devinfo->board_info.addr);
819 up_read(&__i2c_board_lock);
822 static int i2c_do_add_adapter(struct i2c_driver *driver,
823 struct i2c_adapter *adap)
825 /* Detect supported devices on that bus, and instantiate them */
826 i2c_detect(adap, driver);
828 /* Let legacy drivers scan this bus for matching devices */
829 if (driver->attach_adapter) {
830 /* We ignore the return code; if it fails, too bad */
831 driver->attach_adapter(adap);
836 static int __process_new_adapter(struct device_driver *d, void *data)
838 return i2c_do_add_adapter(to_i2c_driver(d), data);
841 static int i2c_register_adapter(struct i2c_adapter *adap)
845 /* Can't register until after driver model init */
846 if (unlikely(WARN_ON(!i2c_bus_type.p))) {
852 if (unlikely(adap->name[0] == '\0')) {
853 pr_err("i2c-core: Attempt to register an adapter with "
857 if (unlikely(!adap->algo)) {
858 pr_err("i2c-core: Attempt to register adapter '%s' with "
859 "no algo!\n", adap->name);
863 rt_mutex_init(&adap->bus_lock);
864 mutex_init(&adap->userspace_clients_lock);
865 INIT_LIST_HEAD(&adap->userspace_clients);
867 /* Set default timeout to 1 second if not already set */
868 if (adap->timeout == 0)
871 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
872 adap->dev.bus = &i2c_bus_type;
873 adap->dev.type = &i2c_adapter_type;
874 res = device_register(&adap->dev);
878 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
880 #ifdef CONFIG_I2C_COMPAT
881 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
885 "Failed to create compatibility class link\n");
888 /* create pre-declared device nodes */
889 if (adap->nr < __i2c_first_dynamic_bus_num)
890 i2c_scan_static_board_info(adap);
893 mutex_lock(&core_lock);
894 bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
895 mutex_unlock(&core_lock);
900 mutex_lock(&core_lock);
901 idr_remove(&i2c_adapter_idr, adap->nr);
902 mutex_unlock(&core_lock);
907 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
908 * @adapter: the adapter to add
911 * This routine is used to declare an I2C adapter when its bus number
912 * doesn't matter. Examples: for I2C adapters dynamically added by
913 * USB links or PCI plugin cards.
915 * When this returns zero, a new bus number was allocated and stored
916 * in adap->nr, and the specified adapter became available for clients.
917 * Otherwise, a negative errno value is returned.
919 int i2c_add_adapter(struct i2c_adapter *adapter)
924 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
927 mutex_lock(&core_lock);
928 /* "above" here means "above or equal to", sigh */
929 res = idr_get_new_above(&i2c_adapter_idr, adapter,
930 __i2c_first_dynamic_bus_num, &id);
931 mutex_unlock(&core_lock);
940 return i2c_register_adapter(adapter);
942 EXPORT_SYMBOL(i2c_add_adapter);
945 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
946 * @adap: the adapter to register (with adap->nr initialized)
949 * This routine is used to declare an I2C adapter when its bus number
950 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
951 * or otherwise built in to the system's mainboard, and where i2c_board_info
952 * is used to properly configure I2C devices.
954 * If no devices have pre-been declared for this bus, then be sure to
955 * register the adapter before any dynamically allocated ones. Otherwise
956 * the required bus ID may not be available.
958 * When this returns zero, the specified adapter became available for
959 * clients using the bus number provided in adap->nr. Also, the table
960 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
961 * and the appropriate driver model device nodes are created. Otherwise, a
962 * negative errno value is returned.
964 int i2c_add_numbered_adapter(struct i2c_adapter *adap)
969 if (adap->nr & ~MAX_ID_MASK)
973 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
976 mutex_lock(&core_lock);
977 /* "above" here means "above or equal to", sigh;
978 * we need the "equal to" result to force the result
980 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
981 if (status == 0 && id != adap->nr) {
983 idr_remove(&i2c_adapter_idr, id);
985 mutex_unlock(&core_lock);
986 if (status == -EAGAIN)
990 status = i2c_register_adapter(adap);
993 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
995 static int i2c_do_del_adapter(struct i2c_driver *driver,
996 struct i2c_adapter *adapter)
998 struct i2c_client *client, *_n;
1001 /* Remove the devices we created ourselves as the result of hardware
1002 * probing (using a driver's detect method) */
1003 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
1004 if (client->adapter == adapter) {
1005 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
1006 client->name, client->addr);
1007 list_del(&client->detected);
1008 i2c_unregister_device(client);
1012 if (!driver->detach_adapter)
1014 res = driver->detach_adapter(adapter);
1016 dev_err(&adapter->dev, "detach_adapter failed (%d) "
1017 "for driver [%s]\n", res, driver->driver.name);
1021 static int __unregister_client(struct device *dev, void *dummy)
1023 struct i2c_client *client = i2c_verify_client(dev);
1025 i2c_unregister_device(client);
1029 static int __process_removed_adapter(struct device_driver *d, void *data)
1031 return i2c_do_del_adapter(to_i2c_driver(d), data);
1035 * i2c_del_adapter - unregister I2C adapter
1036 * @adap: the adapter being unregistered
1037 * Context: can sleep
1039 * This unregisters an I2C adapter which was previously registered
1040 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1042 int i2c_del_adapter(struct i2c_adapter *adap)
1045 struct i2c_adapter *found;
1046 struct i2c_client *client, *next;
1048 /* First make sure that this adapter was ever added */
1049 mutex_lock(&core_lock);
1050 found = idr_find(&i2c_adapter_idr, adap->nr);
1051 mutex_unlock(&core_lock);
1052 if (found != adap) {
1053 pr_debug("i2c-core: attempting to delete unregistered "
1054 "adapter [%s]\n", adap->name);
1058 /* Tell drivers about this removal */
1059 mutex_lock(&core_lock);
1060 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
1061 __process_removed_adapter);
1062 mutex_unlock(&core_lock);
1066 /* Remove devices instantiated from sysfs */
1067 mutex_lock(&adap->userspace_clients_lock);
1068 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1070 dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
1072 list_del(&client->detected);
1073 i2c_unregister_device(client);
1075 mutex_unlock(&adap->userspace_clients_lock);
1077 /* Detach any active clients. This can't fail, thus we do not
1078 checking the returned value. */
1079 res = device_for_each_child(&adap->dev, NULL, __unregister_client);
1081 #ifdef CONFIG_I2C_COMPAT
1082 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
1086 /* device name is gone after device_unregister */
1087 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
1089 /* clean up the sysfs representation */
1090 init_completion(&adap->dev_released);
1091 device_unregister(&adap->dev);
1093 /* wait for sysfs to drop all references */
1094 wait_for_completion(&adap->dev_released);
1097 mutex_lock(&core_lock);
1098 idr_remove(&i2c_adapter_idr, adap->nr);
1099 mutex_unlock(&core_lock);
1101 /* Clear the device structure in case this adapter is ever going to be
1103 memset(&adap->dev, 0, sizeof(adap->dev));
1107 EXPORT_SYMBOL(i2c_del_adapter);
1110 /* ------------------------------------------------------------------------- */
1112 static int __process_new_driver(struct device *dev, void *data)
1114 if (dev->type != &i2c_adapter_type)
1116 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
1120 * An i2c_driver is used with one or more i2c_client (device) nodes to access
1121 * i2c slave chips, on a bus instance associated with some i2c_adapter.
1124 int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
1128 /* Can't register until after driver model init */
1129 if (unlikely(WARN_ON(!i2c_bus_type.p)))
1132 /* add the driver to the list of i2c drivers in the driver core */
1133 driver->driver.owner = owner;
1134 driver->driver.bus = &i2c_bus_type;
1136 /* When registration returns, the driver core
1137 * will have called probe() for all matching-but-unbound devices.
1139 res = driver_register(&driver->driver);
1143 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
1145 INIT_LIST_HEAD(&driver->clients);
1146 /* Walk the adapters that are already present */
1147 mutex_lock(&core_lock);
1148 bus_for_each_dev(&i2c_bus_type, NULL, driver, __process_new_driver);
1149 mutex_unlock(&core_lock);
1153 EXPORT_SYMBOL(i2c_register_driver);
1155 static int __process_removed_driver(struct device *dev, void *data)
1157 if (dev->type != &i2c_adapter_type)
1159 return i2c_do_del_adapter(data, to_i2c_adapter(dev));
1163 * i2c_del_driver - unregister I2C driver
1164 * @driver: the driver being unregistered
1165 * Context: can sleep
1167 void i2c_del_driver(struct i2c_driver *driver)
1169 mutex_lock(&core_lock);
1170 bus_for_each_dev(&i2c_bus_type, NULL, driver, __process_removed_driver);
1171 mutex_unlock(&core_lock);
1173 driver_unregister(&driver->driver);
1174 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
1176 EXPORT_SYMBOL(i2c_del_driver);
1178 /* ------------------------------------------------------------------------- */
1181 * i2c_use_client - increments the reference count of the i2c client structure
1182 * @client: the client being referenced
1184 * Each live reference to a client should be refcounted. The driver model does
1185 * that automatically as part of driver binding, so that most drivers don't
1186 * need to do this explicitly: they hold a reference until they're unbound
1189 * A pointer to the client with the incremented reference counter is returned.
1191 struct i2c_client *i2c_use_client(struct i2c_client *client)
1193 if (client && get_device(&client->dev))
1197 EXPORT_SYMBOL(i2c_use_client);
1200 * i2c_release_client - release a use of the i2c client structure
1201 * @client: the client being no longer referenced
1203 * Must be called when a user of a client is finished with it.
1205 void i2c_release_client(struct i2c_client *client)
1208 put_device(&client->dev);
1210 EXPORT_SYMBOL(i2c_release_client);
1212 struct i2c_cmd_arg {
1217 static int i2c_cmd(struct device *dev, void *_arg)
1219 struct i2c_client *client = i2c_verify_client(dev);
1220 struct i2c_cmd_arg *arg = _arg;
1222 if (client && client->driver && client->driver->command)
1223 client->driver->command(client, arg->cmd, arg->arg);
1227 void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
1229 struct i2c_cmd_arg cmd_arg;
1233 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
1235 EXPORT_SYMBOL(i2c_clients_command);
1237 static int __init i2c_init(void)
1241 retval = bus_register(&i2c_bus_type);
1244 #ifdef CONFIG_I2C_COMPAT
1245 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
1246 if (!i2c_adapter_compat_class) {
1251 retval = i2c_add_driver(&dummy_driver);
1257 #ifdef CONFIG_I2C_COMPAT
1258 class_compat_unregister(i2c_adapter_compat_class);
1261 bus_unregister(&i2c_bus_type);
1265 static void __exit i2c_exit(void)
1267 i2c_del_driver(&dummy_driver);
1268 #ifdef CONFIG_I2C_COMPAT
1269 class_compat_unregister(i2c_adapter_compat_class);
1271 bus_unregister(&i2c_bus_type);
1274 /* We must initialize early, because some subsystems register i2c drivers
1275 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1277 postcore_initcall(i2c_init);
1278 module_exit(i2c_exit);
1280 /* ----------------------------------------------------
1281 * the functional interface to the i2c busses.
1282 * ----------------------------------------------------
1286 * i2c_transfer - execute a single or combined I2C message
1287 * @adap: Handle to I2C bus
1288 * @msgs: One or more messages to execute before STOP is issued to
1289 * terminate the operation; each message begins with a START.
1290 * @num: Number of messages to be executed.
1292 * Returns negative errno, else the number of messages executed.
1294 * Note that there is no requirement that each message be sent to
1295 * the same slave address, although that is the most common model.
1297 int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1299 unsigned long orig_jiffies;
1302 /* REVISIT the fault reporting model here is weak:
1304 * - When we get an error after receiving N bytes from a slave,
1305 * there is no way to report "N".
1307 * - When we get a NAK after transmitting N bytes to a slave,
1308 * there is no way to report "N" ... or to let the master
1309 * continue executing the rest of this combined message, if
1310 * that's the appropriate response.
1312 * - When for example "num" is two and we successfully complete
1313 * the first message but get an error part way through the
1314 * second, it's unclear whether that should be reported as
1315 * one (discarding status on the second message) or errno
1316 * (discarding status on the first one).
1319 if (adap->algo->master_xfer) {
1321 for (ret = 0; ret < num; ret++) {
1322 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
1323 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1324 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1325 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
1329 if (in_atomic() || irqs_disabled()) {
1330 ret = i2c_trylock_adapter(adap);
1332 /* I2C activity is ongoing. */
1335 i2c_lock_adapter(adap);
1338 /* Retry automatically on arbitration loss */
1339 orig_jiffies = jiffies;
1340 for (ret = 0, try = 0; try <= adap->retries; try++) {
1341 ret = adap->algo->master_xfer(adap, msgs, num);
1344 if (time_after(jiffies, orig_jiffies + adap->timeout))
1347 i2c_unlock_adapter(adap);
1351 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
1355 EXPORT_SYMBOL(i2c_transfer);
1358 * i2c_master_send - issue a single I2C message in master transmit mode
1359 * @client: Handle to slave device
1360 * @buf: Data that will be written to the slave
1361 * @count: How many bytes to write, must be less than 64k since msg.len is u16
1363 * Returns negative errno, or else the number of bytes written.
1365 int i2c_master_send(struct i2c_client *client, const char *buf, int count)
1368 struct i2c_adapter *adap = client->adapter;
1371 msg.addr = client->addr;
1372 msg.flags = client->flags & I2C_M_TEN;
1374 msg.buf = (char *)buf;
1376 ret = i2c_transfer(adap, &msg, 1);
1378 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1379 transmitted, else error code. */
1380 return (ret == 1) ? count : ret;
1382 EXPORT_SYMBOL(i2c_master_send);
1385 * i2c_master_recv - issue a single I2C message in master receive mode
1386 * @client: Handle to slave device
1387 * @buf: Where to store data read from slave
1388 * @count: How many bytes to read, must be less than 64k since msg.len is u16
1390 * Returns negative errno, or else the number of bytes read.
1392 int i2c_master_recv(struct i2c_client *client, char *buf, int count)
1394 struct i2c_adapter *adap = client->adapter;
1398 msg.addr = client->addr;
1399 msg.flags = client->flags & I2C_M_TEN;
1400 msg.flags |= I2C_M_RD;
1404 ret = i2c_transfer(adap, &msg, 1);
1406 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1407 transmitted, else error code. */
1408 return (ret == 1) ? count : ret;
1410 EXPORT_SYMBOL(i2c_master_recv);
1412 /* ----------------------------------------------------
1413 * the i2c address scanning function
1414 * Will not work for 10-bit addresses!
1415 * ----------------------------------------------------
1419 * Legacy default probe function, mostly relevant for SMBus. The default
1420 * probe method is a quick write, but it is known to corrupt the 24RF08
1421 * EEPROMs due to a state machine bug, and could also irreversibly
1422 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
1423 * we use a short byte read instead. Also, some bus drivers don't implement
1424 * quick write, so we fallback to a byte read in that case too.
1425 * On x86, there is another special case for FSC hardware monitoring chips,
1426 * which want regular byte reads (address 0x73.) Fortunately, these are the
1427 * only known chips using this I2C address on PC hardware.
1428 * Returns 1 if probe succeeded, 0 if not.
1430 static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
1433 union i2c_smbus_data dummy;
1436 if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
1437 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
1438 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1439 I2C_SMBUS_BYTE_DATA, &dummy);
1442 if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
1443 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
1444 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
1445 I2C_SMBUS_QUICK, NULL);
1446 else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
1447 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1448 I2C_SMBUS_BYTE, &dummy);
1450 dev_warn(&adap->dev, "No suitable probing method supported\n");
1457 static int i2c_detect_address(struct i2c_client *temp_client,
1458 struct i2c_driver *driver)
1460 struct i2c_board_info info;
1461 struct i2c_adapter *adapter = temp_client->adapter;
1462 int addr = temp_client->addr;
1465 /* Make sure the address is valid */
1466 err = i2c_check_addr_validity(addr);
1468 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1473 /* Skip if already in use */
1474 if (i2c_check_addr_busy(adapter, addr))
1477 /* Make sure there is something at this address */
1478 if (!i2c_default_probe(adapter, addr))
1481 /* Finally call the custom detection function */
1482 memset(&info, 0, sizeof(struct i2c_board_info));
1484 err = driver->detect(temp_client, &info);
1486 /* -ENODEV is returned if the detection fails. We catch it
1487 here as this isn't an error. */
1488 return err == -ENODEV ? 0 : err;
1491 /* Consistency check */
1492 if (info.type[0] == '\0') {
1493 dev_err(&adapter->dev, "%s detection function provided "
1494 "no name for 0x%x\n", driver->driver.name,
1497 struct i2c_client *client;
1499 /* Detection succeeded, instantiate the device */
1500 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1501 info.type, info.addr);
1502 client = i2c_new_device(adapter, &info);
1504 list_add_tail(&client->detected, &driver->clients);
1506 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1507 info.type, info.addr);
1512 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1514 const unsigned short *address_list;
1515 struct i2c_client *temp_client;
1517 int adap_id = i2c_adapter_id(adapter);
1519 address_list = driver->address_list;
1520 if (!driver->detect || !address_list)
1523 /* Stop here if the classes do not match */
1524 if (!(adapter->class & driver->class))
1527 /* Set up a temporary client to help detect callback */
1528 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1531 temp_client->adapter = adapter;
1533 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
1534 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1535 "addr 0x%02x\n", adap_id, address_list[i]);
1536 temp_client->addr = address_list[i];
1537 err = i2c_detect_address(temp_client, driver);
1546 int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
1548 return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1549 I2C_SMBUS_QUICK, NULL) >= 0;
1551 EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);
1554 i2c_new_probed_device(struct i2c_adapter *adap,
1555 struct i2c_board_info *info,
1556 unsigned short const *addr_list,
1557 int (*probe)(struct i2c_adapter *, unsigned short addr))
1562 probe = i2c_default_probe;
1564 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1565 /* Check address validity */
1566 if (i2c_check_addr_validity(addr_list[i]) < 0) {
1567 dev_warn(&adap->dev, "Invalid 7-bit address "
1568 "0x%02x\n", addr_list[i]);
1572 /* Check address availability */
1573 if (i2c_check_addr_busy(adap, addr_list[i])) {
1574 dev_dbg(&adap->dev, "Address 0x%02x already in "
1575 "use, not probing\n", addr_list[i]);
1579 /* Test address responsiveness */
1580 if (probe(adap, addr_list[i]))
1584 if (addr_list[i] == I2C_CLIENT_END) {
1585 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1589 info->addr = addr_list[i];
1590 return i2c_new_device(adap, info);
1592 EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1594 struct i2c_adapter *i2c_get_adapter(int id)
1596 struct i2c_adapter *adapter;
1598 mutex_lock(&core_lock);
1599 adapter = idr_find(&i2c_adapter_idr, id);
1600 if (adapter && !try_module_get(adapter->owner))
1603 mutex_unlock(&core_lock);
1606 EXPORT_SYMBOL(i2c_get_adapter);
1608 void i2c_put_adapter(struct i2c_adapter *adap)
1610 module_put(adap->owner);
1612 EXPORT_SYMBOL(i2c_put_adapter);
1614 /* The SMBus parts */
1616 #define POLY (0x1070U << 3)
1617 static u8 crc8(u16 data)
1621 for (i = 0; i < 8; i++) {
1626 return (u8)(data >> 8);
1629 /* Incremental CRC8 over count bytes in the array pointed to by p */
1630 static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1634 for (i = 0; i < count; i++)
1635 crc = crc8((crc ^ p[i]) << 8);
1639 /* Assume a 7-bit address, which is reasonable for SMBus */
1640 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1642 /* The address will be sent first */
1643 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1644 pec = i2c_smbus_pec(pec, &addr, 1);
1646 /* The data buffer follows */
1647 return i2c_smbus_pec(pec, msg->buf, msg->len);
1650 /* Used for write only transactions */
1651 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1653 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1657 /* Return <0 on CRC error
1658 If there was a write before this read (most cases) we need to take the
1659 partial CRC from the write part into account.
1660 Note that this function does modify the message (we need to decrease the
1661 message length to hide the CRC byte from the caller). */
1662 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1664 u8 rpec = msg->buf[--msg->len];
1665 cpec = i2c_smbus_msg_pec(cpec, msg);
1668 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1676 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1677 * @client: Handle to slave device
1679 * This executes the SMBus "receive byte" protocol, returning negative errno
1680 * else the byte received from the device.
1682 s32 i2c_smbus_read_byte(struct i2c_client *client)
1684 union i2c_smbus_data data;
1687 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1689 I2C_SMBUS_BYTE, &data);
1690 return (status < 0) ? status : data.byte;
1692 EXPORT_SYMBOL(i2c_smbus_read_byte);
1695 * i2c_smbus_write_byte - SMBus "send byte" protocol
1696 * @client: Handle to slave device
1697 * @value: Byte to be sent
1699 * This executes the SMBus "send byte" protocol, returning negative errno
1700 * else zero on success.
1702 s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1704 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1705 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1707 EXPORT_SYMBOL(i2c_smbus_write_byte);
1710 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1711 * @client: Handle to slave device
1712 * @command: Byte interpreted by slave
1714 * This executes the SMBus "read byte" protocol, returning negative errno
1715 * else a data byte received from the device.
1717 s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1719 union i2c_smbus_data data;
1722 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1723 I2C_SMBUS_READ, command,
1724 I2C_SMBUS_BYTE_DATA, &data);
1725 return (status < 0) ? status : data.byte;
1727 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1730 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1731 * @client: Handle to slave device
1732 * @command: Byte interpreted by slave
1733 * @value: Byte being written
1735 * This executes the SMBus "write byte" protocol, returning negative errno
1736 * else zero on success.
1738 s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1740 union i2c_smbus_data data;
1742 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1743 I2C_SMBUS_WRITE, command,
1744 I2C_SMBUS_BYTE_DATA, &data);
1746 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1749 * i2c_smbus_read_word_data - SMBus "read word" protocol
1750 * @client: Handle to slave device
1751 * @command: Byte interpreted by slave
1753 * This executes the SMBus "read word" protocol, returning negative errno
1754 * else a 16-bit unsigned "word" received from the device.
1756 s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1758 union i2c_smbus_data data;
1761 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1762 I2C_SMBUS_READ, command,
1763 I2C_SMBUS_WORD_DATA, &data);
1764 return (status < 0) ? status : data.word;
1766 EXPORT_SYMBOL(i2c_smbus_read_word_data);
1769 * i2c_smbus_write_word_data - SMBus "write word" protocol
1770 * @client: Handle to slave device
1771 * @command: Byte interpreted by slave
1772 * @value: 16-bit "word" being written
1774 * This executes the SMBus "write word" protocol, returning negative errno
1775 * else zero on success.
1777 s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1779 union i2c_smbus_data data;
1781 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1782 I2C_SMBUS_WRITE, command,
1783 I2C_SMBUS_WORD_DATA, &data);
1785 EXPORT_SYMBOL(i2c_smbus_write_word_data);
1788 * i2c_smbus_process_call - SMBus "process call" protocol
1789 * @client: Handle to slave device
1790 * @command: Byte interpreted by slave
1791 * @value: 16-bit "word" being written
1793 * This executes the SMBus "process call" protocol, returning negative errno
1794 * else a 16-bit unsigned "word" received from the device.
1796 s32 i2c_smbus_process_call(struct i2c_client *client, u8 command, u16 value)
1798 union i2c_smbus_data data;
1802 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1803 I2C_SMBUS_WRITE, command,
1804 I2C_SMBUS_PROC_CALL, &data);
1805 return (status < 0) ? status : data.word;
1807 EXPORT_SYMBOL(i2c_smbus_process_call);
1810 * i2c_smbus_read_block_data - SMBus "block read" protocol
1811 * @client: Handle to slave device
1812 * @command: Byte interpreted by slave
1813 * @values: Byte array into which data will be read; big enough to hold
1814 * the data returned by the slave. SMBus allows at most 32 bytes.
1816 * This executes the SMBus "block read" protocol, returning negative errno
1817 * else the number of data bytes in the slave's response.
1819 * Note that using this function requires that the client's adapter support
1820 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1821 * support this; its emulation through I2C messaging relies on a specific
1822 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1824 s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1827 union i2c_smbus_data data;
1830 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1831 I2C_SMBUS_READ, command,
1832 I2C_SMBUS_BLOCK_DATA, &data);
1836 memcpy(values, &data.block[1], data.block[0]);
1837 return data.block[0];
1839 EXPORT_SYMBOL(i2c_smbus_read_block_data);
1842 * i2c_smbus_write_block_data - SMBus "block write" protocol
1843 * @client: Handle to slave device
1844 * @command: Byte interpreted by slave
1845 * @length: Size of data block; SMBus allows at most 32 bytes
1846 * @values: Byte array which will be written.
1848 * This executes the SMBus "block write" protocol, returning negative errno
1849 * else zero on success.
1851 s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1852 u8 length, const u8 *values)
1854 union i2c_smbus_data data;
1856 if (length > I2C_SMBUS_BLOCK_MAX)
1857 length = I2C_SMBUS_BLOCK_MAX;
1858 data.block[0] = length;
1859 memcpy(&data.block[1], values, length);
1860 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1861 I2C_SMBUS_WRITE, command,
1862 I2C_SMBUS_BLOCK_DATA, &data);
1864 EXPORT_SYMBOL(i2c_smbus_write_block_data);
1866 /* Returns the number of read bytes */
1867 s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1868 u8 length, u8 *values)
1870 union i2c_smbus_data data;
1873 if (length > I2C_SMBUS_BLOCK_MAX)
1874 length = I2C_SMBUS_BLOCK_MAX;
1875 data.block[0] = length;
1876 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1877 I2C_SMBUS_READ, command,
1878 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1882 memcpy(values, &data.block[1], data.block[0]);
1883 return data.block[0];
1885 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1887 s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1888 u8 length, const u8 *values)
1890 union i2c_smbus_data data;
1892 if (length > I2C_SMBUS_BLOCK_MAX)
1893 length = I2C_SMBUS_BLOCK_MAX;
1894 data.block[0] = length;
1895 memcpy(data.block + 1, values, length);
1896 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1897 I2C_SMBUS_WRITE, command,
1898 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1900 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1902 /* Simulate a SMBus command using the i2c protocol
1903 No checking of parameters is done! */
1904 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter *adapter, u16 addr,
1905 unsigned short flags,
1906 char read_write, u8 command, int size,
1907 union i2c_smbus_data *data)
1909 /* So we need to generate a series of msgs. In the case of writing, we
1910 need to use only one message; when reading, we need two. We initialize
1911 most things with sane defaults, to keep the code below somewhat
1913 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1914 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1915 int num = read_write == I2C_SMBUS_READ ? 2 : 1;
1916 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1917 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1923 msgbuf0[0] = command;
1925 case I2C_SMBUS_QUICK:
1927 /* Special case: The read/write field is used as data */
1928 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
1932 case I2C_SMBUS_BYTE:
1933 if (read_write == I2C_SMBUS_READ) {
1934 /* Special case: only a read! */
1935 msg[0].flags = I2C_M_RD | flags;
1939 case I2C_SMBUS_BYTE_DATA:
1940 if (read_write == I2C_SMBUS_READ)
1944 msgbuf0[1] = data->byte;
1947 case I2C_SMBUS_WORD_DATA:
1948 if (read_write == I2C_SMBUS_READ)
1952 msgbuf0[1] = data->word & 0xff;
1953 msgbuf0[2] = data->word >> 8;
1956 case I2C_SMBUS_PROC_CALL:
1957 num = 2; /* Special case */
1958 read_write = I2C_SMBUS_READ;
1961 msgbuf0[1] = data->word & 0xff;
1962 msgbuf0[2] = data->word >> 8;
1964 case I2C_SMBUS_BLOCK_DATA:
1965 if (read_write == I2C_SMBUS_READ) {
1966 msg[1].flags |= I2C_M_RECV_LEN;
1967 msg[1].len = 1; /* block length will be added by
1968 the underlying bus driver */
1970 msg[0].len = data->block[0] + 2;
1971 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1972 dev_err(&adapter->dev,
1973 "Invalid block write size %d\n",
1977 for (i = 1; i < msg[0].len; i++)
1978 msgbuf0[i] = data->block[i-1];
1981 case I2C_SMBUS_BLOCK_PROC_CALL:
1982 num = 2; /* Another special case */
1983 read_write = I2C_SMBUS_READ;
1984 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1985 dev_err(&adapter->dev,
1986 "Invalid block write size %d\n",
1990 msg[0].len = data->block[0] + 2;
1991 for (i = 1; i < msg[0].len; i++)
1992 msgbuf0[i] = data->block[i-1];
1993 msg[1].flags |= I2C_M_RECV_LEN;
1994 msg[1].len = 1; /* block length will be added by
1995 the underlying bus driver */
1997 case I2C_SMBUS_I2C_BLOCK_DATA:
1998 if (read_write == I2C_SMBUS_READ) {
1999 msg[1].len = data->block[0];
2001 msg[0].len = data->block[0] + 1;
2002 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
2003 dev_err(&adapter->dev,
2004 "Invalid block write size %d\n",
2008 for (i = 1; i <= data->block[0]; i++)
2009 msgbuf0[i] = data->block[i];
2013 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
2017 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
2018 && size != I2C_SMBUS_I2C_BLOCK_DATA);
2020 /* Compute PEC if first message is a write */
2021 if (!(msg[0].flags & I2C_M_RD)) {
2022 if (num == 1) /* Write only */
2023 i2c_smbus_add_pec(&msg[0]);
2024 else /* Write followed by read */
2025 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
2027 /* Ask for PEC if last message is a read */
2028 if (msg[num-1].flags & I2C_M_RD)
2032 status = i2c_transfer(adapter, msg, num);
2036 /* Check PEC if last message is a read */
2037 if (i && (msg[num-1].flags & I2C_M_RD)) {
2038 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
2043 if (read_write == I2C_SMBUS_READ)
2045 case I2C_SMBUS_BYTE:
2046 data->byte = msgbuf0[0];
2048 case I2C_SMBUS_BYTE_DATA:
2049 data->byte = msgbuf1[0];
2051 case I2C_SMBUS_WORD_DATA:
2052 case I2C_SMBUS_PROC_CALL:
2053 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
2055 case I2C_SMBUS_I2C_BLOCK_DATA:
2056 for (i = 0; i < data->block[0]; i++)
2057 data->block[i+1] = msgbuf1[i];
2059 case I2C_SMBUS_BLOCK_DATA:
2060 case I2C_SMBUS_BLOCK_PROC_CALL:
2061 for (i = 0; i < msgbuf1[0] + 1; i++)
2062 data->block[i] = msgbuf1[i];
2069 * i2c_smbus_xfer - execute SMBus protocol operations
2070 * @adapter: Handle to I2C bus
2071 * @addr: Address of SMBus slave on that bus
2072 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
2073 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
2074 * @command: Byte interpreted by slave, for protocols which use such bytes
2075 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
2076 * @data: Data to be read or written
2078 * This executes an SMBus protocol operation, and returns a negative
2079 * errno code else zero on success.
2081 s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
2082 char read_write, u8 command, int protocol,
2083 union i2c_smbus_data *data)
2085 unsigned long orig_jiffies;
2089 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
2091 if (adapter->algo->smbus_xfer) {
2092 i2c_lock_adapter(adapter);
2094 /* Retry automatically on arbitration loss */
2095 orig_jiffies = jiffies;
2096 for (res = 0, try = 0; try <= adapter->retries; try++) {
2097 res = adapter->algo->smbus_xfer(adapter, addr, flags,
2098 read_write, command,
2102 if (time_after(jiffies,
2103 orig_jiffies + adapter->timeout))
2106 i2c_unlock_adapter(adapter);
2108 res = i2c_smbus_xfer_emulated(adapter, addr, flags, read_write,
2109 command, protocol, data);
2113 EXPORT_SYMBOL(i2c_smbus_xfer);
2115 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2116 MODULE_DESCRIPTION("I2C-Bus main module");
2117 MODULE_LICENSE("GPL");