blob: e73d58c43f386a349856cdb95f2935510c2a79fe [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
20/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
21 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>
32#include <linux/seq_file.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010033#include <linux/platform_device.h>
Arjan van de Venb3585e42006-01-11 10:50:26 +010034#include <linux/mutex.h>
Jean Delvareb8d6f452007-02-13 22:09:00 +010035#include <linux/completion.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/uaccess.h>
37
David Brownell9c1600e2007-05-01 23:26:31 +020038#include "i2c-core.h"
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41static LIST_HEAD(adapters);
42static LIST_HEAD(drivers);
Arjan van de Venb3585e42006-01-11 10:50:26 +010043static DEFINE_MUTEX(core_lists);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044static DEFINE_IDR(i2c_adapter_idr);
45
David Brownella1d9e6e2007-05-01 23:26:30 +020046#define is_newstyle_driver(d) ((d)->probe || (d)->remove)
David Brownellf37dd802007-02-13 22:09:00 +010047
48/* ------------------------------------------------------------------------- */
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050static int i2c_device_match(struct device *dev, struct device_driver *drv)
51{
David Brownell7b4fbc52007-05-01 23:26:30 +020052 struct i2c_client *client = to_i2c_client(dev);
53 struct i2c_driver *driver = to_i2c_driver(drv);
54
55 /* make legacy i2c drivers bypass driver model probing entirely;
56 * such drivers scan each i2c adapter/bus themselves.
57 */
David Brownella1d9e6e2007-05-01 23:26:30 +020058 if (!is_newstyle_driver(driver))
David Brownell7b4fbc52007-05-01 23:26:30 +020059 return 0;
60
61 /* new style drivers use the same kind of driver matching policy
62 * as platform devices or SPI: compare device and driver IDs.
63 */
64 return strcmp(client->driver_name, drv->name) == 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065}
66
David Brownell7b4fbc52007-05-01 23:26:30 +020067#ifdef CONFIG_HOTPLUG
68
69/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +020070static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +020071{
72 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +020073
74 /* by definition, legacy drivers can't hotplug */
75 if (dev->driver || !client->driver_name)
76 return 0;
77
Kay Sievers7eff2e72007-08-14 15:15:12 +020078 if (add_uevent_var(env, "MODALIAS=%s", client->driver_name))
David Brownell7b4fbc52007-05-01 23:26:30 +020079 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +020080 dev_dbg(dev, "uevent\n");
81 return 0;
82}
83
84#else
85#define i2c_device_uevent NULL
86#endif /* CONFIG_HOTPLUG */
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088static int i2c_device_probe(struct device *dev)
89{
David Brownell7b4fbc52007-05-01 23:26:30 +020090 struct i2c_client *client = to_i2c_client(dev);
91 struct i2c_driver *driver = to_i2c_driver(dev->driver);
92
93 if (!driver->probe)
94 return -ENODEV;
95 client->driver = driver;
96 dev_dbg(dev, "probe\n");
97 return driver->probe(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098}
99
100static int i2c_device_remove(struct device *dev)
101{
David Brownella1d9e6e2007-05-01 23:26:30 +0200102 struct i2c_client *client = to_i2c_client(dev);
103 struct i2c_driver *driver;
104 int status;
105
106 if (!dev->driver)
107 return 0;
108
109 driver = to_i2c_driver(dev->driver);
110 if (driver->remove) {
111 dev_dbg(dev, "remove\n");
112 status = driver->remove(client);
113 } else {
114 dev->driver = NULL;
115 status = 0;
116 }
117 if (status == 0)
118 client->driver = NULL;
119 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120}
121
David Brownellf37dd802007-02-13 22:09:00 +0100122static void i2c_device_shutdown(struct device *dev)
123{
124 struct i2c_driver *driver;
125
126 if (!dev->driver)
127 return;
128 driver = to_i2c_driver(dev->driver);
129 if (driver->shutdown)
130 driver->shutdown(to_i2c_client(dev));
131}
132
133static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
134{
135 struct i2c_driver *driver;
136
137 if (!dev->driver)
138 return 0;
139 driver = to_i2c_driver(dev->driver);
140 if (!driver->suspend)
141 return 0;
142 return driver->suspend(to_i2c_client(dev), mesg);
143}
144
145static int i2c_device_resume(struct device * dev)
146{
147 struct i2c_driver *driver;
148
149 if (!dev->driver)
150 return 0;
151 driver = to_i2c_driver(dev->driver);
152 if (!driver->resume)
153 return 0;
154 return driver->resume(to_i2c_client(dev));
155}
156
David Brownell7b4fbc52007-05-01 23:26:30 +0200157static void i2c_client_release(struct device *dev)
158{
159 struct i2c_client *client = to_i2c_client(dev);
160 complete(&client->released);
161}
162
David Brownell9c1600e2007-05-01 23:26:31 +0200163static void i2c_client_dev_release(struct device *dev)
164{
165 kfree(to_i2c_client(dev));
166}
167
David Brownell7b4fbc52007-05-01 23:26:30 +0200168static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
169{
170 struct i2c_client *client = to_i2c_client(dev);
171 return sprintf(buf, "%s\n", client->name);
172}
173
174static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
175{
176 struct i2c_client *client = to_i2c_client(dev);
177 return client->driver_name
178 ? sprintf(buf, "%s\n", client->driver_name)
179 : 0;
180}
181
182static struct device_attribute i2c_dev_attrs[] = {
183 __ATTR(name, S_IRUGO, show_client_name, NULL),
184 /* modalias helps coldplug: modprobe $(cat .../modalias) */
185 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
186 { },
187};
188
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200189static struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100190 .name = "i2c",
David Brownell7b4fbc52007-05-01 23:26:30 +0200191 .dev_attrs = i2c_dev_attrs,
David Brownellf37dd802007-02-13 22:09:00 +0100192 .match = i2c_device_match,
David Brownell7b4fbc52007-05-01 23:26:30 +0200193 .uevent = i2c_device_uevent,
David Brownellf37dd802007-02-13 22:09:00 +0100194 .probe = i2c_device_probe,
195 .remove = i2c_device_remove,
196 .shutdown = i2c_device_shutdown,
197 .suspend = i2c_device_suspend,
198 .resume = i2c_device_resume,
Russell Kingb864c7d2006-01-05 14:37:50 +0000199};
200
David Brownell9c1600e2007-05-01 23:26:31 +0200201/**
202 * i2c_new_device - instantiate an i2c device for use with a new style driver
203 * @adap: the adapter managing the device
204 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200205 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200206 *
207 * Create a device to work with a new style i2c driver, where binding is
208 * handled through driver model probe()/remove() methods. This call is not
209 * appropriate for use by mainboad initialization logic, which usually runs
210 * during an arch_initcall() long before any i2c_adapter could exist.
211 *
212 * This returns the new i2c client, which may be saved for later use with
213 * i2c_unregister_device(); or NULL to indicate an error.
214 */
215struct i2c_client *
216i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
217{
218 struct i2c_client *client;
219 int status;
220
221 client = kzalloc(sizeof *client, GFP_KERNEL);
222 if (!client)
223 return NULL;
224
225 client->adapter = adap;
226
227 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200228 device_init_wakeup(&client->dev, info->flags & I2C_CLIENT_WAKE);
229
230 client->flags = info->flags & ~I2C_CLIENT_WAKE;
David Brownell9c1600e2007-05-01 23:26:31 +0200231 client->addr = info->addr;
232 client->irq = info->irq;
233
234 strlcpy(client->driver_name, info->driver_name,
235 sizeof(client->driver_name));
236 strlcpy(client->name, info->type, sizeof(client->name));
237
238 /* a new style driver may be bound to this device when we
239 * return from this function, or any later moment (e.g. maybe
240 * hotplugging will load the driver module). and the device
241 * refcount model is the standard driver model one.
242 */
243 status = i2c_attach_client(client);
244 if (status < 0) {
245 kfree(client);
246 client = NULL;
247 }
248 return client;
249}
250EXPORT_SYMBOL_GPL(i2c_new_device);
251
252
253/**
254 * i2c_unregister_device - reverse effect of i2c_new_device()
255 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200256 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200257 */
258void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200259{
260 struct i2c_adapter *adapter = client->adapter;
261 struct i2c_driver *driver = client->driver;
262
263 if (driver && !is_newstyle_driver(driver)) {
264 dev_err(&client->dev, "can't unregister devices "
265 "with legacy drivers\n");
266 WARN_ON(1);
267 return;
268 }
269
270 mutex_lock(&adapter->clist_lock);
271 list_del(&client->list);
272 mutex_unlock(&adapter->clist_lock);
273
274 device_unregister(&client->dev);
275}
David Brownell9c1600e2007-05-01 23:26:31 +0200276EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200277
278
David Brownellf37dd802007-02-13 22:09:00 +0100279/* ------------------------------------------------------------------------- */
280
David Brownell16ffadf2007-05-01 23:26:28 +0200281/* I2C bus adapters -- one roots each I2C or SMBUS segment */
282
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200283static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
David Brownellef2c83212007-05-01 23:26:28 +0200285 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 complete(&adap->dev_released);
287}
288
David Brownell16ffadf2007-05-01 23:26:28 +0200289static ssize_t
290show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291{
David Brownellef2c83212007-05-01 23:26:28 +0200292 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 return sprintf(buf, "%s\n", adap->name);
294}
David Brownell16ffadf2007-05-01 23:26:28 +0200295
296static struct device_attribute i2c_adapter_attrs[] = {
297 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
298 { },
299};
300
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200301static struct class i2c_adapter_class = {
David Brownell16ffadf2007-05-01 23:26:28 +0200302 .owner = THIS_MODULE,
303 .name = "i2c-adapter",
304 .dev_attrs = i2c_adapter_attrs,
305};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
David Brownell9c1600e2007-05-01 23:26:31 +0200307static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
308{
309 struct i2c_devinfo *devinfo;
310
311 mutex_lock(&__i2c_board_lock);
312 list_for_each_entry(devinfo, &__i2c_board_list, list) {
313 if (devinfo->busnum == adapter->nr
314 && !i2c_new_device(adapter,
315 &devinfo->board_info))
316 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
317 i2c_adapter_id(adapter),
318 devinfo->board_info.addr);
319 }
320 mutex_unlock(&__i2c_board_lock);
321}
322
David Brownell6e13e642007-05-01 23:26:31 +0200323static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324{
David Brownell6e13e642007-05-01 23:26:31 +0200325 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 struct list_head *item;
327 struct i2c_driver *driver;
328
Ingo Molnar5c085d32006-01-18 23:16:04 +0100329 mutex_init(&adap->bus_lock);
330 mutex_init(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 INIT_LIST_HEAD(&adap->clients);
332
David Brownell6e13e642007-05-01 23:26:31 +0200333 mutex_lock(&core_lists);
334 list_add_tail(&adap->list, &adapters);
335
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 /* Add the adapter to the driver core.
337 * If the parent pointer is not set up,
338 * we add this adapter to the host bus.
339 */
David Brownellb119dc32007-01-04 13:07:04 +0100340 if (adap->dev.parent == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 adap->dev.parent = &platform_bus;
Jean Delvarefe2c8d52007-02-13 22:09:04 +0100342 pr_debug("I2C adapter driver [%s] forgot to specify "
343 "physical device\n", adap->name);
David Brownellb119dc32007-01-04 13:07:04 +0100344 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 adap->dev.release = &i2c_adapter_dev_release;
Jean Delvarefccb56e2007-05-01 23:26:27 +0200347 adap->dev.class = &i2c_adapter_class;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200348 res = device_register(&adap->dev);
349 if (res)
350 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200352 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
353
David Brownell6e13e642007-05-01 23:26:31 +0200354 /* create pre-declared device nodes for new-style drivers */
355 if (adap->nr < __i2c_first_dynamic_bus_num)
356 i2c_scan_static_board_info(adap);
357
David Brownell7b4fbc52007-05-01 23:26:30 +0200358 /* let legacy drivers scan this bus for matching devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 list_for_each(item,&drivers) {
360 driver = list_entry(item, struct i2c_driver, list);
Jean Delvare8a994752005-11-26 20:28:06 +0100361 if (driver->attach_adapter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 /* We ignore the return code; if it fails, too bad */
363 driver->attach_adapter(adap);
364 }
365
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366out_unlock:
Arjan van de Venb3585e42006-01-11 10:50:26 +0100367 mutex_unlock(&core_lists);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 return res;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200369
Jean Delvareb119c6c2006-08-15 18:26:30 +0200370out_list:
371 list_del(&adap->list);
372 idr_remove(&i2c_adapter_idr, adap->nr);
373 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374}
375
David Brownell6e13e642007-05-01 23:26:31 +0200376/**
377 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
378 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +0200379 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200380 *
381 * This routine is used to declare an I2C adapter when its bus number
382 * doesn't matter. Examples: for I2C adapters dynamically added by
383 * USB links or PCI plugin cards.
384 *
385 * When this returns zero, a new bus number was allocated and stored
386 * in adap->nr, and the specified adapter became available for clients.
387 * Otherwise, a negative errno value is returned.
388 */
389int i2c_add_adapter(struct i2c_adapter *adapter)
390{
391 int id, res = 0;
392
393retry:
394 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
395 return -ENOMEM;
396
397 mutex_lock(&core_lists);
398 /* "above" here means "above or equal to", sigh */
399 res = idr_get_new_above(&i2c_adapter_idr, adapter,
400 __i2c_first_dynamic_bus_num, &id);
401 mutex_unlock(&core_lists);
402
403 if (res < 0) {
404 if (res == -EAGAIN)
405 goto retry;
406 return res;
407 }
408
409 adapter->nr = id;
410 return i2c_register_adapter(adapter);
411}
412EXPORT_SYMBOL(i2c_add_adapter);
413
414/**
415 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
416 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +0200417 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200418 *
419 * This routine is used to declare an I2C adapter when its bus number
420 * matters. Example: for I2C adapters from system-on-chip CPUs, or
421 * otherwise built in to the system's mainboard, and where i2c_board_info
422 * is used to properly configure I2C devices.
423 *
424 * If no devices have pre-been declared for this bus, then be sure to
425 * register the adapter before any dynamically allocated ones. Otherwise
426 * the required bus ID may not be available.
427 *
428 * When this returns zero, the specified adapter became available for
429 * clients using the bus number provided in adap->nr. Also, the table
430 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
431 * and the appropriate driver model device nodes are created. Otherwise, a
432 * negative errno value is returned.
433 */
434int i2c_add_numbered_adapter(struct i2c_adapter *adap)
435{
436 int id;
437 int status;
438
439 if (adap->nr & ~MAX_ID_MASK)
440 return -EINVAL;
441
442retry:
443 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
444 return -ENOMEM;
445
446 mutex_lock(&core_lists);
447 /* "above" here means "above or equal to", sigh;
448 * we need the "equal to" result to force the result
449 */
450 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
451 if (status == 0 && id != adap->nr) {
452 status = -EBUSY;
453 idr_remove(&i2c_adapter_idr, id);
454 }
455 mutex_unlock(&core_lists);
456 if (status == -EAGAIN)
457 goto retry;
458
459 if (status == 0)
460 status = i2c_register_adapter(adap);
461 return status;
462}
463EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
464
David Brownelld64f73b2007-07-12 14:12:28 +0200465/**
466 * i2c_del_adapter - unregister I2C adapter
467 * @adap: the adapter being unregistered
468 * Context: can sleep
469 *
470 * This unregisters an I2C adapter which was previously registered
471 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
472 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473int i2c_del_adapter(struct i2c_adapter *adap)
474{
475 struct list_head *item, *_n;
476 struct i2c_adapter *adap_from_list;
477 struct i2c_driver *driver;
478 struct i2c_client *client;
479 int res = 0;
480
Arjan van de Venb3585e42006-01-11 10:50:26 +0100481 mutex_lock(&core_lists);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483 /* First make sure that this adapter was ever added */
484 list_for_each_entry(adap_from_list, &adapters, list) {
485 if (adap_from_list == adap)
486 break;
487 }
488 if (adap_from_list != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200489 pr_debug("i2c-core: attempting to delete unregistered "
490 "adapter [%s]\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 res = -EINVAL;
492 goto out_unlock;
493 }
494
495 list_for_each(item,&drivers) {
496 driver = list_entry(item, struct i2c_driver, list);
497 if (driver->detach_adapter)
498 if ((res = driver->detach_adapter(adap))) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200499 dev_err(&adap->dev, "detach_adapter failed "
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100500 "for driver [%s]\n",
501 driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 goto out_unlock;
503 }
504 }
505
506 /* detach any active clients. This must be done first, because
Tobias Klausera551acc2005-05-19 21:40:38 +0200507 * it can fail; in which case we give up. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 list_for_each_safe(item, _n, &adap->clients) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200509 struct i2c_driver *driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
David Brownella1d9e6e2007-05-01 23:26:30 +0200511 client = list_entry(item, struct i2c_client, list);
512 driver = client->driver;
513
514 /* new style, follow standard driver model */
515 if (!driver || is_newstyle_driver(driver)) {
516 i2c_unregister_device(client);
517 continue;
518 }
519
520 /* legacy drivers create and remove clients themselves */
521 if ((res = driver->detach_client(client))) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200522 dev_err(&adap->dev, "detach_client failed for client "
523 "[%s] at address 0x%02x\n", client->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 client->addr);
525 goto out_unlock;
526 }
527 }
528
529 /* clean up the sysfs representation */
530 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 device_unregister(&adap->dev);
532 list_del(&adap->list);
533
534 /* wait for sysfs to drop all references */
535 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
David Brownell6e13e642007-05-01 23:26:31 +0200537 /* free bus id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 idr_remove(&i2c_adapter_idr, adap->nr);
539
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200540 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542 out_unlock:
Arjan van de Venb3585e42006-01-11 10:50:26 +0100543 mutex_unlock(&core_lists);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 return res;
545}
David Brownellc0564602007-05-01 23:26:31 +0200546EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
548
David Brownell7b4fbc52007-05-01 23:26:30 +0200549/* ------------------------------------------------------------------------- */
550
551/*
552 * An i2c_driver is used with one or more i2c_client (device) nodes to access
553 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
554 * are two models for binding the driver to its device: "new style" drivers
555 * follow the standard Linux driver model and just respond to probe() calls
556 * issued if the driver core sees they match(); "legacy" drivers create device
557 * nodes themselves.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 */
559
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800560int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561{
Jean Delvare7eebcb72006-02-05 23:28:21 +0100562 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
David Brownell7b4fbc52007-05-01 23:26:30 +0200564 /* new style driver methods can't mix with legacy ones */
David Brownella1d9e6e2007-05-01 23:26:30 +0200565 if (is_newstyle_driver(driver)) {
David Brownell7b4fbc52007-05-01 23:26:30 +0200566 if (driver->attach_adapter || driver->detach_adapter
567 || driver->detach_client) {
568 printk(KERN_WARNING
569 "i2c-core: driver [%s] is confused\n",
570 driver->driver.name);
571 return -EINVAL;
572 }
573 }
574
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800576 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
David Brownell6e13e642007-05-01 23:26:31 +0200579 /* for new style drivers, when registration returns the driver core
580 * will have called probe() for all matching-but-unbound devices.
581 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 res = driver_register(&driver->driver);
583 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +0100584 return res;
David Brownell438d6c22006-12-10 21:21:31 +0100585
Jean Delvare7eebcb72006-02-05 23:28:21 +0100586 mutex_lock(&core_lists);
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 list_add_tail(&driver->list,&drivers);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100589 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
David Brownell7b4fbc52007-05-01 23:26:30 +0200591 /* legacy drivers scan i2c busses directly */
Jean Delvare8a994752005-11-26 20:28:06 +0100592 if (driver->attach_adapter) {
David Brownell4ad4eac2007-05-01 23:26:28 +0200593 struct i2c_adapter *adapter;
594
595 list_for_each_entry(adapter, &adapters, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 driver->attach_adapter(adapter);
597 }
598 }
599
Arjan van de Venb3585e42006-01-11 10:50:26 +0100600 mutex_unlock(&core_lists);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100601 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800603EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
David Brownella1d9e6e2007-05-01 23:26:30 +0200605/**
606 * i2c_del_driver - unregister I2C driver
607 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +0200608 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +0200609 */
Jean Delvareb3e82092007-05-01 23:26:32 +0200610void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
612 struct list_head *item1, *item2, *_n;
613 struct i2c_client *client;
614 struct i2c_adapter *adap;
David Brownell438d6c22006-12-10 21:21:31 +0100615
Arjan van de Venb3585e42006-01-11 10:50:26 +0100616 mutex_lock(&core_lists);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
David Brownella1d9e6e2007-05-01 23:26:30 +0200618 /* new-style driver? */
619 if (is_newstyle_driver(driver))
620 goto unregister;
621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 /* Have a look at each adapter, if clients of this driver are still
David Brownell438d6c22006-12-10 21:21:31 +0100623 * attached. If so, detach them to be able to kill the driver
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 * afterwards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 */
626 list_for_each(item1,&adapters) {
627 adap = list_entry(item1, struct i2c_adapter, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 if (driver->detach_adapter) {
Jean Delvareb3e82092007-05-01 23:26:32 +0200629 if (driver->detach_adapter(adap)) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200630 dev_err(&adap->dev, "detach_adapter failed "
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100631 "for driver [%s]\n",
632 driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 }
634 } else {
635 list_for_each_safe(item2, _n, &adap->clients) {
636 client = list_entry(item2, struct i2c_client, list);
637 if (client->driver != driver)
638 continue;
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200639 dev_dbg(&adap->dev, "detaching client [%s] "
640 "at 0x%02x\n", client->name,
641 client->addr);
Jean Delvareb3e82092007-05-01 23:26:32 +0200642 if (driver->detach_client(client)) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200643 dev_err(&adap->dev, "detach_client "
644 "failed for client [%s] at "
645 "0x%02x\n", client->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 client->addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 }
648 }
649 }
650 }
651
David Brownella1d9e6e2007-05-01 23:26:30 +0200652 unregister:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 driver_unregister(&driver->driver);
654 list_del(&driver->list);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100655 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
Arjan van de Venb3585e42006-01-11 10:50:26 +0100657 mutex_unlock(&core_lists);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658}
David Brownellc0564602007-05-01 23:26:31 +0200659EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
David Brownell7b4fbc52007-05-01 23:26:30 +0200661/* ------------------------------------------------------------------------- */
662
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663static int __i2c_check_addr(struct i2c_adapter *adapter, unsigned int addr)
664{
665 struct list_head *item;
666 struct i2c_client *client;
667
668 list_for_each(item,&adapter->clients) {
669 client = list_entry(item, struct i2c_client, list);
670 if (client->addr == addr)
671 return -EBUSY;
672 }
673 return 0;
674}
675
676int i2c_check_addr(struct i2c_adapter *adapter, int addr)
677{
678 int rval;
679
Ingo Molnar5c085d32006-01-18 23:16:04 +0100680 mutex_lock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 rval = __i2c_check_addr(adapter, addr);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100682 mutex_unlock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
684 return rval;
685}
David Brownellc0564602007-05-01 23:26:31 +0200686EXPORT_SYMBOL(i2c_check_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688int i2c_attach_client(struct i2c_client *client)
689{
690 struct i2c_adapter *adapter = client->adapter;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200691 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Ingo Molnar5c085d32006-01-18 23:16:04 +0100693 mutex_lock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 if (__i2c_check_addr(client->adapter, client->addr)) {
Jean Delvareb119c6c2006-08-15 18:26:30 +0200695 res = -EBUSY;
696 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 }
698 list_add_tail(&client->list,&adapter->clients);
David Brownell438d6c22006-12-10 21:21:31 +0100699
Jean Delvarecde78592005-11-26 21:00:54 +0100700 client->usage_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
702 client->dev.parent = &client->adapter->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 client->dev.bus = &i2c_bus_type;
David Brownell9c1600e2007-05-01 23:26:31 +0200704
705 if (client->driver)
706 client->dev.driver = &client->driver->driver;
707
David Brownellde81d2a2007-05-22 19:49:16 +0200708 if (client->driver && !is_newstyle_driver(client->driver)) {
David Brownell9c1600e2007-05-01 23:26:31 +0200709 client->dev.release = i2c_client_release;
David Brownellde81d2a2007-05-22 19:49:16 +0200710 client->dev.uevent_suppress = 1;
711 } else
David Brownell9c1600e2007-05-01 23:26:31 +0200712 client->dev.release = i2c_client_dev_release;
David Brownell438d6c22006-12-10 21:21:31 +0100713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
715 "%d-%04x", i2c_adapter_id(adapter), client->addr);
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200716 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
717 client->name, client->dev.bus_id);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200718 res = device_register(&client->dev);
719 if (res)
720 goto out_list;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200721 mutex_unlock(&adapter->clist_lock);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200722
723 if (adapter->client_register) {
724 if (adapter->client_register(client)) {
725 dev_dbg(&adapter->dev, "client_register "
726 "failed for client [%s] at 0x%02x\n",
727 client->name, client->addr);
728 }
729 }
730
731 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200732
Jean Delvareb119c6c2006-08-15 18:26:30 +0200733out_list:
734 list_del(&client->list);
735 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
736 "(%d)\n", client->name, client->addr, res);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200737out_unlock:
738 mutex_unlock(&adapter->clist_lock);
739 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740}
David Brownellc0564602007-05-01 23:26:31 +0200741EXPORT_SYMBOL(i2c_attach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742
743int i2c_detach_client(struct i2c_client *client)
744{
745 struct i2c_adapter *adapter = client->adapter;
746 int res = 0;
David Brownell438d6c22006-12-10 21:21:31 +0100747
Jean Delvarecde78592005-11-26 21:00:54 +0100748 if (client->usage_count > 0) {
Jean Delvare7bef5592005-07-27 22:14:49 +0200749 dev_warn(&client->dev, "Client [%s] still busy, "
750 "can't detach\n", client->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 return -EBUSY;
Jean Delvare7bef5592005-07-27 22:14:49 +0200752 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
754 if (adapter->client_unregister) {
755 res = adapter->client_unregister(client);
756 if (res) {
757 dev_err(&client->dev,
Jean Delvare86749e82005-07-29 12:15:29 -0700758 "client_unregister [%s] failed, "
759 "client not detached\n", client->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 goto out;
761 }
762 }
763
Ingo Molnar5c085d32006-01-18 23:16:04 +0100764 mutex_lock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 list_del(&client->list);
766 init_completion(&client->released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 device_unregister(&client->dev);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100768 mutex_unlock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 wait_for_completion(&client->released);
770
771 out:
772 return res;
773}
David Brownellc0564602007-05-01 23:26:31 +0200774EXPORT_SYMBOL(i2c_detach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
776static int i2c_inc_use_client(struct i2c_client *client)
777{
778
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100779 if (!try_module_get(client->driver->driver.owner))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 return -ENODEV;
781 if (!try_module_get(client->adapter->owner)) {
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100782 module_put(client->driver->driver.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 return -ENODEV;
784 }
785
786 return 0;
787}
788
789static void i2c_dec_use_client(struct i2c_client *client)
790{
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100791 module_put(client->driver->driver.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 module_put(client->adapter->owner);
793}
794
795int i2c_use_client(struct i2c_client *client)
796{
797 int ret;
798
799 ret = i2c_inc_use_client(client);
800 if (ret)
801 return ret;
802
Jean Delvarecde78592005-11-26 21:00:54 +0100803 client->usage_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
805 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806}
David Brownellc0564602007-05-01 23:26:31 +0200807EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
809int i2c_release_client(struct i2c_client *client)
810{
Jean Delvarecde78592005-11-26 21:00:54 +0100811 if (!client->usage_count) {
812 pr_debug("i2c-core: %s used one too many times\n",
813 __FUNCTION__);
814 return -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 }
David Brownell438d6c22006-12-10 21:21:31 +0100816
Jean Delvarecde78592005-11-26 21:00:54 +0100817 client->usage_count--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 i2c_dec_use_client(client);
David Brownell438d6c22006-12-10 21:21:31 +0100819
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 return 0;
821}
David Brownellc0564602007-05-01 23:26:31 +0200822EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
824void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
825{
826 struct list_head *item;
827 struct i2c_client *client;
828
Ingo Molnar5c085d32006-01-18 23:16:04 +0100829 mutex_lock(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 list_for_each(item,&adap->clients) {
831 client = list_entry(item, struct i2c_client, list);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100832 if (!try_module_get(client->driver->driver.owner))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 continue;
834 if (NULL != client->driver->command) {
Ingo Molnar5c085d32006-01-18 23:16:04 +0100835 mutex_unlock(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 client->driver->command(client,cmd,arg);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100837 mutex_lock(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 }
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100839 module_put(client->driver->driver.owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 }
Ingo Molnar5c085d32006-01-18 23:16:04 +0100841 mutex_unlock(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842}
David Brownellc0564602007-05-01 23:26:31 +0200843EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
845static int __init i2c_init(void)
846{
847 int retval;
848
849 retval = bus_register(&i2c_bus_type);
850 if (retval)
851 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 return class_register(&i2c_adapter_class);
853}
854
855static void __exit i2c_exit(void)
856{
857 class_unregister(&i2c_adapter_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 bus_unregister(&i2c_bus_type);
859}
860
861subsys_initcall(i2c_init);
862module_exit(i2c_exit);
863
864/* ----------------------------------------------------
865 * the functional interface to the i2c busses.
866 * ----------------------------------------------------
867 */
868
869int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
870{
871 int ret;
872
873 if (adap->algo->master_xfer) {
874#ifdef DEBUG
875 for (ret = 0; ret < num; ret++) {
876 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +0200877 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
878 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
879 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 }
881#endif
882
Jiri Kosina6ea23032006-12-10 21:21:30 +0100883 mutex_lock_nested(&adap->bus_lock, adap->level);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 ret = adap->algo->master_xfer(adap,msgs,num);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100885 mutex_unlock(&adap->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
887 return ret;
888 } else {
889 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
890 return -ENOSYS;
891 }
892}
David Brownellc0564602007-05-01 23:26:31 +0200893EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894
895int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
896{
897 int ret;
898 struct i2c_adapter *adap=client->adapter;
899 struct i2c_msg msg;
900
Jean Delvare815f55f2005-05-07 22:58:46 +0200901 msg.addr = client->addr;
902 msg.flags = client->flags & I2C_M_TEN;
903 msg.len = count;
904 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +0100905
Jean Delvare815f55f2005-05-07 22:58:46 +0200906 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Jean Delvare815f55f2005-05-07 22:58:46 +0200908 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
909 transmitted, else error code. */
910 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911}
David Brownellc0564602007-05-01 23:26:31 +0200912EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
914int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
915{
916 struct i2c_adapter *adap=client->adapter;
917 struct i2c_msg msg;
918 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Jean Delvare815f55f2005-05-07 22:58:46 +0200920 msg.addr = client->addr;
921 msg.flags = client->flags & I2C_M_TEN;
922 msg.flags |= I2C_M_RD;
923 msg.len = count;
924 msg.buf = buf;
925
926 ret = i2c_transfer(adap, &msg, 1);
927
928 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
929 transmitted, else error code. */
930 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931}
David Brownellc0564602007-05-01 23:26:31 +0200932EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934/* ----------------------------------------------------
935 * the i2c address scanning function
936 * Will not work for 10-bit addresses!
937 * ----------------------------------------------------
938 */
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200939static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
940 int (*found_proc) (struct i2c_adapter *, int, int))
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200941{
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200942 int err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200943
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200944 /* Make sure the address is valid */
945 if (addr < 0x03 || addr > 0x77) {
946 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
947 addr);
948 return -EINVAL;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200949 }
950
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200951 /* Skip if already in use */
952 if (i2c_check_addr(adapter, addr))
953 return 0;
954
955 /* Make sure there is something at this address, unless forced */
Jean Delvare4c9337d2005-08-09 20:28:10 +0200956 if (kind < 0) {
957 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
958 I2C_SMBUS_QUICK, NULL) < 0)
959 return 0;
960
961 /* prevent 24RF08 corruption */
962 if ((addr & ~0x0f) == 0x50)
963 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
964 I2C_SMBUS_QUICK, NULL);
965 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200966
967 /* Finally call the custom detection function */
968 err = found_proc(adapter, addr, kind);
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200969 /* -ENODEV can be returned if there is a chip at the given address
970 but it isn't supported by this chip driver. We catch it here as
971 this isn't an error. */
Jean Delvare114fd182006-09-03 22:25:04 +0200972 if (err == -ENODEV)
973 err = 0;
974
975 if (err)
976 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
977 addr, err);
978 return err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200979}
980
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981int i2c_probe(struct i2c_adapter *adapter,
982 struct i2c_client_address_data *address_data,
983 int (*found_proc) (struct i2c_adapter *, int, int))
984{
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200985 int i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 int adap_id = i2c_adapter_id(adapter);
987
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200988 /* Force entries are done first, and are not affected by ignore
989 entries */
990 if (address_data->forces) {
991 unsigned short **forces = address_data->forces;
992 int kind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200994 for (kind = 0; forces[kind]; kind++) {
995 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
996 i += 2) {
997 if (forces[kind][i] == adap_id
998 || forces[kind][i] == ANY_I2C_BUS) {
999 dev_dbg(&adapter->dev, "found force "
1000 "parameter for adapter %d, "
1001 "addr 0x%02x, kind %d\n",
1002 adap_id, forces[kind][i + 1],
1003 kind);
1004 err = i2c_probe_address(adapter,
1005 forces[kind][i + 1],
1006 kind, found_proc);
1007 if (err)
1008 return err;
1009 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 }
1011 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001013
Jean Delvare4366dc92005-09-25 16:50:06 +02001014 /* Stop here if we can't use SMBUS_QUICK */
1015 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1016 if (address_data->probe[0] == I2C_CLIENT_END
1017 && address_data->normal_i2c[0] == I2C_CLIENT_END)
David Brownell438d6c22006-12-10 21:21:31 +01001018 return 0;
Jean Delvare4366dc92005-09-25 16:50:06 +02001019
1020 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1021 "can't probe for chips\n");
1022 return -1;
1023 }
1024
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001025 /* Probe entries are done second, and are not affected by ignore
1026 entries either */
1027 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1028 if (address_data->probe[i] == adap_id
1029 || address_data->probe[i] == ANY_I2C_BUS) {
1030 dev_dbg(&adapter->dev, "found probe parameter for "
1031 "adapter %d, addr 0x%02x\n", adap_id,
1032 address_data->probe[i + 1]);
1033 err = i2c_probe_address(adapter,
1034 address_data->probe[i + 1],
1035 -1, found_proc);
1036 if (err)
1037 return err;
1038 }
1039 }
1040
1041 /* Normal entries are done last, unless shadowed by an ignore entry */
1042 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1043 int j, ignore;
1044
1045 ignore = 0;
1046 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1047 j += 2) {
1048 if ((address_data->ignore[j] == adap_id ||
1049 address_data->ignore[j] == ANY_I2C_BUS)
1050 && address_data->ignore[j + 1]
1051 == address_data->normal_i2c[i]) {
1052 dev_dbg(&adapter->dev, "found ignore "
1053 "parameter for adapter %d, "
1054 "addr 0x%02x\n", adap_id,
1055 address_data->ignore[j + 1]);
Mark M. Hoffman2369df92006-07-01 17:01:59 +02001056 ignore = 1;
1057 break;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001058 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001059 }
1060 if (ignore)
1061 continue;
1062
1063 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1064 "addr 0x%02x\n", adap_id,
1065 address_data->normal_i2c[i]);
1066 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1067 -1, found_proc);
1068 if (err)
1069 return err;
1070 }
1071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 return 0;
1073}
David Brownellc0564602007-05-01 23:26:31 +02001074EXPORT_SYMBOL(i2c_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
Jean Delvare12b5053a2007-05-01 23:26:31 +02001076struct i2c_client *
1077i2c_new_probed_device(struct i2c_adapter *adap,
1078 struct i2c_board_info *info,
1079 unsigned short const *addr_list)
1080{
1081 int i;
1082
1083 /* Stop here if the bus doesn't support probing */
1084 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1085 dev_err(&adap->dev, "Probing not supported\n");
1086 return NULL;
1087 }
1088
1089 mutex_lock(&adap->clist_lock);
1090 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1091 /* Check address validity */
1092 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1093 dev_warn(&adap->dev, "Invalid 7-bit address "
1094 "0x%02x\n", addr_list[i]);
1095 continue;
1096 }
1097
1098 /* Check address availability */
1099 if (__i2c_check_addr(adap, addr_list[i])) {
1100 dev_dbg(&adap->dev, "Address 0x%02x already in "
1101 "use, not probing\n", addr_list[i]);
1102 continue;
1103 }
1104
1105 /* Test address responsiveness
1106 The default probe method is a quick write, but it is known
1107 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1108 and could also irreversibly write-protect some EEPROMs, so
1109 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1110 read instead. Also, some bus drivers don't implement
1111 quick write, so we fallback to a byte read it that case
1112 too. */
1113 if ((addr_list[i] & ~0x07) == 0x30
1114 || (addr_list[i] & ~0x0f) == 0x50
1115 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1116 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1117 I2C_SMBUS_READ, 0,
1118 I2C_SMBUS_BYTE, NULL) >= 0)
1119 break;
1120 } else {
1121 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1122 I2C_SMBUS_WRITE, 0,
1123 I2C_SMBUS_QUICK, NULL) >= 0)
1124 break;
1125 }
1126 }
1127 mutex_unlock(&adap->clist_lock);
1128
1129 if (addr_list[i] == I2C_CLIENT_END) {
1130 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1131 return NULL;
1132 }
1133
1134 info->addr = addr_list[i];
1135 return i2c_new_device(adap, info);
1136}
1137EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139struct i2c_adapter* i2c_get_adapter(int id)
1140{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001142
Arjan van de Venb3585e42006-01-11 10:50:26 +01001143 mutex_lock(&core_lists);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001144 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1145 if (adapter && !try_module_get(adapter->owner))
1146 adapter = NULL;
1147
Arjan van de Venb3585e42006-01-11 10:50:26 +01001148 mutex_unlock(&core_lists);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001149 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150}
David Brownellc0564602007-05-01 23:26:31 +02001151EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
1153void i2c_put_adapter(struct i2c_adapter *adap)
1154{
1155 module_put(adap->owner);
1156}
David Brownellc0564602007-05-01 23:26:31 +02001157EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158
1159/* The SMBus parts */
1160
David Brownell438d6c22006-12-10 21:21:31 +01001161#define POLY (0x1070U << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162static u8
1163crc8(u16 data)
1164{
1165 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001166
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 for(i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001168 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 data = data ^ POLY;
1170 data = data << 1;
1171 }
1172 return (u8)(data >> 8);
1173}
1174
Jean Delvare421ef472005-10-26 21:28:55 +02001175/* Incremental CRC8 over count bytes in the array pointed to by p */
1176static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177{
1178 int i;
1179
1180 for(i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001181 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 return crc;
1183}
1184
Jean Delvare421ef472005-10-26 21:28:55 +02001185/* Assume a 7-bit address, which is reasonable for SMBus */
1186static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
Jean Delvare421ef472005-10-26 21:28:55 +02001188 /* The address will be sent first */
1189 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1190 pec = i2c_smbus_pec(pec, &addr, 1);
1191
1192 /* The data buffer follows */
1193 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194}
1195
Jean Delvare421ef472005-10-26 21:28:55 +02001196/* Used for write only transactions */
1197static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198{
Jean Delvare421ef472005-10-26 21:28:55 +02001199 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1200 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201}
1202
Jean Delvare421ef472005-10-26 21:28:55 +02001203/* Return <0 on CRC error
1204 If there was a write before this read (most cases) we need to take the
1205 partial CRC from the write part into account.
1206 Note that this function does modify the message (we need to decrease the
1207 message length to hide the CRC byte from the caller). */
1208static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209{
Jean Delvare421ef472005-10-26 21:28:55 +02001210 u8 rpec = msg->buf[--msg->len];
1211 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 if (rpec != cpec) {
1214 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1215 rpec, cpec);
1216 return -1;
1217 }
David Brownell438d6c22006-12-10 21:21:31 +01001218 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219}
1220
1221s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
1222{
1223 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
David Brownell438d6c22006-12-10 21:21:31 +01001224 value,0,I2C_SMBUS_QUICK,NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225}
David Brownellc0564602007-05-01 23:26:31 +02001226EXPORT_SYMBOL(i2c_smbus_write_quick);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227
1228s32 i2c_smbus_read_byte(struct i2c_client *client)
1229{
1230 union i2c_smbus_data data;
1231 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1232 I2C_SMBUS_READ,0,I2C_SMBUS_BYTE, &data))
1233 return -1;
1234 else
Jean Delvare7eff82c2006-09-03 22:24:00 +02001235 return data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236}
David Brownellc0564602007-05-01 23:26:31 +02001237EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
1239s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1240{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001242 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243}
David Brownellc0564602007-05-01 23:26:31 +02001244EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
1246s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1247{
1248 union i2c_smbus_data data;
1249 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1250 I2C_SMBUS_READ,command, I2C_SMBUS_BYTE_DATA,&data))
1251 return -1;
1252 else
Jean Delvare7eff82c2006-09-03 22:24:00 +02001253 return data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254}
David Brownellc0564602007-05-01 23:26:31 +02001255EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256
1257s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1258{
1259 union i2c_smbus_data data;
1260 data.byte = value;
1261 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1262 I2C_SMBUS_WRITE,command,
1263 I2C_SMBUS_BYTE_DATA,&data);
1264}
David Brownellc0564602007-05-01 23:26:31 +02001265EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
1267s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1268{
1269 union i2c_smbus_data data;
1270 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1271 I2C_SMBUS_READ,command, I2C_SMBUS_WORD_DATA, &data))
1272 return -1;
1273 else
Jean Delvare7eff82c2006-09-03 22:24:00 +02001274 return data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275}
David Brownellc0564602007-05-01 23:26:31 +02001276EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
1278s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1279{
1280 union i2c_smbus_data data;
1281 data.word = value;
1282 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1283 I2C_SMBUS_WRITE,command,
1284 I2C_SMBUS_WORD_DATA,&data);
1285}
David Brownellc0564602007-05-01 23:26:31 +02001286EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
David Brownella64ec072007-10-13 23:56:31 +02001288/**
1289 * i2c_smbus_read_block_data - SMBus block read request
1290 * @client: Handle to slave device
1291 * @command: Command byte issued to let the slave know what data should
1292 * be returned
1293 * @values: Byte array into which data will be read; big enough to hold
1294 * the data returned by the slave. SMBus allows at most 32 bytes.
1295 *
1296 * Returns the number of bytes read in the slave's response, else a
1297 * negative number to indicate some kind of error.
1298 *
1299 * Note that using this function requires that the client's adapter support
1300 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1301 * support this; its emulation through I2C messaging relies on a specific
1302 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1303 */
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001304s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1305 u8 *values)
1306{
1307 union i2c_smbus_data data;
1308
1309 if (i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1310 I2C_SMBUS_READ, command,
1311 I2C_SMBUS_BLOCK_DATA, &data))
1312 return -1;
1313
1314 memcpy(values, &data.block[1], data.block[0]);
1315 return data.block[0];
1316}
1317EXPORT_SYMBOL(i2c_smbus_read_block_data);
1318
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001320 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321{
1322 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001323
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 if (length > I2C_SMBUS_BLOCK_MAX)
1325 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01001327 memcpy(&data.block[1], values, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1329 I2C_SMBUS_WRITE,command,
1330 I2C_SMBUS_BLOCK_DATA,&data);
1331}
David Brownellc0564602007-05-01 23:26:31 +02001332EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
1334/* Returns the number of read bytes */
Jean Delvare4b2643d2007-07-12 14:12:29 +02001335s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1336 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337{
1338 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001339
Jean Delvare4b2643d2007-07-12 14:12:29 +02001340 if (length > I2C_SMBUS_BLOCK_MAX)
1341 length = I2C_SMBUS_BLOCK_MAX;
1342 data.block[0] = length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1344 I2C_SMBUS_READ,command,
1345 I2C_SMBUS_I2C_BLOCK_DATA,&data))
1346 return -1;
Jean Delvare76560322006-01-18 23:14:55 +01001347
1348 memcpy(values, &data.block[1], data.block[0]);
1349 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350}
David Brownellc0564602007-05-01 23:26:31 +02001351EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352
Jean Delvare21bbd692006-01-09 15:19:18 +11001353s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001354 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11001355{
1356 union i2c_smbus_data data;
1357
1358 if (length > I2C_SMBUS_BLOCK_MAX)
1359 length = I2C_SMBUS_BLOCK_MAX;
1360 data.block[0] = length;
1361 memcpy(data.block + 1, values, length);
1362 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1363 I2C_SMBUS_WRITE, command,
1364 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1365}
David Brownellc0564602007-05-01 23:26:31 +02001366EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11001367
David Brownell438d6c22006-12-10 21:21:31 +01001368/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 No checking of parameters is done! */
David Brownell438d6c22006-12-10 21:21:31 +01001370static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001372 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 union i2c_smbus_data * data)
1374{
1375 /* So we need to generate a series of msgs. In the case of writing, we
1376 need to use only one message; when reading, we need two. We initialize
1377 most things with sane defaults, to keep the code below somewhat
1378 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001379 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1380 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 int num = read_write == I2C_SMBUS_READ?2:1;
David Brownell438d6c22006-12-10 21:21:31 +01001382 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1384 };
1385 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02001386 u8 partial_pec = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
1388 msgbuf0[0] = command;
1389 switch(size) {
1390 case I2C_SMBUS_QUICK:
1391 msg[0].len = 0;
1392 /* Special case: The read/write field is used as data */
1393 msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
1394 num = 1;
1395 break;
1396 case I2C_SMBUS_BYTE:
1397 if (read_write == I2C_SMBUS_READ) {
1398 /* Special case: only a read! */
1399 msg[0].flags = I2C_M_RD | flags;
1400 num = 1;
1401 }
1402 break;
1403 case I2C_SMBUS_BYTE_DATA:
1404 if (read_write == I2C_SMBUS_READ)
1405 msg[1].len = 1;
1406 else {
1407 msg[0].len = 2;
1408 msgbuf0[1] = data->byte;
1409 }
1410 break;
1411 case I2C_SMBUS_WORD_DATA:
1412 if (read_write == I2C_SMBUS_READ)
1413 msg[1].len = 2;
1414 else {
1415 msg[0].len=3;
1416 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001417 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 }
1419 break;
1420 case I2C_SMBUS_PROC_CALL:
1421 num = 2; /* Special case */
1422 read_write = I2C_SMBUS_READ;
1423 msg[0].len = 3;
1424 msg[1].len = 2;
1425 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001426 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 break;
1428 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02001430 msg[1].flags |= I2C_M_RECV_LEN;
1431 msg[1].len = 1; /* block length will be added by
1432 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 } else {
1434 msg[0].len = data->block[0] + 2;
1435 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1436 dev_err(&adapter->dev, "smbus_access called with "
1437 "invalid block write size (%d)\n",
1438 data->block[0]);
1439 return -1;
1440 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001441 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 msgbuf0[i] = data->block[i-1];
1443 }
1444 break;
1445 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02001446 num = 2; /* Another special case */
1447 read_write = I2C_SMBUS_READ;
1448 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1449 dev_err(&adapter->dev, "%s called with invalid "
1450 "block proc call size (%d)\n", __FUNCTION__,
1451 data->block[0]);
1452 return -1;
1453 }
1454 msg[0].len = data->block[0] + 2;
1455 for (i = 1; i < msg[0].len; i++)
1456 msgbuf0[i] = data->block[i-1];
1457 msg[1].flags |= I2C_M_RECV_LEN;
1458 msg[1].len = 1; /* block length will be added by
1459 the underlying bus driver */
1460 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 case I2C_SMBUS_I2C_BLOCK_DATA:
1462 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02001463 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 } else {
1465 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02001466 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 dev_err(&adapter->dev, "i2c_smbus_xfer_emulated called with "
1468 "invalid block write size (%d)\n",
1469 data->block[0]);
1470 return -1;
1471 }
1472 for (i = 1; i <= data->block[0]; i++)
1473 msgbuf0[i] = data->block[i];
1474 }
1475 break;
1476 default:
1477 dev_err(&adapter->dev, "smbus_access called with invalid size (%d)\n",
1478 size);
1479 return -1;
1480 }
1481
Jean Delvare421ef472005-10-26 21:28:55 +02001482 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1483 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1484 if (i) {
1485 /* Compute PEC if first message is a write */
1486 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01001487 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02001488 i2c_smbus_add_pec(&msg[0]);
1489 else /* Write followed by read */
1490 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1491 }
1492 /* Ask for PEC if last message is a read */
1493 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01001494 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02001495 }
1496
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 if (i2c_transfer(adapter, msg, num) < 0)
1498 return -1;
1499
Jean Delvare421ef472005-10-26 21:28:55 +02001500 /* Check PEC if last message is a read */
1501 if (i && (msg[num-1].flags & I2C_M_RD)) {
1502 if (i2c_smbus_check_pec(partial_pec, &msg[num-1]) < 0)
1503 return -1;
1504 }
1505
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 if (read_write == I2C_SMBUS_READ)
1507 switch(size) {
1508 case I2C_SMBUS_BYTE:
1509 data->byte = msgbuf0[0];
1510 break;
1511 case I2C_SMBUS_BYTE_DATA:
1512 data->byte = msgbuf1[0];
1513 break;
David Brownell438d6c22006-12-10 21:21:31 +01001514 case I2C_SMBUS_WORD_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 case I2C_SMBUS_PROC_CALL:
1516 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1517 break;
1518 case I2C_SMBUS_I2C_BLOCK_DATA:
Jean Delvare4b2643d2007-07-12 14:12:29 +02001519 for (i = 0; i < data->block[0]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 data->block[i+1] = msgbuf1[i];
1521 break;
Jean Delvare209d27c2007-05-01 23:26:29 +02001522 case I2C_SMBUS_BLOCK_DATA:
1523 case I2C_SMBUS_BLOCK_PROC_CALL:
1524 for (i = 0; i < msgbuf1[0] + 1; i++)
1525 data->block[i] = msgbuf1[i];
1526 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 }
1528 return 0;
1529}
1530
1531
1532s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001533 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 union i2c_smbus_data * data)
1535{
1536 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
1538 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
1540 if (adapter->algo->smbus_xfer) {
Ingo Molnar5c085d32006-01-18 23:16:04 +01001541 mutex_lock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
1543 command,size,data);
Ingo Molnar5c085d32006-01-18 23:16:04 +01001544 mutex_unlock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 } else
1546 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
1547 command,size,data);
1548
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 return res;
1550}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
1553MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1554MODULE_DESCRIPTION("I2C-Bus main module");
1555MODULE_LICENSE("GPL");