i2c-core.c 43.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* i2c-core.c - a device driver for the iic-bus interface		     */
/* ------------------------------------------------------------------------- */
/*   Copyright (C) 1995-99 Simon G. Vogl

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.		     */
/* ------------------------------------------------------------------------- */

20
/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
L
Linus Torvalds 已提交
21
   All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
22 23
   SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
   Jean Delvare <khali@linux-fr.org> */
L
Linus Torvalds 已提交
24 25 26 27 28 29 30 31

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/init.h>
#include <linux/idr.h>
32
#include <linux/platform_device.h>
33
#include <linux/mutex.h>
J
Jean Delvare 已提交
34
#include <linux/completion.h>
35 36
#include <linux/hardirq.h>
#include <linux/irqflags.h>
L
Linus Torvalds 已提交
37 38
#include <asm/uaccess.h>

39 40
#include "i2c-core.h"

L
Linus Torvalds 已提交
41

J
Jean Delvare 已提交
42
static DEFINE_MUTEX(core_lock);
L
Linus Torvalds 已提交
43 44
static DEFINE_IDR(i2c_adapter_idr);

D
David Brownell 已提交
45
#define is_newstyle_driver(d) ((d)->probe || (d)->remove)
46 47 48

/* ------------------------------------------------------------------------- */

49 50 51 52 53 54 55 56 57 58 59
static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
						const struct i2c_client *client)
{
	while (id->name[0]) {
		if (strcmp(client->name, id->name) == 0)
			return id;
		id++;
	}
	return NULL;
}

L
Linus Torvalds 已提交
60 61
static int i2c_device_match(struct device *dev, struct device_driver *drv)
{
D
David Brownell 已提交
62 63 64 65 66 67
	struct i2c_client	*client = to_i2c_client(dev);
	struct i2c_driver	*driver = to_i2c_driver(drv);

	/* make legacy i2c drivers bypass driver model probing entirely;
	 * such drivers scan each i2c adapter/bus themselves.
	 */
D
David Brownell 已提交
68
	if (!is_newstyle_driver(driver))
D
David Brownell 已提交
69 70
		return 0;

71 72 73 74
	/* match on an id table if there is one */
	if (driver->id_table)
		return i2c_match_id(driver->id_table, client) != NULL;

75
	return 0;
L
Linus Torvalds 已提交
76 77
}

D
David Brownell 已提交
78 79 80
#ifdef	CONFIG_HOTPLUG

/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
81
static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
D
David Brownell 已提交
82 83 84 85
{
	struct i2c_client	*client = to_i2c_client(dev);

	/* by definition, legacy drivers can't hotplug */
86
	if (dev->driver)
D
David Brownell 已提交
87 88
		return 0;

89 90 91
	if (add_uevent_var(env, "MODALIAS=%s%s",
			   I2C_MODULE_PREFIX, client->name))
		return -ENOMEM;
D
David Brownell 已提交
92 93 94 95 96 97 98 99
	dev_dbg(dev, "uevent\n");
	return 0;
}

#else
#define i2c_device_uevent	NULL
#endif	/* CONFIG_HOTPLUG */

100
static int i2c_device_probe(struct device *dev)
L
Linus Torvalds 已提交
101
{
D
David Brownell 已提交
102 103
	struct i2c_client	*client = to_i2c_client(dev);
	struct i2c_driver	*driver = to_i2c_driver(dev->driver);
104
	const struct i2c_device_id *id;
105
	int status;
D
David Brownell 已提交
106 107 108 109 110

	if (!driver->probe)
		return -ENODEV;
	client->driver = driver;
	dev_dbg(dev, "probe\n");
111 112 113 114 115 116

	if (driver->id_table)
		id = i2c_match_id(driver->id_table, client);
	else
		id = NULL;
	status = driver->probe(client, id);
117 118 119
	if (status)
		client->driver = NULL;
	return status;
120
}
L
Linus Torvalds 已提交
121

122 123
static int i2c_device_remove(struct device *dev)
{
D
David Brownell 已提交
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
	struct i2c_client	*client = to_i2c_client(dev);
	struct i2c_driver	*driver;
	int			status;

	if (!dev->driver)
		return 0;

	driver = to_i2c_driver(dev->driver);
	if (driver->remove) {
		dev_dbg(dev, "remove\n");
		status = driver->remove(client);
	} else {
		dev->driver = NULL;
		status = 0;
	}
	if (status == 0)
		client->driver = NULL;
	return status;
L
Linus Torvalds 已提交
142 143
}

144
static void i2c_device_shutdown(struct device *dev)
L
Linus Torvalds 已提交
145
{
146 147 148 149 150 151 152
	struct i2c_driver *driver;

	if (!dev->driver)
		return;
	driver = to_i2c_driver(dev->driver);
	if (driver->shutdown)
		driver->shutdown(to_i2c_client(dev));
L
Linus Torvalds 已提交
153 154
}

155
static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
L
Linus Torvalds 已提交
156
{
157 158 159 160 161 162 163 164
	struct i2c_driver *driver;

	if (!dev->driver)
		return 0;
	driver = to_i2c_driver(dev->driver);
	if (!driver->suspend)
		return 0;
	return driver->suspend(to_i2c_client(dev), mesg);
L
Linus Torvalds 已提交
165 166
}

167
static int i2c_device_resume(struct device * dev)
L
Linus Torvalds 已提交
168
{
169 170 171 172 173 174 175 176
	struct i2c_driver *driver;

	if (!dev->driver)
		return 0;
	driver = to_i2c_driver(dev->driver);
	if (!driver->resume)
		return 0;
	return driver->resume(to_i2c_client(dev));
L
Linus Torvalds 已提交
177 178
}

D
David Brownell 已提交
179 180 181 182 183 184
static void i2c_client_release(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	complete(&client->released);
}

185 186 187 188 189
static void i2c_client_dev_release(struct device *dev)
{
	kfree(to_i2c_client(dev));
}

D
David Brownell 已提交
190 191 192 193 194 195 196 197 198
static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct i2c_client *client = to_i2c_client(dev);
	return sprintf(buf, "%s\n", client->name);
}

static ssize_t show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct i2c_client *client = to_i2c_client(dev);
199
	return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
D
David Brownell 已提交
200 201 202 203 204 205 206 207 208
}

static struct device_attribute i2c_dev_attrs[] = {
	__ATTR(name, S_IRUGO, show_client_name, NULL),
	/* modalias helps coldplug:  modprobe $(cat .../modalias) */
	__ATTR(modalias, S_IRUGO, show_modalias, NULL),
	{ },
};

A
Adrian Bunk 已提交
209
static struct bus_type i2c_bus_type = {
210
	.name		= "i2c",
D
David Brownell 已提交
211
	.dev_attrs	= i2c_dev_attrs,
212
	.match		= i2c_device_match,
D
David Brownell 已提交
213
	.uevent		= i2c_device_uevent,
214 215 216 217 218
	.probe		= i2c_device_probe,
	.remove		= i2c_device_remove,
	.shutdown	= i2c_device_shutdown,
	.suspend	= i2c_device_suspend,
	.resume		= i2c_device_resume,
219 220
};

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

/**
 * i2c_verify_client - return parameter as i2c_client, or NULL
 * @dev: device, probably from some driver model iterator
 *
 * When traversing the driver model tree, perhaps using driver model
 * iterators like @device_for_each_child(), you can't assume very much
 * about the nodes you find.  Use this function to avoid oopses caused
 * by wrongly treating some non-I2C device as an i2c_client.
 */
struct i2c_client *i2c_verify_client(struct device *dev)
{
	return (dev->bus == &i2c_bus_type)
			? to_i2c_client(dev)
			: NULL;
}
EXPORT_SYMBOL(i2c_verify_client);


240 241 242 243
/**
 * i2c_new_device - instantiate an i2c device for use with a new style driver
 * @adap: the adapter managing the device
 * @info: describes one I2C device; bus_num is ignored
D
David Brownell 已提交
244
 * Context: can sleep
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
 *
 * Create a device to work with a new style i2c driver, where binding is
 * handled through driver model probe()/remove() methods.  This call is not
 * appropriate for use by mainboad initialization logic, which usually runs
 * during an arch_initcall() long before any i2c_adapter could exist.
 *
 * This returns the new i2c client, which may be saved for later use with
 * i2c_unregister_device(); or NULL to indicate an error.
 */
struct i2c_client *
i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
{
	struct i2c_client	*client;
	int			status;

	client = kzalloc(sizeof *client, GFP_KERNEL);
	if (!client)
		return NULL;

	client->adapter = adap;

	client->dev.platform_data = info->platform_data;
267 268 269
	device_init_wakeup(&client->dev, info->flags & I2C_CLIENT_WAKE);

	client->flags = info->flags & ~I2C_CLIENT_WAKE;
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
	client->addr = info->addr;
	client->irq = info->irq;

	strlcpy(client->name, info->type, sizeof(client->name));

	/* a new style driver may be bound to this device when we
	 * return from this function, or any later moment (e.g. maybe
	 * hotplugging will load the driver module).  and the device
	 * refcount model is the standard driver model one.
	 */
	status = i2c_attach_client(client);
	if (status < 0) {
		kfree(client);
		client = NULL;
	}
	return client;
}
EXPORT_SYMBOL_GPL(i2c_new_device);


/**
 * i2c_unregister_device - reverse effect of i2c_new_device()
 * @client: value returned from i2c_new_device()
D
David Brownell 已提交
293
 * Context: can sleep
294 295
 */
void i2c_unregister_device(struct i2c_client *client)
D
David Brownell 已提交
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
{
	struct i2c_adapter	*adapter = client->adapter;
	struct i2c_driver	*driver = client->driver;

	if (driver && !is_newstyle_driver(driver)) {
		dev_err(&client->dev, "can't unregister devices "
			"with legacy drivers\n");
		WARN_ON(1);
		return;
	}

	mutex_lock(&adapter->clist_lock);
	list_del(&client->list);
	mutex_unlock(&adapter->clist_lock);

	device_unregister(&client->dev);
}
313
EXPORT_SYMBOL_GPL(i2c_unregister_device);
D
David Brownell 已提交
314 315


J
Jean Delvare 已提交
316 317 318 319 320
static const struct i2c_device_id dummy_id[] = {
	{ "dummy", 0 },
	{ },
};

321 322 323 324 325 326 327
static int dummy_probe(struct i2c_client *client,
		       const struct i2c_device_id *id)
{
	return 0;
}

static int dummy_remove(struct i2c_client *client)
328 329 330 331 332 333
{
	return 0;
}

static struct i2c_driver dummy_driver = {
	.driver.name	= "dummy",
334 335
	.probe		= dummy_probe,
	.remove		= dummy_remove,
J
Jean Delvare 已提交
336
	.id_table	= dummy_id,
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
};

/**
 * i2c_new_dummy - return a new i2c device bound to a dummy driver
 * @adapter: the adapter managing the device
 * @address: seven bit address to be used
 * Context: can sleep
 *
 * This returns an I2C client bound to the "dummy" driver, intended for use
 * with devices that consume multiple addresses.  Examples of such chips
 * include various EEPROMS (like 24c04 and 24c08 models).
 *
 * These dummy devices have two main uses.  First, most I2C and SMBus calls
 * except i2c_transfer() need a client handle; the dummy will be that handle.
 * And second, this prevents the specified address from being bound to a
 * different driver.
 *
 * This returns the new i2c client, which should be saved for later use with
 * i2c_unregister_device(); or NULL to indicate an error.
 */
struct i2c_client *
J
Jean Delvare 已提交
358
i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
359 360
{
	struct i2c_board_info info = {
J
Jean Delvare 已提交
361
		I2C_BOARD_INFO("dummy", address),
362 363 364 365 366 367
	};

	return i2c_new_device(adapter, &info);
}
EXPORT_SYMBOL_GPL(i2c_new_dummy);

368 369
/* ------------------------------------------------------------------------- */

D
David Brownell 已提交
370 371
/* I2C bus adapters -- one roots each I2C or SMBUS segment */

A
Adrian Bunk 已提交
372
static void i2c_adapter_dev_release(struct device *dev)
L
Linus Torvalds 已提交
373
{
374
	struct i2c_adapter *adap = to_i2c_adapter(dev);
L
Linus Torvalds 已提交
375 376 377
	complete(&adap->dev_released);
}

D
David Brownell 已提交
378 379 380
static ssize_t
show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
{
381
	struct i2c_adapter *adap = to_i2c_adapter(dev);
D
David Brownell 已提交
382 383
	return sprintf(buf, "%s\n", adap->name);
}
384

D
David Brownell 已提交
385 386 387 388
static struct device_attribute i2c_adapter_attrs[] = {
	__ATTR(name, S_IRUGO, show_adapter_name, NULL),
	{ },
};
389

A
Adrian Bunk 已提交
390
static struct class i2c_adapter_class = {
391 392
	.owner			= THIS_MODULE,
	.name			= "i2c-adapter",
D
David Brownell 已提交
393
	.dev_attrs		= i2c_adapter_attrs,
L
Linus Torvalds 已提交
394 395
};

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
{
	struct i2c_devinfo	*devinfo;

	mutex_lock(&__i2c_board_lock);
	list_for_each_entry(devinfo, &__i2c_board_list, list) {
		if (devinfo->busnum == adapter->nr
				&& !i2c_new_device(adapter,
						&devinfo->board_info))
			printk(KERN_ERR "i2c-core: can't create i2c%d-%04x\n",
				i2c_adapter_id(adapter),
				devinfo->board_info.addr);
	}
	mutex_unlock(&__i2c_board_lock);
}

412 413 414 415 416 417 418 419 420 421 422 423
static int i2c_do_add_adapter(struct device_driver *d, void *data)
{
	struct i2c_driver *driver = to_i2c_driver(d);
	struct i2c_adapter *adap = data;

	if (driver->attach_adapter) {
		/* We ignore the return code; if it fails, too bad */
		driver->attach_adapter(adap);
	}
	return 0;
}

424
static int i2c_register_adapter(struct i2c_adapter *adap)
L
Linus Torvalds 已提交
425
{
426
	int res = 0, dummy;
L
Linus Torvalds 已提交
427

428 429
	mutex_init(&adap->bus_lock);
	mutex_init(&adap->clist_lock);
L
Linus Torvalds 已提交
430 431
	INIT_LIST_HEAD(&adap->clients);

J
Jean Delvare 已提交
432
	mutex_lock(&core_lock);
433

L
Linus Torvalds 已提交
434 435 436 437
	/* Add the adapter to the driver core.
	 * If the parent pointer is not set up,
	 * we add this adapter to the host bus.
	 */
438
	if (adap->dev.parent == NULL) {
L
Linus Torvalds 已提交
439
		adap->dev.parent = &platform_bus;
440 441
		pr_debug("I2C adapter driver [%s] forgot to specify "
			 "physical device\n", adap->name);
442
	}
L
Linus Torvalds 已提交
443 444
	sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
	adap->dev.release = &i2c_adapter_dev_release;
J
Jean Delvare 已提交
445
	adap->dev.class = &i2c_adapter_class;
446 447 448
	res = device_register(&adap->dev);
	if (res)
		goto out_list;
L
Linus Torvalds 已提交
449

450 451
	dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);

452 453 454 455
	/* create pre-declared device nodes for new-style drivers */
	if (adap->nr < __i2c_first_dynamic_bus_num)
		i2c_scan_static_board_info(adap);

D
David Brownell 已提交
456
	/* let legacy drivers scan this bus for matching devices */
457 458
	dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
				 i2c_do_add_adapter);
L
Linus Torvalds 已提交
459 460

out_unlock:
J
Jean Delvare 已提交
461
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
462
	return res;
463 464 465 466

out_list:
	idr_remove(&i2c_adapter_idr, adap->nr);
	goto out_unlock;
L
Linus Torvalds 已提交
467 468
}

469 470 471
/**
 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
 * @adapter: the adapter to add
D
David Brownell 已提交
472
 * Context: can sleep
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
 *
 * This routine is used to declare an I2C adapter when its bus number
 * doesn't matter.  Examples: for I2C adapters dynamically added by
 * USB links or PCI plugin cards.
 *
 * When this returns zero, a new bus number was allocated and stored
 * in adap->nr, and the specified adapter became available for clients.
 * Otherwise, a negative errno value is returned.
 */
int i2c_add_adapter(struct i2c_adapter *adapter)
{
	int	id, res = 0;

retry:
	if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
		return -ENOMEM;

J
Jean Delvare 已提交
490
	mutex_lock(&core_lock);
491 492 493
	/* "above" here means "above or equal to", sigh */
	res = idr_get_new_above(&i2c_adapter_idr, adapter,
				__i2c_first_dynamic_bus_num, &id);
J
Jean Delvare 已提交
494
	mutex_unlock(&core_lock);
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509

	if (res < 0) {
		if (res == -EAGAIN)
			goto retry;
		return res;
	}

	adapter->nr = id;
	return i2c_register_adapter(adapter);
}
EXPORT_SYMBOL(i2c_add_adapter);

/**
 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
 * @adap: the adapter to register (with adap->nr initialized)
D
David Brownell 已提交
510
 * Context: can sleep
511 512
 *
 * This routine is used to declare an I2C adapter when its bus number
R
Randy Dunlap 已提交
513 514
 * matters.  For example, use it for I2C adapters from system-on-chip CPUs,
 * or otherwise built in to the system's mainboard, and where i2c_board_info
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
 * is used to properly configure I2C devices.
 *
 * If no devices have pre-been declared for this bus, then be sure to
 * register the adapter before any dynamically allocated ones.  Otherwise
 * the required bus ID may not be available.
 *
 * When this returns zero, the specified adapter became available for
 * clients using the bus number provided in adap->nr.  Also, the table
 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
 * and the appropriate driver model device nodes are created.  Otherwise, a
 * negative errno value is returned.
 */
int i2c_add_numbered_adapter(struct i2c_adapter *adap)
{
	int	id;
	int	status;

	if (adap->nr & ~MAX_ID_MASK)
		return -EINVAL;

retry:
	if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)
		return -ENOMEM;

J
Jean Delvare 已提交
539
	mutex_lock(&core_lock);
540 541 542 543 544 545 546 547
	/* "above" here means "above or equal to", sigh;
	 * we need the "equal to" result to force the result
	 */
	status = idr_get_new_above(&i2c_adapter_idr, adap, adap->nr, &id);
	if (status == 0 && id != adap->nr) {
		status = -EBUSY;
		idr_remove(&i2c_adapter_idr, id);
	}
J
Jean Delvare 已提交
548
	mutex_unlock(&core_lock);
549 550 551 552 553 554 555 556 557
	if (status == -EAGAIN)
		goto retry;

	if (status == 0)
		status = i2c_register_adapter(adap);
	return status;
}
EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);

558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
static int i2c_do_del_adapter(struct device_driver *d, void *data)
{
	struct i2c_driver *driver = to_i2c_driver(d);
	struct i2c_adapter *adapter = data;
	int res;

	if (!driver->detach_adapter)
		return 0;
	res = driver->detach_adapter(adapter);
	if (res)
		dev_err(&adapter->dev, "detach_adapter failed (%d) "
			"for driver [%s]\n", res, driver->driver.name);
	return res;
}

D
David Brownell 已提交
573 574 575 576 577 578 579 580
/**
 * i2c_del_adapter - unregister I2C adapter
 * @adap: the adapter being unregistered
 * Context: can sleep
 *
 * This unregisters an I2C adapter which was previously registered
 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
 */
L
Linus Torvalds 已提交
581 582 583 584 585 586
int i2c_del_adapter(struct i2c_adapter *adap)
{
	struct list_head  *item, *_n;
	struct i2c_client *client;
	int res = 0;

J
Jean Delvare 已提交
587
	mutex_lock(&core_lock);
L
Linus Torvalds 已提交
588 589

	/* First make sure that this adapter was ever added */
590
	if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
591 592
		pr_debug("i2c-core: attempting to delete unregistered "
			 "adapter [%s]\n", adap->name);
L
Linus Torvalds 已提交
593 594 595 596
		res = -EINVAL;
		goto out_unlock;
	}

597 598 599 600 601
	/* Tell drivers about this removal */
	res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
			       i2c_do_del_adapter);
	if (res)
		goto out_unlock;
L
Linus Torvalds 已提交
602 603

	/* detach any active clients. This must be done first, because
604
	 * it can fail; in which case we give up. */
L
Linus Torvalds 已提交
605
	list_for_each_safe(item, _n, &adap->clients) {
D
David Brownell 已提交
606 607
		struct i2c_driver	*driver;

L
Linus Torvalds 已提交
608
		client = list_entry(item, struct i2c_client, list);
D
David Brownell 已提交
609 610 611 612 613 614 615
		driver = client->driver;

		/* new style, follow standard driver model */
		if (!driver || is_newstyle_driver(driver)) {
			i2c_unregister_device(client);
			continue;
		}
L
Linus Torvalds 已提交
616

D
David Brownell 已提交
617 618
		/* legacy drivers create and remove clients themselves */
		if ((res = driver->detach_client(client))) {
619 620
			dev_err(&adap->dev, "detach_client failed for client "
				"[%s] at address 0x%02x\n", client->name,
L
Linus Torvalds 已提交
621 622 623 624 625 626 627 628 629 630 631 632
				client->addr);
			goto out_unlock;
		}
	}

	/* clean up the sysfs representation */
	init_completion(&adap->dev_released);
	device_unregister(&adap->dev);

	/* wait for sysfs to drop all references */
	wait_for_completion(&adap->dev_released);

633
	/* free bus id */
L
Linus Torvalds 已提交
634 635
	idr_remove(&i2c_adapter_idr, adap->nr);

636
	dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
L
Linus Torvalds 已提交
637 638

 out_unlock:
J
Jean Delvare 已提交
639
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
640 641
	return res;
}
D
David Brownell 已提交
642
EXPORT_SYMBOL(i2c_del_adapter);
L
Linus Torvalds 已提交
643 644


D
David Brownell 已提交
645 646
/* ------------------------------------------------------------------------- */

D
Dave Young 已提交
647 648 649 650 651 652 653 654 655 656
static int __attach_adapter(struct device *dev, void *data)
{
	struct i2c_adapter *adapter = to_i2c_adapter(dev);
	struct i2c_driver *driver = data;

	driver->attach_adapter(adapter);

	return 0;
}

D
David Brownell 已提交
657 658 659 660 661 662 663
/*
 * An i2c_driver is used with one or more i2c_client (device) nodes to access
 * i2c slave chips, on a bus instance associated with some i2c_adapter.  There
 * are two models for binding the driver to its device:  "new style" drivers
 * follow the standard Linux driver model and just respond to probe() calls
 * issued if the driver core sees they match(); "legacy" drivers create device
 * nodes themselves.
L
Linus Torvalds 已提交
664 665
 */

666
int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
L
Linus Torvalds 已提交
667
{
668
	int res;
L
Linus Torvalds 已提交
669

D
David Brownell 已提交
670
	/* new style driver methods can't mix with legacy ones */
D
David Brownell 已提交
671
	if (is_newstyle_driver(driver)) {
D
David Brownell 已提交
672 673 674 675 676 677 678 679 680
		if (driver->attach_adapter || driver->detach_adapter
				|| driver->detach_client) {
			printk(KERN_WARNING
					"i2c-core: driver [%s] is confused\n",
					driver->driver.name);
			return -EINVAL;
		}
	}

L
Linus Torvalds 已提交
681
	/* add the driver to the list of i2c drivers in the driver core */
682
	driver->driver.owner = owner;
L
Linus Torvalds 已提交
683 684
	driver->driver.bus = &i2c_bus_type;

685 686 687
	/* for new style drivers, when registration returns the driver core
	 * will have called probe() for all matching-but-unbound devices.
	 */
L
Linus Torvalds 已提交
688 689
	res = driver_register(&driver->driver);
	if (res)
690
		return res;
D
David Brownell 已提交
691

J
Jean Delvare 已提交
692
	mutex_lock(&core_lock);
693

694
	pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
L
Linus Torvalds 已提交
695

D
David Brownell 已提交
696
	/* legacy drivers scan i2c busses directly */
D
Dave Young 已提交
697 698 699
	if (driver->attach_adapter)
		class_for_each_device(&i2c_adapter_class, driver,
				      __attach_adapter);
700

D
Dave Young 已提交
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
	mutex_unlock(&core_lock);
	return 0;
}
EXPORT_SYMBOL(i2c_register_driver);

static int __detach_adapter(struct device *dev, void *data)
{
	struct i2c_adapter *adapter = to_i2c_adapter(dev);
	struct i2c_driver *driver = data;

	/* Have a look at each adapter, if clients of this driver are still
	 * attached. If so, detach them to be able to kill the driver
	 * afterwards.
	 */
	if (driver->detach_adapter) {
		if (driver->detach_adapter(adapter))
			dev_err(&adapter->dev,
				"detach_adapter failed for driver [%s]\n",
				driver->driver.name);
	} else {
		struct list_head *item, *_n;
		struct i2c_client *client;

		list_for_each_safe(item, _n, &adapter->clients) {
			client = list_entry(item, struct i2c_client, list);
			if (client->driver != driver)
				continue;
			dev_dbg(&adapter->dev,
				"detaching client [%s] at 0x%02x\n",
				client->name, client->addr);
			if (driver->detach_client(client))
				dev_err(&adapter->dev, "detach_client "
					"failed for client [%s] at 0x%02x\n",
					client->name, client->addr);
L
Linus Torvalds 已提交
735 736 737
		}
	}

738
	return 0;
L
Linus Torvalds 已提交
739 740
}

D
David Brownell 已提交
741 742 743
/**
 * i2c_del_driver - unregister I2C driver
 * @driver: the driver being unregistered
D
David Brownell 已提交
744
 * Context: can sleep
D
David Brownell 已提交
745
 */
746
void i2c_del_driver(struct i2c_driver *driver)
L
Linus Torvalds 已提交
747
{
J
Jean Delvare 已提交
748
	mutex_lock(&core_lock);
L
Linus Torvalds 已提交
749

D
David Brownell 已提交
750 751 752 753
	/* new-style driver? */
	if (is_newstyle_driver(driver))
		goto unregister;

D
Dave Young 已提交
754
	class_for_each_device(&i2c_adapter_class, driver, __detach_adapter);
L
Linus Torvalds 已提交
755

D
David Brownell 已提交
756
 unregister:
L
Linus Torvalds 已提交
757
	driver_unregister(&driver->driver);
758
	pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
L
Linus Torvalds 已提交
759

J
Jean Delvare 已提交
760
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
761
}
D
David Brownell 已提交
762
EXPORT_SYMBOL(i2c_del_driver);
L
Linus Torvalds 已提交
763

D
David Brownell 已提交
764 765
/* ------------------------------------------------------------------------- */

766
static int __i2c_check_addr(struct device *dev, void *addrp)
L
Linus Torvalds 已提交
767
{
768 769
	struct i2c_client	*client = i2c_verify_client(dev);
	int			addr = *(int *)addrp;
L
Linus Torvalds 已提交
770

771 772
	if (client && client->addr == addr)
		return -EBUSY;
L
Linus Torvalds 已提交
773 774 775
	return 0;
}

J
Jean Delvare 已提交
776
static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
L
Linus Torvalds 已提交
777
{
778
	return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
L
Linus Torvalds 已提交
779 780 781 782 783
}

int i2c_attach_client(struct i2c_client *client)
{
	struct i2c_adapter *adapter = client->adapter;
784
	int res = 0;
L
Linus Torvalds 已提交
785 786 787

	client->dev.parent = &client->adapter->dev;
	client->dev.bus = &i2c_bus_type;
788 789 790 791

	if (client->driver)
		client->dev.driver = &client->driver->driver;

792
	if (client->driver && !is_newstyle_driver(client->driver)) {
793
		client->dev.release = i2c_client_release;
794 795
		client->dev.uevent_suppress = 1;
	} else
796
		client->dev.release = i2c_client_dev_release;
D
David Brownell 已提交
797

L
Linus Torvalds 已提交
798 799
	snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
		"%d-%04x", i2c_adapter_id(adapter), client->addr);
800 801
	res = device_register(&client->dev);
	if (res)
802 803 804 805
		goto out_err;

	mutex_lock(&adapter->clist_lock);
	list_add_tail(&client->list, &adapter->clients);
806
	mutex_unlock(&adapter->clist_lock);
807

808 809 810
	dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
		client->name, client->dev.bus_id);

811 812 813 814 815 816 817 818 819
	if (adapter->client_register)  {
		if (adapter->client_register(client)) {
			dev_dbg(&adapter->dev, "client_register "
				"failed for client [%s] at 0x%02x\n",
				client->name, client->addr);
		}
	}

	return 0;
820

821
out_err:
822 823
	dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
		"(%d)\n", client->name, client->addr, res);
824
	return res;
L
Linus Torvalds 已提交
825
}
D
David Brownell 已提交
826
EXPORT_SYMBOL(i2c_attach_client);
L
Linus Torvalds 已提交
827 828 829 830 831

int i2c_detach_client(struct i2c_client *client)
{
	struct i2c_adapter *adapter = client->adapter;
	int res = 0;
D
David Brownell 已提交
832

L
Linus Torvalds 已提交
833 834 835 836
	if (adapter->client_unregister)  {
		res = adapter->client_unregister(client);
		if (res) {
			dev_err(&client->dev,
837 838
				"client_unregister [%s] failed, "
				"client not detached\n", client->name);
L
Linus Torvalds 已提交
839 840 841 842
			goto out;
		}
	}

843
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
844
	list_del(&client->list);
845 846
	mutex_unlock(&adapter->clist_lock);

L
Linus Torvalds 已提交
847 848 849 850 851 852 853
	init_completion(&client->released);
	device_unregister(&client->dev);
	wait_for_completion(&client->released);

 out:
	return res;
}
D
David Brownell 已提交
854
EXPORT_SYMBOL(i2c_detach_client);
L
Linus Torvalds 已提交
855

856 857 858 859 860 861 862 863 864 865 866 867
/**
 * i2c_use_client - increments the reference count of the i2c client structure
 * @client: the client being referenced
 *
 * Each live reference to a client should be refcounted. The driver model does
 * that automatically as part of driver binding, so that most drivers don't
 * need to do this explicitly: they hold a reference until they're unbound
 * from the device.
 *
 * A pointer to the client with the incremented reference counter is returned.
 */
struct i2c_client *i2c_use_client(struct i2c_client *client)
L
Linus Torvalds 已提交
868
{
869
	get_device(&client->dev);
870
	return client;
L
Linus Torvalds 已提交
871
}
D
David Brownell 已提交
872
EXPORT_SYMBOL(i2c_use_client);
L
Linus Torvalds 已提交
873

874 875 876 877 878 879 880
/**
 * i2c_release_client - release a use of the i2c client structure
 * @client: the client being no longer referenced
 *
 * Must be called when a user of a client is finished with it.
 */
void i2c_release_client(struct i2c_client *client)
L
Linus Torvalds 已提交
881
{
882
	put_device(&client->dev);
L
Linus Torvalds 已提交
883
}
D
David Brownell 已提交
884
EXPORT_SYMBOL(i2c_release_client);
L
Linus Torvalds 已提交
885

886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
struct i2c_cmd_arg {
	unsigned	cmd;
	void		*arg;
};

static int i2c_cmd(struct device *dev, void *_arg)
{
	struct i2c_client	*client = i2c_verify_client(dev);
	struct i2c_cmd_arg	*arg = _arg;

	if (client && client->driver && client->driver->command)
		client->driver->command(client, arg->cmd, arg->arg);
	return 0;
}

L
Linus Torvalds 已提交
901 902
void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
{
903
	struct i2c_cmd_arg	cmd_arg;
L
Linus Torvalds 已提交
904

905 906 907
	cmd_arg.cmd = cmd;
	cmd_arg.arg = arg;
	device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
L
Linus Torvalds 已提交
908
}
D
David Brownell 已提交
909
EXPORT_SYMBOL(i2c_clients_command);
L
Linus Torvalds 已提交
910 911 912 913 914 915 916 917

static int __init i2c_init(void)
{
	int retval;

	retval = bus_register(&i2c_bus_type);
	if (retval)
		return retval;
918 919 920 921 922 923 924 925 926 927 928 929 930
	retval = class_register(&i2c_adapter_class);
	if (retval)
		goto bus_err;
	retval = i2c_add_driver(&dummy_driver);
	if (retval)
		goto class_err;
	return 0;

class_err:
	class_unregister(&i2c_adapter_class);
bus_err:
	bus_unregister(&i2c_bus_type);
	return retval;
L
Linus Torvalds 已提交
931 932 933 934
}

static void __exit i2c_exit(void)
{
935
	i2c_del_driver(&dummy_driver);
L
Linus Torvalds 已提交
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
	class_unregister(&i2c_adapter_class);
	bus_unregister(&i2c_bus_type);
}

subsys_initcall(i2c_init);
module_exit(i2c_exit);

/* ----------------------------------------------------
 * the functional interface to the i2c busses.
 * ----------------------------------------------------
 */

int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
{
	int ret;

	if (adap->algo->master_xfer) {
#ifdef DEBUG
		for (ret = 0; ret < num; ret++) {
			dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
956 957 958
				"len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
				? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
				(msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
L
Linus Torvalds 已提交
959 960 961
		}
#endif

962 963 964 965 966 967 968 969 970
		if (in_atomic() || irqs_disabled()) {
			ret = mutex_trylock(&adap->bus_lock);
			if (!ret)
				/* I2C activity is ongoing. */
				return -EAGAIN;
		} else {
			mutex_lock_nested(&adap->bus_lock, adap->level);
		}

L
Linus Torvalds 已提交
971
		ret = adap->algo->master_xfer(adap,msgs,num);
972
		mutex_unlock(&adap->bus_lock);
L
Linus Torvalds 已提交
973 974 975 976

		return ret;
	} else {
		dev_dbg(&adap->dev, "I2C level transfers not supported\n");
D
David Brownell 已提交
977
		return -EOPNOTSUPP;
L
Linus Torvalds 已提交
978 979
	}
}
D
David Brownell 已提交
980
EXPORT_SYMBOL(i2c_transfer);
L
Linus Torvalds 已提交
981 982 983 984 985 986 987

int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
{
	int ret;
	struct i2c_adapter *adap=client->adapter;
	struct i2c_msg msg;

988 989 990 991
	msg.addr = client->addr;
	msg.flags = client->flags & I2C_M_TEN;
	msg.len = count;
	msg.buf = (char *)buf;
D
David Brownell 已提交
992

993
	ret = i2c_transfer(adap, &msg, 1);
L
Linus Torvalds 已提交
994

995 996 997
	/* If everything went ok (i.e. 1 msg transmitted), return #bytes
	   transmitted, else error code. */
	return (ret == 1) ? count : ret;
L
Linus Torvalds 已提交
998
}
D
David Brownell 已提交
999
EXPORT_SYMBOL(i2c_master_send);
L
Linus Torvalds 已提交
1000 1001 1002 1003 1004 1005

int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
{
	struct i2c_adapter *adap=client->adapter;
	struct i2c_msg msg;
	int ret;
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017

	msg.addr = client->addr;
	msg.flags = client->flags & I2C_M_TEN;
	msg.flags |= I2C_M_RD;
	msg.len = count;
	msg.buf = buf;

	ret = i2c_transfer(adap, &msg, 1);

	/* If everything went ok (i.e. 1 msg transmitted), return #bytes
	   transmitted, else error code. */
	return (ret == 1) ? count : ret;
L
Linus Torvalds 已提交
1018
}
D
David Brownell 已提交
1019
EXPORT_SYMBOL(i2c_master_recv);
L
Linus Torvalds 已提交
1020 1021 1022 1023 1024 1025

/* ----------------------------------------------------
 * the i2c address scanning function
 * Will not work for 10-bit addresses!
 * ----------------------------------------------------
 */
J
Jean Delvare 已提交
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
static int i2c_probe_address(struct i2c_adapter *adapter, int addr, int kind,
			     int (*found_proc) (struct i2c_adapter *, int, int))
{
	int err;

	/* Make sure the address is valid */
	if (addr < 0x03 || addr > 0x77) {
		dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
			 addr);
		return -EINVAL;
1036 1037
	}

J
Jean Delvare 已提交
1038 1039 1040 1041 1042
	/* Skip if already in use */
	if (i2c_check_addr(adapter, addr))
		return 0;

	/* Make sure there is something at this address, unless forced */
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
	if (kind < 0) {
		if (i2c_smbus_xfer(adapter, addr, 0, 0, 0,
				   I2C_SMBUS_QUICK, NULL) < 0)
			return 0;

		/* prevent 24RF08 corruption */
		if ((addr & ~0x0f) == 0x50)
			i2c_smbus_xfer(adapter, addr, 0, 0, 0,
				       I2C_SMBUS_QUICK, NULL);
	}
J
Jean Delvare 已提交
1053 1054 1055 1056 1057 1058

	/* Finally call the custom detection function */
	err = found_proc(adapter, addr, kind);
	/* -ENODEV can be returned if there is a chip at the given address
	   but it isn't supported by this chip driver. We catch it here as
	   this isn't an error. */
1059 1060 1061 1062 1063 1064 1065
	if (err == -ENODEV)
		err = 0;

	if (err)
		dev_warn(&adapter->dev, "Client creation failed at 0x%x (%d)\n",
			 addr, err);
	return err;
1066 1067
}

L
Linus Torvalds 已提交
1068
int i2c_probe(struct i2c_adapter *adapter,
1069
	      const struct i2c_client_address_data *address_data,
L
Linus Torvalds 已提交
1070 1071
	      int (*found_proc) (struct i2c_adapter *, int, int))
{
J
Jean Delvare 已提交
1072
	int i, err;
L
Linus Torvalds 已提交
1073 1074
	int adap_id = i2c_adapter_id(adapter);

J
Jean Delvare 已提交
1075 1076 1077
	/* Force entries are done first, and are not affected by ignore
	   entries */
	if (address_data->forces) {
1078
		const unsigned short * const *forces = address_data->forces;
J
Jean Delvare 已提交
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
		int kind;

		for (kind = 0; forces[kind]; kind++) {
			for (i = 0; forces[kind][i] != I2C_CLIENT_END;
			     i += 2) {
				if (forces[kind][i] == adap_id
				 || forces[kind][i] == ANY_I2C_BUS) {
					dev_dbg(&adapter->dev, "found force "
						"parameter for adapter %d, "
						"addr 0x%02x, kind %d\n",
						adap_id, forces[kind][i + 1],
						kind);
					err = i2c_probe_address(adapter,
						forces[kind][i + 1],
						kind, found_proc);
					if (err)
						return err;
				}
L
Linus Torvalds 已提交
1097 1098
			}
		}
J
Jean Delvare 已提交
1099
	}
L
Linus Torvalds 已提交
1100

1101 1102 1103 1104
	/* Stop here if we can't use SMBUS_QUICK */
	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_QUICK)) {
		if (address_data->probe[0] == I2C_CLIENT_END
		 && address_data->normal_i2c[0] == I2C_CLIENT_END)
D
David Brownell 已提交
1105
			return 0;
1106 1107 1108

		dev_warn(&adapter->dev, "SMBus Quick command not supported, "
			 "can't probe for chips\n");
D
David Brownell 已提交
1109
		return -EOPNOTSUPP;
1110 1111
	}

J
Jean Delvare 已提交
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
	/* Probe entries are done second, and are not affected by ignore
	   entries either */
	for (i = 0; address_data->probe[i] != I2C_CLIENT_END; i += 2) {
		if (address_data->probe[i] == adap_id
		 || address_data->probe[i] == ANY_I2C_BUS) {
			dev_dbg(&adapter->dev, "found probe parameter for "
				"adapter %d, addr 0x%02x\n", adap_id,
				address_data->probe[i + 1]);
			err = i2c_probe_address(adapter,
						address_data->probe[i + 1],
						-1, found_proc);
			if (err)
				return err;
L
Linus Torvalds 已提交
1125
		}
J
Jean Delvare 已提交
1126
	}
L
Linus Torvalds 已提交
1127

J
Jean Delvare 已提交
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
	/* Normal entries are done last, unless shadowed by an ignore entry */
	for (i = 0; address_data->normal_i2c[i] != I2C_CLIENT_END; i += 1) {
		int j, ignore;

		ignore = 0;
		for (j = 0; address_data->ignore[j] != I2C_CLIENT_END;
		     j += 2) {
			if ((address_data->ignore[j] == adap_id ||
			     address_data->ignore[j] == ANY_I2C_BUS)
			 && address_data->ignore[j + 1]
			    == address_data->normal_i2c[i]) {
				dev_dbg(&adapter->dev, "found ignore "
					"parameter for adapter %d, "
					"addr 0x%02x\n", adap_id,
					address_data->ignore[j + 1]);
1143 1144
				ignore = 1;
				break;
L
Linus Torvalds 已提交
1145 1146
			}
		}
J
Jean Delvare 已提交
1147
		if (ignore)
L
Linus Torvalds 已提交
1148 1149
			continue;

J
Jean Delvare 已提交
1150 1151 1152 1153 1154 1155 1156
		dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
			"addr 0x%02x\n", adap_id,
			address_data->normal_i2c[i]);
		err = i2c_probe_address(adapter, address_data->normal_i2c[i],
					-1, found_proc);
		if (err)
			return err;
L
Linus Torvalds 已提交
1157
	}
J
Jean Delvare 已提交
1158

L
Linus Torvalds 已提交
1159 1160
	return 0;
}
D
David Brownell 已提交
1161
EXPORT_SYMBOL(i2c_probe);
L
Linus Torvalds 已提交
1162

J
Jean Delvare 已提交
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
struct i2c_client *
i2c_new_probed_device(struct i2c_adapter *adap,
		      struct i2c_board_info *info,
		      unsigned short const *addr_list)
{
	int i;

	/* Stop here if the bus doesn't support probing */
	if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) {
		dev_err(&adap->dev, "Probing not supported\n");
		return NULL;
	}

	for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
		/* Check address validity */
		if (addr_list[i] < 0x03 || addr_list[i] > 0x77) {
			dev_warn(&adap->dev, "Invalid 7-bit address "
				 "0x%02x\n", addr_list[i]);
			continue;
		}

		/* Check address availability */
1185
		if (i2c_check_addr(adap, addr_list[i])) {
J
Jean Delvare 已提交
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
			dev_dbg(&adap->dev, "Address 0x%02x already in "
				"use, not probing\n", addr_list[i]);
			continue;
		}

		/* Test address responsiveness
		   The default probe method is a quick write, but it is known
		   to corrupt the 24RF08 EEPROMs due to a state machine bug,
		   and could also irreversibly write-protect some EEPROMs, so
		   for address ranges 0x30-0x37 and 0x50-0x5f, we use a byte
		   read instead. Also, some bus drivers don't implement
		   quick write, so we fallback to a byte read it that case
		   too. */
		if ((addr_list[i] & ~0x07) == 0x30
		 || (addr_list[i] & ~0x0f) == 0x50
		 || !i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) {
			if (i2c_smbus_xfer(adap, addr_list[i], 0,
					   I2C_SMBUS_READ, 0,
					   I2C_SMBUS_BYTE, NULL) >= 0)
				break;
		} else {
			if (i2c_smbus_xfer(adap, addr_list[i], 0,
					   I2C_SMBUS_WRITE, 0,
					   I2C_SMBUS_QUICK, NULL) >= 0)
				break;
		}
	}

	if (addr_list[i] == I2C_CLIENT_END) {
		dev_dbg(&adap->dev, "Probing failed, no device found\n");
		return NULL;
	}

	info->addr = addr_list[i];
	return i2c_new_device(adap, info);
}
EXPORT_SYMBOL_GPL(i2c_new_probed_device);

L
Linus Torvalds 已提交
1224 1225 1226
struct i2c_adapter* i2c_get_adapter(int id)
{
	struct i2c_adapter *adapter;
D
David Brownell 已提交
1227

J
Jean Delvare 已提交
1228
	mutex_lock(&core_lock);
1229 1230 1231 1232
	adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
	if (adapter && !try_module_get(adapter->owner))
		adapter = NULL;

J
Jean Delvare 已提交
1233
	mutex_unlock(&core_lock);
1234
	return adapter;
L
Linus Torvalds 已提交
1235
}
D
David Brownell 已提交
1236
EXPORT_SYMBOL(i2c_get_adapter);
L
Linus Torvalds 已提交
1237 1238 1239 1240 1241

void i2c_put_adapter(struct i2c_adapter *adap)
{
	module_put(adap->owner);
}
D
David Brownell 已提交
1242
EXPORT_SYMBOL(i2c_put_adapter);
L
Linus Torvalds 已提交
1243 1244 1245

/* The SMBus parts */

D
David Brownell 已提交
1246
#define POLY    (0x1070U << 3)
L
Linus Torvalds 已提交
1247 1248 1249 1250
static u8
crc8(u16 data)
{
	int i;
D
David Brownell 已提交
1251

L
Linus Torvalds 已提交
1252
	for(i = 0; i < 8; i++) {
D
David Brownell 已提交
1253
		if (data & 0x8000)
L
Linus Torvalds 已提交
1254 1255 1256 1257 1258 1259
			data = data ^ POLY;
		data = data << 1;
	}
	return (u8)(data >> 8);
}

1260 1261
/* Incremental CRC8 over count bytes in the array pointed to by p */
static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
L
Linus Torvalds 已提交
1262 1263 1264 1265
{
	int i;

	for(i = 0; i < count; i++)
1266
		crc = crc8((crc ^ p[i]) << 8);
L
Linus Torvalds 已提交
1267 1268 1269
	return crc;
}

1270 1271
/* Assume a 7-bit address, which is reasonable for SMBus */
static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
L
Linus Torvalds 已提交
1272
{
1273 1274 1275 1276 1277 1278
	/* The address will be sent first */
	u8 addr = (msg->addr << 1) | !!(msg->flags & I2C_M_RD);
	pec = i2c_smbus_pec(pec, &addr, 1);

	/* The data buffer follows */
	return i2c_smbus_pec(pec, msg->buf, msg->len);
L
Linus Torvalds 已提交
1279 1280
}

1281 1282
/* Used for write only transactions */
static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
L
Linus Torvalds 已提交
1283
{
1284 1285
	msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
	msg->len++;
L
Linus Torvalds 已提交
1286 1287
}

1288 1289 1290 1291 1292 1293
/* Return <0 on CRC error
   If there was a write before this read (most cases) we need to take the
   partial CRC from the write part into account.
   Note that this function does modify the message (we need to decrease the
   message length to hide the CRC byte from the caller). */
static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
L
Linus Torvalds 已提交
1294
{
1295 1296
	u8 rpec = msg->buf[--msg->len];
	cpec = i2c_smbus_msg_pec(cpec, msg);
L
Linus Torvalds 已提交
1297 1298 1299 1300

	if (rpec != cpec) {
		pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
			rpec, cpec);
D
David Brownell 已提交
1301
		return -EBADMSG;
L
Linus Torvalds 已提交
1302
	}
D
David Brownell 已提交
1303
	return 0;
L
Linus Torvalds 已提交
1304 1305 1306 1307 1308
}

s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
D
David Brownell 已提交
1309
	                      value,0,I2C_SMBUS_QUICK,NULL);
L
Linus Torvalds 已提交
1310
}
D
David Brownell 已提交
1311
EXPORT_SYMBOL(i2c_smbus_write_quick);
L
Linus Torvalds 已提交
1312 1313 1314 1315

s32 i2c_smbus_read_byte(struct i2c_client *client)
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1316 1317 1318 1319 1320 1321
	int status;

	status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
				I2C_SMBUS_READ, 0,
				I2C_SMBUS_BYTE, &data);
	return (status < 0) ? status : data.byte;
L
Linus Torvalds 已提交
1322
}
D
David Brownell 已提交
1323
EXPORT_SYMBOL(i2c_smbus_read_byte);
L
Linus Torvalds 已提交
1324 1325 1326 1327

s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1328
	                      I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
L
Linus Torvalds 已提交
1329
}
D
David Brownell 已提交
1330
EXPORT_SYMBOL(i2c_smbus_write_byte);
L
Linus Torvalds 已提交
1331 1332 1333 1334

s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1335 1336 1337 1338 1339 1340
	int status;

	status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
				I2C_SMBUS_READ, command,
				I2C_SMBUS_BYTE_DATA, &data);
	return (status < 0) ? status : data.byte;
L
Linus Torvalds 已提交
1341
}
D
David Brownell 已提交
1342
EXPORT_SYMBOL(i2c_smbus_read_byte_data);
L
Linus Torvalds 已提交
1343 1344 1345 1346 1347 1348 1349 1350 1351

s32 i2c_smbus_write_byte_data(struct i2c_client *client, u8 command, u8 value)
{
	union i2c_smbus_data data;
	data.byte = value;
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
	                      I2C_SMBUS_WRITE,command,
	                      I2C_SMBUS_BYTE_DATA,&data);
}
D
David Brownell 已提交
1352
EXPORT_SYMBOL(i2c_smbus_write_byte_data);
L
Linus Torvalds 已提交
1353 1354 1355 1356

s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1357 1358 1359 1360 1361 1362
	int status;

	status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
				I2C_SMBUS_READ, command,
				I2C_SMBUS_WORD_DATA, &data);
	return (status < 0) ? status : data.word;
L
Linus Torvalds 已提交
1363
}
D
David Brownell 已提交
1364
EXPORT_SYMBOL(i2c_smbus_read_word_data);
L
Linus Torvalds 已提交
1365 1366 1367 1368 1369 1370 1371 1372 1373

s32 i2c_smbus_write_word_data(struct i2c_client *client, u8 command, u16 value)
{
	union i2c_smbus_data data;
	data.word = value;
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
	                      I2C_SMBUS_WRITE,command,
	                      I2C_SMBUS_WORD_DATA,&data);
}
D
David Brownell 已提交
1374
EXPORT_SYMBOL(i2c_smbus_write_word_data);
L
Linus Torvalds 已提交
1375

D
David Brownell 已提交
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
/**
 * i2c_smbus_read_block_data - SMBus block read request
 * @client: Handle to slave device
 * @command: Command byte issued to let the slave know what data should
 *	be returned
 * @values: Byte array into which data will be read; big enough to hold
 *	the data returned by the slave.  SMBus allows at most 32 bytes.
 *
 * Returns the number of bytes read in the slave's response, else a
 * negative number to indicate some kind of error.
 *
 * Note that using this function requires that the client's adapter support
 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality.  Not all adapter drivers
 * support this; its emulation through I2C messaging relies on a specific
 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
 */
1392 1393 1394 1395
s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
			      u8 *values)
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1396
	int status;
1397

D
David Brownell 已提交
1398 1399 1400 1401 1402
	status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
				I2C_SMBUS_READ, command,
				I2C_SMBUS_BLOCK_DATA, &data);
	if (status)
		return status;
1403 1404 1405 1406 1407 1408

	memcpy(values, &data.block[1], data.block[0]);
	return data.block[0];
}
EXPORT_SYMBOL(i2c_smbus_read_block_data);

L
Linus Torvalds 已提交
1409
s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1410
			       u8 length, const u8 *values)
L
Linus Torvalds 已提交
1411 1412
{
	union i2c_smbus_data data;
1413

L
Linus Torvalds 已提交
1414 1415 1416
	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
1417
	memcpy(&data.block[1], values, length);
L
Linus Torvalds 已提交
1418 1419 1420 1421
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
			      I2C_SMBUS_WRITE,command,
			      I2C_SMBUS_BLOCK_DATA,&data);
}
D
David Brownell 已提交
1422
EXPORT_SYMBOL(i2c_smbus_write_block_data);
L
Linus Torvalds 已提交
1423 1424

/* Returns the number of read bytes */
1425 1426
s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
				  u8 length, u8 *values)
L
Linus Torvalds 已提交
1427 1428
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1429
	int status;
1430

1431 1432 1433
	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
D
David Brownell 已提交
1434 1435 1436 1437 1438
	status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
				I2C_SMBUS_READ, command,
				I2C_SMBUS_I2C_BLOCK_DATA, &data);
	if (status < 0)
		return status;
1439 1440 1441

	memcpy(values, &data.block[1], data.block[0]);
	return data.block[0];
L
Linus Torvalds 已提交
1442
}
D
David Brownell 已提交
1443
EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
L
Linus Torvalds 已提交
1444

1445
s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1446
				   u8 length, const u8 *values)
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
{
	union i2c_smbus_data data;

	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
	memcpy(data.block + 1, values, length);
	return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
			      I2C_SMBUS_WRITE, command,
			      I2C_SMBUS_I2C_BLOCK_DATA, &data);
}
D
David Brownell 已提交
1458
EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1459

D
David Brownell 已提交
1460
/* Simulate a SMBus command using the i2c protocol
L
Linus Torvalds 已提交
1461
   No checking of parameters is done!  */
D
David Brownell 已提交
1462
static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
L
Linus Torvalds 已提交
1463
                                   unsigned short flags,
D
David Brownell 已提交
1464
                                   char read_write, u8 command, int size,
L
Linus Torvalds 已提交
1465 1466 1467 1468 1469 1470
                                   union i2c_smbus_data * data)
{
	/* So we need to generate a series of msgs. In the case of writing, we
	  need to use only one message; when reading, we need two. We initialize
	  most things with sane defaults, to keep the code below somewhat
	  simpler. */
1471 1472
	unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
	unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
L
Linus Torvalds 已提交
1473
	int num = read_write == I2C_SMBUS_READ?2:1;
D
David Brownell 已提交
1474
	struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
L
Linus Torvalds 已提交
1475 1476 1477
	                          { addr, flags | I2C_M_RD, 0, msgbuf1 }
	                        };
	int i;
1478
	u8 partial_pec = 0;
D
David Brownell 已提交
1479
	int status;
L
Linus Torvalds 已提交
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509

	msgbuf0[0] = command;
	switch(size) {
	case I2C_SMBUS_QUICK:
		msg[0].len = 0;
		/* Special case: The read/write field is used as data */
		msg[0].flags = flags | (read_write==I2C_SMBUS_READ)?I2C_M_RD:0;
		num = 1;
		break;
	case I2C_SMBUS_BYTE:
		if (read_write == I2C_SMBUS_READ) {
			/* Special case: only a read! */
			msg[0].flags = I2C_M_RD | flags;
			num = 1;
		}
		break;
	case I2C_SMBUS_BYTE_DATA:
		if (read_write == I2C_SMBUS_READ)
			msg[1].len = 1;
		else {
			msg[0].len = 2;
			msgbuf0[1] = data->byte;
		}
		break;
	case I2C_SMBUS_WORD_DATA:
		if (read_write == I2C_SMBUS_READ)
			msg[1].len = 2;
		else {
			msg[0].len=3;
			msgbuf0[1] = data->word & 0xff;
1510
			msgbuf0[2] = data->word >> 8;
L
Linus Torvalds 已提交
1511 1512 1513 1514 1515 1516 1517 1518
		}
		break;
	case I2C_SMBUS_PROC_CALL:
		num = 2; /* Special case */
		read_write = I2C_SMBUS_READ;
		msg[0].len = 3;
		msg[1].len = 2;
		msgbuf0[1] = data->word & 0xff;
1519
		msgbuf0[2] = data->word >> 8;
L
Linus Torvalds 已提交
1520 1521 1522
		break;
	case I2C_SMBUS_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1523 1524 1525
			msg[1].flags |= I2C_M_RECV_LEN;
			msg[1].len = 1; /* block length will be added by
					   the underlying bus driver */
L
Linus Torvalds 已提交
1526 1527 1528
		} else {
			msg[0].len = data->block[0] + 2;
			if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
D
David Brownell 已提交
1529 1530 1531 1532
				dev_err(&adapter->dev,
					"Invalid block write size %d\n",
					data->block[0]);
				return -EINVAL;
L
Linus Torvalds 已提交
1533
			}
1534
			for (i = 1; i < msg[0].len; i++)
L
Linus Torvalds 已提交
1535 1536 1537 1538
				msgbuf0[i] = data->block[i-1];
		}
		break;
	case I2C_SMBUS_BLOCK_PROC_CALL:
1539 1540 1541
		num = 2; /* Another special case */
		read_write = I2C_SMBUS_READ;
		if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
D
David Brownell 已提交
1542 1543
			dev_err(&adapter->dev,
				"Invalid block write size %d\n",
1544
				data->block[0]);
D
David Brownell 已提交
1545
			return -EINVAL;
1546 1547 1548 1549 1550 1551 1552 1553
		}
		msg[0].len = data->block[0] + 2;
		for (i = 1; i < msg[0].len; i++)
			msgbuf0[i] = data->block[i-1];
		msg[1].flags |= I2C_M_RECV_LEN;
		msg[1].len = 1; /* block length will be added by
				   the underlying bus driver */
		break;
L
Linus Torvalds 已提交
1554 1555
	case I2C_SMBUS_I2C_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1556
			msg[1].len = data->block[0];
L
Linus Torvalds 已提交
1557 1558
		} else {
			msg[0].len = data->block[0] + 1;
1559
			if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
D
David Brownell 已提交
1560 1561 1562 1563
				dev_err(&adapter->dev,
					"Invalid block write size %d\n",
					data->block[0]);
				return -EINVAL;
L
Linus Torvalds 已提交
1564 1565 1566 1567 1568 1569
			}
			for (i = 1; i <= data->block[0]; i++)
				msgbuf0[i] = data->block[i];
		}
		break;
	default:
D
David Brownell 已提交
1570 1571
		dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
		return -EOPNOTSUPP;
L
Linus Torvalds 已提交
1572 1573
	}

1574 1575 1576 1577 1578
	i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
				      && size != I2C_SMBUS_I2C_BLOCK_DATA);
	if (i) {
		/* Compute PEC if first message is a write */
		if (!(msg[0].flags & I2C_M_RD)) {
D
David Brownell 已提交
1579
			if (num == 1) /* Write only */
1580 1581 1582 1583 1584 1585
				i2c_smbus_add_pec(&msg[0]);
			else /* Write followed by read */
				partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
		}
		/* Ask for PEC if last message is a read */
		if (msg[num-1].flags & I2C_M_RD)
D
David Brownell 已提交
1586
			msg[num-1].len++;
1587 1588
	}

D
David Brownell 已提交
1589 1590 1591
	status = i2c_transfer(adapter, msg, num);
	if (status < 0)
		return status;
L
Linus Torvalds 已提交
1592

1593 1594
	/* Check PEC if last message is a read */
	if (i && (msg[num-1].flags & I2C_M_RD)) {
D
David Brownell 已提交
1595 1596 1597
		status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
		if (status < 0)
			return status;
1598 1599
	}

L
Linus Torvalds 已提交
1600 1601 1602 1603 1604 1605 1606 1607
	if (read_write == I2C_SMBUS_READ)
		switch(size) {
			case I2C_SMBUS_BYTE:
				data->byte = msgbuf0[0];
				break;
			case I2C_SMBUS_BYTE_DATA:
				data->byte = msgbuf1[0];
				break;
D
David Brownell 已提交
1608
			case I2C_SMBUS_WORD_DATA:
L
Linus Torvalds 已提交
1609 1610 1611 1612
			case I2C_SMBUS_PROC_CALL:
				data->word = msgbuf1[0] | (msgbuf1[1] << 8);
				break;
			case I2C_SMBUS_I2C_BLOCK_DATA:
1613
				for (i = 0; i < data->block[0]; i++)
L
Linus Torvalds 已提交
1614 1615
					data->block[i+1] = msgbuf1[i];
				break;
1616 1617 1618 1619 1620
			case I2C_SMBUS_BLOCK_DATA:
			case I2C_SMBUS_BLOCK_PROC_CALL:
				for (i = 0; i < msgbuf1[0] + 1; i++)
					data->block[i] = msgbuf1[i];
				break;
L
Linus Torvalds 已提交
1621 1622 1623 1624 1625 1626
		}
	return 0;
}


s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
D
David Brownell 已提交
1627
                   char read_write, u8 command, int size,
L
Linus Torvalds 已提交
1628 1629 1630 1631 1632 1633 1634
                   union i2c_smbus_data * data)
{
	s32 res;

	flags &= I2C_M_TEN | I2C_CLIENT_PEC;

	if (adapter->algo->smbus_xfer) {
1635
		mutex_lock(&adapter->bus_lock);
L
Linus Torvalds 已提交
1636 1637
		res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
		                                command,size,data);
1638
		mutex_unlock(&adapter->bus_lock);
L
Linus Torvalds 已提交
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
	} else
		res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
	                                      command,size,data);

	return res;
}
EXPORT_SYMBOL(i2c_smbus_xfer);

MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
MODULE_DESCRIPTION("I2C-Bus main module");
MODULE_LICENSE("GPL");