blob: 5e249d7588285f0fcc8458f7eb5670762da39a22 [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
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);
Hans Verkuil50c33042008-03-12 14:15:00 +0100104 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200105
Jean Delvaree0457442008-07-14 22:38:30 +0200106 if (!driver->probe || !driver->id_table)
David Brownell7b4fbc52007-05-01 23:26:30 +0200107 return -ENODEV;
108 client->driver = driver;
109 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200110
Jean Delvaree0457442008-07-14 22:38:30 +0200111 status = driver->probe(client, i2c_match_id(driver->id_table, client));
Hans Verkuil50c33042008-03-12 14:15:00 +0100112 if (status)
113 client->driver = NULL;
114 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115}
116
117static int i2c_device_remove(struct device *dev)
118{
David Brownella1d9e6e2007-05-01 23:26:30 +0200119 struct i2c_client *client = to_i2c_client(dev);
120 struct i2c_driver *driver;
121 int status;
122
123 if (!dev->driver)
124 return 0;
125
126 driver = to_i2c_driver(dev->driver);
127 if (driver->remove) {
128 dev_dbg(dev, "remove\n");
129 status = driver->remove(client);
130 } else {
131 dev->driver = NULL;
132 status = 0;
133 }
134 if (status == 0)
135 client->driver = NULL;
136 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137}
138
David Brownellf37dd802007-02-13 22:09:00 +0100139static void i2c_device_shutdown(struct device *dev)
140{
141 struct i2c_driver *driver;
142
143 if (!dev->driver)
144 return;
145 driver = to_i2c_driver(dev->driver);
146 if (driver->shutdown)
147 driver->shutdown(to_i2c_client(dev));
148}
149
150static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
151{
152 struct i2c_driver *driver;
153
154 if (!dev->driver)
155 return 0;
156 driver = to_i2c_driver(dev->driver);
157 if (!driver->suspend)
158 return 0;
159 return driver->suspend(to_i2c_client(dev), mesg);
160}
161
162static int i2c_device_resume(struct device * dev)
163{
164 struct i2c_driver *driver;
165
166 if (!dev->driver)
167 return 0;
168 driver = to_i2c_driver(dev->driver);
169 if (!driver->resume)
170 return 0;
171 return driver->resume(to_i2c_client(dev));
172}
173
David Brownell7b4fbc52007-05-01 23:26:30 +0200174static void i2c_client_release(struct device *dev)
175{
176 struct i2c_client *client = to_i2c_client(dev);
177 complete(&client->released);
178}
179
David Brownell9c1600e2007-05-01 23:26:31 +0200180static void i2c_client_dev_release(struct device *dev)
181{
182 kfree(to_i2c_client(dev));
183}
184
David Brownell7b4fbc52007-05-01 23:26:30 +0200185static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
186{
187 struct i2c_client *client = to_i2c_client(dev);
188 return sprintf(buf, "%s\n", client->name);
189}
190
191static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
192{
193 struct i2c_client *client = to_i2c_client(dev);
Jean Delvareeb8a7902008-05-18 20:49:41 +0200194 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200195}
196
197static struct device_attribute i2c_dev_attrs[] = {
198 __ATTR(name, S_IRUGO, show_client_name, NULL),
199 /* modalias helps coldplug: modprobe $(cat .../modalias) */
200 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
201 { },
202};
203
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200204struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100205 .name = "i2c",
David Brownell7b4fbc52007-05-01 23:26:30 +0200206 .dev_attrs = i2c_dev_attrs,
David Brownellf37dd802007-02-13 22:09:00 +0100207 .match = i2c_device_match,
David Brownell7b4fbc52007-05-01 23:26:30 +0200208 .uevent = i2c_device_uevent,
David Brownellf37dd802007-02-13 22:09:00 +0100209 .probe = i2c_device_probe,
210 .remove = i2c_device_remove,
211 .shutdown = i2c_device_shutdown,
212 .suspend = i2c_device_suspend,
213 .resume = i2c_device_resume,
Russell Kingb864c7d2006-01-05 14:37:50 +0000214};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200215EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000216
David Brownell9b766b82008-01-27 18:14:51 +0100217
218/**
219 * i2c_verify_client - return parameter as i2c_client, or NULL
220 * @dev: device, probably from some driver model iterator
221 *
222 * When traversing the driver model tree, perhaps using driver model
223 * iterators like @device_for_each_child(), you can't assume very much
224 * about the nodes you find. Use this function to avoid oopses caused
225 * by wrongly treating some non-I2C device as an i2c_client.
226 */
227struct i2c_client *i2c_verify_client(struct device *dev)
228{
229 return (dev->bus == &i2c_bus_type)
230 ? to_i2c_client(dev)
231 : NULL;
232}
233EXPORT_SYMBOL(i2c_verify_client);
234
235
David Brownell9c1600e2007-05-01 23:26:31 +0200236/**
237 * i2c_new_device - instantiate an i2c device for use with a new style driver
238 * @adap: the adapter managing the device
239 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200240 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200241 *
242 * Create a device to work with a new style i2c driver, where binding is
243 * handled through driver model probe()/remove() methods. This call is not
244 * appropriate for use by mainboad initialization logic, which usually runs
245 * during an arch_initcall() long before any i2c_adapter could exist.
246 *
247 * This returns the new i2c client, which may be saved for later use with
248 * i2c_unregister_device(); or NULL to indicate an error.
249 */
250struct i2c_client *
251i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
252{
253 struct i2c_client *client;
254 int status;
255
256 client = kzalloc(sizeof *client, GFP_KERNEL);
257 if (!client)
258 return NULL;
259
260 client->adapter = adap;
261
262 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200263 device_init_wakeup(&client->dev, info->flags & I2C_CLIENT_WAKE);
264
265 client->flags = info->flags & ~I2C_CLIENT_WAKE;
David Brownell9c1600e2007-05-01 23:26:31 +0200266 client->addr = info->addr;
267 client->irq = info->irq;
268
David Brownell9c1600e2007-05-01 23:26:31 +0200269 strlcpy(client->name, info->type, sizeof(client->name));
270
271 /* a new style driver may be bound to this device when we
272 * return from this function, or any later moment (e.g. maybe
273 * hotplugging will load the driver module). and the device
274 * refcount model is the standard driver model one.
275 */
276 status = i2c_attach_client(client);
277 if (status < 0) {
278 kfree(client);
279 client = NULL;
280 }
281 return client;
282}
283EXPORT_SYMBOL_GPL(i2c_new_device);
284
285
286/**
287 * i2c_unregister_device - reverse effect of i2c_new_device()
288 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200289 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200290 */
291void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200292{
293 struct i2c_adapter *adapter = client->adapter;
294 struct i2c_driver *driver = client->driver;
295
296 if (driver && !is_newstyle_driver(driver)) {
297 dev_err(&client->dev, "can't unregister devices "
298 "with legacy drivers\n");
299 WARN_ON(1);
300 return;
301 }
302
Jean Delvare85081592008-07-14 22:38:36 +0200303 if (adapter->client_unregister) {
304 if (adapter->client_unregister(client)) {
305 dev_warn(&client->dev,
306 "client_unregister [%s] failed\n",
307 client->name);
308 }
309 }
310
David Brownella1d9e6e2007-05-01 23:26:30 +0200311 mutex_lock(&adapter->clist_lock);
312 list_del(&client->list);
313 mutex_unlock(&adapter->clist_lock);
314
315 device_unregister(&client->dev);
316}
David Brownell9c1600e2007-05-01 23:26:31 +0200317EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200318
319
Jean Delvare60b129d2008-05-11 20:37:06 +0200320static const struct i2c_device_id dummy_id[] = {
321 { "dummy", 0 },
322 { },
323};
324
Jean Delvared2653e92008-04-29 23:11:39 +0200325static int dummy_probe(struct i2c_client *client,
326 const struct i2c_device_id *id)
327{
328 return 0;
329}
330
331static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100332{
333 return 0;
334}
335
336static struct i2c_driver dummy_driver = {
337 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200338 .probe = dummy_probe,
339 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200340 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100341};
342
343/**
344 * i2c_new_dummy - return a new i2c device bound to a dummy driver
345 * @adapter: the adapter managing the device
346 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100347 * Context: can sleep
348 *
349 * This returns an I2C client bound to the "dummy" driver, intended for use
350 * with devices that consume multiple addresses. Examples of such chips
351 * include various EEPROMS (like 24c04 and 24c08 models).
352 *
353 * These dummy devices have two main uses. First, most I2C and SMBus calls
354 * except i2c_transfer() need a client handle; the dummy will be that handle.
355 * And second, this prevents the specified address from being bound to a
356 * different driver.
357 *
358 * This returns the new i2c client, which should be saved for later use with
359 * i2c_unregister_device(); or NULL to indicate an error.
360 */
361struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200362i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100363{
364 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200365 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100366 };
367
David Brownelle9f13732008-01-27 18:14:52 +0100368 return i2c_new_device(adapter, &info);
369}
370EXPORT_SYMBOL_GPL(i2c_new_dummy);
371
David Brownellf37dd802007-02-13 22:09:00 +0100372/* ------------------------------------------------------------------------- */
373
David Brownell16ffadf2007-05-01 23:26:28 +0200374/* I2C bus adapters -- one roots each I2C or SMBUS segment */
375
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200376static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377{
David Brownellef2c83212007-05-01 23:26:28 +0200378 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 complete(&adap->dev_released);
380}
381
David Brownell16ffadf2007-05-01 23:26:28 +0200382static ssize_t
383show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
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 return sprintf(buf, "%s\n", adap->name);
387}
David Brownell16ffadf2007-05-01 23:26:28 +0200388
389static struct device_attribute i2c_adapter_attrs[] = {
390 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
391 { },
392};
393
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200394static struct class i2c_adapter_class = {
David Brownell16ffadf2007-05-01 23:26:28 +0200395 .owner = THIS_MODULE,
396 .name = "i2c-adapter",
397 .dev_attrs = i2c_adapter_attrs,
398};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
David Brownell9c1600e2007-05-01 23:26:31 +0200400static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
401{
402 struct i2c_devinfo *devinfo;
403
404 mutex_lock(&__i2c_board_lock);
405 list_for_each_entry(devinfo, &__i2c_board_list, list) {
406 if (devinfo->busnum == adapter->nr
407 && !i2c_new_device(adapter,
408 &devinfo->board_info))
409 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
410 i2c_adapter_id(adapter),
411 devinfo->board_info.addr);
412 }
413 mutex_unlock(&__i2c_board_lock);
414}
415
Jean Delvare026526f2008-01-27 18:14:49 +0100416static int i2c_do_add_adapter(struct device_driver *d, void *data)
417{
418 struct i2c_driver *driver = to_i2c_driver(d);
419 struct i2c_adapter *adap = data;
420
421 if (driver->attach_adapter) {
422 /* We ignore the return code; if it fails, too bad */
423 driver->attach_adapter(adap);
424 }
425 return 0;
426}
427
David Brownell6e13e642007-05-01 23:26:31 +0200428static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429{
Jean Delvare026526f2008-01-27 18:14:49 +0100430 int res = 0, dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Ingo Molnar5c085d32006-01-18 23:16:04 +0100432 mutex_init(&adap->bus_lock);
433 mutex_init(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 INIT_LIST_HEAD(&adap->clients);
435
Jean Delvarecaada322008-01-27 18:14:49 +0100436 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 /* Add the adapter to the driver core.
439 * If the parent pointer is not set up,
440 * we add this adapter to the host bus.
441 */
David Brownellb119dc32007-01-04 13:07:04 +0100442 if (adap->dev.parent == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 adap->dev.parent = &platform_bus;
Jean Delvarefe2c8d52007-02-13 22:09:04 +0100444 pr_debug("I2C adapter driver [%s] forgot to specify "
445 "physical device\n", adap->name);
David Brownellb119dc32007-01-04 13:07:04 +0100446 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 adap->dev.release = &i2c_adapter_dev_release;
Jean Delvarefccb56e2007-05-01 23:26:27 +0200449 adap->dev.class = &i2c_adapter_class;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200450 res = device_register(&adap->dev);
451 if (res)
452 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200454 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
455
David Brownell6e13e642007-05-01 23:26:31 +0200456 /* create pre-declared device nodes for new-style drivers */
457 if (adap->nr < __i2c_first_dynamic_bus_num)
458 i2c_scan_static_board_info(adap);
459
David Brownell7b4fbc52007-05-01 23:26:30 +0200460 /* let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +0100461 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
462 i2c_do_add_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100465 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 return res;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200467
Jean Delvareb119c6c2006-08-15 18:26:30 +0200468out_list:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200469 idr_remove(&i2c_adapter_idr, adap->nr);
470 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471}
472
David Brownell6e13e642007-05-01 23:26:31 +0200473/**
474 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
475 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +0200476 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200477 *
478 * This routine is used to declare an I2C adapter when its bus number
479 * doesn't matter. Examples: for I2C adapters dynamically added by
480 * USB links or PCI plugin cards.
481 *
482 * When this returns zero, a new bus number was allocated and stored
483 * in adap->nr, and the specified adapter became available for clients.
484 * Otherwise, a negative errno value is returned.
485 */
486int i2c_add_adapter(struct i2c_adapter *adapter)
487{
488 int id, res = 0;
489
490retry:
491 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
492 return -ENOMEM;
493
Jean Delvarecaada322008-01-27 18:14:49 +0100494 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200495 /* "above" here means "above or equal to", sigh */
496 res = idr_get_new_above(&i2c_adapter_idr, adapter,
497 __i2c_first_dynamic_bus_num, &id);
Jean Delvarecaada322008-01-27 18:14:49 +0100498 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200499
500 if (res < 0) {
501 if (res == -EAGAIN)
502 goto retry;
503 return res;
504 }
505
506 adapter->nr = id;
507 return i2c_register_adapter(adapter);
508}
509EXPORT_SYMBOL(i2c_add_adapter);
510
511/**
512 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
513 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +0200514 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200515 *
516 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +0100517 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
518 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +0200519 * is used to properly configure I2C devices.
520 *
521 * If no devices have pre-been declared for this bus, then be sure to
522 * register the adapter before any dynamically allocated ones. Otherwise
523 * the required bus ID may not be available.
524 *
525 * When this returns zero, the specified adapter became available for
526 * clients using the bus number provided in adap->nr. Also, the table
527 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
528 * and the appropriate driver model device nodes are created. Otherwise, a
529 * negative errno value is returned.
530 */
531int i2c_add_numbered_adapter(struct i2c_adapter *adap)
532{
533 int id;
534 int status;
535
536 if (adap->nr & ~MAX_ID_MASK)
537 return -EINVAL;
538
539retry:
540 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
541 return -ENOMEM;
542
Jean Delvarecaada322008-01-27 18:14:49 +0100543 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200544 /* "above" here means "above or equal to", sigh;
545 * we need the "equal to" result to force the result
546 */
547 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
548 if (status == 0 && id != adap->nr) {
549 status = -EBUSY;
550 idr_remove(&i2c_adapter_idr, id);
551 }
Jean Delvarecaada322008-01-27 18:14:49 +0100552 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200553 if (status == -EAGAIN)
554 goto retry;
555
556 if (status == 0)
557 status = i2c_register_adapter(adap);
558 return status;
559}
560EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
561
Jean Delvare026526f2008-01-27 18:14:49 +0100562static int i2c_do_del_adapter(struct device_driver *d, void *data)
563{
564 struct i2c_driver *driver = to_i2c_driver(d);
565 struct i2c_adapter *adapter = data;
566 int res;
567
568 if (!driver->detach_adapter)
569 return 0;
570 res = driver->detach_adapter(adapter);
571 if (res)
572 dev_err(&adapter->dev, "detach_adapter failed (%d) "
573 "for driver [%s]\n", res, driver->driver.name);
574 return res;
575}
576
David Brownelld64f73b2007-07-12 14:12:28 +0200577/**
578 * i2c_del_adapter - unregister I2C adapter
579 * @adap: the adapter being unregistered
580 * Context: can sleep
581 *
582 * This unregisters an I2C adapter which was previously registered
583 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
584 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585int i2c_del_adapter(struct i2c_adapter *adap)
586{
Matthias Kaehlcke6a03cd932008-07-14 22:38:26 +0200587 struct i2c_client *client, *_n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 int res = 0;
589
Jean Delvarecaada322008-01-27 18:14:49 +0100590 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
592 /* First make sure that this adapter was ever added */
Jean Delvare87c6c222008-01-27 18:14:48 +0100593 if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200594 pr_debug("i2c-core: attempting to delete unregistered "
595 "adapter [%s]\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 res = -EINVAL;
597 goto out_unlock;
598 }
599
Jean Delvare026526f2008-01-27 18:14:49 +0100600 /* Tell drivers about this removal */
601 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
602 i2c_do_del_adapter);
603 if (res)
604 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
606 /* detach any active clients. This must be done first, because
Tobias Klausera551acc2005-05-19 21:40:38 +0200607 * it can fail; in which case we give up. */
Matthias Kaehlcke6a03cd932008-07-14 22:38:26 +0200608 list_for_each_entry_safe(client, _n, &adap->clients, list) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200609 struct i2c_driver *driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
David Brownella1d9e6e2007-05-01 23:26:30 +0200611 driver = client->driver;
612
613 /* new style, follow standard driver model */
614 if (!driver || is_newstyle_driver(driver)) {
615 i2c_unregister_device(client);
616 continue;
617 }
618
619 /* legacy drivers create and remove clients themselves */
620 if ((res = driver->detach_client(client))) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200621 dev_err(&adap->dev, "detach_client failed for client "
622 "[%s] at address 0x%02x\n", client->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 client->addr);
624 goto out_unlock;
625 }
626 }
627
628 /* clean up the sysfs representation */
629 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
632 /* wait for sysfs to drop all references */
633 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
David Brownell6e13e642007-05-01 23:26:31 +0200635 /* free bus id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 idr_remove(&i2c_adapter_idr, adap->nr);
637
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200638 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640 out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100641 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 return res;
643}
David Brownellc0564602007-05-01 23:26:31 +0200644EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
646
David Brownell7b4fbc52007-05-01 23:26:30 +0200647/* ------------------------------------------------------------------------- */
648
Dave Young7f101a92008-07-14 22:38:19 +0200649static int __attach_adapter(struct device *dev, void *data)
650{
651 struct i2c_adapter *adapter = to_i2c_adapter(dev);
652 struct i2c_driver *driver = data;
653
654 driver->attach_adapter(adapter);
655
656 return 0;
657}
658
David Brownell7b4fbc52007-05-01 23:26:30 +0200659/*
660 * An i2c_driver is used with one or more i2c_client (device) nodes to access
661 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
662 * are two models for binding the driver to its device: "new style" drivers
663 * follow the standard Linux driver model and just respond to probe() calls
664 * issued if the driver core sees they match(); "legacy" drivers create device
665 * nodes themselves.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 */
667
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800668int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669{
Jean Delvare7eebcb72006-02-05 23:28:21 +0100670 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
David Brownell7b4fbc52007-05-01 23:26:30 +0200672 /* new style driver methods can't mix with legacy ones */
David Brownella1d9e6e2007-05-01 23:26:30 +0200673 if (is_newstyle_driver(driver)) {
David Brownell7b4fbc52007-05-01 23:26:30 +0200674 if (driver->attach_adapter || driver->detach_adapter
675 || driver->detach_client) {
676 printk(KERN_WARNING
677 "i2c-core: driver [%s] is confused\n",
678 driver->driver.name);
679 return -EINVAL;
680 }
681 }
682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800684 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
David Brownell6e13e642007-05-01 23:26:31 +0200687 /* for new style drivers, when registration returns the driver core
688 * will have called probe() for all matching-but-unbound devices.
689 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 res = driver_register(&driver->driver);
691 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +0100692 return res;
David Brownell438d6c22006-12-10 21:21:31 +0100693
Jean Delvarecaada322008-01-27 18:14:49 +0100694 mutex_lock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100695
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100696 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
David Brownell7b4fbc52007-05-01 23:26:30 +0200698 /* legacy drivers scan i2c busses directly */
Dave Young7f101a92008-07-14 22:38:19 +0200699 if (driver->attach_adapter)
700 class_for_each_device(&i2c_adapter_class, driver,
701 __attach_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Jean Delvarecaada322008-01-27 18:14:49 +0100703 mutex_unlock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100704 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800706EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Dave Young7f101a92008-07-14 22:38:19 +0200708static int __detach_adapter(struct device *dev, void *data)
709{
710 struct i2c_adapter *adapter = to_i2c_adapter(dev);
711 struct i2c_driver *driver = data;
712
713 /* Have a look at each adapter, if clients of this driver are still
714 * attached. If so, detach them to be able to kill the driver
715 * afterwards.
716 */
717 if (driver->detach_adapter) {
718 if (driver->detach_adapter(adapter))
719 dev_err(&adapter->dev,
720 "detach_adapter failed for driver [%s]\n",
721 driver->driver.name);
722 } else {
Matthias Kaehlcke6a03cd932008-07-14 22:38:26 +0200723 struct i2c_client *client, *_n;
Dave Young7f101a92008-07-14 22:38:19 +0200724
Matthias Kaehlcke6a03cd932008-07-14 22:38:26 +0200725 list_for_each_entry_safe(client, _n, &adapter->clients, list) {
Dave Young7f101a92008-07-14 22:38:19 +0200726 if (client->driver != driver)
727 continue;
728 dev_dbg(&adapter->dev,
729 "detaching client [%s] at 0x%02x\n",
730 client->name, client->addr);
731 if (driver->detach_client(client))
732 dev_err(&adapter->dev, "detach_client "
733 "failed for client [%s] at 0x%02x\n",
734 client->name, client->addr);
735 }
736 }
737
738 return 0;
739}
740
David Brownella1d9e6e2007-05-01 23:26:30 +0200741/**
742 * i2c_del_driver - unregister I2C driver
743 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +0200744 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +0200745 */
Jean Delvareb3e82092007-05-01 23:26:32 +0200746void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
Jean Delvarecaada322008-01-27 18:14:49 +0100748 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Jean Delvaref7050bd2008-07-14 22:38:26 +0200750 /* legacy driver? */
751 if (!is_newstyle_driver(driver))
752 class_for_each_device(&i2c_adapter_class, driver,
753 __detach_adapter);
David Brownella1d9e6e2007-05-01 23:26:30 +0200754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100756 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Jean Delvarecaada322008-01-27 18:14:49 +0100758 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759}
David Brownellc0564602007-05-01 23:26:31 +0200760EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
David Brownell7b4fbc52007-05-01 23:26:30 +0200762/* ------------------------------------------------------------------------- */
763
David Brownell9b766b82008-01-27 18:14:51 +0100764static int __i2c_check_addr(struct device *dev, void *addrp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
David Brownell9b766b82008-01-27 18:14:51 +0100766 struct i2c_client *client = i2c_verify_client(dev);
767 int addr = *(int *)addrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
David Brownell9b766b82008-01-27 18:14:51 +0100769 if (client && client->addr == addr)
770 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 return 0;
772}
773
Jean Delvare5e31c2b2007-11-15 19:24:02 +0100774static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775{
David Brownell9b766b82008-01-27 18:14:51 +0100776 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777}
778
779int i2c_attach_client(struct i2c_client *client)
780{
781 struct i2c_adapter *adapter = client->adapter;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200782 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 client->dev.parent = &client->adapter->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 client->dev.bus = &i2c_bus_type;
David Brownell9c1600e2007-05-01 23:26:31 +0200786
787 if (client->driver)
788 client->dev.driver = &client->driver->driver;
789
David Brownellde81d2a2007-05-22 19:49:16 +0200790 if (client->driver && !is_newstyle_driver(client->driver)) {
David Brownell9c1600e2007-05-01 23:26:31 +0200791 client->dev.release = i2c_client_release;
David Brownellde81d2a2007-05-22 19:49:16 +0200792 client->dev.uevent_suppress = 1;
793 } else
David Brownell9c1600e2007-05-01 23:26:31 +0200794 client->dev.release = i2c_client_dev_release;
David Brownell438d6c22006-12-10 21:21:31 +0100795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
797 "%d-%04x", i2c_adapter_id(adapter), client->addr);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200798 res = device_register(&client->dev);
799 if (res)
David Brownell86ec5ec2008-01-27 18:14:51 +0100800 goto out_err;
801
802 mutex_lock(&adapter->clist_lock);
803 list_add_tail(&client->list, &adapter->clients);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200804 mutex_unlock(&adapter->clist_lock);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200805
David Brownell86ec5ec2008-01-27 18:14:51 +0100806 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
807 client->name, client->dev.bus_id);
808
Jean Delvare77ed74d2006-09-30 17:18:59 +0200809 if (adapter->client_register) {
810 if (adapter->client_register(client)) {
811 dev_dbg(&adapter->dev, "client_register "
812 "failed for client [%s] at 0x%02x\n",
813 client->name, client->addr);
814 }
815 }
816
817 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200818
David Brownell86ec5ec2008-01-27 18:14:51 +0100819out_err:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200820 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
821 "(%d)\n", client->name, client->addr, res);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200822 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823}
David Brownellc0564602007-05-01 23:26:31 +0200824EXPORT_SYMBOL(i2c_attach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
826int i2c_detach_client(struct i2c_client *client)
827{
828 struct i2c_adapter *adapter = client->adapter;
829 int res = 0;
David Brownell438d6c22006-12-10 21:21:31 +0100830
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 if (adapter->client_unregister) {
832 res = adapter->client_unregister(client);
833 if (res) {
834 dev_err(&client->dev,
Jean Delvare86749e82005-07-29 12:15:29 -0700835 "client_unregister [%s] failed, "
836 "client not detached\n", client->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 goto out;
838 }
839 }
840
Ingo Molnar5c085d32006-01-18 23:16:04 +0100841 mutex_lock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 list_del(&client->list);
Jean Delvare9ddced12008-01-27 18:14:51 +0100843 mutex_unlock(&adapter->clist_lock);
844
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 init_completion(&client->released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 device_unregister(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 wait_for_completion(&client->released);
848
849 out:
850 return res;
851}
David Brownellc0564602007-05-01 23:26:31 +0200852EXPORT_SYMBOL(i2c_detach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
Jean Delvaree48d3312008-01-27 18:14:48 +0100854/**
855 * i2c_use_client - increments the reference count of the i2c client structure
856 * @client: the client being referenced
857 *
858 * Each live reference to a client should be refcounted. The driver model does
859 * that automatically as part of driver binding, so that most drivers don't
860 * need to do this explicitly: they hold a reference until they're unbound
861 * from the device.
862 *
863 * A pointer to the client with the incremented reference counter is returned.
864 */
865struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
David Brownell6ea438e2008-07-14 22:38:24 +0200867 if (client && get_device(&client->dev))
868 return client;
869 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870}
David Brownellc0564602007-05-01 23:26:31 +0200871EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
Jean Delvaree48d3312008-01-27 18:14:48 +0100873/**
874 * i2c_release_client - release a use of the i2c client structure
875 * @client: the client being no longer referenced
876 *
877 * Must be called when a user of a client is finished with it.
878 */
879void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
David Brownell6ea438e2008-07-14 22:38:24 +0200881 if (client)
882 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883}
David Brownellc0564602007-05-01 23:26:31 +0200884EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
David Brownell9b766b82008-01-27 18:14:51 +0100886struct i2c_cmd_arg {
887 unsigned cmd;
888 void *arg;
889};
890
891static int i2c_cmd(struct device *dev, void *_arg)
892{
893 struct i2c_client *client = i2c_verify_client(dev);
894 struct i2c_cmd_arg *arg = _arg;
895
896 if (client && client->driver && client->driver->command)
897 client->driver->command(client, arg->cmd, arg->arg);
898 return 0;
899}
900
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
902{
David Brownell9b766b82008-01-27 18:14:51 +0100903 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
David Brownell9b766b82008-01-27 18:14:51 +0100905 cmd_arg.cmd = cmd;
906 cmd_arg.arg = arg;
907 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908}
David Brownellc0564602007-05-01 23:26:31 +0200909EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
911static int __init i2c_init(void)
912{
913 int retval;
914
915 retval = bus_register(&i2c_bus_type);
916 if (retval)
917 return retval;
David Brownelle9f13732008-01-27 18:14:52 +0100918 retval = class_register(&i2c_adapter_class);
919 if (retval)
920 goto bus_err;
921 retval = i2c_add_driver(&dummy_driver);
922 if (retval)
923 goto class_err;
924 return 0;
925
926class_err:
927 class_unregister(&i2c_adapter_class);
928bus_err:
929 bus_unregister(&i2c_bus_type);
930 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931}
932
933static void __exit i2c_exit(void)
934{
David Brownelle9f13732008-01-27 18:14:52 +0100935 i2c_del_driver(&dummy_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 class_unregister(&i2c_adapter_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 bus_unregister(&i2c_bus_type);
938}
939
940subsys_initcall(i2c_init);
941module_exit(i2c_exit);
942
943/* ----------------------------------------------------
944 * the functional interface to the i2c busses.
945 * ----------------------------------------------------
946 */
947
David Brownella1cdeda2008-07-14 22:38:24 +0200948/**
949 * i2c_transfer - execute a single or combined I2C message
950 * @adap: Handle to I2C bus
951 * @msgs: One or more messages to execute before STOP is issued to
952 * terminate the operation; each message begins with a START.
953 * @num: Number of messages to be executed.
954 *
955 * Returns negative errno, else the number of messages executed.
956 *
957 * Note that there is no requirement that each message be sent to
958 * the same slave address, although that is the most common model.
959 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
961{
962 int ret;
963
David Brownella1cdeda2008-07-14 22:38:24 +0200964 /* REVISIT the fault reporting model here is weak:
965 *
966 * - When we get an error after receiving N bytes from a slave,
967 * there is no way to report "N".
968 *
969 * - When we get a NAK after transmitting N bytes to a slave,
970 * there is no way to report "N" ... or to let the master
971 * continue executing the rest of this combined message, if
972 * that's the appropriate response.
973 *
974 * - When for example "num" is two and we successfully complete
975 * the first message but get an error part way through the
976 * second, it's unclear whether that should be reported as
977 * one (discarding status on the second message) or errno
978 * (discarding status on the first one).
979 */
980
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 if (adap->algo->master_xfer) {
982#ifdef DEBUG
983 for (ret = 0; ret < num; ret++) {
984 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +0200985 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
986 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
987 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 }
989#endif
990
Mike Rapoportcea443a82008-01-27 18:14:50 +0100991 if (in_atomic() || irqs_disabled()) {
992 ret = mutex_trylock(&adap->bus_lock);
993 if (!ret)
994 /* I2C activity is ongoing. */
995 return -EAGAIN;
996 } else {
997 mutex_lock_nested(&adap->bus_lock, adap->level);
998 }
999
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 ret = adap->algo->master_xfer(adap,msgs,num);
Ingo Molnar5c085d32006-01-18 23:16:04 +01001001 mutex_unlock(&adap->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
1003 return ret;
1004 } else {
1005 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001006 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 }
1008}
David Brownellc0564602007-05-01 23:26:31 +02001009EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
David Brownella1cdeda2008-07-14 22:38:24 +02001011/**
1012 * i2c_master_send - issue a single I2C message in master transmit mode
1013 * @client: Handle to slave device
1014 * @buf: Data that will be written to the slave
1015 * @count: How many bytes to write
1016 *
1017 * Returns negative errno, or else the number of bytes written.
1018 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1020{
1021 int ret;
1022 struct i2c_adapter *adap=client->adapter;
1023 struct i2c_msg msg;
1024
Jean Delvare815f55f2005-05-07 22:58:46 +02001025 msg.addr = client->addr;
1026 msg.flags = client->flags & I2C_M_TEN;
1027 msg.len = count;
1028 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01001029
Jean Delvare815f55f2005-05-07 22:58:46 +02001030 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
Jean Delvare815f55f2005-05-07 22:58:46 +02001032 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1033 transmitted, else error code. */
1034 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035}
David Brownellc0564602007-05-01 23:26:31 +02001036EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
David Brownella1cdeda2008-07-14 22:38:24 +02001038/**
1039 * i2c_master_recv - issue a single I2C message in master receive mode
1040 * @client: Handle to slave device
1041 * @buf: Where to store data read from slave
1042 * @count: How many bytes to read
1043 *
1044 * Returns negative errno, or else the number of bytes read.
1045 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1047{
1048 struct i2c_adapter *adap=client->adapter;
1049 struct i2c_msg msg;
1050 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
Jean Delvare815f55f2005-05-07 22:58:46 +02001052 msg.addr = client->addr;
1053 msg.flags = client->flags & I2C_M_TEN;
1054 msg.flags |= I2C_M_RD;
1055 msg.len = count;
1056 msg.buf = buf;
1057
1058 ret = i2c_transfer(adap, &msg, 1);
1059
1060 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1061 transmitted, else error code. */
1062 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063}
David Brownellc0564602007-05-01 23:26:31 +02001064EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066/* ----------------------------------------------------
1067 * the i2c address scanning function
1068 * Will not work for 10-bit addresses!
1069 * ----------------------------------------------------
1070 */
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001071static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
1072 int (*found_proc) (struct i2c_adapter *, int, int))
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001073{
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001074 int err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001075
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001076 /* Make sure the address is valid */
1077 if (addr < 0x03 || addr > 0x77) {
1078 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1079 addr);
1080 return -EINVAL;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001081 }
1082
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001083 /* Skip if already in use */
1084 if (i2c_check_addr(adapter, addr))
1085 return 0;
1086
1087 /* Make sure there is something at this address, unless forced */
Jean Delvare4c9337d2005-08-09 20:28:10 +02001088 if (kind < 0) {
1089 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1090 I2C_SMBUS_QUICK, NULL) < 0)
1091 return 0;
1092
1093 /* prevent 24RF08 corruption */
1094 if ((addr & ~0x0f) == 0x50)
1095 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1096 I2C_SMBUS_QUICK, NULL);
1097 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001098
1099 /* Finally call the custom detection function */
1100 err = found_proc(adapter, addr, kind);
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001101 /* -ENODEV can be returned if there is a chip at the given address
1102 but it isn't supported by this chip driver. We catch it here as
1103 this isn't an error. */
Jean Delvare114fd182006-09-03 22:25:04 +02001104 if (err == -ENODEV)
1105 err = 0;
1106
1107 if (err)
1108 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
1109 addr, err);
1110 return err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001111}
1112
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113int i2c_probe(struct i2c_adapter *adapter,
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +01001114 const struct i2c_client_address_data *address_data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 int (*found_proc) (struct i2c_adapter *, int, int))
1116{
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001117 int i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 int adap_id = i2c_adapter_id(adapter);
1119
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001120 /* Force entries are done first, and are not affected by ignore
1121 entries */
1122 if (address_data->forces) {
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +01001123 const unsigned short * const *forces = address_data->forces;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001124 int kind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001126 for (kind = 0; forces[kind]; kind++) {
1127 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1128 i += 2) {
1129 if (forces[kind][i] == adap_id
1130 || forces[kind][i] == ANY_I2C_BUS) {
1131 dev_dbg(&adapter->dev, "found force "
1132 "parameter for adapter %d, "
1133 "addr 0x%02x, kind %d\n",
1134 adap_id, forces[kind][i + 1],
1135 kind);
1136 err = i2c_probe_address(adapter,
1137 forces[kind][i + 1],
1138 kind, found_proc);
1139 if (err)
1140 return err;
1141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 }
1143 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001145
Jean Delvare4366dc92005-09-25 16:50:06 +02001146 /* Stop here if we can't use SMBUS_QUICK */
1147 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1148 if (address_data->probe[0] == I2C_CLIENT_END
1149 && address_data->normal_i2c[0] == I2C_CLIENT_END)
David Brownell438d6c22006-12-10 21:21:31 +01001150 return 0;
Jean Delvare4366dc92005-09-25 16:50:06 +02001151
1152 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1153 "can't probe for chips\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001154 return -EOPNOTSUPP;
Jean Delvare4366dc92005-09-25 16:50:06 +02001155 }
1156
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001157 /* Probe entries are done second, and are not affected by ignore
1158 entries either */
1159 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1160 if (address_data->probe[i] == adap_id
1161 || address_data->probe[i] == ANY_I2C_BUS) {
1162 dev_dbg(&adapter->dev, "found probe parameter for "
1163 "adapter %d, addr 0x%02x\n", adap_id,
1164 address_data->probe[i + 1]);
1165 err = i2c_probe_address(adapter,
1166 address_data->probe[i + 1],
1167 -1, found_proc);
1168 if (err)
1169 return err;
1170 }
1171 }
1172
1173 /* Normal entries are done last, unless shadowed by an ignore entry */
1174 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1175 int j, ignore;
1176
1177 ignore = 0;
1178 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1179 j += 2) {
1180 if ((address_data->ignore[j] == adap_id ||
1181 address_data->ignore[j] == ANY_I2C_BUS)
1182 && address_data->ignore[j + 1]
1183 == address_data->normal_i2c[i]) {
1184 dev_dbg(&adapter->dev, "found ignore "
1185 "parameter for adapter %d, "
1186 "addr 0x%02x\n", adap_id,
1187 address_data->ignore[j + 1]);
Mark M. Hoffman2369df92006-07-01 17:01:59 +02001188 ignore = 1;
1189 break;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001190 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001191 }
1192 if (ignore)
1193 continue;
1194
1195 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1196 "addr 0x%02x\n", adap_id,
1197 address_data->normal_i2c[i]);
1198 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1199 -1, found_proc);
1200 if (err)
1201 return err;
1202 }
1203
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 return 0;
1205}
David Brownellc0564602007-05-01 23:26:31 +02001206EXPORT_SYMBOL(i2c_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207
Jean Delvare12b5053a2007-05-01 23:26:31 +02001208struct i2c_client *
1209i2c_new_probed_device(struct i2c_adapter *adap,
1210 struct i2c_board_info *info,
1211 unsigned short const *addr_list)
1212{
1213 int i;
1214
1215 /* Stop here if the bus doesn't support probing */
1216 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1217 dev_err(&adap->dev, "Probing not supported\n");
1218 return NULL;
1219 }
1220
Jean Delvare12b5053a2007-05-01 23:26:31 +02001221 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1222 /* Check address validity */
1223 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1224 dev_warn(&adap->dev, "Invalid 7-bit address "
1225 "0x%02x\n", addr_list[i]);
1226 continue;
1227 }
1228
1229 /* Check address availability */
David Brownell9b766b82008-01-27 18:14:51 +01001230 if (i2c_check_addr(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001231 dev_dbg(&adap->dev, "Address 0x%02x already in "
1232 "use, not probing\n", addr_list[i]);
1233 continue;
1234 }
1235
1236 /* Test address responsiveness
1237 The default probe method is a quick write, but it is known
1238 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1239 and could also irreversibly write-protect some EEPROMs, so
1240 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1241 read instead. Also, some bus drivers don't implement
1242 quick write, so we fallback to a byte read it that case
1243 too. */
1244 if ((addr_list[i] & ~0x07) == 0x30
1245 || (addr_list[i] & ~0x0f) == 0x50
1246 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1247 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1248 I2C_SMBUS_READ, 0,
1249 I2C_SMBUS_BYTE, NULL) >= 0)
1250 break;
1251 } else {
1252 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1253 I2C_SMBUS_WRITE, 0,
1254 I2C_SMBUS_QUICK, NULL) >= 0)
1255 break;
1256 }
1257 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02001258
1259 if (addr_list[i] == I2C_CLIENT_END) {
1260 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1261 return NULL;
1262 }
1263
1264 info->addr = addr_list[i];
1265 return i2c_new_device(adap, info);
1266}
1267EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269struct i2c_adapter* i2c_get_adapter(int id)
1270{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001272
Jean Delvarecaada322008-01-27 18:14:49 +01001273 mutex_lock(&core_lock);
Mark M. Hoffmana0920e102005-06-28 00:21:30 -04001274 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1275 if (adapter && !try_module_get(adapter->owner))
1276 adapter = NULL;
1277
Jean Delvarecaada322008-01-27 18:14:49 +01001278 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e102005-06-28 00:21:30 -04001279 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280}
David Brownellc0564602007-05-01 23:26:31 +02001281EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
1283void i2c_put_adapter(struct i2c_adapter *adap)
1284{
1285 module_put(adap->owner);
1286}
David Brownellc0564602007-05-01 23:26:31 +02001287EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
1289/* The SMBus parts */
1290
David Brownell438d6c22006-12-10 21:21:31 +01001291#define POLY (0x1070U << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292static u8
1293crc8(u16 data)
1294{
1295 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001296
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 for(i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001298 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 data = data ^ POLY;
1300 data = data << 1;
1301 }
1302 return (u8)(data >> 8);
1303}
1304
Jean Delvare421ef472005-10-26 21:28:55 +02001305/* Incremental CRC8 over count bytes in the array pointed to by p */
1306static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307{
1308 int i;
1309
1310 for(i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001311 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 return crc;
1313}
1314
Jean Delvare421ef472005-10-26 21:28:55 +02001315/* Assume a 7-bit address, which is reasonable for SMBus */
1316static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317{
Jean Delvare421ef472005-10-26 21:28:55 +02001318 /* The address will be sent first */
1319 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1320 pec = i2c_smbus_pec(pec, &addr, 1);
1321
1322 /* The data buffer follows */
1323 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324}
1325
Jean Delvare421ef472005-10-26 21:28:55 +02001326/* Used for write only transactions */
1327static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328{
Jean Delvare421ef472005-10-26 21:28:55 +02001329 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1330 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331}
1332
Jean Delvare421ef472005-10-26 21:28:55 +02001333/* Return <0 on CRC error
1334 If there was a write before this read (most cases) we need to take the
1335 partial CRC from the write part into account.
1336 Note that this function does modify the message (we need to decrease the
1337 message length to hide the CRC byte from the caller). */
1338static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339{
Jean Delvare421ef472005-10-26 21:28:55 +02001340 u8 rpec = msg->buf[--msg->len];
1341 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 if (rpec != cpec) {
1344 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1345 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02001346 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 }
David Brownell438d6c22006-12-10 21:21:31 +01001348 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349}
1350
David Brownella1cdeda2008-07-14 22:38:24 +02001351/**
1352 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1353 * @client: Handle to slave device
1354 *
1355 * This executes the SMBus "receive byte" protocol, returning negative errno
1356 * else the byte received from the device.
1357 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358s32 i2c_smbus_read_byte(struct i2c_client *client)
1359{
1360 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001361 int status;
1362
1363 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1364 I2C_SMBUS_READ, 0,
1365 I2C_SMBUS_BYTE, &data);
1366 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367}
David Brownellc0564602007-05-01 23:26:31 +02001368EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
David Brownella1cdeda2008-07-14 22:38:24 +02001370/**
1371 * i2c_smbus_write_byte - SMBus "send byte" protocol
1372 * @client: Handle to slave device
1373 * @value: Byte to be sent
1374 *
1375 * This executes the SMBus "send byte" protocol, returning negative errno
1376 * else zero on success.
1377 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1379{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001381 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382}
David Brownellc0564602007-05-01 23:26:31 +02001383EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
David Brownella1cdeda2008-07-14 22:38:24 +02001385/**
1386 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1387 * @client: Handle to slave device
1388 * @command: Byte interpreted by slave
1389 *
1390 * This executes the SMBus "read byte" protocol, returning negative errno
1391 * else a data byte received from the device.
1392 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1394{
1395 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001396 int status;
1397
1398 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1399 I2C_SMBUS_READ, command,
1400 I2C_SMBUS_BYTE_DATA, &data);
1401 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402}
David Brownellc0564602007-05-01 23:26:31 +02001403EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
David Brownella1cdeda2008-07-14 22:38:24 +02001405/**
1406 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1407 * @client: Handle to slave device
1408 * @command: Byte interpreted by slave
1409 * @value: Byte being written
1410 *
1411 * This executes the SMBus "write byte" protocol, returning negative errno
1412 * else zero on success.
1413 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1415{
1416 union i2c_smbus_data data;
1417 data.byte = value;
1418 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1419 I2C_SMBUS_WRITE,command,
1420 I2C_SMBUS_BYTE_DATA,&data);
1421}
David Brownellc0564602007-05-01 23:26:31 +02001422EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
David Brownella1cdeda2008-07-14 22:38:24 +02001424/**
1425 * i2c_smbus_read_word_data - SMBus "read word" protocol
1426 * @client: Handle to slave device
1427 * @command: Byte interpreted by slave
1428 *
1429 * This executes the SMBus "read word" protocol, returning negative errno
1430 * else a 16-bit unsigned "word" received from the device.
1431 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1433{
1434 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001435 int status;
1436
1437 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1438 I2C_SMBUS_READ, command,
1439 I2C_SMBUS_WORD_DATA, &data);
1440 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441}
David Brownellc0564602007-05-01 23:26:31 +02001442EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
David Brownella1cdeda2008-07-14 22:38:24 +02001444/**
1445 * i2c_smbus_write_word_data - SMBus "write word" protocol
1446 * @client: Handle to slave device
1447 * @command: Byte interpreted by slave
1448 * @value: 16-bit "word" being written
1449 *
1450 * This executes the SMBus "write word" protocol, returning negative errno
1451 * else zero on success.
1452 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1454{
1455 union i2c_smbus_data data;
1456 data.word = value;
1457 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1458 I2C_SMBUS_WRITE,command,
1459 I2C_SMBUS_WORD_DATA,&data);
1460}
David Brownellc0564602007-05-01 23:26:31 +02001461EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
David Brownella64ec072007-10-13 23:56:31 +02001463/**
David Brownella1cdeda2008-07-14 22:38:24 +02001464 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02001465 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02001466 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02001467 * @values: Byte array into which data will be read; big enough to hold
1468 * the data returned by the slave. SMBus allows at most 32 bytes.
1469 *
David Brownella1cdeda2008-07-14 22:38:24 +02001470 * This executes the SMBus "block read" protocol, returning negative errno
1471 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02001472 *
1473 * Note that using this function requires that the client's adapter support
1474 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1475 * support this; its emulation through I2C messaging relies on a specific
1476 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1477 */
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001478s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1479 u8 *values)
1480{
1481 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001482 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001483
David Brownell24a5bb72008-07-14 22:38:23 +02001484 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1485 I2C_SMBUS_READ, command,
1486 I2C_SMBUS_BLOCK_DATA, &data);
1487 if (status)
1488 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001489
1490 memcpy(values, &data.block[1], data.block[0]);
1491 return data.block[0];
1492}
1493EXPORT_SYMBOL(i2c_smbus_read_block_data);
1494
David Brownella1cdeda2008-07-14 22:38:24 +02001495/**
1496 * i2c_smbus_write_block_data - SMBus "block write" protocol
1497 * @client: Handle to slave device
1498 * @command: Byte interpreted by slave
1499 * @length: Size of data block; SMBus allows at most 32 bytes
1500 * @values: Byte array which will be written.
1501 *
1502 * This executes the SMBus "block write" protocol, returning negative errno
1503 * else zero on success.
1504 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001506 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507{
1508 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001509
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 if (length > I2C_SMBUS_BLOCK_MAX)
1511 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01001513 memcpy(&data.block[1], values, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1515 I2C_SMBUS_WRITE,command,
1516 I2C_SMBUS_BLOCK_DATA,&data);
1517}
David Brownellc0564602007-05-01 23:26:31 +02001518EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
1520/* Returns the number of read bytes */
Jean Delvare4b2643d2007-07-12 14:12:29 +02001521s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1522 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523{
1524 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001525 int status;
Jean Delvare76560322006-01-18 23:14:55 +01001526
Jean Delvare4b2643d2007-07-12 14:12:29 +02001527 if (length > I2C_SMBUS_BLOCK_MAX)
1528 length = I2C_SMBUS_BLOCK_MAX;
1529 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02001530 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1531 I2C_SMBUS_READ, command,
1532 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1533 if (status < 0)
1534 return status;
Jean Delvare76560322006-01-18 23:14:55 +01001535
1536 memcpy(values, &data.block[1], data.block[0]);
1537 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538}
David Brownellc0564602007-05-01 23:26:31 +02001539EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540
Jean Delvare21bbd692006-01-09 15:19:18 +11001541s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001542 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11001543{
1544 union i2c_smbus_data data;
1545
1546 if (length > I2C_SMBUS_BLOCK_MAX)
1547 length = I2C_SMBUS_BLOCK_MAX;
1548 data.block[0] = length;
1549 memcpy(data.block + 1, values, length);
1550 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1551 I2C_SMBUS_WRITE, command,
1552 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1553}
David Brownellc0564602007-05-01 23:26:31 +02001554EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11001555
David Brownell438d6c22006-12-10 21:21:31 +01001556/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 No checking of parameters is done! */
David Brownell438d6c22006-12-10 21:21:31 +01001558static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001560 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 union i2c_smbus_data * data)
1562{
1563 /* So we need to generate a series of msgs. In the case of writing, we
1564 need to use only one message; when reading, we need two. We initialize
1565 most things with sane defaults, to keep the code below somewhat
1566 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001567 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1568 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 int num = read_write == I2C_SMBUS_READ?2:1;
David Brownell438d6c22006-12-10 21:21:31 +01001570 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1572 };
1573 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02001574 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02001575 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
1577 msgbuf0[0] = command;
1578 switch(size) {
1579 case I2C_SMBUS_QUICK:
1580 msg[0].len = 0;
1581 /* Special case: The read/write field is used as data */
1582 msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
1583 num = 1;
1584 break;
1585 case I2C_SMBUS_BYTE:
1586 if (read_write == I2C_SMBUS_READ) {
1587 /* Special case: only a read! */
1588 msg[0].flags = I2C_M_RD | flags;
1589 num = 1;
1590 }
1591 break;
1592 case I2C_SMBUS_BYTE_DATA:
1593 if (read_write == I2C_SMBUS_READ)
1594 msg[1].len = 1;
1595 else {
1596 msg[0].len = 2;
1597 msgbuf0[1] = data->byte;
1598 }
1599 break;
1600 case I2C_SMBUS_WORD_DATA:
1601 if (read_write == I2C_SMBUS_READ)
1602 msg[1].len = 2;
1603 else {
1604 msg[0].len=3;
1605 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001606 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 }
1608 break;
1609 case I2C_SMBUS_PROC_CALL:
1610 num = 2; /* Special case */
1611 read_write = I2C_SMBUS_READ;
1612 msg[0].len = 3;
1613 msg[1].len = 2;
1614 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001615 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 break;
1617 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02001619 msg[1].flags |= I2C_M_RECV_LEN;
1620 msg[1].len = 1; /* block length will be added by
1621 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 } else {
1623 msg[0].len = data->block[0] + 2;
1624 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02001625 dev_err(&adapter->dev,
1626 "Invalid block write size %d\n",
1627 data->block[0]);
1628 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001630 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 msgbuf0[i] = data->block[i-1];
1632 }
1633 break;
1634 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02001635 num = 2; /* Another special case */
1636 read_write = I2C_SMBUS_READ;
1637 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02001638 dev_err(&adapter->dev,
1639 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02001640 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02001641 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02001642 }
1643 msg[0].len = data->block[0] + 2;
1644 for (i = 1; i < msg[0].len; i++)
1645 msgbuf0[i] = data->block[i-1];
1646 msg[1].flags |= I2C_M_RECV_LEN;
1647 msg[1].len = 1; /* block length will be added by
1648 the underlying bus driver */
1649 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 case I2C_SMBUS_I2C_BLOCK_DATA:
1651 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02001652 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 } else {
1654 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02001655 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02001656 dev_err(&adapter->dev,
1657 "Invalid block write size %d\n",
1658 data->block[0]);
1659 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 }
1661 for (i = 1; i <= data->block[0]; i++)
1662 msgbuf0[i] = data->block[i];
1663 }
1664 break;
1665 default:
David Brownell24a5bb72008-07-14 22:38:23 +02001666 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1667 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 }
1669
Jean Delvare421ef472005-10-26 21:28:55 +02001670 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1671 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1672 if (i) {
1673 /* Compute PEC if first message is a write */
1674 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01001675 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02001676 i2c_smbus_add_pec(&msg[0]);
1677 else /* Write followed by read */
1678 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1679 }
1680 /* Ask for PEC if last message is a read */
1681 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01001682 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02001683 }
1684
David Brownell24a5bb72008-07-14 22:38:23 +02001685 status = i2c_transfer(adapter, msg, num);
1686 if (status < 0)
1687 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
Jean Delvare421ef472005-10-26 21:28:55 +02001689 /* Check PEC if last message is a read */
1690 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02001691 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1692 if (status < 0)
1693 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02001694 }
1695
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 if (read_write == I2C_SMBUS_READ)
1697 switch(size) {
1698 case I2C_SMBUS_BYTE:
1699 data->byte = msgbuf0[0];
1700 break;
1701 case I2C_SMBUS_BYTE_DATA:
1702 data->byte = msgbuf1[0];
1703 break;
David Brownell438d6c22006-12-10 21:21:31 +01001704 case I2C_SMBUS_WORD_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 case I2C_SMBUS_PROC_CALL:
1706 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1707 break;
1708 case I2C_SMBUS_I2C_BLOCK_DATA:
Jean Delvare4b2643d2007-07-12 14:12:29 +02001709 for (i = 0; i < data->block[0]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 data->block[i+1] = msgbuf1[i];
1711 break;
Jean Delvare209d27c2007-05-01 23:26:29 +02001712 case I2C_SMBUS_BLOCK_DATA:
1713 case I2C_SMBUS_BLOCK_PROC_CALL:
1714 for (i = 0; i < msgbuf1[0] + 1; i++)
1715 data->block[i] = msgbuf1[i];
1716 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 }
1718 return 0;
1719}
1720
David Brownella1cdeda2008-07-14 22:38:24 +02001721/**
1722 * i2c_smbus_xfer - execute SMBus protocol operations
1723 * @adapter: Handle to I2C bus
1724 * @addr: Address of SMBus slave on that bus
1725 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1726 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1727 * @command: Byte interpreted by slave, for protocols which use such bytes
1728 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1729 * @data: Data to be read or written
1730 *
1731 * This executes an SMBus protocol operation, and returns a negative
1732 * errno code else zero on success.
1733 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02001735 char read_write, u8 command, int protocol,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 union i2c_smbus_data * data)
1737{
1738 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739
1740 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
1742 if (adapter->algo->smbus_xfer) {
Ingo Molnar5c085d32006-01-18 23:16:04 +01001743 mutex_lock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02001745 command, protocol, data);
Ingo Molnar5c085d32006-01-18 23:16:04 +01001746 mutex_unlock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 } else
1748 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02001749 command, protocol, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 return res;
1752}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754
1755MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1756MODULE_DESCRIPTION("I2C-Bus main module");
1757MODULE_LICENSE("GPL");