1 /* i2c-core.c - a device driver for the iic-bus interface */
2 /* ------------------------------------------------------------------------- */
3 /* Copyright (C) 1995-99 Simon G. Vogl
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
18 /* ------------------------------------------------------------------------- */
20 /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
21 All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
22 SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
23 Jean Delvare <khali@linux-fr.org> */
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/errno.h>
28 #include <linux/slab.h>
29 #include <linux/i2c.h>
30 #include <linux/init.h>
31 #include <linux/idr.h>
32 #include <linux/mutex.h>
33 #include <linux/completion.h>
34 #include <linux/hardirq.h>
35 #include <linux/irqflags.h>
36 #include <linux/rwsem.h>
37 #include <linux/pm_runtime.h>
38 #include <asm/uaccess.h>
43 /* core_lock protects i2c_adapter_idr, and guarantees
44 that device detection, deletion of detected devices, and attach_adapter
45 and detach_adapter calls are serialized */
46 static DEFINE_MUTEX(core_lock
);
47 static DEFINE_IDR(i2c_adapter_idr
);
49 static struct device_type i2c_client_type
;
50 static int i2c_check_addr(struct i2c_adapter
*adapter
, int addr
);
51 static int i2c_detect(struct i2c_adapter
*adapter
, struct i2c_driver
*driver
);
53 /* ------------------------------------------------------------------------- */
55 static const struct i2c_device_id
*i2c_match_id(const struct i2c_device_id
*id
,
56 const struct i2c_client
*client
)
59 if (strcmp(client
->name
, id
->name
) == 0)
66 static int i2c_device_match(struct device
*dev
, struct device_driver
*drv
)
68 struct i2c_client
*client
= i2c_verify_client(dev
);
69 struct i2c_driver
*driver
;
74 driver
= to_i2c_driver(drv
);
75 /* match on an id table if there is one */
77 return i2c_match_id(driver
->id_table
, client
) != NULL
;
84 /* uevent helps with hotplug: modprobe -q $(MODALIAS) */
85 static int i2c_device_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
87 struct i2c_client
*client
= to_i2c_client(dev
);
89 if (add_uevent_var(env
, "MODALIAS=%s%s",
90 I2C_MODULE_PREFIX
, client
->name
))
92 dev_dbg(dev
, "uevent\n");
97 #define i2c_device_uevent NULL
98 #endif /* CONFIG_HOTPLUG */
100 static int i2c_device_probe(struct device
*dev
)
102 struct i2c_client
*client
= i2c_verify_client(dev
);
103 struct i2c_driver
*driver
;
109 driver
= to_i2c_driver(dev
->driver
);
110 if (!driver
->probe
|| !driver
->id_table
)
112 client
->driver
= driver
;
113 if (!device_can_wakeup(&client
->dev
))
114 device_init_wakeup(&client
->dev
,
115 client
->flags
& I2C_CLIENT_WAKE
);
116 dev_dbg(dev
, "probe\n");
118 status
= driver
->probe(client
, i2c_match_id(driver
->id_table
, client
));
120 client
->driver
= NULL
;
121 i2c_set_clientdata(client
, NULL
);
126 static int i2c_device_remove(struct device
*dev
)
128 struct i2c_client
*client
= i2c_verify_client(dev
);
129 struct i2c_driver
*driver
;
132 if (!client
|| !dev
->driver
)
135 driver
= to_i2c_driver(dev
->driver
);
136 if (driver
->remove
) {
137 dev_dbg(dev
, "remove\n");
138 status
= driver
->remove(client
);
144 client
->driver
= NULL
;
145 i2c_set_clientdata(client
, NULL
);
150 static void i2c_device_shutdown(struct device
*dev
)
152 struct i2c_client
*client
= i2c_verify_client(dev
);
153 struct i2c_driver
*driver
;
155 if (!client
|| !dev
->driver
)
157 driver
= to_i2c_driver(dev
->driver
);
158 if (driver
->shutdown
)
159 driver
->shutdown(client
);
162 #ifdef CONFIG_PM_SLEEP
163 static int i2c_legacy_suspend(struct device
*dev
, pm_message_t mesg
)
165 struct i2c_client
*client
= i2c_verify_client(dev
);
166 struct i2c_driver
*driver
;
168 if (!client
|| !dev
->driver
)
170 driver
= to_i2c_driver(dev
->driver
);
171 if (!driver
->suspend
)
173 return driver
->suspend(client
, mesg
);
176 static int i2c_legacy_resume(struct device
*dev
)
178 struct i2c_client
*client
= i2c_verify_client(dev
);
179 struct i2c_driver
*driver
;
181 if (!client
|| !dev
->driver
)
183 driver
= to_i2c_driver(dev
->driver
);
186 return driver
->resume(client
);
189 static int i2c_device_pm_suspend(struct device
*dev
)
191 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
193 if (pm_runtime_suspended(dev
))
197 return pm
->suspend
? pm
->suspend(dev
) : 0;
199 return i2c_legacy_suspend(dev
, PMSG_SUSPEND
);
202 static int i2c_device_pm_resume(struct device
*dev
)
204 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
208 ret
= pm
->resume
? pm
->resume(dev
) : 0;
210 ret
= i2c_legacy_resume(dev
);
213 pm_runtime_disable(dev
);
214 pm_runtime_set_active(dev
);
215 pm_runtime_enable(dev
);
221 static int i2c_device_pm_freeze(struct device
*dev
)
223 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
225 if (pm_runtime_suspended(dev
))
229 return pm
->freeze
? pm
->freeze(dev
) : 0;
231 return i2c_legacy_suspend(dev
, PMSG_FREEZE
);
234 static int i2c_device_pm_thaw(struct device
*dev
)
236 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
238 if (pm_runtime_suspended(dev
))
242 return pm
->thaw
? pm
->thaw(dev
) : 0;
244 return i2c_legacy_resume(dev
);
247 static int i2c_device_pm_poweroff(struct device
*dev
)
249 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
251 if (pm_runtime_suspended(dev
))
255 return pm
->poweroff
? pm
->poweroff(dev
) : 0;
257 return i2c_legacy_suspend(dev
, PMSG_HIBERNATE
);
260 static int i2c_device_pm_restore(struct device
*dev
)
262 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
266 ret
= pm
->restore
? pm
->restore(dev
) : 0;
268 ret
= i2c_legacy_resume(dev
);
271 pm_runtime_disable(dev
);
272 pm_runtime_set_active(dev
);
273 pm_runtime_enable(dev
);
278 #else /* !CONFIG_PM_SLEEP */
279 #define i2c_device_pm_suspend NULL
280 #define i2c_device_pm_resume NULL
281 #define i2c_device_pm_freeze NULL
282 #define i2c_device_pm_thaw NULL
283 #define i2c_device_pm_poweroff NULL
284 #define i2c_device_pm_restore NULL
285 #endif /* !CONFIG_PM_SLEEP */
287 static void i2c_client_dev_release(struct device
*dev
)
289 kfree(to_i2c_client(dev
));
293 show_name(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
295 return sprintf(buf
, "%s\n", dev
->type
== &i2c_client_type
?
296 to_i2c_client(dev
)->name
: to_i2c_adapter(dev
)->name
);
300 show_modalias(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
302 struct i2c_client
*client
= to_i2c_client(dev
);
303 return sprintf(buf
, "%s%s\n", I2C_MODULE_PREFIX
, client
->name
);
306 static DEVICE_ATTR(name
, S_IRUGO
, show_name
, NULL
);
307 static DEVICE_ATTR(modalias
, S_IRUGO
, show_modalias
, NULL
);
309 static struct attribute
*i2c_dev_attrs
[] = {
311 /* modalias helps coldplug: modprobe $(cat .../modalias) */
312 &dev_attr_modalias
.attr
,
316 static struct attribute_group i2c_dev_attr_group
= {
317 .attrs
= i2c_dev_attrs
,
320 static const struct attribute_group
*i2c_dev_attr_groups
[] = {
325 static const struct dev_pm_ops i2c_device_pm_ops
= {
326 .suspend
= i2c_device_pm_suspend
,
327 .resume
= i2c_device_pm_resume
,
328 .freeze
= i2c_device_pm_freeze
,
329 .thaw
= i2c_device_pm_thaw
,
330 .poweroff
= i2c_device_pm_poweroff
,
331 .restore
= i2c_device_pm_restore
,
333 pm_generic_runtime_suspend
,
334 pm_generic_runtime_resume
,
335 pm_generic_runtime_idle
339 struct bus_type i2c_bus_type
= {
341 .match
= i2c_device_match
,
342 .probe
= i2c_device_probe
,
343 .remove
= i2c_device_remove
,
344 .shutdown
= i2c_device_shutdown
,
345 .pm
= &i2c_device_pm_ops
,
347 EXPORT_SYMBOL_GPL(i2c_bus_type
);
349 static struct device_type i2c_client_type
= {
350 .groups
= i2c_dev_attr_groups
,
351 .uevent
= i2c_device_uevent
,
352 .release
= i2c_client_dev_release
,
357 * i2c_verify_client - return parameter as i2c_client, or NULL
358 * @dev: device, probably from some driver model iterator
360 * When traversing the driver model tree, perhaps using driver model
361 * iterators like @device_for_each_child(), you can't assume very much
362 * about the nodes you find. Use this function to avoid oopses caused
363 * by wrongly treating some non-I2C device as an i2c_client.
365 struct i2c_client
*i2c_verify_client(struct device
*dev
)
367 return (dev
->type
== &i2c_client_type
)
371 EXPORT_SYMBOL(i2c_verify_client
);
375 * i2c_new_device - instantiate an i2c device
376 * @adap: the adapter managing the device
377 * @info: describes one I2C device; bus_num is ignored
380 * Create an i2c device. Binding is handled through driver model
381 * probe()/remove() methods. A driver may be bound to this device when we
382 * return from this function, or any later moment (e.g. maybe hotplugging will
383 * load the driver module). This call is not appropriate for use by mainboard
384 * initialization logic, which usually runs during an arch_initcall() long
385 * before any i2c_adapter could exist.
387 * This returns the new i2c client, which may be saved for later use with
388 * i2c_unregister_device(); or NULL to indicate an error.
391 i2c_new_device(struct i2c_adapter
*adap
, struct i2c_board_info
const *info
)
393 struct i2c_client
*client
;
396 client
= kzalloc(sizeof *client
, GFP_KERNEL
);
400 client
->adapter
= adap
;
402 client
->dev
.platform_data
= info
->platform_data
;
405 client
->dev
.archdata
= *info
->archdata
;
407 client
->flags
= info
->flags
;
408 client
->addr
= info
->addr
;
409 client
->irq
= info
->irq
;
411 strlcpy(client
->name
, info
->type
, sizeof(client
->name
));
413 /* Check for address business */
414 status
= i2c_check_addr(adap
, client
->addr
);
418 client
->dev
.parent
= &client
->adapter
->dev
;
419 client
->dev
.bus
= &i2c_bus_type
;
420 client
->dev
.type
= &i2c_client_type
;
422 dev_set_name(&client
->dev
, "%d-%04x", i2c_adapter_id(adap
),
424 status
= device_register(&client
->dev
);
428 dev_dbg(&adap
->dev
, "client [%s] registered with bus id %s\n",
429 client
->name
, dev_name(&client
->dev
));
434 dev_err(&adap
->dev
, "Failed to register i2c client %s at 0x%02x "
435 "(%d)\n", client
->name
, client
->addr
, status
);
439 EXPORT_SYMBOL_GPL(i2c_new_device
);
443 * i2c_unregister_device - reverse effect of i2c_new_device()
444 * @client: value returned from i2c_new_device()
447 void i2c_unregister_device(struct i2c_client
*client
)
449 device_unregister(&client
->dev
);
451 EXPORT_SYMBOL_GPL(i2c_unregister_device
);
454 static const struct i2c_device_id dummy_id
[] = {
459 static int dummy_probe(struct i2c_client
*client
,
460 const struct i2c_device_id
*id
)
465 static int dummy_remove(struct i2c_client
*client
)
470 static struct i2c_driver dummy_driver
= {
471 .driver
.name
= "dummy",
472 .probe
= dummy_probe
,
473 .remove
= dummy_remove
,
474 .id_table
= dummy_id
,
478 * i2c_new_dummy - return a new i2c device bound to a dummy driver
479 * @adapter: the adapter managing the device
480 * @address: seven bit address to be used
483 * This returns an I2C client bound to the "dummy" driver, intended for use
484 * with devices that consume multiple addresses. Examples of such chips
485 * include various EEPROMS (like 24c04 and 24c08 models).
487 * These dummy devices have two main uses. First, most I2C and SMBus calls
488 * except i2c_transfer() need a client handle; the dummy will be that handle.
489 * And second, this prevents the specified address from being bound to a
492 * This returns the new i2c client, which should be saved for later use with
493 * i2c_unregister_device(); or NULL to indicate an error.
495 struct i2c_client
*i2c_new_dummy(struct i2c_adapter
*adapter
, u16 address
)
497 struct i2c_board_info info
= {
498 I2C_BOARD_INFO("dummy", address
),
501 return i2c_new_device(adapter
, &info
);
503 EXPORT_SYMBOL_GPL(i2c_new_dummy
);
505 /* ------------------------------------------------------------------------- */
507 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
509 static void i2c_adapter_dev_release(struct device
*dev
)
511 struct i2c_adapter
*adap
= to_i2c_adapter(dev
);
512 complete(&adap
->dev_released
);
516 * Let users instantiate I2C devices through sysfs. This can be used when
517 * platform initialization code doesn't contain the proper data for
518 * whatever reason. Also useful for drivers that do device detection and
519 * detection fails, either because the device uses an unexpected address,
520 * or this is a compatible device with different ID register values.
522 * Parameter checking may look overzealous, but we really don't want
523 * the user to provide incorrect parameters.
526 i2c_sysfs_new_device(struct device
*dev
, struct device_attribute
*attr
,
527 const char *buf
, size_t count
)
529 struct i2c_adapter
*adap
= to_i2c_adapter(dev
);
530 struct i2c_board_info info
;
531 struct i2c_client
*client
;
535 dev_warn(dev
, "The new_device interface is still experimental "
536 "and may change in a near future\n");
537 memset(&info
, 0, sizeof(struct i2c_board_info
));
539 blank
= strchr(buf
, ' ');
541 dev_err(dev
, "%s: Missing parameters\n", "new_device");
544 if (blank
- buf
> I2C_NAME_SIZE
- 1) {
545 dev_err(dev
, "%s: Invalid device name\n", "new_device");
548 memcpy(info
.type
, buf
, blank
- buf
);
550 /* Parse remaining parameters, reject extra parameters */
551 res
= sscanf(++blank
, "%hi%c", &info
.addr
, &end
);
553 dev_err(dev
, "%s: Can't parse I2C address\n", "new_device");
556 if (res
> 1 && end
!= '\n') {
557 dev_err(dev
, "%s: Extra parameters\n", "new_device");
561 if (info
.addr
< 0x03 || info
.addr
> 0x77) {
562 dev_err(dev
, "%s: Invalid I2C address 0x%hx\n", "new_device",
567 client
= i2c_new_device(adap
, &info
);
571 /* Keep track of the added device */
572 i2c_lock_adapter(adap
);
573 list_add_tail(&client
->detected
, &adap
->userspace_clients
);
574 i2c_unlock_adapter(adap
);
575 dev_info(dev
, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
576 info
.type
, info
.addr
);
582 * And of course let the users delete the devices they instantiated, if
583 * they got it wrong. This interface can only be used to delete devices
584 * instantiated by i2c_sysfs_new_device above. This guarantees that we
585 * don't delete devices to which some kernel code still has references.
587 * Parameter checking may look overzealous, but we really don't want
588 * the user to delete the wrong device.
591 i2c_sysfs_delete_device(struct device
*dev
, struct device_attribute
*attr
,
592 const char *buf
, size_t count
)
594 struct i2c_adapter
*adap
= to_i2c_adapter(dev
);
595 struct i2c_client
*client
, *next
;
600 /* Parse parameters, reject extra parameters */
601 res
= sscanf(buf
, "%hi%c", &addr
, &end
);
603 dev_err(dev
, "%s: Can't parse I2C address\n", "delete_device");
606 if (res
> 1 && end
!= '\n') {
607 dev_err(dev
, "%s: Extra parameters\n", "delete_device");
611 /* Make sure the device was added through sysfs */
613 i2c_lock_adapter(adap
);
614 list_for_each_entry_safe(client
, next
, &adap
->userspace_clients
,
616 if (client
->addr
== addr
) {
617 dev_info(dev
, "%s: Deleting device %s at 0x%02hx\n",
618 "delete_device", client
->name
, client
->addr
);
620 list_del(&client
->detected
);
621 i2c_unregister_device(client
);
626 i2c_unlock_adapter(adap
);
629 dev_err(dev
, "%s: Can't find device in list\n",
634 static DEVICE_ATTR(new_device
, S_IWUSR
, NULL
, i2c_sysfs_new_device
);
635 static DEVICE_ATTR(delete_device
, S_IWUSR
, NULL
, i2c_sysfs_delete_device
);
637 static struct attribute
*i2c_adapter_attrs
[] = {
639 &dev_attr_new_device
.attr
,
640 &dev_attr_delete_device
.attr
,
644 static struct attribute_group i2c_adapter_attr_group
= {
645 .attrs
= i2c_adapter_attrs
,
648 static const struct attribute_group
*i2c_adapter_attr_groups
[] = {
649 &i2c_adapter_attr_group
,
653 static struct device_type i2c_adapter_type
= {
654 .groups
= i2c_adapter_attr_groups
,
655 .release
= i2c_adapter_dev_release
,
658 #ifdef CONFIG_I2C_COMPAT
659 static struct class_compat
*i2c_adapter_compat_class
;
662 static void i2c_scan_static_board_info(struct i2c_adapter
*adapter
)
664 struct i2c_devinfo
*devinfo
;
666 down_read(&__i2c_board_lock
);
667 list_for_each_entry(devinfo
, &__i2c_board_list
, list
) {
668 if (devinfo
->busnum
== adapter
->nr
669 && !i2c_new_device(adapter
,
670 &devinfo
->board_info
))
671 dev_err(&adapter
->dev
,
672 "Can't create device at 0x%02x\n",
673 devinfo
->board_info
.addr
);
675 up_read(&__i2c_board_lock
);
678 static int i2c_do_add_adapter(struct i2c_driver
*driver
,
679 struct i2c_adapter
*adap
)
681 /* Detect supported devices on that bus, and instantiate them */
682 i2c_detect(adap
, driver
);
684 /* Let legacy drivers scan this bus for matching devices */
685 if (driver
->attach_adapter
) {
686 /* We ignore the return code; if it fails, too bad */
687 driver
->attach_adapter(adap
);
692 static int __process_new_adapter(struct device_driver
*d
, void *data
)
694 return i2c_do_add_adapter(to_i2c_driver(d
), data
);
697 static int i2c_register_adapter(struct i2c_adapter
*adap
)
701 /* Can't register until after driver model init */
702 if (unlikely(WARN_ON(!i2c_bus_type
.p
))) {
707 rt_mutex_init(&adap
->bus_lock
);
708 INIT_LIST_HEAD(&adap
->userspace_clients
);
710 /* Set default timeout to 1 second if not already set */
711 if (adap
->timeout
== 0)
714 dev_set_name(&adap
->dev
, "i2c-%d", adap
->nr
);
715 adap
->dev
.bus
= &i2c_bus_type
;
716 adap
->dev
.type
= &i2c_adapter_type
;
717 res
= device_register(&adap
->dev
);
721 dev_dbg(&adap
->dev
, "adapter [%s] registered\n", adap
->name
);
723 #ifdef CONFIG_I2C_COMPAT
724 res
= class_compat_create_link(i2c_adapter_compat_class
, &adap
->dev
,
728 "Failed to create compatibility class link\n");
731 /* create pre-declared device nodes */
732 if (adap
->nr
< __i2c_first_dynamic_bus_num
)
733 i2c_scan_static_board_info(adap
);
736 mutex_lock(&core_lock
);
737 dummy
= bus_for_each_drv(&i2c_bus_type
, NULL
, adap
,
738 __process_new_adapter
);
739 mutex_unlock(&core_lock
);
744 mutex_lock(&core_lock
);
745 idr_remove(&i2c_adapter_idr
, adap
->nr
);
746 mutex_unlock(&core_lock
);
751 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
752 * @adapter: the adapter to add
755 * This routine is used to declare an I2C adapter when its bus number
756 * doesn't matter. Examples: for I2C adapters dynamically added by
757 * USB links or PCI plugin cards.
759 * When this returns zero, a new bus number was allocated and stored
760 * in adap->nr, and the specified adapter became available for clients.
761 * Otherwise, a negative errno value is returned.
763 int i2c_add_adapter(struct i2c_adapter
*adapter
)
768 if (idr_pre_get(&i2c_adapter_idr
, GFP_KERNEL
) == 0)
771 mutex_lock(&core_lock
);
772 /* "above" here means "above or equal to", sigh */
773 res
= idr_get_new_above(&i2c_adapter_idr
, adapter
,
774 __i2c_first_dynamic_bus_num
, &id
);
775 mutex_unlock(&core_lock
);
784 return i2c_register_adapter(adapter
);
786 EXPORT_SYMBOL(i2c_add_adapter
);
789 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
790 * @adap: the adapter to register (with adap->nr initialized)
793 * This routine is used to declare an I2C adapter when its bus number
794 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
795 * or otherwise built in to the system's mainboard, and where i2c_board_info
796 * is used to properly configure I2C devices.
798 * If no devices have pre-been declared for this bus, then be sure to
799 * register the adapter before any dynamically allocated ones. Otherwise
800 * the required bus ID may not be available.
802 * When this returns zero, the specified adapter became available for
803 * clients using the bus number provided in adap->nr. Also, the table
804 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
805 * and the appropriate driver model device nodes are created. Otherwise, a
806 * negative errno value is returned.
808 int i2c_add_numbered_adapter(struct i2c_adapter
*adap
)
813 if (adap
->nr
& ~MAX_ID_MASK
)
817 if (idr_pre_get(&i2c_adapter_idr
, GFP_KERNEL
) == 0)
820 mutex_lock(&core_lock
);
821 /* "above" here means "above or equal to", sigh;
822 * we need the "equal to" result to force the result
824 status
= idr_get_new_above(&i2c_adapter_idr
, adap
, adap
->nr
, &id
);
825 if (status
== 0 && id
!= adap
->nr
) {
827 idr_remove(&i2c_adapter_idr
, id
);
829 mutex_unlock(&core_lock
);
830 if (status
== -EAGAIN
)
834 status
= i2c_register_adapter(adap
);
837 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter
);
839 static int i2c_do_del_adapter(struct i2c_driver
*driver
,
840 struct i2c_adapter
*adapter
)
842 struct i2c_client
*client
, *_n
;
845 /* Remove the devices we created ourselves as the result of hardware
846 * probing (using a driver's detect method) */
847 list_for_each_entry_safe(client
, _n
, &driver
->clients
, detected
) {
848 if (client
->adapter
== adapter
) {
849 dev_dbg(&adapter
->dev
, "Removing %s at 0x%x\n",
850 client
->name
, client
->addr
);
851 list_del(&client
->detected
);
852 i2c_unregister_device(client
);
856 if (!driver
->detach_adapter
)
858 res
= driver
->detach_adapter(adapter
);
860 dev_err(&adapter
->dev
, "detach_adapter failed (%d) "
861 "for driver [%s]\n", res
, driver
->driver
.name
);
865 static int __unregister_client(struct device
*dev
, void *dummy
)
867 struct i2c_client
*client
= i2c_verify_client(dev
);
869 i2c_unregister_device(client
);
873 static int __process_removed_adapter(struct device_driver
*d
, void *data
)
875 return i2c_do_del_adapter(to_i2c_driver(d
), data
);
879 * i2c_del_adapter - unregister I2C adapter
880 * @adap: the adapter being unregistered
883 * This unregisters an I2C adapter which was previously registered
884 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
886 int i2c_del_adapter(struct i2c_adapter
*adap
)
889 struct i2c_adapter
*found
;
890 struct i2c_client
*client
, *next
;
892 /* First make sure that this adapter was ever added */
893 mutex_lock(&core_lock
);
894 found
= idr_find(&i2c_adapter_idr
, adap
->nr
);
895 mutex_unlock(&core_lock
);
897 pr_debug("i2c-core: attempting to delete unregistered "
898 "adapter [%s]\n", adap
->name
);
902 /* Tell drivers about this removal */
903 mutex_lock(&core_lock
);
904 res
= bus_for_each_drv(&i2c_bus_type
, NULL
, adap
,
905 __process_removed_adapter
);
906 mutex_unlock(&core_lock
);
910 /* Remove devices instantiated from sysfs */
911 i2c_lock_adapter(adap
);
912 list_for_each_entry_safe(client
, next
, &adap
->userspace_clients
,
914 dev_dbg(&adap
->dev
, "Removing %s at 0x%x\n", client
->name
,
916 list_del(&client
->detected
);
917 i2c_unregister_device(client
);
919 i2c_unlock_adapter(adap
);
921 /* Detach any active clients. This can't fail, thus we do not
922 checking the returned value. */
923 res
= device_for_each_child(&adap
->dev
, NULL
, __unregister_client
);
925 #ifdef CONFIG_I2C_COMPAT
926 class_compat_remove_link(i2c_adapter_compat_class
, &adap
->dev
,
930 /* device name is gone after device_unregister */
931 dev_dbg(&adap
->dev
, "adapter [%s] unregistered\n", adap
->name
);
933 /* clean up the sysfs representation */
934 init_completion(&adap
->dev_released
);
935 device_unregister(&adap
->dev
);
937 /* wait for sysfs to drop all references */
938 wait_for_completion(&adap
->dev_released
);
941 mutex_lock(&core_lock
);
942 idr_remove(&i2c_adapter_idr
, adap
->nr
);
943 mutex_unlock(&core_lock
);
945 /* Clear the device structure in case this adapter is ever going to be
947 memset(&adap
->dev
, 0, sizeof(adap
->dev
));
951 EXPORT_SYMBOL(i2c_del_adapter
);
954 /* ------------------------------------------------------------------------- */
956 static int __process_new_driver(struct device
*dev
, void *data
)
958 if (dev
->type
!= &i2c_adapter_type
)
960 return i2c_do_add_adapter(data
, to_i2c_adapter(dev
));
964 * An i2c_driver is used with one or more i2c_client (device) nodes to access
965 * i2c slave chips, on a bus instance associated with some i2c_adapter.
968 int i2c_register_driver(struct module
*owner
, struct i2c_driver
*driver
)
972 /* Can't register until after driver model init */
973 if (unlikely(WARN_ON(!i2c_bus_type
.p
)))
976 /* add the driver to the list of i2c drivers in the driver core */
977 driver
->driver
.owner
= owner
;
978 driver
->driver
.bus
= &i2c_bus_type
;
980 /* When registration returns, the driver core
981 * will have called probe() for all matching-but-unbound devices.
983 res
= driver_register(&driver
->driver
);
987 pr_debug("i2c-core: driver [%s] registered\n", driver
->driver
.name
);
989 INIT_LIST_HEAD(&driver
->clients
);
990 /* Walk the adapters that are already present */
991 mutex_lock(&core_lock
);
992 bus_for_each_dev(&i2c_bus_type
, NULL
, driver
, __process_new_driver
);
993 mutex_unlock(&core_lock
);
997 EXPORT_SYMBOL(i2c_register_driver
);
999 static int __process_removed_driver(struct device
*dev
, void *data
)
1001 if (dev
->type
!= &i2c_adapter_type
)
1003 return i2c_do_del_adapter(data
, to_i2c_adapter(dev
));
1007 * i2c_del_driver - unregister I2C driver
1008 * @driver: the driver being unregistered
1009 * Context: can sleep
1011 void i2c_del_driver(struct i2c_driver
*driver
)
1013 mutex_lock(&core_lock
);
1014 bus_for_each_dev(&i2c_bus_type
, NULL
, driver
, __process_removed_driver
);
1015 mutex_unlock(&core_lock
);
1017 driver_unregister(&driver
->driver
);
1018 pr_debug("i2c-core: driver [%s] unregistered\n", driver
->driver
.name
);
1020 EXPORT_SYMBOL(i2c_del_driver
);
1022 /* ------------------------------------------------------------------------- */
1024 static int __i2c_check_addr(struct device
*dev
, void *addrp
)
1026 struct i2c_client
*client
= i2c_verify_client(dev
);
1027 int addr
= *(int *)addrp
;
1029 if (client
&& client
->addr
== addr
)
1034 static int i2c_check_addr(struct i2c_adapter
*adapter
, int addr
)
1036 return device_for_each_child(&adapter
->dev
, &addr
, __i2c_check_addr
);
1040 * i2c_use_client - increments the reference count of the i2c client structure
1041 * @client: the client being referenced
1043 * Each live reference to a client should be refcounted. The driver model does
1044 * that automatically as part of driver binding, so that most drivers don't
1045 * need to do this explicitly: they hold a reference until they're unbound
1048 * A pointer to the client with the incremented reference counter is returned.
1050 struct i2c_client
*i2c_use_client(struct i2c_client
*client
)
1052 if (client
&& get_device(&client
->dev
))
1056 EXPORT_SYMBOL(i2c_use_client
);
1059 * i2c_release_client - release a use of the i2c client structure
1060 * @client: the client being no longer referenced
1062 * Must be called when a user of a client is finished with it.
1064 void i2c_release_client(struct i2c_client
*client
)
1067 put_device(&client
->dev
);
1069 EXPORT_SYMBOL(i2c_release_client
);
1071 struct i2c_cmd_arg
{
1076 static int i2c_cmd(struct device
*dev
, void *_arg
)
1078 struct i2c_client
*client
= i2c_verify_client(dev
);
1079 struct i2c_cmd_arg
*arg
= _arg
;
1081 if (client
&& client
->driver
&& client
->driver
->command
)
1082 client
->driver
->command(client
, arg
->cmd
, arg
->arg
);
1086 void i2c_clients_command(struct i2c_adapter
*adap
, unsigned int cmd
, void *arg
)
1088 struct i2c_cmd_arg cmd_arg
;
1092 device_for_each_child(&adap
->dev
, &cmd_arg
, i2c_cmd
);
1094 EXPORT_SYMBOL(i2c_clients_command
);
1096 static int __init
i2c_init(void)
1100 retval
= bus_register(&i2c_bus_type
);
1103 #ifdef CONFIG_I2C_COMPAT
1104 i2c_adapter_compat_class
= class_compat_register("i2c-adapter");
1105 if (!i2c_adapter_compat_class
) {
1110 retval
= i2c_add_driver(&dummy_driver
);
1116 #ifdef CONFIG_I2C_COMPAT
1117 class_compat_unregister(i2c_adapter_compat_class
);
1120 bus_unregister(&i2c_bus_type
);
1124 static void __exit
i2c_exit(void)
1126 i2c_del_driver(&dummy_driver
);
1127 #ifdef CONFIG_I2C_COMPAT
1128 class_compat_unregister(i2c_adapter_compat_class
);
1130 bus_unregister(&i2c_bus_type
);
1133 /* We must initialize early, because some subsystems register i2c drivers
1134 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1136 postcore_initcall(i2c_init
);
1137 module_exit(i2c_exit
);
1139 /* ----------------------------------------------------
1140 * the functional interface to the i2c busses.
1141 * ----------------------------------------------------
1145 * i2c_transfer - execute a single or combined I2C message
1146 * @adap: Handle to I2C bus
1147 * @msgs: One or more messages to execute before STOP is issued to
1148 * terminate the operation; each message begins with a START.
1149 * @num: Number of messages to be executed.
1151 * Returns negative errno, else the number of messages executed.
1153 * Note that there is no requirement that each message be sent to
1154 * the same slave address, although that is the most common model.
1156 int i2c_transfer(struct i2c_adapter
*adap
, struct i2c_msg
*msgs
, int num
)
1158 unsigned long orig_jiffies
;
1161 /* REVISIT the fault reporting model here is weak:
1163 * - When we get an error after receiving N bytes from a slave,
1164 * there is no way to report "N".
1166 * - When we get a NAK after transmitting N bytes to a slave,
1167 * there is no way to report "N" ... or to let the master
1168 * continue executing the rest of this combined message, if
1169 * that's the appropriate response.
1171 * - When for example "num" is two and we successfully complete
1172 * the first message but get an error part way through the
1173 * second, it's unclear whether that should be reported as
1174 * one (discarding status on the second message) or errno
1175 * (discarding status on the first one).
1178 if (adap
->algo
->master_xfer
) {
1180 for (ret
= 0; ret
< num
; ret
++) {
1181 dev_dbg(&adap
->dev
, "master_xfer[%d] %c, addr=0x%02x, "
1182 "len=%d%s\n", ret
, (msgs
[ret
].flags
& I2C_M_RD
)
1183 ? 'R' : 'W', msgs
[ret
].addr
, msgs
[ret
].len
,
1184 (msgs
[ret
].flags
& I2C_M_RECV_LEN
) ? "+" : "");
1188 if (in_atomic() || irqs_disabled()) {
1189 ret
= rt_mutex_trylock(&adap
->bus_lock
);
1191 /* I2C activity is ongoing. */
1194 rt_mutex_lock(&adap
->bus_lock
);
1197 /* Retry automatically on arbitration loss */
1198 orig_jiffies
= jiffies
;
1199 for (ret
= 0, try = 0; try <= adap
->retries
; try++) {
1200 ret
= adap
->algo
->master_xfer(adap
, msgs
, num
);
1203 if (time_after(jiffies
, orig_jiffies
+ adap
->timeout
))
1206 rt_mutex_unlock(&adap
->bus_lock
);
1210 dev_dbg(&adap
->dev
, "I2C level transfers not supported\n");
1214 EXPORT_SYMBOL(i2c_transfer
);
1217 * i2c_master_send - issue a single I2C message in master transmit mode
1218 * @client: Handle to slave device
1219 * @buf: Data that will be written to the slave
1220 * @count: How many bytes to write, must be less than 64k since msg.len is u16
1222 * Returns negative errno, or else the number of bytes written.
1224 int i2c_master_send(struct i2c_client
*client
,const char *buf
,int count
)
1227 struct i2c_adapter
*adap
=client
->adapter
;
1230 msg
.addr
= client
->addr
;
1231 msg
.flags
= client
->flags
& I2C_M_TEN
;
1233 msg
.buf
= (char *)buf
;
1235 ret
= i2c_transfer(adap
, &msg
, 1);
1237 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1238 transmitted, else error code. */
1239 return (ret
== 1) ? count
: ret
;
1241 EXPORT_SYMBOL(i2c_master_send
);
1244 * i2c_master_recv - issue a single I2C message in master receive mode
1245 * @client: Handle to slave device
1246 * @buf: Where to store data read from slave
1247 * @count: How many bytes to read, must be less than 64k since msg.len is u16
1249 * Returns negative errno, or else the number of bytes read.
1251 int i2c_master_recv(struct i2c_client
*client
, char *buf
,int count
)
1253 struct i2c_adapter
*adap
=client
->adapter
;
1257 msg
.addr
= client
->addr
;
1258 msg
.flags
= client
->flags
& I2C_M_TEN
;
1259 msg
.flags
|= I2C_M_RD
;
1263 ret
= i2c_transfer(adap
, &msg
, 1);
1265 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1266 transmitted, else error code. */
1267 return (ret
== 1) ? count
: ret
;
1269 EXPORT_SYMBOL(i2c_master_recv
);
1271 /* ----------------------------------------------------
1272 * the i2c address scanning function
1273 * Will not work for 10-bit addresses!
1274 * ----------------------------------------------------
1277 static int i2c_detect_address(struct i2c_client
*temp_client
,
1278 struct i2c_driver
*driver
)
1280 struct i2c_board_info info
;
1281 struct i2c_adapter
*adapter
= temp_client
->adapter
;
1282 int addr
= temp_client
->addr
;
1285 /* Make sure the address is valid */
1286 if (addr
< 0x03 || addr
> 0x77) {
1287 dev_warn(&adapter
->dev
, "Invalid probe address 0x%02x\n",
1292 /* Skip if already in use */
1293 if (i2c_check_addr(adapter
, addr
))
1296 /* Make sure there is something at this address */
1297 if (addr
== 0x73 && (adapter
->class & I2C_CLASS_HWMON
)) {
1298 /* Special probe for FSC hwmon chips */
1299 union i2c_smbus_data dummy
;
1301 if (i2c_smbus_xfer(adapter
, addr
, 0, I2C_SMBUS_READ
, 0,
1302 I2C_SMBUS_BYTE_DATA
, &dummy
) < 0)
1305 if (i2c_smbus_xfer(adapter
, addr
, 0, I2C_SMBUS_WRITE
, 0,
1306 I2C_SMBUS_QUICK
, NULL
) < 0)
1309 /* Prevent 24RF08 corruption */
1310 if ((addr
& ~0x0f) == 0x50)
1311 i2c_smbus_xfer(adapter
, addr
, 0, I2C_SMBUS_WRITE
, 0,
1312 I2C_SMBUS_QUICK
, NULL
);
1315 /* Finally call the custom detection function */
1316 memset(&info
, 0, sizeof(struct i2c_board_info
));
1318 err
= driver
->detect(temp_client
, &info
);
1320 /* -ENODEV is returned if the detection fails. We catch it
1321 here as this isn't an error. */
1322 return err
== -ENODEV
? 0 : err
;
1325 /* Consistency check */
1326 if (info
.type
[0] == '\0') {
1327 dev_err(&adapter
->dev
, "%s detection function provided "
1328 "no name for 0x%x\n", driver
->driver
.name
,
1331 struct i2c_client
*client
;
1333 /* Detection succeeded, instantiate the device */
1334 dev_dbg(&adapter
->dev
, "Creating %s at 0x%02x\n",
1335 info
.type
, info
.addr
);
1336 client
= i2c_new_device(adapter
, &info
);
1338 list_add_tail(&client
->detected
, &driver
->clients
);
1340 dev_err(&adapter
->dev
, "Failed creating %s at 0x%02x\n",
1341 info
.type
, info
.addr
);
1346 static int i2c_detect(struct i2c_adapter
*adapter
, struct i2c_driver
*driver
)
1348 const unsigned short *address_list
;
1349 struct i2c_client
*temp_client
;
1351 int adap_id
= i2c_adapter_id(adapter
);
1353 address_list
= driver
->address_list
;
1354 if (!driver
->detect
|| !address_list
)
1357 /* Set up a temporary client to help detect callback */
1358 temp_client
= kzalloc(sizeof(struct i2c_client
), GFP_KERNEL
);
1361 temp_client
->adapter
= adapter
;
1363 /* Stop here if the classes do not match */
1364 if (!(adapter
->class & driver
->class))
1367 /* Stop here if we can't use SMBUS_QUICK */
1368 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_QUICK
)) {
1369 if (address_list
[0] == I2C_CLIENT_END
)
1372 dev_warn(&adapter
->dev
, "SMBus Quick command not supported, "
1373 "can't probe for chips\n");
1378 for (i
= 0; address_list
[i
] != I2C_CLIENT_END
; i
+= 1) {
1379 dev_dbg(&adapter
->dev
, "found normal entry for adapter %d, "
1380 "addr 0x%02x\n", adap_id
, address_list
[i
]);
1381 temp_client
->addr
= address_list
[i
];
1382 err
= i2c_detect_address(temp_client
, driver
);
1393 i2c_new_probed_device(struct i2c_adapter
*adap
,
1394 struct i2c_board_info
*info
,
1395 unsigned short const *addr_list
)
1399 /* Stop here if the bus doesn't support probing */
1400 if (!i2c_check_functionality(adap
, I2C_FUNC_SMBUS_READ_BYTE
)) {
1401 dev_err(&adap
->dev
, "Probing not supported\n");
1405 for (i
= 0; addr_list
[i
] != I2C_CLIENT_END
; i
++) {
1406 /* Check address validity */
1407 if (addr_list
[i
] < 0x03 || addr_list
[i
] > 0x77) {
1408 dev_warn(&adap
->dev
, "Invalid 7-bit address "
1409 "0x%02x\n", addr_list
[i
]);
1413 /* Check address availability */
1414 if (i2c_check_addr(adap
, addr_list
[i
])) {
1415 dev_dbg(&adap
->dev
, "Address 0x%02x already in "
1416 "use, not probing\n", addr_list
[i
]);
1420 /* Test address responsiveness
1421 The default probe method is a quick write, but it is known
1422 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1423 and could also irreversibly write-protect some EEPROMs, so
1424 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1425 read instead. Also, some bus drivers don't implement
1426 quick write, so we fallback to a byte read it that case
1428 if ((addr_list
[i
] & ~0x07) == 0x30
1429 || (addr_list
[i
] & ~0x0f) == 0x50
1430 || !i2c_check_functionality(adap
, I2C_FUNC_SMBUS_QUICK
)) {
1431 union i2c_smbus_data data
;
1433 if (i2c_smbus_xfer(adap
, addr_list
[i
], 0,
1435 I2C_SMBUS_BYTE
, &data
) >= 0)
1438 if (i2c_smbus_xfer(adap
, addr_list
[i
], 0,
1440 I2C_SMBUS_QUICK
, NULL
) >= 0)
1445 if (addr_list
[i
] == I2C_CLIENT_END
) {
1446 dev_dbg(&adap
->dev
, "Probing failed, no device found\n");
1450 info
->addr
= addr_list
[i
];
1451 return i2c_new_device(adap
, info
);
1453 EXPORT_SYMBOL_GPL(i2c_new_probed_device
);
1455 struct i2c_adapter
* i2c_get_adapter(int id
)
1457 struct i2c_adapter
*adapter
;
1459 mutex_lock(&core_lock
);
1460 adapter
= idr_find(&i2c_adapter_idr
, id
);
1461 if (adapter
&& !try_module_get(adapter
->owner
))
1464 mutex_unlock(&core_lock
);
1467 EXPORT_SYMBOL(i2c_get_adapter
);
1469 void i2c_put_adapter(struct i2c_adapter
*adap
)
1471 module_put(adap
->owner
);
1473 EXPORT_SYMBOL(i2c_put_adapter
);
1475 /* The SMBus parts */
1477 #define POLY (0x1070U << 3)
1478 static u8
crc8(u16 data
)
1482 for(i
= 0; i
< 8; i
++) {
1487 return (u8
)(data
>> 8);
1490 /* Incremental CRC8 over count bytes in the array pointed to by p */
1491 static u8
i2c_smbus_pec(u8 crc
, u8
*p
, size_t count
)
1495 for(i
= 0; i
< count
; i
++)
1496 crc
= crc8((crc
^ p
[i
]) << 8);
1500 /* Assume a 7-bit address, which is reasonable for SMBus */
1501 static u8
i2c_smbus_msg_pec(u8 pec
, struct i2c_msg
*msg
)
1503 /* The address will be sent first */
1504 u8 addr
= (msg
->addr
<< 1) | !!(msg
->flags
& I2C_M_RD
);
1505 pec
= i2c_smbus_pec(pec
, &addr
, 1);
1507 /* The data buffer follows */
1508 return i2c_smbus_pec(pec
, msg
->buf
, msg
->len
);
1511 /* Used for write only transactions */
1512 static inline void i2c_smbus_add_pec(struct i2c_msg
*msg
)
1514 msg
->buf
[msg
->len
] = i2c_smbus_msg_pec(0, msg
);
1518 /* Return <0 on CRC error
1519 If there was a write before this read (most cases) we need to take the
1520 partial CRC from the write part into account.
1521 Note that this function does modify the message (we need to decrease the
1522 message length to hide the CRC byte from the caller). */
1523 static int i2c_smbus_check_pec(u8 cpec
, struct i2c_msg
*msg
)
1525 u8 rpec
= msg
->buf
[--msg
->len
];
1526 cpec
= i2c_smbus_msg_pec(cpec
, msg
);
1529 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1537 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1538 * @client: Handle to slave device
1540 * This executes the SMBus "receive byte" protocol, returning negative errno
1541 * else the byte received from the device.
1543 s32
i2c_smbus_read_byte(struct i2c_client
*client
)
1545 union i2c_smbus_data data
;
1548 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1550 I2C_SMBUS_BYTE
, &data
);
1551 return (status
< 0) ? status
: data
.byte
;
1553 EXPORT_SYMBOL(i2c_smbus_read_byte
);
1556 * i2c_smbus_write_byte - SMBus "send byte" protocol
1557 * @client: Handle to slave device
1558 * @value: Byte to be sent
1560 * This executes the SMBus "send byte" protocol, returning negative errno
1561 * else zero on success.
1563 s32
i2c_smbus_write_byte(struct i2c_client
*client
, u8 value
)
1565 return i2c_smbus_xfer(client
->adapter
,client
->addr
,client
->flags
,
1566 I2C_SMBUS_WRITE
, value
, I2C_SMBUS_BYTE
, NULL
);
1568 EXPORT_SYMBOL(i2c_smbus_write_byte
);
1571 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1572 * @client: Handle to slave device
1573 * @command: Byte interpreted by slave
1575 * This executes the SMBus "read byte" protocol, returning negative errno
1576 * else a data byte received from the device.
1578 s32
i2c_smbus_read_byte_data(struct i2c_client
*client
, u8 command
)
1580 union i2c_smbus_data data
;
1583 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1584 I2C_SMBUS_READ
, command
,
1585 I2C_SMBUS_BYTE_DATA
, &data
);
1586 return (status
< 0) ? status
: data
.byte
;
1588 EXPORT_SYMBOL(i2c_smbus_read_byte_data
);
1591 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1592 * @client: Handle to slave device
1593 * @command: Byte interpreted by slave
1594 * @value: Byte being written
1596 * This executes the SMBus "write byte" protocol, returning negative errno
1597 * else zero on success.
1599 s32
i2c_smbus_write_byte_data(struct i2c_client
*client
, u8 command
, u8 value
)
1601 union i2c_smbus_data data
;
1603 return i2c_smbus_xfer(client
->adapter
,client
->addr
,client
->flags
,
1604 I2C_SMBUS_WRITE
,command
,
1605 I2C_SMBUS_BYTE_DATA
,&data
);
1607 EXPORT_SYMBOL(i2c_smbus_write_byte_data
);
1610 * i2c_smbus_read_word_data - SMBus "read word" protocol
1611 * @client: Handle to slave device
1612 * @command: Byte interpreted by slave
1614 * This executes the SMBus "read word" protocol, returning negative errno
1615 * else a 16-bit unsigned "word" received from the device.
1617 s32
i2c_smbus_read_word_data(struct i2c_client
*client
, u8 command
)
1619 union i2c_smbus_data data
;
1622 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1623 I2C_SMBUS_READ
, command
,
1624 I2C_SMBUS_WORD_DATA
, &data
);
1625 return (status
< 0) ? status
: data
.word
;
1627 EXPORT_SYMBOL(i2c_smbus_read_word_data
);
1630 * i2c_smbus_write_word_data - SMBus "write word" protocol
1631 * @client: Handle to slave device
1632 * @command: Byte interpreted by slave
1633 * @value: 16-bit "word" being written
1635 * This executes the SMBus "write word" protocol, returning negative errno
1636 * else zero on success.
1638 s32
i2c_smbus_write_word_data(struct i2c_client
*client
, u8 command
, u16 value
)
1640 union i2c_smbus_data data
;
1642 return i2c_smbus_xfer(client
->adapter
,client
->addr
,client
->flags
,
1643 I2C_SMBUS_WRITE
,command
,
1644 I2C_SMBUS_WORD_DATA
,&data
);
1646 EXPORT_SYMBOL(i2c_smbus_write_word_data
);
1649 * i2c_smbus_process_call - SMBus "process call" protocol
1650 * @client: Handle to slave device
1651 * @command: Byte interpreted by slave
1652 * @value: 16-bit "word" being written
1654 * This executes the SMBus "process call" protocol, returning negative errno
1655 * else a 16-bit unsigned "word" received from the device.
1657 s32
i2c_smbus_process_call(struct i2c_client
*client
, u8 command
, u16 value
)
1659 union i2c_smbus_data data
;
1663 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1664 I2C_SMBUS_WRITE
, command
,
1665 I2C_SMBUS_PROC_CALL
, &data
);
1666 return (status
< 0) ? status
: data
.word
;
1668 EXPORT_SYMBOL(i2c_smbus_process_call
);
1671 * i2c_smbus_read_block_data - SMBus "block read" protocol
1672 * @client: Handle to slave device
1673 * @command: Byte interpreted by slave
1674 * @values: Byte array into which data will be read; big enough to hold
1675 * the data returned by the slave. SMBus allows at most 32 bytes.
1677 * This executes the SMBus "block read" protocol, returning negative errno
1678 * else the number of data bytes in the slave's response.
1680 * Note that using this function requires that the client's adapter support
1681 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1682 * support this; its emulation through I2C messaging relies on a specific
1683 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1685 s32
i2c_smbus_read_block_data(struct i2c_client
*client
, u8 command
,
1688 union i2c_smbus_data data
;
1691 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1692 I2C_SMBUS_READ
, command
,
1693 I2C_SMBUS_BLOCK_DATA
, &data
);
1697 memcpy(values
, &data
.block
[1], data
.block
[0]);
1698 return data
.block
[0];
1700 EXPORT_SYMBOL(i2c_smbus_read_block_data
);
1703 * i2c_smbus_write_block_data - SMBus "block write" protocol
1704 * @client: Handle to slave device
1705 * @command: Byte interpreted by slave
1706 * @length: Size of data block; SMBus allows at most 32 bytes
1707 * @values: Byte array which will be written.
1709 * This executes the SMBus "block write" protocol, returning negative errno
1710 * else zero on success.
1712 s32
i2c_smbus_write_block_data(struct i2c_client
*client
, u8 command
,
1713 u8 length
, const u8
*values
)
1715 union i2c_smbus_data data
;
1717 if (length
> I2C_SMBUS_BLOCK_MAX
)
1718 length
= I2C_SMBUS_BLOCK_MAX
;
1719 data
.block
[0] = length
;
1720 memcpy(&data
.block
[1], values
, length
);
1721 return i2c_smbus_xfer(client
->adapter
,client
->addr
,client
->flags
,
1722 I2C_SMBUS_WRITE
,command
,
1723 I2C_SMBUS_BLOCK_DATA
,&data
);
1725 EXPORT_SYMBOL(i2c_smbus_write_block_data
);
1727 /* Returns the number of read bytes */
1728 s32
i2c_smbus_read_i2c_block_data(struct i2c_client
*client
, u8 command
,
1729 u8 length
, u8
*values
)
1731 union i2c_smbus_data data
;
1734 if (length
> I2C_SMBUS_BLOCK_MAX
)
1735 length
= I2C_SMBUS_BLOCK_MAX
;
1736 data
.block
[0] = length
;
1737 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1738 I2C_SMBUS_READ
, command
,
1739 I2C_SMBUS_I2C_BLOCK_DATA
, &data
);
1743 memcpy(values
, &data
.block
[1], data
.block
[0]);
1744 return data
.block
[0];
1746 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data
);
1748 s32
i2c_smbus_write_i2c_block_data(struct i2c_client
*client
, u8 command
,
1749 u8 length
, const u8
*values
)
1751 union i2c_smbus_data data
;
1753 if (length
> I2C_SMBUS_BLOCK_MAX
)
1754 length
= I2C_SMBUS_BLOCK_MAX
;
1755 data
.block
[0] = length
;
1756 memcpy(data
.block
+ 1, values
, length
);
1757 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1758 I2C_SMBUS_WRITE
, command
,
1759 I2C_SMBUS_I2C_BLOCK_DATA
, &data
);
1761 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data
);
1763 /* Simulate a SMBus command using the i2c protocol
1764 No checking of parameters is done! */
1765 static s32
i2c_smbus_xfer_emulated(struct i2c_adapter
* adapter
, u16 addr
,
1766 unsigned short flags
,
1767 char read_write
, u8 command
, int size
,
1768 union i2c_smbus_data
* data
)
1770 /* So we need to generate a series of msgs. In the case of writing, we
1771 need to use only one message; when reading, we need two. We initialize
1772 most things with sane defaults, to keep the code below somewhat
1774 unsigned char msgbuf0
[I2C_SMBUS_BLOCK_MAX
+3];
1775 unsigned char msgbuf1
[I2C_SMBUS_BLOCK_MAX
+2];
1776 int num
= read_write
== I2C_SMBUS_READ
?2:1;
1777 struct i2c_msg msg
[2] = { { addr
, flags
, 1, msgbuf0
},
1778 { addr
, flags
| I2C_M_RD
, 0, msgbuf1
}
1784 msgbuf0
[0] = command
;
1786 case I2C_SMBUS_QUICK
:
1788 /* Special case: The read/write field is used as data */
1789 msg
[0].flags
= flags
| (read_write
== I2C_SMBUS_READ
?
1793 case I2C_SMBUS_BYTE
:
1794 if (read_write
== I2C_SMBUS_READ
) {
1795 /* Special case: only a read! */
1796 msg
[0].flags
= I2C_M_RD
| flags
;
1800 case I2C_SMBUS_BYTE_DATA
:
1801 if (read_write
== I2C_SMBUS_READ
)
1805 msgbuf0
[1] = data
->byte
;
1808 case I2C_SMBUS_WORD_DATA
:
1809 if (read_write
== I2C_SMBUS_READ
)
1813 msgbuf0
[1] = data
->word
& 0xff;
1814 msgbuf0
[2] = data
->word
>> 8;
1817 case I2C_SMBUS_PROC_CALL
:
1818 num
= 2; /* Special case */
1819 read_write
= I2C_SMBUS_READ
;
1822 msgbuf0
[1] = data
->word
& 0xff;
1823 msgbuf0
[2] = data
->word
>> 8;
1825 case I2C_SMBUS_BLOCK_DATA
:
1826 if (read_write
== I2C_SMBUS_READ
) {
1827 msg
[1].flags
|= I2C_M_RECV_LEN
;
1828 msg
[1].len
= 1; /* block length will be added by
1829 the underlying bus driver */
1831 msg
[0].len
= data
->block
[0] + 2;
1832 if (msg
[0].len
> I2C_SMBUS_BLOCK_MAX
+ 2) {
1833 dev_err(&adapter
->dev
,
1834 "Invalid block write size %d\n",
1838 for (i
= 1; i
< msg
[0].len
; i
++)
1839 msgbuf0
[i
] = data
->block
[i
-1];
1842 case I2C_SMBUS_BLOCK_PROC_CALL
:
1843 num
= 2; /* Another special case */
1844 read_write
= I2C_SMBUS_READ
;
1845 if (data
->block
[0] > I2C_SMBUS_BLOCK_MAX
) {
1846 dev_err(&adapter
->dev
,
1847 "Invalid block write size %d\n",
1851 msg
[0].len
= data
->block
[0] + 2;
1852 for (i
= 1; i
< msg
[0].len
; i
++)
1853 msgbuf0
[i
] = data
->block
[i
-1];
1854 msg
[1].flags
|= I2C_M_RECV_LEN
;
1855 msg
[1].len
= 1; /* block length will be added by
1856 the underlying bus driver */
1858 case I2C_SMBUS_I2C_BLOCK_DATA
:
1859 if (read_write
== I2C_SMBUS_READ
) {
1860 msg
[1].len
= data
->block
[0];
1862 msg
[0].len
= data
->block
[0] + 1;
1863 if (msg
[0].len
> I2C_SMBUS_BLOCK_MAX
+ 1) {
1864 dev_err(&adapter
->dev
,
1865 "Invalid block write size %d\n",
1869 for (i
= 1; i
<= data
->block
[0]; i
++)
1870 msgbuf0
[i
] = data
->block
[i
];
1874 dev_err(&adapter
->dev
, "Unsupported transaction %d\n", size
);
1878 i
= ((flags
& I2C_CLIENT_PEC
) && size
!= I2C_SMBUS_QUICK
1879 && size
!= I2C_SMBUS_I2C_BLOCK_DATA
);
1881 /* Compute PEC if first message is a write */
1882 if (!(msg
[0].flags
& I2C_M_RD
)) {
1883 if (num
== 1) /* Write only */
1884 i2c_smbus_add_pec(&msg
[0]);
1885 else /* Write followed by read */
1886 partial_pec
= i2c_smbus_msg_pec(0, &msg
[0]);
1888 /* Ask for PEC if last message is a read */
1889 if (msg
[num
-1].flags
& I2C_M_RD
)
1893 status
= i2c_transfer(adapter
, msg
, num
);
1897 /* Check PEC if last message is a read */
1898 if (i
&& (msg
[num
-1].flags
& I2C_M_RD
)) {
1899 status
= i2c_smbus_check_pec(partial_pec
, &msg
[num
-1]);
1904 if (read_write
== I2C_SMBUS_READ
)
1906 case I2C_SMBUS_BYTE
:
1907 data
->byte
= msgbuf0
[0];
1909 case I2C_SMBUS_BYTE_DATA
:
1910 data
->byte
= msgbuf1
[0];
1912 case I2C_SMBUS_WORD_DATA
:
1913 case I2C_SMBUS_PROC_CALL
:
1914 data
->word
= msgbuf1
[0] | (msgbuf1
[1] << 8);
1916 case I2C_SMBUS_I2C_BLOCK_DATA
:
1917 for (i
= 0; i
< data
->block
[0]; i
++)
1918 data
->block
[i
+1] = msgbuf1
[i
];
1920 case I2C_SMBUS_BLOCK_DATA
:
1921 case I2C_SMBUS_BLOCK_PROC_CALL
:
1922 for (i
= 0; i
< msgbuf1
[0] + 1; i
++)
1923 data
->block
[i
] = msgbuf1
[i
];
1930 * i2c_smbus_xfer - execute SMBus protocol operations
1931 * @adapter: Handle to I2C bus
1932 * @addr: Address of SMBus slave on that bus
1933 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1934 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1935 * @command: Byte interpreted by slave, for protocols which use such bytes
1936 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1937 * @data: Data to be read or written
1939 * This executes an SMBus protocol operation, and returns a negative
1940 * errno code else zero on success.
1942 s32
i2c_smbus_xfer(struct i2c_adapter
*adapter
, u16 addr
, unsigned short flags
,
1943 char read_write
, u8 command
, int protocol
,
1944 union i2c_smbus_data
*data
)
1946 unsigned long orig_jiffies
;
1950 flags
&= I2C_M_TEN
| I2C_CLIENT_PEC
;
1952 if (adapter
->algo
->smbus_xfer
) {
1953 rt_mutex_lock(&adapter
->bus_lock
);
1955 /* Retry automatically on arbitration loss */
1956 orig_jiffies
= jiffies
;
1957 for (res
= 0, try = 0; try <= adapter
->retries
; try++) {
1958 res
= adapter
->algo
->smbus_xfer(adapter
, addr
, flags
,
1959 read_write
, command
,
1963 if (time_after(jiffies
,
1964 orig_jiffies
+ adapter
->timeout
))
1967 rt_mutex_unlock(&adapter
->bus_lock
);
1969 res
= i2c_smbus_xfer_emulated(adapter
,addr
,flags
,read_write
,
1970 command
, protocol
, data
);
1974 EXPORT_SYMBOL(i2c_smbus_xfer
);
1976 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1977 MODULE_DESCRIPTION("I2C-Bus main module");
1978 MODULE_LICENSE("GPL");