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>
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
)
61 if (strcmp(client
->name
, id
->name
) == 0)
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
;
76 /* Attempt an OF style match */
77 if (of_driver_match_device(dev
, drv
))
80 driver
= to_i2c_driver(drv
);
81 /* match on an id table if there is one */
83 return i2c_match_id(driver
->id_table
, client
) != NULL
;
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
))
98 dev_dbg(dev
, "uevent\n");
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
;
115 driver
= to_i2c_driver(dev
->driver
);
116 if (!driver
->probe
|| !driver
->id_table
)
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
));
126 client
->driver
= NULL
;
127 i2c_set_clientdata(client
, NULL
);
132 static int i2c_device_remove(struct device
*dev
)
134 struct i2c_client
*client
= i2c_verify_client(dev
);
135 struct i2c_driver
*driver
;
138 if (!client
|| !dev
->driver
)
141 driver
= to_i2c_driver(dev
->driver
);
142 if (driver
->remove
) {
143 dev_dbg(dev
, "remove\n");
144 status
= driver
->remove(client
);
150 client
->driver
= NULL
;
151 i2c_set_clientdata(client
, NULL
);
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
)
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
)
176 driver
= to_i2c_driver(dev
->driver
);
177 if (!driver
->suspend
)
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
)
189 driver
= to_i2c_driver(dev
->driver
);
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
;
200 return pm_generic_suspend(dev
);
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
;
210 return pm_generic_resume(dev
);
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
;
220 return pm_generic_freeze(dev
);
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
;
230 return pm_generic_thaw(dev
);
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
;
240 return pm_generic_poweroff(dev
);
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
;
250 return pm_generic_restore(dev
);
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
));
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
);
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
[] = {
287 /* modalias helps coldplug: modprobe $(cat .../modalias) */
288 &dev_attr_modalias
.attr
,
292 static struct attribute_group i2c_dev_attr_group
= {
293 .attrs
= i2c_dev_attrs
,
296 static const struct attribute_group
*i2c_dev_attr_groups
[] = {
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
,
309 pm_generic_runtime_suspend
,
310 pm_generic_runtime_resume
,
311 pm_generic_runtime_idle
315 struct bus_type i2c_bus_type
= {
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
)
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)
359 /* 7-bit address, reject the general call address */
360 if (client
->addr
== 0x00 || client
->addr
> 0x7f)
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
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)
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
)
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
);
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
);
412 /* recurse down mux tree */
413 static int i2c_check_mux_children(struct device
*dev
, void *addrp
)
417 if (dev
->type
== &i2c_adapter_type
)
418 result
= device_for_each_child(dev
, addrp
,
419 i2c_check_mux_children
);
421 result
= __i2c_check_addr_busy(dev
, addrp
);
426 static int i2c_check_addr_busy(struct i2c_adapter
*adapter
, int addr
)
428 struct i2c_adapter
*parent
= i2c_parent_is_i2c_adapter(adapter
);
432 result
= i2c_check_mux_parents(parent
, addr
);
435 result
= device_for_each_child(&adapter
->dev
, &addr
,
436 i2c_check_mux_children
);
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
);
450 i2c_lock_adapter(parent
);
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
);
465 return i2c_trylock_adapter(parent
);
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
);
479 i2c_unlock_adapter(parent
);
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
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.
502 i2c_new_device(struct i2c_adapter
*adap
, struct i2c_board_info
const *info
)
504 struct i2c_client
*client
;
507 client
= kzalloc(sizeof *client
, GFP_KERNEL
);
511 client
->adapter
= adap
;
513 client
->dev
.platform_data
= info
->platform_data
;
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
);
527 dev_err(&adap
->dev
, "Invalid %d-bit I2C address 0x%02hx\n",
528 client
->flags
& I2C_CLIENT_TEN
? 10 : 7, client
->addr
);
532 /* Check for address business */
533 status
= i2c_check_addr_busy(adap
, client
->addr
);
537 client
->dev
.parent
= &client
->adapter
->dev
;
538 client
->dev
.bus
= &i2c_bus_type
;
539 client
->dev
.type
= &i2c_client_type
;
540 client
->dev
.of_node
= info
->of_node
;
542 dev_set_name(&client
->dev
, "%d-%04x", i2c_adapter_id(adap
),
544 status
= device_register(&client
->dev
);
548 dev_dbg(&adap
->dev
, "client [%s] registered with bus id %s\n",
549 client
->name
, dev_name(&client
->dev
));
554 dev_err(&adap
->dev
, "Failed to register i2c client %s at 0x%02x "
555 "(%d)\n", client
->name
, client
->addr
, status
);
560 EXPORT_SYMBOL_GPL(i2c_new_device
);
564 * i2c_unregister_device - reverse effect of i2c_new_device()
565 * @client: value returned from i2c_new_device()
568 void i2c_unregister_device(struct i2c_client
*client
)
570 device_unregister(&client
->dev
);
572 EXPORT_SYMBOL_GPL(i2c_unregister_device
);
575 static const struct i2c_device_id dummy_id
[] = {
580 static int dummy_probe(struct i2c_client
*client
,
581 const struct i2c_device_id
*id
)
586 static int dummy_remove(struct i2c_client
*client
)
591 static struct i2c_driver dummy_driver
= {
592 .driver
.name
= "dummy",
593 .probe
= dummy_probe
,
594 .remove
= dummy_remove
,
595 .id_table
= dummy_id
,
599 * i2c_new_dummy - return a new i2c device bound to a dummy driver
600 * @adapter: the adapter managing the device
601 * @address: seven bit address to be used
604 * This returns an I2C client bound to the "dummy" driver, intended for use
605 * with devices that consume multiple addresses. Examples of such chips
606 * include various EEPROMS (like 24c04 and 24c08 models).
608 * These dummy devices have two main uses. First, most I2C and SMBus calls
609 * except i2c_transfer() need a client handle; the dummy will be that handle.
610 * And second, this prevents the specified address from being bound to a
613 * This returns the new i2c client, which should be saved for later use with
614 * i2c_unregister_device(); or NULL to indicate an error.
616 struct i2c_client
*i2c_new_dummy(struct i2c_adapter
*adapter
, u16 address
)
618 struct i2c_board_info info
= {
619 I2C_BOARD_INFO("dummy", address
),
622 return i2c_new_device(adapter
, &info
);
624 EXPORT_SYMBOL_GPL(i2c_new_dummy
);
626 /* ------------------------------------------------------------------------- */
628 /* I2C bus adapters -- one roots each I2C or SMBUS segment */
630 static void i2c_adapter_dev_release(struct device
*dev
)
632 struct i2c_adapter
*adap
= to_i2c_adapter(dev
);
633 complete(&adap
->dev_released
);
637 * Let users instantiate I2C devices through sysfs. This can be used when
638 * platform initialization code doesn't contain the proper data for
639 * whatever reason. Also useful for drivers that do device detection and
640 * detection fails, either because the device uses an unexpected address,
641 * or this is a compatible device with different ID register values.
643 * Parameter checking may look overzealous, but we really don't want
644 * the user to provide incorrect parameters.
647 i2c_sysfs_new_device(struct device
*dev
, struct device_attribute
*attr
,
648 const char *buf
, size_t count
)
650 struct i2c_adapter
*adap
= to_i2c_adapter(dev
);
651 struct i2c_board_info info
;
652 struct i2c_client
*client
;
656 memset(&info
, 0, sizeof(struct i2c_board_info
));
658 blank
= strchr(buf
, ' ');
660 dev_err(dev
, "%s: Missing parameters\n", "new_device");
663 if (blank
- buf
> I2C_NAME_SIZE
- 1) {
664 dev_err(dev
, "%s: Invalid device name\n", "new_device");
667 memcpy(info
.type
, buf
, blank
- buf
);
669 /* Parse remaining parameters, reject extra parameters */
670 res
= sscanf(++blank
, "%hi%c", &info
.addr
, &end
);
672 dev_err(dev
, "%s: Can't parse I2C address\n", "new_device");
675 if (res
> 1 && end
!= '\n') {
676 dev_err(dev
, "%s: Extra parameters\n", "new_device");
680 client
= i2c_new_device(adap
, &info
);
684 /* Keep track of the added device */
685 mutex_lock(&adap
->userspace_clients_lock
);
686 list_add_tail(&client
->detected
, &adap
->userspace_clients
);
687 mutex_unlock(&adap
->userspace_clients_lock
);
688 dev_info(dev
, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
689 info
.type
, info
.addr
);
695 * And of course let the users delete the devices they instantiated, if
696 * they got it wrong. This interface can only be used to delete devices
697 * instantiated by i2c_sysfs_new_device above. This guarantees that we
698 * don't delete devices to which some kernel code still has references.
700 * Parameter checking may look overzealous, but we really don't want
701 * the user to delete the wrong device.
704 i2c_sysfs_delete_device(struct device
*dev
, struct device_attribute
*attr
,
705 const char *buf
, size_t count
)
707 struct i2c_adapter
*adap
= to_i2c_adapter(dev
);
708 struct i2c_client
*client
, *next
;
713 /* Parse parameters, reject extra parameters */
714 res
= sscanf(buf
, "%hi%c", &addr
, &end
);
716 dev_err(dev
, "%s: Can't parse I2C address\n", "delete_device");
719 if (res
> 1 && end
!= '\n') {
720 dev_err(dev
, "%s: Extra parameters\n", "delete_device");
724 /* Make sure the device was added through sysfs */
726 mutex_lock(&adap
->userspace_clients_lock
);
727 list_for_each_entry_safe(client
, next
, &adap
->userspace_clients
,
729 if (client
->addr
== addr
) {
730 dev_info(dev
, "%s: Deleting device %s at 0x%02hx\n",
731 "delete_device", client
->name
, client
->addr
);
733 list_del(&client
->detected
);
734 i2c_unregister_device(client
);
739 mutex_unlock(&adap
->userspace_clients_lock
);
742 dev_err(dev
, "%s: Can't find device in list\n",
747 static DEVICE_ATTR(new_device
, S_IWUSR
, NULL
, i2c_sysfs_new_device
);
748 static DEVICE_ATTR(delete_device
, S_IWUSR
, NULL
, i2c_sysfs_delete_device
);
750 static struct attribute
*i2c_adapter_attrs
[] = {
752 &dev_attr_new_device
.attr
,
753 &dev_attr_delete_device
.attr
,
757 static struct attribute_group i2c_adapter_attr_group
= {
758 .attrs
= i2c_adapter_attrs
,
761 static const struct attribute_group
*i2c_adapter_attr_groups
[] = {
762 &i2c_adapter_attr_group
,
766 struct device_type i2c_adapter_type
= {
767 .groups
= i2c_adapter_attr_groups
,
768 .release
= i2c_adapter_dev_release
,
770 EXPORT_SYMBOL_GPL(i2c_adapter_type
);
772 #ifdef CONFIG_I2C_COMPAT
773 static struct class_compat
*i2c_adapter_compat_class
;
776 static void i2c_scan_static_board_info(struct i2c_adapter
*adapter
)
778 struct i2c_devinfo
*devinfo
;
780 down_read(&__i2c_board_lock
);
781 list_for_each_entry(devinfo
, &__i2c_board_list
, list
) {
782 if (devinfo
->busnum
== adapter
->nr
783 && !i2c_new_device(adapter
,
784 &devinfo
->board_info
))
785 dev_err(&adapter
->dev
,
786 "Can't create device at 0x%02x\n",
787 devinfo
->board_info
.addr
);
789 up_read(&__i2c_board_lock
);
792 static int i2c_do_add_adapter(struct i2c_driver
*driver
,
793 struct i2c_adapter
*adap
)
795 /* Detect supported devices on that bus, and instantiate them */
796 i2c_detect(adap
, driver
);
798 /* Let legacy drivers scan this bus for matching devices */
799 if (driver
->attach_adapter
) {
800 dev_warn(&adap
->dev
, "attach_adapter method is deprecated\n");
801 dev_warn(&adap
->dev
, "Please use another way to instantiate "
802 "your i2c_client\n");
803 /* We ignore the return code; if it fails, too bad */
804 driver
->attach_adapter(adap
);
809 static int __process_new_adapter(struct device_driver
*d
, void *data
)
811 return i2c_do_add_adapter(to_i2c_driver(d
), data
);
814 static int i2c_register_adapter(struct i2c_adapter
*adap
)
818 /* Can't register until after driver model init */
819 if (unlikely(WARN_ON(!i2c_bus_type
.p
))) {
825 if (unlikely(adap
->name
[0] == '\0')) {
826 pr_err("i2c-core: Attempt to register an adapter with "
830 if (unlikely(!adap
->algo
)) {
831 pr_err("i2c-core: Attempt to register adapter '%s' with "
832 "no algo!\n", adap
->name
);
836 rt_mutex_init(&adap
->bus_lock
);
837 mutex_init(&adap
->userspace_clients_lock
);
838 INIT_LIST_HEAD(&adap
->userspace_clients
);
840 /* Set default timeout to 1 second if not already set */
841 if (adap
->timeout
== 0)
844 dev_set_name(&adap
->dev
, "i2c-%d", adap
->nr
);
845 adap
->dev
.bus
= &i2c_bus_type
;
846 adap
->dev
.type
= &i2c_adapter_type
;
847 res
= device_register(&adap
->dev
);
851 dev_dbg(&adap
->dev
, "adapter [%s] registered\n", adap
->name
);
853 #ifdef CONFIG_I2C_COMPAT
854 res
= class_compat_create_link(i2c_adapter_compat_class
, &adap
->dev
,
858 "Failed to create compatibility class link\n");
861 /* create pre-declared device nodes */
862 if (adap
->nr
< __i2c_first_dynamic_bus_num
)
863 i2c_scan_static_board_info(adap
);
866 mutex_lock(&core_lock
);
867 bus_for_each_drv(&i2c_bus_type
, NULL
, adap
, __process_new_adapter
);
868 mutex_unlock(&core_lock
);
873 mutex_lock(&core_lock
);
874 idr_remove(&i2c_adapter_idr
, adap
->nr
);
875 mutex_unlock(&core_lock
);
880 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
881 * @adapter: the adapter to add
884 * This routine is used to declare an I2C adapter when its bus number
885 * doesn't matter. Examples: for I2C adapters dynamically added by
886 * USB links or PCI plugin cards.
888 * When this returns zero, a new bus number was allocated and stored
889 * in adap->nr, and the specified adapter became available for clients.
890 * Otherwise, a negative errno value is returned.
892 int i2c_add_adapter(struct i2c_adapter
*adapter
)
897 if (idr_pre_get(&i2c_adapter_idr
, GFP_KERNEL
) == 0)
900 mutex_lock(&core_lock
);
901 /* "above" here means "above or equal to", sigh */
902 res
= idr_get_new_above(&i2c_adapter_idr
, adapter
,
903 __i2c_first_dynamic_bus_num
, &id
);
904 mutex_unlock(&core_lock
);
913 return i2c_register_adapter(adapter
);
915 EXPORT_SYMBOL(i2c_add_adapter
);
918 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
919 * @adap: the adapter to register (with adap->nr initialized)
922 * This routine is used to declare an I2C adapter when its bus number
923 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
924 * or otherwise built in to the system's mainboard, and where i2c_board_info
925 * is used to properly configure I2C devices.
927 * If no devices have pre-been declared for this bus, then be sure to
928 * register the adapter before any dynamically allocated ones. Otherwise
929 * the required bus ID may not be available.
931 * When this returns zero, the specified adapter became available for
932 * clients using the bus number provided in adap->nr. Also, the table
933 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
934 * and the appropriate driver model device nodes are created. Otherwise, a
935 * negative errno value is returned.
937 int i2c_add_numbered_adapter(struct i2c_adapter
*adap
)
942 if (adap
->nr
& ~MAX_ID_MASK
)
946 if (idr_pre_get(&i2c_adapter_idr
, GFP_KERNEL
) == 0)
949 mutex_lock(&core_lock
);
950 /* "above" here means "above or equal to", sigh;
951 * we need the "equal to" result to force the result
953 status
= idr_get_new_above(&i2c_adapter_idr
, adap
, adap
->nr
, &id
);
954 if (status
== 0 && id
!= adap
->nr
) {
956 idr_remove(&i2c_adapter_idr
, id
);
958 mutex_unlock(&core_lock
);
959 if (status
== -EAGAIN
)
963 status
= i2c_register_adapter(adap
);
966 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter
);
968 static int i2c_do_del_adapter(struct i2c_driver
*driver
,
969 struct i2c_adapter
*adapter
)
971 struct i2c_client
*client
, *_n
;
974 /* Remove the devices we created ourselves as the result of hardware
975 * probing (using a driver's detect method) */
976 list_for_each_entry_safe(client
, _n
, &driver
->clients
, detected
) {
977 if (client
->adapter
== adapter
) {
978 dev_dbg(&adapter
->dev
, "Removing %s at 0x%x\n",
979 client
->name
, client
->addr
);
980 list_del(&client
->detected
);
981 i2c_unregister_device(client
);
985 if (!driver
->detach_adapter
)
987 dev_warn(&adapter
->dev
, "detach_adapter method is deprecated\n");
988 res
= driver
->detach_adapter(adapter
);
990 dev_err(&adapter
->dev
, "detach_adapter failed (%d) "
991 "for driver [%s]\n", res
, driver
->driver
.name
);
995 static int __unregister_client(struct device
*dev
, void *dummy
)
997 struct i2c_client
*client
= i2c_verify_client(dev
);
998 if (client
&& strcmp(client
->name
, "dummy"))
999 i2c_unregister_device(client
);
1003 static int __unregister_dummy(struct device
*dev
, void *dummy
)
1005 struct i2c_client
*client
= i2c_verify_client(dev
);
1007 i2c_unregister_device(client
);
1011 static int __process_removed_adapter(struct device_driver
*d
, void *data
)
1013 return i2c_do_del_adapter(to_i2c_driver(d
), data
);
1017 * i2c_del_adapter - unregister I2C adapter
1018 * @adap: the adapter being unregistered
1019 * Context: can sleep
1021 * This unregisters an I2C adapter which was previously registered
1022 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1024 int i2c_del_adapter(struct i2c_adapter
*adap
)
1027 struct i2c_adapter
*found
;
1028 struct i2c_client
*client
, *next
;
1030 /* First make sure that this adapter was ever added */
1031 mutex_lock(&core_lock
);
1032 found
= idr_find(&i2c_adapter_idr
, adap
->nr
);
1033 mutex_unlock(&core_lock
);
1034 if (found
!= adap
) {
1035 pr_debug("i2c-core: attempting to delete unregistered "
1036 "adapter [%s]\n", adap
->name
);
1040 /* Tell drivers about this removal */
1041 mutex_lock(&core_lock
);
1042 res
= bus_for_each_drv(&i2c_bus_type
, NULL
, adap
,
1043 __process_removed_adapter
);
1044 mutex_unlock(&core_lock
);
1048 /* Remove devices instantiated from sysfs */
1049 mutex_lock(&adap
->userspace_clients_lock
);
1050 list_for_each_entry_safe(client
, next
, &adap
->userspace_clients
,
1052 dev_dbg(&adap
->dev
, "Removing %s at 0x%x\n", client
->name
,
1054 list_del(&client
->detected
);
1055 i2c_unregister_device(client
);
1057 mutex_unlock(&adap
->userspace_clients_lock
);
1059 /* Detach any active clients. This can't fail, thus we do not
1060 * check the returned value. This is a two-pass process, because
1061 * we can't remove the dummy devices during the first pass: they
1062 * could have been instantiated by real devices wishing to clean
1063 * them up properly, so we give them a chance to do that first. */
1064 res
= device_for_each_child(&adap
->dev
, NULL
, __unregister_client
);
1065 res
= device_for_each_child(&adap
->dev
, NULL
, __unregister_dummy
);
1067 #ifdef CONFIG_I2C_COMPAT
1068 class_compat_remove_link(i2c_adapter_compat_class
, &adap
->dev
,
1072 /* device name is gone after device_unregister */
1073 dev_dbg(&adap
->dev
, "adapter [%s] unregistered\n", adap
->name
);
1075 /* clean up the sysfs representation */
1076 init_completion(&adap
->dev_released
);
1077 device_unregister(&adap
->dev
);
1079 /* wait for sysfs to drop all references */
1080 wait_for_completion(&adap
->dev_released
);
1083 mutex_lock(&core_lock
);
1084 idr_remove(&i2c_adapter_idr
, adap
->nr
);
1085 mutex_unlock(&core_lock
);
1087 /* Clear the device structure in case this adapter is ever going to be
1089 memset(&adap
->dev
, 0, sizeof(adap
->dev
));
1093 EXPORT_SYMBOL(i2c_del_adapter
);
1096 /* ------------------------------------------------------------------------- */
1098 int i2c_for_each_dev(void *data
, int (*fn
)(struct device
*, void *))
1102 mutex_lock(&core_lock
);
1103 res
= bus_for_each_dev(&i2c_bus_type
, NULL
, data
, fn
);
1104 mutex_unlock(&core_lock
);
1108 EXPORT_SYMBOL_GPL(i2c_for_each_dev
);
1110 static int __process_new_driver(struct device
*dev
, void *data
)
1112 if (dev
->type
!= &i2c_adapter_type
)
1114 return i2c_do_add_adapter(data
, to_i2c_adapter(dev
));
1118 * An i2c_driver is used with one or more i2c_client (device) nodes to access
1119 * i2c slave chips, on a bus instance associated with some i2c_adapter.
1122 int i2c_register_driver(struct module
*owner
, struct i2c_driver
*driver
)
1126 /* Can't register until after driver model init */
1127 if (unlikely(WARN_ON(!i2c_bus_type
.p
)))
1130 /* add the driver to the list of i2c drivers in the driver core */
1131 driver
->driver
.owner
= owner
;
1132 driver
->driver
.bus
= &i2c_bus_type
;
1134 /* When registration returns, the driver core
1135 * will have called probe() for all matching-but-unbound devices.
1137 res
= driver_register(&driver
->driver
);
1141 /* Drivers should switch to dev_pm_ops instead. */
1142 if (driver
->suspend
)
1143 pr_warn("i2c-core: driver [%s] using legacy suspend method\n",
1144 driver
->driver
.name
);
1146 pr_warn("i2c-core: driver [%s] using legacy resume method\n",
1147 driver
->driver
.name
);
1149 pr_debug("i2c-core: driver [%s] registered\n", driver
->driver
.name
);
1151 INIT_LIST_HEAD(&driver
->clients
);
1152 /* Walk the adapters that are already present */
1153 i2c_for_each_dev(driver
, __process_new_driver
);
1157 EXPORT_SYMBOL(i2c_register_driver
);
1159 static int __process_removed_driver(struct device
*dev
, void *data
)
1161 if (dev
->type
!= &i2c_adapter_type
)
1163 return i2c_do_del_adapter(data
, to_i2c_adapter(dev
));
1167 * i2c_del_driver - unregister I2C driver
1168 * @driver: the driver being unregistered
1169 * Context: can sleep
1171 void i2c_del_driver(struct i2c_driver
*driver
)
1173 i2c_for_each_dev(driver
, __process_removed_driver
);
1175 driver_unregister(&driver
->driver
);
1176 pr_debug("i2c-core: driver [%s] unregistered\n", driver
->driver
.name
);
1178 EXPORT_SYMBOL(i2c_del_driver
);
1180 /* ------------------------------------------------------------------------- */
1183 * i2c_use_client - increments the reference count of the i2c client structure
1184 * @client: the client being referenced
1186 * Each live reference to a client should be refcounted. The driver model does
1187 * that automatically as part of driver binding, so that most drivers don't
1188 * need to do this explicitly: they hold a reference until they're unbound
1191 * A pointer to the client with the incremented reference counter is returned.
1193 struct i2c_client
*i2c_use_client(struct i2c_client
*client
)
1195 if (client
&& get_device(&client
->dev
))
1199 EXPORT_SYMBOL(i2c_use_client
);
1202 * i2c_release_client - release a use of the i2c client structure
1203 * @client: the client being no longer referenced
1205 * Must be called when a user of a client is finished with it.
1207 void i2c_release_client(struct i2c_client
*client
)
1210 put_device(&client
->dev
);
1212 EXPORT_SYMBOL(i2c_release_client
);
1214 struct i2c_cmd_arg
{
1219 static int i2c_cmd(struct device
*dev
, void *_arg
)
1221 struct i2c_client
*client
= i2c_verify_client(dev
);
1222 struct i2c_cmd_arg
*arg
= _arg
;
1224 if (client
&& client
->driver
&& client
->driver
->command
)
1225 client
->driver
->command(client
, arg
->cmd
, arg
->arg
);
1229 void i2c_clients_command(struct i2c_adapter
*adap
, unsigned int cmd
, void *arg
)
1231 struct i2c_cmd_arg cmd_arg
;
1235 device_for_each_child(&adap
->dev
, &cmd_arg
, i2c_cmd
);
1237 EXPORT_SYMBOL(i2c_clients_command
);
1239 static int __init
i2c_init(void)
1243 retval
= bus_register(&i2c_bus_type
);
1246 #ifdef CONFIG_I2C_COMPAT
1247 i2c_adapter_compat_class
= class_compat_register("i2c-adapter");
1248 if (!i2c_adapter_compat_class
) {
1253 retval
= i2c_add_driver(&dummy_driver
);
1259 #ifdef CONFIG_I2C_COMPAT
1260 class_compat_unregister(i2c_adapter_compat_class
);
1263 bus_unregister(&i2c_bus_type
);
1267 static void __exit
i2c_exit(void)
1269 i2c_del_driver(&dummy_driver
);
1270 #ifdef CONFIG_I2C_COMPAT
1271 class_compat_unregister(i2c_adapter_compat_class
);
1273 bus_unregister(&i2c_bus_type
);
1276 /* We must initialize early, because some subsystems register i2c drivers
1277 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1279 postcore_initcall(i2c_init
);
1280 module_exit(i2c_exit
);
1282 /* ----------------------------------------------------
1283 * the functional interface to the i2c busses.
1284 * ----------------------------------------------------
1288 * i2c_transfer - execute a single or combined I2C message
1289 * @adap: Handle to I2C bus
1290 * @msgs: One or more messages to execute before STOP is issued to
1291 * terminate the operation; each message begins with a START.
1292 * @num: Number of messages to be executed.
1294 * Returns negative errno, else the number of messages executed.
1296 * Note that there is no requirement that each message be sent to
1297 * the same slave address, although that is the most common model.
1299 int i2c_transfer(struct i2c_adapter
*adap
, struct i2c_msg
*msgs
, int num
)
1301 unsigned long orig_jiffies
;
1304 /* REVISIT the fault reporting model here is weak:
1306 * - When we get an error after receiving N bytes from a slave,
1307 * there is no way to report "N".
1309 * - When we get a NAK after transmitting N bytes to a slave,
1310 * there is no way to report "N" ... or to let the master
1311 * continue executing the rest of this combined message, if
1312 * that's the appropriate response.
1314 * - When for example "num" is two and we successfully complete
1315 * the first message but get an error part way through the
1316 * second, it's unclear whether that should be reported as
1317 * one (discarding status on the second message) or errno
1318 * (discarding status on the first one).
1321 if (adap
->algo
->master_xfer
) {
1323 for (ret
= 0; ret
< num
; ret
++) {
1324 dev_dbg(&adap
->dev
, "master_xfer[%d] %c, addr=0x%02x, "
1325 "len=%d%s\n", ret
, (msgs
[ret
].flags
& I2C_M_RD
)
1326 ? 'R' : 'W', msgs
[ret
].addr
, msgs
[ret
].len
,
1327 (msgs
[ret
].flags
& I2C_M_RECV_LEN
) ? "+" : "");
1331 if (in_atomic() || irqs_disabled()) {
1332 ret
= i2c_trylock_adapter(adap
);
1334 /* I2C activity is ongoing. */
1337 i2c_lock_adapter(adap
);
1340 /* Retry automatically on arbitration loss */
1341 orig_jiffies
= jiffies
;
1342 for (ret
= 0, try = 0; try <= adap
->retries
; try++) {
1343 ret
= adap
->algo
->master_xfer(adap
, msgs
, num
);
1346 if (time_after(jiffies
, orig_jiffies
+ adap
->timeout
))
1349 i2c_unlock_adapter(adap
);
1353 dev_dbg(&adap
->dev
, "I2C level transfers not supported\n");
1357 EXPORT_SYMBOL(i2c_transfer
);
1360 * i2c_master_send - issue a single I2C message in master transmit mode
1361 * @client: Handle to slave device
1362 * @buf: Data that will be written to the slave
1363 * @count: How many bytes to write, must be less than 64k since msg.len is u16
1365 * Returns negative errno, or else the number of bytes written.
1367 int i2c_master_send(const struct i2c_client
*client
, const char *buf
, int count
)
1370 struct i2c_adapter
*adap
= client
->adapter
;
1373 msg
.addr
= client
->addr
;
1374 msg
.flags
= client
->flags
& I2C_M_TEN
;
1376 msg
.buf
= (char *)buf
;
1378 ret
= i2c_transfer(adap
, &msg
, 1);
1380 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1381 transmitted, else error code. */
1382 return (ret
== 1) ? count
: ret
;
1384 EXPORT_SYMBOL(i2c_master_send
);
1387 * i2c_master_recv - issue a single I2C message in master receive mode
1388 * @client: Handle to slave device
1389 * @buf: Where to store data read from slave
1390 * @count: How many bytes to read, must be less than 64k since msg.len is u16
1392 * Returns negative errno, or else the number of bytes read.
1394 int i2c_master_recv(const struct i2c_client
*client
, char *buf
, int count
)
1396 struct i2c_adapter
*adap
= client
->adapter
;
1400 msg
.addr
= client
->addr
;
1401 msg
.flags
= client
->flags
& I2C_M_TEN
;
1402 msg
.flags
|= I2C_M_RD
;
1406 ret
= i2c_transfer(adap
, &msg
, 1);
1408 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1409 transmitted, else error code. */
1410 return (ret
== 1) ? count
: ret
;
1412 EXPORT_SYMBOL(i2c_master_recv
);
1414 /* ----------------------------------------------------
1415 * the i2c address scanning function
1416 * Will not work for 10-bit addresses!
1417 * ----------------------------------------------------
1421 * Legacy default probe function, mostly relevant for SMBus. The default
1422 * probe method is a quick write, but it is known to corrupt the 24RF08
1423 * EEPROMs due to a state machine bug, and could also irreversibly
1424 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
1425 * we use a short byte read instead. Also, some bus drivers don't implement
1426 * quick write, so we fallback to a byte read in that case too.
1427 * On x86, there is another special case for FSC hardware monitoring chips,
1428 * which want regular byte reads (address 0x73.) Fortunately, these are the
1429 * only known chips using this I2C address on PC hardware.
1430 * Returns 1 if probe succeeded, 0 if not.
1432 static int i2c_default_probe(struct i2c_adapter
*adap
, unsigned short addr
)
1435 union i2c_smbus_data dummy
;
1438 if (addr
== 0x73 && (adap
->class & I2C_CLASS_HWMON
)
1439 && i2c_check_functionality(adap
, I2C_FUNC_SMBUS_READ_BYTE_DATA
))
1440 err
= i2c_smbus_xfer(adap
, addr
, 0, I2C_SMBUS_READ
, 0,
1441 I2C_SMBUS_BYTE_DATA
, &dummy
);
1444 if (!((addr
& ~0x07) == 0x30 || (addr
& ~0x0f) == 0x50)
1445 && i2c_check_functionality(adap
, I2C_FUNC_SMBUS_QUICK
))
1446 err
= i2c_smbus_xfer(adap
, addr
, 0, I2C_SMBUS_WRITE
, 0,
1447 I2C_SMBUS_QUICK
, NULL
);
1448 else if (i2c_check_functionality(adap
, I2C_FUNC_SMBUS_READ_BYTE
))
1449 err
= i2c_smbus_xfer(adap
, addr
, 0, I2C_SMBUS_READ
, 0,
1450 I2C_SMBUS_BYTE
, &dummy
);
1452 dev_warn(&adap
->dev
, "No suitable probing method supported\n");
1459 static int i2c_detect_address(struct i2c_client
*temp_client
,
1460 struct i2c_driver
*driver
)
1462 struct i2c_board_info info
;
1463 struct i2c_adapter
*adapter
= temp_client
->adapter
;
1464 int addr
= temp_client
->addr
;
1467 /* Make sure the address is valid */
1468 err
= i2c_check_addr_validity(addr
);
1470 dev_warn(&adapter
->dev
, "Invalid probe address 0x%02x\n",
1475 /* Skip if already in use */
1476 if (i2c_check_addr_busy(adapter
, addr
))
1479 /* Make sure there is something at this address */
1480 if (!i2c_default_probe(adapter
, addr
))
1483 /* Finally call the custom detection function */
1484 memset(&info
, 0, sizeof(struct i2c_board_info
));
1486 err
= driver
->detect(temp_client
, &info
);
1488 /* -ENODEV is returned if the detection fails. We catch it
1489 here as this isn't an error. */
1490 return err
== -ENODEV
? 0 : err
;
1493 /* Consistency check */
1494 if (info
.type
[0] == '\0') {
1495 dev_err(&adapter
->dev
, "%s detection function provided "
1496 "no name for 0x%x\n", driver
->driver
.name
,
1499 struct i2c_client
*client
;
1501 /* Detection succeeded, instantiate the device */
1502 dev_dbg(&adapter
->dev
, "Creating %s at 0x%02x\n",
1503 info
.type
, info
.addr
);
1504 client
= i2c_new_device(adapter
, &info
);
1506 list_add_tail(&client
->detected
, &driver
->clients
);
1508 dev_err(&adapter
->dev
, "Failed creating %s at 0x%02x\n",
1509 info
.type
, info
.addr
);
1514 static int i2c_detect(struct i2c_adapter
*adapter
, struct i2c_driver
*driver
)
1516 const unsigned short *address_list
;
1517 struct i2c_client
*temp_client
;
1519 int adap_id
= i2c_adapter_id(adapter
);
1521 address_list
= driver
->address_list
;
1522 if (!driver
->detect
|| !address_list
)
1525 /* Stop here if the classes do not match */
1526 if (!(adapter
->class & driver
->class))
1529 /* Set up a temporary client to help detect callback */
1530 temp_client
= kzalloc(sizeof(struct i2c_client
), GFP_KERNEL
);
1533 temp_client
->adapter
= adapter
;
1535 for (i
= 0; address_list
[i
] != I2C_CLIENT_END
; i
+= 1) {
1536 dev_dbg(&adapter
->dev
, "found normal entry for adapter %d, "
1537 "addr 0x%02x\n", adap_id
, address_list
[i
]);
1538 temp_client
->addr
= address_list
[i
];
1539 err
= i2c_detect_address(temp_client
, driver
);
1548 int i2c_probe_func_quick_read(struct i2c_adapter
*adap
, unsigned short addr
)
1550 return i2c_smbus_xfer(adap
, addr
, 0, I2C_SMBUS_READ
, 0,
1551 I2C_SMBUS_QUICK
, NULL
) >= 0;
1553 EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read
);
1556 i2c_new_probed_device(struct i2c_adapter
*adap
,
1557 struct i2c_board_info
*info
,
1558 unsigned short const *addr_list
,
1559 int (*probe
)(struct i2c_adapter
*, unsigned short addr
))
1564 probe
= i2c_default_probe
;
1566 for (i
= 0; addr_list
[i
] != I2C_CLIENT_END
; i
++) {
1567 /* Check address validity */
1568 if (i2c_check_addr_validity(addr_list
[i
]) < 0) {
1569 dev_warn(&adap
->dev
, "Invalid 7-bit address "
1570 "0x%02x\n", addr_list
[i
]);
1574 /* Check address availability */
1575 if (i2c_check_addr_busy(adap
, addr_list
[i
])) {
1576 dev_dbg(&adap
->dev
, "Address 0x%02x already in "
1577 "use, not probing\n", addr_list
[i
]);
1581 /* Test address responsiveness */
1582 if (probe(adap
, addr_list
[i
]))
1586 if (addr_list
[i
] == I2C_CLIENT_END
) {
1587 dev_dbg(&adap
->dev
, "Probing failed, no device found\n");
1591 info
->addr
= addr_list
[i
];
1592 return i2c_new_device(adap
, info
);
1594 EXPORT_SYMBOL_GPL(i2c_new_probed_device
);
1596 struct i2c_adapter
*i2c_get_adapter(int nr
)
1598 struct i2c_adapter
*adapter
;
1600 mutex_lock(&core_lock
);
1601 adapter
= idr_find(&i2c_adapter_idr
, nr
);
1602 if (adapter
&& !try_module_get(adapter
->owner
))
1605 mutex_unlock(&core_lock
);
1608 EXPORT_SYMBOL(i2c_get_adapter
);
1610 void i2c_put_adapter(struct i2c_adapter
*adap
)
1612 module_put(adap
->owner
);
1614 EXPORT_SYMBOL(i2c_put_adapter
);
1616 /* The SMBus parts */
1618 #define POLY (0x1070U << 3)
1619 static u8
crc8(u16 data
)
1623 for (i
= 0; i
< 8; i
++) {
1628 return (u8
)(data
>> 8);
1631 /* Incremental CRC8 over count bytes in the array pointed to by p */
1632 static u8
i2c_smbus_pec(u8 crc
, u8
*p
, size_t count
)
1636 for (i
= 0; i
< count
; i
++)
1637 crc
= crc8((crc
^ p
[i
]) << 8);
1641 /* Assume a 7-bit address, which is reasonable for SMBus */
1642 static u8
i2c_smbus_msg_pec(u8 pec
, struct i2c_msg
*msg
)
1644 /* The address will be sent first */
1645 u8 addr
= (msg
->addr
<< 1) | !!(msg
->flags
& I2C_M_RD
);
1646 pec
= i2c_smbus_pec(pec
, &addr
, 1);
1648 /* The data buffer follows */
1649 return i2c_smbus_pec(pec
, msg
->buf
, msg
->len
);
1652 /* Used for write only transactions */
1653 static inline void i2c_smbus_add_pec(struct i2c_msg
*msg
)
1655 msg
->buf
[msg
->len
] = i2c_smbus_msg_pec(0, msg
);
1659 /* Return <0 on CRC error
1660 If there was a write before this read (most cases) we need to take the
1661 partial CRC from the write part into account.
1662 Note that this function does modify the message (we need to decrease the
1663 message length to hide the CRC byte from the caller). */
1664 static int i2c_smbus_check_pec(u8 cpec
, struct i2c_msg
*msg
)
1666 u8 rpec
= msg
->buf
[--msg
->len
];
1667 cpec
= i2c_smbus_msg_pec(cpec
, msg
);
1670 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1678 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1679 * @client: Handle to slave device
1681 * This executes the SMBus "receive byte" protocol, returning negative errno
1682 * else the byte received from the device.
1684 s32
i2c_smbus_read_byte(const struct i2c_client
*client
)
1686 union i2c_smbus_data data
;
1689 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1691 I2C_SMBUS_BYTE
, &data
);
1692 return (status
< 0) ? status
: data
.byte
;
1694 EXPORT_SYMBOL(i2c_smbus_read_byte
);
1697 * i2c_smbus_write_byte - SMBus "send byte" protocol
1698 * @client: Handle to slave device
1699 * @value: Byte to be sent
1701 * This executes the SMBus "send byte" protocol, returning negative errno
1702 * else zero on success.
1704 s32
i2c_smbus_write_byte(const struct i2c_client
*client
, u8 value
)
1706 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1707 I2C_SMBUS_WRITE
, value
, I2C_SMBUS_BYTE
, NULL
);
1709 EXPORT_SYMBOL(i2c_smbus_write_byte
);
1712 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1713 * @client: Handle to slave device
1714 * @command: Byte interpreted by slave
1716 * This executes the SMBus "read byte" protocol, returning negative errno
1717 * else a data byte received from the device.
1719 s32
i2c_smbus_read_byte_data(const struct i2c_client
*client
, u8 command
)
1721 union i2c_smbus_data data
;
1724 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1725 I2C_SMBUS_READ
, command
,
1726 I2C_SMBUS_BYTE_DATA
, &data
);
1727 return (status
< 0) ? status
: data
.byte
;
1729 EXPORT_SYMBOL(i2c_smbus_read_byte_data
);
1732 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1733 * @client: Handle to slave device
1734 * @command: Byte interpreted by slave
1735 * @value: Byte being written
1737 * This executes the SMBus "write byte" protocol, returning negative errno
1738 * else zero on success.
1740 s32
i2c_smbus_write_byte_data(const struct i2c_client
*client
, u8 command
,
1743 union i2c_smbus_data data
;
1745 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1746 I2C_SMBUS_WRITE
, command
,
1747 I2C_SMBUS_BYTE_DATA
, &data
);
1749 EXPORT_SYMBOL(i2c_smbus_write_byte_data
);
1752 * i2c_smbus_read_word_data - SMBus "read word" protocol
1753 * @client: Handle to slave device
1754 * @command: Byte interpreted by slave
1756 * This executes the SMBus "read word" protocol, returning negative errno
1757 * else a 16-bit unsigned "word" received from the device.
1759 s32
i2c_smbus_read_word_data(const struct i2c_client
*client
, u8 command
)
1761 union i2c_smbus_data data
;
1764 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1765 I2C_SMBUS_READ
, command
,
1766 I2C_SMBUS_WORD_DATA
, &data
);
1767 return (status
< 0) ? status
: data
.word
;
1769 EXPORT_SYMBOL(i2c_smbus_read_word_data
);
1772 * i2c_smbus_write_word_data - SMBus "write word" protocol
1773 * @client: Handle to slave device
1774 * @command: Byte interpreted by slave
1775 * @value: 16-bit "word" being written
1777 * This executes the SMBus "write word" protocol, returning negative errno
1778 * else zero on success.
1780 s32
i2c_smbus_write_word_data(const struct i2c_client
*client
, u8 command
,
1783 union i2c_smbus_data data
;
1785 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1786 I2C_SMBUS_WRITE
, command
,
1787 I2C_SMBUS_WORD_DATA
, &data
);
1789 EXPORT_SYMBOL(i2c_smbus_write_word_data
);
1792 * i2c_smbus_process_call - SMBus "process call" protocol
1793 * @client: Handle to slave device
1794 * @command: Byte interpreted by slave
1795 * @value: 16-bit "word" being written
1797 * This executes the SMBus "process call" protocol, returning negative errno
1798 * else a 16-bit unsigned "word" received from the device.
1800 s32
i2c_smbus_process_call(const struct i2c_client
*client
, u8 command
,
1803 union i2c_smbus_data data
;
1807 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1808 I2C_SMBUS_WRITE
, command
,
1809 I2C_SMBUS_PROC_CALL
, &data
);
1810 return (status
< 0) ? status
: data
.word
;
1812 EXPORT_SYMBOL(i2c_smbus_process_call
);
1815 * i2c_smbus_read_block_data - SMBus "block read" protocol
1816 * @client: Handle to slave device
1817 * @command: Byte interpreted by slave
1818 * @values: Byte array into which data will be read; big enough to hold
1819 * the data returned by the slave. SMBus allows at most 32 bytes.
1821 * This executes the SMBus "block read" protocol, returning negative errno
1822 * else the number of data bytes in the slave's response.
1824 * Note that using this function requires that the client's adapter support
1825 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1826 * support this; its emulation through I2C messaging relies on a specific
1827 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1829 s32
i2c_smbus_read_block_data(const struct i2c_client
*client
, u8 command
,
1832 union i2c_smbus_data data
;
1835 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1836 I2C_SMBUS_READ
, command
,
1837 I2C_SMBUS_BLOCK_DATA
, &data
);
1841 memcpy(values
, &data
.block
[1], data
.block
[0]);
1842 return data
.block
[0];
1844 EXPORT_SYMBOL(i2c_smbus_read_block_data
);
1847 * i2c_smbus_write_block_data - SMBus "block write" protocol
1848 * @client: Handle to slave device
1849 * @command: Byte interpreted by slave
1850 * @length: Size of data block; SMBus allows at most 32 bytes
1851 * @values: Byte array which will be written.
1853 * This executes the SMBus "block write" protocol, returning negative errno
1854 * else zero on success.
1856 s32
i2c_smbus_write_block_data(const struct i2c_client
*client
, u8 command
,
1857 u8 length
, const u8
*values
)
1859 union i2c_smbus_data data
;
1861 if (length
> I2C_SMBUS_BLOCK_MAX
)
1862 length
= I2C_SMBUS_BLOCK_MAX
;
1863 data
.block
[0] = length
;
1864 memcpy(&data
.block
[1], values
, length
);
1865 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1866 I2C_SMBUS_WRITE
, command
,
1867 I2C_SMBUS_BLOCK_DATA
, &data
);
1869 EXPORT_SYMBOL(i2c_smbus_write_block_data
);
1871 /* Returns the number of read bytes */
1872 s32
i2c_smbus_read_i2c_block_data(const struct i2c_client
*client
, u8 command
,
1873 u8 length
, u8
*values
)
1875 union i2c_smbus_data data
;
1878 if (length
> I2C_SMBUS_BLOCK_MAX
)
1879 length
= I2C_SMBUS_BLOCK_MAX
;
1880 data
.block
[0] = length
;
1881 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1882 I2C_SMBUS_READ
, command
,
1883 I2C_SMBUS_I2C_BLOCK_DATA
, &data
);
1887 memcpy(values
, &data
.block
[1], data
.block
[0]);
1888 return data
.block
[0];
1890 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data
);
1892 s32
i2c_smbus_write_i2c_block_data(const struct i2c_client
*client
, u8 command
,
1893 u8 length
, const u8
*values
)
1895 union i2c_smbus_data data
;
1897 if (length
> I2C_SMBUS_BLOCK_MAX
)
1898 length
= I2C_SMBUS_BLOCK_MAX
;
1899 data
.block
[0] = length
;
1900 memcpy(data
.block
+ 1, values
, length
);
1901 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1902 I2C_SMBUS_WRITE
, command
,
1903 I2C_SMBUS_I2C_BLOCK_DATA
, &data
);
1905 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data
);
1907 /* Simulate a SMBus command using the i2c protocol
1908 No checking of parameters is done! */
1909 static s32
i2c_smbus_xfer_emulated(struct i2c_adapter
*adapter
, u16 addr
,
1910 unsigned short flags
,
1911 char read_write
, u8 command
, int size
,
1912 union i2c_smbus_data
*data
)
1914 /* So we need to generate a series of msgs. In the case of writing, we
1915 need to use only one message; when reading, we need two. We initialize
1916 most things with sane defaults, to keep the code below somewhat
1918 unsigned char msgbuf0
[I2C_SMBUS_BLOCK_MAX
+3];
1919 unsigned char msgbuf1
[I2C_SMBUS_BLOCK_MAX
+2];
1920 int num
= read_write
== I2C_SMBUS_READ
? 2 : 1;
1921 struct i2c_msg msg
[2] = { { addr
, flags
, 1, msgbuf0
},
1922 { addr
, flags
| I2C_M_RD
, 0, msgbuf1
}
1928 msgbuf0
[0] = command
;
1930 case I2C_SMBUS_QUICK
:
1932 /* Special case: The read/write field is used as data */
1933 msg
[0].flags
= flags
| (read_write
== I2C_SMBUS_READ
?
1937 case I2C_SMBUS_BYTE
:
1938 if (read_write
== I2C_SMBUS_READ
) {
1939 /* Special case: only a read! */
1940 msg
[0].flags
= I2C_M_RD
| flags
;
1944 case I2C_SMBUS_BYTE_DATA
:
1945 if (read_write
== I2C_SMBUS_READ
)
1949 msgbuf0
[1] = data
->byte
;
1952 case I2C_SMBUS_WORD_DATA
:
1953 if (read_write
== I2C_SMBUS_READ
)
1957 msgbuf0
[1] = data
->word
& 0xff;
1958 msgbuf0
[2] = data
->word
>> 8;
1961 case I2C_SMBUS_PROC_CALL
:
1962 num
= 2; /* Special case */
1963 read_write
= I2C_SMBUS_READ
;
1966 msgbuf0
[1] = data
->word
& 0xff;
1967 msgbuf0
[2] = data
->word
>> 8;
1969 case I2C_SMBUS_BLOCK_DATA
:
1970 if (read_write
== I2C_SMBUS_READ
) {
1971 msg
[1].flags
|= I2C_M_RECV_LEN
;
1972 msg
[1].len
= 1; /* block length will be added by
1973 the underlying bus driver */
1975 msg
[0].len
= data
->block
[0] + 2;
1976 if (msg
[0].len
> I2C_SMBUS_BLOCK_MAX
+ 2) {
1977 dev_err(&adapter
->dev
,
1978 "Invalid block write size %d\n",
1982 for (i
= 1; i
< msg
[0].len
; i
++)
1983 msgbuf0
[i
] = data
->block
[i
-1];
1986 case I2C_SMBUS_BLOCK_PROC_CALL
:
1987 num
= 2; /* Another special case */
1988 read_write
= I2C_SMBUS_READ
;
1989 if (data
->block
[0] > I2C_SMBUS_BLOCK_MAX
) {
1990 dev_err(&adapter
->dev
,
1991 "Invalid block write size %d\n",
1995 msg
[0].len
= data
->block
[0] + 2;
1996 for (i
= 1; i
< msg
[0].len
; i
++)
1997 msgbuf0
[i
] = data
->block
[i
-1];
1998 msg
[1].flags
|= I2C_M_RECV_LEN
;
1999 msg
[1].len
= 1; /* block length will be added by
2000 the underlying bus driver */
2002 case I2C_SMBUS_I2C_BLOCK_DATA
:
2003 if (read_write
== I2C_SMBUS_READ
) {
2004 msg
[1].len
= data
->block
[0];
2006 msg
[0].len
= data
->block
[0] + 1;
2007 if (msg
[0].len
> I2C_SMBUS_BLOCK_MAX
+ 1) {
2008 dev_err(&adapter
->dev
,
2009 "Invalid block write size %d\n",
2013 for (i
= 1; i
<= data
->block
[0]; i
++)
2014 msgbuf0
[i
] = data
->block
[i
];
2018 dev_err(&adapter
->dev
, "Unsupported transaction %d\n", size
);
2022 i
= ((flags
& I2C_CLIENT_PEC
) && size
!= I2C_SMBUS_QUICK
2023 && size
!= I2C_SMBUS_I2C_BLOCK_DATA
);
2025 /* Compute PEC if first message is a write */
2026 if (!(msg
[0].flags
& I2C_M_RD
)) {
2027 if (num
== 1) /* Write only */
2028 i2c_smbus_add_pec(&msg
[0]);
2029 else /* Write followed by read */
2030 partial_pec
= i2c_smbus_msg_pec(0, &msg
[0]);
2032 /* Ask for PEC if last message is a read */
2033 if (msg
[num
-1].flags
& I2C_M_RD
)
2037 status
= i2c_transfer(adapter
, msg
, num
);
2041 /* Check PEC if last message is a read */
2042 if (i
&& (msg
[num
-1].flags
& I2C_M_RD
)) {
2043 status
= i2c_smbus_check_pec(partial_pec
, &msg
[num
-1]);
2048 if (read_write
== I2C_SMBUS_READ
)
2050 case I2C_SMBUS_BYTE
:
2051 data
->byte
= msgbuf0
[0];
2053 case I2C_SMBUS_BYTE_DATA
:
2054 data
->byte
= msgbuf1
[0];
2056 case I2C_SMBUS_WORD_DATA
:
2057 case I2C_SMBUS_PROC_CALL
:
2058 data
->word
= msgbuf1
[0] | (msgbuf1
[1] << 8);
2060 case I2C_SMBUS_I2C_BLOCK_DATA
:
2061 for (i
= 0; i
< data
->block
[0]; i
++)
2062 data
->block
[i
+1] = msgbuf1
[i
];
2064 case I2C_SMBUS_BLOCK_DATA
:
2065 case I2C_SMBUS_BLOCK_PROC_CALL
:
2066 for (i
= 0; i
< msgbuf1
[0] + 1; i
++)
2067 data
->block
[i
] = msgbuf1
[i
];
2074 * i2c_smbus_xfer - execute SMBus protocol operations
2075 * @adapter: Handle to I2C bus
2076 * @addr: Address of SMBus slave on that bus
2077 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
2078 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
2079 * @command: Byte interpreted by slave, for protocols which use such bytes
2080 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
2081 * @data: Data to be read or written
2083 * This executes an SMBus protocol operation, and returns a negative
2084 * errno code else zero on success.
2086 s32
i2c_smbus_xfer(struct i2c_adapter
*adapter
, u16 addr
, unsigned short flags
,
2087 char read_write
, u8 command
, int protocol
,
2088 union i2c_smbus_data
*data
)
2090 unsigned long orig_jiffies
;
2094 flags
&= I2C_M_TEN
| I2C_CLIENT_PEC
;
2096 if (adapter
->algo
->smbus_xfer
) {
2097 i2c_lock_adapter(adapter
);
2099 /* Retry automatically on arbitration loss */
2100 orig_jiffies
= jiffies
;
2101 for (res
= 0, try = 0; try <= adapter
->retries
; try++) {
2102 res
= adapter
->algo
->smbus_xfer(adapter
, addr
, flags
,
2103 read_write
, command
,
2107 if (time_after(jiffies
,
2108 orig_jiffies
+ adapter
->timeout
))
2111 i2c_unlock_adapter(adapter
);
2113 res
= i2c_smbus_xfer_emulated(adapter
, addr
, flags
, read_write
,
2114 command
, protocol
, data
);
2118 EXPORT_SYMBOL(i2c_smbus_xfer
);
2120 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2121 MODULE_DESCRIPTION("I2C-Bus main module");
2122 MODULE_LICENSE("GPL");