i2c-core.c 41.5 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 20 21
/* 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.		     */
/* ------------------------------------------------------------------------- */

/* With some changes from Kysti Mlkki <kmalkki@cc.hut.fi>.
   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>
L
Linus Torvalds 已提交
36 37
#include <asm/uaccess.h>

38 39
#include "i2c-core.h"

L
Linus Torvalds 已提交
40 41 42

static LIST_HEAD(adapters);
static LIST_HEAD(drivers);
43
static DEFINE_MUTEX(core_lists);
L
Linus Torvalds 已提交
44 45
static DEFINE_IDR(i2c_adapter_idr);

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

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

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

	/* 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 已提交
65 66
}

D
David Brownell 已提交
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
#ifdef	CONFIG_HOTPLUG

/* uevent helps with hotplug: modprobe -q $(MODALIAS) */
static int i2c_device_uevent(struct device *dev, char **envp, int num_envp,
		      char *buffer, int buffer_size)
{
	struct i2c_client	*client = to_i2c_client(dev);
	int			i = 0, length = 0;

	/* by definition, legacy drivers can't hotplug */
	if (dev->driver || !client->driver_name)
		return 0;

	if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &length,
			"MODALIAS=%s", client->driver_name))
		return -ENOMEM;
	envp[i] = NULL;
	dev_dbg(dev, "uevent\n");
	return 0;
}

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

92
static int i2c_device_probe(struct device *dev)
L
Linus Torvalds 已提交
93
{
D
David Brownell 已提交
94 95 96 97 98 99 100 101
	struct i2c_client	*client = to_i2c_client(dev);
	struct i2c_driver	*driver = to_i2c_driver(dev->driver);

	if (!driver->probe)
		return -ENODEV;
	client->driver = driver;
	dev_dbg(dev, "probe\n");
	return driver->probe(client);
102
}
L
Linus Torvalds 已提交
103

104 105
static int i2c_device_remove(struct device *dev)
{
D
David Brownell 已提交
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
	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 已提交
124 125
}

126
static void i2c_device_shutdown(struct device *dev)
L
Linus Torvalds 已提交
127
{
128 129 130 131 132 133 134
	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 已提交
135 136
}

137
static int i2c_device_suspend(struct device * dev, pm_message_t mesg)
L
Linus Torvalds 已提交
138
{
139 140 141 142 143 144 145 146
	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 已提交
147 148
}

149
static int i2c_device_resume(struct device * dev)
L
Linus Torvalds 已提交
150
{
151 152 153 154 155 156 157 158
	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 已提交
159 160
}

D
David Brownell 已提交
161 162 163 164 165 166
static void i2c_client_release(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	complete(&client->released);
}

167 168 169 170 171
static void i2c_client_dev_release(struct device *dev)
{
	kfree(to_i2c_client(dev));
}

D
David Brownell 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
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);
	return client->driver_name
		? sprintf(buf, "%s\n", client->driver_name)
		: 0;
}

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),
	{ },
};

193
struct bus_type i2c_bus_type = {
194
	.name		= "i2c",
D
David Brownell 已提交
195
	.dev_attrs	= i2c_dev_attrs,
196
	.match		= i2c_device_match,
D
David Brownell 已提交
197
	.uevent		= i2c_device_uevent,
198 199 200 201 202
	.probe		= i2c_device_probe,
	.remove		= i2c_device_remove,
	.shutdown	= i2c_device_shutdown,
	.suspend	= i2c_device_suspend,
	.resume		= i2c_device_resume,
203
};
D
David Brownell 已提交
204
EXPORT_SYMBOL_GPL(i2c_bus_type);
205

206 207 208 209
/**
 * 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 已提交
210
 * Context: can sleep
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
 *
 * 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;
	client->flags = info->flags;
	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 已提交
259
 * Context: can sleep
260 261
 */
void i2c_unregister_device(struct i2c_client *client)
D
David Brownell 已提交
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
{
	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);
}
279
EXPORT_SYMBOL_GPL(i2c_unregister_device);
D
David Brownell 已提交
280 281


282 283
/* ------------------------------------------------------------------------- */

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

286
void i2c_adapter_dev_release(struct device *dev)
L
Linus Torvalds 已提交
287
{
288
	struct i2c_adapter *adap = to_i2c_adapter(dev);
L
Linus Torvalds 已提交
289 290
	complete(&adap->dev_released);
}
D
David Brownell 已提交
291
EXPORT_SYMBOL_GPL(i2c_adapter_dev_release);	/* exported to i2c-isa */
L
Linus Torvalds 已提交
292

D
David Brownell 已提交
293 294 295
static ssize_t
show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
{
296
	struct i2c_adapter *adap = to_i2c_adapter(dev);
D
David Brownell 已提交
297 298
	return sprintf(buf, "%s\n", adap->name);
}
299

D
David Brownell 已提交
300 301 302 303
static struct device_attribute i2c_adapter_attrs[] = {
	__ATTR(name, S_IRUGO, show_adapter_name, NULL),
	{ },
};
304

305
struct class i2c_adapter_class = {
306 307
	.owner			= THIS_MODULE,
	.name			= "i2c-adapter",
D
David Brownell 已提交
308
	.dev_attrs		= i2c_adapter_attrs,
L
Linus Torvalds 已提交
309
};
D
David Brownell 已提交
310
EXPORT_SYMBOL_GPL(i2c_adapter_class);		/* exported to i2c-isa */
L
Linus Torvalds 已提交
311

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
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);
}

328
static int i2c_register_adapter(struct i2c_adapter *adap)
L
Linus Torvalds 已提交
329
{
330
	int res = 0;
L
Linus Torvalds 已提交
331 332 333
	struct list_head   *item;
	struct i2c_driver  *driver;

334 335
	mutex_init(&adap->bus_lock);
	mutex_init(&adap->clist_lock);
L
Linus Torvalds 已提交
336 337
	INIT_LIST_HEAD(&adap->clients);

338 339 340
	mutex_lock(&core_lists);
	list_add_tail(&adap->list, &adapters);

L
Linus Torvalds 已提交
341 342 343 344
	/* Add the adapter to the driver core.
	 * If the parent pointer is not set up,
	 * we add this adapter to the host bus.
	 */
345
	if (adap->dev.parent == NULL) {
L
Linus Torvalds 已提交
346
		adap->dev.parent = &platform_bus;
347 348
		pr_debug("I2C adapter driver [%s] forgot to specify "
			 "physical device\n", adap->name);
349
	}
L
Linus Torvalds 已提交
350 351
	sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
	adap->dev.release = &i2c_adapter_dev_release;
J
Jean Delvare 已提交
352
	adap->dev.class = &i2c_adapter_class;
353 354 355
	res = device_register(&adap->dev);
	if (res)
		goto out_list;
L
Linus Torvalds 已提交
356

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

359 360 361 362
	/* 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 已提交
363
	/* let legacy drivers scan this bus for matching devices */
L
Linus Torvalds 已提交
364 365
	list_for_each(item,&drivers) {
		driver = list_entry(item, struct i2c_driver, list);
366
		if (driver->attach_adapter)
L
Linus Torvalds 已提交
367 368 369 370 371
			/* We ignore the return code; if it fails, too bad */
			driver->attach_adapter(adap);
	}

out_unlock:
372
	mutex_unlock(&core_lists);
L
Linus Torvalds 已提交
373
	return res;
374 375 376 377 378

out_list:
	list_del(&adap->list);
	idr_remove(&i2c_adapter_idr, adap->nr);
	goto out_unlock;
L
Linus Torvalds 已提交
379 380
}

381 382 383
/**
 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
 * @adapter: the adapter to add
D
David Brownell 已提交
384
 * Context: can sleep
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
 *
 * 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;

	mutex_lock(&core_lists);
	/* "above" here means "above or equal to", sigh */
	res = idr_get_new_above(&i2c_adapter_idr, adapter,
				__i2c_first_dynamic_bus_num, &id);
	mutex_unlock(&core_lists);

	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 已提交
422
 * Context: can sleep
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
 *
 * This routine is used to declare an I2C adapter when its bus number
 * matters.  Example: for I2C adapters from system-on-chip CPUs, or
 * otherwise built in to the system's mainboard, and where i2c_board_info
 * 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;

	mutex_lock(&core_lists);
	/* "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);
	}
	mutex_unlock(&core_lists);
	if (status == -EAGAIN)
		goto retry;

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

D
David Brownell 已提交
470 471 472 473 474 475 476 477
/**
 * 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 已提交
478 479 480 481 482 483 484 485
int i2c_del_adapter(struct i2c_adapter *adap)
{
	struct list_head  *item, *_n;
	struct i2c_adapter *adap_from_list;
	struct i2c_driver *driver;
	struct i2c_client *client;
	int res = 0;

486
	mutex_lock(&core_lists);
L
Linus Torvalds 已提交
487 488 489 490 491 492 493

	/* First make sure that this adapter was ever added */
	list_for_each_entry(adap_from_list, &adapters, list) {
		if (adap_from_list == adap)
			break;
	}
	if (adap_from_list != adap) {
494 495
		pr_debug("i2c-core: attempting to delete unregistered "
			 "adapter [%s]\n", adap->name);
L
Linus Torvalds 已提交
496 497 498 499 500 501 502 503
		res = -EINVAL;
		goto out_unlock;
	}

	list_for_each(item,&drivers) {
		driver = list_entry(item, struct i2c_driver, list);
		if (driver->detach_adapter)
			if ((res = driver->detach_adapter(adap))) {
504
				dev_err(&adap->dev, "detach_adapter failed "
505 506
					"for driver [%s]\n",
					driver->driver.name);
L
Linus Torvalds 已提交
507 508 509 510 511
				goto out_unlock;
			}
	}

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

L
Linus Torvalds 已提交
516
		client = list_entry(item, struct i2c_client, list);
D
David Brownell 已提交
517 518 519 520 521 522 523
		driver = client->driver;

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

D
David Brownell 已提交
525 526
		/* legacy drivers create and remove clients themselves */
		if ((res = driver->detach_client(client))) {
527 528
			dev_err(&adap->dev, "detach_client failed for client "
				"[%s] at address 0x%02x\n", client->name,
L
Linus Torvalds 已提交
529 530 531 532 533 534 535 536 537 538 539 540 541
				client->addr);
			goto out_unlock;
		}
	}

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

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

542
	/* free bus id */
L
Linus Torvalds 已提交
543 544
	idr_remove(&i2c_adapter_idr, adap->nr);

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

 out_unlock:
548
	mutex_unlock(&core_lists);
L
Linus Torvalds 已提交
549 550
	return res;
}
D
David Brownell 已提交
551
EXPORT_SYMBOL(i2c_del_adapter);
L
Linus Torvalds 已提交
552 553


D
David Brownell 已提交
554 555 556 557 558 559 560 561 562
/* ------------------------------------------------------------------------- */

/*
 * 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 已提交
563 564
 */

565
int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
L
Linus Torvalds 已提交
566
{
567
	int res;
L
Linus Torvalds 已提交
568

D
David Brownell 已提交
569
	/* new style driver methods can't mix with legacy ones */
D
David Brownell 已提交
570
	if (is_newstyle_driver(driver)) {
D
David Brownell 已提交
571 572 573 574 575 576 577 578 579
		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 已提交
580
	/* add the driver to the list of i2c drivers in the driver core */
581
	driver->driver.owner = owner;
L
Linus Torvalds 已提交
582 583
	driver->driver.bus = &i2c_bus_type;

584 585 586
	/* for new style drivers, when registration returns the driver core
	 * will have called probe() for all matching-but-unbound devices.
	 */
L
Linus Torvalds 已提交
587 588
	res = driver_register(&driver->driver);
	if (res)
589
		return res;
D
David Brownell 已提交
590

591 592
	mutex_lock(&core_lists);

L
Linus Torvalds 已提交
593
	list_add_tail(&driver->list,&drivers);
594
	pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
L
Linus Torvalds 已提交
595

D
David Brownell 已提交
596
	/* legacy drivers scan i2c busses directly */
597
	if (driver->attach_adapter) {
598 599 600
		struct i2c_adapter *adapter;

		list_for_each_entry(adapter, &adapters, list) {
L
Linus Torvalds 已提交
601 602 603 604
			driver->attach_adapter(adapter);
		}
	}

605
	mutex_unlock(&core_lists);
606
	return 0;
L
Linus Torvalds 已提交
607
}
608
EXPORT_SYMBOL(i2c_register_driver);
L
Linus Torvalds 已提交
609

D
David Brownell 已提交
610 611 612
/**
 * i2c_del_driver - unregister I2C driver
 * @driver: the driver being unregistered
D
David Brownell 已提交
613
 * Context: can sleep
D
David Brownell 已提交
614
 */
615
void i2c_del_driver(struct i2c_driver *driver)
L
Linus Torvalds 已提交
616 617 618 619
{
	struct list_head   *item1, *item2, *_n;
	struct i2c_client  *client;
	struct i2c_adapter *adap;
D
David Brownell 已提交
620

621
	mutex_lock(&core_lists);
L
Linus Torvalds 已提交
622

D
David Brownell 已提交
623 624 625 626
	/* new-style driver? */
	if (is_newstyle_driver(driver))
		goto unregister;

L
Linus Torvalds 已提交
627
	/* Have a look at each adapter, if clients of this driver are still
D
David Brownell 已提交
628
	 * attached. If so, detach them to be able to kill the driver
L
Linus Torvalds 已提交
629 630 631 632 633
	 * afterwards.
	 */
	list_for_each(item1,&adapters) {
		adap = list_entry(item1, struct i2c_adapter, list);
		if (driver->detach_adapter) {
634
			if (driver->detach_adapter(adap)) {
635
				dev_err(&adap->dev, "detach_adapter failed "
636 637
					"for driver [%s]\n",
					driver->driver.name);
L
Linus Torvalds 已提交
638 639 640 641 642 643
			}
		} else {
			list_for_each_safe(item2, _n, &adap->clients) {
				client = list_entry(item2, struct i2c_client, list);
				if (client->driver != driver)
					continue;
644 645 646
				dev_dbg(&adap->dev, "detaching client [%s] "
					"at 0x%02x\n", client->name,
					client->addr);
647
				if (driver->detach_client(client)) {
648 649 650
					dev_err(&adap->dev, "detach_client "
						"failed for client [%s] at "
						"0x%02x\n", client->name,
L
Linus Torvalds 已提交
651 652 653 654 655 656
						client->addr);
				}
			}
		}
	}

D
David Brownell 已提交
657
 unregister:
L
Linus Torvalds 已提交
658 659
	driver_unregister(&driver->driver);
	list_del(&driver->list);
660
	pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
L
Linus Torvalds 已提交
661

662
	mutex_unlock(&core_lists);
L
Linus Torvalds 已提交
663
}
D
David Brownell 已提交
664
EXPORT_SYMBOL(i2c_del_driver);
L
Linus Torvalds 已提交
665

D
David Brownell 已提交
666 667
/* ------------------------------------------------------------------------- */

L
Linus Torvalds 已提交
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
static int __i2c_check_addr(struct i2c_adapter *adapter, unsigned int addr)
{
	struct list_head   *item;
	struct i2c_client  *client;

	list_for_each(item,&adapter->clients) {
		client = list_entry(item, struct i2c_client, list);
		if (client->addr == addr)
			return -EBUSY;
	}
	return 0;
}

int i2c_check_addr(struct i2c_adapter *adapter, int addr)
{
	int rval;

685
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
686
	rval = __i2c_check_addr(adapter, addr);
687
	mutex_unlock(&adapter->clist_lock);
L
Linus Torvalds 已提交
688 689 690

	return rval;
}
D
David Brownell 已提交
691
EXPORT_SYMBOL(i2c_check_addr);
L
Linus Torvalds 已提交
692 693 694 695

int i2c_attach_client(struct i2c_client *client)
{
	struct i2c_adapter *adapter = client->adapter;
696
	int res = 0;
L
Linus Torvalds 已提交
697

698
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
699
	if (__i2c_check_addr(client->adapter, client->addr)) {
700 701
		res = -EBUSY;
		goto out_unlock;
L
Linus Torvalds 已提交
702 703
	}
	list_add_tail(&client->list,&adapter->clients);
D
David Brownell 已提交
704

705
	client->usage_count = 0;
L
Linus Torvalds 已提交
706 707 708

	client->dev.parent = &client->adapter->dev;
	client->dev.bus = &i2c_bus_type;
709 710 711 712

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

713
	if (client->driver && !is_newstyle_driver(client->driver)) {
714
		client->dev.release = i2c_client_release;
715 716
		client->dev.uevent_suppress = 1;
	} else
717
		client->dev.release = i2c_client_dev_release;
D
David Brownell 已提交
718

L
Linus Torvalds 已提交
719 720
	snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
		"%d-%04x", i2c_adapter_id(adapter), client->addr);
721 722
	dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
		client->name, client->dev.bus_id);
723 724 725 726
	res = device_register(&client->dev);
	if (res)
		goto out_list;
	mutex_unlock(&adapter->clist_lock);
727 728 729 730 731 732 733 734 735 736

	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;
737 738 739 740 741

out_list:
	list_del(&client->list);
	dev_err(&adapter->dev, "Failed to attach i2c client %s at 0x%02x "
		"(%d)\n", client->name, client->addr, res);
742 743 744
out_unlock:
	mutex_unlock(&adapter->clist_lock);
	return res;
L
Linus Torvalds 已提交
745
}
D
David Brownell 已提交
746
EXPORT_SYMBOL(i2c_attach_client);
L
Linus Torvalds 已提交
747 748 749 750 751

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

753
	if (client->usage_count > 0) {
754 755
		dev_warn(&client->dev, "Client [%s] still busy, "
			 "can't detach\n", client->name);
L
Linus Torvalds 已提交
756
		return -EBUSY;
757
	}
L
Linus Torvalds 已提交
758 759 760 761 762

	if (adapter->client_unregister)  {
		res = adapter->client_unregister(client);
		if (res) {
			dev_err(&client->dev,
763 764
				"client_unregister [%s] failed, "
				"client not detached\n", client->name);
L
Linus Torvalds 已提交
765 766 767 768
			goto out;
		}
	}

769
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
770 771 772
	list_del(&client->list);
	init_completion(&client->released);
	device_unregister(&client->dev);
773
	mutex_unlock(&adapter->clist_lock);
L
Linus Torvalds 已提交
774 775 776 777 778
	wait_for_completion(&client->released);

 out:
	return res;
}
D
David Brownell 已提交
779
EXPORT_SYMBOL(i2c_detach_client);
L
Linus Torvalds 已提交
780 781 782 783

static int i2c_inc_use_client(struct i2c_client *client)
{

784
	if (!try_module_get(client->driver->driver.owner))
L
Linus Torvalds 已提交
785 786
		return -ENODEV;
	if (!try_module_get(client->adapter->owner)) {
787
		module_put(client->driver->driver.owner);
L
Linus Torvalds 已提交
788 789 790 791 792 793 794 795
		return -ENODEV;
	}

	return 0;
}

static void i2c_dec_use_client(struct i2c_client *client)
{
796
	module_put(client->driver->driver.owner);
L
Linus Torvalds 已提交
797 798 799 800 801 802 803 804 805 806 807
	module_put(client->adapter->owner);
}

int i2c_use_client(struct i2c_client *client)
{
	int ret;

	ret = i2c_inc_use_client(client);
	if (ret)
		return ret;

808
	client->usage_count++;
L
Linus Torvalds 已提交
809 810 811

	return 0;
}
D
David Brownell 已提交
812
EXPORT_SYMBOL(i2c_use_client);
L
Linus Torvalds 已提交
813 814 815

int i2c_release_client(struct i2c_client *client)
{
816 817 818 819
	if (!client->usage_count) {
		pr_debug("i2c-core: %s used one too many times\n",
			 __FUNCTION__);
		return -EPERM;
L
Linus Torvalds 已提交
820
	}
D
David Brownell 已提交
821

822
	client->usage_count--;
L
Linus Torvalds 已提交
823
	i2c_dec_use_client(client);
D
David Brownell 已提交
824

L
Linus Torvalds 已提交
825 826
	return 0;
}
D
David Brownell 已提交
827
EXPORT_SYMBOL(i2c_release_client);
L
Linus Torvalds 已提交
828 829 830 831 832 833

void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
{
	struct list_head  *item;
	struct i2c_client *client;

834
	mutex_lock(&adap->clist_lock);
L
Linus Torvalds 已提交
835 836
	list_for_each(item,&adap->clients) {
		client = list_entry(item, struct i2c_client, list);
837
		if (!try_module_get(client->driver->driver.owner))
L
Linus Torvalds 已提交
838 839
			continue;
		if (NULL != client->driver->command) {
840
			mutex_unlock(&adap->clist_lock);
L
Linus Torvalds 已提交
841
			client->driver->command(client,cmd,arg);
842
			mutex_lock(&adap->clist_lock);
L
Linus Torvalds 已提交
843
		}
844
		module_put(client->driver->driver.owner);
L
Linus Torvalds 已提交
845
       }
846
       mutex_unlock(&adap->clist_lock);
L
Linus Torvalds 已提交
847
}
D
David Brownell 已提交
848
EXPORT_SYMBOL(i2c_clients_command);
L
Linus Torvalds 已提交
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881

static int __init i2c_init(void)
{
	int retval;

	retval = bus_register(&i2c_bus_type);
	if (retval)
		return retval;
	return class_register(&i2c_adapter_class);
}

static void __exit i2c_exit(void)
{
	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, "
882 883 884
				"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 已提交
885 886 887
		}
#endif

888
		mutex_lock_nested(&adap->bus_lock, adap->level);
L
Linus Torvalds 已提交
889
		ret = adap->algo->master_xfer(adap,msgs,num);
890
		mutex_unlock(&adap->bus_lock);
L
Linus Torvalds 已提交
891 892 893 894 895 896 897

		return ret;
	} else {
		dev_dbg(&adap->dev, "I2C level transfers not supported\n");
		return -ENOSYS;
	}
}
D
David Brownell 已提交
898
EXPORT_SYMBOL(i2c_transfer);
L
Linus Torvalds 已提交
899 900 901 902 903 904 905

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;

906 907 908 909
	msg.addr = client->addr;
	msg.flags = client->flags & I2C_M_TEN;
	msg.len = count;
	msg.buf = (char *)buf;
D
David Brownell 已提交
910

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

913 914 915
	/* If everything went ok (i.e. 1 msg transmitted), return #bytes
	   transmitted, else error code. */
	return (ret == 1) ? count : ret;
L
Linus Torvalds 已提交
916
}
D
David Brownell 已提交
917
EXPORT_SYMBOL(i2c_master_send);
L
Linus Torvalds 已提交
918 919 920 921 922 923

int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
{
	struct i2c_adapter *adap=client->adapter;
	struct i2c_msg msg;
	int ret;
924 925 926 927 928 929 930 931 932 933 934 935

	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 已提交
936
}
D
David Brownell 已提交
937
EXPORT_SYMBOL(i2c_master_recv);
L
Linus Torvalds 已提交
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958

int i2c_control(struct i2c_client *client,
	unsigned int cmd, unsigned long arg)
{
	int ret = 0;
	struct i2c_adapter *adap = client->adapter;

	dev_dbg(&client->adapter->dev, "i2c ioctl, cmd: 0x%x, arg: %#lx\n", cmd, arg);
	switch (cmd) {
		case I2C_RETRIES:
			adap->retries = arg;
			break;
		case I2C_TIMEOUT:
			adap->timeout = arg;
			break;
		default:
			if (adap->algo->algo_control!=NULL)
				ret = adap->algo->algo_control(adap,cmd,arg);
	}
	return ret;
}
D
David Brownell 已提交
959
EXPORT_SYMBOL(i2c_control);
L
Linus Torvalds 已提交
960 961 962 963 964 965

/* ----------------------------------------------------
 * the i2c address scanning function
 * Will not work for 10-bit addresses!
 * ----------------------------------------------------
 */
J
Jean Delvare 已提交
966 967 968 969 970 971 972 973 974 975
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;
976 977
	}

J
Jean Delvare 已提交
978 979 980 981 982
	/* Skip if already in use */
	if (i2c_check_addr(adapter, addr))
		return 0;

	/* Make sure there is something at this address, unless forced */
983 984 985 986 987 988 989 990 991 992
	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 已提交
993 994 995 996 997 998

	/* 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. */
999 1000 1001 1002 1003 1004 1005
	if (err == -ENODEV)
		err = 0;

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

L
Linus Torvalds 已提交
1008 1009 1010 1011
int i2c_probe(struct i2c_adapter *adapter,
	      struct i2c_client_address_data *address_data,
	      int (*found_proc) (struct i2c_adapter *, int, int))
{
J
Jean Delvare 已提交
1012
	int i, err;
L
Linus Torvalds 已提交
1013 1014
	int adap_id = i2c_adapter_id(adapter);

J
Jean Delvare 已提交
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
	/* Force entries are done first, and are not affected by ignore
	   entries */
	if (address_data->forces) {
		unsigned short **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);
					err = i2c_probe_address(adapter,
						forces[kind][i + 1],
						kind, found_proc);
					if (err)
						return err;
				}
L
Linus Torvalds 已提交
1037 1038
			}
		}
J
Jean Delvare 已提交
1039
	}
L
Linus Torvalds 已提交
1040

1041 1042 1043 1044
	/* 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 已提交
1045
			return 0;
1046 1047 1048 1049 1050 1051

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

J
Jean Delvare 已提交
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
	/* 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 已提交
1065
		}
J
Jean Delvare 已提交
1066
	}
L
Linus Torvalds 已提交
1067

J
Jean Delvare 已提交
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
	/* 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]);
1083 1084
				ignore = 1;
				break;
L
Linus Torvalds 已提交
1085 1086
			}
		}
J
Jean Delvare 已提交
1087
		if (ignore)
L
Linus Torvalds 已提交
1088 1089
			continue;

J
Jean Delvare 已提交
1090 1091 1092 1093 1094 1095 1096
		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 已提交
1097
	}
J
Jean Delvare 已提交
1098

L
Linus Torvalds 已提交
1099 1100
	return 0;
}
D
David Brownell 已提交
1101
EXPORT_SYMBOL(i2c_probe);
L
Linus Torvalds 已提交
1102

J
Jean Delvare 已提交
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
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;
	}

	mutex_lock(&adap->clist_lock);
	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 */
		if (__i2c_check_addr(adap, addr_list[i])) {
			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;
		}
	}
	mutex_unlock(&adap->clist_lock);

	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 已提交
1166 1167 1168
struct i2c_adapter* i2c_get_adapter(int id)
{
	struct i2c_adapter *adapter;
D
David Brownell 已提交
1169

1170
	mutex_lock(&core_lists);
1171 1172 1173 1174
	adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
	if (adapter && !try_module_get(adapter->owner))
		adapter = NULL;

1175
	mutex_unlock(&core_lists);
1176
	return adapter;
L
Linus Torvalds 已提交
1177
}
D
David Brownell 已提交
1178
EXPORT_SYMBOL(i2c_get_adapter);
L
Linus Torvalds 已提交
1179 1180 1181 1182 1183

void i2c_put_adapter(struct i2c_adapter *adap)
{
	module_put(adap->owner);
}
D
David Brownell 已提交
1184
EXPORT_SYMBOL(i2c_put_adapter);
L
Linus Torvalds 已提交
1185 1186 1187

/* The SMBus parts */

D
David Brownell 已提交
1188
#define POLY    (0x1070U << 3)
L
Linus Torvalds 已提交
1189 1190 1191 1192
static u8
crc8(u16 data)
{
	int i;
D
David Brownell 已提交
1193

L
Linus Torvalds 已提交
1194
	for(i = 0; i < 8; i++) {
D
David Brownell 已提交
1195
		if (data & 0x8000)
L
Linus Torvalds 已提交
1196 1197 1198 1199 1200 1201
			data = data ^ POLY;
		data = data << 1;
	}
	return (u8)(data >> 8);
}

1202 1203
/* 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 已提交
1204 1205 1206 1207
{
	int i;

	for(i = 0; i < count; i++)
1208
		crc = crc8((crc ^ p[i]) << 8);
L
Linus Torvalds 已提交
1209 1210 1211
	return crc;
}

1212 1213
/* 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 已提交
1214
{
1215 1216 1217 1218 1219 1220
	/* 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 已提交
1221 1222
}

1223 1224
/* Used for write only transactions */
static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
L
Linus Torvalds 已提交
1225
{
1226 1227
	msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
	msg->len++;
L
Linus Torvalds 已提交
1228 1229
}

1230 1231 1232 1233 1234 1235
/* 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 已提交
1236
{
1237 1238
	u8 rpec = msg->buf[--msg->len];
	cpec = i2c_smbus_msg_pec(cpec, msg);
L
Linus Torvalds 已提交
1239 1240 1241 1242 1243 1244

	if (rpec != cpec) {
		pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
			rpec, cpec);
		return -1;
	}
D
David Brownell 已提交
1245
	return 0;
L
Linus Torvalds 已提交
1246 1247 1248 1249 1250
}

s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
D
David Brownell 已提交
1251
	                      value,0,I2C_SMBUS_QUICK,NULL);
L
Linus Torvalds 已提交
1252
}
D
David Brownell 已提交
1253
EXPORT_SYMBOL(i2c_smbus_write_quick);
L
Linus Torvalds 已提交
1254 1255 1256 1257 1258 1259 1260 1261

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
1262
		return data.byte;
L
Linus Torvalds 已提交
1263
}
D
David Brownell 已提交
1264
EXPORT_SYMBOL(i2c_smbus_read_byte);
L
Linus Torvalds 已提交
1265 1266 1267 1268

s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
1269
	                      I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
L
Linus Torvalds 已提交
1270
}
D
David Brownell 已提交
1271
EXPORT_SYMBOL(i2c_smbus_write_byte);
L
Linus Torvalds 已提交
1272 1273 1274 1275 1276 1277 1278 1279

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
1280
		return data.byte;
L
Linus Torvalds 已提交
1281
}
D
David Brownell 已提交
1282
EXPORT_SYMBOL(i2c_smbus_read_byte_data);
L
Linus Torvalds 已提交
1283 1284 1285 1286 1287 1288 1289 1290 1291

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 已提交
1292
EXPORT_SYMBOL(i2c_smbus_write_byte_data);
L
Linus Torvalds 已提交
1293 1294 1295 1296 1297 1298 1299 1300

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
1301
		return data.word;
L
Linus Torvalds 已提交
1302
}
D
David Brownell 已提交
1303
EXPORT_SYMBOL(i2c_smbus_read_word_data);
L
Linus Torvalds 已提交
1304 1305 1306 1307 1308 1309 1310 1311 1312

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

1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
/* Returns the number of read bytes */
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 已提交
1331
s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
1332
			       u8 length, const u8 *values)
L
Linus Torvalds 已提交
1333 1334
{
	union i2c_smbus_data data;
1335

L
Linus Torvalds 已提交
1336 1337 1338
	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
1339
	memcpy(&data.block[1], values, length);
L
Linus Torvalds 已提交
1340 1341 1342 1343
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
			      I2C_SMBUS_WRITE,command,
			      I2C_SMBUS_BLOCK_DATA,&data);
}
D
David Brownell 已提交
1344
EXPORT_SYMBOL(i2c_smbus_write_block_data);
L
Linus Torvalds 已提交
1345 1346

/* Returns the number of read bytes */
1347 1348
s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command,
				  u8 length, u8 *values)
L
Linus Torvalds 已提交
1349 1350
{
	union i2c_smbus_data data;
1351

1352 1353 1354
	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
L
Linus Torvalds 已提交
1355 1356 1357 1358
	if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
	                      I2C_SMBUS_READ,command,
	                      I2C_SMBUS_I2C_BLOCK_DATA,&data))
		return -1;
1359 1360 1361

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

1365
s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
1366
				   u8 length, const u8 *values)
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
{
	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 已提交
1378
EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
1379

D
David Brownell 已提交
1380
/* Simulate a SMBus command using the i2c protocol
L
Linus Torvalds 已提交
1381
   No checking of parameters is done!  */
D
David Brownell 已提交
1382
static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr,
L
Linus Torvalds 已提交
1383
                                   unsigned short flags,
D
David Brownell 已提交
1384
                                   char read_write, u8 command, int size,
L
Linus Torvalds 已提交
1385 1386 1387 1388 1389 1390
                                   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. */
1391 1392
	unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
	unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
L
Linus Torvalds 已提交
1393
	int num = read_write == I2C_SMBUS_READ?2:1;
D
David Brownell 已提交
1394
	struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 },
L
Linus Torvalds 已提交
1395 1396 1397
	                          { addr, flags | I2C_M_RD, 0, msgbuf1 }
	                        };
	int i;
1398
	u8 partial_pec = 0;
L
Linus Torvalds 已提交
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

	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;
1429
			msgbuf0[2] = data->word >> 8;
L
Linus Torvalds 已提交
1430 1431 1432 1433 1434 1435 1436 1437
		}
		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;
1438
		msgbuf0[2] = data->word >> 8;
L
Linus Torvalds 已提交
1439 1440 1441
		break;
	case I2C_SMBUS_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1442 1443 1444
			msg[1].flags |= I2C_M_RECV_LEN;
			msg[1].len = 1; /* block length will be added by
					   the underlying bus driver */
L
Linus Torvalds 已提交
1445 1446 1447 1448 1449 1450 1451 1452
		} 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;
			}
1453
			for (i = 1; i < msg[0].len; i++)
L
Linus Torvalds 已提交
1454 1455 1456 1457
				msgbuf0[i] = data->block[i-1];
		}
		break;
	case I2C_SMBUS_BLOCK_PROC_CALL:
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
		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 "
				"block proc call size (%d)\n", __FUNCTION__,
				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 已提交
1473 1474
	case I2C_SMBUS_I2C_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1475
			msg[1].len = data->block[0];
L
Linus Torvalds 已提交
1476 1477
		} else {
			msg[0].len = data->block[0] + 1;
1478
			if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
L
Linus Torvalds 已提交
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
				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;
	}

1494 1495 1496 1497 1498
	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 已提交
1499
			if (num == 1) /* Write only */
1500 1501 1502 1503 1504 1505
				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 已提交
1506
			msg[num-1].len++;
1507 1508
	}

L
Linus Torvalds 已提交
1509 1510 1511
	if (i2c_transfer(adapter, msg, num) < 0)
		return -1;

1512 1513 1514 1515 1516 1517
	/* 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 已提交
1518 1519 1520 1521 1522 1523 1524 1525
	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 已提交
1526
			case I2C_SMBUS_WORD_DATA:
L
Linus Torvalds 已提交
1527 1528 1529 1530
			case I2C_SMBUS_PROC_CALL:
				data->word = msgbuf1[0] | (msgbuf1[1] << 8);
				break;
			case I2C_SMBUS_I2C_BLOCK_DATA:
1531
				for (i = 0; i < data->block[0]; i++)
L
Linus Torvalds 已提交
1532 1533
					data->block[i+1] = msgbuf1[i];
				break;
1534 1535 1536 1537 1538
			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 已提交
1539 1540 1541 1542 1543 1544
		}
	return 0;
}


s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
D
David Brownell 已提交
1545
                   char read_write, u8 command, int size,
L
Linus Torvalds 已提交
1546 1547 1548 1549 1550 1551 1552
                   union i2c_smbus_data * data)
{
	s32 res;

	flags &= I2C_M_TEN | I2C_CLIENT_PEC;

	if (adapter->algo->smbus_xfer) {
1553
		mutex_lock(&adapter->bus_lock);
L
Linus Torvalds 已提交
1554 1555
		res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
		                                command,size,data);
1556
		mutex_unlock(&adapter->bus_lock);
L
Linus Torvalds 已提交
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
	} 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");