i2c-core.c 54.7 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);

45 46 47
#define is_newstyle_driver(d) ((d)->probe || (d)->remove || (d)->detect)

static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
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;

77
	return 0;
L
Linus Torvalds 已提交
78 79
}

D
David Brownell 已提交
80 81 82
#ifdef	CONFIG_HOTPLUG

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

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

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

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

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

J
Jean Delvare 已提交
108
	if (!driver->probe || !driver->id_table)
D
David Brownell 已提交
109 110
		return -ENODEV;
	client->driver = driver;
M
Marc Pignat 已提交
111 112 113
	if (!device_can_wakeup(&client->dev))
		device_init_wakeup(&client->dev,
					client->flags & I2C_CLIENT_WAKE);
D
David Brownell 已提交
114
	dev_dbg(dev, "probe\n");
115

J
Jean Delvare 已提交
116
	status = driver->probe(client, i2c_match_id(driver->id_table, client));
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),
	{ },
};

J
Jon Smirl 已提交
209
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
};
J
Jon Smirl 已提交
220
EXPORT_SYMBOL_GPL(i2c_bus_type);
221

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

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


241 242 243 244
/**
 * 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 已提交
245
 * Context: can sleep
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
 *
 * 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;
268

A
Anton Vorontsov 已提交
269 270 271
	if (info->archdata)
		client->dev.archdata = *info->archdata;

M
Marc Pignat 已提交
272
	client->flags = info->flags;
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
	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 已提交
296
 * Context: can sleep
297 298
 */
void i2c_unregister_device(struct i2c_client *client)
D
David Brownell 已提交
299 300 301 302 303 304 305 306 307 308 309
{
	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;
	}

310 311 312 313 314 315 316 317
	if (adapter->client_unregister) {
		if (adapter->client_unregister(client)) {
			dev_warn(&client->dev,
				 "client_unregister [%s] failed\n",
				 client->name);
		}
	}

D
David Brownell 已提交
318 319 320 321 322 323
	mutex_lock(&adapter->clist_lock);
	list_del(&client->list);
	mutex_unlock(&adapter->clist_lock);

	device_unregister(&client->dev);
}
324
EXPORT_SYMBOL_GPL(i2c_unregister_device);
D
David Brownell 已提交
325 326


J
Jean Delvare 已提交
327 328 329 330 331
static const struct i2c_device_id dummy_id[] = {
	{ "dummy", 0 },
	{ },
};

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

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

static struct i2c_driver dummy_driver = {
	.driver.name	= "dummy",
345 346
	.probe		= dummy_probe,
	.remove		= dummy_remove,
J
Jean Delvare 已提交
347
	.id_table	= dummy_id,
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
};

/**
 * 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 已提交
369
i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
370 371
{
	struct i2c_board_info info = {
J
Jean Delvare 已提交
372
		I2C_BOARD_INFO("dummy", address),
373 374 375 376 377 378
	};

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

379 380
/* ------------------------------------------------------------------------- */

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

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

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

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

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

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

423 424 425 426 427
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;

428 429 430 431
	/* Detect supported devices on that bus, and instantiate them */
	i2c_detect(adap, driver);

	/* Let legacy drivers scan this bus for matching devices */
432 433 434 435 436 437 438
	if (driver->attach_adapter) {
		/* We ignore the return code; if it fails, too bad */
		driver->attach_adapter(adap);
	}
	return 0;
}

439
static int i2c_register_adapter(struct i2c_adapter *adap)
L
Linus Torvalds 已提交
440
{
441
	int res = 0, dummy;
L
Linus Torvalds 已提交
442

443 444 445 446
	/* Can't register until after driver model init */
	if (unlikely(WARN_ON(!i2c_bus_type.p)))
		return -EAGAIN;

447 448
	mutex_init(&adap->bus_lock);
	mutex_init(&adap->clist_lock);
L
Linus Torvalds 已提交
449 450
	INIT_LIST_HEAD(&adap->clients);

J
Jean Delvare 已提交
451
	mutex_lock(&core_lock);
452

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

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

471 472 473 474
	/* create pre-declared device nodes for new-style drivers */
	if (adap->nr < __i2c_first_dynamic_bus_num)
		i2c_scan_static_board_info(adap);

475
	/* Notify drivers */
476 477
	dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,
				 i2c_do_add_adapter);
L
Linus Torvalds 已提交
478 479

out_unlock:
J
Jean Delvare 已提交
480
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
481
	return res;
482 483 484 485

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

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

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

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

577 578 579 580
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;
581
	struct i2c_client *client, *_n;
582 583
	int res;

584 585
	/* Remove the devices we created ourselves as the result of hardware
	 * probing (using a driver's detect method) */
586 587 588 589 590 591 592 593 594
	list_for_each_entry_safe(client, _n, &driver->clients, detected) {
		if (client->adapter == adapter) {
			dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
				client->name, client->addr);
			list_del(&client->detected);
			i2c_unregister_device(client);
		}
	}

595 596 597 598 599 600 601 602 603
	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 已提交
604 605 606 607 608 609 610 611
/**
 * 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 已提交
612 613
int i2c_del_adapter(struct i2c_adapter *adap)
{
614
	struct i2c_client *client, *_n;
L
Linus Torvalds 已提交
615 616
	int res = 0;

J
Jean Delvare 已提交
617
	mutex_lock(&core_lock);
L
Linus Torvalds 已提交
618 619

	/* First make sure that this adapter was ever added */
620
	if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {
621 622
		pr_debug("i2c-core: attempting to delete unregistered "
			 "adapter [%s]\n", adap->name);
L
Linus Torvalds 已提交
623 624 625 626
		res = -EINVAL;
		goto out_unlock;
	}

627 628 629 630 631
	/* 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 已提交
632 633

	/* detach any active clients. This must be done first, because
634
	 * it can fail; in which case we give up. */
635
	list_for_each_entry_safe_reverse(client, _n, &adap->clients, list) {
D
David Brownell 已提交
636 637 638 639 640 641 642 643 644
		struct i2c_driver	*driver;

		driver = client->driver;

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

D
David Brownell 已提交
646 647
		/* legacy drivers create and remove clients themselves */
		if ((res = driver->detach_client(client))) {
648 649
			dev_err(&adap->dev, "detach_client failed for client "
				"[%s] at address 0x%02x\n", client->name,
L
Linus Torvalds 已提交
650 651 652 653 654 655 656 657 658 659 660 661
				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);

662
	/* free bus id */
L
Linus Torvalds 已提交
663 664
	idr_remove(&i2c_adapter_idr, adap->nr);

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

667 668 669 670
	/* Clear the device structure in case this adapter is ever going to be
	   added again */
	memset(&adap->dev, 0, sizeof(adap->dev));

L
Linus Torvalds 已提交
671
 out_unlock:
J
Jean Delvare 已提交
672
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
673 674
	return res;
}
D
David Brownell 已提交
675
EXPORT_SYMBOL(i2c_del_adapter);
L
Linus Torvalds 已提交
676 677


D
David Brownell 已提交
678 679
/* ------------------------------------------------------------------------- */

D
Dave Young 已提交
680 681 682 683 684
static int __attach_adapter(struct device *dev, void *data)
{
	struct i2c_adapter *adapter = to_i2c_adapter(dev);
	struct i2c_driver *driver = data;

685 686 687 688 689
	i2c_detect(adapter, driver);

	/* Legacy drivers scan i2c busses directly */
	if (driver->attach_adapter)
		driver->attach_adapter(adapter);
D
Dave Young 已提交
690 691 692 693

	return 0;
}

D
David Brownell 已提交
694 695 696 697 698 699 700
/*
 * 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 已提交
701 702
 */

703
int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
L
Linus Torvalds 已提交
704
{
705
	int res;
L
Linus Torvalds 已提交
706

707 708 709 710
	/* Can't register until after driver model init */
	if (unlikely(WARN_ON(!i2c_bus_type.p)))
		return -EAGAIN;

D
David Brownell 已提交
711
	/* new style driver methods can't mix with legacy ones */
D
David Brownell 已提交
712
	if (is_newstyle_driver(driver)) {
D
David Brownell 已提交
713 714 715 716 717 718 719 720 721
		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 已提交
722
	/* add the driver to the list of i2c drivers in the driver core */
723
	driver->driver.owner = owner;
L
Linus Torvalds 已提交
724 725
	driver->driver.bus = &i2c_bus_type;

726 727 728
	/* for new style drivers, when registration returns the driver core
	 * will have called probe() for all matching-but-unbound devices.
	 */
L
Linus Torvalds 已提交
729 730
	res = driver_register(&driver->driver);
	if (res)
731
		return res;
D
David Brownell 已提交
732

J
Jean Delvare 已提交
733
	mutex_lock(&core_lock);
734

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

737 738
	INIT_LIST_HEAD(&driver->clients);
	/* Walk the adapters that are already present */
739 740
	class_for_each_device(&i2c_adapter_class, NULL, driver,
			      __attach_adapter);
741

D
Dave Young 已提交
742 743 744 745 746 747 748 749 750
	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;
751 752
	struct i2c_client *client, *_n;

753 754
	/* Remove the devices we created ourselves as the result of hardware
	 * probing (using a driver's detect method) */
755 756 757 758 759 760 761 762 763
	list_for_each_entry_safe(client, _n, &driver->clients, detected) {
		dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
			client->name, client->addr);
		list_del(&client->detected);
		i2c_unregister_device(client);
	}

	if (is_newstyle_driver(driver))
		return 0;
D
Dave Young 已提交
764 765 766 767 768 769 770 771 772 773 774

	/* 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 {
775
		struct i2c_client *client, *_n;
D
Dave Young 已提交
776

777
		list_for_each_entry_safe(client, _n, &adapter->clients, list) {
D
Dave Young 已提交
778 779 780 781 782 783 784 785 786
			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 已提交
787 788 789
		}
	}

790
	return 0;
L
Linus Torvalds 已提交
791 792
}

D
David Brownell 已提交
793 794 795
/**
 * i2c_del_driver - unregister I2C driver
 * @driver: the driver being unregistered
D
David Brownell 已提交
796
 * Context: can sleep
D
David Brownell 已提交
797
 */
798
void i2c_del_driver(struct i2c_driver *driver)
L
Linus Torvalds 已提交
799
{
J
Jean Delvare 已提交
800
	mutex_lock(&core_lock);
L
Linus Torvalds 已提交
801

802 803
	class_for_each_device(&i2c_adapter_class, NULL, driver,
			      __detach_adapter);
L
Linus Torvalds 已提交
804 805

	driver_unregister(&driver->driver);
806
	pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
L
Linus Torvalds 已提交
807

J
Jean Delvare 已提交
808
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
809
}
D
David Brownell 已提交
810
EXPORT_SYMBOL(i2c_del_driver);
L
Linus Torvalds 已提交
811

D
David Brownell 已提交
812 813
/* ------------------------------------------------------------------------- */

814
static int __i2c_check_addr(struct device *dev, void *addrp)
L
Linus Torvalds 已提交
815
{
816 817
	struct i2c_client	*client = i2c_verify_client(dev);
	int			addr = *(int *)addrp;
L
Linus Torvalds 已提交
818

819 820
	if (client && client->addr == addr)
		return -EBUSY;
L
Linus Torvalds 已提交
821 822 823
	return 0;
}

J
Jean Delvare 已提交
824
static int i2c_check_addr(struct i2c_adapter *adapter, int addr)
L
Linus Torvalds 已提交
825
{
826
	return device_for_each_child(&adapter->dev, &addr, __i2c_check_addr);
L
Linus Torvalds 已提交
827 828 829 830 831
}

int i2c_attach_client(struct i2c_client *client)
{
	struct i2c_adapter *adapter = client->adapter;
832 833 834 835 836 837
	int res;

	/* Check for address business */
	res = i2c_check_addr(adapter, client->addr);
	if (res)
		return res;
L
Linus Torvalds 已提交
838 839 840

	client->dev.parent = &client->adapter->dev;
	client->dev.bus = &i2c_bus_type;
841 842 843 844

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

845
	if (client->driver && !is_newstyle_driver(client->driver)) {
846
		client->dev.release = i2c_client_release;
847
		dev_set_uevent_suppress(&client->dev, 1);
848
	} else
849
		client->dev.release = i2c_client_dev_release;
D
David Brownell 已提交
850

851 852
	dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adapter),
		     client->addr);
853 854
	res = device_register(&client->dev);
	if (res)
855 856 857 858
		goto out_err;

	mutex_lock(&adapter->clist_lock);
	list_add_tail(&client->list, &adapter->clients);
859
	mutex_unlock(&adapter->clist_lock);
860

861
	dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
862
		client->name, dev_name(&client->dev));
863

864 865 866 867 868 869 870 871 872
	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;
873

874
out_err:
875 876
	dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
		"(%d)\n", client->name, client->addr, res);
877
	return res;
L
Linus Torvalds 已提交
878
}
D
David Brownell 已提交
879
EXPORT_SYMBOL(i2c_attach_client);
L
Linus Torvalds 已提交
880 881 882 883 884

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

L
Linus Torvalds 已提交
886 887 888 889
	if (adapter->client_unregister)  {
		res = adapter->client_unregister(client);
		if (res) {
			dev_err(&client->dev,
890 891
				"client_unregister [%s] failed, "
				"client not detached\n", client->name);
L
Linus Torvalds 已提交
892 893 894 895
			goto out;
		}
	}

896
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
897
	list_del(&client->list);
898 899
	mutex_unlock(&adapter->clist_lock);

L
Linus Torvalds 已提交
900 901 902 903 904 905 906
	init_completion(&client->released);
	device_unregister(&client->dev);
	wait_for_completion(&client->released);

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

909 910 911 912 913 914 915 916 917 918 919 920
/**
 * 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 已提交
921
{
922 923 924
	if (client && get_device(&client->dev))
		return client;
	return NULL;
L
Linus Torvalds 已提交
925
}
D
David Brownell 已提交
926
EXPORT_SYMBOL(i2c_use_client);
L
Linus Torvalds 已提交
927

928 929 930 931 932 933 934
/**
 * 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 已提交
935
{
936 937
	if (client)
		put_device(&client->dev);
L
Linus Torvalds 已提交
938
}
D
David Brownell 已提交
939
EXPORT_SYMBOL(i2c_release_client);
L
Linus Torvalds 已提交
940

941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
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 已提交
956 957
void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
{
958
	struct i2c_cmd_arg	cmd_arg;
L
Linus Torvalds 已提交
959

960 961 962
	cmd_arg.cmd = cmd;
	cmd_arg.arg = arg;
	device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
L
Linus Torvalds 已提交
963
}
D
David Brownell 已提交
964
EXPORT_SYMBOL(i2c_clients_command);
L
Linus Torvalds 已提交
965 966 967 968 969 970 971 972

static int __init i2c_init(void)
{
	int retval;

	retval = bus_register(&i2c_bus_type);
	if (retval)
		return retval;
973 974 975 976 977 978 979 980 981 982 983 984 985
	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 已提交
986 987 988 989
}

static void __exit i2c_exit(void)
{
990
	i2c_del_driver(&dummy_driver);
L
Linus Torvalds 已提交
991 992 993 994
	class_unregister(&i2c_adapter_class);
	bus_unregister(&i2c_bus_type);
}

D
David Brownell 已提交
995 996 997 998
/* We must initialize early, because some subsystems register i2c drivers
 * in subsys_initcall() code, but are linked (and initialized) before i2c.
 */
postcore_initcall(i2c_init);
L
Linus Torvalds 已提交
999 1000 1001 1002 1003 1004 1005
module_exit(i2c_exit);

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

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
/**
 * i2c_transfer - execute a single or combined I2C message
 * @adap: Handle to I2C bus
 * @msgs: One or more messages to execute before STOP is issued to
 *	terminate the operation; each message begins with a START.
 * @num: Number of messages to be executed.
 *
 * Returns negative errno, else the number of messages executed.
 *
 * Note that there is no requirement that each message be sent to
 * the same slave address, although that is the most common model.
 */
L
Linus Torvalds 已提交
1018 1019 1020 1021
int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
{
	int ret;

1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
	/* REVISIT the fault reporting model here is weak:
	 *
	 *  - When we get an error after receiving N bytes from a slave,
	 *    there is no way to report "N".
	 *
	 *  - When we get a NAK after transmitting N bytes to a slave,
	 *    there is no way to report "N" ... or to let the master
	 *    continue executing the rest of this combined message, if
	 *    that's the appropriate response.
	 *
	 *  - When for example "num" is two and we successfully complete
	 *    the first message but get an error part way through the
	 *    second, it's unclear whether that should be reported as
	 *    one (discarding status on the second message) or errno
	 *    (discarding status on the first one).
	 */

L
Linus Torvalds 已提交
1039 1040 1041 1042
	if (adap->algo->master_xfer) {
#ifdef DEBUG
		for (ret = 0; ret < num; ret++) {
			dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
1043 1044 1045
				"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 已提交
1046 1047 1048
		}
#endif

1049 1050 1051 1052 1053 1054 1055 1056 1057
		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 已提交
1058
		ret = adap->algo->master_xfer(adap,msgs,num);
1059
		mutex_unlock(&adap->bus_lock);
L
Linus Torvalds 已提交
1060 1061 1062 1063

		return ret;
	} else {
		dev_dbg(&adap->dev, "I2C level transfers not supported\n");
D
David Brownell 已提交
1064
		return -EOPNOTSUPP;
L
Linus Torvalds 已提交
1065 1066
	}
}
D
David Brownell 已提交
1067
EXPORT_SYMBOL(i2c_transfer);
L
Linus Torvalds 已提交
1068

1069 1070 1071 1072 1073 1074 1075 1076
/**
 * i2c_master_send - issue a single I2C message in master transmit mode
 * @client: Handle to slave device
 * @buf: Data that will be written to the slave
 * @count: How many bytes to write
 *
 * Returns negative errno, or else the number of bytes written.
 */
L
Linus Torvalds 已提交
1077 1078 1079 1080 1081 1082
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;

1083 1084 1085 1086
	msg.addr = client->addr;
	msg.flags = client->flags & I2C_M_TEN;
	msg.len = count;
	msg.buf = (char *)buf;
D
David Brownell 已提交
1087

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

1090 1091 1092
	/* If everything went ok (i.e. 1 msg transmitted), return #bytes
	   transmitted, else error code. */
	return (ret == 1) ? count : ret;
L
Linus Torvalds 已提交
1093
}
D
David Brownell 已提交
1094
EXPORT_SYMBOL(i2c_master_send);
L
Linus Torvalds 已提交
1095

1096 1097 1098 1099 1100 1101 1102 1103
/**
 * i2c_master_recv - issue a single I2C message in master receive mode
 * @client: Handle to slave device
 * @buf: Where to store data read from slave
 * @count: How many bytes to read
 *
 * Returns negative errno, or else the number of bytes read.
 */
L
Linus Torvalds 已提交
1104 1105 1106 1107 1108
int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
{
	struct i2c_adapter *adap=client->adapter;
	struct i2c_msg msg;
	int ret;
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120

	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 已提交
1121
}
D
David Brownell 已提交
1122
EXPORT_SYMBOL(i2c_master_recv);
L
Linus Torvalds 已提交
1123 1124 1125 1126 1127 1128

/* ----------------------------------------------------
 * the i2c address scanning function
 * Will not work for 10-bit addresses!
 * ----------------------------------------------------
 */
J
Jean Delvare 已提交
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
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;
1139 1140
	}

J
Jean Delvare 已提交
1141 1142 1143 1144 1145
	/* Skip if already in use */
	if (i2c_check_addr(adapter, addr))
		return 0;

	/* Make sure there is something at this address, unless forced */
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
	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 已提交
1156 1157 1158 1159 1160 1161

	/* 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. */
1162 1163 1164 1165 1166 1167 1168
	if (err == -ENODEV)
		err = 0;

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

L
Linus Torvalds 已提交
1171
int i2c_probe(struct i2c_adapter *adapter,
1172
	      const struct i2c_client_address_data *address_data,
L
Linus Torvalds 已提交
1173 1174
	      int (*found_proc) (struct i2c_adapter *, int, int))
{
J
Jean Delvare 已提交
1175
	int i, err;
L
Linus Torvalds 已提交
1176 1177
	int adap_id = i2c_adapter_id(adapter);

J
Jean Delvare 已提交
1178 1179 1180
	/* Force entries are done first, and are not affected by ignore
	   entries */
	if (address_data->forces) {
1181
		const unsigned short * const *forces = address_data->forces;
J
Jean Delvare 已提交
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
		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 已提交
1200 1201
			}
		}
J
Jean Delvare 已提交
1202
	}
L
Linus Torvalds 已提交
1203

1204 1205 1206 1207
	/* 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 已提交
1208
			return 0;
1209

1210 1211
		dev_dbg(&adapter->dev, "SMBus Quick command not supported, "
			"can't probe for chips\n");
D
David Brownell 已提交
1212
		return -EOPNOTSUPP;
1213 1214
	}

J
Jean Delvare 已提交
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
	/* 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 已提交
1228
		}
J
Jean Delvare 已提交
1229
	}
L
Linus Torvalds 已提交
1230

J
Jean Delvare 已提交
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
	/* 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]);
1246 1247
				ignore = 1;
				break;
L
Linus Torvalds 已提交
1248 1249
			}
		}
J
Jean Delvare 已提交
1250
		if (ignore)
L
Linus Torvalds 已提交
1251 1252
			continue;

J
Jean Delvare 已提交
1253 1254 1255 1256 1257 1258 1259
		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 已提交
1260
	}
J
Jean Delvare 已提交
1261

L
Linus Torvalds 已提交
1262 1263
	return 0;
}
D
David Brownell 已提交
1264
EXPORT_SYMBOL(i2c_probe);
L
Linus Torvalds 已提交
1265

1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
/* Separate detection function for new-style drivers */
static int i2c_detect_address(struct i2c_client *temp_client, int kind,
			      struct i2c_driver *driver)
{
	struct i2c_board_info info;
	struct i2c_adapter *adapter = temp_client->adapter;
	int addr = temp_client->addr;
	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;
	}

	/* Skip if already in use */
	if (i2c_check_addr(adapter, addr))
		return 0;

	/* Make sure there is something at this address, unless forced */
	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);
	}

	/* Finally call the custom detection function */
	memset(&info, 0, sizeof(struct i2c_board_info));
	info.addr = addr;
	err = driver->detect(temp_client, kind, &info);
	if (err) {
		/* -ENODEV is returned if the detection fails. We catch it
		   here as this isn't an error. */
		return err == -ENODEV ? 0 : err;
	}

	/* Consistency check */
	if (info.type[0] == '\0') {
		dev_err(&adapter->dev, "%s detection function provided "
			"no name for 0x%x\n", driver->driver.name,
			addr);
	} else {
		struct i2c_client *client;

		/* Detection succeeded, instantiate the device */
		dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
			info.type, info.addr);
		client = i2c_new_device(adapter, &info);
		if (client)
			list_add_tail(&client->detected, &driver->clients);
		else
			dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
				info.type, info.addr);
	}
	return 0;
}

static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
{
	const struct i2c_client_address_data *address_data;
	struct i2c_client *temp_client;
	int i, err = 0;
	int adap_id = i2c_adapter_id(adapter);

	address_data = driver->address_data;
	if (!driver->detect || !address_data)
		return 0;

	/* Set up a temporary client to help detect callback */
	temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
	if (!temp_client)
		return -ENOMEM;
	temp_client->adapter = adapter;

	/* Force entries are done first, and are not affected by ignore
	   entries */
	if (address_data->forces) {
		const unsigned short * const *forces = address_data->forces;
		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);
					temp_client->addr = forces[kind][i + 1];
					err = i2c_detect_address(temp_client,
						kind, driver);
					if (err)
						goto exit_free;
				}
			}
		}
	}

1372 1373 1374 1375
	/* Stop here if the classes do not match */
	if (!(adapter->class & driver->class))
		goto exit_free;

1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
	/* 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)
			goto exit_free;

		dev_warn(&adapter->dev, "SMBus Quick command not supported, "
			 "can't probe for chips\n");
		err = -EOPNOTSUPP;
		goto exit_free;
	}

	/* 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]);
			temp_client->addr = address_data->probe[i + 1];
			err = i2c_detect_address(temp_client, -1, driver);
			if (err)
				goto exit_free;
		}
	}

	/* 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]);
				ignore = 1;
				break;
			}
		}
		if (ignore)
			continue;

		dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
			"addr 0x%02x\n", adap_id,
			address_data->normal_i2c[i]);
		temp_client->addr = address_data->normal_i2c[i];
		err = i2c_detect_address(temp_client, -1, driver);
		if (err)
			goto exit_free;
	}

 exit_free:
	kfree(temp_client);
	return err;
}

J
Jean Delvare 已提交
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
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 */
1461
		if (i2c_check_addr(adap, addr_list[i])) {
J
Jean Delvare 已提交
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
			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)) {
1478 1479
			union i2c_smbus_data data;

J
Jean Delvare 已提交
1480 1481
			if (i2c_smbus_xfer(adap, addr_list[i], 0,
					   I2C_SMBUS_READ, 0,
1482
					   I2C_SMBUS_BYTE, &data) >= 0)
J
Jean Delvare 已提交
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
				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 已提交
1502 1503 1504
struct i2c_adapter* i2c_get_adapter(int id)
{
	struct i2c_adapter *adapter;
D
David Brownell 已提交
1505

J
Jean Delvare 已提交
1506
	mutex_lock(&core_lock);
1507 1508 1509 1510
	adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
	if (adapter && !try_module_get(adapter->owner))
		adapter = NULL;

J
Jean Delvare 已提交
1511
	mutex_unlock(&core_lock);
1512
	return adapter;
L
Linus Torvalds 已提交
1513
}
D
David Brownell 已提交
1514
EXPORT_SYMBOL(i2c_get_adapter);
L
Linus Torvalds 已提交
1515 1516 1517 1518 1519

void i2c_put_adapter(struct i2c_adapter *adap)
{
	module_put(adap->owner);
}
D
David Brownell 已提交
1520
EXPORT_SYMBOL(i2c_put_adapter);
L
Linus Torvalds 已提交
1521 1522 1523

/* The SMBus parts */

D
David Brownell 已提交
1524
#define POLY    (0x1070U << 3)
L
Linus Torvalds 已提交
1525 1526 1527 1528
static u8
crc8(u16 data)
{
	int i;
D
David Brownell 已提交
1529

L
Linus Torvalds 已提交
1530
	for(i = 0; i < 8; i++) {
D
David Brownell 已提交
1531
		if (data & 0x8000)
L
Linus Torvalds 已提交
1532 1533 1534 1535 1536 1537
			data = data ^ POLY;
		data = data << 1;
	}
	return (u8)(data >> 8);
}

1538 1539
/* 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 已提交
1540 1541 1542 1543
{
	int i;

	for(i = 0; i < count; i++)
1544
		crc = crc8((crc ^ p[i]) << 8);
L
Linus Torvalds 已提交
1545 1546 1547
	return crc;
}

1548 1549
/* 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 已提交
1550
{
1551 1552 1553 1554 1555 1556
	/* 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 已提交
1557 1558
}

1559 1560
/* Used for write only transactions */
static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
L
Linus Torvalds 已提交
1561
{
1562 1563
	msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
	msg->len++;
L
Linus Torvalds 已提交
1564 1565
}

1566 1567 1568 1569 1570 1571
/* 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 已提交
1572
{
1573 1574
	u8 rpec = msg->buf[--msg->len];
	cpec = i2c_smbus_msg_pec(cpec, msg);
L
Linus Torvalds 已提交
1575 1576 1577 1578

	if (rpec != cpec) {
		pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
			rpec, cpec);
D
David Brownell 已提交
1579
		return -EBADMSG;
L
Linus Torvalds 已提交
1580
	}
D
David Brownell 已提交
1581
	return 0;
L
Linus Torvalds 已提交
1582 1583
}

1584 1585 1586 1587 1588 1589 1590
/**
 * i2c_smbus_read_byte - SMBus "receive byte" protocol
 * @client: Handle to slave device
 *
 * This executes the SMBus "receive byte" protocol, returning negative errno
 * else the byte received from the device.
 */
L
Linus Torvalds 已提交
1591 1592 1593
s32 i2c_smbus_read_byte(struct i2c_client *client)
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1594 1595 1596 1597 1598 1599
	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 已提交
1600
}
D
David Brownell 已提交
1601
EXPORT_SYMBOL(i2c_smbus_read_byte);
L
Linus Torvalds 已提交
1602

1603 1604 1605 1606 1607 1608 1609 1610
/**
 * i2c_smbus_write_byte - SMBus "send byte" protocol
 * @client: Handle to slave device
 * @value: Byte to be sent
 *
 * This executes the SMBus "send byte" protocol, returning negative errno
 * else zero on success.
 */
L
Linus Torvalds 已提交
1611 1612 1613
s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1614
	                      I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
L
Linus Torvalds 已提交
1615
}
D
David Brownell 已提交
1616
EXPORT_SYMBOL(i2c_smbus_write_byte);
L
Linus Torvalds 已提交
1617

1618 1619 1620 1621 1622 1623 1624 1625
/**
 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
 * @client: Handle to slave device
 * @command: Byte interpreted by slave
 *
 * This executes the SMBus "read byte" protocol, returning negative errno
 * else a data byte received from the device.
 */
L
Linus Torvalds 已提交
1626 1627 1628
s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command)
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1629 1630 1631 1632 1633 1634
	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 已提交
1635
}
D
David Brownell 已提交
1636
EXPORT_SYMBOL(i2c_smbus_read_byte_data);
L
Linus Torvalds 已提交
1637

1638 1639 1640 1641 1642 1643 1644 1645 1646
/**
 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
 * @client: Handle to slave device
 * @command: Byte interpreted by slave
 * @value: Byte being written
 *
 * This executes the SMBus "write byte" protocol, returning negative errno
 * else zero on success.
 */
L
Linus Torvalds 已提交
1647 1648 1649 1650 1651 1652 1653 1654
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 已提交
1655
EXPORT_SYMBOL(i2c_smbus_write_byte_data);
L
Linus Torvalds 已提交
1656

1657 1658 1659 1660 1661 1662 1663 1664
/**
 * i2c_smbus_read_word_data - SMBus "read word" protocol
 * @client: Handle to slave device
 * @command: Byte interpreted by slave
 *
 * This executes the SMBus "read word" protocol, returning negative errno
 * else a 16-bit unsigned "word" received from the device.
 */
L
Linus Torvalds 已提交
1665 1666 1667
s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command)
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1668 1669 1670 1671 1672 1673
	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 已提交
1674
}
D
David Brownell 已提交
1675
EXPORT_SYMBOL(i2c_smbus_read_word_data);
L
Linus Torvalds 已提交
1676

1677 1678 1679 1680 1681 1682 1683 1684 1685
/**
 * i2c_smbus_write_word_data - SMBus "write word" protocol
 * @client: Handle to slave device
 * @command: Byte interpreted by slave
 * @value: 16-bit "word" being written
 *
 * This executes the SMBus "write word" protocol, returning negative errno
 * else zero on success.
 */
L
Linus Torvalds 已提交
1686 1687 1688 1689 1690 1691 1692 1693
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 已提交
1694
EXPORT_SYMBOL(i2c_smbus_write_word_data);
L
Linus Torvalds 已提交
1695

1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717
/**
 * i2c_smbus_process_call - SMBus "process call" protocol
 * @client: Handle to slave device
 * @command: Byte interpreted by slave
 * @value: 16-bit "word" being written
 *
 * This executes the SMBus "process call" protocol, returning negative errno
 * else a 16-bit unsigned "word" received from the device.
 */
s32 i2c_smbus_process_call(struct i2c_client *client, u8 command, u16 value)
{
	union i2c_smbus_data data;
	int status;
	data.word = value;

	status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
				I2C_SMBUS_WRITE, command,
				I2C_SMBUS_PROC_CALL, &data);
	return (status < 0) ? status : data.word;
}
EXPORT_SYMBOL(i2c_smbus_process_call);

D
David Brownell 已提交
1718
/**
1719
 * i2c_smbus_read_block_data - SMBus "block read" protocol
D
David Brownell 已提交
1720
 * @client: Handle to slave device
1721
 * @command: Byte interpreted by slave
D
David Brownell 已提交
1722 1723 1724
 * @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.
 *
1725 1726
 * This executes the SMBus "block read" protocol, returning negative errno
 * else the number of data bytes in the slave's response.
D
David Brownell 已提交
1727 1728 1729 1730 1731 1732
 *
 * 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.
 */
1733 1734 1735 1736
s32 i2c_smbus_read_block_data(struct i2c_client *client, u8 command,
			      u8 *values)
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1737
	int status;
1738

D
David Brownell 已提交
1739 1740 1741 1742 1743
	status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
				I2C_SMBUS_READ, command,
				I2C_SMBUS_BLOCK_DATA, &data);
	if (status)
		return status;
1744 1745 1746 1747 1748 1749

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

1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
/**
 * i2c_smbus_write_block_data - SMBus "block write" protocol
 * @client: Handle to slave device
 * @command: Byte interpreted by slave
 * @length: Size of data block; SMBus allows at most 32 bytes
 * @values: Byte array which will be written.
 *
 * This executes the SMBus "block write" protocol, returning negative errno
 * else zero on success.
 */
L
Linus Torvalds 已提交
1760
s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1761
			       u8 length, const u8 *values)
L
Linus Torvalds 已提交
1762 1763
{
	union i2c_smbus_data data;
1764

L
Linus Torvalds 已提交
1765 1766 1767
	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
1768
	memcpy(&data.block[1], values, length);
L
Linus Torvalds 已提交
1769 1770 1771 1772
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
			      I2C_SMBUS_WRITE,command,
			      I2C_SMBUS_BLOCK_DATA,&data);
}
D
David Brownell 已提交
1773
EXPORT_SYMBOL(i2c_smbus_write_block_data);
L
Linus Torvalds 已提交
1774 1775

/* Returns the number of read bytes */
1776 1777
s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
				  u8 length, u8 *values)
L
Linus Torvalds 已提交
1778 1779
{
	union i2c_smbus_data data;
D
David Brownell 已提交
1780
	int status;
1781

1782 1783 1784
	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
D
David Brownell 已提交
1785 1786 1787 1788 1789
	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;
1790 1791 1792

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

1796
s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1797
				   u8 length, const u8 *values)
1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
{
	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 已提交
1809
EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1810

D
David Brownell 已提交
1811
/* Simulate a SMBus command using the i2c protocol
L
Linus Torvalds 已提交
1812
   No checking of parameters is done!  */
D
David Brownell 已提交
1813
static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
L
Linus Torvalds 已提交
1814
                                   unsigned short flags,
D
David Brownell 已提交
1815
                                   char read_write, u8 command, int size,
L
Linus Torvalds 已提交
1816 1817 1818 1819 1820 1821
                                   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. */
1822 1823
	unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
	unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
L
Linus Torvalds 已提交
1824
	int num = read_write == I2C_SMBUS_READ?2:1;
D
David Brownell 已提交
1825
	struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
L
Linus Torvalds 已提交
1826 1827 1828
	                          { addr, flags | I2C_M_RD, 0, msgbuf1 }
	                        };
	int i;
1829
	u8 partial_pec = 0;
D
David Brownell 已提交
1830
	int status;
L
Linus Torvalds 已提交
1831 1832 1833 1834 1835 1836

	msgbuf0[0] = command;
	switch(size) {
	case I2C_SMBUS_QUICK:
		msg[0].len = 0;
		/* Special case: The read/write field is used as data */
R
Roel Kluin 已提交
1837 1838
		msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
					I2C_M_RD : 0);
L
Linus Torvalds 已提交
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
		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;
1862
			msgbuf0[2] = data->word >> 8;
L
Linus Torvalds 已提交
1863 1864 1865 1866 1867 1868 1869 1870
		}
		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;
1871
		msgbuf0[2] = data->word >> 8;
L
Linus Torvalds 已提交
1872 1873 1874
		break;
	case I2C_SMBUS_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1875 1876 1877
			msg[1].flags |= I2C_M_RECV_LEN;
			msg[1].len = 1; /* block length will be added by
					   the underlying bus driver */
L
Linus Torvalds 已提交
1878 1879 1880
		} else {
			msg[0].len = data->block[0] + 2;
			if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
D
David Brownell 已提交
1881 1882 1883 1884
				dev_err(&adapter->dev,
					"Invalid block write size %d\n",
					data->block[0]);
				return -EINVAL;
L
Linus Torvalds 已提交
1885
			}
1886
			for (i = 1; i < msg[0].len; i++)
L
Linus Torvalds 已提交
1887 1888 1889 1890
				msgbuf0[i] = data->block[i-1];
		}
		break;
	case I2C_SMBUS_BLOCK_PROC_CALL:
1891 1892 1893
		num = 2; /* Another special case */
		read_write = I2C_SMBUS_READ;
		if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
D
David Brownell 已提交
1894 1895
			dev_err(&adapter->dev,
				"Invalid block write size %d\n",
1896
				data->block[0]);
D
David Brownell 已提交
1897
			return -EINVAL;
1898 1899 1900 1901 1902 1903 1904 1905
		}
		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 已提交
1906 1907
	case I2C_SMBUS_I2C_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1908
			msg[1].len = data->block[0];
L
Linus Torvalds 已提交
1909 1910
		} else {
			msg[0].len = data->block[0] + 1;
1911
			if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
D
David Brownell 已提交
1912 1913 1914 1915
				dev_err(&adapter->dev,
					"Invalid block write size %d\n",
					data->block[0]);
				return -EINVAL;
L
Linus Torvalds 已提交
1916 1917 1918 1919 1920 1921
			}
			for (i = 1; i <= data->block[0]; i++)
				msgbuf0[i] = data->block[i];
		}
		break;
	default:
D
David Brownell 已提交
1922 1923
		dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
		return -EOPNOTSUPP;
L
Linus Torvalds 已提交
1924 1925
	}

1926 1927 1928 1929 1930
	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 已提交
1931
			if (num == 1) /* Write only */
1932 1933 1934 1935 1936 1937
				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 已提交
1938
			msg[num-1].len++;
1939 1940
	}

D
David Brownell 已提交
1941 1942 1943
	status = i2c_transfer(adapter, msg, num);
	if (status < 0)
		return status;
L
Linus Torvalds 已提交
1944

1945 1946
	/* Check PEC if last message is a read */
	if (i && (msg[num-1].flags & I2C_M_RD)) {
D
David Brownell 已提交
1947 1948 1949
		status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
		if (status < 0)
			return status;
1950 1951
	}

L
Linus Torvalds 已提交
1952 1953 1954 1955 1956 1957 1958 1959
	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 已提交
1960
			case I2C_SMBUS_WORD_DATA:
L
Linus Torvalds 已提交
1961 1962 1963 1964
			case I2C_SMBUS_PROC_CALL:
				data->word = msgbuf1[0] | (msgbuf1[1] << 8);
				break;
			case I2C_SMBUS_I2C_BLOCK_DATA:
1965
				for (i = 0; i < data->block[0]; i++)
L
Linus Torvalds 已提交
1966 1967
					data->block[i+1] = msgbuf1[i];
				break;
1968 1969 1970 1971 1972
			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 已提交
1973 1974 1975 1976
		}
	return 0;
}

1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
/**
 * i2c_smbus_xfer - execute SMBus protocol operations
 * @adapter: Handle to I2C bus
 * @addr: Address of SMBus slave on that bus
 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
 * @command: Byte interpreted by slave, for protocols which use such bytes
 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
 * @data: Data to be read or written
 *
 * This executes an SMBus protocol operation, and returns a negative
 * errno code else zero on success.
 */
L
Linus Torvalds 已提交
1990
s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
1991
		   char read_write, u8 command, int protocol,
L
Linus Torvalds 已提交
1992 1993 1994 1995 1996 1997 1998
                   union i2c_smbus_data * data)
{
	s32 res;

	flags &= I2C_M_TEN | I2C_CLIENT_PEC;

	if (adapter->algo->smbus_xfer) {
1999
		mutex_lock(&adapter->bus_lock);
L
Linus Torvalds 已提交
2000
		res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
2001
						command, protocol, data);
2002
		mutex_unlock(&adapter->bus_lock);
L
Linus Torvalds 已提交
2003 2004
	} else
		res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
2005
					      command, protocol, data);
L
Linus Torvalds 已提交
2006 2007 2008 2009 2010 2011 2012 2013

	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");