blob: 3d9ca2d3d77ec1a876fdb95021f97a521fb0e279 [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
26 Michael Lawnick <michael.lawnick.ext@nsn.com> */
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/module.h>
29#include <linux/kernel.h>
Viresh Kumar5f9296b2012-02-28 18:26:31 +053030#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/errno.h>
Viresh Kumar5f9296b2012-02-28 18:26:31 +053032#include <linux/gpio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/slab.h>
34#include <linux/i2c.h>
35#include <linux/init.h>
36#include <linux/idr.h>
Arjan van de Venb3585e42006-01-11 10:50:26 +010037#include <linux/mutex.h>
Grant Likely959e85f2010-06-08 07:48:19 -060038#include <linux/of_device.h>
Jean Delvareb8d6f452007-02-13 22:09:00 +010039#include <linux/completion.h>
Mike Rapoportcea443a82008-01-27 18:14:50 +010040#include <linux/hardirq.h>
41#include <linux/irqflags.h>
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +020042#include <linux/rwsem.h>
Mark Brown6de468a2010-03-02 12:23:46 +010043#include <linux/pm_runtime.h>
Mika Westerberg907ddf82012-11-23 12:23:40 +010044#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <asm/uaccess.h>
46
David Brownell9c1600e2007-05-01 23:26:31 +020047#include "i2c-core.h"
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Jean Delvare6629dcf2010-05-04 11:09:28 +020050/* core_lock protects i2c_adapter_idr, and guarantees
Jean Delvare35fc37f2009-06-19 16:58:19 +020051 that device detection, deletion of detected devices, and attach_adapter
Lars-Peter Clausen19baba42013-03-09 08:16:44 +000052 calls are serialized */
Jean Delvarecaada322008-01-27 18:14:49 +010053static DEFINE_MUTEX(core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054static DEFINE_IDR(i2c_adapter_idr);
55
Jean Delvare4f8cf822009-09-18 22:45:46 +020056static struct device_type i2c_client_type;
Jean Delvare4735c982008-07-14 22:38:36 +020057static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
David Brownellf37dd802007-02-13 22:09:00 +010058
59/* ------------------------------------------------------------------------- */
60
Jean Delvared2653e92008-04-29 23:11:39 +020061static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
62 const struct i2c_client *client)
63{
64 while (id->name[0]) {
65 if (strcmp(client->name, id->name) == 0)
66 return id;
67 id++;
68 }
69 return NULL;
70}
71
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static int i2c_device_match(struct device *dev, struct device_driver *drv)
73{
Jean Delvare51298d12009-09-18 22:45:45 +020074 struct i2c_client *client = i2c_verify_client(dev);
75 struct i2c_driver *driver;
David Brownell7b4fbc52007-05-01 23:26:30 +020076
Jean Delvare51298d12009-09-18 22:45:45 +020077 if (!client)
78 return 0;
79
Grant Likely959e85f2010-06-08 07:48:19 -060080 /* Attempt an OF style match */
81 if (of_driver_match_device(dev, drv))
82 return 1;
83
Mika Westerberg907ddf82012-11-23 12:23:40 +010084 /* Then ACPI style match */
85 if (acpi_driver_match_device(dev, drv))
86 return 1;
87
Jean Delvare51298d12009-09-18 22:45:45 +020088 driver = to_i2c_driver(drv);
Jean Delvared2653e92008-04-29 23:11:39 +020089 /* match on an id table if there is one */
90 if (driver->id_table)
91 return i2c_match_id(driver->id_table, client) != NULL;
92
Jean Delvareeb8a7902008-05-18 20:49:41 +020093 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094}
95
David Brownell7b4fbc52007-05-01 23:26:30 +020096
97/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +020098static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +020099{
100 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +0200101
Jean Delvareeb8a7902008-05-18 20:49:41 +0200102 if (add_uevent_var(env, "MODALIAS=%s%s",
103 I2C_MODULE_PREFIX, client->name))
104 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +0200105 dev_dbg(dev, "uevent\n");
106 return 0;
107}
108
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530109/* i2c bus recovery routines */
110static int get_scl_gpio_value(struct i2c_adapter *adap)
111{
112 return gpio_get_value(adap->bus_recovery_info->scl_gpio);
113}
114
115static void set_scl_gpio_value(struct i2c_adapter *adap, int val)
116{
117 gpio_set_value(adap->bus_recovery_info->scl_gpio, val);
118}
119
120static int get_sda_gpio_value(struct i2c_adapter *adap)
121{
122 return gpio_get_value(adap->bus_recovery_info->sda_gpio);
123}
124
125static int i2c_get_gpios_for_recovery(struct i2c_adapter *adap)
126{
127 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
128 struct device *dev = &adap->dev;
129 int ret = 0;
130
131 ret = gpio_request_one(bri->scl_gpio, GPIOF_OPEN_DRAIN |
132 GPIOF_OUT_INIT_HIGH, "i2c-scl");
133 if (ret) {
134 dev_warn(dev, "Can't get SCL gpio: %d\n", bri->scl_gpio);
135 return ret;
136 }
137
138 if (bri->get_sda) {
139 if (gpio_request_one(bri->sda_gpio, GPIOF_IN, "i2c-sda")) {
140 /* work without SDA polling */
141 dev_warn(dev, "Can't get SDA gpio: %d. Not using SDA polling\n",
142 bri->sda_gpio);
143 bri->get_sda = NULL;
144 }
145 }
146
147 return ret;
148}
149
150static void i2c_put_gpios_for_recovery(struct i2c_adapter *adap)
151{
152 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
153
154 if (bri->get_sda)
155 gpio_free(bri->sda_gpio);
156
157 gpio_free(bri->scl_gpio);
158}
159
160/*
161 * We are generating clock pulses. ndelay() determines durating of clk pulses.
162 * We will generate clock with rate 100 KHz and so duration of both clock levels
163 * is: delay in ns = (10^6 / 100) / 2
164 */
165#define RECOVERY_NDELAY 5000
166#define RECOVERY_CLK_CNT 9
167
168static int i2c_generic_recovery(struct i2c_adapter *adap)
169{
170 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
171 int i = 0, val = 1, ret = 0;
172
173 if (bri->prepare_recovery)
174 bri->prepare_recovery(bri);
175
176 /*
177 * By this time SCL is high, as we need to give 9 falling-rising edges
178 */
179 while (i++ < RECOVERY_CLK_CNT * 2) {
180 if (val) {
181 /* Break if SDA is high */
182 if (bri->get_sda && bri->get_sda(adap))
183 break;
184 /* SCL shouldn't be low here */
185 if (!bri->get_scl(adap)) {
186 dev_err(&adap->dev,
187 "SCL is stuck low, exit recovery\n");
188 ret = -EBUSY;
189 break;
190 }
191 }
192
193 val = !val;
194 bri->set_scl(adap, val);
195 ndelay(RECOVERY_NDELAY);
196 }
197
198 if (bri->unprepare_recovery)
199 bri->unprepare_recovery(bri);
200
201 return ret;
202}
203
204int i2c_generic_scl_recovery(struct i2c_adapter *adap)
205{
206 adap->bus_recovery_info->set_scl(adap, 1);
207 return i2c_generic_recovery(adap);
208}
209
210int i2c_generic_gpio_recovery(struct i2c_adapter *adap)
211{
212 int ret;
213
214 ret = i2c_get_gpios_for_recovery(adap);
215 if (ret)
216 return ret;
217
218 ret = i2c_generic_recovery(adap);
219 i2c_put_gpios_for_recovery(adap);
220
221 return ret;
222}
223
224int i2c_recover_bus(struct i2c_adapter *adap)
225{
226 if (!adap->bus_recovery_info)
227 return -EOPNOTSUPP;
228
229 dev_dbg(&adap->dev, "Trying i2c bus recovery\n");
230 return adap->bus_recovery_info->recover_bus(adap);
231}
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233static int i2c_device_probe(struct device *dev)
234{
Jean Delvare51298d12009-09-18 22:45:45 +0200235 struct i2c_client *client = i2c_verify_client(dev);
236 struct i2c_driver *driver;
Hans Verkuil50c33042008-03-12 14:15:00 +0100237 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200238
Jean Delvare51298d12009-09-18 22:45:45 +0200239 if (!client)
240 return 0;
241
242 driver = to_i2c_driver(dev->driver);
Jean Delvaree0457442008-07-14 22:38:30 +0200243 if (!driver->probe || !driver->id_table)
David Brownell7b4fbc52007-05-01 23:26:30 +0200244 return -ENODEV;
245 client->driver = driver;
Marc Pignatee354252008-08-28 08:33:22 +0200246 if (!device_can_wakeup(&client->dev))
247 device_init_wakeup(&client->dev,
248 client->flags & I2C_CLIENT_WAKE);
David Brownell7b4fbc52007-05-01 23:26:30 +0200249 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200250
Jean Delvaree0457442008-07-14 22:38:30 +0200251 status = driver->probe(client, i2c_match_id(driver->id_table, client));
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200252 if (status) {
Hans Verkuil50c33042008-03-12 14:15:00 +0100253 client->driver = NULL;
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200254 i2c_set_clientdata(client, NULL);
255 }
Hans Verkuil50c33042008-03-12 14:15:00 +0100256 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257}
258
259static int i2c_device_remove(struct device *dev)
260{
Jean Delvare51298d12009-09-18 22:45:45 +0200261 struct i2c_client *client = i2c_verify_client(dev);
David Brownella1d9e6e2007-05-01 23:26:30 +0200262 struct i2c_driver *driver;
263 int status;
264
Jean Delvare51298d12009-09-18 22:45:45 +0200265 if (!client || !dev->driver)
David Brownella1d9e6e2007-05-01 23:26:30 +0200266 return 0;
267
268 driver = to_i2c_driver(dev->driver);
269 if (driver->remove) {
270 dev_dbg(dev, "remove\n");
271 status = driver->remove(client);
272 } else {
273 dev->driver = NULL;
274 status = 0;
275 }
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200276 if (status == 0) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200277 client->driver = NULL;
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200278 i2c_set_clientdata(client, NULL);
279 }
David Brownella1d9e6e2007-05-01 23:26:30 +0200280 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281}
282
David Brownellf37dd802007-02-13 22:09:00 +0100283static void i2c_device_shutdown(struct device *dev)
284{
Jean Delvare51298d12009-09-18 22:45:45 +0200285 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100286 struct i2c_driver *driver;
287
Jean Delvare51298d12009-09-18 22:45:45 +0200288 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100289 return;
290 driver = to_i2c_driver(dev->driver);
291 if (driver->shutdown)
Jean Delvare51298d12009-09-18 22:45:45 +0200292 driver->shutdown(client);
David Brownellf37dd802007-02-13 22:09:00 +0100293}
294
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200295#ifdef CONFIG_PM_SLEEP
296static int i2c_legacy_suspend(struct device *dev, pm_message_t mesg)
David Brownellf37dd802007-02-13 22:09:00 +0100297{
Jean Delvare51298d12009-09-18 22:45:45 +0200298 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100299 struct i2c_driver *driver;
300
Jean Delvare51298d12009-09-18 22:45:45 +0200301 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100302 return 0;
303 driver = to_i2c_driver(dev->driver);
304 if (!driver->suspend)
305 return 0;
Jean Delvare51298d12009-09-18 22:45:45 +0200306 return driver->suspend(client, mesg);
David Brownellf37dd802007-02-13 22:09:00 +0100307}
308
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200309static int i2c_legacy_resume(struct device *dev)
David Brownellf37dd802007-02-13 22:09:00 +0100310{
Jean Delvare51298d12009-09-18 22:45:45 +0200311 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100312 struct i2c_driver *driver;
313
Jean Delvare51298d12009-09-18 22:45:45 +0200314 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100315 return 0;
316 driver = to_i2c_driver(dev->driver);
317 if (!driver->resume)
318 return 0;
Jean Delvare51298d12009-09-18 22:45:45 +0200319 return driver->resume(client);
David Brownellf37dd802007-02-13 22:09:00 +0100320}
321
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200322static int i2c_device_pm_suspend(struct device *dev)
323{
324 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
325
Mark Brownd529de22011-01-14 22:03:49 +0100326 if (pm)
327 return pm_generic_suspend(dev);
328 else
329 return i2c_legacy_suspend(dev, PMSG_SUSPEND);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200330}
331
332static int i2c_device_pm_resume(struct device *dev)
333{
334 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200335
336 if (pm)
Mark Brownd529de22011-01-14 22:03:49 +0100337 return pm_generic_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200338 else
Mark Brownd529de22011-01-14 22:03:49 +0100339 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200340}
341
342static int i2c_device_pm_freeze(struct device *dev)
343{
344 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
345
Mark Brownd529de22011-01-14 22:03:49 +0100346 if (pm)
347 return pm_generic_freeze(dev);
348 else
349 return i2c_legacy_suspend(dev, PMSG_FREEZE);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200350}
351
352static int i2c_device_pm_thaw(struct device *dev)
353{
354 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
355
Mark Brownd529de22011-01-14 22:03:49 +0100356 if (pm)
357 return pm_generic_thaw(dev);
358 else
359 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200360}
361
362static int i2c_device_pm_poweroff(struct device *dev)
363{
364 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
365
Mark Brownd529de22011-01-14 22:03:49 +0100366 if (pm)
367 return pm_generic_poweroff(dev);
368 else
369 return i2c_legacy_suspend(dev, PMSG_HIBERNATE);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200370}
371
372static int i2c_device_pm_restore(struct device *dev)
373{
374 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200375
376 if (pm)
Mark Brownd529de22011-01-14 22:03:49 +0100377 return pm_generic_restore(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200378 else
Mark Brownd529de22011-01-14 22:03:49 +0100379 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200380}
381#else /* !CONFIG_PM_SLEEP */
382#define i2c_device_pm_suspend NULL
383#define i2c_device_pm_resume NULL
384#define i2c_device_pm_freeze NULL
385#define i2c_device_pm_thaw NULL
386#define i2c_device_pm_poweroff NULL
387#define i2c_device_pm_restore NULL
388#endif /* !CONFIG_PM_SLEEP */
389
David Brownell9c1600e2007-05-01 23:26:31 +0200390static void i2c_client_dev_release(struct device *dev)
391{
392 kfree(to_i2c_client(dev));
393}
394
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100395static ssize_t
Jean Delvare4f8cf822009-09-18 22:45:46 +0200396show_name(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200397{
Jean Delvare4f8cf822009-09-18 22:45:46 +0200398 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
399 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200400}
401
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100402static ssize_t
403show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200404{
405 struct i2c_client *client = to_i2c_client(dev);
Jean Delvareeb8a7902008-05-18 20:49:41 +0200406 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200407}
408
Jean Delvare4f8cf822009-09-18 22:45:46 +0200409static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
Jean Delvare51298d12009-09-18 22:45:45 +0200410static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
411
412static struct attribute *i2c_dev_attrs[] = {
413 &dev_attr_name.attr,
David Brownell7b4fbc52007-05-01 23:26:30 +0200414 /* modalias helps coldplug: modprobe $(cat .../modalias) */
Jean Delvare51298d12009-09-18 22:45:45 +0200415 &dev_attr_modalias.attr,
416 NULL
417};
418
419static struct attribute_group i2c_dev_attr_group = {
420 .attrs = i2c_dev_attrs,
421};
422
423static const struct attribute_group *i2c_dev_attr_groups[] = {
424 &i2c_dev_attr_group,
425 NULL
David Brownell7b4fbc52007-05-01 23:26:30 +0200426};
427
Tobias Klauser0b2c3682010-01-16 20:43:12 +0100428static const struct dev_pm_ops i2c_device_pm_ops = {
sonic zhang54067ee2009-12-14 21:17:30 +0100429 .suspend = i2c_device_pm_suspend,
430 .resume = i2c_device_pm_resume,
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200431 .freeze = i2c_device_pm_freeze,
432 .thaw = i2c_device_pm_thaw,
433 .poweroff = i2c_device_pm_poweroff,
434 .restore = i2c_device_pm_restore,
435 SET_RUNTIME_PM_OPS(
436 pm_generic_runtime_suspend,
437 pm_generic_runtime_resume,
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +0200438 NULL
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200439 )
sonic zhang54067ee2009-12-14 21:17:30 +0100440};
441
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200442struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100443 .name = "i2c",
444 .match = i2c_device_match,
445 .probe = i2c_device_probe,
446 .remove = i2c_device_remove,
447 .shutdown = i2c_device_shutdown,
sonic zhang54067ee2009-12-14 21:17:30 +0100448 .pm = &i2c_device_pm_ops,
Russell Kingb864c7d2006-01-05 14:37:50 +0000449};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200450EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000451
Jean Delvare51298d12009-09-18 22:45:45 +0200452static struct device_type i2c_client_type = {
453 .groups = i2c_dev_attr_groups,
454 .uevent = i2c_device_uevent,
455 .release = i2c_client_dev_release,
456};
457
David Brownell9b766b82008-01-27 18:14:51 +0100458
459/**
460 * i2c_verify_client - return parameter as i2c_client, or NULL
461 * @dev: device, probably from some driver model iterator
462 *
463 * When traversing the driver model tree, perhaps using driver model
464 * iterators like @device_for_each_child(), you can't assume very much
465 * about the nodes you find. Use this function to avoid oopses caused
466 * by wrongly treating some non-I2C device as an i2c_client.
467 */
468struct i2c_client *i2c_verify_client(struct device *dev)
469{
Jean Delvare51298d12009-09-18 22:45:45 +0200470 return (dev->type == &i2c_client_type)
David Brownell9b766b82008-01-27 18:14:51 +0100471 ? to_i2c_client(dev)
472 : NULL;
473}
474EXPORT_SYMBOL(i2c_verify_client);
475
476
Jean Delvare3a89db52010-06-03 11:33:52 +0200477/* This is a permissive address validity check, I2C address map constraints
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300478 * are purposely not enforced, except for the general call address. */
Jean Delvare3a89db52010-06-03 11:33:52 +0200479static int i2c_check_client_addr_validity(const struct i2c_client *client)
480{
481 if (client->flags & I2C_CLIENT_TEN) {
482 /* 10-bit address, all values are valid */
483 if (client->addr > 0x3ff)
484 return -EINVAL;
485 } else {
486 /* 7-bit address, reject the general call address */
487 if (client->addr == 0x00 || client->addr > 0x7f)
488 return -EINVAL;
489 }
490 return 0;
491}
492
Jean Delvare656b8762010-06-03 11:33:53 +0200493/* And this is a strict address validity check, used when probing. If a
494 * device uses a reserved address, then it shouldn't be probed. 7-bit
495 * addressing is assumed, 10-bit address devices are rare and should be
496 * explicitly enumerated. */
497static int i2c_check_addr_validity(unsigned short addr)
498{
499 /*
500 * Reserved addresses per I2C specification:
501 * 0x00 General call address / START byte
502 * 0x01 CBUS address
503 * 0x02 Reserved for different bus format
504 * 0x03 Reserved for future purposes
505 * 0x04-0x07 Hs-mode master code
506 * 0x78-0x7b 10-bit slave addressing
507 * 0x7c-0x7f Reserved for future purposes
508 */
509 if (addr < 0x08 || addr > 0x77)
510 return -EINVAL;
511 return 0;
512}
513
Jean Delvare3b5f7942010-06-03 11:33:55 +0200514static int __i2c_check_addr_busy(struct device *dev, void *addrp)
515{
516 struct i2c_client *client = i2c_verify_client(dev);
517 int addr = *(int *)addrp;
518
519 if (client && client->addr == addr)
520 return -EBUSY;
521 return 0;
522}
523
Michael Lawnick08263742010-08-11 18:21:02 +0200524/* walk up mux tree */
525static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
526{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200527 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200528 int result;
529
530 result = device_for_each_child(&adapter->dev, &addr,
531 __i2c_check_addr_busy);
532
Jean Delvare97cc4d42010-10-24 18:16:57 +0200533 if (!result && parent)
534 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200535
536 return result;
537}
538
539/* recurse down mux tree */
540static int i2c_check_mux_children(struct device *dev, void *addrp)
541{
542 int result;
543
544 if (dev->type == &i2c_adapter_type)
545 result = device_for_each_child(dev, addrp,
546 i2c_check_mux_children);
547 else
548 result = __i2c_check_addr_busy(dev, addrp);
549
550 return result;
551}
552
Jean Delvare3b5f7942010-06-03 11:33:55 +0200553static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
554{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200555 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200556 int result = 0;
557
Jean Delvare97cc4d42010-10-24 18:16:57 +0200558 if (parent)
559 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200560
561 if (!result)
562 result = device_for_each_child(&adapter->dev, &addr,
563 i2c_check_mux_children);
564
565 return result;
Jean Delvare3b5f7942010-06-03 11:33:55 +0200566}
567
David Brownell9c1600e2007-05-01 23:26:31 +0200568/**
Jean Delvarefe61e072010-08-11 18:20:58 +0200569 * i2c_lock_adapter - Get exclusive access to an I2C bus segment
570 * @adapter: Target I2C bus segment
571 */
572void i2c_lock_adapter(struct i2c_adapter *adapter)
573{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200574 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
575
576 if (parent)
577 i2c_lock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200578 else
579 rt_mutex_lock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200580}
581EXPORT_SYMBOL_GPL(i2c_lock_adapter);
582
583/**
584 * i2c_trylock_adapter - Try to get exclusive access to an I2C bus segment
585 * @adapter: Target I2C bus segment
586 */
587static int i2c_trylock_adapter(struct i2c_adapter *adapter)
588{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200589 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
590
591 if (parent)
592 return i2c_trylock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200593 else
594 return rt_mutex_trylock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200595}
596
597/**
598 * i2c_unlock_adapter - Release exclusive access to an I2C bus segment
599 * @adapter: Target I2C bus segment
600 */
601void i2c_unlock_adapter(struct i2c_adapter *adapter)
602{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200603 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
604
605 if (parent)
606 i2c_unlock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200607 else
608 rt_mutex_unlock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200609}
610EXPORT_SYMBOL_GPL(i2c_unlock_adapter);
611
612/**
Jean Delvaref8a227e2009-06-19 16:58:18 +0200613 * i2c_new_device - instantiate an i2c device
David Brownell9c1600e2007-05-01 23:26:31 +0200614 * @adap: the adapter managing the device
615 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200616 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200617 *
Jean Delvaref8a227e2009-06-19 16:58:18 +0200618 * Create an i2c device. Binding is handled through driver model
619 * probe()/remove() methods. A driver may be bound to this device when we
620 * return from this function, or any later moment (e.g. maybe hotplugging will
621 * load the driver module). This call is not appropriate for use by mainboard
622 * initialization logic, which usually runs during an arch_initcall() long
623 * before any i2c_adapter could exist.
David Brownell9c1600e2007-05-01 23:26:31 +0200624 *
625 * This returns the new i2c client, which may be saved for later use with
626 * i2c_unregister_device(); or NULL to indicate an error.
627 */
628struct i2c_client *
629i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
630{
631 struct i2c_client *client;
632 int status;
633
634 client = kzalloc(sizeof *client, GFP_KERNEL);
635 if (!client)
636 return NULL;
637
638 client->adapter = adap;
639
640 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200641
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200642 if (info->archdata)
643 client->dev.archdata = *info->archdata;
644
Marc Pignatee354252008-08-28 08:33:22 +0200645 client->flags = info->flags;
David Brownell9c1600e2007-05-01 23:26:31 +0200646 client->addr = info->addr;
647 client->irq = info->irq;
648
David Brownell9c1600e2007-05-01 23:26:31 +0200649 strlcpy(client->name, info->type, sizeof(client->name));
650
Jean Delvare3a89db52010-06-03 11:33:52 +0200651 /* Check for address validity */
652 status = i2c_check_client_addr_validity(client);
653 if (status) {
654 dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
655 client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
656 goto out_err_silent;
657 }
658
Jean Delvaref8a227e2009-06-19 16:58:18 +0200659 /* Check for address business */
Jean Delvare3b5f7942010-06-03 11:33:55 +0200660 status = i2c_check_addr_busy(adap, client->addr);
Jean Delvaref8a227e2009-06-19 16:58:18 +0200661 if (status)
662 goto out_err;
663
664 client->dev.parent = &client->adapter->dev;
665 client->dev.bus = &i2c_bus_type;
Jean Delvare51298d12009-09-18 22:45:45 +0200666 client->dev.type = &i2c_client_type;
Grant Likelyd12d42f2010-04-13 16:12:28 -0700667 client->dev.of_node = info->of_node;
Mika Westerberg907ddf82012-11-23 12:23:40 +0100668 ACPI_HANDLE_SET(&client->dev, info->acpi_node.handle);
Jean Delvaref8a227e2009-06-19 16:58:18 +0200669
Jean Delvarecbb44512011-11-23 11:33:07 +0100670 /* For 10-bit clients, add an arbitrary offset to avoid collisions */
Jean Delvaref8a227e2009-06-19 16:58:18 +0200671 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
Jean Delvarecbb44512011-11-23 11:33:07 +0100672 client->addr | ((client->flags & I2C_CLIENT_TEN)
673 ? 0xa000 : 0));
Jean Delvaref8a227e2009-06-19 16:58:18 +0200674 status = device_register(&client->dev);
675 if (status)
676 goto out_err;
677
Jean Delvaref8a227e2009-06-19 16:58:18 +0200678 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
679 client->name, dev_name(&client->dev));
680
David Brownell9c1600e2007-05-01 23:26:31 +0200681 return client;
Jean Delvaref8a227e2009-06-19 16:58:18 +0200682
683out_err:
684 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
685 "(%d)\n", client->name, client->addr, status);
Jean Delvare3a89db52010-06-03 11:33:52 +0200686out_err_silent:
Jean Delvaref8a227e2009-06-19 16:58:18 +0200687 kfree(client);
688 return NULL;
David Brownell9c1600e2007-05-01 23:26:31 +0200689}
690EXPORT_SYMBOL_GPL(i2c_new_device);
691
692
693/**
694 * i2c_unregister_device - reverse effect of i2c_new_device()
695 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200696 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200697 */
698void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200699{
David Brownella1d9e6e2007-05-01 23:26:30 +0200700 device_unregister(&client->dev);
701}
David Brownell9c1600e2007-05-01 23:26:31 +0200702EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200703
704
Jean Delvare60b129d2008-05-11 20:37:06 +0200705static const struct i2c_device_id dummy_id[] = {
706 { "dummy", 0 },
707 { },
708};
709
Jean Delvared2653e92008-04-29 23:11:39 +0200710static int dummy_probe(struct i2c_client *client,
711 const struct i2c_device_id *id)
712{
713 return 0;
714}
715
716static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100717{
718 return 0;
719}
720
721static struct i2c_driver dummy_driver = {
722 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200723 .probe = dummy_probe,
724 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200725 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100726};
727
728/**
729 * i2c_new_dummy - return a new i2c device bound to a dummy driver
730 * @adapter: the adapter managing the device
731 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100732 * Context: can sleep
733 *
734 * This returns an I2C client bound to the "dummy" driver, intended for use
735 * with devices that consume multiple addresses. Examples of such chips
736 * include various EEPROMS (like 24c04 and 24c08 models).
737 *
738 * These dummy devices have two main uses. First, most I2C and SMBus calls
739 * except i2c_transfer() need a client handle; the dummy will be that handle.
740 * And second, this prevents the specified address from being bound to a
741 * different driver.
742 *
743 * This returns the new i2c client, which should be saved for later use with
744 * i2c_unregister_device(); or NULL to indicate an error.
745 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100746struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100747{
748 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200749 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100750 };
751
David Brownelle9f13732008-01-27 18:14:52 +0100752 return i2c_new_device(adapter, &info);
753}
754EXPORT_SYMBOL_GPL(i2c_new_dummy);
755
David Brownellf37dd802007-02-13 22:09:00 +0100756/* ------------------------------------------------------------------------- */
757
David Brownell16ffadf2007-05-01 23:26:28 +0200758/* I2C bus adapters -- one roots each I2C or SMBUS segment */
759
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200760static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
David Brownellef2c83212007-05-01 23:26:28 +0200762 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 complete(&adap->dev_released);
764}
765
Jean Delvare99cd8e22009-06-19 16:58:20 +0200766/*
Jean Delvare390946b2012-09-10 10:14:02 +0200767 * This function is only needed for mutex_lock_nested, so it is never
768 * called unless locking correctness checking is enabled. Thus we
769 * make it inline to avoid a compiler warning. That's what gcc ends up
770 * doing anyway.
771 */
772static inline unsigned int i2c_adapter_depth(struct i2c_adapter *adapter)
773{
774 unsigned int depth = 0;
775
776 while ((adapter = i2c_parent_is_i2c_adapter(adapter)))
777 depth++;
778
779 return depth;
780}
781
782/*
Jean Delvare99cd8e22009-06-19 16:58:20 +0200783 * Let users instantiate I2C devices through sysfs. This can be used when
784 * platform initialization code doesn't contain the proper data for
785 * whatever reason. Also useful for drivers that do device detection and
786 * detection fails, either because the device uses an unexpected address,
787 * or this is a compatible device with different ID register values.
788 *
789 * Parameter checking may look overzealous, but we really don't want
790 * the user to provide incorrect parameters.
791 */
792static ssize_t
793i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
794 const char *buf, size_t count)
795{
796 struct i2c_adapter *adap = to_i2c_adapter(dev);
797 struct i2c_board_info info;
798 struct i2c_client *client;
799 char *blank, end;
800 int res;
801
Jean Delvare99cd8e22009-06-19 16:58:20 +0200802 memset(&info, 0, sizeof(struct i2c_board_info));
803
804 blank = strchr(buf, ' ');
805 if (!blank) {
806 dev_err(dev, "%s: Missing parameters\n", "new_device");
807 return -EINVAL;
808 }
809 if (blank - buf > I2C_NAME_SIZE - 1) {
810 dev_err(dev, "%s: Invalid device name\n", "new_device");
811 return -EINVAL;
812 }
813 memcpy(info.type, buf, blank - buf);
814
815 /* Parse remaining parameters, reject extra parameters */
816 res = sscanf(++blank, "%hi%c", &info.addr, &end);
817 if (res < 1) {
818 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
819 return -EINVAL;
820 }
821 if (res > 1 && end != '\n') {
822 dev_err(dev, "%s: Extra parameters\n", "new_device");
823 return -EINVAL;
824 }
825
Jean Delvare99cd8e22009-06-19 16:58:20 +0200826 client = i2c_new_device(adap, &info);
827 if (!client)
Jean Delvare3a89db52010-06-03 11:33:52 +0200828 return -EINVAL;
Jean Delvare99cd8e22009-06-19 16:58:20 +0200829
830 /* Keep track of the added device */
Jean Delvaredafc50d2010-08-11 18:21:01 +0200831 mutex_lock(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +0200832 list_add_tail(&client->detected, &adap->userspace_clients);
Jean Delvaredafc50d2010-08-11 18:21:01 +0200833 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +0200834 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
835 info.type, info.addr);
836
837 return count;
838}
839
840/*
841 * And of course let the users delete the devices they instantiated, if
842 * they got it wrong. This interface can only be used to delete devices
843 * instantiated by i2c_sysfs_new_device above. This guarantees that we
844 * don't delete devices to which some kernel code still has references.
845 *
846 * Parameter checking may look overzealous, but we really don't want
847 * the user to delete the wrong device.
848 */
849static ssize_t
850i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
851 const char *buf, size_t count)
852{
853 struct i2c_adapter *adap = to_i2c_adapter(dev);
854 struct i2c_client *client, *next;
855 unsigned short addr;
856 char end;
857 int res;
858
859 /* Parse parameters, reject extra parameters */
860 res = sscanf(buf, "%hi%c", &addr, &end);
861 if (res < 1) {
862 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
863 return -EINVAL;
864 }
865 if (res > 1 && end != '\n') {
866 dev_err(dev, "%s: Extra parameters\n", "delete_device");
867 return -EINVAL;
868 }
869
870 /* Make sure the device was added through sysfs */
871 res = -ENOENT;
Jean Delvare390946b2012-09-10 10:14:02 +0200872 mutex_lock_nested(&adap->userspace_clients_lock,
873 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +0200874 list_for_each_entry_safe(client, next, &adap->userspace_clients,
875 detected) {
876 if (client->addr == addr) {
Jean Delvare99cd8e22009-06-19 16:58:20 +0200877 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
878 "delete_device", client->name, client->addr);
879
880 list_del(&client->detected);
881 i2c_unregister_device(client);
882 res = count;
883 break;
884 }
885 }
Jean Delvaredafc50d2010-08-11 18:21:01 +0200886 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +0200887
888 if (res < 0)
889 dev_err(dev, "%s: Can't find device in list\n",
890 "delete_device");
891 return res;
892}
893
Jean Delvare4f8cf822009-09-18 22:45:46 +0200894static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
Alexander Sverdline9b526f2013-05-17 14:56:35 +0200895static DEVICE_ATTR_IGNORE_LOCKDEP(delete_device, S_IWUSR, NULL,
896 i2c_sysfs_delete_device);
Jean Delvare4f8cf822009-09-18 22:45:46 +0200897
898static struct attribute *i2c_adapter_attrs[] = {
899 &dev_attr_name.attr,
900 &dev_attr_new_device.attr,
901 &dev_attr_delete_device.attr,
902 NULL
David Brownell16ffadf2007-05-01 23:26:28 +0200903};
904
Jean Delvare4f8cf822009-09-18 22:45:46 +0200905static struct attribute_group i2c_adapter_attr_group = {
906 .attrs = i2c_adapter_attrs,
907};
908
909static const struct attribute_group *i2c_adapter_attr_groups[] = {
910 &i2c_adapter_attr_group,
911 NULL
912};
913
Michael Lawnick08263742010-08-11 18:21:02 +0200914struct device_type i2c_adapter_type = {
Jean Delvare4f8cf822009-09-18 22:45:46 +0200915 .groups = i2c_adapter_attr_groups,
916 .release = i2c_adapter_dev_release,
David Brownell16ffadf2007-05-01 23:26:28 +0200917};
Michael Lawnick08263742010-08-11 18:21:02 +0200918EXPORT_SYMBOL_GPL(i2c_adapter_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Stephen Warren643dd092012-04-17 12:43:33 -0600920/**
921 * i2c_verify_adapter - return parameter as i2c_adapter or NULL
922 * @dev: device, probably from some driver model iterator
923 *
924 * When traversing the driver model tree, perhaps using driver model
925 * iterators like @device_for_each_child(), you can't assume very much
926 * about the nodes you find. Use this function to avoid oopses caused
927 * by wrongly treating some non-I2C device as an i2c_adapter.
928 */
929struct i2c_adapter *i2c_verify_adapter(struct device *dev)
930{
931 return (dev->type == &i2c_adapter_type)
932 ? to_i2c_adapter(dev)
933 : NULL;
934}
935EXPORT_SYMBOL(i2c_verify_adapter);
936
Jean Delvare2bb50952009-09-18 22:45:46 +0200937#ifdef CONFIG_I2C_COMPAT
938static struct class_compat *i2c_adapter_compat_class;
939#endif
940
David Brownell9c1600e2007-05-01 23:26:31 +0200941static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
942{
943 struct i2c_devinfo *devinfo;
944
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +0200945 down_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +0200946 list_for_each_entry(devinfo, &__i2c_board_list, list) {
947 if (devinfo->busnum == adapter->nr
948 && !i2c_new_device(adapter,
949 &devinfo->board_info))
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100950 dev_err(&adapter->dev,
951 "Can't create device at 0x%02x\n",
David Brownell9c1600e2007-05-01 23:26:31 +0200952 devinfo->board_info.addr);
953 }
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +0200954 up_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +0200955}
956
Jean Delvare69b00892009-12-06 17:06:27 +0100957static int i2c_do_add_adapter(struct i2c_driver *driver,
958 struct i2c_adapter *adap)
Jean Delvare026526f2008-01-27 18:14:49 +0100959{
Jean Delvare4735c982008-07-14 22:38:36 +0200960 /* Detect supported devices on that bus, and instantiate them */
961 i2c_detect(adap, driver);
962
963 /* Let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +0100964 if (driver->attach_adapter) {
Jean Delvarea920ff42011-04-17 10:20:19 +0200965 dev_warn(&adap->dev, "%s: attach_adapter method is deprecated\n",
966 driver->driver.name);
Jean Delvarefe6fc252011-03-20 14:50:53 +0100967 dev_warn(&adap->dev, "Please use another way to instantiate "
968 "your i2c_client\n");
Jean Delvare026526f2008-01-27 18:14:49 +0100969 /* We ignore the return code; if it fails, too bad */
970 driver->attach_adapter(adap);
971 }
972 return 0;
973}
974
Jean Delvare69b00892009-12-06 17:06:27 +0100975static int __process_new_adapter(struct device_driver *d, void *data)
976{
977 return i2c_do_add_adapter(to_i2c_driver(d), data);
978}
979
David Brownell6e13e642007-05-01 23:26:31 +0200980static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981{
Jean Delvared6703282010-08-11 18:20:59 +0200982 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
David Brownell1d0b19c2008-10-14 17:30:05 +0200984 /* Can't register until after driver model init */
Jean Delvare35fc37f2009-06-19 16:58:19 +0200985 if (unlikely(WARN_ON(!i2c_bus_type.p))) {
986 res = -EAGAIN;
987 goto out_list;
988 }
David Brownell1d0b19c2008-10-14 17:30:05 +0200989
Jean Delvare2236baa2010-11-15 22:40:38 +0100990 /* Sanity checks */
991 if (unlikely(adap->name[0] == '\0')) {
992 pr_err("i2c-core: Attempt to register an adapter with "
993 "no name!\n");
994 return -EINVAL;
995 }
996 if (unlikely(!adap->algo)) {
997 pr_err("i2c-core: Attempt to register adapter '%s' with "
998 "no algo!\n", adap->name);
999 return -EINVAL;
1000 }
1001
Mika Kuoppala194684e2009-12-06 17:06:22 +01001002 rt_mutex_init(&adap->bus_lock);
Jean Delvaredafc50d2010-08-11 18:21:01 +02001003 mutex_init(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +02001004 INIT_LIST_HEAD(&adap->userspace_clients);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Jean Delvare8fcfef62009-03-28 21:34:43 +01001006 /* Set default timeout to 1 second if not already set */
1007 if (adap->timeout == 0)
1008 adap->timeout = HZ;
1009
Kay Sievers27d9c182009-01-07 14:29:16 +01001010 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001011 adap->dev.bus = &i2c_bus_type;
1012 adap->dev.type = &i2c_adapter_type;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001013 res = device_register(&adap->dev);
1014 if (res)
1015 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001017 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
1018
Jean Delvare2bb50952009-09-18 22:45:46 +02001019#ifdef CONFIG_I2C_COMPAT
1020 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
1021 adap->dev.parent);
1022 if (res)
1023 dev_warn(&adap->dev,
1024 "Failed to create compatibility class link\n");
1025#endif
1026
Viresh Kumar5f9296b2012-02-28 18:26:31 +05301027 /* bus recovery specific initialization */
1028 if (adap->bus_recovery_info) {
1029 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
1030
1031 if (!bri->recover_bus) {
1032 dev_err(&adap->dev, "No recover_bus() found, not using recovery\n");
1033 adap->bus_recovery_info = NULL;
1034 goto exit_recovery;
1035 }
1036
1037 /* Generic GPIO recovery */
1038 if (bri->recover_bus == i2c_generic_gpio_recovery) {
1039 if (!gpio_is_valid(bri->scl_gpio)) {
1040 dev_err(&adap->dev, "Invalid SCL gpio, not using recovery\n");
1041 adap->bus_recovery_info = NULL;
1042 goto exit_recovery;
1043 }
1044
1045 if (gpio_is_valid(bri->sda_gpio))
1046 bri->get_sda = get_sda_gpio_value;
1047 else
1048 bri->get_sda = NULL;
1049
1050 bri->get_scl = get_scl_gpio_value;
1051 bri->set_scl = set_scl_gpio_value;
1052 } else if (!bri->set_scl || !bri->get_scl) {
1053 /* Generic SCL recovery */
1054 dev_err(&adap->dev, "No {get|set}_gpio() found, not using recovery\n");
1055 adap->bus_recovery_info = NULL;
1056 }
1057 }
1058
1059exit_recovery:
Jean Delvare729d6dd2009-06-19 16:58:18 +02001060 /* create pre-declared device nodes */
David Brownell6e13e642007-05-01 23:26:31 +02001061 if (adap->nr < __i2c_first_dynamic_bus_num)
1062 i2c_scan_static_board_info(adap);
1063
Jean Delvare4735c982008-07-14 22:38:36 +02001064 /* Notify drivers */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001065 mutex_lock(&core_lock);
Jean Delvared6703282010-08-11 18:20:59 +02001066 bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
Jean Delvarecaada322008-01-27 18:14:49 +01001067 mutex_unlock(&core_lock);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001068
1069 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001070
Jean Delvareb119c6c2006-08-15 18:26:30 +02001071out_list:
Jean Delvare35fc37f2009-06-19 16:58:19 +02001072 mutex_lock(&core_lock);
Jean Delvareb119c6c2006-08-15 18:26:30 +02001073 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001074 mutex_unlock(&core_lock);
1075 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076}
1077
David Brownell6e13e642007-05-01 23:26:31 +02001078/**
Doug Andersonee5c2742013-03-01 08:57:31 -08001079 * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1
1080 * @adap: the adapter to register (with adap->nr initialized)
1081 * Context: can sleep
1082 *
1083 * See i2c_add_numbered_adapter() for details.
1084 */
1085static int __i2c_add_numbered_adapter(struct i2c_adapter *adap)
1086{
1087 int id;
1088
1089 mutex_lock(&core_lock);
1090 id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1,
1091 GFP_KERNEL);
1092 mutex_unlock(&core_lock);
1093 if (id < 0)
1094 return id == -ENOSPC ? -EBUSY : id;
1095
1096 return i2c_register_adapter(adap);
1097}
1098
1099/**
David Brownell6e13e642007-05-01 23:26:31 +02001100 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
1101 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +02001102 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001103 *
1104 * This routine is used to declare an I2C adapter when its bus number
Doug Andersonee5c2742013-03-01 08:57:31 -08001105 * doesn't matter or when its bus number is specified by an dt alias.
1106 * Examples of bases when the bus number doesn't matter: I2C adapters
1107 * dynamically added by USB links or PCI plugin cards.
David Brownell6e13e642007-05-01 23:26:31 +02001108 *
1109 * When this returns zero, a new bus number was allocated and stored
1110 * in adap->nr, and the specified adapter became available for clients.
1111 * Otherwise, a negative errno value is returned.
1112 */
1113int i2c_add_adapter(struct i2c_adapter *adapter)
1114{
Doug Andersonee5c2742013-03-01 08:57:31 -08001115 struct device *dev = &adapter->dev;
Tejun Heo4ae42b02013-02-27 17:04:15 -08001116 int id;
David Brownell6e13e642007-05-01 23:26:31 +02001117
Doug Andersonee5c2742013-03-01 08:57:31 -08001118 if (dev->of_node) {
1119 id = of_alias_get_id(dev->of_node, "i2c");
1120 if (id >= 0) {
1121 adapter->nr = id;
1122 return __i2c_add_numbered_adapter(adapter);
1123 }
1124 }
1125
Jean Delvarecaada322008-01-27 18:14:49 +01001126 mutex_lock(&core_lock);
Tejun Heo4ae42b02013-02-27 17:04:15 -08001127 id = idr_alloc(&i2c_adapter_idr, adapter,
1128 __i2c_first_dynamic_bus_num, 0, GFP_KERNEL);
Jean Delvarecaada322008-01-27 18:14:49 +01001129 mutex_unlock(&core_lock);
Tejun Heo4ae42b02013-02-27 17:04:15 -08001130 if (id < 0)
1131 return id;
David Brownell6e13e642007-05-01 23:26:31 +02001132
1133 adapter->nr = id;
Tejun Heo4ae42b02013-02-27 17:04:15 -08001134
David Brownell6e13e642007-05-01 23:26:31 +02001135 return i2c_register_adapter(adapter);
1136}
1137EXPORT_SYMBOL(i2c_add_adapter);
1138
1139/**
1140 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
1141 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +02001142 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001143 *
1144 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +01001145 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
1146 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +02001147 * is used to properly configure I2C devices.
1148 *
Grant Likely488bf312011-07-25 17:49:43 +02001149 * If the requested bus number is set to -1, then this function will behave
1150 * identically to i2c_add_adapter, and will dynamically assign a bus number.
1151 *
David Brownell6e13e642007-05-01 23:26:31 +02001152 * If no devices have pre-been declared for this bus, then be sure to
1153 * register the adapter before any dynamically allocated ones. Otherwise
1154 * the required bus ID may not be available.
1155 *
1156 * When this returns zero, the specified adapter became available for
1157 * clients using the bus number provided in adap->nr. Also, the table
1158 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
1159 * and the appropriate driver model device nodes are created. Otherwise, a
1160 * negative errno value is returned.
1161 */
1162int i2c_add_numbered_adapter(struct i2c_adapter *adap)
1163{
Grant Likely488bf312011-07-25 17:49:43 +02001164 if (adap->nr == -1) /* -1 means dynamically assign bus id */
1165 return i2c_add_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001166
Doug Andersonee5c2742013-03-01 08:57:31 -08001167 return __i2c_add_numbered_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001168}
1169EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
1170
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001171static void i2c_do_del_adapter(struct i2c_driver *driver,
Jean Delvare69b00892009-12-06 17:06:27 +01001172 struct i2c_adapter *adapter)
Jean Delvare026526f2008-01-27 18:14:49 +01001173{
Jean Delvare4735c982008-07-14 22:38:36 +02001174 struct i2c_client *client, *_n;
Jean Delvare026526f2008-01-27 18:14:49 +01001175
Jean Delvareacec2112009-03-28 21:34:40 +01001176 /* Remove the devices we created ourselves as the result of hardware
1177 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +02001178 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
1179 if (client->adapter == adapter) {
1180 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
1181 client->name, client->addr);
1182 list_del(&client->detected);
1183 i2c_unregister_device(client);
1184 }
1185 }
Jean Delvare026526f2008-01-27 18:14:49 +01001186}
1187
Jean Delvaree549c2b2009-06-19 16:58:19 +02001188static int __unregister_client(struct device *dev, void *dummy)
1189{
1190 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvare5219bf82011-01-14 22:03:49 +01001191 if (client && strcmp(client->name, "dummy"))
1192 i2c_unregister_device(client);
1193 return 0;
1194}
1195
1196static int __unregister_dummy(struct device *dev, void *dummy)
1197{
1198 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvaree549c2b2009-06-19 16:58:19 +02001199 if (client)
1200 i2c_unregister_device(client);
1201 return 0;
1202}
1203
Jean Delvare69b00892009-12-06 17:06:27 +01001204static int __process_removed_adapter(struct device_driver *d, void *data)
1205{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001206 i2c_do_del_adapter(to_i2c_driver(d), data);
1207 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001208}
1209
David Brownelld64f73b2007-07-12 14:12:28 +02001210/**
1211 * i2c_del_adapter - unregister I2C adapter
1212 * @adap: the adapter being unregistered
1213 * Context: can sleep
1214 *
1215 * This unregisters an I2C adapter which was previously registered
1216 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1217 */
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001218void i2c_del_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219{
Jean Delvare35fc37f2009-06-19 16:58:19 +02001220 struct i2c_adapter *found;
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001221 struct i2c_client *client, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222
1223 /* First make sure that this adapter was ever added */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001224 mutex_lock(&core_lock);
1225 found = idr_find(&i2c_adapter_idr, adap->nr);
1226 mutex_unlock(&core_lock);
1227 if (found != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001228 pr_debug("i2c-core: attempting to delete unregistered "
1229 "adapter [%s]\n", adap->name);
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001230 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 }
1232
Jean Delvare026526f2008-01-27 18:14:49 +01001233 /* Tell drivers about this removal */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001234 mutex_lock(&core_lock);
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001235 bus_for_each_drv(&i2c_bus_type, NULL, adap,
Jean Delvare69b00892009-12-06 17:06:27 +01001236 __process_removed_adapter);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001237 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001239 /* Remove devices instantiated from sysfs */
Jean Delvare390946b2012-09-10 10:14:02 +02001240 mutex_lock_nested(&adap->userspace_clients_lock,
1241 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +02001242 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1243 detected) {
1244 dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
1245 client->addr);
1246 list_del(&client->detected);
1247 i2c_unregister_device(client);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001248 }
Jean Delvaredafc50d2010-08-11 18:21:01 +02001249 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001250
Jean Delvaree549c2b2009-06-19 16:58:19 +02001251 /* Detach any active clients. This can't fail, thus we do not
Jean Delvare5219bf82011-01-14 22:03:49 +01001252 * check the returned value. This is a two-pass process, because
1253 * we can't remove the dummy devices during the first pass: they
1254 * could have been instantiated by real devices wishing to clean
1255 * them up properly, so we give them a chance to do that first. */
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001256 device_for_each_child(&adap->dev, NULL, __unregister_client);
1257 device_for_each_child(&adap->dev, NULL, __unregister_dummy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
Jean Delvare2bb50952009-09-18 22:45:46 +02001259#ifdef CONFIG_I2C_COMPAT
1260 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
1261 adap->dev.parent);
1262#endif
1263
Thadeu Lima de Souza Cascardoc5567522010-01-16 20:43:13 +01001264 /* device name is gone after device_unregister */
1265 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
1266
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 /* clean up the sysfs representation */
1268 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
1271 /* wait for sysfs to drop all references */
1272 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
David Brownell6e13e642007-05-01 23:26:31 +02001274 /* free bus id */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001275 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001277 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
Jean Delvarebd4bc3db2008-07-16 19:30:05 +02001279 /* Clear the device structure in case this adapter is ever going to be
1280 added again */
1281 memset(&adap->dev, 0, sizeof(adap->dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282}
David Brownellc0564602007-05-01 23:26:31 +02001283EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
1285
David Brownell7b4fbc52007-05-01 23:26:30 +02001286/* ------------------------------------------------------------------------- */
1287
Jean Delvare7ae31482011-03-20 14:50:52 +01001288int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *))
1289{
1290 int res;
1291
1292 mutex_lock(&core_lock);
1293 res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn);
1294 mutex_unlock(&core_lock);
1295
1296 return res;
1297}
1298EXPORT_SYMBOL_GPL(i2c_for_each_dev);
1299
Jean Delvare69b00892009-12-06 17:06:27 +01001300static int __process_new_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001301{
Jean Delvare4f8cf822009-09-18 22:45:46 +02001302 if (dev->type != &i2c_adapter_type)
1303 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001304 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
Dave Young7f101a92008-07-14 22:38:19 +02001305}
1306
David Brownell7b4fbc52007-05-01 23:26:30 +02001307/*
1308 * An i2c_driver is used with one or more i2c_client (device) nodes to access
Jean Delvare729d6dd2009-06-19 16:58:18 +02001309 * i2c slave chips, on a bus instance associated with some i2c_adapter.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 */
1311
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001312int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313{
Jean Delvare7eebcb72006-02-05 23:28:21 +01001314 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315
David Brownell1d0b19c2008-10-14 17:30:05 +02001316 /* Can't register until after driver model init */
1317 if (unlikely(WARN_ON(!i2c_bus_type.p)))
1318 return -EAGAIN;
1319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001321 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Jean Delvare729d6dd2009-06-19 16:58:18 +02001324 /* When registration returns, the driver core
David Brownell6e13e642007-05-01 23:26:31 +02001325 * will have called probe() for all matching-but-unbound devices.
1326 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 res = driver_register(&driver->driver);
1328 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +01001329 return res;
David Brownell438d6c22006-12-10 21:21:31 +01001330
Mark Brownf4e8db32011-01-14 22:03:50 +01001331 /* Drivers should switch to dev_pm_ops instead. */
1332 if (driver->suspend)
1333 pr_warn("i2c-core: driver [%s] using legacy suspend method\n",
1334 driver->driver.name);
1335 if (driver->resume)
1336 pr_warn("i2c-core: driver [%s] using legacy resume method\n",
1337 driver->driver.name);
1338
Laurent Riffard35d8b2e2005-11-26 20:34:05 +01001339 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
Jean Delvare4735c982008-07-14 22:38:36 +02001341 INIT_LIST_HEAD(&driver->clients);
1342 /* Walk the adapters that are already present */
Jean Delvare7ae31482011-03-20 14:50:52 +01001343 i2c_for_each_dev(driver, __process_new_driver);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001344
Jean Delvare7eebcb72006-02-05 23:28:21 +01001345 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001347EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348
Jean Delvare69b00892009-12-06 17:06:27 +01001349static int __process_removed_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001350{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001351 if (dev->type == &i2c_adapter_type)
1352 i2c_do_del_adapter(data, to_i2c_adapter(dev));
1353 return 0;
Dave Young7f101a92008-07-14 22:38:19 +02001354}
1355
David Brownella1d9e6e2007-05-01 23:26:30 +02001356/**
1357 * i2c_del_driver - unregister I2C driver
1358 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +02001359 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +02001360 */
Jean Delvareb3e82092007-05-01 23:26:32 +02001361void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362{
Jean Delvare7ae31482011-03-20 14:50:52 +01001363 i2c_for_each_dev(driver, __process_removed_driver);
David Brownella1d9e6e2007-05-01 23:26:30 +02001364
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +01001366 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367}
David Brownellc0564602007-05-01 23:26:31 +02001368EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
David Brownell7b4fbc52007-05-01 23:26:30 +02001370/* ------------------------------------------------------------------------- */
1371
Jean Delvaree48d3312008-01-27 18:14:48 +01001372/**
1373 * i2c_use_client - increments the reference count of the i2c client structure
1374 * @client: the client being referenced
1375 *
1376 * Each live reference to a client should be refcounted. The driver model does
1377 * that automatically as part of driver binding, so that most drivers don't
1378 * need to do this explicitly: they hold a reference until they're unbound
1379 * from the device.
1380 *
1381 * A pointer to the client with the incremented reference counter is returned.
1382 */
1383struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384{
David Brownell6ea438e2008-07-14 22:38:24 +02001385 if (client && get_device(&client->dev))
1386 return client;
1387 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388}
David Brownellc0564602007-05-01 23:26:31 +02001389EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
Jean Delvaree48d3312008-01-27 18:14:48 +01001391/**
1392 * i2c_release_client - release a use of the i2c client structure
1393 * @client: the client being no longer referenced
1394 *
1395 * Must be called when a user of a client is finished with it.
1396 */
1397void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398{
David Brownell6ea438e2008-07-14 22:38:24 +02001399 if (client)
1400 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401}
David Brownellc0564602007-05-01 23:26:31 +02001402EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
David Brownell9b766b82008-01-27 18:14:51 +01001404struct i2c_cmd_arg {
1405 unsigned cmd;
1406 void *arg;
1407};
1408
1409static int i2c_cmd(struct device *dev, void *_arg)
1410{
1411 struct i2c_client *client = i2c_verify_client(dev);
1412 struct i2c_cmd_arg *arg = _arg;
1413
1414 if (client && client->driver && client->driver->command)
1415 client->driver->command(client, arg->cmd, arg->arg);
1416 return 0;
1417}
1418
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
1420{
David Brownell9b766b82008-01-27 18:14:51 +01001421 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
David Brownell9b766b82008-01-27 18:14:51 +01001423 cmd_arg.cmd = cmd;
1424 cmd_arg.arg = arg;
1425 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426}
David Brownellc0564602007-05-01 23:26:31 +02001427EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
1429static int __init i2c_init(void)
1430{
1431 int retval;
1432
1433 retval = bus_register(&i2c_bus_type);
1434 if (retval)
1435 return retval;
Jean Delvare2bb50952009-09-18 22:45:46 +02001436#ifdef CONFIG_I2C_COMPAT
1437 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
1438 if (!i2c_adapter_compat_class) {
1439 retval = -ENOMEM;
1440 goto bus_err;
1441 }
1442#endif
David Brownelle9f13732008-01-27 18:14:52 +01001443 retval = i2c_add_driver(&dummy_driver);
1444 if (retval)
Jean Delvare2bb50952009-09-18 22:45:46 +02001445 goto class_err;
David Brownelle9f13732008-01-27 18:14:52 +01001446 return 0;
1447
Jean Delvare2bb50952009-09-18 22:45:46 +02001448class_err:
1449#ifdef CONFIG_I2C_COMPAT
1450 class_compat_unregister(i2c_adapter_compat_class);
David Brownelle9f13732008-01-27 18:14:52 +01001451bus_err:
Jean Delvare2bb50952009-09-18 22:45:46 +02001452#endif
David Brownelle9f13732008-01-27 18:14:52 +01001453 bus_unregister(&i2c_bus_type);
1454 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455}
1456
1457static void __exit i2c_exit(void)
1458{
David Brownelle9f13732008-01-27 18:14:52 +01001459 i2c_del_driver(&dummy_driver);
Jean Delvare2bb50952009-09-18 22:45:46 +02001460#ifdef CONFIG_I2C_COMPAT
1461 class_compat_unregister(i2c_adapter_compat_class);
1462#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 bus_unregister(&i2c_bus_type);
1464}
1465
David Brownella10f9e72008-10-14 17:30:06 +02001466/* We must initialize early, because some subsystems register i2c drivers
1467 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1468 */
1469postcore_initcall(i2c_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470module_exit(i2c_exit);
1471
1472/* ----------------------------------------------------
1473 * the functional interface to the i2c busses.
1474 * ----------------------------------------------------
1475 */
1476
David Brownella1cdeda2008-07-14 22:38:24 +02001477/**
Jean Delvareb37d2a32012-06-29 07:47:19 -03001478 * __i2c_transfer - unlocked flavor of i2c_transfer
1479 * @adap: Handle to I2C bus
1480 * @msgs: One or more messages to execute before STOP is issued to
1481 * terminate the operation; each message begins with a START.
1482 * @num: Number of messages to be executed.
1483 *
1484 * Returns negative errno, else the number of messages executed.
1485 *
1486 * Adapter lock must be held when calling this function. No debug logging
1487 * takes place. adap->algo->master_xfer existence isn't checked.
1488 */
1489int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1490{
1491 unsigned long orig_jiffies;
1492 int ret, try;
1493
1494 /* Retry automatically on arbitration loss */
1495 orig_jiffies = jiffies;
1496 for (ret = 0, try = 0; try <= adap->retries; try++) {
1497 ret = adap->algo->master_xfer(adap, msgs, num);
1498 if (ret != -EAGAIN)
1499 break;
1500 if (time_after(jiffies, orig_jiffies + adap->timeout))
1501 break;
1502 }
1503
1504 return ret;
1505}
1506EXPORT_SYMBOL(__i2c_transfer);
1507
1508/**
David Brownella1cdeda2008-07-14 22:38:24 +02001509 * i2c_transfer - execute a single or combined I2C message
1510 * @adap: Handle to I2C bus
1511 * @msgs: One or more messages to execute before STOP is issued to
1512 * terminate the operation; each message begins with a START.
1513 * @num: Number of messages to be executed.
1514 *
1515 * Returns negative errno, else the number of messages executed.
1516 *
1517 * Note that there is no requirement that each message be sent to
1518 * the same slave address, although that is the most common model.
1519 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001520int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521{
Jean Delvareb37d2a32012-06-29 07:47:19 -03001522 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
David Brownella1cdeda2008-07-14 22:38:24 +02001524 /* REVISIT the fault reporting model here is weak:
1525 *
1526 * - When we get an error after receiving N bytes from a slave,
1527 * there is no way to report "N".
1528 *
1529 * - When we get a NAK after transmitting N bytes to a slave,
1530 * there is no way to report "N" ... or to let the master
1531 * continue executing the rest of this combined message, if
1532 * that's the appropriate response.
1533 *
1534 * - When for example "num" is two and we successfully complete
1535 * the first message but get an error part way through the
1536 * second, it's unclear whether that should be reported as
1537 * one (discarding status on the second message) or errno
1538 * (discarding status on the first one).
1539 */
1540
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 if (adap->algo->master_xfer) {
1542#ifdef DEBUG
1543 for (ret = 0; ret < num; ret++) {
1544 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +02001545 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1546 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1547 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 }
1549#endif
1550
Mike Rapoportcea443a82008-01-27 18:14:50 +01001551 if (in_atomic() || irqs_disabled()) {
Jean Delvarefe61e072010-08-11 18:20:58 +02001552 ret = i2c_trylock_adapter(adap);
Mike Rapoportcea443a82008-01-27 18:14:50 +01001553 if (!ret)
1554 /* I2C activity is ongoing. */
1555 return -EAGAIN;
1556 } else {
Jean Delvarefe61e072010-08-11 18:20:58 +02001557 i2c_lock_adapter(adap);
Mike Rapoportcea443a82008-01-27 18:14:50 +01001558 }
1559
Jean Delvareb37d2a32012-06-29 07:47:19 -03001560 ret = __i2c_transfer(adap, msgs, num);
Jean Delvarefe61e072010-08-11 18:20:58 +02001561 i2c_unlock_adapter(adap);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
1563 return ret;
1564 } else {
1565 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001566 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 }
1568}
David Brownellc0564602007-05-01 23:26:31 +02001569EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
David Brownella1cdeda2008-07-14 22:38:24 +02001571/**
1572 * i2c_master_send - issue a single I2C message in master transmit mode
1573 * @client: Handle to slave device
1574 * @buf: Data that will be written to the slave
Zhangfei Gao0c43ea52010-03-02 12:23:49 +01001575 * @count: How many bytes to write, must be less than 64k since msg.len is u16
David Brownella1cdeda2008-07-14 22:38:24 +02001576 *
1577 * Returns negative errno, or else the number of bytes written.
1578 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001579int i2c_master_send(const struct i2c_client *client, const char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580{
1581 int ret;
Farid Hammane7225acf2010-05-21 18:40:58 +02001582 struct i2c_adapter *adap = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 struct i2c_msg msg;
1584
Jean Delvare815f55f2005-05-07 22:58:46 +02001585 msg.addr = client->addr;
1586 msg.flags = client->flags & I2C_M_TEN;
1587 msg.len = count;
1588 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01001589
Jean Delvare815f55f2005-05-07 22:58:46 +02001590 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
Wolfram Sang834aa6f2012-03-15 18:11:05 +01001592 /*
1593 * If everything went ok (i.e. 1 msg transmitted), return #bytes
1594 * transmitted, else error code.
1595 */
Jean Delvare815f55f2005-05-07 22:58:46 +02001596 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597}
David Brownellc0564602007-05-01 23:26:31 +02001598EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
David Brownella1cdeda2008-07-14 22:38:24 +02001600/**
1601 * i2c_master_recv - issue a single I2C message in master receive mode
1602 * @client: Handle to slave device
1603 * @buf: Where to store data read from slave
Zhangfei Gao0c43ea52010-03-02 12:23:49 +01001604 * @count: How many bytes to read, must be less than 64k since msg.len is u16
David Brownella1cdeda2008-07-14 22:38:24 +02001605 *
1606 * Returns negative errno, or else the number of bytes read.
1607 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001608int i2c_master_recv(const struct i2c_client *client, char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609{
Farid Hammane7225acf2010-05-21 18:40:58 +02001610 struct i2c_adapter *adap = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 struct i2c_msg msg;
1612 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Jean Delvare815f55f2005-05-07 22:58:46 +02001614 msg.addr = client->addr;
1615 msg.flags = client->flags & I2C_M_TEN;
1616 msg.flags |= I2C_M_RD;
1617 msg.len = count;
1618 msg.buf = buf;
1619
1620 ret = i2c_transfer(adap, &msg, 1);
1621
Wolfram Sang834aa6f2012-03-15 18:11:05 +01001622 /*
1623 * If everything went ok (i.e. 1 msg received), return #bytes received,
1624 * else error code.
1625 */
Jean Delvare815f55f2005-05-07 22:58:46 +02001626 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627}
David Brownellc0564602007-05-01 23:26:31 +02001628EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630/* ----------------------------------------------------
1631 * the i2c address scanning function
1632 * Will not work for 10-bit addresses!
1633 * ----------------------------------------------------
1634 */
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001635
Jean Delvare63e4e802010-06-03 11:33:51 +02001636/*
1637 * Legacy default probe function, mostly relevant for SMBus. The default
1638 * probe method is a quick write, but it is known to corrupt the 24RF08
1639 * EEPROMs due to a state machine bug, and could also irreversibly
1640 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
1641 * we use a short byte read instead. Also, some bus drivers don't implement
1642 * quick write, so we fallback to a byte read in that case too.
1643 * On x86, there is another special case for FSC hardware monitoring chips,
1644 * which want regular byte reads (address 0x73.) Fortunately, these are the
1645 * only known chips using this I2C address on PC hardware.
1646 * Returns 1 if probe succeeded, 0 if not.
1647 */
1648static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
1649{
1650 int err;
1651 union i2c_smbus_data dummy;
1652
1653#ifdef CONFIG_X86
1654 if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
1655 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
1656 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1657 I2C_SMBUS_BYTE_DATA, &dummy);
1658 else
1659#endif
Jean Delvare8031d792010-08-11 18:21:00 +02001660 if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
1661 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
Jean Delvare63e4e802010-06-03 11:33:51 +02001662 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
1663 I2C_SMBUS_QUICK, NULL);
Jean Delvare8031d792010-08-11 18:21:00 +02001664 else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
1665 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1666 I2C_SMBUS_BYTE, &dummy);
1667 else {
Andy Lutomirskid63a9e82013-07-17 13:27:59 -07001668 dev_warn(&adap->dev, "No suitable probing method supported for address 0x%02X\n",
1669 addr);
Jean Delvare8031d792010-08-11 18:21:00 +02001670 err = -EOPNOTSUPP;
1671 }
Jean Delvare63e4e802010-06-03 11:33:51 +02001672
1673 return err >= 0;
1674}
1675
Jean Delvareccfbbd02009-12-06 17:06:25 +01001676static int i2c_detect_address(struct i2c_client *temp_client,
Jean Delvare4735c982008-07-14 22:38:36 +02001677 struct i2c_driver *driver)
1678{
1679 struct i2c_board_info info;
1680 struct i2c_adapter *adapter = temp_client->adapter;
1681 int addr = temp_client->addr;
1682 int err;
1683
1684 /* Make sure the address is valid */
Jean Delvare656b8762010-06-03 11:33:53 +02001685 err = i2c_check_addr_validity(addr);
1686 if (err) {
Jean Delvare4735c982008-07-14 22:38:36 +02001687 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1688 addr);
Jean Delvare656b8762010-06-03 11:33:53 +02001689 return err;
Jean Delvare4735c982008-07-14 22:38:36 +02001690 }
1691
1692 /* Skip if already in use */
Jean Delvare3b5f7942010-06-03 11:33:55 +02001693 if (i2c_check_addr_busy(adapter, addr))
Jean Delvare4735c982008-07-14 22:38:36 +02001694 return 0;
1695
Jean Delvareccfbbd02009-12-06 17:06:25 +01001696 /* Make sure there is something at this address */
Jean Delvare63e4e802010-06-03 11:33:51 +02001697 if (!i2c_default_probe(adapter, addr))
1698 return 0;
Jean Delvare4735c982008-07-14 22:38:36 +02001699
1700 /* Finally call the custom detection function */
1701 memset(&info, 0, sizeof(struct i2c_board_info));
1702 info.addr = addr;
Jean Delvare310ec792009-12-14 21:17:23 +01001703 err = driver->detect(temp_client, &info);
Jean Delvare4735c982008-07-14 22:38:36 +02001704 if (err) {
1705 /* -ENODEV is returned if the detection fails. We catch it
1706 here as this isn't an error. */
1707 return err == -ENODEV ? 0 : err;
1708 }
1709
1710 /* Consistency check */
1711 if (info.type[0] == '\0') {
1712 dev_err(&adapter->dev, "%s detection function provided "
1713 "no name for 0x%x\n", driver->driver.name,
1714 addr);
1715 } else {
1716 struct i2c_client *client;
1717
1718 /* Detection succeeded, instantiate the device */
1719 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1720 info.type, info.addr);
1721 client = i2c_new_device(adapter, &info);
1722 if (client)
1723 list_add_tail(&client->detected, &driver->clients);
1724 else
1725 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1726 info.type, info.addr);
1727 }
1728 return 0;
1729}
1730
1731static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1732{
Jean Delvarec3813d62009-12-14 21:17:25 +01001733 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +02001734 struct i2c_client *temp_client;
1735 int i, err = 0;
1736 int adap_id = i2c_adapter_id(adapter);
1737
Jean Delvarec3813d62009-12-14 21:17:25 +01001738 address_list = driver->address_list;
1739 if (!driver->detect || !address_list)
Jean Delvare4735c982008-07-14 22:38:36 +02001740 return 0;
1741
Jean Delvare51b54ba2010-10-24 18:16:58 +02001742 /* Stop here if the classes do not match */
1743 if (!(adapter->class & driver->class))
1744 return 0;
1745
Jean Delvare4735c982008-07-14 22:38:36 +02001746 /* Set up a temporary client to help detect callback */
1747 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1748 if (!temp_client)
1749 return -ENOMEM;
1750 temp_client->adapter = adapter;
1751
Jean Delvarec3813d62009-12-14 21:17:25 +01001752 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
Jean Delvare4735c982008-07-14 22:38:36 +02001753 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
Jean Delvarec3813d62009-12-14 21:17:25 +01001754 "addr 0x%02x\n", adap_id, address_list[i]);
1755 temp_client->addr = address_list[i];
Jean Delvareccfbbd02009-12-06 17:06:25 +01001756 err = i2c_detect_address(temp_client, driver);
Jean Delvare51b54ba2010-10-24 18:16:58 +02001757 if (unlikely(err))
1758 break;
Jean Delvare4735c982008-07-14 22:38:36 +02001759 }
1760
Jean Delvare4735c982008-07-14 22:38:36 +02001761 kfree(temp_client);
1762 return err;
1763}
1764
Jean Delvared44f19d2010-08-11 18:20:57 +02001765int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
1766{
1767 return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1768 I2C_SMBUS_QUICK, NULL) >= 0;
1769}
1770EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);
1771
Jean Delvare12b5053a2007-05-01 23:26:31 +02001772struct i2c_client *
1773i2c_new_probed_device(struct i2c_adapter *adap,
1774 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +02001775 unsigned short const *addr_list,
1776 int (*probe)(struct i2c_adapter *, unsigned short addr))
Jean Delvare12b5053a2007-05-01 23:26:31 +02001777{
1778 int i;
1779
Jean Delvare8031d792010-08-11 18:21:00 +02001780 if (!probe)
Jean Delvare9a942412010-08-11 18:20:56 +02001781 probe = i2c_default_probe;
Jean Delvare12b5053a2007-05-01 23:26:31 +02001782
Jean Delvare12b5053a2007-05-01 23:26:31 +02001783 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1784 /* Check address validity */
Jean Delvare656b8762010-06-03 11:33:53 +02001785 if (i2c_check_addr_validity(addr_list[i]) < 0) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001786 dev_warn(&adap->dev, "Invalid 7-bit address "
1787 "0x%02x\n", addr_list[i]);
1788 continue;
1789 }
1790
1791 /* Check address availability */
Jean Delvare3b5f7942010-06-03 11:33:55 +02001792 if (i2c_check_addr_busy(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001793 dev_dbg(&adap->dev, "Address 0x%02x already in "
1794 "use, not probing\n", addr_list[i]);
1795 continue;
1796 }
1797
Jean Delvare63e4e802010-06-03 11:33:51 +02001798 /* Test address responsiveness */
Jean Delvare9a942412010-08-11 18:20:56 +02001799 if (probe(adap, addr_list[i]))
Jean Delvare63e4e802010-06-03 11:33:51 +02001800 break;
Jean Delvare12b5053a2007-05-01 23:26:31 +02001801 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02001802
1803 if (addr_list[i] == I2C_CLIENT_END) {
1804 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1805 return NULL;
1806 }
1807
1808 info->addr = addr_list[i];
1809 return i2c_new_device(adap, info);
1810}
1811EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1812
Jean Delvared735b342011-03-20 14:50:52 +01001813struct i2c_adapter *i2c_get_adapter(int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001816
Jean Delvarecaada322008-01-27 18:14:49 +01001817 mutex_lock(&core_lock);
Jean Delvared735b342011-03-20 14:50:52 +01001818 adapter = idr_find(&i2c_adapter_idr, nr);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001819 if (adapter && !try_module_get(adapter->owner))
1820 adapter = NULL;
1821
Jean Delvarecaada322008-01-27 18:14:49 +01001822 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001823 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824}
David Brownellc0564602007-05-01 23:26:31 +02001825EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826
1827void i2c_put_adapter(struct i2c_adapter *adap)
1828{
Sebastian Hesselbarthc66c4cc2013-08-01 14:10:46 +02001829 if (adap)
1830 module_put(adap->owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831}
David Brownellc0564602007-05-01 23:26:31 +02001832EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833
1834/* The SMBus parts */
1835
David Brownell438d6c22006-12-10 21:21:31 +01001836#define POLY (0x1070U << 3)
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001837static u8 crc8(u16 data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838{
1839 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001840
Farid Hammane7225acf2010-05-21 18:40:58 +02001841 for (i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001842 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 data = data ^ POLY;
1844 data = data << 1;
1845 }
1846 return (u8)(data >> 8);
1847}
1848
Jean Delvare421ef472005-10-26 21:28:55 +02001849/* Incremental CRC8 over count bytes in the array pointed to by p */
1850static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851{
1852 int i;
1853
Farid Hammane7225acf2010-05-21 18:40:58 +02001854 for (i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001855 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 return crc;
1857}
1858
Jean Delvare421ef472005-10-26 21:28:55 +02001859/* Assume a 7-bit address, which is reasonable for SMBus */
1860static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861{
Jean Delvare421ef472005-10-26 21:28:55 +02001862 /* The address will be sent first */
1863 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1864 pec = i2c_smbus_pec(pec, &addr, 1);
1865
1866 /* The data buffer follows */
1867 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868}
1869
Jean Delvare421ef472005-10-26 21:28:55 +02001870/* Used for write only transactions */
1871static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872{
Jean Delvare421ef472005-10-26 21:28:55 +02001873 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1874 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875}
1876
Jean Delvare421ef472005-10-26 21:28:55 +02001877/* Return <0 on CRC error
1878 If there was a write before this read (most cases) we need to take the
1879 partial CRC from the write part into account.
1880 Note that this function does modify the message (we need to decrease the
1881 message length to hide the CRC byte from the caller). */
1882static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883{
Jean Delvare421ef472005-10-26 21:28:55 +02001884 u8 rpec = msg->buf[--msg->len];
1885 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 if (rpec != cpec) {
1888 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1889 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02001890 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 }
David Brownell438d6c22006-12-10 21:21:31 +01001892 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893}
1894
David Brownella1cdeda2008-07-14 22:38:24 +02001895/**
1896 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1897 * @client: Handle to slave device
1898 *
1899 * This executes the SMBus "receive byte" protocol, returning negative errno
1900 * else the byte received from the device.
1901 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001902s32 i2c_smbus_read_byte(const struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903{
1904 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001905 int status;
1906
1907 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1908 I2C_SMBUS_READ, 0,
1909 I2C_SMBUS_BYTE, &data);
1910 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911}
David Brownellc0564602007-05-01 23:26:31 +02001912EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913
David Brownella1cdeda2008-07-14 22:38:24 +02001914/**
1915 * i2c_smbus_write_byte - SMBus "send byte" protocol
1916 * @client: Handle to slave device
1917 * @value: Byte to be sent
1918 *
1919 * This executes the SMBus "send byte" protocol, returning negative errno
1920 * else zero on success.
1921 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001922s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923{
Farid Hammane7225acf2010-05-21 18:40:58 +02001924 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001925 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926}
David Brownellc0564602007-05-01 23:26:31 +02001927EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928
David Brownella1cdeda2008-07-14 22:38:24 +02001929/**
1930 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1931 * @client: Handle to slave device
1932 * @command: Byte interpreted by slave
1933 *
1934 * This executes the SMBus "read byte" protocol, returning negative errno
1935 * else a data byte received from the device.
1936 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001937s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938{
1939 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001940 int status;
1941
1942 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1943 I2C_SMBUS_READ, command,
1944 I2C_SMBUS_BYTE_DATA, &data);
1945 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946}
David Brownellc0564602007-05-01 23:26:31 +02001947EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948
David Brownella1cdeda2008-07-14 22:38:24 +02001949/**
1950 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1951 * @client: Handle to slave device
1952 * @command: Byte interpreted by slave
1953 * @value: Byte being written
1954 *
1955 * This executes the SMBus "write byte" protocol, returning negative errno
1956 * else zero on success.
1957 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001958s32 i2c_smbus_write_byte_data(const struct i2c_client *client, u8 command,
1959 u8 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960{
1961 union i2c_smbus_data data;
1962 data.byte = value;
Farid Hammane7225acf2010-05-21 18:40:58 +02001963 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1964 I2C_SMBUS_WRITE, command,
1965 I2C_SMBUS_BYTE_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966}
David Brownellc0564602007-05-01 23:26:31 +02001967EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968
David Brownella1cdeda2008-07-14 22:38:24 +02001969/**
1970 * i2c_smbus_read_word_data - SMBus "read word" protocol
1971 * @client: Handle to slave device
1972 * @command: Byte interpreted by slave
1973 *
1974 * This executes the SMBus "read word" protocol, returning negative errno
1975 * else a 16-bit unsigned "word" received from the device.
1976 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001977s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978{
1979 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001980 int status;
1981
1982 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1983 I2C_SMBUS_READ, command,
1984 I2C_SMBUS_WORD_DATA, &data);
1985 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986}
David Brownellc0564602007-05-01 23:26:31 +02001987EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988
David Brownella1cdeda2008-07-14 22:38:24 +02001989/**
1990 * i2c_smbus_write_word_data - SMBus "write word" protocol
1991 * @client: Handle to slave device
1992 * @command: Byte interpreted by slave
1993 * @value: 16-bit "word" being written
1994 *
1995 * This executes the SMBus "write word" protocol, returning negative errno
1996 * else zero on success.
1997 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001998s32 i2c_smbus_write_word_data(const struct i2c_client *client, u8 command,
1999 u16 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000{
2001 union i2c_smbus_data data;
2002 data.word = value;
Farid Hammane7225acf2010-05-21 18:40:58 +02002003 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2004 I2C_SMBUS_WRITE, command,
2005 I2C_SMBUS_WORD_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006}
David Brownellc0564602007-05-01 23:26:31 +02002007EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
David Brownella64ec072007-10-13 23:56:31 +02002009/**
David Brownella1cdeda2008-07-14 22:38:24 +02002010 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02002011 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02002012 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02002013 * @values: Byte array into which data will be read; big enough to hold
2014 * the data returned by the slave. SMBus allows at most 32 bytes.
2015 *
David Brownella1cdeda2008-07-14 22:38:24 +02002016 * This executes the SMBus "block read" protocol, returning negative errno
2017 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02002018 *
2019 * Note that using this function requires that the client's adapter support
2020 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
2021 * support this; its emulation through I2C messaging relies on a specific
2022 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
2023 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002024s32 i2c_smbus_read_block_data(const struct i2c_client *client, u8 command,
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002025 u8 *values)
2026{
2027 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002028 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002029
David Brownell24a5bb72008-07-14 22:38:23 +02002030 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2031 I2C_SMBUS_READ, command,
2032 I2C_SMBUS_BLOCK_DATA, &data);
2033 if (status)
2034 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002035
2036 memcpy(values, &data.block[1], data.block[0]);
2037 return data.block[0];
2038}
2039EXPORT_SYMBOL(i2c_smbus_read_block_data);
2040
David Brownella1cdeda2008-07-14 22:38:24 +02002041/**
2042 * i2c_smbus_write_block_data - SMBus "block write" protocol
2043 * @client: Handle to slave device
2044 * @command: Byte interpreted by slave
2045 * @length: Size of data block; SMBus allows at most 32 bytes
2046 * @values: Byte array which will be written.
2047 *
2048 * This executes the SMBus "block write" protocol, returning negative errno
2049 * else zero on success.
2050 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002051s32 i2c_smbus_write_block_data(const struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02002052 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053{
2054 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01002055
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 if (length > I2C_SMBUS_BLOCK_MAX)
2057 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01002059 memcpy(&data.block[1], values, length);
Farid Hammane7225acf2010-05-21 18:40:58 +02002060 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2061 I2C_SMBUS_WRITE, command,
2062 I2C_SMBUS_BLOCK_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063}
David Brownellc0564602007-05-01 23:26:31 +02002064EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
2066/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002067s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, u8 command,
Jean Delvare4b2643d2007-07-12 14:12:29 +02002068 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069{
2070 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002071 int status;
Jean Delvare76560322006-01-18 23:14:55 +01002072
Jean Delvare4b2643d2007-07-12 14:12:29 +02002073 if (length > I2C_SMBUS_BLOCK_MAX)
2074 length = I2C_SMBUS_BLOCK_MAX;
2075 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02002076 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2077 I2C_SMBUS_READ, command,
2078 I2C_SMBUS_I2C_BLOCK_DATA, &data);
2079 if (status < 0)
2080 return status;
Jean Delvare76560322006-01-18 23:14:55 +01002081
2082 memcpy(values, &data.block[1], data.block[0]);
2083 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084}
David Brownellc0564602007-05-01 23:26:31 +02002085EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086
Jean Delvare0cc43a12011-01-10 22:11:23 +01002087s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02002088 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11002089{
2090 union i2c_smbus_data data;
2091
2092 if (length > I2C_SMBUS_BLOCK_MAX)
2093 length = I2C_SMBUS_BLOCK_MAX;
2094 data.block[0] = length;
2095 memcpy(data.block + 1, values, length);
2096 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2097 I2C_SMBUS_WRITE, command,
2098 I2C_SMBUS_I2C_BLOCK_DATA, &data);
2099}
David Brownellc0564602007-05-01 23:26:31 +02002100EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11002101
David Brownell438d6c22006-12-10 21:21:31 +01002102/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 No checking of parameters is done! */
Farid Hammane7225acf2010-05-21 18:40:58 +02002104static s32 i2c_smbus_xfer_emulated(struct i2c_adapter *adapter, u16 addr,
2105 unsigned short flags,
2106 char read_write, u8 command, int size,
2107 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108{
2109 /* So we need to generate a series of msgs. In the case of writing, we
2110 need to use only one message; when reading, we need two. We initialize
2111 most things with sane defaults, to keep the code below somewhat
2112 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02002113 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
2114 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Farid Hammane7225acf2010-05-21 18:40:58 +02002115 int num = read_write == I2C_SMBUS_READ ? 2 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02002117 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02002118 int status;
Shubhrajyoti D230da092012-10-05 22:23:52 +02002119 struct i2c_msg msg[2] = {
2120 {
2121 .addr = addr,
2122 .flags = flags,
2123 .len = 1,
2124 .buf = msgbuf0,
2125 }, {
2126 .addr = addr,
2127 .flags = flags | I2C_M_RD,
2128 .len = 0,
2129 .buf = msgbuf1,
2130 },
2131 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
2133 msgbuf0[0] = command;
Farid Hammane7225acf2010-05-21 18:40:58 +02002134 switch (size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 case I2C_SMBUS_QUICK:
2136 msg[0].len = 0;
2137 /* Special case: The read/write field is used as data */
Roel Kluinf29d2e02009-02-24 19:19:48 +01002138 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
2139 I2C_M_RD : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 num = 1;
2141 break;
2142 case I2C_SMBUS_BYTE:
2143 if (read_write == I2C_SMBUS_READ) {
2144 /* Special case: only a read! */
2145 msg[0].flags = I2C_M_RD | flags;
2146 num = 1;
2147 }
2148 break;
2149 case I2C_SMBUS_BYTE_DATA:
2150 if (read_write == I2C_SMBUS_READ)
2151 msg[1].len = 1;
2152 else {
2153 msg[0].len = 2;
2154 msgbuf0[1] = data->byte;
2155 }
2156 break;
2157 case I2C_SMBUS_WORD_DATA:
2158 if (read_write == I2C_SMBUS_READ)
2159 msg[1].len = 2;
2160 else {
Farid Hammane7225acf2010-05-21 18:40:58 +02002161 msg[0].len = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02002163 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 }
2165 break;
2166 case I2C_SMBUS_PROC_CALL:
2167 num = 2; /* Special case */
2168 read_write = I2C_SMBUS_READ;
2169 msg[0].len = 3;
2170 msg[1].len = 2;
2171 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02002172 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 break;
2174 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02002176 msg[1].flags |= I2C_M_RECV_LEN;
2177 msg[1].len = 1; /* block length will be added by
2178 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 } else {
2180 msg[0].len = data->block[0] + 2;
2181 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02002182 dev_err(&adapter->dev,
2183 "Invalid block write size %d\n",
2184 data->block[0]);
2185 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02002187 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 msgbuf0[i] = data->block[i-1];
2189 }
2190 break;
2191 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02002192 num = 2; /* Another special case */
2193 read_write = I2C_SMBUS_READ;
2194 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02002195 dev_err(&adapter->dev,
2196 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02002197 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02002198 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02002199 }
2200 msg[0].len = data->block[0] + 2;
2201 for (i = 1; i < msg[0].len; i++)
2202 msgbuf0[i] = data->block[i-1];
2203 msg[1].flags |= I2C_M_RECV_LEN;
2204 msg[1].len = 1; /* block length will be added by
2205 the underlying bus driver */
2206 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 case I2C_SMBUS_I2C_BLOCK_DATA:
2208 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02002209 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 } else {
2211 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02002212 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02002213 dev_err(&adapter->dev,
2214 "Invalid block write size %d\n",
2215 data->block[0]);
2216 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 }
2218 for (i = 1; i <= data->block[0]; i++)
2219 msgbuf0[i] = data->block[i];
2220 }
2221 break;
2222 default:
David Brownell24a5bb72008-07-14 22:38:23 +02002223 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
2224 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 }
2226
Jean Delvare421ef472005-10-26 21:28:55 +02002227 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
2228 && size != I2C_SMBUS_I2C_BLOCK_DATA);
2229 if (i) {
2230 /* Compute PEC if first message is a write */
2231 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01002232 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02002233 i2c_smbus_add_pec(&msg[0]);
2234 else /* Write followed by read */
2235 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
2236 }
2237 /* Ask for PEC if last message is a read */
2238 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01002239 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02002240 }
2241
David Brownell24a5bb72008-07-14 22:38:23 +02002242 status = i2c_transfer(adapter, msg, num);
2243 if (status < 0)
2244 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
Jean Delvare421ef472005-10-26 21:28:55 +02002246 /* Check PEC if last message is a read */
2247 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02002248 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
2249 if (status < 0)
2250 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02002251 }
2252
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 if (read_write == I2C_SMBUS_READ)
Farid Hammane7225acf2010-05-21 18:40:58 +02002254 switch (size) {
2255 case I2C_SMBUS_BYTE:
2256 data->byte = msgbuf0[0];
2257 break;
2258 case I2C_SMBUS_BYTE_DATA:
2259 data->byte = msgbuf1[0];
2260 break;
2261 case I2C_SMBUS_WORD_DATA:
2262 case I2C_SMBUS_PROC_CALL:
2263 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
2264 break;
2265 case I2C_SMBUS_I2C_BLOCK_DATA:
2266 for (i = 0; i < data->block[0]; i++)
2267 data->block[i+1] = msgbuf1[i];
2268 break;
2269 case I2C_SMBUS_BLOCK_DATA:
2270 case I2C_SMBUS_BLOCK_PROC_CALL:
2271 for (i = 0; i < msgbuf1[0] + 1; i++)
2272 data->block[i] = msgbuf1[i];
2273 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 }
2275 return 0;
2276}
2277
David Brownella1cdeda2008-07-14 22:38:24 +02002278/**
2279 * i2c_smbus_xfer - execute SMBus protocol operations
2280 * @adapter: Handle to I2C bus
2281 * @addr: Address of SMBus slave on that bus
2282 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
2283 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
2284 * @command: Byte interpreted by slave, for protocols which use such bytes
2285 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
2286 * @data: Data to be read or written
2287 *
2288 * This executes an SMBus protocol operation, and returns a negative
2289 * errno code else zero on success.
2290 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01002291s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02002292 char read_write, u8 command, int protocol,
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01002293 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294{
Clifford Wolf66b650f2009-06-15 18:01:46 +02002295 unsigned long orig_jiffies;
2296 int try;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298
Laurent Pinchartd47726c2012-07-24 14:13:59 +02002299 flags &= I2C_M_TEN | I2C_CLIENT_PEC | I2C_CLIENT_SCCB;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300
2301 if (adapter->algo->smbus_xfer) {
Jean Delvarefe61e072010-08-11 18:20:58 +02002302 i2c_lock_adapter(adapter);
Clifford Wolf66b650f2009-06-15 18:01:46 +02002303
2304 /* Retry automatically on arbitration loss */
2305 orig_jiffies = jiffies;
2306 for (res = 0, try = 0; try <= adapter->retries; try++) {
2307 res = adapter->algo->smbus_xfer(adapter, addr, flags,
2308 read_write, command,
2309 protocol, data);
2310 if (res != -EAGAIN)
2311 break;
2312 if (time_after(jiffies,
2313 orig_jiffies + adapter->timeout))
2314 break;
2315 }
Jean Delvarefe61e072010-08-11 18:20:58 +02002316 i2c_unlock_adapter(adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317
Laurent Pinchart72fc2c72012-07-24 14:13:59 +02002318 if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
2319 return res;
2320 /*
2321 * Fall back to i2c_smbus_xfer_emulated if the adapter doesn't
2322 * implement native support for the SMBus operation.
2323 */
2324 }
2325
2326 return i2c_smbus_xfer_emulated(adapter, addr, flags, read_write,
2327 command, protocol, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330
2331MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2332MODULE_DESCRIPTION("I2C-Bus main module");
2333MODULE_LICENSE("GPL");