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/seq_file.h>
33 #include <linux/platform_device.h>
34 #include <linux/mutex.h>
35 #include <linux/completion.h>
36 #include <asm/uaccess.h>
41 static LIST_HEAD(adapters);
42 static LIST_HEAD(drivers);
43 static DEFINE_MUTEX(core_lists);
44 static DEFINE_IDR(i2c_adapter_idr);
46 #define is_newstyle_driver(d) ((d)->probe || (d)->remove)
48 /* ------------------------------------------------------------------------- */
50 static int i2c_device_match(struct device *dev, struct device_driver *drv)
52 struct i2c_client *client = to_i2c_client(dev);
53 struct i2c_driver *driver = to_i2c_driver(drv);
55 /* make legacy i2c drivers bypass driver model probing entirely;
56 * such drivers scan each i2c adapter/bus themselves.
58 if (!is_newstyle_driver(driver))
61 /* new style drivers use the same kind of driver matching policy
62 * as platform devices or SPI: compare device and driver IDs.
64 return strcmp(client->driver_name, drv->name) == 0;
69 /* uevent helps with hotplug: modprobe -q $(MODALIAS) */
70 static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
72 struct i2c_client *client = to_i2c_client(dev);
74 /* by definition, legacy drivers can't hotplug */
75 if (dev->driver || !client->driver_name)
78 if (add_uevent_var(env, "MODALIAS=%s", client->driver_name))
80 dev_dbg(dev, "uevent\n");
85 #define i2c_device_uevent NULL
86 #endif /* CONFIG_HOTPLUG */
88 static int i2c_device_probe(struct device *dev)
90 struct i2c_client *client = to_i2c_client(dev);
91 struct i2c_driver *driver = to_i2c_driver(dev->driver);
95 client->driver = driver;
96 dev_dbg(dev, "probe\n");
97 return driver->probe(client);
100 static int i2c_device_remove(struct device *dev)
102 struct i2c_client *client = to_i2c_client(dev);
103 struct i2c_driver *driver;
109 driver = to_i2c_driver(dev->driver);
110 if (driver->remove) {
111 dev_dbg(dev, "remove\n");
112 status = driver->remove(client);
118 client->driver = NULL;
122 static void i2c_device_shutdown(struct device *dev)
124 struct i2c_driver *driver;
128 driver = to_i2c_driver(dev->driver);
129 if (driver->shutdown)
130 driver->shutdown(to_i2c_client(dev));
133 static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
135 struct i2c_driver *driver;
139 driver = to_i2c_driver(dev->driver);
140 if (!driver->suspend)
142 return driver->suspend(to_i2c_client(dev), mesg);
145 static int i2c_device_resume(struct device * dev)
147 struct i2c_driver *driver;
151 driver = to_i2c_driver(dev->driver);
154 return driver->resume(to_i2c_client(dev));
157 static void i2c_client_release(struct device *dev)
159 struct i2c_client *client = to_i2c_client(dev);
160 complete(&client->released);
163 static void i2c_client_dev_release(struct device *dev)
165 kfree(to_i2c_client(dev));
168 static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
170 struct i2c_client *client = to_i2c_client(dev);
171 return sprintf(buf, "%s\n", client->name);
174 static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
176 struct i2c_client *client = to_i2c_client(dev);
177 return client->driver_name
178 ? sprintf(buf, "%s\n", client->driver_name)
182 static struct device_attribute i2c_dev_attrs[] = {
183 __ATTR(name, S_IRUGO, show_client_name, NULL),
184 /* modalias helps coldplug: modprobe $(cat .../modalias) */
185 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
189 static struct bus_type i2c_bus_type = {
191 .dev_attrs = i2c_dev_attrs,
192 .match = i2c_device_match,
193 .uevent = i2c_device_uevent,
194 .probe = i2c_device_probe,
195 .remove = i2c_device_remove,
196 .shutdown = i2c_device_shutdown,
197 .suspend = i2c_device_suspend,
198 .resume = i2c_device_resume,
202 * i2c_new_device - instantiate an i2c device for use with a new style driver
203 * @adap: the adapter managing the device
204 * @info: describes one I2C device; bus_num is ignored
207 * Create a device to work with a new style i2c driver, where binding is
208 * handled through driver model probe()/remove() methods. This call is not
209 * appropriate for use by mainboad initialization logic, which usually runs
210 * during an arch_initcall() long before any i2c_adapter could exist.
212 * This returns the new i2c client, which may be saved for later use with
213 * i2c_unregister_device(); or NULL to indicate an error.
216 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
218 struct i2c_client *client;
221 client = kzalloc(sizeof *client, GFP_KERNEL);
225 client->adapter = adap;
227 client->dev.platform_data = info->platform_data;
228 device_init_wakeup(&client->dev, info->flags & I2C_CLIENT_WAKE);
230 client->flags = info->flags & ~I2C_CLIENT_WAKE;
231 client->addr = info->addr;
232 client->irq = info->irq;
234 strlcpy(client->driver_name, info->driver_name,
235 sizeof(client->driver_name));
236 strlcpy(client->name, info->type, sizeof(client->name));
238 /* a new style driver may be bound to this device when we
239 * return from this function, or any later moment (e.g. maybe
240 * hotplugging will load the driver module). and the device
241 * refcount model is the standard driver model one.
243 status = i2c_attach_client(client);
250 EXPORT_SYMBOL_GPL(i2c_new_device);
254 * i2c_unregister_device - reverse effect of i2c_new_device()
255 * @client: value returned from i2c_new_device()
258 void i2c_unregister_device(struct i2c_client *client)
260 struct i2c_adapter *adapter = client->adapter;
261 struct i2c_driver *driver = client->driver;
263 if (driver && !is_newstyle_driver(driver)) {
264 dev_err(&client->dev, "can't unregister devices "
265 "with legacy drivers\n");
270 mutex_lock(&adapter->clist_lock);
271 list_del(&client->list);
272 mutex_unlock(&adapter->clist_lock);
274 device_unregister(&client->dev);
276 EXPORT_SYMBOL_GPL(i2c_unregister_device);
279 /* ------------------------------------------------------------------------- */
281 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
283 static void i2c_adapter_dev_release(struct device *dev)
285 struct i2c_adapter *adap = to_i2c_adapter(dev);
286 complete(&adap->dev_released);
290 show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
292 struct i2c_adapter *adap = to_i2c_adapter(dev);
293 return sprintf(buf, "%s\n", adap->name);
296 static struct device_attribute i2c_adapter_attrs[] = {
297 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
301 static struct class i2c_adapter_class = {
302 .owner = THIS_MODULE,
303 .name = "i2c-adapter",
304 .dev_attrs = i2c_adapter_attrs,
307 static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
309 struct i2c_devinfo *devinfo;
311 mutex_lock(&__i2c_board_lock);
312 list_for_each_entry(devinfo, &__i2c_board_list, list) {
313 if (devinfo->busnum == adapter->nr
314 && !i2c_new_device(adapter,
315 &devinfo->board_info))
316 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
317 i2c_adapter_id(adapter),
318 devinfo->board_info.addr);
320 mutex_unlock(&__i2c_board_lock);
323 static int i2c_register_adapter(struct i2c_adapter *adap)
326 struct list_head *item;
327 struct i2c_driver *driver;
329 mutex_init(&adap->bus_lock);
330 mutex_init(&adap->clist_lock);
331 INIT_LIST_HEAD(&adap->clients);
333 mutex_lock(&core_lists);
334 list_add_tail(&adap->list, &adapters);
336 /* Add the adapter to the driver core.
337 * If the parent pointer is not set up,
338 * we add this adapter to the host bus.
340 if (adap->dev.parent == NULL) {
341 adap->dev.parent = &platform_bus;
342 pr_debug("I2C adapter driver [%s] forgot to specify "
343 "physical device\n", adap->name);
345 sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
346 adap->dev.release = &i2c_adapter_dev_release;
347 adap->dev.class = &i2c_adapter_class;
348 res = device_register(&adap->dev);
352 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
354 /* create pre-declared device nodes for new-style drivers */
355 if (adap->nr < __i2c_first_dynamic_bus_num)
356 i2c_scan_static_board_info(adap);
358 /* let legacy drivers scan this bus for matching devices */
359 list_for_each(item,&drivers) {
360 driver = list_entry(item, struct i2c_driver, list);
361 if (driver->attach_adapter)
362 /* We ignore the return code; if it fails, too bad */
363 driver->attach_adapter(adap);
367 mutex_unlock(&core_lists);
371 list_del(&adap->list);
372 idr_remove(&i2c_adapter_idr, adap->nr);
377 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
378 * @adapter: the adapter to add
381 * This routine is used to declare an I2C adapter when its bus number
382 * doesn't matter. Examples: for I2C adapters dynamically added by
383 * USB links or PCI plugin cards.
385 * When this returns zero, a new bus number was allocated and stored
386 * in adap->nr, and the specified adapter became available for clients.
387 * Otherwise, a negative errno value is returned.
389 int i2c_add_adapter(struct i2c_adapter *adapter)
394 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
397 mutex_lock(&core_lists);
398 /* "above" here means "above or equal to", sigh */
399 res = idr_get_new_above(&i2c_adapter_idr, adapter,
400 __i2c_first_dynamic_bus_num, &id);
401 mutex_unlock(&core_lists);
410 return i2c_register_adapter(adapter);
412 EXPORT_SYMBOL(i2c_add_adapter);
415 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
416 * @adap: the adapter to register (with adap->nr initialized)
419 * This routine is used to declare an I2C adapter when its bus number
420 * matters. Example: for I2C adapters from system-on-chip CPUs, or
421 * otherwise built in to the system's mainboard, and where i2c_board_info
422 * is used to properly configure I2C devices.
424 * If no devices have pre-been declared for this bus, then be sure to
425 * register the adapter before any dynamically allocated ones. Otherwise
426 * the required bus ID may not be available.
428 * When this returns zero, the specified adapter became available for
429 * clients using the bus number provided in adap->nr. Also, the table
430 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
431 * and the appropriate driver model device nodes are created. Otherwise, a
432 * negative errno value is returned.
434 int i2c_add_numbered_adapter(struct i2c_adapter *adap)
439 if (adap->nr & ~MAX_ID_MASK)
443 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
446 mutex_lock(&core_lists);
447 /* "above" here means "above or equal to", sigh;
448 * we need the "equal to" result to force the result
450 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
451 if (status == 0 && id != adap->nr) {
453 idr_remove(&i2c_adapter_idr, id);
455 mutex_unlock(&core_lists);
456 if (status == -EAGAIN)
460 status = i2c_register_adapter(adap);
463 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
466 * i2c_del_adapter - unregister I2C adapter
467 * @adap: the adapter being unregistered
470 * This unregisters an I2C adapter which was previously registered
471 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
473 int i2c_del_adapter(struct i2c_adapter *adap)
475 struct list_head *item, *_n;
476 struct i2c_adapter *adap_from_list;
477 struct i2c_driver *driver;
478 struct i2c_client *client;
481 mutex_lock(&core_lists);
483 /* First make sure that this adapter was ever added */
484 list_for_each_entry(adap_from_list, &adapters, list) {
485 if (adap_from_list == adap)
488 if (adap_from_list != adap) {
489 pr_debug("i2c-core: attempting to delete unregistered "
490 "adapter [%s]\n", adap->name);
495 list_for_each(item,&drivers) {
496 driver = list_entry(item, struct i2c_driver, list);
497 if (driver->detach_adapter)
498 if ((res = driver->detach_adapter(adap))) {
499 dev_err(&adap->dev, "detach_adapter failed "
501 driver->driver.name);
506 /* detach any active clients. This must be done first, because
507 * it can fail; in which case we give up. */
508 list_for_each_safe(item, _n, &adap->clients) {
509 struct i2c_driver *driver;
511 client = list_entry(item, struct i2c_client, list);
512 driver = client->driver;
514 /* new style, follow standard driver model */
515 if (!driver || is_newstyle_driver(driver)) {
516 i2c_unregister_device(client);
520 /* legacy drivers create and remove clients themselves */
521 if ((res = driver->detach_client(client))) {
522 dev_err(&adap->dev, "detach_client failed for client "
523 "[%s] at address 0x%02x\n", client->name,
529 /* clean up the sysfs representation */
530 init_completion(&adap->dev_released);
531 device_unregister(&adap->dev);
532 list_del(&adap->list);
534 /* wait for sysfs to drop all references */
535 wait_for_completion(&adap->dev_released);
538 idr_remove(&i2c_adapter_idr, adap->nr);
540 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
543 mutex_unlock(&core_lists);
546 EXPORT_SYMBOL(i2c_del_adapter);
549 /* ------------------------------------------------------------------------- */
552 * An i2c_driver is used with one or more i2c_client (device) nodes to access
553 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
554 * are two models for binding the driver to its device: "new style" drivers
555 * follow the standard Linux driver model and just respond to probe() calls
556 * issued if the driver core sees they match(); "legacy" drivers create device
560 int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
564 /* new style driver methods can't mix with legacy ones */
565 if (is_newstyle_driver(driver)) {
566 if (driver->attach_adapter || driver->detach_adapter
567 || driver->detach_client) {
569 "i2c-core: driver [%s] is confused\n",
570 driver->driver.name);
575 /* add the driver to the list of i2c drivers in the driver core */
576 driver->driver.owner = owner;
577 driver->driver.bus = &i2c_bus_type;
579 /* for new style drivers, when registration returns the driver core
580 * will have called probe() for all matching-but-unbound devices.
582 res = driver_register(&driver->driver);
586 mutex_lock(&core_lists);
588 list_add_tail(&driver->list,&drivers);
589 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
591 /* legacy drivers scan i2c busses directly */
592 if (driver->attach_adapter) {
593 struct i2c_adapter *adapter;
595 list_for_each_entry(adapter, &adapters, list) {
596 driver->attach_adapter(adapter);
600 mutex_unlock(&core_lists);
603 EXPORT_SYMBOL(i2c_register_driver);
606 * i2c_del_driver - unregister I2C driver
607 * @driver: the driver being unregistered
610 void i2c_del_driver(struct i2c_driver *driver)
612 struct list_head *item1, *item2, *_n;
613 struct i2c_client *client;
614 struct i2c_adapter *adap;
616 mutex_lock(&core_lists);
618 /* new-style driver? */
619 if (is_newstyle_driver(driver))
622 /* Have a look at each adapter, if clients of this driver are still
623 * attached. If so, detach them to be able to kill the driver
626 list_for_each(item1,&adapters) {
627 adap = list_entry(item1, struct i2c_adapter, list);
628 if (driver->detach_adapter) {
629 if (driver->detach_adapter(adap)) {
630 dev_err(&adap->dev, "detach_adapter failed "
632 driver->driver.name);
635 list_for_each_safe(item2, _n, &adap->clients) {
636 client = list_entry(item2, struct i2c_client, list);
637 if (client->driver != driver)
639 dev_dbg(&adap->dev, "detaching client [%s] "
640 "at 0x%02x\n", client->name,
642 if (driver->detach_client(client)) {
643 dev_err(&adap->dev, "detach_client "
644 "failed for client [%s] at "
645 "0x%02x\n", client->name,
653 driver_unregister(&driver->driver);
654 list_del(&driver->list);
655 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
657 mutex_unlock(&core_lists);
659 EXPORT_SYMBOL(i2c_del_driver);
661 /* ------------------------------------------------------------------------- */
663 static int __i2c_check_addr(struct i2c_adapter *adapter, unsigned int addr)
665 struct list_head *item;
666 struct i2c_client *client;
668 list_for_each(item,&adapter->clients) {
669 client = list_entry(item, struct i2c_client, list);
670 if (client->addr == addr)
676 static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
680 mutex_lock(&adapter->clist_lock);
681 rval = __i2c_check_addr(adapter, addr);
682 mutex_unlock(&adapter->clist_lock);
687 int i2c_attach_client(struct i2c_client *client)
689 struct i2c_adapter *adapter = client->adapter;
692 mutex_lock(&adapter->clist_lock);
693 if (__i2c_check_addr(client->adapter, client->addr)) {
697 list_add_tail(&client->list,&adapter->clients);
699 client->usage_count = 0;
701 client->dev.parent = &client->adapter->dev;
702 client->dev.bus = &i2c_bus_type;
705 client->dev.driver = &client->driver->driver;
707 if (client->driver && !is_newstyle_driver(client->driver)) {
708 client->dev.release = i2c_client_release;
709 client->dev.uevent_suppress = 1;
711 client->dev.release = i2c_client_dev_release;
713 snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
714 "%d-%04x", i2c_adapter_id(adapter), client->addr);
715 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
716 client->name, client->dev.bus_id);
717 res = device_register(&client->dev);
720 mutex_unlock(&adapter->clist_lock);
722 if (adapter->client_register) {
723 if (adapter->client_register(client)) {
724 dev_dbg(&adapter->dev, "client_register "
725 "failed for client [%s] at 0x%02x\n",
726 client->name, client->addr);
733 list_del(&client->list);
734 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
735 "(%d)\n", client->name, client->addr, res);
737 mutex_unlock(&adapter->clist_lock);
740 EXPORT_SYMBOL(i2c_attach_client);
742 int i2c_detach_client(struct i2c_client *client)
744 struct i2c_adapter *adapter = client->adapter;
747 if (client->usage_count > 0) {
748 dev_warn(&client->dev, "Client [%s] still busy, "
749 "can't detach\n", client->name);
753 if (adapter->client_unregister) {
754 res = adapter->client_unregister(client);
756 dev_err(&client->dev,
757 "client_unregister [%s] failed, "
758 "client not detached\n", client->name);
763 mutex_lock(&adapter->clist_lock);
764 list_del(&client->list);
765 init_completion(&client->released);
766 device_unregister(&client->dev);
767 mutex_unlock(&adapter->clist_lock);
768 wait_for_completion(&client->released);
773 EXPORT_SYMBOL(i2c_detach_client);
775 static int i2c_inc_use_client(struct i2c_client *client)
778 if (!try_module_get(client->driver->driver.owner))
780 if (!try_module_get(client->adapter->owner)) {
781 module_put(client->driver->driver.owner);
788 static void i2c_dec_use_client(struct i2c_client *client)
790 module_put(client->driver->driver.owner);
791 module_put(client->adapter->owner);
794 int i2c_use_client(struct i2c_client *client)
798 ret = i2c_inc_use_client(client);
802 client->usage_count++;
806 EXPORT_SYMBOL(i2c_use_client);
808 int i2c_release_client(struct i2c_client *client)
810 if (!client->usage_count) {
811 pr_debug("i2c-core: %s used one too many times\n",
816 client->usage_count--;
817 i2c_dec_use_client(client);
821 EXPORT_SYMBOL(i2c_release_client);
823 void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
825 struct list_head *item;
826 struct i2c_client *client;
828 mutex_lock(&adap->clist_lock);
829 list_for_each(item,&adap->clients) {
830 client = list_entry(item, struct i2c_client, list);
831 if (!try_module_get(client->driver->driver.owner))
833 if (NULL != client->driver->command) {
834 mutex_unlock(&adap->clist_lock);
835 client->driver->command(client,cmd,arg);
836 mutex_lock(&adap->clist_lock);
838 module_put(client->driver->driver.owner);
840 mutex_unlock(&adap->clist_lock);
842 EXPORT_SYMBOL(i2c_clients_command);
844 static int __init i2c_init(void)
848 retval = bus_register(&i2c_bus_type);
851 return class_register(&i2c_adapter_class);
854 static void __exit i2c_exit(void)
856 class_unregister(&i2c_adapter_class);
857 bus_unregister(&i2c_bus_type);
860 subsys_initcall(i2c_init);
861 module_exit(i2c_exit);
863 /* ----------------------------------------------------
864 * the functional interface to the i2c busses.
865 * ----------------------------------------------------
868 int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
872 if (adap->algo->master_xfer) {
874 for (ret = 0; ret < num; ret++) {
875 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
876 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
877 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
878 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
882 mutex_lock_nested(&adap->bus_lock, adap->level);
883 ret = adap->algo->master_xfer(adap,msgs,num);
884 mutex_unlock(&adap->bus_lock);
888 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
892 EXPORT_SYMBOL(i2c_transfer);
894 int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
897 struct i2c_adapter *adap=client->adapter;
900 msg.addr = client->addr;
901 msg.flags = client->flags & I2C_M_TEN;
903 msg.buf = (char *)buf;
905 ret = i2c_transfer(adap, &msg, 1);
907 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
908 transmitted, else error code. */
909 return (ret == 1) ? count : ret;
911 EXPORT_SYMBOL(i2c_master_send);
913 int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
915 struct i2c_adapter *adap=client->adapter;
919 msg.addr = client->addr;
920 msg.flags = client->flags & I2C_M_TEN;
921 msg.flags |= I2C_M_RD;
925 ret = i2c_transfer(adap, &msg, 1);
927 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
928 transmitted, else error code. */
929 return (ret == 1) ? count : ret;
931 EXPORT_SYMBOL(i2c_master_recv);
933 /* ----------------------------------------------------
934 * the i2c address scanning function
935 * Will not work for 10-bit addresses!
936 * ----------------------------------------------------
938 static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
939 int (*found_proc) (struct i2c_adapter *, int, int))
943 /* Make sure the address is valid */
944 if (addr < 0x03 || addr > 0x77) {
945 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
950 /* Skip if already in use */
951 if (i2c_check_addr(adapter, addr))
954 /* Make sure there is something at this address, unless forced */
956 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
957 I2C_SMBUS_QUICK, NULL) < 0)
960 /* prevent 24RF08 corruption */
961 if ((addr & ~0x0f) == 0x50)
962 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
963 I2C_SMBUS_QUICK, NULL);
966 /* Finally call the custom detection function */
967 err = found_proc(adapter, addr, kind);
968 /* -ENODEV can be returned if there is a chip at the given address
969 but it isn't supported by this chip driver. We catch it here as
970 this isn't an error. */
975 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
980 int i2c_probe(struct i2c_adapter *adapter,
981 struct i2c_client_address_data *address_data,
982 int (*found_proc) (struct i2c_adapter *, int, int))
985 int adap_id = i2c_adapter_id(adapter);
987 /* Force entries are done first, and are not affected by ignore
989 if (address_data->forces) {
990 unsigned short **forces = address_data->forces;
993 for (kind = 0; forces[kind]; kind++) {
994 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
996 if (forces[kind][i] == adap_id
997 || forces[kind][i] == ANY_I2C_BUS) {
998 dev_dbg(&adapter->dev, "found force "
999 "parameter for adapter %d, "
1000 "addr 0x%02x, kind %d\n",
1001 adap_id, forces[kind][i + 1],
1003 err = i2c_probe_address(adapter,
1004 forces[kind][i + 1],
1013 /* Stop here if we can't use SMBUS_QUICK */
1014 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1015 if (address_data->probe[0] == I2C_CLIENT_END
1016 && address_data->normal_i2c[0] == I2C_CLIENT_END)
1019 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1020 "can't probe for chips\n");
1024 /* Probe entries are done second, and are not affected by ignore
1026 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1027 if (address_data->probe[i] == adap_id
1028 || address_data->probe[i] == ANY_I2C_BUS) {
1029 dev_dbg(&adapter->dev, "found probe parameter for "
1030 "adapter %d, addr 0x%02x\n", adap_id,
1031 address_data->probe[i + 1]);
1032 err = i2c_probe_address(adapter,
1033 address_data->probe[i + 1],
1040 /* Normal entries are done last, unless shadowed by an ignore entry */
1041 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1045 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1047 if ((address_data->ignore[j] == adap_id ||
1048 address_data->ignore[j] == ANY_I2C_BUS)
1049 && address_data->ignore[j + 1]
1050 == address_data->normal_i2c[i]) {
1051 dev_dbg(&adapter->dev, "found ignore "
1052 "parameter for adapter %d, "
1053 "addr 0x%02x\n", adap_id,
1054 address_data->ignore[j + 1]);
1062 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1063 "addr 0x%02x\n", adap_id,
1064 address_data->normal_i2c[i]);
1065 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1073 EXPORT_SYMBOL(i2c_probe);
1076 i2c_new_probed_device(struct i2c_adapter *adap,
1077 struct i2c_board_info *info,
1078 unsigned short const *addr_list)
1082 /* Stop here if the bus doesn't support probing */
1083 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1084 dev_err(&adap->dev, "Probing not supported\n");
1088 mutex_lock(&adap->clist_lock);
1089 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1090 /* Check address validity */
1091 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1092 dev_warn(&adap->dev, "Invalid 7-bit address "
1093 "0x%02x\n", addr_list[i]);
1097 /* Check address availability */
1098 if (__i2c_check_addr(adap, addr_list[i])) {
1099 dev_dbg(&adap->dev, "Address 0x%02x already in "
1100 "use, not probing\n", addr_list[i]);
1104 /* Test address responsiveness
1105 The default probe method is a quick write, but it is known
1106 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1107 and could also irreversibly write-protect some EEPROMs, so
1108 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1109 read instead. Also, some bus drivers don't implement
1110 quick write, so we fallback to a byte read it that case
1112 if ((addr_list[i] & ~0x07) == 0x30
1113 || (addr_list[i] & ~0x0f) == 0x50
1114 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1115 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1117 I2C_SMBUS_BYTE, NULL) >= 0)
1120 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1122 I2C_SMBUS_QUICK, NULL) >= 0)
1126 mutex_unlock(&adap->clist_lock);
1128 if (addr_list[i] == I2C_CLIENT_END) {
1129 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1133 info->addr = addr_list[i];
1134 return i2c_new_device(adap, info);
1136 EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1138 struct i2c_adapter* i2c_get_adapter(int id)
1140 struct i2c_adapter *adapter;
1142 mutex_lock(&core_lists);
1143 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1144 if (adapter && !try_module_get(adapter->owner))
1147 mutex_unlock(&core_lists);
1150 EXPORT_SYMBOL(i2c_get_adapter);
1152 void i2c_put_adapter(struct i2c_adapter *adap)
1154 module_put(adap->owner);
1156 EXPORT_SYMBOL(i2c_put_adapter);
1158 /* The SMBus parts */
1160 #define POLY (0x1070U << 3)
1166 for(i = 0; i < 8; i++) {
1171 return (u8)(data >> 8);
1174 /* Incremental CRC8 over count bytes in the array pointed to by p */
1175 static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1179 for(i = 0; i < count; i++)
1180 crc = crc8((crc ^ p[i]) << 8);
1184 /* Assume a 7-bit address, which is reasonable for SMBus */
1185 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1187 /* The address will be sent first */
1188 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1189 pec = i2c_smbus_pec(pec, &addr, 1);
1191 /* The data buffer follows */
1192 return i2c_smbus_pec(pec, msg->buf, msg->len);
1195 /* Used for write only transactions */
1196 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1198 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1202 /* Return <0 on CRC error
1203 If there was a write before this read (most cases) we need to take the
1204 partial CRC from the write part into account.
1205 Note that this function does modify the message (we need to decrease the
1206 message length to hide the CRC byte from the caller). */
1207 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1209 u8 rpec = msg->buf[--msg->len];
1210 cpec = i2c_smbus_msg_pec(cpec, msg);
1213 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1220 s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
1222 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1223 value,0,I2C_SMBUS_QUICK,NULL);
1225 EXPORT_SYMBOL(i2c_smbus_write_quick);
1227 s32 i2c_smbus_read_byte(struct i2c_client *client)
1229 union i2c_smbus_data data;
1230 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1231 I2C_SMBUS_READ,0,I2C_SMBUS_BYTE, &data))
1236 EXPORT_SYMBOL(i2c_smbus_read_byte);
1238 s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1240 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1241 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1243 EXPORT_SYMBOL(i2c_smbus_write_byte);
1245 s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1247 union i2c_smbus_data data;
1248 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1249 I2C_SMBUS_READ,command, I2C_SMBUS_BYTE_DATA,&data))
1254 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1256 s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1258 union i2c_smbus_data data;
1260 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1261 I2C_SMBUS_WRITE,command,
1262 I2C_SMBUS_BYTE_DATA,&data);
1264 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1266 s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1268 union i2c_smbus_data data;
1269 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1270 I2C_SMBUS_READ,command, I2C_SMBUS_WORD_DATA, &data))
1275 EXPORT_SYMBOL(i2c_smbus_read_word_data);
1277 s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1279 union i2c_smbus_data data;
1281 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1282 I2C_SMBUS_WRITE,command,
1283 I2C_SMBUS_WORD_DATA,&data);
1285 EXPORT_SYMBOL(i2c_smbus_write_word_data);
1288 * i2c_smbus_read_block_data - SMBus block read request
1289 * @client: Handle to slave device
1290 * @command: Command byte issued to let the slave know what data should
1292 * @values: Byte array into which data will be read; big enough to hold
1293 * the data returned by the slave. SMBus allows at most 32 bytes.
1295 * Returns the number of bytes read in the slave's response, else a
1296 * negative number to indicate some kind of error.
1298 * Note that using this function requires that the client's adapter support
1299 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1300 * support this; its emulation through I2C messaging relies on a specific
1301 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1303 s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1306 union i2c_smbus_data data;
1308 if (i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1309 I2C_SMBUS_READ, command,
1310 I2C_SMBUS_BLOCK_DATA, &data))
1313 memcpy(values, &data.block[1], data.block[0]);
1314 return data.block[0];
1316 EXPORT_SYMBOL(i2c_smbus_read_block_data);
1318 s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1319 u8 length, const u8 *values)
1321 union i2c_smbus_data data;
1323 if (length > I2C_SMBUS_BLOCK_MAX)
1324 length = I2C_SMBUS_BLOCK_MAX;
1325 data.block[0] = length;
1326 memcpy(&data.block[1], values, length);
1327 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1328 I2C_SMBUS_WRITE,command,
1329 I2C_SMBUS_BLOCK_DATA,&data);
1331 EXPORT_SYMBOL(i2c_smbus_write_block_data);
1333 /* Returns the number of read bytes */
1334 s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1335 u8 length, u8 *values)
1337 union i2c_smbus_data data;
1339 if (length > I2C_SMBUS_BLOCK_MAX)
1340 length = I2C_SMBUS_BLOCK_MAX;
1341 data.block[0] = length;
1342 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1343 I2C_SMBUS_READ,command,
1344 I2C_SMBUS_I2C_BLOCK_DATA,&data))
1347 memcpy(values, &data.block[1], data.block[0]);
1348 return data.block[0];
1350 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1352 s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1353 u8 length, const u8 *values)
1355 union i2c_smbus_data data;
1357 if (length > I2C_SMBUS_BLOCK_MAX)
1358 length = I2C_SMBUS_BLOCK_MAX;
1359 data.block[0] = length;
1360 memcpy(data.block + 1, values, length);
1361 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1362 I2C_SMBUS_WRITE, command,
1363 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1365 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1367 /* Simulate a SMBus command using the i2c protocol
1368 No checking of parameters is done! */
1369 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
1370 unsigned short flags,
1371 char read_write, u8 command, int size,
1372 union i2c_smbus_data * data)
1374 /* So we need to generate a series of msgs. In the case of writing, we
1375 need to use only one message; when reading, we need two. We initialize
1376 most things with sane defaults, to keep the code below somewhat
1378 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1379 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1380 int num = read_write == I2C_SMBUS_READ?2:1;
1381 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1382 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1387 msgbuf0[0] = command;
1389 case I2C_SMBUS_QUICK:
1391 /* Special case: The read/write field is used as data */
1392 msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
1395 case I2C_SMBUS_BYTE:
1396 if (read_write == I2C_SMBUS_READ) {
1397 /* Special case: only a read! */
1398 msg[0].flags = I2C_M_RD | flags;
1402 case I2C_SMBUS_BYTE_DATA:
1403 if (read_write == I2C_SMBUS_READ)
1407 msgbuf0[1] = data->byte;
1410 case I2C_SMBUS_WORD_DATA:
1411 if (read_write == I2C_SMBUS_READ)
1415 msgbuf0[1] = data->word & 0xff;
1416 msgbuf0[2] = data->word >> 8;
1419 case I2C_SMBUS_PROC_CALL:
1420 num = 2; /* Special case */
1421 read_write = I2C_SMBUS_READ;
1424 msgbuf0[1] = data->word & 0xff;
1425 msgbuf0[2] = data->word >> 8;
1427 case I2C_SMBUS_BLOCK_DATA:
1428 if (read_write == I2C_SMBUS_READ) {
1429 msg[1].flags |= I2C_M_RECV_LEN;
1430 msg[1].len = 1; /* block length will be added by
1431 the underlying bus driver */
1433 msg[0].len = data->block[0] + 2;
1434 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1435 dev_err(&adapter->dev, "smbus_access called with "
1436 "invalid block write size (%d)\n",
1440 for (i = 1; i < msg[0].len; i++)
1441 msgbuf0[i] = data->block[i-1];
1444 case I2C_SMBUS_BLOCK_PROC_CALL:
1445 num = 2; /* Another special case */
1446 read_write = I2C_SMBUS_READ;
1447 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1448 dev_err(&adapter->dev, "%s called with invalid "
1449 "block proc call size (%d)\n", __FUNCTION__,
1453 msg[0].len = data->block[0] + 2;
1454 for (i = 1; i < msg[0].len; i++)
1455 msgbuf0[i] = data->block[i-1];
1456 msg[1].flags |= I2C_M_RECV_LEN;
1457 msg[1].len = 1; /* block length will be added by
1458 the underlying bus driver */
1460 case I2C_SMBUS_I2C_BLOCK_DATA:
1461 if (read_write == I2C_SMBUS_READ) {
1462 msg[1].len = data->block[0];
1464 msg[0].len = data->block[0] + 1;
1465 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
1466 dev_err(&adapter->dev, "i2c_smbus_xfer_emulated called with "
1467 "invalid block write size (%d)\n",
1471 for (i = 1; i <= data->block[0]; i++)
1472 msgbuf0[i] = data->block[i];
1476 dev_err(&adapter->dev, "smbus_access called with invalid size (%d)\n",
1481 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1482 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1484 /* Compute PEC if first message is a write */
1485 if (!(msg[0].flags & I2C_M_RD)) {
1486 if (num == 1) /* Write only */
1487 i2c_smbus_add_pec(&msg[0]);
1488 else /* Write followed by read */
1489 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1491 /* Ask for PEC if last message is a read */
1492 if (msg[num-1].flags & I2C_M_RD)
1496 if (i2c_transfer(adapter, msg, num) < 0)
1499 /* Check PEC if last message is a read */
1500 if (i && (msg[num-1].flags & I2C_M_RD)) {
1501 if (i2c_smbus_check_pec(partial_pec, &msg[num-1]) < 0)
1505 if (read_write == I2C_SMBUS_READ)
1507 case I2C_SMBUS_BYTE:
1508 data->byte = msgbuf0[0];
1510 case I2C_SMBUS_BYTE_DATA:
1511 data->byte = msgbuf1[0];
1513 case I2C_SMBUS_WORD_DATA:
1514 case I2C_SMBUS_PROC_CALL:
1515 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1517 case I2C_SMBUS_I2C_BLOCK_DATA:
1518 for (i = 0; i < data->block[0]; i++)
1519 data->block[i+1] = msgbuf1[i];
1521 case I2C_SMBUS_BLOCK_DATA:
1522 case I2C_SMBUS_BLOCK_PROC_CALL:
1523 for (i = 0; i < msgbuf1[0] + 1; i++)
1524 data->block[i] = msgbuf1[i];
1531 s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
1532 char read_write, u8 command, int size,
1533 union i2c_smbus_data * data)
1537 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
1539 if (adapter->algo->smbus_xfer) {
1540 mutex_lock(&adapter->bus_lock);
1541 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
1543 mutex_unlock(&adapter->bus_lock);
1545 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
1550 EXPORT_SYMBOL(i2c_smbus_xfer);
1552 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1553 MODULE_DESCRIPTION("I2C-Bus main module");
1554 MODULE_LICENSE("GPL");