blob: 9065c7238b5ef5edff061e72daf38d8b5e98236b [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>
Arjan van de Venb3585e42006-01-11 10:50:26 +010032#include <linux/mutex.h>
Jean Delvareb8d6f452007-02-13 22:09:00 +010033#include <linux/completion.h>
Mike Rapoportcea443a82008-01-27 18:14:50 +010034#include <linux/hardirq.h>
35#include <linux/irqflags.h>
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +020036#include <linux/rwsem.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 Delvare99cd8e22009-06-19 16:58:20 +020042/* core_lock protects i2c_adapter_idr, userspace_devices, and guarantees
Jean Delvare35fc37f2009-06-19 16:58:19 +020043 that device detection, deletion of detected devices, and attach_adapter
44 and detach_adapter calls are serialized */
Jean Delvarecaada322008-01-27 18:14:49 +010045static DEFINE_MUTEX(core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046static DEFINE_IDR(i2c_adapter_idr);
Jean Delvare99cd8e22009-06-19 16:58:20 +020047static LIST_HEAD(userspace_devices);
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Jean Delvare4f8cf822009-09-18 22:45:46 +020049static struct device_type i2c_client_type;
Jean Delvaref8a227e2009-06-19 16:58:18 +020050static int i2c_check_addr(struct i2c_adapter *adapter, int addr);
Jean Delvare4735c982008-07-14 22:38:36 +020051static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
David Brownellf37dd802007-02-13 22:09:00 +010052
53/* ------------------------------------------------------------------------- */
54
Jean Delvared2653e92008-04-29 23:11:39 +020055static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
56 const struct i2c_client *client)
57{
58 while (id->name[0]) {
59 if (strcmp(client->name, id->name) == 0)
60 return id;
61 id++;
62 }
63 return NULL;
64}
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066static int i2c_device_match(struct device *dev, struct device_driver *drv)
67{
Jean Delvare51298d12009-09-18 22:45:45 +020068 struct i2c_client *client = i2c_verify_client(dev);
69 struct i2c_driver *driver;
David Brownell7b4fbc52007-05-01 23:26:30 +020070
Jean Delvare51298d12009-09-18 22:45:45 +020071 if (!client)
72 return 0;
73
74 driver = to_i2c_driver(drv);
Jean Delvared2653e92008-04-29 23:11:39 +020075 /* match on an id table if there is one */
76 if (driver->id_table)
77 return i2c_match_id(driver->id_table, client) != NULL;
78
Jean Delvareeb8a7902008-05-18 20:49:41 +020079 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080}
81
David Brownell7b4fbc52007-05-01 23:26:30 +020082#ifdef CONFIG_HOTPLUG
83
84/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
Kay Sievers7eff2e72007-08-14 15:15:12 +020085static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +020086{
87 struct i2c_client *client = to_i2c_client(dev);
David Brownell7b4fbc52007-05-01 23:26:30 +020088
Jean Delvareeb8a7902008-05-18 20:49:41 +020089 if (add_uevent_var(env, "MODALIAS=%s%s",
90 I2C_MODULE_PREFIX, client->name))
91 return -ENOMEM;
David Brownell7b4fbc52007-05-01 23:26:30 +020092 dev_dbg(dev, "uevent\n");
93 return 0;
94}
95
96#else
97#define i2c_device_uevent NULL
98#endif /* CONFIG_HOTPLUG */
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100static int i2c_device_probe(struct device *dev)
101{
Jean Delvare51298d12009-09-18 22:45:45 +0200102 struct i2c_client *client = i2c_verify_client(dev);
103 struct i2c_driver *driver;
Hans Verkuil50c33042008-03-12 14:15:00 +0100104 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200105
Jean Delvare51298d12009-09-18 22:45:45 +0200106 if (!client)
107 return 0;
108
109 driver = to_i2c_driver(dev->driver);
Jean Delvaree0457442008-07-14 22:38:30 +0200110 if (!driver->probe || !driver->id_table)
David Brownell7b4fbc52007-05-01 23:26:30 +0200111 return -ENODEV;
112 client->driver = driver;
Marc Pignatee354252008-08-28 08:33:22 +0200113 if (!device_can_wakeup(&client->dev))
114 device_init_wakeup(&client->dev,
115 client->flags & I2C_CLIENT_WAKE);
David Brownell7b4fbc52007-05-01 23:26:30 +0200116 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200117
Jean Delvaree0457442008-07-14 22:38:30 +0200118 status = driver->probe(client, i2c_match_id(driver->id_table, client));
Hans Verkuil50c33042008-03-12 14:15:00 +0100119 if (status)
120 client->driver = NULL;
121 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122}
123
124static int i2c_device_remove(struct device *dev)
125{
Jean Delvare51298d12009-09-18 22:45:45 +0200126 struct i2c_client *client = i2c_verify_client(dev);
David Brownella1d9e6e2007-05-01 23:26:30 +0200127 struct i2c_driver *driver;
128 int status;
129
Jean Delvare51298d12009-09-18 22:45:45 +0200130 if (!client || !dev->driver)
David Brownella1d9e6e2007-05-01 23:26:30 +0200131 return 0;
132
133 driver = to_i2c_driver(dev->driver);
134 if (driver->remove) {
135 dev_dbg(dev, "remove\n");
136 status = driver->remove(client);
137 } else {
138 dev->driver = NULL;
139 status = 0;
140 }
141 if (status == 0)
142 client->driver = NULL;
143 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144}
145
David Brownellf37dd802007-02-13 22:09:00 +0100146static void i2c_device_shutdown(struct device *dev)
147{
Jean Delvare51298d12009-09-18 22:45:45 +0200148 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100149 struct i2c_driver *driver;
150
Jean Delvare51298d12009-09-18 22:45:45 +0200151 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100152 return;
153 driver = to_i2c_driver(dev->driver);
154 if (driver->shutdown)
Jean Delvare51298d12009-09-18 22:45:45 +0200155 driver->shutdown(client);
David Brownellf37dd802007-02-13 22:09:00 +0100156}
157
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100158static int i2c_device_suspend(struct device *dev, pm_message_t mesg)
David Brownellf37dd802007-02-13 22:09:00 +0100159{
Jean Delvare51298d12009-09-18 22:45:45 +0200160 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100161 struct i2c_driver *driver;
162
Jean Delvare51298d12009-09-18 22:45:45 +0200163 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100164 return 0;
165 driver = to_i2c_driver(dev->driver);
166 if (!driver->suspend)
167 return 0;
Jean Delvare51298d12009-09-18 22:45:45 +0200168 return driver->suspend(client, mesg);
David Brownellf37dd802007-02-13 22:09:00 +0100169}
170
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100171static int i2c_device_resume(struct device *dev)
David Brownellf37dd802007-02-13 22:09:00 +0100172{
Jean Delvare51298d12009-09-18 22:45:45 +0200173 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100174 struct i2c_driver *driver;
175
Jean Delvare51298d12009-09-18 22:45:45 +0200176 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100177 return 0;
178 driver = to_i2c_driver(dev->driver);
179 if (!driver->resume)
180 return 0;
Jean Delvare51298d12009-09-18 22:45:45 +0200181 return driver->resume(client);
David Brownellf37dd802007-02-13 22:09:00 +0100182}
183
David Brownell9c1600e2007-05-01 23:26:31 +0200184static void i2c_client_dev_release(struct device *dev)
185{
186 kfree(to_i2c_client(dev));
187}
188
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100189static ssize_t
Jean Delvare4f8cf822009-09-18 22:45:46 +0200190show_name(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200191{
Jean Delvare4f8cf822009-09-18 22:45:46 +0200192 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
193 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200194}
195
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100196static ssize_t
197show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200198{
199 struct i2c_client *client = to_i2c_client(dev);
Jean Delvareeb8a7902008-05-18 20:49:41 +0200200 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200201}
202
Jean Delvare4f8cf822009-09-18 22:45:46 +0200203static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
Jean Delvare51298d12009-09-18 22:45:45 +0200204static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
205
206static struct attribute *i2c_dev_attrs[] = {
207 &dev_attr_name.attr,
David Brownell7b4fbc52007-05-01 23:26:30 +0200208 /* modalias helps coldplug: modprobe $(cat .../modalias) */
Jean Delvare51298d12009-09-18 22:45:45 +0200209 &dev_attr_modalias.attr,
210 NULL
211};
212
213static struct attribute_group i2c_dev_attr_group = {
214 .attrs = i2c_dev_attrs,
215};
216
217static const struct attribute_group *i2c_dev_attr_groups[] = {
218 &i2c_dev_attr_group,
219 NULL
David Brownell7b4fbc52007-05-01 23:26:30 +0200220};
221
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200222struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100223 .name = "i2c",
224 .match = i2c_device_match,
225 .probe = i2c_device_probe,
226 .remove = i2c_device_remove,
227 .shutdown = i2c_device_shutdown,
228 .suspend = i2c_device_suspend,
229 .resume = i2c_device_resume,
Russell Kingb864c7d2006-01-05 14:37:50 +0000230};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200231EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000232
Jean Delvare51298d12009-09-18 22:45:45 +0200233static struct device_type i2c_client_type = {
234 .groups = i2c_dev_attr_groups,
235 .uevent = i2c_device_uevent,
236 .release = i2c_client_dev_release,
237};
238
David Brownell9b766b82008-01-27 18:14:51 +0100239
240/**
241 * i2c_verify_client - return parameter as i2c_client, or NULL
242 * @dev: device, probably from some driver model iterator
243 *
244 * When traversing the driver model tree, perhaps using driver model
245 * iterators like @device_for_each_child(), you can't assume very much
246 * about the nodes you find. Use this function to avoid oopses caused
247 * by wrongly treating some non-I2C device as an i2c_client.
248 */
249struct i2c_client *i2c_verify_client(struct device *dev)
250{
Jean Delvare51298d12009-09-18 22:45:45 +0200251 return (dev->type == &i2c_client_type)
David Brownell9b766b82008-01-27 18:14:51 +0100252 ? to_i2c_client(dev)
253 : NULL;
254}
255EXPORT_SYMBOL(i2c_verify_client);
256
257
David Brownell9c1600e2007-05-01 23:26:31 +0200258/**
Jean Delvaref8a227e2009-06-19 16:58:18 +0200259 * i2c_new_device - instantiate an i2c device
David Brownell9c1600e2007-05-01 23:26:31 +0200260 * @adap: the adapter managing the device
261 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200262 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200263 *
Jean Delvaref8a227e2009-06-19 16:58:18 +0200264 * Create an i2c device. Binding is handled through driver model
265 * probe()/remove() methods. A driver may be bound to this device when we
266 * return from this function, or any later moment (e.g. maybe hotplugging will
267 * load the driver module). This call is not appropriate for use by mainboard
268 * initialization logic, which usually runs during an arch_initcall() long
269 * before any i2c_adapter could exist.
David Brownell9c1600e2007-05-01 23:26:31 +0200270 *
271 * This returns the new i2c client, which may be saved for later use with
272 * i2c_unregister_device(); or NULL to indicate an error.
273 */
274struct i2c_client *
275i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
276{
277 struct i2c_client *client;
278 int status;
279
280 client = kzalloc(sizeof *client, GFP_KERNEL);
281 if (!client)
282 return NULL;
283
284 client->adapter = adap;
285
286 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +0200287
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200288 if (info->archdata)
289 client->dev.archdata = *info->archdata;
290
Marc Pignatee354252008-08-28 08:33:22 +0200291 client->flags = info->flags;
David Brownell9c1600e2007-05-01 23:26:31 +0200292 client->addr = info->addr;
293 client->irq = info->irq;
294
David Brownell9c1600e2007-05-01 23:26:31 +0200295 strlcpy(client->name, info->type, sizeof(client->name));
296
Jean Delvaref8a227e2009-06-19 16:58:18 +0200297 /* Check for address business */
298 status = i2c_check_addr(adap, client->addr);
299 if (status)
300 goto out_err;
301
302 client->dev.parent = &client->adapter->dev;
303 client->dev.bus = &i2c_bus_type;
Jean Delvare51298d12009-09-18 22:45:45 +0200304 client->dev.type = &i2c_client_type;
Jean Delvaref8a227e2009-06-19 16:58:18 +0200305
306 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
307 client->addr);
308 status = device_register(&client->dev);
309 if (status)
310 goto out_err;
311
Jean Delvaref8a227e2009-06-19 16:58:18 +0200312 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
313 client->name, dev_name(&client->dev));
314
David Brownell9c1600e2007-05-01 23:26:31 +0200315 return client;
Jean Delvaref8a227e2009-06-19 16:58:18 +0200316
317out_err:
318 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
319 "(%d)\n", client->name, client->addr, status);
320 kfree(client);
321 return NULL;
David Brownell9c1600e2007-05-01 23:26:31 +0200322}
323EXPORT_SYMBOL_GPL(i2c_new_device);
324
325
326/**
327 * i2c_unregister_device - reverse effect of i2c_new_device()
328 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200329 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200330 */
331void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200332{
David Brownella1d9e6e2007-05-01 23:26:30 +0200333 device_unregister(&client->dev);
334}
David Brownell9c1600e2007-05-01 23:26:31 +0200335EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200336
337
Jean Delvare60b129d2008-05-11 20:37:06 +0200338static const struct i2c_device_id dummy_id[] = {
339 { "dummy", 0 },
340 { },
341};
342
Jean Delvared2653e92008-04-29 23:11:39 +0200343static int dummy_probe(struct i2c_client *client,
344 const struct i2c_device_id *id)
345{
346 return 0;
347}
348
349static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100350{
351 return 0;
352}
353
354static struct i2c_driver dummy_driver = {
355 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200356 .probe = dummy_probe,
357 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200358 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100359};
360
361/**
362 * i2c_new_dummy - return a new i2c device bound to a dummy driver
363 * @adapter: the adapter managing the device
364 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100365 * Context: can sleep
366 *
367 * This returns an I2C client bound to the "dummy" driver, intended for use
368 * with devices that consume multiple addresses. Examples of such chips
369 * include various EEPROMS (like 24c04 and 24c08 models).
370 *
371 * These dummy devices have two main uses. First, most I2C and SMBus calls
372 * except i2c_transfer() need a client handle; the dummy will be that handle.
373 * And second, this prevents the specified address from being bound to a
374 * different driver.
375 *
376 * This returns the new i2c client, which should be saved for later use with
377 * i2c_unregister_device(); or NULL to indicate an error.
378 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100379struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100380{
381 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200382 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100383 };
384
David Brownelle9f13732008-01-27 18:14:52 +0100385 return i2c_new_device(adapter, &info);
386}
387EXPORT_SYMBOL_GPL(i2c_new_dummy);
388
David Brownellf37dd802007-02-13 22:09:00 +0100389/* ------------------------------------------------------------------------- */
390
David Brownell16ffadf2007-05-01 23:26:28 +0200391/* I2C bus adapters -- one roots each I2C or SMBUS segment */
392
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200393static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394{
David Brownellef2c83212007-05-01 23:26:28 +0200395 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 complete(&adap->dev_released);
397}
398
Jean Delvare99cd8e22009-06-19 16:58:20 +0200399/*
400 * Let users instantiate I2C devices through sysfs. This can be used when
401 * platform initialization code doesn't contain the proper data for
402 * whatever reason. Also useful for drivers that do device detection and
403 * detection fails, either because the device uses an unexpected address,
404 * or this is a compatible device with different ID register values.
405 *
406 * Parameter checking may look overzealous, but we really don't want
407 * the user to provide incorrect parameters.
408 */
409static ssize_t
410i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
411 const char *buf, size_t count)
412{
413 struct i2c_adapter *adap = to_i2c_adapter(dev);
414 struct i2c_board_info info;
415 struct i2c_client *client;
416 char *blank, end;
417 int res;
418
419 dev_warn(dev, "The new_device interface is still experimental "
420 "and may change in a near future\n");
421 memset(&info, 0, sizeof(struct i2c_board_info));
422
423 blank = strchr(buf, ' ');
424 if (!blank) {
425 dev_err(dev, "%s: Missing parameters\n", "new_device");
426 return -EINVAL;
427 }
428 if (blank - buf > I2C_NAME_SIZE - 1) {
429 dev_err(dev, "%s: Invalid device name\n", "new_device");
430 return -EINVAL;
431 }
432 memcpy(info.type, buf, blank - buf);
433
434 /* Parse remaining parameters, reject extra parameters */
435 res = sscanf(++blank, "%hi%c", &info.addr, &end);
436 if (res < 1) {
437 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
438 return -EINVAL;
439 }
440 if (res > 1 && end != '\n') {
441 dev_err(dev, "%s: Extra parameters\n", "new_device");
442 return -EINVAL;
443 }
444
445 if (info.addr < 0x03 || info.addr > 0x77) {
446 dev_err(dev, "%s: Invalid I2C address 0x%hx\n", "new_device",
447 info.addr);
448 return -EINVAL;
449 }
450
451 client = i2c_new_device(adap, &info);
452 if (!client)
453 return -EEXIST;
454
455 /* Keep track of the added device */
456 mutex_lock(&core_lock);
457 list_add_tail(&client->detected, &userspace_devices);
458 mutex_unlock(&core_lock);
459 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
460 info.type, info.addr);
461
462 return count;
463}
464
465/*
466 * And of course let the users delete the devices they instantiated, if
467 * they got it wrong. This interface can only be used to delete devices
468 * instantiated by i2c_sysfs_new_device above. This guarantees that we
469 * don't delete devices to which some kernel code still has references.
470 *
471 * Parameter checking may look overzealous, but we really don't want
472 * the user to delete the wrong device.
473 */
474static ssize_t
475i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
476 const char *buf, size_t count)
477{
478 struct i2c_adapter *adap = to_i2c_adapter(dev);
479 struct i2c_client *client, *next;
480 unsigned short addr;
481 char end;
482 int res;
483
484 /* Parse parameters, reject extra parameters */
485 res = sscanf(buf, "%hi%c", &addr, &end);
486 if (res < 1) {
487 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
488 return -EINVAL;
489 }
490 if (res > 1 && end != '\n') {
491 dev_err(dev, "%s: Extra parameters\n", "delete_device");
492 return -EINVAL;
493 }
494
495 /* Make sure the device was added through sysfs */
496 res = -ENOENT;
497 mutex_lock(&core_lock);
498 list_for_each_entry_safe(client, next, &userspace_devices, detected) {
499 if (client->addr == addr && client->adapter == adap) {
500 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
501 "delete_device", client->name, client->addr);
502
503 list_del(&client->detected);
504 i2c_unregister_device(client);
505 res = count;
506 break;
507 }
508 }
509 mutex_unlock(&core_lock);
510
511 if (res < 0)
512 dev_err(dev, "%s: Can't find device in list\n",
513 "delete_device");
514 return res;
515}
516
Jean Delvare4f8cf822009-09-18 22:45:46 +0200517static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
518static DEVICE_ATTR(delete_device, S_IWUSR, NULL, i2c_sysfs_delete_device);
519
520static struct attribute *i2c_adapter_attrs[] = {
521 &dev_attr_name.attr,
522 &dev_attr_new_device.attr,
523 &dev_attr_delete_device.attr,
524 NULL
David Brownell16ffadf2007-05-01 23:26:28 +0200525};
526
Jean Delvare4f8cf822009-09-18 22:45:46 +0200527static struct attribute_group i2c_adapter_attr_group = {
528 .attrs = i2c_adapter_attrs,
529};
530
531static const struct attribute_group *i2c_adapter_attr_groups[] = {
532 &i2c_adapter_attr_group,
533 NULL
534};
535
536static struct device_type i2c_adapter_type = {
537 .groups = i2c_adapter_attr_groups,
538 .release = i2c_adapter_dev_release,
David Brownell16ffadf2007-05-01 23:26:28 +0200539};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Jean Delvare2bb50952009-09-18 22:45:46 +0200541#ifdef CONFIG_I2C_COMPAT
542static struct class_compat *i2c_adapter_compat_class;
543#endif
544
David Brownell9c1600e2007-05-01 23:26:31 +0200545static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
546{
547 struct i2c_devinfo *devinfo;
548
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +0200549 down_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +0200550 list_for_each_entry(devinfo, &__i2c_board_list, list) {
551 if (devinfo->busnum == adapter->nr
552 && !i2c_new_device(adapter,
553 &devinfo->board_info))
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100554 dev_err(&adapter->dev,
555 "Can't create device at 0x%02x\n",
David Brownell9c1600e2007-05-01 23:26:31 +0200556 devinfo->board_info.addr);
557 }
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +0200558 up_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +0200559}
560
Jean Delvare69b00892009-12-06 17:06:27 +0100561static int i2c_do_add_adapter(struct i2c_driver *driver,
562 struct i2c_adapter *adap)
Jean Delvare026526f2008-01-27 18:14:49 +0100563{
Jean Delvare4735c982008-07-14 22:38:36 +0200564 /* Detect supported devices on that bus, and instantiate them */
565 i2c_detect(adap, driver);
566
567 /* Let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +0100568 if (driver->attach_adapter) {
569 /* We ignore the return code; if it fails, too bad */
570 driver->attach_adapter(adap);
571 }
572 return 0;
573}
574
Jean Delvare69b00892009-12-06 17:06:27 +0100575static int __process_new_adapter(struct device_driver *d, void *data)
576{
577 return i2c_do_add_adapter(to_i2c_driver(d), data);
578}
579
David Brownell6e13e642007-05-01 23:26:31 +0200580static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581{
Jean Delvare026526f2008-01-27 18:14:49 +0100582 int res = 0, dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
David Brownell1d0b19c2008-10-14 17:30:05 +0200584 /* Can't register until after driver model init */
Jean Delvare35fc37f2009-06-19 16:58:19 +0200585 if (unlikely(WARN_ON(!i2c_bus_type.p))) {
586 res = -EAGAIN;
587 goto out_list;
588 }
David Brownell1d0b19c2008-10-14 17:30:05 +0200589
Mika Kuoppala194684e2009-12-06 17:06:22 +0100590 rt_mutex_init(&adap->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Jean Delvare8fcfef62009-03-28 21:34:43 +0100592 /* Set default timeout to 1 second if not already set */
593 if (adap->timeout == 0)
594 adap->timeout = HZ;
595
Kay Sievers27d9c182009-01-07 14:29:16 +0100596 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
Jean Delvare4f8cf822009-09-18 22:45:46 +0200597 adap->dev.bus = &i2c_bus_type;
598 adap->dev.type = &i2c_adapter_type;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200599 res = device_register(&adap->dev);
600 if (res)
601 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200603 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
604
Jean Delvare2bb50952009-09-18 22:45:46 +0200605#ifdef CONFIG_I2C_COMPAT
606 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
607 adap->dev.parent);
608 if (res)
609 dev_warn(&adap->dev,
610 "Failed to create compatibility class link\n");
611#endif
612
Jean Delvare729d6dd2009-06-19 16:58:18 +0200613 /* create pre-declared device nodes */
David Brownell6e13e642007-05-01 23:26:31 +0200614 if (adap->nr < __i2c_first_dynamic_bus_num)
615 i2c_scan_static_board_info(adap);
616
Jean Delvare4735c982008-07-14 22:38:36 +0200617 /* Notify drivers */
Jean Delvare35fc37f2009-06-19 16:58:19 +0200618 mutex_lock(&core_lock);
Jean Delvare026526f2008-01-27 18:14:49 +0100619 dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
Jean Delvare69b00892009-12-06 17:06:27 +0100620 __process_new_adapter);
Jean Delvarecaada322008-01-27 18:14:49 +0100621 mutex_unlock(&core_lock);
Jean Delvare35fc37f2009-06-19 16:58:19 +0200622
623 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +0200624
Jean Delvareb119c6c2006-08-15 18:26:30 +0200625out_list:
Jean Delvare35fc37f2009-06-19 16:58:19 +0200626 mutex_lock(&core_lock);
Jean Delvareb119c6c2006-08-15 18:26:30 +0200627 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +0200628 mutex_unlock(&core_lock);
629 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630}
631
David Brownell6e13e642007-05-01 23:26:31 +0200632/**
633 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
634 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +0200635 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200636 *
637 * This routine is used to declare an I2C adapter when its bus number
638 * doesn't matter. Examples: for I2C adapters dynamically added by
639 * USB links or PCI plugin cards.
640 *
641 * When this returns zero, a new bus number was allocated and stored
642 * in adap->nr, and the specified adapter became available for clients.
643 * Otherwise, a negative errno value is returned.
644 */
645int i2c_add_adapter(struct i2c_adapter *adapter)
646{
647 int id, res = 0;
648
649retry:
650 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
651 return -ENOMEM;
652
Jean Delvarecaada322008-01-27 18:14:49 +0100653 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200654 /* "above" here means "above or equal to", sigh */
655 res = idr_get_new_above(&i2c_adapter_idr, adapter,
656 __i2c_first_dynamic_bus_num, &id);
Jean Delvarecaada322008-01-27 18:14:49 +0100657 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200658
659 if (res < 0) {
660 if (res == -EAGAIN)
661 goto retry;
662 return res;
663 }
664
665 adapter->nr = id;
666 return i2c_register_adapter(adapter);
667}
668EXPORT_SYMBOL(i2c_add_adapter);
669
670/**
671 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
672 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +0200673 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +0200674 *
675 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +0100676 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
677 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +0200678 * is used to properly configure I2C devices.
679 *
680 * If no devices have pre-been declared for this bus, then be sure to
681 * register the adapter before any dynamically allocated ones. Otherwise
682 * the required bus ID may not be available.
683 *
684 * When this returns zero, the specified adapter became available for
685 * clients using the bus number provided in adap->nr. Also, the table
686 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
687 * and the appropriate driver model device nodes are created. Otherwise, a
688 * negative errno value is returned.
689 */
690int i2c_add_numbered_adapter(struct i2c_adapter *adap)
691{
692 int id;
693 int status;
694
695 if (adap->nr & ~MAX_ID_MASK)
696 return -EINVAL;
697
698retry:
699 if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
700 return -ENOMEM;
701
Jean Delvarecaada322008-01-27 18:14:49 +0100702 mutex_lock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200703 /* "above" here means "above or equal to", sigh;
704 * we need the "equal to" result to force the result
705 */
706 status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
707 if (status == 0 && id != adap->nr) {
708 status = -EBUSY;
709 idr_remove(&i2c_adapter_idr, id);
710 }
Jean Delvarecaada322008-01-27 18:14:49 +0100711 mutex_unlock(&core_lock);
David Brownell6e13e642007-05-01 23:26:31 +0200712 if (status == -EAGAIN)
713 goto retry;
714
715 if (status == 0)
716 status = i2c_register_adapter(adap);
717 return status;
718}
719EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
720
Jean Delvare69b00892009-12-06 17:06:27 +0100721static int i2c_do_del_adapter(struct i2c_driver *driver,
722 struct i2c_adapter *adapter)
Jean Delvare026526f2008-01-27 18:14:49 +0100723{
Jean Delvare4735c982008-07-14 22:38:36 +0200724 struct i2c_client *client, *_n;
Jean Delvare026526f2008-01-27 18:14:49 +0100725 int res;
726
Jean Delvareacec2112009-03-28 21:34:40 +0100727 /* Remove the devices we created ourselves as the result of hardware
728 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +0200729 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
730 if (client->adapter == adapter) {
731 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
732 client->name, client->addr);
733 list_del(&client->detected);
734 i2c_unregister_device(client);
735 }
736 }
737
Jean Delvare026526f2008-01-27 18:14:49 +0100738 if (!driver->detach_adapter)
739 return 0;
740 res = driver->detach_adapter(adapter);
741 if (res)
742 dev_err(&adapter->dev, "detach_adapter failed (%d) "
743 "for driver [%s]\n", res, driver->driver.name);
744 return res;
745}
746
Jean Delvaree549c2b2009-06-19 16:58:19 +0200747static int __unregister_client(struct device *dev, void *dummy)
748{
749 struct i2c_client *client = i2c_verify_client(dev);
750 if (client)
751 i2c_unregister_device(client);
752 return 0;
753}
754
Jean Delvare69b00892009-12-06 17:06:27 +0100755static int __process_removed_adapter(struct device_driver *d, void *data)
756{
757 return i2c_do_del_adapter(to_i2c_driver(d), data);
758}
759
David Brownelld64f73b2007-07-12 14:12:28 +0200760/**
761 * i2c_del_adapter - unregister I2C adapter
762 * @adap: the adapter being unregistered
763 * Context: can sleep
764 *
765 * This unregisters an I2C adapter which was previously registered
766 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
767 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768int i2c_del_adapter(struct i2c_adapter *adap)
769{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 int res = 0;
Jean Delvare35fc37f2009-06-19 16:58:19 +0200771 struct i2c_adapter *found;
Jean Delvarebbd2d9c2009-11-26 09:22:33 +0100772 struct i2c_client *client, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
774 /* First make sure that this adapter was ever added */
Jean Delvare35fc37f2009-06-19 16:58:19 +0200775 mutex_lock(&core_lock);
776 found = idr_find(&i2c_adapter_idr, adap->nr);
777 mutex_unlock(&core_lock);
778 if (found != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200779 pr_debug("i2c-core: attempting to delete unregistered "
780 "adapter [%s]\n", adap->name);
Jean Delvare35fc37f2009-06-19 16:58:19 +0200781 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 }
783
Jean Delvare026526f2008-01-27 18:14:49 +0100784 /* Tell drivers about this removal */
Jean Delvare35fc37f2009-06-19 16:58:19 +0200785 mutex_lock(&core_lock);
Jean Delvare026526f2008-01-27 18:14:49 +0100786 res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
Jean Delvare69b00892009-12-06 17:06:27 +0100787 __process_removed_adapter);
Jean Delvare35fc37f2009-06-19 16:58:19 +0200788 mutex_unlock(&core_lock);
Jean Delvare026526f2008-01-27 18:14:49 +0100789 if (res)
Jean Delvare35fc37f2009-06-19 16:58:19 +0200790 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Jean Delvarebbd2d9c2009-11-26 09:22:33 +0100792 /* Remove devices instantiated from sysfs */
793 list_for_each_entry_safe(client, next, &userspace_devices, detected) {
794 if (client->adapter == adap) {
795 dev_dbg(&adap->dev, "Removing %s at 0x%x\n",
796 client->name, client->addr);
797 list_del(&client->detected);
798 i2c_unregister_device(client);
799 }
800 }
801
Jean Delvaree549c2b2009-06-19 16:58:19 +0200802 /* Detach any active clients. This can't fail, thus we do not
803 checking the returned value. */
804 res = device_for_each_child(&adap->dev, NULL, __unregister_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Jean Delvare2bb50952009-09-18 22:45:46 +0200806#ifdef CONFIG_I2C_COMPAT
807 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
808 adap->dev.parent);
809#endif
810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 /* clean up the sysfs representation */
812 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814
815 /* wait for sysfs to drop all references */
816 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
David Brownell6e13e642007-05-01 23:26:31 +0200818 /* free bus id */
Jean Delvare35fc37f2009-06-19 16:58:19 +0200819 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +0200821 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Jean Delvareb6d7b3d2005-07-31 19:02:53 +0200823 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
Jean Delvarebd4bc3db2008-07-16 19:30:05 +0200825 /* Clear the device structure in case this adapter is ever going to be
826 added again */
827 memset(&adap->dev, 0, sizeof(adap->dev));
828
Jean Delvare35fc37f2009-06-19 16:58:19 +0200829 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830}
David Brownellc0564602007-05-01 23:26:31 +0200831EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
833
David Brownell7b4fbc52007-05-01 23:26:30 +0200834/* ------------------------------------------------------------------------- */
835
Jean Delvare69b00892009-12-06 17:06:27 +0100836static int __process_new_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +0200837{
Jean Delvare4f8cf822009-09-18 22:45:46 +0200838 if (dev->type != &i2c_adapter_type)
839 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +0100840 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
Dave Young7f101a92008-07-14 22:38:19 +0200841}
842
David Brownell7b4fbc52007-05-01 23:26:30 +0200843/*
844 * An i2c_driver is used with one or more i2c_client (device) nodes to access
Jean Delvare729d6dd2009-06-19 16:58:18 +0200845 * i2c slave chips, on a bus instance associated with some i2c_adapter.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 */
847
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800848int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
Jean Delvare7eebcb72006-02-05 23:28:21 +0100850 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
David Brownell1d0b19c2008-10-14 17:30:05 +0200852 /* Can't register until after driver model init */
853 if (unlikely(WARN_ON(!i2c_bus_type.p)))
854 return -EAGAIN;
855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800857 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Jean Delvare729d6dd2009-06-19 16:58:18 +0200860 /* When registration returns, the driver core
David Brownell6e13e642007-05-01 23:26:31 +0200861 * will have called probe() for all matching-but-unbound devices.
862 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 res = driver_register(&driver->driver);
864 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +0100865 return res;
David Brownell438d6c22006-12-10 21:21:31 +0100866
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100867 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Jean Delvare4735c982008-07-14 22:38:36 +0200869 INIT_LIST_HEAD(&driver->clients);
870 /* Walk the adapters that are already present */
Jean Delvare35fc37f2009-06-19 16:58:19 +0200871 mutex_lock(&core_lock);
Jean Delvare69b00892009-12-06 17:06:27 +0100872 bus_for_each_dev(&i2c_bus_type, NULL, driver, __process_new_driver);
Jean Delvarecaada322008-01-27 18:14:49 +0100873 mutex_unlock(&core_lock);
Jean Delvare35fc37f2009-06-19 16:58:19 +0200874
Jean Delvare7eebcb72006-02-05 23:28:21 +0100875 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800877EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
Jean Delvare69b00892009-12-06 17:06:27 +0100879static int __process_removed_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +0200880{
Jean Delvare4f8cf822009-09-18 22:45:46 +0200881 if (dev->type != &i2c_adapter_type)
882 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +0100883 return i2c_do_del_adapter(data, to_i2c_adapter(dev));
Dave Young7f101a92008-07-14 22:38:19 +0200884}
885
David Brownella1d9e6e2007-05-01 23:26:30 +0200886/**
887 * i2c_del_driver - unregister I2C driver
888 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +0200889 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +0200890 */
Jean Delvareb3e82092007-05-01 23:26:32 +0200891void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892{
Jean Delvarecaada322008-01-27 18:14:49 +0100893 mutex_lock(&core_lock);
Jean Delvare69b00892009-12-06 17:06:27 +0100894 bus_for_each_dev(&i2c_bus_type, NULL, driver, __process_removed_driver);
Jean Delvare35fc37f2009-06-19 16:58:19 +0200895 mutex_unlock(&core_lock);
David Brownella1d9e6e2007-05-01 23:26:30 +0200896
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100898 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899}
David Brownellc0564602007-05-01 23:26:31 +0200900EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
David Brownell7b4fbc52007-05-01 23:26:30 +0200902/* ------------------------------------------------------------------------- */
903
David Brownell9b766b82008-01-27 18:14:51 +0100904static int __i2c_check_addr(struct device *dev, void *addrp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905{
David Brownell9b766b82008-01-27 18:14:51 +0100906 struct i2c_client *client = i2c_verify_client(dev);
907 int addr = *(int *)addrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
David Brownell9b766b82008-01-27 18:14:51 +0100909 if (client && client->addr == addr)
910 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 return 0;
912}
913
Jean Delvare5e31c2b2007-11-15 19:24:02 +0100914static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915{
David Brownell9b766b82008-01-27 18:14:51 +0100916 return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917}
918
Jean Delvaree48d3312008-01-27 18:14:48 +0100919/**
920 * i2c_use_client - increments the reference count of the i2c client structure
921 * @client: the client being referenced
922 *
923 * Each live reference to a client should be refcounted. The driver model does
924 * that automatically as part of driver binding, so that most drivers don't
925 * need to do this explicitly: they hold a reference until they're unbound
926 * from the device.
927 *
928 * A pointer to the client with the incremented reference counter is returned.
929 */
930struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931{
David Brownell6ea438e2008-07-14 22:38:24 +0200932 if (client && get_device(&client->dev))
933 return client;
934 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935}
David Brownellc0564602007-05-01 23:26:31 +0200936EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
Jean Delvaree48d3312008-01-27 18:14:48 +0100938/**
939 * i2c_release_client - release a use of the i2c client structure
940 * @client: the client being no longer referenced
941 *
942 * Must be called when a user of a client is finished with it.
943 */
944void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945{
David Brownell6ea438e2008-07-14 22:38:24 +0200946 if (client)
947 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948}
David Brownellc0564602007-05-01 23:26:31 +0200949EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
David Brownell9b766b82008-01-27 18:14:51 +0100951struct i2c_cmd_arg {
952 unsigned cmd;
953 void *arg;
954};
955
956static int i2c_cmd(struct device *dev, void *_arg)
957{
958 struct i2c_client *client = i2c_verify_client(dev);
959 struct i2c_cmd_arg *arg = _arg;
960
961 if (client && client->driver && client->driver->command)
962 client->driver->command(client, arg->cmd, arg->arg);
963 return 0;
964}
965
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
967{
David Brownell9b766b82008-01-27 18:14:51 +0100968 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
David Brownell9b766b82008-01-27 18:14:51 +0100970 cmd_arg.cmd = cmd;
971 cmd_arg.arg = arg;
972 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973}
David Brownellc0564602007-05-01 23:26:31 +0200974EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
976static int __init i2c_init(void)
977{
978 int retval;
979
980 retval = bus_register(&i2c_bus_type);
981 if (retval)
982 return retval;
Jean Delvare2bb50952009-09-18 22:45:46 +0200983#ifdef CONFIG_I2C_COMPAT
984 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
985 if (!i2c_adapter_compat_class) {
986 retval = -ENOMEM;
987 goto bus_err;
988 }
989#endif
David Brownelle9f13732008-01-27 18:14:52 +0100990 retval = i2c_add_driver(&dummy_driver);
991 if (retval)
Jean Delvare2bb50952009-09-18 22:45:46 +0200992 goto class_err;
David Brownelle9f13732008-01-27 18:14:52 +0100993 return 0;
994
Jean Delvare2bb50952009-09-18 22:45:46 +0200995class_err:
996#ifdef CONFIG_I2C_COMPAT
997 class_compat_unregister(i2c_adapter_compat_class);
David Brownelle9f13732008-01-27 18:14:52 +0100998bus_err:
Jean Delvare2bb50952009-09-18 22:45:46 +0200999#endif
David Brownelle9f13732008-01-27 18:14:52 +01001000 bus_unregister(&i2c_bus_type);
1001 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002}
1003
1004static void __exit i2c_exit(void)
1005{
David Brownelle9f13732008-01-27 18:14:52 +01001006 i2c_del_driver(&dummy_driver);
Jean Delvare2bb50952009-09-18 22:45:46 +02001007#ifdef CONFIG_I2C_COMPAT
1008 class_compat_unregister(i2c_adapter_compat_class);
1009#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 bus_unregister(&i2c_bus_type);
1011}
1012
David Brownella10f9e72008-10-14 17:30:06 +02001013/* We must initialize early, because some subsystems register i2c drivers
1014 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1015 */
1016postcore_initcall(i2c_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017module_exit(i2c_exit);
1018
1019/* ----------------------------------------------------
1020 * the functional interface to the i2c busses.
1021 * ----------------------------------------------------
1022 */
1023
David Brownella1cdeda2008-07-14 22:38:24 +02001024/**
1025 * i2c_transfer - execute a single or combined I2C message
1026 * @adap: Handle to I2C bus
1027 * @msgs: One or more messages to execute before STOP is issued to
1028 * terminate the operation; each message begins with a START.
1029 * @num: Number of messages to be executed.
1030 *
1031 * Returns negative errno, else the number of messages executed.
1032 *
1033 * Note that there is no requirement that each message be sent to
1034 * the same slave address, although that is the most common model.
1035 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001036int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037{
Clifford Wolf66b650f2009-06-15 18:01:46 +02001038 unsigned long orig_jiffies;
1039 int ret, try;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040
David Brownella1cdeda2008-07-14 22:38:24 +02001041 /* REVISIT the fault reporting model here is weak:
1042 *
1043 * - When we get an error after receiving N bytes from a slave,
1044 * there is no way to report "N".
1045 *
1046 * - When we get a NAK after transmitting N bytes to a slave,
1047 * there is no way to report "N" ... or to let the master
1048 * continue executing the rest of this combined message, if
1049 * that's the appropriate response.
1050 *
1051 * - When for example "num" is two and we successfully complete
1052 * the first message but get an error part way through the
1053 * second, it's unclear whether that should be reported as
1054 * one (discarding status on the second message) or errno
1055 * (discarding status on the first one).
1056 */
1057
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 if (adap->algo->master_xfer) {
1059#ifdef DEBUG
1060 for (ret = 0; ret < num; ret++) {
1061 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +02001062 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
1063 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
1064 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 }
1066#endif
1067
Mike Rapoportcea443a82008-01-27 18:14:50 +01001068 if (in_atomic() || irqs_disabled()) {
Mika Kuoppala194684e2009-12-06 17:06:22 +01001069 ret = rt_mutex_trylock(&adap->bus_lock);
Mike Rapoportcea443a82008-01-27 18:14:50 +01001070 if (!ret)
1071 /* I2C activity is ongoing. */
1072 return -EAGAIN;
1073 } else {
Mika Kuoppala194684e2009-12-06 17:06:22 +01001074 rt_mutex_lock(&adap->bus_lock);
Mike Rapoportcea443a82008-01-27 18:14:50 +01001075 }
1076
Clifford Wolf66b650f2009-06-15 18:01:46 +02001077 /* Retry automatically on arbitration loss */
1078 orig_jiffies = jiffies;
1079 for (ret = 0, try = 0; try <= adap->retries; try++) {
1080 ret = adap->algo->master_xfer(adap, msgs, num);
1081 if (ret != -EAGAIN)
1082 break;
1083 if (time_after(jiffies, orig_jiffies + adap->timeout))
1084 break;
1085 }
Mika Kuoppala194684e2009-12-06 17:06:22 +01001086 rt_mutex_unlock(&adap->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087
1088 return ret;
1089 } else {
1090 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02001091 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 }
1093}
David Brownellc0564602007-05-01 23:26:31 +02001094EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
David Brownella1cdeda2008-07-14 22:38:24 +02001096/**
1097 * i2c_master_send - issue a single I2C message in master transmit mode
1098 * @client: Handle to slave device
1099 * @buf: Data that will be written to the slave
1100 * @count: How many bytes to write
1101 *
1102 * Returns negative errno, or else the number of bytes written.
1103 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
1105{
1106 int ret;
1107 struct i2c_adapter *adap=client->adapter;
1108 struct i2c_msg msg;
1109
Jean Delvare815f55f2005-05-07 22:58:46 +02001110 msg.addr = client->addr;
1111 msg.flags = client->flags & I2C_M_TEN;
1112 msg.len = count;
1113 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01001114
Jean Delvare815f55f2005-05-07 22:58:46 +02001115 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
Jean Delvare815f55f2005-05-07 22:58:46 +02001117 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1118 transmitted, else error code. */
1119 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120}
David Brownellc0564602007-05-01 23:26:31 +02001121EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122
David Brownella1cdeda2008-07-14 22:38:24 +02001123/**
1124 * i2c_master_recv - issue a single I2C message in master receive mode
1125 * @client: Handle to slave device
1126 * @buf: Where to store data read from slave
1127 * @count: How many bytes to read
1128 *
1129 * Returns negative errno, or else the number of bytes read.
1130 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
1132{
1133 struct i2c_adapter *adap=client->adapter;
1134 struct i2c_msg msg;
1135 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136
Jean Delvare815f55f2005-05-07 22:58:46 +02001137 msg.addr = client->addr;
1138 msg.flags = client->flags & I2C_M_TEN;
1139 msg.flags |= I2C_M_RD;
1140 msg.len = count;
1141 msg.buf = buf;
1142
1143 ret = i2c_transfer(adap, &msg, 1);
1144
1145 /* If everything went ok (i.e. 1 msg transmitted), return #bytes
1146 transmitted, else error code. */
1147 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148}
David Brownellc0564602007-05-01 23:26:31 +02001149EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151/* ----------------------------------------------------
1152 * the i2c address scanning function
1153 * Will not work for 10-bit addresses!
1154 * ----------------------------------------------------
1155 */
Jean Delvare9fc6adf2005-07-31 21:20:43 +02001156
Jean Delvareccfbbd02009-12-06 17:06:25 +01001157static int i2c_detect_address(struct i2c_client *temp_client,
Jean Delvare4735c982008-07-14 22:38:36 +02001158 struct i2c_driver *driver)
1159{
1160 struct i2c_board_info info;
1161 struct i2c_adapter *adapter = temp_client->adapter;
1162 int addr = temp_client->addr;
1163 int err;
1164
1165 /* Make sure the address is valid */
1166 if (addr < 0x03 || addr > 0x77) {
1167 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
1168 addr);
1169 return -EINVAL;
1170 }
1171
1172 /* Skip if already in use */
1173 if (i2c_check_addr(adapter, addr))
1174 return 0;
1175
Jean Delvareccfbbd02009-12-06 17:06:25 +01001176 /* Make sure there is something at this address */
1177 if (i2c_smbus_xfer(adapter, addr, 0, 0, 0, I2C_SMBUS_QUICK, NULL) < 0)
1178 return 0;
Jean Delvare4735c982008-07-14 22:38:36 +02001179
Jean Delvareccfbbd02009-12-06 17:06:25 +01001180 /* Prevent 24RF08 corruption */
1181 if ((addr & ~0x0f) == 0x50)
1182 i2c_smbus_xfer(adapter, addr, 0, 0, 0, I2C_SMBUS_QUICK, NULL);
Jean Delvare4735c982008-07-14 22:38:36 +02001183
1184 /* Finally call the custom detection function */
1185 memset(&info, 0, sizeof(struct i2c_board_info));
1186 info.addr = addr;
Jean Delvare310ec792009-12-14 21:17:23 +01001187 err = driver->detect(temp_client, &info);
Jean Delvare4735c982008-07-14 22:38:36 +02001188 if (err) {
1189 /* -ENODEV is returned if the detection fails. We catch it
1190 here as this isn't an error. */
1191 return err == -ENODEV ? 0 : err;
1192 }
1193
1194 /* Consistency check */
1195 if (info.type[0] == '\0') {
1196 dev_err(&adapter->dev, "%s detection function provided "
1197 "no name for 0x%x\n", driver->driver.name,
1198 addr);
1199 } else {
1200 struct i2c_client *client;
1201
1202 /* Detection succeeded, instantiate the device */
1203 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
1204 info.type, info.addr);
1205 client = i2c_new_device(adapter, &info);
1206 if (client)
1207 list_add_tail(&client->detected, &driver->clients);
1208 else
1209 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
1210 info.type, info.addr);
1211 }
1212 return 0;
1213}
1214
1215static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
1216{
Jean Delvarec3813d62009-12-14 21:17:25 +01001217 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +02001218 struct i2c_client *temp_client;
1219 int i, err = 0;
1220 int adap_id = i2c_adapter_id(adapter);
1221
Jean Delvarec3813d62009-12-14 21:17:25 +01001222 address_list = driver->address_list;
1223 if (!driver->detect || !address_list)
Jean Delvare4735c982008-07-14 22:38:36 +02001224 return 0;
1225
1226 /* Set up a temporary client to help detect callback */
1227 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
1228 if (!temp_client)
1229 return -ENOMEM;
1230 temp_client->adapter = adapter;
1231
Jean Delvare4329cf82008-08-28 08:33:23 +02001232 /* Stop here if the classes do not match */
1233 if (!(adapter->class & driver->class))
1234 goto exit_free;
1235
Jean Delvare4735c982008-07-14 22:38:36 +02001236 /* Stop here if we can't use SMBUS_QUICK */
1237 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
Jean Delvarec3813d62009-12-14 21:17:25 +01001238 if (address_list[0] == I2C_CLIENT_END)
Jean Delvare4735c982008-07-14 22:38:36 +02001239 goto exit_free;
1240
1241 dev_warn(&adapter->dev, "SMBus Quick command not supported, "
1242 "can't probe for chips\n");
1243 err = -EOPNOTSUPP;
1244 goto exit_free;
1245 }
1246
Jean Delvarec3813d62009-12-14 21:17:25 +01001247 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
Jean Delvare4735c982008-07-14 22:38:36 +02001248 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
Jean Delvarec3813d62009-12-14 21:17:25 +01001249 "addr 0x%02x\n", adap_id, address_list[i]);
1250 temp_client->addr = address_list[i];
Jean Delvareccfbbd02009-12-06 17:06:25 +01001251 err = i2c_detect_address(temp_client, driver);
Jean Delvare4735c982008-07-14 22:38:36 +02001252 if (err)
1253 goto exit_free;
1254 }
1255
1256 exit_free:
1257 kfree(temp_client);
1258 return err;
1259}
1260
Jean Delvare12b5053a2007-05-01 23:26:31 +02001261struct i2c_client *
1262i2c_new_probed_device(struct i2c_adapter *adap,
1263 struct i2c_board_info *info,
1264 unsigned short const *addr_list)
1265{
1266 int i;
1267
1268 /* Stop here if the bus doesn't support probing */
1269 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
1270 dev_err(&adap->dev, "Probing not supported\n");
1271 return NULL;
1272 }
1273
Jean Delvare12b5053a2007-05-01 23:26:31 +02001274 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
1275 /* Check address validity */
1276 if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
1277 dev_warn(&adap->dev, "Invalid 7-bit address "
1278 "0x%02x\n", addr_list[i]);
1279 continue;
1280 }
1281
1282 /* Check address availability */
David Brownell9b766b82008-01-27 18:14:51 +01001283 if (i2c_check_addr(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02001284 dev_dbg(&adap->dev, "Address 0x%02x already in "
1285 "use, not probing\n", addr_list[i]);
1286 continue;
1287 }
1288
1289 /* Test address responsiveness
1290 The default probe method is a quick write, but it is known
1291 to corrupt the 24RF08 EEPROMs due to a state machine bug,
1292 and could also irreversibly write-protect some EEPROMs, so
1293 for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
1294 read instead. Also, some bus drivers don't implement
1295 quick write, so we fallback to a byte read it that case
1296 too. */
1297 if ((addr_list[i] & ~0x07) == 0x30
1298 || (addr_list[i] & ~0x0f) == 0x50
1299 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
Hans Verkuilb25b7912008-08-10 22:56:15 +02001300 union i2c_smbus_data data;
1301
Jean Delvare12b5053a2007-05-01 23:26:31 +02001302 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1303 I2C_SMBUS_READ, 0,
Hans Verkuilb25b7912008-08-10 22:56:15 +02001304 I2C_SMBUS_BYTE, &data) >= 0)
Jean Delvare12b5053a2007-05-01 23:26:31 +02001305 break;
1306 } else {
1307 if (i2c_smbus_xfer(adap, addr_list[i], 0,
1308 I2C_SMBUS_WRITE, 0,
1309 I2C_SMBUS_QUICK, NULL) >= 0)
1310 break;
1311 }
1312 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02001313
1314 if (addr_list[i] == I2C_CLIENT_END) {
1315 dev_dbg(&adap->dev, "Probing failed, no device found\n");
1316 return NULL;
1317 }
1318
1319 info->addr = addr_list[i];
1320 return i2c_new_device(adap, info);
1321}
1322EXPORT_SYMBOL_GPL(i2c_new_probed_device);
1323
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324struct i2c_adapter* i2c_get_adapter(int id)
1325{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01001327
Jean Delvarecaada322008-01-27 18:14:49 +01001328 mutex_lock(&core_lock);
Jack Stone1cf92b42009-06-15 18:01:46 +02001329 adapter = idr_find(&i2c_adapter_idr, id);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001330 if (adapter && !try_module_get(adapter->owner))
1331 adapter = NULL;
1332
Jean Delvarecaada322008-01-27 18:14:49 +01001333 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04001334 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335}
David Brownellc0564602007-05-01 23:26:31 +02001336EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
1338void i2c_put_adapter(struct i2c_adapter *adap)
1339{
1340 module_put(adap->owner);
1341}
David Brownellc0564602007-05-01 23:26:31 +02001342EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
1344/* The SMBus parts */
1345
David Brownell438d6c22006-12-10 21:21:31 +01001346#define POLY (0x1070U << 3)
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001347static u8 crc8(u16 data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348{
1349 int i;
David Brownell438d6c22006-12-10 21:21:31 +01001350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 for(i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01001352 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 data = data ^ POLY;
1354 data = data << 1;
1355 }
1356 return (u8)(data >> 8);
1357}
1358
Jean Delvare421ef472005-10-26 21:28:55 +02001359/* Incremental CRC8 over count bytes in the array pointed to by p */
1360static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361{
1362 int i;
1363
1364 for(i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02001365 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 return crc;
1367}
1368
Jean Delvare421ef472005-10-26 21:28:55 +02001369/* Assume a 7-bit address, which is reasonable for SMBus */
1370static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371{
Jean Delvare421ef472005-10-26 21:28:55 +02001372 /* The address will be sent first */
1373 u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
1374 pec = i2c_smbus_pec(pec, &addr, 1);
1375
1376 /* The data buffer follows */
1377 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378}
1379
Jean Delvare421ef472005-10-26 21:28:55 +02001380/* Used for write only transactions */
1381static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382{
Jean Delvare421ef472005-10-26 21:28:55 +02001383 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
1384 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385}
1386
Jean Delvare421ef472005-10-26 21:28:55 +02001387/* Return <0 on CRC error
1388 If there was a write before this read (most cases) we need to take the
1389 partial CRC from the write part into account.
1390 Note that this function does modify the message (we need to decrease the
1391 message length to hide the CRC byte from the caller). */
1392static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393{
Jean Delvare421ef472005-10-26 21:28:55 +02001394 u8 rpec = msg->buf[--msg->len];
1395 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 if (rpec != cpec) {
1398 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
1399 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02001400 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 }
David Brownell438d6c22006-12-10 21:21:31 +01001402 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403}
1404
David Brownella1cdeda2008-07-14 22:38:24 +02001405/**
1406 * i2c_smbus_read_byte - SMBus "receive byte" protocol
1407 * @client: Handle to slave device
1408 *
1409 * This executes the SMBus "receive byte" protocol, returning negative errno
1410 * else the byte received from the device.
1411 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412s32 i2c_smbus_read_byte(struct i2c_client *client)
1413{
1414 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001415 int status;
1416
1417 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1418 I2C_SMBUS_READ, 0,
1419 I2C_SMBUS_BYTE, &data);
1420 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421}
David Brownellc0564602007-05-01 23:26:31 +02001422EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
David Brownella1cdeda2008-07-14 22:38:24 +02001424/**
1425 * i2c_smbus_write_byte - SMBus "send byte" protocol
1426 * @client: Handle to slave device
1427 * @value: Byte to be sent
1428 *
1429 * This executes the SMBus "send byte" protocol, returning negative errno
1430 * else zero on success.
1431 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
1433{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02001435 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436}
David Brownellc0564602007-05-01 23:26:31 +02001437EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438
David Brownella1cdeda2008-07-14 22:38:24 +02001439/**
1440 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
1441 * @client: Handle to slave device
1442 * @command: Byte interpreted by slave
1443 *
1444 * This executes the SMBus "read byte" protocol, returning negative errno
1445 * else a data byte received from the device.
1446 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
1448{
1449 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001450 int status;
1451
1452 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1453 I2C_SMBUS_READ, command,
1454 I2C_SMBUS_BYTE_DATA, &data);
1455 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456}
David Brownellc0564602007-05-01 23:26:31 +02001457EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
David Brownella1cdeda2008-07-14 22:38:24 +02001459/**
1460 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
1461 * @client: Handle to slave device
1462 * @command: Byte interpreted by slave
1463 * @value: Byte being written
1464 *
1465 * This executes the SMBus "write byte" protocol, returning negative errno
1466 * else zero on success.
1467 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
1469{
1470 union i2c_smbus_data data;
1471 data.byte = value;
1472 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1473 I2C_SMBUS_WRITE,command,
1474 I2C_SMBUS_BYTE_DATA,&data);
1475}
David Brownellc0564602007-05-01 23:26:31 +02001476EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477
David Brownella1cdeda2008-07-14 22:38:24 +02001478/**
1479 * i2c_smbus_read_word_data - SMBus "read word" protocol
1480 * @client: Handle to slave device
1481 * @command: Byte interpreted by slave
1482 *
1483 * This executes the SMBus "read word" protocol, returning negative errno
1484 * else a 16-bit unsigned "word" received from the device.
1485 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
1487{
1488 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001489 int status;
1490
1491 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1492 I2C_SMBUS_READ, command,
1493 I2C_SMBUS_WORD_DATA, &data);
1494 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495}
David Brownellc0564602007-05-01 23:26:31 +02001496EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497
David Brownella1cdeda2008-07-14 22:38:24 +02001498/**
1499 * i2c_smbus_write_word_data - SMBus "write word" protocol
1500 * @client: Handle to slave device
1501 * @command: Byte interpreted by slave
1502 * @value: 16-bit "word" being written
1503 *
1504 * This executes the SMBus "write word" protocol, returning negative errno
1505 * else zero on success.
1506 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
1508{
1509 union i2c_smbus_data data;
1510 data.word = value;
1511 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1512 I2C_SMBUS_WRITE,command,
1513 I2C_SMBUS_WORD_DATA,&data);
1514}
David Brownellc0564602007-05-01 23:26:31 +02001515EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
David Brownella64ec072007-10-13 23:56:31 +02001517/**
Prakash Mortha596c88f2008-10-14 17:30:06 +02001518 * i2c_smbus_process_call - SMBus "process call" protocol
1519 * @client: Handle to slave device
1520 * @command: Byte interpreted by slave
1521 * @value: 16-bit "word" being written
1522 *
1523 * This executes the SMBus "process call" protocol, returning negative errno
1524 * else a 16-bit unsigned "word" received from the device.
1525 */
1526s32 i2c_smbus_process_call(struct i2c_client *client, u8 command, u16 value)
1527{
1528 union i2c_smbus_data data;
1529 int status;
1530 data.word = value;
1531
1532 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1533 I2C_SMBUS_WRITE, command,
1534 I2C_SMBUS_PROC_CALL, &data);
1535 return (status < 0) ? status : data.word;
1536}
1537EXPORT_SYMBOL(i2c_smbus_process_call);
1538
1539/**
David Brownella1cdeda2008-07-14 22:38:24 +02001540 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02001541 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02001542 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02001543 * @values: Byte array into which data will be read; big enough to hold
1544 * the data returned by the slave. SMBus allows at most 32 bytes.
1545 *
David Brownella1cdeda2008-07-14 22:38:24 +02001546 * This executes the SMBus "block read" protocol, returning negative errno
1547 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02001548 *
1549 * Note that using this function requires that the client's adapter support
1550 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
1551 * support this; its emulation through I2C messaging relies on a specific
1552 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
1553 */
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001554s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
1555 u8 *values)
1556{
1557 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001558 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001559
David Brownell24a5bb72008-07-14 22:38:23 +02001560 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1561 I2C_SMBUS_READ, command,
1562 I2C_SMBUS_BLOCK_DATA, &data);
1563 if (status)
1564 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02001565
1566 memcpy(values, &data.block[1], data.block[0]);
1567 return data.block[0];
1568}
1569EXPORT_SYMBOL(i2c_smbus_read_block_data);
1570
David Brownella1cdeda2008-07-14 22:38:24 +02001571/**
1572 * i2c_smbus_write_block_data - SMBus "block write" protocol
1573 * @client: Handle to slave device
1574 * @command: Byte interpreted by slave
1575 * @length: Size of data block; SMBus allows at most 32 bytes
1576 * @values: Byte array which will be written.
1577 *
1578 * This executes the SMBus "block write" protocol, returning negative errno
1579 * else zero on success.
1580 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001582 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583{
1584 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01001585
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 if (length > I2C_SMBUS_BLOCK_MAX)
1587 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01001589 memcpy(&data.block[1], values, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1591 I2C_SMBUS_WRITE,command,
1592 I2C_SMBUS_BLOCK_DATA,&data);
1593}
David Brownellc0564602007-05-01 23:26:31 +02001594EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
1596/* Returns the number of read bytes */
Jean Delvare4b2643d2007-07-12 14:12:29 +02001597s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
1598 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599{
1600 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02001601 int status;
Jean Delvare76560322006-01-18 23:14:55 +01001602
Jean Delvare4b2643d2007-07-12 14:12:29 +02001603 if (length > I2C_SMBUS_BLOCK_MAX)
1604 length = I2C_SMBUS_BLOCK_MAX;
1605 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02001606 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1607 I2C_SMBUS_READ, command,
1608 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1609 if (status < 0)
1610 return status;
Jean Delvare76560322006-01-18 23:14:55 +01001611
1612 memcpy(values, &data.block[1], data.block[0]);
1613 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614}
David Brownellc0564602007-05-01 23:26:31 +02001615EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
Jean Delvare21bbd692006-01-09 15:19:18 +11001617s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02001618 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11001619{
1620 union i2c_smbus_data data;
1621
1622 if (length > I2C_SMBUS_BLOCK_MAX)
1623 length = I2C_SMBUS_BLOCK_MAX;
1624 data.block[0] = length;
1625 memcpy(data.block + 1, values, length);
1626 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
1627 I2C_SMBUS_WRITE, command,
1628 I2C_SMBUS_I2C_BLOCK_DATA, &data);
1629}
David Brownellc0564602007-05-01 23:26:31 +02001630EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11001631
David Brownell438d6c22006-12-10 21:21:31 +01001632/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 No checking of parameters is done! */
David Brownell438d6c22006-12-10 21:21:31 +01001634static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 unsigned short flags,
David Brownell438d6c22006-12-10 21:21:31 +01001636 char read_write, u8 command, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 union i2c_smbus_data * data)
1638{
1639 /* So we need to generate a series of msgs. In the case of writing, we
1640 need to use only one message; when reading, we need two. We initialize
1641 most things with sane defaults, to keep the code below somewhat
1642 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001643 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
1644 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 int num = read_write == I2C_SMBUS_READ?2:1;
David Brownell438d6c22006-12-10 21:21:31 +01001646 struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 { addr, flags | I2C_M_RD, 0, msgbuf1 }
1648 };
1649 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02001650 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02001651 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
1653 msgbuf0[0] = command;
1654 switch(size) {
1655 case I2C_SMBUS_QUICK:
1656 msg[0].len = 0;
1657 /* Special case: The read/write field is used as data */
Roel Kluinf29d2e02009-02-24 19:19:48 +01001658 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
1659 I2C_M_RD : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 num = 1;
1661 break;
1662 case I2C_SMBUS_BYTE:
1663 if (read_write == I2C_SMBUS_READ) {
1664 /* Special case: only a read! */
1665 msg[0].flags = I2C_M_RD | flags;
1666 num = 1;
1667 }
1668 break;
1669 case I2C_SMBUS_BYTE_DATA:
1670 if (read_write == I2C_SMBUS_READ)
1671 msg[1].len = 1;
1672 else {
1673 msg[0].len = 2;
1674 msgbuf0[1] = data->byte;
1675 }
1676 break;
1677 case I2C_SMBUS_WORD_DATA:
1678 if (read_write == I2C_SMBUS_READ)
1679 msg[1].len = 2;
1680 else {
1681 msg[0].len=3;
1682 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001683 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 }
1685 break;
1686 case I2C_SMBUS_PROC_CALL:
1687 num = 2; /* Special case */
1688 read_write = I2C_SMBUS_READ;
1689 msg[0].len = 3;
1690 msg[1].len = 2;
1691 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02001692 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 break;
1694 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02001696 msg[1].flags |= I2C_M_RECV_LEN;
1697 msg[1].len = 1; /* block length will be added by
1698 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 } else {
1700 msg[0].len = data->block[0] + 2;
1701 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02001702 dev_err(&adapter->dev,
1703 "Invalid block write size %d\n",
1704 data->block[0]);
1705 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02001707 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 msgbuf0[i] = data->block[i-1];
1709 }
1710 break;
1711 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02001712 num = 2; /* Another special case */
1713 read_write = I2C_SMBUS_READ;
1714 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02001715 dev_err(&adapter->dev,
1716 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02001717 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02001718 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02001719 }
1720 msg[0].len = data->block[0] + 2;
1721 for (i = 1; i < msg[0].len; i++)
1722 msgbuf0[i] = data->block[i-1];
1723 msg[1].flags |= I2C_M_RECV_LEN;
1724 msg[1].len = 1; /* block length will be added by
1725 the underlying bus driver */
1726 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 case I2C_SMBUS_I2C_BLOCK_DATA:
1728 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02001729 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 } else {
1731 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02001732 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02001733 dev_err(&adapter->dev,
1734 "Invalid block write size %d\n",
1735 data->block[0]);
1736 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 }
1738 for (i = 1; i <= data->block[0]; i++)
1739 msgbuf0[i] = data->block[i];
1740 }
1741 break;
1742 default:
David Brownell24a5bb72008-07-14 22:38:23 +02001743 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
1744 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 }
1746
Jean Delvare421ef472005-10-26 21:28:55 +02001747 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
1748 && size != I2C_SMBUS_I2C_BLOCK_DATA);
1749 if (i) {
1750 /* Compute PEC if first message is a write */
1751 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01001752 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02001753 i2c_smbus_add_pec(&msg[0]);
1754 else /* Write followed by read */
1755 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
1756 }
1757 /* Ask for PEC if last message is a read */
1758 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01001759 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02001760 }
1761
David Brownell24a5bb72008-07-14 22:38:23 +02001762 status = i2c_transfer(adapter, msg, num);
1763 if (status < 0)
1764 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
Jean Delvare421ef472005-10-26 21:28:55 +02001766 /* Check PEC if last message is a read */
1767 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02001768 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
1769 if (status < 0)
1770 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02001771 }
1772
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 if (read_write == I2C_SMBUS_READ)
1774 switch(size) {
1775 case I2C_SMBUS_BYTE:
1776 data->byte = msgbuf0[0];
1777 break;
1778 case I2C_SMBUS_BYTE_DATA:
1779 data->byte = msgbuf1[0];
1780 break;
David Brownell438d6c22006-12-10 21:21:31 +01001781 case I2C_SMBUS_WORD_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 case I2C_SMBUS_PROC_CALL:
1783 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
1784 break;
1785 case I2C_SMBUS_I2C_BLOCK_DATA:
Jean Delvare4b2643d2007-07-12 14:12:29 +02001786 for (i = 0; i < data->block[0]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 data->block[i+1] = msgbuf1[i];
1788 break;
Jean Delvare209d27c2007-05-01 23:26:29 +02001789 case I2C_SMBUS_BLOCK_DATA:
1790 case I2C_SMBUS_BLOCK_PROC_CALL:
1791 for (i = 0; i < msgbuf1[0] + 1; i++)
1792 data->block[i] = msgbuf1[i];
1793 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 }
1795 return 0;
1796}
1797
David Brownella1cdeda2008-07-14 22:38:24 +02001798/**
1799 * i2c_smbus_xfer - execute SMBus protocol operations
1800 * @adapter: Handle to I2C bus
1801 * @addr: Address of SMBus slave on that bus
1802 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
1803 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
1804 * @command: Byte interpreted by slave, for protocols which use such bytes
1805 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
1806 * @data: Data to be read or written
1807 *
1808 * This executes an SMBus protocol operation, and returns a negative
1809 * errno code else zero on success.
1810 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001811s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02001812 char read_write, u8 command, int protocol,
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001813 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814{
Clifford Wolf66b650f2009-06-15 18:01:46 +02001815 unsigned long orig_jiffies;
1816 int try;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818
1819 flags &= I2C_M_TEN | I2C_CLIENT_PEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820
1821 if (adapter->algo->smbus_xfer) {
Mika Kuoppala194684e2009-12-06 17:06:22 +01001822 rt_mutex_lock(&adapter->bus_lock);
Clifford Wolf66b650f2009-06-15 18:01:46 +02001823
1824 /* Retry automatically on arbitration loss */
1825 orig_jiffies = jiffies;
1826 for (res = 0, try = 0; try <= adapter->retries; try++) {
1827 res = adapter->algo->smbus_xfer(adapter, addr, flags,
1828 read_write, command,
1829 protocol, data);
1830 if (res != -EAGAIN)
1831 break;
1832 if (time_after(jiffies,
1833 orig_jiffies + adapter->timeout))
1834 break;
1835 }
Mika Kuoppala194684e2009-12-06 17:06:22 +01001836 rt_mutex_unlock(&adapter->bus_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 } else
1838 res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
David Brownella1cdeda2008-07-14 22:38:24 +02001839 command, protocol, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 return res;
1842}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
1845MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
1846MODULE_DESCRIPTION("I2C-Bus main module");
1847MODULE_LICENSE("GPL");