blob: e9ac0d84a01ea8cc32c56422295752b4dd049dc1 [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#ifdef CONFIG_HOTPLUG
97
98/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +020099static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +0200100{
101 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +0200102
Jean Delvareeb8a7902008-05-18 20:49:41 +0200103 if (add_uevent_var(env, "MODALIAS=%s%s",
104 I2C_MODULE_PREFIX, client->name))
105 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +0200106 dev_dbg(dev, "uevent\n");
107 return 0;
108}
109
110#else
111#define i2c_device_uevent NULL
112#endif /* CONFIG_HOTPLUG */
113
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530114/* i2c bus recovery routines */
115static int get_scl_gpio_value(struct i2c_adapter *adap)
116{
117 return gpio_get_value(adap->bus_recovery_info->scl_gpio);
118}
119
120static void set_scl_gpio_value(struct i2c_adapter *adap, int val)
121{
122 gpio_set_value(adap->bus_recovery_info->scl_gpio, val);
123}
124
125static int get_sda_gpio_value(struct i2c_adapter *adap)
126{
127 return gpio_get_value(adap->bus_recovery_info->sda_gpio);
128}
129
130static int i2c_get_gpios_for_recovery(struct i2c_adapter *adap)
131{
132 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
133 struct device *dev = &adap->dev;
134 int ret = 0;
135
136 ret = gpio_request_one(bri->scl_gpio, GPIOF_OPEN_DRAIN |
137 GPIOF_OUT_INIT_HIGH, "i2c-scl");
138 if (ret) {
139 dev_warn(dev, "Can't get SCL gpio: %d\n", bri->scl_gpio);
140 return ret;
141 }
142
143 if (bri->get_sda) {
144 if (gpio_request_one(bri->sda_gpio, GPIOF_IN, "i2c-sda")) {
145 /* work without SDA polling */
146 dev_warn(dev, "Can't get SDA gpio: %d. Not using SDA polling\n",
147 bri->sda_gpio);
148 bri->get_sda = NULL;
149 }
150 }
151
152 return ret;
153}
154
155static void i2c_put_gpios_for_recovery(struct i2c_adapter *adap)
156{
157 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
158
159 if (bri->get_sda)
160 gpio_free(bri->sda_gpio);
161
162 gpio_free(bri->scl_gpio);
163}
164
165/*
166 * We are generating clock pulses. ndelay() determines durating of clk pulses.
167 * We will generate clock with rate 100 KHz and so duration of both clock levels
168 * is: delay in ns = (10^6 / 100) / 2
169 */
170#define RECOVERY_NDELAY 5000
171#define RECOVERY_CLK_CNT 9
172
173static int i2c_generic_recovery(struct i2c_adapter *adap)
174{
175 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
176 int i = 0, val = 1, ret = 0;
177
178 if (bri->prepare_recovery)
179 bri->prepare_recovery(bri);
180
181 /*
182 * By this time SCL is high, as we need to give 9 falling-rising edges
183 */
184 while (i++ < RECOVERY_CLK_CNT * 2) {
185 if (val) {
186 /* Break if SDA is high */
187 if (bri->get_sda && bri->get_sda(adap))
188 break;
189 /* SCL shouldn't be low here */
190 if (!bri->get_scl(adap)) {
191 dev_err(&adap->dev,
192 "SCL is stuck low, exit recovery\n");
193 ret = -EBUSY;
194 break;
195 }
196 }
197
198 val = !val;
199 bri->set_scl(adap, val);
200 ndelay(RECOVERY_NDELAY);
201 }
202
203 if (bri->unprepare_recovery)
204 bri->unprepare_recovery(bri);
205
206 return ret;
207}
208
209int i2c_generic_scl_recovery(struct i2c_adapter *adap)
210{
211 adap->bus_recovery_info->set_scl(adap, 1);
212 return i2c_generic_recovery(adap);
213}
214
215int i2c_generic_gpio_recovery(struct i2c_adapter *adap)
216{
217 int ret;
218
219 ret = i2c_get_gpios_for_recovery(adap);
220 if (ret)
221 return ret;
222
223 ret = i2c_generic_recovery(adap);
224 i2c_put_gpios_for_recovery(adap);
225
226 return ret;
227}
228
229int i2c_recover_bus(struct i2c_adapter *adap)
230{
231 if (!adap->bus_recovery_info)
232 return -EOPNOTSUPP;
233
234 dev_dbg(&adap->dev, "Trying i2c bus recovery\n");
235 return adap->bus_recovery_info->recover_bus(adap);
236}
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238static int i2c_device_probe(struct device *dev)
239{
Jean Delvare51298d12009-09-18 22:45:45 +0200240 struct i2c_client *client = i2c_verify_client(dev);
241 struct i2c_driver *driver;
Hans Verkuil50c33042008-03-12 14:15:00 +0100242 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200243
Jean Delvare51298d12009-09-18 22:45:45 +0200244 if (!client)
245 return 0;
246
247 driver = to_i2c_driver(dev->driver);
Jean Delvaree0457442008-07-14 22:38:30 +0200248 if (!driver->probe || !driver->id_table)
David Brownell7b4fbc52007-05-01 23:26:30 +0200249 return -ENODEV;
250 client->driver = driver;
Marc Pignatee354252008-08-28 08:33:22 +0200251 if (!device_can_wakeup(&client->dev))
252 device_init_wakeup(&client->dev,
253 client->flags & I2C_CLIENT_WAKE);
David Brownell7b4fbc52007-05-01 23:26:30 +0200254 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200255
Jean Delvaree0457442008-07-14 22:38:30 +0200256 status = driver->probe(client, i2c_match_id(driver->id_table, client));
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200257 if (status) {
Hans Verkuil50c33042008-03-12 14:15:00 +0100258 client->driver = NULL;
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200259 i2c_set_clientdata(client, NULL);
260 }
Hans Verkuil50c33042008-03-12 14:15:00 +0100261 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262}
263
264static int i2c_device_remove(struct device *dev)
265{
Jean Delvare51298d12009-09-18 22:45:45 +0200266 struct i2c_client *client = i2c_verify_client(dev);
David Brownella1d9e6e2007-05-01 23:26:30 +0200267 struct i2c_driver *driver;
268 int status;
269
Jean Delvare51298d12009-09-18 22:45:45 +0200270 if (!client || !dev->driver)
David Brownella1d9e6e2007-05-01 23:26:30 +0200271 return 0;
272
273 driver = to_i2c_driver(dev->driver);
274 if (driver->remove) {
275 dev_dbg(dev, "remove\n");
276 status = driver->remove(client);
277 } else {
278 dev->driver = NULL;
279 status = 0;
280 }
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200281 if (status == 0) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200282 client->driver = NULL;
Wolfram Sange4a7b9b2010-05-04 11:09:27 +0200283 i2c_set_clientdata(client, NULL);
284 }
David Brownella1d9e6e2007-05-01 23:26:30 +0200285 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286}
287
David Brownellf37dd802007-02-13 22:09:00 +0100288static void i2c_device_shutdown(struct device *dev)
289{
Jean Delvare51298d12009-09-18 22:45:45 +0200290 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100291 struct i2c_driver *driver;
292
Jean Delvare51298d12009-09-18 22:45:45 +0200293 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100294 return;
295 driver = to_i2c_driver(dev->driver);
296 if (driver->shutdown)
Jean Delvare51298d12009-09-18 22:45:45 +0200297 driver->shutdown(client);
David Brownellf37dd802007-02-13 22:09:00 +0100298}
299
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200300#ifdef CONFIG_PM_SLEEP
301static int i2c_legacy_suspend(struct device *dev, pm_message_t mesg)
David Brownellf37dd802007-02-13 22:09:00 +0100302{
Jean Delvare51298d12009-09-18 22:45:45 +0200303 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100304 struct i2c_driver *driver;
305
Jean Delvare51298d12009-09-18 22:45:45 +0200306 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100307 return 0;
308 driver = to_i2c_driver(dev->driver);
309 if (!driver->suspend)
310 return 0;
Jean Delvare51298d12009-09-18 22:45:45 +0200311 return driver->suspend(client, mesg);
David Brownellf37dd802007-02-13 22:09:00 +0100312}
313
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200314static int i2c_legacy_resume(struct device *dev)
David Brownellf37dd802007-02-13 22:09:00 +0100315{
Jean Delvare51298d12009-09-18 22:45:45 +0200316 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100317 struct i2c_driver *driver;
318
Jean Delvare51298d12009-09-18 22:45:45 +0200319 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100320 return 0;
321 driver = to_i2c_driver(dev->driver);
322 if (!driver->resume)
323 return 0;
Jean Delvare51298d12009-09-18 22:45:45 +0200324 return driver->resume(client);
David Brownellf37dd802007-02-13 22:09:00 +0100325}
326
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200327static int i2c_device_pm_suspend(struct device *dev)
328{
329 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
330
Mark Brownd529de22011-01-14 22:03:49 +0100331 if (pm)
332 return pm_generic_suspend(dev);
333 else
334 return i2c_legacy_suspend(dev, PMSG_SUSPEND);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200335}
336
337static int i2c_device_pm_resume(struct device *dev)
338{
339 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200340
341 if (pm)
Mark Brownd529de22011-01-14 22:03:49 +0100342 return pm_generic_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200343 else
Mark Brownd529de22011-01-14 22:03:49 +0100344 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200345}
346
347static int i2c_device_pm_freeze(struct device *dev)
348{
349 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
350
Mark Brownd529de22011-01-14 22:03:49 +0100351 if (pm)
352 return pm_generic_freeze(dev);
353 else
354 return i2c_legacy_suspend(dev, PMSG_FREEZE);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200355}
356
357static int i2c_device_pm_thaw(struct device *dev)
358{
359 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
360
Mark Brownd529de22011-01-14 22:03:49 +0100361 if (pm)
362 return pm_generic_thaw(dev);
363 else
364 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200365}
366
367static int i2c_device_pm_poweroff(struct device *dev)
368{
369 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
370
Mark Brownd529de22011-01-14 22:03:49 +0100371 if (pm)
372 return pm_generic_poweroff(dev);
373 else
374 return i2c_legacy_suspend(dev, PMSG_HIBERNATE);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200375}
376
377static int i2c_device_pm_restore(struct device *dev)
378{
379 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200380
381 if (pm)
Mark Brownd529de22011-01-14 22:03:49 +0100382 return pm_generic_restore(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200383 else
Mark Brownd529de22011-01-14 22:03:49 +0100384 return i2c_legacy_resume(dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200385}
386#else /* !CONFIG_PM_SLEEP */
387#define i2c_device_pm_suspend NULL
388#define i2c_device_pm_resume NULL
389#define i2c_device_pm_freeze NULL
390#define i2c_device_pm_thaw NULL
391#define i2c_device_pm_poweroff NULL
392#define i2c_device_pm_restore NULL
393#endif /* !CONFIG_PM_SLEEP */
394
David Brownell9c1600e2007-05-01 23:26:31 +0200395static void i2c_client_dev_release(struct device *dev)
396{
397 kfree(to_i2c_client(dev));
398}
399
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100400static ssize_t
Jean Delvare4f8cf822009-09-18 22:45:46 +0200401show_name(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200402{
Jean Delvare4f8cf822009-09-18 22:45:46 +0200403 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
404 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200405}
406
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100407static ssize_t
408show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200409{
410 struct i2c_client *client = to_i2c_client(dev);
Jean Delvareeb8a7902008-05-18 20:49:41 +0200411 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200412}
413
Jean Delvare4f8cf822009-09-18 22:45:46 +0200414static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
Jean Delvare51298d12009-09-18 22:45:45 +0200415static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
416
417static struct attribute *i2c_dev_attrs[] = {
418 &dev_attr_name.attr,
David Brownell7b4fbc52007-05-01 23:26:30 +0200419 /* modalias helps coldplug: modprobe $(cat .../modalias) */
Jean Delvare51298d12009-09-18 22:45:45 +0200420 &dev_attr_modalias.attr,
421 NULL
422};
423
424static struct attribute_group i2c_dev_attr_group = {
425 .attrs = i2c_dev_attrs,
426};
427
428static const struct attribute_group *i2c_dev_attr_groups[] = {
429 &i2c_dev_attr_group,
430 NULL
David Brownell7b4fbc52007-05-01 23:26:30 +0200431};
432
Tobias Klauser0b2c3682010-01-16 20:43:12 +0100433static const struct dev_pm_ops i2c_device_pm_ops = {
sonic zhang54067ee2009-12-14 21:17:30 +0100434 .suspend = i2c_device_pm_suspend,
435 .resume = i2c_device_pm_resume,
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200436 .freeze = i2c_device_pm_freeze,
437 .thaw = i2c_device_pm_thaw,
438 .poweroff = i2c_device_pm_poweroff,
439 .restore = i2c_device_pm_restore,
440 SET_RUNTIME_PM_OPS(
441 pm_generic_runtime_suspend,
442 pm_generic_runtime_resume,
443 pm_generic_runtime_idle
444 )
sonic zhang54067ee2009-12-14 21:17:30 +0100445};
446
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200447struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100448 .name = "i2c",
449 .match = i2c_device_match,
450 .probe = i2c_device_probe,
451 .remove = i2c_device_remove,
452 .shutdown = i2c_device_shutdown,
sonic zhang54067ee2009-12-14 21:17:30 +0100453 .pm = &i2c_device_pm_ops,
Russell Kingb864c7d2006-01-05 14:37:50 +0000454};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200455EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000456
Jean Delvare51298d12009-09-18 22:45:45 +0200457static struct device_type i2c_client_type = {
458 .groups = i2c_dev_attr_groups,
459 .uevent = i2c_device_uevent,
460 .release = i2c_client_dev_release,
461};
462
David Brownell9b766b82008-01-27 18:14:51 +0100463
464/**
465 * i2c_verify_client - return parameter as i2c_client, or NULL
466 * @dev: device, probably from some driver model iterator
467 *
468 * When traversing the driver model tree, perhaps using driver model
469 * iterators like @device_for_each_child(), you can't assume very much
470 * about the nodes you find. Use this function to avoid oopses caused
471 * by wrongly treating some non-I2C device as an i2c_client.
472 */
473struct i2c_client *i2c_verify_client(struct device *dev)
474{
Jean Delvare51298d12009-09-18 22:45:45 +0200475 return (dev->type == &i2c_client_type)
David Brownell9b766b82008-01-27 18:14:51 +0100476 ? to_i2c_client(dev)
477 : NULL;
478}
479EXPORT_SYMBOL(i2c_verify_client);
480
481
Jean Delvare3a89db52010-06-03 11:33:52 +0200482/* This is a permissive address validity check, I2C address map constraints
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300483 * are purposely not enforced, except for the general call address. */
Jean Delvare3a89db52010-06-03 11:33:52 +0200484static int i2c_check_client_addr_validity(const struct i2c_client *client)
485{
486 if (client->flags & I2C_CLIENT_TEN) {
487 /* 10-bit address, all values are valid */
488 if (client->addr > 0x3ff)
489 return -EINVAL;
490 } else {
491 /* 7-bit address, reject the general call address */
492 if (client->addr == 0x00 || client->addr > 0x7f)
493 return -EINVAL;
494 }
495 return 0;
496}
497
Jean Delvare656b8762010-06-03 11:33:53 +0200498/* And this is a strict address validity check, used when probing. If a
499 * device uses a reserved address, then it shouldn't be probed. 7-bit
500 * addressing is assumed, 10-bit address devices are rare and should be
501 * explicitly enumerated. */
502static int i2c_check_addr_validity(unsigned short addr)
503{
504 /*
505 * Reserved addresses per I2C specification:
506 * 0x00 General call address / START byte
507 * 0x01 CBUS address
508 * 0x02 Reserved for different bus format
509 * 0x03 Reserved for future purposes
510 * 0x04-0x07 Hs-mode master code
511 * 0x78-0x7b 10-bit slave addressing
512 * 0x7c-0x7f Reserved for future purposes
513 */
514 if (addr < 0x08 || addr > 0x77)
515 return -EINVAL;
516 return 0;
517}
518
Jean Delvare3b5f7942010-06-03 11:33:55 +0200519static int __i2c_check_addr_busy(struct device *dev, void *addrp)
520{
521 struct i2c_client *client = i2c_verify_client(dev);
522 int addr = *(int *)addrp;
523
524 if (client && client->addr == addr)
525 return -EBUSY;
526 return 0;
527}
528
Michael Lawnick08263742010-08-11 18:21:02 +0200529/* walk up mux tree */
530static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
531{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200532 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200533 int result;
534
535 result = device_for_each_child(&adapter->dev, &addr,
536 __i2c_check_addr_busy);
537
Jean Delvare97cc4d42010-10-24 18:16:57 +0200538 if (!result && parent)
539 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200540
541 return result;
542}
543
544/* recurse down mux tree */
545static int i2c_check_mux_children(struct device *dev, void *addrp)
546{
547 int result;
548
549 if (dev->type == &i2c_adapter_type)
550 result = device_for_each_child(dev, addrp,
551 i2c_check_mux_children);
552 else
553 result = __i2c_check_addr_busy(dev, addrp);
554
555 return result;
556}
557
Jean Delvare3b5f7942010-06-03 11:33:55 +0200558static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
559{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200560 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200561 int result = 0;
562
Jean Delvare97cc4d42010-10-24 18:16:57 +0200563 if (parent)
564 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200565
566 if (!result)
567 result = device_for_each_child(&adapter->dev, &addr,
568 i2c_check_mux_children);
569
570 return result;
Jean Delvare3b5f7942010-06-03 11:33:55 +0200571}
572
David Brownell9c1600e2007-05-01 23:26:31 +0200573/**
Jean Delvarefe61e072010-08-11 18:20:58 +0200574 * i2c_lock_adapter - Get exclusive access to an I2C bus segment
575 * @adapter: Target I2C bus segment
576 */
577void i2c_lock_adapter(struct i2c_adapter *adapter)
578{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200579 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
580
581 if (parent)
582 i2c_lock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200583 else
584 rt_mutex_lock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200585}
586EXPORT_SYMBOL_GPL(i2c_lock_adapter);
587
588/**
589 * i2c_trylock_adapter - Try to get exclusive access to an I2C bus segment
590 * @adapter: Target I2C bus segment
591 */
592static int i2c_trylock_adapter(struct i2c_adapter *adapter)
593{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200594 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
595
596 if (parent)
597 return i2c_trylock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200598 else
599 return rt_mutex_trylock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200600}
601
602/**
603 * i2c_unlock_adapter - Release exclusive access to an I2C bus segment
604 * @adapter: Target I2C bus segment
605 */
606void i2c_unlock_adapter(struct i2c_adapter *adapter)
607{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200608 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
609
610 if (parent)
611 i2c_unlock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200612 else
613 rt_mutex_unlock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200614}
615EXPORT_SYMBOL_GPL(i2c_unlock_adapter);
616
617/**
Jean Delvaref8a227e2009-06-19 16:58:18 +0200618 * i2c_new_device - instantiate an i2c device
David Brownell9c1600e2007-05-01 23:26:31 +0200619 * @adap: the adapter managing the device
620 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200621 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200622 *
Jean Delvaref8a227e2009-06-19 16:58:18 +0200623 * Create an i2c device. Binding is handled through driver model
624 * probe()/remove() methods. A driver may be bound to this device when we
625 * return from this function, or any later moment (e.g. maybe hotplugging will
626 * load the driver module). This call is not appropriate for use by mainboard
627 * initialization logic, which usually runs during an arch_initcall() long
628 * before any i2c_adapter could exist.
David Brownell9c1600e2007-05-01 23:26:31 +0200629 *
630 * This returns the new i2c client, which may be saved for later use with
631 * i2c_unregister_device(); or NULL to indicate an error.
632 */
633struct i2c_client *
634i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
635{
636 struct i2c_client *client;
637 int status;
638
639 client = kzalloc(sizeof *client, GFP_KERNEL);
640 if (!client)
641 return NULL;
642
643 client->adapter = adap;
644
645 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200646
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200647 if (info->archdata)
648 client->dev.archdata = *info->archdata;
649
Marc Pignatee354252008-08-28 08:33:22 +0200650 client->flags = info->flags;
David Brownell9c1600e2007-05-01 23:26:31 +0200651 client->addr = info->addr;
652 client->irq = info->irq;
653
David Brownell9c1600e2007-05-01 23:26:31 +0200654 strlcpy(client->name, info->type, sizeof(client->name));
655
Jean Delvare3a89db52010-06-03 11:33:52 +0200656 /* Check for address validity */
657 status = i2c_check_client_addr_validity(client);
658 if (status) {
659 dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
660 client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
661 goto out_err_silent;
662 }
663
Jean Delvaref8a227e2009-06-19 16:58:18 +0200664 /* Check for address business */
Jean Delvare3b5f7942010-06-03 11:33:55 +0200665 status = i2c_check_addr_busy(adap, client->addr);
Jean Delvaref8a227e2009-06-19 16:58:18 +0200666 if (status)
667 goto out_err;
668
669 client->dev.parent = &client->adapter->dev;
670 client->dev.bus = &i2c_bus_type;
Jean Delvare51298d12009-09-18 22:45:45 +0200671 client->dev.type = &i2c_client_type;
Grant Likelyd12d42f2010-04-13 16:12:28 -0700672 client->dev.of_node = info->of_node;
Mika Westerberg907ddf82012-11-23 12:23:40 +0100673 ACPI_HANDLE_SET(&client->dev, info->acpi_node.handle);
Jean Delvaref8a227e2009-06-19 16:58:18 +0200674
Jean Delvarecbb44512011-11-23 11:33:07 +0100675 /* For 10-bit clients, add an arbitrary offset to avoid collisions */
Jean Delvaref8a227e2009-06-19 16:58:18 +0200676 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
Jean Delvarecbb44512011-11-23 11:33:07 +0100677 client->addr | ((client->flags & I2C_CLIENT_TEN)
678 ? 0xa000 : 0));
Jean Delvaref8a227e2009-06-19 16:58:18 +0200679 status = device_register(&client->dev);
680 if (status)
681 goto out_err;
682
Jean Delvaref8a227e2009-06-19 16:58:18 +0200683 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
684 client->name, dev_name(&client->dev));
685
David Brownell9c1600e2007-05-01 23:26:31 +0200686 return client;
Jean Delvaref8a227e2009-06-19 16:58:18 +0200687
688out_err:
689 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
690 "(%d)\n", client->name, client->addr, status);
Jean Delvare3a89db52010-06-03 11:33:52 +0200691out_err_silent:
Jean Delvaref8a227e2009-06-19 16:58:18 +0200692 kfree(client);
693 return NULL;
David Brownell9c1600e2007-05-01 23:26:31 +0200694}
695EXPORT_SYMBOL_GPL(i2c_new_device);
696
697
698/**
699 * i2c_unregister_device - reverse effect of i2c_new_device()
700 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200701 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200702 */
703void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200704{
David Brownella1d9e6e2007-05-01 23:26:30 +0200705 device_unregister(&client->dev);
706}
David Brownell9c1600e2007-05-01 23:26:31 +0200707EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200708
709
Jean Delvare60b129d2008-05-11 20:37:06 +0200710static const struct i2c_device_id dummy_id[] = {
711 { "dummy", 0 },
712 { },
713};
714
Jean Delvared2653e92008-04-29 23:11:39 +0200715static int dummy_probe(struct i2c_client *client,
716 const struct i2c_device_id *id)
717{
718 return 0;
719}
720
721static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100722{
723 return 0;
724}
725
726static struct i2c_driver dummy_driver = {
727 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200728 .probe = dummy_probe,
729 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200730 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100731};
732
733/**
734 * i2c_new_dummy - return a new i2c device bound to a dummy driver
735 * @adapter: the adapter managing the device
736 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100737 * Context: can sleep
738 *
739 * This returns an I2C client bound to the "dummy" driver, intended for use
740 * with devices that consume multiple addresses. Examples of such chips
741 * include various EEPROMS (like 24c04 and 24c08 models).
742 *
743 * These dummy devices have two main uses. First, most I2C and SMBus calls
744 * except i2c_transfer() need a client handle; the dummy will be that handle.
745 * And second, this prevents the specified address from being bound to a
746 * different driver.
747 *
748 * This returns the new i2c client, which should be saved for later use with
749 * i2c_unregister_device(); or NULL to indicate an error.
750 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100751struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100752{
753 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200754 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100755 };
756
David Brownelle9f13732008-01-27 18:14:52 +0100757 return i2c_new_device(adapter, &info);
758}
759EXPORT_SYMBOL_GPL(i2c_new_dummy);
760
David Brownellf37dd802007-02-13 22:09:00 +0100761/* ------------------------------------------------------------------------- */
762
David Brownell16ffadf2007-05-01 23:26:28 +0200763/* I2C bus adapters -- one roots each I2C or SMBUS segment */
764
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200765static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766{
David Brownellef2c83212007-05-01 23:26:28 +0200767 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 complete(&adap->dev_released);
769}
770
Jean Delvare99cd8e22009-06-19 16:58:20 +0200771/*
Jean Delvare390946b2012-09-10 10:14:02 +0200772 * This function is only needed for mutex_lock_nested, so it is never
773 * called unless locking correctness checking is enabled. Thus we
774 * make it inline to avoid a compiler warning. That's what gcc ends up
775 * doing anyway.
776 */
777static inline unsigned int i2c_adapter_depth(struct i2c_adapter *adapter)
778{
779 unsigned int depth = 0;
780
781 while ((adapter = i2c_parent_is_i2c_adapter(adapter)))
782 depth++;
783
784 return depth;
785}
786
787/*
Jean Delvare99cd8e22009-06-19 16:58:20 +0200788 * Let users instantiate I2C devices through sysfs. This can be used when
789 * platform initialization code doesn't contain the proper data for
790 * whatever reason. Also useful for drivers that do device detection and
791 * detection fails, either because the device uses an unexpected address,
792 * or this is a compatible device with different ID register values.
793 *
794 * Parameter checking may look overzealous, but we really don't want
795 * the user to provide incorrect parameters.
796 */
797static ssize_t
798i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
799 const char *buf, size_t count)
800{
801 struct i2c_adapter *adap = to_i2c_adapter(dev);
802 struct i2c_board_info info;
803 struct i2c_client *client;
804 char *blank, end;
805 int res;
806
Jean Delvare99cd8e22009-06-19 16:58:20 +0200807 memset(&info, 0, sizeof(struct i2c_board_info));
808
809 blank = strchr(buf, ' ');
810 if (!blank) {
811 dev_err(dev, "%s: Missing parameters\n", "new_device");
812 return -EINVAL;
813 }
814 if (blank - buf > I2C_NAME_SIZE - 1) {
815 dev_err(dev, "%s: Invalid device name\n", "new_device");
816 return -EINVAL;
817 }
818 memcpy(info.type, buf, blank - buf);
819
820 /* Parse remaining parameters, reject extra parameters */
821 res = sscanf(++blank, "%hi%c", &info.addr, &end);
822 if (res < 1) {
823 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
824 return -EINVAL;
825 }
826 if (res > 1 && end != '\n') {
827 dev_err(dev, "%s: Extra parameters\n", "new_device");
828 return -EINVAL;
829 }
830
Jean Delvare99cd8e22009-06-19 16:58:20 +0200831 client = i2c_new_device(adap, &info);
832 if (!client)
Jean Delvare3a89db52010-06-03 11:33:52 +0200833 return -EINVAL;
Jean Delvare99cd8e22009-06-19 16:58:20 +0200834
835 /* Keep track of the added device */
Jean Delvaredafc50d2010-08-11 18:21:01 +0200836 mutex_lock(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +0200837 list_add_tail(&client->detected, &adap->userspace_clients);
Jean Delvaredafc50d2010-08-11 18:21:01 +0200838 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +0200839 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
840 info.type, info.addr);
841
842 return count;
843}
844
845/*
846 * And of course let the users delete the devices they instantiated, if
847 * they got it wrong. This interface can only be used to delete devices
848 * instantiated by i2c_sysfs_new_device above. This guarantees that we
849 * don't delete devices to which some kernel code still has references.
850 *
851 * Parameter checking may look overzealous, but we really don't want
852 * the user to delete the wrong device.
853 */
854static ssize_t
855i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
856 const char *buf, size_t count)
857{
858 struct i2c_adapter *adap = to_i2c_adapter(dev);
859 struct i2c_client *client, *next;
860 unsigned short addr;
861 char end;
862 int res;
863
864 /* Parse parameters, reject extra parameters */
865 res = sscanf(buf, "%hi%c", &addr, &end);
866 if (res < 1) {
867 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
868 return -EINVAL;
869 }
870 if (res > 1 && end != '\n') {
871 dev_err(dev, "%s: Extra parameters\n", "delete_device");
872 return -EINVAL;
873 }
874
875 /* Make sure the device was added through sysfs */
876 res = -ENOENT;
Jean Delvare390946b2012-09-10 10:14:02 +0200877 mutex_lock_nested(&adap->userspace_clients_lock,
878 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +0200879 list_for_each_entry_safe(client, next, &adap->userspace_clients,
880 detected) {
881 if (client->addr == addr) {
Jean Delvare99cd8e22009-06-19 16:58:20 +0200882 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
883 "delete_device", client->name, client->addr);
884
885 list_del(&client->detected);
886 i2c_unregister_device(client);
887 res = count;
888 break;
889 }
890 }
Jean Delvaredafc50d2010-08-11 18:21:01 +0200891 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +0200892
893 if (res < 0)
894 dev_err(dev, "%s: Can't find device in list\n",
895 "delete_device");
896 return res;
897}
898
Jean Delvare4f8cf822009-09-18 22:45:46 +0200899static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
900static DEVICE_ATTR(delete_device, S_IWUSR, NULL, i2c_sysfs_delete_device);
901
902static struct attribute *i2c_adapter_attrs[] = {
903 &dev_attr_name.attr,
904 &dev_attr_new_device.attr,
905 &dev_attr_delete_device.attr,
906 NULL
David Brownell16ffadf2007-05-01 23:26:28 +0200907};
908
Jean Delvare4f8cf822009-09-18 22:45:46 +0200909static struct attribute_group i2c_adapter_attr_group = {
910 .attrs = i2c_adapter_attrs,
911};
912
913static const struct attribute_group *i2c_adapter_attr_groups[] = {
914 &i2c_adapter_attr_group,
915 NULL
916};
917
Michael Lawnick08263742010-08-11 18:21:02 +0200918struct device_type i2c_adapter_type = {
Jean Delvare4f8cf822009-09-18 22:45:46 +0200919 .groups = i2c_adapter_attr_groups,
920 .release = i2c_adapter_dev_release,
David Brownell16ffadf2007-05-01 23:26:28 +0200921};
Michael Lawnick08263742010-08-11 18:21:02 +0200922EXPORT_SYMBOL_GPL(i2c_adapter_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
Stephen Warren643dd092012-04-17 12:43:33 -0600924/**
925 * i2c_verify_adapter - return parameter as i2c_adapter or NULL
926 * @dev: device, probably from some driver model iterator
927 *
928 * When traversing the driver model tree, perhaps using driver model
929 * iterators like @device_for_each_child(), you can't assume very much
930 * about the nodes you find. Use this function to avoid oopses caused
931 * by wrongly treating some non-I2C device as an i2c_adapter.
932 */
933struct i2c_adapter *i2c_verify_adapter(struct device *dev)
934{
935 return (dev->type == &i2c_adapter_type)
936 ? to_i2c_adapter(dev)
937 : NULL;
938}
939EXPORT_SYMBOL(i2c_verify_adapter);
940
Jean Delvare2bb50952009-09-18 22:45:46 +0200941#ifdef CONFIG_I2C_COMPAT
942static struct class_compat *i2c_adapter_compat_class;
943#endif
944
David Brownell9c1600e2007-05-01 23:26:31 +0200945static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
946{
947 struct i2c_devinfo *devinfo;
948
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +0200949 down_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +0200950 list_for_each_entry(devinfo, &__i2c_board_list, list) {
951 if (devinfo->busnum == adapter->nr
952 && !i2c_new_device(adapter,
953 &devinfo->board_info))
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100954 dev_err(&adapter->dev,
955 "Can't create device at 0x%02x\n",
David Brownell9c1600e2007-05-01 23:26:31 +0200956 devinfo->board_info.addr);
957 }
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +0200958 up_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +0200959}
960
Jean Delvare69b00892009-12-06 17:06:27 +0100961static int i2c_do_add_adapter(struct i2c_driver *driver,
962 struct i2c_adapter *adap)
Jean Delvare026526f2008-01-27 18:14:49 +0100963{
Jean Delvare4735c982008-07-14 22:38:36 +0200964 /* Detect supported devices on that bus, and instantiate them */
965 i2c_detect(adap, driver);
966
967 /* Let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +0100968 if (driver->attach_adapter) {
Jean Delvarea920ff42011-04-17 10:20:19 +0200969 dev_warn(&adap->dev, "%s: attach_adapter method is deprecated\n",
970 driver->driver.name);
Jean Delvarefe6fc252011-03-20 14:50:53 +0100971 dev_warn(&adap->dev, "Please use another way to instantiate "
972 "your i2c_client\n");
Jean Delvare026526f2008-01-27 18:14:49 +0100973 /* We ignore the return code; if it fails, too bad */
974 driver->attach_adapter(adap);
975 }
976 return 0;
977}
978
Jean Delvare69b00892009-12-06 17:06:27 +0100979static int __process_new_adapter(struct device_driver *d, void *data)
980{
981 return i2c_do_add_adapter(to_i2c_driver(d), data);
982}
983
David Brownell6e13e642007-05-01 23:26:31 +0200984static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985{
Jean Delvared6703282010-08-11 18:20:59 +0200986 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
David Brownell1d0b19c2008-10-14 17:30:05 +0200988 /* Can't register until after driver model init */
Jean Delvare35fc37f2009-06-19 16:58:19 +0200989 if (unlikely(WARN_ON(!i2c_bus_type.p))) {
990 res = -EAGAIN;
991 goto out_list;
992 }
David Brownell1d0b19c2008-10-14 17:30:05 +0200993
Jean Delvare2236baa2010-11-15 22:40:38 +0100994 /* Sanity checks */
995 if (unlikely(adap->name[0] == '\0')) {
996 pr_err("i2c-core: Attempt to register an adapter with "
997 "no name!\n");
998 return -EINVAL;
999 }
1000 if (unlikely(!adap->algo)) {
1001 pr_err("i2c-core: Attempt to register adapter '%s' with "
1002 "no algo!\n", adap->name);
1003 return -EINVAL;
1004 }
1005
Mika Kuoppala194684e2009-12-06 17:06:22 +01001006 rt_mutex_init(&adap->bus_lock);
Jean Delvaredafc50d2010-08-11 18:21:01 +02001007 mutex_init(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +02001008 INIT_LIST_HEAD(&adap->userspace_clients);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Jean Delvare8fcfef62009-03-28 21:34:43 +01001010 /* Set default timeout to 1 second if not already set */
1011 if (adap->timeout == 0)
1012 adap->timeout = HZ;
1013
Kay Sievers27d9c182009-01-07 14:29:16 +01001014 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001015 adap->dev.bus = &i2c_bus_type;
1016 adap->dev.type = &i2c_adapter_type;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001017 res = device_register(&adap->dev);
1018 if (res)
1019 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001021 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
1022
Jean Delvare2bb50952009-09-18 22:45:46 +02001023#ifdef CONFIG_I2C_COMPAT
1024 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
1025 adap->dev.parent);
1026 if (res)
1027 dev_warn(&adap->dev,
1028 "Failed to create compatibility class link\n");
1029#endif
1030
Viresh Kumar5f9296b2012-02-28 18:26:31 +05301031 /* bus recovery specific initialization */
1032 if (adap->bus_recovery_info) {
1033 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
1034
1035 if (!bri->recover_bus) {
1036 dev_err(&adap->dev, "No recover_bus() found, not using recovery\n");
1037 adap->bus_recovery_info = NULL;
1038 goto exit_recovery;
1039 }
1040
1041 /* Generic GPIO recovery */
1042 if (bri->recover_bus == i2c_generic_gpio_recovery) {
1043 if (!gpio_is_valid(bri->scl_gpio)) {
1044 dev_err(&adap->dev, "Invalid SCL gpio, not using recovery\n");
1045 adap->bus_recovery_info = NULL;
1046 goto exit_recovery;
1047 }
1048
1049 if (gpio_is_valid(bri->sda_gpio))
1050 bri->get_sda = get_sda_gpio_value;
1051 else
1052 bri->get_sda = NULL;
1053
1054 bri->get_scl = get_scl_gpio_value;
1055 bri->set_scl = set_scl_gpio_value;
1056 } else if (!bri->set_scl || !bri->get_scl) {
1057 /* Generic SCL recovery */
1058 dev_err(&adap->dev, "No {get|set}_gpio() found, not using recovery\n");
1059 adap->bus_recovery_info = NULL;
1060 }
1061 }
1062
1063exit_recovery:
Jean Delvare729d6dd2009-06-19 16:58:18 +02001064 /* create pre-declared device nodes */
David Brownell6e13e642007-05-01 23:26:31 +02001065 if (adap->nr < __i2c_first_dynamic_bus_num)
1066 i2c_scan_static_board_info(adap);
1067
Jean Delvare4735c982008-07-14 22:38:36 +02001068 /* Notify drivers */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001069 mutex_lock(&core_lock);
Jean Delvared6703282010-08-11 18:20:59 +02001070 bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
Jean Delvarecaada322008-01-27 18:14:49 +01001071 mutex_unlock(&core_lock);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001072
1073 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001074
Jean Delvareb119c6c2006-08-15 18:26:30 +02001075out_list:
Jean Delvare35fc37f2009-06-19 16:58:19 +02001076 mutex_lock(&core_lock);
Jean Delvareb119c6c2006-08-15 18:26:30 +02001077 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001078 mutex_unlock(&core_lock);
1079 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080}
1081
David Brownell6e13e642007-05-01 23:26:31 +02001082/**
Doug Andersonee5c2742013-03-01 08:57:31 -08001083 * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1
1084 * @adap: the adapter to register (with adap->nr initialized)
1085 * Context: can sleep
1086 *
1087 * See i2c_add_numbered_adapter() for details.
1088 */
1089static int __i2c_add_numbered_adapter(struct i2c_adapter *adap)
1090{
1091 int id;
1092
1093 mutex_lock(&core_lock);
1094 id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1,
1095 GFP_KERNEL);
1096 mutex_unlock(&core_lock);
1097 if (id < 0)
1098 return id == -ENOSPC ? -EBUSY : id;
1099
1100 return i2c_register_adapter(adap);
1101}
1102
1103/**
David Brownell6e13e642007-05-01 23:26:31 +02001104 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
1105 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +02001106 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001107 *
1108 * This routine is used to declare an I2C adapter when its bus number
Doug Andersonee5c2742013-03-01 08:57:31 -08001109 * doesn't matter or when its bus number is specified by an dt alias.
1110 * Examples of bases when the bus number doesn't matter: I2C adapters
1111 * dynamically added by USB links or PCI plugin cards.
David Brownell6e13e642007-05-01 23:26:31 +02001112 *
1113 * When this returns zero, a new bus number was allocated and stored
1114 * in adap->nr, and the specified adapter became available for clients.
1115 * Otherwise, a negative errno value is returned.
1116 */
1117int i2c_add_adapter(struct i2c_adapter *adapter)
1118{
Doug Andersonee5c2742013-03-01 08:57:31 -08001119 struct device *dev = &adapter->dev;
Tejun Heo4ae42b02013-02-27 17:04:15 -08001120 int id;
David Brownell6e13e642007-05-01 23:26:31 +02001121
Doug Andersonee5c2742013-03-01 08:57:31 -08001122 if (dev->of_node) {
1123 id = of_alias_get_id(dev->of_node, "i2c");
1124 if (id >= 0) {
1125 adapter->nr = id;
1126 return __i2c_add_numbered_adapter(adapter);
1127 }
1128 }
1129
Jean Delvarecaada322008-01-27 18:14:49 +01001130 mutex_lock(&core_lock);
Tejun Heo4ae42b02013-02-27 17:04:15 -08001131 id = idr_alloc(&i2c_adapter_idr, adapter,
1132 __i2c_first_dynamic_bus_num, 0, GFP_KERNEL);
Jean Delvarecaada322008-01-27 18:14:49 +01001133 mutex_unlock(&core_lock);
Tejun Heo4ae42b02013-02-27 17:04:15 -08001134 if (id < 0)
1135 return id;
David Brownell6e13e642007-05-01 23:26:31 +02001136
1137 adapter->nr = id;
Tejun Heo4ae42b02013-02-27 17:04:15 -08001138
David Brownell6e13e642007-05-01 23:26:31 +02001139 return i2c_register_adapter(adapter);
1140}
1141EXPORT_SYMBOL(i2c_add_adapter);
1142
1143/**
1144 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
1145 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +02001146 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001147 *
1148 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +01001149 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
1150 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +02001151 * is used to properly configure I2C devices.
1152 *
Grant Likely488bf312011-07-25 17:49:43 +02001153 * If the requested bus number is set to -1, then this function will behave
1154 * identically to i2c_add_adapter, and will dynamically assign a bus number.
1155 *
David Brownell6e13e642007-05-01 23:26:31 +02001156 * If no devices have pre-been declared for this bus, then be sure to
1157 * register the adapter before any dynamically allocated ones. Otherwise
1158 * the required bus ID may not be available.
1159 *
1160 * When this returns zero, the specified adapter became available for
1161 * clients using the bus number provided in adap->nr. Also, the table
1162 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
1163 * and the appropriate driver model device nodes are created. Otherwise, a
1164 * negative errno value is returned.
1165 */
1166int i2c_add_numbered_adapter(struct i2c_adapter *adap)
1167{
Grant Likely488bf312011-07-25 17:49:43 +02001168 if (adap->nr == -1) /* -1 means dynamically assign bus id */
1169 return i2c_add_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001170
Doug Andersonee5c2742013-03-01 08:57:31 -08001171 return __i2c_add_numbered_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001172}
1173EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
1174
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001175static void i2c_do_del_adapter(struct i2c_driver *driver,
Jean Delvare69b00892009-12-06 17:06:27 +01001176 struct i2c_adapter *adapter)
Jean Delvare026526f2008-01-27 18:14:49 +01001177{
Jean Delvare4735c982008-07-14 22:38:36 +02001178 struct i2c_client *client, *_n;
Jean Delvare026526f2008-01-27 18:14:49 +01001179
Jean Delvareacec2112009-03-28 21:34:40 +01001180 /* Remove the devices we created ourselves as the result of hardware
1181 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +02001182 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
1183 if (client->adapter == adapter) {
1184 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
1185 client->name, client->addr);
1186 list_del(&client->detected);
1187 i2c_unregister_device(client);
1188 }
1189 }
Jean Delvare026526f2008-01-27 18:14:49 +01001190}
1191
Jean Delvaree549c2b2009-06-19 16:58:19 +02001192static int __unregister_client(struct device *dev, void *dummy)
1193{
1194 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvare5219bf82011-01-14 22:03:49 +01001195 if (client && strcmp(client->name, "dummy"))
1196 i2c_unregister_device(client);
1197 return 0;
1198}
1199
1200static int __unregister_dummy(struct device *dev, void *dummy)
1201{
1202 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvaree549c2b2009-06-19 16:58:19 +02001203 if (client)
1204 i2c_unregister_device(client);
1205 return 0;
1206}
1207
Jean Delvare69b00892009-12-06 17:06:27 +01001208static int __process_removed_adapter(struct device_driver *d, void *data)
1209{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001210 i2c_do_del_adapter(to_i2c_driver(d), data);
1211 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001212}
1213
David Brownelld64f73b2007-07-12 14:12:28 +02001214/**
1215 * i2c_del_adapter - unregister I2C adapter
1216 * @adap: the adapter being unregistered
1217 * Context: can sleep
1218 *
1219 * This unregisters an I2C adapter which was previously registered
1220 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1221 */
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001222void i2c_del_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223{
Jean Delvare35fc37f2009-06-19 16:58:19 +02001224 struct i2c_adapter *found;
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001225 struct i2c_client *client, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
1227 /* First make sure that this adapter was ever added */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001228 mutex_lock(&core_lock);
1229 found = idr_find(&i2c_adapter_idr, adap->nr);
1230 mutex_unlock(&core_lock);
1231 if (found != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001232 pr_debug("i2c-core: attempting to delete unregistered "
1233 "adapter [%s]\n", adap->name);
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001234 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 }
1236
Jean Delvare026526f2008-01-27 18:14:49 +01001237 /* Tell drivers about this removal */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001238 mutex_lock(&core_lock);
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001239 bus_for_each_drv(&i2c_bus_type, NULL, adap,
Jean Delvare69b00892009-12-06 17:06:27 +01001240 __process_removed_adapter);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001241 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001243 /* Remove devices instantiated from sysfs */
Jean Delvare390946b2012-09-10 10:14:02 +02001244 mutex_lock_nested(&adap->userspace_clients_lock,
1245 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +02001246 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1247 detected) {
1248 dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
1249 client->addr);
1250 list_del(&client->detected);
1251 i2c_unregister_device(client);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001252 }
Jean Delvaredafc50d2010-08-11 18:21:01 +02001253 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001254
Jean Delvaree549c2b2009-06-19 16:58:19 +02001255 /* Detach any active clients. This can't fail, thus we do not
Jean Delvare5219bf82011-01-14 22:03:49 +01001256 * check the returned value. This is a two-pass process, because
1257 * we can't remove the dummy devices during the first pass: they
1258 * could have been instantiated by real devices wishing to clean
1259 * them up properly, so we give them a chance to do that first. */
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001260 device_for_each_child(&adap->dev, NULL, __unregister_client);
1261 device_for_each_child(&adap->dev, NULL, __unregister_dummy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262
Jean Delvare2bb50952009-09-18 22:45:46 +02001263#ifdef CONFIG_I2C_COMPAT
1264 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
1265 adap->dev.parent);
1266#endif
1267
Thadeu Lima de Souza Cascardoc5567522010-01-16 20:43:13 +01001268 /* device name is gone after device_unregister */
1269 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
1270
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 /* clean up the sysfs representation */
1272 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274
1275 /* wait for sysfs to drop all references */
1276 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
David Brownell6e13e642007-05-01 23:26:31 +02001278 /* free bus id */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001279 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001281 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Jean Delvarebd4bc3db2008-07-16 19:30:05 +02001283 /* Clear the device structure in case this adapter is ever going to be
1284 added again */
1285 memset(&adap->dev, 0, sizeof(adap->dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286}
David Brownellc0564602007-05-01 23:26:31 +02001287EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
1289
David Brownell7b4fbc52007-05-01 23:26:30 +02001290/* ------------------------------------------------------------------------- */
1291
Jean Delvare7ae31482011-03-20 14:50:52 +01001292int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *))
1293{
1294 int res;
1295
1296 mutex_lock(&core_lock);
1297 res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn);
1298 mutex_unlock(&core_lock);
1299
1300 return res;
1301}
1302EXPORT_SYMBOL_GPL(i2c_for_each_dev);
1303
Jean Delvare69b00892009-12-06 17:06:27 +01001304static int __process_new_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001305{
Jean Delvare4f8cf822009-09-18 22:45:46 +02001306 if (dev->type != &i2c_adapter_type)
1307 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001308 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
Dave Young7f101a92008-07-14 22:38:19 +02001309}
1310
David Brownell7b4fbc52007-05-01 23:26:30 +02001311/*
1312 * An i2c_driver is used with one or more i2c_client (device) nodes to access
Jean Delvare729d6dd2009-06-19 16:58:18 +02001313 * i2c slave chips, on a bus instance associated with some i2c_adapter.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 */
1315
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001316int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317{
Jean Delvare7eebcb72006-02-05 23:28:21 +01001318 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
David Brownell1d0b19c2008-10-14 17:30:05 +02001320 /* Can't register until after driver model init */
1321 if (unlikely(WARN_ON(!i2c_bus_type.p)))
1322 return -EAGAIN;
1323
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001325 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
Jean Delvare729d6dd2009-06-19 16:58:18 +02001328 /* When registration returns, the driver core
David Brownell6e13e642007-05-01 23:26:31 +02001329 * will have called probe() for all matching-but-unbound devices.
1330 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 res = driver_register(&driver->driver);
1332 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +01001333 return res;
David Brownell438d6c22006-12-10 21:21:31 +01001334
Mark Brownf4e8db32011-01-14 22:03:50 +01001335 /* Drivers should switch to dev_pm_ops instead. */
1336 if (driver->suspend)
1337 pr_warn("i2c-core: driver [%s] using legacy suspend method\n",
1338 driver->driver.name);
1339 if (driver->resume)
1340 pr_warn("i2c-core: driver [%s] using legacy resume method\n",
1341 driver->driver.name);
1342
Laurent Riffard35d8b2e2005-11-26 20:34:05 +01001343 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Jean Delvare4735c982008-07-14 22:38:36 +02001345 INIT_LIST_HEAD(&driver->clients);
1346 /* Walk the adapters that are already present */
Jean Delvare7ae31482011-03-20 14:50:52 +01001347 i2c_for_each_dev(driver, __process_new_driver);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001348
Jean Delvare7eebcb72006-02-05 23:28:21 +01001349 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001351EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352
Jean Delvare69b00892009-12-06 17:06:27 +01001353static int __process_removed_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001354{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001355 if (dev->type == &i2c_adapter_type)
1356 i2c_do_del_adapter(data, to_i2c_adapter(dev));
1357 return 0;
Dave Young7f101a92008-07-14 22:38:19 +02001358}
1359
David Brownella1d9e6e2007-05-01 23:26:30 +02001360/**
1361 * i2c_del_driver - unregister I2C driver
1362 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +02001363 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +02001364 */
Jean Delvareb3e82092007-05-01 23:26:32 +02001365void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366{
Jean Delvare7ae31482011-03-20 14:50:52 +01001367 i2c_for_each_dev(driver, __process_removed_driver);
David Brownella1d9e6e2007-05-01 23:26:30 +02001368
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +01001370 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371}
David Brownellc0564602007-05-01 23:26:31 +02001372EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
David Brownell7b4fbc52007-05-01 23:26:30 +02001374/* ------------------------------------------------------------------------- */
1375
Jean Delvaree48d3312008-01-27 18:14:48 +01001376/**
1377 * i2c_use_client - increments the reference count of the i2c client structure
1378 * @client: the client being referenced
1379 *
1380 * Each live reference to a client should be refcounted. The driver model does
1381 * that automatically as part of driver binding, so that most drivers don't
1382 * need to do this explicitly: they hold a reference until they're unbound
1383 * from the device.
1384 *
1385 * A pointer to the client with the incremented reference counter is returned.
1386 */
1387struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388{
David Brownell6ea438e2008-07-14 22:38:24 +02001389 if (client && get_device(&client->dev))
1390 return client;
1391 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392}
David Brownellc0564602007-05-01 23:26:31 +02001393EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
Jean Delvaree48d3312008-01-27 18:14:48 +01001395/**
1396 * i2c_release_client - release a use of the i2c client structure
1397 * @client: the client being no longer referenced
1398 *
1399 * Must be called when a user of a client is finished with it.
1400 */
1401void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402{
David Brownell6ea438e2008-07-14 22:38:24 +02001403 if (client)
1404 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405}
David Brownellc0564602007-05-01 23:26:31 +02001406EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
David Brownell9b766b82008-01-27 18:14:51 +01001408struct i2c_cmd_arg {
1409 unsigned cmd;
1410 void *arg;
1411};
1412
1413static int i2c_cmd(struct device *dev, void *_arg)
1414{
1415 struct i2c_client *client = i2c_verify_client(dev);
1416 struct i2c_cmd_arg *arg = _arg;
1417
1418 if (client && client->driver && client->driver->command)
1419 client->driver->command(client, arg->cmd, arg->arg);
1420 return 0;
1421}
1422
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
1424{
David Brownell9b766b82008-01-27 18:14:51 +01001425 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
David Brownell9b766b82008-01-27 18:14:51 +01001427 cmd_arg.cmd = cmd;
1428 cmd_arg.arg = arg;
1429 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430}
David Brownellc0564602007-05-01 23:26:31 +02001431EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432
1433static int __init i2c_init(void)
1434{
1435 int retval;
1436
1437 retval = bus_register(&i2c_bus_type);
1438 if (retval)
1439 return retval;
Jean Delvare2bb50952009-09-18 22:45:46 +02001440#ifdef CONFIG_I2C_COMPAT
1441 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
1442 if (!i2c_adapter_compat_class) {
1443 retval = -ENOMEM;
1444 goto bus_err;
1445 }
1446#endif
David Brownelle9f13732008-01-27 18:14:52 +01001447 retval = i2c_add_driver(&dummy_driver);
1448 if (retval)
Jean Delvare2bb50952009-09-18 22:45:46 +02001449 goto class_err;
David Brownelle9f13732008-01-27 18:14:52 +01001450 return 0;
1451
Jean Delvare2bb50952009-09-18 22:45:46 +02001452class_err:
1453#ifdef CONFIG_I2C_COMPAT
1454 class_compat_unregister(i2c_adapter_compat_class);
David Brownelle9f13732008-01-27 18:14:52 +01001455bus_err:
Jean Delvare2bb50952009-09-18 22:45:46 +02001456#endif
David Brownelle9f13732008-01-27 18:14:52 +01001457 bus_unregister(&i2c_bus_type);
1458 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459}
1460
1461static void __exit i2c_exit(void)
1462{
David Brownelle9f13732008-01-27 18:14:52 +01001463 i2c_del_driver(&dummy_driver);
Jean Delvare2bb50952009-09-18 22:45:46 +02001464#ifdef CONFIG_I2C_COMPAT
1465 class_compat_unregister(i2c_adapter_compat_class);
1466#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 bus_unregister(&i2c_bus_type);
1468}
1469
David Brownella10f9e72008-10-14 17:30:06 +02001470/* We must initialize early, because some subsystems register i2c drivers
1471 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1472 */
1473postcore_initcall(i2c_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474module_exit(i2c_exit);
1475
1476/* ----------------------------------------------------
1477 * the functional interface to the i2c busses.
1478 * ----------------------------------------------------
1479 */
1480
David Brownella1cdeda2008-07-14 22:38:24 +02001481/**
Jean Delvareb37d2a32012-06-29 07:47:19 -03001482 * __i2c_transfer - unlocked flavor of i2c_transfer
1483 * @adap: Handle to I2C bus
1484 * @msgs: One or more messages to execute before STOP is issued to
1485 * terminate the operation; each message begins with a START.
1486 * @num: Number of messages to be executed.
1487 *
1488 * Returns negative errno, else the number of messages executed.
1489 *
1490 * Adapter lock must be held when calling this function. No debug logging
1491 * takes place. adap->algo->master_xfer existence isn't checked.
1492 */
1493int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1494{
1495 unsigned long orig_jiffies;
1496 int ret, try;
1497
1498 /* Retry automatically on arbitration loss */
1499 orig_jiffies = jiffies;
1500 for (ret = 0, try = 0; try <= adap->retries; try++) {
1501 ret = adap->algo->master_xfer(adap, msgs, num);
1502 if (ret != -EAGAIN)
1503 break;
1504 if (time_after(jiffies, orig_jiffies + adap->timeout))
1505 break;
1506 }
1507
1508 return ret;
1509}
1510EXPORT_SYMBOL(__i2c_transfer);
1511
1512/**
David Brownella1cdeda2008-07-14 22:38:24 +02001513 * i2c_transfer - execute a single or combined I2C message
1514 * @adap: Handle to I2C bus
1515 * @msgs: One or more messages to execute before STOP is issued to
1516 * terminate the operation; each message begins with a START.
1517 * @num: Number of messages to be executed.
1518 *
1519 * Returns negative errno, else the number of messages executed.
1520 *
1521 * Note that there is no requirement that each message be sent to
1522 * the same slave address, although that is the most common model.
1523 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001524int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525{
Jean Delvareb37d2a32012-06-29 07:47:19 -03001526 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
David Brownella1cdeda2008-07-14 22:38:24 +02001528 /* REVISIT the fault reporting model here is weak:
1529 *
1530 * - When we get an error after receiving N bytes from a slave,
1531 * there is no way to report "N".
1532 *
1533 * - When we get a NAK after transmitting N bytes to a slave,
1534 * there is no way to report "N" ... or to let the master
1535 * continue executing the rest of this combined message, if
1536 * that's the appropriate response.
1537 *
1538 * - When for example "num" is two and we successfully complete
1539 * the first message but get an error part way through the
1540 * second, it's unclear whether that should be reported as
1541 * one (discarding status on the second message) or errno
1542 * (discarding status on the first one).
1543 */
1544
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 if (adap->algo->master_xfer) {
1546#ifdef DEBUG
1547 for (ret = 0; ret < num; ret++) {
1548 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +02001549 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1550 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1551 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 }
1553#endif
1554
Mike Rapoportcea443a82008-01-27 18:14:50 +01001555 if (in_atomic() || irqs_disabled()) {
Jean Delvarefe61e072010-08-11 18:20:58 +02001556 ret = i2c_trylock_adapter(adap);
Mike Rapoportcea443a82008-01-27 18:14:50 +01001557 if (!ret)
1558 /* I2C activity is ongoing. */
1559 return -EAGAIN;
1560 } else {
Jean Delvarefe61e072010-08-11 18:20:58 +02001561 i2c_lock_adapter(adap);
Mike Rapoportcea443a82008-01-27 18:14:50 +01001562 }
1563
Jean Delvareb37d2a32012-06-29 07:47:19 -03001564 ret = __i2c_transfer(adap, msgs, num);
Jean Delvarefe61e072010-08-11 18:20:58 +02001565 i2c_unlock_adapter(adap);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
1567 return ret;
1568 } else {
1569 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001570 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 }
1572}
David Brownellc0564602007-05-01 23:26:31 +02001573EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
David Brownella1cdeda2008-07-14 22:38:24 +02001575/**
1576 * i2c_master_send - issue a single I2C message in master transmit mode
1577 * @client: Handle to slave device
1578 * @buf: Data that will be written to the slave
Zhangfei Gao0c43ea52010-03-02 12:23:49 +01001579 * @count: How many bytes to write, must be less than 64k since msg.len is u16
David Brownella1cdeda2008-07-14 22:38:24 +02001580 *
1581 * Returns negative errno, or else the number of bytes written.
1582 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001583int i2c_master_send(const struct i2c_client *client, const char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584{
1585 int ret;
Farid Hammane7225acf2010-05-21 18:40:58 +02001586 struct i2c_adapter *adap = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 struct i2c_msg msg;
1588
Jean Delvare815f55f2005-05-07 22:58:46 +02001589 msg.addr = client->addr;
1590 msg.flags = client->flags & I2C_M_TEN;
1591 msg.len = count;
1592 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01001593
Jean Delvare815f55f2005-05-07 22:58:46 +02001594 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
Wolfram Sang834aa6f2012-03-15 18:11:05 +01001596 /*
1597 * If everything went ok (i.e. 1 msg transmitted), return #bytes
1598 * transmitted, else error code.
1599 */
Jean Delvare815f55f2005-05-07 22:58:46 +02001600 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601}
David Brownellc0564602007-05-01 23:26:31 +02001602EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
David Brownella1cdeda2008-07-14 22:38:24 +02001604/**
1605 * i2c_master_recv - issue a single I2C message in master receive mode
1606 * @client: Handle to slave device
1607 * @buf: Where to store data read from slave
Zhangfei Gao0c43ea52010-03-02 12:23:49 +01001608 * @count: How many bytes to read, must be less than 64k since msg.len is u16
David Brownella1cdeda2008-07-14 22:38:24 +02001609 *
1610 * Returns negative errno, or else the number of bytes read.
1611 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001612int i2c_master_recv(const struct i2c_client *client, char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613{
Farid Hammane7225acf2010-05-21 18:40:58 +02001614 struct i2c_adapter *adap = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 struct i2c_msg msg;
1616 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
Jean Delvare815f55f2005-05-07 22:58:46 +02001618 msg.addr = client->addr;
1619 msg.flags = client->flags & I2C_M_TEN;
1620 msg.flags |= I2C_M_RD;
1621 msg.len = count;
1622 msg.buf = buf;
1623
1624 ret = i2c_transfer(adap, &msg, 1);
1625
Wolfram Sang834aa6f2012-03-15 18:11:05 +01001626 /*
1627 * If everything went ok (i.e. 1 msg received), return #bytes received,
1628 * else error code.
1629 */
Jean Delvare815f55f2005-05-07 22:58:46 +02001630 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631}
David Brownellc0564602007-05-01 23:26:31 +02001632EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634/* ----------------------------------------------------
1635 * the i2c address scanning function
1636 * Will not work for 10-bit addresses!
1637 * ----------------------------------------------------
1638 */
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001639
Jean Delvare63e4e802010-06-03 11:33:51 +02001640/*
1641 * Legacy default probe function, mostly relevant for SMBus. The default
1642 * probe method is a quick write, but it is known to corrupt the 24RF08
1643 * EEPROMs due to a state machine bug, and could also irreversibly
1644 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
1645 * we use a short byte read instead. Also, some bus drivers don't implement
1646 * quick write, so we fallback to a byte read in that case too.
1647 * On x86, there is another special case for FSC hardware monitoring chips,
1648 * which want regular byte reads (address 0x73.) Fortunately, these are the
1649 * only known chips using this I2C address on PC hardware.
1650 * Returns 1 if probe succeeded, 0 if not.
1651 */
1652static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
1653{
1654 int err;
1655 union i2c_smbus_data dummy;
1656
1657#ifdef CONFIG_X86
1658 if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
1659 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
1660 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1661 I2C_SMBUS_BYTE_DATA, &dummy);
1662 else
1663#endif
Jean Delvare8031d792010-08-11 18:21:00 +02001664 if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
1665 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
Jean Delvare63e4e802010-06-03 11:33:51 +02001666 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
1667 I2C_SMBUS_QUICK, NULL);
Jean Delvare8031d792010-08-11 18:21:00 +02001668 else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
1669 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1670 I2C_SMBUS_BYTE, &dummy);
1671 else {
1672 dev_warn(&adap->dev, "No suitable probing method supported\n");
1673 err = -EOPNOTSUPP;
1674 }
Jean Delvare63e4e802010-06-03 11:33:51 +02001675
1676 return err >= 0;
1677}
1678
Jean Delvareccfbbd02009-12-06 17:06:25 +01001679static int i2c_detect_address(struct i2c_client *temp_client,
Jean Delvare4735c982008-07-14 22:38:36 +02001680 struct i2c_driver *driver)
1681{
1682 struct i2c_board_info info;
1683 struct i2c_adapter *adapter = temp_client->adapter;
1684 int addr = temp_client->addr;
1685 int err;
1686
1687 /* Make sure the address is valid */
Jean Delvare656b8762010-06-03 11:33:53 +02001688 err = i2c_check_addr_validity(addr);
1689 if (err) {
Jean Delvare4735c982008-07-14 22:38:36 +02001690 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1691 addr);
Jean Delvare656b8762010-06-03 11:33:53 +02001692 return err;
Jean Delvare4735c982008-07-14 22:38:36 +02001693 }
1694
1695 /* Skip if already in use */
Jean Delvare3b5f7942010-06-03 11:33:55 +02001696 if (i2c_check_addr_busy(adapter, addr))
Jean Delvare4735c982008-07-14 22:38:36 +02001697 return 0;
1698
Jean Delvareccfbbd02009-12-06 17:06:25 +01001699 /* Make sure there is something at this address */
Jean Delvare63e4e802010-06-03 11:33:51 +02001700 if (!i2c_default_probe(adapter, addr))
1701 return 0;
Jean Delvare4735c982008-07-14 22:38:36 +02001702
1703 /* Finally call the custom detection function */
1704 memset(&info, 0, sizeof(struct i2c_board_info));
1705 info.addr = addr;
Jean Delvare310ec792009-12-14 21:17:23 +01001706 err = driver->detect(temp_client, &info);
Jean Delvare4735c982008-07-14 22:38:36 +02001707 if (err) {
1708 /* -ENODEV is returned if the detection fails. We catch it
1709 here as this isn't an error. */
1710 return err == -ENODEV ? 0 : err;
1711 }
1712
1713 /* Consistency check */
1714 if (info.type[0] == '\0') {
1715 dev_err(&adapter->dev, "%s detection function provided "
1716 "no name for 0x%x\n", driver->driver.name,
1717 addr);
1718 } else {
1719 struct i2c_client *client;
1720
1721 /* Detection succeeded, instantiate the device */
1722 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1723 info.type, info.addr);
1724 client = i2c_new_device(adapter, &info);
1725 if (client)
1726 list_add_tail(&client->detected, &driver->clients);
1727 else
1728 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1729 info.type, info.addr);
1730 }
1731 return 0;
1732}
1733
1734static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1735{
Jean Delvarec3813d62009-12-14 21:17:25 +01001736 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +02001737 struct i2c_client *temp_client;
1738 int i, err = 0;
1739 int adap_id = i2c_adapter_id(adapter);
1740
Jean Delvarec3813d62009-12-14 21:17:25 +01001741 address_list = driver->address_list;
1742 if (!driver->detect || !address_list)
Jean Delvare4735c982008-07-14 22:38:36 +02001743 return 0;
1744
Jean Delvare51b54ba2010-10-24 18:16:58 +02001745 /* Stop here if the classes do not match */
1746 if (!(adapter->class & driver->class))
1747 return 0;
1748
Jean Delvare4735c982008-07-14 22:38:36 +02001749 /* Set up a temporary client to help detect callback */
1750 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1751 if (!temp_client)
1752 return -ENOMEM;
1753 temp_client->adapter = adapter;
1754
Jean Delvarec3813d62009-12-14 21:17:25 +01001755 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
Jean Delvare4735c982008-07-14 22:38:36 +02001756 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
Jean Delvarec3813d62009-12-14 21:17:25 +01001757 "addr 0x%02x\n", adap_id, address_list[i]);
1758 temp_client->addr = address_list[i];
Jean Delvareccfbbd02009-12-06 17:06:25 +01001759 err = i2c_detect_address(temp_client, driver);
Jean Delvare51b54ba2010-10-24 18:16:58 +02001760 if (unlikely(err))
1761 break;
Jean Delvare4735c982008-07-14 22:38:36 +02001762 }
1763
Jean Delvare4735c982008-07-14 22:38:36 +02001764 kfree(temp_client);
1765 return err;
1766}
1767
Jean Delvared44f19d2010-08-11 18:20:57 +02001768int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
1769{
1770 return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
1771 I2C_SMBUS_QUICK, NULL) >= 0;
1772}
1773EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);
1774
Jean Delvare12b5053a2007-05-01 23:26:31 +02001775struct i2c_client *
1776i2c_new_probed_device(struct i2c_adapter *adap,
1777 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +02001778 unsigned short const *addr_list,
1779 int (*probe)(struct i2c_adapter *, unsigned short addr))
Jean Delvare12b5053a2007-05-01 23:26:31 +02001780{
1781 int i;
1782
Jean Delvare8031d792010-08-11 18:21:00 +02001783 if (!probe)
Jean Delvare9a942412010-08-11 18:20:56 +02001784 probe = i2c_default_probe;
Jean Delvare12b5053a2007-05-01 23:26:31 +02001785
Jean Delvare12b5053a2007-05-01 23:26:31 +02001786 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1787 /* Check address validity */
Jean Delvare656b8762010-06-03 11:33:53 +02001788 if (i2c_check_addr_validity(addr_list[i]) < 0) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001789 dev_warn(&adap->dev, "Invalid 7-bit address "
1790 "0x%02x\n", addr_list[i]);
1791 continue;
1792 }
1793
1794 /* Check address availability */
Jean Delvare3b5f7942010-06-03 11:33:55 +02001795 if (i2c_check_addr_busy(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001796 dev_dbg(&adap->dev, "Address 0x%02x already in "
1797 "use, not probing\n", addr_list[i]);
1798 continue;
1799 }
1800
Jean Delvare63e4e802010-06-03 11:33:51 +02001801 /* Test address responsiveness */
Jean Delvare9a942412010-08-11 18:20:56 +02001802 if (probe(adap, addr_list[i]))
Jean Delvare63e4e802010-06-03 11:33:51 +02001803 break;
Jean Delvare12b5053a2007-05-01 23:26:31 +02001804 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02001805
1806 if (addr_list[i] == I2C_CLIENT_END) {
1807 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1808 return NULL;
1809 }
1810
1811 info->addr = addr_list[i];
1812 return i2c_new_device(adap, info);
1813}
1814EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1815
Jean Delvared735b342011-03-20 14:50:52 +01001816struct i2c_adapter *i2c_get_adapter(int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001819
Jean Delvarecaada322008-01-27 18:14:49 +01001820 mutex_lock(&core_lock);
Jean Delvared735b342011-03-20 14:50:52 +01001821 adapter = idr_find(&i2c_adapter_idr, nr);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001822 if (adapter && !try_module_get(adapter->owner))
1823 adapter = NULL;
1824
Jean Delvarecaada322008-01-27 18:14:49 +01001825 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001826 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827}
David Brownellc0564602007-05-01 23:26:31 +02001828EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829
1830void i2c_put_adapter(struct i2c_adapter *adap)
1831{
1832 module_put(adap->owner);
1833}
David Brownellc0564602007-05-01 23:26:31 +02001834EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835
1836/* The SMBus parts */
1837
David Brownell438d6c22006-12-10 21:21:31 +01001838#define POLY (0x1070U << 3)
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001839static u8 crc8(u16 data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840{
1841 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001842
Farid Hammane7225acf2010-05-21 18:40:58 +02001843 for (i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001844 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 data = data ^ POLY;
1846 data = data << 1;
1847 }
1848 return (u8)(data >> 8);
1849}
1850
Jean Delvare421ef472005-10-26 21:28:55 +02001851/* Incremental CRC8 over count bytes in the array pointed to by p */
1852static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853{
1854 int i;
1855
Farid Hammane7225acf2010-05-21 18:40:58 +02001856 for (i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001857 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 return crc;
1859}
1860
Jean Delvare421ef472005-10-26 21:28:55 +02001861/* Assume a 7-bit address, which is reasonable for SMBus */
1862static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863{
Jean Delvare421ef472005-10-26 21:28:55 +02001864 /* The address will be sent first */
1865 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1866 pec = i2c_smbus_pec(pec, &addr, 1);
1867
1868 /* The data buffer follows */
1869 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870}
1871
Jean Delvare421ef472005-10-26 21:28:55 +02001872/* Used for write only transactions */
1873static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874{
Jean Delvare421ef472005-10-26 21:28:55 +02001875 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1876 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877}
1878
Jean Delvare421ef472005-10-26 21:28:55 +02001879/* Return <0 on CRC error
1880 If there was a write before this read (most cases) we need to take the
1881 partial CRC from the write part into account.
1882 Note that this function does modify the message (we need to decrease the
1883 message length to hide the CRC byte from the caller). */
1884static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885{
Jean Delvare421ef472005-10-26 21:28:55 +02001886 u8 rpec = msg->buf[--msg->len];
1887 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 if (rpec != cpec) {
1890 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1891 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02001892 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 }
David Brownell438d6c22006-12-10 21:21:31 +01001894 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895}
1896
David Brownella1cdeda2008-07-14 22:38:24 +02001897/**
1898 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1899 * @client: Handle to slave device
1900 *
1901 * This executes the SMBus "receive byte" protocol, returning negative errno
1902 * else the byte received from the device.
1903 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001904s32 i2c_smbus_read_byte(const struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905{
1906 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001907 int status;
1908
1909 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1910 I2C_SMBUS_READ, 0,
1911 I2C_SMBUS_BYTE, &data);
1912 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913}
David Brownellc0564602007-05-01 23:26:31 +02001914EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915
David Brownella1cdeda2008-07-14 22:38:24 +02001916/**
1917 * i2c_smbus_write_byte - SMBus "send byte" protocol
1918 * @client: Handle to slave device
1919 * @value: Byte to be sent
1920 *
1921 * This executes the SMBus "send byte" protocol, returning negative errno
1922 * else zero on success.
1923 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001924s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925{
Farid Hammane7225acf2010-05-21 18:40:58 +02001926 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001927 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928}
David Brownellc0564602007-05-01 23:26:31 +02001929EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
David Brownella1cdeda2008-07-14 22:38:24 +02001931/**
1932 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1933 * @client: Handle to slave device
1934 * @command: Byte interpreted by slave
1935 *
1936 * This executes the SMBus "read byte" protocol, returning negative errno
1937 * else a data byte received from the device.
1938 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001939s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940{
1941 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001942 int status;
1943
1944 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1945 I2C_SMBUS_READ, command,
1946 I2C_SMBUS_BYTE_DATA, &data);
1947 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948}
David Brownellc0564602007-05-01 23:26:31 +02001949EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950
David Brownella1cdeda2008-07-14 22:38:24 +02001951/**
1952 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1953 * @client: Handle to slave device
1954 * @command: Byte interpreted by slave
1955 * @value: Byte being written
1956 *
1957 * This executes the SMBus "write byte" protocol, returning negative errno
1958 * else zero on success.
1959 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001960s32 i2c_smbus_write_byte_data(const struct i2c_client *client, u8 command,
1961 u8 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962{
1963 union i2c_smbus_data data;
1964 data.byte = value;
Farid Hammane7225acf2010-05-21 18:40:58 +02001965 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1966 I2C_SMBUS_WRITE, command,
1967 I2C_SMBUS_BYTE_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968}
David Brownellc0564602007-05-01 23:26:31 +02001969EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
David Brownella1cdeda2008-07-14 22:38:24 +02001971/**
1972 * i2c_smbus_read_word_data - SMBus "read word" protocol
1973 * @client: Handle to slave device
1974 * @command: Byte interpreted by slave
1975 *
1976 * This executes the SMBus "read word" protocol, returning negative errno
1977 * else a 16-bit unsigned "word" received from the device.
1978 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01001979s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980{
1981 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001982 int status;
1983
1984 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1985 I2C_SMBUS_READ, command,
1986 I2C_SMBUS_WORD_DATA, &data);
1987 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988}
David Brownellc0564602007-05-01 23:26:31 +02001989EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
David Brownella1cdeda2008-07-14 22:38:24 +02001991/**
1992 * i2c_smbus_write_word_data - SMBus "write word" protocol
1993 * @client: Handle to slave device
1994 * @command: Byte interpreted by slave
1995 * @value: 16-bit "word" being written
1996 *
1997 * This executes the SMBus "write word" protocol, returning negative errno
1998 * else zero on success.
1999 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002000s32 i2c_smbus_write_word_data(const struct i2c_client *client, u8 command,
2001 u16 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002{
2003 union i2c_smbus_data data;
2004 data.word = value;
Farid Hammane7225acf2010-05-21 18:40:58 +02002005 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2006 I2C_SMBUS_WRITE, command,
2007 I2C_SMBUS_WORD_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008}
David Brownellc0564602007-05-01 23:26:31 +02002009EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010
David Brownella64ec072007-10-13 23:56:31 +02002011/**
David Brownella1cdeda2008-07-14 22:38:24 +02002012 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02002013 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02002014 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02002015 * @values: Byte array into which data will be read; big enough to hold
2016 * the data returned by the slave. SMBus allows at most 32 bytes.
2017 *
David Brownella1cdeda2008-07-14 22:38:24 +02002018 * This executes the SMBus "block read" protocol, returning negative errno
2019 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02002020 *
2021 * Note that using this function requires that the client's adapter support
2022 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
2023 * support this; its emulation through I2C messaging relies on a specific
2024 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
2025 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002026s32 i2c_smbus_read_block_data(const struct i2c_client *client, u8 command,
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002027 u8 *values)
2028{
2029 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002030 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002031
David Brownell24a5bb72008-07-14 22:38:23 +02002032 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2033 I2C_SMBUS_READ, command,
2034 I2C_SMBUS_BLOCK_DATA, &data);
2035 if (status)
2036 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002037
2038 memcpy(values, &data.block[1], data.block[0]);
2039 return data.block[0];
2040}
2041EXPORT_SYMBOL(i2c_smbus_read_block_data);
2042
David Brownella1cdeda2008-07-14 22:38:24 +02002043/**
2044 * i2c_smbus_write_block_data - SMBus "block write" protocol
2045 * @client: Handle to slave device
2046 * @command: Byte interpreted by slave
2047 * @length: Size of data block; SMBus allows at most 32 bytes
2048 * @values: Byte array which will be written.
2049 *
2050 * This executes the SMBus "block write" protocol, returning negative errno
2051 * else zero on success.
2052 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002053s32 i2c_smbus_write_block_data(const struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02002054 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055{
2056 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01002057
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 if (length > I2C_SMBUS_BLOCK_MAX)
2059 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01002061 memcpy(&data.block[1], values, length);
Farid Hammane7225acf2010-05-21 18:40:58 +02002062 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2063 I2C_SMBUS_WRITE, command,
2064 I2C_SMBUS_BLOCK_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065}
David Brownellc0564602007-05-01 23:26:31 +02002066EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067
2068/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002069s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, u8 command,
Jean Delvare4b2643d2007-07-12 14:12:29 +02002070 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071{
2072 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002073 int status;
Jean Delvare76560322006-01-18 23:14:55 +01002074
Jean Delvare4b2643d2007-07-12 14:12:29 +02002075 if (length > I2C_SMBUS_BLOCK_MAX)
2076 length = I2C_SMBUS_BLOCK_MAX;
2077 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02002078 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2079 I2C_SMBUS_READ, command,
2080 I2C_SMBUS_I2C_BLOCK_DATA, &data);
2081 if (status < 0)
2082 return status;
Jean Delvare76560322006-01-18 23:14:55 +01002083
2084 memcpy(values, &data.block[1], data.block[0]);
2085 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086}
David Brownellc0564602007-05-01 23:26:31 +02002087EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088
Jean Delvare0cc43a12011-01-10 22:11:23 +01002089s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02002090 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11002091{
2092 union i2c_smbus_data data;
2093
2094 if (length > I2C_SMBUS_BLOCK_MAX)
2095 length = I2C_SMBUS_BLOCK_MAX;
2096 data.block[0] = length;
2097 memcpy(data.block + 1, values, length);
2098 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2099 I2C_SMBUS_WRITE, command,
2100 I2C_SMBUS_I2C_BLOCK_DATA, &data);
2101}
David Brownellc0564602007-05-01 23:26:31 +02002102EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11002103
David Brownell438d6c22006-12-10 21:21:31 +01002104/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 No checking of parameters is done! */
Farid Hammane7225acf2010-05-21 18:40:58 +02002106static s32 i2c_smbus_xfer_emulated(struct i2c_adapter *adapter, u16 addr,
2107 unsigned short flags,
2108 char read_write, u8 command, int size,
2109 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110{
2111 /* So we need to generate a series of msgs. In the case of writing, we
2112 need to use only one message; when reading, we need two. We initialize
2113 most things with sane defaults, to keep the code below somewhat
2114 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02002115 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
2116 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Farid Hammane7225acf2010-05-21 18:40:58 +02002117 int num = read_write == I2C_SMBUS_READ ? 2 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02002119 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02002120 int status;
Shubhrajyoti D230da092012-10-05 22:23:52 +02002121 struct i2c_msg msg[2] = {
2122 {
2123 .addr = addr,
2124 .flags = flags,
2125 .len = 1,
2126 .buf = msgbuf0,
2127 }, {
2128 .addr = addr,
2129 .flags = flags | I2C_M_RD,
2130 .len = 0,
2131 .buf = msgbuf1,
2132 },
2133 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134
2135 msgbuf0[0] = command;
Farid Hammane7225acf2010-05-21 18:40:58 +02002136 switch (size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 case I2C_SMBUS_QUICK:
2138 msg[0].len = 0;
2139 /* Special case: The read/write field is used as data */
Roel Kluinf29d2e02009-02-24 19:19:48 +01002140 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
2141 I2C_M_RD : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 num = 1;
2143 break;
2144 case I2C_SMBUS_BYTE:
2145 if (read_write == I2C_SMBUS_READ) {
2146 /* Special case: only a read! */
2147 msg[0].flags = I2C_M_RD | flags;
2148 num = 1;
2149 }
2150 break;
2151 case I2C_SMBUS_BYTE_DATA:
2152 if (read_write == I2C_SMBUS_READ)
2153 msg[1].len = 1;
2154 else {
2155 msg[0].len = 2;
2156 msgbuf0[1] = data->byte;
2157 }
2158 break;
2159 case I2C_SMBUS_WORD_DATA:
2160 if (read_write == I2C_SMBUS_READ)
2161 msg[1].len = 2;
2162 else {
Farid Hammane7225acf2010-05-21 18:40:58 +02002163 msg[0].len = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02002165 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 }
2167 break;
2168 case I2C_SMBUS_PROC_CALL:
2169 num = 2; /* Special case */
2170 read_write = I2C_SMBUS_READ;
2171 msg[0].len = 3;
2172 msg[1].len = 2;
2173 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02002174 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 break;
2176 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02002178 msg[1].flags |= I2C_M_RECV_LEN;
2179 msg[1].len = 1; /* block length will be added by
2180 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 } else {
2182 msg[0].len = data->block[0] + 2;
2183 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02002184 dev_err(&adapter->dev,
2185 "Invalid block write size %d\n",
2186 data->block[0]);
2187 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02002189 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 msgbuf0[i] = data->block[i-1];
2191 }
2192 break;
2193 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02002194 num = 2; /* Another special case */
2195 read_write = I2C_SMBUS_READ;
2196 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02002197 dev_err(&adapter->dev,
2198 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02002199 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02002200 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02002201 }
2202 msg[0].len = data->block[0] + 2;
2203 for (i = 1; i < msg[0].len; i++)
2204 msgbuf0[i] = data->block[i-1];
2205 msg[1].flags |= I2C_M_RECV_LEN;
2206 msg[1].len = 1; /* block length will be added by
2207 the underlying bus driver */
2208 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 case I2C_SMBUS_I2C_BLOCK_DATA:
2210 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02002211 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 } else {
2213 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02002214 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02002215 dev_err(&adapter->dev,
2216 "Invalid block write size %d\n",
2217 data->block[0]);
2218 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 }
2220 for (i = 1; i <= data->block[0]; i++)
2221 msgbuf0[i] = data->block[i];
2222 }
2223 break;
2224 default:
David Brownell24a5bb72008-07-14 22:38:23 +02002225 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
2226 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 }
2228
Jean Delvare421ef472005-10-26 21:28:55 +02002229 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
2230 && size != I2C_SMBUS_I2C_BLOCK_DATA);
2231 if (i) {
2232 /* Compute PEC if first message is a write */
2233 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01002234 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02002235 i2c_smbus_add_pec(&msg[0]);
2236 else /* Write followed by read */
2237 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
2238 }
2239 /* Ask for PEC if last message is a read */
2240 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01002241 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02002242 }
2243
David Brownell24a5bb72008-07-14 22:38:23 +02002244 status = i2c_transfer(adapter, msg, num);
2245 if (status < 0)
2246 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
Jean Delvare421ef472005-10-26 21:28:55 +02002248 /* Check PEC if last message is a read */
2249 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02002250 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
2251 if (status < 0)
2252 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02002253 }
2254
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 if (read_write == I2C_SMBUS_READ)
Farid Hammane7225acf2010-05-21 18:40:58 +02002256 switch (size) {
2257 case I2C_SMBUS_BYTE:
2258 data->byte = msgbuf0[0];
2259 break;
2260 case I2C_SMBUS_BYTE_DATA:
2261 data->byte = msgbuf1[0];
2262 break;
2263 case I2C_SMBUS_WORD_DATA:
2264 case I2C_SMBUS_PROC_CALL:
2265 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
2266 break;
2267 case I2C_SMBUS_I2C_BLOCK_DATA:
2268 for (i = 0; i < data->block[0]; i++)
2269 data->block[i+1] = msgbuf1[i];
2270 break;
2271 case I2C_SMBUS_BLOCK_DATA:
2272 case I2C_SMBUS_BLOCK_PROC_CALL:
2273 for (i = 0; i < msgbuf1[0] + 1; i++)
2274 data->block[i] = msgbuf1[i];
2275 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 }
2277 return 0;
2278}
2279
David Brownella1cdeda2008-07-14 22:38:24 +02002280/**
2281 * i2c_smbus_xfer - execute SMBus protocol operations
2282 * @adapter: Handle to I2C bus
2283 * @addr: Address of SMBus slave on that bus
2284 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
2285 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
2286 * @command: Byte interpreted by slave, for protocols which use such bytes
2287 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
2288 * @data: Data to be read or written
2289 *
2290 * This executes an SMBus protocol operation, and returns a negative
2291 * errno code else zero on success.
2292 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01002293s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02002294 char read_write, u8 command, int protocol,
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01002295 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296{
Clifford Wolf66b650f2009-06-15 18:01:46 +02002297 unsigned long orig_jiffies;
2298 int try;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300
Laurent Pinchartd47726c2012-07-24 14:13:59 +02002301 flags &= I2C_M_TEN | I2C_CLIENT_PEC | I2C_CLIENT_SCCB;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302
2303 if (adapter->algo->smbus_xfer) {
Jean Delvarefe61e072010-08-11 18:20:58 +02002304 i2c_lock_adapter(adapter);
Clifford Wolf66b650f2009-06-15 18:01:46 +02002305
2306 /* Retry automatically on arbitration loss */
2307 orig_jiffies = jiffies;
2308 for (res = 0, try = 0; try <= adapter->retries; try++) {
2309 res = adapter->algo->smbus_xfer(adapter, addr, flags,
2310 read_write, command,
2311 protocol, data);
2312 if (res != -EAGAIN)
2313 break;
2314 if (time_after(jiffies,
2315 orig_jiffies + adapter->timeout))
2316 break;
2317 }
Jean Delvarefe61e072010-08-11 18:20:58 +02002318 i2c_unlock_adapter(adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319
Laurent Pinchart72fc2c72012-07-24 14:13:59 +02002320 if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
2321 return res;
2322 /*
2323 * Fall back to i2c_smbus_xfer_emulated if the adapter doesn't
2324 * implement native support for the SMBus operation.
2325 */
2326 }
2327
2328 return i2c_smbus_xfer_emulated(adapter, addr, flags, read_write,
2329 command, protocol, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332
2333MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2334MODULE_DESCRIPTION("I2C-Bus main module");
2335MODULE_LICENSE("GPL");