ixgbe: DCB, set minimum bandwidth per traffic class
[linux-2.6/libata-dev.git] / drivers / i2c / i2c-core.c
blobf0bd5bcdf56329294b5cab85a0fe41ce06600dd6
1 /* i2c-core.c - a device driver for the iic-bus interface */
2 /* ------------------------------------------------------------------------- */
3 /* Copyright (C) 1995-99 Simon G. Vogl
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
18 /* ------------------------------------------------------------------------- */
20 /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
21 All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
22 SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
23 Jean Delvare <khali@linux-fr.org>
24 Mux support by Rodolfo Giometti <giometti@enneenne.com> and
25 Michael Lawnick <michael.lawnick.ext@nsn.com> */
27 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/errno.h>
30 #include <linux/slab.h>
31 #include <linux/i2c.h>
32 #include <linux/init.h>
33 #include <linux/idr.h>
34 #include <linux/mutex.h>
35 #include <linux/of_device.h>
36 #include <linux/completion.h>
37 #include <linux/hardirq.h>
38 #include <linux/irqflags.h>
39 #include <linux/rwsem.h>
40 #include <linux/pm_runtime.h>
41 #include <asm/uaccess.h>
43 #include "i2c-core.h"
46 /* core_lock protects i2c_adapter_idr, and guarantees
47 that device detection, deletion of detected devices, and attach_adapter
48 and detach_adapter calls are serialized */
49 static DEFINE_MUTEX(core_lock);
50 static DEFINE_IDR(i2c_adapter_idr);
52 static struct device_type i2c_client_type;
53 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
55 /* ------------------------------------------------------------------------- */
57 static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
58 const struct i2c_client *client)
60 while (id->name[0]) {
61 if (strcmp(client->name, id->name) == 0)
62 return id;
63 id++;
65 return NULL;
68 static int i2c_device_match(struct device *dev, struct device_driver *drv)
70 struct i2c_client *client = i2c_verify_client(dev);
71 struct i2c_driver *driver;
73 if (!client)
74 return 0;
76 /* Attempt an OF style match */
77 if (of_driver_match_device(dev, drv))
78 return 1;
80 driver = to_i2c_driver(drv);
81 /* match on an id table if there is one */
82 if (driver->id_table)
83 return i2c_match_id(driver->id_table, client) != NULL;
85 return 0;
88 #ifdef CONFIG_HOTPLUG
90 /* uevent helps with hotplug: modprobe -q $(MODALIAS) */
91 static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
93 struct i2c_client *client = to_i2c_client(dev);
95 if (add_uevent_var(env, "MODALIAS=%s%s",
96 I2C_MODULE_PREFIX, client->name))
97 return -ENOMEM;
98 dev_dbg(dev, "uevent\n");
99 return 0;
102 #else
103 #define i2c_device_uevent NULL
104 #endif /* CONFIG_HOTPLUG */
106 static int i2c_device_probe(struct device *dev)
108 struct i2c_client *client = i2c_verify_client(dev);
109 struct i2c_driver *driver;
110 int status;
112 if (!client)
113 return 0;
115 driver = to_i2c_driver(dev->driver);
116 if (!driver->probe || !driver->id_table)
117 return -ENODEV;
118 client->driver = driver;
119 if (!device_can_wakeup(&client->dev))
120 device_init_wakeup(&client->dev,
121 client->flags & I2C_CLIENT_WAKE);
122 dev_dbg(dev, "probe\n");
124 status = driver->probe(client, i2c_match_id(driver->id_table, client));
125 if (status) {
126 client->driver = NULL;
127 i2c_set_clientdata(client, NULL);
129 return status;
132 static int i2c_device_remove(struct device *dev)
134 struct i2c_client *client = i2c_verify_client(dev);
135 struct i2c_driver *driver;
136 int status;
138 if (!client || !dev->driver)
139 return 0;
141 driver = to_i2c_driver(dev->driver);
142 if (driver->remove) {
143 dev_dbg(dev, "remove\n");
144 status = driver->remove(client);
145 } else {
146 dev->driver = NULL;
147 status = 0;
149 if (status == 0) {
150 client->driver = NULL;
151 i2c_set_clientdata(client, NULL);
153 return status;
156 static void i2c_device_shutdown(struct device *dev)
158 struct i2c_client *client = i2c_verify_client(dev);
159 struct i2c_driver *driver;
161 if (!client || !dev->driver)
162 return;
163 driver = to_i2c_driver(dev->driver);
164 if (driver->shutdown)
165 driver->shutdown(client);
168 #ifdef CONFIG_PM_SLEEP
169 static int i2c_legacy_suspend(struct device *dev, pm_message_t mesg)
171 struct i2c_client *client = i2c_verify_client(dev);
172 struct i2c_driver *driver;
174 if (!client || !dev->driver)
175 return 0;
176 driver = to_i2c_driver(dev->driver);
177 if (!driver->suspend)
178 return 0;
179 return driver->suspend(client, mesg);
182 static int i2c_legacy_resume(struct device *dev)
184 struct i2c_client *client = i2c_verify_client(dev);
185 struct i2c_driver *driver;
187 if (!client || !dev->driver)
188 return 0;
189 driver = to_i2c_driver(dev->driver);
190 if (!driver->resume)
191 return 0;
192 return driver->resume(client);
195 static int i2c_device_pm_suspend(struct device *dev)
197 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
199 if (pm)
200 return pm_generic_suspend(dev);
201 else
202 return i2c_legacy_suspend(dev, PMSG_SUSPEND);
205 static int i2c_device_pm_resume(struct device *dev)
207 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
209 if (pm)
210 return pm_generic_resume(dev);
211 else
212 return i2c_legacy_resume(dev);
215 static int i2c_device_pm_freeze(struct device *dev)
217 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
219 if (pm)
220 return pm_generic_freeze(dev);
221 else
222 return i2c_legacy_suspend(dev, PMSG_FREEZE);
225 static int i2c_device_pm_thaw(struct device *dev)
227 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
229 if (pm)
230 return pm_generic_thaw(dev);
231 else
232 return i2c_legacy_resume(dev);
235 static int i2c_device_pm_poweroff(struct device *dev)
237 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
239 if (pm)
240 return pm_generic_poweroff(dev);
241 else
242 return i2c_legacy_suspend(dev, PMSG_HIBERNATE);
245 static int i2c_device_pm_restore(struct device *dev)
247 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
249 if (pm)
250 return pm_generic_restore(dev);
251 else
252 return i2c_legacy_resume(dev);
254 #else /* !CONFIG_PM_SLEEP */
255 #define i2c_device_pm_suspend NULL
256 #define i2c_device_pm_resume NULL
257 #define i2c_device_pm_freeze NULL
258 #define i2c_device_pm_thaw NULL
259 #define i2c_device_pm_poweroff NULL
260 #define i2c_device_pm_restore NULL
261 #endif /* !CONFIG_PM_SLEEP */
263 static void i2c_client_dev_release(struct device *dev)
265 kfree(to_i2c_client(dev));
268 static ssize_t
269 show_name(struct device *dev, struct device_attribute *attr, char *buf)
271 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
272 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
275 static ssize_t
276 show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
278 struct i2c_client *client = to_i2c_client(dev);
279 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
282 static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
283 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
285 static struct attribute *i2c_dev_attrs[] = {
286 &dev_attr_name.attr,
287 /* modalias helps coldplug: modprobe $(cat .../modalias) */
288 &dev_attr_modalias.attr,
289 NULL
292 static struct attribute_group i2c_dev_attr_group = {
293 .attrs = i2c_dev_attrs,
296 static const struct attribute_group *i2c_dev_attr_groups[] = {
297 &i2c_dev_attr_group,
298 NULL
301 static const struct dev_pm_ops i2c_device_pm_ops = {
302 .suspend = i2c_device_pm_suspend,
303 .resume = i2c_device_pm_resume,
304 .freeze = i2c_device_pm_freeze,
305 .thaw = i2c_device_pm_thaw,
306 .poweroff = i2c_device_pm_poweroff,
307 .restore = i2c_device_pm_restore,
308 SET_RUNTIME_PM_OPS(
309 pm_generic_runtime_suspend,
310 pm_generic_runtime_resume,
311 pm_generic_runtime_idle
315 struct bus_type i2c_bus_type = {
316 .name = "i2c",
317 .match = i2c_device_match,
318 .probe = i2c_device_probe,
319 .remove = i2c_device_remove,
320 .shutdown = i2c_device_shutdown,
321 .pm = &i2c_device_pm_ops,
323 EXPORT_SYMBOL_GPL(i2c_bus_type);
325 static struct device_type i2c_client_type = {
326 .groups = i2c_dev_attr_groups,
327 .uevent = i2c_device_uevent,
328 .release = i2c_client_dev_release,
333 * i2c_verify_client - return parameter as i2c_client, or NULL
334 * @dev: device, probably from some driver model iterator
336 * When traversing the driver model tree, perhaps using driver model
337 * iterators like @device_for_each_child(), you can't assume very much
338 * about the nodes you find. Use this function to avoid oopses caused
339 * by wrongly treating some non-I2C device as an i2c_client.
341 struct i2c_client *i2c_verify_client(struct device *dev)
343 return (dev->type == &i2c_client_type)
344 ? to_i2c_client(dev)
345 : NULL;
347 EXPORT_SYMBOL(i2c_verify_client);
350 /* This is a permissive address validity check, I2C address map constraints
351 * are purposedly not enforced, except for the general call address. */
352 static int i2c_check_client_addr_validity(const struct i2c_client *client)
354 if (client->flags & I2C_CLIENT_TEN) {
355 /* 10-bit address, all values are valid */
356 if (client->addr > 0x3ff)
357 return -EINVAL;
358 } else {
359 /* 7-bit address, reject the general call address */
360 if (client->addr == 0x00 || client->addr > 0x7f)
361 return -EINVAL;
363 return 0;
366 /* And this is a strict address validity check, used when probing. If a
367 * device uses a reserved address, then it shouldn't be probed. 7-bit
368 * addressing is assumed, 10-bit address devices are rare and should be
369 * explicitly enumerated. */
370 static int i2c_check_addr_validity(unsigned short addr)
373 * Reserved addresses per I2C specification:
374 * 0x00 General call address / START byte
375 * 0x01 CBUS address
376 * 0x02 Reserved for different bus format
377 * 0x03 Reserved for future purposes
378 * 0x04-0x07 Hs-mode master code
379 * 0x78-0x7b 10-bit slave addressing
380 * 0x7c-0x7f Reserved for future purposes
382 if (addr < 0x08 || addr > 0x77)
383 return -EINVAL;
384 return 0;
387 static int __i2c_check_addr_busy(struct device *dev, void *addrp)
389 struct i2c_client *client = i2c_verify_client(dev);
390 int addr = *(int *)addrp;
392 if (client && client->addr == addr)
393 return -EBUSY;
394 return 0;
397 /* walk up mux tree */
398 static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
400 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
401 int result;
403 result = device_for_each_child(&adapter->dev, &addr,
404 __i2c_check_addr_busy);
406 if (!result && parent)
407 result = i2c_check_mux_parents(parent, addr);
409 return result;
412 /* recurse down mux tree */
413 static int i2c_check_mux_children(struct device *dev, void *addrp)
415 int result;
417 if (dev->type == &i2c_adapter_type)
418 result = device_for_each_child(dev, addrp,
419 i2c_check_mux_children);
420 else
421 result = __i2c_check_addr_busy(dev, addrp);
423 return result;
426 static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
428 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
429 int result = 0;
431 if (parent)
432 result = i2c_check_mux_parents(parent, addr);
434 if (!result)
435 result = device_for_each_child(&adapter->dev, &addr,
436 i2c_check_mux_children);
438 return result;
442 * i2c_lock_adapter - Get exclusive access to an I2C bus segment
443 * @adapter: Target I2C bus segment
445 void i2c_lock_adapter(struct i2c_adapter *adapter)
447 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
449 if (parent)
450 i2c_lock_adapter(parent);
451 else
452 rt_mutex_lock(&adapter->bus_lock);
454 EXPORT_SYMBOL_GPL(i2c_lock_adapter);
457 * i2c_trylock_adapter - Try to get exclusive access to an I2C bus segment
458 * @adapter: Target I2C bus segment
460 static int i2c_trylock_adapter(struct i2c_adapter *adapter)
462 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
464 if (parent)
465 return i2c_trylock_adapter(parent);
466 else
467 return rt_mutex_trylock(&adapter->bus_lock);
471 * i2c_unlock_adapter - Release exclusive access to an I2C bus segment
472 * @adapter: Target I2C bus segment
474 void i2c_unlock_adapter(struct i2c_adapter *adapter)
476 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
478 if (parent)
479 i2c_unlock_adapter(parent);
480 else
481 rt_mutex_unlock(&adapter->bus_lock);
483 EXPORT_SYMBOL_GPL(i2c_unlock_adapter);
486 * i2c_new_device - instantiate an i2c device
487 * @adap: the adapter managing the device
488 * @info: describes one I2C device; bus_num is ignored
489 * Context: can sleep
491 * Create an i2c device. Binding is handled through driver model
492 * probe()/remove() methods. A driver may be bound to this device when we
493 * return from this function, or any later moment (e.g. maybe hotplugging will
494 * load the driver module). This call is not appropriate for use by mainboard
495 * initialization logic, which usually runs during an arch_initcall() long
496 * before any i2c_adapter could exist.
498 * This returns the new i2c client, which may be saved for later use with
499 * i2c_unregister_device(); or NULL to indicate an error.
501 struct i2c_client *
502 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
504 struct i2c_client *client;
505 int status;
507 client = kzalloc(sizeof *client, GFP_KERNEL);
508 if (!client)
509 return NULL;
511 client->adapter = adap;
513 client->dev.platform_data = info->platform_data;
515 if (info->archdata)
516 client->dev.archdata = *info->archdata;
518 client->flags = info->flags;
519 client->addr = info->addr;
520 client->irq = info->irq;
522 strlcpy(client->name, info->type, sizeof(client->name));
524 /* Check for address validity */
525 status = i2c_check_client_addr_validity(client);
526 if (status) {
527 dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
528 client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
529 goto out_err_silent;
532 /* Check for address business */
533 status = i2c_check_addr_busy(adap, client->addr);
534 if (status)
535 goto out_err;
537 client->dev.parent = &client->adapter->dev;
538 client->dev.bus = &i2c_bus_type;
539 client->dev.type = &i2c_client_type;
540 #ifdef CONFIG_OF
541 client->dev.of_node = info->of_node;
542 #endif
544 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
545 client->addr);
546 status = device_register(&client->dev);
547 if (status)
548 goto out_err;
550 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
551 client->name, dev_name(&client->dev));
553 return client;
555 out_err:
556 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
557 "(%d)\n", client->name, client->addr, status);
558 out_err_silent:
559 kfree(client);
560 return NULL;
562 EXPORT_SYMBOL_GPL(i2c_new_device);
566 * i2c_unregister_device - reverse effect of i2c_new_device()
567 * @client: value returned from i2c_new_device()
568 * Context: can sleep
570 void i2c_unregister_device(struct i2c_client *client)
572 device_unregister(&client->dev);
574 EXPORT_SYMBOL_GPL(i2c_unregister_device);
577 static const struct i2c_device_id dummy_id[] = {
578 { "dummy", 0 },
579 { },
582 static int dummy_probe(struct i2c_client *client,
583 const struct i2c_device_id *id)
585 return 0;
588 static int dummy_remove(struct i2c_client *client)
590 return 0;
593 static struct i2c_driver dummy_driver = {
594 .driver.name = "dummy",
595 .probe = dummy_probe,
596 .remove = dummy_remove,
597 .id_table = dummy_id,
601 * i2c_new_dummy - return a new i2c device bound to a dummy driver
602 * @adapter: the adapter managing the device
603 * @address: seven bit address to be used
604 * Context: can sleep
606 * This returns an I2C client bound to the "dummy" driver, intended for use
607 * with devices that consume multiple addresses. Examples of such chips
608 * include various EEPROMS (like 24c04 and 24c08 models).
610 * These dummy devices have two main uses. First, most I2C and SMBus calls
611 * except i2c_transfer() need a client handle; the dummy will be that handle.
612 * And second, this prevents the specified address from being bound to a
613 * different driver.
615 * This returns the new i2c client, which should be saved for later use with
616 * i2c_unregister_device(); or NULL to indicate an error.
618 struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
620 struct i2c_board_info info = {
621 I2C_BOARD_INFO("dummy", address),
624 return i2c_new_device(adapter, &info);
626 EXPORT_SYMBOL_GPL(i2c_new_dummy);
628 /* ------------------------------------------------------------------------- */
630 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
632 static void i2c_adapter_dev_release(struct device *dev)
634 struct i2c_adapter *adap = to_i2c_adapter(dev);
635 complete(&adap->dev_released);
639 * Let users instantiate I2C devices through sysfs. This can be used when
640 * platform initialization code doesn't contain the proper data for
641 * whatever reason. Also useful for drivers that do device detection and
642 * detection fails, either because the device uses an unexpected address,
643 * or this is a compatible device with different ID register values.
645 * Parameter checking may look overzealous, but we really don't want
646 * the user to provide incorrect parameters.
648 static ssize_t
649 i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
650 const char *buf, size_t count)
652 struct i2c_adapter *adap = to_i2c_adapter(dev);
653 struct i2c_board_info info;
654 struct i2c_client *client;
655 char *blank, end;
656 int res;
658 memset(&info, 0, sizeof(struct i2c_board_info));
660 blank = strchr(buf, ' ');
661 if (!blank) {
662 dev_err(dev, "%s: Missing parameters\n", "new_device");
663 return -EINVAL;
665 if (blank - buf > I2C_NAME_SIZE - 1) {
666 dev_err(dev, "%s: Invalid device name\n", "new_device");
667 return -EINVAL;
669 memcpy(info.type, buf, blank - buf);
671 /* Parse remaining parameters, reject extra parameters */
672 res = sscanf(++blank, "%hi%c", &info.addr, &end);
673 if (res < 1) {
674 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
675 return -EINVAL;
677 if (res > 1 && end != '\n') {
678 dev_err(dev, "%s: Extra parameters\n", "new_device");
679 return -EINVAL;
682 client = i2c_new_device(adap, &info);
683 if (!client)
684 return -EINVAL;
686 /* Keep track of the added device */
687 mutex_lock(&adap->userspace_clients_lock);
688 list_add_tail(&client->detected, &adap->userspace_clients);
689 mutex_unlock(&adap->userspace_clients_lock);
690 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
691 info.type, info.addr);
693 return count;
697 * And of course let the users delete the devices they instantiated, if
698 * they got it wrong. This interface can only be used to delete devices
699 * instantiated by i2c_sysfs_new_device above. This guarantees that we
700 * don't delete devices to which some kernel code still has references.
702 * Parameter checking may look overzealous, but we really don't want
703 * the user to delete the wrong device.
705 static ssize_t
706 i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
707 const char *buf, size_t count)
709 struct i2c_adapter *adap = to_i2c_adapter(dev);
710 struct i2c_client *client, *next;
711 unsigned short addr;
712 char end;
713 int res;
715 /* Parse parameters, reject extra parameters */
716 res = sscanf(buf, "%hi%c", &addr, &end);
717 if (res < 1) {
718 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
719 return -EINVAL;
721 if (res > 1 && end != '\n') {
722 dev_err(dev, "%s: Extra parameters\n", "delete_device");
723 return -EINVAL;
726 /* Make sure the device was added through sysfs */
727 res = -ENOENT;
728 mutex_lock(&adap->userspace_clients_lock);
729 list_for_each_entry_safe(client, next, &adap->userspace_clients,
730 detected) {
731 if (client->addr == addr) {
732 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
733 "delete_device", client->name, client->addr);
735 list_del(&client->detected);
736 i2c_unregister_device(client);
737 res = count;
738 break;
741 mutex_unlock(&adap->userspace_clients_lock);
743 if (res < 0)
744 dev_err(dev, "%s: Can't find device in list\n",
745 "delete_device");
746 return res;
749 static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
750 static DEVICE_ATTR(delete_device, S_IWUSR, NULL, i2c_sysfs_delete_device);
752 static struct attribute *i2c_adapter_attrs[] = {
753 &dev_attr_name.attr,
754 &dev_attr_new_device.attr,
755 &dev_attr_delete_device.attr,
756 NULL
759 static struct attribute_group i2c_adapter_attr_group = {
760 .attrs = i2c_adapter_attrs,
763 static const struct attribute_group *i2c_adapter_attr_groups[] = {
764 &i2c_adapter_attr_group,
765 NULL
768 struct device_type i2c_adapter_type = {
769 .groups = i2c_adapter_attr_groups,
770 .release = i2c_adapter_dev_release,
772 EXPORT_SYMBOL_GPL(i2c_adapter_type);
774 #ifdef CONFIG_I2C_COMPAT
775 static struct class_compat *i2c_adapter_compat_class;
776 #endif
778 static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
780 struct i2c_devinfo *devinfo;
782 down_read(&__i2c_board_lock);
783 list_for_each_entry(devinfo, &__i2c_board_list, list) {
784 if (devinfo->busnum == adapter->nr
785 && !i2c_new_device(adapter,
786 &devinfo->board_info))
787 dev_err(&adapter->dev,
788 "Can't create device at 0x%02x\n",
789 devinfo->board_info.addr);
791 up_read(&__i2c_board_lock);
794 static int i2c_do_add_adapter(struct i2c_driver *driver,
795 struct i2c_adapter *adap)
797 /* Detect supported devices on that bus, and instantiate them */
798 i2c_detect(adap, driver);
800 /* Let legacy drivers scan this bus for matching devices */
801 if (driver->attach_adapter) {
802 /* We ignore the return code; if it fails, too bad */
803 driver->attach_adapter(adap);
805 return 0;
808 static int __process_new_adapter(struct device_driver *d, void *data)
810 return i2c_do_add_adapter(to_i2c_driver(d), data);
813 static int i2c_register_adapter(struct i2c_adapter *adap)
815 int res = 0;
817 /* Can't register until after driver model init */
818 if (unlikely(WARN_ON(!i2c_bus_type.p))) {
819 res = -EAGAIN;
820 goto out_list;
823 /* Sanity checks */
824 if (unlikely(adap->name[0] == '\0')) {
825 pr_err("i2c-core: Attempt to register an adapter with "
826 "no name!\n");
827 return -EINVAL;
829 if (unlikely(!adap->algo)) {
830 pr_err("i2c-core: Attempt to register adapter '%s' with "
831 "no algo!\n", adap->name);
832 return -EINVAL;
835 rt_mutex_init(&adap->bus_lock);
836 mutex_init(&adap->userspace_clients_lock);
837 INIT_LIST_HEAD(&adap->userspace_clients);
839 /* Set default timeout to 1 second if not already set */
840 if (adap->timeout == 0)
841 adap->timeout = HZ;
843 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
844 adap->dev.bus = &i2c_bus_type;
845 adap->dev.type = &i2c_adapter_type;
846 res = device_register(&adap->dev);
847 if (res)
848 goto out_list;
850 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
852 #ifdef CONFIG_I2C_COMPAT
853 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
854 adap->dev.parent);
855 if (res)
856 dev_warn(&adap->dev,
857 "Failed to create compatibility class link\n");
858 #endif
860 /* create pre-declared device nodes */
861 if (adap->nr < __i2c_first_dynamic_bus_num)
862 i2c_scan_static_board_info(adap);
864 /* Notify drivers */
865 mutex_lock(&core_lock);
866 bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
867 mutex_unlock(&core_lock);
869 return 0;
871 out_list:
872 mutex_lock(&core_lock);
873 idr_remove(&i2c_adapter_idr, adap->nr);
874 mutex_unlock(&core_lock);
875 return res;
879 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
880 * @adapter: the adapter to add
881 * Context: can sleep
883 * This routine is used to declare an I2C adapter when its bus number
884 * doesn't matter. Examples: for I2C adapters dynamically added by
885 * USB links or PCI plugin cards.
887 * When this returns zero, a new bus number was allocated and stored
888 * in adap->nr, and the specified adapter became available for clients.
889 * Otherwise, a negative errno value is returned.
891 int i2c_add_adapter(struct i2c_adapter *adapter)
893 int id, res = 0;
895 retry:
896 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
897 return -ENOMEM;
899 mutex_lock(&core_lock);
900 /* "above" here means "above or equal to", sigh */
901 res = idr_get_new_above(&i2c_adapter_idr, adapter,
902 __i2c_first_dynamic_bus_num, &id);
903 mutex_unlock(&core_lock);
905 if (res < 0) {
906 if (res == -EAGAIN)
907 goto retry;
908 return res;
911 adapter->nr = id;
912 return i2c_register_adapter(adapter);
914 EXPORT_SYMBOL(i2c_add_adapter);
917 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
918 * @adap: the adapter to register (with adap->nr initialized)
919 * Context: can sleep
921 * This routine is used to declare an I2C adapter when its bus number
922 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
923 * or otherwise built in to the system's mainboard, and where i2c_board_info
924 * is used to properly configure I2C devices.
926 * If no devices have pre-been declared for this bus, then be sure to
927 * register the adapter before any dynamically allocated ones. Otherwise
928 * the required bus ID may not be available.
930 * When this returns zero, the specified adapter became available for
931 * clients using the bus number provided in adap->nr. Also, the table
932 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
933 * and the appropriate driver model device nodes are created. Otherwise, a
934 * negative errno value is returned.
936 int i2c_add_numbered_adapter(struct i2c_adapter *adap)
938 int id;
939 int status;
941 if (adap->nr & ~MAX_ID_MASK)
942 return -EINVAL;
944 retry:
945 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
946 return -ENOMEM;
948 mutex_lock(&core_lock);
949 /* "above" here means "above or equal to", sigh;
950 * we need the "equal to" result to force the result
952 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
953 if (status == 0 && id != adap->nr) {
954 status = -EBUSY;
955 idr_remove(&i2c_adapter_idr, id);
957 mutex_unlock(&core_lock);
958 if (status == -EAGAIN)
959 goto retry;
961 if (status == 0)
962 status = i2c_register_adapter(adap);
963 return status;
965 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
967 static int i2c_do_del_adapter(struct i2c_driver *driver,
968 struct i2c_adapter *adapter)
970 struct i2c_client *client, *_n;
971 int res;
973 /* Remove the devices we created ourselves as the result of hardware
974 * probing (using a driver's detect method) */
975 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
976 if (client->adapter == adapter) {
977 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
978 client->name, client->addr);
979 list_del(&client->detected);
980 i2c_unregister_device(client);
984 if (!driver->detach_adapter)
985 return 0;
986 res = driver->detach_adapter(adapter);
987 if (res)
988 dev_err(&adapter->dev, "detach_adapter failed (%d) "
989 "for driver [%s]\n", res, driver->driver.name);
990 return res;
993 static int __unregister_client(struct device *dev, void *dummy)
995 struct i2c_client *client = i2c_verify_client(dev);
996 if (client && strcmp(client->name, "dummy"))
997 i2c_unregister_device(client);
998 return 0;
1001 static int __unregister_dummy(struct device *dev, void *dummy)
1003 struct i2c_client *client = i2c_verify_client(dev);
1004 if (client)
1005 i2c_unregister_device(client);
1006 return 0;
1009 static int __process_removed_adapter(struct device_driver *d, void *data)
1011 return i2c_do_del_adapter(to_i2c_driver(d), data);
1015 * i2c_del_adapter - unregister I2C adapter
1016 * @adap: the adapter being unregistered
1017 * Context: can sleep
1019 * This unregisters an I2C adapter which was previously registered
1020 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1022 int i2c_del_adapter(struct i2c_adapter *adap)
1024 int res = 0;
1025 struct i2c_adapter *found;
1026 struct i2c_client *client, *next;
1028 /* First make sure that this adapter was ever added */
1029 mutex_lock(&core_lock);
1030 found = idr_find(&i2c_adapter_idr, adap->nr);
1031 mutex_unlock(&core_lock);
1032 if (found != adap) {
1033 pr_debug("i2c-core: attempting to delete unregistered "
1034 "adapter [%s]\n", adap->name);
1035 return -EINVAL;
1038 /* Tell drivers about this removal */
1039 mutex_lock(&core_lock);
1040 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
1041 __process_removed_adapter);
1042 mutex_unlock(&core_lock);
1043 if (res)
1044 return res;
1046 /* Remove devices instantiated from sysfs */
1047 mutex_lock(&adap->userspace_clients_lock);
1048 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1049 detected) {
1050 dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
1051 client->addr);
1052 list_del(&client->detected);
1053 i2c_unregister_device(client);
1055 mutex_unlock(&adap->userspace_clients_lock);
1057 /* Detach any active clients. This can't fail, thus we do not
1058 * check the returned value. This is a two-pass process, because
1059 * we can't remove the dummy devices during the first pass: they
1060 * could have been instantiated by real devices wishing to clean
1061 * them up properly, so we give them a chance to do that first. */
1062 res = device_for_each_child(&adap->dev, NULL, __unregister_client);
1063 res = device_for_each_child(&adap->dev, NULL, __unregister_dummy);
1065 #ifdef CONFIG_I2C_COMPAT
1066 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
1067 adap->dev.parent);
1068 #endif
1070 /* device name is gone after device_unregister */
1071 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
1073 /* clean up the sysfs representation */
1074 init_completion(&adap->dev_released);
1075 device_unregister(&adap->dev);
1077 /* wait for sysfs to drop all references */
1078 wait_for_completion(&adap->dev_released);
1080 /* free bus id */
1081 mutex_lock(&core_lock);
1082 idr_remove(&i2c_adapter_idr, adap->nr);
1083 mutex_unlock(&core_lock);
1085 /* Clear the device structure in case this adapter is ever going to be
1086 added again */
1087 memset(&adap->dev, 0, sizeof(adap->dev));
1089 return 0;
1091 EXPORT_SYMBOL(i2c_del_adapter);
1094 /* ------------------------------------------------------------------------- */
1096 static int __process_new_driver(struct device *dev, void *data)
1098 if (dev->type != &i2c_adapter_type)
1099 return 0;
1100 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
1104 * An i2c_driver is used with one or more i2c_client (device) nodes to access
1105 * i2c slave chips, on a bus instance associated with some i2c_adapter.
1108 int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
1110 int res;
1112 /* Can't register until after driver model init */
1113 if (unlikely(WARN_ON(!i2c_bus_type.p)))
1114 return -EAGAIN;
1116 /* add the driver to the list of i2c drivers in the driver core */
1117 driver->driver.owner = owner;
1118 driver->driver.bus = &i2c_bus_type;
1120 /* When registration returns, the driver core
1121 * will have called probe() for all matching-but-unbound devices.
1123 res = driver_register(&driver->driver);
1124 if (res)
1125 return res;
1127 /* Drivers should switch to dev_pm_ops instead. */
1128 if (driver->suspend)
1129 pr_warn("i2c-core: driver [%s] using legacy suspend method\n",
1130 driver->driver.name);
1131 if (driver->resume)
1132 pr_warn("i2c-core: driver [%s] using legacy resume method\n",
1133 driver->driver.name);
1135 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
1137 INIT_LIST_HEAD(&driver->clients);
1138 /* Walk the adapters that are already present */
1139 mutex_lock(&core_lock);
1140 bus_for_each_dev(&i2c_bus_type, NULL, driver, __process_new_driver);
1141 mutex_unlock(&core_lock);
1143 return 0;
1145 EXPORT_SYMBOL(i2c_register_driver);
1147 static int __process_removed_driver(struct device *dev, void *data)
1149 if (dev->type != &i2c_adapter_type)
1150 return 0;
1151 return i2c_do_del_adapter(data, to_i2c_adapter(dev));
1155 * i2c_del_driver - unregister I2C driver
1156 * @driver: the driver being unregistered
1157 * Context: can sleep
1159 void i2c_del_driver(struct i2c_driver *driver)
1161 mutex_lock(&core_lock);
1162 bus_for_each_dev(&i2c_bus_type, NULL, driver, __process_removed_driver);
1163 mutex_unlock(&core_lock);
1165 driver_unregister(&driver->driver);
1166 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
1168 EXPORT_SYMBOL(i2c_del_driver);
1170 /* ------------------------------------------------------------------------- */
1173 * i2c_use_client - increments the reference count of the i2c client structure
1174 * @client: the client being referenced
1176 * Each live reference to a client should be refcounted. The driver model does
1177 * that automatically as part of driver binding, so that most drivers don't
1178 * need to do this explicitly: they hold a reference until they're unbound
1179 * from the device.
1181 * A pointer to the client with the incremented reference counter is returned.
1183 struct i2c_client *i2c_use_client(struct i2c_client *client)
1185 if (client && get_device(&client->dev))
1186 return client;
1187 return NULL;
1189 EXPORT_SYMBOL(i2c_use_client);
1192 * i2c_release_client - release a use of the i2c client structure
1193 * @client: the client being no longer referenced
1195 * Must be called when a user of a client is finished with it.
1197 void i2c_release_client(struct i2c_client *client)
1199 if (client)
1200 put_device(&client->dev);
1202 EXPORT_SYMBOL(i2c_release_client);
1204 struct i2c_cmd_arg {
1205 unsigned cmd;
1206 void *arg;
1209 static int i2c_cmd(struct device *dev, void *_arg)
1211 struct i2c_client *client = i2c_verify_client(dev);
1212 struct i2c_cmd_arg *arg = _arg;
1214 if (client && client->driver && client->driver->command)
1215 client->driver->command(client, arg->cmd, arg->arg);
1216 return 0;
1219 void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
1221 struct i2c_cmd_arg cmd_arg;
1223 cmd_arg.cmd = cmd;
1224 cmd_arg.arg = arg;
1225 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
1227 EXPORT_SYMBOL(i2c_clients_command);
1229 static int __init i2c_init(void)
1231 int retval;
1233 retval = bus_register(&i2c_bus_type);
1234 if (retval)
1235 return retval;
1236 #ifdef CONFIG_I2C_COMPAT
1237 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
1238 if (!i2c_adapter_compat_class) {
1239 retval = -ENOMEM;
1240 goto bus_err;
1242 #endif
1243 retval = i2c_add_driver(&dummy_driver);
1244 if (retval)
1245 goto class_err;
1246 return 0;
1248 class_err:
1249 #ifdef CONFIG_I2C_COMPAT
1250 class_compat_unregister(i2c_adapter_compat_class);
1251 bus_err:
1252 #endif
1253 bus_unregister(&i2c_bus_type);
1254 return retval;
1257 static void __exit i2c_exit(void)
1259 i2c_del_driver(&dummy_driver);
1260 #ifdef CONFIG_I2C_COMPAT
1261 class_compat_unregister(i2c_adapter_compat_class);
1262 #endif
1263 bus_unregister(&i2c_bus_type);
1266 /* We must initialize early, because some subsystems register i2c drivers
1267 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1269 postcore_initcall(i2c_init);
1270 module_exit(i2c_exit);
1272 /* ----------------------------------------------------
1273 * the functional interface to the i2c busses.
1274 * ----------------------------------------------------
1278 * i2c_transfer - execute a single or combined I2C message
1279 * @adap: Handle to I2C bus
1280 * @msgs: One or more messages to execute before STOP is issued to
1281 * terminate the operation; each message begins with a START.
1282 * @num: Number of messages to be executed.
1284 * Returns negative errno, else the number of messages executed.
1286 * Note that there is no requirement that each message be sent to
1287 * the same slave address, although that is the most common model.
1289 int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1291 unsigned long orig_jiffies;
1292 int ret, try;
1294 /* REVISIT the fault reporting model here is weak:
1296 * - When we get an error after receiving N bytes from a slave,
1297 * there is no way to report "N".
1299 * - When we get a NAK after transmitting N bytes to a slave,
1300 * there is no way to report "N" ... or to let the master
1301 * continue executing the rest of this combined message, if
1302 * that's the appropriate response.
1304 * - When for example "num" is two and we successfully complete
1305 * the first message but get an error part way through the
1306 * second, it's unclear whether that should be reported as
1307 * one (discarding status on the second message) or errno
1308 * (discarding status on the first one).
1311 if (adap->algo->master_xfer) {
1312 #ifdef DEBUG
1313 for (ret = 0; ret < num; ret++) {
1314 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
1315 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1316 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1317 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
1319 #endif
1321 if (in_atomic() || irqs_disabled()) {
1322 ret = i2c_trylock_adapter(adap);
1323 if (!ret)
1324 /* I2C activity is ongoing. */
1325 return -EAGAIN;
1326 } else {
1327 i2c_lock_adapter(adap);
1330 /* Retry automatically on arbitration loss */
1331 orig_jiffies = jiffies;
1332 for (ret = 0, try = 0; try <= adap->retries; try++) {
1333 ret = adap->algo->master_xfer(adap, msgs, num);
1334 if (ret != -EAGAIN)
1335 break;
1336 if (time_after(jiffies, orig_jiffies + adap->timeout))
1337 break;
1339 i2c_unlock_adapter(adap);
1341 return ret;
1342 } else {
1343 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
1344 return -EOPNOTSUPP;
1347 EXPORT_SYMBOL(i2c_transfer);
1350 * i2c_master_send - issue a single I2C message in master transmit mode
1351 * @client: Handle to slave device
1352 * @buf: Data that will be written to the slave
1353 * @count: How many bytes to write, must be less than 64k since msg.len is u16
1355 * Returns negative errno, or else the number of bytes written.
1357 int i2c_master_send(const struct i2c_client *client, const char *buf, int count)
1359 int ret;
1360 struct i2c_adapter *adap = client->adapter;
1361 struct i2c_msg msg;
1363 msg.addr = client->addr;
1364 msg.flags = client->flags & I2C_M_TEN;
1365 msg.len = count;
1366 msg.buf = (char *)buf;
1368 ret = i2c_transfer(adap, &msg, 1);
1370 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1371 transmitted, else error code. */
1372 return (ret == 1) ? count : ret;
1374 EXPORT_SYMBOL(i2c_master_send);
1377 * i2c_master_recv - issue a single I2C message in master receive mode
1378 * @client: Handle to slave device
1379 * @buf: Where to store data read from slave
1380 * @count: How many bytes to read, must be less than 64k since msg.len is u16
1382 * Returns negative errno, or else the number of bytes read.
1384 int i2c_master_recv(const struct i2c_client *client, char *buf, int count)
1386 struct i2c_adapter *adap = client->adapter;
1387 struct i2c_msg msg;
1388 int ret;
1390 msg.addr = client->addr;
1391 msg.flags = client->flags & I2C_M_TEN;
1392 msg.flags |= I2C_M_RD;
1393 msg.len = count;
1394 msg.buf = buf;
1396 ret = i2c_transfer(adap, &msg, 1);
1398 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1399 transmitted, else error code. */
1400 return (ret == 1) ? count : ret;
1402 EXPORT_SYMBOL(i2c_master_recv);
1404 /* ----------------------------------------------------
1405 * the i2c address scanning function
1406 * Will not work for 10-bit addresses!
1407 * ----------------------------------------------------
1411 * Legacy default probe function, mostly relevant for SMBus. The default
1412 * probe method is a quick write, but it is known to corrupt the 24RF08
1413 * EEPROMs due to a state machine bug, and could also irreversibly
1414 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
1415 * we use a short byte read instead. Also, some bus drivers don't implement
1416 * quick write, so we fallback to a byte read in that case too.
1417 * On x86, there is another special case for FSC hardware monitoring chips,
1418 * which want regular byte reads (address 0x73.) Fortunately, these are the
1419 * only known chips using this I2C address on PC hardware.
1420 * Returns 1 if probe succeeded, 0 if not.
1422 static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
1424 int err;
1425 union i2c_smbus_data dummy;
1427 #ifdef CONFIG_X86
1428 if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
1429 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
1430 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1431 I2C_SMBUS_BYTE_DATA, &dummy);
1432 else
1433 #endif
1434 if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
1435 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
1436 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
1437 I2C_SMBUS_QUICK, NULL);
1438 else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
1439 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1440 I2C_SMBUS_BYTE, &dummy);
1441 else {
1442 dev_warn(&adap->dev, "No suitable probing method supported\n");
1443 err = -EOPNOTSUPP;
1446 return err >= 0;
1449 static int i2c_detect_address(struct i2c_client *temp_client,
1450 struct i2c_driver *driver)
1452 struct i2c_board_info info;
1453 struct i2c_adapter *adapter = temp_client->adapter;
1454 int addr = temp_client->addr;
1455 int err;
1457 /* Make sure the address is valid */
1458 err = i2c_check_addr_validity(addr);
1459 if (err) {
1460 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1461 addr);
1462 return err;
1465 /* Skip if already in use */
1466 if (i2c_check_addr_busy(adapter, addr))
1467 return 0;
1469 /* Make sure there is something at this address */
1470 if (!i2c_default_probe(adapter, addr))
1471 return 0;
1473 /* Finally call the custom detection function */
1474 memset(&info, 0, sizeof(struct i2c_board_info));
1475 info.addr = addr;
1476 err = driver->detect(temp_client, &info);
1477 if (err) {
1478 /* -ENODEV is returned if the detection fails. We catch it
1479 here as this isn't an error. */
1480 return err == -ENODEV ? 0 : err;
1483 /* Consistency check */
1484 if (info.type[0] == '\0') {
1485 dev_err(&adapter->dev, "%s detection function provided "
1486 "no name for 0x%x\n", driver->driver.name,
1487 addr);
1488 } else {
1489 struct i2c_client *client;
1491 /* Detection succeeded, instantiate the device */
1492 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1493 info.type, info.addr);
1494 client = i2c_new_device(adapter, &info);
1495 if (client)
1496 list_add_tail(&client->detected, &driver->clients);
1497 else
1498 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1499 info.type, info.addr);
1501 return 0;
1504 static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1506 const unsigned short *address_list;
1507 struct i2c_client *temp_client;
1508 int i, err = 0;
1509 int adap_id = i2c_adapter_id(adapter);
1511 address_list = driver->address_list;
1512 if (!driver->detect || !address_list)
1513 return 0;
1515 /* Stop here if the classes do not match */
1516 if (!(adapter->class & driver->class))
1517 return 0;
1519 /* Set up a temporary client to help detect callback */
1520 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1521 if (!temp_client)
1522 return -ENOMEM;
1523 temp_client->adapter = adapter;
1525 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
1526 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1527 "addr 0x%02x\n", adap_id, address_list[i]);
1528 temp_client->addr = address_list[i];
1529 err = i2c_detect_address(temp_client, driver);
1530 if (unlikely(err))
1531 break;
1534 kfree(temp_client);
1535 return err;
1538 int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
1540 return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1541 I2C_SMBUS_QUICK, NULL) >= 0;
1543 EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);
1545 struct i2c_client *
1546 i2c_new_probed_device(struct i2c_adapter *adap,
1547 struct i2c_board_info *info,
1548 unsigned short const *addr_list,
1549 int (*probe)(struct i2c_adapter *, unsigned short addr))
1551 int i;
1553 if (!probe)
1554 probe = i2c_default_probe;
1556 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1557 /* Check address validity */
1558 if (i2c_check_addr_validity(addr_list[i]) < 0) {
1559 dev_warn(&adap->dev, "Invalid 7-bit address "
1560 "0x%02x\n", addr_list[i]);
1561 continue;
1564 /* Check address availability */
1565 if (i2c_check_addr_busy(adap, addr_list[i])) {
1566 dev_dbg(&adap->dev, "Address 0x%02x already in "
1567 "use, not probing\n", addr_list[i]);
1568 continue;
1571 /* Test address responsiveness */
1572 if (probe(adap, addr_list[i]))
1573 break;
1576 if (addr_list[i] == I2C_CLIENT_END) {
1577 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1578 return NULL;
1581 info->addr = addr_list[i];
1582 return i2c_new_device(adap, info);
1584 EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1586 struct i2c_adapter *i2c_get_adapter(int id)
1588 struct i2c_adapter *adapter;
1590 mutex_lock(&core_lock);
1591 adapter = idr_find(&i2c_adapter_idr, id);
1592 if (adapter && !try_module_get(adapter->owner))
1593 adapter = NULL;
1595 mutex_unlock(&core_lock);
1596 return adapter;
1598 EXPORT_SYMBOL(i2c_get_adapter);
1600 void i2c_put_adapter(struct i2c_adapter *adap)
1602 module_put(adap->owner);
1604 EXPORT_SYMBOL(i2c_put_adapter);
1606 /* The SMBus parts */
1608 #define POLY (0x1070U << 3)
1609 static u8 crc8(u16 data)
1611 int i;
1613 for (i = 0; i < 8; i++) {
1614 if (data & 0x8000)
1615 data = data ^ POLY;
1616 data = data << 1;
1618 return (u8)(data >> 8);
1621 /* Incremental CRC8 over count bytes in the array pointed to by p */
1622 static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1624 int i;
1626 for (i = 0; i < count; i++)
1627 crc = crc8((crc ^ p[i]) << 8);
1628 return crc;
1631 /* Assume a 7-bit address, which is reasonable for SMBus */
1632 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1634 /* The address will be sent first */
1635 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1636 pec = i2c_smbus_pec(pec, &addr, 1);
1638 /* The data buffer follows */
1639 return i2c_smbus_pec(pec, msg->buf, msg->len);
1642 /* Used for write only transactions */
1643 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1645 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1646 msg->len++;
1649 /* Return <0 on CRC error
1650 If there was a write before this read (most cases) we need to take the
1651 partial CRC from the write part into account.
1652 Note that this function does modify the message (we need to decrease the
1653 message length to hide the CRC byte from the caller). */
1654 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1656 u8 rpec = msg->buf[--msg->len];
1657 cpec = i2c_smbus_msg_pec(cpec, msg);
1659 if (rpec != cpec) {
1660 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1661 rpec, cpec);
1662 return -EBADMSG;
1664 return 0;
1668 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1669 * @client: Handle to slave device
1671 * This executes the SMBus "receive byte" protocol, returning negative errno
1672 * else the byte received from the device.
1674 s32 i2c_smbus_read_byte(const struct i2c_client *client)
1676 union i2c_smbus_data data;
1677 int status;
1679 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1680 I2C_SMBUS_READ, 0,
1681 I2C_SMBUS_BYTE, &data);
1682 return (status < 0) ? status : data.byte;
1684 EXPORT_SYMBOL(i2c_smbus_read_byte);
1687 * i2c_smbus_write_byte - SMBus "send byte" protocol
1688 * @client: Handle to slave device
1689 * @value: Byte to be sent
1691 * This executes the SMBus "send byte" protocol, returning negative errno
1692 * else zero on success.
1694 s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value)
1696 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1697 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1699 EXPORT_SYMBOL(i2c_smbus_write_byte);
1702 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1703 * @client: Handle to slave device
1704 * @command: Byte interpreted by slave
1706 * This executes the SMBus "read byte" protocol, returning negative errno
1707 * else a data byte received from the device.
1709 s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command)
1711 union i2c_smbus_data data;
1712 int status;
1714 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1715 I2C_SMBUS_READ, command,
1716 I2C_SMBUS_BYTE_DATA, &data);
1717 return (status < 0) ? status : data.byte;
1719 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1722 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1723 * @client: Handle to slave device
1724 * @command: Byte interpreted by slave
1725 * @value: Byte being written
1727 * This executes the SMBus "write byte" protocol, returning negative errno
1728 * else zero on success.
1730 s32 i2c_smbus_write_byte_data(const struct i2c_client *client, u8 command,
1731 u8 value)
1733 union i2c_smbus_data data;
1734 data.byte = value;
1735 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1736 I2C_SMBUS_WRITE, command,
1737 I2C_SMBUS_BYTE_DATA, &data);
1739 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1742 * i2c_smbus_read_word_data - SMBus "read word" protocol
1743 * @client: Handle to slave device
1744 * @command: Byte interpreted by slave
1746 * This executes the SMBus "read word" protocol, returning negative errno
1747 * else a 16-bit unsigned "word" received from the device.
1749 s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command)
1751 union i2c_smbus_data data;
1752 int status;
1754 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1755 I2C_SMBUS_READ, command,
1756 I2C_SMBUS_WORD_DATA, &data);
1757 return (status < 0) ? status : data.word;
1759 EXPORT_SYMBOL(i2c_smbus_read_word_data);
1762 * i2c_smbus_write_word_data - SMBus "write word" protocol
1763 * @client: Handle to slave device
1764 * @command: Byte interpreted by slave
1765 * @value: 16-bit "word" being written
1767 * This executes the SMBus "write word" protocol, returning negative errno
1768 * else zero on success.
1770 s32 i2c_smbus_write_word_data(const struct i2c_client *client, u8 command,
1771 u16 value)
1773 union i2c_smbus_data data;
1774 data.word = value;
1775 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1776 I2C_SMBUS_WRITE, command,
1777 I2C_SMBUS_WORD_DATA, &data);
1779 EXPORT_SYMBOL(i2c_smbus_write_word_data);
1782 * i2c_smbus_process_call - SMBus "process call" protocol
1783 * @client: Handle to slave device
1784 * @command: Byte interpreted by slave
1785 * @value: 16-bit "word" being written
1787 * This executes the SMBus "process call" protocol, returning negative errno
1788 * else a 16-bit unsigned "word" received from the device.
1790 s32 i2c_smbus_process_call(const struct i2c_client *client, u8 command,
1791 u16 value)
1793 union i2c_smbus_data data;
1794 int status;
1795 data.word = value;
1797 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1798 I2C_SMBUS_WRITE, command,
1799 I2C_SMBUS_PROC_CALL, &data);
1800 return (status < 0) ? status : data.word;
1802 EXPORT_SYMBOL(i2c_smbus_process_call);
1805 * i2c_smbus_read_block_data - SMBus "block read" protocol
1806 * @client: Handle to slave device
1807 * @command: Byte interpreted by slave
1808 * @values: Byte array into which data will be read; big enough to hold
1809 * the data returned by the slave. SMBus allows at most 32 bytes.
1811 * This executes the SMBus "block read" protocol, returning negative errno
1812 * else the number of data bytes in the slave's response.
1814 * Note that using this function requires that the client's adapter support
1815 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1816 * support this; its emulation through I2C messaging relies on a specific
1817 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1819 s32 i2c_smbus_read_block_data(const struct i2c_client *client, u8 command,
1820 u8 *values)
1822 union i2c_smbus_data data;
1823 int status;
1825 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1826 I2C_SMBUS_READ, command,
1827 I2C_SMBUS_BLOCK_DATA, &data);
1828 if (status)
1829 return status;
1831 memcpy(values, &data.block[1], data.block[0]);
1832 return data.block[0];
1834 EXPORT_SYMBOL(i2c_smbus_read_block_data);
1837 * i2c_smbus_write_block_data - SMBus "block write" protocol
1838 * @client: Handle to slave device
1839 * @command: Byte interpreted by slave
1840 * @length: Size of data block; SMBus allows at most 32 bytes
1841 * @values: Byte array which will be written.
1843 * This executes the SMBus "block write" protocol, returning negative errno
1844 * else zero on success.
1846 s32 i2c_smbus_write_block_data(const struct i2c_client *client, u8 command,
1847 u8 length, const u8 *values)
1849 union i2c_smbus_data data;
1851 if (length > I2C_SMBUS_BLOCK_MAX)
1852 length = I2C_SMBUS_BLOCK_MAX;
1853 data.block[0] = length;
1854 memcpy(&data.block[1], values, length);
1855 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1856 I2C_SMBUS_WRITE, command,
1857 I2C_SMBUS_BLOCK_DATA, &data);
1859 EXPORT_SYMBOL(i2c_smbus_write_block_data);
1861 /* Returns the number of read bytes */
1862 s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, u8 command,
1863 u8 length, u8 *values)
1865 union i2c_smbus_data data;
1866 int status;
1868 if (length > I2C_SMBUS_BLOCK_MAX)
1869 length = I2C_SMBUS_BLOCK_MAX;
1870 data.block[0] = length;
1871 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1872 I2C_SMBUS_READ, command,
1873 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1874 if (status < 0)
1875 return status;
1877 memcpy(values, &data.block[1], data.block[0]);
1878 return data.block[0];
1880 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1882 s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, u8 command,
1883 u8 length, const u8 *values)
1885 union i2c_smbus_data data;
1887 if (length > I2C_SMBUS_BLOCK_MAX)
1888 length = I2C_SMBUS_BLOCK_MAX;
1889 data.block[0] = length;
1890 memcpy(data.block + 1, values, length);
1891 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1892 I2C_SMBUS_WRITE, command,
1893 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1895 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1897 /* Simulate a SMBus command using the i2c protocol
1898 No checking of parameters is done! */
1899 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter *adapter, u16 addr,
1900 unsigned short flags,
1901 char read_write, u8 command, int size,
1902 union i2c_smbus_data *data)
1904 /* So we need to generate a series of msgs. In the case of writing, we
1905 need to use only one message; when reading, we need two. We initialize
1906 most things with sane defaults, to keep the code below somewhat
1907 simpler. */
1908 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1909 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1910 int num = read_write == I2C_SMBUS_READ ? 2 : 1;
1911 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1912 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1914 int i;
1915 u8 partial_pec = 0;
1916 int status;
1918 msgbuf0[0] = command;
1919 switch (size) {
1920 case I2C_SMBUS_QUICK:
1921 msg[0].len = 0;
1922 /* Special case: The read/write field is used as data */
1923 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
1924 I2C_M_RD : 0);
1925 num = 1;
1926 break;
1927 case I2C_SMBUS_BYTE:
1928 if (read_write == I2C_SMBUS_READ) {
1929 /* Special case: only a read! */
1930 msg[0].flags = I2C_M_RD | flags;
1931 num = 1;
1933 break;
1934 case I2C_SMBUS_BYTE_DATA:
1935 if (read_write == I2C_SMBUS_READ)
1936 msg[1].len = 1;
1937 else {
1938 msg[0].len = 2;
1939 msgbuf0[1] = data->byte;
1941 break;
1942 case I2C_SMBUS_WORD_DATA:
1943 if (read_write == I2C_SMBUS_READ)
1944 msg[1].len = 2;
1945 else {
1946 msg[0].len = 3;
1947 msgbuf0[1] = data->word & 0xff;
1948 msgbuf0[2] = data->word >> 8;
1950 break;
1951 case I2C_SMBUS_PROC_CALL:
1952 num = 2; /* Special case */
1953 read_write = I2C_SMBUS_READ;
1954 msg[0].len = 3;
1955 msg[1].len = 2;
1956 msgbuf0[1] = data->word & 0xff;
1957 msgbuf0[2] = data->word >> 8;
1958 break;
1959 case I2C_SMBUS_BLOCK_DATA:
1960 if (read_write == I2C_SMBUS_READ) {
1961 msg[1].flags |= I2C_M_RECV_LEN;
1962 msg[1].len = 1; /* block length will be added by
1963 the underlying bus driver */
1964 } else {
1965 msg[0].len = data->block[0] + 2;
1966 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1967 dev_err(&adapter->dev,
1968 "Invalid block write size %d\n",
1969 data->block[0]);
1970 return -EINVAL;
1972 for (i = 1; i < msg[0].len; i++)
1973 msgbuf0[i] = data->block[i-1];
1975 break;
1976 case I2C_SMBUS_BLOCK_PROC_CALL:
1977 num = 2; /* Another special case */
1978 read_write = I2C_SMBUS_READ;
1979 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1980 dev_err(&adapter->dev,
1981 "Invalid block write size %d\n",
1982 data->block[0]);
1983 return -EINVAL;
1985 msg[0].len = data->block[0] + 2;
1986 for (i = 1; i < msg[0].len; i++)
1987 msgbuf0[i] = data->block[i-1];
1988 msg[1].flags |= I2C_M_RECV_LEN;
1989 msg[1].len = 1; /* block length will be added by
1990 the underlying bus driver */
1991 break;
1992 case I2C_SMBUS_I2C_BLOCK_DATA:
1993 if (read_write == I2C_SMBUS_READ) {
1994 msg[1].len = data->block[0];
1995 } else {
1996 msg[0].len = data->block[0] + 1;
1997 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
1998 dev_err(&adapter->dev,
1999 "Invalid block write size %d\n",
2000 data->block[0]);
2001 return -EINVAL;
2003 for (i = 1; i <= data->block[0]; i++)
2004 msgbuf0[i] = data->block[i];
2006 break;
2007 default:
2008 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
2009 return -EOPNOTSUPP;
2012 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
2013 && size != I2C_SMBUS_I2C_BLOCK_DATA);
2014 if (i) {
2015 /* Compute PEC if first message is a write */
2016 if (!(msg[0].flags & I2C_M_RD)) {
2017 if (num == 1) /* Write only */
2018 i2c_smbus_add_pec(&msg[0]);
2019 else /* Write followed by read */
2020 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
2022 /* Ask for PEC if last message is a read */
2023 if (msg[num-1].flags & I2C_M_RD)
2024 msg[num-1].len++;
2027 status = i2c_transfer(adapter, msg, num);
2028 if (status < 0)
2029 return status;
2031 /* Check PEC if last message is a read */
2032 if (i && (msg[num-1].flags & I2C_M_RD)) {
2033 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
2034 if (status < 0)
2035 return status;
2038 if (read_write == I2C_SMBUS_READ)
2039 switch (size) {
2040 case I2C_SMBUS_BYTE:
2041 data->byte = msgbuf0[0];
2042 break;
2043 case I2C_SMBUS_BYTE_DATA:
2044 data->byte = msgbuf1[0];
2045 break;
2046 case I2C_SMBUS_WORD_DATA:
2047 case I2C_SMBUS_PROC_CALL:
2048 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
2049 break;
2050 case I2C_SMBUS_I2C_BLOCK_DATA:
2051 for (i = 0; i < data->block[0]; i++)
2052 data->block[i+1] = msgbuf1[i];
2053 break;
2054 case I2C_SMBUS_BLOCK_DATA:
2055 case I2C_SMBUS_BLOCK_PROC_CALL:
2056 for (i = 0; i < msgbuf1[0] + 1; i++)
2057 data->block[i] = msgbuf1[i];
2058 break;
2060 return 0;
2064 * i2c_smbus_xfer - execute SMBus protocol operations
2065 * @adapter: Handle to I2C bus
2066 * @addr: Address of SMBus slave on that bus
2067 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
2068 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
2069 * @command: Byte interpreted by slave, for protocols which use such bytes
2070 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
2071 * @data: Data to be read or written
2073 * This executes an SMBus protocol operation, and returns a negative
2074 * errno code else zero on success.
2076 s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
2077 char read_write, u8 command, int protocol,
2078 union i2c_smbus_data *data)
2080 unsigned long orig_jiffies;
2081 int try;
2082 s32 res;
2084 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
2086 if (adapter->algo->smbus_xfer) {
2087 i2c_lock_adapter(adapter);
2089 /* Retry automatically on arbitration loss */
2090 orig_jiffies = jiffies;
2091 for (res = 0, try = 0; try <= adapter->retries; try++) {
2092 res = adapter->algo->smbus_xfer(adapter, addr, flags,
2093 read_write, command,
2094 protocol, data);
2095 if (res != -EAGAIN)
2096 break;
2097 if (time_after(jiffies,
2098 orig_jiffies + adapter->timeout))
2099 break;
2101 i2c_unlock_adapter(adapter);
2102 } else
2103 res = i2c_smbus_xfer_emulated(adapter, addr, flags, read_write,
2104 command, protocol, data);
2106 return res;
2108 EXPORT_SYMBOL(i2c_smbus_xfer);
2110 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2111 MODULE_DESCRIPTION("I2C-Bus main module");
2112 MODULE_LICENSE("GPL");