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/mutex.h>
33 #include <linux/completion.h>
34 #include <linux/hardirq.h>
35 #include <linux/irqflags.h>
36 #include <asm/uaccess.h>
41 static DEFINE_MUTEX(core_lock);
42 static DEFINE_IDR(i2c_adapter_idr);
44 #define is_newstyle_driver(d) ((d)->probe || (d)->remove || (d)->detect)
46 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
48 /* ------------------------------------------------------------------------- */
50 static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
51 const struct i2c_client *client)
54 if (strcmp(client->name, id->name) == 0)
61 static int i2c_device_match(struct device *dev, struct device_driver *drv)
63 struct i2c_client *client = to_i2c_client(dev);
64 struct i2c_driver *driver = to_i2c_driver(drv);
66 /* make legacy i2c drivers bypass driver model probing entirely;
67 * such drivers scan each i2c adapter/bus themselves.
69 if (!is_newstyle_driver(driver))
72 /* match on an id table if there is one */
74 return i2c_match_id(driver->id_table, client) != NULL;
81 /* uevent helps with hotplug: modprobe -q $(MODALIAS) */
82 static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
84 struct i2c_client *client = to_i2c_client(dev);
86 /* by definition, legacy drivers can't hotplug */
90 if (add_uevent_var(env, "MODALIAS=%s%s",
91 I2C_MODULE_PREFIX, client->name))
93 dev_dbg(dev, "uevent\n");
98 #define i2c_device_uevent NULL
99 #endif /* CONFIG_HOTPLUG */
101 static int i2c_device_probe(struct device *dev)
103 struct i2c_client *client = to_i2c_client(dev);
104 struct i2c_driver *driver = to_i2c_driver(dev->driver);
107 if (!driver->probe || !driver->id_table)
109 client->driver = driver;
110 if (!device_can_wakeup(&client->dev))
111 device_init_wakeup(&client->dev,
112 client->flags & I2C_CLIENT_WAKE);
113 dev_dbg(dev, "probe\n");
115 status = driver->probe(client, i2c_match_id(driver->id_table, client));
117 client->driver = NULL;
121 static int i2c_device_remove(struct device *dev)
123 struct i2c_client *client = to_i2c_client(dev);
124 struct i2c_driver *driver;
130 driver = to_i2c_driver(dev->driver);
131 if (driver->remove) {
132 dev_dbg(dev, "remove\n");
133 status = driver->remove(client);
139 client->driver = NULL;
143 static void i2c_device_shutdown(struct device *dev)
145 struct i2c_driver *driver;
149 driver = to_i2c_driver(dev->driver);
150 if (driver->shutdown)
151 driver->shutdown(to_i2c_client(dev));
154 static int i2c_device_suspend(struct device *dev, pm_message_t mesg)
156 struct i2c_driver *driver;
160 driver = to_i2c_driver(dev->driver);
161 if (!driver->suspend)
163 return driver->suspend(to_i2c_client(dev), mesg);
166 static int i2c_device_resume(struct device *dev)
168 struct i2c_driver *driver;
172 driver = to_i2c_driver(dev->driver);
175 return driver->resume(to_i2c_client(dev));
178 static void i2c_client_release(struct device *dev)
180 struct i2c_client *client = to_i2c_client(dev);
181 complete(&client->released);
184 static void i2c_client_dev_release(struct device *dev)
186 kfree(to_i2c_client(dev));
190 show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
192 struct i2c_client *client = to_i2c_client(dev);
193 return sprintf(buf, "%s\n", client->name);
197 show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
199 struct i2c_client *client = to_i2c_client(dev);
200 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
203 static struct device_attribute i2c_dev_attrs[] = {
204 __ATTR(name, S_IRUGO, show_client_name, NULL),
205 /* modalias helps coldplug: modprobe $(cat .../modalias) */
206 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
210 struct bus_type i2c_bus_type = {
212 .dev_attrs = i2c_dev_attrs,
213 .match = i2c_device_match,
214 .uevent = i2c_device_uevent,
215 .probe = i2c_device_probe,
216 .remove = i2c_device_remove,
217 .shutdown = i2c_device_shutdown,
218 .suspend = i2c_device_suspend,
219 .resume = i2c_device_resume,
221 EXPORT_SYMBOL_GPL(i2c_bus_type);
225 * i2c_verify_client - return parameter as i2c_client, or NULL
226 * @dev: device, probably from some driver model iterator
228 * When traversing the driver model tree, perhaps using driver model
229 * iterators like @device_for_each_child(), you can't assume very much
230 * about the nodes you find. Use this function to avoid oopses caused
231 * by wrongly treating some non-I2C device as an i2c_client.
233 struct i2c_client *i2c_verify_client(struct device *dev)
235 return (dev->bus == &i2c_bus_type)
239 EXPORT_SYMBOL(i2c_verify_client);
243 * i2c_new_device - instantiate an i2c device for use with a new style driver
244 * @adap: the adapter managing the device
245 * @info: describes one I2C device; bus_num is ignored
248 * Create a device to work with a new style i2c driver, where binding is
249 * handled through driver model probe()/remove() methods. This call is not
250 * appropriate for use by mainboad initialization logic, which usually runs
251 * during an arch_initcall() long before any i2c_adapter could exist.
253 * This returns the new i2c client, which may be saved for later use with
254 * i2c_unregister_device(); or NULL to indicate an error.
257 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
259 struct i2c_client *client;
262 client = kzalloc(sizeof *client, GFP_KERNEL);
266 client->adapter = adap;
268 client->dev.platform_data = info->platform_data;
271 client->dev.archdata = *info->archdata;
273 client->flags = info->flags;
274 client->addr = info->addr;
275 client->irq = info->irq;
277 strlcpy(client->name, info->type, sizeof(client->name));
279 /* a new style driver may be bound to this device when we
280 * return from this function, or any later moment (e.g. maybe
281 * hotplugging will load the driver module). and the device
282 * refcount model is the standard driver model one.
284 status = i2c_attach_client(client);
291 EXPORT_SYMBOL_GPL(i2c_new_device);
295 * i2c_unregister_device - reverse effect of i2c_new_device()
296 * @client: value returned from i2c_new_device()
299 void i2c_unregister_device(struct i2c_client *client)
301 struct i2c_adapter *adapter = client->adapter;
302 struct i2c_driver *driver = client->driver;
304 if (driver && !is_newstyle_driver(driver)) {
305 dev_err(&client->dev, "can't unregister devices "
306 "with legacy drivers\n");
311 if (adapter->client_unregister) {
312 if (adapter->client_unregister(client)) {
313 dev_warn(&client->dev,
314 "client_unregister [%s] failed\n",
319 mutex_lock(&adapter->clist_lock);
320 list_del(&client->list);
321 mutex_unlock(&adapter->clist_lock);
323 device_unregister(&client->dev);
325 EXPORT_SYMBOL_GPL(i2c_unregister_device);
328 static const struct i2c_device_id dummy_id[] = {
333 static int dummy_probe(struct i2c_client *client,
334 const struct i2c_device_id *id)
339 static int dummy_remove(struct i2c_client *client)
344 static struct i2c_driver dummy_driver = {
345 .driver.name = "dummy",
346 .probe = dummy_probe,
347 .remove = dummy_remove,
348 .id_table = dummy_id,
352 * i2c_new_dummy - return a new i2c device bound to a dummy driver
353 * @adapter: the adapter managing the device
354 * @address: seven bit address to be used
357 * This returns an I2C client bound to the "dummy" driver, intended for use
358 * with devices that consume multiple addresses. Examples of such chips
359 * include various EEPROMS (like 24c04 and 24c08 models).
361 * These dummy devices have two main uses. First, most I2C and SMBus calls
362 * except i2c_transfer() need a client handle; the dummy will be that handle.
363 * And second, this prevents the specified address from being bound to a
366 * This returns the new i2c client, which should be saved for later use with
367 * i2c_unregister_device(); or NULL to indicate an error.
369 struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
371 struct i2c_board_info info = {
372 I2C_BOARD_INFO("dummy", address),
375 return i2c_new_device(adapter, &info);
377 EXPORT_SYMBOL_GPL(i2c_new_dummy);
379 /* ------------------------------------------------------------------------- */
381 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
383 static void i2c_adapter_dev_release(struct device *dev)
385 struct i2c_adapter *adap = to_i2c_adapter(dev);
386 complete(&adap->dev_released);
390 show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
392 struct i2c_adapter *adap = to_i2c_adapter(dev);
393 return sprintf(buf, "%s\n", adap->name);
396 static struct device_attribute i2c_adapter_attrs[] = {
397 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
401 static struct class i2c_adapter_class = {
402 .owner = THIS_MODULE,
403 .name = "i2c-adapter",
404 .dev_attrs = i2c_adapter_attrs,
407 static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
409 struct i2c_devinfo *devinfo;
411 mutex_lock(&__i2c_board_lock);
412 list_for_each_entry(devinfo, &__i2c_board_list, list) {
413 if (devinfo->busnum == adapter->nr
414 && !i2c_new_device(adapter,
415 &devinfo->board_info))
416 dev_err(&adapter->dev,
417 "Can't create device at 0x%02x\n",
418 devinfo->board_info.addr);
420 mutex_unlock(&__i2c_board_lock);
423 static int i2c_do_add_adapter(struct device_driver *d, void *data)
425 struct i2c_driver *driver = to_i2c_driver(d);
426 struct i2c_adapter *adap = data;
428 /* Detect supported devices on that bus, and instantiate them */
429 i2c_detect(adap, driver);
431 /* Let legacy drivers scan this bus for matching devices */
432 if (driver->attach_adapter) {
433 /* We ignore the return code; if it fails, too bad */
434 driver->attach_adapter(adap);
439 static int i2c_register_adapter(struct i2c_adapter *adap)
443 /* Can't register until after driver model init */
444 if (unlikely(WARN_ON(!i2c_bus_type.p)))
447 mutex_init(&adap->bus_lock);
448 mutex_init(&adap->clist_lock);
449 INIT_LIST_HEAD(&adap->clients);
451 mutex_lock(&core_lock);
453 /* Set default timeout to 1 second if not already set */
454 if (adap->timeout == 0)
457 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
458 adap->dev.release = &i2c_adapter_dev_release;
459 adap->dev.class = &i2c_adapter_class;
460 res = device_register(&adap->dev);
464 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
466 /* create pre-declared device nodes for new-style drivers */
467 if (adap->nr < __i2c_first_dynamic_bus_num)
468 i2c_scan_static_board_info(adap);
471 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
475 mutex_unlock(&core_lock);
479 idr_remove(&i2c_adapter_idr, adap->nr);
484 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
485 * @adapter: the adapter to add
488 * This routine is used to declare an I2C adapter when its bus number
489 * doesn't matter. Examples: for I2C adapters dynamically added by
490 * USB links or PCI plugin cards.
492 * When this returns zero, a new bus number was allocated and stored
493 * in adap->nr, and the specified adapter became available for clients.
494 * Otherwise, a negative errno value is returned.
496 int i2c_add_adapter(struct i2c_adapter *adapter)
501 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
504 mutex_lock(&core_lock);
505 /* "above" here means "above or equal to", sigh */
506 res = idr_get_new_above(&i2c_adapter_idr, adapter,
507 __i2c_first_dynamic_bus_num, &id);
508 mutex_unlock(&core_lock);
517 return i2c_register_adapter(adapter);
519 EXPORT_SYMBOL(i2c_add_adapter);
522 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
523 * @adap: the adapter to register (with adap->nr initialized)
526 * This routine is used to declare an I2C adapter when its bus number
527 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
528 * or otherwise built in to the system's mainboard, and where i2c_board_info
529 * is used to properly configure I2C devices.
531 * If no devices have pre-been declared for this bus, then be sure to
532 * register the adapter before any dynamically allocated ones. Otherwise
533 * the required bus ID may not be available.
535 * When this returns zero, the specified adapter became available for
536 * clients using the bus number provided in adap->nr. Also, the table
537 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
538 * and the appropriate driver model device nodes are created. Otherwise, a
539 * negative errno value is returned.
541 int i2c_add_numbered_adapter(struct i2c_adapter *adap)
546 if (adap->nr & ~MAX_ID_MASK)
550 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
553 mutex_lock(&core_lock);
554 /* "above" here means "above or equal to", sigh;
555 * we need the "equal to" result to force the result
557 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
558 if (status == 0 && id != adap->nr) {
560 idr_remove(&i2c_adapter_idr, id);
562 mutex_unlock(&core_lock);
563 if (status == -EAGAIN)
567 status = i2c_register_adapter(adap);
570 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
572 static int i2c_do_del_adapter(struct device_driver *d, void *data)
574 struct i2c_driver *driver = to_i2c_driver(d);
575 struct i2c_adapter *adapter = data;
576 struct i2c_client *client, *_n;
579 /* Remove the devices we created ourselves as the result of hardware
580 * probing (using a driver's detect method) */
581 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
582 if (client->adapter == adapter) {
583 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
584 client->name, client->addr);
585 list_del(&client->detected);
586 i2c_unregister_device(client);
590 if (!driver->detach_adapter)
592 res = driver->detach_adapter(adapter);
594 dev_err(&adapter->dev, "detach_adapter failed (%d) "
595 "for driver [%s]\n", res, driver->driver.name);
600 * i2c_del_adapter - unregister I2C adapter
601 * @adap: the adapter being unregistered
604 * This unregisters an I2C adapter which was previously registered
605 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
607 int i2c_del_adapter(struct i2c_adapter *adap)
609 struct i2c_client *client, *_n;
612 mutex_lock(&core_lock);
614 /* First make sure that this adapter was ever added */
615 if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
616 pr_debug("i2c-core: attempting to delete unregistered "
617 "adapter [%s]\n", adap->name);
622 /* Tell drivers about this removal */
623 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
628 /* detach any active clients. This must be done first, because
629 * it can fail; in which case we give up. */
630 list_for_each_entry_safe_reverse(client, _n, &adap->clients, list) {
631 struct i2c_driver *driver;
633 driver = client->driver;
635 /* new style, follow standard driver model */
636 if (!driver || is_newstyle_driver(driver)) {
637 i2c_unregister_device(client);
641 /* legacy drivers create and remove clients themselves */
642 if ((res = driver->detach_client(client))) {
643 dev_err(&adap->dev, "detach_client failed for client "
644 "[%s] at address 0x%02x\n", client->name,
650 /* clean up the sysfs representation */
651 init_completion(&adap->dev_released);
652 device_unregister(&adap->dev);
654 /* wait for sysfs to drop all references */
655 wait_for_completion(&adap->dev_released);
658 idr_remove(&i2c_adapter_idr, adap->nr);
660 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
662 /* Clear the device structure in case this adapter is ever going to be
664 memset(&adap->dev, 0, sizeof(adap->dev));
667 mutex_unlock(&core_lock);
670 EXPORT_SYMBOL(i2c_del_adapter);
673 /* ------------------------------------------------------------------------- */
675 static int __attach_adapter(struct device *dev, void *data)
677 struct i2c_adapter *adapter = to_i2c_adapter(dev);
678 struct i2c_driver *driver = data;
680 i2c_detect(adapter, driver);
682 /* Legacy drivers scan i2c busses directly */
683 if (driver->attach_adapter)
684 driver->attach_adapter(adapter);
690 * An i2c_driver is used with one or more i2c_client (device) nodes to access
691 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
692 * are two models for binding the driver to its device: "new style" drivers
693 * follow the standard Linux driver model and just respond to probe() calls
694 * issued if the driver core sees they match(); "legacy" drivers create device
698 int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
702 /* Can't register until after driver model init */
703 if (unlikely(WARN_ON(!i2c_bus_type.p)))
706 /* new style driver methods can't mix with legacy ones */
707 if (is_newstyle_driver(driver)) {
708 if (driver->detach_adapter || driver->detach_client) {
710 "i2c-core: driver [%s] is confused\n",
711 driver->driver.name);
716 /* add the driver to the list of i2c drivers in the driver core */
717 driver->driver.owner = owner;
718 driver->driver.bus = &i2c_bus_type;
720 /* for new style drivers, when registration returns the driver core
721 * will have called probe() for all matching-but-unbound devices.
723 res = driver_register(&driver->driver);
727 mutex_lock(&core_lock);
729 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
731 INIT_LIST_HEAD(&driver->clients);
732 /* Walk the adapters that are already present */
733 class_for_each_device(&i2c_adapter_class, NULL, driver,
736 mutex_unlock(&core_lock);
739 EXPORT_SYMBOL(i2c_register_driver);
741 static int __detach_adapter(struct device *dev, void *data)
743 struct i2c_adapter *adapter = to_i2c_adapter(dev);
744 struct i2c_driver *driver = data;
745 struct i2c_client *client, *_n;
747 /* Remove the devices we created ourselves as the result of hardware
748 * probing (using a driver's detect method) */
749 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
750 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
751 client->name, client->addr);
752 list_del(&client->detected);
753 i2c_unregister_device(client);
756 if (is_newstyle_driver(driver))
759 /* Have a look at each adapter, if clients of this driver are still
760 * attached. If so, detach them to be able to kill the driver
763 if (driver->detach_adapter) {
764 if (driver->detach_adapter(adapter))
765 dev_err(&adapter->dev,
766 "detach_adapter failed for driver [%s]\n",
767 driver->driver.name);
769 struct i2c_client *client, *_n;
771 list_for_each_entry_safe(client, _n, &adapter->clients, list) {
772 if (client->driver != driver)
774 dev_dbg(&adapter->dev,
775 "detaching client [%s] at 0x%02x\n",
776 client->name, client->addr);
777 if (driver->detach_client(client))
778 dev_err(&adapter->dev, "detach_client "
779 "failed for client [%s] at 0x%02x\n",
780 client->name, client->addr);
788 * i2c_del_driver - unregister I2C driver
789 * @driver: the driver being unregistered
792 void i2c_del_driver(struct i2c_driver *driver)
794 mutex_lock(&core_lock);
796 class_for_each_device(&i2c_adapter_class, NULL, driver,
799 driver_unregister(&driver->driver);
800 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
802 mutex_unlock(&core_lock);
804 EXPORT_SYMBOL(i2c_del_driver);
806 /* ------------------------------------------------------------------------- */
808 static int __i2c_check_addr(struct device *dev, void *addrp)
810 struct i2c_client *client = i2c_verify_client(dev);
811 int addr = *(int *)addrp;
813 if (client && client->addr == addr)
818 static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
820 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
823 int i2c_attach_client(struct i2c_client *client)
825 struct i2c_adapter *adapter = client->adapter;
828 /* Check for address business */
829 res = i2c_check_addr(adapter, client->addr);
833 client->dev.parent = &client->adapter->dev;
834 client->dev.bus = &i2c_bus_type;
837 client->dev.driver = &client->driver->driver;
839 if (client->driver && !is_newstyle_driver(client->driver)) {
840 client->dev.release = i2c_client_release;
841 dev_set_uevent_suppress(&client->dev, 1);
843 client->dev.release = i2c_client_dev_release;
845 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adapter),
847 res = device_register(&client->dev);
851 mutex_lock(&adapter->clist_lock);
852 list_add_tail(&client->list, &adapter->clients);
853 mutex_unlock(&adapter->clist_lock);
855 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
856 client->name, dev_name(&client->dev));
858 if (adapter->client_register) {
859 if (adapter->client_register(client)) {
860 dev_dbg(&adapter->dev, "client_register "
861 "failed for client [%s] at 0x%02x\n",
862 client->name, client->addr);
869 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
870 "(%d)\n", client->name, client->addr, res);
873 EXPORT_SYMBOL(i2c_attach_client);
875 int i2c_detach_client(struct i2c_client *client)
877 struct i2c_adapter *adapter = client->adapter;
880 if (adapter->client_unregister) {
881 res = adapter->client_unregister(client);
883 dev_err(&client->dev,
884 "client_unregister [%s] failed, "
885 "client not detached\n", client->name);
890 mutex_lock(&adapter->clist_lock);
891 list_del(&client->list);
892 mutex_unlock(&adapter->clist_lock);
894 init_completion(&client->released);
895 device_unregister(&client->dev);
896 wait_for_completion(&client->released);
901 EXPORT_SYMBOL(i2c_detach_client);
904 * i2c_use_client - increments the reference count of the i2c client structure
905 * @client: the client being referenced
907 * Each live reference to a client should be refcounted. The driver model does
908 * that automatically as part of driver binding, so that most drivers don't
909 * need to do this explicitly: they hold a reference until they're unbound
912 * A pointer to the client with the incremented reference counter is returned.
914 struct i2c_client *i2c_use_client(struct i2c_client *client)
916 if (client && get_device(&client->dev))
920 EXPORT_SYMBOL(i2c_use_client);
923 * i2c_release_client - release a use of the i2c client structure
924 * @client: the client being no longer referenced
926 * Must be called when a user of a client is finished with it.
928 void i2c_release_client(struct i2c_client *client)
931 put_device(&client->dev);
933 EXPORT_SYMBOL(i2c_release_client);
940 static int i2c_cmd(struct device *dev, void *_arg)
942 struct i2c_client *client = i2c_verify_client(dev);
943 struct i2c_cmd_arg *arg = _arg;
945 if (client && client->driver && client->driver->command)
946 client->driver->command(client, arg->cmd, arg->arg);
950 void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
952 struct i2c_cmd_arg cmd_arg;
956 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
958 EXPORT_SYMBOL(i2c_clients_command);
960 static int __init i2c_init(void)
964 retval = bus_register(&i2c_bus_type);
967 retval = class_register(&i2c_adapter_class);
970 retval = i2c_add_driver(&dummy_driver);
976 class_unregister(&i2c_adapter_class);
978 bus_unregister(&i2c_bus_type);
982 static void __exit i2c_exit(void)
984 i2c_del_driver(&dummy_driver);
985 class_unregister(&i2c_adapter_class);
986 bus_unregister(&i2c_bus_type);
989 /* We must initialize early, because some subsystems register i2c drivers
990 * in subsys_initcall() code, but are linked (and initialized) before i2c.
992 postcore_initcall(i2c_init);
993 module_exit(i2c_exit);
995 /* ----------------------------------------------------
996 * the functional interface to the i2c busses.
997 * ----------------------------------------------------
1001 * i2c_transfer - execute a single or combined I2C message
1002 * @adap: Handle to I2C bus
1003 * @msgs: One or more messages to execute before STOP is issued to
1004 * terminate the operation; each message begins with a START.
1005 * @num: Number of messages to be executed.
1007 * Returns negative errno, else the number of messages executed.
1009 * Note that there is no requirement that each message be sent to
1010 * the same slave address, although that is the most common model.
1012 int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1014 unsigned long orig_jiffies;
1017 /* REVISIT the fault reporting model here is weak:
1019 * - When we get an error after receiving N bytes from a slave,
1020 * there is no way to report "N".
1022 * - When we get a NAK after transmitting N bytes to a slave,
1023 * there is no way to report "N" ... or to let the master
1024 * continue executing the rest of this combined message, if
1025 * that's the appropriate response.
1027 * - When for example "num" is two and we successfully complete
1028 * the first message but get an error part way through the
1029 * second, it's unclear whether that should be reported as
1030 * one (discarding status on the second message) or errno
1031 * (discarding status on the first one).
1034 if (adap->algo->master_xfer) {
1036 for (ret = 0; ret < num; ret++) {
1037 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
1038 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1039 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1040 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
1044 if (in_atomic() || irqs_disabled()) {
1045 ret = mutex_trylock(&adap->bus_lock);
1047 /* I2C activity is ongoing. */
1050 mutex_lock_nested(&adap->bus_lock, adap->level);
1053 /* Retry automatically on arbitration loss */
1054 orig_jiffies = jiffies;
1055 for (ret = 0, try = 0; try <= adap->retries; try++) {
1056 ret = adap->algo->master_xfer(adap, msgs, num);
1059 if (time_after(jiffies, orig_jiffies + adap->timeout))
1062 mutex_unlock(&adap->bus_lock);
1066 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
1070 EXPORT_SYMBOL(i2c_transfer);
1073 * i2c_master_send - issue a single I2C message in master transmit mode
1074 * @client: Handle to slave device
1075 * @buf: Data that will be written to the slave
1076 * @count: How many bytes to write
1078 * Returns negative errno, or else the number of bytes written.
1080 int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1083 struct i2c_adapter *adap=client->adapter;
1086 msg.addr = client->addr;
1087 msg.flags = client->flags & I2C_M_TEN;
1089 msg.buf = (char *)buf;
1091 ret = i2c_transfer(adap, &msg, 1);
1093 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1094 transmitted, else error code. */
1095 return (ret == 1) ? count : ret;
1097 EXPORT_SYMBOL(i2c_master_send);
1100 * i2c_master_recv - issue a single I2C message in master receive mode
1101 * @client: Handle to slave device
1102 * @buf: Where to store data read from slave
1103 * @count: How many bytes to read
1105 * Returns negative errno, or else the number of bytes read.
1107 int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1109 struct i2c_adapter *adap=client->adapter;
1113 msg.addr = client->addr;
1114 msg.flags = client->flags & I2C_M_TEN;
1115 msg.flags |= I2C_M_RD;
1119 ret = i2c_transfer(adap, &msg, 1);
1121 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1122 transmitted, else error code. */
1123 return (ret == 1) ? count : ret;
1125 EXPORT_SYMBOL(i2c_master_recv);
1127 /* ----------------------------------------------------
1128 * the i2c address scanning function
1129 * Will not work for 10-bit addresses!
1130 * ----------------------------------------------------
1132 static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
1133 int (*found_proc) (struct i2c_adapter *, int, int))
1137 /* Make sure the address is valid */
1138 if (addr < 0x03 || addr > 0x77) {
1139 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1144 /* Skip if already in use */
1145 if (i2c_check_addr(adapter, addr))
1148 /* Make sure there is something at this address, unless forced */
1150 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1151 I2C_SMBUS_QUICK, NULL) < 0)
1154 /* prevent 24RF08 corruption */
1155 if ((addr & ~0x0f) == 0x50)
1156 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1157 I2C_SMBUS_QUICK, NULL);
1160 /* Finally call the custom detection function */
1161 err = found_proc(adapter, addr, kind);
1162 /* -ENODEV can be returned if there is a chip at the given address
1163 but it isn't supported by this chip driver. We catch it here as
1164 this isn't an error. */
1169 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
1174 int i2c_probe(struct i2c_adapter *adapter,
1175 const struct i2c_client_address_data *address_data,
1176 int (*found_proc) (struct i2c_adapter *, int, int))
1179 int adap_id = i2c_adapter_id(adapter);
1181 /* Force entries are done first, and are not affected by ignore
1183 if (address_data->forces) {
1184 const unsigned short * const *forces = address_data->forces;
1187 for (kind = 0; forces[kind]; kind++) {
1188 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1190 if (forces[kind][i] == adap_id
1191 || forces[kind][i] == ANY_I2C_BUS) {
1192 dev_dbg(&adapter->dev, "found force "
1193 "parameter for adapter %d, "
1194 "addr 0x%02x, kind %d\n",
1195 adap_id, forces[kind][i + 1],
1197 err = i2c_probe_address(adapter,
1198 forces[kind][i + 1],
1207 /* Stop here if we can't use SMBUS_QUICK */
1208 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1209 if (address_data->probe[0] == I2C_CLIENT_END
1210 && address_data->normal_i2c[0] == I2C_CLIENT_END)
1213 dev_dbg(&adapter->dev, "SMBus Quick command not supported, "
1214 "can't probe for chips\n");
1218 /* Probe entries are done second, and are not affected by ignore
1220 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1221 if (address_data->probe[i] == adap_id
1222 || address_data->probe[i] == ANY_I2C_BUS) {
1223 dev_dbg(&adapter->dev, "found probe parameter for "
1224 "adapter %d, addr 0x%02x\n", adap_id,
1225 address_data->probe[i + 1]);
1226 err = i2c_probe_address(adapter,
1227 address_data->probe[i + 1],
1234 /* Normal entries are done last, unless shadowed by an ignore entry */
1235 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1239 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1241 if ((address_data->ignore[j] == adap_id ||
1242 address_data->ignore[j] == ANY_I2C_BUS)
1243 && address_data->ignore[j + 1]
1244 == address_data->normal_i2c[i]) {
1245 dev_dbg(&adapter->dev, "found ignore "
1246 "parameter for adapter %d, "
1247 "addr 0x%02x\n", adap_id,
1248 address_data->ignore[j + 1]);
1256 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1257 "addr 0x%02x\n", adap_id,
1258 address_data->normal_i2c[i]);
1259 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1267 EXPORT_SYMBOL(i2c_probe);
1269 /* Separate detection function for new-style drivers */
1270 static int i2c_detect_address(struct i2c_client *temp_client, int kind,
1271 struct i2c_driver *driver)
1273 struct i2c_board_info info;
1274 struct i2c_adapter *adapter = temp_client->adapter;
1275 int addr = temp_client->addr;
1278 /* Make sure the address is valid */
1279 if (addr < 0x03 || addr > 0x77) {
1280 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1285 /* Skip if already in use */
1286 if (i2c_check_addr(adapter, addr))
1289 /* Make sure there is something at this address, unless forced */
1291 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1292 I2C_SMBUS_QUICK, NULL) < 0)
1295 /* prevent 24RF08 corruption */
1296 if ((addr & ~0x0f) == 0x50)
1297 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1298 I2C_SMBUS_QUICK, NULL);
1301 /* Finally call the custom detection function */
1302 memset(&info, 0, sizeof(struct i2c_board_info));
1304 err = driver->detect(temp_client, kind, &info);
1306 /* -ENODEV is returned if the detection fails. We catch it
1307 here as this isn't an error. */
1308 return err == -ENODEV ? 0 : err;
1311 /* Consistency check */
1312 if (info.type[0] == '\0') {
1313 dev_err(&adapter->dev, "%s detection function provided "
1314 "no name for 0x%x\n", driver->driver.name,
1317 struct i2c_client *client;
1319 /* Detection succeeded, instantiate the device */
1320 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1321 info.type, info.addr);
1322 client = i2c_new_device(adapter, &info);
1324 list_add_tail(&client->detected, &driver->clients);
1326 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1327 info.type, info.addr);
1332 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1334 const struct i2c_client_address_data *address_data;
1335 struct i2c_client *temp_client;
1337 int adap_id = i2c_adapter_id(adapter);
1339 address_data = driver->address_data;
1340 if (!driver->detect || !address_data)
1343 /* Set up a temporary client to help detect callback */
1344 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1347 temp_client->adapter = adapter;
1349 /* Force entries are done first, and are not affected by ignore
1351 if (address_data->forces) {
1352 const unsigned short * const *forces = address_data->forces;
1355 for (kind = 0; forces[kind]; kind++) {
1356 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1358 if (forces[kind][i] == adap_id
1359 || forces[kind][i] == ANY_I2C_BUS) {
1360 dev_dbg(&adapter->dev, "found force "
1361 "parameter for adapter %d, "
1362 "addr 0x%02x, kind %d\n",
1363 adap_id, forces[kind][i + 1],
1365 temp_client->addr = forces[kind][i + 1];
1366 err = i2c_detect_address(temp_client,
1375 /* Stop here if the classes do not match */
1376 if (!(adapter->class & driver->class))
1379 /* Stop here if we can't use SMBUS_QUICK */
1380 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1381 if (address_data->probe[0] == I2C_CLIENT_END
1382 && address_data->normal_i2c[0] == I2C_CLIENT_END)
1385 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1386 "can't probe for chips\n");
1391 /* Probe entries are done second, and are not affected by ignore
1393 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1394 if (address_data->probe[i] == adap_id
1395 || address_data->probe[i] == ANY_I2C_BUS) {
1396 dev_dbg(&adapter->dev, "found probe parameter for "
1397 "adapter %d, addr 0x%02x\n", adap_id,
1398 address_data->probe[i + 1]);
1399 temp_client->addr = address_data->probe[i + 1];
1400 err = i2c_detect_address(temp_client, -1, driver);
1406 /* Normal entries are done last, unless shadowed by an ignore entry */
1407 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1411 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1413 if ((address_data->ignore[j] == adap_id ||
1414 address_data->ignore[j] == ANY_I2C_BUS)
1415 && address_data->ignore[j + 1]
1416 == address_data->normal_i2c[i]) {
1417 dev_dbg(&adapter->dev, "found ignore "
1418 "parameter for adapter %d, "
1419 "addr 0x%02x\n", adap_id,
1420 address_data->ignore[j + 1]);
1428 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1429 "addr 0x%02x\n", adap_id,
1430 address_data->normal_i2c[i]);
1431 temp_client->addr = address_data->normal_i2c[i];
1432 err = i2c_detect_address(temp_client, -1, driver);
1443 i2c_new_probed_device(struct i2c_adapter *adap,
1444 struct i2c_board_info *info,
1445 unsigned short const *addr_list)
1449 /* Stop here if the bus doesn't support probing */
1450 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1451 dev_err(&adap->dev, "Probing not supported\n");
1455 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1456 /* Check address validity */
1457 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1458 dev_warn(&adap->dev, "Invalid 7-bit address "
1459 "0x%02x\n", addr_list[i]);
1463 /* Check address availability */
1464 if (i2c_check_addr(adap, addr_list[i])) {
1465 dev_dbg(&adap->dev, "Address 0x%02x already in "
1466 "use, not probing\n", addr_list[i]);
1470 /* Test address responsiveness
1471 The default probe method is a quick write, but it is known
1472 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1473 and could also irreversibly write-protect some EEPROMs, so
1474 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1475 read instead. Also, some bus drivers don't implement
1476 quick write, so we fallback to a byte read it that case
1478 if ((addr_list[i] & ~0x07) == 0x30
1479 || (addr_list[i] & ~0x0f) == 0x50
1480 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1481 union i2c_smbus_data data;
1483 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1485 I2C_SMBUS_BYTE, &data) >= 0)
1488 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1490 I2C_SMBUS_QUICK, NULL) >= 0)
1495 if (addr_list[i] == I2C_CLIENT_END) {
1496 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1500 info->addr = addr_list[i];
1501 return i2c_new_device(adap, info);
1503 EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1505 struct i2c_adapter* i2c_get_adapter(int id)
1507 struct i2c_adapter *adapter;
1509 mutex_lock(&core_lock);
1510 adapter = idr_find(&i2c_adapter_idr, id);
1511 if (adapter && !try_module_get(adapter->owner))
1514 mutex_unlock(&core_lock);
1517 EXPORT_SYMBOL(i2c_get_adapter);
1519 void i2c_put_adapter(struct i2c_adapter *adap)
1521 module_put(adap->owner);
1523 EXPORT_SYMBOL(i2c_put_adapter);
1525 /* The SMBus parts */
1527 #define POLY (0x1070U << 3)
1528 static u8 crc8(u16 data)
1532 for(i = 0; i < 8; i++) {
1537 return (u8)(data >> 8);
1540 /* Incremental CRC8 over count bytes in the array pointed to by p */
1541 static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1545 for(i = 0; i < count; i++)
1546 crc = crc8((crc ^ p[i]) << 8);
1550 /* Assume a 7-bit address, which is reasonable for SMBus */
1551 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1553 /* The address will be sent first */
1554 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1555 pec = i2c_smbus_pec(pec, &addr, 1);
1557 /* The data buffer follows */
1558 return i2c_smbus_pec(pec, msg->buf, msg->len);
1561 /* Used for write only transactions */
1562 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1564 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1568 /* Return <0 on CRC error
1569 If there was a write before this read (most cases) we need to take the
1570 partial CRC from the write part into account.
1571 Note that this function does modify the message (we need to decrease the
1572 message length to hide the CRC byte from the caller). */
1573 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1575 u8 rpec = msg->buf[--msg->len];
1576 cpec = i2c_smbus_msg_pec(cpec, msg);
1579 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1587 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1588 * @client: Handle to slave device
1590 * This executes the SMBus "receive byte" protocol, returning negative errno
1591 * else the byte received from the device.
1593 s32 i2c_smbus_read_byte(struct i2c_client *client)
1595 union i2c_smbus_data data;
1598 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1600 I2C_SMBUS_BYTE, &data);
1601 return (status < 0) ? status : data.byte;
1603 EXPORT_SYMBOL(i2c_smbus_read_byte);
1606 * i2c_smbus_write_byte - SMBus "send byte" protocol
1607 * @client: Handle to slave device
1608 * @value: Byte to be sent
1610 * This executes the SMBus "send byte" protocol, returning negative errno
1611 * else zero on success.
1613 s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1615 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1616 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1618 EXPORT_SYMBOL(i2c_smbus_write_byte);
1621 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1622 * @client: Handle to slave device
1623 * @command: Byte interpreted by slave
1625 * This executes the SMBus "read byte" protocol, returning negative errno
1626 * else a data byte received from the device.
1628 s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1630 union i2c_smbus_data data;
1633 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1634 I2C_SMBUS_READ, command,
1635 I2C_SMBUS_BYTE_DATA, &data);
1636 return (status < 0) ? status : data.byte;
1638 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1641 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1642 * @client: Handle to slave device
1643 * @command: Byte interpreted by slave
1644 * @value: Byte being written
1646 * This executes the SMBus "write byte" protocol, returning negative errno
1647 * else zero on success.
1649 s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1651 union i2c_smbus_data data;
1653 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1654 I2C_SMBUS_WRITE,command,
1655 I2C_SMBUS_BYTE_DATA,&data);
1657 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1660 * i2c_smbus_read_word_data - SMBus "read word" protocol
1661 * @client: Handle to slave device
1662 * @command: Byte interpreted by slave
1664 * This executes the SMBus "read word" protocol, returning negative errno
1665 * else a 16-bit unsigned "word" received from the device.
1667 s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1669 union i2c_smbus_data data;
1672 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1673 I2C_SMBUS_READ, command,
1674 I2C_SMBUS_WORD_DATA, &data);
1675 return (status < 0) ? status : data.word;
1677 EXPORT_SYMBOL(i2c_smbus_read_word_data);
1680 * i2c_smbus_write_word_data - SMBus "write word" protocol
1681 * @client: Handle to slave device
1682 * @command: Byte interpreted by slave
1683 * @value: 16-bit "word" being written
1685 * This executes the SMBus "write word" protocol, returning negative errno
1686 * else zero on success.
1688 s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1690 union i2c_smbus_data data;
1692 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1693 I2C_SMBUS_WRITE,command,
1694 I2C_SMBUS_WORD_DATA,&data);
1696 EXPORT_SYMBOL(i2c_smbus_write_word_data);
1699 * i2c_smbus_process_call - SMBus "process call" protocol
1700 * @client: Handle to slave device
1701 * @command: Byte interpreted by slave
1702 * @value: 16-bit "word" being written
1704 * This executes the SMBus "process call" protocol, returning negative errno
1705 * else a 16-bit unsigned "word" received from the device.
1707 s32 i2c_smbus_process_call(struct i2c_client *client, u8 command, u16 value)
1709 union i2c_smbus_data data;
1713 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1714 I2C_SMBUS_WRITE, command,
1715 I2C_SMBUS_PROC_CALL, &data);
1716 return (status < 0) ? status : data.word;
1718 EXPORT_SYMBOL(i2c_smbus_process_call);
1721 * i2c_smbus_read_block_data - SMBus "block read" protocol
1722 * @client: Handle to slave device
1723 * @command: Byte interpreted by slave
1724 * @values: Byte array into which data will be read; big enough to hold
1725 * the data returned by the slave. SMBus allows at most 32 bytes.
1727 * This executes the SMBus "block read" protocol, returning negative errno
1728 * else the number of data bytes in the slave's response.
1730 * Note that using this function requires that the client's adapter support
1731 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1732 * support this; its emulation through I2C messaging relies on a specific
1733 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1735 s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1738 union i2c_smbus_data data;
1741 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1742 I2C_SMBUS_READ, command,
1743 I2C_SMBUS_BLOCK_DATA, &data);
1747 memcpy(values, &data.block[1], data.block[0]);
1748 return data.block[0];
1750 EXPORT_SYMBOL(i2c_smbus_read_block_data);
1753 * i2c_smbus_write_block_data - SMBus "block write" protocol
1754 * @client: Handle to slave device
1755 * @command: Byte interpreted by slave
1756 * @length: Size of data block; SMBus allows at most 32 bytes
1757 * @values: Byte array which will be written.
1759 * This executes the SMBus "block write" protocol, returning negative errno
1760 * else zero on success.
1762 s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1763 u8 length, const u8 *values)
1765 union i2c_smbus_data data;
1767 if (length > I2C_SMBUS_BLOCK_MAX)
1768 length = I2C_SMBUS_BLOCK_MAX;
1769 data.block[0] = length;
1770 memcpy(&data.block[1], values, length);
1771 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1772 I2C_SMBUS_WRITE,command,
1773 I2C_SMBUS_BLOCK_DATA,&data);
1775 EXPORT_SYMBOL(i2c_smbus_write_block_data);
1777 /* Returns the number of read bytes */
1778 s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1779 u8 length, u8 *values)
1781 union i2c_smbus_data data;
1784 if (length > I2C_SMBUS_BLOCK_MAX)
1785 length = I2C_SMBUS_BLOCK_MAX;
1786 data.block[0] = length;
1787 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1788 I2C_SMBUS_READ, command,
1789 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1793 memcpy(values, &data.block[1], data.block[0]);
1794 return data.block[0];
1796 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1798 s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1799 u8 length, const u8 *values)
1801 union i2c_smbus_data data;
1803 if (length > I2C_SMBUS_BLOCK_MAX)
1804 length = I2C_SMBUS_BLOCK_MAX;
1805 data.block[0] = length;
1806 memcpy(data.block + 1, values, length);
1807 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1808 I2C_SMBUS_WRITE, command,
1809 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1811 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1813 /* Simulate a SMBus command using the i2c protocol
1814 No checking of parameters is done! */
1815 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
1816 unsigned short flags,
1817 char read_write, u8 command, int size,
1818 union i2c_smbus_data * data)
1820 /* So we need to generate a series of msgs. In the case of writing, we
1821 need to use only one message; when reading, we need two. We initialize
1822 most things with sane defaults, to keep the code below somewhat
1824 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1825 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1826 int num = read_write == I2C_SMBUS_READ?2:1;
1827 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1828 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1834 msgbuf0[0] = command;
1836 case I2C_SMBUS_QUICK:
1838 /* Special case: The read/write field is used as data */
1839 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
1843 case I2C_SMBUS_BYTE:
1844 if (read_write == I2C_SMBUS_READ) {
1845 /* Special case: only a read! */
1846 msg[0].flags = I2C_M_RD | flags;
1850 case I2C_SMBUS_BYTE_DATA:
1851 if (read_write == I2C_SMBUS_READ)
1855 msgbuf0[1] = data->byte;
1858 case I2C_SMBUS_WORD_DATA:
1859 if (read_write == I2C_SMBUS_READ)
1863 msgbuf0[1] = data->word & 0xff;
1864 msgbuf0[2] = data->word >> 8;
1867 case I2C_SMBUS_PROC_CALL:
1868 num = 2; /* Special case */
1869 read_write = I2C_SMBUS_READ;
1872 msgbuf0[1] = data->word & 0xff;
1873 msgbuf0[2] = data->word >> 8;
1875 case I2C_SMBUS_BLOCK_DATA:
1876 if (read_write == I2C_SMBUS_READ) {
1877 msg[1].flags |= I2C_M_RECV_LEN;
1878 msg[1].len = 1; /* block length will be added by
1879 the underlying bus driver */
1881 msg[0].len = data->block[0] + 2;
1882 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1883 dev_err(&adapter->dev,
1884 "Invalid block write size %d\n",
1888 for (i = 1; i < msg[0].len; i++)
1889 msgbuf0[i] = data->block[i-1];
1892 case I2C_SMBUS_BLOCK_PROC_CALL:
1893 num = 2; /* Another special case */
1894 read_write = I2C_SMBUS_READ;
1895 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1896 dev_err(&adapter->dev,
1897 "Invalid block write size %d\n",
1901 msg[0].len = data->block[0] + 2;
1902 for (i = 1; i < msg[0].len; i++)
1903 msgbuf0[i] = data->block[i-1];
1904 msg[1].flags |= I2C_M_RECV_LEN;
1905 msg[1].len = 1; /* block length will be added by
1906 the underlying bus driver */
1908 case I2C_SMBUS_I2C_BLOCK_DATA:
1909 if (read_write == I2C_SMBUS_READ) {
1910 msg[1].len = data->block[0];
1912 msg[0].len = data->block[0] + 1;
1913 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
1914 dev_err(&adapter->dev,
1915 "Invalid block write size %d\n",
1919 for (i = 1; i <= data->block[0]; i++)
1920 msgbuf0[i] = data->block[i];
1924 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1928 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1929 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1931 /* Compute PEC if first message is a write */
1932 if (!(msg[0].flags & I2C_M_RD)) {
1933 if (num == 1) /* Write only */
1934 i2c_smbus_add_pec(&msg[0]);
1935 else /* Write followed by read */
1936 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1938 /* Ask for PEC if last message is a read */
1939 if (msg[num-1].flags & I2C_M_RD)
1943 status = i2c_transfer(adapter, msg, num);
1947 /* Check PEC if last message is a read */
1948 if (i && (msg[num-1].flags & I2C_M_RD)) {
1949 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1954 if (read_write == I2C_SMBUS_READ)
1956 case I2C_SMBUS_BYTE:
1957 data->byte = msgbuf0[0];
1959 case I2C_SMBUS_BYTE_DATA:
1960 data->byte = msgbuf1[0];
1962 case I2C_SMBUS_WORD_DATA:
1963 case I2C_SMBUS_PROC_CALL:
1964 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1966 case I2C_SMBUS_I2C_BLOCK_DATA:
1967 for (i = 0; i < data->block[0]; i++)
1968 data->block[i+1] = msgbuf1[i];
1970 case I2C_SMBUS_BLOCK_DATA:
1971 case I2C_SMBUS_BLOCK_PROC_CALL:
1972 for (i = 0; i < msgbuf1[0] + 1; i++)
1973 data->block[i] = msgbuf1[i];
1980 * i2c_smbus_xfer - execute SMBus protocol operations
1981 * @adapter: Handle to I2C bus
1982 * @addr: Address of SMBus slave on that bus
1983 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1984 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1985 * @command: Byte interpreted by slave, for protocols which use such bytes
1986 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1987 * @data: Data to be read or written
1989 * This executes an SMBus protocol operation, and returns a negative
1990 * errno code else zero on success.
1992 s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
1993 char read_write, u8 command, int protocol,
1994 union i2c_smbus_data *data)
1996 unsigned long orig_jiffies;
2000 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
2002 if (adapter->algo->smbus_xfer) {
2003 mutex_lock(&adapter->bus_lock);
2005 /* Retry automatically on arbitration loss */
2006 orig_jiffies = jiffies;
2007 for (res = 0, try = 0; try <= adapter->retries; try++) {
2008 res = adapter->algo->smbus_xfer(adapter, addr, flags,
2009 read_write, command,
2013 if (time_after(jiffies,
2014 orig_jiffies + adapter->timeout))
2017 mutex_unlock(&adapter->bus_lock);
2019 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
2020 command, protocol, data);
2024 EXPORT_SYMBOL(i2c_smbus_xfer);
2026 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2027 MODULE_DESCRIPTION("I2C-Bus main module");
2028 MODULE_LICENSE("GPL");