blob: e06067ebd2050c83a6bb5355d9c4a004a7985edf [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 Rapoportcea443a2008-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
David Brownella1d9e6e2007-05-01 23:26:30 +020045#define is_newstyle_driver(d) ((d)->probe || (d)->remove)
David Brownellf37dd802007-02-13 22:09:00 +010046
47/* ------------------------------------------------------------------------- */
48
Jean Delvared2653e92008-04-29 23:11:39 +020049static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
50 const struct i2c_client *client)
51{
52 while (id->name[0]) {
53 if (strcmp(client->name, id->name) == 0)
54 return id;
55 id++;
56 }
57 return NULL;
58}
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060static int i2c_device_match(struct device *dev, struct device_driver *drv)
61{
David Brownell7b4fbc52007-05-01 23:26:30 +020062 struct i2c_client *client = to_i2c_client(dev);
63 struct i2c_driver *driver = to_i2c_driver(drv);
64
65 /* make legacy i2c drivers bypass driver model probing entirely;
66 * such drivers scan each i2c adapter/bus themselves.
67 */
David Brownella1d9e6e2007-05-01 23:26:30 +020068 if (!is_newstyle_driver(driver))
David Brownell7b4fbc52007-05-01 23:26:30 +020069 return 0;
70
Jean Delvared2653e92008-04-29 23:11:39 +020071 /* match on an id table if there is one */
72 if (driver->id_table)
73 return i2c_match_id(driver->id_table, client) != NULL;
74
Jean Delvareeb8a7902008-05-18 20:49:41 +020075 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076}
77
David Brownell7b4fbc52007-05-01 23:26:30 +020078#ifdef CONFIG_HOTPLUG
79
80/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +020081static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +020082{
83 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +020084
85 /* by definition, legacy drivers can't hotplug */
Jean Delvared2653e92008-04-29 23:11:39 +020086 if (dev->driver)
David Brownell7b4fbc52007-05-01 23:26:30 +020087 return 0;
88
Jean Delvareeb8a7902008-05-18 20:49:41 +020089 if (add_uevent_var(env, "MODALIAS=%s%s",
90 I2C_MODULE_PREFIX, client->name))
91 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +020092 dev_dbg(dev, "uevent\n");
93 return 0;
94}
95
96#else
97#define i2c_device_uevent NULL
98#endif /* CONFIG_HOTPLUG */
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100static int i2c_device_probe(struct device *dev)
101{
David Brownell7b4fbc52007-05-01 23:26:30 +0200102 struct i2c_client *client = to_i2c_client(dev);
103 struct i2c_driver *driver = to_i2c_driver(dev->driver);
Jean Delvared2653e92008-04-29 23:11:39 +0200104 const struct i2c_device_id *id;
Hans Verkuil50c33042008-03-12 14:15:00 +0100105 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200106
107 if (!driver->probe)
108 return -ENODEV;
109 client->driver = driver;
110 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200111
112 if (driver->id_table)
113 id = i2c_match_id(driver->id_table, client);
114 else
115 id = NULL;
116 status = driver->probe(client, id);
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
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200209static struct 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};
220
David Brownell9b766b82008-01-27 18:14:51 +0100221
222/**
223 * i2c_verify_client - return parameter as i2c_client, or NULL
224 * @dev: device, probably from some driver model iterator
225 *
226 * When traversing the driver model tree, perhaps using driver model
227 * iterators like @device_for_each_child(), you can't assume very much
228 * about the nodes you find. Use this function to avoid oopses caused
229 * by wrongly treating some non-I2C device as an i2c_client.
230 */
231struct i2c_client *i2c_verify_client(struct device *dev)
232{
233 return (dev->bus == &i2c_bus_type)
234 ? to_i2c_client(dev)
235 : NULL;
236}
237EXPORT_SYMBOL(i2c_verify_client);
238
239
David Brownell9c1600e2007-05-01 23:26:31 +0200240/**
241 * i2c_new_device - instantiate an i2c device for use with a new style driver
242 * @adap: the adapter managing the device
243 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200244 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200245 *
246 * Create a device to work with a new style i2c driver, where binding is
247 * handled through driver model probe()/remove() methods. This call is not
248 * appropriate for use by mainboad initialization logic, which usually runs
249 * during an arch_initcall() long before any i2c_adapter could exist.
250 *
251 * This returns the new i2c client, which may be saved for later use with
252 * i2c_unregister_device(); or NULL to indicate an error.
253 */
254struct i2c_client *
255i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
256{
257 struct i2c_client *client;
258 int status;
259
260 client = kzalloc(sizeof *client, GFP_KERNEL);
261 if (!client)
262 return NULL;
263
264 client->adapter = adap;
265
266 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200267 device_init_wakeup(&client->dev, info->flags & I2C_CLIENT_WAKE);
268
269 client->flags = info->flags & ~I2C_CLIENT_WAKE;
David Brownell9c1600e2007-05-01 23:26:31 +0200270 client->addr = info->addr;
271 client->irq = info->irq;
272
David Brownell9c1600e2007-05-01 23:26:31 +0200273 strlcpy(client->name, info->type, sizeof(client->name));
274
275 /* a new style driver may be bound to this device when we
276 * return from this function, or any later moment (e.g. maybe
277 * hotplugging will load the driver module). and the device
278 * refcount model is the standard driver model one.
279 */
280 status = i2c_attach_client(client);
281 if (status < 0) {
282 kfree(client);
283 client = NULL;
284 }
285 return client;
286}
287EXPORT_SYMBOL_GPL(i2c_new_device);
288
289
290/**
291 * i2c_unregister_device - reverse effect of i2c_new_device()
292 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200293 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200294 */
295void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200296{
297 struct i2c_adapter *adapter = client->adapter;
298 struct i2c_driver *driver = client->driver;
299
300 if (driver && !is_newstyle_driver(driver)) {
301 dev_err(&client->dev, "can't unregister devices "
302 "with legacy drivers\n");
303 WARN_ON(1);
304 return;
305 }
306
307 mutex_lock(&adapter->clist_lock);
308 list_del(&client->list);
309 mutex_unlock(&adapter->clist_lock);
310
311 device_unregister(&client->dev);
312}
David Brownell9c1600e2007-05-01 23:26:31 +0200313EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200314
315
Jean Delvare60b129d2008-05-11 20:37:06 +0200316static const struct i2c_device_id dummy_id[] = {
317 { "dummy", 0 },
318 { },
319};
320
Jean Delvared2653e92008-04-29 23:11:39 +0200321static int dummy_probe(struct i2c_client *client,
322 const struct i2c_device_id *id)
323{
324 return 0;
325}
326
327static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100328{
329 return 0;
330}
331
332static struct i2c_driver dummy_driver = {
333 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200334 .probe = dummy_probe,
335 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200336 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100337};
338
339/**
340 * i2c_new_dummy - return a new i2c device bound to a dummy driver
341 * @adapter: the adapter managing the device
342 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100343 * Context: can sleep
344 *
345 * This returns an I2C client bound to the "dummy" driver, intended for use
346 * with devices that consume multiple addresses. Examples of such chips
347 * include various EEPROMS (like 24c04 and 24c08 models).
348 *
349 * These dummy devices have two main uses. First, most I2C and SMBus calls
350 * except i2c_transfer() need a client handle; the dummy will be that handle.
351 * And second, this prevents the specified address from being bound to a
352 * different driver.
353 *
354 * This returns the new i2c client, which should be saved for later use with
355 * i2c_unregister_device(); or NULL to indicate an error.
356 */
357struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200358i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100359{
360 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200361 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100362 };
363
David Brownelle9f13732008-01-27 18:14:52 +0100364 return i2c_new_device(adapter, &info);
365}
366EXPORT_SYMBOL_GPL(i2c_new_dummy);
367
David Brownellf37dd802007-02-13 22:09:00 +0100368/* ------------------------------------------------------------------------- */
369
David Brownell16ffadf2007-05-01 23:26:28 +0200370/* I2C bus adapters -- one roots each I2C or SMBUS segment */
371
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200372static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373{
David Brownellef2c8322007-05-01 23:26:28 +0200374 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 complete(&adap->dev_released);
376}
377
David Brownell16ffadf2007-05-01 23:26:28 +0200378static ssize_t
379show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380{
David Brownellef2c8322007-05-01 23:26:28 +0200381 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 return sprintf(buf, "%s\n", adap->name);
383}
David Brownell16ffadf2007-05-01 23:26:28 +0200384
385static struct device_attribute i2c_adapter_attrs[] = {
386 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
387 { },
388};
389
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200390static struct class i2c_adapter_class = {
David Brownell16ffadf2007-05-01 23:26:28 +0200391 .owner = THIS_MODULE,
392 .name = "i2c-adapter",
393 .dev_attrs = i2c_adapter_attrs,
394};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
David Brownell9c1600e2007-05-01 23:26:31 +0200396static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
397{
398 struct i2c_devinfo *devinfo;
399
400 mutex_lock(&__i2c_board_lock);
401 list_for_each_entry(devinfo, &__i2c_board_list, list) {
402 if (devinfo->busnum == adapter->nr
403 && !i2c_new_device(adapter,
404 &devinfo->board_info))
405 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
406 i2c_adapter_id(adapter),
407 devinfo->board_info.addr);
408 }
409 mutex_unlock(&__i2c_board_lock);
410}
411
Jean Delvare026526f2008-01-27 18:14:49 +0100412static int i2c_do_add_adapter(struct device_driver *d, void *data)
413{
414 struct i2c_driver *driver = to_i2c_driver(d);
415 struct i2c_adapter *adap = data;
416
417 if (driver->attach_adapter) {
418 /* We ignore the return code; if it fails, too bad */
419 driver->attach_adapter(adap);
420 }
421 return 0;
422}
423
David Brownell6e13e642007-05-01 23:26:31 +0200424static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425{
Jean Delvare026526f2008-01-27 18:14:49 +0100426 int res = 0, dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Ingo Molnar5c085d32006-01-18 23:16:04 +0100428 mutex_init(&adap->bus_lock);
429 mutex_init(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 INIT_LIST_HEAD(&adap->clients);
431
Jean Delvarecaada322008-01-27 18:14:49 +0100432 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200433
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 /* Add the adapter to the driver core.
435 * If the parent pointer is not set up,
436 * we add this adapter to the host bus.
437 */
David Brownellb119dc32007-01-04 13:07:04 +0100438 if (adap->dev.parent == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 adap->dev.parent = &platform_bus;
Jean Delvarefe2c8d52007-02-13 22:09:04 +0100440 pr_debug("I2C adapter driver [%s] forgot to specify "
441 "physical device\n", adap->name);
David Brownellb119dc32007-01-04 13:07:04 +0100442 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 adap->dev.release = &i2c_adapter_dev_release;
Jean Delvarefccb56e2007-05-01 23:26:27 +0200445 adap->dev.class = &i2c_adapter_class;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200446 res = device_register(&adap->dev);
447 if (res)
448 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200450 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
451
David Brownell6e13e642007-05-01 23:26:31 +0200452 /* create pre-declared device nodes for new-style drivers */
453 if (adap->nr < __i2c_first_dynamic_bus_num)
454 i2c_scan_static_board_info(adap);
455
David Brownell7b4fbc52007-05-01 23:26:30 +0200456 /* let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +0100457 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
458 i2c_do_add_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100461 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 return res;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200463
Jean Delvareb119c6c2006-08-15 18:26:30 +0200464out_list:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200465 idr_remove(&i2c_adapter_idr, adap->nr);
466 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467}
468
David Brownell6e13e642007-05-01 23:26:31 +0200469/**
470 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
471 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +0200472 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200473 *
474 * This routine is used to declare an I2C adapter when its bus number
475 * doesn't matter. Examples: for I2C adapters dynamically added by
476 * USB links or PCI plugin cards.
477 *
478 * When this returns zero, a new bus number was allocated and stored
479 * in adap->nr, and the specified adapter became available for clients.
480 * Otherwise, a negative errno value is returned.
481 */
482int i2c_add_adapter(struct i2c_adapter *adapter)
483{
484 int id, res = 0;
485
486retry:
487 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
488 return -ENOMEM;
489
Jean Delvarecaada322008-01-27 18:14:49 +0100490 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200491 /* "above" here means "above or equal to", sigh */
492 res = idr_get_new_above(&i2c_adapter_idr, adapter,
493 __i2c_first_dynamic_bus_num, &id);
Jean Delvarecaada322008-01-27 18:14:49 +0100494 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200495
496 if (res < 0) {
497 if (res == -EAGAIN)
498 goto retry;
499 return res;
500 }
501
502 adapter->nr = id;
503 return i2c_register_adapter(adapter);
504}
505EXPORT_SYMBOL(i2c_add_adapter);
506
507/**
508 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
509 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +0200510 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200511 *
512 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +0100513 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
514 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +0200515 * is used to properly configure I2C devices.
516 *
517 * If no devices have pre-been declared for this bus, then be sure to
518 * register the adapter before any dynamically allocated ones. Otherwise
519 * the required bus ID may not be available.
520 *
521 * When this returns zero, the specified adapter became available for
522 * clients using the bus number provided in adap->nr. Also, the table
523 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
524 * and the appropriate driver model device nodes are created. Otherwise, a
525 * negative errno value is returned.
526 */
527int i2c_add_numbered_adapter(struct i2c_adapter *adap)
528{
529 int id;
530 int status;
531
532 if (adap->nr & ~MAX_ID_MASK)
533 return -EINVAL;
534
535retry:
536 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
537 return -ENOMEM;
538
Jean Delvarecaada322008-01-27 18:14:49 +0100539 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200540 /* "above" here means "above or equal to", sigh;
541 * we need the "equal to" result to force the result
542 */
543 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
544 if (status == 0 && id != adap->nr) {
545 status = -EBUSY;
546 idr_remove(&i2c_adapter_idr, id);
547 }
Jean Delvarecaada322008-01-27 18:14:49 +0100548 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200549 if (status == -EAGAIN)
550 goto retry;
551
552 if (status == 0)
553 status = i2c_register_adapter(adap);
554 return status;
555}
556EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
557
Jean Delvare026526f2008-01-27 18:14:49 +0100558static int i2c_do_del_adapter(struct device_driver *d, void *data)
559{
560 struct i2c_driver *driver = to_i2c_driver(d);
561 struct i2c_adapter *adapter = data;
562 int res;
563
564 if (!driver->detach_adapter)
565 return 0;
566 res = driver->detach_adapter(adapter);
567 if (res)
568 dev_err(&adapter->dev, "detach_adapter failed (%d) "
569 "for driver [%s]\n", res, driver->driver.name);
570 return res;
571}
572
David Brownelld64f73b2007-07-12 14:12:28 +0200573/**
574 * i2c_del_adapter - unregister I2C adapter
575 * @adap: the adapter being unregistered
576 * Context: can sleep
577 *
578 * This unregisters an I2C adapter which was previously registered
579 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
580 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581int i2c_del_adapter(struct i2c_adapter *adap)
582{
Matthias Kaehlcke6a03cd92008-07-14 22:38:26 +0200583 struct i2c_client *client, *_n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 int res = 0;
585
Jean Delvarecaada322008-01-27 18:14:49 +0100586 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
588 /* First make sure that this adapter was ever added */
Jean Delvare87c6c222008-01-27 18:14:48 +0100589 if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200590 pr_debug("i2c-core: attempting to delete unregistered "
591 "adapter [%s]\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 res = -EINVAL;
593 goto out_unlock;
594 }
595
Jean Delvare026526f2008-01-27 18:14:49 +0100596 /* Tell drivers about this removal */
597 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
598 i2c_do_del_adapter);
599 if (res)
600 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
602 /* detach any active clients. This must be done first, because
Tobias Klausera551acc2005-05-19 21:40:38 +0200603 * it can fail; in which case we give up. */
Matthias Kaehlcke6a03cd92008-07-14 22:38:26 +0200604 list_for_each_entry_safe(client, _n, &adap->clients, list) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200605 struct i2c_driver *driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
David Brownella1d9e6e2007-05-01 23:26:30 +0200607 driver = client->driver;
608
609 /* new style, follow standard driver model */
610 if (!driver || is_newstyle_driver(driver)) {
611 i2c_unregister_device(client);
612 continue;
613 }
614
615 /* legacy drivers create and remove clients themselves */
616 if ((res = driver->detach_client(client))) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200617 dev_err(&adap->dev, "detach_client failed for client "
618 "[%s] at address 0x%02x\n", client->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 client->addr);
620 goto out_unlock;
621 }
622 }
623
624 /* clean up the sysfs representation */
625 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
628 /* wait for sysfs to drop all references */
629 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
David Brownell6e13e642007-05-01 23:26:31 +0200631 /* free bus id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 idr_remove(&i2c_adapter_idr, adap->nr);
633
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200634 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
636 out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100637 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 return res;
639}
David Brownellc0564602007-05-01 23:26:31 +0200640EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
642
David Brownell7b4fbc52007-05-01 23:26:30 +0200643/* ------------------------------------------------------------------------- */
644
Dave Young7f101a92008-07-14 22:38:19 +0200645static int __attach_adapter(struct device *dev, void *data)
646{
647 struct i2c_adapter *adapter = to_i2c_adapter(dev);
648 struct i2c_driver *driver = data;
649
650 driver->attach_adapter(adapter);
651
652 return 0;
653}
654
David Brownell7b4fbc52007-05-01 23:26:30 +0200655/*
656 * An i2c_driver is used with one or more i2c_client (device) nodes to access
657 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
658 * are two models for binding the driver to its device: "new style" drivers
659 * follow the standard Linux driver model and just respond to probe() calls
660 * issued if the driver core sees they match(); "legacy" drivers create device
661 * nodes themselves.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 */
663
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800664int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665{
Jean Delvare7eebcb72006-02-05 23:28:21 +0100666 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
David Brownell7b4fbc52007-05-01 23:26:30 +0200668 /* new style driver methods can't mix with legacy ones */
David Brownella1d9e6e2007-05-01 23:26:30 +0200669 if (is_newstyle_driver(driver)) {
David Brownell7b4fbc52007-05-01 23:26:30 +0200670 if (driver->attach_adapter || driver->detach_adapter
671 || driver->detach_client) {
672 printk(KERN_WARNING
673 "i2c-core: driver [%s] is confused\n",
674 driver->driver.name);
675 return -EINVAL;
676 }
677 }
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800680 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
David Brownell6e13e642007-05-01 23:26:31 +0200683 /* for new style drivers, when registration returns the driver core
684 * will have called probe() for all matching-but-unbound devices.
685 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 res = driver_register(&driver->driver);
687 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +0100688 return res;
David Brownell438d6c22006-12-10 21:21:31 +0100689
Jean Delvarecaada322008-01-27 18:14:49 +0100690 mutex_lock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100691
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100692 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
David Brownell7b4fbc52007-05-01 23:26:30 +0200694 /* legacy drivers scan i2c busses directly */
Dave Young7f101a92008-07-14 22:38:19 +0200695 if (driver->attach_adapter)
696 class_for_each_device(&i2c_adapter_class, driver,
697 __attach_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Jean Delvarecaada322008-01-27 18:14:49 +0100699 mutex_unlock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100700 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800702EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Dave Young7f101a92008-07-14 22:38:19 +0200704static int __detach_adapter(struct device *dev, void *data)
705{
706 struct i2c_adapter *adapter = to_i2c_adapter(dev);
707 struct i2c_driver *driver = data;
708
709 /* Have a look at each adapter, if clients of this driver are still
710 * attached. If so, detach them to be able to kill the driver
711 * afterwards.
712 */
713 if (driver->detach_adapter) {
714 if (driver->detach_adapter(adapter))
715 dev_err(&adapter->dev,
716 "detach_adapter failed for driver [%s]\n",
717 driver->driver.name);
718 } else {
Matthias Kaehlcke6a03cd92008-07-14 22:38:26 +0200719 struct i2c_client *client, *_n;
Dave Young7f101a92008-07-14 22:38:19 +0200720
Matthias Kaehlcke6a03cd92008-07-14 22:38:26 +0200721 list_for_each_entry_safe(client, _n, &adapter->clients, list) {
Dave Young7f101a92008-07-14 22:38:19 +0200722 if (client->driver != driver)
723 continue;
724 dev_dbg(&adapter->dev,
725 "detaching client [%s] at 0x%02x\n",
726 client->name, client->addr);
727 if (driver->detach_client(client))
728 dev_err(&adapter->dev, "detach_client "
729 "failed for client [%s] at 0x%02x\n",
730 client->name, client->addr);
731 }
732 }
733
734 return 0;
735}
736
David Brownella1d9e6e2007-05-01 23:26:30 +0200737/**
738 * i2c_del_driver - unregister I2C driver
739 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +0200740 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +0200741 */
Jean Delvareb3e82092007-05-01 23:26:32 +0200742void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
Jean Delvarecaada322008-01-27 18:14:49 +0100744 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
Jean Delvaref7050bd2008-07-14 22:38:26 +0200746 /* legacy driver? */
747 if (!is_newstyle_driver(driver))
748 class_for_each_device(&i2c_adapter_class, driver,
749 __detach_adapter);
David Brownella1d9e6e2007-05-01 23:26:30 +0200750
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100752 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Jean Delvarecaada322008-01-27 18:14:49 +0100754 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755}
David Brownellc0564602007-05-01 23:26:31 +0200756EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
David Brownell7b4fbc52007-05-01 23:26:30 +0200758/* ------------------------------------------------------------------------- */
759
David Brownell9b766b82008-01-27 18:14:51 +0100760static int __i2c_check_addr(struct device *dev, void *addrp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
David Brownell9b766b82008-01-27 18:14:51 +0100762 struct i2c_client *client = i2c_verify_client(dev);
763 int addr = *(int *)addrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
David Brownell9b766b82008-01-27 18:14:51 +0100765 if (client && client->addr == addr)
766 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 return 0;
768}
769
Jean Delvare5e31c2b2007-11-15 19:24:02 +0100770static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771{
David Brownell9b766b82008-01-27 18:14:51 +0100772 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773}
774
775int i2c_attach_client(struct i2c_client *client)
776{
777 struct i2c_adapter *adapter = client->adapter;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200778 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 client->dev.parent = &client->adapter->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 client->dev.bus = &i2c_bus_type;
David Brownell9c1600e2007-05-01 23:26:31 +0200782
783 if (client->driver)
784 client->dev.driver = &client->driver->driver;
785
David Brownellde81d2a2007-05-22 19:49:16 +0200786 if (client->driver && !is_newstyle_driver(client->driver)) {
David Brownell9c1600e2007-05-01 23:26:31 +0200787 client->dev.release = i2c_client_release;
David Brownellde81d2a2007-05-22 19:49:16 +0200788 client->dev.uevent_suppress = 1;
789 } else
David Brownell9c1600e2007-05-01 23:26:31 +0200790 client->dev.release = i2c_client_dev_release;
David Brownell438d6c22006-12-10 21:21:31 +0100791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
793 "%d-%04x", i2c_adapter_id(adapter), client->addr);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200794 res = device_register(&client->dev);
795 if (res)
David Brownell86ec5ec2008-01-27 18:14:51 +0100796 goto out_err;
797
798 mutex_lock(&adapter->clist_lock);
799 list_add_tail(&client->list, &adapter->clients);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200800 mutex_unlock(&adapter->clist_lock);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200801
David Brownell86ec5ec2008-01-27 18:14:51 +0100802 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
803 client->name, client->dev.bus_id);
804
Jean Delvare77ed74d2006-09-30 17:18:59 +0200805 if (adapter->client_register) {
806 if (adapter->client_register(client)) {
807 dev_dbg(&adapter->dev, "client_register "
808 "failed for client [%s] at 0x%02x\n",
809 client->name, client->addr);
810 }
811 }
812
813 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200814
David Brownell86ec5ec2008-01-27 18:14:51 +0100815out_err:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200816 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
817 "(%d)\n", client->name, client->addr, res);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200818 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819}
David Brownellc0564602007-05-01 23:26:31 +0200820EXPORT_SYMBOL(i2c_attach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
822int i2c_detach_client(struct i2c_client *client)
823{
824 struct i2c_adapter *adapter = client->adapter;
825 int res = 0;
David Brownell438d6c22006-12-10 21:21:31 +0100826
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 if (adapter->client_unregister) {
828 res = adapter->client_unregister(client);
829 if (res) {
830 dev_err(&client->dev,
Jean Delvare86749e82005-07-29 12:15:29 -0700831 "client_unregister [%s] failed, "
832 "client not detached\n", client->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 goto out;
834 }
835 }
836
Ingo Molnar5c085d32006-01-18 23:16:04 +0100837 mutex_lock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 list_del(&client->list);
Jean Delvare9ddced12008-01-27 18:14:51 +0100839 mutex_unlock(&adapter->clist_lock);
840
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 init_completion(&client->released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 device_unregister(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 wait_for_completion(&client->released);
844
845 out:
846 return res;
847}
David Brownellc0564602007-05-01 23:26:31 +0200848EXPORT_SYMBOL(i2c_detach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
Jean Delvaree48d3312008-01-27 18:14:48 +0100850/**
851 * i2c_use_client - increments the reference count of the i2c client structure
852 * @client: the client being referenced
853 *
854 * Each live reference to a client should be refcounted. The driver model does
855 * that automatically as part of driver binding, so that most drivers don't
856 * need to do this explicitly: they hold a reference until they're unbound
857 * from the device.
858 *
859 * A pointer to the client with the incremented reference counter is returned.
860 */
861struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862{
David Brownell6ea438e2008-07-14 22:38:24 +0200863 if (client && get_device(&client->dev))
864 return client;
865 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866}
David Brownellc0564602007-05-01 23:26:31 +0200867EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Jean Delvaree48d3312008-01-27 18:14:48 +0100869/**
870 * i2c_release_client - release a use of the i2c client structure
871 * @client: the client being no longer referenced
872 *
873 * Must be called when a user of a client is finished with it.
874 */
875void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876{
David Brownell6ea438e2008-07-14 22:38:24 +0200877 if (client)
878 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879}
David Brownellc0564602007-05-01 23:26:31 +0200880EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
David Brownell9b766b82008-01-27 18:14:51 +0100882struct i2c_cmd_arg {
883 unsigned cmd;
884 void *arg;
885};
886
887static int i2c_cmd(struct device *dev, void *_arg)
888{
889 struct i2c_client *client = i2c_verify_client(dev);
890 struct i2c_cmd_arg *arg = _arg;
891
892 if (client && client->driver && client->driver->command)
893 client->driver->command(client, arg->cmd, arg->arg);
894 return 0;
895}
896
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
898{
David Brownell9b766b82008-01-27 18:14:51 +0100899 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
David Brownell9b766b82008-01-27 18:14:51 +0100901 cmd_arg.cmd = cmd;
902 cmd_arg.arg = arg;
903 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904}
David Brownellc0564602007-05-01 23:26:31 +0200905EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
907static int __init i2c_init(void)
908{
909 int retval;
910
911 retval = bus_register(&i2c_bus_type);
912 if (retval)
913 return retval;
David Brownelle9f13732008-01-27 18:14:52 +0100914 retval = class_register(&i2c_adapter_class);
915 if (retval)
916 goto bus_err;
917 retval = i2c_add_driver(&dummy_driver);
918 if (retval)
919 goto class_err;
920 return 0;
921
922class_err:
923 class_unregister(&i2c_adapter_class);
924bus_err:
925 bus_unregister(&i2c_bus_type);
926 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927}
928
929static void __exit i2c_exit(void)
930{
David Brownelle9f13732008-01-27 18:14:52 +0100931 i2c_del_driver(&dummy_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 class_unregister(&i2c_adapter_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 bus_unregister(&i2c_bus_type);
934}
935
936subsys_initcall(i2c_init);
937module_exit(i2c_exit);
938
939/* ----------------------------------------------------
940 * the functional interface to the i2c busses.
941 * ----------------------------------------------------
942 */
943
David Brownella1cdeda2008-07-14 22:38:24 +0200944/**
945 * i2c_transfer - execute a single or combined I2C message
946 * @adap: Handle to I2C bus
947 * @msgs: One or more messages to execute before STOP is issued to
948 * terminate the operation; each message begins with a START.
949 * @num: Number of messages to be executed.
950 *
951 * Returns negative errno, else the number of messages executed.
952 *
953 * Note that there is no requirement that each message be sent to
954 * the same slave address, although that is the most common model.
955 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
957{
958 int ret;
959
David Brownella1cdeda2008-07-14 22:38:24 +0200960 /* REVISIT the fault reporting model here is weak:
961 *
962 * - When we get an error after receiving N bytes from a slave,
963 * there is no way to report "N".
964 *
965 * - When we get a NAK after transmitting N bytes to a slave,
966 * there is no way to report "N" ... or to let the master
967 * continue executing the rest of this combined message, if
968 * that's the appropriate response.
969 *
970 * - When for example "num" is two and we successfully complete
971 * the first message but get an error part way through the
972 * second, it's unclear whether that should be reported as
973 * one (discarding status on the second message) or errno
974 * (discarding status on the first one).
975 */
976
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 if (adap->algo->master_xfer) {
978#ifdef DEBUG
979 for (ret = 0; ret < num; ret++) {
980 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +0200981 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
982 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
983 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 }
985#endif
986
Mike Rapoportcea443a2008-01-27 18:14:50 +0100987 if (in_atomic() || irqs_disabled()) {
988 ret = mutex_trylock(&adap->bus_lock);
989 if (!ret)
990 /* I2C activity is ongoing. */
991 return -EAGAIN;
992 } else {
993 mutex_lock_nested(&adap->bus_lock, adap->level);
994 }
995
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 ret = adap->algo->master_xfer(adap,msgs,num);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100997 mutex_unlock(&adap->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
999 return ret;
1000 } else {
1001 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001002 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 }
1004}
David Brownellc0564602007-05-01 23:26:31 +02001005EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
David Brownella1cdeda2008-07-14 22:38:24 +02001007/**
1008 * i2c_master_send - issue a single I2C message in master transmit mode
1009 * @client: Handle to slave device
1010 * @buf: Data that will be written to the slave
1011 * @count: How many bytes to write
1012 *
1013 * Returns negative errno, or else the number of bytes written.
1014 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1016{
1017 int ret;
1018 struct i2c_adapter *adap=client->adapter;
1019 struct i2c_msg msg;
1020
Jean Delvare815f55f2005-05-07 22:58:46 +02001021 msg.addr = client->addr;
1022 msg.flags = client->flags & I2C_M_TEN;
1023 msg.len = count;
1024 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01001025
Jean Delvare815f55f2005-05-07 22:58:46 +02001026 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
Jean Delvare815f55f2005-05-07 22:58:46 +02001028 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1029 transmitted, else error code. */
1030 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031}
David Brownellc0564602007-05-01 23:26:31 +02001032EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
David Brownella1cdeda2008-07-14 22:38:24 +02001034/**
1035 * i2c_master_recv - issue a single I2C message in master receive mode
1036 * @client: Handle to slave device
1037 * @buf: Where to store data read from slave
1038 * @count: How many bytes to read
1039 *
1040 * Returns negative errno, or else the number of bytes read.
1041 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1043{
1044 struct i2c_adapter *adap=client->adapter;
1045 struct i2c_msg msg;
1046 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
Jean Delvare815f55f2005-05-07 22:58:46 +02001048 msg.addr = client->addr;
1049 msg.flags = client->flags & I2C_M_TEN;
1050 msg.flags |= I2C_M_RD;
1051 msg.len = count;
1052 msg.buf = buf;
1053
1054 ret = i2c_transfer(adap, &msg, 1);
1055
1056 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1057 transmitted, else error code. */
1058 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059}
David Brownellc0564602007-05-01 23:26:31 +02001060EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062/* ----------------------------------------------------
1063 * the i2c address scanning function
1064 * Will not work for 10-bit addresses!
1065 * ----------------------------------------------------
1066 */
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001067static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
1068 int (*found_proc) (struct i2c_adapter *, int, int))
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001069{
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001070 int err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001071
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001072 /* Make sure the address is valid */
1073 if (addr < 0x03 || addr > 0x77) {
1074 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1075 addr);
1076 return -EINVAL;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001077 }
1078
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001079 /* Skip if already in use */
1080 if (i2c_check_addr(adapter, addr))
1081 return 0;
1082
1083 /* Make sure there is something at this address, unless forced */
Jean Delvare4c9337d2005-08-09 20:28:10 +02001084 if (kind < 0) {
1085 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1086 I2C_SMBUS_QUICK, NULL) < 0)
1087 return 0;
1088
1089 /* prevent 24RF08 corruption */
1090 if ((addr & ~0x0f) == 0x50)
1091 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1092 I2C_SMBUS_QUICK, NULL);
1093 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001094
1095 /* Finally call the custom detection function */
1096 err = found_proc(adapter, addr, kind);
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001097 /* -ENODEV can be returned if there is a chip at the given address
1098 but it isn't supported by this chip driver. We catch it here as
1099 this isn't an error. */
Jean Delvare114fd182006-09-03 22:25:04 +02001100 if (err == -ENODEV)
1101 err = 0;
1102
1103 if (err)
1104 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
1105 addr, err);
1106 return err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001107}
1108
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109int i2c_probe(struct i2c_adapter *adapter,
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +01001110 const struct i2c_client_address_data *address_data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 int (*found_proc) (struct i2c_adapter *, int, int))
1112{
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001113 int i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 int adap_id = i2c_adapter_id(adapter);
1115
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001116 /* Force entries are done first, and are not affected by ignore
1117 entries */
1118 if (address_data->forces) {
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +01001119 const unsigned short * const *forces = address_data->forces;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001120 int kind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001122 for (kind = 0; forces[kind]; kind++) {
1123 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1124 i += 2) {
1125 if (forces[kind][i] == adap_id
1126 || forces[kind][i] == ANY_I2C_BUS) {
1127 dev_dbg(&adapter->dev, "found force "
1128 "parameter for adapter %d, "
1129 "addr 0x%02x, kind %d\n",
1130 adap_id, forces[kind][i + 1],
1131 kind);
1132 err = i2c_probe_address(adapter,
1133 forces[kind][i + 1],
1134 kind, found_proc);
1135 if (err)
1136 return err;
1137 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 }
1139 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001141
Jean Delvare4366dc92005-09-25 16:50:06 +02001142 /* Stop here if we can't use SMBUS_QUICK */
1143 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1144 if (address_data->probe[0] == I2C_CLIENT_END
1145 && address_data->normal_i2c[0] == I2C_CLIENT_END)
David Brownell438d6c22006-12-10 21:21:31 +01001146 return 0;
Jean Delvare4366dc92005-09-25 16:50:06 +02001147
1148 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1149 "can't probe for chips\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001150 return -EOPNOTSUPP;
Jean Delvare4366dc92005-09-25 16:50:06 +02001151 }
1152
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001153 /* Probe entries are done second, and are not affected by ignore
1154 entries either */
1155 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1156 if (address_data->probe[i] == adap_id
1157 || address_data->probe[i] == ANY_I2C_BUS) {
1158 dev_dbg(&adapter->dev, "found probe parameter for "
1159 "adapter %d, addr 0x%02x\n", adap_id,
1160 address_data->probe[i + 1]);
1161 err = i2c_probe_address(adapter,
1162 address_data->probe[i + 1],
1163 -1, found_proc);
1164 if (err)
1165 return err;
1166 }
1167 }
1168
1169 /* Normal entries are done last, unless shadowed by an ignore entry */
1170 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1171 int j, ignore;
1172
1173 ignore = 0;
1174 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1175 j += 2) {
1176 if ((address_data->ignore[j] == adap_id ||
1177 address_data->ignore[j] == ANY_I2C_BUS)
1178 && address_data->ignore[j + 1]
1179 == address_data->normal_i2c[i]) {
1180 dev_dbg(&adapter->dev, "found ignore "
1181 "parameter for adapter %d, "
1182 "addr 0x%02x\n", adap_id,
1183 address_data->ignore[j + 1]);
Mark M. Hoffman2369df92006-07-01 17:01:59 +02001184 ignore = 1;
1185 break;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001186 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001187 }
1188 if (ignore)
1189 continue;
1190
1191 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1192 "addr 0x%02x\n", adap_id,
1193 address_data->normal_i2c[i]);
1194 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1195 -1, found_proc);
1196 if (err)
1197 return err;
1198 }
1199
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 return 0;
1201}
David Brownellc0564602007-05-01 23:26:31 +02001202EXPORT_SYMBOL(i2c_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203
Jean Delvare12b50532007-05-01 23:26:31 +02001204struct i2c_client *
1205i2c_new_probed_device(struct i2c_adapter *adap,
1206 struct i2c_board_info *info,
1207 unsigned short const *addr_list)
1208{
1209 int i;
1210
1211 /* Stop here if the bus doesn't support probing */
1212 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1213 dev_err(&adap->dev, "Probing not supported\n");
1214 return NULL;
1215 }
1216
Jean Delvare12b50532007-05-01 23:26:31 +02001217 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1218 /* Check address validity */
1219 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1220 dev_warn(&adap->dev, "Invalid 7-bit address "
1221 "0x%02x\n", addr_list[i]);
1222 continue;
1223 }
1224
1225 /* Check address availability */
David Brownell9b766b82008-01-27 18:14:51 +01001226 if (i2c_check_addr(adap, addr_list[i])) {
Jean Delvare12b50532007-05-01 23:26:31 +02001227 dev_dbg(&adap->dev, "Address 0x%02x already in "
1228 "use, not probing\n", addr_list[i]);
1229 continue;
1230 }
1231
1232 /* Test address responsiveness
1233 The default probe method is a quick write, but it is known
1234 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1235 and could also irreversibly write-protect some EEPROMs, so
1236 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1237 read instead. Also, some bus drivers don't implement
1238 quick write, so we fallback to a byte read it that case
1239 too. */
1240 if ((addr_list[i] & ~0x07) == 0x30
1241 || (addr_list[i] & ~0x0f) == 0x50
1242 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1243 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1244 I2C_SMBUS_READ, 0,
1245 I2C_SMBUS_BYTE, NULL) >= 0)
1246 break;
1247 } else {
1248 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1249 I2C_SMBUS_WRITE, 0,
1250 I2C_SMBUS_QUICK, NULL) >= 0)
1251 break;
1252 }
1253 }
Jean Delvare12b50532007-05-01 23:26:31 +02001254
1255 if (addr_list[i] == I2C_CLIENT_END) {
1256 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1257 return NULL;
1258 }
1259
1260 info->addr = addr_list[i];
1261 return i2c_new_device(adap, info);
1262}
1263EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1264
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265struct i2c_adapter* i2c_get_adapter(int id)
1266{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001268
Jean Delvarecaada322008-01-27 18:14:49 +01001269 mutex_lock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001270 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1271 if (adapter && !try_module_get(adapter->owner))
1272 adapter = NULL;
1273
Jean Delvarecaada322008-01-27 18:14:49 +01001274 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001275 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276}
David Brownellc0564602007-05-01 23:26:31 +02001277EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
1279void i2c_put_adapter(struct i2c_adapter *adap)
1280{
1281 module_put(adap->owner);
1282}
David Brownellc0564602007-05-01 23:26:31 +02001283EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
1285/* The SMBus parts */
1286
David Brownell438d6c22006-12-10 21:21:31 +01001287#define POLY (0x1070U << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288static u8
1289crc8(u16 data)
1290{
1291 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 for(i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001294 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 data = data ^ POLY;
1296 data = data << 1;
1297 }
1298 return (u8)(data >> 8);
1299}
1300
Jean Delvare421ef472005-10-26 21:28:55 +02001301/* Incremental CRC8 over count bytes in the array pointed to by p */
1302static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303{
1304 int i;
1305
1306 for(i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001307 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 return crc;
1309}
1310
Jean Delvare421ef472005-10-26 21:28:55 +02001311/* Assume a 7-bit address, which is reasonable for SMBus */
1312static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313{
Jean Delvare421ef472005-10-26 21:28:55 +02001314 /* The address will be sent first */
1315 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1316 pec = i2c_smbus_pec(pec, &addr, 1);
1317
1318 /* The data buffer follows */
1319 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320}
1321
Jean Delvare421ef472005-10-26 21:28:55 +02001322/* Used for write only transactions */
1323static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324{
Jean Delvare421ef472005-10-26 21:28:55 +02001325 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1326 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327}
1328
Jean Delvare421ef472005-10-26 21:28:55 +02001329/* Return <0 on CRC error
1330 If there was a write before this read (most cases) we need to take the
1331 partial CRC from the write part into account.
1332 Note that this function does modify the message (we need to decrease the
1333 message length to hide the CRC byte from the caller). */
1334static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335{
Jean Delvare421ef472005-10-26 21:28:55 +02001336 u8 rpec = msg->buf[--msg->len];
1337 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 if (rpec != cpec) {
1340 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1341 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02001342 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 }
David Brownell438d6c22006-12-10 21:21:31 +01001344 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345}
1346
David Brownella1cdeda2008-07-14 22:38:24 +02001347/**
1348 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1349 * @client: Handle to slave device
1350 *
1351 * This executes the SMBus "receive byte" protocol, returning negative errno
1352 * else the byte received from the device.
1353 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354s32 i2c_smbus_read_byte(struct i2c_client *client)
1355{
1356 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001357 int status;
1358
1359 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1360 I2C_SMBUS_READ, 0,
1361 I2C_SMBUS_BYTE, &data);
1362 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363}
David Brownellc0564602007-05-01 23:26:31 +02001364EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
David Brownella1cdeda2008-07-14 22:38:24 +02001366/**
1367 * i2c_smbus_write_byte - SMBus "send byte" protocol
1368 * @client: Handle to slave device
1369 * @value: Byte to be sent
1370 *
1371 * This executes the SMBus "send byte" protocol, returning negative errno
1372 * else zero on success.
1373 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1375{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001377 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378}
David Brownellc0564602007-05-01 23:26:31 +02001379EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
David Brownella1cdeda2008-07-14 22:38:24 +02001381/**
1382 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1383 * @client: Handle to slave device
1384 * @command: Byte interpreted by slave
1385 *
1386 * This executes the SMBus "read byte" protocol, returning negative errno
1387 * else a data byte received from the device.
1388 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1390{
1391 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001392 int status;
1393
1394 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1395 I2C_SMBUS_READ, command,
1396 I2C_SMBUS_BYTE_DATA, &data);
1397 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398}
David Brownellc0564602007-05-01 23:26:31 +02001399EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
David Brownella1cdeda2008-07-14 22:38:24 +02001401/**
1402 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1403 * @client: Handle to slave device
1404 * @command: Byte interpreted by slave
1405 * @value: Byte being written
1406 *
1407 * This executes the SMBus "write byte" protocol, returning negative errno
1408 * else zero on success.
1409 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1411{
1412 union i2c_smbus_data data;
1413 data.byte = value;
1414 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1415 I2C_SMBUS_WRITE,command,
1416 I2C_SMBUS_BYTE_DATA,&data);
1417}
David Brownellc0564602007-05-01 23:26:31 +02001418EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
David Brownella1cdeda2008-07-14 22:38:24 +02001420/**
1421 * i2c_smbus_read_word_data - SMBus "read word" protocol
1422 * @client: Handle to slave device
1423 * @command: Byte interpreted by slave
1424 *
1425 * This executes the SMBus "read word" protocol, returning negative errno
1426 * else a 16-bit unsigned "word" received from the device.
1427 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1429{
1430 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001431 int status;
1432
1433 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1434 I2C_SMBUS_READ, command,
1435 I2C_SMBUS_WORD_DATA, &data);
1436 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437}
David Brownellc0564602007-05-01 23:26:31 +02001438EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
David Brownella1cdeda2008-07-14 22:38:24 +02001440/**
1441 * i2c_smbus_write_word_data - SMBus "write word" protocol
1442 * @client: Handle to slave device
1443 * @command: Byte interpreted by slave
1444 * @value: 16-bit "word" being written
1445 *
1446 * This executes the SMBus "write word" protocol, returning negative errno
1447 * else zero on success.
1448 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1450{
1451 union i2c_smbus_data data;
1452 data.word = value;
1453 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1454 I2C_SMBUS_WRITE,command,
1455 I2C_SMBUS_WORD_DATA,&data);
1456}
David Brownellc0564602007-05-01 23:26:31 +02001457EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
David Brownella64ec072007-10-13 23:56:31 +02001459/**
David Brownella1cdeda2008-07-14 22:38:24 +02001460 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02001461 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02001462 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02001463 * @values: Byte array into which data will be read; big enough to hold
1464 * the data returned by the slave. SMBus allows at most 32 bytes.
1465 *
David Brownella1cdeda2008-07-14 22:38:24 +02001466 * This executes the SMBus "block read" protocol, returning negative errno
1467 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02001468 *
1469 * Note that using this function requires that the client's adapter support
1470 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1471 * support this; its emulation through I2C messaging relies on a specific
1472 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1473 */
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001474s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1475 u8 *values)
1476{
1477 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001478 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001479
David Brownell24a5bb72008-07-14 22:38:23 +02001480 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1481 I2C_SMBUS_READ, command,
1482 I2C_SMBUS_BLOCK_DATA, &data);
1483 if (status)
1484 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001485
1486 memcpy(values, &data.block[1], data.block[0]);
1487 return data.block[0];
1488}
1489EXPORT_SYMBOL(i2c_smbus_read_block_data);
1490
David Brownella1cdeda2008-07-14 22:38:24 +02001491/**
1492 * i2c_smbus_write_block_data - SMBus "block write" protocol
1493 * @client: Handle to slave device
1494 * @command: Byte interpreted by slave
1495 * @length: Size of data block; SMBus allows at most 32 bytes
1496 * @values: Byte array which will be written.
1497 *
1498 * This executes the SMBus "block write" protocol, returning negative errno
1499 * else zero on success.
1500 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001502 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503{
1504 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001505
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 if (length > I2C_SMBUS_BLOCK_MAX)
1507 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01001509 memcpy(&data.block[1], values, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1511 I2C_SMBUS_WRITE,command,
1512 I2C_SMBUS_BLOCK_DATA,&data);
1513}
David Brownellc0564602007-05-01 23:26:31 +02001514EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
1516/* Returns the number of read bytes */
Jean Delvare4b2643d2007-07-12 14:12:29 +02001517s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1518 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519{
1520 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001521 int status;
Jean Delvare76560322006-01-18 23:14:55 +01001522
Jean Delvare4b2643d2007-07-12 14:12:29 +02001523 if (length > I2C_SMBUS_BLOCK_MAX)
1524 length = I2C_SMBUS_BLOCK_MAX;
1525 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02001526 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1527 I2C_SMBUS_READ, command,
1528 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1529 if (status < 0)
1530 return status;
Jean Delvare76560322006-01-18 23:14:55 +01001531
1532 memcpy(values, &data.block[1], data.block[0]);
1533 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534}
David Brownellc0564602007-05-01 23:26:31 +02001535EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Jean Delvare21bbd692006-01-09 15:19:18 +11001537s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001538 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11001539{
1540 union i2c_smbus_data data;
1541
1542 if (length > I2C_SMBUS_BLOCK_MAX)
1543 length = I2C_SMBUS_BLOCK_MAX;
1544 data.block[0] = length;
1545 memcpy(data.block + 1, values, length);
1546 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1547 I2C_SMBUS_WRITE, command,
1548 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1549}
David Brownellc0564602007-05-01 23:26:31 +02001550EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11001551
David Brownell438d6c22006-12-10 21:21:31 +01001552/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 No checking of parameters is done! */
David Brownell438d6c22006-12-10 21:21:31 +01001554static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001556 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 union i2c_smbus_data * data)
1558{
1559 /* So we need to generate a series of msgs. In the case of writing, we
1560 need to use only one message; when reading, we need two. We initialize
1561 most things with sane defaults, to keep the code below somewhat
1562 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001563 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1564 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 int num = read_write == I2C_SMBUS_READ?2:1;
David Brownell438d6c22006-12-10 21:21:31 +01001566 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1568 };
1569 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02001570 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02001571 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
1573 msgbuf0[0] = command;
1574 switch(size) {
1575 case I2C_SMBUS_QUICK:
1576 msg[0].len = 0;
1577 /* Special case: The read/write field is used as data */
1578 msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
1579 num = 1;
1580 break;
1581 case I2C_SMBUS_BYTE:
1582 if (read_write == I2C_SMBUS_READ) {
1583 /* Special case: only a read! */
1584 msg[0].flags = I2C_M_RD | flags;
1585 num = 1;
1586 }
1587 break;
1588 case I2C_SMBUS_BYTE_DATA:
1589 if (read_write == I2C_SMBUS_READ)
1590 msg[1].len = 1;
1591 else {
1592 msg[0].len = 2;
1593 msgbuf0[1] = data->byte;
1594 }
1595 break;
1596 case I2C_SMBUS_WORD_DATA:
1597 if (read_write == I2C_SMBUS_READ)
1598 msg[1].len = 2;
1599 else {
1600 msg[0].len=3;
1601 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001602 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 }
1604 break;
1605 case I2C_SMBUS_PROC_CALL:
1606 num = 2; /* Special case */
1607 read_write = I2C_SMBUS_READ;
1608 msg[0].len = 3;
1609 msg[1].len = 2;
1610 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001611 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 break;
1613 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02001615 msg[1].flags |= I2C_M_RECV_LEN;
1616 msg[1].len = 1; /* block length will be added by
1617 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 } else {
1619 msg[0].len = data->block[0] + 2;
1620 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02001621 dev_err(&adapter->dev,
1622 "Invalid block write size %d\n",
1623 data->block[0]);
1624 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001626 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 msgbuf0[i] = data->block[i-1];
1628 }
1629 break;
1630 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02001631 num = 2; /* Another special case */
1632 read_write = I2C_SMBUS_READ;
1633 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02001634 dev_err(&adapter->dev,
1635 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02001636 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02001637 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02001638 }
1639 msg[0].len = data->block[0] + 2;
1640 for (i = 1; i < msg[0].len; i++)
1641 msgbuf0[i] = data->block[i-1];
1642 msg[1].flags |= I2C_M_RECV_LEN;
1643 msg[1].len = 1; /* block length will be added by
1644 the underlying bus driver */
1645 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 case I2C_SMBUS_I2C_BLOCK_DATA:
1647 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02001648 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 } else {
1650 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02001651 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02001652 dev_err(&adapter->dev,
1653 "Invalid block write size %d\n",
1654 data->block[0]);
1655 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656 }
1657 for (i = 1; i <= data->block[0]; i++)
1658 msgbuf0[i] = data->block[i];
1659 }
1660 break;
1661 default:
David Brownell24a5bb72008-07-14 22:38:23 +02001662 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1663 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 }
1665
Jean Delvare421ef472005-10-26 21:28:55 +02001666 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1667 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1668 if (i) {
1669 /* Compute PEC if first message is a write */
1670 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01001671 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02001672 i2c_smbus_add_pec(&msg[0]);
1673 else /* Write followed by read */
1674 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1675 }
1676 /* Ask for PEC if last message is a read */
1677 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01001678 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02001679 }
1680
David Brownell24a5bb72008-07-14 22:38:23 +02001681 status = i2c_transfer(adapter, msg, num);
1682 if (status < 0)
1683 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684
Jean Delvare421ef472005-10-26 21:28:55 +02001685 /* Check PEC if last message is a read */
1686 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02001687 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1688 if (status < 0)
1689 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02001690 }
1691
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 if (read_write == I2C_SMBUS_READ)
1693 switch(size) {
1694 case I2C_SMBUS_BYTE:
1695 data->byte = msgbuf0[0];
1696 break;
1697 case I2C_SMBUS_BYTE_DATA:
1698 data->byte = msgbuf1[0];
1699 break;
David Brownell438d6c22006-12-10 21:21:31 +01001700 case I2C_SMBUS_WORD_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 case I2C_SMBUS_PROC_CALL:
1702 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1703 break;
1704 case I2C_SMBUS_I2C_BLOCK_DATA:
Jean Delvare4b2643d2007-07-12 14:12:29 +02001705 for (i = 0; i < data->block[0]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 data->block[i+1] = msgbuf1[i];
1707 break;
Jean Delvare209d27c2007-05-01 23:26:29 +02001708 case I2C_SMBUS_BLOCK_DATA:
1709 case I2C_SMBUS_BLOCK_PROC_CALL:
1710 for (i = 0; i < msgbuf1[0] + 1; i++)
1711 data->block[i] = msgbuf1[i];
1712 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 }
1714 return 0;
1715}
1716
David Brownella1cdeda2008-07-14 22:38:24 +02001717/**
1718 * i2c_smbus_xfer - execute SMBus protocol operations
1719 * @adapter: Handle to I2C bus
1720 * @addr: Address of SMBus slave on that bus
1721 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1722 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1723 * @command: Byte interpreted by slave, for protocols which use such bytes
1724 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1725 * @data: Data to be read or written
1726 *
1727 * This executes an SMBus protocol operation, and returns a negative
1728 * errno code else zero on success.
1729 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02001731 char read_write, u8 command, int protocol,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 union i2c_smbus_data * data)
1733{
1734 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735
1736 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
1738 if (adapter->algo->smbus_xfer) {
Ingo Molnar5c085d32006-01-18 23:16:04 +01001739 mutex_lock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02001741 command, protocol, data);
Ingo Molnar5c085d32006-01-18 23:16:04 +01001742 mutex_unlock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 } else
1744 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02001745 command, protocol, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 return res;
1748}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
1751MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1752MODULE_DESCRIPTION("I2C-Bus main module");
1753MODULE_LICENSE("GPL");