sched: Fix select_task_rq() vs hotplug issues
[linux-2.6/libata-dev.git] / drivers / i2c / i2c-core.c
blob0ac2f90ab840c8f1863013ba9551a3266247f738
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 #ifdef CONFIG_SUSPEND
159 static int i2c_device_pm_suspend(struct device *dev)
161 const struct dev_pm_ops *pm;
163 if (!dev->driver)
164 return 0;
165 pm = dev->driver->pm;
166 if (!pm || !pm->suspend)
167 return 0;
168 return pm->suspend(dev);
171 static int i2c_device_pm_resume(struct device *dev)
173 const struct dev_pm_ops *pm;
175 if (!dev->driver)
176 return 0;
177 pm = dev->driver->pm;
178 if (!pm || !pm->resume)
179 return 0;
180 return pm->resume(dev);
182 #else
183 #define i2c_device_pm_suspend NULL
184 #define i2c_device_pm_resume NULL
185 #endif
187 static int i2c_device_suspend(struct device *dev, pm_message_t mesg)
189 struct i2c_client *client = i2c_verify_client(dev);
190 struct i2c_driver *driver;
192 if (!client || !dev->driver)
193 return 0;
194 driver = to_i2c_driver(dev->driver);
195 if (!driver->suspend)
196 return 0;
197 return driver->suspend(client, mesg);
200 static int i2c_device_resume(struct device *dev)
202 struct i2c_client *client = i2c_verify_client(dev);
203 struct i2c_driver *driver;
205 if (!client || !dev->driver)
206 return 0;
207 driver = to_i2c_driver(dev->driver);
208 if (!driver->resume)
209 return 0;
210 return driver->resume(client);
213 static void i2c_client_dev_release(struct device *dev)
215 kfree(to_i2c_client(dev));
218 static ssize_t
219 show_name(struct device *dev, struct device_attribute *attr, char *buf)
221 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
222 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
225 static ssize_t
226 show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
228 struct i2c_client *client = to_i2c_client(dev);
229 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
232 static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
233 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
235 static struct attribute *i2c_dev_attrs[] = {
236 &dev_attr_name.attr,
237 /* modalias helps coldplug: modprobe $(cat .../modalias) */
238 &dev_attr_modalias.attr,
239 NULL
242 static struct attribute_group i2c_dev_attr_group = {
243 .attrs = i2c_dev_attrs,
246 static const struct attribute_group *i2c_dev_attr_groups[] = {
247 &i2c_dev_attr_group,
248 NULL
251 const static struct dev_pm_ops i2c_device_pm_ops = {
252 .suspend = i2c_device_pm_suspend,
253 .resume = i2c_device_pm_resume,
256 struct bus_type i2c_bus_type = {
257 .name = "i2c",
258 .match = i2c_device_match,
259 .probe = i2c_device_probe,
260 .remove = i2c_device_remove,
261 .shutdown = i2c_device_shutdown,
262 .suspend = i2c_device_suspend,
263 .resume = i2c_device_resume,
264 .pm = &i2c_device_pm_ops,
266 EXPORT_SYMBOL_GPL(i2c_bus_type);
268 static struct device_type i2c_client_type = {
269 .groups = i2c_dev_attr_groups,
270 .uevent = i2c_device_uevent,
271 .release = i2c_client_dev_release,
276 * i2c_verify_client - return parameter as i2c_client, or NULL
277 * @dev: device, probably from some driver model iterator
279 * When traversing the driver model tree, perhaps using driver model
280 * iterators like @device_for_each_child(), you can't assume very much
281 * about the nodes you find. Use this function to avoid oopses caused
282 * by wrongly treating some non-I2C device as an i2c_client.
284 struct i2c_client *i2c_verify_client(struct device *dev)
286 return (dev->type == &i2c_client_type)
287 ? to_i2c_client(dev)
288 : NULL;
290 EXPORT_SYMBOL(i2c_verify_client);
294 * i2c_new_device - instantiate an i2c device
295 * @adap: the adapter managing the device
296 * @info: describes one I2C device; bus_num is ignored
297 * Context: can sleep
299 * Create an i2c device. Binding is handled through driver model
300 * probe()/remove() methods. A driver may be bound to this device when we
301 * return from this function, or any later moment (e.g. maybe hotplugging will
302 * load the driver module). This call is not appropriate for use by mainboard
303 * initialization logic, which usually runs during an arch_initcall() long
304 * before any i2c_adapter could exist.
306 * This returns the new i2c client, which may be saved for later use with
307 * i2c_unregister_device(); or NULL to indicate an error.
309 struct i2c_client *
310 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
312 struct i2c_client *client;
313 int status;
315 client = kzalloc(sizeof *client, GFP_KERNEL);
316 if (!client)
317 return NULL;
319 client->adapter = adap;
321 client->dev.platform_data = info->platform_data;
323 if (info->archdata)
324 client->dev.archdata = *info->archdata;
326 client->flags = info->flags;
327 client->addr = info->addr;
328 client->irq = info->irq;
330 strlcpy(client->name, info->type, sizeof(client->name));
332 /* Check for address business */
333 status = i2c_check_addr(adap, client->addr);
334 if (status)
335 goto out_err;
337 client->dev.parent = &client->adapter->dev;
338 client->dev.bus = &i2c_bus_type;
339 client->dev.type = &i2c_client_type;
341 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
342 client->addr);
343 status = device_register(&client->dev);
344 if (status)
345 goto out_err;
347 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
348 client->name, dev_name(&client->dev));
350 return client;
352 out_err:
353 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
354 "(%d)\n", client->name, client->addr, status);
355 kfree(client);
356 return NULL;
358 EXPORT_SYMBOL_GPL(i2c_new_device);
362 * i2c_unregister_device - reverse effect of i2c_new_device()
363 * @client: value returned from i2c_new_device()
364 * Context: can sleep
366 void i2c_unregister_device(struct i2c_client *client)
368 device_unregister(&client->dev);
370 EXPORT_SYMBOL_GPL(i2c_unregister_device);
373 static const struct i2c_device_id dummy_id[] = {
374 { "dummy", 0 },
375 { },
378 static int dummy_probe(struct i2c_client *client,
379 const struct i2c_device_id *id)
381 return 0;
384 static int dummy_remove(struct i2c_client *client)
386 return 0;
389 static struct i2c_driver dummy_driver = {
390 .driver.name = "dummy",
391 .probe = dummy_probe,
392 .remove = dummy_remove,
393 .id_table = dummy_id,
397 * i2c_new_dummy - return a new i2c device bound to a dummy driver
398 * @adapter: the adapter managing the device
399 * @address: seven bit address to be used
400 * Context: can sleep
402 * This returns an I2C client bound to the "dummy" driver, intended for use
403 * with devices that consume multiple addresses. Examples of such chips
404 * include various EEPROMS (like 24c04 and 24c08 models).
406 * These dummy devices have two main uses. First, most I2C and SMBus calls
407 * except i2c_transfer() need a client handle; the dummy will be that handle.
408 * And second, this prevents the specified address from being bound to a
409 * different driver.
411 * This returns the new i2c client, which should be saved for later use with
412 * i2c_unregister_device(); or NULL to indicate an error.
414 struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
416 struct i2c_board_info info = {
417 I2C_BOARD_INFO("dummy", address),
420 return i2c_new_device(adapter, &info);
422 EXPORT_SYMBOL_GPL(i2c_new_dummy);
424 /* ------------------------------------------------------------------------- */
426 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
428 static void i2c_adapter_dev_release(struct device *dev)
430 struct i2c_adapter *adap = to_i2c_adapter(dev);
431 complete(&adap->dev_released);
435 * Let users instantiate I2C devices through sysfs. This can be used when
436 * platform initialization code doesn't contain the proper data for
437 * whatever reason. Also useful for drivers that do device detection and
438 * detection fails, either because the device uses an unexpected address,
439 * or this is a compatible device with different ID register values.
441 * Parameter checking may look overzealous, but we really don't want
442 * the user to provide incorrect parameters.
444 static ssize_t
445 i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
446 const char *buf, size_t count)
448 struct i2c_adapter *adap = to_i2c_adapter(dev);
449 struct i2c_board_info info;
450 struct i2c_client *client;
451 char *blank, end;
452 int res;
454 dev_warn(dev, "The new_device interface is still experimental "
455 "and may change in a near future\n");
456 memset(&info, 0, sizeof(struct i2c_board_info));
458 blank = strchr(buf, ' ');
459 if (!blank) {
460 dev_err(dev, "%s: Missing parameters\n", "new_device");
461 return -EINVAL;
463 if (blank - buf > I2C_NAME_SIZE - 1) {
464 dev_err(dev, "%s: Invalid device name\n", "new_device");
465 return -EINVAL;
467 memcpy(info.type, buf, blank - buf);
469 /* Parse remaining parameters, reject extra parameters */
470 res = sscanf(++blank, "%hi%c", &info.addr, &end);
471 if (res < 1) {
472 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
473 return -EINVAL;
475 if (res > 1 && end != '\n') {
476 dev_err(dev, "%s: Extra parameters\n", "new_device");
477 return -EINVAL;
480 if (info.addr < 0x03 || info.addr > 0x77) {
481 dev_err(dev, "%s: Invalid I2C address 0x%hx\n", "new_device",
482 info.addr);
483 return -EINVAL;
486 client = i2c_new_device(adap, &info);
487 if (!client)
488 return -EEXIST;
490 /* Keep track of the added device */
491 mutex_lock(&core_lock);
492 list_add_tail(&client->detected, &userspace_devices);
493 mutex_unlock(&core_lock);
494 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
495 info.type, info.addr);
497 return count;
501 * And of course let the users delete the devices they instantiated, if
502 * they got it wrong. This interface can only be used to delete devices
503 * instantiated by i2c_sysfs_new_device above. This guarantees that we
504 * don't delete devices to which some kernel code still has references.
506 * Parameter checking may look overzealous, but we really don't want
507 * the user to delete the wrong device.
509 static ssize_t
510 i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
511 const char *buf, size_t count)
513 struct i2c_adapter *adap = to_i2c_adapter(dev);
514 struct i2c_client *client, *next;
515 unsigned short addr;
516 char end;
517 int res;
519 /* Parse parameters, reject extra parameters */
520 res = sscanf(buf, "%hi%c", &addr, &end);
521 if (res < 1) {
522 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
523 return -EINVAL;
525 if (res > 1 && end != '\n') {
526 dev_err(dev, "%s: Extra parameters\n", "delete_device");
527 return -EINVAL;
530 /* Make sure the device was added through sysfs */
531 res = -ENOENT;
532 mutex_lock(&core_lock);
533 list_for_each_entry_safe(client, next, &userspace_devices, detected) {
534 if (client->addr == addr && client->adapter == adap) {
535 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
536 "delete_device", client->name, client->addr);
538 list_del(&client->detected);
539 i2c_unregister_device(client);
540 res = count;
541 break;
544 mutex_unlock(&core_lock);
546 if (res < 0)
547 dev_err(dev, "%s: Can't find device in list\n",
548 "delete_device");
549 return res;
552 static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
553 static DEVICE_ATTR(delete_device, S_IWUSR, NULL, i2c_sysfs_delete_device);
555 static struct attribute *i2c_adapter_attrs[] = {
556 &dev_attr_name.attr,
557 &dev_attr_new_device.attr,
558 &dev_attr_delete_device.attr,
559 NULL
562 static struct attribute_group i2c_adapter_attr_group = {
563 .attrs = i2c_adapter_attrs,
566 static const struct attribute_group *i2c_adapter_attr_groups[] = {
567 &i2c_adapter_attr_group,
568 NULL
571 static struct device_type i2c_adapter_type = {
572 .groups = i2c_adapter_attr_groups,
573 .release = i2c_adapter_dev_release,
576 #ifdef CONFIG_I2C_COMPAT
577 static struct class_compat *i2c_adapter_compat_class;
578 #endif
580 static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
582 struct i2c_devinfo *devinfo;
584 down_read(&__i2c_board_lock);
585 list_for_each_entry(devinfo, &__i2c_board_list, list) {
586 if (devinfo->busnum == adapter->nr
587 && !i2c_new_device(adapter,
588 &devinfo->board_info))
589 dev_err(&adapter->dev,
590 "Can't create device at 0x%02x\n",
591 devinfo->board_info.addr);
593 up_read(&__i2c_board_lock);
596 static int i2c_do_add_adapter(struct i2c_driver *driver,
597 struct i2c_adapter *adap)
599 /* Detect supported devices on that bus, and instantiate them */
600 i2c_detect(adap, driver);
602 /* Let legacy drivers scan this bus for matching devices */
603 if (driver->attach_adapter) {
604 /* We ignore the return code; if it fails, too bad */
605 driver->attach_adapter(adap);
607 return 0;
610 static int __process_new_adapter(struct device_driver *d, void *data)
612 return i2c_do_add_adapter(to_i2c_driver(d), data);
615 static int i2c_register_adapter(struct i2c_adapter *adap)
617 int res = 0, dummy;
619 /* Can't register until after driver model init */
620 if (unlikely(WARN_ON(!i2c_bus_type.p))) {
621 res = -EAGAIN;
622 goto out_list;
625 rt_mutex_init(&adap->bus_lock);
627 /* Set default timeout to 1 second if not already set */
628 if (adap->timeout == 0)
629 adap->timeout = HZ;
631 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
632 adap->dev.bus = &i2c_bus_type;
633 adap->dev.type = &i2c_adapter_type;
634 res = device_register(&adap->dev);
635 if (res)
636 goto out_list;
638 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
640 #ifdef CONFIG_I2C_COMPAT
641 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
642 adap->dev.parent);
643 if (res)
644 dev_warn(&adap->dev,
645 "Failed to create compatibility class link\n");
646 #endif
648 /* create pre-declared device nodes */
649 if (adap->nr < __i2c_first_dynamic_bus_num)
650 i2c_scan_static_board_info(adap);
652 /* Notify drivers */
653 mutex_lock(&core_lock);
654 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
655 __process_new_adapter);
656 mutex_unlock(&core_lock);
658 return 0;
660 out_list:
661 mutex_lock(&core_lock);
662 idr_remove(&i2c_adapter_idr, adap->nr);
663 mutex_unlock(&core_lock);
664 return res;
668 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
669 * @adapter: the adapter to add
670 * Context: can sleep
672 * This routine is used to declare an I2C adapter when its bus number
673 * doesn't matter. Examples: for I2C adapters dynamically added by
674 * USB links or PCI plugin cards.
676 * When this returns zero, a new bus number was allocated and stored
677 * in adap->nr, and the specified adapter became available for clients.
678 * Otherwise, a negative errno value is returned.
680 int i2c_add_adapter(struct i2c_adapter *adapter)
682 int id, res = 0;
684 retry:
685 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
686 return -ENOMEM;
688 mutex_lock(&core_lock);
689 /* "above" here means "above or equal to", sigh */
690 res = idr_get_new_above(&i2c_adapter_idr, adapter,
691 __i2c_first_dynamic_bus_num, &id);
692 mutex_unlock(&core_lock);
694 if (res < 0) {
695 if (res == -EAGAIN)
696 goto retry;
697 return res;
700 adapter->nr = id;
701 return i2c_register_adapter(adapter);
703 EXPORT_SYMBOL(i2c_add_adapter);
706 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
707 * @adap: the adapter to register (with adap->nr initialized)
708 * Context: can sleep
710 * This routine is used to declare an I2C adapter when its bus number
711 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
712 * or otherwise built in to the system's mainboard, and where i2c_board_info
713 * is used to properly configure I2C devices.
715 * If no devices have pre-been declared for this bus, then be sure to
716 * register the adapter before any dynamically allocated ones. Otherwise
717 * the required bus ID may not be available.
719 * When this returns zero, the specified adapter became available for
720 * clients using the bus number provided in adap->nr. Also, the table
721 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
722 * and the appropriate driver model device nodes are created. Otherwise, a
723 * negative errno value is returned.
725 int i2c_add_numbered_adapter(struct i2c_adapter *adap)
727 int id;
728 int status;
730 if (adap->nr & ~MAX_ID_MASK)
731 return -EINVAL;
733 retry:
734 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
735 return -ENOMEM;
737 mutex_lock(&core_lock);
738 /* "above" here means "above or equal to", sigh;
739 * we need the "equal to" result to force the result
741 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
742 if (status == 0 && id != adap->nr) {
743 status = -EBUSY;
744 idr_remove(&i2c_adapter_idr, id);
746 mutex_unlock(&core_lock);
747 if (status == -EAGAIN)
748 goto retry;
750 if (status == 0)
751 status = i2c_register_adapter(adap);
752 return status;
754 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
756 static int i2c_do_del_adapter(struct i2c_driver *driver,
757 struct i2c_adapter *adapter)
759 struct i2c_client *client, *_n;
760 int res;
762 /* Remove the devices we created ourselves as the result of hardware
763 * probing (using a driver's detect method) */
764 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
765 if (client->adapter == adapter) {
766 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
767 client->name, client->addr);
768 list_del(&client->detected);
769 i2c_unregister_device(client);
773 if (!driver->detach_adapter)
774 return 0;
775 res = driver->detach_adapter(adapter);
776 if (res)
777 dev_err(&adapter->dev, "detach_adapter failed (%d) "
778 "for driver [%s]\n", res, driver->driver.name);
779 return res;
782 static int __unregister_client(struct device *dev, void *dummy)
784 struct i2c_client *client = i2c_verify_client(dev);
785 if (client)
786 i2c_unregister_device(client);
787 return 0;
790 static int __process_removed_adapter(struct device_driver *d, void *data)
792 return i2c_do_del_adapter(to_i2c_driver(d), data);
796 * i2c_del_adapter - unregister I2C adapter
797 * @adap: the adapter being unregistered
798 * Context: can sleep
800 * This unregisters an I2C adapter which was previously registered
801 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
803 int i2c_del_adapter(struct i2c_adapter *adap)
805 int res = 0;
806 struct i2c_adapter *found;
807 struct i2c_client *client, *next;
809 /* First make sure that this adapter was ever added */
810 mutex_lock(&core_lock);
811 found = idr_find(&i2c_adapter_idr, adap->nr);
812 mutex_unlock(&core_lock);
813 if (found != adap) {
814 pr_debug("i2c-core: attempting to delete unregistered "
815 "adapter [%s]\n", adap->name);
816 return -EINVAL;
819 /* Tell drivers about this removal */
820 mutex_lock(&core_lock);
821 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
822 __process_removed_adapter);
823 mutex_unlock(&core_lock);
824 if (res)
825 return res;
827 /* Remove devices instantiated from sysfs */
828 list_for_each_entry_safe(client, next, &userspace_devices, detected) {
829 if (client->adapter == adap) {
830 dev_dbg(&adap->dev, "Removing %s at 0x%x\n",
831 client->name, client->addr);
832 list_del(&client->detected);
833 i2c_unregister_device(client);
837 /* Detach any active clients. This can't fail, thus we do not
838 checking the returned value. */
839 res = device_for_each_child(&adap->dev, NULL, __unregister_client);
841 #ifdef CONFIG_I2C_COMPAT
842 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
843 adap->dev.parent);
844 #endif
846 /* clean up the sysfs representation */
847 init_completion(&adap->dev_released);
848 device_unregister(&adap->dev);
850 /* wait for sysfs to drop all references */
851 wait_for_completion(&adap->dev_released);
853 /* free bus id */
854 mutex_lock(&core_lock);
855 idr_remove(&i2c_adapter_idr, adap->nr);
856 mutex_unlock(&core_lock);
858 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
860 /* Clear the device structure in case this adapter is ever going to be
861 added again */
862 memset(&adap->dev, 0, sizeof(adap->dev));
864 return 0;
866 EXPORT_SYMBOL(i2c_del_adapter);
869 /* ------------------------------------------------------------------------- */
871 static int __process_new_driver(struct device *dev, void *data)
873 if (dev->type != &i2c_adapter_type)
874 return 0;
875 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
879 * An i2c_driver is used with one or more i2c_client (device) nodes to access
880 * i2c slave chips, on a bus instance associated with some i2c_adapter.
883 int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
885 int res;
887 /* Can't register until after driver model init */
888 if (unlikely(WARN_ON(!i2c_bus_type.p)))
889 return -EAGAIN;
891 /* add the driver to the list of i2c drivers in the driver core */
892 driver->driver.owner = owner;
893 driver->driver.bus = &i2c_bus_type;
895 /* When registration returns, the driver core
896 * will have called probe() for all matching-but-unbound devices.
898 res = driver_register(&driver->driver);
899 if (res)
900 return res;
902 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
904 INIT_LIST_HEAD(&driver->clients);
905 /* Walk the adapters that are already present */
906 mutex_lock(&core_lock);
907 bus_for_each_dev(&i2c_bus_type, NULL, driver, __process_new_driver);
908 mutex_unlock(&core_lock);
910 return 0;
912 EXPORT_SYMBOL(i2c_register_driver);
914 static int __process_removed_driver(struct device *dev, void *data)
916 if (dev->type != &i2c_adapter_type)
917 return 0;
918 return i2c_do_del_adapter(data, to_i2c_adapter(dev));
922 * i2c_del_driver - unregister I2C driver
923 * @driver: the driver being unregistered
924 * Context: can sleep
926 void i2c_del_driver(struct i2c_driver *driver)
928 mutex_lock(&core_lock);
929 bus_for_each_dev(&i2c_bus_type, NULL, driver, __process_removed_driver);
930 mutex_unlock(&core_lock);
932 driver_unregister(&driver->driver);
933 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
935 EXPORT_SYMBOL(i2c_del_driver);
937 /* ------------------------------------------------------------------------- */
939 static int __i2c_check_addr(struct device *dev, void *addrp)
941 struct i2c_client *client = i2c_verify_client(dev);
942 int addr = *(int *)addrp;
944 if (client && client->addr == addr)
945 return -EBUSY;
946 return 0;
949 static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
951 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
955 * i2c_use_client - increments the reference count of the i2c client structure
956 * @client: the client being referenced
958 * Each live reference to a client should be refcounted. The driver model does
959 * that automatically as part of driver binding, so that most drivers don't
960 * need to do this explicitly: they hold a reference until they're unbound
961 * from the device.
963 * A pointer to the client with the incremented reference counter is returned.
965 struct i2c_client *i2c_use_client(struct i2c_client *client)
967 if (client && get_device(&client->dev))
968 return client;
969 return NULL;
971 EXPORT_SYMBOL(i2c_use_client);
974 * i2c_release_client - release a use of the i2c client structure
975 * @client: the client being no longer referenced
977 * Must be called when a user of a client is finished with it.
979 void i2c_release_client(struct i2c_client *client)
981 if (client)
982 put_device(&client->dev);
984 EXPORT_SYMBOL(i2c_release_client);
986 struct i2c_cmd_arg {
987 unsigned cmd;
988 void *arg;
991 static int i2c_cmd(struct device *dev, void *_arg)
993 struct i2c_client *client = i2c_verify_client(dev);
994 struct i2c_cmd_arg *arg = _arg;
996 if (client && client->driver && client->driver->command)
997 client->driver->command(client, arg->cmd, arg->arg);
998 return 0;
1001 void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
1003 struct i2c_cmd_arg cmd_arg;
1005 cmd_arg.cmd = cmd;
1006 cmd_arg.arg = arg;
1007 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
1009 EXPORT_SYMBOL(i2c_clients_command);
1011 static int __init i2c_init(void)
1013 int retval;
1015 retval = bus_register(&i2c_bus_type);
1016 if (retval)
1017 return retval;
1018 #ifdef CONFIG_I2C_COMPAT
1019 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
1020 if (!i2c_adapter_compat_class) {
1021 retval = -ENOMEM;
1022 goto bus_err;
1024 #endif
1025 retval = i2c_add_driver(&dummy_driver);
1026 if (retval)
1027 goto class_err;
1028 return 0;
1030 class_err:
1031 #ifdef CONFIG_I2C_COMPAT
1032 class_compat_unregister(i2c_adapter_compat_class);
1033 bus_err:
1034 #endif
1035 bus_unregister(&i2c_bus_type);
1036 return retval;
1039 static void __exit i2c_exit(void)
1041 i2c_del_driver(&dummy_driver);
1042 #ifdef CONFIG_I2C_COMPAT
1043 class_compat_unregister(i2c_adapter_compat_class);
1044 #endif
1045 bus_unregister(&i2c_bus_type);
1048 /* We must initialize early, because some subsystems register i2c drivers
1049 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1051 postcore_initcall(i2c_init);
1052 module_exit(i2c_exit);
1054 /* ----------------------------------------------------
1055 * the functional interface to the i2c busses.
1056 * ----------------------------------------------------
1060 * i2c_transfer - execute a single or combined I2C message
1061 * @adap: Handle to I2C bus
1062 * @msgs: One or more messages to execute before STOP is issued to
1063 * terminate the operation; each message begins with a START.
1064 * @num: Number of messages to be executed.
1066 * Returns negative errno, else the number of messages executed.
1068 * Note that there is no requirement that each message be sent to
1069 * the same slave address, although that is the most common model.
1071 int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1073 unsigned long orig_jiffies;
1074 int ret, try;
1076 /* REVISIT the fault reporting model here is weak:
1078 * - When we get an error after receiving N bytes from a slave,
1079 * there is no way to report "N".
1081 * - When we get a NAK after transmitting N bytes to a slave,
1082 * there is no way to report "N" ... or to let the master
1083 * continue executing the rest of this combined message, if
1084 * that's the appropriate response.
1086 * - When for example "num" is two and we successfully complete
1087 * the first message but get an error part way through the
1088 * second, it's unclear whether that should be reported as
1089 * one (discarding status on the second message) or errno
1090 * (discarding status on the first one).
1093 if (adap->algo->master_xfer) {
1094 #ifdef DEBUG
1095 for (ret = 0; ret < num; ret++) {
1096 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
1097 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1098 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1099 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
1101 #endif
1103 if (in_atomic() || irqs_disabled()) {
1104 ret = rt_mutex_trylock(&adap->bus_lock);
1105 if (!ret)
1106 /* I2C activity is ongoing. */
1107 return -EAGAIN;
1108 } else {
1109 rt_mutex_lock(&adap->bus_lock);
1112 /* Retry automatically on arbitration loss */
1113 orig_jiffies = jiffies;
1114 for (ret = 0, try = 0; try <= adap->retries; try++) {
1115 ret = adap->algo->master_xfer(adap, msgs, num);
1116 if (ret != -EAGAIN)
1117 break;
1118 if (time_after(jiffies, orig_jiffies + adap->timeout))
1119 break;
1121 rt_mutex_unlock(&adap->bus_lock);
1123 return ret;
1124 } else {
1125 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
1126 return -EOPNOTSUPP;
1129 EXPORT_SYMBOL(i2c_transfer);
1132 * i2c_master_send - issue a single I2C message in master transmit mode
1133 * @client: Handle to slave device
1134 * @buf: Data that will be written to the slave
1135 * @count: How many bytes to write
1137 * Returns negative errno, or else the number of bytes written.
1139 int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1141 int ret;
1142 struct i2c_adapter *adap=client->adapter;
1143 struct i2c_msg msg;
1145 msg.addr = client->addr;
1146 msg.flags = client->flags & I2C_M_TEN;
1147 msg.len = count;
1148 msg.buf = (char *)buf;
1150 ret = i2c_transfer(adap, &msg, 1);
1152 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1153 transmitted, else error code. */
1154 return (ret == 1) ? count : ret;
1156 EXPORT_SYMBOL(i2c_master_send);
1159 * i2c_master_recv - issue a single I2C message in master receive mode
1160 * @client: Handle to slave device
1161 * @buf: Where to store data read from slave
1162 * @count: How many bytes to read
1164 * Returns negative errno, or else the number of bytes read.
1166 int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1168 struct i2c_adapter *adap=client->adapter;
1169 struct i2c_msg msg;
1170 int ret;
1172 msg.addr = client->addr;
1173 msg.flags = client->flags & I2C_M_TEN;
1174 msg.flags |= I2C_M_RD;
1175 msg.len = count;
1176 msg.buf = buf;
1178 ret = i2c_transfer(adap, &msg, 1);
1180 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1181 transmitted, else error code. */
1182 return (ret == 1) ? count : ret;
1184 EXPORT_SYMBOL(i2c_master_recv);
1186 /* ----------------------------------------------------
1187 * the i2c address scanning function
1188 * Will not work for 10-bit addresses!
1189 * ----------------------------------------------------
1192 static int i2c_detect_address(struct i2c_client *temp_client,
1193 struct i2c_driver *driver)
1195 struct i2c_board_info info;
1196 struct i2c_adapter *adapter = temp_client->adapter;
1197 int addr = temp_client->addr;
1198 int err;
1200 /* Make sure the address is valid */
1201 if (addr < 0x03 || addr > 0x77) {
1202 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1203 addr);
1204 return -EINVAL;
1207 /* Skip if already in use */
1208 if (i2c_check_addr(adapter, addr))
1209 return 0;
1211 /* Make sure there is something at this address */
1212 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0, I2C_SMBUS_QUICK, NULL) < 0)
1213 return 0;
1215 /* Prevent 24RF08 corruption */
1216 if ((addr & ~0x0f) == 0x50)
1217 i2c_smbus_xfer(adapter, addr, 0, 0, 0, I2C_SMBUS_QUICK, NULL);
1219 /* Finally call the custom detection function */
1220 memset(&info, 0, sizeof(struct i2c_board_info));
1221 info.addr = addr;
1222 err = driver->detect(temp_client, &info);
1223 if (err) {
1224 /* -ENODEV is returned if the detection fails. We catch it
1225 here as this isn't an error. */
1226 return err == -ENODEV ? 0 : err;
1229 /* Consistency check */
1230 if (info.type[0] == '\0') {
1231 dev_err(&adapter->dev, "%s detection function provided "
1232 "no name for 0x%x\n", driver->driver.name,
1233 addr);
1234 } else {
1235 struct i2c_client *client;
1237 /* Detection succeeded, instantiate the device */
1238 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1239 info.type, info.addr);
1240 client = i2c_new_device(adapter, &info);
1241 if (client)
1242 list_add_tail(&client->detected, &driver->clients);
1243 else
1244 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1245 info.type, info.addr);
1247 return 0;
1250 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1252 const unsigned short *address_list;
1253 struct i2c_client *temp_client;
1254 int i, err = 0;
1255 int adap_id = i2c_adapter_id(adapter);
1257 address_list = driver->address_list;
1258 if (!driver->detect || !address_list)
1259 return 0;
1261 /* Set up a temporary client to help detect callback */
1262 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1263 if (!temp_client)
1264 return -ENOMEM;
1265 temp_client->adapter = adapter;
1267 /* Stop here if the classes do not match */
1268 if (!(adapter->class & driver->class))
1269 goto exit_free;
1271 /* Stop here if we can't use SMBUS_QUICK */
1272 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1273 if (address_list[0] == I2C_CLIENT_END)
1274 goto exit_free;
1276 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1277 "can't probe for chips\n");
1278 err = -EOPNOTSUPP;
1279 goto exit_free;
1282 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
1283 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1284 "addr 0x%02x\n", adap_id, address_list[i]);
1285 temp_client->addr = address_list[i];
1286 err = i2c_detect_address(temp_client, driver);
1287 if (err)
1288 goto exit_free;
1291 exit_free:
1292 kfree(temp_client);
1293 return err;
1296 struct i2c_client *
1297 i2c_new_probed_device(struct i2c_adapter *adap,
1298 struct i2c_board_info *info,
1299 unsigned short const *addr_list)
1301 int i;
1303 /* Stop here if the bus doesn't support probing */
1304 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1305 dev_err(&adap->dev, "Probing not supported\n");
1306 return NULL;
1309 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1310 /* Check address validity */
1311 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1312 dev_warn(&adap->dev, "Invalid 7-bit address "
1313 "0x%02x\n", addr_list[i]);
1314 continue;
1317 /* Check address availability */
1318 if (i2c_check_addr(adap, addr_list[i])) {
1319 dev_dbg(&adap->dev, "Address 0x%02x already in "
1320 "use, not probing\n", addr_list[i]);
1321 continue;
1324 /* Test address responsiveness
1325 The default probe method is a quick write, but it is known
1326 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1327 and could also irreversibly write-protect some EEPROMs, so
1328 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1329 read instead. Also, some bus drivers don't implement
1330 quick write, so we fallback to a byte read it that case
1331 too. */
1332 if ((addr_list[i] & ~0x07) == 0x30
1333 || (addr_list[i] & ~0x0f) == 0x50
1334 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1335 union i2c_smbus_data data;
1337 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1338 I2C_SMBUS_READ, 0,
1339 I2C_SMBUS_BYTE, &data) >= 0)
1340 break;
1341 } else {
1342 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1343 I2C_SMBUS_WRITE, 0,
1344 I2C_SMBUS_QUICK, NULL) >= 0)
1345 break;
1349 if (addr_list[i] == I2C_CLIENT_END) {
1350 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1351 return NULL;
1354 info->addr = addr_list[i];
1355 return i2c_new_device(adap, info);
1357 EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1359 struct i2c_adapter* i2c_get_adapter(int id)
1361 struct i2c_adapter *adapter;
1363 mutex_lock(&core_lock);
1364 adapter = idr_find(&i2c_adapter_idr, id);
1365 if (adapter && !try_module_get(adapter->owner))
1366 adapter = NULL;
1368 mutex_unlock(&core_lock);
1369 return adapter;
1371 EXPORT_SYMBOL(i2c_get_adapter);
1373 void i2c_put_adapter(struct i2c_adapter *adap)
1375 module_put(adap->owner);
1377 EXPORT_SYMBOL(i2c_put_adapter);
1379 /* The SMBus parts */
1381 #define POLY (0x1070U << 3)
1382 static u8 crc8(u16 data)
1384 int i;
1386 for(i = 0; i < 8; i++) {
1387 if (data & 0x8000)
1388 data = data ^ POLY;
1389 data = data << 1;
1391 return (u8)(data >> 8);
1394 /* Incremental CRC8 over count bytes in the array pointed to by p */
1395 static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1397 int i;
1399 for(i = 0; i < count; i++)
1400 crc = crc8((crc ^ p[i]) << 8);
1401 return crc;
1404 /* Assume a 7-bit address, which is reasonable for SMBus */
1405 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1407 /* The address will be sent first */
1408 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1409 pec = i2c_smbus_pec(pec, &addr, 1);
1411 /* The data buffer follows */
1412 return i2c_smbus_pec(pec, msg->buf, msg->len);
1415 /* Used for write only transactions */
1416 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1418 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1419 msg->len++;
1422 /* Return <0 on CRC error
1423 If there was a write before this read (most cases) we need to take the
1424 partial CRC from the write part into account.
1425 Note that this function does modify the message (we need to decrease the
1426 message length to hide the CRC byte from the caller). */
1427 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1429 u8 rpec = msg->buf[--msg->len];
1430 cpec = i2c_smbus_msg_pec(cpec, msg);
1432 if (rpec != cpec) {
1433 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1434 rpec, cpec);
1435 return -EBADMSG;
1437 return 0;
1441 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1442 * @client: Handle to slave device
1444 * This executes the SMBus "receive byte" protocol, returning negative errno
1445 * else the byte received from the device.
1447 s32 i2c_smbus_read_byte(struct i2c_client *client)
1449 union i2c_smbus_data data;
1450 int status;
1452 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1453 I2C_SMBUS_READ, 0,
1454 I2C_SMBUS_BYTE, &data);
1455 return (status < 0) ? status : data.byte;
1457 EXPORT_SYMBOL(i2c_smbus_read_byte);
1460 * i2c_smbus_write_byte - SMBus "send byte" protocol
1461 * @client: Handle to slave device
1462 * @value: Byte to be sent
1464 * This executes the SMBus "send byte" protocol, returning negative errno
1465 * else zero on success.
1467 s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1469 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1470 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1472 EXPORT_SYMBOL(i2c_smbus_write_byte);
1475 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1476 * @client: Handle to slave device
1477 * @command: Byte interpreted by slave
1479 * This executes the SMBus "read byte" protocol, returning negative errno
1480 * else a data byte received from the device.
1482 s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1484 union i2c_smbus_data data;
1485 int status;
1487 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1488 I2C_SMBUS_READ, command,
1489 I2C_SMBUS_BYTE_DATA, &data);
1490 return (status < 0) ? status : data.byte;
1492 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1495 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1496 * @client: Handle to slave device
1497 * @command: Byte interpreted by slave
1498 * @value: Byte being written
1500 * This executes the SMBus "write byte" protocol, returning negative errno
1501 * else zero on success.
1503 s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1505 union i2c_smbus_data data;
1506 data.byte = value;
1507 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1508 I2C_SMBUS_WRITE,command,
1509 I2C_SMBUS_BYTE_DATA,&data);
1511 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1514 * i2c_smbus_read_word_data - SMBus "read word" protocol
1515 * @client: Handle to slave device
1516 * @command: Byte interpreted by slave
1518 * This executes the SMBus "read word" protocol, returning negative errno
1519 * else a 16-bit unsigned "word" received from the device.
1521 s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1523 union i2c_smbus_data data;
1524 int status;
1526 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1527 I2C_SMBUS_READ, command,
1528 I2C_SMBUS_WORD_DATA, &data);
1529 return (status < 0) ? status : data.word;
1531 EXPORT_SYMBOL(i2c_smbus_read_word_data);
1534 * i2c_smbus_write_word_data - SMBus "write word" 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 "write word" protocol, returning negative errno
1540 * else zero on success.
1542 s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1544 union i2c_smbus_data data;
1545 data.word = value;
1546 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1547 I2C_SMBUS_WRITE,command,
1548 I2C_SMBUS_WORD_DATA,&data);
1550 EXPORT_SYMBOL(i2c_smbus_write_word_data);
1553 * i2c_smbus_process_call - SMBus "process call" protocol
1554 * @client: Handle to slave device
1555 * @command: Byte interpreted by slave
1556 * @value: 16-bit "word" being written
1558 * This executes the SMBus "process call" protocol, returning negative errno
1559 * else a 16-bit unsigned "word" received from the device.
1561 s32 i2c_smbus_process_call(struct i2c_client *client, u8 command, u16 value)
1563 union i2c_smbus_data data;
1564 int status;
1565 data.word = value;
1567 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1568 I2C_SMBUS_WRITE, command,
1569 I2C_SMBUS_PROC_CALL, &data);
1570 return (status < 0) ? status : data.word;
1572 EXPORT_SYMBOL(i2c_smbus_process_call);
1575 * i2c_smbus_read_block_data - SMBus "block read" protocol
1576 * @client: Handle to slave device
1577 * @command: Byte interpreted by slave
1578 * @values: Byte array into which data will be read; big enough to hold
1579 * the data returned by the slave. SMBus allows at most 32 bytes.
1581 * This executes the SMBus "block read" protocol, returning negative errno
1582 * else the number of data bytes in the slave's response.
1584 * Note that using this function requires that the client's adapter support
1585 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1586 * support this; its emulation through I2C messaging relies on a specific
1587 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1589 s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1590 u8 *values)
1592 union i2c_smbus_data data;
1593 int status;
1595 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1596 I2C_SMBUS_READ, command,
1597 I2C_SMBUS_BLOCK_DATA, &data);
1598 if (status)
1599 return status;
1601 memcpy(values, &data.block[1], data.block[0]);
1602 return data.block[0];
1604 EXPORT_SYMBOL(i2c_smbus_read_block_data);
1607 * i2c_smbus_write_block_data - SMBus "block write" protocol
1608 * @client: Handle to slave device
1609 * @command: Byte interpreted by slave
1610 * @length: Size of data block; SMBus allows at most 32 bytes
1611 * @values: Byte array which will be written.
1613 * This executes the SMBus "block write" protocol, returning negative errno
1614 * else zero on success.
1616 s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1617 u8 length, const u8 *values)
1619 union i2c_smbus_data data;
1621 if (length > I2C_SMBUS_BLOCK_MAX)
1622 length = I2C_SMBUS_BLOCK_MAX;
1623 data.block[0] = length;
1624 memcpy(&data.block[1], values, length);
1625 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1626 I2C_SMBUS_WRITE,command,
1627 I2C_SMBUS_BLOCK_DATA,&data);
1629 EXPORT_SYMBOL(i2c_smbus_write_block_data);
1631 /* Returns the number of read bytes */
1632 s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1633 u8 length, u8 *values)
1635 union i2c_smbus_data data;
1636 int status;
1638 if (length > I2C_SMBUS_BLOCK_MAX)
1639 length = I2C_SMBUS_BLOCK_MAX;
1640 data.block[0] = length;
1641 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1642 I2C_SMBUS_READ, command,
1643 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1644 if (status < 0)
1645 return status;
1647 memcpy(values, &data.block[1], data.block[0]);
1648 return data.block[0];
1650 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1652 s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1653 u8 length, const u8 *values)
1655 union i2c_smbus_data data;
1657 if (length > I2C_SMBUS_BLOCK_MAX)
1658 length = I2C_SMBUS_BLOCK_MAX;
1659 data.block[0] = length;
1660 memcpy(data.block + 1, values, length);
1661 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1662 I2C_SMBUS_WRITE, command,
1663 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1665 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1667 /* Simulate a SMBus command using the i2c protocol
1668 No checking of parameters is done! */
1669 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
1670 unsigned short flags,
1671 char read_write, u8 command, int size,
1672 union i2c_smbus_data * data)
1674 /* So we need to generate a series of msgs. In the case of writing, we
1675 need to use only one message; when reading, we need two. We initialize
1676 most things with sane defaults, to keep the code below somewhat
1677 simpler. */
1678 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1679 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1680 int num = read_write == I2C_SMBUS_READ?2:1;
1681 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1682 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1684 int i;
1685 u8 partial_pec = 0;
1686 int status;
1688 msgbuf0[0] = command;
1689 switch(size) {
1690 case I2C_SMBUS_QUICK:
1691 msg[0].len = 0;
1692 /* Special case: The read/write field is used as data */
1693 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
1694 I2C_M_RD : 0);
1695 num = 1;
1696 break;
1697 case I2C_SMBUS_BYTE:
1698 if (read_write == I2C_SMBUS_READ) {
1699 /* Special case: only a read! */
1700 msg[0].flags = I2C_M_RD | flags;
1701 num = 1;
1703 break;
1704 case I2C_SMBUS_BYTE_DATA:
1705 if (read_write == I2C_SMBUS_READ)
1706 msg[1].len = 1;
1707 else {
1708 msg[0].len = 2;
1709 msgbuf0[1] = data->byte;
1711 break;
1712 case I2C_SMBUS_WORD_DATA:
1713 if (read_write == I2C_SMBUS_READ)
1714 msg[1].len = 2;
1715 else {
1716 msg[0].len=3;
1717 msgbuf0[1] = data->word & 0xff;
1718 msgbuf0[2] = data->word >> 8;
1720 break;
1721 case I2C_SMBUS_PROC_CALL:
1722 num = 2; /* Special case */
1723 read_write = I2C_SMBUS_READ;
1724 msg[0].len = 3;
1725 msg[1].len = 2;
1726 msgbuf0[1] = data->word & 0xff;
1727 msgbuf0[2] = data->word >> 8;
1728 break;
1729 case I2C_SMBUS_BLOCK_DATA:
1730 if (read_write == I2C_SMBUS_READ) {
1731 msg[1].flags |= I2C_M_RECV_LEN;
1732 msg[1].len = 1; /* block length will be added by
1733 the underlying bus driver */
1734 } else {
1735 msg[0].len = data->block[0] + 2;
1736 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1737 dev_err(&adapter->dev,
1738 "Invalid block write size %d\n",
1739 data->block[0]);
1740 return -EINVAL;
1742 for (i = 1; i < msg[0].len; i++)
1743 msgbuf0[i] = data->block[i-1];
1745 break;
1746 case I2C_SMBUS_BLOCK_PROC_CALL:
1747 num = 2; /* Another special case */
1748 read_write = I2C_SMBUS_READ;
1749 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1750 dev_err(&adapter->dev,
1751 "Invalid block write size %d\n",
1752 data->block[0]);
1753 return -EINVAL;
1755 msg[0].len = data->block[0] + 2;
1756 for (i = 1; i < msg[0].len; i++)
1757 msgbuf0[i] = data->block[i-1];
1758 msg[1].flags |= I2C_M_RECV_LEN;
1759 msg[1].len = 1; /* block length will be added by
1760 the underlying bus driver */
1761 break;
1762 case I2C_SMBUS_I2C_BLOCK_DATA:
1763 if (read_write == I2C_SMBUS_READ) {
1764 msg[1].len = data->block[0];
1765 } else {
1766 msg[0].len = data->block[0] + 1;
1767 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
1768 dev_err(&adapter->dev,
1769 "Invalid block write size %d\n",
1770 data->block[0]);
1771 return -EINVAL;
1773 for (i = 1; i <= data->block[0]; i++)
1774 msgbuf0[i] = data->block[i];
1776 break;
1777 default:
1778 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1779 return -EOPNOTSUPP;
1782 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1783 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1784 if (i) {
1785 /* Compute PEC if first message is a write */
1786 if (!(msg[0].flags & I2C_M_RD)) {
1787 if (num == 1) /* Write only */
1788 i2c_smbus_add_pec(&msg[0]);
1789 else /* Write followed by read */
1790 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1792 /* Ask for PEC if last message is a read */
1793 if (msg[num-1].flags & I2C_M_RD)
1794 msg[num-1].len++;
1797 status = i2c_transfer(adapter, msg, num);
1798 if (status < 0)
1799 return status;
1801 /* Check PEC if last message is a read */
1802 if (i && (msg[num-1].flags & I2C_M_RD)) {
1803 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1804 if (status < 0)
1805 return status;
1808 if (read_write == I2C_SMBUS_READ)
1809 switch(size) {
1810 case I2C_SMBUS_BYTE:
1811 data->byte = msgbuf0[0];
1812 break;
1813 case I2C_SMBUS_BYTE_DATA:
1814 data->byte = msgbuf1[0];
1815 break;
1816 case I2C_SMBUS_WORD_DATA:
1817 case I2C_SMBUS_PROC_CALL:
1818 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1819 break;
1820 case I2C_SMBUS_I2C_BLOCK_DATA:
1821 for (i = 0; i < data->block[0]; i++)
1822 data->block[i+1] = msgbuf1[i];
1823 break;
1824 case I2C_SMBUS_BLOCK_DATA:
1825 case I2C_SMBUS_BLOCK_PROC_CALL:
1826 for (i = 0; i < msgbuf1[0] + 1; i++)
1827 data->block[i] = msgbuf1[i];
1828 break;
1830 return 0;
1834 * i2c_smbus_xfer - execute SMBus protocol operations
1835 * @adapter: Handle to I2C bus
1836 * @addr: Address of SMBus slave on that bus
1837 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1838 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1839 * @command: Byte interpreted by slave, for protocols which use such bytes
1840 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1841 * @data: Data to be read or written
1843 * This executes an SMBus protocol operation, and returns a negative
1844 * errno code else zero on success.
1846 s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
1847 char read_write, u8 command, int protocol,
1848 union i2c_smbus_data *data)
1850 unsigned long orig_jiffies;
1851 int try;
1852 s32 res;
1854 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
1856 if (adapter->algo->smbus_xfer) {
1857 rt_mutex_lock(&adapter->bus_lock);
1859 /* Retry automatically on arbitration loss */
1860 orig_jiffies = jiffies;
1861 for (res = 0, try = 0; try <= adapter->retries; try++) {
1862 res = adapter->algo->smbus_xfer(adapter, addr, flags,
1863 read_write, command,
1864 protocol, data);
1865 if (res != -EAGAIN)
1866 break;
1867 if (time_after(jiffies,
1868 orig_jiffies + adapter->timeout))
1869 break;
1871 rt_mutex_unlock(&adapter->bus_lock);
1872 } else
1873 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
1874 command, protocol, data);
1876 return res;
1878 EXPORT_SYMBOL(i2c_smbus_xfer);
1880 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1881 MODULE_DESCRIPTION("I2C-Bus main module");
1882 MODULE_LICENSE("GPL");