i2c-core.c 44.2 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 32

#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>
#include <linux/seq_file.h>
33
#include <linux/platform_device.h>
34
#include <linux/mutex.h>
J
Jean Delvare 已提交
35
#include <linux/completion.h>
36 37
#include <linux/hardirq.h>
#include <linux/irqflags.h>
38
#include <linux/semaphore.h>
L
Linus Torvalds 已提交
39 40
#include <asm/uaccess.h>

41 42
#include "i2c-core.h"

L
Linus Torvalds 已提交
43

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

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

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

51 52 53 54 55 56 57 58 59 60 61
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 已提交
62 63
static int i2c_device_match(struct device *dev, struct device_driver *drv)
{
D
David Brownell 已提交
64 65 66 67 68 69
	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 已提交
70
	if (!is_newstyle_driver(driver))
D
David Brownell 已提交
71 72
		return 0;

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

D
David Brownell 已提交
77 78 79 80
	/* new style drivers use the same kind of driver matching policy
	 * as platform devices or SPI:  compare device and driver IDs.
	 */
	return strcmp(client->driver_name, drv->name) == 0;
L
Linus Torvalds 已提交
81 82
}

D
David Brownell 已提交
83 84 85
#ifdef	CONFIG_HOTPLUG

/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
86
static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
D
David Brownell 已提交
87 88 89 90
{
	struct i2c_client	*client = to_i2c_client(dev);

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

94 95 96 97 98 99 100 101
	if (client->driver_name[0]) {
		if (add_uevent_var(env, "MODALIAS=%s", client->driver_name))
			return -ENOMEM;
	} else {
		if (add_uevent_var(env, "MODALIAS=%s%s",
				   I2C_MODULE_PREFIX, client->name))
			return -ENOMEM;
	}
D
David Brownell 已提交
102 103 104 105 106 107 108 109
	dev_dbg(dev, "uevent\n");
	return 0;
}

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

110
static int i2c_device_probe(struct device *dev)
L
Linus Torvalds 已提交
111
{
D
David Brownell 已提交
112 113
	struct i2c_client	*client = to_i2c_client(dev);
	struct i2c_driver	*driver = to_i2c_driver(dev->driver);
114
	const struct i2c_device_id *id;
115
	int status;
D
David Brownell 已提交
116 117 118 119 120

	if (!driver->probe)
		return -ENODEV;
	client->driver = driver;
	dev_dbg(dev, "probe\n");
121 122 123 124 125 126

	if (driver->id_table)
		id = i2c_match_id(driver->id_table, client);
	else
		id = NULL;
	status = driver->probe(client, id);
127 128 129
	if (status)
		client->driver = NULL;
	return status;
130
}
L
Linus Torvalds 已提交
131

132 133
static int i2c_device_remove(struct device *dev)
{
D
David Brownell 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
	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 已提交
152 153
}

154
static void i2c_device_shutdown(struct device *dev)
L
Linus Torvalds 已提交
155
{
156 157 158 159 160 161 162
	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 已提交
163 164
}

165
static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
L
Linus Torvalds 已提交
166
{
167 168 169 170 171 172 173 174
	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 已提交
175 176
}

177
static int i2c_device_resume(struct device * dev)
L
Linus Torvalds 已提交
178
{
179 180 181 182 183 184 185 186
	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 已提交
187 188
}

D
David Brownell 已提交
189 190 191 192 193 194
static void i2c_client_release(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	complete(&client->released);
}

195 196 197 198 199
static void i2c_client_dev_release(struct device *dev)
{
	kfree(to_i2c_client(dev));
}

D
David Brownell 已提交
200 201 202 203 204 205 206 207 208
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);
209
	return client->driver_name[0]
D
David Brownell 已提交
210
		? sprintf(buf, "%s\n", client->driver_name)
211
		: sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
D
David Brownell 已提交
212 213 214 215 216 217 218 219 220
}

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 已提交
221
static struct bus_type i2c_bus_type = {
222
	.name		= "i2c",
D
David Brownell 已提交
223
	.dev_attrs	= i2c_dev_attrs,
224
	.match		= i2c_device_match,
D
David Brownell 已提交
225
	.uevent		= i2c_device_uevent,
226 227 228 229 230
	.probe		= i2c_device_probe,
	.remove		= i2c_device_remove,
	.shutdown	= i2c_device_shutdown,
	.suspend	= i2c_device_suspend,
	.resume		= i2c_device_resume,
231 232
};

233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

/**
 * 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);


252 253 254 255
/**
 * 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 已提交
256
 * Context: can sleep
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
 *
 * 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;
279 280 281
	device_init_wakeup(&client->dev, info->flags & I2C_CLIENT_WAKE);

	client->flags = info->flags & ~I2C_CLIENT_WAKE;
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
	client->addr = info->addr;
	client->irq = info->irq;

	strlcpy(client->driver_name, info->driver_name,
		sizeof(client->driver_name));
	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 已提交
307
 * Context: can sleep
308 309
 */
void i2c_unregister_device(struct i2c_client *client)
D
David Brownell 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
{
	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);
}
327
EXPORT_SYMBOL_GPL(i2c_unregister_device);
D
David Brownell 已提交
328 329


330 331 332 333 334 335 336
static int dummy_probe(struct i2c_client *client,
		       const struct i2c_device_id *id)
{
	return 0;
}

static int dummy_remove(struct i2c_client *client)
337 338 339 340 341 342
{
	return 0;
}

static struct i2c_driver dummy_driver = {
	.driver.name	= "dummy",
343 344
	.probe		= dummy_probe,
	.remove		= dummy_remove,
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
};

/**
 * 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
 * @type: optional label used for i2c_client.name
 * 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 *
i2c_new_dummy(struct i2c_adapter *adapter, u16 address, const char *type)
{
	struct i2c_board_info info = {
		.driver_name	= "dummy",
		.addr		= address,
	};

	if (type)
		strlcpy(info.type, type, sizeof info.type);
	return i2c_new_device(adapter, &info);
}
EXPORT_SYMBOL_GPL(i2c_new_dummy);

380 381
/* ------------------------------------------------------------------------- */

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

A
Adrian Bunk 已提交
384
static void i2c_adapter_dev_release(struct device *dev)
L
Linus Torvalds 已提交
385
{
386
	struct i2c_adapter *adap = to_i2c_adapter(dev);
L
Linus Torvalds 已提交
387 388 389
	complete(&adap->dev_released);
}

D
David Brownell 已提交
390 391 392
static ssize_t
show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
{
393
	struct i2c_adapter *adap = to_i2c_adapter(dev);
D
David Brownell 已提交
394 395
	return sprintf(buf, "%s\n", adap->name);
}
396

D
David Brownell 已提交
397 398 399 400
static struct device_attribute i2c_adapter_attrs[] = {
	__ATTR(name, S_IRUGO, show_adapter_name, NULL),
	{ },
};
401

A
Adrian Bunk 已提交
402
static struct class i2c_adapter_class = {
403 404
	.owner			= THIS_MODULE,
	.name			= "i2c-adapter",
D
David Brownell 已提交
405
	.dev_attrs		= i2c_adapter_attrs,
L
Linus Torvalds 已提交
406 407
};

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
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);
}

424 425 426 427 428 429 430 431 432 433 434 435
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;
}

436
static int i2c_register_adapter(struct i2c_adapter *adap)
L
Linus Torvalds 已提交
437
{
438
	int res = 0, dummy;
L
Linus Torvalds 已提交
439

440 441
	mutex_init(&adap->bus_lock);
	mutex_init(&adap->clist_lock);
L
Linus Torvalds 已提交
442 443
	INIT_LIST_HEAD(&adap->clients);

J
Jean Delvare 已提交
444
	mutex_lock(&core_lock);
445

L
Linus Torvalds 已提交
446 447 448 449
	/* Add the adapter to the driver core.
	 * If the parent pointer is not set up,
	 * we add this adapter to the host bus.
	 */
450
	if (adap->dev.parent == NULL) {
L
Linus Torvalds 已提交
451
		adap->dev.parent = &platform_bus;
452 453
		pr_debug("I2C adapter driver [%s] forgot to specify "
			 "physical device\n", adap->name);
454
	}
L
Linus Torvalds 已提交
455 456
	sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
	adap->dev.release = &i2c_adapter_dev_release;
J
Jean Delvare 已提交
457
	adap->dev.class = &i2c_adapter_class;
458 459 460
	res = device_register(&adap->dev);
	if (res)
		goto out_list;
L
Linus Torvalds 已提交
461

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

464 465 466 467
	/* 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 已提交
468
	/* let legacy drivers scan this bus for matching devices */
469 470
	dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
				 i2c_do_add_adapter);
L
Linus Torvalds 已提交
471 472

out_unlock:
J
Jean Delvare 已提交
473
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
474
	return res;
475 476 477 478

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

481 482 483
/**
 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
 * @adapter: the adapter to add
D
David Brownell 已提交
484
 * Context: can sleep
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
 *
 * 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 已提交
502
	mutex_lock(&core_lock);
503 504 505
	/* "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 已提交
506
	mutex_unlock(&core_lock);
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521

	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 已提交
522
 * Context: can sleep
523 524
 *
 * This routine is used to declare an I2C adapter when its bus number
R
Randy Dunlap 已提交
525 526
 * 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
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
 * 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 已提交
551
	mutex_lock(&core_lock);
552 553 554 555 556 557 558 559
	/* "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 已提交
560
	mutex_unlock(&core_lock);
561 562 563 564 565 566 567 568 569
	if (status == -EAGAIN)
		goto retry;

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

570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
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 已提交
585 586 587 588 589 590 591 592
/**
 * 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 已提交
593 594 595 596 597 598
int i2c_del_adapter(struct i2c_adapter *adap)
{
	struct list_head  *item, *_n;
	struct i2c_client *client;
	int res = 0;

J
Jean Delvare 已提交
599
	mutex_lock(&core_lock);
L
Linus Torvalds 已提交
600 601

	/* First make sure that this adapter was ever added */
602
	if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
603 604
		pr_debug("i2c-core: attempting to delete unregistered "
			 "adapter [%s]\n", adap->name);
L
Linus Torvalds 已提交
605 606 607 608
		res = -EINVAL;
		goto out_unlock;
	}

609 610 611 612 613
	/* 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 已提交
614 615

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

L
Linus Torvalds 已提交
620
		client = list_entry(item, struct i2c_client, list);
D
David Brownell 已提交
621 622 623 624 625 626 627
		driver = client->driver;

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

D
David Brownell 已提交
629 630
		/* legacy drivers create and remove clients themselves */
		if ((res = driver->detach_client(client))) {
631 632
			dev_err(&adap->dev, "detach_client failed for client "
				"[%s] at address 0x%02x\n", client->name,
L
Linus Torvalds 已提交
633 634 635 636 637 638 639 640 641 642 643 644
				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);

645
	/* free bus id */
L
Linus Torvalds 已提交
646 647
	idr_remove(&i2c_adapter_idr, adap->nr);

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

 out_unlock:
J
Jean Delvare 已提交
651
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
652 653
	return res;
}
D
David Brownell 已提交
654
EXPORT_SYMBOL(i2c_del_adapter);
L
Linus Torvalds 已提交
655 656


D
David Brownell 已提交
657 658 659 660 661 662 663 664 665
/* ------------------------------------------------------------------------- */

/*
 * 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 已提交
666 667
 */

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

D
David Brownell 已提交
672
	/* new style driver methods can't mix with legacy ones */
D
David Brownell 已提交
673
	if (is_newstyle_driver(driver)) {
D
David Brownell 已提交
674 675 676 677 678 679 680 681 682
		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 已提交
683
	/* add the driver to the list of i2c drivers in the driver core */
684
	driver->driver.owner = owner;
L
Linus Torvalds 已提交
685 686
	driver->driver.bus = &i2c_bus_type;

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

J
Jean Delvare 已提交
694
	mutex_lock(&core_lock);
695

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

D
David Brownell 已提交
698
	/* legacy drivers scan i2c busses directly */
699
	if (driver->attach_adapter) {
700 701
		struct i2c_adapter *adapter;

702 703 704
		down(&i2c_adapter_class.sem);
		list_for_each_entry(adapter, &i2c_adapter_class.devices,
				    dev.node) {
L
Linus Torvalds 已提交
705 706
			driver->attach_adapter(adapter);
		}
707
		up(&i2c_adapter_class.sem);
L
Linus Torvalds 已提交
708 709
	}

J
Jean Delvare 已提交
710
	mutex_unlock(&core_lock);
711
	return 0;
L
Linus Torvalds 已提交
712
}
713
EXPORT_SYMBOL(i2c_register_driver);
L
Linus Torvalds 已提交
714

D
David Brownell 已提交
715 716 717
/**
 * i2c_del_driver - unregister I2C driver
 * @driver: the driver being unregistered
D
David Brownell 已提交
718
 * Context: can sleep
D
David Brownell 已提交
719
 */
720
void i2c_del_driver(struct i2c_driver *driver)
L
Linus Torvalds 已提交
721
{
722
	struct list_head   *item2, *_n;
L
Linus Torvalds 已提交
723 724
	struct i2c_client  *client;
	struct i2c_adapter *adap;
D
David Brownell 已提交
725

J
Jean Delvare 已提交
726
	mutex_lock(&core_lock);
L
Linus Torvalds 已提交
727

D
David Brownell 已提交
728 729 730 731
	/* new-style driver? */
	if (is_newstyle_driver(driver))
		goto unregister;

L
Linus Torvalds 已提交
732
	/* Have a look at each adapter, if clients of this driver are still
D
David Brownell 已提交
733
	 * attached. If so, detach them to be able to kill the driver
L
Linus Torvalds 已提交
734 735
	 * afterwards.
	 */
736 737
	down(&i2c_adapter_class.sem);
	list_for_each_entry(adap, &i2c_adapter_class.devices, dev.node) {
L
Linus Torvalds 已提交
738
		if (driver->detach_adapter) {
739
			if (driver->detach_adapter(adap)) {
740
				dev_err(&adap->dev, "detach_adapter failed "
741 742
					"for driver [%s]\n",
					driver->driver.name);
L
Linus Torvalds 已提交
743 744 745 746 747 748
			}
		} else {
			list_for_each_safe(item2, _n, &adap->clients) {
				client = list_entry(item2, struct i2c_client, list);
				if (client->driver != driver)
					continue;
749 750 751
				dev_dbg(&adap->dev, "detaching client [%s] "
					"at 0x%02x\n", client->name,
					client->addr);
752
				if (driver->detach_client(client)) {
753 754 755
					dev_err(&adap->dev, "detach_client "
						"failed for client [%s] at "
						"0x%02x\n", client->name,
L
Linus Torvalds 已提交
756 757 758 759 760
						client->addr);
				}
			}
		}
	}
761
	up(&i2c_adapter_class.sem);
L
Linus Torvalds 已提交
762

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

J
Jean Delvare 已提交
767
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
768
}
D
David Brownell 已提交
769
EXPORT_SYMBOL(i2c_del_driver);
L
Linus Torvalds 已提交
770

D
David Brownell 已提交
771 772
/* ------------------------------------------------------------------------- */

773
static int __i2c_check_addr(struct device *dev, void *addrp)
L
Linus Torvalds 已提交
774
{
775 776
	struct i2c_client	*client = i2c_verify_client(dev);
	int			addr = *(int *)addrp;
L
Linus Torvalds 已提交
777

778 779
	if (client && client->addr == addr)
		return -EBUSY;
L
Linus Torvalds 已提交
780 781 782
	return 0;
}

J
Jean Delvare 已提交
783
static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
L
Linus Torvalds 已提交
784
{
785
	return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
L
Linus Torvalds 已提交
786 787 788 789 790
}

int i2c_attach_client(struct i2c_client *client)
{
	struct i2c_adapter *adapter = client->adapter;
791
	int res = 0;
L
Linus Torvalds 已提交
792 793 794

	client->dev.parent = &client->adapter->dev;
	client->dev.bus = &i2c_bus_type;
795 796 797 798

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

799
	if (client->driver && !is_newstyle_driver(client->driver)) {
800
		client->dev.release = i2c_client_release;
801 802
		client->dev.uevent_suppress = 1;
	} else
803
		client->dev.release = i2c_client_dev_release;
D
David Brownell 已提交
804

L
Linus Torvalds 已提交
805 806
	snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
		"%d-%04x", i2c_adapter_id(adapter), client->addr);
807 808
	res = device_register(&client->dev);
	if (res)
809 810 811 812
		goto out_err;

	mutex_lock(&adapter->clist_lock);
	list_add_tail(&client->list, &adapter->clients);
813
	mutex_unlock(&adapter->clist_lock);
814

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

818 819 820 821 822 823 824 825 826
	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;
827

828
out_err:
829 830
	dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
		"(%d)\n", client->name, client->addr, res);
831
	return res;
L
Linus Torvalds 已提交
832
}
D
David Brownell 已提交
833
EXPORT_SYMBOL(i2c_attach_client);
L
Linus Torvalds 已提交
834 835 836 837 838

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

L
Linus Torvalds 已提交
840 841 842 843
	if (adapter->client_unregister)  {
		res = adapter->client_unregister(client);
		if (res) {
			dev_err(&client->dev,
844 845
				"client_unregister [%s] failed, "
				"client not detached\n", client->name);
L
Linus Torvalds 已提交
846 847 848 849
			goto out;
		}
	}

850
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
851
	list_del(&client->list);
852 853
	mutex_unlock(&adapter->clist_lock);

L
Linus Torvalds 已提交
854 855 856 857 858 859 860
	init_completion(&client->released);
	device_unregister(&client->dev);
	wait_for_completion(&client->released);

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

863 864 865 866 867 868 869 870 871 872 873 874
/**
 * 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 已提交
875
{
876
	get_device(&client->dev);
877
	return client;
L
Linus Torvalds 已提交
878
}
D
David Brownell 已提交
879
EXPORT_SYMBOL(i2c_use_client);
L
Linus Torvalds 已提交
880

881 882 883 884 885 886 887
/**
 * 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 已提交
888
{
889
	put_device(&client->dev);
L
Linus Torvalds 已提交
890
}
D
David Brownell 已提交
891
EXPORT_SYMBOL(i2c_release_client);
L
Linus Torvalds 已提交
892

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
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 已提交
908 909
void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
{
910
	struct i2c_cmd_arg	cmd_arg;
L
Linus Torvalds 已提交
911

912 913 914
	cmd_arg.cmd = cmd;
	cmd_arg.arg = arg;
	device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
L
Linus Torvalds 已提交
915
}
D
David Brownell 已提交
916
EXPORT_SYMBOL(i2c_clients_command);
L
Linus Torvalds 已提交
917 918 919 920 921 922 923 924

static int __init i2c_init(void)
{
	int retval;

	retval = bus_register(&i2c_bus_type);
	if (retval)
		return retval;
925 926 927 928 929 930 931 932 933 934 935 936 937
	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 已提交
938 939 940 941
}

static void __exit i2c_exit(void)
{
942
	i2c_del_driver(&dummy_driver);
L
Linus Torvalds 已提交
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
	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, "
963 964 965
				"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 已提交
966 967 968
		}
#endif

969 970 971 972 973 974 975 976 977
		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 已提交
978
		ret = adap->algo->master_xfer(adap,msgs,num);
979
		mutex_unlock(&adap->bus_lock);
L
Linus Torvalds 已提交
980 981 982 983 984 985 986

		return ret;
	} else {
		dev_dbg(&adap->dev, "I2C level transfers not supported\n");
		return -ENOSYS;
	}
}
D
David Brownell 已提交
987
EXPORT_SYMBOL(i2c_transfer);
L
Linus Torvalds 已提交
988 989 990 991 992 993 994

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;

995 996 997 998
	msg.addr = client->addr;
	msg.flags = client->flags & I2C_M_TEN;
	msg.len = count;
	msg.buf = (char *)buf;
D
David Brownell 已提交
999

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

1002 1003 1004
	/* If everything went ok (i.e. 1 msg transmitted), return #bytes
	   transmitted, else error code. */
	return (ret == 1) ? count : ret;
L
Linus Torvalds 已提交
1005
}
D
David Brownell 已提交
1006
EXPORT_SYMBOL(i2c_master_send);
L
Linus Torvalds 已提交
1007 1008 1009 1010 1011 1012

int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
{
	struct i2c_adapter *adap=client->adapter;
	struct i2c_msg msg;
	int ret;
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024

	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 已提交
1025
}
D
David Brownell 已提交
1026
EXPORT_SYMBOL(i2c_master_recv);
L
Linus Torvalds 已提交
1027 1028 1029 1030 1031 1032

/* ----------------------------------------------------
 * the i2c address scanning function
 * Will not work for 10-bit addresses!
 * ----------------------------------------------------
 */
J
Jean Delvare 已提交
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
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;
1043 1044
	}

J
Jean Delvare 已提交
1045 1046 1047 1048 1049
	/* Skip if already in use */
	if (i2c_check_addr(adapter, addr))
		return 0;

	/* Make sure there is something at this address, unless forced */
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
	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 已提交
1060 1061 1062 1063 1064 1065

	/* 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. */
1066 1067 1068 1069 1070 1071 1072
	if (err == -ENODEV)
		err = 0;

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

L
Linus Torvalds 已提交
1075
int i2c_probe(struct i2c_adapter *adapter,
1076
	      const struct i2c_client_address_data *address_data,
L
Linus Torvalds 已提交
1077 1078
	      int (*found_proc) (struct i2c_adapter *, int, int))
{
J
Jean Delvare 已提交
1079
	int i, err;
L
Linus Torvalds 已提交
1080 1081
	int adap_id = i2c_adapter_id(adapter);

J
Jean Delvare 已提交
1082 1083 1084
	/* Force entries are done first, and are not affected by ignore
	   entries */
	if (address_data->forces) {
1085
		const unsigned short * const *forces = address_data->forces;
J
Jean Delvare 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
		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 已提交
1104 1105
			}
		}
J
Jean Delvare 已提交
1106
	}
L
Linus Torvalds 已提交
1107

1108 1109 1110 1111
	/* 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 已提交
1112
			return 0;
1113 1114 1115 1116 1117 1118

		dev_warn(&adapter->dev, "SMBus Quick command not supported, "
			 "can't probe for chips\n");
		return -1;
	}

J
Jean Delvare 已提交
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
	/* 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 已提交
1132
		}
J
Jean Delvare 已提交
1133
	}
L
Linus Torvalds 已提交
1134

J
Jean Delvare 已提交
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
	/* 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]);
1150 1151
				ignore = 1;
				break;
L
Linus Torvalds 已提交
1152 1153
			}
		}
J
Jean Delvare 已提交
1154
		if (ignore)
L
Linus Torvalds 已提交
1155 1156
			continue;

J
Jean Delvare 已提交
1157 1158 1159 1160 1161 1162 1163
		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 已提交
1164
	}
J
Jean Delvare 已提交
1165

L
Linus Torvalds 已提交
1166 1167
	return 0;
}
D
David Brownell 已提交
1168
EXPORT_SYMBOL(i2c_probe);
L
Linus Torvalds 已提交
1169

J
Jean Delvare 已提交
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
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 */
1192
		if (i2c_check_addr(adap, addr_list[i])) {
J
Jean Delvare 已提交
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 1224 1225 1226 1227 1228 1229 1230
			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 已提交
1231 1232 1233
struct i2c_adapter* i2c_get_adapter(int id)
{
	struct i2c_adapter *adapter;
D
David Brownell 已提交
1234

J
Jean Delvare 已提交
1235
	mutex_lock(&core_lock);
1236 1237 1238 1239
	adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
	if (adapter && !try_module_get(adapter->owner))
		adapter = NULL;

J
Jean Delvare 已提交
1240
	mutex_unlock(&core_lock);
1241
	return adapter;
L
Linus Torvalds 已提交
1242
}
D
David Brownell 已提交
1243
EXPORT_SYMBOL(i2c_get_adapter);
L
Linus Torvalds 已提交
1244 1245 1246 1247 1248

void i2c_put_adapter(struct i2c_adapter *adap)
{
	module_put(adap->owner);
}
D
David Brownell 已提交
1249
EXPORT_SYMBOL(i2c_put_adapter);
L
Linus Torvalds 已提交
1250 1251 1252

/* The SMBus parts */

D
David Brownell 已提交
1253
#define POLY    (0x1070U << 3)
L
Linus Torvalds 已提交
1254 1255 1256 1257
static u8
crc8(u16 data)
{
	int i;
D
David Brownell 已提交
1258

L
Linus Torvalds 已提交
1259
	for(i = 0; i < 8; i++) {
D
David Brownell 已提交
1260
		if (data & 0x8000)
L
Linus Torvalds 已提交
1261 1262 1263 1264 1265 1266
			data = data ^ POLY;
		data = data << 1;
	}
	return (u8)(data >> 8);
}

1267 1268
/* 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 已提交
1269 1270 1271 1272
{
	int i;

	for(i = 0; i < count; i++)
1273
		crc = crc8((crc ^ p[i]) << 8);
L
Linus Torvalds 已提交
1274 1275 1276
	return crc;
}

1277 1278
/* 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 已提交
1279
{
1280 1281 1282 1283 1284 1285
	/* 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 已提交
1286 1287
}

1288 1289
/* Used for write only transactions */
static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
L
Linus Torvalds 已提交
1290
{
1291 1292
	msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
	msg->len++;
L
Linus Torvalds 已提交
1293 1294
}

1295 1296 1297 1298 1299 1300
/* 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 已提交
1301
{
1302 1303
	u8 rpec = msg->buf[--msg->len];
	cpec = i2c_smbus_msg_pec(cpec, msg);
L
Linus Torvalds 已提交
1304 1305 1306 1307 1308 1309

	if (rpec != cpec) {
		pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
			rpec, cpec);
		return -1;
	}
D
David Brownell 已提交
1310
	return 0;
L
Linus Torvalds 已提交
1311 1312 1313 1314 1315
}

s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
D
David Brownell 已提交
1316
	                      value,0,I2C_SMBUS_QUICK,NULL);
L
Linus Torvalds 已提交
1317
}
D
David Brownell 已提交
1318
EXPORT_SYMBOL(i2c_smbus_write_quick);
L
Linus Torvalds 已提交
1319 1320 1321 1322 1323 1324 1325 1326

s32 i2c_smbus_read_byte(struct i2c_client *client)
{
	union i2c_smbus_data data;
	if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
	                   I2C_SMBUS_READ,0,I2C_SMBUS_BYTE, &data))
		return -1;
	else
1327
		return data.byte;
L
Linus Torvalds 已提交
1328
}
D
David Brownell 已提交
1329
EXPORT_SYMBOL(i2c_smbus_read_byte);
L
Linus Torvalds 已提交
1330 1331 1332 1333

s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1334
	                      I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
L
Linus Torvalds 已提交
1335
}
D
David Brownell 已提交
1336
EXPORT_SYMBOL(i2c_smbus_write_byte);
L
Linus Torvalds 已提交
1337 1338 1339 1340 1341 1342 1343 1344

s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
{
	union i2c_smbus_data data;
	if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
	                   I2C_SMBUS_READ,command, I2C_SMBUS_BYTE_DATA,&data))
		return -1;
	else
1345
		return data.byte;
L
Linus Torvalds 已提交
1346
}
D
David Brownell 已提交
1347
EXPORT_SYMBOL(i2c_smbus_read_byte_data);
L
Linus Torvalds 已提交
1348 1349 1350 1351 1352 1353 1354 1355 1356

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 已提交
1357
EXPORT_SYMBOL(i2c_smbus_write_byte_data);
L
Linus Torvalds 已提交
1358 1359 1360 1361 1362 1363 1364 1365

s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
{
	union i2c_smbus_data data;
	if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
	                   I2C_SMBUS_READ,command, I2C_SMBUS_WORD_DATA, &data))
		return -1;
	else
1366
		return data.word;
L
Linus Torvalds 已提交
1367
}
D
David Brownell 已提交
1368
EXPORT_SYMBOL(i2c_smbus_read_word_data);
L
Linus Torvalds 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377

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 已提交
1378
EXPORT_SYMBOL(i2c_smbus_write_word_data);
L
Linus Torvalds 已提交
1379

D
David Brownell 已提交
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
/**
 * 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.
 */
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
			      u8 *values)
{
	union i2c_smbus_data data;

	if (i2c_smbus_xfer(client->adapter, client->addr, client->flags,
	                   I2C_SMBUS_READ, command,
	                   I2C_SMBUS_BLOCK_DATA, &data))
		return -1;

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

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

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

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

1432 1433 1434
	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
L
Linus Torvalds 已提交
1435 1436 1437 1438
	if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
	                      I2C_SMBUS_READ,command,
	                      I2C_SMBUS_I2C_BLOCK_DATA,&data))
		return -1;
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;
L
Linus Torvalds 已提交
1479 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

	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;
1509
			msgbuf0[2] = data->word >> 8;
L
Linus Torvalds 已提交
1510 1511 1512 1513 1514 1515 1516 1517
		}
		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;
1518
		msgbuf0[2] = data->word >> 8;
L
Linus Torvalds 已提交
1519 1520 1521
		break;
	case I2C_SMBUS_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1522 1523 1524
			msg[1].flags |= I2C_M_RECV_LEN;
			msg[1].len = 1; /* block length will be added by
					   the underlying bus driver */
L
Linus Torvalds 已提交
1525 1526 1527 1528 1529 1530 1531 1532
		} else {
			msg[0].len = data->block[0] + 2;
			if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
				dev_err(&adapter->dev, "smbus_access called with "
				       "invalid block write size (%d)\n",
				       data->block[0]);
				return -1;
			}
1533
			for (i = 1; i < msg[0].len; i++)
L
Linus Torvalds 已提交
1534 1535 1536 1537
				msgbuf0[i] = data->block[i-1];
		}
		break;
	case I2C_SMBUS_BLOCK_PROC_CALL:
1538 1539 1540 1541
		num = 2; /* Another special case */
		read_write = I2C_SMBUS_READ;
		if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
			dev_err(&adapter->dev, "%s called with invalid "
1542
				"block proc call size (%d)\n", __func__,
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
				data->block[0]);
			return -1;
		}
		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 已提交
1553 1554
	case I2C_SMBUS_I2C_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1555
			msg[1].len = data->block[0];
L
Linus Torvalds 已提交
1556 1557
		} else {
			msg[0].len = data->block[0] + 1;
1558
			if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
L
Linus Torvalds 已提交
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
				dev_err(&adapter->dev, "i2c_smbus_xfer_emulated called with "
				       "invalid block write size (%d)\n",
				       data->block[0]);
				return -1;
			}
			for (i = 1; i <= data->block[0]; i++)
				msgbuf0[i] = data->block[i];
		}
		break;
	default:
		dev_err(&adapter->dev, "smbus_access called with invalid size (%d)\n",
		       size);
		return -1;
	}

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
	}

L
Linus Torvalds 已提交
1589 1590 1591
	if (i2c_transfer(adapter, msg, num) < 0)
		return -1;

1592 1593 1594 1595 1596 1597
	/* Check PEC if last message is a read */
	if (i && (msg[num-1].flags & I2C_M_RD)) {
		if (i2c_smbus_check_pec(partial_pec, &msg[num-1]) < 0)
			return -1;
	}

L
Linus Torvalds 已提交
1598 1599 1600 1601 1602 1603 1604 1605
	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 已提交
1606
			case I2C_SMBUS_WORD_DATA:
L
Linus Torvalds 已提交
1607 1608 1609 1610
			case I2C_SMBUS_PROC_CALL:
				data->word = msgbuf1[0] | (msgbuf1[1] << 8);
				break;
			case I2C_SMBUS_I2C_BLOCK_DATA:
1611
				for (i = 0; i < data->block[0]; i++)
L
Linus Torvalds 已提交
1612 1613
					data->block[i+1] = msgbuf1[i];
				break;
1614 1615 1616 1617 1618
			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 已提交
1619 1620 1621 1622 1623 1624
		}
	return 0;
}


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

	flags &= I2C_M_TEN | I2C_CLIENT_PEC;

	if (adapter->algo->smbus_xfer) {
1633
		mutex_lock(&adapter->bus_lock);
L
Linus Torvalds 已提交
1634 1635
		res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
		                                command,size,data);
1636
		mutex_unlock(&adapter->bus_lock);
L
Linus Torvalds 已提交
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
	} 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");