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 purposely 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
, "%s: attach_adapter method is deprecated\n",
801 driver
->driver
.name
);
802 dev_warn(&adap
->dev
, "Please use another way to instantiate "
803 "your i2c_client\n");
804 /* We ignore the return code; if it fails, too bad */
805 driver
->attach_adapter(adap
);
810 static int __process_new_adapter(struct device_driver
*d
, void *data
)
812 return i2c_do_add_adapter(to_i2c_driver(d
), data
);
815 static int i2c_register_adapter(struct i2c_adapter
*adap
)
819 /* Can't register until after driver model init */
820 if (unlikely(WARN_ON(!i2c_bus_type
.p
))) {
826 if (unlikely(adap
->name
[0] == '\0')) {
827 pr_err("i2c-core: Attempt to register an adapter with "
831 if (unlikely(!adap
->algo
)) {
832 pr_err("i2c-core: Attempt to register adapter '%s' with "
833 "no algo!\n", adap
->name
);
837 rt_mutex_init(&adap
->bus_lock
);
838 mutex_init(&adap
->userspace_clients_lock
);
839 INIT_LIST_HEAD(&adap
->userspace_clients
);
841 /* Set default timeout to 1 second if not already set */
842 if (adap
->timeout
== 0)
845 dev_set_name(&adap
->dev
, "i2c-%d", adap
->nr
);
846 adap
->dev
.bus
= &i2c_bus_type
;
847 adap
->dev
.type
= &i2c_adapter_type
;
848 res
= device_register(&adap
->dev
);
852 dev_dbg(&adap
->dev
, "adapter [%s] registered\n", adap
->name
);
854 #ifdef CONFIG_I2C_COMPAT
855 res
= class_compat_create_link(i2c_adapter_compat_class
, &adap
->dev
,
859 "Failed to create compatibility class link\n");
862 /* create pre-declared device nodes */
863 if (adap
->nr
< __i2c_first_dynamic_bus_num
)
864 i2c_scan_static_board_info(adap
);
867 mutex_lock(&core_lock
);
868 bus_for_each_drv(&i2c_bus_type
, NULL
, adap
, __process_new_adapter
);
869 mutex_unlock(&core_lock
);
874 mutex_lock(&core_lock
);
875 idr_remove(&i2c_adapter_idr
, adap
->nr
);
876 mutex_unlock(&core_lock
);
881 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
882 * @adapter: the adapter to add
885 * This routine is used to declare an I2C adapter when its bus number
886 * doesn't matter. Examples: for I2C adapters dynamically added by
887 * USB links or PCI plugin cards.
889 * When this returns zero, a new bus number was allocated and stored
890 * in adap->nr, and the specified adapter became available for clients.
891 * Otherwise, a negative errno value is returned.
893 int i2c_add_adapter(struct i2c_adapter
*adapter
)
898 if (idr_pre_get(&i2c_adapter_idr
, GFP_KERNEL
) == 0)
901 mutex_lock(&core_lock
);
902 /* "above" here means "above or equal to", sigh */
903 res
= idr_get_new_above(&i2c_adapter_idr
, adapter
,
904 __i2c_first_dynamic_bus_num
, &id
);
905 mutex_unlock(&core_lock
);
914 return i2c_register_adapter(adapter
);
916 EXPORT_SYMBOL(i2c_add_adapter
);
919 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
920 * @adap: the adapter to register (with adap->nr initialized)
923 * This routine is used to declare an I2C adapter when its bus number
924 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
925 * or otherwise built in to the system's mainboard, and where i2c_board_info
926 * is used to properly configure I2C devices.
928 * If no devices have pre-been declared for this bus, then be sure to
929 * register the adapter before any dynamically allocated ones. Otherwise
930 * the required bus ID may not be available.
932 * When this returns zero, the specified adapter became available for
933 * clients using the bus number provided in adap->nr. Also, the table
934 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
935 * and the appropriate driver model device nodes are created. Otherwise, a
936 * negative errno value is returned.
938 int i2c_add_numbered_adapter(struct i2c_adapter
*adap
)
943 if (adap
->nr
& ~MAX_ID_MASK
)
947 if (idr_pre_get(&i2c_adapter_idr
, GFP_KERNEL
) == 0)
950 mutex_lock(&core_lock
);
951 /* "above" here means "above or equal to", sigh;
952 * we need the "equal to" result to force the result
954 status
= idr_get_new_above(&i2c_adapter_idr
, adap
, adap
->nr
, &id
);
955 if (status
== 0 && id
!= adap
->nr
) {
957 idr_remove(&i2c_adapter_idr
, id
);
959 mutex_unlock(&core_lock
);
960 if (status
== -EAGAIN
)
964 status
= i2c_register_adapter(adap
);
967 EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter
);
969 static int i2c_do_del_adapter(struct i2c_driver
*driver
,
970 struct i2c_adapter
*adapter
)
972 struct i2c_client
*client
, *_n
;
975 /* Remove the devices we created ourselves as the result of hardware
976 * probing (using a driver's detect method) */
977 list_for_each_entry_safe(client
, _n
, &driver
->clients
, detected
) {
978 if (client
->adapter
== adapter
) {
979 dev_dbg(&adapter
->dev
, "Removing %s at 0x%x\n",
980 client
->name
, client
->addr
);
981 list_del(&client
->detected
);
982 i2c_unregister_device(client
);
986 if (!driver
->detach_adapter
)
988 dev_warn(&adapter
->dev
, "%s: detach_adapter method is deprecated\n",
989 driver
->driver
.name
);
990 res
= driver
->detach_adapter(adapter
);
992 dev_err(&adapter
->dev
, "detach_adapter failed (%d) "
993 "for driver [%s]\n", res
, driver
->driver
.name
);
997 static int __unregister_client(struct device
*dev
, void *dummy
)
999 struct i2c_client
*client
= i2c_verify_client(dev
);
1000 if (client
&& strcmp(client
->name
, "dummy"))
1001 i2c_unregister_device(client
);
1005 static int __unregister_dummy(struct device
*dev
, void *dummy
)
1007 struct i2c_client
*client
= i2c_verify_client(dev
);
1009 i2c_unregister_device(client
);
1013 static int __process_removed_adapter(struct device_driver
*d
, void *data
)
1015 return i2c_do_del_adapter(to_i2c_driver(d
), data
);
1019 * i2c_del_adapter - unregister I2C adapter
1020 * @adap: the adapter being unregistered
1021 * Context: can sleep
1023 * This unregisters an I2C adapter which was previously registered
1024 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1026 int i2c_del_adapter(struct i2c_adapter
*adap
)
1029 struct i2c_adapter
*found
;
1030 struct i2c_client
*client
, *next
;
1032 /* First make sure that this adapter was ever added */
1033 mutex_lock(&core_lock
);
1034 found
= idr_find(&i2c_adapter_idr
, adap
->nr
);
1035 mutex_unlock(&core_lock
);
1036 if (found
!= adap
) {
1037 pr_debug("i2c-core: attempting to delete unregistered "
1038 "adapter [%s]\n", adap
->name
);
1042 /* Tell drivers about this removal */
1043 mutex_lock(&core_lock
);
1044 res
= bus_for_each_drv(&i2c_bus_type
, NULL
, adap
,
1045 __process_removed_adapter
);
1046 mutex_unlock(&core_lock
);
1050 /* Remove devices instantiated from sysfs */
1051 mutex_lock(&adap
->userspace_clients_lock
);
1052 list_for_each_entry_safe(client
, next
, &adap
->userspace_clients
,
1054 dev_dbg(&adap
->dev
, "Removing %s at 0x%x\n", client
->name
,
1056 list_del(&client
->detected
);
1057 i2c_unregister_device(client
);
1059 mutex_unlock(&adap
->userspace_clients_lock
);
1061 /* Detach any active clients. This can't fail, thus we do not
1062 * check the returned value. This is a two-pass process, because
1063 * we can't remove the dummy devices during the first pass: they
1064 * could have been instantiated by real devices wishing to clean
1065 * them up properly, so we give them a chance to do that first. */
1066 res
= device_for_each_child(&adap
->dev
, NULL
, __unregister_client
);
1067 res
= device_for_each_child(&adap
->dev
, NULL
, __unregister_dummy
);
1069 #ifdef CONFIG_I2C_COMPAT
1070 class_compat_remove_link(i2c_adapter_compat_class
, &adap
->dev
,
1074 /* device name is gone after device_unregister */
1075 dev_dbg(&adap
->dev
, "adapter [%s] unregistered\n", adap
->name
);
1077 /* clean up the sysfs representation */
1078 init_completion(&adap
->dev_released
);
1079 device_unregister(&adap
->dev
);
1081 /* wait for sysfs to drop all references */
1082 wait_for_completion(&adap
->dev_released
);
1085 mutex_lock(&core_lock
);
1086 idr_remove(&i2c_adapter_idr
, adap
->nr
);
1087 mutex_unlock(&core_lock
);
1089 /* Clear the device structure in case this adapter is ever going to be
1091 memset(&adap
->dev
, 0, sizeof(adap
->dev
));
1095 EXPORT_SYMBOL(i2c_del_adapter
);
1098 /* ------------------------------------------------------------------------- */
1100 int i2c_for_each_dev(void *data
, int (*fn
)(struct device
*, void *))
1104 mutex_lock(&core_lock
);
1105 res
= bus_for_each_dev(&i2c_bus_type
, NULL
, data
, fn
);
1106 mutex_unlock(&core_lock
);
1110 EXPORT_SYMBOL_GPL(i2c_for_each_dev
);
1112 static int __process_new_driver(struct device
*dev
, void *data
)
1114 if (dev
->type
!= &i2c_adapter_type
)
1116 return i2c_do_add_adapter(data
, to_i2c_adapter(dev
));
1120 * An i2c_driver is used with one or more i2c_client (device) nodes to access
1121 * i2c slave chips, on a bus instance associated with some i2c_adapter.
1124 int i2c_register_driver(struct module
*owner
, struct i2c_driver
*driver
)
1128 /* Can't register until after driver model init */
1129 if (unlikely(WARN_ON(!i2c_bus_type
.p
)))
1132 /* add the driver to the list of i2c drivers in the driver core */
1133 driver
->driver
.owner
= owner
;
1134 driver
->driver
.bus
= &i2c_bus_type
;
1136 /* When registration returns, the driver core
1137 * will have called probe() for all matching-but-unbound devices.
1139 res
= driver_register(&driver
->driver
);
1143 /* Drivers should switch to dev_pm_ops instead. */
1144 if (driver
->suspend
)
1145 pr_warn("i2c-core: driver [%s] using legacy suspend method\n",
1146 driver
->driver
.name
);
1148 pr_warn("i2c-core: driver [%s] using legacy resume method\n",
1149 driver
->driver
.name
);
1151 pr_debug("i2c-core: driver [%s] registered\n", driver
->driver
.name
);
1153 INIT_LIST_HEAD(&driver
->clients
);
1154 /* Walk the adapters that are already present */
1155 i2c_for_each_dev(driver
, __process_new_driver
);
1159 EXPORT_SYMBOL(i2c_register_driver
);
1161 static int __process_removed_driver(struct device
*dev
, void *data
)
1163 if (dev
->type
!= &i2c_adapter_type
)
1165 return i2c_do_del_adapter(data
, to_i2c_adapter(dev
));
1169 * i2c_del_driver - unregister I2C driver
1170 * @driver: the driver being unregistered
1171 * Context: can sleep
1173 void i2c_del_driver(struct i2c_driver
*driver
)
1175 i2c_for_each_dev(driver
, __process_removed_driver
);
1177 driver_unregister(&driver
->driver
);
1178 pr_debug("i2c-core: driver [%s] unregistered\n", driver
->driver
.name
);
1180 EXPORT_SYMBOL(i2c_del_driver
);
1182 /* ------------------------------------------------------------------------- */
1185 * i2c_use_client - increments the reference count of the i2c client structure
1186 * @client: the client being referenced
1188 * Each live reference to a client should be refcounted. The driver model does
1189 * that automatically as part of driver binding, so that most drivers don't
1190 * need to do this explicitly: they hold a reference until they're unbound
1193 * A pointer to the client with the incremented reference counter is returned.
1195 struct i2c_client
*i2c_use_client(struct i2c_client
*client
)
1197 if (client
&& get_device(&client
->dev
))
1201 EXPORT_SYMBOL(i2c_use_client
);
1204 * i2c_release_client - release a use of the i2c client structure
1205 * @client: the client being no longer referenced
1207 * Must be called when a user of a client is finished with it.
1209 void i2c_release_client(struct i2c_client
*client
)
1212 put_device(&client
->dev
);
1214 EXPORT_SYMBOL(i2c_release_client
);
1216 struct i2c_cmd_arg
{
1221 static int i2c_cmd(struct device
*dev
, void *_arg
)
1223 struct i2c_client
*client
= i2c_verify_client(dev
);
1224 struct i2c_cmd_arg
*arg
= _arg
;
1226 if (client
&& client
->driver
&& client
->driver
->command
)
1227 client
->driver
->command(client
, arg
->cmd
, arg
->arg
);
1231 void i2c_clients_command(struct i2c_adapter
*adap
, unsigned int cmd
, void *arg
)
1233 struct i2c_cmd_arg cmd_arg
;
1237 device_for_each_child(&adap
->dev
, &cmd_arg
, i2c_cmd
);
1239 EXPORT_SYMBOL(i2c_clients_command
);
1241 static int __init
i2c_init(void)
1245 retval
= bus_register(&i2c_bus_type
);
1248 #ifdef CONFIG_I2C_COMPAT
1249 i2c_adapter_compat_class
= class_compat_register("i2c-adapter");
1250 if (!i2c_adapter_compat_class
) {
1255 retval
= i2c_add_driver(&dummy_driver
);
1261 #ifdef CONFIG_I2C_COMPAT
1262 class_compat_unregister(i2c_adapter_compat_class
);
1265 bus_unregister(&i2c_bus_type
);
1269 static void __exit
i2c_exit(void)
1271 i2c_del_driver(&dummy_driver
);
1272 #ifdef CONFIG_I2C_COMPAT
1273 class_compat_unregister(i2c_adapter_compat_class
);
1275 bus_unregister(&i2c_bus_type
);
1278 /* We must initialize early, because some subsystems register i2c drivers
1279 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1281 postcore_initcall(i2c_init
);
1282 module_exit(i2c_exit
);
1284 /* ----------------------------------------------------
1285 * the functional interface to the i2c busses.
1286 * ----------------------------------------------------
1290 * i2c_transfer - execute a single or combined I2C message
1291 * @adap: Handle to I2C bus
1292 * @msgs: One or more messages to execute before STOP is issued to
1293 * terminate the operation; each message begins with a START.
1294 * @num: Number of messages to be executed.
1296 * Returns negative errno, else the number of messages executed.
1298 * Note that there is no requirement that each message be sent to
1299 * the same slave address, although that is the most common model.
1301 int i2c_transfer(struct i2c_adapter
*adap
, struct i2c_msg
*msgs
, int num
)
1303 unsigned long orig_jiffies
;
1306 /* REVISIT the fault reporting model here is weak:
1308 * - When we get an error after receiving N bytes from a slave,
1309 * there is no way to report "N".
1311 * - When we get a NAK after transmitting N bytes to a slave,
1312 * there is no way to report "N" ... or to let the master
1313 * continue executing the rest of this combined message, if
1314 * that's the appropriate response.
1316 * - When for example "num" is two and we successfully complete
1317 * the first message but get an error part way through the
1318 * second, it's unclear whether that should be reported as
1319 * one (discarding status on the second message) or errno
1320 * (discarding status on the first one).
1323 if (adap
->algo
->master_xfer
) {
1325 for (ret
= 0; ret
< num
; ret
++) {
1326 dev_dbg(&adap
->dev
, "master_xfer[%d] %c, addr=0x%02x, "
1327 "len=%d%s\n", ret
, (msgs
[ret
].flags
& I2C_M_RD
)
1328 ? 'R' : 'W', msgs
[ret
].addr
, msgs
[ret
].len
,
1329 (msgs
[ret
].flags
& I2C_M_RECV_LEN
) ? "+" : "");
1333 if (in_atomic() || irqs_disabled()) {
1334 ret
= i2c_trylock_adapter(adap
);
1336 /* I2C activity is ongoing. */
1339 i2c_lock_adapter(adap
);
1342 /* Retry automatically on arbitration loss */
1343 orig_jiffies
= jiffies
;
1344 for (ret
= 0, try = 0; try <= adap
->retries
; try++) {
1345 ret
= adap
->algo
->master_xfer(adap
, msgs
, num
);
1348 if (time_after(jiffies
, orig_jiffies
+ adap
->timeout
))
1351 i2c_unlock_adapter(adap
);
1355 dev_dbg(&adap
->dev
, "I2C level transfers not supported\n");
1359 EXPORT_SYMBOL(i2c_transfer
);
1362 * i2c_master_send - issue a single I2C message in master transmit mode
1363 * @client: Handle to slave device
1364 * @buf: Data that will be written to the slave
1365 * @count: How many bytes to write, must be less than 64k since msg.len is u16
1367 * Returns negative errno, or else the number of bytes written.
1369 int i2c_master_send(const struct i2c_client
*client
, const char *buf
, int count
)
1372 struct i2c_adapter
*adap
= client
->adapter
;
1375 msg
.addr
= client
->addr
;
1376 msg
.flags
= client
->flags
& I2C_M_TEN
;
1378 msg
.buf
= (char *)buf
;
1380 ret
= i2c_transfer(adap
, &msg
, 1);
1382 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1383 transmitted, else error code. */
1384 return (ret
== 1) ? count
: ret
;
1386 EXPORT_SYMBOL(i2c_master_send
);
1389 * i2c_master_recv - issue a single I2C message in master receive mode
1390 * @client: Handle to slave device
1391 * @buf: Where to store data read from slave
1392 * @count: How many bytes to read, must be less than 64k since msg.len is u16
1394 * Returns negative errno, or else the number of bytes read.
1396 int i2c_master_recv(const struct i2c_client
*client
, char *buf
, int count
)
1398 struct i2c_adapter
*adap
= client
->adapter
;
1402 msg
.addr
= client
->addr
;
1403 msg
.flags
= client
->flags
& I2C_M_TEN
;
1404 msg
.flags
|= I2C_M_RD
;
1408 ret
= i2c_transfer(adap
, &msg
, 1);
1410 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1411 transmitted, else error code. */
1412 return (ret
== 1) ? count
: ret
;
1414 EXPORT_SYMBOL(i2c_master_recv
);
1416 /* ----------------------------------------------------
1417 * the i2c address scanning function
1418 * Will not work for 10-bit addresses!
1419 * ----------------------------------------------------
1423 * Legacy default probe function, mostly relevant for SMBus. The default
1424 * probe method is a quick write, but it is known to corrupt the 24RF08
1425 * EEPROMs due to a state machine bug, and could also irreversibly
1426 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
1427 * we use a short byte read instead. Also, some bus drivers don't implement
1428 * quick write, so we fallback to a byte read in that case too.
1429 * On x86, there is another special case for FSC hardware monitoring chips,
1430 * which want regular byte reads (address 0x73.) Fortunately, these are the
1431 * only known chips using this I2C address on PC hardware.
1432 * Returns 1 if probe succeeded, 0 if not.
1434 static int i2c_default_probe(struct i2c_adapter
*adap
, unsigned short addr
)
1437 union i2c_smbus_data dummy
;
1440 if (addr
== 0x73 && (adap
->class & I2C_CLASS_HWMON
)
1441 && i2c_check_functionality(adap
, I2C_FUNC_SMBUS_READ_BYTE_DATA
))
1442 err
= i2c_smbus_xfer(adap
, addr
, 0, I2C_SMBUS_READ
, 0,
1443 I2C_SMBUS_BYTE_DATA
, &dummy
);
1446 if (!((addr
& ~0x07) == 0x30 || (addr
& ~0x0f) == 0x50)
1447 && i2c_check_functionality(adap
, I2C_FUNC_SMBUS_QUICK
))
1448 err
= i2c_smbus_xfer(adap
, addr
, 0, I2C_SMBUS_WRITE
, 0,
1449 I2C_SMBUS_QUICK
, NULL
);
1450 else if (i2c_check_functionality(adap
, I2C_FUNC_SMBUS_READ_BYTE
))
1451 err
= i2c_smbus_xfer(adap
, addr
, 0, I2C_SMBUS_READ
, 0,
1452 I2C_SMBUS_BYTE
, &dummy
);
1454 dev_warn(&adap
->dev
, "No suitable probing method supported\n");
1461 static int i2c_detect_address(struct i2c_client
*temp_client
,
1462 struct i2c_driver
*driver
)
1464 struct i2c_board_info info
;
1465 struct i2c_adapter
*adapter
= temp_client
->adapter
;
1466 int addr
= temp_client
->addr
;
1469 /* Make sure the address is valid */
1470 err
= i2c_check_addr_validity(addr
);
1472 dev_warn(&adapter
->dev
, "Invalid probe address 0x%02x\n",
1477 /* Skip if already in use */
1478 if (i2c_check_addr_busy(adapter
, addr
))
1481 /* Make sure there is something at this address */
1482 if (!i2c_default_probe(adapter
, addr
))
1485 /* Finally call the custom detection function */
1486 memset(&info
, 0, sizeof(struct i2c_board_info
));
1488 err
= driver
->detect(temp_client
, &info
);
1490 /* -ENODEV is returned if the detection fails. We catch it
1491 here as this isn't an error. */
1492 return err
== -ENODEV
? 0 : err
;
1495 /* Consistency check */
1496 if (info
.type
[0] == '\0') {
1497 dev_err(&adapter
->dev
, "%s detection function provided "
1498 "no name for 0x%x\n", driver
->driver
.name
,
1501 struct i2c_client
*client
;
1503 /* Detection succeeded, instantiate the device */
1504 dev_dbg(&adapter
->dev
, "Creating %s at 0x%02x\n",
1505 info
.type
, info
.addr
);
1506 client
= i2c_new_device(adapter
, &info
);
1508 list_add_tail(&client
->detected
, &driver
->clients
);
1510 dev_err(&adapter
->dev
, "Failed creating %s at 0x%02x\n",
1511 info
.type
, info
.addr
);
1516 static int i2c_detect(struct i2c_adapter
*adapter
, struct i2c_driver
*driver
)
1518 const unsigned short *address_list
;
1519 struct i2c_client
*temp_client
;
1521 int adap_id
= i2c_adapter_id(adapter
);
1523 address_list
= driver
->address_list
;
1524 if (!driver
->detect
|| !address_list
)
1527 /* Stop here if the classes do not match */
1528 if (!(adapter
->class & driver
->class))
1531 /* Set up a temporary client to help detect callback */
1532 temp_client
= kzalloc(sizeof(struct i2c_client
), GFP_KERNEL
);
1535 temp_client
->adapter
= adapter
;
1537 for (i
= 0; address_list
[i
] != I2C_CLIENT_END
; i
+= 1) {
1538 dev_dbg(&adapter
->dev
, "found normal entry for adapter %d, "
1539 "addr 0x%02x\n", adap_id
, address_list
[i
]);
1540 temp_client
->addr
= address_list
[i
];
1541 err
= i2c_detect_address(temp_client
, driver
);
1550 int i2c_probe_func_quick_read(struct i2c_adapter
*adap
, unsigned short addr
)
1552 return i2c_smbus_xfer(adap
, addr
, 0, I2C_SMBUS_READ
, 0,
1553 I2C_SMBUS_QUICK
, NULL
) >= 0;
1555 EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read
);
1558 i2c_new_probed_device(struct i2c_adapter
*adap
,
1559 struct i2c_board_info
*info
,
1560 unsigned short const *addr_list
,
1561 int (*probe
)(struct i2c_adapter
*, unsigned short addr
))
1566 probe
= i2c_default_probe
;
1568 for (i
= 0; addr_list
[i
] != I2C_CLIENT_END
; i
++) {
1569 /* Check address validity */
1570 if (i2c_check_addr_validity(addr_list
[i
]) < 0) {
1571 dev_warn(&adap
->dev
, "Invalid 7-bit address "
1572 "0x%02x\n", addr_list
[i
]);
1576 /* Check address availability */
1577 if (i2c_check_addr_busy(adap
, addr_list
[i
])) {
1578 dev_dbg(&adap
->dev
, "Address 0x%02x already in "
1579 "use, not probing\n", addr_list
[i
]);
1583 /* Test address responsiveness */
1584 if (probe(adap
, addr_list
[i
]))
1588 if (addr_list
[i
] == I2C_CLIENT_END
) {
1589 dev_dbg(&adap
->dev
, "Probing failed, no device found\n");
1593 info
->addr
= addr_list
[i
];
1594 return i2c_new_device(adap
, info
);
1596 EXPORT_SYMBOL_GPL(i2c_new_probed_device
);
1598 struct i2c_adapter
*i2c_get_adapter(int nr
)
1600 struct i2c_adapter
*adapter
;
1602 mutex_lock(&core_lock
);
1603 adapter
= idr_find(&i2c_adapter_idr
, nr
);
1604 if (adapter
&& !try_module_get(adapter
->owner
))
1607 mutex_unlock(&core_lock
);
1610 EXPORT_SYMBOL(i2c_get_adapter
);
1612 void i2c_put_adapter(struct i2c_adapter
*adap
)
1614 module_put(adap
->owner
);
1616 EXPORT_SYMBOL(i2c_put_adapter
);
1618 /* The SMBus parts */
1620 #define POLY (0x1070U << 3)
1621 static u8
crc8(u16 data
)
1625 for (i
= 0; i
< 8; i
++) {
1630 return (u8
)(data
>> 8);
1633 /* Incremental CRC8 over count bytes in the array pointed to by p */
1634 static u8
i2c_smbus_pec(u8 crc
, u8
*p
, size_t count
)
1638 for (i
= 0; i
< count
; i
++)
1639 crc
= crc8((crc
^ p
[i
]) << 8);
1643 /* Assume a 7-bit address, which is reasonable for SMBus */
1644 static u8
i2c_smbus_msg_pec(u8 pec
, struct i2c_msg
*msg
)
1646 /* The address will be sent first */
1647 u8 addr
= (msg
->addr
<< 1) | !!(msg
->flags
& I2C_M_RD
);
1648 pec
= i2c_smbus_pec(pec
, &addr
, 1);
1650 /* The data buffer follows */
1651 return i2c_smbus_pec(pec
, msg
->buf
, msg
->len
);
1654 /* Used for write only transactions */
1655 static inline void i2c_smbus_add_pec(struct i2c_msg
*msg
)
1657 msg
->buf
[msg
->len
] = i2c_smbus_msg_pec(0, msg
);
1661 /* Return <0 on CRC error
1662 If there was a write before this read (most cases) we need to take the
1663 partial CRC from the write part into account.
1664 Note that this function does modify the message (we need to decrease the
1665 message length to hide the CRC byte from the caller). */
1666 static int i2c_smbus_check_pec(u8 cpec
, struct i2c_msg
*msg
)
1668 u8 rpec
= msg
->buf
[--msg
->len
];
1669 cpec
= i2c_smbus_msg_pec(cpec
, msg
);
1672 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1680 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1681 * @client: Handle to slave device
1683 * This executes the SMBus "receive byte" protocol, returning negative errno
1684 * else the byte received from the device.
1686 s32
i2c_smbus_read_byte(const struct i2c_client
*client
)
1688 union i2c_smbus_data data
;
1691 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1693 I2C_SMBUS_BYTE
, &data
);
1694 return (status
< 0) ? status
: data
.byte
;
1696 EXPORT_SYMBOL(i2c_smbus_read_byte
);
1699 * i2c_smbus_write_byte - SMBus "send byte" protocol
1700 * @client: Handle to slave device
1701 * @value: Byte to be sent
1703 * This executes the SMBus "send byte" protocol, returning negative errno
1704 * else zero on success.
1706 s32
i2c_smbus_write_byte(const struct i2c_client
*client
, u8 value
)
1708 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1709 I2C_SMBUS_WRITE
, value
, I2C_SMBUS_BYTE
, NULL
);
1711 EXPORT_SYMBOL(i2c_smbus_write_byte
);
1714 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1715 * @client: Handle to slave device
1716 * @command: Byte interpreted by slave
1718 * This executes the SMBus "read byte" protocol, returning negative errno
1719 * else a data byte received from the device.
1721 s32
i2c_smbus_read_byte_data(const struct i2c_client
*client
, u8 command
)
1723 union i2c_smbus_data data
;
1726 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1727 I2C_SMBUS_READ
, command
,
1728 I2C_SMBUS_BYTE_DATA
, &data
);
1729 return (status
< 0) ? status
: data
.byte
;
1731 EXPORT_SYMBOL(i2c_smbus_read_byte_data
);
1734 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1735 * @client: Handle to slave device
1736 * @command: Byte interpreted by slave
1737 * @value: Byte being written
1739 * This executes the SMBus "write byte" protocol, returning negative errno
1740 * else zero on success.
1742 s32
i2c_smbus_write_byte_data(const struct i2c_client
*client
, u8 command
,
1745 union i2c_smbus_data data
;
1747 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1748 I2C_SMBUS_WRITE
, command
,
1749 I2C_SMBUS_BYTE_DATA
, &data
);
1751 EXPORT_SYMBOL(i2c_smbus_write_byte_data
);
1754 * i2c_smbus_read_word_data - SMBus "read word" protocol
1755 * @client: Handle to slave device
1756 * @command: Byte interpreted by slave
1758 * This executes the SMBus "read word" protocol, returning negative errno
1759 * else a 16-bit unsigned "word" received from the device.
1761 s32
i2c_smbus_read_word_data(const struct i2c_client
*client
, u8 command
)
1763 union i2c_smbus_data data
;
1766 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1767 I2C_SMBUS_READ
, command
,
1768 I2C_SMBUS_WORD_DATA
, &data
);
1769 return (status
< 0) ? status
: data
.word
;
1771 EXPORT_SYMBOL(i2c_smbus_read_word_data
);
1774 * i2c_smbus_write_word_data - SMBus "write word" protocol
1775 * @client: Handle to slave device
1776 * @command: Byte interpreted by slave
1777 * @value: 16-bit "word" being written
1779 * This executes the SMBus "write word" protocol, returning negative errno
1780 * else zero on success.
1782 s32
i2c_smbus_write_word_data(const struct i2c_client
*client
, u8 command
,
1785 union i2c_smbus_data data
;
1787 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1788 I2C_SMBUS_WRITE
, command
,
1789 I2C_SMBUS_WORD_DATA
, &data
);
1791 EXPORT_SYMBOL(i2c_smbus_write_word_data
);
1794 * i2c_smbus_process_call - SMBus "process call" protocol
1795 * @client: Handle to slave device
1796 * @command: Byte interpreted by slave
1797 * @value: 16-bit "word" being written
1799 * This executes the SMBus "process call" protocol, returning negative errno
1800 * else a 16-bit unsigned "word" received from the device.
1802 s32
i2c_smbus_process_call(const struct i2c_client
*client
, u8 command
,
1805 union i2c_smbus_data data
;
1809 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1810 I2C_SMBUS_WRITE
, command
,
1811 I2C_SMBUS_PROC_CALL
, &data
);
1812 return (status
< 0) ? status
: data
.word
;
1814 EXPORT_SYMBOL(i2c_smbus_process_call
);
1817 * i2c_smbus_read_block_data - SMBus "block read" protocol
1818 * @client: Handle to slave device
1819 * @command: Byte interpreted by slave
1820 * @values: Byte array into which data will be read; big enough to hold
1821 * the data returned by the slave. SMBus allows at most 32 bytes.
1823 * This executes the SMBus "block read" protocol, returning negative errno
1824 * else the number of data bytes in the slave's response.
1826 * Note that using this function requires that the client's adapter support
1827 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1828 * support this; its emulation through I2C messaging relies on a specific
1829 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1831 s32
i2c_smbus_read_block_data(const struct i2c_client
*client
, u8 command
,
1834 union i2c_smbus_data data
;
1837 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1838 I2C_SMBUS_READ
, command
,
1839 I2C_SMBUS_BLOCK_DATA
, &data
);
1843 memcpy(values
, &data
.block
[1], data
.block
[0]);
1844 return data
.block
[0];
1846 EXPORT_SYMBOL(i2c_smbus_read_block_data
);
1849 * i2c_smbus_write_block_data - SMBus "block write" protocol
1850 * @client: Handle to slave device
1851 * @command: Byte interpreted by slave
1852 * @length: Size of data block; SMBus allows at most 32 bytes
1853 * @values: Byte array which will be written.
1855 * This executes the SMBus "block write" protocol, returning negative errno
1856 * else zero on success.
1858 s32
i2c_smbus_write_block_data(const struct i2c_client
*client
, u8 command
,
1859 u8 length
, const u8
*values
)
1861 union i2c_smbus_data data
;
1863 if (length
> I2C_SMBUS_BLOCK_MAX
)
1864 length
= I2C_SMBUS_BLOCK_MAX
;
1865 data
.block
[0] = length
;
1866 memcpy(&data
.block
[1], values
, length
);
1867 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1868 I2C_SMBUS_WRITE
, command
,
1869 I2C_SMBUS_BLOCK_DATA
, &data
);
1871 EXPORT_SYMBOL(i2c_smbus_write_block_data
);
1873 /* Returns the number of read bytes */
1874 s32
i2c_smbus_read_i2c_block_data(const struct i2c_client
*client
, u8 command
,
1875 u8 length
, u8
*values
)
1877 union i2c_smbus_data data
;
1880 if (length
> I2C_SMBUS_BLOCK_MAX
)
1881 length
= I2C_SMBUS_BLOCK_MAX
;
1882 data
.block
[0] = length
;
1883 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1884 I2C_SMBUS_READ
, command
,
1885 I2C_SMBUS_I2C_BLOCK_DATA
, &data
);
1889 memcpy(values
, &data
.block
[1], data
.block
[0]);
1890 return data
.block
[0];
1892 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data
);
1894 s32
i2c_smbus_write_i2c_block_data(const struct i2c_client
*client
, u8 command
,
1895 u8 length
, const u8
*values
)
1897 union i2c_smbus_data data
;
1899 if (length
> I2C_SMBUS_BLOCK_MAX
)
1900 length
= I2C_SMBUS_BLOCK_MAX
;
1901 data
.block
[0] = length
;
1902 memcpy(data
.block
+ 1, values
, length
);
1903 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
1904 I2C_SMBUS_WRITE
, command
,
1905 I2C_SMBUS_I2C_BLOCK_DATA
, &data
);
1907 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data
);
1909 /* Simulate a SMBus command using the i2c protocol
1910 No checking of parameters is done! */
1911 static s32
i2c_smbus_xfer_emulated(struct i2c_adapter
*adapter
, u16 addr
,
1912 unsigned short flags
,
1913 char read_write
, u8 command
, int size
,
1914 union i2c_smbus_data
*data
)
1916 /* So we need to generate a series of msgs. In the case of writing, we
1917 need to use only one message; when reading, we need two. We initialize
1918 most things with sane defaults, to keep the code below somewhat
1920 unsigned char msgbuf0
[I2C_SMBUS_BLOCK_MAX
+3];
1921 unsigned char msgbuf1
[I2C_SMBUS_BLOCK_MAX
+2];
1922 int num
= read_write
== I2C_SMBUS_READ
? 2 : 1;
1923 struct i2c_msg msg
[2] = { { addr
, flags
, 1, msgbuf0
},
1924 { addr
, flags
| I2C_M_RD
, 0, msgbuf1
}
1930 msgbuf0
[0] = command
;
1932 case I2C_SMBUS_QUICK
:
1934 /* Special case: The read/write field is used as data */
1935 msg
[0].flags
= flags
| (read_write
== I2C_SMBUS_READ
?
1939 case I2C_SMBUS_BYTE
:
1940 if (read_write
== I2C_SMBUS_READ
) {
1941 /* Special case: only a read! */
1942 msg
[0].flags
= I2C_M_RD
| flags
;
1946 case I2C_SMBUS_BYTE_DATA
:
1947 if (read_write
== I2C_SMBUS_READ
)
1951 msgbuf0
[1] = data
->byte
;
1954 case I2C_SMBUS_WORD_DATA
:
1955 if (read_write
== I2C_SMBUS_READ
)
1959 msgbuf0
[1] = data
->word
& 0xff;
1960 msgbuf0
[2] = data
->word
>> 8;
1963 case I2C_SMBUS_PROC_CALL
:
1964 num
= 2; /* Special case */
1965 read_write
= I2C_SMBUS_READ
;
1968 msgbuf0
[1] = data
->word
& 0xff;
1969 msgbuf0
[2] = data
->word
>> 8;
1971 case I2C_SMBUS_BLOCK_DATA
:
1972 if (read_write
== I2C_SMBUS_READ
) {
1973 msg
[1].flags
|= I2C_M_RECV_LEN
;
1974 msg
[1].len
= 1; /* block length will be added by
1975 the underlying bus driver */
1977 msg
[0].len
= data
->block
[0] + 2;
1978 if (msg
[0].len
> I2C_SMBUS_BLOCK_MAX
+ 2) {
1979 dev_err(&adapter
->dev
,
1980 "Invalid block write size %d\n",
1984 for (i
= 1; i
< msg
[0].len
; i
++)
1985 msgbuf0
[i
] = data
->block
[i
-1];
1988 case I2C_SMBUS_BLOCK_PROC_CALL
:
1989 num
= 2; /* Another special case */
1990 read_write
= I2C_SMBUS_READ
;
1991 if (data
->block
[0] > I2C_SMBUS_BLOCK_MAX
) {
1992 dev_err(&adapter
->dev
,
1993 "Invalid block write size %d\n",
1997 msg
[0].len
= data
->block
[0] + 2;
1998 for (i
= 1; i
< msg
[0].len
; i
++)
1999 msgbuf0
[i
] = data
->block
[i
-1];
2000 msg
[1].flags
|= I2C_M_RECV_LEN
;
2001 msg
[1].len
= 1; /* block length will be added by
2002 the underlying bus driver */
2004 case I2C_SMBUS_I2C_BLOCK_DATA
:
2005 if (read_write
== I2C_SMBUS_READ
) {
2006 msg
[1].len
= data
->block
[0];
2008 msg
[0].len
= data
->block
[0] + 1;
2009 if (msg
[0].len
> I2C_SMBUS_BLOCK_MAX
+ 1) {
2010 dev_err(&adapter
->dev
,
2011 "Invalid block write size %d\n",
2015 for (i
= 1; i
<= data
->block
[0]; i
++)
2016 msgbuf0
[i
] = data
->block
[i
];
2020 dev_err(&adapter
->dev
, "Unsupported transaction %d\n", size
);
2024 i
= ((flags
& I2C_CLIENT_PEC
) && size
!= I2C_SMBUS_QUICK
2025 && size
!= I2C_SMBUS_I2C_BLOCK_DATA
);
2027 /* Compute PEC if first message is a write */
2028 if (!(msg
[0].flags
& I2C_M_RD
)) {
2029 if (num
== 1) /* Write only */
2030 i2c_smbus_add_pec(&msg
[0]);
2031 else /* Write followed by read */
2032 partial_pec
= i2c_smbus_msg_pec(0, &msg
[0]);
2034 /* Ask for PEC if last message is a read */
2035 if (msg
[num
-1].flags
& I2C_M_RD
)
2039 status
= i2c_transfer(adapter
, msg
, num
);
2043 /* Check PEC if last message is a read */
2044 if (i
&& (msg
[num
-1].flags
& I2C_M_RD
)) {
2045 status
= i2c_smbus_check_pec(partial_pec
, &msg
[num
-1]);
2050 if (read_write
== I2C_SMBUS_READ
)
2052 case I2C_SMBUS_BYTE
:
2053 data
->byte
= msgbuf0
[0];
2055 case I2C_SMBUS_BYTE_DATA
:
2056 data
->byte
= msgbuf1
[0];
2058 case I2C_SMBUS_WORD_DATA
:
2059 case I2C_SMBUS_PROC_CALL
:
2060 data
->word
= msgbuf1
[0] | (msgbuf1
[1] << 8);
2062 case I2C_SMBUS_I2C_BLOCK_DATA
:
2063 for (i
= 0; i
< data
->block
[0]; i
++)
2064 data
->block
[i
+1] = msgbuf1
[i
];
2066 case I2C_SMBUS_BLOCK_DATA
:
2067 case I2C_SMBUS_BLOCK_PROC_CALL
:
2068 for (i
= 0; i
< msgbuf1
[0] + 1; i
++)
2069 data
->block
[i
] = msgbuf1
[i
];
2076 * i2c_smbus_xfer - execute SMBus protocol operations
2077 * @adapter: Handle to I2C bus
2078 * @addr: Address of SMBus slave on that bus
2079 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
2080 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
2081 * @command: Byte interpreted by slave, for protocols which use such bytes
2082 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
2083 * @data: Data to be read or written
2085 * This executes an SMBus protocol operation, and returns a negative
2086 * errno code else zero on success.
2088 s32
i2c_smbus_xfer(struct i2c_adapter
*adapter
, u16 addr
, unsigned short flags
,
2089 char read_write
, u8 command
, int protocol
,
2090 union i2c_smbus_data
*data
)
2092 unsigned long orig_jiffies
;
2096 flags
&= I2C_M_TEN
| I2C_CLIENT_PEC
;
2098 if (adapter
->algo
->smbus_xfer
) {
2099 i2c_lock_adapter(adapter
);
2101 /* Retry automatically on arbitration loss */
2102 orig_jiffies
= jiffies
;
2103 for (res
= 0, try = 0; try <= adapter
->retries
; try++) {
2104 res
= adapter
->algo
->smbus_xfer(adapter
, addr
, flags
,
2105 read_write
, command
,
2109 if (time_after(jiffies
,
2110 orig_jiffies
+ adapter
->timeout
))
2113 i2c_unlock_adapter(adapter
);
2115 res
= i2c_smbus_xfer_emulated(adapter
, addr
, flags
, read_write
,
2116 command
, protocol
, data
);
2120 EXPORT_SYMBOL(i2c_smbus_xfer
);
2122 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2123 MODULE_DESCRIPTION("I2C-Bus main module");
2124 MODULE_LICENSE("GPL");