i2c: Kerneldoc for most I/O calls
[deliverable/linux.git] / drivers / i2c / i2c-core.c
CommitLineData
1da177e4
LT
1/* 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
96de0e25 20/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
1da177e4 21 All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
421ef47b
JD
22 SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
23 Jean Delvare <khali@linux-fr.org> */
1da177e4 24
1da177e4
LT
25#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>
d052d1be 32#include <linux/platform_device.h>
b3585e4f 33#include <linux/mutex.h>
b8d6f45b 34#include <linux/completion.h>
cea443a8
MR
35#include <linux/hardirq.h>
36#include <linux/irqflags.h>
1da177e4
LT
37#include <asm/uaccess.h>
38
9c1600ed
DB
39#include "i2c-core.h"
40
1da177e4 41
caada32a 42static DEFINE_MUTEX(core_lock);
1da177e4
LT
43static DEFINE_IDR(i2c_adapter_idr);
44
a1d9e6e4 45#define is_newstyle_driver(d) ((d)->probe || (d)->remove)
f37dd80a
DB
46
47/* ------------------------------------------------------------------------- */
48
d2653e92
JD
49static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
50 const struct i2c_client *client)
51{
52 while (id->name[0]) {
53 if (strcmp(client->name, id->name) == 0)
54 return id;
55 id++;
56 }
57 return NULL;
58}
59
1da177e4
LT
60static int i2c_device_match(struct device *dev, struct device_driver *drv)
61{
7b4fbc50
DB
62 struct i2c_client *client = to_i2c_client(dev);
63 struct i2c_driver *driver = to_i2c_driver(drv);
64
65 /* make legacy i2c drivers bypass driver model probing entirely;
66 * such drivers scan each i2c adapter/bus themselves.
67 */
a1d9e6e4 68 if (!is_newstyle_driver(driver))
7b4fbc50
DB
69 return 0;
70
d2653e92
JD
71 /* match on an id table if there is one */
72 if (driver->id_table)
73 return i2c_match_id(driver->id_table, client) != NULL;
74
eb8a7908 75 return 0;
1da177e4
LT
76}
77
7b4fbc50
DB
78#ifdef CONFIG_HOTPLUG
79
80/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
7eff2e7a 81static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
7b4fbc50
DB
82{
83 struct i2c_client *client = to_i2c_client(dev);
7b4fbc50
DB
84
85 /* by definition, legacy drivers can't hotplug */
d2653e92 86 if (dev->driver)
7b4fbc50
DB
87 return 0;
88
eb8a7908
JD
89 if (add_uevent_var(env, "MODALIAS=%s%s",
90 I2C_MODULE_PREFIX, client->name))
91 return -ENOMEM;
7b4fbc50
DB
92 dev_dbg(dev, "uevent\n");
93 return 0;
94}
95
96#else
97#define i2c_device_uevent NULL
98#endif /* CONFIG_HOTPLUG */
99
f37dd80a 100static int i2c_device_probe(struct device *dev)
1da177e4 101{
7b4fbc50
DB
102 struct i2c_client *client = to_i2c_client(dev);
103 struct i2c_driver *driver = to_i2c_driver(dev->driver);
d2653e92 104 const struct i2c_device_id *id;
50c3304a 105 int status;
7b4fbc50
DB
106
107 if (!driver->probe)
108 return -ENODEV;
109 client->driver = driver;
110 dev_dbg(dev, "probe\n");
d2653e92
JD
111
112 if (driver->id_table)
113 id = i2c_match_id(driver->id_table, client);
114 else
115 id = NULL;
116 status = driver->probe(client, id);
50c3304a
HV
117 if (status)
118 client->driver = NULL;
119 return status;
f37dd80a 120}
1da177e4 121
f37dd80a
DB
122static int i2c_device_remove(struct device *dev)
123{
a1d9e6e4
DB
124 struct i2c_client *client = to_i2c_client(dev);
125 struct i2c_driver *driver;
126 int status;
127
128 if (!dev->driver)
129 return 0;
130
131 driver = to_i2c_driver(dev->driver);
132 if (driver->remove) {
133 dev_dbg(dev, "remove\n");
134 status = driver->remove(client);
135 } else {
136 dev->driver = NULL;
137 status = 0;
138 }
139 if (status == 0)
140 client->driver = NULL;
141 return status;
1da177e4
LT
142}
143
f37dd80a 144static void i2c_device_shutdown(struct device *dev)
1da177e4 145{
f37dd80a
DB
146 struct i2c_driver *driver;
147
148 if (!dev->driver)
149 return;
150 driver = to_i2c_driver(dev->driver);
151 if (driver->shutdown)
152 driver->shutdown(to_i2c_client(dev));
1da177e4
LT
153}
154
f37dd80a 155static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
1da177e4 156{
f37dd80a
DB
157 struct i2c_driver *driver;
158
159 if (!dev->driver)
160 return 0;
161 driver = to_i2c_driver(dev->driver);
162 if (!driver->suspend)
163 return 0;
164 return driver->suspend(to_i2c_client(dev), mesg);
1da177e4
LT
165}
166
f37dd80a 167static int i2c_device_resume(struct device * dev)
1da177e4 168{
f37dd80a
DB
169 struct i2c_driver *driver;
170
171 if (!dev->driver)
172 return 0;
173 driver = to_i2c_driver(dev->driver);
174 if (!driver->resume)
175 return 0;
176 return driver->resume(to_i2c_client(dev));
1da177e4
LT
177}
178
7b4fbc50
DB
179static void i2c_client_release(struct device *dev)
180{
181 struct i2c_client *client = to_i2c_client(dev);
182 complete(&client->released);
183}
184
9c1600ed
DB
185static void i2c_client_dev_release(struct device *dev)
186{
187 kfree(to_i2c_client(dev));
188}
189
7b4fbc50
DB
190static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
191{
192 struct i2c_client *client = to_i2c_client(dev);
193 return sprintf(buf, "%s\n", client->name);
194}
195
196static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
197{
198 struct i2c_client *client = to_i2c_client(dev);
eb8a7908 199 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
7b4fbc50
DB
200}
201
202static struct device_attribute i2c_dev_attrs[] = {
203 __ATTR(name, S_IRUGO, show_client_name, NULL),
204 /* modalias helps coldplug: modprobe $(cat .../modalias) */
205 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
206 { },
207};
208
83eaaed0 209static struct bus_type i2c_bus_type = {
f37dd80a 210 .name = "i2c",
7b4fbc50 211 .dev_attrs = i2c_dev_attrs,
f37dd80a 212 .match = i2c_device_match,
7b4fbc50 213 .uevent = i2c_device_uevent,
f37dd80a
DB
214 .probe = i2c_device_probe,
215 .remove = i2c_device_remove,
216 .shutdown = i2c_device_shutdown,
217 .suspend = i2c_device_suspend,
218 .resume = i2c_device_resume,
b864c7d5
RK
219};
220
9b766b81
DB
221
222/**
223 * i2c_verify_client - return parameter as i2c_client, or NULL
224 * @dev: device, probably from some driver model iterator
225 *
226 * When traversing the driver model tree, perhaps using driver model
227 * iterators like @device_for_each_child(), you can't assume very much
228 * about the nodes you find. Use this function to avoid oopses caused
229 * by wrongly treating some non-I2C device as an i2c_client.
230 */
231struct i2c_client *i2c_verify_client(struct device *dev)
232{
233 return (dev->bus == &i2c_bus_type)
234 ? to_i2c_client(dev)
235 : NULL;
236}
237EXPORT_SYMBOL(i2c_verify_client);
238
239
9c1600ed
DB
240/**
241 * i2c_new_device - instantiate an i2c device for use with a new style driver
242 * @adap: the adapter managing the device
243 * @info: describes one I2C device; bus_num is ignored
d64f73be 244 * Context: can sleep
9c1600ed
DB
245 *
246 * Create a device to work with a new style i2c driver, where binding is
247 * handled through driver model probe()/remove() methods. This call is not
248 * appropriate for use by mainboad initialization logic, which usually runs
249 * during an arch_initcall() long before any i2c_adapter could exist.
250 *
251 * This returns the new i2c client, which may be saved for later use with
252 * i2c_unregister_device(); or NULL to indicate an error.
253 */
254struct i2c_client *
255i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
256{
257 struct i2c_client *client;
258 int status;
259
260 client = kzalloc(sizeof *client, GFP_KERNEL);
261 if (!client)
262 return NULL;
263
264 client->adapter = adap;
265
266 client->dev.platform_data = info->platform_data;
3bbb835d
DB
267 device_init_wakeup(&client->dev, info->flags & I2C_CLIENT_WAKE);
268
269 client->flags = info->flags & ~I2C_CLIENT_WAKE;
9c1600ed
DB
270 client->addr = info->addr;
271 client->irq = info->irq;
272
9c1600ed
DB
273 strlcpy(client->name, info->type, sizeof(client->name));
274
275 /* a new style driver may be bound to this device when we
276 * return from this function, or any later moment (e.g. maybe
277 * hotplugging will load the driver module). and the device
278 * refcount model is the standard driver model one.
279 */
280 status = i2c_attach_client(client);
281 if (status < 0) {
282 kfree(client);
283 client = NULL;
284 }
285 return client;
286}
287EXPORT_SYMBOL_GPL(i2c_new_device);
288
289
290/**
291 * i2c_unregister_device - reverse effect of i2c_new_device()
292 * @client: value returned from i2c_new_device()
d64f73be 293 * Context: can sleep
9c1600ed
DB
294 */
295void i2c_unregister_device(struct i2c_client *client)
a1d9e6e4
DB
296{
297 struct i2c_adapter *adapter = client->adapter;
298 struct i2c_driver *driver = client->driver;
299
300 if (driver && !is_newstyle_driver(driver)) {
301 dev_err(&client->dev, "can't unregister devices "
302 "with legacy drivers\n");
303 WARN_ON(1);
304 return;
305 }
306
307 mutex_lock(&adapter->clist_lock);
308 list_del(&client->list);
309 mutex_unlock(&adapter->clist_lock);
310
311 device_unregister(&client->dev);
312}
9c1600ed 313EXPORT_SYMBOL_GPL(i2c_unregister_device);
a1d9e6e4
DB
314
315
60b129d7
JD
316static const struct i2c_device_id dummy_id[] = {
317 { "dummy", 0 },
318 { },
319};
320
d2653e92
JD
321static int dummy_probe(struct i2c_client *client,
322 const struct i2c_device_id *id)
323{
324 return 0;
325}
326
327static int dummy_remove(struct i2c_client *client)
e9f1373b
DB
328{
329 return 0;
330}
331
332static struct i2c_driver dummy_driver = {
333 .driver.name = "dummy",
d2653e92
JD
334 .probe = dummy_probe,
335 .remove = dummy_remove,
60b129d7 336 .id_table = dummy_id,
e9f1373b
DB
337};
338
339/**
340 * i2c_new_dummy - return a new i2c device bound to a dummy driver
341 * @adapter: the adapter managing the device
342 * @address: seven bit address to be used
e9f1373b
DB
343 * Context: can sleep
344 *
345 * This returns an I2C client bound to the "dummy" driver, intended for use
346 * with devices that consume multiple addresses. Examples of such chips
347 * include various EEPROMS (like 24c04 and 24c08 models).
348 *
349 * These dummy devices have two main uses. First, most I2C and SMBus calls
350 * except i2c_transfer() need a client handle; the dummy will be that handle.
351 * And second, this prevents the specified address from being bound to a
352 * different driver.
353 *
354 * This returns the new i2c client, which should be saved for later use with
355 * i2c_unregister_device(); or NULL to indicate an error.
356 */
357struct i2c_client *
60b129d7 358i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
e9f1373b
DB
359{
360 struct i2c_board_info info = {
60b129d7 361 I2C_BOARD_INFO("dummy", address),
e9f1373b
DB
362 };
363
e9f1373b
DB
364 return i2c_new_device(adapter, &info);
365}
366EXPORT_SYMBOL_GPL(i2c_new_dummy);
367
f37dd80a
DB
368/* ------------------------------------------------------------------------- */
369
16ffadfc
DB
370/* I2C bus adapters -- one roots each I2C or SMBUS segment */
371
83eaaed0 372static void i2c_adapter_dev_release(struct device *dev)
1da177e4 373{
ef2c8321 374 struct i2c_adapter *adap = to_i2c_adapter(dev);
1da177e4
LT
375 complete(&adap->dev_released);
376}
377
16ffadfc
DB
378static ssize_t
379show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
380{
ef2c8321 381 struct i2c_adapter *adap = to_i2c_adapter(dev);
16ffadfc
DB
382 return sprintf(buf, "%s\n", adap->name);
383}
b119dc3f 384
16ffadfc
DB
385static struct device_attribute i2c_adapter_attrs[] = {
386 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
387 { },
388};
b119dc3f 389
83eaaed0 390static struct class i2c_adapter_class = {
b119dc3f
DB
391 .owner = THIS_MODULE,
392 .name = "i2c-adapter",
16ffadfc 393 .dev_attrs = i2c_adapter_attrs,
1da177e4
LT
394};
395
9c1600ed
DB
396static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
397{
398 struct i2c_devinfo *devinfo;
399
400 mutex_lock(&__i2c_board_lock);
401 list_for_each_entry(devinfo, &__i2c_board_list, list) {
402 if (devinfo->busnum == adapter->nr
403 && !i2c_new_device(adapter,
404 &devinfo->board_info))
405 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
406 i2c_adapter_id(adapter),
407 devinfo->board_info.addr);
408 }
409 mutex_unlock(&__i2c_board_lock);
410}
411
026526f5
JD
412static int i2c_do_add_adapter(struct device_driver *d, void *data)
413{
414 struct i2c_driver *driver = to_i2c_driver(d);
415 struct i2c_adapter *adap = data;
416
417 if (driver->attach_adapter) {
418 /* We ignore the return code; if it fails, too bad */
419 driver->attach_adapter(adap);
420 }
421 return 0;
422}
423
6e13e641 424static int i2c_register_adapter(struct i2c_adapter *adap)
1da177e4 425{
026526f5 426 int res = 0, dummy;
1da177e4 427
5c085d36
IM
428 mutex_init(&adap->bus_lock);
429 mutex_init(&adap->clist_lock);
1da177e4
LT
430 INIT_LIST_HEAD(&adap->clients);
431
caada32a 432 mutex_lock(&core_lock);
6e13e641 433
1da177e4
LT
434 /* Add the adapter to the driver core.
435 * If the parent pointer is not set up,
436 * we add this adapter to the host bus.
437 */
b119dc3f 438 if (adap->dev.parent == NULL) {
1da177e4 439 adap->dev.parent = &platform_bus;
fe2c8d51
JD
440 pr_debug("I2C adapter driver [%s] forgot to specify "
441 "physical device\n", adap->name);
b119dc3f 442 }
1da177e4 443 sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
1da177e4 444 adap->dev.release = &i2c_adapter_dev_release;
fccb56e4 445 adap->dev.class = &i2c_adapter_class;
b119c6c9
JD
446 res = device_register(&adap->dev);
447 if (res)
448 goto out_list;
1da177e4 449
b6d7b3d1
JD
450 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
451
6e13e641
DB
452 /* create pre-declared device nodes for new-style drivers */
453 if (adap->nr < __i2c_first_dynamic_bus_num)
454 i2c_scan_static_board_info(adap);
455
7b4fbc50 456 /* let legacy drivers scan this bus for matching devices */
026526f5
JD
457 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
458 i2c_do_add_adapter);
1da177e4 459
1da177e4 460out_unlock:
caada32a 461 mutex_unlock(&core_lock);
1da177e4 462 return res;
b119c6c9 463
b119c6c9 464out_list:
b119c6c9
JD
465 idr_remove(&i2c_adapter_idr, adap->nr);
466 goto out_unlock;
1da177e4
LT
467}
468
6e13e641
DB
469/**
470 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
471 * @adapter: the adapter to add
d64f73be 472 * Context: can sleep
6e13e641
DB
473 *
474 * This routine is used to declare an I2C adapter when its bus number
475 * doesn't matter. Examples: for I2C adapters dynamically added by
476 * USB links or PCI plugin cards.
477 *
478 * When this returns zero, a new bus number was allocated and stored
479 * in adap->nr, and the specified adapter became available for clients.
480 * Otherwise, a negative errno value is returned.
481 */
482int i2c_add_adapter(struct i2c_adapter *adapter)
483{
484 int id, res = 0;
485
486retry:
487 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
488 return -ENOMEM;
489
caada32a 490 mutex_lock(&core_lock);
6e13e641
DB
491 /* "above" here means "above or equal to", sigh */
492 res = idr_get_new_above(&i2c_adapter_idr, adapter,
493 __i2c_first_dynamic_bus_num, &id);
caada32a 494 mutex_unlock(&core_lock);
6e13e641
DB
495
496 if (res < 0) {
497 if (res == -EAGAIN)
498 goto retry;
499 return res;
500 }
501
502 adapter->nr = id;
503 return i2c_register_adapter(adapter);
504}
505EXPORT_SYMBOL(i2c_add_adapter);
506
507/**
508 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
509 * @adap: the adapter to register (with adap->nr initialized)
d64f73be 510 * Context: can sleep
6e13e641
DB
511 *
512 * This routine is used to declare an I2C adapter when its bus number
8c07e46f
RD
513 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
514 * or otherwise built in to the system's mainboard, and where i2c_board_info
6e13e641
DB
515 * is used to properly configure I2C devices.
516 *
517 * If no devices have pre-been declared for this bus, then be sure to
518 * register the adapter before any dynamically allocated ones. Otherwise
519 * the required bus ID may not be available.
520 *
521 * When this returns zero, the specified adapter became available for
522 * clients using the bus number provided in adap->nr. Also, the table
523 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
524 * and the appropriate driver model device nodes are created. Otherwise, a
525 * negative errno value is returned.
526 */
527int i2c_add_numbered_adapter(struct i2c_adapter *adap)
528{
529 int id;
530 int status;
531
532 if (adap->nr & ~MAX_ID_MASK)
533 return -EINVAL;
534
535retry:
536 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
537 return -ENOMEM;
538
caada32a 539 mutex_lock(&core_lock);
6e13e641
DB
540 /* "above" here means "above or equal to", sigh;
541 * we need the "equal to" result to force the result
542 */
543 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
544 if (status == 0 && id != adap->nr) {
545 status = -EBUSY;
546 idr_remove(&i2c_adapter_idr, id);
547 }
caada32a 548 mutex_unlock(&core_lock);
6e13e641
DB
549 if (status == -EAGAIN)
550 goto retry;
551
552 if (status == 0)
553 status = i2c_register_adapter(adap);
554 return status;
555}
556EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
557
026526f5
JD
558static int i2c_do_del_adapter(struct device_driver *d, void *data)
559{
560 struct i2c_driver *driver = to_i2c_driver(d);
561 struct i2c_adapter *adapter = data;
562 int res;
563
564 if (!driver->detach_adapter)
565 return 0;
566 res = driver->detach_adapter(adapter);
567 if (res)
568 dev_err(&adapter->dev, "detach_adapter failed (%d) "
569 "for driver [%s]\n", res, driver->driver.name);
570 return res;
571}
572
d64f73be
DB
573/**
574 * i2c_del_adapter - unregister I2C adapter
575 * @adap: the adapter being unregistered
576 * Context: can sleep
577 *
578 * This unregisters an I2C adapter which was previously registered
579 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
580 */
1da177e4
LT
581int i2c_del_adapter(struct i2c_adapter *adap)
582{
583 struct list_head *item, *_n;
1da177e4
LT
584 struct i2c_client *client;
585 int res = 0;
586
caada32a 587 mutex_lock(&core_lock);
1da177e4
LT
588
589 /* First make sure that this adapter was ever added */
87c6c229 590 if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
b6d7b3d1
JD
591 pr_debug("i2c-core: attempting to delete unregistered "
592 "adapter [%s]\n", adap->name);
1da177e4
LT
593 res = -EINVAL;
594 goto out_unlock;
595 }
596
026526f5
JD
597 /* Tell drivers about this removal */
598 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
599 i2c_do_del_adapter);
600 if (res)
601 goto out_unlock;
1da177e4
LT
602
603 /* detach any active clients. This must be done first, because
a551acc2 604 * it can fail; in which case we give up. */
1da177e4 605 list_for_each_safe(item, _n, &adap->clients) {
a1d9e6e4
DB
606 struct i2c_driver *driver;
607
1da177e4 608 client = list_entry(item, struct i2c_client, list);
a1d9e6e4
DB
609 driver = client->driver;
610
611 /* new style, follow standard driver model */
612 if (!driver || is_newstyle_driver(driver)) {
613 i2c_unregister_device(client);
614 continue;
615 }
1da177e4 616
a1d9e6e4
DB
617 /* legacy drivers create and remove clients themselves */
618 if ((res = driver->detach_client(client))) {
b6d7b3d1
JD
619 dev_err(&adap->dev, "detach_client failed for client "
620 "[%s] at address 0x%02x\n", client->name,
1da177e4
LT
621 client->addr);
622 goto out_unlock;
623 }
624 }
625
626 /* clean up the sysfs representation */
627 init_completion(&adap->dev_released);
1da177e4 628 device_unregister(&adap->dev);
1da177e4
LT
629
630 /* wait for sysfs to drop all references */
631 wait_for_completion(&adap->dev_released);
1da177e4 632
6e13e641 633 /* free bus id */
1da177e4
LT
634 idr_remove(&i2c_adapter_idr, adap->nr);
635
b6d7b3d1 636 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
1da177e4
LT
637
638 out_unlock:
caada32a 639 mutex_unlock(&core_lock);
1da177e4
LT
640 return res;
641}
c0564606 642EXPORT_SYMBOL(i2c_del_adapter);
1da177e4
LT
643
644
7b4fbc50
DB
645/* ------------------------------------------------------------------------- */
646
7f101a97
DY
647static int __attach_adapter(struct device *dev, void *data)
648{
649 struct i2c_adapter *adapter = to_i2c_adapter(dev);
650 struct i2c_driver *driver = data;
651
652 driver->attach_adapter(adapter);
653
654 return 0;
655}
656
7b4fbc50
DB
657/*
658 * An i2c_driver is used with one or more i2c_client (device) nodes to access
659 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
660 * are two models for binding the driver to its device: "new style" drivers
661 * follow the standard Linux driver model and just respond to probe() calls
662 * issued if the driver core sees they match(); "legacy" drivers create device
663 * nodes themselves.
1da177e4
LT
664 */
665
de59cf9e 666int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
1da177e4 667{
7eebcb7c 668 int res;
1da177e4 669
7b4fbc50 670 /* new style driver methods can't mix with legacy ones */
a1d9e6e4 671 if (is_newstyle_driver(driver)) {
7b4fbc50
DB
672 if (driver->attach_adapter || driver->detach_adapter
673 || driver->detach_client) {
674 printk(KERN_WARNING
675 "i2c-core: driver [%s] is confused\n",
676 driver->driver.name);
677 return -EINVAL;
678 }
679 }
680
1da177e4 681 /* add the driver to the list of i2c drivers in the driver core */
de59cf9e 682 driver->driver.owner = owner;
1da177e4 683 driver->driver.bus = &i2c_bus_type;
1da177e4 684
6e13e641
DB
685 /* for new style drivers, when registration returns the driver core
686 * will have called probe() for all matching-but-unbound devices.
687 */
1da177e4
LT
688 res = driver_register(&driver->driver);
689 if (res)
7eebcb7c 690 return res;
438d6c2c 691
caada32a 692 mutex_lock(&core_lock);
7eebcb7c 693
35d8b2e6 694 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
1da177e4 695
7b4fbc50 696 /* legacy drivers scan i2c busses directly */
7f101a97
DY
697 if (driver->attach_adapter)
698 class_for_each_device(&i2c_adapter_class, driver,
699 __attach_adapter);
4ad4eac6 700
7f101a97
DY
701 mutex_unlock(&core_lock);
702 return 0;
703}
704EXPORT_SYMBOL(i2c_register_driver);
705
706static int __detach_adapter(struct device *dev, void *data)
707{
708 struct i2c_adapter *adapter = to_i2c_adapter(dev);
709 struct i2c_driver *driver = data;
710
711 /* Have a look at each adapter, if clients of this driver are still
712 * attached. If so, detach them to be able to kill the driver
713 * afterwards.
714 */
715 if (driver->detach_adapter) {
716 if (driver->detach_adapter(adapter))
717 dev_err(&adapter->dev,
718 "detach_adapter failed for driver [%s]\n",
719 driver->driver.name);
720 } else {
721 struct list_head *item, *_n;
722 struct i2c_client *client;
723
724 list_for_each_safe(item, _n, &adapter->clients) {
725 client = list_entry(item, struct i2c_client, list);
726 if (client->driver != driver)
727 continue;
728 dev_dbg(&adapter->dev,
729 "detaching client [%s] at 0x%02x\n",
730 client->name, client->addr);
731 if (driver->detach_client(client))
732 dev_err(&adapter->dev, "detach_client "
733 "failed for client [%s] at 0x%02x\n",
734 client->name, client->addr);
1da177e4
LT
735 }
736 }
737
7eebcb7c 738 return 0;
1da177e4
LT
739}
740
a1d9e6e4
DB
741/**
742 * i2c_del_driver - unregister I2C driver
743 * @driver: the driver being unregistered
d64f73be 744 * Context: can sleep
a1d9e6e4 745 */
b3e82096 746void i2c_del_driver(struct i2c_driver *driver)
1da177e4 747{
caada32a 748 mutex_lock(&core_lock);
1da177e4 749
a1d9e6e4
DB
750 /* new-style driver? */
751 if (is_newstyle_driver(driver))
752 goto unregister;
753
7f101a97 754 class_for_each_device(&i2c_adapter_class, driver, __detach_adapter);
1da177e4 755
a1d9e6e4 756 unregister:
1da177e4 757 driver_unregister(&driver->driver);
35d8b2e6 758 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
1da177e4 759
caada32a 760 mutex_unlock(&core_lock);
1da177e4 761}
c0564606 762EXPORT_SYMBOL(i2c_del_driver);
1da177e4 763
7b4fbc50
DB
764/* ------------------------------------------------------------------------- */
765
9b766b81 766static int __i2c_check_addr(struct device *dev, void *addrp)
1da177e4 767{
9b766b81
DB
768 struct i2c_client *client = i2c_verify_client(dev);
769 int addr = *(int *)addrp;
1da177e4 770
9b766b81
DB
771 if (client && client->addr == addr)
772 return -EBUSY;
1da177e4
LT
773 return 0;
774}
775
5e31c2bd 776static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
1da177e4 777{
9b766b81 778 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
1da177e4
LT
779}
780
781int i2c_attach_client(struct i2c_client *client)
782{
783 struct i2c_adapter *adapter = client->adapter;
b119c6c9 784 int res = 0;
1da177e4 785
1da177e4 786 client->dev.parent = &client->adapter->dev;
1da177e4 787 client->dev.bus = &i2c_bus_type;
9c1600ed
DB
788
789 if (client->driver)
790 client->dev.driver = &client->driver->driver;
791
de81d2aa 792 if (client->driver && !is_newstyle_driver(client->driver)) {
9c1600ed 793 client->dev.release = i2c_client_release;
de81d2aa
DB
794 client->dev.uevent_suppress = 1;
795 } else
9c1600ed 796 client->dev.release = i2c_client_dev_release;
438d6c2c 797
1da177e4
LT
798 snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
799 "%d-%04x", i2c_adapter_id(adapter), client->addr);
b119c6c9
JD
800 res = device_register(&client->dev);
801 if (res)
86ec5ec8
DB
802 goto out_err;
803
804 mutex_lock(&adapter->clist_lock);
805 list_add_tail(&client->list, &adapter->clients);
b119c6c9 806 mutex_unlock(&adapter->clist_lock);
77ed74da 807
86ec5ec8
DB
808 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
809 client->name, client->dev.bus_id);
810
77ed74da
JD
811 if (adapter->client_register) {
812 if (adapter->client_register(client)) {
813 dev_dbg(&adapter->dev, "client_register "
814 "failed for client [%s] at 0x%02x\n",
815 client->name, client->addr);
816 }
817 }
818
819 return 0;
b119c6c9 820
86ec5ec8 821out_err:
b119c6c9
JD
822 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
823 "(%d)\n", client->name, client->addr, res);
77ed74da 824 return res;
1da177e4 825}
c0564606 826EXPORT_SYMBOL(i2c_attach_client);
1da177e4
LT
827
828int i2c_detach_client(struct i2c_client *client)
829{
830 struct i2c_adapter *adapter = client->adapter;
831 int res = 0;
438d6c2c 832
1da177e4
LT
833 if (adapter->client_unregister) {
834 res = adapter->client_unregister(client);
835 if (res) {
836 dev_err(&client->dev,
86749e85
JD
837 "client_unregister [%s] failed, "
838 "client not detached\n", client->name);
1da177e4
LT
839 goto out;
840 }
841 }
842
5c085d36 843 mutex_lock(&adapter->clist_lock);
1da177e4 844 list_del(&client->list);
9ddced16
JD
845 mutex_unlock(&adapter->clist_lock);
846
1da177e4 847 init_completion(&client->released);
1da177e4 848 device_unregister(&client->dev);
1da177e4
LT
849 wait_for_completion(&client->released);
850
851 out:
852 return res;
853}
c0564606 854EXPORT_SYMBOL(i2c_detach_client);
1da177e4 855
e48d3319
JD
856/**
857 * i2c_use_client - increments the reference count of the i2c client structure
858 * @client: the client being referenced
859 *
860 * Each live reference to a client should be refcounted. The driver model does
861 * that automatically as part of driver binding, so that most drivers don't
862 * need to do this explicitly: they hold a reference until they're unbound
863 * from the device.
864 *
865 * A pointer to the client with the incremented reference counter is returned.
866 */
867struct i2c_client *i2c_use_client(struct i2c_client *client)
1da177e4 868{
bdc511f4 869 get_device(&client->dev);
e48d3319 870 return client;
1da177e4 871}
c0564606 872EXPORT_SYMBOL(i2c_use_client);
1da177e4 873
e48d3319
JD
874/**
875 * i2c_release_client - release a use of the i2c client structure
876 * @client: the client being no longer referenced
877 *
878 * Must be called when a user of a client is finished with it.
879 */
880void i2c_release_client(struct i2c_client *client)
1da177e4 881{
bdc511f4 882 put_device(&client->dev);
1da177e4 883}
c0564606 884EXPORT_SYMBOL(i2c_release_client);
1da177e4 885
9b766b81
DB
886struct i2c_cmd_arg {
887 unsigned cmd;
888 void *arg;
889};
890
891static int i2c_cmd(struct device *dev, void *_arg)
892{
893 struct i2c_client *client = i2c_verify_client(dev);
894 struct i2c_cmd_arg *arg = _arg;
895
896 if (client && client->driver && client->driver->command)
897 client->driver->command(client, arg->cmd, arg->arg);
898 return 0;
899}
900
1da177e4
LT
901void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
902{
9b766b81 903 struct i2c_cmd_arg cmd_arg;
1da177e4 904
9b766b81
DB
905 cmd_arg.cmd = cmd;
906 cmd_arg.arg = arg;
907 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
1da177e4 908}
c0564606 909EXPORT_SYMBOL(i2c_clients_command);
1da177e4
LT
910
911static int __init i2c_init(void)
912{
913 int retval;
914
915 retval = bus_register(&i2c_bus_type);
1da177e4
LT
916 if (retval)
917 return retval;
e9f1373b
DB
918 retval = class_register(&i2c_adapter_class);
919 if (retval)
920 goto bus_err;
921 retval = i2c_add_driver(&dummy_driver);
922 if (retval)
923 goto class_err;
924 return 0;
925
926class_err:
927 class_unregister(&i2c_adapter_class);
928bus_err:
929 bus_unregister(&i2c_bus_type);
930 return retval;
1da177e4
LT
931}
932
933static void __exit i2c_exit(void)
934{
e9f1373b 935 i2c_del_driver(&dummy_driver);
1da177e4 936 class_unregister(&i2c_adapter_class);
1da177e4
LT
937 bus_unregister(&i2c_bus_type);
938}
939
940subsys_initcall(i2c_init);
941module_exit(i2c_exit);
942
943/* ----------------------------------------------------
944 * the functional interface to the i2c busses.
945 * ----------------------------------------------------
946 */
947
a1cdedac
DB
948/**
949 * i2c_transfer - execute a single or combined I2C message
950 * @adap: Handle to I2C bus
951 * @msgs: One or more messages to execute before STOP is issued to
952 * terminate the operation; each message begins with a START.
953 * @num: Number of messages to be executed.
954 *
955 * Returns negative errno, else the number of messages executed.
956 *
957 * Note that there is no requirement that each message be sent to
958 * the same slave address, although that is the most common model.
959 */
1da177e4
LT
960int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
961{
962 int ret;
963
a1cdedac
DB
964 /* REVISIT the fault reporting model here is weak:
965 *
966 * - When we get an error after receiving N bytes from a slave,
967 * there is no way to report "N".
968 *
969 * - When we get a NAK after transmitting N bytes to a slave,
970 * there is no way to report "N" ... or to let the master
971 * continue executing the rest of this combined message, if
972 * that's the appropriate response.
973 *
974 * - When for example "num" is two and we successfully complete
975 * the first message but get an error part way through the
976 * second, it's unclear whether that should be reported as
977 * one (discarding status on the second message) or errno
978 * (discarding status on the first one).
979 */
980
1da177e4
LT
981 if (adap->algo->master_xfer) {
982#ifdef DEBUG
983 for (ret = 0; ret < num; ret++) {
984 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
209d27c3
JD
985 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
986 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
987 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
1da177e4
LT
988 }
989#endif
990
cea443a8
MR
991 if (in_atomic() || irqs_disabled()) {
992 ret = mutex_trylock(&adap->bus_lock);
993 if (!ret)
994 /* I2C activity is ongoing. */
995 return -EAGAIN;
996 } else {
997 mutex_lock_nested(&adap->bus_lock, adap->level);
998 }
999
1da177e4 1000 ret = adap->algo->master_xfer(adap,msgs,num);
5c085d36 1001 mutex_unlock(&adap->bus_lock);
1da177e4
LT
1002
1003 return ret;
1004 } else {
1005 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
24a5bb7b 1006 return -EOPNOTSUPP;
1da177e4
LT
1007 }
1008}
c0564606 1009EXPORT_SYMBOL(i2c_transfer);
1da177e4 1010
a1cdedac
DB
1011/**
1012 * i2c_master_send - issue a single I2C message in master transmit mode
1013 * @client: Handle to slave device
1014 * @buf: Data that will be written to the slave
1015 * @count: How many bytes to write
1016 *
1017 * Returns negative errno, or else the number of bytes written.
1018 */
1da177e4
LT
1019int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1020{
1021 int ret;
1022 struct i2c_adapter *adap=client->adapter;
1023 struct i2c_msg msg;
1024
815f55f2
JD
1025 msg.addr = client->addr;
1026 msg.flags = client->flags & I2C_M_TEN;
1027 msg.len = count;
1028 msg.buf = (char *)buf;
438d6c2c 1029
815f55f2 1030 ret = i2c_transfer(adap, &msg, 1);
1da177e4 1031
815f55f2
JD
1032 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1033 transmitted, else error code. */
1034 return (ret == 1) ? count : ret;
1da177e4 1035}
c0564606 1036EXPORT_SYMBOL(i2c_master_send);
1da177e4 1037
a1cdedac
DB
1038/**
1039 * i2c_master_recv - issue a single I2C message in master receive mode
1040 * @client: Handle to slave device
1041 * @buf: Where to store data read from slave
1042 * @count: How many bytes to read
1043 *
1044 * Returns negative errno, or else the number of bytes read.
1045 */
1da177e4
LT
1046int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1047{
1048 struct i2c_adapter *adap=client->adapter;
1049 struct i2c_msg msg;
1050 int ret;
815f55f2
JD
1051
1052 msg.addr = client->addr;
1053 msg.flags = client->flags & I2C_M_TEN;
1054 msg.flags |= I2C_M_RD;
1055 msg.len = count;
1056 msg.buf = buf;
1057
1058 ret = i2c_transfer(adap, &msg, 1);
1059
1060 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1061 transmitted, else error code. */
1062 return (ret == 1) ? count : ret;
1da177e4 1063}
c0564606 1064EXPORT_SYMBOL(i2c_master_recv);
1da177e4 1065
1da177e4
LT
1066/* ----------------------------------------------------
1067 * the i2c address scanning function
1068 * Will not work for 10-bit addresses!
1069 * ----------------------------------------------------
1070 */
a89ba0bc
JD
1071static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
1072 int (*found_proc) (struct i2c_adapter *, int, int))
1073{
1074 int err;
1075
1076 /* Make sure the address is valid */
1077 if (addr < 0x03 || addr > 0x77) {
1078 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1079 addr);
1080 return -EINVAL;
9fc6adfa
JD
1081 }
1082
a89ba0bc
JD
1083 /* Skip if already in use */
1084 if (i2c_check_addr(adapter, addr))
1085 return 0;
1086
1087 /* Make sure there is something at this address, unless forced */
4c9337da
JD
1088 if (kind < 0) {
1089 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1090 I2C_SMBUS_QUICK, NULL) < 0)
1091 return 0;
1092
1093 /* prevent 24RF08 corruption */
1094 if ((addr & ~0x0f) == 0x50)
1095 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1096 I2C_SMBUS_QUICK, NULL);
1097 }
a89ba0bc
JD
1098
1099 /* Finally call the custom detection function */
1100 err = found_proc(adapter, addr, kind);
a89ba0bc
JD
1101 /* -ENODEV can be returned if there is a chip at the given address
1102 but it isn't supported by this chip driver. We catch it here as
1103 this isn't an error. */
114fd183
JD
1104 if (err == -ENODEV)
1105 err = 0;
1106
1107 if (err)
1108 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
1109 addr, err);
1110 return err;
9fc6adfa
JD
1111}
1112
1da177e4 1113int i2c_probe(struct i2c_adapter *adapter,
bfb6df24 1114 const struct i2c_client_address_data *address_data,
1da177e4
LT
1115 int (*found_proc) (struct i2c_adapter *, int, int))
1116{
a89ba0bc 1117 int i, err;
1da177e4
LT
1118 int adap_id = i2c_adapter_id(adapter);
1119
a89ba0bc
JD
1120 /* Force entries are done first, and are not affected by ignore
1121 entries */
1122 if (address_data->forces) {
bfb6df24 1123 const unsigned short * const *forces = address_data->forces;
a89ba0bc
JD
1124 int kind;
1125
1126 for (kind = 0; forces[kind]; kind++) {
1127 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1128 i += 2) {
1129 if (forces[kind][i] == adap_id
1130 || forces[kind][i] == ANY_I2C_BUS) {
1131 dev_dbg(&adapter->dev, "found force "
1132 "parameter for adapter %d, "
1133 "addr 0x%02x, kind %d\n",
1134 adap_id, forces[kind][i + 1],
1135 kind);
1136 err = i2c_probe_address(adapter,
1137 forces[kind][i + 1],
1138 kind, found_proc);
1139 if (err)
1140 return err;
1141 }
1da177e4
LT
1142 }
1143 }
a89ba0bc 1144 }
1da177e4 1145
4366dc94
JD
1146 /* Stop here if we can't use SMBUS_QUICK */
1147 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1148 if (address_data->probe[0] == I2C_CLIENT_END
1149 && address_data->normal_i2c[0] == I2C_CLIENT_END)
438d6c2c 1150 return 0;
4366dc94
JD
1151
1152 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1153 "can't probe for chips\n");
24a5bb7b 1154 return -EOPNOTSUPP;
4366dc94
JD
1155 }
1156
a89ba0bc
JD
1157 /* Probe entries are done second, and are not affected by ignore
1158 entries either */
1159 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1160 if (address_data->probe[i] == adap_id
1161 || address_data->probe[i] == ANY_I2C_BUS) {
1162 dev_dbg(&adapter->dev, "found probe parameter for "
1163 "adapter %d, addr 0x%02x\n", adap_id,
1164 address_data->probe[i + 1]);
1165 err = i2c_probe_address(adapter,
1166 address_data->probe[i + 1],
1167 -1, found_proc);
1168 if (err)
1169 return err;
1da177e4 1170 }
a89ba0bc 1171 }
1da177e4 1172
a89ba0bc
JD
1173 /* Normal entries are done last, unless shadowed by an ignore entry */
1174 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1175 int j, ignore;
1176
1177 ignore = 0;
1178 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1179 j += 2) {
1180 if ((address_data->ignore[j] == adap_id ||
1181 address_data->ignore[j] == ANY_I2C_BUS)
1182 && address_data->ignore[j + 1]
1183 == address_data->normal_i2c[i]) {
1184 dev_dbg(&adapter->dev, "found ignore "
1185 "parameter for adapter %d, "
1186 "addr 0x%02x\n", adap_id,
1187 address_data->ignore[j + 1]);
2369df93
MH
1188 ignore = 1;
1189 break;
1da177e4
LT
1190 }
1191 }
a89ba0bc 1192 if (ignore)
1da177e4
LT
1193 continue;
1194
a89ba0bc
JD
1195 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1196 "addr 0x%02x\n", adap_id,
1197 address_data->normal_i2c[i]);
1198 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1199 -1, found_proc);
1200 if (err)
1201 return err;
1da177e4 1202 }
a89ba0bc 1203
1da177e4
LT
1204 return 0;
1205}
c0564606 1206EXPORT_SYMBOL(i2c_probe);
1da177e4 1207
12b5053a
JD
1208struct i2c_client *
1209i2c_new_probed_device(struct i2c_adapter *adap,
1210 struct i2c_board_info *info,
1211 unsigned short const *addr_list)
1212{
1213 int i;
1214
1215 /* Stop here if the bus doesn't support probing */
1216 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1217 dev_err(&adap->dev, "Probing not supported\n");
1218 return NULL;
1219 }
1220
12b5053a
JD
1221 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1222 /* Check address validity */
1223 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1224 dev_warn(&adap->dev, "Invalid 7-bit address "
1225 "0x%02x\n", addr_list[i]);
1226 continue;
1227 }
1228
1229 /* Check address availability */
9b766b81 1230 if (i2c_check_addr(adap, addr_list[i])) {
12b5053a
JD
1231 dev_dbg(&adap->dev, "Address 0x%02x already in "
1232 "use, not probing\n", addr_list[i]);
1233 continue;
1234 }
1235
1236 /* Test address responsiveness
1237 The default probe method is a quick write, but it is known
1238 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1239 and could also irreversibly write-protect some EEPROMs, so
1240 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1241 read instead. Also, some bus drivers don't implement
1242 quick write, so we fallback to a byte read it that case
1243 too. */
1244 if ((addr_list[i] & ~0x07) == 0x30
1245 || (addr_list[i] & ~0x0f) == 0x50
1246 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
1247 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1248 I2C_SMBUS_READ, 0,
1249 I2C_SMBUS_BYTE, NULL) >= 0)
1250 break;
1251 } else {
1252 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1253 I2C_SMBUS_WRITE, 0,
1254 I2C_SMBUS_QUICK, NULL) >= 0)
1255 break;
1256 }
1257 }
12b5053a
JD
1258
1259 if (addr_list[i] == I2C_CLIENT_END) {
1260 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1261 return NULL;
1262 }
1263
1264 info->addr = addr_list[i];
1265 return i2c_new_device(adap, info);
1266}
1267EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1268
1da177e4
LT
1269struct i2c_adapter* i2c_get_adapter(int id)
1270{
1da177e4 1271 struct i2c_adapter *adapter;
438d6c2c 1272
caada32a 1273 mutex_lock(&core_lock);
a0920e10
MH
1274 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1275 if (adapter && !try_module_get(adapter->owner))
1276 adapter = NULL;
1277
caada32a 1278 mutex_unlock(&core_lock);
a0920e10 1279 return adapter;
1da177e4 1280}
c0564606 1281EXPORT_SYMBOL(i2c_get_adapter);
1da177e4
LT
1282
1283void i2c_put_adapter(struct i2c_adapter *adap)
1284{
1285 module_put(adap->owner);
1286}
c0564606 1287EXPORT_SYMBOL(i2c_put_adapter);
1da177e4
LT
1288
1289/* The SMBus parts */
1290
438d6c2c 1291#define POLY (0x1070U << 3)
1da177e4
LT
1292static u8
1293crc8(u16 data)
1294{
1295 int i;
438d6c2c 1296
1da177e4 1297 for(i = 0; i < 8; i++) {
438d6c2c 1298 if (data & 0x8000)
1da177e4
LT
1299 data = data ^ POLY;
1300 data = data << 1;
1301 }
1302 return (u8)(data >> 8);
1303}
1304
421ef47b
JD
1305/* Incremental CRC8 over count bytes in the array pointed to by p */
1306static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
1da177e4
LT
1307{
1308 int i;
1309
1310 for(i = 0; i < count; i++)
421ef47b 1311 crc = crc8((crc ^ p[i]) << 8);
1da177e4
LT
1312 return crc;
1313}
1314
421ef47b
JD
1315/* Assume a 7-bit address, which is reasonable for SMBus */
1316static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
1da177e4 1317{
421ef47b
JD
1318 /* The address will be sent first */
1319 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1320 pec = i2c_smbus_pec(pec, &addr, 1);
1321
1322 /* The data buffer follows */
1323 return i2c_smbus_pec(pec, msg->buf, msg->len);
1da177e4
LT
1324}
1325
421ef47b
JD
1326/* Used for write only transactions */
1327static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
1da177e4 1328{
421ef47b
JD
1329 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1330 msg->len++;
1da177e4
LT
1331}
1332
421ef47b
JD
1333/* Return <0 on CRC error
1334 If there was a write before this read (most cases) we need to take the
1335 partial CRC from the write part into account.
1336 Note that this function does modify the message (we need to decrease the
1337 message length to hide the CRC byte from the caller). */
1338static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
1da177e4 1339{
421ef47b
JD
1340 u8 rpec = msg->buf[--msg->len];
1341 cpec = i2c_smbus_msg_pec(cpec, msg);
1da177e4 1342
1da177e4
LT
1343 if (rpec != cpec) {
1344 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1345 rpec, cpec);
24a5bb7b 1346 return -EBADMSG;
1da177e4 1347 }
438d6c2c 1348 return 0;
1da177e4
LT
1349}
1350
a1cdedac
DB
1351/**
1352 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1353 * @client: Handle to slave device
1354 *
1355 * This executes the SMBus "receive byte" protocol, returning negative errno
1356 * else the byte received from the device.
1357 */
1da177e4
LT
1358s32 i2c_smbus_read_byte(struct i2c_client *client)
1359{
1360 union i2c_smbus_data data;
24a5bb7b
DB
1361 int status;
1362
1363 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1364 I2C_SMBUS_READ, 0,
1365 I2C_SMBUS_BYTE, &data);
1366 return (status < 0) ? status : data.byte;
1da177e4 1367}
c0564606 1368EXPORT_SYMBOL(i2c_smbus_read_byte);
1da177e4 1369
a1cdedac
DB
1370/**
1371 * i2c_smbus_write_byte - SMBus "send byte" protocol
1372 * @client: Handle to slave device
1373 * @value: Byte to be sent
1374 *
1375 * This executes the SMBus "send byte" protocol, returning negative errno
1376 * else zero on success.
1377 */
1da177e4
LT
1378s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1379{
1da177e4 1380 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
421ef47b 1381 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
1da177e4 1382}
c0564606 1383EXPORT_SYMBOL(i2c_smbus_write_byte);
1da177e4 1384
a1cdedac
DB
1385/**
1386 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1387 * @client: Handle to slave device
1388 * @command: Byte interpreted by slave
1389 *
1390 * This executes the SMBus "read byte" protocol, returning negative errno
1391 * else a data byte received from the device.
1392 */
1da177e4
LT
1393s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1394{
1395 union i2c_smbus_data data;
24a5bb7b
DB
1396 int status;
1397
1398 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1399 I2C_SMBUS_READ, command,
1400 I2C_SMBUS_BYTE_DATA, &data);
1401 return (status < 0) ? status : data.byte;
1da177e4 1402}
c0564606 1403EXPORT_SYMBOL(i2c_smbus_read_byte_data);
1da177e4 1404
a1cdedac
DB
1405/**
1406 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1407 * @client: Handle to slave device
1408 * @command: Byte interpreted by slave
1409 * @value: Byte being written
1410 *
1411 * This executes the SMBus "write byte" protocol, returning negative errno
1412 * else zero on success.
1413 */
1da177e4
LT
1414s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1415{
1416 union i2c_smbus_data data;
1417 data.byte = value;
1418 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1419 I2C_SMBUS_WRITE,command,
1420 I2C_SMBUS_BYTE_DATA,&data);
1421}
c0564606 1422EXPORT_SYMBOL(i2c_smbus_write_byte_data);
1da177e4 1423
a1cdedac
DB
1424/**
1425 * i2c_smbus_read_word_data - SMBus "read word" protocol
1426 * @client: Handle to slave device
1427 * @command: Byte interpreted by slave
1428 *
1429 * This executes the SMBus "read word" protocol, returning negative errno
1430 * else a 16-bit unsigned "word" received from the device.
1431 */
1da177e4
LT
1432s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1433{
1434 union i2c_smbus_data data;
24a5bb7b
DB
1435 int status;
1436
1437 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1438 I2C_SMBUS_READ, command,
1439 I2C_SMBUS_WORD_DATA, &data);
1440 return (status < 0) ? status : data.word;
1da177e4 1441}
c0564606 1442EXPORT_SYMBOL(i2c_smbus_read_word_data);
1da177e4 1443
a1cdedac
DB
1444/**
1445 * i2c_smbus_write_word_data - SMBus "write word" protocol
1446 * @client: Handle to slave device
1447 * @command: Byte interpreted by slave
1448 * @value: 16-bit "word" being written
1449 *
1450 * This executes the SMBus "write word" protocol, returning negative errno
1451 * else zero on success.
1452 */
1da177e4
LT
1453s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1454{
1455 union i2c_smbus_data data;
1456 data.word = value;
1457 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1458 I2C_SMBUS_WRITE,command,
1459 I2C_SMBUS_WORD_DATA,&data);
1460}
c0564606 1461EXPORT_SYMBOL(i2c_smbus_write_word_data);
1da177e4 1462
a64ec07d 1463/**
a1cdedac 1464 * i2c_smbus_read_block_data - SMBus "block read" protocol
a64ec07d 1465 * @client: Handle to slave device
a1cdedac 1466 * @command: Byte interpreted by slave
a64ec07d
DB
1467 * @values: Byte array into which data will be read; big enough to hold
1468 * the data returned by the slave. SMBus allows at most 32 bytes.
1469 *
a1cdedac
DB
1470 * This executes the SMBus "block read" protocol, returning negative errno
1471 * else the number of data bytes in the slave's response.
a64ec07d
DB
1472 *
1473 * Note that using this function requires that the client's adapter support
1474 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1475 * support this; its emulation through I2C messaging relies on a specific
1476 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1477 */
b86a1bc8
JD
1478s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1479 u8 *values)
1480{
1481 union i2c_smbus_data data;
24a5bb7b 1482 int status;
b86a1bc8 1483
24a5bb7b
DB
1484 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1485 I2C_SMBUS_READ, command,
1486 I2C_SMBUS_BLOCK_DATA, &data);
1487 if (status)
1488 return status;
b86a1bc8
JD
1489
1490 memcpy(values, &data.block[1], data.block[0]);
1491 return data.block[0];
1492}
1493EXPORT_SYMBOL(i2c_smbus_read_block_data);
1494
a1cdedac
DB
1495/**
1496 * i2c_smbus_write_block_data - SMBus "block write" protocol
1497 * @client: Handle to slave device
1498 * @command: Byte interpreted by slave
1499 * @length: Size of data block; SMBus allows at most 32 bytes
1500 * @values: Byte array which will be written.
1501 *
1502 * This executes the SMBus "block write" protocol, returning negative errno
1503 * else zero on success.
1504 */
1da177e4 1505s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
46f5ed75 1506 u8 length, const u8 *values)
1da177e4
LT
1507{
1508 union i2c_smbus_data data;
7656032b 1509
1da177e4
LT
1510 if (length > I2C_SMBUS_BLOCK_MAX)
1511 length = I2C_SMBUS_BLOCK_MAX;
1da177e4 1512 data.block[0] = length;
7656032b 1513 memcpy(&data.block[1], values, length);
1da177e4
LT
1514 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1515 I2C_SMBUS_WRITE,command,
1516 I2C_SMBUS_BLOCK_DATA,&data);
1517}
c0564606 1518EXPORT_SYMBOL(i2c_smbus_write_block_data);
1da177e4
LT
1519
1520/* Returns the number of read bytes */
4b2643d7
JD
1521s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1522 u8 length, u8 *values)
1da177e4
LT
1523{
1524 union i2c_smbus_data data;
24a5bb7b 1525 int status;
7656032b 1526
4b2643d7
JD
1527 if (length > I2C_SMBUS_BLOCK_MAX)
1528 length = I2C_SMBUS_BLOCK_MAX;
1529 data.block[0] = length;
24a5bb7b
DB
1530 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1531 I2C_SMBUS_READ, command,
1532 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1533 if (status < 0)
1534 return status;
7656032b
JD
1535
1536 memcpy(values, &data.block[1], data.block[0]);
1537 return data.block[0];
1da177e4 1538}
c0564606 1539EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1da177e4 1540
21bbd691 1541s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
46f5ed75 1542 u8 length, const u8 *values)
21bbd691
JD
1543{
1544 union i2c_smbus_data data;
1545
1546 if (length > I2C_SMBUS_BLOCK_MAX)
1547 length = I2C_SMBUS_BLOCK_MAX;
1548 data.block[0] = length;
1549 memcpy(data.block + 1, values, length);
1550 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1551 I2C_SMBUS_WRITE, command,
1552 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1553}
c0564606 1554EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
21bbd691 1555
438d6c2c 1556/* Simulate a SMBus command using the i2c protocol
1da177e4 1557 No checking of parameters is done! */
438d6c2c 1558static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
1da177e4 1559 unsigned short flags,
438d6c2c 1560 char read_write, u8 command, int size,
1da177e4
LT
1561 union i2c_smbus_data * data)
1562{
1563 /* So we need to generate a series of msgs. In the case of writing, we
1564 need to use only one message; when reading, we need two. We initialize
1565 most things with sane defaults, to keep the code below somewhat
1566 simpler. */
5c50d188
HI
1567 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1568 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
1da177e4 1569 int num = read_write == I2C_SMBUS_READ?2:1;
438d6c2c 1570 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
1da177e4
LT
1571 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1572 };
1573 int i;
421ef47b 1574 u8 partial_pec = 0;
24a5bb7b 1575 int status;
1da177e4
LT
1576
1577 msgbuf0[0] = command;
1578 switch(size) {
1579 case I2C_SMBUS_QUICK:
1580 msg[0].len = 0;
1581 /* Special case: The read/write field is used as data */
1582 msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
1583 num = 1;
1584 break;
1585 case I2C_SMBUS_BYTE:
1586 if (read_write == I2C_SMBUS_READ) {
1587 /* Special case: only a read! */
1588 msg[0].flags = I2C_M_RD | flags;
1589 num = 1;
1590 }
1591 break;
1592 case I2C_SMBUS_BYTE_DATA:
1593 if (read_write == I2C_SMBUS_READ)
1594 msg[1].len = 1;
1595 else {
1596 msg[0].len = 2;
1597 msgbuf0[1] = data->byte;
1598 }
1599 break;
1600 case I2C_SMBUS_WORD_DATA:
1601 if (read_write == I2C_SMBUS_READ)
1602 msg[1].len = 2;
1603 else {
1604 msg[0].len=3;
1605 msgbuf0[1] = data->word & 0xff;
7eff82c8 1606 msgbuf0[2] = data->word >> 8;
1da177e4
LT
1607 }
1608 break;
1609 case I2C_SMBUS_PROC_CALL:
1610 num = 2; /* Special case */
1611 read_write = I2C_SMBUS_READ;
1612 msg[0].len = 3;
1613 msg[1].len = 2;
1614 msgbuf0[1] = data->word & 0xff;
7eff82c8 1615 msgbuf0[2] = data->word >> 8;
1da177e4
LT
1616 break;
1617 case I2C_SMBUS_BLOCK_DATA:
1da177e4 1618 if (read_write == I2C_SMBUS_READ) {
209d27c3
JD
1619 msg[1].flags |= I2C_M_RECV_LEN;
1620 msg[1].len = 1; /* block length will be added by
1621 the underlying bus driver */
1da177e4
LT
1622 } else {
1623 msg[0].len = data->block[0] + 2;
1624 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
24a5bb7b
DB
1625 dev_err(&adapter->dev,
1626 "Invalid block write size %d\n",
1627 data->block[0]);
1628 return -EINVAL;
1da177e4 1629 }
5c50d188 1630 for (i = 1; i < msg[0].len; i++)
1da177e4
LT
1631 msgbuf0[i] = data->block[i-1];
1632 }
1633 break;
1634 case I2C_SMBUS_BLOCK_PROC_CALL:
209d27c3
JD
1635 num = 2; /* Another special case */
1636 read_write = I2C_SMBUS_READ;
1637 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
24a5bb7b
DB
1638 dev_err(&adapter->dev,
1639 "Invalid block write size %d\n",
209d27c3 1640 data->block[0]);
24a5bb7b 1641 return -EINVAL;
209d27c3
JD
1642 }
1643 msg[0].len = data->block[0] + 2;
1644 for (i = 1; i < msg[0].len; i++)
1645 msgbuf0[i] = data->block[i-1];
1646 msg[1].flags |= I2C_M_RECV_LEN;
1647 msg[1].len = 1; /* block length will be added by
1648 the underlying bus driver */
1649 break;
1da177e4
LT
1650 case I2C_SMBUS_I2C_BLOCK_DATA:
1651 if (read_write == I2C_SMBUS_READ) {
4b2643d7 1652 msg[1].len = data->block[0];
1da177e4
LT
1653 } else {
1654 msg[0].len = data->block[0] + 1;
30dac746 1655 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
24a5bb7b
DB
1656 dev_err(&adapter->dev,
1657 "Invalid block write size %d\n",
1658 data->block[0]);
1659 return -EINVAL;
1da177e4
LT
1660 }
1661 for (i = 1; i <= data->block[0]; i++)
1662 msgbuf0[i] = data->block[i];
1663 }
1664 break;
1665 default:
24a5bb7b
DB
1666 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1667 return -EOPNOTSUPP;
1da177e4
LT
1668 }
1669
421ef47b
JD
1670 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1671 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1672 if (i) {
1673 /* Compute PEC if first message is a write */
1674 if (!(msg[0].flags & I2C_M_RD)) {
438d6c2c 1675 if (num == 1) /* Write only */
421ef47b
JD
1676 i2c_smbus_add_pec(&msg[0]);
1677 else /* Write followed by read */
1678 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1679 }
1680 /* Ask for PEC if last message is a read */
1681 if (msg[num-1].flags & I2C_M_RD)
438d6c2c 1682 msg[num-1].len++;
421ef47b
JD
1683 }
1684
24a5bb7b
DB
1685 status = i2c_transfer(adapter, msg, num);
1686 if (status < 0)
1687 return status;
1da177e4 1688
421ef47b
JD
1689 /* Check PEC if last message is a read */
1690 if (i && (msg[num-1].flags & I2C_M_RD)) {
24a5bb7b
DB
1691 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1692 if (status < 0)
1693 return status;
421ef47b
JD
1694 }
1695
1da177e4
LT
1696 if (read_write == I2C_SMBUS_READ)
1697 switch(size) {
1698 case I2C_SMBUS_BYTE:
1699 data->byte = msgbuf0[0];
1700 break;
1701 case I2C_SMBUS_BYTE_DATA:
1702 data->byte = msgbuf1[0];
1703 break;
438d6c2c 1704 case I2C_SMBUS_WORD_DATA:
1da177e4
LT
1705 case I2C_SMBUS_PROC_CALL:
1706 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1707 break;
1708 case I2C_SMBUS_I2C_BLOCK_DATA:
4b2643d7 1709 for (i = 0; i < data->block[0]; i++)
1da177e4
LT
1710 data->block[i+1] = msgbuf1[i];
1711 break;
209d27c3
JD
1712 case I2C_SMBUS_BLOCK_DATA:
1713 case I2C_SMBUS_BLOCK_PROC_CALL:
1714 for (i = 0; i < msgbuf1[0] + 1; i++)
1715 data->block[i] = msgbuf1[i];
1716 break;
1da177e4
LT
1717 }
1718 return 0;
1719}
1720
a1cdedac
DB
1721/**
1722 * i2c_smbus_xfer - execute SMBus protocol operations
1723 * @adapter: Handle to I2C bus
1724 * @addr: Address of SMBus slave on that bus
1725 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1726 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1727 * @command: Byte interpreted by slave, for protocols which use such bytes
1728 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1729 * @data: Data to be read or written
1730 *
1731 * This executes an SMBus protocol operation, and returns a negative
1732 * errno code else zero on success.
1733 */
1da177e4 1734s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
a1cdedac 1735 char read_write, u8 command, int protocol,
1da177e4
LT
1736 union i2c_smbus_data * data)
1737{
1738 s32 res;
1da177e4
LT
1739
1740 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
1da177e4
LT
1741
1742 if (adapter->algo->smbus_xfer) {
5c085d36 1743 mutex_lock(&adapter->bus_lock);
1da177e4 1744 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
a1cdedac 1745 command, protocol, data);
5c085d36 1746 mutex_unlock(&adapter->bus_lock);
1da177e4
LT
1747 } else
1748 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
a1cdedac 1749 command, protocol, data);
1da177e4 1750
1da177e4
LT
1751 return res;
1752}
1da177e4 1753EXPORT_SYMBOL(i2c_smbus_xfer);
1da177e4
LT
1754
1755MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1756MODULE_DESCRIPTION("I2C-Bus main module");
1757MODULE_LICENSE("GPL");
This page took 0.490867 seconds and 5 git commands to generate.