blob: 656f0a6fe3adf6917996c48fffef71bc3700351f [file] [log] [blame]
Wolfram Sang61e3d0f2017-05-23 19:23:11 +02001/*
2 * Linux I2C core
3 *
4 * Copyright (C) 1995-99 Simon G. Vogl
5 * With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>
6 * Mux support by Rodolfo Giometti <giometti@enneenne.com> and
7 * Michael Lawnick <michael.lawnick.ext@nsn.com>
8 *
9 * Copyright (C) 2013-2017 Wolfram Sang <wsa@the-dreams.de>
10 *
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the Free
13 * Software Foundation; either version 2 of the License, or (at your option)
14 * any later version.
15 *
16 * This program is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
Wolfram Sang687b81d2013-07-11 12:56:15 +010019 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Wolfram Sang44239a52016-07-09 13:35:04 +090021#define pr_fmt(fmt) "i2c-core: " fmt
22
Wolfram Sangb4e2f6a2015-05-19 21:04:40 +020023#include <dt-bindings/i2c/i2c.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010024#include <linux/acpi.h>
Sylwester Nawrocki86be4082014-06-18 17:29:32 +020025#include <linux/clk/clk-conf.h>
Jean Delvareb8d6f452007-02-13 22:09:00 +010026#include <linux/completion.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010027#include <linux/delay.h>
Pantelis Antonioua430a3452014-10-28 22:36:02 +020028#include <linux/err.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010029#include <linux/errno.h>
Phil Reid10c9ef02017-11-28 11:09:10 +080030#include <linux/gpio/consumer.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010031#include <linux/i2c.h>
Phil Reidf8756c62017-08-24 17:31:04 +080032#include <linux/i2c-smbus.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010033#include <linux/idr.h>
34#include <linux/init.h>
35#include <linux/irqflags.h>
36#include <linux/jump_label.h>
37#include <linux/kernel.h>
38#include <linux/module.h>
39#include <linux/mutex.h>
40#include <linux/of_device.h>
41#include <linux/of.h>
42#include <linux/of_irq.h>
43#include <linux/pm_domain.h>
44#include <linux/pm_runtime.h>
45#include <linux/pm_wakeirq.h>
Wolfram Sange1dba012015-12-08 10:37:46 +010046#include <linux/property.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010047#include <linux/rwsem.h>
48#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
David Brownell9c1600e2007-05-01 23:26:31 +020050#include "i2c-core.h"
51
David Howellsd9a83d62014-03-06 13:35:59 +000052#define CREATE_TRACE_POINTS
53#include <trace/events/i2c.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Wolfram Sangda899f52015-05-18 21:09:12 +020055#define I2C_ADDR_OFFSET_TEN_BIT 0xa000
56#define I2C_ADDR_OFFSET_SLAVE 0x1000
57
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +020058#define I2C_ADDR_7BITS_MAX 0x77
59#define I2C_ADDR_7BITS_COUNT (I2C_ADDR_7BITS_MAX + 1)
60
Peter Rosindde67eb2018-01-22 08:32:01 +010061#define I2C_ADDR_DEVICE_ID 0x7c
62
Wolfram Sang61e3d0f2017-05-23 19:23:11 +020063/*
64 * core_lock protects i2c_adapter_idr, and guarantees that device detection,
Wolfram Sang0c36dd32018-08-21 17:02:40 +020065 * deletion of detected devices are serialized
Wolfram Sang61e3d0f2017-05-23 19:23:11 +020066 */
Jean Delvarecaada322008-01-27 18:14:49 +010067static DEFINE_MUTEX(core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068static DEFINE_IDR(i2c_adapter_idr);
69
Jean Delvare4735c982008-07-14 22:38:36 +020070static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
David Brownellf37dd802007-02-13 22:09:00 +010071
Davidlohr Bueso50888b02018-03-26 14:09:24 -070072static DEFINE_STATIC_KEY_FALSE(i2c_trace_msg_key);
Sudip Mukherjee95026652016-03-07 17:19:17 +053073static bool is_registered;
David Howellsd9a83d62014-03-06 13:35:59 +000074
Steven Rostedt (Red Hat)8cf868a2016-11-28 13:03:21 -050075int i2c_transfer_trace_reg(void)
David Howellsd9a83d62014-03-06 13:35:59 +000076{
Davidlohr Bueso50888b02018-03-26 14:09:24 -070077 static_branch_inc(&i2c_trace_msg_key);
Steven Rostedt (Red Hat)8cf868a2016-11-28 13:03:21 -050078 return 0;
David Howellsd9a83d62014-03-06 13:35:59 +000079}
80
81void i2c_transfer_trace_unreg(void)
82{
Davidlohr Bueso50888b02018-03-26 14:09:24 -070083 static_branch_dec(&i2c_trace_msg_key);
David Howellsd9a83d62014-03-06 13:35:59 +000084}
85
Lee Jones5f441fc2016-11-07 12:47:40 +000086const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
Jean Delvared2653e92008-04-29 23:11:39 +020087 const struct i2c_client *client)
88{
Lee Jones811073b2016-11-07 12:47:36 +000089 if (!(id && client))
90 return NULL;
91
Jean Delvared2653e92008-04-29 23:11:39 +020092 while (id->name[0]) {
93 if (strcmp(client->name, id->name) == 0)
94 return id;
95 id++;
96 }
97 return NULL;
98}
Lee Jones5f441fc2016-11-07 12:47:40 +000099EXPORT_SYMBOL_GPL(i2c_match_id);
Jean Delvared2653e92008-04-29 23:11:39 +0200100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101static int i2c_device_match(struct device *dev, struct device_driver *drv)
102{
Jean Delvare51298d12009-09-18 22:45:45 +0200103 struct i2c_client *client = i2c_verify_client(dev);
104 struct i2c_driver *driver;
David Brownell7b4fbc52007-05-01 23:26:30 +0200105
Jean Delvare51298d12009-09-18 22:45:45 +0200106
Grant Likely959e85f2010-06-08 07:48:19 -0600107 /* Attempt an OF style match */
Lee Jonesda10c062016-11-07 12:47:39 +0000108 if (i2c_of_match_device(drv->of_match_table, client))
Grant Likely959e85f2010-06-08 07:48:19 -0600109 return 1;
110
Mika Westerberg907ddf82012-11-23 12:23:40 +0100111 /* Then ACPI style match */
112 if (acpi_driver_match_device(dev, drv))
113 return 1;
114
Jean Delvare51298d12009-09-18 22:45:45 +0200115 driver = to_i2c_driver(drv);
Lee Jones811073b2016-11-07 12:47:36 +0000116
117 /* Finally an I2C match */
118 if (i2c_match_id(driver->id_table, client))
119 return 1;
Jean Delvared2653e92008-04-29 23:11:39 +0200120
Jean Delvareeb8a7902008-05-18 20:49:41 +0200121 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122}
123
Kay Sievers7eff2e72007-08-14 15:15:12 +0200124static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +0200125{
Wolfram Sang8dcf3212016-03-23 20:47:02 +0100126 struct i2c_client *client = to_i2c_client(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800127 int rc;
128
Javier Martinez Canillasaf503712017-12-03 22:40:50 +0100129 rc = of_device_uevent_modalias(dev, env);
130 if (rc != -ENODEV)
131 return rc;
132
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800133 rc = acpi_device_uevent_modalias(dev, env);
134 if (rc != -ENODEV)
135 return rc;
David Brownell7b4fbc52007-05-01 23:26:30 +0200136
Wolfram Sang8dcf3212016-03-23 20:47:02 +0100137 return add_uevent_var(env, "MODALIAS=%s%s", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200138}
139
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530140/* i2c bus recovery routines */
141static int get_scl_gpio_value(struct i2c_adapter *adap)
142{
Phil Reid3991c5c2017-11-02 10:40:24 +0800143 return gpiod_get_value_cansleep(adap->bus_recovery_info->scl_gpiod);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530144}
145
146static void set_scl_gpio_value(struct i2c_adapter *adap, int val)
147{
Phil Reid3991c5c2017-11-02 10:40:24 +0800148 gpiod_set_value_cansleep(adap->bus_recovery_info->scl_gpiod, val);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530149}
150
151static int get_sda_gpio_value(struct i2c_adapter *adap)
152{
Phil Reid3991c5c2017-11-02 10:40:24 +0800153 return gpiod_get_value_cansleep(adap->bus_recovery_info->sda_gpiod);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530154}
155
Wolfram Sang80921782018-01-09 14:58:56 +0100156static void set_sda_gpio_value(struct i2c_adapter *adap, int val)
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530157{
Wolfram Sang80921782018-01-09 14:58:56 +0100158 gpiod_set_value_cansleep(adap->bus_recovery_info->sda_gpiod, val);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530159}
160
Wolfram Sang7ca5f6b2018-07-11 00:24:22 +0200161static int i2c_generic_bus_free(struct i2c_adapter *adap)
162{
163 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
164 int ret = -EOPNOTSUPP;
165
166 if (bri->get_bus_free)
167 ret = bri->get_bus_free(adap);
168 else if (bri->get_sda)
169 ret = bri->get_sda(adap);
170
171 if (ret < 0)
172 return ret;
173
174 return ret ? 0 : -EBUSY;
175}
176
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530177/*
178 * We are generating clock pulses. ndelay() determines durating of clk pulses.
179 * We will generate clock with rate 100 KHz and so duration of both clock levels
180 * is: delay in ns = (10^6 / 100) / 2
181 */
182#define RECOVERY_NDELAY 5000
183#define RECOVERY_CLK_CNT 9
184
Phil Reide1eb7d22017-11-02 10:40:30 +0800185int i2c_generic_scl_recovery(struct i2c_adapter *adap)
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530186{
187 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
Wolfram Sangf7ff75e2018-07-11 00:27:22 +0200188 int i = 0, scl = 1, ret;
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530189
190 if (bri->prepare_recovery)
Grygorii Strashko2b2190a2015-04-06 15:38:39 +0300191 bri->prepare_recovery(adap);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530192
Wolfram Sangc4ae05b2018-07-17 11:00:05 +0200193 /*
194 * If we can set SDA, we will always create a STOP to ensure additional
195 * pulses will do no harm. This is achieved by letting SDA follow SCL
196 * half a cycle later. Check the 'incomplete_write_byte' fault injector
197 * for details.
198 */
Wolfram Sangf7ff75e2018-07-11 00:27:22 +0200199 bri->set_scl(adap, scl);
Wolfram Sangc4ae05b2018-07-17 11:00:05 +0200200 ndelay(RECOVERY_NDELAY / 2);
Wolfram Sang72b08fc2018-01-09 14:58:57 +0100201 if (bri->set_sda)
Wolfram Sangc4ae05b2018-07-17 11:00:05 +0200202 bri->set_sda(adap, scl);
203 ndelay(RECOVERY_NDELAY / 2);
Jan Luebbe8b062602015-07-08 16:35:06 +0200204
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530205 /*
206 * By this time SCL is high, as we need to give 9 falling-rising edges
207 */
208 while (i++ < RECOVERY_CLK_CNT * 2) {
Wolfram Sangf7ff75e2018-07-11 00:27:22 +0200209 if (scl) {
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530210 /* SCL shouldn't be low here */
211 if (!bri->get_scl(adap)) {
212 dev_err(&adap->dev,
213 "SCL is stuck low, exit recovery\n");
214 ret = -EBUSY;
215 break;
216 }
217 }
218
Wolfram Sangf7ff75e2018-07-11 00:27:22 +0200219 scl = !scl;
220 bri->set_scl(adap, scl);
Wolfram Sangc4ae05b2018-07-17 11:00:05 +0200221 /* Creating STOP again, see above */
Wolfram Sangabe41182018-07-10 23:42:15 +0200222 ndelay(RECOVERY_NDELAY / 2);
223 if (bri->set_sda)
Wolfram Sangf7ff75e2018-07-11 00:27:22 +0200224 bri->set_sda(adap, scl);
Wolfram Sangabe41182018-07-10 23:42:15 +0200225 ndelay(RECOVERY_NDELAY / 2);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530226
Wolfram Sangf7ff75e2018-07-11 00:27:22 +0200227 if (scl) {
Wolfram Sang7ca5f6b2018-07-11 00:24:22 +0200228 ret = i2c_generic_bus_free(adap);
Wolfram Sang0b710262018-07-10 23:42:17 +0200229 if (ret == 0)
230 break;
231 }
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530232 }
233
Wolfram Sang7ca5f6b2018-07-11 00:24:22 +0200234 /* If we can't check bus status, assume recovery worked */
235 if (ret == -EOPNOTSUPP)
236 ret = 0;
Wolfram Sang2806e6a2018-01-09 14:58:58 +0100237
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530238 if (bri->unprepare_recovery)
Grygorii Strashko2b2190a2015-04-06 15:38:39 +0300239 bri->unprepare_recovery(adap);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530240
241 return ret;
242}
Mark Brownc1c21f42015-04-15 19:18:39 +0100243EXPORT_SYMBOL_GPL(i2c_generic_scl_recovery);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530244
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530245int i2c_recover_bus(struct i2c_adapter *adap)
246{
247 if (!adap->bus_recovery_info)
248 return -EOPNOTSUPP;
249
250 dev_dbg(&adap->dev, "Trying i2c bus recovery\n");
251 return adap->bus_recovery_info->recover_bus(adap);
252}
Mark Brownc1c21f42015-04-15 19:18:39 +0100253EXPORT_SYMBOL_GPL(i2c_recover_bus);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530254
Wolfram Sangd3b11d82016-07-09 13:34:59 +0900255static void i2c_init_recovery(struct i2c_adapter *adap)
256{
257 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
258 char *err_str;
259
260 if (!bri)
261 return;
262
263 if (!bri->recover_bus) {
264 err_str = "no recover_bus() found";
265 goto err;
266 }
267
Phil Reid3991c5c2017-11-02 10:40:24 +0800268 if (bri->scl_gpiod && bri->recover_bus == i2c_generic_scl_recovery) {
Wolfram Sangd3b11d82016-07-09 13:34:59 +0900269 bri->get_scl = get_scl_gpio_value;
270 bri->set_scl = set_scl_gpio_value;
Wolfram Sang80921782018-01-09 14:58:56 +0100271 if (bri->sda_gpiod) {
Phil Reid3991c5c2017-11-02 10:40:24 +0800272 bri->get_sda = get_sda_gpio_value;
Wolfram Sang80921782018-01-09 14:58:56 +0100273 /* FIXME: add proper flag instead of '0' once available */
274 if (gpiod_get_direction(bri->sda_gpiod) == 0)
275 bri->set_sda = set_sda_gpio_value;
276 }
Phil Reid3991c5c2017-11-02 10:40:24 +0800277 return;
278 }
279
Phil Reide1eb7d22017-11-02 10:40:30 +0800280 if (bri->recover_bus == i2c_generic_scl_recovery) {
Wolfram Sangd3b11d82016-07-09 13:34:59 +0900281 /* Generic SCL recovery */
282 if (!bri->set_scl || !bri->get_scl) {
283 err_str = "no {get|set}_scl() found";
284 goto err;
285 }
Wolfram Sangffc59c42018-07-10 23:42:16 +0200286 if (!bri->set_sda && !bri->get_sda) {
287 err_str = "either get_sda() or set_sda() needed";
288 goto err;
289 }
Wolfram Sangd3b11d82016-07-09 13:34:59 +0900290 }
291
292 return;
293 err:
294 dev_err(&adap->dev, "Not using recovery: %s\n", err_str);
295 adap->bus_recovery_info = NULL;
296}
297
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +0200298static int i2c_smbus_host_notify_to_irq(const struct i2c_client *client)
299{
300 struct i2c_adapter *adap = client->adapter;
301 unsigned int irq;
302
303 if (!adap->host_notify_domain)
304 return -ENXIO;
305
306 if (client->flags & I2C_CLIENT_TEN)
307 return -EINVAL;
308
Charles Keepaxb9bb3fd2018-10-19 09:59:57 +0100309 irq = irq_create_mapping(adap->host_notify_domain, client->addr);
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +0200310
311 return irq > 0 ? irq : -ENXIO;
312}
313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314static int i2c_device_probe(struct device *dev)
315{
Jean Delvare51298d12009-09-18 22:45:45 +0200316 struct i2c_client *client = i2c_verify_client(dev);
317 struct i2c_driver *driver;
Hans Verkuil50c33042008-03-12 14:15:00 +0100318 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200319
Jean Delvare51298d12009-09-18 22:45:45 +0200320 if (!client)
321 return 0;
322
Hans de Goeded1d84bb2017-04-05 00:03:34 +0200323 driver = to_i2c_driver(dev->driver);
324
325 if (!client->irq && !driver->disable_i2c_core_irq_mapping) {
Mika Westerberg845c8772015-05-06 13:29:08 +0300326 int irq = -ENOENT;
327
Dmitry Torokhov331c3422017-01-04 20:57:22 -0800328 if (client->flags & I2C_CLIENT_HOST_NOTIFY) {
329 dev_dbg(dev, "Using Host Notify IRQ\n");
330 irq = i2c_smbus_host_notify_to_irq(client);
331 } else if (dev->of_node) {
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700332 irq = of_irq_get_byname(dev->of_node, "irq");
333 if (irq == -EINVAL || irq == -ENODATA)
334 irq = of_irq_get(dev->of_node, 0);
335 } else if (ACPI_COMPANION(dev)) {
Mika Westerberg845c8772015-05-06 13:29:08 +0300336 irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700337 }
Geert Uytterhoeven6f34be72014-11-17 12:43:00 +0100338 if (irq == -EPROBE_DEFER)
Laurent Pinchart2fd36c5522014-10-30 15:59:38 +0200339 return irq;
Dmitry Torokhov331c3422017-01-04 20:57:22 -0800340
Geert Uytterhoeven6f34be72014-11-17 12:43:00 +0100341 if (irq < 0)
342 irq = 0;
Laurent Pinchart2fd36c5522014-10-30 15:59:38 +0200343
344 client->irq = irq;
345 }
346
Lee Jonesda10c062016-11-07 12:47:39 +0000347 /*
Javier Martinez Canillasf4b17a12017-08-09 11:21:28 +0200348 * An I2C ID table is not mandatory, if and only if, a suitable OF
349 * or ACPI ID table is supplied for the probing device.
Lee Jonesda10c062016-11-07 12:47:39 +0000350 */
351 if (!driver->id_table &&
Andy Shevchenkoc64ffff2017-07-17 17:13:28 +0300352 !i2c_acpi_match_device(dev->driver->acpi_match_table, client) &&
Lee Jonesda10c062016-11-07 12:47:39 +0000353 !i2c_of_match_device(dev->driver->of_match_table, client))
David Brownell7b4fbc52007-05-01 23:26:30 +0200354 return -ENODEV;
Lars-Peter Clausen0acc2b32013-09-29 10:51:06 +0200355
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700356 if (client->flags & I2C_CLIENT_WAKE) {
357 int wakeirq = -ENOENT;
358
359 if (dev->of_node) {
360 wakeirq = of_irq_get_byname(dev->of_node, "wakeup");
361 if (wakeirq == -EPROBE_DEFER)
362 return wakeirq;
363 }
364
365 device_init_wakeup(&client->dev, true);
366
367 if (wakeirq > 0 && wakeirq != client->irq)
368 status = dev_pm_set_dedicated_wake_irq(dev, wakeirq);
369 else if (client->irq > 0)
Grygorii Strashkoc18fba22015-11-12 15:42:26 +0200370 status = dev_pm_set_wake_irq(dev, client->irq);
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700371 else
372 status = 0;
373
374 if (status)
Andy Shevchenkob93d3d32016-08-25 17:42:10 +0300375 dev_warn(&client->dev, "failed to set up wakeup irq\n");
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700376 }
377
David Brownell7b4fbc52007-05-01 23:26:30 +0200378 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200379
Sylwester Nawrocki86be4082014-06-18 17:29:32 +0200380 status = of_clk_set_defaults(dev->of_node, false);
381 if (status < 0)
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700382 goto err_clear_wakeup_irq;
Sylwester Nawrocki86be4082014-06-18 17:29:32 +0200383
Ulf Hanssone09b0d42014-09-19 20:27:39 +0200384 status = dev_pm_domain_attach(&client->dev, true);
Ulf Hanssone6a20b62018-04-26 10:53:07 +0200385 if (status)
Kieran Bingham74cedd32015-10-12 21:54:43 +0100386 goto err_clear_wakeup_irq;
387
Lee Jonesb8a1a4c2016-11-07 12:47:41 +0000388 /*
389 * When there are no more users of probe(),
390 * rename probe_new to probe.
391 */
392 if (driver->probe_new)
393 status = driver->probe_new(client);
394 else if (driver->probe)
395 status = driver->probe(client,
396 i2c_match_id(driver->id_table, client));
397 else
398 status = -EINVAL;
399
Kieran Bingham74cedd32015-10-12 21:54:43 +0100400 if (status)
401 goto err_detach_pm_domain;
Wolfram Sang72fa8182014-01-21 17:48:34 +0100402
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700403 return 0;
404
405err_detach_pm_domain:
406 dev_pm_domain_detach(&client->dev, true);
407err_clear_wakeup_irq:
408 dev_pm_clear_wake_irq(&client->dev);
409 device_init_wakeup(&client->dev, false);
Hans Verkuil50c33042008-03-12 14:15:00 +0100410 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411}
412
413static int i2c_device_remove(struct device *dev)
414{
Jean Delvare51298d12009-09-18 22:45:45 +0200415 struct i2c_client *client = i2c_verify_client(dev);
David Brownella1d9e6e2007-05-01 23:26:30 +0200416 struct i2c_driver *driver;
Wolfram Sang72fa8182014-01-21 17:48:34 +0100417 int status = 0;
David Brownella1d9e6e2007-05-01 23:26:30 +0200418
Jean Delvare51298d12009-09-18 22:45:45 +0200419 if (!client || !dev->driver)
David Brownella1d9e6e2007-05-01 23:26:30 +0200420 return 0;
421
422 driver = to_i2c_driver(dev->driver);
423 if (driver->remove) {
424 dev_dbg(dev, "remove\n");
425 status = driver->remove(client);
David Brownella1d9e6e2007-05-01 23:26:30 +0200426 }
Wolfram Sang72fa8182014-01-21 17:48:34 +0100427
Ulf Hanssone09b0d42014-09-19 20:27:39 +0200428 dev_pm_domain_detach(&client->dev, true);
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700429
430 dev_pm_clear_wake_irq(&client->dev);
431 device_init_wakeup(&client->dev, false);
432
David Brownella1d9e6e2007-05-01 23:26:30 +0200433 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434}
435
David Brownellf37dd802007-02-13 22:09:00 +0100436static void i2c_device_shutdown(struct device *dev)
437{
Jean Delvare51298d12009-09-18 22:45:45 +0200438 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100439 struct i2c_driver *driver;
440
Jean Delvare51298d12009-09-18 22:45:45 +0200441 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100442 return;
443 driver = to_i2c_driver(dev->driver);
444 if (driver->shutdown)
Jean Delvare51298d12009-09-18 22:45:45 +0200445 driver->shutdown(client);
David Brownellf37dd802007-02-13 22:09:00 +0100446}
447
David Brownell9c1600e2007-05-01 23:26:31 +0200448static void i2c_client_dev_release(struct device *dev)
449{
450 kfree(to_i2c_client(dev));
451}
452
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100453static ssize_t
Jean Delvare4f8cf822009-09-18 22:45:46 +0200454show_name(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200455{
Jean Delvare4f8cf822009-09-18 22:45:46 +0200456 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
457 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200458}
Wolfram Sanga5eb71b2015-01-19 20:12:24 +0100459static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
David Brownell7b4fbc52007-05-01 23:26:30 +0200460
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100461static ssize_t
462show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200463{
464 struct i2c_client *client = to_i2c_client(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800465 int len;
466
Javier Martinez Canillasaf503712017-12-03 22:40:50 +0100467 len = of_device_modalias(dev, buf, PAGE_SIZE);
468 if (len != -ENODEV)
469 return len;
470
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800471 len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
472 if (len != -ENODEV)
473 return len;
474
Jean Delvareeb8a7902008-05-18 20:49:41 +0200475 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200476}
Jean Delvare51298d12009-09-18 22:45:45 +0200477static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
478
479static struct attribute *i2c_dev_attrs[] = {
480 &dev_attr_name.attr,
David Brownell7b4fbc52007-05-01 23:26:30 +0200481 /* modalias helps coldplug: modprobe $(cat .../modalias) */
Jean Delvare51298d12009-09-18 22:45:45 +0200482 &dev_attr_modalias.attr,
483 NULL
484};
Wolfram Sanga5eb71b2015-01-19 20:12:24 +0100485ATTRIBUTE_GROUPS(i2c_dev);
sonic zhang54067ee2009-12-14 21:17:30 +0100486
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200487struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100488 .name = "i2c",
489 .match = i2c_device_match,
490 .probe = i2c_device_probe,
491 .remove = i2c_device_remove,
492 .shutdown = i2c_device_shutdown,
Russell Kingb864c7d2006-01-05 14:37:50 +0000493};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200494EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000495
Dmitry Torokhov00a06c22017-03-04 11:29:34 -0800496struct device_type i2c_client_type = {
Wolfram Sanga5eb71b2015-01-19 20:12:24 +0100497 .groups = i2c_dev_groups,
Jean Delvare51298d12009-09-18 22:45:45 +0200498 .uevent = i2c_device_uevent,
499 .release = i2c_client_dev_release,
500};
Dmitry Torokhov00a06c22017-03-04 11:29:34 -0800501EXPORT_SYMBOL_GPL(i2c_client_type);
Jean Delvare51298d12009-09-18 22:45:45 +0200502
David Brownell9b766b82008-01-27 18:14:51 +0100503
504/**
505 * i2c_verify_client - return parameter as i2c_client, or NULL
506 * @dev: device, probably from some driver model iterator
507 *
508 * When traversing the driver model tree, perhaps using driver model
509 * iterators like @device_for_each_child(), you can't assume very much
510 * about the nodes you find. Use this function to avoid oopses caused
511 * by wrongly treating some non-I2C device as an i2c_client.
512 */
513struct i2c_client *i2c_verify_client(struct device *dev)
514{
Jean Delvare51298d12009-09-18 22:45:45 +0200515 return (dev->type == &i2c_client_type)
David Brownell9b766b82008-01-27 18:14:51 +0100516 ? to_i2c_client(dev)
517 : NULL;
518}
519EXPORT_SYMBOL(i2c_verify_client);
520
521
Wolfram Sangda899f52015-05-18 21:09:12 +0200522/* Return a unique address which takes the flags of the client into account */
523static unsigned short i2c_encode_flags_to_addr(struct i2c_client *client)
524{
525 unsigned short addr = client->addr;
526
527 /* For some client flags, add an arbitrary offset to avoid collisions */
528 if (client->flags & I2C_CLIENT_TEN)
529 addr |= I2C_ADDR_OFFSET_TEN_BIT;
530
531 if (client->flags & I2C_CLIENT_SLAVE)
532 addr |= I2C_ADDR_OFFSET_SLAVE;
533
534 return addr;
535}
536
Jean Delvare3a89db52010-06-03 11:33:52 +0200537/* This is a permissive address validity check, I2C address map constraints
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300538 * are purposely not enforced, except for the general call address. */
Wolfram Sang398432e2018-03-20 21:54:38 +0100539static int i2c_check_addr_validity(unsigned int addr, unsigned short flags)
Jean Delvare3a89db52010-06-03 11:33:52 +0200540{
Wolfram Sangc4019b72015-07-17 12:50:06 +0200541 if (flags & I2C_CLIENT_TEN) {
Jean Delvare3a89db52010-06-03 11:33:52 +0200542 /* 10-bit address, all values are valid */
Wolfram Sangc4019b72015-07-17 12:50:06 +0200543 if (addr > 0x3ff)
Jean Delvare3a89db52010-06-03 11:33:52 +0200544 return -EINVAL;
545 } else {
546 /* 7-bit address, reject the general call address */
Wolfram Sangc4019b72015-07-17 12:50:06 +0200547 if (addr == 0x00 || addr > 0x7f)
Jean Delvare3a89db52010-06-03 11:33:52 +0200548 return -EINVAL;
549 }
550 return 0;
551}
552
Jean Delvare656b8762010-06-03 11:33:53 +0200553/* And this is a strict address validity check, used when probing. If a
554 * device uses a reserved address, then it shouldn't be probed. 7-bit
555 * addressing is assumed, 10-bit address devices are rare and should be
556 * explicitly enumerated. */
Wolfram Sange4991ec2017-05-23 11:14:17 +0200557int i2c_check_7bit_addr_validity_strict(unsigned short addr)
Jean Delvare656b8762010-06-03 11:33:53 +0200558{
559 /*
560 * Reserved addresses per I2C specification:
561 * 0x00 General call address / START byte
562 * 0x01 CBUS address
563 * 0x02 Reserved for different bus format
564 * 0x03 Reserved for future purposes
565 * 0x04-0x07 Hs-mode master code
566 * 0x78-0x7b 10-bit slave addressing
567 * 0x7c-0x7f Reserved for future purposes
568 */
569 if (addr < 0x08 || addr > 0x77)
570 return -EINVAL;
571 return 0;
572}
573
Jean Delvare3b5f7942010-06-03 11:33:55 +0200574static int __i2c_check_addr_busy(struct device *dev, void *addrp)
575{
576 struct i2c_client *client = i2c_verify_client(dev);
577 int addr = *(int *)addrp;
578
Wolfram Sang9bccc702015-07-17 14:48:56 +0200579 if (client && i2c_encode_flags_to_addr(client) == addr)
Jean Delvare3b5f7942010-06-03 11:33:55 +0200580 return -EBUSY;
581 return 0;
582}
583
Michael Lawnick08263742010-08-11 18:21:02 +0200584/* walk up mux tree */
585static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
586{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200587 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200588 int result;
589
590 result = device_for_each_child(&adapter->dev, &addr,
591 __i2c_check_addr_busy);
592
Jean Delvare97cc4d42010-10-24 18:16:57 +0200593 if (!result && parent)
594 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200595
596 return result;
597}
598
599/* recurse down mux tree */
600static int i2c_check_mux_children(struct device *dev, void *addrp)
601{
602 int result;
603
604 if (dev->type == &i2c_adapter_type)
605 result = device_for_each_child(dev, addrp,
606 i2c_check_mux_children);
607 else
608 result = __i2c_check_addr_busy(dev, addrp);
609
610 return result;
611}
612
Jean Delvare3b5f7942010-06-03 11:33:55 +0200613static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
614{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200615 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200616 int result = 0;
617
Jean Delvare97cc4d42010-10-24 18:16:57 +0200618 if (parent)
619 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200620
621 if (!result)
622 result = device_for_each_child(&adapter->dev, &addr,
623 i2c_check_mux_children);
624
625 return result;
Jean Delvare3b5f7942010-06-03 11:33:55 +0200626}
627
David Brownell9c1600e2007-05-01 23:26:31 +0200628/**
Peter Rosin8320f492016-05-04 22:15:27 +0200629 * i2c_adapter_lock_bus - Get exclusive access to an I2C bus segment
Jean Delvarefe61e072010-08-11 18:20:58 +0200630 * @adapter: Target I2C bus segment
Peter Rosin8320f492016-05-04 22:15:27 +0200631 * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT
632 * locks only this branch in the adapter tree
Jean Delvarefe61e072010-08-11 18:20:58 +0200633 */
Peter Rosin8320f492016-05-04 22:15:27 +0200634static void i2c_adapter_lock_bus(struct i2c_adapter *adapter,
635 unsigned int flags)
Jean Delvarefe61e072010-08-11 18:20:58 +0200636{
Peter Rosin7b94ea52018-07-20 10:39:14 +0200637 rt_mutex_lock_nested(&adapter->bus_lock, i2c_adapter_depth(adapter));
Jean Delvarefe61e072010-08-11 18:20:58 +0200638}
Jean Delvarefe61e072010-08-11 18:20:58 +0200639
640/**
Peter Rosin8320f492016-05-04 22:15:27 +0200641 * i2c_adapter_trylock_bus - Try to get exclusive access to an I2C bus segment
Jean Delvarefe61e072010-08-11 18:20:58 +0200642 * @adapter: Target I2C bus segment
Peter Rosin8320f492016-05-04 22:15:27 +0200643 * @flags: I2C_LOCK_ROOT_ADAPTER trylocks the root i2c adapter, I2C_LOCK_SEGMENT
644 * trylocks only this branch in the adapter tree
Jean Delvarefe61e072010-08-11 18:20:58 +0200645 */
Peter Rosin8320f492016-05-04 22:15:27 +0200646static int i2c_adapter_trylock_bus(struct i2c_adapter *adapter,
647 unsigned int flags)
Jean Delvarefe61e072010-08-11 18:20:58 +0200648{
Peter Rosinfa96f0c2016-05-04 22:15:28 +0200649 return rt_mutex_trylock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200650}
651
652/**
Peter Rosin8320f492016-05-04 22:15:27 +0200653 * i2c_adapter_unlock_bus - Release exclusive access to an I2C bus segment
Jean Delvarefe61e072010-08-11 18:20:58 +0200654 * @adapter: Target I2C bus segment
Peter Rosin8320f492016-05-04 22:15:27 +0200655 * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT
656 * unlocks only this branch in the adapter tree
Jean Delvarefe61e072010-08-11 18:20:58 +0200657 */
Peter Rosin8320f492016-05-04 22:15:27 +0200658static void i2c_adapter_unlock_bus(struct i2c_adapter *adapter,
659 unsigned int flags)
Jean Delvarefe61e072010-08-11 18:20:58 +0200660{
Peter Rosinfa96f0c2016-05-04 22:15:28 +0200661 rt_mutex_unlock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200662}
Jean Delvarefe61e072010-08-11 18:20:58 +0200663
Jarkko Nikula70762ab2013-11-14 14:03:52 +0200664static void i2c_dev_set_name(struct i2c_adapter *adap,
Hans de Goede728fe6c2017-10-11 11:41:19 +0200665 struct i2c_client *client,
666 struct i2c_board_info const *info)
Jarkko Nikula70762ab2013-11-14 14:03:52 +0200667{
668 struct acpi_device *adev = ACPI_COMPANION(&client->dev);
669
Hans de Goede728fe6c2017-10-11 11:41:19 +0200670 if (info && info->dev_name) {
671 dev_set_name(&client->dev, "i2c-%s", info->dev_name);
672 return;
673 }
674
Jarkko Nikula70762ab2013-11-14 14:03:52 +0200675 if (adev) {
676 dev_set_name(&client->dev, "i2c-%s", acpi_dev_name(adev));
677 return;
678 }
679
Jarkko Nikula70762ab2013-11-14 14:03:52 +0200680 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
Wolfram Sangda899f52015-05-18 21:09:12 +0200681 i2c_encode_flags_to_addr(client));
Jarkko Nikula70762ab2013-11-14 14:03:52 +0200682}
683
Dmitry Torokhov4124c4e2017-03-01 11:45:51 -0800684static int i2c_dev_irq_from_resources(const struct resource *resources,
685 unsigned int num_resources)
686{
687 struct irq_data *irqd;
688 int i;
689
690 for (i = 0; i < num_resources; i++) {
691 const struct resource *r = &resources[i];
692
693 if (resource_type(r) != IORESOURCE_IRQ)
694 continue;
695
696 if (r->flags & IORESOURCE_BITS) {
697 irqd = irq_get_irq_data(r->start);
698 if (!irqd)
699 break;
700
701 irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS);
702 }
703
704 return r->start;
705 }
706
707 return 0;
708}
709
Jean Delvarefe61e072010-08-11 18:20:58 +0200710/**
Jean Delvaref8a227e2009-06-19 16:58:18 +0200711 * i2c_new_device - instantiate an i2c device
David Brownell9c1600e2007-05-01 23:26:31 +0200712 * @adap: the adapter managing the device
713 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +0200714 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200715 *
Jean Delvaref8a227e2009-06-19 16:58:18 +0200716 * Create an i2c device. Binding is handled through driver model
717 * probe()/remove() methods. A driver may be bound to this device when we
718 * return from this function, or any later moment (e.g. maybe hotplugging will
719 * load the driver module). This call is not appropriate for use by mainboard
720 * initialization logic, which usually runs during an arch_initcall() long
721 * before any i2c_adapter could exist.
David Brownell9c1600e2007-05-01 23:26:31 +0200722 *
723 * This returns the new i2c client, which may be saved for later use with
724 * i2c_unregister_device(); or NULL to indicate an error.
725 */
726struct i2c_client *
727i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
728{
729 struct i2c_client *client;
730 int status;
731
732 client = kzalloc(sizeof *client, GFP_KERNEL);
733 if (!client)
734 return NULL;
735
736 client->adapter = adap;
737
738 client->dev.platform_data = info->platform_data;
Marc Pignatee354252008-08-28 08:33:22 +0200739 client->flags = info->flags;
David Brownell9c1600e2007-05-01 23:26:31 +0200740 client->addr = info->addr;
Dmitry Torokhov4124c4e2017-03-01 11:45:51 -0800741
David Brownell9c1600e2007-05-01 23:26:31 +0200742 client->irq = info->irq;
Dmitry Torokhov4124c4e2017-03-01 11:45:51 -0800743 if (!client->irq)
744 client->irq = i2c_dev_irq_from_resources(info->resources,
745 info->num_resources);
David Brownell9c1600e2007-05-01 23:26:31 +0200746
David Brownell9c1600e2007-05-01 23:26:31 +0200747 strlcpy(client->name, info->type, sizeof(client->name));
748
Wolfram Sangc4019b72015-07-17 12:50:06 +0200749 status = i2c_check_addr_validity(client->addr, client->flags);
Jean Delvare3a89db52010-06-03 11:33:52 +0200750 if (status) {
751 dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
752 client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
753 goto out_err_silent;
754 }
755
Jean Delvaref8a227e2009-06-19 16:58:18 +0200756 /* Check for address business */
Wolfram Sang9bccc702015-07-17 14:48:56 +0200757 status = i2c_check_addr_busy(adap, i2c_encode_flags_to_addr(client));
Jean Delvaref8a227e2009-06-19 16:58:18 +0200758 if (status)
759 goto out_err;
760
761 client->dev.parent = &client->adapter->dev;
762 client->dev.bus = &i2c_bus_type;
Jean Delvare51298d12009-09-18 22:45:45 +0200763 client->dev.type = &i2c_client_type;
Boris Brezillon04782262018-03-25 14:49:02 +0200764 client->dev.of_node = of_node_get(info->of_node);
Rafael J. Wysockice793482015-03-16 23:49:03 +0100765 client->dev.fwnode = info->fwnode;
Jean Delvaref8a227e2009-06-19 16:58:18 +0200766
Hans de Goede728fe6c2017-10-11 11:41:19 +0200767 i2c_dev_set_name(adap, client, info);
Dmitry Torokhovd3e1b612017-02-02 17:41:28 -0800768
769 if (info->properties) {
770 status = device_add_properties(&client->dev, info->properties);
771 if (status) {
772 dev_err(&adap->dev,
773 "Failed to add properties to client %s: %d\n",
774 client->name, status);
Boris Brezillon04782262018-03-25 14:49:02 +0200775 goto out_err_put_of_node;
Dmitry Torokhovd3e1b612017-02-02 17:41:28 -0800776 }
777 }
778
Jean Delvaref8a227e2009-06-19 16:58:18 +0200779 status = device_register(&client->dev);
780 if (status)
Dmitry Torokhovd3e1b612017-02-02 17:41:28 -0800781 goto out_free_props;
Jean Delvaref8a227e2009-06-19 16:58:18 +0200782
Jean Delvaref8a227e2009-06-19 16:58:18 +0200783 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
784 client->name, dev_name(&client->dev));
785
David Brownell9c1600e2007-05-01 23:26:31 +0200786 return client;
Jean Delvaref8a227e2009-06-19 16:58:18 +0200787
Dmitry Torokhovd3e1b612017-02-02 17:41:28 -0800788out_free_props:
789 if (info->properties)
790 device_remove_properties(&client->dev);
Boris Brezillon04782262018-03-25 14:49:02 +0200791out_err_put_of_node:
792 of_node_put(info->of_node);
Jean Delvaref8a227e2009-06-19 16:58:18 +0200793out_err:
Andy Shevchenkob93d3d32016-08-25 17:42:10 +0300794 dev_err(&adap->dev,
795 "Failed to register i2c client %s at 0x%02x (%d)\n",
796 client->name, client->addr, status);
Jean Delvare3a89db52010-06-03 11:33:52 +0200797out_err_silent:
Jean Delvaref8a227e2009-06-19 16:58:18 +0200798 kfree(client);
799 return NULL;
David Brownell9c1600e2007-05-01 23:26:31 +0200800}
801EXPORT_SYMBOL_GPL(i2c_new_device);
802
803
804/**
805 * i2c_unregister_device - reverse effect of i2c_new_device()
806 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +0200807 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +0200808 */
809void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +0200810{
Andy Shevchenko7b43dd12017-10-31 16:21:35 +0200811 if (!client)
812 return;
Lixin Wange0638fa2017-11-27 15:06:55 +0800813
814 if (client->dev.of_node) {
Pantelis Antoniou4f001fd2015-01-24 09:16:29 +0200815 of_node_clear_flag(client->dev.of_node, OF_POPULATED);
Lixin Wange0638fa2017-11-27 15:06:55 +0800816 of_node_put(client->dev.of_node);
817 }
818
Octavian Purdila525e6fa2016-07-08 19:13:10 +0300819 if (ACPI_COMPANION(&client->dev))
820 acpi_device_clear_enumerated(ACPI_COMPANION(&client->dev));
David Brownella1d9e6e2007-05-01 23:26:30 +0200821 device_unregister(&client->dev);
822}
David Brownell9c1600e2007-05-01 23:26:31 +0200823EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +0200824
825
Jean Delvare60b129d2008-05-11 20:37:06 +0200826static const struct i2c_device_id dummy_id[] = {
827 { "dummy", 0 },
828 { },
829};
830
Jean Delvared2653e92008-04-29 23:11:39 +0200831static int dummy_probe(struct i2c_client *client,
832 const struct i2c_device_id *id)
833{
834 return 0;
835}
836
837static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +0100838{
839 return 0;
840}
841
842static struct i2c_driver dummy_driver = {
843 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +0200844 .probe = dummy_probe,
845 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +0200846 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +0100847};
848
849/**
850 * i2c_new_dummy - return a new i2c device bound to a dummy driver
851 * @adapter: the adapter managing the device
852 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +0100853 * Context: can sleep
854 *
855 * This returns an I2C client bound to the "dummy" driver, intended for use
856 * with devices that consume multiple addresses. Examples of such chips
857 * include various EEPROMS (like 24c04 and 24c08 models).
858 *
859 * These dummy devices have two main uses. First, most I2C and SMBus calls
860 * except i2c_transfer() need a client handle; the dummy will be that handle.
861 * And second, this prevents the specified address from being bound to a
862 * different driver.
863 *
864 * This returns the new i2c client, which should be saved for later use with
865 * i2c_unregister_device(); or NULL to indicate an error.
866 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100867struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +0100868{
869 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +0200870 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +0100871 };
872
David Brownelle9f13732008-01-27 18:14:52 +0100873 return i2c_new_device(adapter, &info);
874}
875EXPORT_SYMBOL_GPL(i2c_new_dummy);
876
Jean-Michel Hautbois0f614d82016-01-31 16:33:00 +0100877/**
878 * i2c_new_secondary_device - Helper to get the instantiated secondary address
879 * and create the associated device
880 * @client: Handle to the primary client
881 * @name: Handle to specify which secondary address to get
882 * @default_addr: Used as a fallback if no secondary address was specified
883 * Context: can sleep
884 *
885 * I2C clients can be composed of multiple I2C slaves bound together in a single
886 * component. The I2C client driver then binds to the master I2C slave and needs
887 * to create I2C dummy clients to communicate with all the other slaves.
888 *
889 * This function creates and returns an I2C dummy client whose I2C address is
890 * retrieved from the platform firmware based on the given slave name. If no
891 * address is specified by the firmware default_addr is used.
892 *
893 * On DT-based platforms the address is retrieved from the "reg" property entry
894 * cell whose "reg-names" value matches the slave name.
895 *
896 * This returns the new i2c client, which should be saved for later use with
897 * i2c_unregister_device(); or NULL to indicate an error.
898 */
899struct i2c_client *i2c_new_secondary_device(struct i2c_client *client,
900 const char *name,
901 u16 default_addr)
902{
903 struct device_node *np = client->dev.of_node;
904 u32 addr = default_addr;
905 int i;
906
907 if (np) {
908 i = of_property_match_string(np, "reg-names", name);
909 if (i >= 0)
910 of_property_read_u32_index(np, "reg", i, &addr);
911 }
912
913 dev_dbg(&client->adapter->dev, "Address for %s : 0x%x\n", name, addr);
914 return i2c_new_dummy(client->adapter, addr);
915}
916EXPORT_SYMBOL_GPL(i2c_new_secondary_device);
917
David Brownellf37dd802007-02-13 22:09:00 +0100918/* ------------------------------------------------------------------------- */
919
David Brownell16ffadf2007-05-01 23:26:28 +0200920/* I2C bus adapters -- one roots each I2C or SMBUS segment */
921
Adrian Bunk83eaaed2007-10-13 23:56:30 +0200922static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923{
David Brownellef2c83212007-05-01 23:26:28 +0200924 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 complete(&adap->dev_released);
926}
927
Bartosz Golaszewski8dd1fe12016-09-16 18:02:42 +0200928unsigned int i2c_adapter_depth(struct i2c_adapter *adapter)
Jean Delvare390946b2012-09-10 10:14:02 +0200929{
930 unsigned int depth = 0;
931
932 while ((adapter = i2c_parent_is_i2c_adapter(adapter)))
933 depth++;
934
Bartosz Golaszewski2771dc32016-09-16 18:02:44 +0200935 WARN_ONCE(depth >= MAX_LOCKDEP_SUBCLASSES,
936 "adapter depth exceeds lockdep subclass limit\n");
937
Jean Delvare390946b2012-09-10 10:14:02 +0200938 return depth;
939}
Bartosz Golaszewski8dd1fe12016-09-16 18:02:42 +0200940EXPORT_SYMBOL_GPL(i2c_adapter_depth);
Jean Delvare390946b2012-09-10 10:14:02 +0200941
942/*
Jean Delvare99cd8e22009-06-19 16:58:20 +0200943 * Let users instantiate I2C devices through sysfs. This can be used when
944 * platform initialization code doesn't contain the proper data for
945 * whatever reason. Also useful for drivers that do device detection and
946 * detection fails, either because the device uses an unexpected address,
947 * or this is a compatible device with different ID register values.
948 *
949 * Parameter checking may look overzealous, but we really don't want
950 * the user to provide incorrect parameters.
951 */
952static ssize_t
953i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
954 const char *buf, size_t count)
955{
956 struct i2c_adapter *adap = to_i2c_adapter(dev);
957 struct i2c_board_info info;
958 struct i2c_client *client;
959 char *blank, end;
960 int res;
961
Jean Delvare99cd8e22009-06-19 16:58:20 +0200962 memset(&info, 0, sizeof(struct i2c_board_info));
963
964 blank = strchr(buf, ' ');
965 if (!blank) {
966 dev_err(dev, "%s: Missing parameters\n", "new_device");
967 return -EINVAL;
968 }
969 if (blank - buf > I2C_NAME_SIZE - 1) {
970 dev_err(dev, "%s: Invalid device name\n", "new_device");
971 return -EINVAL;
972 }
973 memcpy(info.type, buf, blank - buf);
974
975 /* Parse remaining parameters, reject extra parameters */
976 res = sscanf(++blank, "%hi%c", &info.addr, &end);
977 if (res < 1) {
978 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
979 return -EINVAL;
980 }
981 if (res > 1 && end != '\n') {
982 dev_err(dev, "%s: Extra parameters\n", "new_device");
983 return -EINVAL;
984 }
985
Wolfram Sangcfa03272015-07-27 14:03:38 +0200986 if ((info.addr & I2C_ADDR_OFFSET_TEN_BIT) == I2C_ADDR_OFFSET_TEN_BIT) {
987 info.addr &= ~I2C_ADDR_OFFSET_TEN_BIT;
988 info.flags |= I2C_CLIENT_TEN;
989 }
990
991 if (info.addr & I2C_ADDR_OFFSET_SLAVE) {
992 info.addr &= ~I2C_ADDR_OFFSET_SLAVE;
993 info.flags |= I2C_CLIENT_SLAVE;
994 }
995
Jean Delvare99cd8e22009-06-19 16:58:20 +0200996 client = i2c_new_device(adap, &info);
997 if (!client)
Jean Delvare3a89db52010-06-03 11:33:52 +0200998 return -EINVAL;
Jean Delvare99cd8e22009-06-19 16:58:20 +0200999
1000 /* Keep track of the added device */
Jean Delvaredafc50d2010-08-11 18:21:01 +02001001 mutex_lock(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +02001002 list_add_tail(&client->detected, &adap->userspace_clients);
Jean Delvaredafc50d2010-08-11 18:21:01 +02001003 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +02001004 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
1005 info.type, info.addr);
1006
1007 return count;
1008}
Wolfram Sanga5eb71b2015-01-19 20:12:24 +01001009static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
Jean Delvare99cd8e22009-06-19 16:58:20 +02001010
1011/*
1012 * And of course let the users delete the devices they instantiated, if
1013 * they got it wrong. This interface can only be used to delete devices
1014 * instantiated by i2c_sysfs_new_device above. This guarantees that we
1015 * don't delete devices to which some kernel code still has references.
1016 *
1017 * Parameter checking may look overzealous, but we really don't want
1018 * the user to delete the wrong device.
1019 */
1020static ssize_t
1021i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
1022 const char *buf, size_t count)
1023{
1024 struct i2c_adapter *adap = to_i2c_adapter(dev);
1025 struct i2c_client *client, *next;
1026 unsigned short addr;
1027 char end;
1028 int res;
1029
1030 /* Parse parameters, reject extra parameters */
1031 res = sscanf(buf, "%hi%c", &addr, &end);
1032 if (res < 1) {
1033 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
1034 return -EINVAL;
1035 }
1036 if (res > 1 && end != '\n') {
1037 dev_err(dev, "%s: Extra parameters\n", "delete_device");
1038 return -EINVAL;
1039 }
1040
1041 /* Make sure the device was added through sysfs */
1042 res = -ENOENT;
Jean Delvare390946b2012-09-10 10:14:02 +02001043 mutex_lock_nested(&adap->userspace_clients_lock,
1044 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +02001045 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1046 detected) {
Wolfram Sangcfa03272015-07-27 14:03:38 +02001047 if (i2c_encode_flags_to_addr(client) == addr) {
Jean Delvare99cd8e22009-06-19 16:58:20 +02001048 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
1049 "delete_device", client->name, client->addr);
1050
1051 list_del(&client->detected);
1052 i2c_unregister_device(client);
1053 res = count;
1054 break;
1055 }
1056 }
Jean Delvaredafc50d2010-08-11 18:21:01 +02001057 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +02001058
1059 if (res < 0)
1060 dev_err(dev, "%s: Can't find device in list\n",
1061 "delete_device");
1062 return res;
1063}
Alexander Sverdline9b526f2013-05-17 14:56:35 +02001064static DEVICE_ATTR_IGNORE_LOCKDEP(delete_device, S_IWUSR, NULL,
1065 i2c_sysfs_delete_device);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001066
1067static struct attribute *i2c_adapter_attrs[] = {
1068 &dev_attr_name.attr,
1069 &dev_attr_new_device.attr,
1070 &dev_attr_delete_device.attr,
1071 NULL
David Brownell16ffadf2007-05-01 23:26:28 +02001072};
Wolfram Sanga5eb71b2015-01-19 20:12:24 +01001073ATTRIBUTE_GROUPS(i2c_adapter);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001074
Michael Lawnick08263742010-08-11 18:21:02 +02001075struct device_type i2c_adapter_type = {
Wolfram Sanga5eb71b2015-01-19 20:12:24 +01001076 .groups = i2c_adapter_groups,
Jean Delvare4f8cf822009-09-18 22:45:46 +02001077 .release = i2c_adapter_dev_release,
David Brownell16ffadf2007-05-01 23:26:28 +02001078};
Michael Lawnick08263742010-08-11 18:21:02 +02001079EXPORT_SYMBOL_GPL(i2c_adapter_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080
Stephen Warren643dd092012-04-17 12:43:33 -06001081/**
1082 * i2c_verify_adapter - return parameter as i2c_adapter or NULL
1083 * @dev: device, probably from some driver model iterator
1084 *
1085 * When traversing the driver model tree, perhaps using driver model
1086 * iterators like @device_for_each_child(), you can't assume very much
1087 * about the nodes you find. Use this function to avoid oopses caused
1088 * by wrongly treating some non-I2C device as an i2c_adapter.
1089 */
1090struct i2c_adapter *i2c_verify_adapter(struct device *dev)
1091{
1092 return (dev->type == &i2c_adapter_type)
1093 ? to_i2c_adapter(dev)
1094 : NULL;
1095}
1096EXPORT_SYMBOL(i2c_verify_adapter);
1097
Jean Delvare2bb50952009-09-18 22:45:46 +02001098#ifdef CONFIG_I2C_COMPAT
1099static struct class_compat *i2c_adapter_compat_class;
1100#endif
1101
David Brownell9c1600e2007-05-01 23:26:31 +02001102static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
1103{
1104 struct i2c_devinfo *devinfo;
1105
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +02001106 down_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +02001107 list_for_each_entry(devinfo, &__i2c_board_list, list) {
1108 if (devinfo->busnum == adapter->nr
1109 && !i2c_new_device(adapter,
1110 &devinfo->board_info))
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001111 dev_err(&adapter->dev,
1112 "Can't create device at 0x%02x\n",
David Brownell9c1600e2007-05-01 23:26:31 +02001113 devinfo->board_info.addr);
1114 }
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +02001115 up_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +02001116}
1117
Jean Delvare69b00892009-12-06 17:06:27 +01001118static int i2c_do_add_adapter(struct i2c_driver *driver,
1119 struct i2c_adapter *adap)
Jean Delvare026526f2008-01-27 18:14:49 +01001120{
Jean Delvare4735c982008-07-14 22:38:36 +02001121 /* Detect supported devices on that bus, and instantiate them */
1122 i2c_detect(adap, driver);
1123
Jean Delvare026526f2008-01-27 18:14:49 +01001124 return 0;
1125}
1126
Jean Delvare69b00892009-12-06 17:06:27 +01001127static int __process_new_adapter(struct device_driver *d, void *data)
1128{
1129 return i2c_do_add_adapter(to_i2c_driver(d), data);
1130}
1131
Peter Rosind1ed7982016-08-25 23:07:01 +02001132static const struct i2c_lock_operations i2c_adapter_lock_ops = {
1133 .lock_bus = i2c_adapter_lock_bus,
1134 .trylock_bus = i2c_adapter_trylock_bus,
1135 .unlock_bus = i2c_adapter_unlock_bus,
1136};
1137
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +02001138static void i2c_host_notify_irq_teardown(struct i2c_adapter *adap)
1139{
1140 struct irq_domain *domain = adap->host_notify_domain;
1141 irq_hw_number_t hwirq;
1142
1143 if (!domain)
1144 return;
1145
1146 for (hwirq = 0 ; hwirq < I2C_ADDR_7BITS_COUNT ; hwirq++)
1147 irq_dispose_mapping(irq_find_mapping(domain, hwirq));
1148
1149 irq_domain_remove(domain);
1150 adap->host_notify_domain = NULL;
1151}
1152
1153static int i2c_host_notify_irq_map(struct irq_domain *h,
1154 unsigned int virq,
1155 irq_hw_number_t hw_irq_num)
1156{
1157 irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq);
1158
1159 return 0;
1160}
1161
1162static const struct irq_domain_ops i2c_host_notify_irq_ops = {
1163 .map = i2c_host_notify_irq_map,
1164};
1165
1166static int i2c_setup_host_notify_irq_domain(struct i2c_adapter *adap)
1167{
1168 struct irq_domain *domain;
1169
1170 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_HOST_NOTIFY))
1171 return 0;
1172
1173 domain = irq_domain_create_linear(adap->dev.fwnode,
1174 I2C_ADDR_7BITS_COUNT,
1175 &i2c_host_notify_irq_ops, adap);
1176 if (!domain)
1177 return -ENOMEM;
1178
1179 adap->host_notify_domain = domain;
1180
1181 return 0;
1182}
1183
1184/**
1185 * i2c_handle_smbus_host_notify - Forward a Host Notify event to the correct
1186 * I2C client.
1187 * @adap: the adapter
1188 * @addr: the I2C address of the notifying device
1189 * Context: can't sleep
1190 *
1191 * Helper function to be called from an I2C bus driver's interrupt
1192 * handler. It will schedule the Host Notify IRQ.
1193 */
1194int i2c_handle_smbus_host_notify(struct i2c_adapter *adap, unsigned short addr)
1195{
1196 int irq;
1197
1198 if (!adap)
1199 return -EINVAL;
1200
1201 irq = irq_find_mapping(adap->host_notify_domain, addr);
1202 if (irq <= 0)
1203 return -ENXIO;
1204
1205 generic_handle_irq(irq);
1206
1207 return 0;
1208}
1209EXPORT_SYMBOL_GPL(i2c_handle_smbus_host_notify);
1210
David Brownell6e13e642007-05-01 23:26:31 +02001211static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212{
Wolfram Sangce0dffa2016-07-09 13:34:58 +09001213 int res = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214
David Brownell1d0b19c2008-10-14 17:30:05 +02001215 /* Can't register until after driver model init */
Sudip Mukherjee95026652016-03-07 17:19:17 +05301216 if (WARN_ON(!is_registered)) {
Jean Delvare35fc37f2009-06-19 16:58:19 +02001217 res = -EAGAIN;
1218 goto out_list;
1219 }
David Brownell1d0b19c2008-10-14 17:30:05 +02001220
Jean Delvare2236baa2010-11-15 22:40:38 +01001221 /* Sanity checks */
Wolfram Sang8ddfe412016-07-09 13:35:00 +09001222 if (WARN(!adap->name[0], "i2c adapter has no name"))
Wolfram Sangce0dffa2016-07-09 13:34:58 +09001223 goto out_list;
Wolfram Sang8ddfe412016-07-09 13:35:00 +09001224
1225 if (!adap->algo) {
Wolfram Sang44239a52016-07-09 13:35:04 +09001226 pr_err("adapter '%s': no algo supplied!\n", adap->name);
Wolfram Sangce0dffa2016-07-09 13:34:58 +09001227 goto out_list;
Jean Delvare2236baa2010-11-15 22:40:38 +01001228 }
1229
Peter Rosind1ed7982016-08-25 23:07:01 +02001230 if (!adap->lock_ops)
1231 adap->lock_ops = &i2c_adapter_lock_ops;
Peter Rosin8320f492016-05-04 22:15:27 +02001232
Mika Kuoppala194684e2009-12-06 17:06:22 +01001233 rt_mutex_init(&adap->bus_lock);
Peter Rosin6ef91fc2016-05-04 22:15:29 +02001234 rt_mutex_init(&adap->mux_lock);
Jean Delvaredafc50d2010-08-11 18:21:01 +02001235 mutex_init(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +02001236 INIT_LIST_HEAD(&adap->userspace_clients);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
Jean Delvare8fcfef62009-03-28 21:34:43 +01001238 /* Set default timeout to 1 second if not already set */
1239 if (adap->timeout == 0)
1240 adap->timeout = HZ;
1241
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +02001242 /* register soft irqs for Host Notify */
1243 res = i2c_setup_host_notify_irq_domain(adap);
1244 if (res) {
1245 pr_err("adapter '%s': can't create Host Notify IRQs (%d)\n",
1246 adap->name, res);
1247 goto out_list;
1248 }
1249
Kay Sievers27d9c182009-01-07 14:29:16 +01001250 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001251 adap->dev.bus = &i2c_bus_type;
1252 adap->dev.type = &i2c_adapter_type;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001253 res = device_register(&adap->dev);
Wolfram Sang8ddfe412016-07-09 13:35:00 +09001254 if (res) {
Wolfram Sang44239a52016-07-09 13:35:04 +09001255 pr_err("adapter '%s': can't register device (%d)\n", adap->name, res);
Jean Delvareb119c6c2006-08-15 18:26:30 +02001256 goto out_list;
Wolfram Sang8ddfe412016-07-09 13:35:00 +09001257 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
Phil Reidf8756c62017-08-24 17:31:04 +08001259 res = of_i2c_setup_smbus_alert(adap);
1260 if (res)
1261 goto out_reg;
1262
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001263 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
1264
Charles Keepax6ada5c12015-04-16 13:05:19 +01001265 pm_runtime_no_callbacks(&adap->dev);
Linus Walleij04f59142016-04-12 09:57:35 +02001266 pm_suspend_ignore_children(&adap->dev, true);
Wolfram Sang9f924162015-12-23 18:19:28 +01001267 pm_runtime_enable(&adap->dev);
Charles Keepax6ada5c12015-04-16 13:05:19 +01001268
Jean Delvare2bb50952009-09-18 22:45:46 +02001269#ifdef CONFIG_I2C_COMPAT
1270 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
1271 adap->dev.parent);
1272 if (res)
1273 dev_warn(&adap->dev,
1274 "Failed to create compatibility class link\n");
1275#endif
1276
Wolfram Sangd3b11d82016-07-09 13:34:59 +09001277 i2c_init_recovery(adap);
Viresh Kumar5f9296b2012-02-28 18:26:31 +05301278
Jean Delvare729d6dd2009-06-19 16:58:18 +02001279 /* create pre-declared device nodes */
Wolfram Sang687b81d2013-07-11 12:56:15 +01001280 of_i2c_register_devices(adap);
Jarkko Nikulaaec809f2016-08-12 17:02:52 +03001281 i2c_acpi_register_devices(adap);
1282 i2c_acpi_install_space_handler(adap);
Wolfram Sang687b81d2013-07-11 12:56:15 +01001283
David Brownell6e13e642007-05-01 23:26:31 +02001284 if (adap->nr < __i2c_first_dynamic_bus_num)
1285 i2c_scan_static_board_info(adap);
1286
Jean Delvare4735c982008-07-14 22:38:36 +02001287 /* Notify drivers */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001288 mutex_lock(&core_lock);
Jean Delvared6703282010-08-11 18:20:59 +02001289 bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
Jean Delvarecaada322008-01-27 18:14:49 +01001290 mutex_unlock(&core_lock);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001291
1292 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001293
Phil Reidf8756c62017-08-24 17:31:04 +08001294out_reg:
1295 init_completion(&adap->dev_released);
1296 device_unregister(&adap->dev);
1297 wait_for_completion(&adap->dev_released);
Jean Delvareb119c6c2006-08-15 18:26:30 +02001298out_list:
Jean Delvare35fc37f2009-06-19 16:58:19 +02001299 mutex_lock(&core_lock);
Jean Delvareb119c6c2006-08-15 18:26:30 +02001300 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001301 mutex_unlock(&core_lock);
1302 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303}
1304
David Brownell6e13e642007-05-01 23:26:31 +02001305/**
Doug Andersonee5c2742013-03-01 08:57:31 -08001306 * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1
1307 * @adap: the adapter to register (with adap->nr initialized)
1308 * Context: can sleep
1309 *
1310 * See i2c_add_numbered_adapter() for details.
1311 */
1312static int __i2c_add_numbered_adapter(struct i2c_adapter *adap)
1313{
Wolfram Sang84d0b612016-07-09 13:35:01 +09001314 int id;
Doug Andersonee5c2742013-03-01 08:57:31 -08001315
1316 mutex_lock(&core_lock);
Wolfram Sang84d0b612016-07-09 13:35:01 +09001317 id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1, GFP_KERNEL);
Doug Andersonee5c2742013-03-01 08:57:31 -08001318 mutex_unlock(&core_lock);
Wolfram Sang84d0b612016-07-09 13:35:01 +09001319 if (WARN(id < 0, "couldn't get idr"))
Doug Andersonee5c2742013-03-01 08:57:31 -08001320 return id == -ENOSPC ? -EBUSY : id;
1321
1322 return i2c_register_adapter(adap);
1323}
1324
1325/**
David Brownell6e13e642007-05-01 23:26:31 +02001326 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
1327 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +02001328 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001329 *
1330 * This routine is used to declare an I2C adapter when its bus number
Doug Andersonee5c2742013-03-01 08:57:31 -08001331 * doesn't matter or when its bus number is specified by an dt alias.
1332 * Examples of bases when the bus number doesn't matter: I2C adapters
1333 * dynamically added by USB links or PCI plugin cards.
David Brownell6e13e642007-05-01 23:26:31 +02001334 *
1335 * When this returns zero, a new bus number was allocated and stored
1336 * in adap->nr, and the specified adapter became available for clients.
1337 * Otherwise, a negative errno value is returned.
1338 */
1339int i2c_add_adapter(struct i2c_adapter *adapter)
1340{
Doug Andersonee5c2742013-03-01 08:57:31 -08001341 struct device *dev = &adapter->dev;
Tejun Heo4ae42b02013-02-27 17:04:15 -08001342 int id;
David Brownell6e13e642007-05-01 23:26:31 +02001343
Doug Andersonee5c2742013-03-01 08:57:31 -08001344 if (dev->of_node) {
1345 id = of_alias_get_id(dev->of_node, "i2c");
1346 if (id >= 0) {
1347 adapter->nr = id;
1348 return __i2c_add_numbered_adapter(adapter);
1349 }
1350 }
1351
Jean Delvarecaada322008-01-27 18:14:49 +01001352 mutex_lock(&core_lock);
Tejun Heo4ae42b02013-02-27 17:04:15 -08001353 id = idr_alloc(&i2c_adapter_idr, adapter,
1354 __i2c_first_dynamic_bus_num, 0, GFP_KERNEL);
Jean Delvarecaada322008-01-27 18:14:49 +01001355 mutex_unlock(&core_lock);
Wolfram Sang84d0b612016-07-09 13:35:01 +09001356 if (WARN(id < 0, "couldn't get idr"))
Tejun Heo4ae42b02013-02-27 17:04:15 -08001357 return id;
David Brownell6e13e642007-05-01 23:26:31 +02001358
1359 adapter->nr = id;
Tejun Heo4ae42b02013-02-27 17:04:15 -08001360
David Brownell6e13e642007-05-01 23:26:31 +02001361 return i2c_register_adapter(adapter);
1362}
1363EXPORT_SYMBOL(i2c_add_adapter);
1364
1365/**
1366 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
1367 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +02001368 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001369 *
1370 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +01001371 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
1372 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +02001373 * is used to properly configure I2C devices.
1374 *
Grant Likely488bf312011-07-25 17:49:43 +02001375 * If the requested bus number is set to -1, then this function will behave
1376 * identically to i2c_add_adapter, and will dynamically assign a bus number.
1377 *
David Brownell6e13e642007-05-01 23:26:31 +02001378 * If no devices have pre-been declared for this bus, then be sure to
1379 * register the adapter before any dynamically allocated ones. Otherwise
1380 * the required bus ID may not be available.
1381 *
1382 * When this returns zero, the specified adapter became available for
1383 * clients using the bus number provided in adap->nr. Also, the table
1384 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
1385 * and the appropriate driver model device nodes are created. Otherwise, a
1386 * negative errno value is returned.
1387 */
1388int i2c_add_numbered_adapter(struct i2c_adapter *adap)
1389{
Grant Likely488bf312011-07-25 17:49:43 +02001390 if (adap->nr == -1) /* -1 means dynamically assign bus id */
1391 return i2c_add_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001392
Doug Andersonee5c2742013-03-01 08:57:31 -08001393 return __i2c_add_numbered_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001394}
1395EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
1396
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001397static void i2c_do_del_adapter(struct i2c_driver *driver,
Jean Delvare69b00892009-12-06 17:06:27 +01001398 struct i2c_adapter *adapter)
Jean Delvare026526f2008-01-27 18:14:49 +01001399{
Jean Delvare4735c982008-07-14 22:38:36 +02001400 struct i2c_client *client, *_n;
Jean Delvare026526f2008-01-27 18:14:49 +01001401
Jean Delvareacec2112009-03-28 21:34:40 +01001402 /* Remove the devices we created ourselves as the result of hardware
1403 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +02001404 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
1405 if (client->adapter == adapter) {
1406 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
1407 client->name, client->addr);
1408 list_del(&client->detected);
1409 i2c_unregister_device(client);
1410 }
1411 }
Jean Delvare026526f2008-01-27 18:14:49 +01001412}
1413
Jean Delvaree549c2b2009-06-19 16:58:19 +02001414static int __unregister_client(struct device *dev, void *dummy)
1415{
1416 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvare5219bf82011-01-14 22:03:49 +01001417 if (client && strcmp(client->name, "dummy"))
1418 i2c_unregister_device(client);
1419 return 0;
1420}
1421
1422static int __unregister_dummy(struct device *dev, void *dummy)
1423{
1424 struct i2c_client *client = i2c_verify_client(dev);
Andy Shevchenko7b43dd12017-10-31 16:21:35 +02001425 i2c_unregister_device(client);
Jean Delvaree549c2b2009-06-19 16:58:19 +02001426 return 0;
1427}
1428
Jean Delvare69b00892009-12-06 17:06:27 +01001429static int __process_removed_adapter(struct device_driver *d, void *data)
1430{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001431 i2c_do_del_adapter(to_i2c_driver(d), data);
1432 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001433}
1434
David Brownelld64f73b2007-07-12 14:12:28 +02001435/**
1436 * i2c_del_adapter - unregister I2C adapter
1437 * @adap: the adapter being unregistered
1438 * Context: can sleep
1439 *
1440 * This unregisters an I2C adapter which was previously registered
1441 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1442 */
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001443void i2c_del_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444{
Jean Delvare35fc37f2009-06-19 16:58:19 +02001445 struct i2c_adapter *found;
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001446 struct i2c_client *client, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
1448 /* First make sure that this adapter was ever added */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001449 mutex_lock(&core_lock);
1450 found = idr_find(&i2c_adapter_idr, adap->nr);
1451 mutex_unlock(&core_lock);
1452 if (found != adap) {
Wolfram Sang44239a52016-07-09 13:35:04 +09001453 pr_debug("attempting to delete unregistered adapter [%s]\n", adap->name);
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001454 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 }
1456
Jarkko Nikulaaec809f2016-08-12 17:02:52 +03001457 i2c_acpi_remove_space_handler(adap);
Jean Delvare026526f2008-01-27 18:14:49 +01001458 /* Tell drivers about this removal */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001459 mutex_lock(&core_lock);
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001460 bus_for_each_drv(&i2c_bus_type, NULL, adap,
Jean Delvare69b00892009-12-06 17:06:27 +01001461 __process_removed_adapter);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001462 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001464 /* Remove devices instantiated from sysfs */
Jean Delvare390946b2012-09-10 10:14:02 +02001465 mutex_lock_nested(&adap->userspace_clients_lock,
1466 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +02001467 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1468 detected) {
1469 dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
1470 client->addr);
1471 list_del(&client->detected);
1472 i2c_unregister_device(client);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001473 }
Jean Delvaredafc50d2010-08-11 18:21:01 +02001474 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001475
Jean Delvaree549c2b2009-06-19 16:58:19 +02001476 /* Detach any active clients. This can't fail, thus we do not
Jean Delvare5219bf82011-01-14 22:03:49 +01001477 * check the returned value. This is a two-pass process, because
1478 * we can't remove the dummy devices during the first pass: they
1479 * could have been instantiated by real devices wishing to clean
1480 * them up properly, so we give them a chance to do that first. */
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001481 device_for_each_child(&adap->dev, NULL, __unregister_client);
1482 device_for_each_child(&adap->dev, NULL, __unregister_dummy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
Jean Delvare2bb50952009-09-18 22:45:46 +02001484#ifdef CONFIG_I2C_COMPAT
1485 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
1486 adap->dev.parent);
1487#endif
1488
Thadeu Lima de Souza Cascardoc5567522010-01-16 20:43:13 +01001489 /* device name is gone after device_unregister */
1490 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
1491
Wolfram Sang9f924162015-12-23 18:19:28 +01001492 pm_runtime_disable(&adap->dev);
1493
Benjamin Tissoires4d5538f2016-10-13 14:10:40 +02001494 i2c_host_notify_irq_teardown(adap);
1495
Wolfram Sang26680ee2015-01-29 22:45:09 +01001496 /* wait until all references to the device are gone
1497 *
1498 * FIXME: This is old code and should ideally be replaced by an
1499 * alternative which results in decoupling the lifetime of the struct
1500 * device from the i2c_adapter, like spi or netdev do. Any solution
Shailendra Verma95cc1e32015-05-18 22:24:01 +05301501 * should be thoroughly tested with DEBUG_KOBJECT_RELEASE enabled!
Wolfram Sang26680ee2015-01-29 22:45:09 +01001502 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
David Brownell6e13e642007-05-01 23:26:31 +02001507 /* free bus id */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001508 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001510 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Jean Delvarebd4bc3db2008-07-16 19:30:05 +02001512 /* Clear the device structure in case this adapter is ever going to be
1513 added again */
1514 memset(&adap->dev, 0, sizeof(adap->dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515}
David Brownellc0564602007-05-01 23:26:31 +02001516EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
Wolfram Sang54177cc2015-12-17 13:32:36 +01001518/**
1519 * i2c_parse_fw_timings - get I2C related timing parameters from firmware
1520 * @dev: The device to scan for I2C timing properties
1521 * @t: the i2c_timings struct to be filled with values
1522 * @use_defaults: bool to use sane defaults derived from the I2C specification
1523 * when properties are not found, otherwise use 0
1524 *
1525 * Scan the device for the generic I2C properties describing timing parameters
1526 * for the signal and fill the given struct with the results. If a property was
1527 * not found and use_defaults was true, then maximum timings are assumed which
1528 * are derived from the I2C specification. If use_defaults is not used, the
1529 * results will be 0, so drivers can apply their own defaults later. The latter
1530 * is mainly intended for avoiding regressions of existing drivers which want
1531 * to switch to this function. New drivers almost always should use the defaults.
1532 */
1533
1534void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults)
1535{
1536 int ret;
1537
1538 memset(t, 0, sizeof(*t));
1539
1540 ret = device_property_read_u32(dev, "clock-frequency", &t->bus_freq_hz);
1541 if (ret && use_defaults)
1542 t->bus_freq_hz = 100000;
1543
1544 ret = device_property_read_u32(dev, "i2c-scl-rising-time-ns", &t->scl_rise_ns);
1545 if (ret && use_defaults) {
1546 if (t->bus_freq_hz <= 100000)
1547 t->scl_rise_ns = 1000;
1548 else if (t->bus_freq_hz <= 400000)
1549 t->scl_rise_ns = 300;
1550 else
1551 t->scl_rise_ns = 120;
1552 }
1553
1554 ret = device_property_read_u32(dev, "i2c-scl-falling-time-ns", &t->scl_fall_ns);
1555 if (ret && use_defaults) {
1556 if (t->bus_freq_hz <= 400000)
1557 t->scl_fall_ns = 300;
1558 else
1559 t->scl_fall_ns = 120;
1560 }
1561
1562 device_property_read_u32(dev, "i2c-scl-internal-delay-ns", &t->scl_int_delay_ns);
1563
1564 ret = device_property_read_u32(dev, "i2c-sda-falling-time-ns", &t->sda_fall_ns);
1565 if (ret && use_defaults)
1566 t->sda_fall_ns = t->scl_fall_ns;
Andy Shevchenko4717be72018-07-25 17:39:25 +03001567
1568 device_property_read_u32(dev, "i2c-sda-hold-time-ns", &t->sda_hold_ns);
Wolfram Sang54177cc2015-12-17 13:32:36 +01001569}
1570EXPORT_SYMBOL_GPL(i2c_parse_fw_timings);
1571
David Brownell7b4fbc52007-05-01 23:26:30 +02001572/* ------------------------------------------------------------------------- */
1573
Jean Delvare7ae31482011-03-20 14:50:52 +01001574int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *))
1575{
1576 int res;
1577
1578 mutex_lock(&core_lock);
1579 res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn);
1580 mutex_unlock(&core_lock);
1581
1582 return res;
1583}
1584EXPORT_SYMBOL_GPL(i2c_for_each_dev);
1585
Jean Delvare69b00892009-12-06 17:06:27 +01001586static int __process_new_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001587{
Jean Delvare4f8cf822009-09-18 22:45:46 +02001588 if (dev->type != &i2c_adapter_type)
1589 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001590 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
Dave Young7f101a92008-07-14 22:38:19 +02001591}
1592
David Brownell7b4fbc52007-05-01 23:26:30 +02001593/*
1594 * An i2c_driver is used with one or more i2c_client (device) nodes to access
Jean Delvare729d6dd2009-06-19 16:58:18 +02001595 * i2c slave chips, on a bus instance associated with some i2c_adapter.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 */
1597
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001598int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599{
Jean Delvare7eebcb72006-02-05 23:28:21 +01001600 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
David Brownell1d0b19c2008-10-14 17:30:05 +02001602 /* Can't register until after driver model init */
Sudip Mukherjee95026652016-03-07 17:19:17 +05301603 if (WARN_ON(!is_registered))
David Brownell1d0b19c2008-10-14 17:30:05 +02001604 return -EAGAIN;
1605
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001607 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 driver->driver.bus = &i2c_bus_type;
Vladimir Zapolskiy147b36d2016-10-31 21:46:24 +02001609 INIT_LIST_HEAD(&driver->clients);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610
Jean Delvare729d6dd2009-06-19 16:58:18 +02001611 /* When registration returns, the driver core
David Brownell6e13e642007-05-01 23:26:31 +02001612 * will have called probe() for all matching-but-unbound devices.
1613 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 res = driver_register(&driver->driver);
1615 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +01001616 return res;
David Brownell438d6c22006-12-10 21:21:31 +01001617
Wolfram Sang44239a52016-07-09 13:35:04 +09001618 pr_debug("driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
Jean Delvare4735c982008-07-14 22:38:36 +02001620 /* Walk the adapters that are already present */
Jean Delvare7ae31482011-03-20 14:50:52 +01001621 i2c_for_each_dev(driver, __process_new_driver);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001622
Jean Delvare7eebcb72006-02-05 23:28:21 +01001623 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001625EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Jean Delvare69b00892009-12-06 17:06:27 +01001627static int __process_removed_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001628{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001629 if (dev->type == &i2c_adapter_type)
1630 i2c_do_del_adapter(data, to_i2c_adapter(dev));
1631 return 0;
Dave Young7f101a92008-07-14 22:38:19 +02001632}
1633
David Brownella1d9e6e2007-05-01 23:26:30 +02001634/**
1635 * i2c_del_driver - unregister I2C driver
1636 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +02001637 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +02001638 */
Jean Delvareb3e82092007-05-01 23:26:32 +02001639void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640{
Jean Delvare7ae31482011-03-20 14:50:52 +01001641 i2c_for_each_dev(driver, __process_removed_driver);
David Brownella1d9e6e2007-05-01 23:26:30 +02001642
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 driver_unregister(&driver->driver);
Wolfram Sang44239a52016-07-09 13:35:04 +09001644 pr_debug("driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645}
David Brownellc0564602007-05-01 23:26:31 +02001646EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
David Brownell7b4fbc52007-05-01 23:26:30 +02001648/* ------------------------------------------------------------------------- */
1649
Jean Delvaree48d3312008-01-27 18:14:48 +01001650/**
1651 * i2c_use_client - increments the reference count of the i2c client structure
1652 * @client: the client being referenced
1653 *
1654 * Each live reference to a client should be refcounted. The driver model does
1655 * that automatically as part of driver binding, so that most drivers don't
1656 * need to do this explicitly: they hold a reference until they're unbound
1657 * from the device.
1658 *
1659 * A pointer to the client with the incremented reference counter is returned.
1660 */
1661struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662{
David Brownell6ea438e2008-07-14 22:38:24 +02001663 if (client && get_device(&client->dev))
1664 return client;
1665 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666}
David Brownellc0564602007-05-01 23:26:31 +02001667EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668
Jean Delvaree48d3312008-01-27 18:14:48 +01001669/**
1670 * i2c_release_client - release a use of the i2c client structure
1671 * @client: the client being no longer referenced
1672 *
1673 * Must be called when a user of a client is finished with it.
1674 */
1675void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676{
David Brownell6ea438e2008-07-14 22:38:24 +02001677 if (client)
1678 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679}
David Brownellc0564602007-05-01 23:26:31 +02001680EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681
David Brownell9b766b82008-01-27 18:14:51 +01001682struct i2c_cmd_arg {
1683 unsigned cmd;
1684 void *arg;
1685};
1686
1687static int i2c_cmd(struct device *dev, void *_arg)
1688{
1689 struct i2c_client *client = i2c_verify_client(dev);
1690 struct i2c_cmd_arg *arg = _arg;
Lars-Peter Clausen0acc2b32013-09-29 10:51:06 +02001691 struct i2c_driver *driver;
David Brownell9b766b82008-01-27 18:14:51 +01001692
Lars-Peter Clausen0acc2b32013-09-29 10:51:06 +02001693 if (!client || !client->dev.driver)
1694 return 0;
1695
1696 driver = to_i2c_driver(client->dev.driver);
1697 if (driver->command)
1698 driver->command(client, arg->cmd, arg->arg);
David Brownell9b766b82008-01-27 18:14:51 +01001699 return 0;
1700}
1701
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
1703{
David Brownell9b766b82008-01-27 18:14:51 +01001704 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705
David Brownell9b766b82008-01-27 18:14:51 +01001706 cmd_arg.cmd = cmd;
1707 cmd_arg.arg = arg;
1708 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709}
David Brownellc0564602007-05-01 23:26:31 +02001710EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711
1712static int __init i2c_init(void)
1713{
1714 int retval;
1715
Wolfram Sang03bde7c2015-03-12 17:17:59 +01001716 retval = of_alias_get_highest_id("i2c");
1717
1718 down_write(&__i2c_board_lock);
1719 if (retval >= __i2c_first_dynamic_bus_num)
1720 __i2c_first_dynamic_bus_num = retval + 1;
1721 up_write(&__i2c_board_lock);
1722
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 retval = bus_register(&i2c_bus_type);
1724 if (retval)
1725 return retval;
Wolfram Sangb980a262016-03-14 10:41:52 +01001726
1727 is_registered = true;
1728
Jean Delvare2bb50952009-09-18 22:45:46 +02001729#ifdef CONFIG_I2C_COMPAT
1730 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
1731 if (!i2c_adapter_compat_class) {
1732 retval = -ENOMEM;
1733 goto bus_err;
1734 }
1735#endif
David Brownelle9f13732008-01-27 18:14:52 +01001736 retval = i2c_add_driver(&dummy_driver);
1737 if (retval)
Jean Delvare2bb50952009-09-18 22:45:46 +02001738 goto class_err;
Pantelis Antoniouea7513b2014-10-28 22:36:03 +02001739
1740 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
1741 WARN_ON(of_reconfig_notifier_register(&i2c_of_notifier));
Octavian Purdila525e6fa2016-07-08 19:13:10 +03001742 if (IS_ENABLED(CONFIG_ACPI))
1743 WARN_ON(acpi_reconfig_notifier_register(&i2c_acpi_notifier));
Pantelis Antoniouea7513b2014-10-28 22:36:03 +02001744
David Brownelle9f13732008-01-27 18:14:52 +01001745 return 0;
1746
Jean Delvare2bb50952009-09-18 22:45:46 +02001747class_err:
1748#ifdef CONFIG_I2C_COMPAT
1749 class_compat_unregister(i2c_adapter_compat_class);
David Brownelle9f13732008-01-27 18:14:52 +01001750bus_err:
Jean Delvare2bb50952009-09-18 22:45:46 +02001751#endif
Wolfram Sangb980a262016-03-14 10:41:52 +01001752 is_registered = false;
David Brownelle9f13732008-01-27 18:14:52 +01001753 bus_unregister(&i2c_bus_type);
1754 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755}
1756
1757static void __exit i2c_exit(void)
1758{
Octavian Purdila525e6fa2016-07-08 19:13:10 +03001759 if (IS_ENABLED(CONFIG_ACPI))
1760 WARN_ON(acpi_reconfig_notifier_unregister(&i2c_acpi_notifier));
Pantelis Antoniouea7513b2014-10-28 22:36:03 +02001761 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
1762 WARN_ON(of_reconfig_notifier_unregister(&i2c_of_notifier));
David Brownelle9f13732008-01-27 18:14:52 +01001763 i2c_del_driver(&dummy_driver);
Jean Delvare2bb50952009-09-18 22:45:46 +02001764#ifdef CONFIG_I2C_COMPAT
1765 class_compat_unregister(i2c_adapter_compat_class);
1766#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 bus_unregister(&i2c_bus_type);
David Howellsd9a83d62014-03-06 13:35:59 +00001768 tracepoint_synchronize_unregister();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769}
1770
David Brownella10f9e72008-10-14 17:30:06 +02001771/* We must initialize early, because some subsystems register i2c drivers
1772 * in subsys_initcall() code, but are linked (and initialized) before i2c.
1773 */
1774postcore_initcall(i2c_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775module_exit(i2c_exit);
1776
1777/* ----------------------------------------------------
1778 * the functional interface to the i2c busses.
1779 * ----------------------------------------------------
1780 */
1781
Wolfram Sangb7f62582015-01-05 23:45:59 +01001782/* Check if val is exceeding the quirk IFF quirk is non 0 */
1783#define i2c_quirk_exceeded(val, quirk) ((quirk) && ((val) > (quirk)))
1784
1785static int i2c_quirk_error(struct i2c_adapter *adap, struct i2c_msg *msg, char *err_msg)
1786{
1787 dev_err_ratelimited(&adap->dev, "adapter quirk: %s (addr 0x%04x, size %u, %s)\n",
1788 err_msg, msg->addr, msg->len,
1789 msg->flags & I2C_M_RD ? "read" : "write");
1790 return -EOPNOTSUPP;
1791}
1792
1793static int i2c_check_for_quirks(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1794{
1795 const struct i2c_adapter_quirks *q = adap->quirks;
1796 int max_num = q->max_num_msgs, i;
1797 bool do_len_check = true;
1798
1799 if (q->flags & I2C_AQ_COMB) {
1800 max_num = 2;
1801
1802 /* special checks for combined messages */
1803 if (num == 2) {
1804 if (q->flags & I2C_AQ_COMB_WRITE_FIRST && msgs[0].flags & I2C_M_RD)
1805 return i2c_quirk_error(adap, &msgs[0], "1st comb msg must be write");
1806
1807 if (q->flags & I2C_AQ_COMB_READ_SECOND && !(msgs[1].flags & I2C_M_RD))
1808 return i2c_quirk_error(adap, &msgs[1], "2nd comb msg must be read");
1809
1810 if (q->flags & I2C_AQ_COMB_SAME_ADDR && msgs[0].addr != msgs[1].addr)
1811 return i2c_quirk_error(adap, &msgs[0], "comb msg only to same addr");
1812
1813 if (i2c_quirk_exceeded(msgs[0].len, q->max_comb_1st_msg_len))
1814 return i2c_quirk_error(adap, &msgs[0], "msg too long");
1815
1816 if (i2c_quirk_exceeded(msgs[1].len, q->max_comb_2nd_msg_len))
1817 return i2c_quirk_error(adap, &msgs[1], "msg too long");
1818
1819 do_len_check = false;
1820 }
1821 }
1822
1823 if (i2c_quirk_exceeded(num, max_num))
1824 return i2c_quirk_error(adap, &msgs[0], "too many messages");
1825
1826 for (i = 0; i < num; i++) {
1827 u16 len = msgs[i].len;
1828
1829 if (msgs[i].flags & I2C_M_RD) {
1830 if (do_len_check && i2c_quirk_exceeded(len, q->max_read_len))
1831 return i2c_quirk_error(adap, &msgs[i], "msg too long");
Wolfram Sangd9cfe2c2018-07-23 22:26:05 +02001832
1833 if (q->flags & I2C_AQ_NO_ZERO_LEN_READ && len == 0)
1834 return i2c_quirk_error(adap, &msgs[i], "no zero length");
Wolfram Sangb7f62582015-01-05 23:45:59 +01001835 } else {
1836 if (do_len_check && i2c_quirk_exceeded(len, q->max_write_len))
1837 return i2c_quirk_error(adap, &msgs[i], "msg too long");
Wolfram Sangd9cfe2c2018-07-23 22:26:05 +02001838
1839 if (q->flags & I2C_AQ_NO_ZERO_LEN_WRITE && len == 0)
1840 return i2c_quirk_error(adap, &msgs[i], "no zero length");
Wolfram Sangb7f62582015-01-05 23:45:59 +01001841 }
1842 }
1843
1844 return 0;
1845}
1846
David Brownella1cdeda2008-07-14 22:38:24 +02001847/**
Jean Delvareb37d2a32012-06-29 07:47:19 -03001848 * __i2c_transfer - unlocked flavor of i2c_transfer
1849 * @adap: Handle to I2C bus
1850 * @msgs: One or more messages to execute before STOP is issued to
1851 * terminate the operation; each message begins with a START.
1852 * @num: Number of messages to be executed.
1853 *
1854 * Returns negative errno, else the number of messages executed.
1855 *
1856 * Adapter lock must be held when calling this function. No debug logging
1857 * takes place. adap->algo->master_xfer existence isn't checked.
1858 */
1859int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1860{
1861 unsigned long orig_jiffies;
1862 int ret, try;
1863
Ard Biesheuvel1eace832018-04-03 21:11:50 +02001864 if (WARN_ON(!msgs || num < 1))
1865 return -EINVAL;
1866
Wolfram Sangb7f62582015-01-05 23:45:59 +01001867 if (adap->quirks && i2c_check_for_quirks(adap, msgs, num))
1868 return -EOPNOTSUPP;
1869
Davidlohr Bueso50888b02018-03-26 14:09:24 -07001870 /*
1871 * i2c_trace_msg_key gets enabled when tracepoint i2c_transfer gets
David Howellsd9a83d62014-03-06 13:35:59 +00001872 * enabled. This is an efficient way of keeping the for-loop from
1873 * being executed when not needed.
1874 */
Davidlohr Bueso50888b02018-03-26 14:09:24 -07001875 if (static_branch_unlikely(&i2c_trace_msg_key)) {
David Howellsd9a83d62014-03-06 13:35:59 +00001876 int i;
1877 for (i = 0; i < num; i++)
1878 if (msgs[i].flags & I2C_M_RD)
1879 trace_i2c_read(adap, &msgs[i], i);
1880 else
1881 trace_i2c_write(adap, &msgs[i], i);
1882 }
1883
Jean Delvareb37d2a32012-06-29 07:47:19 -03001884 /* Retry automatically on arbitration loss */
1885 orig_jiffies = jiffies;
1886 for (ret = 0, try = 0; try <= adap->retries; try++) {
1887 ret = adap->algo->master_xfer(adap, msgs, num);
1888 if (ret != -EAGAIN)
1889 break;
1890 if (time_after(jiffies, orig_jiffies + adap->timeout))
1891 break;
1892 }
1893
Davidlohr Bueso50888b02018-03-26 14:09:24 -07001894 if (static_branch_unlikely(&i2c_trace_msg_key)) {
David Howellsd9a83d62014-03-06 13:35:59 +00001895 int i;
1896 for (i = 0; i < ret; i++)
1897 if (msgs[i].flags & I2C_M_RD)
1898 trace_i2c_reply(adap, &msgs[i], i);
Ahbong Chang4a3f7692018-03-31 16:17:34 +08001899 trace_i2c_result(adap, num, ret);
David Howellsd9a83d62014-03-06 13:35:59 +00001900 }
1901
Jean Delvareb37d2a32012-06-29 07:47:19 -03001902 return ret;
1903}
1904EXPORT_SYMBOL(__i2c_transfer);
1905
1906/**
David Brownella1cdeda2008-07-14 22:38:24 +02001907 * i2c_transfer - execute a single or combined I2C message
1908 * @adap: Handle to I2C bus
1909 * @msgs: One or more messages to execute before STOP is issued to
1910 * terminate the operation; each message begins with a START.
1911 * @num: Number of messages to be executed.
1912 *
1913 * Returns negative errno, else the number of messages executed.
1914 *
1915 * Note that there is no requirement that each message be sent to
1916 * the same slave address, although that is the most common model.
1917 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001918int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919{
Jean Delvareb37d2a32012-06-29 07:47:19 -03001920 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921
Wolfram Sangcc526122018-09-20 18:14:21 +02001922 if (!adap->algo->master_xfer) {
1923 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
1924 return -EOPNOTSUPP;
1925 }
1926
David Brownella1cdeda2008-07-14 22:38:24 +02001927 /* REVISIT the fault reporting model here is weak:
1928 *
1929 * - When we get an error after receiving N bytes from a slave,
1930 * there is no way to report "N".
1931 *
1932 * - When we get a NAK after transmitting N bytes to a slave,
1933 * there is no way to report "N" ... or to let the master
1934 * continue executing the rest of this combined message, if
1935 * that's the appropriate response.
1936 *
1937 * - When for example "num" is two and we successfully complete
1938 * the first message but get an error part way through the
1939 * second, it's unclear whether that should be reported as
1940 * one (discarding status on the second message) or errno
1941 * (discarding status on the first one).
1942 */
Wolfram Sangcc526122018-09-20 18:14:21 +02001943 if (in_atomic() || irqs_disabled()) {
1944 ret = i2c_trylock_bus(adap, I2C_LOCK_SEGMENT);
1945 if (!ret)
1946 /* I2C activity is ongoing. */
1947 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 } else {
Wolfram Sangcc526122018-09-20 18:14:21 +02001949 i2c_lock_bus(adap, I2C_LOCK_SEGMENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 }
Wolfram Sangcc526122018-09-20 18:14:21 +02001951
1952 ret = __i2c_transfer(adap, msgs, num);
1953 i2c_unlock_bus(adap, I2C_LOCK_SEGMENT);
1954
1955 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956}
David Brownellc0564602007-05-01 23:26:31 +02001957EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958
David Brownella1cdeda2008-07-14 22:38:24 +02001959/**
Wolfram Sang8a917322017-11-04 21:20:04 +01001960 * i2c_transfer_buffer_flags - issue a single I2C message transferring data
1961 * to/from a buffer
David Brownella1cdeda2008-07-14 22:38:24 +02001962 * @client: Handle to slave device
Wolfram Sang8a917322017-11-04 21:20:04 +01001963 * @buf: Where the data is stored
1964 * @count: How many bytes to transfer, must be less than 64k since msg.len is u16
1965 * @flags: The flags to be used for the message, e.g. I2C_M_RD for reads
David Brownella1cdeda2008-07-14 22:38:24 +02001966 *
Wolfram Sang8a917322017-11-04 21:20:04 +01001967 * Returns negative errno, or else the number of bytes transferred.
David Brownella1cdeda2008-07-14 22:38:24 +02001968 */
Wolfram Sang8a917322017-11-04 21:20:04 +01001969int i2c_transfer_buffer_flags(const struct i2c_client *client, char *buf,
1970 int count, u16 flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971{
1972 int ret;
Wolfram Sang8a917322017-11-04 21:20:04 +01001973 struct i2c_msg msg = {
1974 .addr = client->addr,
1975 .flags = flags | (client->flags & I2C_M_TEN),
1976 .len = count,
1977 .buf = buf,
1978 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
Wolfram Sang8a917322017-11-04 21:20:04 +01001980 ret = i2c_transfer(client->adapter, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981
Wolfram Sang834aa6f2012-03-15 18:11:05 +01001982 /*
Wolfram Sang8a917322017-11-04 21:20:04 +01001983 * If everything went ok (i.e. 1 msg transferred), return #bytes
1984 * transferred, else error code.
Wolfram Sang834aa6f2012-03-15 18:11:05 +01001985 */
Jean Delvare815f55f2005-05-07 22:58:46 +02001986 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987}
Wolfram Sang8a917322017-11-04 21:20:04 +01001988EXPORT_SYMBOL(i2c_transfer_buffer_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
Peter Rosindde67eb2018-01-22 08:32:01 +01001990/**
1991 * i2c_get_device_id - get manufacturer, part id and die revision of a device
1992 * @client: The device to query
1993 * @id: The queried information
1994 *
1995 * Returns negative errno on error, zero on success.
1996 */
1997int i2c_get_device_id(const struct i2c_client *client,
1998 struct i2c_device_identity *id)
1999{
2000 struct i2c_adapter *adap = client->adapter;
2001 union i2c_smbus_data raw_id;
2002 int ret;
2003
2004 if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_I2C_BLOCK))
2005 return -EOPNOTSUPP;
2006
2007 raw_id.block[0] = 3;
2008 ret = i2c_smbus_xfer(adap, I2C_ADDR_DEVICE_ID, 0,
2009 I2C_SMBUS_READ, client->addr << 1,
2010 I2C_SMBUS_I2C_BLOCK_DATA, &raw_id);
2011 if (ret)
2012 return ret;
2013
2014 id->manufacturer_id = (raw_id.block[1] << 4) | (raw_id.block[2] >> 4);
2015 id->part_id = ((raw_id.block[2] & 0xf) << 5) | (raw_id.block[3] >> 3);
2016 id->die_revision = raw_id.block[3] & 0x7;
2017 return 0;
2018}
2019EXPORT_SYMBOL_GPL(i2c_get_device_id);
2020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021/* ----------------------------------------------------
2022 * the i2c address scanning function
2023 * Will not work for 10-bit addresses!
2024 * ----------------------------------------------------
2025 */
Jean Delvare9fc6adf2005-07-31 21:20:43 +02002026
Jean Delvare63e4e802010-06-03 11:33:51 +02002027/*
2028 * Legacy default probe function, mostly relevant for SMBus. The default
2029 * probe method is a quick write, but it is known to corrupt the 24RF08
2030 * EEPROMs due to a state machine bug, and could also irreversibly
2031 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
2032 * we use a short byte read instead. Also, some bus drivers don't implement
2033 * quick write, so we fallback to a byte read in that case too.
2034 * On x86, there is another special case for FSC hardware monitoring chips,
2035 * which want regular byte reads (address 0x73.) Fortunately, these are the
2036 * only known chips using this I2C address on PC hardware.
2037 * Returns 1 if probe succeeded, 0 if not.
2038 */
2039static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
2040{
2041 int err;
2042 union i2c_smbus_data dummy;
2043
2044#ifdef CONFIG_X86
2045 if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
2046 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
2047 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
2048 I2C_SMBUS_BYTE_DATA, &dummy);
2049 else
2050#endif
Jean Delvare8031d792010-08-11 18:21:00 +02002051 if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
2052 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
Jean Delvare63e4e802010-06-03 11:33:51 +02002053 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
2054 I2C_SMBUS_QUICK, NULL);
Jean Delvare8031d792010-08-11 18:21:00 +02002055 else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
2056 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
2057 I2C_SMBUS_BYTE, &dummy);
2058 else {
Andy Lutomirskid63a9e82013-07-17 13:27:59 -07002059 dev_warn(&adap->dev, "No suitable probing method supported for address 0x%02X\n",
2060 addr);
Jean Delvare8031d792010-08-11 18:21:00 +02002061 err = -EOPNOTSUPP;
2062 }
Jean Delvare63e4e802010-06-03 11:33:51 +02002063
2064 return err >= 0;
2065}
2066
Jean Delvareccfbbd02009-12-06 17:06:25 +01002067static int i2c_detect_address(struct i2c_client *temp_client,
Jean Delvare4735c982008-07-14 22:38:36 +02002068 struct i2c_driver *driver)
2069{
2070 struct i2c_board_info info;
2071 struct i2c_adapter *adapter = temp_client->adapter;
2072 int addr = temp_client->addr;
2073 int err;
2074
2075 /* Make sure the address is valid */
Wolfram Sang66be60562015-07-17 12:43:22 +02002076 err = i2c_check_7bit_addr_validity_strict(addr);
Jean Delvare656b8762010-06-03 11:33:53 +02002077 if (err) {
Jean Delvare4735c982008-07-14 22:38:36 +02002078 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
2079 addr);
Jean Delvare656b8762010-06-03 11:33:53 +02002080 return err;
Jean Delvare4735c982008-07-14 22:38:36 +02002081 }
2082
Wolfram Sang9bccc702015-07-17 14:48:56 +02002083 /* Skip if already in use (7 bit, no need to encode flags) */
Jean Delvare3b5f7942010-06-03 11:33:55 +02002084 if (i2c_check_addr_busy(adapter, addr))
Jean Delvare4735c982008-07-14 22:38:36 +02002085 return 0;
2086
Jean Delvareccfbbd02009-12-06 17:06:25 +01002087 /* Make sure there is something at this address */
Jean Delvare63e4e802010-06-03 11:33:51 +02002088 if (!i2c_default_probe(adapter, addr))
2089 return 0;
Jean Delvare4735c982008-07-14 22:38:36 +02002090
2091 /* Finally call the custom detection function */
2092 memset(&info, 0, sizeof(struct i2c_board_info));
2093 info.addr = addr;
Jean Delvare310ec792009-12-14 21:17:23 +01002094 err = driver->detect(temp_client, &info);
Jean Delvare4735c982008-07-14 22:38:36 +02002095 if (err) {
2096 /* -ENODEV is returned if the detection fails. We catch it
2097 here as this isn't an error. */
2098 return err == -ENODEV ? 0 : err;
2099 }
2100
2101 /* Consistency check */
2102 if (info.type[0] == '\0') {
Andy Shevchenkob93d3d32016-08-25 17:42:10 +03002103 dev_err(&adapter->dev,
2104 "%s detection function provided no name for 0x%x\n",
2105 driver->driver.name, addr);
Jean Delvare4735c982008-07-14 22:38:36 +02002106 } else {
2107 struct i2c_client *client;
2108
2109 /* Detection succeeded, instantiate the device */
Wolfram Sang0c176172014-02-10 11:03:56 +01002110 if (adapter->class & I2C_CLASS_DEPRECATED)
2111 dev_warn(&adapter->dev,
2112 "This adapter will soon drop class based instantiation of devices. "
2113 "Please make sure client 0x%02x gets instantiated by other means. "
2114 "Check 'Documentation/i2c/instantiating-devices' for details.\n",
2115 info.addr);
2116
Jean Delvare4735c982008-07-14 22:38:36 +02002117 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
2118 info.type, info.addr);
2119 client = i2c_new_device(adapter, &info);
2120 if (client)
2121 list_add_tail(&client->detected, &driver->clients);
2122 else
2123 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
2124 info.type, info.addr);
2125 }
2126 return 0;
2127}
2128
2129static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
2130{
Jean Delvarec3813d62009-12-14 21:17:25 +01002131 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +02002132 struct i2c_client *temp_client;
2133 int i, err = 0;
2134 int adap_id = i2c_adapter_id(adapter);
2135
Jean Delvarec3813d62009-12-14 21:17:25 +01002136 address_list = driver->address_list;
2137 if (!driver->detect || !address_list)
Jean Delvare4735c982008-07-14 22:38:36 +02002138 return 0;
2139
Wolfram Sang45552272014-07-10 13:46:21 +02002140 /* Warn that the adapter lost class based instantiation */
2141 if (adapter->class == I2C_CLASS_DEPRECATED) {
2142 dev_dbg(&adapter->dev,
Andy Shevchenkob93d3d32016-08-25 17:42:10 +03002143 "This adapter dropped support for I2C classes and won't auto-detect %s devices anymore. "
2144 "If you need it, check 'Documentation/i2c/instantiating-devices' for alternatives.\n",
Wolfram Sang45552272014-07-10 13:46:21 +02002145 driver->driver.name);
2146 return 0;
2147 }
2148
Jean Delvare51b54ba2010-10-24 18:16:58 +02002149 /* Stop here if the classes do not match */
2150 if (!(adapter->class & driver->class))
2151 return 0;
2152
Jean Delvare4735c982008-07-14 22:38:36 +02002153 /* Set up a temporary client to help detect callback */
2154 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
2155 if (!temp_client)
2156 return -ENOMEM;
2157 temp_client->adapter = adapter;
2158
Jean Delvarec3813d62009-12-14 21:17:25 +01002159 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
Andy Shevchenkob93d3d32016-08-25 17:42:10 +03002160 dev_dbg(&adapter->dev,
2161 "found normal entry for adapter %d, addr 0x%02x\n",
2162 adap_id, address_list[i]);
Jean Delvarec3813d62009-12-14 21:17:25 +01002163 temp_client->addr = address_list[i];
Jean Delvareccfbbd02009-12-06 17:06:25 +01002164 err = i2c_detect_address(temp_client, driver);
Jean Delvare51b54ba2010-10-24 18:16:58 +02002165 if (unlikely(err))
2166 break;
Jean Delvare4735c982008-07-14 22:38:36 +02002167 }
2168
Jean Delvare4735c982008-07-14 22:38:36 +02002169 kfree(temp_client);
2170 return err;
2171}
2172
Jean Delvared44f19d2010-08-11 18:20:57 +02002173int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
2174{
2175 return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
2176 I2C_SMBUS_QUICK, NULL) >= 0;
2177}
2178EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);
2179
Jean Delvare12b5053a2007-05-01 23:26:31 +02002180struct i2c_client *
2181i2c_new_probed_device(struct i2c_adapter *adap,
2182 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +02002183 unsigned short const *addr_list,
2184 int (*probe)(struct i2c_adapter *, unsigned short addr))
Jean Delvare12b5053a2007-05-01 23:26:31 +02002185{
2186 int i;
2187
Jean Delvare8031d792010-08-11 18:21:00 +02002188 if (!probe)
Jean Delvare9a942412010-08-11 18:20:56 +02002189 probe = i2c_default_probe;
Jean Delvare12b5053a2007-05-01 23:26:31 +02002190
Jean Delvare12b5053a2007-05-01 23:26:31 +02002191 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
2192 /* Check address validity */
Wolfram Sang66be60562015-07-17 12:43:22 +02002193 if (i2c_check_7bit_addr_validity_strict(addr_list[i]) < 0) {
Andy Shevchenkob93d3d32016-08-25 17:42:10 +03002194 dev_warn(&adap->dev, "Invalid 7-bit address 0x%02x\n",
2195 addr_list[i]);
Jean Delvare12b5053a2007-05-01 23:26:31 +02002196 continue;
2197 }
2198
Wolfram Sang9bccc702015-07-17 14:48:56 +02002199 /* Check address availability (7 bit, no need to encode flags) */
Jean Delvare3b5f7942010-06-03 11:33:55 +02002200 if (i2c_check_addr_busy(adap, addr_list[i])) {
Andy Shevchenkob93d3d32016-08-25 17:42:10 +03002201 dev_dbg(&adap->dev,
2202 "Address 0x%02x already in use, not probing\n",
2203 addr_list[i]);
Jean Delvare12b5053a2007-05-01 23:26:31 +02002204 continue;
2205 }
2206
Jean Delvare63e4e802010-06-03 11:33:51 +02002207 /* Test address responsiveness */
Jean Delvare9a942412010-08-11 18:20:56 +02002208 if (probe(adap, addr_list[i]))
Jean Delvare63e4e802010-06-03 11:33:51 +02002209 break;
Jean Delvare12b5053a2007-05-01 23:26:31 +02002210 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02002211
2212 if (addr_list[i] == I2C_CLIENT_END) {
2213 dev_dbg(&adap->dev, "Probing failed, no device found\n");
2214 return NULL;
2215 }
2216
2217 info->addr = addr_list[i];
2218 return i2c_new_device(adap, info);
2219}
2220EXPORT_SYMBOL_GPL(i2c_new_probed_device);
2221
Jean Delvared735b342011-03-20 14:50:52 +01002222struct i2c_adapter *i2c_get_adapter(int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01002225
Jean Delvarecaada322008-01-27 18:14:49 +01002226 mutex_lock(&core_lock);
Jean Delvared735b342011-03-20 14:50:52 +01002227 adapter = idr_find(&i2c_adapter_idr, nr);
Vladimir Zapolskiy611e12e2015-07-27 17:30:49 +03002228 if (!adapter)
2229 goto exit;
2230
2231 if (try_module_get(adapter->owner))
2232 get_device(&adapter->dev);
2233 else
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04002234 adapter = NULL;
2235
Vladimir Zapolskiy611e12e2015-07-27 17:30:49 +03002236 exit:
Jean Delvarecaada322008-01-27 18:14:49 +01002237 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04002238 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239}
David Brownellc0564602007-05-01 23:26:31 +02002240EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241
2242void i2c_put_adapter(struct i2c_adapter *adap)
2243{
Vladimir Zapolskiy611e12e2015-07-27 17:30:49 +03002244 if (!adap)
2245 return;
2246
2247 put_device(&adap->dev);
2248 module_put(adap->owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249}
David Brownellc0564602007-05-01 23:26:31 +02002250EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251
Wolfram Sange94bc5d2017-11-04 21:20:02 +01002252/**
2253 * i2c_get_dma_safe_msg_buf() - get a DMA safe buffer for the given i2c_msg
2254 * @msg: the message to be checked
2255 * @threshold: the minimum number of bytes for which using DMA makes sense
2256 *
2257 * Return: NULL if a DMA safe buffer was not obtained. Use msg->buf with PIO.
2258 * Or a valid pointer to be used with DMA. After use, release it by
Stephen Boyd34d1b822018-10-08 07:55:20 -07002259 * calling i2c_put_dma_safe_msg_buf().
Wolfram Sange94bc5d2017-11-04 21:20:02 +01002260 *
2261 * This function must only be called from process context!
2262 */
2263u8 *i2c_get_dma_safe_msg_buf(struct i2c_msg *msg, unsigned int threshold)
2264{
2265 if (msg->len < threshold)
2266 return NULL;
2267
2268 if (msg->flags & I2C_M_DMA_SAFE)
2269 return msg->buf;
2270
2271 pr_debug("using bounce buffer for addr=0x%02x, len=%d\n",
2272 msg->addr, msg->len);
2273
2274 if (msg->flags & I2C_M_RD)
2275 return kzalloc(msg->len, GFP_KERNEL);
2276 else
2277 return kmemdup(msg->buf, msg->len, GFP_KERNEL);
2278}
2279EXPORT_SYMBOL_GPL(i2c_get_dma_safe_msg_buf);
2280
2281/**
Wolfram Sang82fe39a2018-08-24 16:52:44 +02002282 * i2c_put_dma_safe_msg_buf - release DMA safe buffer and sync with i2c_msg
Wolfram Sange94bc5d2017-11-04 21:20:02 +01002283 * @buf: the buffer obtained from i2c_get_dma_safe_msg_buf(). May be NULL.
Wolfram Sang82fe39a2018-08-24 16:52:44 +02002284 * @msg: the message which the buffer corresponds to
2285 * @xferred: bool saying if the message was transferred
Wolfram Sange94bc5d2017-11-04 21:20:02 +01002286 */
Wolfram Sang82fe39a2018-08-24 16:52:44 +02002287void i2c_put_dma_safe_msg_buf(u8 *buf, struct i2c_msg *msg, bool xferred)
Wolfram Sange94bc5d2017-11-04 21:20:02 +01002288{
2289 if (!buf || buf == msg->buf)
2290 return;
2291
Wolfram Sang82fe39a2018-08-24 16:52:44 +02002292 if (xferred && msg->flags & I2C_M_RD)
Wolfram Sange94bc5d2017-11-04 21:20:02 +01002293 memcpy(msg->buf, buf, msg->len);
2294
2295 kfree(buf);
2296}
Wolfram Sang82fe39a2018-08-24 16:52:44 +02002297EXPORT_SYMBOL_GPL(i2c_put_dma_safe_msg_buf);
Wolfram Sange94bc5d2017-11-04 21:20:02 +01002298
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
2300MODULE_DESCRIPTION("I2C-Bus main module");
2301MODULE_LICENSE("GPL");