blob: e361033815d3ffe8cb2e537d2b39862051ea308c [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
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
18/* ------------------------------------------------------------------------- */
19
Jan Engelhardt96de0e22007-10-19 23:21:04 +020020/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
Jean Delvare421ef472005-10-26 21:28:55 +020022 SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
23 Jean Delvare <khali@linux-fr.org> */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/module.h>
26#include <linux/kernel.h>
27#include <linux/errno.h>
28#include <linux/slab.h>
29#include <linux/i2c.h>
30#include <linux/init.h>
31#include <linux/idr.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010032#include <linux/platform_device.h>
Arjan van de Venb3585e42006-01-11 10:50:26 +010033#include <linux/mutex.h>
Jean Delvareb8d6f452007-02-13 22:09:00 +010034#include <linux/completion.h>
Mike Rapoportcea443a82008-01-27 18:14:50 +010035#include <linux/hardirq.h>
36#include <linux/irqflags.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <asm/uaccess.h>
38
David Brownell9c1600e2007-05-01 23:26:31 +020039#include "i2c-core.h"
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Jean Delvarecaada322008-01-27 18:14:49 +010042static DEFINE_MUTEX(core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043static DEFINE_IDR(i2c_adapter_idr);
44
Jean Delvare4735c982008-07-14 22:38:36 +020045#define is_newstyle_driver(d) ((d)->probe || (d)->remove || (d)->detect)
46
47static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
David Brownellf37dd802007-02-13 22:09:00 +010048
49/* ------------------------------------------------------------------------- */
50
Jean Delvared2653e92008-04-29 23:11:39 +020051static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
52 const struct i2c_client *client)
53{
54 while (id->name[0]) {
55 if (strcmp(client->name, id->name) == 0)
56 return id;
57 id++;
58 }
59 return NULL;
60}
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062static int i2c_device_match(struct device *dev, struct device_driver *drv)
63{
David Brownell7b4fbc52007-05-01 23:26:30 +020064 struct i2c_client *client = to_i2c_client(dev);
65 struct i2c_driver *driver = to_i2c_driver(drv);
66
67 /* make legacy i2c drivers bypass driver model probing entirely;
68 * such drivers scan each i2c adapter/bus themselves.
69 */
David Brownella1d9e6e2007-05-01 23:26:30 +020070 if (!is_newstyle_driver(driver))
David Brownell7b4fbc52007-05-01 23:26:30 +020071 return 0;
72
Jean Delvared2653e92008-04-29 23:11:39 +020073 /* match on an id table if there is one */
74 if (driver->id_table)
75 return i2c_match_id(driver->id_table, client) != NULL;
76
Jean Delvareeb8a7902008-05-18 20:49:41 +020077 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078}
79
David Brownell7b4fbc52007-05-01 23:26:30 +020080#ifdef CONFIG_HOTPLUG
81
82/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +020083static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +020084{
85 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +020086
87 /* by definition, legacy drivers can't hotplug */
Jean Delvared2653e92008-04-29 23:11:39 +020088 if (dev->driver)
David Brownell7b4fbc52007-05-01 23:26:30 +020089 return 0;
90
Jean Delvareeb8a7902008-05-18 20:49:41 +020091 if (add_uevent_var(env, "MODALIAS=%s%s",
92 I2C_MODULE_PREFIX, client->name))
93 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +020094 dev_dbg(dev, "uevent\n");
95 return 0;
96}
97
98#else
99#define i2c_device_uevent NULL
100#endif /* CONFIG_HOTPLUG */
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102static int i2c_device_probe(struct device *dev)
103{
David Brownell7b4fbc52007-05-01 23:26:30 +0200104 struct i2c_client *client = to_i2c_client(dev);
105 struct i2c_driver *driver = to_i2c_driver(dev->driver);
Hans Verkuil50c33042008-03-12 14:15:00 +0100106 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200107
Jean Delvaree0457442008-07-14 22:38:30 +0200108 if (!driver->probe || !driver->id_table)
David Brownell7b4fbc52007-05-01 23:26:30 +0200109 return -ENODEV;
110 client->driver = driver;
Marc Pignatee354252008-08-28 08:33:22 +0200111 if (!device_can_wakeup(&client->dev))
112 device_init_wakeup(&client->dev,
113 client->flags & I2C_CLIENT_WAKE);
David Brownell7b4fbc52007-05-01 23:26:30 +0200114 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200115
Jean Delvaree0457442008-07-14 22:38:30 +0200116 status = driver->probe(client, i2c_match_id(driver->id_table, client));
Hans Verkuil50c33042008-03-12 14:15:00 +0100117 if (status)
118 client->driver = NULL;
119 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120}
121
122static int i2c_device_remove(struct device *dev)
123{
David Brownella1d9e6e2007-05-01 23:26:30 +0200124 struct i2c_client *client = to_i2c_client(dev);
125 struct i2c_driver *driver;
126 int status;
127
128 if (!dev->driver)
129 return 0;
130
131 driver = to_i2c_driver(dev->driver);
132 if (driver->remove) {
133 dev_dbg(dev, "remove\n");
134 status = driver->remove(client);
135 } else {
136 dev->driver = NULL;
137 status = 0;
138 }
139 if (status == 0)
140 client->driver = NULL;
141 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142}
143
David Brownellf37dd802007-02-13 22:09:00 +0100144static void i2c_device_shutdown(struct device *dev)
145{
146 struct i2c_driver *driver;
147
148 if (!dev->driver)
149 return;
150 driver = to_i2c_driver(dev->driver);
151 if (driver->shutdown)
152 driver->shutdown(to_i2c_client(dev));
153}
154
155static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
156{
157 struct i2c_driver *driver;
158
159 if (!dev->driver)
160 return 0;
161 driver = to_i2c_driver(dev->driver);
162 if (!driver->suspend)
163 return 0;
164 return driver->suspend(to_i2c_client(dev), mesg);
165}
166
167static int i2c_device_resume(struct device * dev)
168{
169 struct i2c_driver *driver;
170
171 if (!dev->driver)
172 return 0;
173 driver = to_i2c_driver(dev->driver);
174 if (!driver->resume)
175 return 0;
176 return driver->resume(to_i2c_client(dev));
177}
178
David Brownell7b4fbc52007-05-01 23:26:30 +0200179static void i2c_client_release(struct device *dev)
180{
181 struct i2c_client *client = to_i2c_client(dev);
182 complete(&client->released);
183}
184
David Brownell9c1600e2007-05-01 23:26:31 +0200185static void i2c_client_dev_release(struct device *dev)
186{
187 kfree(to_i2c_client(dev));
188}
189
David Brownell7b4fbc52007-05-01 23:26:30 +0200190static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
191{
192 struct i2c_client *client = to_i2c_client(dev);
193 return sprintf(buf, "%s\n", client->name);
194}
195
196static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
197{
198 struct i2c_client *client = to_i2c_client(dev);
Jean Delvareeb8a7902008-05-18 20:49:41 +0200199 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200200}
201
202static struct device_attribute i2c_dev_attrs[] = {
203 __ATTR(name, S_IRUGO, show_client_name, NULL),
204 /* modalias helps coldplug: modprobe $(cat .../modalias) */
205 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
206 { },
207};
208
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200209struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100210 .name = "i2c",
David Brownell7b4fbc52007-05-01 23:26:30 +0200211 .dev_attrs = i2c_dev_attrs,
David Brownellf37dd802007-02-13 22:09:00 +0100212 .match = i2c_device_match,
David Brownell7b4fbc52007-05-01 23:26:30 +0200213 .uevent = i2c_device_uevent,
David Brownellf37dd802007-02-13 22:09:00 +0100214 .probe = i2c_device_probe,
215 .remove = i2c_device_remove,
216 .shutdown = i2c_device_shutdown,
217 .suspend = i2c_device_suspend,
218 .resume = i2c_device_resume,
Russell Kingb864c7d2006-01-05 14:37:50 +0000219};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200220EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000221
David Brownell9b766b82008-01-27 18:14:51 +0100222
223/**
224 * i2c_verify_client - return parameter as i2c_client, or NULL
225 * @dev: device, probably from some driver model iterator
226 *
227 * When traversing the driver model tree, perhaps using driver model
228 * iterators like @device_for_each_child(), you can't assume very much
229 * about the nodes you find. Use this function to avoid oopses caused
230 * by wrongly treating some non-I2C device as an i2c_client.
231 */
232struct i2c_client *i2c_verify_client(struct device *dev)
233{
234 return (dev->bus == &i2c_bus_type)
235 ? to_i2c_client(dev)
236 : NULL;
237}
238EXPORT_SYMBOL(i2c_verify_client);
239
240
David Brownell9c1600e2007-05-01 23:26:31 +0200241/**
242 * i2c_new_device - instantiate an i2c device for use with a new style driver
243 * @adap: the adapter managing the device
244 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200245 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200246 *
247 * Create a device to work with a new style i2c driver, where binding is
248 * handled through driver model probe()/remove() methods. This call is not
249 * appropriate for use by mainboad initialization logic, which usually runs
250 * during an arch_initcall() long before any i2c_adapter could exist.
251 *
252 * This returns the new i2c client, which may be saved for later use with
253 * i2c_unregister_device(); or NULL to indicate an error.
254 */
255struct i2c_client *
256i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
257{
258 struct i2c_client *client;
259 int status;
260
261 client = kzalloc(sizeof *client, GFP_KERNEL);
262 if (!client)
263 return NULL;
264
265 client->adapter = adap;
266
267 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200268
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200269 if (info->archdata)
270 client->dev.archdata = *info->archdata;
271
Marc Pignatee354252008-08-28 08:33:22 +0200272 client->flags = info->flags;
David Brownell9c1600e2007-05-01 23:26:31 +0200273 client->addr = info->addr;
274 client->irq = info->irq;
275
David Brownell9c1600e2007-05-01 23:26:31 +0200276 strlcpy(client->name, info->type, sizeof(client->name));
277
278 /* a new style driver may be bound to this device when we
279 * return from this function, or any later moment (e.g. maybe
280 * hotplugging will load the driver module). and the device
281 * refcount model is the standard driver model one.
282 */
283 status = i2c_attach_client(client);
284 if (status < 0) {
285 kfree(client);
286 client = NULL;
287 }
288 return client;
289}
290EXPORT_SYMBOL_GPL(i2c_new_device);
291
292
293/**
294 * i2c_unregister_device - reverse effect of i2c_new_device()
295 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200296 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200297 */
298void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200299{
300 struct i2c_adapter *adapter = client->adapter;
301 struct i2c_driver *driver = client->driver;
302
303 if (driver && !is_newstyle_driver(driver)) {
304 dev_err(&client->dev, "can't unregister devices "
305 "with legacy drivers\n");
306 WARN_ON(1);
307 return;
308 }
309
Jean Delvare85081592008-07-14 22:38:36 +0200310 if (adapter->client_unregister) {
311 if (adapter->client_unregister(client)) {
312 dev_warn(&client->dev,
313 "client_unregister [%s] failed\n",
314 client->name);
315 }
316 }
317
David Brownella1d9e6e2007-05-01 23:26:30 +0200318 mutex_lock(&adapter->clist_lock);
319 list_del(&client->list);
320 mutex_unlock(&adapter->clist_lock);
321
322 device_unregister(&client->dev);
323}
David Brownell9c1600e2007-05-01 23:26:31 +0200324EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200325
326
Jean Delvare60b129d2008-05-11 20:37:06 +0200327static const struct i2c_device_id dummy_id[] = {
328 { "dummy", 0 },
329 { },
330};
331
Jean Delvared2653e92008-04-29 23:11:39 +0200332static int dummy_probe(struct i2c_client *client,
333 const struct i2c_device_id *id)
334{
335 return 0;
336}
337
338static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100339{
340 return 0;
341}
342
343static struct i2c_driver dummy_driver = {
344 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200345 .probe = dummy_probe,
346 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200347 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100348};
349
350/**
351 * i2c_new_dummy - return a new i2c device bound to a dummy driver
352 * @adapter: the adapter managing the device
353 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100354 * Context: can sleep
355 *
356 * This returns an I2C client bound to the "dummy" driver, intended for use
357 * with devices that consume multiple addresses. Examples of such chips
358 * include various EEPROMS (like 24c04 and 24c08 models).
359 *
360 * These dummy devices have two main uses. First, most I2C and SMBus calls
361 * except i2c_transfer() need a client handle; the dummy will be that handle.
362 * And second, this prevents the specified address from being bound to a
363 * different driver.
364 *
365 * This returns the new i2c client, which should be saved for later use with
366 * i2c_unregister_device(); or NULL to indicate an error.
367 */
368struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200369i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100370{
371 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200372 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100373 };
374
David Brownelle9f13732008-01-27 18:14:52 +0100375 return i2c_new_device(adapter, &info);
376}
377EXPORT_SYMBOL_GPL(i2c_new_dummy);
378
David Brownellf37dd802007-02-13 22:09:00 +0100379/* ------------------------------------------------------------------------- */
380
David Brownell16ffadf2007-05-01 23:26:28 +0200381/* I2C bus adapters -- one roots each I2C or SMBUS segment */
382
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200383static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384{
David Brownellef2c83212007-05-01 23:26:28 +0200385 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 complete(&adap->dev_released);
387}
388
David Brownell16ffadf2007-05-01 23:26:28 +0200389static ssize_t
390show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391{
David Brownellef2c83212007-05-01 23:26:28 +0200392 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 return sprintf(buf, "%s\n", adap->name);
394}
David Brownell16ffadf2007-05-01 23:26:28 +0200395
396static struct device_attribute i2c_adapter_attrs[] = {
397 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
398 { },
399};
400
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200401static struct class i2c_adapter_class = {
David Brownell16ffadf2007-05-01 23:26:28 +0200402 .owner = THIS_MODULE,
403 .name = "i2c-adapter",
404 .dev_attrs = i2c_adapter_attrs,
405};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
David Brownell9c1600e2007-05-01 23:26:31 +0200407static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
408{
409 struct i2c_devinfo *devinfo;
410
411 mutex_lock(&__i2c_board_lock);
412 list_for_each_entry(devinfo, &__i2c_board_list, list) {
413 if (devinfo->busnum == adapter->nr
414 && !i2c_new_device(adapter,
415 &devinfo->board_info))
416 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
417 i2c_adapter_id(adapter),
418 devinfo->board_info.addr);
419 }
420 mutex_unlock(&__i2c_board_lock);
421}
422
Jean Delvare026526f2008-01-27 18:14:49 +0100423static int i2c_do_add_adapter(struct device_driver *d, void *data)
424{
425 struct i2c_driver *driver = to_i2c_driver(d);
426 struct i2c_adapter *adap = data;
427
Jean Delvare4735c982008-07-14 22:38:36 +0200428 /* Detect supported devices on that bus, and instantiate them */
429 i2c_detect(adap, driver);
430
431 /* Let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +0100432 if (driver->attach_adapter) {
433 /* We ignore the return code; if it fails, too bad */
434 driver->attach_adapter(adap);
435 }
436 return 0;
437}
438
David Brownell6e13e642007-05-01 23:26:31 +0200439static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
Jean Delvare026526f2008-01-27 18:14:49 +0100441 int res = 0, dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
David Brownell1d0b19c2008-10-14 17:30:05 +0200443 /* Can't register until after driver model init */
444 if (unlikely(WARN_ON(!i2c_bus_type.p)))
445 return -EAGAIN;
446
Ingo Molnar5c085d32006-01-18 23:16:04 +0100447 mutex_init(&adap->bus_lock);
448 mutex_init(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 INIT_LIST_HEAD(&adap->clients);
450
Jean Delvarecaada322008-01-27 18:14:49 +0100451 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200452
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 /* Add the adapter to the driver core.
454 * If the parent pointer is not set up,
455 * we add this adapter to the host bus.
456 */
David Brownellb119dc32007-01-04 13:07:04 +0100457 if (adap->dev.parent == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 adap->dev.parent = &platform_bus;
Jean Delvarefe2c8d52007-02-13 22:09:04 +0100459 pr_debug("I2C adapter driver [%s] forgot to specify "
460 "physical device\n", adap->name);
David Brownellb119dc32007-01-04 13:07:04 +0100461 }
Jean Delvare8fcfef62009-03-28 21:34:43 +0100462
463 /* Set default timeout to 1 second if not already set */
464 if (adap->timeout == 0)
465 adap->timeout = HZ;
466
Kay Sievers27d9c182009-01-07 14:29:16 +0100467 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 adap->dev.release = &i2c_adapter_dev_release;
Jean Delvarefccb56e2007-05-01 23:26:27 +0200469 adap->dev.class = &i2c_adapter_class;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200470 res = device_register(&adap->dev);
471 if (res)
472 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200474 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
475
David Brownell6e13e642007-05-01 23:26:31 +0200476 /* create pre-declared device nodes for new-style drivers */
477 if (adap->nr < __i2c_first_dynamic_bus_num)
478 i2c_scan_static_board_info(adap);
479
Jean Delvare4735c982008-07-14 22:38:36 +0200480 /* Notify drivers */
Jean Delvare026526f2008-01-27 18:14:49 +0100481 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
482 i2c_do_add_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100485 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 return res;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200487
Jean Delvareb119c6c2006-08-15 18:26:30 +0200488out_list:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200489 idr_remove(&i2c_adapter_idr, adap->nr);
490 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491}
492
David Brownell6e13e642007-05-01 23:26:31 +0200493/**
494 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
495 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +0200496 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200497 *
498 * This routine is used to declare an I2C adapter when its bus number
499 * doesn't matter. Examples: for I2C adapters dynamically added by
500 * USB links or PCI plugin cards.
501 *
502 * When this returns zero, a new bus number was allocated and stored
503 * in adap->nr, and the specified adapter became available for clients.
504 * Otherwise, a negative errno value is returned.
505 */
506int i2c_add_adapter(struct i2c_adapter *adapter)
507{
508 int id, res = 0;
509
510retry:
511 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
512 return -ENOMEM;
513
Jean Delvarecaada322008-01-27 18:14:49 +0100514 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200515 /* "above" here means "above or equal to", sigh */
516 res = idr_get_new_above(&i2c_adapter_idr, adapter,
517 __i2c_first_dynamic_bus_num, &id);
Jean Delvarecaada322008-01-27 18:14:49 +0100518 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200519
520 if (res < 0) {
521 if (res == -EAGAIN)
522 goto retry;
523 return res;
524 }
525
526 adapter->nr = id;
527 return i2c_register_adapter(adapter);
528}
529EXPORT_SYMBOL(i2c_add_adapter);
530
531/**
532 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
533 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +0200534 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200535 *
536 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +0100537 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
538 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +0200539 * is used to properly configure I2C devices.
540 *
541 * If no devices have pre-been declared for this bus, then be sure to
542 * register the adapter before any dynamically allocated ones. Otherwise
543 * the required bus ID may not be available.
544 *
545 * When this returns zero, the specified adapter became available for
546 * clients using the bus number provided in adap->nr. Also, the table
547 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
548 * and the appropriate driver model device nodes are created. Otherwise, a
549 * negative errno value is returned.
550 */
551int i2c_add_numbered_adapter(struct i2c_adapter *adap)
552{
553 int id;
554 int status;
555
556 if (adap->nr & ~MAX_ID_MASK)
557 return -EINVAL;
558
559retry:
560 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
561 return -ENOMEM;
562
Jean Delvarecaada322008-01-27 18:14:49 +0100563 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200564 /* "above" here means "above or equal to", sigh;
565 * we need the "equal to" result to force the result
566 */
567 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
568 if (status == 0 && id != adap->nr) {
569 status = -EBUSY;
570 idr_remove(&i2c_adapter_idr, id);
571 }
Jean Delvarecaada322008-01-27 18:14:49 +0100572 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200573 if (status == -EAGAIN)
574 goto retry;
575
576 if (status == 0)
577 status = i2c_register_adapter(adap);
578 return status;
579}
580EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
581
Jean Delvare026526f2008-01-27 18:14:49 +0100582static int i2c_do_del_adapter(struct device_driver *d, void *data)
583{
584 struct i2c_driver *driver = to_i2c_driver(d);
585 struct i2c_adapter *adapter = data;
Jean Delvare4735c982008-07-14 22:38:36 +0200586 struct i2c_client *client, *_n;
Jean Delvare026526f2008-01-27 18:14:49 +0100587 int res;
588
Jean Delvareacec2112009-03-28 21:34:40 +0100589 /* Remove the devices we created ourselves as the result of hardware
590 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +0200591 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
592 if (client->adapter == adapter) {
593 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
594 client->name, client->addr);
595 list_del(&client->detected);
596 i2c_unregister_device(client);
597 }
598 }
599
Jean Delvare026526f2008-01-27 18:14:49 +0100600 if (!driver->detach_adapter)
601 return 0;
602 res = driver->detach_adapter(adapter);
603 if (res)
604 dev_err(&adapter->dev, "detach_adapter failed (%d) "
605 "for driver [%s]\n", res, driver->driver.name);
606 return res;
607}
608
David Brownelld64f73b2007-07-12 14:12:28 +0200609/**
610 * i2c_del_adapter - unregister I2C adapter
611 * @adap: the adapter being unregistered
612 * Context: can sleep
613 *
614 * This unregisters an I2C adapter which was previously registered
615 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
616 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617int i2c_del_adapter(struct i2c_adapter *adap)
618{
Matthias Kaehlcke6a03cd932008-07-14 22:38:26 +0200619 struct i2c_client *client, *_n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 int res = 0;
621
Jean Delvarecaada322008-01-27 18:14:49 +0100622 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
624 /* First make sure that this adapter was ever added */
Jean Delvare87c6c222008-01-27 18:14:48 +0100625 if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200626 pr_debug("i2c-core: attempting to delete unregistered "
627 "adapter [%s]\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 res = -EINVAL;
629 goto out_unlock;
630 }
631
Jean Delvare026526f2008-01-27 18:14:49 +0100632 /* Tell drivers about this removal */
633 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
634 i2c_do_del_adapter);
635 if (res)
636 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
638 /* detach any active clients. This must be done first, because
Tobias Klausera551acc2005-05-19 21:40:38 +0200639 * it can fail; in which case we give up. */
Jean Delvare79b93e12008-11-28 15:24:38 +0100640 list_for_each_entry_safe_reverse(client, _n, &adap->clients, list) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200641 struct i2c_driver *driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
David Brownella1d9e6e2007-05-01 23:26:30 +0200643 driver = client->driver;
644
645 /* new style, follow standard driver model */
646 if (!driver || is_newstyle_driver(driver)) {
647 i2c_unregister_device(client);
648 continue;
649 }
650
651 /* legacy drivers create and remove clients themselves */
652 if ((res = driver->detach_client(client))) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200653 dev_err(&adap->dev, "detach_client failed for client "
654 "[%s] at address 0x%02x\n", client->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 client->addr);
656 goto out_unlock;
657 }
658 }
659
660 /* clean up the sysfs representation */
661 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
664 /* wait for sysfs to drop all references */
665 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
David Brownell6e13e642007-05-01 23:26:31 +0200667 /* free bus id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 idr_remove(&i2c_adapter_idr, adap->nr);
669
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200670 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
Jean Delvarebd4bc3db2008-07-16 19:30:05 +0200672 /* Clear the device structure in case this adapter is ever going to be
673 added again */
674 memset(&adap->dev, 0, sizeof(adap->dev));
675
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100677 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 return res;
679}
David Brownellc0564602007-05-01 23:26:31 +0200680EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
682
David Brownell7b4fbc52007-05-01 23:26:30 +0200683/* ------------------------------------------------------------------------- */
684
Dave Young7f101a92008-07-14 22:38:19 +0200685static int __attach_adapter(struct device *dev, void *data)
686{
687 struct i2c_adapter *adapter = to_i2c_adapter(dev);
688 struct i2c_driver *driver = data;
689
Jean Delvare4735c982008-07-14 22:38:36 +0200690 i2c_detect(adapter, driver);
691
692 /* Legacy drivers scan i2c busses directly */
693 if (driver->attach_adapter)
694 driver->attach_adapter(adapter);
Dave Young7f101a92008-07-14 22:38:19 +0200695
696 return 0;
697}
698
David Brownell7b4fbc52007-05-01 23:26:30 +0200699/*
700 * An i2c_driver is used with one or more i2c_client (device) nodes to access
701 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
702 * are two models for binding the driver to its device: "new style" drivers
703 * follow the standard Linux driver model and just respond to probe() calls
704 * issued if the driver core sees they match(); "legacy" drivers create device
705 * nodes themselves.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 */
707
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800708int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709{
Jean Delvare7eebcb72006-02-05 23:28:21 +0100710 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
David Brownell1d0b19c2008-10-14 17:30:05 +0200712 /* Can't register until after driver model init */
713 if (unlikely(WARN_ON(!i2c_bus_type.p)))
714 return -EAGAIN;
715
David Brownell7b4fbc52007-05-01 23:26:30 +0200716 /* new style driver methods can't mix with legacy ones */
David Brownella1d9e6e2007-05-01 23:26:30 +0200717 if (is_newstyle_driver(driver)) {
David Brownell7b4fbc52007-05-01 23:26:30 +0200718 if (driver->attach_adapter || driver->detach_adapter
719 || driver->detach_client) {
720 printk(KERN_WARNING
721 "i2c-core: driver [%s] is confused\n",
722 driver->driver.name);
723 return -EINVAL;
724 }
725 }
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800728 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
David Brownell6e13e642007-05-01 23:26:31 +0200731 /* for new style drivers, when registration returns the driver core
732 * will have called probe() for all matching-but-unbound devices.
733 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 res = driver_register(&driver->driver);
735 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +0100736 return res;
David Brownell438d6c22006-12-10 21:21:31 +0100737
Jean Delvarecaada322008-01-27 18:14:49 +0100738 mutex_lock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100739
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100740 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
Jean Delvare4735c982008-07-14 22:38:36 +0200742 INIT_LIST_HEAD(&driver->clients);
743 /* Walk the adapters that are already present */
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400744 class_for_each_device(&i2c_adapter_class, NULL, driver,
745 __attach_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
Jean Delvarecaada322008-01-27 18:14:49 +0100747 mutex_unlock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100748 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800750EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Dave Young7f101a92008-07-14 22:38:19 +0200752static int __detach_adapter(struct device *dev, void *data)
753{
754 struct i2c_adapter *adapter = to_i2c_adapter(dev);
755 struct i2c_driver *driver = data;
Jean Delvare4735c982008-07-14 22:38:36 +0200756 struct i2c_client *client, *_n;
757
Jean Delvareacec2112009-03-28 21:34:40 +0100758 /* Remove the devices we created ourselves as the result of hardware
759 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +0200760 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
761 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
762 client->name, client->addr);
763 list_del(&client->detected);
764 i2c_unregister_device(client);
765 }
766
767 if (is_newstyle_driver(driver))
768 return 0;
Dave Young7f101a92008-07-14 22:38:19 +0200769
770 /* Have a look at each adapter, if clients of this driver are still
771 * attached. If so, detach them to be able to kill the driver
772 * afterwards.
773 */
774 if (driver->detach_adapter) {
775 if (driver->detach_adapter(adapter))
776 dev_err(&adapter->dev,
777 "detach_adapter failed for driver [%s]\n",
778 driver->driver.name);
779 } else {
Matthias Kaehlcke6a03cd932008-07-14 22:38:26 +0200780 struct i2c_client *client, *_n;
Dave Young7f101a92008-07-14 22:38:19 +0200781
Matthias Kaehlcke6a03cd932008-07-14 22:38:26 +0200782 list_for_each_entry_safe(client, _n, &adapter->clients, list) {
Dave Young7f101a92008-07-14 22:38:19 +0200783 if (client->driver != driver)
784 continue;
785 dev_dbg(&adapter->dev,
786 "detaching client [%s] at 0x%02x\n",
787 client->name, client->addr);
788 if (driver->detach_client(client))
789 dev_err(&adapter->dev, "detach_client "
790 "failed for client [%s] at 0x%02x\n",
791 client->name, client->addr);
792 }
793 }
794
795 return 0;
796}
797
David Brownella1d9e6e2007-05-01 23:26:30 +0200798/**
799 * i2c_del_driver - unregister I2C driver
800 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +0200801 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +0200802 */
Jean Delvareb3e82092007-05-01 23:26:32 +0200803void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804{
Jean Delvarecaada322008-01-27 18:14:49 +0100805 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400807 class_for_each_device(&i2c_adapter_class, NULL, driver,
808 __detach_adapter);
David Brownella1d9e6e2007-05-01 23:26:30 +0200809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100811 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
Jean Delvarecaada322008-01-27 18:14:49 +0100813 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814}
David Brownellc0564602007-05-01 23:26:31 +0200815EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816
David Brownell7b4fbc52007-05-01 23:26:30 +0200817/* ------------------------------------------------------------------------- */
818
David Brownell9b766b82008-01-27 18:14:51 +0100819static int __i2c_check_addr(struct device *dev, void *addrp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820{
David Brownell9b766b82008-01-27 18:14:51 +0100821 struct i2c_client *client = i2c_verify_client(dev);
822 int addr = *(int *)addrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
David Brownell9b766b82008-01-27 18:14:51 +0100824 if (client && client->addr == addr)
825 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 return 0;
827}
828
Jean Delvare5e31c2b2007-11-15 19:24:02 +0100829static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
David Brownell9b766b82008-01-27 18:14:51 +0100831 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832}
833
834int i2c_attach_client(struct i2c_client *client)
835{
836 struct i2c_adapter *adapter = client->adapter;
Jean Delvarec1159f92008-08-10 22:56:16 +0200837 int res;
838
839 /* Check for address business */
840 res = i2c_check_addr(adapter, client->addr);
841 if (res)
842 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 client->dev.parent = &client->adapter->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 client->dev.bus = &i2c_bus_type;
David Brownell9c1600e2007-05-01 23:26:31 +0200846
847 if (client->driver)
848 client->dev.driver = &client->driver->driver;
849
David Brownellde81d2a2007-05-22 19:49:16 +0200850 if (client->driver && !is_newstyle_driver(client->driver)) {
David Brownell9c1600e2007-05-01 23:26:31 +0200851 client->dev.release = i2c_client_release;
Ming Leif67f1292009-03-01 21:10:49 +0800852 dev_set_uevent_suppress(&client->dev, 1);
David Brownellde81d2a2007-05-22 19:49:16 +0200853 } else
David Brownell9c1600e2007-05-01 23:26:31 +0200854 client->dev.release = i2c_client_dev_release;
David Brownell438d6c22006-12-10 21:21:31 +0100855
Kay Sievers27d9c182009-01-07 14:29:16 +0100856 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adapter),
857 client->addr);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200858 res = device_register(&client->dev);
859 if (res)
David Brownell86ec5ec2008-01-27 18:14:51 +0100860 goto out_err;
861
862 mutex_lock(&adapter->clist_lock);
863 list_add_tail(&client->list, &adapter->clients);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200864 mutex_unlock(&adapter->clist_lock);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200865
David Brownell86ec5ec2008-01-27 18:14:51 +0100866 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
Kay Sievers27d9c182009-01-07 14:29:16 +0100867 client->name, dev_name(&client->dev));
David Brownell86ec5ec2008-01-27 18:14:51 +0100868
Jean Delvare77ed74d2006-09-30 17:18:59 +0200869 if (adapter->client_register) {
870 if (adapter->client_register(client)) {
871 dev_dbg(&adapter->dev, "client_register "
872 "failed for client [%s] at 0x%02x\n",
873 client->name, client->addr);
874 }
875 }
876
877 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200878
David Brownell86ec5ec2008-01-27 18:14:51 +0100879out_err:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200880 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
881 "(%d)\n", client->name, client->addr, res);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200882 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883}
David Brownellc0564602007-05-01 23:26:31 +0200884EXPORT_SYMBOL(i2c_attach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
886int i2c_detach_client(struct i2c_client *client)
887{
888 struct i2c_adapter *adapter = client->adapter;
889 int res = 0;
David Brownell438d6c22006-12-10 21:21:31 +0100890
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 if (adapter->client_unregister) {
892 res = adapter->client_unregister(client);
893 if (res) {
894 dev_err(&client->dev,
Jean Delvare86749e82005-07-29 12:15:29 -0700895 "client_unregister [%s] failed, "
896 "client not detached\n", client->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 goto out;
898 }
899 }
900
Ingo Molnar5c085d32006-01-18 23:16:04 +0100901 mutex_lock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 list_del(&client->list);
Jean Delvare9ddced12008-01-27 18:14:51 +0100903 mutex_unlock(&adapter->clist_lock);
904
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 init_completion(&client->released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 device_unregister(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 wait_for_completion(&client->released);
908
909 out:
910 return res;
911}
David Brownellc0564602007-05-01 23:26:31 +0200912EXPORT_SYMBOL(i2c_detach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
Jean Delvaree48d3312008-01-27 18:14:48 +0100914/**
915 * i2c_use_client - increments the reference count of the i2c client structure
916 * @client: the client being referenced
917 *
918 * Each live reference to a client should be refcounted. The driver model does
919 * that automatically as part of driver binding, so that most drivers don't
920 * need to do this explicitly: they hold a reference until they're unbound
921 * from the device.
922 *
923 * A pointer to the client with the incremented reference counter is returned.
924 */
925struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926{
David Brownell6ea438e2008-07-14 22:38:24 +0200927 if (client && get_device(&client->dev))
928 return client;
929 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930}
David Brownellc0564602007-05-01 23:26:31 +0200931EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Jean Delvaree48d3312008-01-27 18:14:48 +0100933/**
934 * i2c_release_client - release a use of the i2c client structure
935 * @client: the client being no longer referenced
936 *
937 * Must be called when a user of a client is finished with it.
938 */
939void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940{
David Brownell6ea438e2008-07-14 22:38:24 +0200941 if (client)
942 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943}
David Brownellc0564602007-05-01 23:26:31 +0200944EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945
David Brownell9b766b82008-01-27 18:14:51 +0100946struct i2c_cmd_arg {
947 unsigned cmd;
948 void *arg;
949};
950
951static int i2c_cmd(struct device *dev, void *_arg)
952{
953 struct i2c_client *client = i2c_verify_client(dev);
954 struct i2c_cmd_arg *arg = _arg;
955
956 if (client && client->driver && client->driver->command)
957 client->driver->command(client, arg->cmd, arg->arg);
958 return 0;
959}
960
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
962{
David Brownell9b766b82008-01-27 18:14:51 +0100963 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
David Brownell9b766b82008-01-27 18:14:51 +0100965 cmd_arg.cmd = cmd;
966 cmd_arg.arg = arg;
967 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968}
David Brownellc0564602007-05-01 23:26:31 +0200969EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
971static int __init i2c_init(void)
972{
973 int retval;
974
975 retval = bus_register(&i2c_bus_type);
976 if (retval)
977 return retval;
David Brownelle9f13732008-01-27 18:14:52 +0100978 retval = class_register(&i2c_adapter_class);
979 if (retval)
980 goto bus_err;
981 retval = i2c_add_driver(&dummy_driver);
982 if (retval)
983 goto class_err;
984 return 0;
985
986class_err:
987 class_unregister(&i2c_adapter_class);
988bus_err:
989 bus_unregister(&i2c_bus_type);
990 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991}
992
993static void __exit i2c_exit(void)
994{
David Brownelle9f13732008-01-27 18:14:52 +0100995 i2c_del_driver(&dummy_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 class_unregister(&i2c_adapter_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 bus_unregister(&i2c_bus_type);
998}
999
David Brownella10f9e72008-10-14 17:30:06 +02001000/* We must initialize early, because some subsystems register i2c drivers
1001 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1002 */
1003postcore_initcall(i2c_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004module_exit(i2c_exit);
1005
1006/* ----------------------------------------------------
1007 * the functional interface to the i2c busses.
1008 * ----------------------------------------------------
1009 */
1010
David Brownella1cdeda2008-07-14 22:38:24 +02001011/**
1012 * i2c_transfer - execute a single or combined I2C message
1013 * @adap: Handle to I2C bus
1014 * @msgs: One or more messages to execute before STOP is issued to
1015 * terminate the operation; each message begins with a START.
1016 * @num: Number of messages to be executed.
1017 *
1018 * Returns negative errno, else the number of messages executed.
1019 *
1020 * Note that there is no requirement that each message be sent to
1021 * the same slave address, although that is the most common model.
1022 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
1024{
1025 int ret;
1026
David Brownella1cdeda2008-07-14 22:38:24 +02001027 /* REVISIT the fault reporting model here is weak:
1028 *
1029 * - When we get an error after receiving N bytes from a slave,
1030 * there is no way to report "N".
1031 *
1032 * - When we get a NAK after transmitting N bytes to a slave,
1033 * there is no way to report "N" ... or to let the master
1034 * continue executing the rest of this combined message, if
1035 * that's the appropriate response.
1036 *
1037 * - When for example "num" is two and we successfully complete
1038 * the first message but get an error part way through the
1039 * second, it's unclear whether that should be reported as
1040 * one (discarding status on the second message) or errno
1041 * (discarding status on the first one).
1042 */
1043
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 if (adap->algo->master_xfer) {
1045#ifdef DEBUG
1046 for (ret = 0; ret < num; ret++) {
1047 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +02001048 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1049 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1050 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 }
1052#endif
1053
Mike Rapoportcea443a82008-01-27 18:14:50 +01001054 if (in_atomic() || irqs_disabled()) {
1055 ret = mutex_trylock(&adap->bus_lock);
1056 if (!ret)
1057 /* I2C activity is ongoing. */
1058 return -EAGAIN;
1059 } else {
1060 mutex_lock_nested(&adap->bus_lock, adap->level);
1061 }
1062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 ret = adap->algo->master_xfer(adap,msgs,num);
Ingo Molnar5c085d32006-01-18 23:16:04 +01001064 mutex_unlock(&adap->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
1066 return ret;
1067 } else {
1068 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001069 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 }
1071}
David Brownellc0564602007-05-01 23:26:31 +02001072EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
David Brownella1cdeda2008-07-14 22:38:24 +02001074/**
1075 * i2c_master_send - issue a single I2C message in master transmit mode
1076 * @client: Handle to slave device
1077 * @buf: Data that will be written to the slave
1078 * @count: How many bytes to write
1079 *
1080 * Returns negative errno, or else the number of bytes written.
1081 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1083{
1084 int ret;
1085 struct i2c_adapter *adap=client->adapter;
1086 struct i2c_msg msg;
1087
Jean Delvare815f55f2005-05-07 22:58:46 +02001088 msg.addr = client->addr;
1089 msg.flags = client->flags & I2C_M_TEN;
1090 msg.len = count;
1091 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01001092
Jean Delvare815f55f2005-05-07 22:58:46 +02001093 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
Jean Delvare815f55f2005-05-07 22:58:46 +02001095 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1096 transmitted, else error code. */
1097 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098}
David Brownellc0564602007-05-01 23:26:31 +02001099EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
David Brownella1cdeda2008-07-14 22:38:24 +02001101/**
1102 * i2c_master_recv - issue a single I2C message in master receive mode
1103 * @client: Handle to slave device
1104 * @buf: Where to store data read from slave
1105 * @count: How many bytes to read
1106 *
1107 * Returns negative errno, or else the number of bytes read.
1108 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1110{
1111 struct i2c_adapter *adap=client->adapter;
1112 struct i2c_msg msg;
1113 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114
Jean Delvare815f55f2005-05-07 22:58:46 +02001115 msg.addr = client->addr;
1116 msg.flags = client->flags & I2C_M_TEN;
1117 msg.flags |= I2C_M_RD;
1118 msg.len = count;
1119 msg.buf = buf;
1120
1121 ret = i2c_transfer(adap, &msg, 1);
1122
1123 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1124 transmitted, else error code. */
1125 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126}
David Brownellc0564602007-05-01 23:26:31 +02001127EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129/* ----------------------------------------------------
1130 * the i2c address scanning function
1131 * Will not work for 10-bit addresses!
1132 * ----------------------------------------------------
1133 */
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001134static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
1135 int (*found_proc) (struct i2c_adapter *, int, int))
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001136{
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001137 int err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001138
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001139 /* Make sure the address is valid */
1140 if (addr < 0x03 || addr > 0x77) {
1141 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1142 addr);
1143 return -EINVAL;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001144 }
1145
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001146 /* Skip if already in use */
1147 if (i2c_check_addr(adapter, addr))
1148 return 0;
1149
1150 /* Make sure there is something at this address, unless forced */
Jean Delvare4c9337d2005-08-09 20:28:10 +02001151 if (kind < 0) {
1152 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1153 I2C_SMBUS_QUICK, NULL) < 0)
1154 return 0;
1155
1156 /* prevent 24RF08 corruption */
1157 if ((addr & ~0x0f) == 0x50)
1158 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1159 I2C_SMBUS_QUICK, NULL);
1160 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001161
1162 /* Finally call the custom detection function */
1163 err = found_proc(adapter, addr, kind);
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001164 /* -ENODEV can be returned if there is a chip at the given address
1165 but it isn't supported by this chip driver. We catch it here as
1166 this isn't an error. */
Jean Delvare114fd182006-09-03 22:25:04 +02001167 if (err == -ENODEV)
1168 err = 0;
1169
1170 if (err)
1171 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
1172 addr, err);
1173 return err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001174}
1175
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176int i2c_probe(struct i2c_adapter *adapter,
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +01001177 const struct i2c_client_address_data *address_data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 int (*found_proc) (struct i2c_adapter *, int, int))
1179{
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001180 int i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 int adap_id = i2c_adapter_id(adapter);
1182
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001183 /* Force entries are done first, and are not affected by ignore
1184 entries */
1185 if (address_data->forces) {
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +01001186 const unsigned short * const *forces = address_data->forces;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001187 int kind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001189 for (kind = 0; forces[kind]; kind++) {
1190 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1191 i += 2) {
1192 if (forces[kind][i] == adap_id
1193 || forces[kind][i] == ANY_I2C_BUS) {
1194 dev_dbg(&adapter->dev, "found force "
1195 "parameter for adapter %d, "
1196 "addr 0x%02x, kind %d\n",
1197 adap_id, forces[kind][i + 1],
1198 kind);
1199 err = i2c_probe_address(adapter,
1200 forces[kind][i + 1],
1201 kind, found_proc);
1202 if (err)
1203 return err;
1204 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 }
1206 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001208
Jean Delvare4366dc92005-09-25 16:50:06 +02001209 /* Stop here if we can't use SMBUS_QUICK */
1210 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1211 if (address_data->probe[0] == I2C_CLIENT_END
1212 && address_data->normal_i2c[0] == I2C_CLIENT_END)
David Brownell438d6c22006-12-10 21:21:31 +01001213 return 0;
Jean Delvare4366dc92005-09-25 16:50:06 +02001214
Jean Delvare4329cf82008-08-28 08:33:23 +02001215 dev_dbg(&adapter->dev, "SMBus Quick command not supported, "
1216 "can't probe for chips\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001217 return -EOPNOTSUPP;
Jean Delvare4366dc92005-09-25 16:50:06 +02001218 }
1219
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001220 /* Probe entries are done second, and are not affected by ignore
1221 entries either */
1222 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1223 if (address_data->probe[i] == adap_id
1224 || address_data->probe[i] == ANY_I2C_BUS) {
1225 dev_dbg(&adapter->dev, "found probe parameter for "
1226 "adapter %d, addr 0x%02x\n", adap_id,
1227 address_data->probe[i + 1]);
1228 err = i2c_probe_address(adapter,
1229 address_data->probe[i + 1],
1230 -1, found_proc);
1231 if (err)
1232 return err;
1233 }
1234 }
1235
1236 /* Normal entries are done last, unless shadowed by an ignore entry */
1237 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1238 int j, ignore;
1239
1240 ignore = 0;
1241 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1242 j += 2) {
1243 if ((address_data->ignore[j] == adap_id ||
1244 address_data->ignore[j] == ANY_I2C_BUS)
1245 && address_data->ignore[j + 1]
1246 == address_data->normal_i2c[i]) {
1247 dev_dbg(&adapter->dev, "found ignore "
1248 "parameter for adapter %d, "
1249 "addr 0x%02x\n", adap_id,
1250 address_data->ignore[j + 1]);
Mark M. Hoffman2369df92006-07-01 17:01:59 +02001251 ignore = 1;
1252 break;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001253 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001254 }
1255 if (ignore)
1256 continue;
1257
1258 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1259 "addr 0x%02x\n", adap_id,
1260 address_data->normal_i2c[i]);
1261 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1262 -1, found_proc);
1263 if (err)
1264 return err;
1265 }
1266
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 return 0;
1268}
David Brownellc0564602007-05-01 23:26:31 +02001269EXPORT_SYMBOL(i2c_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
Jean Delvare4735c982008-07-14 22:38:36 +02001271/* Separate detection function for new-style drivers */
1272static int i2c_detect_address(struct i2c_client *temp_client, int kind,
1273 struct i2c_driver *driver)
1274{
1275 struct i2c_board_info info;
1276 struct i2c_adapter *adapter = temp_client->adapter;
1277 int addr = temp_client->addr;
1278 int err;
1279
1280 /* Make sure the address is valid */
1281 if (addr < 0x03 || addr > 0x77) {
1282 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1283 addr);
1284 return -EINVAL;
1285 }
1286
1287 /* Skip if already in use */
1288 if (i2c_check_addr(adapter, addr))
1289 return 0;
1290
1291 /* Make sure there is something at this address, unless forced */
1292 if (kind < 0) {
1293 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1294 I2C_SMBUS_QUICK, NULL) < 0)
1295 return 0;
1296
1297 /* prevent 24RF08 corruption */
1298 if ((addr & ~0x0f) == 0x50)
1299 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1300 I2C_SMBUS_QUICK, NULL);
1301 }
1302
1303 /* Finally call the custom detection function */
1304 memset(&info, 0, sizeof(struct i2c_board_info));
1305 info.addr = addr;
1306 err = driver->detect(temp_client, kind, &info);
1307 if (err) {
1308 /* -ENODEV is returned if the detection fails. We catch it
1309 here as this isn't an error. */
1310 return err == -ENODEV ? 0 : err;
1311 }
1312
1313 /* Consistency check */
1314 if (info.type[0] == '\0') {
1315 dev_err(&adapter->dev, "%s detection function provided "
1316 "no name for 0x%x\n", driver->driver.name,
1317 addr);
1318 } else {
1319 struct i2c_client *client;
1320
1321 /* Detection succeeded, instantiate the device */
1322 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1323 info.type, info.addr);
1324 client = i2c_new_device(adapter, &info);
1325 if (client)
1326 list_add_tail(&client->detected, &driver->clients);
1327 else
1328 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1329 info.type, info.addr);
1330 }
1331 return 0;
1332}
1333
1334static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1335{
1336 const struct i2c_client_address_data *address_data;
1337 struct i2c_client *temp_client;
1338 int i, err = 0;
1339 int adap_id = i2c_adapter_id(adapter);
1340
1341 address_data = driver->address_data;
1342 if (!driver->detect || !address_data)
1343 return 0;
1344
1345 /* Set up a temporary client to help detect callback */
1346 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1347 if (!temp_client)
1348 return -ENOMEM;
1349 temp_client->adapter = adapter;
1350
1351 /* Force entries are done first, and are not affected by ignore
1352 entries */
1353 if (address_data->forces) {
1354 const unsigned short * const *forces = address_data->forces;
1355 int kind;
1356
1357 for (kind = 0; forces[kind]; kind++) {
1358 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1359 i += 2) {
1360 if (forces[kind][i] == adap_id
1361 || forces[kind][i] == ANY_I2C_BUS) {
1362 dev_dbg(&adapter->dev, "found force "
1363 "parameter for adapter %d, "
1364 "addr 0x%02x, kind %d\n",
1365 adap_id, forces[kind][i + 1],
1366 kind);
1367 temp_client->addr = forces[kind][i + 1];
1368 err = i2c_detect_address(temp_client,
1369 kind, driver);
1370 if (err)
1371 goto exit_free;
1372 }
1373 }
1374 }
1375 }
1376
Jean Delvare4329cf82008-08-28 08:33:23 +02001377 /* Stop here if the classes do not match */
1378 if (!(adapter->class & driver->class))
1379 goto exit_free;
1380
Jean Delvare4735c982008-07-14 22:38:36 +02001381 /* Stop here if we can't use SMBUS_QUICK */
1382 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1383 if (address_data->probe[0] == I2C_CLIENT_END
1384 && address_data->normal_i2c[0] == I2C_CLIENT_END)
1385 goto exit_free;
1386
1387 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1388 "can't probe for chips\n");
1389 err = -EOPNOTSUPP;
1390 goto exit_free;
1391 }
1392
Jean Delvare4735c982008-07-14 22:38:36 +02001393 /* Probe entries are done second, and are not affected by ignore
1394 entries either */
1395 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1396 if (address_data->probe[i] == adap_id
1397 || address_data->probe[i] == ANY_I2C_BUS) {
1398 dev_dbg(&adapter->dev, "found probe parameter for "
1399 "adapter %d, addr 0x%02x\n", adap_id,
1400 address_data->probe[i + 1]);
1401 temp_client->addr = address_data->probe[i + 1];
1402 err = i2c_detect_address(temp_client, -1, driver);
1403 if (err)
1404 goto exit_free;
1405 }
1406 }
1407
1408 /* Normal entries are done last, unless shadowed by an ignore entry */
1409 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1410 int j, ignore;
1411
1412 ignore = 0;
1413 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1414 j += 2) {
1415 if ((address_data->ignore[j] == adap_id ||
1416 address_data->ignore[j] == ANY_I2C_BUS)
1417 && address_data->ignore[j + 1]
1418 == address_data->normal_i2c[i]) {
1419 dev_dbg(&adapter->dev, "found ignore "
1420 "parameter for adapter %d, "
1421 "addr 0x%02x\n", adap_id,
1422 address_data->ignore[j + 1]);
1423 ignore = 1;
1424 break;
1425 }
1426 }
1427 if (ignore)
1428 continue;
1429
1430 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1431 "addr 0x%02x\n", adap_id,
1432 address_data->normal_i2c[i]);
1433 temp_client->addr = address_data->normal_i2c[i];
1434 err = i2c_detect_address(temp_client, -1, driver);
1435 if (err)
1436 goto exit_free;
1437 }
1438
1439 exit_free:
1440 kfree(temp_client);
1441 return err;
1442}
1443
Jean Delvare12b5053a2007-05-01 23:26:31 +02001444struct i2c_client *
1445i2c_new_probed_device(struct i2c_adapter *adap,
1446 struct i2c_board_info *info,
1447 unsigned short const *addr_list)
1448{
1449 int i;
1450
1451 /* Stop here if the bus doesn't support probing */
1452 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1453 dev_err(&adap->dev, "Probing not supported\n");
1454 return NULL;
1455 }
1456
Jean Delvare12b5053a2007-05-01 23:26:31 +02001457 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1458 /* Check address validity */
1459 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1460 dev_warn(&adap->dev, "Invalid 7-bit address "
1461 "0x%02x\n", addr_list[i]);
1462 continue;
1463 }
1464
1465 /* Check address availability */
David Brownell9b766b82008-01-27 18:14:51 +01001466 if (i2c_check_addr(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001467 dev_dbg(&adap->dev, "Address 0x%02x already in "
1468 "use, not probing\n", addr_list[i]);
1469 continue;
1470 }
1471
1472 /* Test address responsiveness
1473 The default probe method is a quick write, but it is known
1474 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1475 and could also irreversibly write-protect some EEPROMs, so
1476 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1477 read instead. Also, some bus drivers don't implement
1478 quick write, so we fallback to a byte read it that case
1479 too. */
1480 if ((addr_list[i] & ~0x07) == 0x30
1481 || (addr_list[i] & ~0x0f) == 0x50
1482 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
Hans Verkuilb25b7912008-08-10 22:56:15 +02001483 union i2c_smbus_data data;
1484
Jean Delvare12b5053a2007-05-01 23:26:31 +02001485 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1486 I2C_SMBUS_READ, 0,
Hans Verkuilb25b7912008-08-10 22:56:15 +02001487 I2C_SMBUS_BYTE, &data) >= 0)
Jean Delvare12b5053a2007-05-01 23:26:31 +02001488 break;
1489 } else {
1490 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1491 I2C_SMBUS_WRITE, 0,
1492 I2C_SMBUS_QUICK, NULL) >= 0)
1493 break;
1494 }
1495 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02001496
1497 if (addr_list[i] == I2C_CLIENT_END) {
1498 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1499 return NULL;
1500 }
1501
1502 info->addr = addr_list[i];
1503 return i2c_new_device(adap, info);
1504}
1505EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1506
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507struct i2c_adapter* i2c_get_adapter(int id)
1508{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001510
Jean Delvarecaada322008-01-27 18:14:49 +01001511 mutex_lock(&core_lock);
Mark M. Hoffmana0920e102005-06-28 00:21:30 -04001512 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1513 if (adapter && !try_module_get(adapter->owner))
1514 adapter = NULL;
1515
Jean Delvarecaada322008-01-27 18:14:49 +01001516 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e102005-06-28 00:21:30 -04001517 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518}
David Brownellc0564602007-05-01 23:26:31 +02001519EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
1521void i2c_put_adapter(struct i2c_adapter *adap)
1522{
1523 module_put(adap->owner);
1524}
David Brownellc0564602007-05-01 23:26:31 +02001525EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
1527/* The SMBus parts */
1528
David Brownell438d6c22006-12-10 21:21:31 +01001529#define POLY (0x1070U << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530static u8
1531crc8(u16 data)
1532{
1533 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001534
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 for(i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001536 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 data = data ^ POLY;
1538 data = data << 1;
1539 }
1540 return (u8)(data >> 8);
1541}
1542
Jean Delvare421ef472005-10-26 21:28:55 +02001543/* Incremental CRC8 over count bytes in the array pointed to by p */
1544static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545{
1546 int i;
1547
1548 for(i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001549 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 return crc;
1551}
1552
Jean Delvare421ef472005-10-26 21:28:55 +02001553/* Assume a 7-bit address, which is reasonable for SMBus */
1554static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555{
Jean Delvare421ef472005-10-26 21:28:55 +02001556 /* The address will be sent first */
1557 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1558 pec = i2c_smbus_pec(pec, &addr, 1);
1559
1560 /* The data buffer follows */
1561 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562}
1563
Jean Delvare421ef472005-10-26 21:28:55 +02001564/* Used for write only transactions */
1565static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566{
Jean Delvare421ef472005-10-26 21:28:55 +02001567 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1568 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569}
1570
Jean Delvare421ef472005-10-26 21:28:55 +02001571/* Return <0 on CRC error
1572 If there was a write before this read (most cases) we need to take the
1573 partial CRC from the write part into account.
1574 Note that this function does modify the message (we need to decrease the
1575 message length to hide the CRC byte from the caller). */
1576static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577{
Jean Delvare421ef472005-10-26 21:28:55 +02001578 u8 rpec = msg->buf[--msg->len];
1579 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 if (rpec != cpec) {
1582 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1583 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02001584 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 }
David Brownell438d6c22006-12-10 21:21:31 +01001586 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587}
1588
David Brownella1cdeda2008-07-14 22:38:24 +02001589/**
1590 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1591 * @client: Handle to slave device
1592 *
1593 * This executes the SMBus "receive byte" protocol, returning negative errno
1594 * else the byte received from the device.
1595 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596s32 i2c_smbus_read_byte(struct i2c_client *client)
1597{
1598 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001599 int status;
1600
1601 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1602 I2C_SMBUS_READ, 0,
1603 I2C_SMBUS_BYTE, &data);
1604 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605}
David Brownellc0564602007-05-01 23:26:31 +02001606EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
David Brownella1cdeda2008-07-14 22:38:24 +02001608/**
1609 * i2c_smbus_write_byte - SMBus "send byte" protocol
1610 * @client: Handle to slave device
1611 * @value: Byte to be sent
1612 *
1613 * This executes the SMBus "send byte" protocol, returning negative errno
1614 * else zero on success.
1615 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1617{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001619 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620}
David Brownellc0564602007-05-01 23:26:31 +02001621EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
David Brownella1cdeda2008-07-14 22:38:24 +02001623/**
1624 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1625 * @client: Handle to slave device
1626 * @command: Byte interpreted by slave
1627 *
1628 * This executes the SMBus "read byte" protocol, returning negative errno
1629 * else a data byte received from the device.
1630 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1632{
1633 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001634 int status;
1635
1636 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1637 I2C_SMBUS_READ, command,
1638 I2C_SMBUS_BYTE_DATA, &data);
1639 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640}
David Brownellc0564602007-05-01 23:26:31 +02001641EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
David Brownella1cdeda2008-07-14 22:38:24 +02001643/**
1644 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1645 * @client: Handle to slave device
1646 * @command: Byte interpreted by slave
1647 * @value: Byte being written
1648 *
1649 * This executes the SMBus "write byte" protocol, returning negative errno
1650 * else zero on success.
1651 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1653{
1654 union i2c_smbus_data data;
1655 data.byte = value;
1656 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1657 I2C_SMBUS_WRITE,command,
1658 I2C_SMBUS_BYTE_DATA,&data);
1659}
David Brownellc0564602007-05-01 23:26:31 +02001660EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661
David Brownella1cdeda2008-07-14 22:38:24 +02001662/**
1663 * i2c_smbus_read_word_data - SMBus "read word" protocol
1664 * @client: Handle to slave device
1665 * @command: Byte interpreted by slave
1666 *
1667 * This executes the SMBus "read word" protocol, returning negative errno
1668 * else a 16-bit unsigned "word" received from the device.
1669 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1671{
1672 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001673 int status;
1674
1675 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1676 I2C_SMBUS_READ, command,
1677 I2C_SMBUS_WORD_DATA, &data);
1678 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679}
David Brownellc0564602007-05-01 23:26:31 +02001680EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681
David Brownella1cdeda2008-07-14 22:38:24 +02001682/**
1683 * i2c_smbus_write_word_data - SMBus "write word" protocol
1684 * @client: Handle to slave device
1685 * @command: Byte interpreted by slave
1686 * @value: 16-bit "word" being written
1687 *
1688 * This executes the SMBus "write word" protocol, returning negative errno
1689 * else zero on success.
1690 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1692{
1693 union i2c_smbus_data data;
1694 data.word = value;
1695 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1696 I2C_SMBUS_WRITE,command,
1697 I2C_SMBUS_WORD_DATA,&data);
1698}
David Brownellc0564602007-05-01 23:26:31 +02001699EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
David Brownella64ec072007-10-13 23:56:31 +02001701/**
Prakash Mortha596c88f2008-10-14 17:30:06 +02001702 * i2c_smbus_process_call - SMBus "process call" protocol
1703 * @client: Handle to slave device
1704 * @command: Byte interpreted by slave
1705 * @value: 16-bit "word" being written
1706 *
1707 * This executes the SMBus "process call" protocol, returning negative errno
1708 * else a 16-bit unsigned "word" received from the device.
1709 */
1710s32 i2c_smbus_process_call(struct i2c_client *client, u8 command, u16 value)
1711{
1712 union i2c_smbus_data data;
1713 int status;
1714 data.word = value;
1715
1716 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1717 I2C_SMBUS_WRITE, command,
1718 I2C_SMBUS_PROC_CALL, &data);
1719 return (status < 0) ? status : data.word;
1720}
1721EXPORT_SYMBOL(i2c_smbus_process_call);
1722
1723/**
David Brownella1cdeda2008-07-14 22:38:24 +02001724 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02001725 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02001726 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02001727 * @values: Byte array into which data will be read; big enough to hold
1728 * the data returned by the slave. SMBus allows at most 32 bytes.
1729 *
David Brownella1cdeda2008-07-14 22:38:24 +02001730 * This executes the SMBus "block read" protocol, returning negative errno
1731 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02001732 *
1733 * Note that using this function requires that the client's adapter support
1734 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1735 * support this; its emulation through I2C messaging relies on a specific
1736 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1737 */
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001738s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1739 u8 *values)
1740{
1741 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001742 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001743
David Brownell24a5bb72008-07-14 22:38:23 +02001744 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1745 I2C_SMBUS_READ, command,
1746 I2C_SMBUS_BLOCK_DATA, &data);
1747 if (status)
1748 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001749
1750 memcpy(values, &data.block[1], data.block[0]);
1751 return data.block[0];
1752}
1753EXPORT_SYMBOL(i2c_smbus_read_block_data);
1754
David Brownella1cdeda2008-07-14 22:38:24 +02001755/**
1756 * i2c_smbus_write_block_data - SMBus "block write" protocol
1757 * @client: Handle to slave device
1758 * @command: Byte interpreted by slave
1759 * @length: Size of data block; SMBus allows at most 32 bytes
1760 * @values: Byte array which will be written.
1761 *
1762 * This executes the SMBus "block write" protocol, returning negative errno
1763 * else zero on success.
1764 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001766 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767{
1768 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001769
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 if (length > I2C_SMBUS_BLOCK_MAX)
1771 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01001773 memcpy(&data.block[1], values, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1775 I2C_SMBUS_WRITE,command,
1776 I2C_SMBUS_BLOCK_DATA,&data);
1777}
David Brownellc0564602007-05-01 23:26:31 +02001778EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
1780/* Returns the number of read bytes */
Jean Delvare4b2643d2007-07-12 14:12:29 +02001781s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1782 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783{
1784 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001785 int status;
Jean Delvare76560322006-01-18 23:14:55 +01001786
Jean Delvare4b2643d2007-07-12 14:12:29 +02001787 if (length > I2C_SMBUS_BLOCK_MAX)
1788 length = I2C_SMBUS_BLOCK_MAX;
1789 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02001790 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1791 I2C_SMBUS_READ, command,
1792 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1793 if (status < 0)
1794 return status;
Jean Delvare76560322006-01-18 23:14:55 +01001795
1796 memcpy(values, &data.block[1], data.block[0]);
1797 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798}
David Brownellc0564602007-05-01 23:26:31 +02001799EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
Jean Delvare21bbd692006-01-09 15:19:18 +11001801s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001802 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11001803{
1804 union i2c_smbus_data data;
1805
1806 if (length > I2C_SMBUS_BLOCK_MAX)
1807 length = I2C_SMBUS_BLOCK_MAX;
1808 data.block[0] = length;
1809 memcpy(data.block + 1, values, length);
1810 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1811 I2C_SMBUS_WRITE, command,
1812 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1813}
David Brownellc0564602007-05-01 23:26:31 +02001814EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11001815
David Brownell438d6c22006-12-10 21:21:31 +01001816/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 No checking of parameters is done! */
David Brownell438d6c22006-12-10 21:21:31 +01001818static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001820 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 union i2c_smbus_data * data)
1822{
1823 /* So we need to generate a series of msgs. In the case of writing, we
1824 need to use only one message; when reading, we need two. We initialize
1825 most things with sane defaults, to keep the code below somewhat
1826 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001827 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1828 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 int num = read_write == I2C_SMBUS_READ?2:1;
David Brownell438d6c22006-12-10 21:21:31 +01001830 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1832 };
1833 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02001834 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02001835 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836
1837 msgbuf0[0] = command;
1838 switch(size) {
1839 case I2C_SMBUS_QUICK:
1840 msg[0].len = 0;
1841 /* Special case: The read/write field is used as data */
Roel Kluinf29d2e02009-02-24 19:19:48 +01001842 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
1843 I2C_M_RD : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 num = 1;
1845 break;
1846 case I2C_SMBUS_BYTE:
1847 if (read_write == I2C_SMBUS_READ) {
1848 /* Special case: only a read! */
1849 msg[0].flags = I2C_M_RD | flags;
1850 num = 1;
1851 }
1852 break;
1853 case I2C_SMBUS_BYTE_DATA:
1854 if (read_write == I2C_SMBUS_READ)
1855 msg[1].len = 1;
1856 else {
1857 msg[0].len = 2;
1858 msgbuf0[1] = data->byte;
1859 }
1860 break;
1861 case I2C_SMBUS_WORD_DATA:
1862 if (read_write == I2C_SMBUS_READ)
1863 msg[1].len = 2;
1864 else {
1865 msg[0].len=3;
1866 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001867 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 }
1869 break;
1870 case I2C_SMBUS_PROC_CALL:
1871 num = 2; /* Special case */
1872 read_write = I2C_SMBUS_READ;
1873 msg[0].len = 3;
1874 msg[1].len = 2;
1875 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001876 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 break;
1878 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02001880 msg[1].flags |= I2C_M_RECV_LEN;
1881 msg[1].len = 1; /* block length will be added by
1882 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 } else {
1884 msg[0].len = data->block[0] + 2;
1885 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02001886 dev_err(&adapter->dev,
1887 "Invalid block write size %d\n",
1888 data->block[0]);
1889 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001891 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 msgbuf0[i] = data->block[i-1];
1893 }
1894 break;
1895 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02001896 num = 2; /* Another special case */
1897 read_write = I2C_SMBUS_READ;
1898 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02001899 dev_err(&adapter->dev,
1900 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02001901 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02001902 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02001903 }
1904 msg[0].len = data->block[0] + 2;
1905 for (i = 1; i < msg[0].len; i++)
1906 msgbuf0[i] = data->block[i-1];
1907 msg[1].flags |= I2C_M_RECV_LEN;
1908 msg[1].len = 1; /* block length will be added by
1909 the underlying bus driver */
1910 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 case I2C_SMBUS_I2C_BLOCK_DATA:
1912 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02001913 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 } else {
1915 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02001916 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02001917 dev_err(&adapter->dev,
1918 "Invalid block write size %d\n",
1919 data->block[0]);
1920 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 }
1922 for (i = 1; i <= data->block[0]; i++)
1923 msgbuf0[i] = data->block[i];
1924 }
1925 break;
1926 default:
David Brownell24a5bb72008-07-14 22:38:23 +02001927 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1928 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 }
1930
Jean Delvare421ef472005-10-26 21:28:55 +02001931 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1932 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1933 if (i) {
1934 /* Compute PEC if first message is a write */
1935 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01001936 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02001937 i2c_smbus_add_pec(&msg[0]);
1938 else /* Write followed by read */
1939 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1940 }
1941 /* Ask for PEC if last message is a read */
1942 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01001943 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02001944 }
1945
David Brownell24a5bb72008-07-14 22:38:23 +02001946 status = i2c_transfer(adapter, msg, num);
1947 if (status < 0)
1948 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949
Jean Delvare421ef472005-10-26 21:28:55 +02001950 /* Check PEC if last message is a read */
1951 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02001952 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1953 if (status < 0)
1954 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02001955 }
1956
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 if (read_write == I2C_SMBUS_READ)
1958 switch(size) {
1959 case I2C_SMBUS_BYTE:
1960 data->byte = msgbuf0[0];
1961 break;
1962 case I2C_SMBUS_BYTE_DATA:
1963 data->byte = msgbuf1[0];
1964 break;
David Brownell438d6c22006-12-10 21:21:31 +01001965 case I2C_SMBUS_WORD_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 case I2C_SMBUS_PROC_CALL:
1967 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1968 break;
1969 case I2C_SMBUS_I2C_BLOCK_DATA:
Jean Delvare4b2643d2007-07-12 14:12:29 +02001970 for (i = 0; i < data->block[0]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 data->block[i+1] = msgbuf1[i];
1972 break;
Jean Delvare209d27c2007-05-01 23:26:29 +02001973 case I2C_SMBUS_BLOCK_DATA:
1974 case I2C_SMBUS_BLOCK_PROC_CALL:
1975 for (i = 0; i < msgbuf1[0] + 1; i++)
1976 data->block[i] = msgbuf1[i];
1977 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 }
1979 return 0;
1980}
1981
David Brownella1cdeda2008-07-14 22:38:24 +02001982/**
1983 * i2c_smbus_xfer - execute SMBus protocol operations
1984 * @adapter: Handle to I2C bus
1985 * @addr: Address of SMBus slave on that bus
1986 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1987 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1988 * @command: Byte interpreted by slave, for protocols which use such bytes
1989 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1990 * @data: Data to be read or written
1991 *
1992 * This executes an SMBus protocol operation, and returns a negative
1993 * errno code else zero on success.
1994 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02001996 char read_write, u8 command, int protocol,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 union i2c_smbus_data * data)
1998{
1999 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000
2001 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002
2003 if (adapter->algo->smbus_xfer) {
Ingo Molnar5c085d32006-01-18 23:16:04 +01002004 mutex_lock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02002006 command, protocol, data);
Ingo Molnar5c085d32006-01-18 23:16:04 +01002007 mutex_unlock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 } else
2009 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02002010 command, protocol, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 return res;
2013}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015
2016MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2017MODULE_DESCRIPTION("I2C-Bus main module");
2018MODULE_LICENSE("GPL");