i2c-core.c 31.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 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>
L
Linus Torvalds 已提交
35 36 37 38 39
#include <asm/uaccess.h>


static LIST_HEAD(adapters);
static LIST_HEAD(drivers);
40
static DEFINE_MUTEX(core_lists);
L
Linus Torvalds 已提交
41 42 43 44 45 46 47 48 49 50 51 52 53
static DEFINE_IDR(i2c_adapter_idr);

/* match always succeeds, as we want the probe() to tell if we really accept this match */
static int i2c_device_match(struct device *dev, struct device_driver *drv)
{
	return 1;
}

static int i2c_bus_suspend(struct device * dev, pm_message_t state)
{
	int rc = 0;

	if (dev->driver && dev->driver->suspend)
54
		rc = dev->driver->suspend(dev, state);
L
Linus Torvalds 已提交
55 56 57 58 59 60 61 62
	return rc;
}

static int i2c_bus_resume(struct device * dev)
{
	int rc = 0;
	
	if (dev->driver && dev->driver->resume)
63
		rc = dev->driver->resume(dev);
L
Linus Torvalds 已提交
64 65 66 67 68 69 70 71 72 73 74 75 76
	return rc;
}

static int i2c_device_probe(struct device *dev)
{
	return -ENODEV;
}

static int i2c_device_remove(struct device *dev)
{
	return 0;
}

77 78 79 80 81 82 83 84 85
struct bus_type i2c_bus_type = {
	.name =		"i2c",
	.match =	i2c_device_match,
	.probe =	i2c_device_probe,
	.remove =	i2c_device_remove,
	.suspend =      i2c_bus_suspend,
	.resume =       i2c_bus_resume,
};

86
void i2c_adapter_dev_release(struct device *dev)
L
Linus Torvalds 已提交
87 88 89 90 91
{
	struct i2c_adapter *adap = dev_to_i2c_adapter(dev);
	complete(&adap->dev_released);
}

92
struct device_driver i2c_adapter_driver = {
93
	.owner = THIS_MODULE,
L
Linus Torvalds 已提交
94 95 96 97 98 99 100 101 102 103
	.name =	"i2c_adapter",
	.bus = &i2c_bus_type,
};

static void i2c_adapter_class_dev_release(struct class_device *dev)
{
	struct i2c_adapter *adap = class_dev_to_i2c_adapter(dev);
	complete(&adap->class_dev_released);
}

104
struct class i2c_adapter_class = {
105
	.owner =	THIS_MODULE,
L
Linus Torvalds 已提交
106 107 108 109
	.name =		"i2c-adapter",
	.release =	&i2c_adapter_class_dev_release,
};

110
static ssize_t show_adapter_name(struct device *dev, struct device_attribute *attr, char *buf)
L
Linus Torvalds 已提交
111 112 113 114 115 116 117 118 119 120 121 122 123
{
	struct i2c_adapter *adap = dev_to_i2c_adapter(dev);
	return sprintf(buf, "%s\n", adap->name);
}
static DEVICE_ATTR(name, S_IRUGO, show_adapter_name, NULL);


static void i2c_client_release(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	complete(&client->released);
}

124
static ssize_t show_client_name(struct device *dev, struct device_attribute *attr, char *buf)
L
Linus Torvalds 已提交
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
{
	struct i2c_client *client = to_i2c_client(dev);
	return sprintf(buf, "%s\n", client->name);
}

/* 
 * We can't use the DEVICE_ATTR() macro here as we want the same filename for a
 * different type of a device.  So beware if the DEVICE_ATTR() macro ever
 * changes, this definition will also have to change.
 */
static struct device_attribute dev_attr_client_name = {
	.attr	= {.name = "name", .mode = S_IRUGO, .owner = THIS_MODULE },
	.show	= &show_client_name,
};


/* ---------------------------------------------------
 * registering functions 
 * --------------------------------------------------- 
 */

/* -----
 * i2c_add_adapter is called from within the algorithm layer,
 * when a new hw adapter registers. A new device is register to be
 * available for clients.
 */
int i2c_add_adapter(struct i2c_adapter *adap)
{
	int id, res = 0;
	struct list_head   *item;
	struct i2c_driver  *driver;

157
	mutex_lock(&core_lists);
L
Linus Torvalds 已提交
158 159 160 161 162 163

	if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0) {
		res = -ENOMEM;
		goto out_unlock;
	}

164
	res = idr_get_new(&i2c_adapter_idr, adap, &id);
L
Linus Torvalds 已提交
165 166 167 168 169 170 171
	if (res < 0) {
		if (res == -EAGAIN)
			res = -ENOMEM;
		goto out_unlock;
	}

	adap->nr =  id & MAX_ID_MASK;
172 173
	mutex_init(&adap->bus_lock);
	mutex_init(&adap->clist_lock);
L
Linus Torvalds 已提交
174 175 176 177 178 179 180 181 182 183 184 185
	list_add_tail(&adap->list,&adapters);
	INIT_LIST_HEAD(&adap->clients);

	/* Add the adapter to the driver core.
	 * If the parent pointer is not set up,
	 * we add this adapter to the host bus.
	 */
	if (adap->dev.parent == NULL)
		adap->dev.parent = &platform_bus;
	sprintf(adap->dev.bus_id, "i2c-%d", adap->nr);
	adap->dev.driver = &i2c_adapter_driver;
	adap->dev.release = &i2c_adapter_dev_release;
186 187 188 189 190 191
	res = device_register(&adap->dev);
	if (res)
		goto out_list;
	res = device_create_file(&adap->dev, &dev_attr_name);
	if (res)
		goto out_unregister;
L
Linus Torvalds 已提交
192 193 194 195 196 197

	/* Add this adapter to the i2c_adapter class */
	memset(&adap->class_dev, 0x00, sizeof(struct class_device));
	adap->class_dev.dev = &adap->dev;
	adap->class_dev.class = &i2c_adapter_class;
	strlcpy(adap->class_dev.class_id, adap->dev.bus_id, BUS_ID_SIZE);
198 199 200
	res = class_device_register(&adap->class_dev);
	if (res)
		goto out_remove_name;
L
Linus Torvalds 已提交
201

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

L
Linus Torvalds 已提交
204 205 206
	/* inform drivers of new adapters */
	list_for_each(item,&drivers) {
		driver = list_entry(item, struct i2c_driver, list);
207
		if (driver->attach_adapter)
L
Linus Torvalds 已提交
208 209 210 211 212
			/* We ignore the return code; if it fails, too bad */
			driver->attach_adapter(adap);
	}

out_unlock:
213
	mutex_unlock(&core_lists);
L
Linus Torvalds 已提交
214
	return res;
215 216 217 218 219 220 221 222 223 224 225

out_remove_name:
	device_remove_file(&adap->dev, &dev_attr_name);
out_unregister:
	init_completion(&adap->dev_released); /* Needed? */
	device_unregister(&adap->dev);
	wait_for_completion(&adap->dev_released);
out_list:
	list_del(&adap->list);
	idr_remove(&i2c_adapter_idr, adap->nr);
	goto out_unlock;
L
Linus Torvalds 已提交
226 227 228 229 230 231 232 233 234 235 236
}


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;

237
	mutex_lock(&core_lists);
L
Linus Torvalds 已提交
238 239 240 241 242 243 244

	/* 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) {
245 246
		pr_debug("i2c-core: attempting to delete unregistered "
			 "adapter [%s]\n", adap->name);
L
Linus Torvalds 已提交
247 248 249 250 251 252 253 254
		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))) {
255
				dev_err(&adap->dev, "detach_adapter failed "
256 257
					"for driver [%s]\n",
					driver->driver.name);
L
Linus Torvalds 已提交
258 259 260 261 262
				goto out_unlock;
			}
	}

	/* detach any active clients. This must be done first, because
263
	 * it can fail; in which case we give up. */
L
Linus Torvalds 已提交
264 265 266 267
	list_for_each_safe(item, _n, &adap->clients) {
		client = list_entry(item, struct i2c_client, list);

		if ((res=client->driver->detach_client(client))) {
268 269
			dev_err(&adap->dev, "detach_client failed for client "
				"[%s] at address 0x%02x\n", client->name,
L
Linus Torvalds 已提交
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
				client->addr);
			goto out_unlock;
		}
	}

	/* clean up the sysfs representation */
	init_completion(&adap->dev_released);
	init_completion(&adap->class_dev_released);
	class_device_unregister(&adap->class_dev);
	device_remove_file(&adap->dev, &dev_attr_name);
	device_unregister(&adap->dev);
	list_del(&adap->list);

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

	/* free dynamically allocated bus id */
	idr_remove(&i2c_adapter_idr, adap->nr);

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

 out_unlock:
293
	mutex_unlock(&core_lists);
L
Linus Torvalds 已提交
294 295 296 297 298 299 300 301 302 303
	return res;
}


/* -----
 * What follows is the "upwards" interface: commands for talking to clients,
 * which implement the functions to access the physical information of the
 * chips.
 */

304
int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
L
Linus Torvalds 已提交
305 306 307
{
	struct list_head   *item;
	struct i2c_adapter *adapter;
308
	int res;
L
Linus Torvalds 已提交
309 310

	/* add the driver to the list of i2c drivers in the driver core */
311
	driver->driver.owner = owner;
L
Linus Torvalds 已提交
312 313 314 315
	driver->driver.bus = &i2c_bus_type;

	res = driver_register(&driver->driver);
	if (res)
316
		return res;
L
Linus Torvalds 已提交
317
	
318 319
	mutex_lock(&core_lists);

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

	/* now look for instances of driver on our adapters */
324
	if (driver->attach_adapter) {
L
Linus Torvalds 已提交
325 326 327 328 329 330
		list_for_each(item,&adapters) {
			adapter = list_entry(item, struct i2c_adapter, list);
			driver->attach_adapter(adapter);
		}
	}

331
	mutex_unlock(&core_lists);
332
	return 0;
L
Linus Torvalds 已提交
333
}
334
EXPORT_SYMBOL(i2c_register_driver);
L
Linus Torvalds 已提交
335 336 337 338 339 340 341 342 343

int i2c_del_driver(struct i2c_driver *driver)
{
	struct list_head   *item1, *item2, *_n;
	struct i2c_client  *client;
	struct i2c_adapter *adap;
	
	int res = 0;

344
	mutex_lock(&core_lists);
L
Linus Torvalds 已提交
345 346 347 348 349 350 351 352 353

	/* 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.
	 */
	list_for_each(item1,&adapters) {
		adap = list_entry(item1, struct i2c_adapter, list);
		if (driver->detach_adapter) {
			if ((res = driver->detach_adapter(adap))) {
354
				dev_err(&adap->dev, "detach_adapter failed "
355 356
					"for driver [%s]\n",
					driver->driver.name);
L
Linus Torvalds 已提交
357 358 359 360 361 362 363
				goto out_unlock;
			}
		} else {
			list_for_each_safe(item2, _n, &adap->clients) {
				client = list_entry(item2, struct i2c_client, list);
				if (client->driver != driver)
					continue;
364 365 366
				dev_dbg(&adap->dev, "detaching client [%s] "
					"at 0x%02x\n", client->name,
					client->addr);
L
Linus Torvalds 已提交
367
				if ((res = driver->detach_client(client))) {
368 369 370
					dev_err(&adap->dev, "detach_client "
						"failed for client [%s] at "
						"0x%02x\n", client->name,
L
Linus Torvalds 已提交
371 372 373 374 375 376 377 378 379
						client->addr);
					goto out_unlock;
				}
			}
		}
	}

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

 out_unlock:
383
	mutex_unlock(&core_lists);
L
Linus Torvalds 已提交
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
	return 0;
}

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;

404
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
405
	rval = __i2c_check_addr(adapter, addr);
406
	mutex_unlock(&adapter->clist_lock);
L
Linus Torvalds 已提交
407 408 409 410 411 412 413

	return rval;
}

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

416
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
417
	if (__i2c_check_addr(client->adapter, client->addr)) {
418 419
		res = -EBUSY;
		goto out_unlock;
L
Linus Torvalds 已提交
420 421 422 423 424
	}
	list_add_tail(&client->list,&adapter->clients);
	
	if (adapter->client_register)  {
		if (adapter->client_register(client))  {
425 426 427
			dev_dbg(&adapter->dev, "client_register "
				"failed for client [%s] at 0x%02x\n",
				client->name, client->addr);
L
Linus Torvalds 已提交
428 429 430
		}
	}

431
	client->usage_count = 0;
L
Linus Torvalds 已提交
432 433 434 435 436 437 438 439

	client->dev.parent = &client->adapter->dev;
	client->dev.driver = &client->driver->driver;
	client->dev.bus = &i2c_bus_type;
	client->dev.release = &i2c_client_release;
	
	snprintf(&client->dev.bus_id[0], sizeof(client->dev.bus_id),
		"%d-%04x", i2c_adapter_id(adapter), client->addr);
440 441
	dev_dbg(&adapter->dev, "client [%s] registered with bus id %s\n",
		client->name, client->dev.bus_id);
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
	res = device_register(&client->dev);
	if (res)
		goto out_list;
	res = device_create_file(&client->dev, &dev_attr_client_name);
	if (res)
		goto out_unregister;

out_unlock:
	mutex_unlock(&adapter->clist_lock);
	return res;

out_unregister:
	init_completion(&client->released); /* Needed? */
	device_unregister(&client->dev);
	wait_for_completion(&client->released);
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);
	goto out_unlock;
L
Linus Torvalds 已提交
462 463 464 465 466 467 468 469
}


int i2c_detach_client(struct i2c_client *client)
{
	struct i2c_adapter *adapter = client->adapter;
	int res = 0;
	
470
	if (client->usage_count > 0) {
471 472
		dev_warn(&client->dev, "Client [%s] still busy, "
			 "can't detach\n", client->name);
L
Linus Torvalds 已提交
473
		return -EBUSY;
474
	}
L
Linus Torvalds 已提交
475 476 477 478 479

	if (adapter->client_unregister)  {
		res = adapter->client_unregister(client);
		if (res) {
			dev_err(&client->dev,
480 481
				"client_unregister [%s] failed, "
				"client not detached\n", client->name);
L
Linus Torvalds 已提交
482 483 484 485
			goto out;
		}
	}

486
	mutex_lock(&adapter->clist_lock);
L
Linus Torvalds 已提交
487 488 489 490
	list_del(&client->list);
	init_completion(&client->released);
	device_remove_file(&client->dev, &dev_attr_client_name);
	device_unregister(&client->dev);
491
	mutex_unlock(&adapter->clist_lock);
L
Linus Torvalds 已提交
492 493 494 495 496 497 498 499 500
	wait_for_completion(&client->released);

 out:
	return res;
}

static int i2c_inc_use_client(struct i2c_client *client)
{

501
	if (!try_module_get(client->driver->driver.owner))
L
Linus Torvalds 已提交
502 503
		return -ENODEV;
	if (!try_module_get(client->adapter->owner)) {
504
		module_put(client->driver->driver.owner);
L
Linus Torvalds 已提交
505 506 507 508 509 510 511 512
		return -ENODEV;
	}

	return 0;
}

static void i2c_dec_use_client(struct i2c_client *client)
{
513
	module_put(client->driver->driver.owner);
L
Linus Torvalds 已提交
514 515 516 517 518 519 520 521 522 523 524
	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;

525
	client->usage_count++;
L
Linus Torvalds 已提交
526 527 528 529 530 531

	return 0;
}

int i2c_release_client(struct i2c_client *client)
{
532 533 534 535
	if (!client->usage_count) {
		pr_debug("i2c-core: %s used one too many times\n",
			 __FUNCTION__);
		return -EPERM;
L
Linus Torvalds 已提交
536 537
	}
	
538
	client->usage_count--;
L
Linus Torvalds 已提交
539 540 541 542 543 544 545 546 547 548
	i2c_dec_use_client(client);
	
	return 0;
}

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

549
	mutex_lock(&adap->clist_lock);
L
Linus Torvalds 已提交
550 551
	list_for_each(item,&adap->clients) {
		client = list_entry(item, struct i2c_client, list);
552
		if (!try_module_get(client->driver->driver.owner))
L
Linus Torvalds 已提交
553 554
			continue;
		if (NULL != client->driver->command) {
555
			mutex_unlock(&adap->clist_lock);
L
Linus Torvalds 已提交
556
			client->driver->command(client,cmd,arg);
557
			mutex_lock(&adap->clist_lock);
L
Linus Torvalds 已提交
558
		}
559
		module_put(client->driver->driver.owner);
L
Linus Torvalds 已提交
560
       }
561
       mutex_unlock(&adap->clist_lock);
L
Linus Torvalds 已提交
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
}

static int __init i2c_init(void)
{
	int retval;

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

static void __exit i2c_exit(void)
{
	class_unregister(&i2c_adapter_class);
	driver_unregister(&i2c_adapter_driver);
	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, "
				"len=%d\n", ret, msgs[ret].flags & I2C_M_RD ?
				'R' : 'W', msgs[ret].addr, msgs[ret].len);
		}
#endif

605
		mutex_lock(&adap->bus_lock);
L
Linus Torvalds 已提交
606
		ret = adap->algo->master_xfer(adap,msgs,num);
607
		mutex_unlock(&adap->bus_lock);
L
Linus Torvalds 已提交
608 609 610 611 612 613 614 615 616 617 618 619 620 621

		return ret;
	} else {
		dev_dbg(&adap->dev, "I2C level transfers not supported\n");
		return -ENOSYS;
	}
}

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;

622 623 624 625
	msg.addr = client->addr;
	msg.flags = client->flags & I2C_M_TEN;
	msg.len = count;
	msg.buf = (char *)buf;
L
Linus Torvalds 已提交
626
	
627
	ret = i2c_transfer(adap, &msg, 1);
L
Linus Torvalds 已提交
628

629 630 631
	/* If everything went ok (i.e. 1 msg transmitted), return #bytes
	   transmitted, else error code. */
	return (ret == 1) ? count : ret;
L
Linus Torvalds 已提交
632 633 634 635 636 637 638
}

int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
{
	struct i2c_adapter *adap=client->adapter;
	struct i2c_msg msg;
	int ret;
639 640 641 642 643 644 645 646 647 648 649 650

	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 已提交
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
}


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;
}

/* ----------------------------------------------------
 * the i2c address scanning function
 * Will not work for 10-bit addresses!
 * ----------------------------------------------------
 */
J
Jean Delvare 已提交
680 681 682 683 684 685 686 687 688 689
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;
690 691
	}

J
Jean Delvare 已提交
692 693 694 695 696
	/* Skip if already in use */
	if (i2c_check_addr(adapter, addr))
		return 0;

	/* Make sure there is something at this address, unless forced */
697 698 699 700 701 702 703 704 705 706
	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 已提交
707 708 709 710 711 712 713 714

	/* 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. */
	return (err == -ENODEV) ? 0 : err;
715 716
}

L
Linus Torvalds 已提交
717 718 719 720
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 已提交
721
	int i, err;
L
Linus Torvalds 已提交
722 723
	int adap_id = i2c_adapter_id(adapter);

J
Jean Delvare 已提交
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
	/* 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 已提交
746 747
			}
		}
J
Jean Delvare 已提交
748
	}
L
Linus Torvalds 已提交
749

750 751 752 753 754 755 756 757 758 759 760
	/* 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)
		 	return 0;

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

J
Jean Delvare 已提交
761 762 763 764 765 766 767 768 769 770 771 772 773
	/* 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 已提交
774
		}
J
Jean Delvare 已提交
775
	}
L
Linus Torvalds 已提交
776

J
Jean Delvare 已提交
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
	/* 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]);
792 793
				ignore = 1;
				break;
L
Linus Torvalds 已提交
794 795
			}
		}
J
Jean Delvare 已提交
796
		if (ignore)
L
Linus Torvalds 已提交
797 798
			continue;

J
Jean Delvare 已提交
799 800 801 802 803 804 805
		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 已提交
806
	}
J
Jean Delvare 已提交
807

L
Linus Torvalds 已提交
808 809 810 811 812 813 814
	return 0;
}

struct i2c_adapter* i2c_get_adapter(int id)
{
	struct i2c_adapter *adapter;
	
815
	mutex_lock(&core_lists);
816 817 818 819
	adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);
	if (adapter && !try_module_get(adapter->owner))
		adapter = NULL;

820
	mutex_unlock(&core_lists);
821
	return adapter;
L
Linus Torvalds 已提交
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
}

void i2c_put_adapter(struct i2c_adapter *adap)
{
	module_put(adap->owner);
}

/* The SMBus parts */

#define POLY    (0x1070U << 3) 
static u8
crc8(u16 data)
{
	int i;
  
	for(i = 0; i < 8; i++) {
		if (data & 0x8000) 
			data = data ^ POLY;
		data = data << 1;
	}
	return (u8)(data >> 8);
}

845 846
/* 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 已提交
847 848 849 850
{
	int i;

	for(i = 0; i < count; i++)
851
		crc = crc8((crc ^ p[i]) << 8);
L
Linus Torvalds 已提交
852 853 854
	return crc;
}

855 856
/* 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 已提交
857
{
858 859 860 861 862 863
	/* 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 已提交
864 865
}

866 867
/* Used for write only transactions */
static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
L
Linus Torvalds 已提交
868
{
869 870
	msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
	msg->len++;
L
Linus Torvalds 已提交
871 872
}

873 874 875 876 877 878
/* 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 已提交
879
{
880 881
	u8 rpec = msg->buf[--msg->len];
	cpec = i2c_smbus_msg_pec(cpec, msg);
L
Linus Torvalds 已提交
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909

	if (rpec != cpec) {
		pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
			rpec, cpec);
		return -1;
	}
	return 0;	
}

s32 i2c_smbus_write_quick(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
 	                      value,0,I2C_SMBUS_QUICK,NULL);
}

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
		return 0x0FF & data.byte;
}

s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value)
{
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
910
	                      I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
L
Linus Torvalds 已提交
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
}

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
		return 0x0FF & data.byte;
}

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

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
		return 0x0FFFF & data.word;
}

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

s32 i2c_smbus_write_block_data(struct i2c_client *client, u8 command,
952
			       u8 length, const u8 *values)
L
Linus Torvalds 已提交
953 954
{
	union i2c_smbus_data data;
955

L
Linus Torvalds 已提交
956 957 958
	if (length > I2C_SMBUS_BLOCK_MAX)
		length = I2C_SMBUS_BLOCK_MAX;
	data.block[0] = length;
959
	memcpy(&data.block[1], values, length);
L
Linus Torvalds 已提交
960 961 962 963 964 965 966 967 968
	return i2c_smbus_xfer(client->adapter,client->addr,client->flags,
			      I2C_SMBUS_WRITE,command,
			      I2C_SMBUS_BLOCK_DATA,&data);
}

/* Returns the number of read bytes */
s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, u8 command, u8 *values)
{
	union i2c_smbus_data data;
969

L
Linus Torvalds 已提交
970 971 972 973
	if (i2c_smbus_xfer(client->adapter,client->addr,client->flags,
	                      I2C_SMBUS_READ,command,
	                      I2C_SMBUS_I2C_BLOCK_DATA,&data))
		return -1;
974 975 976

	memcpy(values, &data.block[1], data.block[0]);
	return data.block[0];
L
Linus Torvalds 已提交
977 978
}

979
s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, u8 command,
980
				   u8 length, const u8 *values)
981 982 983 984 985 986 987 988 989 990 991 992
{
	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);
}

L
Linus Torvalds 已提交
993 994 995 996 997 998 999 1000 1001 1002 1003
/* Simulate a SMBus command using the i2c protocol 
   No checking of parameters is done!  */
static s32 i2c_smbus_xfer_emulated(struct i2c_adapter * adapter, u16 addr, 
                                   unsigned short flags,
                                   char read_write, u8 command, int size, 
                                   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. */
1004 1005
	unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
	unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
L
Linus Torvalds 已提交
1006 1007 1008 1009 1010
	int num = read_write == I2C_SMBUS_READ?2:1;
	struct i2c_msg msg[2] = { { addr, flags, 1, msgbuf0 }, 
	                          { addr, flags | I2C_M_RD, 0, msgbuf1 }
	                        };
	int i;
1011
	u8 partial_pec = 0;
L
Linus Torvalds 已提交
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065

	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;
			msgbuf0[2] = (data->word >> 8) & 0xff;
		}
		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;
		msgbuf0[2] = (data->word >> 8) & 0xff;
		break;
	case I2C_SMBUS_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
			dev_err(&adapter->dev, "Block read not supported "
			       "under I2C emulation!\n");
			return -1;
		} 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;
			}
1066
			for (i = 1; i < msg[0].len; i++)
L
Linus Torvalds 已提交
1067 1068 1069 1070 1071 1072 1073 1074 1075
				msgbuf0[i] = data->block[i-1];
		}
		break;
	case I2C_SMBUS_BLOCK_PROC_CALL:
		dev_dbg(&adapter->dev, "Block process call not supported "
		       "under I2C emulation!\n");
		return -1;
	case I2C_SMBUS_I2C_BLOCK_DATA:
		if (read_write == I2C_SMBUS_READ) {
1076
			msg[1].len = I2C_SMBUS_BLOCK_MAX;
L
Linus Torvalds 已提交
1077 1078
		} else {
			msg[0].len = data->block[0] + 1;
1079
			if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
L
Linus Torvalds 已提交
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
				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;
	}

1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
	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)) {
		 	if (num == 1) /* Write only */
				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)
		 	msg[num-1].len++;
	}

L
Linus Torvalds 已提交
1110 1111 1112
	if (i2c_transfer(adapter, msg, num) < 0)
		return -1;

1113 1114 1115 1116 1117 1118
	/* 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 已提交
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
	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;
			case I2C_SMBUS_WORD_DATA: 
			case I2C_SMBUS_PROC_CALL:
				data->word = msgbuf1[0] | (msgbuf1[1] << 8);
				break;
			case I2C_SMBUS_I2C_BLOCK_DATA:
				/* fixed at 32 for now */
1133 1134
				data->block[0] = I2C_SMBUS_BLOCK_MAX;
				for (i = 0; i < I2C_SMBUS_BLOCK_MAX; i++)
L
Linus Torvalds 已提交
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
					data->block[i+1] = msgbuf1[i];
				break;
		}
	return 0;
}


s32 i2c_smbus_xfer(struct i2c_adapter * adapter, u16 addr, unsigned short flags,
                   char read_write, u8 command, int size, 
                   union i2c_smbus_data * data)
{
	s32 res;

	flags &= I2C_M_TEN | I2C_CLIENT_PEC;

	if (adapter->algo->smbus_xfer) {
1151
		mutex_lock(&adapter->bus_lock);
L
Linus Torvalds 已提交
1152 1153
		res = adapter->algo->smbus_xfer(adapter,addr,flags,read_write,
		                                command,size,data);
1154
		mutex_unlock(&adapter->bus_lock);
L
Linus Torvalds 已提交
1155 1156 1157 1158 1159 1160 1161 1162
	} else
		res = i2c_smbus_xfer_emulated(adapter,addr,flags,read_write,
	                                      command,size,data);

	return res;
}


1163 1164 1165 1166 1167 1168
/* Next four are needed by i2c-isa */
EXPORT_SYMBOL_GPL(i2c_adapter_dev_release);
EXPORT_SYMBOL_GPL(i2c_adapter_driver);
EXPORT_SYMBOL_GPL(i2c_adapter_class);
EXPORT_SYMBOL_GPL(i2c_bus_type);

L
Linus Torvalds 已提交
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
EXPORT_SYMBOL(i2c_add_adapter);
EXPORT_SYMBOL(i2c_del_adapter);
EXPORT_SYMBOL(i2c_del_driver);
EXPORT_SYMBOL(i2c_attach_client);
EXPORT_SYMBOL(i2c_detach_client);
EXPORT_SYMBOL(i2c_use_client);
EXPORT_SYMBOL(i2c_release_client);
EXPORT_SYMBOL(i2c_clients_command);
EXPORT_SYMBOL(i2c_check_addr);

EXPORT_SYMBOL(i2c_master_send);
EXPORT_SYMBOL(i2c_master_recv);
EXPORT_SYMBOL(i2c_control);
EXPORT_SYMBOL(i2c_transfer);
EXPORT_SYMBOL(i2c_get_adapter);
EXPORT_SYMBOL(i2c_put_adapter);
EXPORT_SYMBOL(i2c_probe);

EXPORT_SYMBOL(i2c_smbus_xfer);
EXPORT_SYMBOL(i2c_smbus_write_quick);
EXPORT_SYMBOL(i2c_smbus_read_byte);
EXPORT_SYMBOL(i2c_smbus_write_byte);
EXPORT_SYMBOL(i2c_smbus_read_byte_data);
EXPORT_SYMBOL(i2c_smbus_write_byte_data);
EXPORT_SYMBOL(i2c_smbus_read_word_data);
EXPORT_SYMBOL(i2c_smbus_write_word_data);
EXPORT_SYMBOL(i2c_smbus_write_block_data);
EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
1197
EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
L
Linus Torvalds 已提交
1198 1199 1200 1201

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