blob: c8bbd672226b2ce8deb8d4b33b48c9ddbee9323a [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>
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>
Mike Rapoportcea443a2008-01-27 18:14:50 +010036#include <linux/hardirq.h>
37#include <linux/irqflags.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <asm/uaccess.h>
Jean Delvare87c6c222008-01-27 18:14:48 +010039#include <asm/semaphore.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
David Brownell9c1600e2007-05-01 23:26:31 +020041#include "i2c-core.h"
42
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Jean Delvarecaada322008-01-27 18:14:49 +010044static DEFINE_MUTEX(core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045static DEFINE_IDR(i2c_adapter_idr);
46
David Brownella1d9e6e2007-05-01 23:26:30 +020047#define is_newstyle_driver(d) ((d)->probe || (d)->remove)
David Brownellf37dd802007-02-13 22:09:00 +010048
49/* ------------------------------------------------------------------------- */
50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051static int i2c_device_match(struct device *dev, struct device_driver *drv)
52{
David Brownell7b4fbc52007-05-01 23:26:30 +020053 struct i2c_client *client = to_i2c_client(dev);
54 struct i2c_driver *driver = to_i2c_driver(drv);
55
56 /* make legacy i2c drivers bypass driver model probing entirely;
57 * such drivers scan each i2c adapter/bus themselves.
58 */
David Brownella1d9e6e2007-05-01 23:26:30 +020059 if (!is_newstyle_driver(driver))
David Brownell7b4fbc52007-05-01 23:26:30 +020060 return 0;
61
62 /* new style drivers use the same kind of driver matching policy
63 * as platform devices or SPI: compare device and driver IDs.
64 */
65 return strcmp(client->driver_name, drv->name) == 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066}
67
David Brownell7b4fbc52007-05-01 23:26:30 +020068#ifdef CONFIG_HOTPLUG
69
70/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +020071static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +020072{
73 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +020074
75 /* by definition, legacy drivers can't hotplug */
76 if (dev->driver || !client->driver_name)
77 return 0;
78
Kay Sievers7eff2e72007-08-14 15:15:12 +020079 if (add_uevent_var(env, "MODALIAS=%s", client->driver_name))
David Brownell7b4fbc52007-05-01 23:26:30 +020080 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +020081 dev_dbg(dev, "uevent\n");
82 return 0;
83}
84
85#else
86#define i2c_device_uevent NULL
87#endif /* CONFIG_HOTPLUG */
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089static int i2c_device_probe(struct device *dev)
90{
David Brownell7b4fbc52007-05-01 23:26:30 +020091 struct i2c_client *client = to_i2c_client(dev);
92 struct i2c_driver *driver = to_i2c_driver(dev->driver);
93
94 if (!driver->probe)
95 return -ENODEV;
96 client->driver = driver;
97 dev_dbg(dev, "probe\n");
98 return driver->probe(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099}
100
101static int i2c_device_remove(struct device *dev)
102{
David Brownella1d9e6e2007-05-01 23:26:30 +0200103 struct i2c_client *client = to_i2c_client(dev);
104 struct i2c_driver *driver;
105 int status;
106
107 if (!dev->driver)
108 return 0;
109
110 driver = to_i2c_driver(dev->driver);
111 if (driver->remove) {
112 dev_dbg(dev, "remove\n");
113 status = driver->remove(client);
114 } else {
115 dev->driver = NULL;
116 status = 0;
117 }
118 if (status == 0)
119 client->driver = NULL;
120 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121}
122
David Brownellf37dd802007-02-13 22:09:00 +0100123static void i2c_device_shutdown(struct device *dev)
124{
125 struct i2c_driver *driver;
126
127 if (!dev->driver)
128 return;
129 driver = to_i2c_driver(dev->driver);
130 if (driver->shutdown)
131 driver->shutdown(to_i2c_client(dev));
132}
133
134static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
135{
136 struct i2c_driver *driver;
137
138 if (!dev->driver)
139 return 0;
140 driver = to_i2c_driver(dev->driver);
141 if (!driver->suspend)
142 return 0;
143 return driver->suspend(to_i2c_client(dev), mesg);
144}
145
146static int i2c_device_resume(struct device * dev)
147{
148 struct i2c_driver *driver;
149
150 if (!dev->driver)
151 return 0;
152 driver = to_i2c_driver(dev->driver);
153 if (!driver->resume)
154 return 0;
155 return driver->resume(to_i2c_client(dev));
156}
157
David Brownell7b4fbc52007-05-01 23:26:30 +0200158static void i2c_client_release(struct device *dev)
159{
160 struct i2c_client *client = to_i2c_client(dev);
161 complete(&client->released);
162}
163
David Brownell9c1600e2007-05-01 23:26:31 +0200164static void i2c_client_dev_release(struct device *dev)
165{
166 kfree(to_i2c_client(dev));
167}
168
David Brownell7b4fbc52007-05-01 23:26:30 +0200169static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
170{
171 struct i2c_client *client = to_i2c_client(dev);
172 return sprintf(buf, "%s\n", client->name);
173}
174
175static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
176{
177 struct i2c_client *client = to_i2c_client(dev);
178 return client->driver_name
179 ? sprintf(buf, "%s\n", client->driver_name)
180 : 0;
181}
182
183static struct device_attribute i2c_dev_attrs[] = {
184 __ATTR(name, S_IRUGO, show_client_name, NULL),
185 /* modalias helps coldplug: modprobe $(cat .../modalias) */
186 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
187 { },
188};
189
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200190static struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100191 .name = "i2c",
David Brownell7b4fbc52007-05-01 23:26:30 +0200192 .dev_attrs = i2c_dev_attrs,
David Brownellf37dd802007-02-13 22:09:00 +0100193 .match = i2c_device_match,
David Brownell7b4fbc52007-05-01 23:26:30 +0200194 .uevent = i2c_device_uevent,
David Brownellf37dd802007-02-13 22:09:00 +0100195 .probe = i2c_device_probe,
196 .remove = i2c_device_remove,
197 .shutdown = i2c_device_shutdown,
198 .suspend = i2c_device_suspend,
199 .resume = i2c_device_resume,
Russell Kingb864c7d2006-01-05 14:37:50 +0000200};
201
David Brownell9b766b82008-01-27 18:14:51 +0100202
203/**
204 * i2c_verify_client - return parameter as i2c_client, or NULL
205 * @dev: device, probably from some driver model iterator
206 *
207 * When traversing the driver model tree, perhaps using driver model
208 * iterators like @device_for_each_child(), you can't assume very much
209 * about the nodes you find. Use this function to avoid oopses caused
210 * by wrongly treating some non-I2C device as an i2c_client.
211 */
212struct i2c_client *i2c_verify_client(struct device *dev)
213{
214 return (dev->bus == &i2c_bus_type)
215 ? to_i2c_client(dev)
216 : NULL;
217}
218EXPORT_SYMBOL(i2c_verify_client);
219
220
David Brownell9c1600e2007-05-01 23:26:31 +0200221/**
222 * i2c_new_device - instantiate an i2c device for use with a new style driver
223 * @adap: the adapter managing the device
224 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200225 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200226 *
227 * Create a device to work with a new style i2c driver, where binding is
228 * handled through driver model probe()/remove() methods. This call is not
229 * appropriate for use by mainboad initialization logic, which usually runs
230 * during an arch_initcall() long before any i2c_adapter could exist.
231 *
232 * This returns the new i2c client, which may be saved for later use with
233 * i2c_unregister_device(); or NULL to indicate an error.
234 */
235struct i2c_client *
236i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
237{
238 struct i2c_client *client;
239 int status;
240
241 client = kzalloc(sizeof *client, GFP_KERNEL);
242 if (!client)
243 return NULL;
244
245 client->adapter = adap;
246
247 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200248 device_init_wakeup(&client->dev, info->flags & I2C_CLIENT_WAKE);
249
250 client->flags = info->flags & ~I2C_CLIENT_WAKE;
David Brownell9c1600e2007-05-01 23:26:31 +0200251 client->addr = info->addr;
252 client->irq = info->irq;
253
254 strlcpy(client->driver_name, info->driver_name,
255 sizeof(client->driver_name));
256 strlcpy(client->name, info->type, sizeof(client->name));
257
258 /* a new style driver may be bound to this device when we
259 * return from this function, or any later moment (e.g. maybe
260 * hotplugging will load the driver module). and the device
261 * refcount model is the standard driver model one.
262 */
263 status = i2c_attach_client(client);
264 if (status < 0) {
265 kfree(client);
266 client = NULL;
267 }
268 return client;
269}
270EXPORT_SYMBOL_GPL(i2c_new_device);
271
272
273/**
274 * i2c_unregister_device - reverse effect of i2c_new_device()
275 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200276 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200277 */
278void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200279{
280 struct i2c_adapter *adapter = client->adapter;
281 struct i2c_driver *driver = client->driver;
282
283 if (driver && !is_newstyle_driver(driver)) {
284 dev_err(&client->dev, "can't unregister devices "
285 "with legacy drivers\n");
286 WARN_ON(1);
287 return;
288 }
289
290 mutex_lock(&adapter->clist_lock);
291 list_del(&client->list);
292 mutex_unlock(&adapter->clist_lock);
293
294 device_unregister(&client->dev);
295}
David Brownell9c1600e2007-05-01 23:26:31 +0200296EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200297
298
David Brownellf37dd802007-02-13 22:09:00 +0100299/* ------------------------------------------------------------------------- */
300
David Brownell16ffadf2007-05-01 23:26:28 +0200301/* I2C bus adapters -- one roots each I2C or SMBUS segment */
302
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200303static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304{
David Brownellef2c83212007-05-01 23:26:28 +0200305 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 complete(&adap->dev_released);
307}
308
David Brownell16ffadf2007-05-01 23:26:28 +0200309static ssize_t
310show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311{
David Brownellef2c83212007-05-01 23:26:28 +0200312 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 return sprintf(buf, "%s\n", adap->name);
314}
David Brownell16ffadf2007-05-01 23:26:28 +0200315
316static struct device_attribute i2c_adapter_attrs[] = {
317 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
318 { },
319};
320
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200321static struct class i2c_adapter_class = {
David Brownell16ffadf2007-05-01 23:26:28 +0200322 .owner = THIS_MODULE,
323 .name = "i2c-adapter",
324 .dev_attrs = i2c_adapter_attrs,
325};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
David Brownell9c1600e2007-05-01 23:26:31 +0200327static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
328{
329 struct i2c_devinfo *devinfo;
330
331 mutex_lock(&__i2c_board_lock);
332 list_for_each_entry(devinfo, &__i2c_board_list, list) {
333 if (devinfo->busnum == adapter->nr
334 && !i2c_new_device(adapter,
335 &devinfo->board_info))
336 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
337 i2c_adapter_id(adapter),
338 devinfo->board_info.addr);
339 }
340 mutex_unlock(&__i2c_board_lock);
341}
342
Jean Delvare026526f2008-01-27 18:14:49 +0100343static int i2c_do_add_adapter(struct device_driver *d, void *data)
344{
345 struct i2c_driver *driver = to_i2c_driver(d);
346 struct i2c_adapter *adap = data;
347
348 if (driver->attach_adapter) {
349 /* We ignore the return code; if it fails, too bad */
350 driver->attach_adapter(adap);
351 }
352 return 0;
353}
354
David Brownell6e13e642007-05-01 23:26:31 +0200355static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356{
Jean Delvare026526f2008-01-27 18:14:49 +0100357 int res = 0, dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Ingo Molnar5c085d32006-01-18 23:16:04 +0100359 mutex_init(&adap->bus_lock);
360 mutex_init(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 INIT_LIST_HEAD(&adap->clients);
362
Jean Delvarecaada322008-01-27 18:14:49 +0100363 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 /* Add the adapter to the driver core.
366 * If the parent pointer is not set up,
367 * we add this adapter to the host bus.
368 */
David Brownellb119dc32007-01-04 13:07:04 +0100369 if (adap->dev.parent == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 adap->dev.parent = &platform_bus;
Jean Delvarefe2c8d52007-02-13 22:09:04 +0100371 pr_debug("I2C adapter driver [%s] forgot to specify "
372 "physical device\n", adap->name);
David Brownellb119dc32007-01-04 13:07:04 +0100373 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 adap->dev.release = &i2c_adapter_dev_release;
Jean Delvarefccb56e2007-05-01 23:26:27 +0200376 adap->dev.class = &i2c_adapter_class;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200377 res = device_register(&adap->dev);
378 if (res)
379 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200381 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
382
David Brownell6e13e642007-05-01 23:26:31 +0200383 /* create pre-declared device nodes for new-style drivers */
384 if (adap->nr < __i2c_first_dynamic_bus_num)
385 i2c_scan_static_board_info(adap);
386
David Brownell7b4fbc52007-05-01 23:26:30 +0200387 /* let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +0100388 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
389 i2c_do_add_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100392 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 return res;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200394
Jean Delvareb119c6c2006-08-15 18:26:30 +0200395out_list:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200396 idr_remove(&i2c_adapter_idr, adap->nr);
397 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398}
399
David Brownell6e13e642007-05-01 23:26:31 +0200400/**
401 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
402 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +0200403 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200404 *
405 * This routine is used to declare an I2C adapter when its bus number
406 * doesn't matter. Examples: for I2C adapters dynamically added by
407 * USB links or PCI plugin cards.
408 *
409 * When this returns zero, a new bus number was allocated and stored
410 * in adap->nr, and the specified adapter became available for clients.
411 * Otherwise, a negative errno value is returned.
412 */
413int i2c_add_adapter(struct i2c_adapter *adapter)
414{
415 int id, res = 0;
416
417retry:
418 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
419 return -ENOMEM;
420
Jean Delvarecaada322008-01-27 18:14:49 +0100421 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200422 /* "above" here means "above or equal to", sigh */
423 res = idr_get_new_above(&i2c_adapter_idr, adapter,
424 __i2c_first_dynamic_bus_num, &id);
Jean Delvarecaada322008-01-27 18:14:49 +0100425 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200426
427 if (res < 0) {
428 if (res == -EAGAIN)
429 goto retry;
430 return res;
431 }
432
433 adapter->nr = id;
434 return i2c_register_adapter(adapter);
435}
436EXPORT_SYMBOL(i2c_add_adapter);
437
438/**
439 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
440 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +0200441 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200442 *
443 * This routine is used to declare an I2C adapter when its bus number
444 * matters. Example: for I2C adapters from system-on-chip CPUs, or
445 * otherwise built in to the system's mainboard, and where i2c_board_info
446 * is used to properly configure I2C devices.
447 *
448 * If no devices have pre-been declared for this bus, then be sure to
449 * register the adapter before any dynamically allocated ones. Otherwise
450 * the required bus ID may not be available.
451 *
452 * When this returns zero, the specified adapter became available for
453 * clients using the bus number provided in adap->nr. Also, the table
454 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
455 * and the appropriate driver model device nodes are created. Otherwise, a
456 * negative errno value is returned.
457 */
458int i2c_add_numbered_adapter(struct i2c_adapter *adap)
459{
460 int id;
461 int status;
462
463 if (adap->nr & ~MAX_ID_MASK)
464 return -EINVAL;
465
466retry:
467 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
468 return -ENOMEM;
469
Jean Delvarecaada322008-01-27 18:14:49 +0100470 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200471 /* "above" here means "above or equal to", sigh;
472 * we need the "equal to" result to force the result
473 */
474 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
475 if (status == 0 && id != adap->nr) {
476 status = -EBUSY;
477 idr_remove(&i2c_adapter_idr, id);
478 }
Jean Delvarecaada322008-01-27 18:14:49 +0100479 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200480 if (status == -EAGAIN)
481 goto retry;
482
483 if (status == 0)
484 status = i2c_register_adapter(adap);
485 return status;
486}
487EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
488
Jean Delvare026526f2008-01-27 18:14:49 +0100489static int i2c_do_del_adapter(struct device_driver *d, void *data)
490{
491 struct i2c_driver *driver = to_i2c_driver(d);
492 struct i2c_adapter *adapter = data;
493 int res;
494
495 if (!driver->detach_adapter)
496 return 0;
497 res = driver->detach_adapter(adapter);
498 if (res)
499 dev_err(&adapter->dev, "detach_adapter failed (%d) "
500 "for driver [%s]\n", res, driver->driver.name);
501 return res;
502}
503
David Brownelld64f73b2007-07-12 14:12:28 +0200504/**
505 * i2c_del_adapter - unregister I2C adapter
506 * @adap: the adapter being unregistered
507 * Context: can sleep
508 *
509 * This unregisters an I2C adapter which was previously registered
510 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
511 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512int i2c_del_adapter(struct i2c_adapter *adap)
513{
514 struct list_head *item, *_n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 struct i2c_client *client;
516 int res = 0;
517
Jean Delvarecaada322008-01-27 18:14:49 +0100518 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
520 /* First make sure that this adapter was ever added */
Jean Delvare87c6c222008-01-27 18:14:48 +0100521 if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200522 pr_debug("i2c-core: attempting to delete unregistered "
523 "adapter [%s]\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 res = -EINVAL;
525 goto out_unlock;
526 }
527
Jean Delvare026526f2008-01-27 18:14:49 +0100528 /* Tell drivers about this removal */
529 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
530 i2c_do_del_adapter);
531 if (res)
532 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
534 /* detach any active clients. This must be done first, because
Tobias Klausera551acc2005-05-19 21:40:38 +0200535 * it can fail; in which case we give up. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 list_for_each_safe(item, _n, &adap->clients) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200537 struct i2c_driver *driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
David Brownella1d9e6e2007-05-01 23:26:30 +0200539 client = list_entry(item, struct i2c_client, list);
540 driver = client->driver;
541
542 /* new style, follow standard driver model */
543 if (!driver || is_newstyle_driver(driver)) {
544 i2c_unregister_device(client);
545 continue;
546 }
547
548 /* legacy drivers create and remove clients themselves */
549 if ((res = driver->detach_client(client))) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200550 dev_err(&adap->dev, "detach_client failed for client "
551 "[%s] at address 0x%02x\n", client->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 client->addr);
553 goto out_unlock;
554 }
555 }
556
557 /* clean up the sysfs representation */
558 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
561 /* wait for sysfs to drop all references */
562 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
David Brownell6e13e642007-05-01 23:26:31 +0200564 /* free bus id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 idr_remove(&i2c_adapter_idr, adap->nr);
566
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200567 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
569 out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100570 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 return res;
572}
David Brownellc0564602007-05-01 23:26:31 +0200573EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
575
David Brownell7b4fbc52007-05-01 23:26:30 +0200576/* ------------------------------------------------------------------------- */
577
578/*
579 * An i2c_driver is used with one or more i2c_client (device) nodes to access
580 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
581 * are two models for binding the driver to its device: "new style" drivers
582 * follow the standard Linux driver model and just respond to probe() calls
583 * issued if the driver core sees they match(); "legacy" drivers create device
584 * nodes themselves.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 */
586
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800587int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
Jean Delvare7eebcb72006-02-05 23:28:21 +0100589 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
David Brownell7b4fbc52007-05-01 23:26:30 +0200591 /* new style driver methods can't mix with legacy ones */
David Brownella1d9e6e2007-05-01 23:26:30 +0200592 if (is_newstyle_driver(driver)) {
David Brownell7b4fbc52007-05-01 23:26:30 +0200593 if (driver->attach_adapter || driver->detach_adapter
594 || driver->detach_client) {
595 printk(KERN_WARNING
596 "i2c-core: driver [%s] is confused\n",
597 driver->driver.name);
598 return -EINVAL;
599 }
600 }
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800603 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
David Brownell6e13e642007-05-01 23:26:31 +0200606 /* for new style drivers, when registration returns the driver core
607 * will have called probe() for all matching-but-unbound devices.
608 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 res = driver_register(&driver->driver);
610 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +0100611 return res;
David Brownell438d6c22006-12-10 21:21:31 +0100612
Jean Delvarecaada322008-01-27 18:14:49 +0100613 mutex_lock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100614
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100615 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
David Brownell7b4fbc52007-05-01 23:26:30 +0200617 /* legacy drivers scan i2c busses directly */
Jean Delvare8a994752005-11-26 20:28:06 +0100618 if (driver->attach_adapter) {
David Brownell4ad4eac2007-05-01 23:26:28 +0200619 struct i2c_adapter *adapter;
620
Jean Delvare87c6c222008-01-27 18:14:48 +0100621 down(&i2c_adapter_class.sem);
622 list_for_each_entry(adapter, &i2c_adapter_class.devices,
623 dev.node) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 driver->attach_adapter(adapter);
625 }
Jean Delvare87c6c222008-01-27 18:14:48 +0100626 up(&i2c_adapter_class.sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 }
628
Jean Delvarecaada322008-01-27 18:14:49 +0100629 mutex_unlock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100630 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800632EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
David Brownella1d9e6e2007-05-01 23:26:30 +0200634/**
635 * i2c_del_driver - unregister I2C driver
636 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +0200637 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +0200638 */
Jean Delvareb3e82092007-05-01 23:26:32 +0200639void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
Jean Delvare87c6c222008-01-27 18:14:48 +0100641 struct list_head *item2, *_n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 struct i2c_client *client;
643 struct i2c_adapter *adap;
David Brownell438d6c22006-12-10 21:21:31 +0100644
Jean Delvarecaada322008-01-27 18:14:49 +0100645 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
David Brownella1d9e6e2007-05-01 23:26:30 +0200647 /* new-style driver? */
648 if (is_newstyle_driver(driver))
649 goto unregister;
650
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 /* Have a look at each adapter, if clients of this driver are still
David Brownell438d6c22006-12-10 21:21:31 +0100652 * attached. If so, detach them to be able to kill the driver
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 * afterwards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 */
Jean Delvare87c6c222008-01-27 18:14:48 +0100655 down(&i2c_adapter_class.sem);
656 list_for_each_entry(adap, &i2c_adapter_class.devices, dev.node) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 if (driver->detach_adapter) {
Jean Delvareb3e82092007-05-01 23:26:32 +0200658 if (driver->detach_adapter(adap)) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200659 dev_err(&adap->dev, "detach_adapter failed "
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100660 "for driver [%s]\n",
661 driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 }
663 } else {
664 list_for_each_safe(item2, _n, &adap->clients) {
665 client = list_entry(item2, struct i2c_client, list);
666 if (client->driver != driver)
667 continue;
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200668 dev_dbg(&adap->dev, "detaching client [%s] "
669 "at 0x%02x\n", client->name,
670 client->addr);
Jean Delvareb3e82092007-05-01 23:26:32 +0200671 if (driver->detach_client(client)) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200672 dev_err(&adap->dev, "detach_client "
673 "failed for client [%s] at "
674 "0x%02x\n", client->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 client->addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 }
677 }
678 }
679 }
Jean Delvare87c6c222008-01-27 18:14:48 +0100680 up(&i2c_adapter_class.sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
David Brownella1d9e6e2007-05-01 23:26:30 +0200682 unregister:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100684 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Jean Delvarecaada322008-01-27 18:14:49 +0100686 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687}
David Brownellc0564602007-05-01 23:26:31 +0200688EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
David Brownell7b4fbc52007-05-01 23:26:30 +0200690/* ------------------------------------------------------------------------- */
691
David Brownell9b766b82008-01-27 18:14:51 +0100692static int __i2c_check_addr(struct device *dev, void *addrp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693{
David Brownell9b766b82008-01-27 18:14:51 +0100694 struct i2c_client *client = i2c_verify_client(dev);
695 int addr = *(int *)addrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
David Brownell9b766b82008-01-27 18:14:51 +0100697 if (client && client->addr == addr)
698 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 return 0;
700}
701
Jean Delvare5e31c2b2007-11-15 19:24:02 +0100702static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703{
David Brownell9b766b82008-01-27 18:14:51 +0100704 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705}
706
707int i2c_attach_client(struct i2c_client *client)
708{
709 struct i2c_adapter *adapter = client->adapter;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200710 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Ingo Molnar5c085d32006-01-18 23:16:04 +0100712 mutex_lock(&adapter->clist_lock);
David Brownell9b766b82008-01-27 18:14:51 +0100713 if (i2c_check_addr(client->adapter, client->addr)) {
Jean Delvareb119c6c2006-08-15 18:26:30 +0200714 res = -EBUSY;
715 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 }
717 list_add_tail(&client->list,&adapter->clients);
David Brownell438d6c22006-12-10 21:21:31 +0100718
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 client->dev.parent = &client->adapter->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 client->dev.bus = &i2c_bus_type;
David Brownell9c1600e2007-05-01 23:26:31 +0200721
722 if (client->driver)
723 client->dev.driver = &client->driver->driver;
724
David Brownellde81d2a2007-05-22 19:49:16 +0200725 if (client->driver && !is_newstyle_driver(client->driver)) {
David Brownell9c1600e2007-05-01 23:26:31 +0200726 client->dev.release = i2c_client_release;
David Brownellde81d2a2007-05-22 19:49:16 +0200727 client->dev.uevent_suppress = 1;
728 } else
David Brownell9c1600e2007-05-01 23:26:31 +0200729 client->dev.release = i2c_client_dev_release;
David Brownell438d6c22006-12-10 21:21:31 +0100730
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
732 "%d-%04x", i2c_adapter_id(adapter), client->addr);
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200733 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
734 client->name, client->dev.bus_id);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200735 res = device_register(&client->dev);
736 if (res)
737 goto out_list;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200738 mutex_unlock(&adapter->clist_lock);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200739
740 if (adapter->client_register) {
741 if (adapter->client_register(client)) {
742 dev_dbg(&adapter->dev, "client_register "
743 "failed for client [%s] at 0x%02x\n",
744 client->name, client->addr);
745 }
746 }
747
748 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200749
Jean Delvareb119c6c2006-08-15 18:26:30 +0200750out_list:
751 list_del(&client->list);
752 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
753 "(%d)\n", client->name, client->addr, res);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200754out_unlock:
755 mutex_unlock(&adapter->clist_lock);
756 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757}
David Brownellc0564602007-05-01 23:26:31 +0200758EXPORT_SYMBOL(i2c_attach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
760int i2c_detach_client(struct i2c_client *client)
761{
762 struct i2c_adapter *adapter = client->adapter;
763 int res = 0;
David Brownell438d6c22006-12-10 21:21:31 +0100764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 if (adapter->client_unregister) {
766 res = adapter->client_unregister(client);
767 if (res) {
768 dev_err(&client->dev,
Jean Delvare86749e82005-07-29 12:15:29 -0700769 "client_unregister [%s] failed, "
770 "client not detached\n", client->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 goto out;
772 }
773 }
774
Ingo Molnar5c085d32006-01-18 23:16:04 +0100775 mutex_lock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 list_del(&client->list);
777 init_completion(&client->released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 device_unregister(&client->dev);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100779 mutex_unlock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 wait_for_completion(&client->released);
781
782 out:
783 return res;
784}
David Brownellc0564602007-05-01 23:26:31 +0200785EXPORT_SYMBOL(i2c_detach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Jean Delvaree48d3312008-01-27 18:14:48 +0100787/**
788 * i2c_use_client - increments the reference count of the i2c client structure
789 * @client: the client being referenced
790 *
791 * Each live reference to a client should be refcounted. The driver model does
792 * that automatically as part of driver binding, so that most drivers don't
793 * need to do this explicitly: they hold a reference until they're unbound
794 * from the device.
795 *
796 * A pointer to the client with the incremented reference counter is returned.
797 */
798struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
Jean Delvarebdc511f2008-01-27 18:14:48 +0100800 get_device(&client->dev);
Jean Delvaree48d3312008-01-27 18:14:48 +0100801 return client;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802}
David Brownellc0564602007-05-01 23:26:31 +0200803EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
Jean Delvaree48d3312008-01-27 18:14:48 +0100805/**
806 * i2c_release_client - release a use of the i2c client structure
807 * @client: the client being no longer referenced
808 *
809 * Must be called when a user of a client is finished with it.
810 */
811void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812{
Jean Delvarebdc511f2008-01-27 18:14:48 +0100813 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814}
David Brownellc0564602007-05-01 23:26:31 +0200815EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816
David Brownell9b766b82008-01-27 18:14:51 +0100817struct i2c_cmd_arg {
818 unsigned cmd;
819 void *arg;
820};
821
822static int i2c_cmd(struct device *dev, void *_arg)
823{
824 struct i2c_client *client = i2c_verify_client(dev);
825 struct i2c_cmd_arg *arg = _arg;
826
827 if (client && client->driver && client->driver->command)
828 client->driver->command(client, arg->cmd, arg->arg);
829 return 0;
830}
831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
833{
David Brownell9b766b82008-01-27 18:14:51 +0100834 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
David Brownell9b766b82008-01-27 18:14:51 +0100836 cmd_arg.cmd = cmd;
837 cmd_arg.arg = arg;
838 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839}
David Brownellc0564602007-05-01 23:26:31 +0200840EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
842static int __init i2c_init(void)
843{
844 int retval;
845
846 retval = bus_register(&i2c_bus_type);
847 if (retval)
848 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 return class_register(&i2c_adapter_class);
850}
851
852static void __exit i2c_exit(void)
853{
854 class_unregister(&i2c_adapter_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 bus_unregister(&i2c_bus_type);
856}
857
858subsys_initcall(i2c_init);
859module_exit(i2c_exit);
860
861/* ----------------------------------------------------
862 * the functional interface to the i2c busses.
863 * ----------------------------------------------------
864 */
865
866int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
867{
868 int ret;
869
870 if (adap->algo->master_xfer) {
871#ifdef DEBUG
872 for (ret = 0; ret < num; ret++) {
873 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +0200874 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
875 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
876 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 }
878#endif
879
Mike Rapoportcea443a2008-01-27 18:14:50 +0100880 if (in_atomic() || irqs_disabled()) {
881 ret = mutex_trylock(&adap->bus_lock);
882 if (!ret)
883 /* I2C activity is ongoing. */
884 return -EAGAIN;
885 } else {
886 mutex_lock_nested(&adap->bus_lock, adap->level);
887 }
888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 ret = adap->algo->master_xfer(adap,msgs,num);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100890 mutex_unlock(&adap->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
892 return ret;
893 } else {
894 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
895 return -ENOSYS;
896 }
897}
David Brownellc0564602007-05-01 23:26:31 +0200898EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
900int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
901{
902 int ret;
903 struct i2c_adapter *adap=client->adapter;
904 struct i2c_msg msg;
905
Jean Delvare815f55f2005-05-07 22:58:46 +0200906 msg.addr = client->addr;
907 msg.flags = client->flags & I2C_M_TEN;
908 msg.len = count;
909 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +0100910
Jean Delvare815f55f2005-05-07 22:58:46 +0200911 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
Jean Delvare815f55f2005-05-07 22:58:46 +0200913 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
914 transmitted, else error code. */
915 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916}
David Brownellc0564602007-05-01 23:26:31 +0200917EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
920{
921 struct i2c_adapter *adap=client->adapter;
922 struct i2c_msg msg;
923 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
Jean Delvare815f55f2005-05-07 22:58:46 +0200925 msg.addr = client->addr;
926 msg.flags = client->flags & I2C_M_TEN;
927 msg.flags |= I2C_M_RD;
928 msg.len = count;
929 msg.buf = buf;
930
931 ret = i2c_transfer(adap, &msg, 1);
932
933 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
934 transmitted, else error code. */
935 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936}
David Brownellc0564602007-05-01 23:26:31 +0200937EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939/* ----------------------------------------------------
940 * the i2c address scanning function
941 * Will not work for 10-bit addresses!
942 * ----------------------------------------------------
943 */
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200944static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
945 int (*found_proc) (struct i2c_adapter *, int, int))
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200946{
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200947 int err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200948
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200949 /* Make sure the address is valid */
950 if (addr < 0x03 || addr > 0x77) {
951 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
952 addr);
953 return -EINVAL;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200954 }
955
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200956 /* Skip if already in use */
957 if (i2c_check_addr(adapter, addr))
958 return 0;
959
960 /* Make sure there is something at this address, unless forced */
Jean Delvare4c9337d2005-08-09 20:28:10 +0200961 if (kind < 0) {
962 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
963 I2C_SMBUS_QUICK, NULL) < 0)
964 return 0;
965
966 /* prevent 24RF08 corruption */
967 if ((addr & ~0x0f) == 0x50)
968 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
969 I2C_SMBUS_QUICK, NULL);
970 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200971
972 /* Finally call the custom detection function */
973 err = found_proc(adapter, addr, kind);
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200974 /* -ENODEV can be returned if there is a chip at the given address
975 but it isn't supported by this chip driver. We catch it here as
976 this isn't an error. */
Jean Delvare114fd182006-09-03 22:25:04 +0200977 if (err == -ENODEV)
978 err = 0;
979
980 if (err)
981 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
982 addr, err);
983 return err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200984}
985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986int i2c_probe(struct i2c_adapter *adapter,
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100987 const struct i2c_client_address_data *address_data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 int (*found_proc) (struct i2c_adapter *, int, int))
989{
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200990 int i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 int adap_id = i2c_adapter_id(adapter);
992
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200993 /* Force entries are done first, and are not affected by ignore
994 entries */
995 if (address_data->forces) {
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +0100996 const unsigned short * const *forces = address_data->forces;
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200997 int kind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Jean Delvarea89ba0b2005-08-09 20:17:55 +0200999 for (kind = 0; forces[kind]; kind++) {
1000 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1001 i += 2) {
1002 if (forces[kind][i] == adap_id
1003 || forces[kind][i] == ANY_I2C_BUS) {
1004 dev_dbg(&adapter->dev, "found force "
1005 "parameter for adapter %d, "
1006 "addr 0x%02x, kind %d\n",
1007 adap_id, forces[kind][i + 1],
1008 kind);
1009 err = i2c_probe_address(adapter,
1010 forces[kind][i + 1],
1011 kind, found_proc);
1012 if (err)
1013 return err;
1014 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 }
1016 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001018
Jean Delvare4366dc92005-09-25 16:50:06 +02001019 /* Stop here if we can't use SMBUS_QUICK */
1020 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1021 if (address_data->probe[0] == I2C_CLIENT_END
1022 && address_data->normal_i2c[0] == I2C_CLIENT_END)
David Brownell438d6c22006-12-10 21:21:31 +01001023 return 0;
Jean Delvare4366dc92005-09-25 16:50:06 +02001024
1025 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1026 "can't probe for chips\n");
1027 return -1;
1028 }
1029
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001030 /* Probe entries are done second, and are not affected by ignore
1031 entries either */
1032 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1033 if (address_data->probe[i] == adap_id
1034 || address_data->probe[i] == ANY_I2C_BUS) {
1035 dev_dbg(&adapter->dev, "found probe parameter for "
1036 "adapter %d, addr 0x%02x\n", adap_id,
1037 address_data->probe[i + 1]);
1038 err = i2c_probe_address(adapter,
1039 address_data->probe[i + 1],
1040 -1, found_proc);
1041 if (err)
1042 return err;
1043 }
1044 }
1045
1046 /* Normal entries are done last, unless shadowed by an ignore entry */
1047 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1048 int j, ignore;
1049
1050 ignore = 0;
1051 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1052 j += 2) {
1053 if ((address_data->ignore[j] == adap_id ||
1054 address_data->ignore[j] == ANY_I2C_BUS)
1055 && address_data->ignore[j + 1]
1056 == address_data->normal_i2c[i]) {
1057 dev_dbg(&adapter->dev, "found ignore "
1058 "parameter for adapter %d, "
1059 "addr 0x%02x\n", adap_id,
1060 address_data->ignore[j + 1]);
Mark M. Hoffman2369df92006-07-01 17:01:59 +02001061 ignore = 1;
1062 break;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001063 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001064 }
1065 if (ignore)
1066 continue;
1067
1068 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1069 "addr 0x%02x\n", adap_id,
1070 address_data->normal_i2c[i]);
1071 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1072 -1, found_proc);
1073 if (err)
1074 return err;
1075 }
1076
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 return 0;
1078}
David Brownellc0564602007-05-01 23:26:31 +02001079EXPORT_SYMBOL(i2c_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080
Jean Delvare12b5053a2007-05-01 23:26:31 +02001081struct i2c_client *
1082i2c_new_probed_device(struct i2c_adapter *adap,
1083 struct i2c_board_info *info,
1084 unsigned short const *addr_list)
1085{
1086 int i;
1087
1088 /* Stop here if the bus doesn't support probing */
1089 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1090 dev_err(&adap->dev, "Probing not supported\n");
1091 return NULL;
1092 }
1093
1094 mutex_lock(&adap->clist_lock);
1095 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1096 /* Check address validity */
1097 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1098 dev_warn(&adap->dev, "Invalid 7-bit address "
1099 "0x%02x\n", addr_list[i]);
1100 continue;
1101 }
1102
1103 /* Check address availability */
David Brownell9b766b82008-01-27 18:14:51 +01001104 if (i2c_check_addr(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001105 dev_dbg(&adap->dev, "Address 0x%02x already in "
1106 "use, not probing\n", addr_list[i]);
1107 continue;
1108 }
1109
1110 /* Test address responsiveness
1111 The default probe method is a quick write, but it is known
1112 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1113 and could also irreversibly write-protect some EEPROMs, so
1114 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1115 read instead. Also, some bus drivers don't implement
1116 quick write, so we fallback to a byte read it that case
1117 too. */
1118 if ((addr_list[i] & ~0x07) == 0x30
1119 || (addr_list[i] & ~0x0f) == 0x50
1120 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1121 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1122 I2C_SMBUS_READ, 0,
1123 I2C_SMBUS_BYTE, NULL) >= 0)
1124 break;
1125 } else {
1126 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1127 I2C_SMBUS_WRITE, 0,
1128 I2C_SMBUS_QUICK, NULL) >= 0)
1129 break;
1130 }
1131 }
1132 mutex_unlock(&adap->clist_lock);
1133
1134 if (addr_list[i] == I2C_CLIENT_END) {
1135 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1136 return NULL;
1137 }
1138
1139 info->addr = addr_list[i];
1140 return i2c_new_device(adap, info);
1141}
1142EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144struct i2c_adapter* i2c_get_adapter(int id)
1145{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001147
Jean Delvarecaada322008-01-27 18:14:49 +01001148 mutex_lock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001149 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1150 if (adapter && !try_module_get(adapter->owner))
1151 adapter = NULL;
1152
Jean Delvarecaada322008-01-27 18:14:49 +01001153 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001154 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155}
David Brownellc0564602007-05-01 23:26:31 +02001156EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
1158void i2c_put_adapter(struct i2c_adapter *adap)
1159{
1160 module_put(adap->owner);
1161}
David Brownellc0564602007-05-01 23:26:31 +02001162EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163
1164/* The SMBus parts */
1165
David Brownell438d6c22006-12-10 21:21:31 +01001166#define POLY (0x1070U << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167static u8
1168crc8(u16 data)
1169{
1170 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001171
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 for(i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001173 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 data = data ^ POLY;
1175 data = data << 1;
1176 }
1177 return (u8)(data >> 8);
1178}
1179
Jean Delvare421ef472005-10-26 21:28:55 +02001180/* Incremental CRC8 over count bytes in the array pointed to by p */
1181static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182{
1183 int i;
1184
1185 for(i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001186 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 return crc;
1188}
1189
Jean Delvare421ef472005-10-26 21:28:55 +02001190/* Assume a 7-bit address, which is reasonable for SMBus */
1191static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192{
Jean Delvare421ef472005-10-26 21:28:55 +02001193 /* The address will be sent first */
1194 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1195 pec = i2c_smbus_pec(pec, &addr, 1);
1196
1197 /* The data buffer follows */
1198 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199}
1200
Jean Delvare421ef472005-10-26 21:28:55 +02001201/* Used for write only transactions */
1202static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203{
Jean Delvare421ef472005-10-26 21:28:55 +02001204 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1205 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206}
1207
Jean Delvare421ef472005-10-26 21:28:55 +02001208/* Return <0 on CRC error
1209 If there was a write before this read (most cases) we need to take the
1210 partial CRC from the write part into account.
1211 Note that this function does modify the message (we need to decrease the
1212 message length to hide the CRC byte from the caller). */
1213static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214{
Jean Delvare421ef472005-10-26 21:28:55 +02001215 u8 rpec = msg->buf[--msg->len];
1216 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 if (rpec != cpec) {
1219 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1220 rpec, cpec);
1221 return -1;
1222 }
David Brownell438d6c22006-12-10 21:21:31 +01001223 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224}
1225
1226s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
1227{
1228 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
David Brownell438d6c22006-12-10 21:21:31 +01001229 value,0,I2C_SMBUS_QUICK,NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230}
David Brownellc0564602007-05-01 23:26:31 +02001231EXPORT_SYMBOL(i2c_smbus_write_quick);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232
1233s32 i2c_smbus_read_byte(struct i2c_client *client)
1234{
1235 union i2c_smbus_data data;
1236 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1237 I2C_SMBUS_READ,0,I2C_SMBUS_BYTE, &data))
1238 return -1;
1239 else
Jean Delvare7eff82c2006-09-03 22:24:00 +02001240 return data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241}
David Brownellc0564602007-05-01 23:26:31 +02001242EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243
1244s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1245{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001247 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248}
David Brownellc0564602007-05-01 23:26:31 +02001249EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250
1251s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1252{
1253 union i2c_smbus_data data;
1254 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1255 I2C_SMBUS_READ,command, I2C_SMBUS_BYTE_DATA,&data))
1256 return -1;
1257 else
Jean Delvare7eff82c2006-09-03 22:24:00 +02001258 return data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259}
David Brownellc0564602007-05-01 23:26:31 +02001260EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
1262s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1263{
1264 union i2c_smbus_data data;
1265 data.byte = value;
1266 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1267 I2C_SMBUS_WRITE,command,
1268 I2C_SMBUS_BYTE_DATA,&data);
1269}
David Brownellc0564602007-05-01 23:26:31 +02001270EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
1272s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1273{
1274 union i2c_smbus_data data;
1275 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1276 I2C_SMBUS_READ,command, I2C_SMBUS_WORD_DATA, &data))
1277 return -1;
1278 else
Jean Delvare7eff82c2006-09-03 22:24:00 +02001279 return data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280}
David Brownellc0564602007-05-01 23:26:31 +02001281EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
1283s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1284{
1285 union i2c_smbus_data data;
1286 data.word = value;
1287 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1288 I2C_SMBUS_WRITE,command,
1289 I2C_SMBUS_WORD_DATA,&data);
1290}
David Brownellc0564602007-05-01 23:26:31 +02001291EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
David Brownella64ec072007-10-13 23:56:31 +02001293/**
1294 * i2c_smbus_read_block_data - SMBus block read request
1295 * @client: Handle to slave device
1296 * @command: Command byte issued to let the slave know what data should
1297 * be returned
1298 * @values: Byte array into which data will be read; big enough to hold
1299 * the data returned by the slave. SMBus allows at most 32 bytes.
1300 *
1301 * Returns the number of bytes read in the slave's response, else a
1302 * negative number to indicate some kind of error.
1303 *
1304 * Note that using this function requires that the client's adapter support
1305 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1306 * support this; its emulation through I2C messaging relies on a specific
1307 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1308 */
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001309s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1310 u8 *values)
1311{
1312 union i2c_smbus_data data;
1313
1314 if (i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1315 I2C_SMBUS_READ, command,
1316 I2C_SMBUS_BLOCK_DATA, &data))
1317 return -1;
1318
1319 memcpy(values, &data.block[1], data.block[0]);
1320 return data.block[0];
1321}
1322EXPORT_SYMBOL(i2c_smbus_read_block_data);
1323
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001325 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326{
1327 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001328
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 if (length > I2C_SMBUS_BLOCK_MAX)
1330 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01001332 memcpy(&data.block[1], values, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1334 I2C_SMBUS_WRITE,command,
1335 I2C_SMBUS_BLOCK_DATA,&data);
1336}
David Brownellc0564602007-05-01 23:26:31 +02001337EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
1339/* Returns the number of read bytes */
Jean Delvare4b2643d2007-07-12 14:12:29 +02001340s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1341 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342{
1343 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001344
Jean Delvare4b2643d2007-07-12 14:12:29 +02001345 if (length > I2C_SMBUS_BLOCK_MAX)
1346 length = I2C_SMBUS_BLOCK_MAX;
1347 data.block[0] = length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1349 I2C_SMBUS_READ,command,
1350 I2C_SMBUS_I2C_BLOCK_DATA,&data))
1351 return -1;
Jean Delvare76560322006-01-18 23:14:55 +01001352
1353 memcpy(values, &data.block[1], data.block[0]);
1354 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355}
David Brownellc0564602007-05-01 23:26:31 +02001356EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357
Jean Delvare21bbd692006-01-09 15:19:18 +11001358s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001359 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11001360{
1361 union i2c_smbus_data data;
1362
1363 if (length > I2C_SMBUS_BLOCK_MAX)
1364 length = I2C_SMBUS_BLOCK_MAX;
1365 data.block[0] = length;
1366 memcpy(data.block + 1, values, length);
1367 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1368 I2C_SMBUS_WRITE, command,
1369 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1370}
David Brownellc0564602007-05-01 23:26:31 +02001371EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11001372
David Brownell438d6c22006-12-10 21:21:31 +01001373/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 No checking of parameters is done! */
David Brownell438d6c22006-12-10 21:21:31 +01001375static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001377 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 union i2c_smbus_data * data)
1379{
1380 /* So we need to generate a series of msgs. In the case of writing, we
1381 need to use only one message; when reading, we need two. We initialize
1382 most things with sane defaults, to keep the code below somewhat
1383 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001384 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1385 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 int num = read_write == I2C_SMBUS_READ?2:1;
David Brownell438d6c22006-12-10 21:21:31 +01001387 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1389 };
1390 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02001391 u8 partial_pec = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
1393 msgbuf0[0] = command;
1394 switch(size) {
1395 case I2C_SMBUS_QUICK:
1396 msg[0].len = 0;
1397 /* Special case: The read/write field is used as data */
1398 msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
1399 num = 1;
1400 break;
1401 case I2C_SMBUS_BYTE:
1402 if (read_write == I2C_SMBUS_READ) {
1403 /* Special case: only a read! */
1404 msg[0].flags = I2C_M_RD | flags;
1405 num = 1;
1406 }
1407 break;
1408 case I2C_SMBUS_BYTE_DATA:
1409 if (read_write == I2C_SMBUS_READ)
1410 msg[1].len = 1;
1411 else {
1412 msg[0].len = 2;
1413 msgbuf0[1] = data->byte;
1414 }
1415 break;
1416 case I2C_SMBUS_WORD_DATA:
1417 if (read_write == I2C_SMBUS_READ)
1418 msg[1].len = 2;
1419 else {
1420 msg[0].len=3;
1421 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001422 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 }
1424 break;
1425 case I2C_SMBUS_PROC_CALL:
1426 num = 2; /* Special case */
1427 read_write = I2C_SMBUS_READ;
1428 msg[0].len = 3;
1429 msg[1].len = 2;
1430 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001431 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 break;
1433 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02001435 msg[1].flags |= I2C_M_RECV_LEN;
1436 msg[1].len = 1; /* block length will be added by
1437 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 } else {
1439 msg[0].len = data->block[0] + 2;
1440 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
1441 dev_err(&adapter->dev, "smbus_access called with "
1442 "invalid block write size (%d)\n",
1443 data->block[0]);
1444 return -1;
1445 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001446 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 msgbuf0[i] = data->block[i-1];
1448 }
1449 break;
1450 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02001451 num = 2; /* Another special case */
1452 read_write = I2C_SMBUS_READ;
1453 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
1454 dev_err(&adapter->dev, "%s called with invalid "
1455 "block proc call size (%d)\n", __FUNCTION__,
1456 data->block[0]);
1457 return -1;
1458 }
1459 msg[0].len = data->block[0] + 2;
1460 for (i = 1; i < msg[0].len; i++)
1461 msgbuf0[i] = data->block[i-1];
1462 msg[1].flags |= I2C_M_RECV_LEN;
1463 msg[1].len = 1; /* block length will be added by
1464 the underlying bus driver */
1465 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 case I2C_SMBUS_I2C_BLOCK_DATA:
1467 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02001468 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 } else {
1470 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02001471 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 dev_err(&adapter->dev, "i2c_smbus_xfer_emulated called with "
1473 "invalid block write size (%d)\n",
1474 data->block[0]);
1475 return -1;
1476 }
1477 for (i = 1; i <= data->block[0]; i++)
1478 msgbuf0[i] = data->block[i];
1479 }
1480 break;
1481 default:
1482 dev_err(&adapter->dev, "smbus_access called with invalid size (%d)\n",
1483 size);
1484 return -1;
1485 }
1486
Jean Delvare421ef472005-10-26 21:28:55 +02001487 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1488 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1489 if (i) {
1490 /* Compute PEC if first message is a write */
1491 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01001492 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02001493 i2c_smbus_add_pec(&msg[0]);
1494 else /* Write followed by read */
1495 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1496 }
1497 /* Ask for PEC if last message is a read */
1498 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01001499 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02001500 }
1501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 if (i2c_transfer(adapter, msg, num) < 0)
1503 return -1;
1504
Jean Delvare421ef472005-10-26 21:28:55 +02001505 /* Check PEC if last message is a read */
1506 if (i && (msg[num-1].flags & I2C_M_RD)) {
1507 if (i2c_smbus_check_pec(partial_pec, &msg[num-1]) < 0)
1508 return -1;
1509 }
1510
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 if (read_write == I2C_SMBUS_READ)
1512 switch(size) {
1513 case I2C_SMBUS_BYTE:
1514 data->byte = msgbuf0[0];
1515 break;
1516 case I2C_SMBUS_BYTE_DATA:
1517 data->byte = msgbuf1[0];
1518 break;
David Brownell438d6c22006-12-10 21:21:31 +01001519 case I2C_SMBUS_WORD_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 case I2C_SMBUS_PROC_CALL:
1521 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1522 break;
1523 case I2C_SMBUS_I2C_BLOCK_DATA:
Jean Delvare4b2643d2007-07-12 14:12:29 +02001524 for (i = 0; i < data->block[0]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 data->block[i+1] = msgbuf1[i];
1526 break;
Jean Delvare209d27c2007-05-01 23:26:29 +02001527 case I2C_SMBUS_BLOCK_DATA:
1528 case I2C_SMBUS_BLOCK_PROC_CALL:
1529 for (i = 0; i < msgbuf1[0] + 1; i++)
1530 data->block[i] = msgbuf1[i];
1531 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532 }
1533 return 0;
1534}
1535
1536
1537s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001538 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 union i2c_smbus_data * data)
1540{
1541 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
1543 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544
1545 if (adapter->algo->smbus_xfer) {
Ingo Molnar5c085d32006-01-18 23:16:04 +01001546 mutex_lock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
1548 command,size,data);
Ingo Molnar5c085d32006-01-18 23:16:04 +01001549 mutex_unlock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 } else
1551 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
1552 command,size,data);
1553
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 return res;
1555}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
1558MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1559MODULE_DESCRIPTION("I2C-Bus main module");
1560MODULE_LICENSE("GPL");