i2c-core-base.c 62.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * Linux I2C core
 *
 * Copyright (C) 1995-99 Simon G. Vogl
 *   With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>
 *   Mux support by Rodolfo Giometti <giometti@enneenne.com> and
 *   Michael Lawnick <michael.lawnick.ext@nsn.com>
 *
 * Copyright (C) 2013-2017 Wolfram Sang <wsa@the-dreams.de>
 *
 * 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.
19
 */
L
Linus Torvalds 已提交
20

W
Wolfram Sang 已提交
21 22
#define pr_fmt(fmt) "i2c-core: " fmt

W
Wolfram Sang 已提交
23
#include <dt-bindings/i2c/i2c.h>
W
Wolfram Sang 已提交
24 25 26
#include <linux/acpi.h>
#include <linux/clk/clk-conf.h>
#include <linux/completion.h>
27
#include <linux/delay.h>
W
Wolfram Sang 已提交
28
#include <linux/err.h>
L
Linus Torvalds 已提交
29
#include <linux/errno.h>
30
#include <linux/gpio/consumer.h>
L
Linus Torvalds 已提交
31
#include <linux/i2c.h>
32
#include <linux/i2c-smbus.h>
L
Linus Torvalds 已提交
33
#include <linux/idr.h>
W
Wolfram Sang 已提交
34 35 36 37 38
#include <linux/init.h>
#include <linux/irqflags.h>
#include <linux/jump_label.h>
#include <linux/kernel.h>
#include <linux/module.h>
39
#include <linux/mutex.h>
40
#include <linux/of_device.h>
W
Wolfram Sang 已提交
41
#include <linux/of.h>
42
#include <linux/of_irq.h>
43
#include <linux/pm_domain.h>
W
Wolfram Sang 已提交
44
#include <linux/pm_runtime.h>
45
#include <linux/pm_wakeirq.h>
46
#include <linux/property.h>
W
Wolfram Sang 已提交
47 48
#include <linux/rwsem.h>
#include <linux/slab.h>
L
Linus Torvalds 已提交
49

50 51
#include "i2c-core.h"

52 53
#define CREATE_TRACE_POINTS
#include <trace/events/i2c.h>
L
Linus Torvalds 已提交
54

55 56 57
#define I2C_ADDR_OFFSET_TEN_BIT	0xa000
#define I2C_ADDR_OFFSET_SLAVE	0x1000

58 59 60
#define I2C_ADDR_7BITS_MAX	0x77
#define I2C_ADDR_7BITS_COUNT	(I2C_ADDR_7BITS_MAX + 1)

61 62
#define I2C_ADDR_DEVICE_ID	0x7c

63 64 65 66
/*
 * core_lock protects i2c_adapter_idr, and guarantees that device detection,
 * deletion of detected devices, and attach_adapter calls are serialized
 */
J
Jean Delvare 已提交
67
static DEFINE_MUTEX(core_lock);
L
Linus Torvalds 已提交
68 69
static DEFINE_IDR(i2c_adapter_idr);

70
static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
71

72
static struct static_key i2c_trace_msg = STATIC_KEY_INIT_FALSE;
73
static bool is_registered;
74

75
int i2c_transfer_trace_reg(void)
76 77
{
	static_key_slow_inc(&i2c_trace_msg);
78
	return 0;
79 80 81 82 83 84 85
}

void i2c_transfer_trace_unreg(void)
{
	static_key_slow_dec(&i2c_trace_msg);
}

86
const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
87 88
						const struct i2c_client *client)
{
89 90 91
	if (!(id && client))
		return NULL;

92 93 94 95 96 97 98
	while (id->name[0]) {
		if (strcmp(client->name, id->name) == 0)
			return id;
		id++;
	}
	return NULL;
}
99
EXPORT_SYMBOL_GPL(i2c_match_id);
100

L
Linus Torvalds 已提交
101 102
static int i2c_device_match(struct device *dev, struct device_driver *drv)
{
103 104 105
	struct i2c_client	*client = i2c_verify_client(dev);
	struct i2c_driver	*driver;

D
David Brownell 已提交
106

107
	/* Attempt an OF style match */
108
	if (i2c_of_match_device(drv->of_match_table, client))
109 110
		return 1;

111 112 113 114
	/* Then ACPI style match */
	if (acpi_driver_match_device(dev, drv))
		return 1;

115
	driver = to_i2c_driver(drv);
116 117 118 119

	/* Finally an I2C match */
	if (i2c_match_id(driver->id_table, client))
		return 1;
120

121
	return 0;
L
Linus Torvalds 已提交
122 123
}

124
static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
D
David Brownell 已提交
125
{
126
	struct i2c_client *client = to_i2c_client(dev);
127 128
	int rc;

129 130 131 132
	rc = of_device_uevent_modalias(dev, env);
	if (rc != -ENODEV)
		return rc;

133 134 135
	rc = acpi_device_uevent_modalias(dev, env);
	if (rc != -ENODEV)
		return rc;
D
David Brownell 已提交
136

137
	return add_uevent_var(env, "MODALIAS=%s%s", I2C_MODULE_PREFIX, client->name);
D
David Brownell 已提交
138 139
}

140 141 142
/* i2c bus recovery routines */
static int get_scl_gpio_value(struct i2c_adapter *adap)
{
143
	return gpiod_get_value_cansleep(adap->bus_recovery_info->scl_gpiod);
144 145 146 147
}

static void set_scl_gpio_value(struct i2c_adapter *adap, int val)
{
148
	gpiod_set_value_cansleep(adap->bus_recovery_info->scl_gpiod, val);
149 150 151 152
}

static int get_sda_gpio_value(struct i2c_adapter *adap)
{
153
	return gpiod_get_value_cansleep(adap->bus_recovery_info->sda_gpiod);
154 155
}

156
static void set_sda_gpio_value(struct i2c_adapter *adap, int val)
157
{
158
	gpiod_set_value_cansleep(adap->bus_recovery_info->sda_gpiod, val);
159 160 161 162 163 164 165 166 167 168
}

/*
 * We are generating clock pulses. ndelay() determines durating of clk pulses.
 * We will generate clock with rate 100 KHz and so duration of both clock levels
 * is: delay in ns = (10^6 / 100) / 2
 */
#define RECOVERY_NDELAY		5000
#define RECOVERY_CLK_CNT	9

169
int i2c_generic_scl_recovery(struct i2c_adapter *adap)
170 171 172 173 174
{
	struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
	int i = 0, val = 1, ret = 0;

	if (bri->prepare_recovery)
175
		bri->prepare_recovery(adap);
176

177
	bri->set_scl(adap, val);
178 179
	if (bri->set_sda)
		bri->set_sda(adap, 1);
180 181
	ndelay(RECOVERY_NDELAY);

182 183 184 185 186 187 188 189 190 191 192 193
	/*
	 * By this time SCL is high, as we need to give 9 falling-rising edges
	 */
	while (i++ < RECOVERY_CLK_CNT * 2) {
		if (val) {
			/* SCL shouldn't be low here */
			if (!bri->get_scl(adap)) {
				dev_err(&adap->dev,
					"SCL is stuck low, exit recovery\n");
				ret = -EBUSY;
				break;
			}
194 195 196
			/* Break if SDA is high */
			if (bri->get_sda && bri->get_sda(adap))
				break;
197 198 199 200 201 202 203
		}

		val = !val;
		bri->set_scl(adap, val);
		ndelay(RECOVERY_NDELAY);
	}

204 205 206 207
	/* check if recovery actually succeeded */
	if (bri->get_sda && !bri->get_sda(adap))
		ret = -EBUSY;

208 209 210 211 212 213 214 215 216 217 218 219
	/* If all went well, send STOP for a sane bus state. */
	if (ret == 0 && bri->set_sda) {
		bri->set_scl(adap, 0);
		ndelay(RECOVERY_NDELAY / 2);
		bri->set_sda(adap, 0);
		ndelay(RECOVERY_NDELAY / 2);
		bri->set_scl(adap, 1);
		ndelay(RECOVERY_NDELAY / 2);
		bri->set_sda(adap, 1);
		ndelay(RECOVERY_NDELAY / 2);
	}

220
	if (bri->unprepare_recovery)
221
		bri->unprepare_recovery(adap);
222 223 224

	return ret;
}
225
EXPORT_SYMBOL_GPL(i2c_generic_scl_recovery);
226 227 228 229 230 231 232 233 234

int i2c_recover_bus(struct i2c_adapter *adap)
{
	if (!adap->bus_recovery_info)
		return -EOPNOTSUPP;

	dev_dbg(&adap->dev, "Trying i2c bus recovery\n");
	return adap->bus_recovery_info->recover_bus(adap);
}
235
EXPORT_SYMBOL_GPL(i2c_recover_bus);
236

237 238 239 240 241 242 243 244 245 246 247 248 249
static void i2c_init_recovery(struct i2c_adapter *adap)
{
	struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
	char *err_str;

	if (!bri)
		return;

	if (!bri->recover_bus) {
		err_str = "no recover_bus() found";
		goto err;
	}

250
	if (bri->scl_gpiod && bri->recover_bus == i2c_generic_scl_recovery) {
251 252
		bri->get_scl = get_scl_gpio_value;
		bri->set_scl = set_scl_gpio_value;
253
		if (bri->sda_gpiod) {
254
			bri->get_sda = get_sda_gpio_value;
255 256 257 258
			/* FIXME: add proper flag instead of '0' once available */
			if (gpiod_get_direction(bri->sda_gpiod) == 0)
				bri->set_sda = set_sda_gpio_value;
		}
259 260 261
		return;
	}

262
	if (bri->recover_bus == i2c_generic_scl_recovery) {
263 264 265 266 267 268 269 270 271 272 273 274 275
		/* Generic SCL recovery */
		if (!bri->set_scl || !bri->get_scl) {
			err_str = "no {get|set}_scl() found";
			goto err;
		}
	}

	return;
 err:
	dev_err(&adap->dev, "Not using recovery: %s\n", err_str);
	adap->bus_recovery_info = NULL;
}

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
static int i2c_smbus_host_notify_to_irq(const struct i2c_client *client)
{
	struct i2c_adapter *adap = client->adapter;
	unsigned int irq;

	if (!adap->host_notify_domain)
		return -ENXIO;

	if (client->flags & I2C_CLIENT_TEN)
		return -EINVAL;

	irq = irq_find_mapping(adap->host_notify_domain, client->addr);
	if (!irq)
		irq = irq_create_mapping(adap->host_notify_domain,
					 client->addr);

	return irq > 0 ? irq : -ENXIO;
}

295
static int i2c_device_probe(struct device *dev)
L
Linus Torvalds 已提交
296
{
297 298
	struct i2c_client	*client = i2c_verify_client(dev);
	struct i2c_driver	*driver;
299
	int status;
D
David Brownell 已提交
300

301 302 303
	if (!client)
		return 0;

304 305 306
	driver = to_i2c_driver(dev->driver);

	if (!client->irq && !driver->disable_i2c_core_irq_mapping) {
307 308
		int irq = -ENOENT;

309 310 311 312
		if (client->flags & I2C_CLIENT_HOST_NOTIFY) {
			dev_dbg(dev, "Using Host Notify IRQ\n");
			irq = i2c_smbus_host_notify_to_irq(client);
		} else if (dev->of_node) {
313 314 315 316
			irq = of_irq_get_byname(dev->of_node, "irq");
			if (irq == -EINVAL || irq == -ENODATA)
				irq = of_irq_get(dev->of_node, 0);
		} else if (ACPI_COMPANION(dev)) {
317
			irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
318
		}
319
		if (irq == -EPROBE_DEFER)
320
			return irq;
321

322 323
		if (irq < 0)
			irq = 0;
324 325 326 327

		client->irq = irq;
	}

328
	/*
329 330
	 * An I2C ID table is not mandatory, if and only if, a suitable OF
	 * or ACPI ID table is supplied for the probing device.
331 332
	 */
	if (!driver->id_table &&
333
	    !i2c_acpi_match_device(dev->driver->acpi_match_table, client) &&
334
	    !i2c_of_match_device(dev->driver->of_match_table, client))
D
David Brownell 已提交
335
		return -ENODEV;
336

337 338 339 340 341 342 343 344 345 346 347 348 349 350
	if (client->flags & I2C_CLIENT_WAKE) {
		int wakeirq = -ENOENT;

		if (dev->of_node) {
			wakeirq = of_irq_get_byname(dev->of_node, "wakeup");
			if (wakeirq == -EPROBE_DEFER)
				return wakeirq;
		}

		device_init_wakeup(&client->dev, true);

		if (wakeirq > 0 && wakeirq != client->irq)
			status = dev_pm_set_dedicated_wake_irq(dev, wakeirq);
		else if (client->irq > 0)
G
Grygorii Strashko 已提交
351
			status = dev_pm_set_wake_irq(dev, client->irq);
352 353 354 355
		else
			status = 0;

		if (status)
356
			dev_warn(&client->dev, "failed to set up wakeup irq\n");
357 358
	}

D
David Brownell 已提交
359
	dev_dbg(dev, "probe\n");
360

361 362
	status = of_clk_set_defaults(dev->of_node, false);
	if (status < 0)
363
		goto err_clear_wakeup_irq;
364

365
	status = dev_pm_domain_attach(&client->dev, true);
366 367 368
	if (status == -EPROBE_DEFER)
		goto err_clear_wakeup_irq;

369 370 371 372 373 374 375 376 377 378 379 380
	/*
	 * When there are no more users of probe(),
	 * rename probe_new to probe.
	 */
	if (driver->probe_new)
		status = driver->probe_new(client);
	else if (driver->probe)
		status = driver->probe(client,
				       i2c_match_id(driver->id_table, client));
	else
		status = -EINVAL;

381 382
	if (status)
		goto err_detach_pm_domain;
383

384 385 386 387 388 389 390
	return 0;

err_detach_pm_domain:
	dev_pm_domain_detach(&client->dev, true);
err_clear_wakeup_irq:
	dev_pm_clear_wake_irq(&client->dev);
	device_init_wakeup(&client->dev, false);
391
	return status;
392
}
L
Linus Torvalds 已提交
393

394 395
static int i2c_device_remove(struct device *dev)
{
396
	struct i2c_client	*client = i2c_verify_client(dev);
D
David Brownell 已提交
397
	struct i2c_driver	*driver;
398
	int status = 0;
D
David Brownell 已提交
399

400
	if (!client || !dev->driver)
D
David Brownell 已提交
401 402 403 404 405 406 407
		return 0;

	driver = to_i2c_driver(dev->driver);
	if (driver->remove) {
		dev_dbg(dev, "remove\n");
		status = driver->remove(client);
	}
408

409
	dev_pm_domain_detach(&client->dev, true);
410 411 412 413

	dev_pm_clear_wake_irq(&client->dev);
	device_init_wakeup(&client->dev, false);

D
David Brownell 已提交
414
	return status;
L
Linus Torvalds 已提交
415 416
}

417
static void i2c_device_shutdown(struct device *dev)
L
Linus Torvalds 已提交
418
{
419
	struct i2c_client *client = i2c_verify_client(dev);
420 421
	struct i2c_driver *driver;

422
	if (!client || !dev->driver)
423 424 425
		return;
	driver = to_i2c_driver(dev->driver);
	if (driver->shutdown)
426
		driver->shutdown(client);
L
Linus Torvalds 已提交
427 428
}

429 430 431 432 433
static void i2c_client_dev_release(struct device *dev)
{
	kfree(to_i2c_client(dev));
}

Z
Zhenwen Xu 已提交
434
static ssize_t
435
show_name(struct device *dev, struct device_attribute *attr, char *buf)
D
David Brownell 已提交
436
{
437 438
	return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
		       to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
D
David Brownell 已提交
439
}
440
static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
D
David Brownell 已提交
441

Z
Zhenwen Xu 已提交
442 443
static ssize_t
show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
D
David Brownell 已提交
444 445
{
	struct i2c_client *client = to_i2c_client(dev);
446 447
	int len;

448 449 450 451
	len = of_device_modalias(dev, buf, PAGE_SIZE);
	if (len != -ENODEV)
		return len;

452 453 454 455
	len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
	if (len != -ENODEV)
		return len;

456
	return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
D
David Brownell 已提交
457
}
458 459 460 461
static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);

static struct attribute *i2c_dev_attrs[] = {
	&dev_attr_name.attr,
D
David Brownell 已提交
462
	/* modalias helps coldplug:  modprobe $(cat .../modalias) */
463 464 465
	&dev_attr_modalias.attr,
	NULL
};
466
ATTRIBUTE_GROUPS(i2c_dev);
467

J
Jon Smirl 已提交
468
struct bus_type i2c_bus_type = {
469 470 471 472 473
	.name		= "i2c",
	.match		= i2c_device_match,
	.probe		= i2c_device_probe,
	.remove		= i2c_device_remove,
	.shutdown	= i2c_device_shutdown,
474
};
J
Jon Smirl 已提交
475
EXPORT_SYMBOL_GPL(i2c_bus_type);
476

477
struct device_type i2c_client_type = {
478
	.groups		= i2c_dev_groups,
479 480 481
	.uevent		= i2c_device_uevent,
	.release	= i2c_client_dev_release,
};
482
EXPORT_SYMBOL_GPL(i2c_client_type);
483

484 485 486 487 488 489 490 491 492 493 494 495

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


503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
/* Return a unique address which takes the flags of the client into account */
static unsigned short i2c_encode_flags_to_addr(struct i2c_client *client)
{
	unsigned short addr = client->addr;

	/* For some client flags, add an arbitrary offset to avoid collisions */
	if (client->flags & I2C_CLIENT_TEN)
		addr |= I2C_ADDR_OFFSET_TEN_BIT;

	if (client->flags & I2C_CLIENT_SLAVE)
		addr |= I2C_ADDR_OFFSET_SLAVE;

	return addr;
}

518
/* This is a permissive address validity check, I2C address map constraints
L
Lucas De Marchi 已提交
519
 * are purposely not enforced, except for the general call address. */
520
static int i2c_check_addr_validity(unsigned int addr, unsigned short flags)
521
{
522
	if (flags & I2C_CLIENT_TEN) {
523
		/* 10-bit address, all values are valid */
524
		if (addr > 0x3ff)
525 526 527
			return -EINVAL;
	} else {
		/* 7-bit address, reject the general call address */
528
		if (addr == 0x00 || addr > 0x7f)
529 530 531 532 533
			return -EINVAL;
	}
	return 0;
}

534 535 536 537
/* And this is a strict address validity check, used when probing. If a
 * device uses a reserved address, then it shouldn't be probed. 7-bit
 * addressing is assumed, 10-bit address devices are rare and should be
 * explicitly enumerated. */
538
int i2c_check_7bit_addr_validity_strict(unsigned short addr)
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
{
	/*
	 * Reserved addresses per I2C specification:
	 *  0x00       General call address / START byte
	 *  0x01       CBUS address
	 *  0x02       Reserved for different bus format
	 *  0x03       Reserved for future purposes
	 *  0x04-0x07  Hs-mode master code
	 *  0x78-0x7b  10-bit slave addressing
	 *  0x7c-0x7f  Reserved for future purposes
	 */
	if (addr < 0x08 || addr > 0x77)
		return -EINVAL;
	return 0;
}

555 556 557 558 559
static int __i2c_check_addr_busy(struct device *dev, void *addrp)
{
	struct i2c_client	*client = i2c_verify_client(dev);
	int			addr = *(int *)addrp;

560
	if (client && i2c_encode_flags_to_addr(client) == addr)
561 562 563 564
		return -EBUSY;
	return 0;
}

565 566 567
/* walk up mux tree */
static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
{
568
	struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
569 570 571 572 573
	int result;

	result = device_for_each_child(&adapter->dev, &addr,
					__i2c_check_addr_busy);

574 575
	if (!result && parent)
		result = i2c_check_mux_parents(parent, addr);
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

	return result;
}

/* recurse down mux tree */
static int i2c_check_mux_children(struct device *dev, void *addrp)
{
	int result;

	if (dev->type == &i2c_adapter_type)
		result = device_for_each_child(dev, addrp,
						i2c_check_mux_children);
	else
		result = __i2c_check_addr_busy(dev, addrp);

	return result;
}

594 595
static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
{
596
	struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
597 598
	int result = 0;

599 600
	if (parent)
		result = i2c_check_mux_parents(parent, addr);
601 602 603 604 605 606

	if (!result)
		result = device_for_each_child(&adapter->dev, &addr,
						i2c_check_mux_children);

	return result;
607 608
}

609
/**
610
 * i2c_adapter_lock_bus - Get exclusive access to an I2C bus segment
611
 * @adapter: Target I2C bus segment
612 613
 * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT
 *	locks only this branch in the adapter tree
614
 */
615 616
static void i2c_adapter_lock_bus(struct i2c_adapter *adapter,
				 unsigned int flags)
617
{
618
	rt_mutex_lock(&adapter->bus_lock);
619 620 621
}

/**
622
 * i2c_adapter_trylock_bus - Try to get exclusive access to an I2C bus segment
623
 * @adapter: Target I2C bus segment
624 625
 * @flags: I2C_LOCK_ROOT_ADAPTER trylocks the root i2c adapter, I2C_LOCK_SEGMENT
 *	trylocks only this branch in the adapter tree
626
 */
627 628
static int i2c_adapter_trylock_bus(struct i2c_adapter *adapter,
				   unsigned int flags)
629
{
630
	return rt_mutex_trylock(&adapter->bus_lock);
631 632 633
}

/**
634
 * i2c_adapter_unlock_bus - Release exclusive access to an I2C bus segment
635
 * @adapter: Target I2C bus segment
636 637
 * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT
 *	unlocks only this branch in the adapter tree
638
 */
639 640
static void i2c_adapter_unlock_bus(struct i2c_adapter *adapter,
				   unsigned int flags)
641
{
642
	rt_mutex_unlock(&adapter->bus_lock);
643 644
}

645
static void i2c_dev_set_name(struct i2c_adapter *adap,
646 647
			     struct i2c_client *client,
			     struct i2c_board_info const *info)
648 649 650
{
	struct acpi_device *adev = ACPI_COMPANION(&client->dev);

651 652 653 654 655
	if (info && info->dev_name) {
		dev_set_name(&client->dev, "i2c-%s", info->dev_name);
		return;
	}

656 657 658 659 660 661
	if (adev) {
		dev_set_name(&client->dev, "i2c-%s", acpi_dev_name(adev));
		return;
	}

	dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
662
		     i2c_encode_flags_to_addr(client));
663 664
}

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
static int i2c_dev_irq_from_resources(const struct resource *resources,
				      unsigned int num_resources)
{
	struct irq_data *irqd;
	int i;

	for (i = 0; i < num_resources; i++) {
		const struct resource *r = &resources[i];

		if (resource_type(r) != IORESOURCE_IRQ)
			continue;

		if (r->flags & IORESOURCE_BITS) {
			irqd = irq_get_irq_data(r->start);
			if (!irqd)
				break;

			irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS);
		}

		return r->start;
	}

	return 0;
}

691
/**
692
 * i2c_new_device - instantiate an i2c device
693 694
 * @adap: the adapter managing the device
 * @info: describes one I2C device; bus_num is ignored
D
David Brownell 已提交
695
 * Context: can sleep
696
 *
697 698 699 700 701 702
 * Create an i2c device. Binding is handled through driver model
 * probe()/remove() methods.  A 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).  This call is not appropriate for use by mainboard
 * initialization logic, which usually runs during an arch_initcall() long
 * before any i2c_adapter could exist.
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
 *
 * 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;
720

A
Anton Vorontsov 已提交
721 722 723
	if (info->archdata)
		client->dev.archdata = *info->archdata;

M
Marc Pignat 已提交
724
	client->flags = info->flags;
725
	client->addr = info->addr;
726

727
	client->irq = info->irq;
728 729 730
	if (!client->irq)
		client->irq = i2c_dev_irq_from_resources(info->resources,
							 info->num_resources);
731 732 733

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

734
	status = i2c_check_addr_validity(client->addr, client->flags);
735 736 737 738 739 740
	if (status) {
		dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
			client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
		goto out_err_silent;
	}

741
	/* Check for address business */
742
	status = i2c_check_addr_busy(adap, i2c_encode_flags_to_addr(client));
743 744 745 746 747
	if (status)
		goto out_err;

	client->dev.parent = &client->adapter->dev;
	client->dev.bus = &i2c_bus_type;
748
	client->dev.type = &i2c_client_type;
749
	client->dev.of_node = info->of_node;
750
	client->dev.fwnode = info->fwnode;
751

752
	i2c_dev_set_name(adap, client, info);
753 754 755 756 757 758 759 760 761 762 763

	if (info->properties) {
		status = device_add_properties(&client->dev, info->properties);
		if (status) {
			dev_err(&adap->dev,
				"Failed to add properties to client %s: %d\n",
				client->name, status);
			goto out_err;
		}
	}

764 765
	status = device_register(&client->dev);
	if (status)
766
		goto out_free_props;
767 768 769 770

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

771
	return client;
772

773 774 775
out_free_props:
	if (info->properties)
		device_remove_properties(&client->dev);
776
out_err:
777 778 779
	dev_err(&adap->dev,
		"Failed to register i2c client %s at 0x%02x (%d)\n",
		client->name, client->addr, status);
780
out_err_silent:
781 782
	kfree(client);
	return NULL;
783 784 785 786 787 788 789
}
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 已提交
790
 * Context: can sleep
791 792
 */
void i2c_unregister_device(struct i2c_client *client)
D
David Brownell 已提交
793
{
794 795
	if (!client)
		return;
796 797

	if (client->dev.of_node) {
798
		of_node_clear_flag(client->dev.of_node, OF_POPULATED);
799 800 801
		of_node_put(client->dev.of_node);
	}

802 803
	if (ACPI_COMPANION(&client->dev))
		acpi_device_clear_enumerated(ACPI_COMPANION(&client->dev));
D
David Brownell 已提交
804 805
	device_unregister(&client->dev);
}
806
EXPORT_SYMBOL_GPL(i2c_unregister_device);
D
David Brownell 已提交
807 808


J
Jean Delvare 已提交
809 810 811 812 813
static const struct i2c_device_id dummy_id[] = {
	{ "dummy", 0 },
	{ },
};

814 815 816 817 818 819 820
static int dummy_probe(struct i2c_client *client,
		       const struct i2c_device_id *id)
{
	return 0;
}

static int dummy_remove(struct i2c_client *client)
821 822 823 824 825 826
{
	return 0;
}

static struct i2c_driver dummy_driver = {
	.driver.name	= "dummy",
827 828
	.probe		= dummy_probe,
	.remove		= dummy_remove,
J
Jean Delvare 已提交
829
	.id_table	= dummy_id,
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
};

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

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

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
/**
 * i2c_new_secondary_device - Helper to get the instantiated secondary address
 * and create the associated device
 * @client: Handle to the primary client
 * @name: Handle to specify which secondary address to get
 * @default_addr: Used as a fallback if no secondary address was specified
 * Context: can sleep
 *
 * I2C clients can be composed of multiple I2C slaves bound together in a single
 * component. The I2C client driver then binds to the master I2C slave and needs
 * to create I2C dummy clients to communicate with all the other slaves.
 *
 * This function creates and returns an I2C dummy client whose I2C address is
 * retrieved from the platform firmware based on the given slave name. If no
 * address is specified by the firmware default_addr is used.
 *
 * On DT-based platforms the address is retrieved from the "reg" property entry
 * cell whose "reg-names" value matches the slave name.
 *
 * This returns the new i2c client, which should be saved for later use with
 * i2c_unregister_device(); or NULL to indicate an error.
 */
struct i2c_client *i2c_new_secondary_device(struct i2c_client *client,
						const char *name,
						u16 default_addr)
{
	struct device_node *np = client->dev.of_node;
	u32 addr = default_addr;
	int i;

	if (np) {
		i = of_property_match_string(np, "reg-names", name);
		if (i >= 0)
			of_property_read_u32_index(np, "reg", i, &addr);
	}

	dev_dbg(&client->adapter->dev, "Address for %s : 0x%x\n", name, addr);
	return i2c_new_dummy(client->adapter, addr);
}
EXPORT_SYMBOL_GPL(i2c_new_secondary_device);

901 902
/* ------------------------------------------------------------------------- */

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

A
Adrian Bunk 已提交
905
static void i2c_adapter_dev_release(struct device *dev)
L
Linus Torvalds 已提交
906
{
907
	struct i2c_adapter *adap = to_i2c_adapter(dev);
L
Linus Torvalds 已提交
908 909 910
	complete(&adap->dev_released);
}

911
unsigned int i2c_adapter_depth(struct i2c_adapter *adapter)
912 913 914 915 916 917
{
	unsigned int depth = 0;

	while ((adapter = i2c_parent_is_i2c_adapter(adapter)))
		depth++;

918 919 920
	WARN_ONCE(depth >= MAX_LOCKDEP_SUBCLASSES,
		  "adapter depth exceeds lockdep subclass limit\n");

921 922
	return depth;
}
923
EXPORT_SYMBOL_GPL(i2c_adapter_depth);
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 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
/*
 * Let users instantiate I2C devices through sysfs. This can be used when
 * platform initialization code doesn't contain the proper data for
 * whatever reason. Also useful for drivers that do device detection and
 * detection fails, either because the device uses an unexpected address,
 * or this is a compatible device with different ID register values.
 *
 * Parameter checking may look overzealous, but we really don't want
 * the user to provide incorrect parameters.
 */
static ssize_t
i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
		     const char *buf, size_t count)
{
	struct i2c_adapter *adap = to_i2c_adapter(dev);
	struct i2c_board_info info;
	struct i2c_client *client;
	char *blank, end;
	int res;

	memset(&info, 0, sizeof(struct i2c_board_info));

	blank = strchr(buf, ' ');
	if (!blank) {
		dev_err(dev, "%s: Missing parameters\n", "new_device");
		return -EINVAL;
	}
	if (blank - buf > I2C_NAME_SIZE - 1) {
		dev_err(dev, "%s: Invalid device name\n", "new_device");
		return -EINVAL;
	}
	memcpy(info.type, buf, blank - buf);

	/* Parse remaining parameters, reject extra parameters */
	res = sscanf(++blank, "%hi%c", &info.addr, &end);
	if (res < 1) {
		dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
		return -EINVAL;
	}
	if (res > 1  && end != '\n') {
		dev_err(dev, "%s: Extra parameters\n", "new_device");
		return -EINVAL;
	}

969 970 971 972 973 974 975 976 977 978
	if ((info.addr & I2C_ADDR_OFFSET_TEN_BIT) == I2C_ADDR_OFFSET_TEN_BIT) {
		info.addr &= ~I2C_ADDR_OFFSET_TEN_BIT;
		info.flags |= I2C_CLIENT_TEN;
	}

	if (info.addr & I2C_ADDR_OFFSET_SLAVE) {
		info.addr &= ~I2C_ADDR_OFFSET_SLAVE;
		info.flags |= I2C_CLIENT_SLAVE;
	}

979 980
	client = i2c_new_device(adap, &info);
	if (!client)
981
		return -EINVAL;
982 983

	/* Keep track of the added device */
984
	mutex_lock(&adap->userspace_clients_lock);
985
	list_add_tail(&client->detected, &adap->userspace_clients);
986
	mutex_unlock(&adap->userspace_clients_lock);
987 988 989 990 991
	dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
		 info.type, info.addr);

	return count;
}
992
static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025

/*
 * And of course let the users delete the devices they instantiated, if
 * they got it wrong. This interface can only be used to delete devices
 * instantiated by i2c_sysfs_new_device above. This guarantees that we
 * don't delete devices to which some kernel code still has references.
 *
 * Parameter checking may look overzealous, but we really don't want
 * the user to delete the wrong device.
 */
static ssize_t
i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
			const char *buf, size_t count)
{
	struct i2c_adapter *adap = to_i2c_adapter(dev);
	struct i2c_client *client, *next;
	unsigned short addr;
	char end;
	int res;

	/* Parse parameters, reject extra parameters */
	res = sscanf(buf, "%hi%c", &addr, &end);
	if (res < 1) {
		dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
		return -EINVAL;
	}
	if (res > 1  && end != '\n') {
		dev_err(dev, "%s: Extra parameters\n", "delete_device");
		return -EINVAL;
	}

	/* Make sure the device was added through sysfs */
	res = -ENOENT;
1026 1027
	mutex_lock_nested(&adap->userspace_clients_lock,
			  i2c_adapter_depth(adap));
1028 1029
	list_for_each_entry_safe(client, next, &adap->userspace_clients,
				 detected) {
1030
		if (i2c_encode_flags_to_addr(client) == addr) {
1031 1032 1033 1034 1035 1036 1037 1038 1039
			dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
				 "delete_device", client->name, client->addr);

			list_del(&client->detected);
			i2c_unregister_device(client);
			res = count;
			break;
		}
	}
1040
	mutex_unlock(&adap->userspace_clients_lock);
1041 1042 1043 1044 1045 1046

	if (res < 0)
		dev_err(dev, "%s: Can't find device in list\n",
			"delete_device");
	return res;
}
1047 1048
static DEVICE_ATTR_IGNORE_LOCKDEP(delete_device, S_IWUSR, NULL,
				   i2c_sysfs_delete_device);
1049 1050 1051 1052 1053 1054 1055

static struct attribute *i2c_adapter_attrs[] = {
	&dev_attr_name.attr,
	&dev_attr_new_device.attr,
	&dev_attr_delete_device.attr,
	NULL
};
1056
ATTRIBUTE_GROUPS(i2c_adapter);
1057

1058
struct device_type i2c_adapter_type = {
1059
	.groups		= i2c_adapter_groups,
1060
	.release	= i2c_adapter_dev_release,
L
Linus Torvalds 已提交
1061
};
1062
EXPORT_SYMBOL_GPL(i2c_adapter_type);
L
Linus Torvalds 已提交
1063

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
/**
 * i2c_verify_adapter - return parameter as i2c_adapter or NULL
 * @dev: device, probably from some driver model iterator
 *
 * When traversing the driver model tree, perhaps using driver model
 * iterators like @device_for_each_child(), you can't assume very much
 * about the nodes you find.  Use this function to avoid oopses caused
 * by wrongly treating some non-I2C device as an i2c_adapter.
 */
struct i2c_adapter *i2c_verify_adapter(struct device *dev)
{
	return (dev->type == &i2c_adapter_type)
			? to_i2c_adapter(dev)
			: NULL;
}
EXPORT_SYMBOL(i2c_verify_adapter);

1081 1082 1083 1084
#ifdef CONFIG_I2C_COMPAT
static struct class_compat *i2c_adapter_compat_class;
#endif

1085 1086 1087 1088
static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
{
	struct i2c_devinfo	*devinfo;

1089
	down_read(&__i2c_board_lock);
1090 1091 1092 1093
	list_for_each_entry(devinfo, &__i2c_board_list, list) {
		if (devinfo->busnum == adapter->nr
				&& !i2c_new_device(adapter,
						&devinfo->board_info))
Z
Zhenwen Xu 已提交
1094 1095
			dev_err(&adapter->dev,
				"Can't create device at 0x%02x\n",
1096 1097
				devinfo->board_info.addr);
	}
1098
	up_read(&__i2c_board_lock);
1099 1100
}

J
Jean Delvare 已提交
1101 1102
static int i2c_do_add_adapter(struct i2c_driver *driver,
			      struct i2c_adapter *adap)
1103
{
1104 1105 1106 1107
	/* Detect supported devices on that bus, and instantiate them */
	i2c_detect(adap, driver);

	/* Let legacy drivers scan this bus for matching devices */
1108
	if (driver->attach_adapter) {
J
Jean Delvare 已提交
1109 1110
		dev_warn(&adap->dev, "%s: attach_adapter method is deprecated\n",
			 driver->driver.name);
1111 1112
		dev_warn(&adap->dev,
			 "Please use another way to instantiate your i2c_client\n");
1113 1114 1115 1116 1117 1118
		/* We ignore the return code; if it fails, too bad */
		driver->attach_adapter(adap);
	}
	return 0;
}

J
Jean Delvare 已提交
1119 1120 1121 1122 1123
static int __process_new_adapter(struct device_driver *d, void *data)
{
	return i2c_do_add_adapter(to_i2c_driver(d), data);
}

1124 1125 1126 1127 1128 1129
static const struct i2c_lock_operations i2c_adapter_lock_ops = {
	.lock_bus =    i2c_adapter_lock_bus,
	.trylock_bus = i2c_adapter_trylock_bus,
	.unlock_bus =  i2c_adapter_unlock_bus,
};

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 1166 1167 1168 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 1197 1198 1199 1200 1201 1202
static void i2c_host_notify_irq_teardown(struct i2c_adapter *adap)
{
	struct irq_domain *domain = adap->host_notify_domain;
	irq_hw_number_t hwirq;

	if (!domain)
		return;

	for (hwirq = 0 ; hwirq < I2C_ADDR_7BITS_COUNT ; hwirq++)
		irq_dispose_mapping(irq_find_mapping(domain, hwirq));

	irq_domain_remove(domain);
	adap->host_notify_domain = NULL;
}

static int i2c_host_notify_irq_map(struct irq_domain *h,
					  unsigned int virq,
					  irq_hw_number_t hw_irq_num)
{
	irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq);

	return 0;
}

static const struct irq_domain_ops i2c_host_notify_irq_ops = {
	.map = i2c_host_notify_irq_map,
};

static int i2c_setup_host_notify_irq_domain(struct i2c_adapter *adap)
{
	struct irq_domain *domain;

	if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_HOST_NOTIFY))
		return 0;

	domain = irq_domain_create_linear(adap->dev.fwnode,
					  I2C_ADDR_7BITS_COUNT,
					  &i2c_host_notify_irq_ops, adap);
	if (!domain)
		return -ENOMEM;

	adap->host_notify_domain = domain;

	return 0;
}

/**
 * i2c_handle_smbus_host_notify - Forward a Host Notify event to the correct
 * I2C client.
 * @adap: the adapter
 * @addr: the I2C address of the notifying device
 * Context: can't sleep
 *
 * Helper function to be called from an I2C bus driver's interrupt
 * handler. It will schedule the Host Notify IRQ.
 */
int i2c_handle_smbus_host_notify(struct i2c_adapter *adap, unsigned short addr)
{
	int irq;

	if (!adap)
		return -EINVAL;

	irq = irq_find_mapping(adap->host_notify_domain, addr);
	if (irq <= 0)
		return -ENXIO;

	generic_handle_irq(irq);

	return 0;
}
EXPORT_SYMBOL_GPL(i2c_handle_smbus_host_notify);

1203
static int i2c_register_adapter(struct i2c_adapter *adap)
L
Linus Torvalds 已提交
1204
{
1205
	int res = -EINVAL;
L
Linus Torvalds 已提交
1206

1207
	/* Can't register until after driver model init */
1208
	if (WARN_ON(!is_registered)) {
1209 1210 1211
		res = -EAGAIN;
		goto out_list;
	}
1212

1213
	/* Sanity checks */
1214
	if (WARN(!adap->name[0], "i2c adapter has no name"))
1215
		goto out_list;
1216 1217

	if (!adap->algo) {
W
Wolfram Sang 已提交
1218
		pr_err("adapter '%s': no algo supplied!\n", adap->name);
1219
		goto out_list;
1220 1221
	}

1222 1223
	if (!adap->lock_ops)
		adap->lock_ops = &i2c_adapter_lock_ops;
1224

1225
	rt_mutex_init(&adap->bus_lock);
1226
	rt_mutex_init(&adap->mux_lock);
1227
	mutex_init(&adap->userspace_clients_lock);
1228
	INIT_LIST_HEAD(&adap->userspace_clients);
L
Linus Torvalds 已提交
1229

1230 1231 1232 1233
	/* Set default timeout to 1 second if not already set */
	if (adap->timeout == 0)
		adap->timeout = HZ;

1234 1235 1236 1237 1238 1239 1240 1241
	/* register soft irqs for Host Notify */
	res = i2c_setup_host_notify_irq_domain(adap);
	if (res) {
		pr_err("adapter '%s': can't create Host Notify IRQs (%d)\n",
		       adap->name, res);
		goto out_list;
	}

1242
	dev_set_name(&adap->dev, "i2c-%d", adap->nr);
1243 1244
	adap->dev.bus = &i2c_bus_type;
	adap->dev.type = &i2c_adapter_type;
1245
	res = device_register(&adap->dev);
1246
	if (res) {
W
Wolfram Sang 已提交
1247
		pr_err("adapter '%s': can't register device (%d)\n", adap->name, res);
1248
		goto out_list;
1249
	}
L
Linus Torvalds 已提交
1250

1251 1252 1253 1254
	res = of_i2c_setup_smbus_alert(adap);
	if (res)
		goto out_reg;

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

1257
	pm_runtime_no_callbacks(&adap->dev);
1258
	pm_suspend_ignore_children(&adap->dev, true);
1259
	pm_runtime_enable(&adap->dev);
1260

1261 1262 1263 1264 1265 1266 1267 1268
#ifdef CONFIG_I2C_COMPAT
	res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
				       adap->dev.parent);
	if (res)
		dev_warn(&adap->dev,
			 "Failed to create compatibility class link\n");
#endif

1269
	i2c_init_recovery(adap);
1270

1271
	/* create pre-declared device nodes */
1272
	of_i2c_register_devices(adap);
1273 1274
	i2c_acpi_register_devices(adap);
	i2c_acpi_install_space_handler(adap);
1275

1276 1277 1278
	if (adap->nr < __i2c_first_dynamic_bus_num)
		i2c_scan_static_board_info(adap);

1279
	/* Notify drivers */
1280
	mutex_lock(&core_lock);
J
Jean Delvare 已提交
1281
	bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
J
Jean Delvare 已提交
1282
	mutex_unlock(&core_lock);
1283 1284

	return 0;
1285

1286 1287 1288 1289
out_reg:
	init_completion(&adap->dev_released);
	device_unregister(&adap->dev);
	wait_for_completion(&adap->dev_released);
1290
out_list:
1291
	mutex_lock(&core_lock);
1292
	idr_remove(&i2c_adapter_idr, adap->nr);
1293 1294
	mutex_unlock(&core_lock);
	return res;
L
Linus Torvalds 已提交
1295 1296
}

1297 1298 1299 1300 1301 1302 1303 1304 1305
/**
 * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1
 * @adap: the adapter to register (with adap->nr initialized)
 * Context: can sleep
 *
 * See i2c_add_numbered_adapter() for details.
 */
static int __i2c_add_numbered_adapter(struct i2c_adapter *adap)
{
1306
	int id;
1307 1308

	mutex_lock(&core_lock);
1309
	id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1, GFP_KERNEL);
1310
	mutex_unlock(&core_lock);
1311
	if (WARN(id < 0, "couldn't get idr"))
1312 1313 1314 1315 1316
		return id == -ENOSPC ? -EBUSY : id;

	return i2c_register_adapter(adap);
}

1317 1318 1319
/**
 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
 * @adapter: the adapter to add
D
David Brownell 已提交
1320
 * Context: can sleep
1321 1322
 *
 * This routine is used to declare an I2C adapter when its bus number
1323 1324 1325
 * doesn't matter or when its bus number is specified by an dt alias.
 * Examples of bases when the bus number doesn't matter: I2C adapters
 * dynamically added by USB links or PCI plugin cards.
1326 1327 1328 1329 1330 1331 1332
 *
 * 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)
{
1333
	struct device *dev = &adapter->dev;
T
Tejun Heo 已提交
1334
	int id;
1335

1336 1337 1338 1339 1340 1341 1342 1343
	if (dev->of_node) {
		id = of_alias_get_id(dev->of_node, "i2c");
		if (id >= 0) {
			adapter->nr = id;
			return __i2c_add_numbered_adapter(adapter);
		}
	}

J
Jean Delvare 已提交
1344
	mutex_lock(&core_lock);
T
Tejun Heo 已提交
1345 1346
	id = idr_alloc(&i2c_adapter_idr, adapter,
		       __i2c_first_dynamic_bus_num, 0, GFP_KERNEL);
J
Jean Delvare 已提交
1347
	mutex_unlock(&core_lock);
1348
	if (WARN(id < 0, "couldn't get idr"))
T
Tejun Heo 已提交
1349
		return id;
1350 1351

	adapter->nr = id;
T
Tejun Heo 已提交
1352

1353 1354 1355 1356 1357 1358 1359
	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 已提交
1360
 * Context: can sleep
1361 1362
 *
 * This routine is used to declare an I2C adapter when its bus number
R
Randy Dunlap 已提交
1363 1364
 * matters.  For example, use it for I2C adapters from system-on-chip CPUs,
 * or otherwise built in to the system's mainboard, and where i2c_board_info
1365 1366
 * is used to properly configure I2C devices.
 *
1367 1368 1369
 * If the requested bus number is set to -1, then this function will behave
 * identically to i2c_add_adapter, and will dynamically assign a bus number.
 *
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
 * 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)
{
1382 1383
	if (adap->nr == -1) /* -1 means dynamically assign bus id */
		return i2c_add_adapter(adap);
1384

1385
	return __i2c_add_numbered_adapter(adap);
1386 1387 1388
}
EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);

L
Lars-Peter Clausen 已提交
1389
static void i2c_do_del_adapter(struct i2c_driver *driver,
J
Jean Delvare 已提交
1390
			      struct i2c_adapter *adapter)
1391
{
1392
	struct i2c_client *client, *_n;
1393

1394 1395
	/* Remove the devices we created ourselves as the result of hardware
	 * probing (using a driver's detect method) */
1396 1397 1398 1399 1400 1401 1402 1403
	list_for_each_entry_safe(client, _n, &driver->clients, detected) {
		if (client->adapter == adapter) {
			dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
				client->name, client->addr);
			list_del(&client->detected);
			i2c_unregister_device(client);
		}
	}
1404 1405
}

1406
static int __unregister_client(struct device *dev, void *dummy)
1407 1408 1409 1410 1411 1412 1413 1414
{
	struct i2c_client *client = i2c_verify_client(dev);
	if (client && strcmp(client->name, "dummy"))
		i2c_unregister_device(client);
	return 0;
}

static int __unregister_dummy(struct device *dev, void *dummy)
1415 1416
{
	struct i2c_client *client = i2c_verify_client(dev);
1417
	i2c_unregister_device(client);
1418 1419 1420
	return 0;
}

J
Jean Delvare 已提交
1421 1422
static int __process_removed_adapter(struct device_driver *d, void *data)
{
L
Lars-Peter Clausen 已提交
1423 1424
	i2c_do_del_adapter(to_i2c_driver(d), data);
	return 0;
J
Jean Delvare 已提交
1425 1426
}

D
David Brownell 已提交
1427 1428 1429 1430 1431 1432 1433 1434
/**
 * 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.
 */
1435
void i2c_del_adapter(struct i2c_adapter *adap)
L
Linus Torvalds 已提交
1436
{
1437
	struct i2c_adapter *found;
1438
	struct i2c_client *client, *next;
L
Linus Torvalds 已提交
1439 1440

	/* First make sure that this adapter was ever added */
1441 1442 1443 1444
	mutex_lock(&core_lock);
	found = idr_find(&i2c_adapter_idr, adap->nr);
	mutex_unlock(&core_lock);
	if (found != adap) {
W
Wolfram Sang 已提交
1445
		pr_debug("attempting to delete unregistered adapter [%s]\n", adap->name);
1446
		return;
L
Linus Torvalds 已提交
1447 1448
	}

1449
	i2c_acpi_remove_space_handler(adap);
1450
	/* Tell drivers about this removal */
1451
	mutex_lock(&core_lock);
L
Lars-Peter Clausen 已提交
1452
	bus_for_each_drv(&i2c_bus_type, NULL, adap,
J
Jean Delvare 已提交
1453
			       __process_removed_adapter);
1454
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
1455

1456
	/* Remove devices instantiated from sysfs */
1457 1458
	mutex_lock_nested(&adap->userspace_clients_lock,
			  i2c_adapter_depth(adap));
1459 1460 1461 1462 1463 1464
	list_for_each_entry_safe(client, next, &adap->userspace_clients,
				 detected) {
		dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
			client->addr);
		list_del(&client->detected);
		i2c_unregister_device(client);
1465
	}
1466
	mutex_unlock(&adap->userspace_clients_lock);
1467

1468
	/* Detach any active clients. This can't fail, thus we do not
1469 1470 1471 1472
	 * check the returned value. This is a two-pass process, because
	 * we can't remove the dummy devices during the first pass: they
	 * could have been instantiated by real devices wishing to clean
	 * them up properly, so we give them a chance to do that first. */
L
Lars-Peter Clausen 已提交
1473 1474
	device_for_each_child(&adap->dev, NULL, __unregister_client);
	device_for_each_child(&adap->dev, NULL, __unregister_dummy);
L
Linus Torvalds 已提交
1475

1476 1477 1478 1479 1480
#ifdef CONFIG_I2C_COMPAT
	class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
				 adap->dev.parent);
#endif

1481 1482 1483
	/* device name is gone after device_unregister */
	dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);

1484 1485
	pm_runtime_disable(&adap->dev);

1486 1487
	i2c_host_notify_irq_teardown(adap);

1488 1489 1490 1491 1492
	/* wait until all references to the device are gone
	 *
	 * FIXME: This is old code and should ideally be replaced by an
	 * alternative which results in decoupling the lifetime of the struct
	 * device from the i2c_adapter, like spi or netdev do. Any solution
1493
	 * should be thoroughly tested with DEBUG_KOBJECT_RELEASE enabled!
1494
	 */
L
Linus Torvalds 已提交
1495 1496 1497 1498
	init_completion(&adap->dev_released);
	device_unregister(&adap->dev);
	wait_for_completion(&adap->dev_released);

1499
	/* free bus id */
1500
	mutex_lock(&core_lock);
L
Linus Torvalds 已提交
1501
	idr_remove(&i2c_adapter_idr, adap->nr);
1502
	mutex_unlock(&core_lock);
L
Linus Torvalds 已提交
1503

1504 1505 1506
	/* Clear the device structure in case this adapter is ever going to be
	   added again */
	memset(&adap->dev, 0, sizeof(adap->dev));
L
Linus Torvalds 已提交
1507
}
D
David Brownell 已提交
1508
EXPORT_SYMBOL(i2c_del_adapter);
L
Linus Torvalds 已提交
1509

1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
/**
 * i2c_parse_fw_timings - get I2C related timing parameters from firmware
 * @dev: The device to scan for I2C timing properties
 * @t: the i2c_timings struct to be filled with values
 * @use_defaults: bool to use sane defaults derived from the I2C specification
 *		  when properties are not found, otherwise use 0
 *
 * Scan the device for the generic I2C properties describing timing parameters
 * for the signal and fill the given struct with the results. If a property was
 * not found and use_defaults was true, then maximum timings are assumed which
 * are derived from the I2C specification. If use_defaults is not used, the
 * results will be 0, so drivers can apply their own defaults later. The latter
 * is mainly intended for avoiding regressions of existing drivers which want
 * to switch to this function. New drivers almost always should use the defaults.
 */

void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults)
{
	int ret;

	memset(t, 0, sizeof(*t));

	ret = device_property_read_u32(dev, "clock-frequency", &t->bus_freq_hz);
	if (ret && use_defaults)
		t->bus_freq_hz = 100000;

	ret = device_property_read_u32(dev, "i2c-scl-rising-time-ns", &t->scl_rise_ns);
	if (ret && use_defaults) {
		if (t->bus_freq_hz <= 100000)
			t->scl_rise_ns = 1000;
		else if (t->bus_freq_hz <= 400000)
			t->scl_rise_ns = 300;
		else
			t->scl_rise_ns = 120;
	}

	ret = device_property_read_u32(dev, "i2c-scl-falling-time-ns", &t->scl_fall_ns);
	if (ret && use_defaults) {
		if (t->bus_freq_hz <= 400000)
			t->scl_fall_ns = 300;
		else
			t->scl_fall_ns = 120;
	}

	device_property_read_u32(dev, "i2c-scl-internal-delay-ns", &t->scl_int_delay_ns);

	ret = device_property_read_u32(dev, "i2c-sda-falling-time-ns", &t->sda_fall_ns);
	if (ret && use_defaults)
		t->sda_fall_ns = t->scl_fall_ns;
}
EXPORT_SYMBOL_GPL(i2c_parse_fw_timings);

D
David Brownell 已提交
1562 1563
/* ------------------------------------------------------------------------- */

J
Jean Delvare 已提交
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *))
{
	int res;

	mutex_lock(&core_lock);
	res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn);
	mutex_unlock(&core_lock);

	return res;
}
EXPORT_SYMBOL_GPL(i2c_for_each_dev);

J
Jean Delvare 已提交
1576
static int __process_new_driver(struct device *dev, void *data)
D
Dave Young 已提交
1577
{
1578 1579
	if (dev->type != &i2c_adapter_type)
		return 0;
J
Jean Delvare 已提交
1580
	return i2c_do_add_adapter(data, to_i2c_adapter(dev));
D
Dave Young 已提交
1581 1582
}

D
David Brownell 已提交
1583 1584
/*
 * An i2c_driver is used with one or more i2c_client (device) nodes to access
1585
 * i2c slave chips, on a bus instance associated with some i2c_adapter.
L
Linus Torvalds 已提交
1586 1587
 */

1588
int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
L
Linus Torvalds 已提交
1589
{
1590
	int res;
L
Linus Torvalds 已提交
1591

1592
	/* Can't register until after driver model init */
1593
	if (WARN_ON(!is_registered))
1594 1595
		return -EAGAIN;

L
Linus Torvalds 已提交
1596
	/* add the driver to the list of i2c drivers in the driver core */
1597
	driver->driver.owner = owner;
L
Linus Torvalds 已提交
1598
	driver->driver.bus = &i2c_bus_type;
1599
	INIT_LIST_HEAD(&driver->clients);
L
Linus Torvalds 已提交
1600

1601
	/* When registration returns, the driver core
1602 1603
	 * will have called probe() for all matching-but-unbound devices.
	 */
L
Linus Torvalds 已提交
1604 1605
	res = driver_register(&driver->driver);
	if (res)
1606
		return res;
D
David Brownell 已提交
1607

W
Wolfram Sang 已提交
1608
	pr_debug("driver [%s] registered\n", driver->driver.name);
L
Linus Torvalds 已提交
1609

1610
	/* Walk the adapters that are already present */
J
Jean Delvare 已提交
1611
	i2c_for_each_dev(driver, __process_new_driver);
1612

D
Dave Young 已提交
1613 1614 1615 1616
	return 0;
}
EXPORT_SYMBOL(i2c_register_driver);

J
Jean Delvare 已提交
1617
static int __process_removed_driver(struct device *dev, void *data)
D
Dave Young 已提交
1618
{
L
Lars-Peter Clausen 已提交
1619 1620 1621
	if (dev->type == &i2c_adapter_type)
		i2c_do_del_adapter(data, to_i2c_adapter(dev));
	return 0;
L
Linus Torvalds 已提交
1622 1623
}

D
David Brownell 已提交
1624 1625 1626
/**
 * i2c_del_driver - unregister I2C driver
 * @driver: the driver being unregistered
D
David Brownell 已提交
1627
 * Context: can sleep
D
David Brownell 已提交
1628
 */
1629
void i2c_del_driver(struct i2c_driver *driver)
L
Linus Torvalds 已提交
1630
{
J
Jean Delvare 已提交
1631
	i2c_for_each_dev(driver, __process_removed_driver);
L
Linus Torvalds 已提交
1632 1633

	driver_unregister(&driver->driver);
W
Wolfram Sang 已提交
1634
	pr_debug("driver [%s] unregistered\n", driver->driver.name);
L
Linus Torvalds 已提交
1635
}
D
David Brownell 已提交
1636
EXPORT_SYMBOL(i2c_del_driver);
L
Linus Torvalds 已提交
1637

D
David Brownell 已提交
1638 1639
/* ------------------------------------------------------------------------- */

1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651
/**
 * i2c_use_client - increments the reference count of the i2c client structure
 * @client: the client being referenced
 *
 * Each live reference to a client should be refcounted. The driver model does
 * that automatically as part of driver binding, so that most drivers don't
 * need to do this explicitly: they hold a reference until they're unbound
 * from the device.
 *
 * A pointer to the client with the incremented reference counter is returned.
 */
struct i2c_client *i2c_use_client(struct i2c_client *client)
L
Linus Torvalds 已提交
1652
{
1653 1654 1655
	if (client && get_device(&client->dev))
		return client;
	return NULL;
L
Linus Torvalds 已提交
1656
}
D
David Brownell 已提交
1657
EXPORT_SYMBOL(i2c_use_client);
L
Linus Torvalds 已提交
1658

1659 1660 1661 1662 1663 1664 1665
/**
 * i2c_release_client - release a use of the i2c client structure
 * @client: the client being no longer referenced
 *
 * Must be called when a user of a client is finished with it.
 */
void i2c_release_client(struct i2c_client *client)
L
Linus Torvalds 已提交
1666
{
1667 1668
	if (client)
		put_device(&client->dev);
L
Linus Torvalds 已提交
1669
}
D
David Brownell 已提交
1670
EXPORT_SYMBOL(i2c_release_client);
L
Linus Torvalds 已提交
1671

1672 1673 1674 1675 1676 1677 1678 1679 1680
struct i2c_cmd_arg {
	unsigned	cmd;
	void		*arg;
};

static int i2c_cmd(struct device *dev, void *_arg)
{
	struct i2c_client	*client = i2c_verify_client(dev);
	struct i2c_cmd_arg	*arg = _arg;
1681 1682 1683 1684
	struct i2c_driver	*driver;

	if (!client || !client->dev.driver)
		return 0;
1685

1686 1687 1688
	driver = to_i2c_driver(client->dev.driver);
	if (driver->command)
		driver->command(client, arg->cmd, arg->arg);
1689 1690 1691
	return 0;
}

L
Linus Torvalds 已提交
1692 1693
void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
{
1694
	struct i2c_cmd_arg	cmd_arg;
L
Linus Torvalds 已提交
1695

1696 1697 1698
	cmd_arg.cmd = cmd;
	cmd_arg.arg = arg;
	device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
L
Linus Torvalds 已提交
1699
}
D
David Brownell 已提交
1700
EXPORT_SYMBOL(i2c_clients_command);
L
Linus Torvalds 已提交
1701 1702 1703 1704 1705

static int __init i2c_init(void)
{
	int retval;

1706 1707 1708 1709 1710 1711 1712
	retval = of_alias_get_highest_id("i2c");

	down_write(&__i2c_board_lock);
	if (retval >= __i2c_first_dynamic_bus_num)
		__i2c_first_dynamic_bus_num = retval + 1;
	up_write(&__i2c_board_lock);

L
Linus Torvalds 已提交
1713 1714 1715
	retval = bus_register(&i2c_bus_type);
	if (retval)
		return retval;
1716 1717 1718

	is_registered = true;

1719 1720 1721 1722 1723 1724 1725
#ifdef CONFIG_I2C_COMPAT
	i2c_adapter_compat_class = class_compat_register("i2c-adapter");
	if (!i2c_adapter_compat_class) {
		retval = -ENOMEM;
		goto bus_err;
	}
#endif
1726 1727
	retval = i2c_add_driver(&dummy_driver);
	if (retval)
1728
		goto class_err;
1729 1730 1731

	if (IS_ENABLED(CONFIG_OF_DYNAMIC))
		WARN_ON(of_reconfig_notifier_register(&i2c_of_notifier));
1732 1733
	if (IS_ENABLED(CONFIG_ACPI))
		WARN_ON(acpi_reconfig_notifier_register(&i2c_acpi_notifier));
1734

1735 1736
	return 0;

1737 1738 1739
class_err:
#ifdef CONFIG_I2C_COMPAT
	class_compat_unregister(i2c_adapter_compat_class);
1740
bus_err:
1741
#endif
1742
	is_registered = false;
1743 1744
	bus_unregister(&i2c_bus_type);
	return retval;
L
Linus Torvalds 已提交
1745 1746 1747 1748
}

static void __exit i2c_exit(void)
{
1749 1750
	if (IS_ENABLED(CONFIG_ACPI))
		WARN_ON(acpi_reconfig_notifier_unregister(&i2c_acpi_notifier));
1751 1752
	if (IS_ENABLED(CONFIG_OF_DYNAMIC))
		WARN_ON(of_reconfig_notifier_unregister(&i2c_of_notifier));
1753
	i2c_del_driver(&dummy_driver);
1754 1755 1756
#ifdef CONFIG_I2C_COMPAT
	class_compat_unregister(i2c_adapter_compat_class);
#endif
L
Linus Torvalds 已提交
1757
	bus_unregister(&i2c_bus_type);
1758
	tracepoint_synchronize_unregister();
L
Linus Torvalds 已提交
1759 1760
}

D
David Brownell 已提交
1761 1762 1763 1764
/* We must initialize early, because some subsystems register i2c drivers
 * in subsys_initcall() code, but are linked (and initialized) before i2c.
 */
postcore_initcall(i2c_init);
L
Linus Torvalds 已提交
1765 1766 1767 1768 1769 1770 1771
module_exit(i2c_exit);

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

W
Wolfram Sang 已提交
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
/* Check if val is exceeding the quirk IFF quirk is non 0 */
#define i2c_quirk_exceeded(val, quirk) ((quirk) && ((val) > (quirk)))

static int i2c_quirk_error(struct i2c_adapter *adap, struct i2c_msg *msg, char *err_msg)
{
	dev_err_ratelimited(&adap->dev, "adapter quirk: %s (addr 0x%04x, size %u, %s)\n",
			    err_msg, msg->addr, msg->len,
			    msg->flags & I2C_M_RD ? "read" : "write");
	return -EOPNOTSUPP;
}

static int i2c_check_for_quirks(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
{
	const struct i2c_adapter_quirks *q = adap->quirks;
	int max_num = q->max_num_msgs, i;
	bool do_len_check = true;

	if (q->flags & I2C_AQ_COMB) {
		max_num = 2;

		/* special checks for combined messages */
		if (num == 2) {
			if (q->flags & I2C_AQ_COMB_WRITE_FIRST && msgs[0].flags & I2C_M_RD)
				return i2c_quirk_error(adap, &msgs[0], "1st comb msg must be write");

			if (q->flags & I2C_AQ_COMB_READ_SECOND && !(msgs[1].flags & I2C_M_RD))
				return i2c_quirk_error(adap, &msgs[1], "2nd comb msg must be read");

			if (q->flags & I2C_AQ_COMB_SAME_ADDR && msgs[0].addr != msgs[1].addr)
				return i2c_quirk_error(adap, &msgs[0], "comb msg only to same addr");

			if (i2c_quirk_exceeded(msgs[0].len, q->max_comb_1st_msg_len))
				return i2c_quirk_error(adap, &msgs[0], "msg too long");

			if (i2c_quirk_exceeded(msgs[1].len, q->max_comb_2nd_msg_len))
				return i2c_quirk_error(adap, &msgs[1], "msg too long");

			do_len_check = false;
		}
	}

	if (i2c_quirk_exceeded(num, max_num))
		return i2c_quirk_error(adap, &msgs[0], "too many messages");

	for (i = 0; i < num; i++) {
		u16 len = msgs[i].len;

		if (msgs[i].flags & I2C_M_RD) {
			if (do_len_check && i2c_quirk_exceeded(len, q->max_read_len))
				return i2c_quirk_error(adap, &msgs[i], "msg too long");
		} else {
			if (do_len_check && i2c_quirk_exceeded(len, q->max_write_len))
				return i2c_quirk_error(adap, &msgs[i], "msg too long");
		}
	}

	return 0;
}

1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
/**
 * __i2c_transfer - unlocked flavor of i2c_transfer
 * @adap: Handle to I2C bus
 * @msgs: One or more messages to execute before STOP is issued to
 *	terminate the operation; each message begins with a START.
 * @num: Number of messages to be executed.
 *
 * Returns negative errno, else the number of messages executed.
 *
 * Adapter lock must be held when calling this function. No debug logging
 * takes place. adap->algo->master_xfer existence isn't checked.
 */
int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
{
	unsigned long orig_jiffies;
	int ret, try;

W
Wolfram Sang 已提交
1848 1849 1850
	if (adap->quirks && i2c_check_for_quirks(adap, msgs, num))
		return -EOPNOTSUPP;

1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
	/* i2c_trace_msg gets enabled when tracepoint i2c_transfer gets
	 * enabled.  This is an efficient way of keeping the for-loop from
	 * being executed when not needed.
	 */
	if (static_key_false(&i2c_trace_msg)) {
		int i;
		for (i = 0; i < num; i++)
			if (msgs[i].flags & I2C_M_RD)
				trace_i2c_read(adap, &msgs[i], i);
			else
				trace_i2c_write(adap, &msgs[i], i);
	}

1864 1865 1866 1867 1868 1869 1870 1871 1872 1873
	/* Retry automatically on arbitration loss */
	orig_jiffies = jiffies;
	for (ret = 0, try = 0; try <= adap->retries; try++) {
		ret = adap->algo->master_xfer(adap, msgs, num);
		if (ret != -EAGAIN)
			break;
		if (time_after(jiffies, orig_jiffies + adap->timeout))
			break;
	}

1874 1875 1876 1877 1878 1879 1880 1881
	if (static_key_false(&i2c_trace_msg)) {
		int i;
		for (i = 0; i < ret; i++)
			if (msgs[i].flags & I2C_M_RD)
				trace_i2c_reply(adap, &msgs[i], i);
		trace_i2c_result(adap, i, ret);
	}

1882 1883 1884 1885
	return ret;
}
EXPORT_SYMBOL(__i2c_transfer);

1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
/**
 * i2c_transfer - execute a single or combined I2C message
 * @adap: Handle to I2C bus
 * @msgs: One or more messages to execute before STOP is issued to
 *	terminate the operation; each message begins with a START.
 * @num: Number of messages to be executed.
 *
 * Returns negative errno, else the number of messages executed.
 *
 * Note that there is no requirement that each message be sent to
 * the same slave address, although that is the most common model.
 */
Z
Zhenwen Xu 已提交
1898
int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
L
Linus Torvalds 已提交
1899
{
1900
	int ret;
L
Linus Torvalds 已提交
1901

1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
	/* REVISIT the fault reporting model here is weak:
	 *
	 *  - When we get an error after receiving N bytes from a slave,
	 *    there is no way to report "N".
	 *
	 *  - When we get a NAK after transmitting N bytes to a slave,
	 *    there is no way to report "N" ... or to let the master
	 *    continue executing the rest of this combined message, if
	 *    that's the appropriate response.
	 *
	 *  - When for example "num" is two and we successfully complete
	 *    the first message but get an error part way through the
	 *    second, it's unclear whether that should be reported as
	 *    one (discarding status on the second message) or errno
	 *    (discarding status on the first one).
	 */

L
Linus Torvalds 已提交
1919 1920 1921
	if (adap->algo->master_xfer) {
#ifdef DEBUG
		for (ret = 0; ret < num; ret++) {
1922 1923 1924 1925
			dev_dbg(&adap->dev,
				"master_xfer[%d] %c, addr=0x%02x, len=%d%s\n",
				ret, (msgs[ret].flags & I2C_M_RD) ? 'R' : 'W',
				msgs[ret].addr, msgs[ret].len,
1926
				(msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
L
Linus Torvalds 已提交
1927 1928 1929
		}
#endif

1930
		if (in_atomic() || irqs_disabled()) {
1931
			ret = i2c_trylock_bus(adap, I2C_LOCK_SEGMENT);
1932 1933 1934 1935
			if (!ret)
				/* I2C activity is ongoing. */
				return -EAGAIN;
		} else {
1936
			i2c_lock_bus(adap, I2C_LOCK_SEGMENT);
1937 1938
		}

1939
		ret = __i2c_transfer(adap, msgs, num);
1940
		i2c_unlock_bus(adap, I2C_LOCK_SEGMENT);
L
Linus Torvalds 已提交
1941 1942 1943 1944

		return ret;
	} else {
		dev_dbg(&adap->dev, "I2C level transfers not supported\n");
D
David Brownell 已提交
1945
		return -EOPNOTSUPP;
L
Linus Torvalds 已提交
1946 1947
	}
}
D
David Brownell 已提交
1948
EXPORT_SYMBOL(i2c_transfer);
L
Linus Torvalds 已提交
1949

1950
/**
1951 1952
 * i2c_transfer_buffer_flags - issue a single I2C message transferring data
 *			       to/from a buffer
1953
 * @client: Handle to slave device
1954 1955 1956
 * @buf: Where the data is stored
 * @count: How many bytes to transfer, must be less than 64k since msg.len is u16
 * @flags: The flags to be used for the message, e.g. I2C_M_RD for reads
1957
 *
1958
 * Returns negative errno, or else the number of bytes transferred.
1959
 */
1960 1961
int i2c_transfer_buffer_flags(const struct i2c_client *client, char *buf,
			      int count, u16 flags)
L
Linus Torvalds 已提交
1962 1963
{
	int ret;
1964 1965 1966 1967 1968 1969
	struct i2c_msg msg = {
		.addr = client->addr,
		.flags = flags | (client->flags & I2C_M_TEN),
		.len = count,
		.buf = buf,
	};
1970

1971
	ret = i2c_transfer(client->adapter, &msg, 1);
1972

1973
	/*
1974 1975
	 * If everything went ok (i.e. 1 msg transferred), return #bytes
	 * transferred, else error code.
1976
	 */
1977
	return (ret == 1) ? count : ret;
L
Linus Torvalds 已提交
1978
}
1979
EXPORT_SYMBOL(i2c_transfer_buffer_flags);
L
Linus Torvalds 已提交
1980

1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011
/**
 * i2c_get_device_id - get manufacturer, part id and die revision of a device
 * @client: The device to query
 * @id: The queried information
 *
 * Returns negative errno on error, zero on success.
 */
int i2c_get_device_id(const struct i2c_client *client,
		      struct i2c_device_identity *id)
{
	struct i2c_adapter *adap = client->adapter;
	union i2c_smbus_data raw_id;
	int ret;

	if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_I2C_BLOCK))
		return -EOPNOTSUPP;

	raw_id.block[0] = 3;
	ret = i2c_smbus_xfer(adap, I2C_ADDR_DEVICE_ID, 0,
			     I2C_SMBUS_READ, client->addr << 1,
			     I2C_SMBUS_I2C_BLOCK_DATA, &raw_id);
	if (ret)
		return ret;

	id->manufacturer_id = (raw_id.block[1] << 4) | (raw_id.block[2] >> 4);
	id->part_id = ((raw_id.block[2] & 0xf) << 5) | (raw_id.block[3] >> 3);
	id->die_revision = raw_id.block[3] & 0x7;
	return 0;
}
EXPORT_SYMBOL_GPL(i2c_get_device_id);

L
Linus Torvalds 已提交
2012 2013 2014 2015 2016 2017
/* ----------------------------------------------------
 * the i2c address scanning function
 * Will not work for 10-bit addresses!
 * ----------------------------------------------------
 */

2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041
/*
 * Legacy default probe function, mostly relevant for SMBus. 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 short byte read instead. Also, some bus drivers don't implement
 * quick write, so we fallback to a byte read in that case too.
 * On x86, there is another special case for FSC hardware monitoring chips,
 * which want regular byte reads (address 0x73.) Fortunately, these are the
 * only known chips using this I2C address on PC hardware.
 * Returns 1 if probe succeeded, 0 if not.
 */
static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
{
	int err;
	union i2c_smbus_data dummy;

#ifdef CONFIG_X86
	if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
	 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
		err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
				     I2C_SMBUS_BYTE_DATA, &dummy);
	else
#endif
2042 2043
	if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
	 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
2044 2045
		err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
				     I2C_SMBUS_QUICK, NULL);
2046 2047 2048 2049
	else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
		err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
				     I2C_SMBUS_BYTE, &dummy);
	else {
2050 2051
		dev_warn(&adap->dev, "No suitable probing method supported for address 0x%02X\n",
			 addr);
2052 2053
		err = -EOPNOTSUPP;
	}
2054 2055 2056 2057

	return err >= 0;
}

J
Jean Delvare 已提交
2058
static int i2c_detect_address(struct i2c_client *temp_client,
2059 2060 2061 2062 2063 2064 2065 2066
			      struct i2c_driver *driver)
{
	struct i2c_board_info info;
	struct i2c_adapter *adapter = temp_client->adapter;
	int addr = temp_client->addr;
	int err;

	/* Make sure the address is valid */
2067
	err = i2c_check_7bit_addr_validity_strict(addr);
2068
	if (err) {
2069 2070
		dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
			 addr);
2071
		return err;
2072 2073
	}

2074
	/* Skip if already in use (7 bit, no need to encode flags) */
2075
	if (i2c_check_addr_busy(adapter, addr))
2076 2077
		return 0;

J
Jean Delvare 已提交
2078
	/* Make sure there is something at this address */
2079 2080
	if (!i2c_default_probe(adapter, addr))
		return 0;
2081 2082 2083 2084

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

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

		/* Detection succeeded, instantiate the device */
2101 2102 2103 2104 2105 2106 2107
		if (adapter->class & I2C_CLASS_DEPRECATED)
			dev_warn(&adapter->dev,
				"This adapter will soon drop class based instantiation of devices. "
				"Please make sure client 0x%02x gets instantiated by other means. "
				"Check 'Documentation/i2c/instantiating-devices' for details.\n",
				info.addr);

2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121
		dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
			info.type, info.addr);
		client = i2c_new_device(adapter, &info);
		if (client)
			list_add_tail(&client->detected, &driver->clients);
		else
			dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
				info.type, info.addr);
	}
	return 0;
}

static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
{
2122
	const unsigned short *address_list;
2123 2124 2125 2126
	struct i2c_client *temp_client;
	int i, err = 0;
	int adap_id = i2c_adapter_id(adapter);

2127 2128
	address_list = driver->address_list;
	if (!driver->detect || !address_list)
2129 2130
		return 0;

2131 2132 2133
	/* Warn that the adapter lost class based instantiation */
	if (adapter->class == I2C_CLASS_DEPRECATED) {
		dev_dbg(&adapter->dev,
2134 2135
			"This adapter dropped support for I2C classes and won't auto-detect %s devices anymore. "
			"If you need it, check 'Documentation/i2c/instantiating-devices' for alternatives.\n",
2136 2137 2138 2139
			driver->driver.name);
		return 0;
	}

J
Jean Delvare 已提交
2140 2141 2142 2143
	/* Stop here if the classes do not match */
	if (!(adapter->class & driver->class))
		return 0;

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

2150
	for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
2151 2152 2153
		dev_dbg(&adapter->dev,
			"found normal entry for adapter %d, addr 0x%02x\n",
			adap_id, address_list[i]);
2154
		temp_client->addr = address_list[i];
J
Jean Delvare 已提交
2155
		err = i2c_detect_address(temp_client, driver);
J
Jean Delvare 已提交
2156 2157
		if (unlikely(err))
			break;
2158 2159 2160 2161 2162 2163
	}

	kfree(temp_client);
	return err;
}

2164 2165 2166 2167 2168 2169 2170
int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
{
	return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
			      I2C_SMBUS_QUICK, NULL) >= 0;
}
EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);

J
Jean Delvare 已提交
2171 2172 2173
struct i2c_client *
i2c_new_probed_device(struct i2c_adapter *adap,
		      struct i2c_board_info *info,
2174 2175
		      unsigned short const *addr_list,
		      int (*probe)(struct i2c_adapter *, unsigned short addr))
J
Jean Delvare 已提交
2176 2177 2178
{
	int i;

2179
	if (!probe)
2180
		probe = i2c_default_probe;
J
Jean Delvare 已提交
2181 2182 2183

	for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
		/* Check address validity */
2184
		if (i2c_check_7bit_addr_validity_strict(addr_list[i]) < 0) {
2185 2186
			dev_warn(&adap->dev, "Invalid 7-bit address 0x%02x\n",
				 addr_list[i]);
J
Jean Delvare 已提交
2187 2188 2189
			continue;
		}

2190
		/* Check address availability (7 bit, no need to encode flags) */
2191
		if (i2c_check_addr_busy(adap, addr_list[i])) {
2192 2193 2194
			dev_dbg(&adap->dev,
				"Address 0x%02x already in use, not probing\n",
				addr_list[i]);
J
Jean Delvare 已提交
2195 2196 2197
			continue;
		}

2198
		/* Test address responsiveness */
2199
		if (probe(adap, addr_list[i]))
2200
			break;
J
Jean Delvare 已提交
2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212
	}

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

2213
struct i2c_adapter *i2c_get_adapter(int nr)
L
Linus Torvalds 已提交
2214 2215
{
	struct i2c_adapter *adapter;
D
David Brownell 已提交
2216

J
Jean Delvare 已提交
2217
	mutex_lock(&core_lock);
2218
	adapter = idr_find(&i2c_adapter_idr, nr);
2219 2220 2221 2222 2223 2224
	if (!adapter)
		goto exit;

	if (try_module_get(adapter->owner))
		get_device(&adapter->dev);
	else
2225 2226
		adapter = NULL;

2227
 exit:
J
Jean Delvare 已提交
2228
	mutex_unlock(&core_lock);
2229
	return adapter;
L
Linus Torvalds 已提交
2230
}
D
David Brownell 已提交
2231
EXPORT_SYMBOL(i2c_get_adapter);
L
Linus Torvalds 已提交
2232 2233 2234

void i2c_put_adapter(struct i2c_adapter *adap)
{
2235 2236 2237 2238 2239
	if (!adap)
		return;

	put_device(&adap->dev);
	module_put(adap->owner);
L
Linus Torvalds 已提交
2240
}
D
David Brownell 已提交
2241
EXPORT_SYMBOL(i2c_put_adapter);
L
Linus Torvalds 已提交
2242

2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288
/**
 * i2c_get_dma_safe_msg_buf() - get a DMA safe buffer for the given i2c_msg
 * @msg: the message to be checked
 * @threshold: the minimum number of bytes for which using DMA makes sense
 *
 * Return: NULL if a DMA safe buffer was not obtained. Use msg->buf with PIO.
 *	   Or a valid pointer to be used with DMA. After use, release it by
 *	   calling i2c_release_dma_safe_msg_buf().
 *
 * This function must only be called from process context!
 */
u8 *i2c_get_dma_safe_msg_buf(struct i2c_msg *msg, unsigned int threshold)
{
	if (msg->len < threshold)
		return NULL;

	if (msg->flags & I2C_M_DMA_SAFE)
		return msg->buf;

	pr_debug("using bounce buffer for addr=0x%02x, len=%d\n",
		 msg->addr, msg->len);

	if (msg->flags & I2C_M_RD)
		return kzalloc(msg->len, GFP_KERNEL);
	else
		return kmemdup(msg->buf, msg->len, GFP_KERNEL);
}
EXPORT_SYMBOL_GPL(i2c_get_dma_safe_msg_buf);

/**
 * i2c_release_dma_safe_msg_buf - release DMA safe buffer and sync with i2c_msg
 * @msg: the message to be synced with
 * @buf: the buffer obtained from i2c_get_dma_safe_msg_buf(). May be NULL.
 */
void i2c_release_dma_safe_msg_buf(struct i2c_msg *msg, u8 *buf)
{
	if (!buf || buf == msg->buf)
		return;

	if (msg->flags & I2C_M_RD)
		memcpy(msg->buf, buf, msg->len);

	kfree(buf);
}
EXPORT_SYMBOL_GPL(i2c_release_dma_safe_msg_buf);

L
Linus Torvalds 已提交
2289 2290 2291
MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
MODULE_DESCRIPTION("I2C-Bus main module");
MODULE_LICENSE("GPL");