blob: e874b052b4f85eaca1896f2b256a281a8ea60e47 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* i2c-core.c - a device driver for the iic-bus interface */
2/* ------------------------------------------------------------------------- */
3/* Copyright (C) 1995-99 Simon G. Vogl
4
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.
9
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.
14
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
Jean Delvare5694f8a2012-03-26 21:47:19 +020017 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
18 MA 02110-1301 USA. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070019/* ------------------------------------------------------------------------- */
20
Jan Engelhardt96de0e22007-10-19 23:21:04 +020021/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
Jean Delvare421ef472005-10-26 21:28:55 +020023 SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
Michael Lawnick08263742010-08-11 18:21:02 +020024 Jean Delvare <khali@linux-fr.org>
25 Mux support by Rodolfo Giometti <giometti@enneenne.com> and
Wolfram Sang687b81d2013-07-11 12:56:15 +010026 Michael Lawnick <michael.lawnick.ext@nsn.com>
27 OF support is copyright (c) 2008 Jochen Friedrich <jochen@scram.de>
28 (based on a previous patch from Jon Smirl <jonsmirl@gmail.com>) and
29 (c) 2013 Wolfram Sang <wsa@the-dreams.de>
30 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/module.h>
33#include <linux/kernel.h>
Viresh Kumar5f9296b2012-02-28 18:26:31 +053034#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/errno.h>
Viresh Kumar5f9296b2012-02-28 18:26:31 +053036#include <linux/gpio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/slab.h>
38#include <linux/i2c.h>
39#include <linux/init.h>
40#include <linux/idr.h>
Arjan van de Venb3585e42006-01-11 10:50:26 +010041#include <linux/mutex.h>
Wolfram Sang687b81d2013-07-11 12:56:15 +010042#include <linux/of.h>
Grant Likely959e85f2010-06-08 07:48:19 -060043#include <linux/of_device.h>
Wolfram Sang687b81d2013-07-11 12:56:15 +010044#include <linux/of_irq.h>
Jean Delvareb8d6f452007-02-13 22:09:00 +010045#include <linux/completion.h>
Mike Rapoportcea443a2008-01-27 18:14:50 +010046#include <linux/hardirq.h>
47#include <linux/irqflags.h>
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +020048#include <linux/rwsem.h>
Mark Brown6de468a2010-03-02 12:23:46 +010049#include <linux/pm_runtime.h>
Mika Westerberg907ddf82012-11-23 12:23:40 +010050#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <asm/uaccess.h>
52
David Brownell9c1600e2007-05-01 23:26:31 +020053#include "i2c-core.h"
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Jean Delvare6629dcf2010-05-04 11:09:28 +020056/* core_lock protects i2c_adapter_idr, and guarantees
Jean Delvare35fc37f2009-06-19 16:58:19 +020057 that device detection, deletion of detected devices, and attach_adapter
Lars-Peter Clausen19baba42013-03-09 08:16:44 +000058 calls are serialized */
Jean Delvarecaada322008-01-27 18:14:49 +010059static DEFINE_MUTEX(core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060static DEFINE_IDR(i2c_adapter_idr);
61
Jean Delvare4f8cf822009-09-18 22:45:46 +020062static struct device_type i2c_client_type;
Jean Delvare4735c982008-07-14 22:38:36 +020063static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
David Brownellf37dd802007-02-13 22:09:00 +010064
65/* ------------------------------------------------------------------------- */
66
Jean Delvared2653e92008-04-29 23:11:39 +020067static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
68 const struct i2c_client *client)
69{
70 while (id->name[0]) {
71 if (strcmp(client->name, id->name) == 0)
72 return id;
73 id++;
74 }
75 return NULL;
76}
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078static int i2c_device_match(struct device *dev, struct device_driver *drv)
79{
Jean Delvare51298d12009-09-18 22:45:45 +020080 struct i2c_client *client = i2c_verify_client(dev);
81 struct i2c_driver *driver;
David Brownell7b4fbc52007-05-01 23:26:30 +020082
Jean Delvare51298d12009-09-18 22:45:45 +020083 if (!client)
84 return 0;
85
Grant Likely959e85f2010-06-08 07:48:19 -060086 /* Attempt an OF style match */
87 if (of_driver_match_device(dev, drv))
88 return 1;
89
Mika Westerberg907ddf82012-11-23 12:23:40 +010090 /* Then ACPI style match */
91 if (acpi_driver_match_device(dev, drv))
92 return 1;
93
Jean Delvare51298d12009-09-18 22:45:45 +020094 driver = to_i2c_driver(drv);
Jean Delvared2653e92008-04-29 23:11:39 +020095 /* match on an id table if there is one */
96 if (driver->id_table)
97 return i2c_match_id(driver->id_table, client) != NULL;
98
Jean Delvareeb8a7902008-05-18 20:49:41 +020099 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100}
101
David Brownell7b4fbc52007-05-01 23:26:30 +0200102
103/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200104static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +0200105{
106 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +0200107
Jean Delvareeb8a7902008-05-18 20:49:41 +0200108 if (add_uevent_var(env, "MODALIAS=%s%s",
109 I2C_MODULE_PREFIX, client->name))
110 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +0200111 dev_dbg(dev, "uevent\n");
112 return 0;
113}
114
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530115/* i2c bus recovery routines */
116static int get_scl_gpio_value(struct i2c_adapter *adap)
117{
118 return gpio_get_value(adap->bus_recovery_info->scl_gpio);
119}
120
121static void set_scl_gpio_value(struct i2c_adapter *adap, int val)
122{
123 gpio_set_value(adap->bus_recovery_info->scl_gpio, val);
124}
125
126static int get_sda_gpio_value(struct i2c_adapter *adap)
127{
128 return gpio_get_value(adap->bus_recovery_info->sda_gpio);
129}
130
131static int i2c_get_gpios_for_recovery(struct i2c_adapter *adap)
132{
133 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
134 struct device *dev = &adap->dev;
135 int ret = 0;
136
137 ret = gpio_request_one(bri->scl_gpio, GPIOF_OPEN_DRAIN |
138 GPIOF_OUT_INIT_HIGH, "i2c-scl");
139 if (ret) {
140 dev_warn(dev, "Can't get SCL gpio: %d\n", bri->scl_gpio);
141 return ret;
142 }
143
144 if (bri->get_sda) {
145 if (gpio_request_one(bri->sda_gpio, GPIOF_IN, "i2c-sda")) {
146 /* work without SDA polling */
147 dev_warn(dev, "Can't get SDA gpio: %d. Not using SDA polling\n",
148 bri->sda_gpio);
149 bri->get_sda = NULL;
150 }
151 }
152
153 return ret;
154}
155
156static void i2c_put_gpios_for_recovery(struct i2c_adapter *adap)
157{
158 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
159
160 if (bri->get_sda)
161 gpio_free(bri->sda_gpio);
162
163 gpio_free(bri->scl_gpio);
164}
165
166/*
167 * We are generating clock pulses. ndelay() determines durating of clk pulses.
168 * We will generate clock with rate 100 KHz and so duration of both clock levels
169 * is: delay in ns = (10^6 / 100) / 2
170 */
171#define RECOVERY_NDELAY 5000
172#define RECOVERY_CLK_CNT 9
173
174static int i2c_generic_recovery(struct i2c_adapter *adap)
175{
176 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
177 int i = 0, val = 1, ret = 0;
178
179 if (bri->prepare_recovery)
180 bri->prepare_recovery(bri);
181
182 /*
183 * By this time SCL is high, as we need to give 9 falling-rising edges
184 */
185 while (i++ < RECOVERY_CLK_CNT * 2) {
186 if (val) {
187 /* Break if SDA is high */
188 if (bri->get_sda && bri->get_sda(adap))
189 break;
190 /* SCL shouldn't be low here */
191 if (!bri->get_scl(adap)) {
192 dev_err(&adap->dev,
193 "SCL is stuck low, exit recovery\n");
194 ret = -EBUSY;
195 break;
196 }
197 }
198
199 val = !val;
200 bri->set_scl(adap, val);
201 ndelay(RECOVERY_NDELAY);
202 }
203
204 if (bri->unprepare_recovery)
205 bri->unprepare_recovery(bri);
206
207 return ret;
208}
209
210int i2c_generic_scl_recovery(struct i2c_adapter *adap)
211{
212 adap->bus_recovery_info->set_scl(adap, 1);
213 return i2c_generic_recovery(adap);
214}
215
216int i2c_generic_gpio_recovery(struct i2c_adapter *adap)
217{
218 int ret;
219
220 ret = i2c_get_gpios_for_recovery(adap);
221 if (ret)
222 return ret;
223
224 ret = i2c_generic_recovery(adap);
225 i2c_put_gpios_for_recovery(adap);
226
227 return ret;
228}
229
230int i2c_recover_bus(struct i2c_adapter *adap)
231{
232 if (!adap->bus_recovery_info)
233 return -EOPNOTSUPP;
234
235 dev_dbg(&adap->dev, "Trying i2c bus recovery\n");
236 return adap->bus_recovery_info->recover_bus(adap);
237}
238
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239static int i2c_device_probe(struct device *dev)
240{
Jean Delvare51298d12009-09-18 22:45:45 +0200241 struct i2c_client *client = i2c_verify_client(dev);
242 struct i2c_driver *driver;
Hans Verkuil50c33042008-03-12 14:15:00 +0100243 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200244
Jean Delvare51298d12009-09-18 22:45:45 +0200245 if (!client)
246 return 0;
247
248 driver = to_i2c_driver(dev->driver);
Jean Delvaree0457442008-07-14 22:38:30 +0200249 if (!driver->probe || !driver->id_table)
David Brownell7b4fbc52007-05-01 23:26:30 +0200250 return -ENODEV;
251 client->driver = driver;
Marc Pignatee354252008-08-28 08:33:22 +0200252 if (!device_can_wakeup(&client->dev))
253 device_init_wakeup(&client->dev,
254 client->flags & I2C_CLIENT_WAKE);
David Brownell7b4fbc52007-05-01 23:26:30 +0200255 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200256
Jean Delvaree0457442008-07-14 22:38:30 +0200257 status = driver->probe(client, i2c_match_id(driver->id_table, client));
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200258 if (status) {
Hans Verkuil50c33042008-03-12 14:15:00 +0100259 client->driver = NULL;
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200260 i2c_set_clientdata(client, NULL);
261 }
Hans Verkuil50c33042008-03-12 14:15:00 +0100262 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263}
264
265static int i2c_device_remove(struct device *dev)
266{
Jean Delvare51298d12009-09-18 22:45:45 +0200267 struct i2c_client *client = i2c_verify_client(dev);
David Brownella1d9e6e2007-05-01 23:26:30 +0200268 struct i2c_driver *driver;
269 int status;
270
Jean Delvare51298d12009-09-18 22:45:45 +0200271 if (!client || !dev->driver)
David Brownella1d9e6e2007-05-01 23:26:30 +0200272 return 0;
273
274 driver = to_i2c_driver(dev->driver);
275 if (driver->remove) {
276 dev_dbg(dev, "remove\n");
277 status = driver->remove(client);
278 } else {
279 dev->driver = NULL;
280 status = 0;
281 }
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200282 if (status == 0) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200283 client->driver = NULL;
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200284 i2c_set_clientdata(client, NULL);
285 }
David Brownella1d9e6e2007-05-01 23:26:30 +0200286 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287}
288
David Brownellf37dd802007-02-13 22:09:00 +0100289static void i2c_device_shutdown(struct device *dev)
290{
Jean Delvare51298d12009-09-18 22:45:45 +0200291 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100292 struct i2c_driver *driver;
293
Jean Delvare51298d12009-09-18 22:45:45 +0200294 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100295 return;
296 driver = to_i2c_driver(dev->driver);
297 if (driver->shutdown)
Jean Delvare51298d12009-09-18 22:45:45 +0200298 driver->shutdown(client);
David Brownellf37dd802007-02-13 22:09:00 +0100299}
300
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200301#ifdef CONFIG_PM_SLEEP
302static int i2c_legacy_suspend(struct device *dev, pm_message_t mesg)
David Brownellf37dd802007-02-13 22:09:00 +0100303{
Jean Delvare51298d12009-09-18 22:45:45 +0200304 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100305 struct i2c_driver *driver;
306
Jean Delvare51298d12009-09-18 22:45:45 +0200307 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100308 return 0;
309 driver = to_i2c_driver(dev->driver);
310 if (!driver->suspend)
311 return 0;
Jean Delvare51298d12009-09-18 22:45:45 +0200312 return driver->suspend(client, mesg);
David Brownellf37dd802007-02-13 22:09:00 +0100313}
314
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200315static int i2c_legacy_resume(struct device *dev)
David Brownellf37dd802007-02-13 22:09:00 +0100316{
Jean Delvare51298d12009-09-18 22:45:45 +0200317 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100318 struct i2c_driver *driver;
319
Jean Delvare51298d12009-09-18 22:45:45 +0200320 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100321 return 0;
322 driver = to_i2c_driver(dev->driver);
323 if (!driver->resume)
324 return 0;
Jean Delvare51298d12009-09-18 22:45:45 +0200325 return driver->resume(client);
David Brownellf37dd802007-02-13 22:09:00 +0100326}
327
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200328static int i2c_device_pm_suspend(struct device *dev)
329{
330 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
331
Mark Brownd529de22011-01-14 22:03:49 +0100332 if (pm)
333 return pm_generic_suspend(dev);
334 else
335 return i2c_legacy_suspend(dev, PMSG_SUSPEND);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200336}
337
338static int i2c_device_pm_resume(struct device *dev)
339{
340 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200341
342 if (pm)
Mark Brownd529de22011-01-14 22:03:49 +0100343 return pm_generic_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200344 else
Mark Brownd529de22011-01-14 22:03:49 +0100345 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200346}
347
348static int i2c_device_pm_freeze(struct device *dev)
349{
350 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
351
Mark Brownd529de22011-01-14 22:03:49 +0100352 if (pm)
353 return pm_generic_freeze(dev);
354 else
355 return i2c_legacy_suspend(dev, PMSG_FREEZE);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200356}
357
358static int i2c_device_pm_thaw(struct device *dev)
359{
360 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
361
Mark Brownd529de22011-01-14 22:03:49 +0100362 if (pm)
363 return pm_generic_thaw(dev);
364 else
365 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200366}
367
368static int i2c_device_pm_poweroff(struct device *dev)
369{
370 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
371
Mark Brownd529de22011-01-14 22:03:49 +0100372 if (pm)
373 return pm_generic_poweroff(dev);
374 else
375 return i2c_legacy_suspend(dev, PMSG_HIBERNATE);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200376}
377
378static int i2c_device_pm_restore(struct device *dev)
379{
380 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200381
382 if (pm)
Mark Brownd529de22011-01-14 22:03:49 +0100383 return pm_generic_restore(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200384 else
Mark Brownd529de22011-01-14 22:03:49 +0100385 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200386}
387#else /* !CONFIG_PM_SLEEP */
388#define i2c_device_pm_suspend NULL
389#define i2c_device_pm_resume NULL
390#define i2c_device_pm_freeze NULL
391#define i2c_device_pm_thaw NULL
392#define i2c_device_pm_poweroff NULL
393#define i2c_device_pm_restore NULL
394#endif /* !CONFIG_PM_SLEEP */
395
David Brownell9c1600e2007-05-01 23:26:31 +0200396static void i2c_client_dev_release(struct device *dev)
397{
398 kfree(to_i2c_client(dev));
399}
400
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100401static ssize_t
Jean Delvare4f8cf822009-09-18 22:45:46 +0200402show_name(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200403{
Jean Delvare4f8cf822009-09-18 22:45:46 +0200404 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
405 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200406}
407
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100408static ssize_t
409show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200410{
411 struct i2c_client *client = to_i2c_client(dev);
Jean Delvareeb8a7902008-05-18 20:49:41 +0200412 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200413}
414
Jean Delvare4f8cf822009-09-18 22:45:46 +0200415static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
Jean Delvare51298d12009-09-18 22:45:45 +0200416static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
417
418static struct attribute *i2c_dev_attrs[] = {
419 &dev_attr_name.attr,
David Brownell7b4fbc52007-05-01 23:26:30 +0200420 /* modalias helps coldplug: modprobe $(cat .../modalias) */
Jean Delvare51298d12009-09-18 22:45:45 +0200421 &dev_attr_modalias.attr,
422 NULL
423};
424
425static struct attribute_group i2c_dev_attr_group = {
426 .attrs = i2c_dev_attrs,
427};
428
429static const struct attribute_group *i2c_dev_attr_groups[] = {
430 &i2c_dev_attr_group,
431 NULL
David Brownell7b4fbc52007-05-01 23:26:30 +0200432};
433
Tobias Klauser0b2c3682010-01-16 20:43:12 +0100434static const struct dev_pm_ops i2c_device_pm_ops = {
sonic zhang54067ee2009-12-14 21:17:30 +0100435 .suspend = i2c_device_pm_suspend,
436 .resume = i2c_device_pm_resume,
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200437 .freeze = i2c_device_pm_freeze,
438 .thaw = i2c_device_pm_thaw,
439 .poweroff = i2c_device_pm_poweroff,
440 .restore = i2c_device_pm_restore,
441 SET_RUNTIME_PM_OPS(
442 pm_generic_runtime_suspend,
443 pm_generic_runtime_resume,
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +0200444 NULL
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200445 )
sonic zhang54067ee2009-12-14 21:17:30 +0100446};
447
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200448struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100449 .name = "i2c",
450 .match = i2c_device_match,
451 .probe = i2c_device_probe,
452 .remove = i2c_device_remove,
453 .shutdown = i2c_device_shutdown,
sonic zhang54067ee2009-12-14 21:17:30 +0100454 .pm = &i2c_device_pm_ops,
Russell Kingb864c7d2006-01-05 14:37:50 +0000455};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200456EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000457
Jean Delvare51298d12009-09-18 22:45:45 +0200458static struct device_type i2c_client_type = {
459 .groups = i2c_dev_attr_groups,
460 .uevent = i2c_device_uevent,
461 .release = i2c_client_dev_release,
462};
463
David Brownell9b766b82008-01-27 18:14:51 +0100464
465/**
466 * i2c_verify_client - return parameter as i2c_client, or NULL
467 * @dev: device, probably from some driver model iterator
468 *
469 * When traversing the driver model tree, perhaps using driver model
470 * iterators like @device_for_each_child(), you can't assume very much
471 * about the nodes you find. Use this function to avoid oopses caused
472 * by wrongly treating some non-I2C device as an i2c_client.
473 */
474struct i2c_client *i2c_verify_client(struct device *dev)
475{
Jean Delvare51298d12009-09-18 22:45:45 +0200476 return (dev->type == &i2c_client_type)
David Brownell9b766b82008-01-27 18:14:51 +0100477 ? to_i2c_client(dev)
478 : NULL;
479}
480EXPORT_SYMBOL(i2c_verify_client);
481
482
Jean Delvare3a89db52010-06-03 11:33:52 +0200483/* This is a permissive address validity check, I2C address map constraints
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300484 * are purposely not enforced, except for the general call address. */
Jean Delvare3a89db52010-06-03 11:33:52 +0200485static int i2c_check_client_addr_validity(const struct i2c_client *client)
486{
487 if (client->flags & I2C_CLIENT_TEN) {
488 /* 10-bit address, all values are valid */
489 if (client->addr > 0x3ff)
490 return -EINVAL;
491 } else {
492 /* 7-bit address, reject the general call address */
493 if (client->addr == 0x00 || client->addr > 0x7f)
494 return -EINVAL;
495 }
496 return 0;
497}
498
Jean Delvare656b8762010-06-03 11:33:53 +0200499/* And this is a strict address validity check, used when probing. If a
500 * device uses a reserved address, then it shouldn't be probed. 7-bit
501 * addressing is assumed, 10-bit address devices are rare and should be
502 * explicitly enumerated. */
503static int i2c_check_addr_validity(unsigned short addr)
504{
505 /*
506 * Reserved addresses per I2C specification:
507 * 0x00 General call address / START byte
508 * 0x01 CBUS address
509 * 0x02 Reserved for different bus format
510 * 0x03 Reserved for future purposes
511 * 0x04-0x07 Hs-mode master code
512 * 0x78-0x7b 10-bit slave addressing
513 * 0x7c-0x7f Reserved for future purposes
514 */
515 if (addr < 0x08 || addr > 0x77)
516 return -EINVAL;
517 return 0;
518}
519
Jean Delvare3b5f7942010-06-03 11:33:55 +0200520static int __i2c_check_addr_busy(struct device *dev, void *addrp)
521{
522 struct i2c_client *client = i2c_verify_client(dev);
523 int addr = *(int *)addrp;
524
525 if (client && client->addr == addr)
526 return -EBUSY;
527 return 0;
528}
529
Michael Lawnick08263742010-08-11 18:21:02 +0200530/* walk up mux tree */
531static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
532{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200533 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200534 int result;
535
536 result = device_for_each_child(&adapter->dev, &addr,
537 __i2c_check_addr_busy);
538
Jean Delvare97cc4d42010-10-24 18:16:57 +0200539 if (!result && parent)
540 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200541
542 return result;
543}
544
545/* recurse down mux tree */
546static int i2c_check_mux_children(struct device *dev, void *addrp)
547{
548 int result;
549
550 if (dev->type == &i2c_adapter_type)
551 result = device_for_each_child(dev, addrp,
552 i2c_check_mux_children);
553 else
554 result = __i2c_check_addr_busy(dev, addrp);
555
556 return result;
557}
558
Jean Delvare3b5f7942010-06-03 11:33:55 +0200559static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
560{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200561 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200562 int result = 0;
563
Jean Delvare97cc4d42010-10-24 18:16:57 +0200564 if (parent)
565 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200566
567 if (!result)
568 result = device_for_each_child(&adapter->dev, &addr,
569 i2c_check_mux_children);
570
571 return result;
Jean Delvare3b5f7942010-06-03 11:33:55 +0200572}
573
David Brownell9c1600e2007-05-01 23:26:31 +0200574/**
Jean Delvarefe61e072010-08-11 18:20:58 +0200575 * i2c_lock_adapter - Get exclusive access to an I2C bus segment
576 * @adapter: Target I2C bus segment
577 */
578void i2c_lock_adapter(struct i2c_adapter *adapter)
579{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200580 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
581
582 if (parent)
583 i2c_lock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200584 else
585 rt_mutex_lock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200586}
587EXPORT_SYMBOL_GPL(i2c_lock_adapter);
588
589/**
590 * i2c_trylock_adapter - Try to get exclusive access to an I2C bus segment
591 * @adapter: Target I2C bus segment
592 */
593static int i2c_trylock_adapter(struct i2c_adapter *adapter)
594{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200595 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
596
597 if (parent)
598 return i2c_trylock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200599 else
600 return rt_mutex_trylock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200601}
602
603/**
604 * i2c_unlock_adapter - Release exclusive access to an I2C bus segment
605 * @adapter: Target I2C bus segment
606 */
607void i2c_unlock_adapter(struct i2c_adapter *adapter)
608{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200609 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
610
611 if (parent)
612 i2c_unlock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200613 else
614 rt_mutex_unlock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200615}
616EXPORT_SYMBOL_GPL(i2c_unlock_adapter);
617
618/**
Jean Delvaref8a227e2009-06-19 16:58:18 +0200619 * i2c_new_device - instantiate an i2c device
David Brownell9c1600e2007-05-01 23:26:31 +0200620 * @adap: the adapter managing the device
621 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200622 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200623 *
Jean Delvaref8a227e2009-06-19 16:58:18 +0200624 * Create an i2c device. Binding is handled through driver model
625 * probe()/remove() methods. A driver may be bound to this device when we
626 * return from this function, or any later moment (e.g. maybe hotplugging will
627 * load the driver module). This call is not appropriate for use by mainboard
628 * initialization logic, which usually runs during an arch_initcall() long
629 * before any i2c_adapter could exist.
David Brownell9c1600e2007-05-01 23:26:31 +0200630 *
631 * This returns the new i2c client, which may be saved for later use with
632 * i2c_unregister_device(); or NULL to indicate an error.
633 */
634struct i2c_client *
635i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
636{
637 struct i2c_client *client;
638 int status;
639
640 client = kzalloc(sizeof *client, GFP_KERNEL);
641 if (!client)
642 return NULL;
643
644 client->adapter = adap;
645
646 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200647
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200648 if (info->archdata)
649 client->dev.archdata = *info->archdata;
650
Marc Pignatee354252008-08-28 08:33:22 +0200651 client->flags = info->flags;
David Brownell9c1600e2007-05-01 23:26:31 +0200652 client->addr = info->addr;
653 client->irq = info->irq;
654
David Brownell9c1600e2007-05-01 23:26:31 +0200655 strlcpy(client->name, info->type, sizeof(client->name));
656
Jean Delvare3a89db52010-06-03 11:33:52 +0200657 /* Check for address validity */
658 status = i2c_check_client_addr_validity(client);
659 if (status) {
660 dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
661 client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
662 goto out_err_silent;
663 }
664
Jean Delvaref8a227e2009-06-19 16:58:18 +0200665 /* Check for address business */
Jean Delvare3b5f7942010-06-03 11:33:55 +0200666 status = i2c_check_addr_busy(adap, client->addr);
Jean Delvaref8a227e2009-06-19 16:58:18 +0200667 if (status)
668 goto out_err;
669
670 client->dev.parent = &client->adapter->dev;
671 client->dev.bus = &i2c_bus_type;
Jean Delvare51298d12009-09-18 22:45:45 +0200672 client->dev.type = &i2c_client_type;
Grant Likelyd12d42f2010-04-13 16:12:28 -0700673 client->dev.of_node = info->of_node;
Mika Westerberg907ddf82012-11-23 12:23:40 +0100674 ACPI_HANDLE_SET(&client->dev, info->acpi_node.handle);
Jean Delvaref8a227e2009-06-19 16:58:18 +0200675
Jean Delvarecbb44512011-11-23 11:33:07 +0100676 /* For 10-bit clients, add an arbitrary offset to avoid collisions */
Jean Delvaref8a227e2009-06-19 16:58:18 +0200677 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
Jean Delvarecbb44512011-11-23 11:33:07 +0100678 client->addr | ((client->flags & I2C_CLIENT_TEN)
679 ? 0xa000 : 0));
Jean Delvaref8a227e2009-06-19 16:58:18 +0200680 status = device_register(&client->dev);
681 if (status)
682 goto out_err;
683
Jean Delvaref8a227e2009-06-19 16:58:18 +0200684 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
685 client->name, dev_name(&client->dev));
686
David Brownell9c1600e2007-05-01 23:26:31 +0200687 return client;
Jean Delvaref8a227e2009-06-19 16:58:18 +0200688
689out_err:
690 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
691 "(%d)\n", client->name, client->addr, status);
Jean Delvare3a89db52010-06-03 11:33:52 +0200692out_err_silent:
Jean Delvaref8a227e2009-06-19 16:58:18 +0200693 kfree(client);
694 return NULL;
David Brownell9c1600e2007-05-01 23:26:31 +0200695}
696EXPORT_SYMBOL_GPL(i2c_new_device);
697
698
699/**
700 * i2c_unregister_device - reverse effect of i2c_new_device()
701 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200702 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200703 */
704void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200705{
David Brownella1d9e6e2007-05-01 23:26:30 +0200706 device_unregister(&client->dev);
707}
David Brownell9c1600e2007-05-01 23:26:31 +0200708EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200709
710
Jean Delvare60b129d2008-05-11 20:37:06 +0200711static const struct i2c_device_id dummy_id[] = {
712 { "dummy", 0 },
713 { },
714};
715
Jean Delvared2653e92008-04-29 23:11:39 +0200716static int dummy_probe(struct i2c_client *client,
717 const struct i2c_device_id *id)
718{
719 return 0;
720}
721
722static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100723{
724 return 0;
725}
726
727static struct i2c_driver dummy_driver = {
728 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200729 .probe = dummy_probe,
730 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200731 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100732};
733
734/**
735 * i2c_new_dummy - return a new i2c device bound to a dummy driver
736 * @adapter: the adapter managing the device
737 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100738 * Context: can sleep
739 *
740 * This returns an I2C client bound to the "dummy" driver, intended for use
741 * with devices that consume multiple addresses. Examples of such chips
742 * include various EEPROMS (like 24c04 and 24c08 models).
743 *
744 * These dummy devices have two main uses. First, most I2C and SMBus calls
745 * except i2c_transfer() need a client handle; the dummy will be that handle.
746 * And second, this prevents the specified address from being bound to a
747 * different driver.
748 *
749 * This returns the new i2c client, which should be saved for later use with
750 * i2c_unregister_device(); or NULL to indicate an error.
751 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100752struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100753{
754 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200755 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100756 };
757
David Brownelle9f13732008-01-27 18:14:52 +0100758 return i2c_new_device(adapter, &info);
759}
760EXPORT_SYMBOL_GPL(i2c_new_dummy);
761
David Brownellf37dd802007-02-13 22:09:00 +0100762/* ------------------------------------------------------------------------- */
763
David Brownell16ffadf2007-05-01 23:26:28 +0200764/* I2C bus adapters -- one roots each I2C or SMBUS segment */
765
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200766static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767{
David Brownellef2c83212007-05-01 23:26:28 +0200768 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 complete(&adap->dev_released);
770}
771
Jean Delvare99cd8e22009-06-19 16:58:20 +0200772/*
Jean Delvare390946b2012-09-10 10:14:02 +0200773 * This function is only needed for mutex_lock_nested, so it is never
774 * called unless locking correctness checking is enabled. Thus we
775 * make it inline to avoid a compiler warning. That's what gcc ends up
776 * doing anyway.
777 */
778static inline unsigned int i2c_adapter_depth(struct i2c_adapter *adapter)
779{
780 unsigned int depth = 0;
781
782 while ((adapter = i2c_parent_is_i2c_adapter(adapter)))
783 depth++;
784
785 return depth;
786}
787
788/*
Jean Delvare99cd8e22009-06-19 16:58:20 +0200789 * Let users instantiate I2C devices through sysfs. This can be used when
790 * platform initialization code doesn't contain the proper data for
791 * whatever reason. Also useful for drivers that do device detection and
792 * detection fails, either because the device uses an unexpected address,
793 * or this is a compatible device with different ID register values.
794 *
795 * Parameter checking may look overzealous, but we really don't want
796 * the user to provide incorrect parameters.
797 */
798static ssize_t
799i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
800 const char *buf, size_t count)
801{
802 struct i2c_adapter *adap = to_i2c_adapter(dev);
803 struct i2c_board_info info;
804 struct i2c_client *client;
805 char *blank, end;
806 int res;
807
Jean Delvare99cd8e22009-06-19 16:58:20 +0200808 memset(&info, 0, sizeof(struct i2c_board_info));
809
810 blank = strchr(buf, ' ');
811 if (!blank) {
812 dev_err(dev, "%s: Missing parameters\n", "new_device");
813 return -EINVAL;
814 }
815 if (blank - buf > I2C_NAME_SIZE - 1) {
816 dev_err(dev, "%s: Invalid device name\n", "new_device");
817 return -EINVAL;
818 }
819 memcpy(info.type, buf, blank - buf);
820
821 /* Parse remaining parameters, reject extra parameters */
822 res = sscanf(++blank, "%hi%c", &info.addr, &end);
823 if (res < 1) {
824 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
825 return -EINVAL;
826 }
827 if (res > 1 && end != '\n') {
828 dev_err(dev, "%s: Extra parameters\n", "new_device");
829 return -EINVAL;
830 }
831
Jean Delvare99cd8e22009-06-19 16:58:20 +0200832 client = i2c_new_device(adap, &info);
833 if (!client)
Jean Delvare3a89db52010-06-03 11:33:52 +0200834 return -EINVAL;
Jean Delvare99cd8e22009-06-19 16:58:20 +0200835
836 /* Keep track of the added device */
Jean Delvaredafc50d2010-08-11 18:21:01 +0200837 mutex_lock(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +0200838 list_add_tail(&client->detected, &adap->userspace_clients);
Jean Delvaredafc50d2010-08-11 18:21:01 +0200839 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +0200840 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
841 info.type, info.addr);
842
843 return count;
844}
845
846/*
847 * And of course let the users delete the devices they instantiated, if
848 * they got it wrong. This interface can only be used to delete devices
849 * instantiated by i2c_sysfs_new_device above. This guarantees that we
850 * don't delete devices to which some kernel code still has references.
851 *
852 * Parameter checking may look overzealous, but we really don't want
853 * the user to delete the wrong device.
854 */
855static ssize_t
856i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
857 const char *buf, size_t count)
858{
859 struct i2c_adapter *adap = to_i2c_adapter(dev);
860 struct i2c_client *client, *next;
861 unsigned short addr;
862 char end;
863 int res;
864
865 /* Parse parameters, reject extra parameters */
866 res = sscanf(buf, "%hi%c", &addr, &end);
867 if (res < 1) {
868 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
869 return -EINVAL;
870 }
871 if (res > 1 && end != '\n') {
872 dev_err(dev, "%s: Extra parameters\n", "delete_device");
873 return -EINVAL;
874 }
875
876 /* Make sure the device was added through sysfs */
877 res = -ENOENT;
Jean Delvare390946b2012-09-10 10:14:02 +0200878 mutex_lock_nested(&adap->userspace_clients_lock,
879 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +0200880 list_for_each_entry_safe(client, next, &adap->userspace_clients,
881 detected) {
882 if (client->addr == addr) {
Jean Delvare99cd8e22009-06-19 16:58:20 +0200883 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
884 "delete_device", client->name, client->addr);
885
886 list_del(&client->detected);
887 i2c_unregister_device(client);
888 res = count;
889 break;
890 }
891 }
Jean Delvaredafc50d2010-08-11 18:21:01 +0200892 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +0200893
894 if (res < 0)
895 dev_err(dev, "%s: Can't find device in list\n",
896 "delete_device");
897 return res;
898}
899
Jean Delvare4f8cf822009-09-18 22:45:46 +0200900static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
Alexander Sverdline9b526f2013-05-17 14:56:35 +0200901static DEVICE_ATTR_IGNORE_LOCKDEP(delete_device, S_IWUSR, NULL,
902 i2c_sysfs_delete_device);
Jean Delvare4f8cf822009-09-18 22:45:46 +0200903
904static struct attribute *i2c_adapter_attrs[] = {
905 &dev_attr_name.attr,
906 &dev_attr_new_device.attr,
907 &dev_attr_delete_device.attr,
908 NULL
David Brownell16ffadf2007-05-01 23:26:28 +0200909};
910
Jean Delvare4f8cf822009-09-18 22:45:46 +0200911static struct attribute_group i2c_adapter_attr_group = {
912 .attrs = i2c_adapter_attrs,
913};
914
915static const struct attribute_group *i2c_adapter_attr_groups[] = {
916 &i2c_adapter_attr_group,
917 NULL
918};
919
Michael Lawnick08263742010-08-11 18:21:02 +0200920struct device_type i2c_adapter_type = {
Jean Delvare4f8cf822009-09-18 22:45:46 +0200921 .groups = i2c_adapter_attr_groups,
922 .release = i2c_adapter_dev_release,
David Brownell16ffadf2007-05-01 23:26:28 +0200923};
Michael Lawnick08263742010-08-11 18:21:02 +0200924EXPORT_SYMBOL_GPL(i2c_adapter_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Stephen Warren643dd092012-04-17 12:43:33 -0600926/**
927 * i2c_verify_adapter - return parameter as i2c_adapter or NULL
928 * @dev: device, probably from some driver model iterator
929 *
930 * When traversing the driver model tree, perhaps using driver model
931 * iterators like @device_for_each_child(), you can't assume very much
932 * about the nodes you find. Use this function to avoid oopses caused
933 * by wrongly treating some non-I2C device as an i2c_adapter.
934 */
935struct i2c_adapter *i2c_verify_adapter(struct device *dev)
936{
937 return (dev->type == &i2c_adapter_type)
938 ? to_i2c_adapter(dev)
939 : NULL;
940}
941EXPORT_SYMBOL(i2c_verify_adapter);
942
Jean Delvare2bb50952009-09-18 22:45:46 +0200943#ifdef CONFIG_I2C_COMPAT
944static struct class_compat *i2c_adapter_compat_class;
945#endif
946
David Brownell9c1600e2007-05-01 23:26:31 +0200947static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
948{
949 struct i2c_devinfo *devinfo;
950
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +0200951 down_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +0200952 list_for_each_entry(devinfo, &__i2c_board_list, list) {
953 if (devinfo->busnum == adapter->nr
954 && !i2c_new_device(adapter,
955 &devinfo->board_info))
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100956 dev_err(&adapter->dev,
957 "Can't create device at 0x%02x\n",
David Brownell9c1600e2007-05-01 23:26:31 +0200958 devinfo->board_info.addr);
959 }
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +0200960 up_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +0200961}
962
Wolfram Sang687b81d2013-07-11 12:56:15 +0100963/* OF support code */
964
965#if IS_ENABLED(CONFIG_OF)
966static void of_i2c_register_devices(struct i2c_adapter *adap)
967{
968 void *result;
969 struct device_node *node;
970
971 /* Only register child devices if the adapter has a node pointer set */
972 if (!adap->dev.of_node)
973 return;
974
975 dev_dbg(&adap->dev, "of_i2c: walking child nodes\n");
976
977 for_each_available_child_of_node(adap->dev.of_node, node) {
978 struct i2c_board_info info = {};
979 struct dev_archdata dev_ad = {};
980 const __be32 *addr;
981 int len;
982
983 dev_dbg(&adap->dev, "of_i2c: register %s\n", node->full_name);
984
985 if (of_modalias_node(node, info.type, sizeof(info.type)) < 0) {
986 dev_err(&adap->dev, "of_i2c: modalias failure on %s\n",
987 node->full_name);
988 continue;
989 }
990
991 addr = of_get_property(node, "reg", &len);
992 if (!addr || (len < sizeof(int))) {
993 dev_err(&adap->dev, "of_i2c: invalid reg on %s\n",
994 node->full_name);
995 continue;
996 }
997
998 info.addr = be32_to_cpup(addr);
999 if (info.addr > (1 << 10) - 1) {
1000 dev_err(&adap->dev, "of_i2c: invalid addr=%x on %s\n",
1001 info.addr, node->full_name);
1002 continue;
1003 }
1004
1005 info.irq = irq_of_parse_and_map(node, 0);
1006 info.of_node = of_node_get(node);
1007 info.archdata = &dev_ad;
1008
1009 if (of_get_property(node, "wakeup-source", NULL))
1010 info.flags |= I2C_CLIENT_WAKE;
1011
1012 request_module("%s%s", I2C_MODULE_PREFIX, info.type);
1013
1014 result = i2c_new_device(adap, &info);
1015 if (result == NULL) {
1016 dev_err(&adap->dev, "of_i2c: Failure registering %s\n",
1017 node->full_name);
1018 of_node_put(node);
1019 irq_dispose_mapping(info.irq);
1020 continue;
1021 }
1022 }
1023}
1024
1025static int of_dev_node_match(struct device *dev, void *data)
1026{
1027 return dev->of_node == data;
1028}
1029
1030/* must call put_device() when done with returned i2c_client device */
1031struct i2c_client *of_find_i2c_device_by_node(struct device_node *node)
1032{
1033 struct device *dev;
1034
1035 dev = bus_find_device(&i2c_bus_type, NULL, node,
1036 of_dev_node_match);
1037 if (!dev)
1038 return NULL;
1039
1040 return i2c_verify_client(dev);
1041}
1042EXPORT_SYMBOL(of_find_i2c_device_by_node);
1043
1044/* must call put_device() when done with returned i2c_adapter device */
1045struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node)
1046{
1047 struct device *dev;
1048
1049 dev = bus_find_device(&i2c_bus_type, NULL, node,
1050 of_dev_node_match);
1051 if (!dev)
1052 return NULL;
1053
1054 return i2c_verify_adapter(dev);
1055}
1056EXPORT_SYMBOL(of_find_i2c_adapter_by_node);
1057#else
1058static void of_i2c_register_devices(struct i2c_adapter *adap) { }
1059#endif /* CONFIG_OF */
1060
Jean Delvare69b00892009-12-06 17:06:27 +01001061static int i2c_do_add_adapter(struct i2c_driver *driver,
1062 struct i2c_adapter *adap)
Jean Delvare026526f2008-01-27 18:14:49 +01001063{
Jean Delvare4735c982008-07-14 22:38:36 +02001064 /* Detect supported devices on that bus, and instantiate them */
1065 i2c_detect(adap, driver);
1066
1067 /* Let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +01001068 if (driver->attach_adapter) {
Jean Delvarea920ff42011-04-17 10:20:19 +02001069 dev_warn(&adap->dev, "%s: attach_adapter method is deprecated\n",
1070 driver->driver.name);
Jean Delvarefe6fc252011-03-20 14:50:53 +01001071 dev_warn(&adap->dev, "Please use another way to instantiate "
1072 "your i2c_client\n");
Jean Delvare026526f2008-01-27 18:14:49 +01001073 /* We ignore the return code; if it fails, too bad */
1074 driver->attach_adapter(adap);
1075 }
1076 return 0;
1077}
1078
Jean Delvare69b00892009-12-06 17:06:27 +01001079static int __process_new_adapter(struct device_driver *d, void *data)
1080{
1081 return i2c_do_add_adapter(to_i2c_driver(d), data);
1082}
1083
David Brownell6e13e642007-05-01 23:26:31 +02001084static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085{
Jean Delvared6703282010-08-11 18:20:59 +02001086 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087
David Brownell1d0b19c2008-10-14 17:30:05 +02001088 /* Can't register until after driver model init */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001089 if (unlikely(WARN_ON(!i2c_bus_type.p))) {
1090 res = -EAGAIN;
1091 goto out_list;
1092 }
David Brownell1d0b19c2008-10-14 17:30:05 +02001093
Jean Delvare2236baa2010-11-15 22:40:38 +01001094 /* Sanity checks */
1095 if (unlikely(adap->name[0] == '\0')) {
1096 pr_err("i2c-core: Attempt to register an adapter with "
1097 "no name!\n");
1098 return -EINVAL;
1099 }
1100 if (unlikely(!adap->algo)) {
1101 pr_err("i2c-core: Attempt to register adapter '%s' with "
1102 "no algo!\n", adap->name);
1103 return -EINVAL;
1104 }
1105
Mika Kuoppala194684e2009-12-06 17:06:22 +01001106 rt_mutex_init(&adap->bus_lock);
Jean Delvaredafc50d2010-08-11 18:21:01 +02001107 mutex_init(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +02001108 INIT_LIST_HEAD(&adap->userspace_clients);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
Jean Delvare8fcfef62009-03-28 21:34:43 +01001110 /* Set default timeout to 1 second if not already set */
1111 if (adap->timeout == 0)
1112 adap->timeout = HZ;
1113
Kay Sievers27d9c182009-01-07 14:29:16 +01001114 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001115 adap->dev.bus = &i2c_bus_type;
1116 adap->dev.type = &i2c_adapter_type;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001117 res = device_register(&adap->dev);
1118 if (res)
1119 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001121 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
1122
Jean Delvare2bb50952009-09-18 22:45:46 +02001123#ifdef CONFIG_I2C_COMPAT
1124 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
1125 adap->dev.parent);
1126 if (res)
1127 dev_warn(&adap->dev,
1128 "Failed to create compatibility class link\n");
1129#endif
1130
Viresh Kumar5f9296b2012-02-28 18:26:31 +05301131 /* bus recovery specific initialization */
1132 if (adap->bus_recovery_info) {
1133 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
1134
1135 if (!bri->recover_bus) {
1136 dev_err(&adap->dev, "No recover_bus() found, not using recovery\n");
1137 adap->bus_recovery_info = NULL;
1138 goto exit_recovery;
1139 }
1140
1141 /* Generic GPIO recovery */
1142 if (bri->recover_bus == i2c_generic_gpio_recovery) {
1143 if (!gpio_is_valid(bri->scl_gpio)) {
1144 dev_err(&adap->dev, "Invalid SCL gpio, not using recovery\n");
1145 adap->bus_recovery_info = NULL;
1146 goto exit_recovery;
1147 }
1148
1149 if (gpio_is_valid(bri->sda_gpio))
1150 bri->get_sda = get_sda_gpio_value;
1151 else
1152 bri->get_sda = NULL;
1153
1154 bri->get_scl = get_scl_gpio_value;
1155 bri->set_scl = set_scl_gpio_value;
1156 } else if (!bri->set_scl || !bri->get_scl) {
1157 /* Generic SCL recovery */
1158 dev_err(&adap->dev, "No {get|set}_gpio() found, not using recovery\n");
1159 adap->bus_recovery_info = NULL;
1160 }
1161 }
1162
1163exit_recovery:
Jean Delvare729d6dd2009-06-19 16:58:18 +02001164 /* create pre-declared device nodes */
Wolfram Sang687b81d2013-07-11 12:56:15 +01001165 of_i2c_register_devices(adap);
1166
David Brownell6e13e642007-05-01 23:26:31 +02001167 if (adap->nr < __i2c_first_dynamic_bus_num)
1168 i2c_scan_static_board_info(adap);
1169
Jean Delvare4735c982008-07-14 22:38:36 +02001170 /* Notify drivers */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001171 mutex_lock(&core_lock);
Jean Delvared6703282010-08-11 18:20:59 +02001172 bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
Jean Delvarecaada322008-01-27 18:14:49 +01001173 mutex_unlock(&core_lock);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001174
1175 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001176
Jean Delvareb119c6c2006-08-15 18:26:30 +02001177out_list:
Jean Delvare35fc37f2009-06-19 16:58:19 +02001178 mutex_lock(&core_lock);
Jean Delvareb119c6c2006-08-15 18:26:30 +02001179 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001180 mutex_unlock(&core_lock);
1181 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182}
1183
David Brownell6e13e642007-05-01 23:26:31 +02001184/**
Doug Andersonee5c2742013-03-01 08:57:31 -08001185 * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1
1186 * @adap: the adapter to register (with adap->nr initialized)
1187 * Context: can sleep
1188 *
1189 * See i2c_add_numbered_adapter() for details.
1190 */
1191static int __i2c_add_numbered_adapter(struct i2c_adapter *adap)
1192{
1193 int id;
1194
1195 mutex_lock(&core_lock);
1196 id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1,
1197 GFP_KERNEL);
1198 mutex_unlock(&core_lock);
1199 if (id < 0)
1200 return id == -ENOSPC ? -EBUSY : id;
1201
1202 return i2c_register_adapter(adap);
1203}
1204
1205/**
David Brownell6e13e642007-05-01 23:26:31 +02001206 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
1207 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +02001208 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001209 *
1210 * This routine is used to declare an I2C adapter when its bus number
Doug Andersonee5c2742013-03-01 08:57:31 -08001211 * doesn't matter or when its bus number is specified by an dt alias.
1212 * Examples of bases when the bus number doesn't matter: I2C adapters
1213 * dynamically added by USB links or PCI plugin cards.
David Brownell6e13e642007-05-01 23:26:31 +02001214 *
1215 * When this returns zero, a new bus number was allocated and stored
1216 * in adap->nr, and the specified adapter became available for clients.
1217 * Otherwise, a negative errno value is returned.
1218 */
1219int i2c_add_adapter(struct i2c_adapter *adapter)
1220{
Doug Andersonee5c2742013-03-01 08:57:31 -08001221 struct device *dev = &adapter->dev;
Tejun Heo4ae42b0f2013-02-27 17:04:15 -08001222 int id;
David Brownell6e13e642007-05-01 23:26:31 +02001223
Doug Andersonee5c2742013-03-01 08:57:31 -08001224 if (dev->of_node) {
1225 id = of_alias_get_id(dev->of_node, "i2c");
1226 if (id >= 0) {
1227 adapter->nr = id;
1228 return __i2c_add_numbered_adapter(adapter);
1229 }
1230 }
1231
Jean Delvarecaada322008-01-27 18:14:49 +01001232 mutex_lock(&core_lock);
Tejun Heo4ae42b0f2013-02-27 17:04:15 -08001233 id = idr_alloc(&i2c_adapter_idr, adapter,
1234 __i2c_first_dynamic_bus_num, 0, GFP_KERNEL);
Jean Delvarecaada322008-01-27 18:14:49 +01001235 mutex_unlock(&core_lock);
Tejun Heo4ae42b0f2013-02-27 17:04:15 -08001236 if (id < 0)
1237 return id;
David Brownell6e13e642007-05-01 23:26:31 +02001238
1239 adapter->nr = id;
Tejun Heo4ae42b0f2013-02-27 17:04:15 -08001240
David Brownell6e13e642007-05-01 23:26:31 +02001241 return i2c_register_adapter(adapter);
1242}
1243EXPORT_SYMBOL(i2c_add_adapter);
1244
1245/**
1246 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
1247 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +02001248 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001249 *
1250 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +01001251 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
1252 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +02001253 * is used to properly configure I2C devices.
1254 *
Grant Likely488bf312011-07-25 17:49:43 +02001255 * If the requested bus number is set to -1, then this function will behave
1256 * identically to i2c_add_adapter, and will dynamically assign a bus number.
1257 *
David Brownell6e13e642007-05-01 23:26:31 +02001258 * If no devices have pre-been declared for this bus, then be sure to
1259 * register the adapter before any dynamically allocated ones. Otherwise
1260 * the required bus ID may not be available.
1261 *
1262 * When this returns zero, the specified adapter became available for
1263 * clients using the bus number provided in adap->nr. Also, the table
1264 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
1265 * and the appropriate driver model device nodes are created. Otherwise, a
1266 * negative errno value is returned.
1267 */
1268int i2c_add_numbered_adapter(struct i2c_adapter *adap)
1269{
Grant Likely488bf312011-07-25 17:49:43 +02001270 if (adap->nr == -1) /* -1 means dynamically assign bus id */
1271 return i2c_add_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001272
Doug Andersonee5c2742013-03-01 08:57:31 -08001273 return __i2c_add_numbered_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001274}
1275EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
1276
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001277static void i2c_do_del_adapter(struct i2c_driver *driver,
Jean Delvare69b00892009-12-06 17:06:27 +01001278 struct i2c_adapter *adapter)
Jean Delvare026526f2008-01-27 18:14:49 +01001279{
Jean Delvare4735c982008-07-14 22:38:36 +02001280 struct i2c_client *client, *_n;
Jean Delvare026526f2008-01-27 18:14:49 +01001281
Jean Delvareacec2112009-03-28 21:34:40 +01001282 /* Remove the devices we created ourselves as the result of hardware
1283 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +02001284 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
1285 if (client->adapter == adapter) {
1286 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
1287 client->name, client->addr);
1288 list_del(&client->detected);
1289 i2c_unregister_device(client);
1290 }
1291 }
Jean Delvare026526f2008-01-27 18:14:49 +01001292}
1293
Jean Delvaree549c2b2009-06-19 16:58:19 +02001294static int __unregister_client(struct device *dev, void *dummy)
1295{
1296 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvare5219bf82011-01-14 22:03:49 +01001297 if (client && strcmp(client->name, "dummy"))
1298 i2c_unregister_device(client);
1299 return 0;
1300}
1301
1302static int __unregister_dummy(struct device *dev, void *dummy)
1303{
1304 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvaree549c2b2009-06-19 16:58:19 +02001305 if (client)
1306 i2c_unregister_device(client);
1307 return 0;
1308}
1309
Jean Delvare69b00892009-12-06 17:06:27 +01001310static int __process_removed_adapter(struct device_driver *d, void *data)
1311{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001312 i2c_do_del_adapter(to_i2c_driver(d), data);
1313 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001314}
1315
David Brownelld64f73b2007-07-12 14:12:28 +02001316/**
1317 * i2c_del_adapter - unregister I2C adapter
1318 * @adap: the adapter being unregistered
1319 * Context: can sleep
1320 *
1321 * This unregisters an I2C adapter which was previously registered
1322 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1323 */
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001324void i2c_del_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325{
Jean Delvare35fc37f2009-06-19 16:58:19 +02001326 struct i2c_adapter *found;
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001327 struct i2c_client *client, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
1329 /* First make sure that this adapter was ever added */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001330 mutex_lock(&core_lock);
1331 found = idr_find(&i2c_adapter_idr, adap->nr);
1332 mutex_unlock(&core_lock);
1333 if (found != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001334 pr_debug("i2c-core: attempting to delete unregistered "
1335 "adapter [%s]\n", adap->name);
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001336 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 }
1338
Jean Delvare026526f2008-01-27 18:14:49 +01001339 /* Tell drivers about this removal */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001340 mutex_lock(&core_lock);
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001341 bus_for_each_drv(&i2c_bus_type, NULL, adap,
Jean Delvare69b00892009-12-06 17:06:27 +01001342 __process_removed_adapter);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001343 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001345 /* Remove devices instantiated from sysfs */
Jean Delvare390946b2012-09-10 10:14:02 +02001346 mutex_lock_nested(&adap->userspace_clients_lock,
1347 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +02001348 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1349 detected) {
1350 dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
1351 client->addr);
1352 list_del(&client->detected);
1353 i2c_unregister_device(client);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001354 }
Jean Delvaredafc50d2010-08-11 18:21:01 +02001355 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001356
Jean Delvaree549c2b2009-06-19 16:58:19 +02001357 /* Detach any active clients. This can't fail, thus we do not
Jean Delvare5219bf82011-01-14 22:03:49 +01001358 * check the returned value. This is a two-pass process, because
1359 * we can't remove the dummy devices during the first pass: they
1360 * could have been instantiated by real devices wishing to clean
1361 * them up properly, so we give them a chance to do that first. */
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001362 device_for_each_child(&adap->dev, NULL, __unregister_client);
1363 device_for_each_child(&adap->dev, NULL, __unregister_dummy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Jean Delvare2bb50952009-09-18 22:45:46 +02001365#ifdef CONFIG_I2C_COMPAT
1366 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
1367 adap->dev.parent);
1368#endif
1369
Thadeu Lima de Souza Cascardoc5567522010-01-16 20:43:13 +01001370 /* device name is gone after device_unregister */
1371 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
1372
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 /* clean up the sysfs representation */
1374 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
1377 /* wait for sysfs to drop all references */
1378 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
David Brownell6e13e642007-05-01 23:26:31 +02001380 /* free bus id */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001381 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001383 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
Jean Delvarebd4bc3db2008-07-16 19:30:05 +02001385 /* Clear the device structure in case this adapter is ever going to be
1386 added again */
1387 memset(&adap->dev, 0, sizeof(adap->dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388}
David Brownellc0564602007-05-01 23:26:31 +02001389EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
David Brownell7b4fbc52007-05-01 23:26:30 +02001391/* ------------------------------------------------------------------------- */
1392
Jean Delvare7ae31482011-03-20 14:50:52 +01001393int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *))
1394{
1395 int res;
1396
1397 mutex_lock(&core_lock);
1398 res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn);
1399 mutex_unlock(&core_lock);
1400
1401 return res;
1402}
1403EXPORT_SYMBOL_GPL(i2c_for_each_dev);
1404
Jean Delvare69b00892009-12-06 17:06:27 +01001405static int __process_new_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001406{
Jean Delvare4f8cf822009-09-18 22:45:46 +02001407 if (dev->type != &i2c_adapter_type)
1408 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001409 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
Dave Young7f101a92008-07-14 22:38:19 +02001410}
1411
David Brownell7b4fbc52007-05-01 23:26:30 +02001412/*
1413 * An i2c_driver is used with one or more i2c_client (device) nodes to access
Jean Delvare729d6dd2009-06-19 16:58:18 +02001414 * i2c slave chips, on a bus instance associated with some i2c_adapter.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 */
1416
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001417int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418{
Jean Delvare7eebcb72006-02-05 23:28:21 +01001419 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
David Brownell1d0b19c2008-10-14 17:30:05 +02001421 /* Can't register until after driver model init */
1422 if (unlikely(WARN_ON(!i2c_bus_type.p)))
1423 return -EAGAIN;
1424
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001426 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
Jean Delvare729d6dd2009-06-19 16:58:18 +02001429 /* When registration returns, the driver core
David Brownell6e13e642007-05-01 23:26:31 +02001430 * will have called probe() for all matching-but-unbound devices.
1431 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 res = driver_register(&driver->driver);
1433 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +01001434 return res;
David Brownell438d6c22006-12-10 21:21:31 +01001435
Mark Brownf4e8db32011-01-14 22:03:50 +01001436 /* Drivers should switch to dev_pm_ops instead. */
1437 if (driver->suspend)
1438 pr_warn("i2c-core: driver [%s] using legacy suspend method\n",
1439 driver->driver.name);
1440 if (driver->resume)
1441 pr_warn("i2c-core: driver [%s] using legacy resume method\n",
1442 driver->driver.name);
1443
Laurent Riffard35d8b2e2005-11-26 20:34:05 +01001444 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Jean Delvare4735c982008-07-14 22:38:36 +02001446 INIT_LIST_HEAD(&driver->clients);
1447 /* Walk the adapters that are already present */
Jean Delvare7ae31482011-03-20 14:50:52 +01001448 i2c_for_each_dev(driver, __process_new_driver);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001449
Jean Delvare7eebcb72006-02-05 23:28:21 +01001450 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001452EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
Jean Delvare69b00892009-12-06 17:06:27 +01001454static int __process_removed_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001455{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001456 if (dev->type == &i2c_adapter_type)
1457 i2c_do_del_adapter(data, to_i2c_adapter(dev));
1458 return 0;
Dave Young7f101a92008-07-14 22:38:19 +02001459}
1460
David Brownella1d9e6e2007-05-01 23:26:30 +02001461/**
1462 * i2c_del_driver - unregister I2C driver
1463 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +02001464 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +02001465 */
Jean Delvareb3e82092007-05-01 23:26:32 +02001466void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467{
Jean Delvare7ae31482011-03-20 14:50:52 +01001468 i2c_for_each_dev(driver, __process_removed_driver);
David Brownella1d9e6e2007-05-01 23:26:30 +02001469
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +01001471 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472}
David Brownellc0564602007-05-01 23:26:31 +02001473EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
David Brownell7b4fbc52007-05-01 23:26:30 +02001475/* ------------------------------------------------------------------------- */
1476
Jean Delvaree48d3312008-01-27 18:14:48 +01001477/**
1478 * i2c_use_client - increments the reference count of the i2c client structure
1479 * @client: the client being referenced
1480 *
1481 * Each live reference to a client should be refcounted. The driver model does
1482 * that automatically as part of driver binding, so that most drivers don't
1483 * need to do this explicitly: they hold a reference until they're unbound
1484 * from the device.
1485 *
1486 * A pointer to the client with the incremented reference counter is returned.
1487 */
1488struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489{
David Brownell6ea438e2008-07-14 22:38:24 +02001490 if (client && get_device(&client->dev))
1491 return client;
1492 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493}
David Brownellc0564602007-05-01 23:26:31 +02001494EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Jean Delvaree48d3312008-01-27 18:14:48 +01001496/**
1497 * i2c_release_client - release a use of the i2c client structure
1498 * @client: the client being no longer referenced
1499 *
1500 * Must be called when a user of a client is finished with it.
1501 */
1502void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503{
David Brownell6ea438e2008-07-14 22:38:24 +02001504 if (client)
1505 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506}
David Brownellc0564602007-05-01 23:26:31 +02001507EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
David Brownell9b766b82008-01-27 18:14:51 +01001509struct i2c_cmd_arg {
1510 unsigned cmd;
1511 void *arg;
1512};
1513
1514static int i2c_cmd(struct device *dev, void *_arg)
1515{
1516 struct i2c_client *client = i2c_verify_client(dev);
1517 struct i2c_cmd_arg *arg = _arg;
1518
1519 if (client && client->driver && client->driver->command)
1520 client->driver->command(client, arg->cmd, arg->arg);
1521 return 0;
1522}
1523
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
1525{
David Brownell9b766b82008-01-27 18:14:51 +01001526 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
David Brownell9b766b82008-01-27 18:14:51 +01001528 cmd_arg.cmd = cmd;
1529 cmd_arg.arg = arg;
1530 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531}
David Brownellc0564602007-05-01 23:26:31 +02001532EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
1534static int __init i2c_init(void)
1535{
1536 int retval;
1537
1538 retval = bus_register(&i2c_bus_type);
1539 if (retval)
1540 return retval;
Jean Delvare2bb50952009-09-18 22:45:46 +02001541#ifdef CONFIG_I2C_COMPAT
1542 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
1543 if (!i2c_adapter_compat_class) {
1544 retval = -ENOMEM;
1545 goto bus_err;
1546 }
1547#endif
David Brownelle9f13732008-01-27 18:14:52 +01001548 retval = i2c_add_driver(&dummy_driver);
1549 if (retval)
Jean Delvare2bb50952009-09-18 22:45:46 +02001550 goto class_err;
David Brownelle9f13732008-01-27 18:14:52 +01001551 return 0;
1552
Jean Delvare2bb50952009-09-18 22:45:46 +02001553class_err:
1554#ifdef CONFIG_I2C_COMPAT
1555 class_compat_unregister(i2c_adapter_compat_class);
David Brownelle9f13732008-01-27 18:14:52 +01001556bus_err:
Jean Delvare2bb50952009-09-18 22:45:46 +02001557#endif
David Brownelle9f13732008-01-27 18:14:52 +01001558 bus_unregister(&i2c_bus_type);
1559 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560}
1561
1562static void __exit i2c_exit(void)
1563{
David Brownelle9f13732008-01-27 18:14:52 +01001564 i2c_del_driver(&dummy_driver);
Jean Delvare2bb50952009-09-18 22:45:46 +02001565#ifdef CONFIG_I2C_COMPAT
1566 class_compat_unregister(i2c_adapter_compat_class);
1567#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 bus_unregister(&i2c_bus_type);
1569}
1570
David Brownella10f9e72008-10-14 17:30:06 +02001571/* We must initialize early, because some subsystems register i2c drivers
1572 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1573 */
1574postcore_initcall(i2c_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575module_exit(i2c_exit);
1576
1577/* ----------------------------------------------------
1578 * the functional interface to the i2c busses.
1579 * ----------------------------------------------------
1580 */
1581
David Brownella1cdeda2008-07-14 22:38:24 +02001582/**
Jean Delvareb37d2a32012-06-29 07:47:19 -03001583 * __i2c_transfer - unlocked flavor of i2c_transfer
1584 * @adap: Handle to I2C bus
1585 * @msgs: One or more messages to execute before STOP is issued to
1586 * terminate the operation; each message begins with a START.
1587 * @num: Number of messages to be executed.
1588 *
1589 * Returns negative errno, else the number of messages executed.
1590 *
1591 * Adapter lock must be held when calling this function. No debug logging
1592 * takes place. adap->algo->master_xfer existence isn't checked.
1593 */
1594int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1595{
1596 unsigned long orig_jiffies;
1597 int ret, try;
1598
1599 /* Retry automatically on arbitration loss */
1600 orig_jiffies = jiffies;
1601 for (ret = 0, try = 0; try <= adap->retries; try++) {
1602 ret = adap->algo->master_xfer(adap, msgs, num);
1603 if (ret != -EAGAIN)
1604 break;
1605 if (time_after(jiffies, orig_jiffies + adap->timeout))
1606 break;
1607 }
1608
1609 return ret;
1610}
1611EXPORT_SYMBOL(__i2c_transfer);
1612
1613/**
David Brownella1cdeda2008-07-14 22:38:24 +02001614 * i2c_transfer - execute a single or combined I2C message
1615 * @adap: Handle to I2C bus
1616 * @msgs: One or more messages to execute before STOP is issued to
1617 * terminate the operation; each message begins with a START.
1618 * @num: Number of messages to be executed.
1619 *
1620 * Returns negative errno, else the number of messages executed.
1621 *
1622 * Note that there is no requirement that each message be sent to
1623 * the same slave address, although that is the most common model.
1624 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001625int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626{
Jean Delvareb37d2a32012-06-29 07:47:19 -03001627 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
David Brownella1cdeda2008-07-14 22:38:24 +02001629 /* REVISIT the fault reporting model here is weak:
1630 *
1631 * - When we get an error after receiving N bytes from a slave,
1632 * there is no way to report "N".
1633 *
1634 * - When we get a NAK after transmitting N bytes to a slave,
1635 * there is no way to report "N" ... or to let the master
1636 * continue executing the rest of this combined message, if
1637 * that's the appropriate response.
1638 *
1639 * - When for example "num" is two and we successfully complete
1640 * the first message but get an error part way through the
1641 * second, it's unclear whether that should be reported as
1642 * one (discarding status on the second message) or errno
1643 * (discarding status on the first one).
1644 */
1645
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 if (adap->algo->master_xfer) {
1647#ifdef DEBUG
1648 for (ret = 0; ret < num; ret++) {
1649 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +02001650 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1651 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1652 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 }
1654#endif
1655
Mike Rapoportcea443a2008-01-27 18:14:50 +01001656 if (in_atomic() || irqs_disabled()) {
Jean Delvarefe61e072010-08-11 18:20:58 +02001657 ret = i2c_trylock_adapter(adap);
Mike Rapoportcea443a2008-01-27 18:14:50 +01001658 if (!ret)
1659 /* I2C activity is ongoing. */
1660 return -EAGAIN;
1661 } else {
Jean Delvarefe61e072010-08-11 18:20:58 +02001662 i2c_lock_adapter(adap);
Mike Rapoportcea443a2008-01-27 18:14:50 +01001663 }
1664
Jean Delvareb37d2a32012-06-29 07:47:19 -03001665 ret = __i2c_transfer(adap, msgs, num);
Jean Delvarefe61e072010-08-11 18:20:58 +02001666 i2c_unlock_adapter(adap);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
1668 return ret;
1669 } else {
1670 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001671 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 }
1673}
David Brownellc0564602007-05-01 23:26:31 +02001674EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
David Brownella1cdeda2008-07-14 22:38:24 +02001676/**
1677 * i2c_master_send - issue a single I2C message in master transmit mode
1678 * @client: Handle to slave device
1679 * @buf: Data that will be written to the slave
Zhangfei Gao0c43ea52010-03-02 12:23:49 +01001680 * @count: How many bytes to write, must be less than 64k since msg.len is u16
David Brownella1cdeda2008-07-14 22:38:24 +02001681 *
1682 * Returns negative errno, or else the number of bytes written.
1683 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001684int i2c_master_send(const struct i2c_client *client, const char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685{
1686 int ret;
Farid Hammane7225acf2010-05-21 18:40:58 +02001687 struct i2c_adapter *adap = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 struct i2c_msg msg;
1689
Jean Delvare815f55f2005-05-07 22:58:46 +02001690 msg.addr = client->addr;
1691 msg.flags = client->flags & I2C_M_TEN;
1692 msg.len = count;
1693 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01001694
Jean Delvare815f55f2005-05-07 22:58:46 +02001695 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696
Wolfram Sang834aa6f2012-03-15 18:11:05 +01001697 /*
1698 * If everything went ok (i.e. 1 msg transmitted), return #bytes
1699 * transmitted, else error code.
1700 */
Jean Delvare815f55f2005-05-07 22:58:46 +02001701 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702}
David Brownellc0564602007-05-01 23:26:31 +02001703EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704
David Brownella1cdeda2008-07-14 22:38:24 +02001705/**
1706 * i2c_master_recv - issue a single I2C message in master receive mode
1707 * @client: Handle to slave device
1708 * @buf: Where to store data read from slave
Zhangfei Gao0c43ea52010-03-02 12:23:49 +01001709 * @count: How many bytes to read, must be less than 64k since msg.len is u16
David Brownella1cdeda2008-07-14 22:38:24 +02001710 *
1711 * Returns negative errno, or else the number of bytes read.
1712 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001713int i2c_master_recv(const struct i2c_client *client, char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714{
Farid Hammane7225acf2010-05-21 18:40:58 +02001715 struct i2c_adapter *adap = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 struct i2c_msg msg;
1717 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718
Jean Delvare815f55f2005-05-07 22:58:46 +02001719 msg.addr = client->addr;
1720 msg.flags = client->flags & I2C_M_TEN;
1721 msg.flags |= I2C_M_RD;
1722 msg.len = count;
1723 msg.buf = buf;
1724
1725 ret = i2c_transfer(adap, &msg, 1);
1726
Wolfram Sang834aa6f2012-03-15 18:11:05 +01001727 /*
1728 * If everything went ok (i.e. 1 msg received), return #bytes received,
1729 * else error code.
1730 */
Jean Delvare815f55f2005-05-07 22:58:46 +02001731 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732}
David Brownellc0564602007-05-01 23:26:31 +02001733EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735/* ----------------------------------------------------
1736 * the i2c address scanning function
1737 * Will not work for 10-bit addresses!
1738 * ----------------------------------------------------
1739 */
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001740
Jean Delvare63e4e802010-06-03 11:33:51 +02001741/*
1742 * Legacy default probe function, mostly relevant for SMBus. The default
1743 * probe method is a quick write, but it is known to corrupt the 24RF08
1744 * EEPROMs due to a state machine bug, and could also irreversibly
1745 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
1746 * we use a short byte read instead. Also, some bus drivers don't implement
1747 * quick write, so we fallback to a byte read in that case too.
1748 * On x86, there is another special case for FSC hardware monitoring chips,
1749 * which want regular byte reads (address 0x73.) Fortunately, these are the
1750 * only known chips using this I2C address on PC hardware.
1751 * Returns 1 if probe succeeded, 0 if not.
1752 */
1753static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
1754{
1755 int err;
1756 union i2c_smbus_data dummy;
1757
1758#ifdef CONFIG_X86
1759 if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
1760 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
1761 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1762 I2C_SMBUS_BYTE_DATA, &dummy);
1763 else
1764#endif
Jean Delvare8031d792010-08-11 18:21:00 +02001765 if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
1766 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
Jean Delvare63e4e802010-06-03 11:33:51 +02001767 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
1768 I2C_SMBUS_QUICK, NULL);
Jean Delvare8031d792010-08-11 18:21:00 +02001769 else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
1770 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1771 I2C_SMBUS_BYTE, &dummy);
1772 else {
Andy Lutomirskid63a9e82013-07-17 13:27:59 -07001773 dev_warn(&adap->dev, "No suitable probing method supported for address 0x%02X\n",
1774 addr);
Jean Delvare8031d792010-08-11 18:21:00 +02001775 err = -EOPNOTSUPP;
1776 }
Jean Delvare63e4e802010-06-03 11:33:51 +02001777
1778 return err >= 0;
1779}
1780
Jean Delvareccfbbd02009-12-06 17:06:25 +01001781static int i2c_detect_address(struct i2c_client *temp_client,
Jean Delvare4735c982008-07-14 22:38:36 +02001782 struct i2c_driver *driver)
1783{
1784 struct i2c_board_info info;
1785 struct i2c_adapter *adapter = temp_client->adapter;
1786 int addr = temp_client->addr;
1787 int err;
1788
1789 /* Make sure the address is valid */
Jean Delvare656b8762010-06-03 11:33:53 +02001790 err = i2c_check_addr_validity(addr);
1791 if (err) {
Jean Delvare4735c982008-07-14 22:38:36 +02001792 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1793 addr);
Jean Delvare656b8762010-06-03 11:33:53 +02001794 return err;
Jean Delvare4735c982008-07-14 22:38:36 +02001795 }
1796
1797 /* Skip if already in use */
Jean Delvare3b5f7942010-06-03 11:33:55 +02001798 if (i2c_check_addr_busy(adapter, addr))
Jean Delvare4735c982008-07-14 22:38:36 +02001799 return 0;
1800
Jean Delvareccfbbd02009-12-06 17:06:25 +01001801 /* Make sure there is something at this address */
Jean Delvare63e4e802010-06-03 11:33:51 +02001802 if (!i2c_default_probe(adapter, addr))
1803 return 0;
Jean Delvare4735c982008-07-14 22:38:36 +02001804
1805 /* Finally call the custom detection function */
1806 memset(&info, 0, sizeof(struct i2c_board_info));
1807 info.addr = addr;
Jean Delvare310ec792009-12-14 21:17:23 +01001808 err = driver->detect(temp_client, &info);
Jean Delvare4735c982008-07-14 22:38:36 +02001809 if (err) {
1810 /* -ENODEV is returned if the detection fails. We catch it
1811 here as this isn't an error. */
1812 return err == -ENODEV ? 0 : err;
1813 }
1814
1815 /* Consistency check */
1816 if (info.type[0] == '\0') {
1817 dev_err(&adapter->dev, "%s detection function provided "
1818 "no name for 0x%x\n", driver->driver.name,
1819 addr);
1820 } else {
1821 struct i2c_client *client;
1822
1823 /* Detection succeeded, instantiate the device */
1824 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1825 info.type, info.addr);
1826 client = i2c_new_device(adapter, &info);
1827 if (client)
1828 list_add_tail(&client->detected, &driver->clients);
1829 else
1830 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1831 info.type, info.addr);
1832 }
1833 return 0;
1834}
1835
1836static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1837{
Jean Delvarec3813d62009-12-14 21:17:25 +01001838 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +02001839 struct i2c_client *temp_client;
1840 int i, err = 0;
1841 int adap_id = i2c_adapter_id(adapter);
1842
Jean Delvarec3813d62009-12-14 21:17:25 +01001843 address_list = driver->address_list;
1844 if (!driver->detect || !address_list)
Jean Delvare4735c982008-07-14 22:38:36 +02001845 return 0;
1846
Jean Delvare51b54ba2010-10-24 18:16:58 +02001847 /* Stop here if the classes do not match */
1848 if (!(adapter->class & driver->class))
1849 return 0;
1850
Jean Delvare4735c982008-07-14 22:38:36 +02001851 /* Set up a temporary client to help detect callback */
1852 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1853 if (!temp_client)
1854 return -ENOMEM;
1855 temp_client->adapter = adapter;
1856
Jean Delvarec3813d62009-12-14 21:17:25 +01001857 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
Jean Delvare4735c982008-07-14 22:38:36 +02001858 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
Jean Delvarec3813d62009-12-14 21:17:25 +01001859 "addr 0x%02x\n", adap_id, address_list[i]);
1860 temp_client->addr = address_list[i];
Jean Delvareccfbbd02009-12-06 17:06:25 +01001861 err = i2c_detect_address(temp_client, driver);
Jean Delvare51b54ba2010-10-24 18:16:58 +02001862 if (unlikely(err))
1863 break;
Jean Delvare4735c982008-07-14 22:38:36 +02001864 }
1865
Jean Delvare4735c982008-07-14 22:38:36 +02001866 kfree(temp_client);
1867 return err;
1868}
1869
Jean Delvared44f19d2010-08-11 18:20:57 +02001870int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
1871{
1872 return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1873 I2C_SMBUS_QUICK, NULL) >= 0;
1874}
1875EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);
1876
Jean Delvare12b5053a2007-05-01 23:26:31 +02001877struct i2c_client *
1878i2c_new_probed_device(struct i2c_adapter *adap,
1879 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +02001880 unsigned short const *addr_list,
1881 int (*probe)(struct i2c_adapter *, unsigned short addr))
Jean Delvare12b5053a2007-05-01 23:26:31 +02001882{
1883 int i;
1884
Jean Delvare8031d792010-08-11 18:21:00 +02001885 if (!probe)
Jean Delvare9a942412010-08-11 18:20:56 +02001886 probe = i2c_default_probe;
Jean Delvare12b5053a2007-05-01 23:26:31 +02001887
Jean Delvare12b5053a2007-05-01 23:26:31 +02001888 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1889 /* Check address validity */
Jean Delvare656b8762010-06-03 11:33:53 +02001890 if (i2c_check_addr_validity(addr_list[i]) < 0) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001891 dev_warn(&adap->dev, "Invalid 7-bit address "
1892 "0x%02x\n", addr_list[i]);
1893 continue;
1894 }
1895
1896 /* Check address availability */
Jean Delvare3b5f7942010-06-03 11:33:55 +02001897 if (i2c_check_addr_busy(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001898 dev_dbg(&adap->dev, "Address 0x%02x already in "
1899 "use, not probing\n", addr_list[i]);
1900 continue;
1901 }
1902
Jean Delvare63e4e802010-06-03 11:33:51 +02001903 /* Test address responsiveness */
Jean Delvare9a942412010-08-11 18:20:56 +02001904 if (probe(adap, addr_list[i]))
Jean Delvare63e4e802010-06-03 11:33:51 +02001905 break;
Jean Delvare12b5053a2007-05-01 23:26:31 +02001906 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02001907
1908 if (addr_list[i] == I2C_CLIENT_END) {
1909 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1910 return NULL;
1911 }
1912
1913 info->addr = addr_list[i];
1914 return i2c_new_device(adap, info);
1915}
1916EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1917
Jean Delvared735b342011-03-20 14:50:52 +01001918struct i2c_adapter *i2c_get_adapter(int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001921
Jean Delvarecaada322008-01-27 18:14:49 +01001922 mutex_lock(&core_lock);
Jean Delvared735b342011-03-20 14:50:52 +01001923 adapter = idr_find(&i2c_adapter_idr, nr);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001924 if (adapter && !try_module_get(adapter->owner))
1925 adapter = NULL;
1926
Jean Delvarecaada322008-01-27 18:14:49 +01001927 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001928 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929}
David Brownellc0564602007-05-01 23:26:31 +02001930EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931
1932void i2c_put_adapter(struct i2c_adapter *adap)
1933{
Sebastian Hesselbarthc66c4cc2013-08-01 14:10:46 +02001934 if (adap)
1935 module_put(adap->owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936}
David Brownellc0564602007-05-01 23:26:31 +02001937EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
1939/* The SMBus parts */
1940
David Brownell438d6c22006-12-10 21:21:31 +01001941#define POLY (0x1070U << 3)
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001942static u8 crc8(u16 data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943{
1944 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001945
Farid Hammane7225acf2010-05-21 18:40:58 +02001946 for (i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001947 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 data = data ^ POLY;
1949 data = data << 1;
1950 }
1951 return (u8)(data >> 8);
1952}
1953
Jean Delvare421ef472005-10-26 21:28:55 +02001954/* Incremental CRC8 over count bytes in the array pointed to by p */
1955static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956{
1957 int i;
1958
Farid Hammane7225acf2010-05-21 18:40:58 +02001959 for (i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001960 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 return crc;
1962}
1963
Jean Delvare421ef472005-10-26 21:28:55 +02001964/* Assume a 7-bit address, which is reasonable for SMBus */
1965static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966{
Jean Delvare421ef472005-10-26 21:28:55 +02001967 /* The address will be sent first */
1968 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1969 pec = i2c_smbus_pec(pec, &addr, 1);
1970
1971 /* The data buffer follows */
1972 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973}
1974
Jean Delvare421ef472005-10-26 21:28:55 +02001975/* Used for write only transactions */
1976static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977{
Jean Delvare421ef472005-10-26 21:28:55 +02001978 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1979 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980}
1981
Jean Delvare421ef472005-10-26 21:28:55 +02001982/* Return <0 on CRC error
1983 If there was a write before this read (most cases) we need to take the
1984 partial CRC from the write part into account.
1985 Note that this function does modify the message (we need to decrease the
1986 message length to hide the CRC byte from the caller). */
1987static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988{
Jean Delvare421ef472005-10-26 21:28:55 +02001989 u8 rpec = msg->buf[--msg->len];
1990 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 if (rpec != cpec) {
1993 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1994 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02001995 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 }
David Brownell438d6c22006-12-10 21:21:31 +01001997 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998}
1999
David Brownella1cdeda2008-07-14 22:38:24 +02002000/**
2001 * i2c_smbus_read_byte - SMBus "receive byte" protocol
2002 * @client: Handle to slave device
2003 *
2004 * This executes the SMBus "receive byte" protocol, returning negative errno
2005 * else the byte received from the device.
2006 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002007s32 i2c_smbus_read_byte(const struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008{
2009 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002010 int status;
2011
2012 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2013 I2C_SMBUS_READ, 0,
2014 I2C_SMBUS_BYTE, &data);
2015 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016}
David Brownellc0564602007-05-01 23:26:31 +02002017EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018
David Brownella1cdeda2008-07-14 22:38:24 +02002019/**
2020 * i2c_smbus_write_byte - SMBus "send byte" protocol
2021 * @client: Handle to slave device
2022 * @value: Byte to be sent
2023 *
2024 * This executes the SMBus "send byte" protocol, returning negative errno
2025 * else zero on success.
2026 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002027s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028{
Farid Hammane7225acf2010-05-21 18:40:58 +02002029 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02002030 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031}
David Brownellc0564602007-05-01 23:26:31 +02002032EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033
David Brownella1cdeda2008-07-14 22:38:24 +02002034/**
2035 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
2036 * @client: Handle to slave device
2037 * @command: Byte interpreted by slave
2038 *
2039 * This executes the SMBus "read byte" protocol, returning negative errno
2040 * else a data byte received from the device.
2041 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002042s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043{
2044 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002045 int status;
2046
2047 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2048 I2C_SMBUS_READ, command,
2049 I2C_SMBUS_BYTE_DATA, &data);
2050 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051}
David Brownellc0564602007-05-01 23:26:31 +02002052EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053
David Brownella1cdeda2008-07-14 22:38:24 +02002054/**
2055 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
2056 * @client: Handle to slave device
2057 * @command: Byte interpreted by slave
2058 * @value: Byte being written
2059 *
2060 * This executes the SMBus "write byte" protocol, returning negative errno
2061 * else zero on success.
2062 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002063s32 i2c_smbus_write_byte_data(const struct i2c_client *client, u8 command,
2064 u8 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065{
2066 union i2c_smbus_data data;
2067 data.byte = value;
Farid Hammane7225acf2010-05-21 18:40:58 +02002068 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2069 I2C_SMBUS_WRITE, command,
2070 I2C_SMBUS_BYTE_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071}
David Brownellc0564602007-05-01 23:26:31 +02002072EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073
David Brownella1cdeda2008-07-14 22:38:24 +02002074/**
2075 * i2c_smbus_read_word_data - SMBus "read word" protocol
2076 * @client: Handle to slave device
2077 * @command: Byte interpreted by slave
2078 *
2079 * This executes the SMBus "read word" protocol, returning negative errno
2080 * else a 16-bit unsigned "word" received from the device.
2081 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002082s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083{
2084 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002085 int status;
2086
2087 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2088 I2C_SMBUS_READ, command,
2089 I2C_SMBUS_WORD_DATA, &data);
2090 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091}
David Brownellc0564602007-05-01 23:26:31 +02002092EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093
David Brownella1cdeda2008-07-14 22:38:24 +02002094/**
2095 * i2c_smbus_write_word_data - SMBus "write word" protocol
2096 * @client: Handle to slave device
2097 * @command: Byte interpreted by slave
2098 * @value: 16-bit "word" being written
2099 *
2100 * This executes the SMBus "write word" protocol, returning negative errno
2101 * else zero on success.
2102 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002103s32 i2c_smbus_write_word_data(const struct i2c_client *client, u8 command,
2104 u16 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105{
2106 union i2c_smbus_data data;
2107 data.word = value;
Farid Hammane7225acf2010-05-21 18:40:58 +02002108 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2109 I2C_SMBUS_WRITE, command,
2110 I2C_SMBUS_WORD_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111}
David Brownellc0564602007-05-01 23:26:31 +02002112EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113
David Brownella64ec072007-10-13 23:56:31 +02002114/**
David Brownella1cdeda2008-07-14 22:38:24 +02002115 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02002116 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02002117 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02002118 * @values: Byte array into which data will be read; big enough to hold
2119 * the data returned by the slave. SMBus allows at most 32 bytes.
2120 *
David Brownella1cdeda2008-07-14 22:38:24 +02002121 * This executes the SMBus "block read" protocol, returning negative errno
2122 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02002123 *
2124 * Note that using this function requires that the client's adapter support
2125 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
2126 * support this; its emulation through I2C messaging relies on a specific
2127 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
2128 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002129s32 i2c_smbus_read_block_data(const struct i2c_client *client, u8 command,
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002130 u8 *values)
2131{
2132 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002133 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002134
David Brownell24a5bb72008-07-14 22:38:23 +02002135 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2136 I2C_SMBUS_READ, command,
2137 I2C_SMBUS_BLOCK_DATA, &data);
2138 if (status)
2139 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002140
2141 memcpy(values, &data.block[1], data.block[0]);
2142 return data.block[0];
2143}
2144EXPORT_SYMBOL(i2c_smbus_read_block_data);
2145
David Brownella1cdeda2008-07-14 22:38:24 +02002146/**
2147 * i2c_smbus_write_block_data - SMBus "block write" protocol
2148 * @client: Handle to slave device
2149 * @command: Byte interpreted by slave
2150 * @length: Size of data block; SMBus allows at most 32 bytes
2151 * @values: Byte array which will be written.
2152 *
2153 * This executes the SMBus "block write" protocol, returning negative errno
2154 * else zero on success.
2155 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002156s32 i2c_smbus_write_block_data(const struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02002157 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158{
2159 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01002160
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 if (length > I2C_SMBUS_BLOCK_MAX)
2162 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01002164 memcpy(&data.block[1], values, length);
Farid Hammane7225acf2010-05-21 18:40:58 +02002165 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2166 I2C_SMBUS_WRITE, command,
2167 I2C_SMBUS_BLOCK_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168}
David Brownellc0564602007-05-01 23:26:31 +02002169EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170
2171/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002172s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, u8 command,
Jean Delvare4b2643d2007-07-12 14:12:29 +02002173 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174{
2175 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002176 int status;
Jean Delvare76560322006-01-18 23:14:55 +01002177
Jean Delvare4b2643d2007-07-12 14:12:29 +02002178 if (length > I2C_SMBUS_BLOCK_MAX)
2179 length = I2C_SMBUS_BLOCK_MAX;
2180 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02002181 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2182 I2C_SMBUS_READ, command,
2183 I2C_SMBUS_I2C_BLOCK_DATA, &data);
2184 if (status < 0)
2185 return status;
Jean Delvare76560322006-01-18 23:14:55 +01002186
2187 memcpy(values, &data.block[1], data.block[0]);
2188 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189}
David Brownellc0564602007-05-01 23:26:31 +02002190EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191
Jean Delvare0cc43a12011-01-10 22:11:23 +01002192s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02002193 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11002194{
2195 union i2c_smbus_data data;
2196
2197 if (length > I2C_SMBUS_BLOCK_MAX)
2198 length = I2C_SMBUS_BLOCK_MAX;
2199 data.block[0] = length;
2200 memcpy(data.block + 1, values, length);
2201 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2202 I2C_SMBUS_WRITE, command,
2203 I2C_SMBUS_I2C_BLOCK_DATA, &data);
2204}
David Brownellc0564602007-05-01 23:26:31 +02002205EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11002206
David Brownell438d6c22006-12-10 21:21:31 +01002207/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 No checking of parameters is done! */
Farid Hammane7225acf2010-05-21 18:40:58 +02002209static s32 i2c_smbus_xfer_emulated(struct i2c_adapter *adapter, u16 addr,
2210 unsigned short flags,
2211 char read_write, u8 command, int size,
2212 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213{
2214 /* So we need to generate a series of msgs. In the case of writing, we
2215 need to use only one message; when reading, we need two. We initialize
2216 most things with sane defaults, to keep the code below somewhat
2217 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02002218 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
2219 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Farid Hammane7225acf2010-05-21 18:40:58 +02002220 int num = read_write == I2C_SMBUS_READ ? 2 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02002222 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02002223 int status;
Shubhrajyoti D230da092012-10-05 22:23:52 +02002224 struct i2c_msg msg[2] = {
2225 {
2226 .addr = addr,
2227 .flags = flags,
2228 .len = 1,
2229 .buf = msgbuf0,
2230 }, {
2231 .addr = addr,
2232 .flags = flags | I2C_M_RD,
2233 .len = 0,
2234 .buf = msgbuf1,
2235 },
2236 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237
2238 msgbuf0[0] = command;
Farid Hammane7225acf2010-05-21 18:40:58 +02002239 switch (size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 case I2C_SMBUS_QUICK:
2241 msg[0].len = 0;
2242 /* Special case: The read/write field is used as data */
Roel Kluinf29d2e02009-02-24 19:19:48 +01002243 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
2244 I2C_M_RD : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 num = 1;
2246 break;
2247 case I2C_SMBUS_BYTE:
2248 if (read_write == I2C_SMBUS_READ) {
2249 /* Special case: only a read! */
2250 msg[0].flags = I2C_M_RD | flags;
2251 num = 1;
2252 }
2253 break;
2254 case I2C_SMBUS_BYTE_DATA:
2255 if (read_write == I2C_SMBUS_READ)
2256 msg[1].len = 1;
2257 else {
2258 msg[0].len = 2;
2259 msgbuf0[1] = data->byte;
2260 }
2261 break;
2262 case I2C_SMBUS_WORD_DATA:
2263 if (read_write == I2C_SMBUS_READ)
2264 msg[1].len = 2;
2265 else {
Farid Hammane7225acf2010-05-21 18:40:58 +02002266 msg[0].len = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02002268 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 }
2270 break;
2271 case I2C_SMBUS_PROC_CALL:
2272 num = 2; /* Special case */
2273 read_write = I2C_SMBUS_READ;
2274 msg[0].len = 3;
2275 msg[1].len = 2;
2276 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02002277 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 break;
2279 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02002281 msg[1].flags |= I2C_M_RECV_LEN;
2282 msg[1].len = 1; /* block length will be added by
2283 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 } else {
2285 msg[0].len = data->block[0] + 2;
2286 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02002287 dev_err(&adapter->dev,
2288 "Invalid block write size %d\n",
2289 data->block[0]);
2290 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02002292 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 msgbuf0[i] = data->block[i-1];
2294 }
2295 break;
2296 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02002297 num = 2; /* Another special case */
2298 read_write = I2C_SMBUS_READ;
2299 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02002300 dev_err(&adapter->dev,
2301 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02002302 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02002303 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02002304 }
2305 msg[0].len = data->block[0] + 2;
2306 for (i = 1; i < msg[0].len; i++)
2307 msgbuf0[i] = data->block[i-1];
2308 msg[1].flags |= I2C_M_RECV_LEN;
2309 msg[1].len = 1; /* block length will be added by
2310 the underlying bus driver */
2311 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 case I2C_SMBUS_I2C_BLOCK_DATA:
2313 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02002314 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 } else {
2316 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02002317 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02002318 dev_err(&adapter->dev,
2319 "Invalid block write size %d\n",
2320 data->block[0]);
2321 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 }
2323 for (i = 1; i <= data->block[0]; i++)
2324 msgbuf0[i] = data->block[i];
2325 }
2326 break;
2327 default:
David Brownell24a5bb72008-07-14 22:38:23 +02002328 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
2329 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 }
2331
Jean Delvare421ef472005-10-26 21:28:55 +02002332 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
2333 && size != I2C_SMBUS_I2C_BLOCK_DATA);
2334 if (i) {
2335 /* Compute PEC if first message is a write */
2336 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01002337 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02002338 i2c_smbus_add_pec(&msg[0]);
2339 else /* Write followed by read */
2340 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
2341 }
2342 /* Ask for PEC if last message is a read */
2343 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01002344 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02002345 }
2346
David Brownell24a5bb72008-07-14 22:38:23 +02002347 status = i2c_transfer(adapter, msg, num);
2348 if (status < 0)
2349 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350
Jean Delvare421ef472005-10-26 21:28:55 +02002351 /* Check PEC if last message is a read */
2352 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02002353 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
2354 if (status < 0)
2355 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02002356 }
2357
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 if (read_write == I2C_SMBUS_READ)
Farid Hammane7225acf2010-05-21 18:40:58 +02002359 switch (size) {
2360 case I2C_SMBUS_BYTE:
2361 data->byte = msgbuf0[0];
2362 break;
2363 case I2C_SMBUS_BYTE_DATA:
2364 data->byte = msgbuf1[0];
2365 break;
2366 case I2C_SMBUS_WORD_DATA:
2367 case I2C_SMBUS_PROC_CALL:
2368 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
2369 break;
2370 case I2C_SMBUS_I2C_BLOCK_DATA:
2371 for (i = 0; i < data->block[0]; i++)
2372 data->block[i+1] = msgbuf1[i];
2373 break;
2374 case I2C_SMBUS_BLOCK_DATA:
2375 case I2C_SMBUS_BLOCK_PROC_CALL:
2376 for (i = 0; i < msgbuf1[0] + 1; i++)
2377 data->block[i] = msgbuf1[i];
2378 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 }
2380 return 0;
2381}
2382
David Brownella1cdeda2008-07-14 22:38:24 +02002383/**
2384 * i2c_smbus_xfer - execute SMBus protocol operations
2385 * @adapter: Handle to I2C bus
2386 * @addr: Address of SMBus slave on that bus
2387 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
2388 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
2389 * @command: Byte interpreted by slave, for protocols which use such bytes
2390 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
2391 * @data: Data to be read or written
2392 *
2393 * This executes an SMBus protocol operation, and returns a negative
2394 * errno code else zero on success.
2395 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01002396s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02002397 char read_write, u8 command, int protocol,
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01002398 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399{
Clifford Wolf66b650f2009-06-15 18:01:46 +02002400 unsigned long orig_jiffies;
2401 int try;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403
Laurent Pinchartd47726c2012-07-24 14:13:59 +02002404 flags &= I2C_M_TEN | I2C_CLIENT_PEC | I2C_CLIENT_SCCB;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405
2406 if (adapter->algo->smbus_xfer) {
Jean Delvarefe61e072010-08-11 18:20:58 +02002407 i2c_lock_adapter(adapter);
Clifford Wolf66b650f2009-06-15 18:01:46 +02002408
2409 /* Retry automatically on arbitration loss */
2410 orig_jiffies = jiffies;
2411 for (res = 0, try = 0; try <= adapter->retries; try++) {
2412 res = adapter->algo->smbus_xfer(adapter, addr, flags,
2413 read_write, command,
2414 protocol, data);
2415 if (res != -EAGAIN)
2416 break;
2417 if (time_after(jiffies,
2418 orig_jiffies + adapter->timeout))
2419 break;
2420 }
Jean Delvarefe61e072010-08-11 18:20:58 +02002421 i2c_unlock_adapter(adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422
Laurent Pinchart72fc2c72012-07-24 14:13:59 +02002423 if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
2424 return res;
2425 /*
2426 * Fall back to i2c_smbus_xfer_emulated if the adapter doesn't
2427 * implement native support for the SMBus operation.
2428 */
2429 }
2430
2431 return i2c_smbus_xfer_emulated(adapter, addr, flags, read_write,
2432 command, protocol, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435
2436MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2437MODULE_DESCRIPTION("I2C-Bus main module");
2438MODULE_LICENSE("GPL");