blob: 456caa80bfd3ba369ee279d0356fcdaa6dcadbdb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* i2c-core.c - a device driver for the iic-bus interface */
2/* ------------------------------------------------------------------------- */
3/* Copyright (C) 1995-99 Simon G. Vogl
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
18/* ------------------------------------------------------------------------- */
19
Jan Engelhardt96de0e22007-10-19 23:21:04 +020020/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
Jean Delvare421ef472005-10-26 21:28:55 +020022 SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
23 Jean Delvare <khali@linux-fr.org> */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/module.h>
26#include <linux/kernel.h>
27#include <linux/errno.h>
28#include <linux/slab.h>
29#include <linux/i2c.h>
30#include <linux/init.h>
31#include <linux/idr.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010032#include <linux/platform_device.h>
Arjan van de Venb3585e42006-01-11 10:50:26 +010033#include <linux/mutex.h>
Jean Delvareb8d6f452007-02-13 22:09:00 +010034#include <linux/completion.h>
Mike Rapoportcea443a2008-01-27 18:14:50 +010035#include <linux/hardirq.h>
36#include <linux/irqflags.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <asm/uaccess.h>
38
David Brownell9c1600e2007-05-01 23:26:31 +020039#include "i2c-core.h"
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Jean Delvarecaada322008-01-27 18:14:49 +010042static DEFINE_MUTEX(core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043static DEFINE_IDR(i2c_adapter_idr);
44
Jean Delvare4735c982008-07-14 22:38:36 +020045#define is_newstyle_driver(d) ((d)->probe || (d)->remove || (d)->detect)
46
47static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
David Brownellf37dd802007-02-13 22:09:00 +010048
49/* ------------------------------------------------------------------------- */
50
Jean Delvared2653e92008-04-29 23:11:39 +020051static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
52 const struct i2c_client *client)
53{
54 while (id->name[0]) {
55 if (strcmp(client->name, id->name) == 0)
56 return id;
57 id++;
58 }
59 return NULL;
60}
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062static int i2c_device_match(struct device *dev, struct device_driver *drv)
63{
David Brownell7b4fbc52007-05-01 23:26:30 +020064 struct i2c_client *client = to_i2c_client(dev);
65 struct i2c_driver *driver = to_i2c_driver(drv);
66
67 /* make legacy i2c drivers bypass driver model probing entirely;
68 * such drivers scan each i2c adapter/bus themselves.
69 */
David Brownella1d9e6e2007-05-01 23:26:30 +020070 if (!is_newstyle_driver(driver))
David Brownell7b4fbc52007-05-01 23:26:30 +020071 return 0;
72
Jean Delvared2653e92008-04-29 23:11:39 +020073 /* match on an id table if there is one */
74 if (driver->id_table)
75 return i2c_match_id(driver->id_table, client) != NULL;
76
Jean Delvareeb8a7902008-05-18 20:49:41 +020077 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078}
79
David Brownell7b4fbc52007-05-01 23:26:30 +020080#ifdef CONFIG_HOTPLUG
81
82/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +020083static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +020084{
85 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +020086
87 /* by definition, legacy drivers can't hotplug */
Jean Delvared2653e92008-04-29 23:11:39 +020088 if (dev->driver)
David Brownell7b4fbc52007-05-01 23:26:30 +020089 return 0;
90
Jean Delvareeb8a7902008-05-18 20:49:41 +020091 if (add_uevent_var(env, "MODALIAS=%s%s",
92 I2C_MODULE_PREFIX, client->name))
93 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +020094 dev_dbg(dev, "uevent\n");
95 return 0;
96}
97
98#else
99#define i2c_device_uevent NULL
100#endif /* CONFIG_HOTPLUG */
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102static int i2c_device_probe(struct device *dev)
103{
David Brownell7b4fbc52007-05-01 23:26:30 +0200104 struct i2c_client *client = to_i2c_client(dev);
105 struct i2c_driver *driver = to_i2c_driver(dev->driver);
Hans Verkuil50c33042008-03-12 14:15:00 +0100106 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200107
Jean Delvaree0457442008-07-14 22:38:30 +0200108 if (!driver->probe || !driver->id_table)
David Brownell7b4fbc52007-05-01 23:26:30 +0200109 return -ENODEV;
110 client->driver = driver;
Marc Pignatee354252008-08-28 08:33:22 +0200111 if (!device_can_wakeup(&client->dev))
112 device_init_wakeup(&client->dev,
113 client->flags & I2C_CLIENT_WAKE);
David Brownell7b4fbc52007-05-01 23:26:30 +0200114 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200115
Jean Delvaree0457442008-07-14 22:38:30 +0200116 status = driver->probe(client, i2c_match_id(driver->id_table, client));
Hans Verkuil50c33042008-03-12 14:15:00 +0100117 if (status)
118 client->driver = NULL;
119 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120}
121
122static int i2c_device_remove(struct device *dev)
123{
David Brownella1d9e6e2007-05-01 23:26:30 +0200124 struct i2c_client *client = to_i2c_client(dev);
125 struct i2c_driver *driver;
126 int status;
127
128 if (!dev->driver)
129 return 0;
130
131 driver = to_i2c_driver(dev->driver);
132 if (driver->remove) {
133 dev_dbg(dev, "remove\n");
134 status = driver->remove(client);
135 } else {
136 dev->driver = NULL;
137 status = 0;
138 }
139 if (status == 0)
140 client->driver = NULL;
141 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142}
143
David Brownellf37dd802007-02-13 22:09:00 +0100144static void i2c_device_shutdown(struct device *dev)
145{
146 struct i2c_driver *driver;
147
148 if (!dev->driver)
149 return;
150 driver = to_i2c_driver(dev->driver);
151 if (driver->shutdown)
152 driver->shutdown(to_i2c_client(dev));
153}
154
155static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
156{
157 struct i2c_driver *driver;
158
159 if (!dev->driver)
160 return 0;
161 driver = to_i2c_driver(dev->driver);
162 if (!driver->suspend)
163 return 0;
164 return driver->suspend(to_i2c_client(dev), mesg);
165}
166
167static int i2c_device_resume(struct device * dev)
168{
169 struct i2c_driver *driver;
170
171 if (!dev->driver)
172 return 0;
173 driver = to_i2c_driver(dev->driver);
174 if (!driver->resume)
175 return 0;
176 return driver->resume(to_i2c_client(dev));
177}
178
David Brownell7b4fbc52007-05-01 23:26:30 +0200179static void i2c_client_release(struct device *dev)
180{
181 struct i2c_client *client = to_i2c_client(dev);
182 complete(&client->released);
183}
184
David Brownell9c1600e2007-05-01 23:26:31 +0200185static void i2c_client_dev_release(struct device *dev)
186{
187 kfree(to_i2c_client(dev));
188}
189
David Brownell7b4fbc52007-05-01 23:26:30 +0200190static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
191{
192 struct i2c_client *client = to_i2c_client(dev);
193 return sprintf(buf, "%s\n", client->name);
194}
195
196static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
197{
198 struct i2c_client *client = to_i2c_client(dev);
Jean Delvareeb8a7902008-05-18 20:49:41 +0200199 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200200}
201
202static struct device_attribute i2c_dev_attrs[] = {
203 __ATTR(name, S_IRUGO, show_client_name, NULL),
204 /* modalias helps coldplug: modprobe $(cat .../modalias) */
205 __ATTR(modalias, S_IRUGO, show_modalias, NULL),
206 { },
207};
208
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200209struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100210 .name = "i2c",
David Brownell7b4fbc52007-05-01 23:26:30 +0200211 .dev_attrs = i2c_dev_attrs,
David Brownellf37dd802007-02-13 22:09:00 +0100212 .match = i2c_device_match,
David Brownell7b4fbc52007-05-01 23:26:30 +0200213 .uevent = i2c_device_uevent,
David Brownellf37dd802007-02-13 22:09:00 +0100214 .probe = i2c_device_probe,
215 .remove = i2c_device_remove,
216 .shutdown = i2c_device_shutdown,
217 .suspend = i2c_device_suspend,
218 .resume = i2c_device_resume,
Russell Kingb864c7d2006-01-05 14:37:50 +0000219};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200220EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000221
David Brownell9b766b82008-01-27 18:14:51 +0100222
223/**
224 * i2c_verify_client - return parameter as i2c_client, or NULL
225 * @dev: device, probably from some driver model iterator
226 *
227 * When traversing the driver model tree, perhaps using driver model
228 * iterators like @device_for_each_child(), you can't assume very much
229 * about the nodes you find. Use this function to avoid oopses caused
230 * by wrongly treating some non-I2C device as an i2c_client.
231 */
232struct i2c_client *i2c_verify_client(struct device *dev)
233{
234 return (dev->bus == &i2c_bus_type)
235 ? to_i2c_client(dev)
236 : NULL;
237}
238EXPORT_SYMBOL(i2c_verify_client);
239
240
David Brownell9c1600e2007-05-01 23:26:31 +0200241/**
242 * i2c_new_device - instantiate an i2c device for use with a new style driver
243 * @adap: the adapter managing the device
244 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200245 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200246 *
247 * Create a device to work with a new style i2c driver, where binding is
248 * handled through driver model probe()/remove() methods. This call is not
249 * appropriate for use by mainboad initialization logic, which usually runs
250 * during an arch_initcall() long before any i2c_adapter could exist.
251 *
252 * This returns the new i2c client, which may be saved for later use with
253 * i2c_unregister_device(); or NULL to indicate an error.
254 */
255struct i2c_client *
256i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
257{
258 struct i2c_client *client;
259 int status;
260
261 client = kzalloc(sizeof *client, GFP_KERNEL);
262 if (!client)
263 return NULL;
264
265 client->adapter = adap;
266
267 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200268
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200269 if (info->archdata)
270 client->dev.archdata = *info->archdata;
271
Marc Pignatee354252008-08-28 08:33:22 +0200272 client->flags = info->flags;
David Brownell9c1600e2007-05-01 23:26:31 +0200273 client->addr = info->addr;
274 client->irq = info->irq;
275
David Brownell9c1600e2007-05-01 23:26:31 +0200276 strlcpy(client->name, info->type, sizeof(client->name));
277
278 /* a new style driver may be bound to this device when we
279 * return from this function, or any later moment (e.g. maybe
280 * hotplugging will load the driver module). and the device
281 * refcount model is the standard driver model one.
282 */
283 status = i2c_attach_client(client);
284 if (status < 0) {
285 kfree(client);
286 client = NULL;
287 }
288 return client;
289}
290EXPORT_SYMBOL_GPL(i2c_new_device);
291
292
293/**
294 * i2c_unregister_device - reverse effect of i2c_new_device()
295 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200296 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200297 */
298void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200299{
300 struct i2c_adapter *adapter = client->adapter;
301 struct i2c_driver *driver = client->driver;
302
303 if (driver && !is_newstyle_driver(driver)) {
304 dev_err(&client->dev, "can't unregister devices "
305 "with legacy drivers\n");
306 WARN_ON(1);
307 return;
308 }
309
Jean Delvare85081592008-07-14 22:38:36 +0200310 if (adapter->client_unregister) {
311 if (adapter->client_unregister(client)) {
312 dev_warn(&client->dev,
313 "client_unregister [%s] failed\n",
314 client->name);
315 }
316 }
317
David Brownella1d9e6e2007-05-01 23:26:30 +0200318 mutex_lock(&adapter->clist_lock);
319 list_del(&client->list);
320 mutex_unlock(&adapter->clist_lock);
321
322 device_unregister(&client->dev);
323}
David Brownell9c1600e2007-05-01 23:26:31 +0200324EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200325
326
Jean Delvare60b129d2008-05-11 20:37:06 +0200327static const struct i2c_device_id dummy_id[] = {
328 { "dummy", 0 },
329 { },
330};
331
Jean Delvared2653e92008-04-29 23:11:39 +0200332static int dummy_probe(struct i2c_client *client,
333 const struct i2c_device_id *id)
334{
335 return 0;
336}
337
338static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100339{
340 return 0;
341}
342
343static struct i2c_driver dummy_driver = {
344 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200345 .probe = dummy_probe,
346 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200347 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100348};
349
350/**
351 * i2c_new_dummy - return a new i2c device bound to a dummy driver
352 * @adapter: the adapter managing the device
353 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100354 * Context: can sleep
355 *
356 * This returns an I2C client bound to the "dummy" driver, intended for use
357 * with devices that consume multiple addresses. Examples of such chips
358 * include various EEPROMS (like 24c04 and 24c08 models).
359 *
360 * These dummy devices have two main uses. First, most I2C and SMBus calls
361 * except i2c_transfer() need a client handle; the dummy will be that handle.
362 * And second, this prevents the specified address from being bound to a
363 * different driver.
364 *
365 * This returns the new i2c client, which should be saved for later use with
366 * i2c_unregister_device(); or NULL to indicate an error.
367 */
368struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200369i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100370{
371 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200372 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100373 };
374
David Brownelle9f13732008-01-27 18:14:52 +0100375 return i2c_new_device(adapter, &info);
376}
377EXPORT_SYMBOL_GPL(i2c_new_dummy);
378
David Brownellf37dd802007-02-13 22:09:00 +0100379/* ------------------------------------------------------------------------- */
380
David Brownell16ffadf2007-05-01 23:26:28 +0200381/* I2C bus adapters -- one roots each I2C or SMBUS segment */
382
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200383static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384{
David Brownellef2c83212007-05-01 23:26:28 +0200385 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 complete(&adap->dev_released);
387}
388
David Brownell16ffadf2007-05-01 23:26:28 +0200389static ssize_t
390show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391{
David Brownellef2c83212007-05-01 23:26:28 +0200392 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 return sprintf(buf, "%s\n", adap->name);
394}
David Brownell16ffadf2007-05-01 23:26:28 +0200395
396static struct device_attribute i2c_adapter_attrs[] = {
397 __ATTR(name, S_IRUGO, show_adapter_name, NULL),
398 { },
399};
400
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200401static struct class i2c_adapter_class = {
David Brownell16ffadf2007-05-01 23:26:28 +0200402 .owner = THIS_MODULE,
403 .name = "i2c-adapter",
404 .dev_attrs = i2c_adapter_attrs,
405};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
David Brownell9c1600e2007-05-01 23:26:31 +0200407static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
408{
409 struct i2c_devinfo *devinfo;
410
411 mutex_lock(&__i2c_board_lock);
412 list_for_each_entry(devinfo, &__i2c_board_list, list) {
413 if (devinfo->busnum == adapter->nr
414 && !i2c_new_device(adapter,
415 &devinfo->board_info))
416 printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
417 i2c_adapter_id(adapter),
418 devinfo->board_info.addr);
419 }
420 mutex_unlock(&__i2c_board_lock);
421}
422
Jean Delvare026526f2008-01-27 18:14:49 +0100423static int i2c_do_add_adapter(struct device_driver *d, void *data)
424{
425 struct i2c_driver *driver = to_i2c_driver(d);
426 struct i2c_adapter *adap = data;
427
Jean Delvare4735c982008-07-14 22:38:36 +0200428 /* Detect supported devices on that bus, and instantiate them */
429 i2c_detect(adap, driver);
430
431 /* Let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +0100432 if (driver->attach_adapter) {
433 /* We ignore the return code; if it fails, too bad */
434 driver->attach_adapter(adap);
435 }
436 return 0;
437}
438
David Brownell6e13e642007-05-01 23:26:31 +0200439static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
Jean Delvare026526f2008-01-27 18:14:49 +0100441 int res = 0, dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
David Brownell1d0b19c2008-10-14 17:30:05 +0200443 /* Can't register until after driver model init */
444 if (unlikely(WARN_ON(!i2c_bus_type.p)))
445 return -EAGAIN;
446
Ingo Molnar5c085d32006-01-18 23:16:04 +0100447 mutex_init(&adap->bus_lock);
448 mutex_init(&adap->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 INIT_LIST_HEAD(&adap->clients);
450
Jean Delvarecaada322008-01-27 18:14:49 +0100451 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200452
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 /* Add the adapter to the driver core.
454 * If the parent pointer is not set up,
455 * we add this adapter to the host bus.
456 */
David Brownellb119dc32007-01-04 13:07:04 +0100457 if (adap->dev.parent == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 adap->dev.parent = &platform_bus;
Jean Delvarefe2c8d52007-02-13 22:09:04 +0100459 pr_debug("I2C adapter driver [%s] forgot to specify "
460 "physical device\n", adap->name);
David Brownellb119dc32007-01-04 13:07:04 +0100461 }
Kay Sievers27d9c182009-01-07 14:29:16 +0100462 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 adap->dev.release = &i2c_adapter_dev_release;
Jean Delvarefccb56e2007-05-01 23:26:27 +0200464 adap->dev.class = &i2c_adapter_class;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200465 res = device_register(&adap->dev);
466 if (res)
467 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200469 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
470
David Brownell6e13e642007-05-01 23:26:31 +0200471 /* create pre-declared device nodes for new-style drivers */
472 if (adap->nr < __i2c_first_dynamic_bus_num)
473 i2c_scan_static_board_info(adap);
474
Jean Delvare4735c982008-07-14 22:38:36 +0200475 /* Notify drivers */
Jean Delvare026526f2008-01-27 18:14:49 +0100476 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
477 i2c_do_add_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100480 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 return res;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200482
Jean Delvareb119c6c2006-08-15 18:26:30 +0200483out_list:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200484 idr_remove(&i2c_adapter_idr, adap->nr);
485 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487
David Brownell6e13e642007-05-01 23:26:31 +0200488/**
489 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
490 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +0200491 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200492 *
493 * This routine is used to declare an I2C adapter when its bus number
494 * doesn't matter. Examples: for I2C adapters dynamically added by
495 * USB links or PCI plugin cards.
496 *
497 * When this returns zero, a new bus number was allocated and stored
498 * in adap->nr, and the specified adapter became available for clients.
499 * Otherwise, a negative errno value is returned.
500 */
501int i2c_add_adapter(struct i2c_adapter *adapter)
502{
503 int id, res = 0;
504
505retry:
506 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
507 return -ENOMEM;
508
Jean Delvarecaada322008-01-27 18:14:49 +0100509 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200510 /* "above" here means "above or equal to", sigh */
511 res = idr_get_new_above(&i2c_adapter_idr, adapter,
512 __i2c_first_dynamic_bus_num, &id);
Jean Delvarecaada322008-01-27 18:14:49 +0100513 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200514
515 if (res < 0) {
516 if (res == -EAGAIN)
517 goto retry;
518 return res;
519 }
520
521 adapter->nr = id;
522 return i2c_register_adapter(adapter);
523}
524EXPORT_SYMBOL(i2c_add_adapter);
525
526/**
527 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
528 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +0200529 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200530 *
531 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +0100532 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
533 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +0200534 * is used to properly configure I2C devices.
535 *
536 * If no devices have pre-been declared for this bus, then be sure to
537 * register the adapter before any dynamically allocated ones. Otherwise
538 * the required bus ID may not be available.
539 *
540 * When this returns zero, the specified adapter became available for
541 * clients using the bus number provided in adap->nr. Also, the table
542 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
543 * and the appropriate driver model device nodes are created. Otherwise, a
544 * negative errno value is returned.
545 */
546int i2c_add_numbered_adapter(struct i2c_adapter *adap)
547{
548 int id;
549 int status;
550
551 if (adap->nr & ~MAX_ID_MASK)
552 return -EINVAL;
553
554retry:
555 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
556 return -ENOMEM;
557
Jean Delvarecaada322008-01-27 18:14:49 +0100558 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200559 /* "above" here means "above or equal to", sigh;
560 * we need the "equal to" result to force the result
561 */
562 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
563 if (status == 0 && id != adap->nr) {
564 status = -EBUSY;
565 idr_remove(&i2c_adapter_idr, id);
566 }
Jean Delvarecaada322008-01-27 18:14:49 +0100567 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200568 if (status == -EAGAIN)
569 goto retry;
570
571 if (status == 0)
572 status = i2c_register_adapter(adap);
573 return status;
574}
575EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
576
Jean Delvare026526f2008-01-27 18:14:49 +0100577static int i2c_do_del_adapter(struct device_driver *d, void *data)
578{
579 struct i2c_driver *driver = to_i2c_driver(d);
580 struct i2c_adapter *adapter = data;
Jean Delvare4735c982008-07-14 22:38:36 +0200581 struct i2c_client *client, *_n;
Jean Delvare026526f2008-01-27 18:14:49 +0100582 int res;
583
Jean Delvareacec2112009-03-28 21:34:40 +0100584 /* Remove the devices we created ourselves as the result of hardware
585 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +0200586 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
587 if (client->adapter == adapter) {
588 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
589 client->name, client->addr);
590 list_del(&client->detected);
591 i2c_unregister_device(client);
592 }
593 }
594
Jean Delvare026526f2008-01-27 18:14:49 +0100595 if (!driver->detach_adapter)
596 return 0;
597 res = driver->detach_adapter(adapter);
598 if (res)
599 dev_err(&adapter->dev, "detach_adapter failed (%d) "
600 "for driver [%s]\n", res, driver->driver.name);
601 return res;
602}
603
David Brownelld64f73b2007-07-12 14:12:28 +0200604/**
605 * i2c_del_adapter - unregister I2C adapter
606 * @adap: the adapter being unregistered
607 * Context: can sleep
608 *
609 * This unregisters an I2C adapter which was previously registered
610 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
611 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612int i2c_del_adapter(struct i2c_adapter *adap)
613{
Matthias Kaehlcke6a03cd92008-07-14 22:38:26 +0200614 struct i2c_client *client, *_n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 int res = 0;
616
Jean Delvarecaada322008-01-27 18:14:49 +0100617 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619 /* First make sure that this adapter was ever added */
Jean Delvare87c6c222008-01-27 18:14:48 +0100620 if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200621 pr_debug("i2c-core: attempting to delete unregistered "
622 "adapter [%s]\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 res = -EINVAL;
624 goto out_unlock;
625 }
626
Jean Delvare026526f2008-01-27 18:14:49 +0100627 /* Tell drivers about this removal */
628 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
629 i2c_do_del_adapter);
630 if (res)
631 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633 /* detach any active clients. This must be done first, because
Tobias Klausera551acc2005-05-19 21:40:38 +0200634 * it can fail; in which case we give up. */
Jean Delvare79b93e12008-11-28 15:24:38 +0100635 list_for_each_entry_safe_reverse(client, _n, &adap->clients, list) {
David Brownella1d9e6e2007-05-01 23:26:30 +0200636 struct i2c_driver *driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
David Brownella1d9e6e2007-05-01 23:26:30 +0200638 driver = client->driver;
639
640 /* new style, follow standard driver model */
641 if (!driver || is_newstyle_driver(driver)) {
642 i2c_unregister_device(client);
643 continue;
644 }
645
646 /* legacy drivers create and remove clients themselves */
647 if ((res = driver->detach_client(client))) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200648 dev_err(&adap->dev, "detach_client failed for client "
649 "[%s] at address 0x%02x\n", client->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 client->addr);
651 goto out_unlock;
652 }
653 }
654
655 /* clean up the sysfs representation */
656 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
659 /* wait for sysfs to drop all references */
660 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
David Brownell6e13e642007-05-01 23:26:31 +0200662 /* free bus id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 idr_remove(&i2c_adapter_idr, adap->nr);
664
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200665 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
Jean Delvarebd4bc3db2008-07-16 19:30:05 +0200667 /* Clear the device structure in case this adapter is ever going to be
668 added again */
669 memset(&adap->dev, 0, sizeof(adap->dev));
670
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 out_unlock:
Jean Delvarecaada322008-01-27 18:14:49 +0100672 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 return res;
674}
David Brownellc0564602007-05-01 23:26:31 +0200675EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
677
David Brownell7b4fbc52007-05-01 23:26:30 +0200678/* ------------------------------------------------------------------------- */
679
Dave Young7f101a92008-07-14 22:38:19 +0200680static int __attach_adapter(struct device *dev, void *data)
681{
682 struct i2c_adapter *adapter = to_i2c_adapter(dev);
683 struct i2c_driver *driver = data;
684
Jean Delvare4735c982008-07-14 22:38:36 +0200685 i2c_detect(adapter, driver);
686
687 /* Legacy drivers scan i2c busses directly */
688 if (driver->attach_adapter)
689 driver->attach_adapter(adapter);
Dave Young7f101a92008-07-14 22:38:19 +0200690
691 return 0;
692}
693
David Brownell7b4fbc52007-05-01 23:26:30 +0200694/*
695 * An i2c_driver is used with one or more i2c_client (device) nodes to access
696 * i2c slave chips, on a bus instance associated with some i2c_adapter. There
697 * are two models for binding the driver to its device: "new style" drivers
698 * follow the standard Linux driver model and just respond to probe() calls
699 * issued if the driver core sees they match(); "legacy" drivers create device
700 * nodes themselves.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 */
702
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800703int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
Jean Delvare7eebcb72006-02-05 23:28:21 +0100705 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
David Brownell1d0b19c2008-10-14 17:30:05 +0200707 /* Can't register until after driver model init */
708 if (unlikely(WARN_ON(!i2c_bus_type.p)))
709 return -EAGAIN;
710
David Brownell7b4fbc52007-05-01 23:26:30 +0200711 /* new style driver methods can't mix with legacy ones */
David Brownella1d9e6e2007-05-01 23:26:30 +0200712 if (is_newstyle_driver(driver)) {
David Brownell7b4fbc52007-05-01 23:26:30 +0200713 if (driver->attach_adapter || driver->detach_adapter
714 || driver->detach_client) {
715 printk(KERN_WARNING
716 "i2c-core: driver [%s] is confused\n",
717 driver->driver.name);
718 return -EINVAL;
719 }
720 }
721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800723 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
David Brownell6e13e642007-05-01 23:26:31 +0200726 /* for new style drivers, when registration returns the driver core
727 * will have called probe() for all matching-but-unbound devices.
728 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 res = driver_register(&driver->driver);
730 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +0100731 return res;
David Brownell438d6c22006-12-10 21:21:31 +0100732
Jean Delvarecaada322008-01-27 18:14:49 +0100733 mutex_lock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100734
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100735 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Jean Delvare4735c982008-07-14 22:38:36 +0200737 INIT_LIST_HEAD(&driver->clients);
738 /* Walk the adapters that are already present */
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400739 class_for_each_device(&i2c_adapter_class, NULL, driver,
740 __attach_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
Jean Delvarecaada322008-01-27 18:14:49 +0100742 mutex_unlock(&core_lock);
Jean Delvare7eebcb72006-02-05 23:28:21 +0100743 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800745EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
Dave Young7f101a92008-07-14 22:38:19 +0200747static int __detach_adapter(struct device *dev, void *data)
748{
749 struct i2c_adapter *adapter = to_i2c_adapter(dev);
750 struct i2c_driver *driver = data;
Jean Delvare4735c982008-07-14 22:38:36 +0200751 struct i2c_client *client, *_n;
752
Jean Delvareacec2112009-03-28 21:34:40 +0100753 /* Remove the devices we created ourselves as the result of hardware
754 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +0200755 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
756 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
757 client->name, client->addr);
758 list_del(&client->detected);
759 i2c_unregister_device(client);
760 }
761
762 if (is_newstyle_driver(driver))
763 return 0;
Dave Young7f101a92008-07-14 22:38:19 +0200764
765 /* Have a look at each adapter, if clients of this driver are still
766 * attached. If so, detach them to be able to kill the driver
767 * afterwards.
768 */
769 if (driver->detach_adapter) {
770 if (driver->detach_adapter(adapter))
771 dev_err(&adapter->dev,
772 "detach_adapter failed for driver [%s]\n",
773 driver->driver.name);
774 } else {
Matthias Kaehlcke6a03cd92008-07-14 22:38:26 +0200775 struct i2c_client *client, *_n;
Dave Young7f101a92008-07-14 22:38:19 +0200776
Matthias Kaehlcke6a03cd92008-07-14 22:38:26 +0200777 list_for_each_entry_safe(client, _n, &adapter->clients, list) {
Dave Young7f101a92008-07-14 22:38:19 +0200778 if (client->driver != driver)
779 continue;
780 dev_dbg(&adapter->dev,
781 "detaching client [%s] at 0x%02x\n",
782 client->name, client->addr);
783 if (driver->detach_client(client))
784 dev_err(&adapter->dev, "detach_client "
785 "failed for client [%s] at 0x%02x\n",
786 client->name, client->addr);
787 }
788 }
789
790 return 0;
791}
792
David Brownella1d9e6e2007-05-01 23:26:30 +0200793/**
794 * i2c_del_driver - unregister I2C driver
795 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +0200796 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +0200797 */
Jean Delvareb3e82092007-05-01 23:26:32 +0200798void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
Jean Delvarecaada322008-01-27 18:14:49 +0100800 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400802 class_for_each_device(&i2c_adapter_class, NULL, driver,
803 __detach_adapter);
David Brownella1d9e6e2007-05-01 23:26:30 +0200804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100806 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
Jean Delvarecaada322008-01-27 18:14:49 +0100808 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809}
David Brownellc0564602007-05-01 23:26:31 +0200810EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
David Brownell7b4fbc52007-05-01 23:26:30 +0200812/* ------------------------------------------------------------------------- */
813
David Brownell9b766b82008-01-27 18:14:51 +0100814static int __i2c_check_addr(struct device *dev, void *addrp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815{
David Brownell9b766b82008-01-27 18:14:51 +0100816 struct i2c_client *client = i2c_verify_client(dev);
817 int addr = *(int *)addrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
David Brownell9b766b82008-01-27 18:14:51 +0100819 if (client && client->addr == addr)
820 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 return 0;
822}
823
Jean Delvare5e31c2b2007-11-15 19:24:02 +0100824static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825{
David Brownell9b766b82008-01-27 18:14:51 +0100826 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827}
828
829int i2c_attach_client(struct i2c_client *client)
830{
831 struct i2c_adapter *adapter = client->adapter;
Jean Delvarec1159f92008-08-10 22:56:16 +0200832 int res;
833
834 /* Check for address business */
835 res = i2c_check_addr(adapter, client->addr);
836 if (res)
837 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 client->dev.parent = &client->adapter->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 client->dev.bus = &i2c_bus_type;
David Brownell9c1600e2007-05-01 23:26:31 +0200841
842 if (client->driver)
843 client->dev.driver = &client->driver->driver;
844
David Brownellde81d2a2007-05-22 19:49:16 +0200845 if (client->driver && !is_newstyle_driver(client->driver)) {
David Brownell9c1600e2007-05-01 23:26:31 +0200846 client->dev.release = i2c_client_release;
Ming Leif67f1292009-03-01 21:10:49 +0800847 dev_set_uevent_suppress(&client->dev, 1);
David Brownellde81d2a2007-05-22 19:49:16 +0200848 } else
David Brownell9c1600e2007-05-01 23:26:31 +0200849 client->dev.release = i2c_client_dev_release;
David Brownell438d6c22006-12-10 21:21:31 +0100850
Kay Sievers27d9c182009-01-07 14:29:16 +0100851 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adapter),
852 client->addr);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200853 res = device_register(&client->dev);
854 if (res)
David Brownell86ec5ec2008-01-27 18:14:51 +0100855 goto out_err;
856
857 mutex_lock(&adapter->clist_lock);
858 list_add_tail(&client->list, &adapter->clients);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200859 mutex_unlock(&adapter->clist_lock);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200860
David Brownell86ec5ec2008-01-27 18:14:51 +0100861 dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
Kay Sievers27d9c182009-01-07 14:29:16 +0100862 client->name, dev_name(&client->dev));
David Brownell86ec5ec2008-01-27 18:14:51 +0100863
Jean Delvare77ed74d2006-09-30 17:18:59 +0200864 if (adapter->client_register) {
865 if (adapter->client_register(client)) {
866 dev_dbg(&adapter->dev, "client_register "
867 "failed for client [%s] at 0x%02x\n",
868 client->name, client->addr);
869 }
870 }
871
872 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200873
David Brownell86ec5ec2008-01-27 18:14:51 +0100874out_err:
Jean Delvareb119c6c2006-08-15 18:26:30 +0200875 dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
876 "(%d)\n", client->name, client->addr, res);
Jean Delvare77ed74d2006-09-30 17:18:59 +0200877 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878}
David Brownellc0564602007-05-01 23:26:31 +0200879EXPORT_SYMBOL(i2c_attach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
881int i2c_detach_client(struct i2c_client *client)
882{
883 struct i2c_adapter *adapter = client->adapter;
884 int res = 0;
David Brownell438d6c22006-12-10 21:21:31 +0100885
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 if (adapter->client_unregister) {
887 res = adapter->client_unregister(client);
888 if (res) {
889 dev_err(&client->dev,
Jean Delvare86749e82005-07-29 12:15:29 -0700890 "client_unregister [%s] failed, "
891 "client not detached\n", client->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 goto out;
893 }
894 }
895
Ingo Molnar5c085d32006-01-18 23:16:04 +0100896 mutex_lock(&adapter->clist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 list_del(&client->list);
Jean Delvare9ddced12008-01-27 18:14:51 +0100898 mutex_unlock(&adapter->clist_lock);
899
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 init_completion(&client->released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 device_unregister(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 wait_for_completion(&client->released);
903
904 out:
905 return res;
906}
David Brownellc0564602007-05-01 23:26:31 +0200907EXPORT_SYMBOL(i2c_detach_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
Jean Delvaree48d3312008-01-27 18:14:48 +0100909/**
910 * i2c_use_client - increments the reference count of the i2c client structure
911 * @client: the client being referenced
912 *
913 * Each live reference to a client should be refcounted. The driver model does
914 * that automatically as part of driver binding, so that most drivers don't
915 * need to do this explicitly: they hold a reference until they're unbound
916 * from the device.
917 *
918 * A pointer to the client with the incremented reference counter is returned.
919 */
920struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921{
David Brownell6ea438e2008-07-14 22:38:24 +0200922 if (client && get_device(&client->dev))
923 return client;
924 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925}
David Brownellc0564602007-05-01 23:26:31 +0200926EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Jean Delvaree48d3312008-01-27 18:14:48 +0100928/**
929 * i2c_release_client - release a use of the i2c client structure
930 * @client: the client being no longer referenced
931 *
932 * Must be called when a user of a client is finished with it.
933 */
934void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935{
David Brownell6ea438e2008-07-14 22:38:24 +0200936 if (client)
937 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938}
David Brownellc0564602007-05-01 23:26:31 +0200939EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
David Brownell9b766b82008-01-27 18:14:51 +0100941struct i2c_cmd_arg {
942 unsigned cmd;
943 void *arg;
944};
945
946static int i2c_cmd(struct device *dev, void *_arg)
947{
948 struct i2c_client *client = i2c_verify_client(dev);
949 struct i2c_cmd_arg *arg = _arg;
950
951 if (client && client->driver && client->driver->command)
952 client->driver->command(client, arg->cmd, arg->arg);
953 return 0;
954}
955
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
957{
David Brownell9b766b82008-01-27 18:14:51 +0100958 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
David Brownell9b766b82008-01-27 18:14:51 +0100960 cmd_arg.cmd = cmd;
961 cmd_arg.arg = arg;
962 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963}
David Brownellc0564602007-05-01 23:26:31 +0200964EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966static int __init i2c_init(void)
967{
968 int retval;
969
970 retval = bus_register(&i2c_bus_type);
971 if (retval)
972 return retval;
David Brownelle9f13732008-01-27 18:14:52 +0100973 retval = class_register(&i2c_adapter_class);
974 if (retval)
975 goto bus_err;
976 retval = i2c_add_driver(&dummy_driver);
977 if (retval)
978 goto class_err;
979 return 0;
980
981class_err:
982 class_unregister(&i2c_adapter_class);
983bus_err:
984 bus_unregister(&i2c_bus_type);
985 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986}
987
988static void __exit i2c_exit(void)
989{
David Brownelle9f13732008-01-27 18:14:52 +0100990 i2c_del_driver(&dummy_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 class_unregister(&i2c_adapter_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 bus_unregister(&i2c_bus_type);
993}
994
David Brownella10f9e72008-10-14 17:30:06 +0200995/* We must initialize early, because some subsystems register i2c drivers
996 * in subsys_initcall() code, but are linked (and initialized) before i2c.
997 */
998postcore_initcall(i2c_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999module_exit(i2c_exit);
1000
1001/* ----------------------------------------------------
1002 * the functional interface to the i2c busses.
1003 * ----------------------------------------------------
1004 */
1005
David Brownella1cdeda2008-07-14 22:38:24 +02001006/**
1007 * i2c_transfer - execute a single or combined I2C message
1008 * @adap: Handle to I2C bus
1009 * @msgs: One or more messages to execute before STOP is issued to
1010 * terminate the operation; each message begins with a START.
1011 * @num: Number of messages to be executed.
1012 *
1013 * Returns negative errno, else the number of messages executed.
1014 *
1015 * Note that there is no requirement that each message be sent to
1016 * the same slave address, although that is the most common model.
1017 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
1019{
1020 int ret;
1021
David Brownella1cdeda2008-07-14 22:38:24 +02001022 /* REVISIT the fault reporting model here is weak:
1023 *
1024 * - When we get an error after receiving N bytes from a slave,
1025 * there is no way to report "N".
1026 *
1027 * - When we get a NAK after transmitting N bytes to a slave,
1028 * there is no way to report "N" ... or to let the master
1029 * continue executing the rest of this combined message, if
1030 * that's the appropriate response.
1031 *
1032 * - When for example "num" is two and we successfully complete
1033 * the first message but get an error part way through the
1034 * second, it's unclear whether that should be reported as
1035 * one (discarding status on the second message) or errno
1036 * (discarding status on the first one).
1037 */
1038
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 if (adap->algo->master_xfer) {
1040#ifdef DEBUG
1041 for (ret = 0; ret < num; ret++) {
1042 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +02001043 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1044 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1045 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 }
1047#endif
1048
Mike Rapoportcea443a2008-01-27 18:14:50 +01001049 if (in_atomic() || irqs_disabled()) {
1050 ret = mutex_trylock(&adap->bus_lock);
1051 if (!ret)
1052 /* I2C activity is ongoing. */
1053 return -EAGAIN;
1054 } else {
1055 mutex_lock_nested(&adap->bus_lock, adap->level);
1056 }
1057
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 ret = adap->algo->master_xfer(adap,msgs,num);
Ingo Molnar5c085d32006-01-18 23:16:04 +01001059 mutex_unlock(&adap->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060
1061 return ret;
1062 } else {
1063 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001064 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 }
1066}
David Brownellc0564602007-05-01 23:26:31 +02001067EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068
David Brownella1cdeda2008-07-14 22:38:24 +02001069/**
1070 * i2c_master_send - issue a single I2C message in master transmit mode
1071 * @client: Handle to slave device
1072 * @buf: Data that will be written to the slave
1073 * @count: How many bytes to write
1074 *
1075 * Returns negative errno, or else the number of bytes written.
1076 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1078{
1079 int ret;
1080 struct i2c_adapter *adap=client->adapter;
1081 struct i2c_msg msg;
1082
Jean Delvare815f55f2005-05-07 22:58:46 +02001083 msg.addr = client->addr;
1084 msg.flags = client->flags & I2C_M_TEN;
1085 msg.len = count;
1086 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01001087
Jean Delvare815f55f2005-05-07 22:58:46 +02001088 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
Jean Delvare815f55f2005-05-07 22:58:46 +02001090 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1091 transmitted, else error code. */
1092 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093}
David Brownellc0564602007-05-01 23:26:31 +02001094EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
David Brownella1cdeda2008-07-14 22:38:24 +02001096/**
1097 * i2c_master_recv - issue a single I2C message in master receive mode
1098 * @client: Handle to slave device
1099 * @buf: Where to store data read from slave
1100 * @count: How many bytes to read
1101 *
1102 * Returns negative errno, or else the number of bytes read.
1103 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1105{
1106 struct i2c_adapter *adap=client->adapter;
1107 struct i2c_msg msg;
1108 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
Jean Delvare815f55f2005-05-07 22:58:46 +02001110 msg.addr = client->addr;
1111 msg.flags = client->flags & I2C_M_TEN;
1112 msg.flags |= I2C_M_RD;
1113 msg.len = count;
1114 msg.buf = buf;
1115
1116 ret = i2c_transfer(adap, &msg, 1);
1117
1118 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1119 transmitted, else error code. */
1120 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121}
David Brownellc0564602007-05-01 23:26:31 +02001122EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124/* ----------------------------------------------------
1125 * the i2c address scanning function
1126 * Will not work for 10-bit addresses!
1127 * ----------------------------------------------------
1128 */
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001129static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
1130 int (*found_proc) (struct i2c_adapter *, int, int))
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001131{
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001132 int err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001133
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001134 /* Make sure the address is valid */
1135 if (addr < 0x03 || addr > 0x77) {
1136 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1137 addr);
1138 return -EINVAL;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001139 }
1140
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001141 /* Skip if already in use */
1142 if (i2c_check_addr(adapter, addr))
1143 return 0;
1144
1145 /* Make sure there is something at this address, unless forced */
Jean Delvare4c9337d2005-08-09 20:28:10 +02001146 if (kind < 0) {
1147 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1148 I2C_SMBUS_QUICK, NULL) < 0)
1149 return 0;
1150
1151 /* prevent 24RF08 corruption */
1152 if ((addr & ~0x0f) == 0x50)
1153 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1154 I2C_SMBUS_QUICK, NULL);
1155 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001156
1157 /* Finally call the custom detection function */
1158 err = found_proc(adapter, addr, kind);
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001159 /* -ENODEV can be returned if there is a chip at the given address
1160 but it isn't supported by this chip driver. We catch it here as
1161 this isn't an error. */
Jean Delvare114fd182006-09-03 22:25:04 +02001162 if (err == -ENODEV)
1163 err = 0;
1164
1165 if (err)
1166 dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
1167 addr, err);
1168 return err;
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001169}
1170
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171int i2c_probe(struct i2c_adapter *adapter,
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +01001172 const struct i2c_client_address_data *address_data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 int (*found_proc) (struct i2c_adapter *, int, int))
1174{
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001175 int i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 int adap_id = i2c_adapter_id(adapter);
1177
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001178 /* Force entries are done first, and are not affected by ignore
1179 entries */
1180 if (address_data->forces) {
Mark M. Hoffmanbfb6df22008-01-27 18:14:46 +01001181 const unsigned short * const *forces = address_data->forces;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001182 int kind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001184 for (kind = 0; forces[kind]; kind++) {
1185 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1186 i += 2) {
1187 if (forces[kind][i] == adap_id
1188 || forces[kind][i] == ANY_I2C_BUS) {
1189 dev_dbg(&adapter->dev, "found force "
1190 "parameter for adapter %d, "
1191 "addr 0x%02x, kind %d\n",
1192 adap_id, forces[kind][i + 1],
1193 kind);
1194 err = i2c_probe_address(adapter,
1195 forces[kind][i + 1],
1196 kind, found_proc);
1197 if (err)
1198 return err;
1199 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 }
1201 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001203
Jean Delvare4366dc92005-09-25 16:50:06 +02001204 /* Stop here if we can't use SMBUS_QUICK */
1205 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1206 if (address_data->probe[0] == I2C_CLIENT_END
1207 && address_data->normal_i2c[0] == I2C_CLIENT_END)
David Brownell438d6c22006-12-10 21:21:31 +01001208 return 0;
Jean Delvare4366dc92005-09-25 16:50:06 +02001209
Jean Delvare4329cf82008-08-28 08:33:23 +02001210 dev_dbg(&adapter->dev, "SMBus Quick command not supported, "
1211 "can't probe for chips\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001212 return -EOPNOTSUPP;
Jean Delvare4366dc92005-09-25 16:50:06 +02001213 }
1214
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001215 /* Probe entries are done second, and are not affected by ignore
1216 entries either */
1217 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1218 if (address_data->probe[i] == adap_id
1219 || address_data->probe[i] == ANY_I2C_BUS) {
1220 dev_dbg(&adapter->dev, "found probe parameter for "
1221 "adapter %d, addr 0x%02x\n", adap_id,
1222 address_data->probe[i + 1]);
1223 err = i2c_probe_address(adapter,
1224 address_data->probe[i + 1],
1225 -1, found_proc);
1226 if (err)
1227 return err;
1228 }
1229 }
1230
1231 /* Normal entries are done last, unless shadowed by an ignore entry */
1232 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1233 int j, ignore;
1234
1235 ignore = 0;
1236 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1237 j += 2) {
1238 if ((address_data->ignore[j] == adap_id ||
1239 address_data->ignore[j] == ANY_I2C_BUS)
1240 && address_data->ignore[j + 1]
1241 == address_data->normal_i2c[i]) {
1242 dev_dbg(&adapter->dev, "found ignore "
1243 "parameter for adapter %d, "
1244 "addr 0x%02x\n", adap_id,
1245 address_data->ignore[j + 1]);
Mark M. Hoffman2369df92006-07-01 17:01:59 +02001246 ignore = 1;
1247 break;
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001248 }
Jean Delvarea89ba0b2005-08-09 20:17:55 +02001249 }
1250 if (ignore)
1251 continue;
1252
1253 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1254 "addr 0x%02x\n", adap_id,
1255 address_data->normal_i2c[i]);
1256 err = i2c_probe_address(adapter, address_data->normal_i2c[i],
1257 -1, found_proc);
1258 if (err)
1259 return err;
1260 }
1261
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 return 0;
1263}
David Brownellc0564602007-05-01 23:26:31 +02001264EXPORT_SYMBOL(i2c_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
Jean Delvare4735c982008-07-14 22:38:36 +02001266/* Separate detection function for new-style drivers */
1267static int i2c_detect_address(struct i2c_client *temp_client, int kind,
1268 struct i2c_driver *driver)
1269{
1270 struct i2c_board_info info;
1271 struct i2c_adapter *adapter = temp_client->adapter;
1272 int addr = temp_client->addr;
1273 int err;
1274
1275 /* Make sure the address is valid */
1276 if (addr < 0x03 || addr > 0x77) {
1277 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1278 addr);
1279 return -EINVAL;
1280 }
1281
1282 /* Skip if already in use */
1283 if (i2c_check_addr(adapter, addr))
1284 return 0;
1285
1286 /* Make sure there is something at this address, unless forced */
1287 if (kind < 0) {
1288 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1289 I2C_SMBUS_QUICK, NULL) < 0)
1290 return 0;
1291
1292 /* prevent 24RF08 corruption */
1293 if ((addr & ~0x0f) == 0x50)
1294 i2c_smbus_xfer(adapter, addr, 0, 0, 0,
1295 I2C_SMBUS_QUICK, NULL);
1296 }
1297
1298 /* Finally call the custom detection function */
1299 memset(&info, 0, sizeof(struct i2c_board_info));
1300 info.addr = addr;
1301 err = driver->detect(temp_client, kind, &info);
1302 if (err) {
1303 /* -ENODEV is returned if the detection fails. We catch it
1304 here as this isn't an error. */
1305 return err == -ENODEV ? 0 : err;
1306 }
1307
1308 /* Consistency check */
1309 if (info.type[0] == '\0') {
1310 dev_err(&adapter->dev, "%s detection function provided "
1311 "no name for 0x%x\n", driver->driver.name,
1312 addr);
1313 } else {
1314 struct i2c_client *client;
1315
1316 /* Detection succeeded, instantiate the device */
1317 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1318 info.type, info.addr);
1319 client = i2c_new_device(adapter, &info);
1320 if (client)
1321 list_add_tail(&client->detected, &driver->clients);
1322 else
1323 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1324 info.type, info.addr);
1325 }
1326 return 0;
1327}
1328
1329static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1330{
1331 const struct i2c_client_address_data *address_data;
1332 struct i2c_client *temp_client;
1333 int i, err = 0;
1334 int adap_id = i2c_adapter_id(adapter);
1335
1336 address_data = driver->address_data;
1337 if (!driver->detect || !address_data)
1338 return 0;
1339
1340 /* Set up a temporary client to help detect callback */
1341 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1342 if (!temp_client)
1343 return -ENOMEM;
1344 temp_client->adapter = adapter;
1345
1346 /* Force entries are done first, and are not affected by ignore
1347 entries */
1348 if (address_data->forces) {
1349 const unsigned short * const *forces = address_data->forces;
1350 int kind;
1351
1352 for (kind = 0; forces[kind]; kind++) {
1353 for (i = 0; forces[kind][i] != I2C_CLIENT_END;
1354 i += 2) {
1355 if (forces[kind][i] == adap_id
1356 || forces[kind][i] == ANY_I2C_BUS) {
1357 dev_dbg(&adapter->dev, "found force "
1358 "parameter for adapter %d, "
1359 "addr 0x%02x, kind %d\n",
1360 adap_id, forces[kind][i + 1],
1361 kind);
1362 temp_client->addr = forces[kind][i + 1];
1363 err = i2c_detect_address(temp_client,
1364 kind, driver);
1365 if (err)
1366 goto exit_free;
1367 }
1368 }
1369 }
1370 }
1371
Jean Delvare4329cf82008-08-28 08:33:23 +02001372 /* Stop here if the classes do not match */
1373 if (!(adapter->class & driver->class))
1374 goto exit_free;
1375
Jean Delvare4735c982008-07-14 22:38:36 +02001376 /* Stop here if we can't use SMBUS_QUICK */
1377 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
1378 if (address_data->probe[0] == I2C_CLIENT_END
1379 && address_data->normal_i2c[0] == I2C_CLIENT_END)
1380 goto exit_free;
1381
1382 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1383 "can't probe for chips\n");
1384 err = -EOPNOTSUPP;
1385 goto exit_free;
1386 }
1387
Jean Delvare4735c982008-07-14 22:38:36 +02001388 /* Probe entries are done second, and are not affected by ignore
1389 entries either */
1390 for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
1391 if (address_data->probe[i] == adap_id
1392 || address_data->probe[i] == ANY_I2C_BUS) {
1393 dev_dbg(&adapter->dev, "found probe parameter for "
1394 "adapter %d, addr 0x%02x\n", adap_id,
1395 address_data->probe[i + 1]);
1396 temp_client->addr = address_data->probe[i + 1];
1397 err = i2c_detect_address(temp_client, -1, driver);
1398 if (err)
1399 goto exit_free;
1400 }
1401 }
1402
1403 /* Normal entries are done last, unless shadowed by an ignore entry */
1404 for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
1405 int j, ignore;
1406
1407 ignore = 0;
1408 for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
1409 j += 2) {
1410 if ((address_data->ignore[j] == adap_id ||
1411 address_data->ignore[j] == ANY_I2C_BUS)
1412 && address_data->ignore[j + 1]
1413 == address_data->normal_i2c[i]) {
1414 dev_dbg(&adapter->dev, "found ignore "
1415 "parameter for adapter %d, "
1416 "addr 0x%02x\n", adap_id,
1417 address_data->ignore[j + 1]);
1418 ignore = 1;
1419 break;
1420 }
1421 }
1422 if (ignore)
1423 continue;
1424
1425 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
1426 "addr 0x%02x\n", adap_id,
1427 address_data->normal_i2c[i]);
1428 temp_client->addr = address_data->normal_i2c[i];
1429 err = i2c_detect_address(temp_client, -1, driver);
1430 if (err)
1431 goto exit_free;
1432 }
1433
1434 exit_free:
1435 kfree(temp_client);
1436 return err;
1437}
1438
Jean Delvare12b5053a2007-05-01 23:26:31 +02001439struct i2c_client *
1440i2c_new_probed_device(struct i2c_adapter *adap,
1441 struct i2c_board_info *info,
1442 unsigned short const *addr_list)
1443{
1444 int i;
1445
1446 /* Stop here if the bus doesn't support probing */
1447 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1448 dev_err(&adap->dev, "Probing not supported\n");
1449 return NULL;
1450 }
1451
Jean Delvare12b5053a2007-05-01 23:26:31 +02001452 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1453 /* Check address validity */
1454 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1455 dev_warn(&adap->dev, "Invalid 7-bit address "
1456 "0x%02x\n", addr_list[i]);
1457 continue;
1458 }
1459
1460 /* Check address availability */
David Brownell9b766b82008-01-27 18:14:51 +01001461 if (i2c_check_addr(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001462 dev_dbg(&adap->dev, "Address 0x%02x already in "
1463 "use, not probing\n", addr_list[i]);
1464 continue;
1465 }
1466
1467 /* Test address responsiveness
1468 The default probe method is a quick write, but it is known
1469 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1470 and could also irreversibly write-protect some EEPROMs, so
1471 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1472 read instead. Also, some bus drivers don't implement
1473 quick write, so we fallback to a byte read it that case
1474 too. */
1475 if ((addr_list[i] & ~0x07) == 0x30
1476 || (addr_list[i] & ~0x0f) == 0x50
1477 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
Hans Verkuilb25b7912008-08-10 22:56:15 +02001478 union i2c_smbus_data data;
1479
Jean Delvare12b5053a2007-05-01 23:26:31 +02001480 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1481 I2C_SMBUS_READ, 0,
Hans Verkuilb25b7912008-08-10 22:56:15 +02001482 I2C_SMBUS_BYTE, &data) >= 0)
Jean Delvare12b5053a2007-05-01 23:26:31 +02001483 break;
1484 } else {
1485 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1486 I2C_SMBUS_WRITE, 0,
1487 I2C_SMBUS_QUICK, NULL) >= 0)
1488 break;
1489 }
1490 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02001491
1492 if (addr_list[i] == I2C_CLIENT_END) {
1493 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1494 return NULL;
1495 }
1496
1497 info->addr = addr_list[i];
1498 return i2c_new_device(adap, info);
1499}
1500EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502struct i2c_adapter* i2c_get_adapter(int id)
1503{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001505
Jean Delvarecaada322008-01-27 18:14:49 +01001506 mutex_lock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001507 adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
1508 if (adapter && !try_module_get(adapter->owner))
1509 adapter = NULL;
1510
Jean Delvarecaada322008-01-27 18:14:49 +01001511 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001512 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513}
David Brownellc0564602007-05-01 23:26:31 +02001514EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
1516void i2c_put_adapter(struct i2c_adapter *adap)
1517{
1518 module_put(adap->owner);
1519}
David Brownellc0564602007-05-01 23:26:31 +02001520EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
1522/* The SMBus parts */
1523
David Brownell438d6c22006-12-10 21:21:31 +01001524#define POLY (0x1070U << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525static u8
1526crc8(u16 data)
1527{
1528 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001529
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 for(i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001531 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532 data = data ^ POLY;
1533 data = data << 1;
1534 }
1535 return (u8)(data >> 8);
1536}
1537
Jean Delvare421ef472005-10-26 21:28:55 +02001538/* Incremental CRC8 over count bytes in the array pointed to by p */
1539static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540{
1541 int i;
1542
1543 for(i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001544 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 return crc;
1546}
1547
Jean Delvare421ef472005-10-26 21:28:55 +02001548/* Assume a 7-bit address, which is reasonable for SMBus */
1549static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550{
Jean Delvare421ef472005-10-26 21:28:55 +02001551 /* The address will be sent first */
1552 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1553 pec = i2c_smbus_pec(pec, &addr, 1);
1554
1555 /* The data buffer follows */
1556 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557}
1558
Jean Delvare421ef472005-10-26 21:28:55 +02001559/* Used for write only transactions */
1560static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561{
Jean Delvare421ef472005-10-26 21:28:55 +02001562 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1563 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564}
1565
Jean Delvare421ef472005-10-26 21:28:55 +02001566/* Return <0 on CRC error
1567 If there was a write before this read (most cases) we need to take the
1568 partial CRC from the write part into account.
1569 Note that this function does modify the message (we need to decrease the
1570 message length to hide the CRC byte from the caller). */
1571static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572{
Jean Delvare421ef472005-10-26 21:28:55 +02001573 u8 rpec = msg->buf[--msg->len];
1574 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 if (rpec != cpec) {
1577 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1578 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02001579 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 }
David Brownell438d6c22006-12-10 21:21:31 +01001581 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582}
1583
David Brownella1cdeda2008-07-14 22:38:24 +02001584/**
1585 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1586 * @client: Handle to slave device
1587 *
1588 * This executes the SMBus "receive byte" protocol, returning negative errno
1589 * else the byte received from the device.
1590 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591s32 i2c_smbus_read_byte(struct i2c_client *client)
1592{
1593 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001594 int status;
1595
1596 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1597 I2C_SMBUS_READ, 0,
1598 I2C_SMBUS_BYTE, &data);
1599 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600}
David Brownellc0564602007-05-01 23:26:31 +02001601EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602
David Brownella1cdeda2008-07-14 22:38:24 +02001603/**
1604 * i2c_smbus_write_byte - SMBus "send byte" protocol
1605 * @client: Handle to slave device
1606 * @value: Byte to be sent
1607 *
1608 * This executes the SMBus "send byte" protocol, returning negative errno
1609 * else zero on success.
1610 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1612{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001614 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615}
David Brownellc0564602007-05-01 23:26:31 +02001616EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
David Brownella1cdeda2008-07-14 22:38:24 +02001618/**
1619 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1620 * @client: Handle to slave device
1621 * @command: Byte interpreted by slave
1622 *
1623 * This executes the SMBus "read byte" protocol, returning negative errno
1624 * else a data byte received from the device.
1625 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1627{
1628 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001629 int status;
1630
1631 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1632 I2C_SMBUS_READ, command,
1633 I2C_SMBUS_BYTE_DATA, &data);
1634 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635}
David Brownellc0564602007-05-01 23:26:31 +02001636EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
David Brownella1cdeda2008-07-14 22:38:24 +02001638/**
1639 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1640 * @client: Handle to slave device
1641 * @command: Byte interpreted by slave
1642 * @value: Byte being written
1643 *
1644 * This executes the SMBus "write byte" protocol, returning negative errno
1645 * else zero on success.
1646 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1648{
1649 union i2c_smbus_data data;
1650 data.byte = value;
1651 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1652 I2C_SMBUS_WRITE,command,
1653 I2C_SMBUS_BYTE_DATA,&data);
1654}
David Brownellc0564602007-05-01 23:26:31 +02001655EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
David Brownella1cdeda2008-07-14 22:38:24 +02001657/**
1658 * i2c_smbus_read_word_data - SMBus "read word" protocol
1659 * @client: Handle to slave device
1660 * @command: Byte interpreted by slave
1661 *
1662 * This executes the SMBus "read word" protocol, returning negative errno
1663 * else a 16-bit unsigned "word" received from the device.
1664 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1666{
1667 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001668 int status;
1669
1670 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1671 I2C_SMBUS_READ, command,
1672 I2C_SMBUS_WORD_DATA, &data);
1673 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674}
David Brownellc0564602007-05-01 23:26:31 +02001675EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
David Brownella1cdeda2008-07-14 22:38:24 +02001677/**
1678 * i2c_smbus_write_word_data - SMBus "write word" protocol
1679 * @client: Handle to slave device
1680 * @command: Byte interpreted by slave
1681 * @value: 16-bit "word" being written
1682 *
1683 * This executes the SMBus "write word" protocol, returning negative errno
1684 * else zero on success.
1685 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1687{
1688 union i2c_smbus_data data;
1689 data.word = value;
1690 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1691 I2C_SMBUS_WRITE,command,
1692 I2C_SMBUS_WORD_DATA,&data);
1693}
David Brownellc0564602007-05-01 23:26:31 +02001694EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695
David Brownella64ec072007-10-13 23:56:31 +02001696/**
Prakash Mortha596c88f2008-10-14 17:30:06 +02001697 * i2c_smbus_process_call - SMBus "process call" protocol
1698 * @client: Handle to slave device
1699 * @command: Byte interpreted by slave
1700 * @value: 16-bit "word" being written
1701 *
1702 * This executes the SMBus "process call" protocol, returning negative errno
1703 * else a 16-bit unsigned "word" received from the device.
1704 */
1705s32 i2c_smbus_process_call(struct i2c_client *client, u8 command, u16 value)
1706{
1707 union i2c_smbus_data data;
1708 int status;
1709 data.word = value;
1710
1711 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1712 I2C_SMBUS_WRITE, command,
1713 I2C_SMBUS_PROC_CALL, &data);
1714 return (status < 0) ? status : data.word;
1715}
1716EXPORT_SYMBOL(i2c_smbus_process_call);
1717
1718/**
David Brownella1cdeda2008-07-14 22:38:24 +02001719 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02001720 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02001721 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02001722 * @values: Byte array into which data will be read; big enough to hold
1723 * the data returned by the slave. SMBus allows at most 32 bytes.
1724 *
David Brownella1cdeda2008-07-14 22:38:24 +02001725 * This executes the SMBus "block read" protocol, returning negative errno
1726 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02001727 *
1728 * Note that using this function requires that the client's adapter support
1729 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1730 * support this; its emulation through I2C messaging relies on a specific
1731 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1732 */
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001733s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1734 u8 *values)
1735{
1736 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001737 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001738
David Brownell24a5bb72008-07-14 22:38:23 +02001739 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1740 I2C_SMBUS_READ, command,
1741 I2C_SMBUS_BLOCK_DATA, &data);
1742 if (status)
1743 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001744
1745 memcpy(values, &data.block[1], data.block[0]);
1746 return data.block[0];
1747}
1748EXPORT_SYMBOL(i2c_smbus_read_block_data);
1749
David Brownella1cdeda2008-07-14 22:38:24 +02001750/**
1751 * i2c_smbus_write_block_data - SMBus "block write" protocol
1752 * @client: Handle to slave device
1753 * @command: Byte interpreted by slave
1754 * @length: Size of data block; SMBus allows at most 32 bytes
1755 * @values: Byte array which will be written.
1756 *
1757 * This executes the SMBus "block write" protocol, returning negative errno
1758 * else zero on success.
1759 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001761 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762{
1763 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001764
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 if (length > I2C_SMBUS_BLOCK_MAX)
1766 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01001768 memcpy(&data.block[1], values, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1770 I2C_SMBUS_WRITE,command,
1771 I2C_SMBUS_BLOCK_DATA,&data);
1772}
David Brownellc0564602007-05-01 23:26:31 +02001773EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
1775/* Returns the number of read bytes */
Jean Delvare4b2643d2007-07-12 14:12:29 +02001776s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1777 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778{
1779 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001780 int status;
Jean Delvare76560322006-01-18 23:14:55 +01001781
Jean Delvare4b2643d2007-07-12 14:12:29 +02001782 if (length > I2C_SMBUS_BLOCK_MAX)
1783 length = I2C_SMBUS_BLOCK_MAX;
1784 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02001785 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1786 I2C_SMBUS_READ, command,
1787 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1788 if (status < 0)
1789 return status;
Jean Delvare76560322006-01-18 23:14:55 +01001790
1791 memcpy(values, &data.block[1], data.block[0]);
1792 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793}
David Brownellc0564602007-05-01 23:26:31 +02001794EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795
Jean Delvare21bbd692006-01-09 15:19:18 +11001796s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001797 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11001798{
1799 union i2c_smbus_data data;
1800
1801 if (length > I2C_SMBUS_BLOCK_MAX)
1802 length = I2C_SMBUS_BLOCK_MAX;
1803 data.block[0] = length;
1804 memcpy(data.block + 1, values, length);
1805 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1806 I2C_SMBUS_WRITE, command,
1807 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1808}
David Brownellc0564602007-05-01 23:26:31 +02001809EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11001810
David Brownell438d6c22006-12-10 21:21:31 +01001811/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 No checking of parameters is done! */
David Brownell438d6c22006-12-10 21:21:31 +01001813static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001815 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 union i2c_smbus_data * data)
1817{
1818 /* So we need to generate a series of msgs. In the case of writing, we
1819 need to use only one message; when reading, we need two. We initialize
1820 most things with sane defaults, to keep the code below somewhat
1821 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001822 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1823 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 int num = read_write == I2C_SMBUS_READ?2:1;
David Brownell438d6c22006-12-10 21:21:31 +01001825 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1827 };
1828 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02001829 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02001830 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831
1832 msgbuf0[0] = command;
1833 switch(size) {
1834 case I2C_SMBUS_QUICK:
1835 msg[0].len = 0;
1836 /* Special case: The read/write field is used as data */
Roel Kluinf29d2e02009-02-24 19:19:48 +01001837 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
1838 I2C_M_RD : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 num = 1;
1840 break;
1841 case I2C_SMBUS_BYTE:
1842 if (read_write == I2C_SMBUS_READ) {
1843 /* Special case: only a read! */
1844 msg[0].flags = I2C_M_RD | flags;
1845 num = 1;
1846 }
1847 break;
1848 case I2C_SMBUS_BYTE_DATA:
1849 if (read_write == I2C_SMBUS_READ)
1850 msg[1].len = 1;
1851 else {
1852 msg[0].len = 2;
1853 msgbuf0[1] = data->byte;
1854 }
1855 break;
1856 case I2C_SMBUS_WORD_DATA:
1857 if (read_write == I2C_SMBUS_READ)
1858 msg[1].len = 2;
1859 else {
1860 msg[0].len=3;
1861 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001862 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 }
1864 break;
1865 case I2C_SMBUS_PROC_CALL:
1866 num = 2; /* Special case */
1867 read_write = I2C_SMBUS_READ;
1868 msg[0].len = 3;
1869 msg[1].len = 2;
1870 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001871 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 break;
1873 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02001875 msg[1].flags |= I2C_M_RECV_LEN;
1876 msg[1].len = 1; /* block length will be added by
1877 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 } else {
1879 msg[0].len = data->block[0] + 2;
1880 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02001881 dev_err(&adapter->dev,
1882 "Invalid block write size %d\n",
1883 data->block[0]);
1884 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001886 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 msgbuf0[i] = data->block[i-1];
1888 }
1889 break;
1890 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02001891 num = 2; /* Another special case */
1892 read_write = I2C_SMBUS_READ;
1893 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02001894 dev_err(&adapter->dev,
1895 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02001896 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02001897 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02001898 }
1899 msg[0].len = data->block[0] + 2;
1900 for (i = 1; i < msg[0].len; i++)
1901 msgbuf0[i] = data->block[i-1];
1902 msg[1].flags |= I2C_M_RECV_LEN;
1903 msg[1].len = 1; /* block length will be added by
1904 the underlying bus driver */
1905 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 case I2C_SMBUS_I2C_BLOCK_DATA:
1907 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02001908 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 } else {
1910 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02001911 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02001912 dev_err(&adapter->dev,
1913 "Invalid block write size %d\n",
1914 data->block[0]);
1915 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 }
1917 for (i = 1; i <= data->block[0]; i++)
1918 msgbuf0[i] = data->block[i];
1919 }
1920 break;
1921 default:
David Brownell24a5bb72008-07-14 22:38:23 +02001922 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1923 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 }
1925
Jean Delvare421ef472005-10-26 21:28:55 +02001926 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1927 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1928 if (i) {
1929 /* Compute PEC if first message is a write */
1930 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01001931 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02001932 i2c_smbus_add_pec(&msg[0]);
1933 else /* Write followed by read */
1934 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1935 }
1936 /* Ask for PEC if last message is a read */
1937 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01001938 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02001939 }
1940
David Brownell24a5bb72008-07-14 22:38:23 +02001941 status = i2c_transfer(adapter, msg, num);
1942 if (status < 0)
1943 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944
Jean Delvare421ef472005-10-26 21:28:55 +02001945 /* Check PEC if last message is a read */
1946 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02001947 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1948 if (status < 0)
1949 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02001950 }
1951
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 if (read_write == I2C_SMBUS_READ)
1953 switch(size) {
1954 case I2C_SMBUS_BYTE:
1955 data->byte = msgbuf0[0];
1956 break;
1957 case I2C_SMBUS_BYTE_DATA:
1958 data->byte = msgbuf1[0];
1959 break;
David Brownell438d6c22006-12-10 21:21:31 +01001960 case I2C_SMBUS_WORD_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 case I2C_SMBUS_PROC_CALL:
1962 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1963 break;
1964 case I2C_SMBUS_I2C_BLOCK_DATA:
Jean Delvare4b2643d2007-07-12 14:12:29 +02001965 for (i = 0; i < data->block[0]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 data->block[i+1] = msgbuf1[i];
1967 break;
Jean Delvare209d27c2007-05-01 23:26:29 +02001968 case I2C_SMBUS_BLOCK_DATA:
1969 case I2C_SMBUS_BLOCK_PROC_CALL:
1970 for (i = 0; i < msgbuf1[0] + 1; i++)
1971 data->block[i] = msgbuf1[i];
1972 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 }
1974 return 0;
1975}
1976
David Brownella1cdeda2008-07-14 22:38:24 +02001977/**
1978 * i2c_smbus_xfer - execute SMBus protocol operations
1979 * @adapter: Handle to I2C bus
1980 * @addr: Address of SMBus slave on that bus
1981 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1982 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1983 * @command: Byte interpreted by slave, for protocols which use such bytes
1984 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1985 * @data: Data to be read or written
1986 *
1987 * This executes an SMBus protocol operation, and returns a negative
1988 * errno code else zero on success.
1989 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02001991 char read_write, u8 command, int protocol,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 union i2c_smbus_data * data)
1993{
1994 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995
1996 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
1998 if (adapter->algo->smbus_xfer) {
Ingo Molnar5c085d32006-01-18 23:16:04 +01001999 mutex_lock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02002001 command, protocol, data);
Ingo Molnar5c085d32006-01-18 23:16:04 +01002002 mutex_unlock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 } else
2004 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02002005 command, protocol, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 return res;
2008}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010
2011MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2012MODULE_DESCRIPTION("I2C-Bus main module");
2013MODULE_LICENSE("GPL");