mm-only debug patch...
[mmotm.git] / drivers / i2c / i2c-core.c
blob4c4088c7fd6614a274388d51d3a976cb890cddab
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 <linux/rwsem.h>
37 #include <asm/uaccess.h>
39 #include "i2c-core.h"
42 /* core_lock protects i2c_adapter_idr, userspace_devices, and guarantees
43 that device detection, deletion of detected devices, and attach_adapter
44 and detach_adapter calls are serialized */
45 static DEFINE_MUTEX(core_lock);
46 static DEFINE_IDR(i2c_adapter_idr);
47 static LIST_HEAD(userspace_devices);
49 static struct device_type i2c_client_type;
50 static int i2c_check_addr(struct i2c_adapter *adapter, int addr);
51 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
53 /* ------------------------------------------------------------------------- */
55 static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
56 const struct i2c_client *client)
58 while (id->name[0]) {
59 if (strcmp(client->name, id->name) == 0)
60 return id;
61 id++;
63 return NULL;
66 static int i2c_device_match(struct device *dev, struct device_driver *drv)
68 struct i2c_client *client = i2c_verify_client(dev);
69 struct i2c_driver *driver;
71 if (!client)
72 return 0;
74 driver = to_i2c_driver(drv);
75 /* match on an id table if there is one */
76 if (driver->id_table)
77 return i2c_match_id(driver->id_table, client) != NULL;
79 return 0;
82 #ifdef CONFIG_HOTPLUG
84 /* uevent helps with hotplug: modprobe -q $(MODALIAS) */
85 static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
87 struct i2c_client *client = to_i2c_client(dev);
89 if (add_uevent_var(env, "MODALIAS=%s%s",
90 I2C_MODULE_PREFIX, client->name))
91 return -ENOMEM;
92 dev_dbg(dev, "uevent\n");
93 return 0;
96 #else
97 #define i2c_device_uevent NULL
98 #endif /* CONFIG_HOTPLUG */
100 static int i2c_device_probe(struct device *dev)
102 struct i2c_client *client = i2c_verify_client(dev);
103 struct i2c_driver *driver;
104 int status;
106 if (!client)
107 return 0;
109 driver = to_i2c_driver(dev->driver);
110 if (!driver->probe || !driver->id_table)
111 return -ENODEV;
112 client->driver = driver;
113 if (!device_can_wakeup(&client->dev))
114 device_init_wakeup(&client->dev,
115 client->flags & I2C_CLIENT_WAKE);
116 dev_dbg(dev, "probe\n");
118 status = driver->probe(client, i2c_match_id(driver->id_table, client));
119 if (status)
120 client->driver = NULL;
121 return status;
124 static int i2c_device_remove(struct device *dev)
126 struct i2c_client *client = i2c_verify_client(dev);
127 struct i2c_driver *driver;
128 int status;
130 if (!client || !dev->driver)
131 return 0;
133 driver = to_i2c_driver(dev->driver);
134 if (driver->remove) {
135 dev_dbg(dev, "remove\n");
136 status = driver->remove(client);
137 } else {
138 dev->driver = NULL;
139 status = 0;
141 if (status == 0)
142 client->driver = NULL;
143 return status;
146 static void i2c_device_shutdown(struct device *dev)
148 struct i2c_client *client = i2c_verify_client(dev);
149 struct i2c_driver *driver;
151 if (!client || !dev->driver)
152 return;
153 driver = to_i2c_driver(dev->driver);
154 if (driver->shutdown)
155 driver->shutdown(client);
158 static int i2c_device_suspend(struct device *dev, pm_message_t mesg)
160 struct i2c_client *client = i2c_verify_client(dev);
161 struct i2c_driver *driver;
163 if (!client || !dev->driver)
164 return 0;
165 driver = to_i2c_driver(dev->driver);
166 if (!driver->suspend)
167 return 0;
168 return driver->suspend(client, mesg);
171 static int i2c_device_resume(struct device *dev)
173 struct i2c_client *client = i2c_verify_client(dev);
174 struct i2c_driver *driver;
176 if (!client || !dev->driver)
177 return 0;
178 driver = to_i2c_driver(dev->driver);
179 if (!driver->resume)
180 return 0;
181 return driver->resume(client);
184 static void i2c_client_dev_release(struct device *dev)
186 kfree(to_i2c_client(dev));
189 static ssize_t
190 show_name(struct device *dev, struct device_attribute *attr, char *buf)
192 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
193 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
196 static ssize_t
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 DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
204 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
206 static struct attribute *i2c_dev_attrs[] = {
207 &dev_attr_name.attr,
208 /* modalias helps coldplug: modprobe $(cat .../modalias) */
209 &dev_attr_modalias.attr,
210 NULL
213 static struct attribute_group i2c_dev_attr_group = {
214 .attrs = i2c_dev_attrs,
217 static const struct attribute_group *i2c_dev_attr_groups[] = {
218 &i2c_dev_attr_group,
219 NULL
222 struct bus_type i2c_bus_type = {
223 .name = "i2c",
224 .match = i2c_device_match,
225 .probe = i2c_device_probe,
226 .remove = i2c_device_remove,
227 .shutdown = i2c_device_shutdown,
228 .suspend = i2c_device_suspend,
229 .resume = i2c_device_resume,
231 EXPORT_SYMBOL_GPL(i2c_bus_type);
233 static struct device_type i2c_client_type = {
234 .groups = i2c_dev_attr_groups,
235 .uevent = i2c_device_uevent,
236 .release = i2c_client_dev_release,
241 * i2c_verify_client - return parameter as i2c_client, or NULL
242 * @dev: device, probably from some driver model iterator
244 * When traversing the driver model tree, perhaps using driver model
245 * iterators like @device_for_each_child(), you can't assume very much
246 * about the nodes you find. Use this function to avoid oopses caused
247 * by wrongly treating some non-I2C device as an i2c_client.
249 struct i2c_client *i2c_verify_client(struct device *dev)
251 return (dev->type == &i2c_client_type)
252 ? to_i2c_client(dev)
253 : NULL;
255 EXPORT_SYMBOL(i2c_verify_client);
259 * i2c_new_device - instantiate an i2c device
260 * @adap: the adapter managing the device
261 * @info: describes one I2C device; bus_num is ignored
262 * Context: can sleep
264 * Create an i2c device. Binding is handled through driver model
265 * probe()/remove() methods. A driver may be bound to this device when we
266 * return from this function, or any later moment (e.g. maybe hotplugging will
267 * load the driver module). This call is not appropriate for use by mainboard
268 * initialization logic, which usually runs during an arch_initcall() long
269 * before any i2c_adapter could exist.
271 * This returns the new i2c client, which may be saved for later use with
272 * i2c_unregister_device(); or NULL to indicate an error.
274 struct i2c_client *
275 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
277 struct i2c_client *client;
278 int status;
280 client = kzalloc(sizeof *client, GFP_KERNEL);
281 if (!client)
282 return NULL;
284 client->adapter = adap;
286 client->dev.platform_data = info->platform_data;
288 if (info->archdata)
289 client->dev.archdata = *info->archdata;
291 client->flags = info->flags;
292 client->addr = info->addr;
293 client->irq = info->irq;
295 strlcpy(client->name, info->type, sizeof(client->name));
297 /* Check for address business */
298 status = i2c_check_addr(adap, client->addr);
299 if (status)
300 goto out_err;
302 client->dev.parent = &client->adapter->dev;
303 client->dev.bus = &i2c_bus_type;
304 client->dev.type = &i2c_client_type;
306 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
307 client->addr);
308 status = device_register(&client->dev);
309 if (status)
310 goto out_err;
312 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
313 client->name, dev_name(&client->dev));
315 return client;
317 out_err:
318 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
319 "(%d)\n", client->name, client->addr, status);
320 kfree(client);
321 return NULL;
323 EXPORT_SYMBOL_GPL(i2c_new_device);
327 * i2c_unregister_device - reverse effect of i2c_new_device()
328 * @client: value returned from i2c_new_device()
329 * Context: can sleep
331 void i2c_unregister_device(struct i2c_client *client)
333 device_unregister(&client->dev);
335 EXPORT_SYMBOL_GPL(i2c_unregister_device);
338 static const struct i2c_device_id dummy_id[] = {
339 { "dummy", 0 },
340 { },
343 static int dummy_probe(struct i2c_client *client,
344 const struct i2c_device_id *id)
346 return 0;
349 static int dummy_remove(struct i2c_client *client)
351 return 0;
354 static struct i2c_driver dummy_driver = {
355 .driver.name = "dummy",
356 .probe = dummy_probe,
357 .remove = dummy_remove,
358 .id_table = dummy_id,
362 * i2c_new_dummy - return a new i2c device bound to a dummy driver
363 * @adapter: the adapter managing the device
364 * @address: seven bit address to be used
365 * Context: can sleep
367 * This returns an I2C client bound to the "dummy" driver, intended for use
368 * with devices that consume multiple addresses. Examples of such chips
369 * include various EEPROMS (like 24c04 and 24c08 models).
371 * These dummy devices have two main uses. First, most I2C and SMBus calls
372 * except i2c_transfer() need a client handle; the dummy will be that handle.
373 * And second, this prevents the specified address from being bound to a
374 * different driver.
376 * This returns the new i2c client, which should be saved for later use with
377 * i2c_unregister_device(); or NULL to indicate an error.
379 struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
381 struct i2c_board_info info = {
382 I2C_BOARD_INFO("dummy", address),
385 return i2c_new_device(adapter, &info);
387 EXPORT_SYMBOL_GPL(i2c_new_dummy);
389 /* ------------------------------------------------------------------------- */
391 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
393 static void i2c_adapter_dev_release(struct device *dev)
395 struct i2c_adapter *adap = to_i2c_adapter(dev);
396 complete(&adap->dev_released);
400 * Let users instantiate I2C devices through sysfs. This can be used when
401 * platform initialization code doesn't contain the proper data for
402 * whatever reason. Also useful for drivers that do device detection and
403 * detection fails, either because the device uses an unexpected address,
404 * or this is a compatible device with different ID register values.
406 * Parameter checking may look overzealous, but we really don't want
407 * the user to provide incorrect parameters.
409 static ssize_t
410 i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
411 const char *buf, size_t count)
413 struct i2c_adapter *adap = to_i2c_adapter(dev);
414 struct i2c_board_info info;
415 struct i2c_client *client;
416 char *blank, end;
417 int res;
419 dev_warn(dev, "The new_device interface is still experimental "
420 "and may change in a near future\n");
421 memset(&info, 0, sizeof(struct i2c_board_info));
423 blank = strchr(buf, ' ');
424 if (!blank) {
425 dev_err(dev, "%s: Missing parameters\n", "new_device");
426 return -EINVAL;
428 if (blank - buf > I2C_NAME_SIZE - 1) {
429 dev_err(dev, "%s: Invalid device name\n", "new_device");
430 return -EINVAL;
432 memcpy(info.type, buf, blank - buf);
434 /* Parse remaining parameters, reject extra parameters */
435 res = sscanf(++blank, "%hi%c", &info.addr, &end);
436 if (res < 1) {
437 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
438 return -EINVAL;
440 if (res > 1 && end != '\n') {
441 dev_err(dev, "%s: Extra parameters\n", "new_device");
442 return -EINVAL;
445 if (info.addr < 0x03 || info.addr > 0x77) {
446 dev_err(dev, "%s: Invalid I2C address 0x%hx\n", "new_device",
447 info.addr);
448 return -EINVAL;
451 client = i2c_new_device(adap, &info);
452 if (!client)
453 return -EEXIST;
455 /* Keep track of the added device */
456 mutex_lock(&core_lock);
457 list_add_tail(&client->detected, &userspace_devices);
458 mutex_unlock(&core_lock);
459 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
460 info.type, info.addr);
462 return count;
466 * And of course let the users delete the devices they instantiated, if
467 * they got it wrong. This interface can only be used to delete devices
468 * instantiated by i2c_sysfs_new_device above. This guarantees that we
469 * don't delete devices to which some kernel code still has references.
471 * Parameter checking may look overzealous, but we really don't want
472 * the user to delete the wrong device.
474 static ssize_t
475 i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
476 const char *buf, size_t count)
478 struct i2c_adapter *adap = to_i2c_adapter(dev);
479 struct i2c_client *client, *next;
480 unsigned short addr;
481 char end;
482 int res;
484 /* Parse parameters, reject extra parameters */
485 res = sscanf(buf, "%hi%c", &addr, &end);
486 if (res < 1) {
487 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
488 return -EINVAL;
490 if (res > 1 && end != '\n') {
491 dev_err(dev, "%s: Extra parameters\n", "delete_device");
492 return -EINVAL;
495 /* Make sure the device was added through sysfs */
496 res = -ENOENT;
497 mutex_lock(&core_lock);
498 list_for_each_entry_safe(client, next, &userspace_devices, detected) {
499 if (client->addr == addr && client->adapter == adap) {
500 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
501 "delete_device", client->name, client->addr);
503 list_del(&client->detected);
504 i2c_unregister_device(client);
505 res = count;
506 break;
509 mutex_unlock(&core_lock);
511 if (res < 0)
512 dev_err(dev, "%s: Can't find device in list\n",
513 "delete_device");
514 return res;
517 static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
518 static DEVICE_ATTR(delete_device, S_IWUSR, NULL, i2c_sysfs_delete_device);
520 static struct attribute *i2c_adapter_attrs[] = {
521 &dev_attr_name.attr,
522 &dev_attr_new_device.attr,
523 &dev_attr_delete_device.attr,
524 NULL
527 static struct attribute_group i2c_adapter_attr_group = {
528 .attrs = i2c_adapter_attrs,
531 static const struct attribute_group *i2c_adapter_attr_groups[] = {
532 &i2c_adapter_attr_group,
533 NULL
536 static struct device_type i2c_adapter_type = {
537 .groups = i2c_adapter_attr_groups,
538 .release = i2c_adapter_dev_release,
541 #ifdef CONFIG_I2C_COMPAT
542 static struct class_compat *i2c_adapter_compat_class;
543 #endif
545 static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
547 struct i2c_devinfo *devinfo;
549 down_read(&__i2c_board_lock);
550 list_for_each_entry(devinfo, &__i2c_board_list, list) {
551 if (devinfo->busnum == adapter->nr
552 && !i2c_new_device(adapter,
553 &devinfo->board_info))
554 dev_err(&adapter->dev,
555 "Can't create device at 0x%02x\n",
556 devinfo->board_info.addr);
558 up_read(&__i2c_board_lock);
561 static int i2c_do_add_adapter(struct device_driver *d, void *data)
563 struct i2c_driver *driver = to_i2c_driver(d);
564 struct i2c_adapter *adap = data;
566 /* Detect supported devices on that bus, and instantiate them */
567 i2c_detect(adap, driver);
569 /* Let legacy drivers scan this bus for matching devices */
570 if (driver->attach_adapter) {
571 /* We ignore the return code; if it fails, too bad */
572 driver->attach_adapter(adap);
574 return 0;
577 static int i2c_register_adapter(struct i2c_adapter *adap)
579 int res = 0, dummy;
581 /* Can't register until after driver model init */
582 if (unlikely(WARN_ON(!i2c_bus_type.p))) {
583 res = -EAGAIN;
584 goto out_list;
587 rt_mutex_init(&adap->bus_lock);
589 /* Set default timeout to 1 second if not already set */
590 if (adap->timeout == 0)
591 adap->timeout = HZ;
593 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
594 adap->dev.bus = &i2c_bus_type;
595 adap->dev.type = &i2c_adapter_type;
596 res = device_register(&adap->dev);
597 if (res)
598 goto out_list;
600 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
602 #ifdef CONFIG_I2C_COMPAT
603 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
604 adap->dev.parent);
605 if (res)
606 dev_warn(&adap->dev,
607 "Failed to create compatibility class link\n");
608 #endif
610 /* create pre-declared device nodes */
611 if (adap->nr < __i2c_first_dynamic_bus_num)
612 i2c_scan_static_board_info(adap);
614 /* Notify drivers */
615 mutex_lock(&core_lock);
616 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
617 i2c_do_add_adapter);
618 mutex_unlock(&core_lock);
620 return 0;
622 out_list:
623 mutex_lock(&core_lock);
624 idr_remove(&i2c_adapter_idr, adap->nr);
625 mutex_unlock(&core_lock);
626 return res;
630 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
631 * @adapter: the adapter to add
632 * Context: can sleep
634 * This routine is used to declare an I2C adapter when its bus number
635 * doesn't matter. Examples: for I2C adapters dynamically added by
636 * USB links or PCI plugin cards.
638 * When this returns zero, a new bus number was allocated and stored
639 * in adap->nr, and the specified adapter became available for clients.
640 * Otherwise, a negative errno value is returned.
642 int i2c_add_adapter(struct i2c_adapter *adapter)
644 int id, res = 0;
646 retry:
647 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
648 return -ENOMEM;
650 mutex_lock(&core_lock);
651 /* "above" here means "above or equal to", sigh */
652 res = idr_get_new_above(&i2c_adapter_idr, adapter,
653 __i2c_first_dynamic_bus_num, &id);
654 mutex_unlock(&core_lock);
656 if (res < 0) {
657 if (res == -EAGAIN)
658 goto retry;
659 return res;
662 adapter->nr = id;
663 return i2c_register_adapter(adapter);
665 EXPORT_SYMBOL(i2c_add_adapter);
668 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
669 * @adap: the adapter to register (with adap->nr initialized)
670 * Context: can sleep
672 * This routine is used to declare an I2C adapter when its bus number
673 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
674 * or otherwise built in to the system's mainboard, and where i2c_board_info
675 * is used to properly configure I2C devices.
677 * If no devices have pre-been declared for this bus, then be sure to
678 * register the adapter before any dynamically allocated ones. Otherwise
679 * the required bus ID may not be available.
681 * When this returns zero, the specified adapter became available for
682 * clients using the bus number provided in adap->nr. Also, the table
683 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
684 * and the appropriate driver model device nodes are created. Otherwise, a
685 * negative errno value is returned.
687 int i2c_add_numbered_adapter(struct i2c_adapter *adap)
689 int id;
690 int status;
692 if (adap->nr & ~MAX_ID_MASK)
693 return -EINVAL;
695 retry:
696 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
697 return -ENOMEM;
699 mutex_lock(&core_lock);
700 /* "above" here means "above or equal to", sigh;
701 * we need the "equal to" result to force the result
703 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
704 if (status == 0 && id != adap->nr) {
705 status = -EBUSY;
706 idr_remove(&i2c_adapter_idr, id);
708 mutex_unlock(&core_lock);
709 if (status == -EAGAIN)
710 goto retry;
712 if (status == 0)
713 status = i2c_register_adapter(adap);
714 return status;
716 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
718 static int i2c_do_del_adapter(struct device_driver *d, void *data)
720 struct i2c_driver *driver = to_i2c_driver(d);
721 struct i2c_adapter *adapter = data;
722 struct i2c_client *client, *_n;
723 int res;
725 /* Remove the devices we created ourselves as the result of hardware
726 * probing (using a driver's detect method) */
727 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
728 if (client->adapter == adapter) {
729 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
730 client->name, client->addr);
731 list_del(&client->detected);
732 i2c_unregister_device(client);
736 if (!driver->detach_adapter)
737 return 0;
738 res = driver->detach_adapter(adapter);
739 if (res)
740 dev_err(&adapter->dev, "detach_adapter failed (%d) "
741 "for driver [%s]\n", res, driver->driver.name);
742 return res;
745 static int __unregister_client(struct device *dev, void *dummy)
747 struct i2c_client *client = i2c_verify_client(dev);
748 if (client)
749 i2c_unregister_device(client);
750 return 0;
754 * i2c_del_adapter - unregister I2C adapter
755 * @adap: the adapter being unregistered
756 * Context: can sleep
758 * This unregisters an I2C adapter which was previously registered
759 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
761 int i2c_del_adapter(struct i2c_adapter *adap)
763 int res = 0;
764 struct i2c_adapter *found;
766 /* First make sure that this adapter was ever added */
767 mutex_lock(&core_lock);
768 found = idr_find(&i2c_adapter_idr, adap->nr);
769 mutex_unlock(&core_lock);
770 if (found != adap) {
771 pr_debug("i2c-core: attempting to delete unregistered "
772 "adapter [%s]\n", adap->name);
773 return -EINVAL;
776 /* Tell drivers about this removal */
777 mutex_lock(&core_lock);
778 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
779 i2c_do_del_adapter);
780 mutex_unlock(&core_lock);
781 if (res)
782 return res;
784 /* Detach any active clients. This can't fail, thus we do not
785 checking the returned value. */
786 res = device_for_each_child(&adap->dev, NULL, __unregister_client);
788 #ifdef CONFIG_I2C_COMPAT
789 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
790 adap->dev.parent);
791 #endif
793 /* clean up the sysfs representation */
794 init_completion(&adap->dev_released);
795 device_unregister(&adap->dev);
797 /* wait for sysfs to drop all references */
798 wait_for_completion(&adap->dev_released);
800 /* free bus id */
801 mutex_lock(&core_lock);
802 idr_remove(&i2c_adapter_idr, adap->nr);
803 mutex_unlock(&core_lock);
805 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
807 /* Clear the device structure in case this adapter is ever going to be
808 added again */
809 memset(&adap->dev, 0, sizeof(adap->dev));
811 return 0;
813 EXPORT_SYMBOL(i2c_del_adapter);
816 /* ------------------------------------------------------------------------- */
818 static int __attach_adapter(struct device *dev, void *data)
820 struct i2c_adapter *adapter;
821 struct i2c_driver *driver = data;
823 if (dev->type != &i2c_adapter_type)
824 return 0;
825 adapter = to_i2c_adapter(dev);
827 i2c_detect(adapter, driver);
829 /* Legacy drivers scan i2c busses directly */
830 if (driver->attach_adapter)
831 driver->attach_adapter(adapter);
833 return 0;
837 * An i2c_driver is used with one or more i2c_client (device) nodes to access
838 * i2c slave chips, on a bus instance associated with some i2c_adapter.
841 int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
843 int res;
845 /* Can't register until after driver model init */
846 if (unlikely(WARN_ON(!i2c_bus_type.p)))
847 return -EAGAIN;
849 /* add the driver to the list of i2c drivers in the driver core */
850 driver->driver.owner = owner;
851 driver->driver.bus = &i2c_bus_type;
853 /* When registration returns, the driver core
854 * will have called probe() for all matching-but-unbound devices.
856 res = driver_register(&driver->driver);
857 if (res)
858 return res;
860 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
862 INIT_LIST_HEAD(&driver->clients);
863 /* Walk the adapters that are already present */
864 mutex_lock(&core_lock);
865 bus_for_each_dev(&i2c_bus_type, NULL, driver, __attach_adapter);
866 mutex_unlock(&core_lock);
868 return 0;
870 EXPORT_SYMBOL(i2c_register_driver);
872 static int __detach_adapter(struct device *dev, void *data)
874 struct i2c_adapter *adapter;
875 struct i2c_driver *driver = data;
876 struct i2c_client *client, *_n;
878 if (dev->type != &i2c_adapter_type)
879 return 0;
880 adapter = to_i2c_adapter(dev);
882 /* Remove the devices we created ourselves as the result of hardware
883 * probing (using a driver's detect method) */
884 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
885 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
886 client->name, client->addr);
887 list_del(&client->detected);
888 i2c_unregister_device(client);
891 if (driver->detach_adapter) {
892 if (driver->detach_adapter(adapter))
893 dev_err(&adapter->dev,
894 "detach_adapter failed for driver [%s]\n",
895 driver->driver.name);
898 return 0;
902 * i2c_del_driver - unregister I2C driver
903 * @driver: the driver being unregistered
904 * Context: can sleep
906 void i2c_del_driver(struct i2c_driver *driver)
908 mutex_lock(&core_lock);
909 bus_for_each_dev(&i2c_bus_type, NULL, driver, __detach_adapter);
910 mutex_unlock(&core_lock);
912 driver_unregister(&driver->driver);
913 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
915 EXPORT_SYMBOL(i2c_del_driver);
917 /* ------------------------------------------------------------------------- */
919 static int __i2c_check_addr(struct device *dev, void *addrp)
921 struct i2c_client *client = i2c_verify_client(dev);
922 int addr = *(int *)addrp;
924 if (client && client->addr == addr)
925 return -EBUSY;
926 return 0;
929 static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
931 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
935 * i2c_use_client - increments the reference count of the i2c client structure
936 * @client: the client being referenced
938 * Each live reference to a client should be refcounted. The driver model does
939 * that automatically as part of driver binding, so that most drivers don't
940 * need to do this explicitly: they hold a reference until they're unbound
941 * from the device.
943 * A pointer to the client with the incremented reference counter is returned.
945 struct i2c_client *i2c_use_client(struct i2c_client *client)
947 if (client && get_device(&client->dev))
948 return client;
949 return NULL;
951 EXPORT_SYMBOL(i2c_use_client);
954 * i2c_release_client - release a use of the i2c client structure
955 * @client: the client being no longer referenced
957 * Must be called when a user of a client is finished with it.
959 void i2c_release_client(struct i2c_client *client)
961 if (client)
962 put_device(&client->dev);
964 EXPORT_SYMBOL(i2c_release_client);
966 struct i2c_cmd_arg {
967 unsigned cmd;
968 void *arg;
971 static int i2c_cmd(struct device *dev, void *_arg)
973 struct i2c_client *client = i2c_verify_client(dev);
974 struct i2c_cmd_arg *arg = _arg;
976 if (client && client->driver && client->driver->command)
977 client->driver->command(client, arg->cmd, arg->arg);
978 return 0;
981 void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
983 struct i2c_cmd_arg cmd_arg;
985 cmd_arg.cmd = cmd;
986 cmd_arg.arg = arg;
987 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
989 EXPORT_SYMBOL(i2c_clients_command);
991 static int __init i2c_init(void)
993 int retval;
995 retval = bus_register(&i2c_bus_type);
996 if (retval)
997 return retval;
998 #ifdef CONFIG_I2C_COMPAT
999 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
1000 if (!i2c_adapter_compat_class) {
1001 retval = -ENOMEM;
1002 goto bus_err;
1004 #endif
1005 retval = i2c_add_driver(&dummy_driver);
1006 if (retval)
1007 goto class_err;
1008 return 0;
1010 class_err:
1011 #ifdef CONFIG_I2C_COMPAT
1012 class_compat_unregister(i2c_adapter_compat_class);
1013 bus_err:
1014 #endif
1015 bus_unregister(&i2c_bus_type);
1016 return retval;
1019 static void __exit i2c_exit(void)
1021 i2c_del_driver(&dummy_driver);
1022 #ifdef CONFIG_I2C_COMPAT
1023 class_compat_unregister(i2c_adapter_compat_class);
1024 #endif
1025 bus_unregister(&i2c_bus_type);
1028 /* We must initialize early, because some subsystems register i2c drivers
1029 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1031 postcore_initcall(i2c_init);
1032 module_exit(i2c_exit);
1034 /* ----------------------------------------------------
1035 * the functional interface to the i2c busses.
1036 * ----------------------------------------------------
1040 * i2c_transfer - execute a single or combined I2C message
1041 * @adap: Handle to I2C bus
1042 * @msgs: One or more messages to execute before STOP is issued to
1043 * terminate the operation; each message begins with a START.
1044 * @num: Number of messages to be executed.
1046 * Returns negative errno, else the number of messages executed.
1048 * Note that there is no requirement that each message be sent to
1049 * the same slave address, although that is the most common model.
1051 int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1053 unsigned long orig_jiffies;
1054 int ret, try;
1056 /* REVISIT the fault reporting model here is weak:
1058 * - When we get an error after receiving N bytes from a slave,
1059 * there is no way to report "N".
1061 * - When we get a NAK after transmitting N bytes to a slave,
1062 * there is no way to report "N" ... or to let the master
1063 * continue executing the rest of this combined message, if
1064 * that's the appropriate response.
1066 * - When for example "num" is two and we successfully complete
1067 * the first message but get an error part way through the
1068 * second, it's unclear whether that should be reported as
1069 * one (discarding status on the second message) or errno
1070 * (discarding status on the first one).
1073 if (adap->algo->master_xfer) {
1074 #ifdef DEBUG
1075 for (ret = 0; ret < num; ret++) {
1076 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
1077 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1078 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1079 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
1081 #endif
1083 if (in_atomic() || irqs_disabled()) {
1084 ret = rt_mutex_trylock(&adap->bus_lock);
1085 if (!ret)
1086 /* I2C activity is ongoing. */
1087 return -EAGAIN;
1088 } else {
1089 rt_mutex_lock(&adap->bus_lock);
1092 /* Retry automatically on arbitration loss */
1093 orig_jiffies = jiffies;
1094 for (ret = 0, try = 0; try <= adap->retries; try++) {
1095 ret = adap->algo->master_xfer(adap, msgs, num);
1096 if (ret != -EAGAIN)
1097 break;
1098 if (time_after(jiffies, orig_jiffies + adap->timeout))
1099 break;
1101 rt_mutex_unlock(&adap->bus_lock);
1103 return ret;
1104 } else {
1105 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
1106 return -EOPNOTSUPP;
1109 EXPORT_SYMBOL(i2c_transfer);
1112 * i2c_master_send - issue a single I2C message in master transmit mode
1113 * @client: Handle to slave device
1114 * @buf: Data that will be written to the slave
1115 * @count: How many bytes to write
1117 * Returns negative errno, or else the number of bytes written.
1119 int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1121 int ret;
1122 struct i2c_adapter *adap=client->adapter;
1123 struct i2c_msg msg;
1125 msg.addr = client->addr;
1126 msg.flags = client->flags & I2C_M_TEN;
1127 msg.len = count;
1128 msg.buf = (char *)buf;
1130 ret = i2c_transfer(adap, &msg, 1);
1132 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1133 transmitted, else error code. */
1134 return (ret == 1) ? count : ret;
1136 EXPORT_SYMBOL(i2c_master_send);
1139 * i2c_master_recv - issue a single I2C message in master receive mode
1140 * @client: Handle to slave device
1141 * @buf: Where to store data read from slave
1142 * @count: How many bytes to read
1144 * Returns negative errno, or else the number of bytes read.
1146 int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1148 struct i2c_adapter *adap=client->adapter;
1149 struct i2c_msg msg;
1150 int ret;
1152 msg.addr = client->addr;
1153 msg.flags = client->flags & I2C_M_TEN;
1154 msg.flags |= I2C_M_RD;
1155 msg.len = count;
1156 msg.buf = buf;
1158 ret = i2c_transfer(adap, &msg, 1);
1160 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1161 transmitted, else error code. */
1162 return (ret == 1) ? count : ret;
1164 EXPORT_SYMBOL(i2c_master_recv);
1166 /* ----------------------------------------------------
1167 * the i2c address scanning function
1168 * Will not work for 10-bit addresses!
1169 * ----------------------------------------------------
1172 static int i2c_detect_address(struct i2c_client *temp_client,
1173 struct i2c_driver *driver)
1175 struct i2c_board_info info;
1176 struct i2c_adapter *adapter = temp_client->adapter;
1177 int addr = temp_client->addr;
1178 int err;
1180 /* Make sure the address is valid */
1181 if (addr < 0x03 || addr > 0x77) {
1182 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1183 addr);
1184 return -EINVAL;
1187 /* Skip if already in use */
1188 if (i2c_check_addr(adapter, addr))
1189 return 0;
1191 /* Make sure there is something at this address */
1192 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0, I2C_SMBUS_QUICK, NULL) < 0)
1193 return 0;
1195 /* Prevent 24RF08 corruption */
1196 if ((addr & ~0x0f) == 0x50)
1197 i2c_smbus_xfer(adapter, addr, 0, 0, 0, I2C_SMBUS_QUICK, NULL);
1199 /* Finally call the custom detection function */
1200 memset(&info, 0, sizeof(struct i2c_board_info));
1201 info.addr = addr;
1202 err = driver->detect(temp_client, -1, &info);
1203 if (err) {
1204 /* -ENODEV is returned if the detection fails. We catch it
1205 here as this isn't an error. */
1206 return err == -ENODEV ? 0 : err;
1209 /* Consistency check */
1210 if (info.type[0] == '\0') {
1211 dev_err(&adapter->dev, "%s detection function provided "
1212 "no name for 0x%x\n", driver->driver.name,
1213 addr);
1214 } else {
1215 struct i2c_client *client;
1217 /* Detection succeeded, instantiate the device */
1218 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1219 info.type, info.addr);
1220 client = i2c_new_device(adapter, &info);
1221 if (client)
1222 list_add_tail(&client->detected, &driver->clients);
1223 else
1224 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1225 info.type, info.addr);
1227 return 0;
1230 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1232 const struct i2c_client_address_data *address_data;
1233 struct i2c_client *temp_client;
1234 int i, err = 0;
1235 int adap_id = i2c_adapter_id(adapter);
1237 address_data = driver->address_data;
1238 if (!driver->detect || !address_data)
1239 return 0;
1241 /* Set up a temporary client to help detect callback */
1242 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1243 if (!temp_client)
1244 return -ENOMEM;
1245 temp_client->adapter = adapter;
1247 /* Stop here if the classes do not match */
1248 if (!(adapter->class & driver->class))
1249 goto exit_free;
1251 /* Stop here if we can't use SMBUS_QUICK */
1252 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1253 if (address_data->normal_i2c[0] == I2C_CLIENT_END)
1254 goto exit_free;
1256 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1257 "can't probe for chips\n");
1258 err = -EOPNOTSUPP;
1259 goto exit_free;
1262 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1263 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1264 "addr 0x%02x\n", adap_id,
1265 address_data->normal_i2c[i]);
1266 temp_client->addr = address_data->normal_i2c[i];
1267 err = i2c_detect_address(temp_client, driver);
1268 if (err)
1269 goto exit_free;
1272 exit_free:
1273 kfree(temp_client);
1274 return err;
1277 struct i2c_client *
1278 i2c_new_probed_device(struct i2c_adapter *adap,
1279 struct i2c_board_info *info,
1280 unsigned short const *addr_list)
1282 int i;
1284 /* Stop here if the bus doesn't support probing */
1285 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1286 dev_err(&adap->dev, "Probing not supported\n");
1287 return NULL;
1290 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1291 /* Check address validity */
1292 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1293 dev_warn(&adap->dev, "Invalid 7-bit address "
1294 "0x%02x\n", addr_list[i]);
1295 continue;
1298 /* Check address availability */
1299 if (i2c_check_addr(adap, addr_list[i])) {
1300 dev_dbg(&adap->dev, "Address 0x%02x already in "
1301 "use, not probing\n", addr_list[i]);
1302 continue;
1305 /* Test address responsiveness
1306 The default probe method is a quick write, but it is known
1307 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1308 and could also irreversibly write-protect some EEPROMs, so
1309 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1310 read instead. Also, some bus drivers don't implement
1311 quick write, so we fallback to a byte read it that case
1312 too. */
1313 if ((addr_list[i] & ~0x07) == 0x30
1314 || (addr_list[i] & ~0x0f) == 0x50
1315 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1316 union i2c_smbus_data data;
1318 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1319 I2C_SMBUS_READ, 0,
1320 I2C_SMBUS_BYTE, &data) >= 0)
1321 break;
1322 } else {
1323 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1324 I2C_SMBUS_WRITE, 0,
1325 I2C_SMBUS_QUICK, NULL) >= 0)
1326 break;
1330 if (addr_list[i] == I2C_CLIENT_END) {
1331 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1332 return NULL;
1335 info->addr = addr_list[i];
1336 return i2c_new_device(adap, info);
1338 EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1340 struct i2c_adapter* i2c_get_adapter(int id)
1342 struct i2c_adapter *adapter;
1344 mutex_lock(&core_lock);
1345 adapter = idr_find(&i2c_adapter_idr, id);
1346 if (adapter && !try_module_get(adapter->owner))
1347 adapter = NULL;
1349 mutex_unlock(&core_lock);
1350 return adapter;
1352 EXPORT_SYMBOL(i2c_get_adapter);
1354 void i2c_put_adapter(struct i2c_adapter *adap)
1356 module_put(adap->owner);
1358 EXPORT_SYMBOL(i2c_put_adapter);
1360 /* The SMBus parts */
1362 #define POLY (0x1070U << 3)
1363 static u8 crc8(u16 data)
1365 int i;
1367 for(i = 0; i < 8; i++) {
1368 if (data & 0x8000)
1369 data = data ^ POLY;
1370 data = data << 1;
1372 return (u8)(data >> 8);
1375 /* Incremental CRC8 over count bytes in the array pointed to by p */
1376 static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1378 int i;
1380 for(i = 0; i < count; i++)
1381 crc = crc8((crc ^ p[i]) << 8);
1382 return crc;
1385 /* Assume a 7-bit address, which is reasonable for SMBus */
1386 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1388 /* The address will be sent first */
1389 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1390 pec = i2c_smbus_pec(pec, &addr, 1);
1392 /* The data buffer follows */
1393 return i2c_smbus_pec(pec, msg->buf, msg->len);
1396 /* Used for write only transactions */
1397 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1399 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1400 msg->len++;
1403 /* Return <0 on CRC error
1404 If there was a write before this read (most cases) we need to take the
1405 partial CRC from the write part into account.
1406 Note that this function does modify the message (we need to decrease the
1407 message length to hide the CRC byte from the caller). */
1408 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1410 u8 rpec = msg->buf[--msg->len];
1411 cpec = i2c_smbus_msg_pec(cpec, msg);
1413 if (rpec != cpec) {
1414 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1415 rpec, cpec);
1416 return -EBADMSG;
1418 return 0;
1422 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1423 * @client: Handle to slave device
1425 * This executes the SMBus "receive byte" protocol, returning negative errno
1426 * else the byte received from the device.
1428 s32 i2c_smbus_read_byte(struct i2c_client *client)
1430 union i2c_smbus_data data;
1431 int status;
1433 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1434 I2C_SMBUS_READ, 0,
1435 I2C_SMBUS_BYTE, &data);
1436 return (status < 0) ? status : data.byte;
1438 EXPORT_SYMBOL(i2c_smbus_read_byte);
1441 * i2c_smbus_write_byte - SMBus "send byte" protocol
1442 * @client: Handle to slave device
1443 * @value: Byte to be sent
1445 * This executes the SMBus "send byte" protocol, returning negative errno
1446 * else zero on success.
1448 s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1450 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1451 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1453 EXPORT_SYMBOL(i2c_smbus_write_byte);
1456 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1457 * @client: Handle to slave device
1458 * @command: Byte interpreted by slave
1460 * This executes the SMBus "read byte" protocol, returning negative errno
1461 * else a data byte received from the device.
1463 s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1465 union i2c_smbus_data data;
1466 int status;
1468 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1469 I2C_SMBUS_READ, command,
1470 I2C_SMBUS_BYTE_DATA, &data);
1471 return (status < 0) ? status : data.byte;
1473 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1476 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1477 * @client: Handle to slave device
1478 * @command: Byte interpreted by slave
1479 * @value: Byte being written
1481 * This executes the SMBus "write byte" protocol, returning negative errno
1482 * else zero on success.
1484 s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1486 union i2c_smbus_data data;
1487 data.byte = value;
1488 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1489 I2C_SMBUS_WRITE,command,
1490 I2C_SMBUS_BYTE_DATA,&data);
1492 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1495 * i2c_smbus_read_word_data - SMBus "read word" protocol
1496 * @client: Handle to slave device
1497 * @command: Byte interpreted by slave
1499 * This executes the SMBus "read word" protocol, returning negative errno
1500 * else a 16-bit unsigned "word" received from the device.
1502 s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1504 union i2c_smbus_data data;
1505 int status;
1507 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1508 I2C_SMBUS_READ, command,
1509 I2C_SMBUS_WORD_DATA, &data);
1510 return (status < 0) ? status : data.word;
1512 EXPORT_SYMBOL(i2c_smbus_read_word_data);
1515 * i2c_smbus_write_word_data - SMBus "write word" protocol
1516 * @client: Handle to slave device
1517 * @command: Byte interpreted by slave
1518 * @value: 16-bit "word" being written
1520 * This executes the SMBus "write word" protocol, returning negative errno
1521 * else zero on success.
1523 s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1525 union i2c_smbus_data data;
1526 data.word = value;
1527 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1528 I2C_SMBUS_WRITE,command,
1529 I2C_SMBUS_WORD_DATA,&data);
1531 EXPORT_SYMBOL(i2c_smbus_write_word_data);
1534 * i2c_smbus_process_call - SMBus "process call" protocol
1535 * @client: Handle to slave device
1536 * @command: Byte interpreted by slave
1537 * @value: 16-bit "word" being written
1539 * This executes the SMBus "process call" protocol, returning negative errno
1540 * else a 16-bit unsigned "word" received from the device.
1542 s32 i2c_smbus_process_call(struct i2c_client *client, u8 command, u16 value)
1544 union i2c_smbus_data data;
1545 int status;
1546 data.word = value;
1548 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1549 I2C_SMBUS_WRITE, command,
1550 I2C_SMBUS_PROC_CALL, &data);
1551 return (status < 0) ? status : data.word;
1553 EXPORT_SYMBOL(i2c_smbus_process_call);
1556 * i2c_smbus_read_block_data - SMBus "block read" protocol
1557 * @client: Handle to slave device
1558 * @command: Byte interpreted by slave
1559 * @values: Byte array into which data will be read; big enough to hold
1560 * the data returned by the slave. SMBus allows at most 32 bytes.
1562 * This executes the SMBus "block read" protocol, returning negative errno
1563 * else the number of data bytes in the slave's response.
1565 * Note that using this function requires that the client's adapter support
1566 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1567 * support this; its emulation through I2C messaging relies on a specific
1568 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1570 s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1571 u8 *values)
1573 union i2c_smbus_data data;
1574 int status;
1576 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1577 I2C_SMBUS_READ, command,
1578 I2C_SMBUS_BLOCK_DATA, &data);
1579 if (status)
1580 return status;
1582 memcpy(values, &data.block[1], data.block[0]);
1583 return data.block[0];
1585 EXPORT_SYMBOL(i2c_smbus_read_block_data);
1588 * i2c_smbus_write_block_data - SMBus "block write" protocol
1589 * @client: Handle to slave device
1590 * @command: Byte interpreted by slave
1591 * @length: Size of data block; SMBus allows at most 32 bytes
1592 * @values: Byte array which will be written.
1594 * This executes the SMBus "block write" protocol, returning negative errno
1595 * else zero on success.
1597 s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1598 u8 length, const u8 *values)
1600 union i2c_smbus_data data;
1602 if (length > I2C_SMBUS_BLOCK_MAX)
1603 length = I2C_SMBUS_BLOCK_MAX;
1604 data.block[0] = length;
1605 memcpy(&data.block[1], values, length);
1606 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1607 I2C_SMBUS_WRITE,command,
1608 I2C_SMBUS_BLOCK_DATA,&data);
1610 EXPORT_SYMBOL(i2c_smbus_write_block_data);
1612 /* Returns the number of read bytes */
1613 s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1614 u8 length, u8 *values)
1616 union i2c_smbus_data data;
1617 int status;
1619 if (length > I2C_SMBUS_BLOCK_MAX)
1620 length = I2C_SMBUS_BLOCK_MAX;
1621 data.block[0] = length;
1622 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1623 I2C_SMBUS_READ, command,
1624 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1625 if (status < 0)
1626 return status;
1628 memcpy(values, &data.block[1], data.block[0]);
1629 return data.block[0];
1631 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1633 s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1634 u8 length, const u8 *values)
1636 union i2c_smbus_data data;
1638 if (length > I2C_SMBUS_BLOCK_MAX)
1639 length = I2C_SMBUS_BLOCK_MAX;
1640 data.block[0] = length;
1641 memcpy(data.block + 1, values, length);
1642 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1643 I2C_SMBUS_WRITE, command,
1644 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1646 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1648 /* Simulate a SMBus command using the i2c protocol
1649 No checking of parameters is done! */
1650 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
1651 unsigned short flags,
1652 char read_write, u8 command, int size,
1653 union i2c_smbus_data * data)
1655 /* So we need to generate a series of msgs. In the case of writing, we
1656 need to use only one message; when reading, we need two. We initialize
1657 most things with sane defaults, to keep the code below somewhat
1658 simpler. */
1659 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1660 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1661 int num = read_write == I2C_SMBUS_READ?2:1;
1662 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1663 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1665 int i;
1666 u8 partial_pec = 0;
1667 int status;
1669 msgbuf0[0] = command;
1670 switch(size) {
1671 case I2C_SMBUS_QUICK:
1672 msg[0].len = 0;
1673 /* Special case: The read/write field is used as data */
1674 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
1675 I2C_M_RD : 0);
1676 num = 1;
1677 break;
1678 case I2C_SMBUS_BYTE:
1679 if (read_write == I2C_SMBUS_READ) {
1680 /* Special case: only a read! */
1681 msg[0].flags = I2C_M_RD | flags;
1682 num = 1;
1684 break;
1685 case I2C_SMBUS_BYTE_DATA:
1686 if (read_write == I2C_SMBUS_READ)
1687 msg[1].len = 1;
1688 else {
1689 msg[0].len = 2;
1690 msgbuf0[1] = data->byte;
1692 break;
1693 case I2C_SMBUS_WORD_DATA:
1694 if (read_write == I2C_SMBUS_READ)
1695 msg[1].len = 2;
1696 else {
1697 msg[0].len=3;
1698 msgbuf0[1] = data->word & 0xff;
1699 msgbuf0[2] = data->word >> 8;
1701 break;
1702 case I2C_SMBUS_PROC_CALL:
1703 num = 2; /* Special case */
1704 read_write = I2C_SMBUS_READ;
1705 msg[0].len = 3;
1706 msg[1].len = 2;
1707 msgbuf0[1] = data->word & 0xff;
1708 msgbuf0[2] = data->word >> 8;
1709 break;
1710 case I2C_SMBUS_BLOCK_DATA:
1711 if (read_write == I2C_SMBUS_READ) {
1712 msg[1].flags |= I2C_M_RECV_LEN;
1713 msg[1].len = 1; /* block length will be added by
1714 the underlying bus driver */
1715 } else {
1716 msg[0].len = data->block[0] + 2;
1717 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1718 dev_err(&adapter->dev,
1719 "Invalid block write size %d\n",
1720 data->block[0]);
1721 return -EINVAL;
1723 for (i = 1; i < msg[0].len; i++)
1724 msgbuf0[i] = data->block[i-1];
1726 break;
1727 case I2C_SMBUS_BLOCK_PROC_CALL:
1728 num = 2; /* Another special case */
1729 read_write = I2C_SMBUS_READ;
1730 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1731 dev_err(&adapter->dev,
1732 "Invalid block write size %d\n",
1733 data->block[0]);
1734 return -EINVAL;
1736 msg[0].len = data->block[0] + 2;
1737 for (i = 1; i < msg[0].len; i++)
1738 msgbuf0[i] = data->block[i-1];
1739 msg[1].flags |= I2C_M_RECV_LEN;
1740 msg[1].len = 1; /* block length will be added by
1741 the underlying bus driver */
1742 break;
1743 case I2C_SMBUS_I2C_BLOCK_DATA:
1744 if (read_write == I2C_SMBUS_READ) {
1745 msg[1].len = data->block[0];
1746 } else {
1747 msg[0].len = data->block[0] + 1;
1748 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
1749 dev_err(&adapter->dev,
1750 "Invalid block write size %d\n",
1751 data->block[0]);
1752 return -EINVAL;
1754 for (i = 1; i <= data->block[0]; i++)
1755 msgbuf0[i] = data->block[i];
1757 break;
1758 default:
1759 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1760 return -EOPNOTSUPP;
1763 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1764 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1765 if (i) {
1766 /* Compute PEC if first message is a write */
1767 if (!(msg[0].flags & I2C_M_RD)) {
1768 if (num == 1) /* Write only */
1769 i2c_smbus_add_pec(&msg[0]);
1770 else /* Write followed by read */
1771 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1773 /* Ask for PEC if last message is a read */
1774 if (msg[num-1].flags & I2C_M_RD)
1775 msg[num-1].len++;
1778 status = i2c_transfer(adapter, msg, num);
1779 if (status < 0)
1780 return status;
1782 /* Check PEC if last message is a read */
1783 if (i && (msg[num-1].flags & I2C_M_RD)) {
1784 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1785 if (status < 0)
1786 return status;
1789 if (read_write == I2C_SMBUS_READ)
1790 switch(size) {
1791 case I2C_SMBUS_BYTE:
1792 data->byte = msgbuf0[0];
1793 break;
1794 case I2C_SMBUS_BYTE_DATA:
1795 data->byte = msgbuf1[0];
1796 break;
1797 case I2C_SMBUS_WORD_DATA:
1798 case I2C_SMBUS_PROC_CALL:
1799 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1800 break;
1801 case I2C_SMBUS_I2C_BLOCK_DATA:
1802 for (i = 0; i < data->block[0]; i++)
1803 data->block[i+1] = msgbuf1[i];
1804 break;
1805 case I2C_SMBUS_BLOCK_DATA:
1806 case I2C_SMBUS_BLOCK_PROC_CALL:
1807 for (i = 0; i < msgbuf1[0] + 1; i++)
1808 data->block[i] = msgbuf1[i];
1809 break;
1811 return 0;
1815 * i2c_smbus_xfer - execute SMBus protocol operations
1816 * @adapter: Handle to I2C bus
1817 * @addr: Address of SMBus slave on that bus
1818 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1819 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1820 * @command: Byte interpreted by slave, for protocols which use such bytes
1821 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1822 * @data: Data to be read or written
1824 * This executes an SMBus protocol operation, and returns a negative
1825 * errno code else zero on success.
1827 s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
1828 char read_write, u8 command, int protocol,
1829 union i2c_smbus_data *data)
1831 unsigned long orig_jiffies;
1832 int try;
1833 s32 res;
1835 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
1837 if (adapter->algo->smbus_xfer) {
1838 rt_mutex_lock(&adapter->bus_lock);
1840 /* Retry automatically on arbitration loss */
1841 orig_jiffies = jiffies;
1842 for (res = 0, try = 0; try <= adapter->retries; try++) {
1843 res = adapter->algo->smbus_xfer(adapter, addr, flags,
1844 read_write, command,
1845 protocol, data);
1846 if (res != -EAGAIN)
1847 break;
1848 if (time_after(jiffies,
1849 orig_jiffies + adapter->timeout))
1850 break;
1852 rt_mutex_unlock(&adapter->bus_lock);
1853 } else
1854 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
1855 command, protocol, data);
1857 return res;
1859 EXPORT_SYMBOL(i2c_smbus_xfer);
1861 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1862 MODULE_DESCRIPTION("I2C-Bus main module");
1863 MODULE_LICENSE("GPL");