blob: 7ef5bd085476c78e5e03f3ea5a0270b1ade1dcb2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* i2c-core.c - a device driver for the iic-bus interface */
2/* ------------------------------------------------------------------------- */
3/* Copyright (C) 1995-99 Simon G. Vogl
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Wolfram Sangca1f8da2014-11-04 23:46:27 +010013 GNU General Public License for more details. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070014/* ------------------------------------------------------------------------- */
15
Jan Engelhardt96de0e22007-10-19 23:21:04 +020016/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>.
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
Jean Delvare421ef472005-10-26 21:28:55 +020018 SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
Jean Delvare7c81c602014-01-29 20:40:08 +010019 Jean Delvare <jdelvare@suse.de>
Michael Lawnick08263742010-08-11 18:21:02 +020020 Mux support by Rodolfo Giometti <giometti@enneenne.com> and
Wolfram Sang687b81d2013-07-11 12:56:15 +010021 Michael Lawnick <michael.lawnick.ext@nsn.com>
22 OF support is copyright (c) 2008 Jochen Friedrich <jochen@scram.de>
23 (based on a previous patch from Jon Smirl <jonsmirl@gmail.com>) and
24 (c) 2013 Wolfram Sang <wsa@the-dreams.de>
Wolfram Sang17f4a5c2014-09-22 19:41:00 +020025 I2C ACPI code Copyright (C) 2014 Intel Corp
26 Author: Lan Tianyu <tianyu.lan@intel.com>
Wolfram Sang4b1acc42014-11-18 17:04:53 +010027 I2C slave support (c) 2014 by Wolfram Sang <wsa@sang-engineering.com>
Wolfram Sang687b81d2013-07-11 12:56:15 +010028 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Wolfram Sangb4e2f6a2015-05-19 21:04:40 +020030#include <dt-bindings/i2c/i2c.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010031#include <asm/uaccess.h>
32#include <linux/acpi.h>
Sylwester Nawrocki86be4082014-06-18 17:29:32 +020033#include <linux/clk/clk-conf.h>
Jean Delvareb8d6f452007-02-13 22:09:00 +010034#include <linux/completion.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010035#include <linux/delay.h>
Pantelis Antonioua430a3452014-10-28 22:36:02 +020036#include <linux/err.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010037#include <linux/errno.h>
38#include <linux/gpio.h>
39#include <linux/hardirq.h>
40#include <linux/i2c.h>
41#include <linux/idr.h>
42#include <linux/init.h>
43#include <linux/irqflags.h>
44#include <linux/jump_label.h>
45#include <linux/kernel.h>
46#include <linux/module.h>
47#include <linux/mutex.h>
48#include <linux/of_device.h>
49#include <linux/of.h>
50#include <linux/of_irq.h>
51#include <linux/pm_domain.h>
52#include <linux/pm_runtime.h>
53#include <linux/pm_wakeirq.h>
Wolfram Sange1dba012015-12-08 10:37:46 +010054#include <linux/property.h>
Wolfram Sang53feedf2016-02-20 23:33:38 +010055#include <linux/rwsem.h>
56#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
David Brownell9c1600e2007-05-01 23:26:31 +020058#include "i2c-core.h"
59
David Howellsd9a83d62014-03-06 13:35:59 +000060#define CREATE_TRACE_POINTS
61#include <trace/events/i2c.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Wolfram Sangda899f52015-05-18 21:09:12 +020063#define I2C_ADDR_OFFSET_TEN_BIT 0xa000
64#define I2C_ADDR_OFFSET_SLAVE 0x1000
65
Jean Delvare6629dcf2010-05-04 11:09:28 +020066/* core_lock protects i2c_adapter_idr, and guarantees
Jean Delvare35fc37f2009-06-19 16:58:19 +020067 that device detection, deletion of detected devices, and attach_adapter
Lars-Peter Clausen19baba42013-03-09 08:16:44 +000068 calls are serialized */
Jean Delvarecaada322008-01-27 18:14:49 +010069static DEFINE_MUTEX(core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070static DEFINE_IDR(i2c_adapter_idr);
71
Jean Delvare4f8cf822009-09-18 22:45:46 +020072static struct device_type i2c_client_type;
Jean Delvare4735c982008-07-14 22:38:36 +020073static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
David Brownellf37dd802007-02-13 22:09:00 +010074
David Howellsd9a83d62014-03-06 13:35:59 +000075static struct static_key i2c_trace_msg = STATIC_KEY_INIT_FALSE;
Sudip Mukherjee95026652016-03-07 17:19:17 +053076static bool is_registered;
David Howellsd9a83d62014-03-06 13:35:59 +000077
78void i2c_transfer_trace_reg(void)
79{
80 static_key_slow_inc(&i2c_trace_msg);
81}
82
83void i2c_transfer_trace_unreg(void)
84{
85 static_key_slow_dec(&i2c_trace_msg);
86}
87
Wolfram Sang17f4a5c2014-09-22 19:41:00 +020088#if defined(CONFIG_ACPI)
89struct acpi_i2c_handler_data {
90 struct acpi_connection_info info;
91 struct i2c_adapter *adapter;
92};
93
94struct gsb_buffer {
95 u8 status;
96 u8 len;
97 union {
98 u16 wdata;
99 u8 bdata;
100 u8 data[0];
101 };
102} __packed;
103
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300104struct acpi_i2c_lookup {
105 struct i2c_board_info *info;
106 acpi_handle adapter_handle;
107 acpi_handle device_handle;
108};
109
110static int acpi_i2c_find_address(struct acpi_resource *ares, void *data)
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200111{
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300112 struct acpi_i2c_lookup *lookup = data;
113 struct i2c_board_info *info = lookup->info;
114 struct acpi_resource_i2c_serialbus *sb;
115 acpi_handle adapter_handle;
116 acpi_status status;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200117
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300118 if (info->addr || ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
119 return 1;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200120
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300121 sb = &ares->data.i2c_serial_bus;
122 if (sb->type != ACPI_RESOURCE_SERIAL_TYPE_I2C)
123 return 1;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200124
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300125 /*
126 * Extract the ResourceSource and make sure that the handle matches
127 * with the I2C adapter handle.
128 */
129 status = acpi_get_handle(lookup->device_handle,
130 sb->resource_source.string_ptr,
131 &adapter_handle);
132 if (ACPI_SUCCESS(status) && adapter_handle == lookup->adapter_handle) {
133 info->addr = sb->slave_address;
134 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
135 info->flags |= I2C_CLIENT_TEN;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200136 }
137
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200138 return 1;
139}
140
141static acpi_status acpi_i2c_add_device(acpi_handle handle, u32 level,
142 void *data, void **return_value)
143{
144 struct i2c_adapter *adapter = data;
145 struct list_head resource_list;
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300146 struct acpi_i2c_lookup lookup;
147 struct resource_entry *entry;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200148 struct i2c_board_info info;
149 struct acpi_device *adev;
150 int ret;
151
152 if (acpi_bus_get_device(handle, &adev))
153 return AE_OK;
154 if (acpi_bus_get_status(adev) || !adev->status.present)
155 return AE_OK;
156
157 memset(&info, 0, sizeof(info));
Rafael J. Wysockice793482015-03-16 23:49:03 +0100158 info.fwnode = acpi_fwnode_handle(adev);
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200159
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300160 memset(&lookup, 0, sizeof(lookup));
Dustin Byford8eb5c872015-10-23 12:27:07 -0700161 lookup.adapter_handle = ACPI_HANDLE(&adapter->dev);
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300162 lookup.device_handle = handle;
163 lookup.info = &info;
164
165 /*
166 * Look up for I2cSerialBus resource with ResourceSource that
167 * matches with this adapter.
168 */
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200169 INIT_LIST_HEAD(&resource_list);
170 ret = acpi_dev_get_resources(adev, &resource_list,
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300171 acpi_i2c_find_address, &lookup);
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200172 acpi_dev_free_resource_list(&resource_list);
173
174 if (ret < 0 || !info.addr)
175 return AE_OK;
176
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300177 /* Then fill IRQ number if any */
178 ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
179 if (ret < 0)
180 return AE_OK;
181
182 resource_list_for_each_entry(entry, &resource_list) {
183 if (resource_type(entry->res) == IORESOURCE_IRQ) {
184 info.irq = entry->res->start;
185 break;
186 }
187 }
188
189 acpi_dev_free_resource_list(&resource_list);
190
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200191 adev->power.flags.ignore_parent = true;
192 strlcpy(info.type, dev_name(&adev->dev), sizeof(info.type));
193 if (!i2c_new_device(adapter, &info)) {
194 adev->power.flags.ignore_parent = false;
195 dev_err(&adapter->dev,
196 "failed to add I2C device %s from ACPI\n",
197 dev_name(&adev->dev));
198 }
199
200 return AE_OK;
201}
202
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300203#define ACPI_I2C_MAX_SCAN_DEPTH 32
204
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200205/**
206 * acpi_i2c_register_devices - enumerate I2C slave devices behind adapter
207 * @adap: pointer to adapter
208 *
209 * Enumerate all I2C slave devices behind this adapter by walking the ACPI
210 * namespace. When a device is found it will be added to the Linux device
211 * model and bound to the corresponding ACPI handle.
212 */
213static void acpi_i2c_register_devices(struct i2c_adapter *adap)
214{
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200215 acpi_status status;
216
Dustin Byford8eb5c872015-10-23 12:27:07 -0700217 if (!has_acpi_companion(&adap->dev))
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200218 return;
219
Mika Westerberg166c2ba2015-10-07 13:18:44 +0300220 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
221 ACPI_I2C_MAX_SCAN_DEPTH,
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200222 acpi_i2c_add_device, NULL,
223 adap, NULL);
224 if (ACPI_FAILURE(status))
225 dev_warn(&adap->dev, "failed to enumerate I2C slaves\n");
226}
227
228#else /* CONFIG_ACPI */
229static inline void acpi_i2c_register_devices(struct i2c_adapter *adap) { }
230#endif /* CONFIG_ACPI */
231
232#ifdef CONFIG_ACPI_I2C_OPREGION
233static int acpi_gsb_i2c_read_bytes(struct i2c_client *client,
234 u8 cmd, u8 *data, u8 data_len)
235{
236
237 struct i2c_msg msgs[2];
238 int ret;
239 u8 *buffer;
240
241 buffer = kzalloc(data_len, GFP_KERNEL);
242 if (!buffer)
243 return AE_NO_MEMORY;
244
245 msgs[0].addr = client->addr;
246 msgs[0].flags = client->flags;
247 msgs[0].len = 1;
248 msgs[0].buf = &cmd;
249
250 msgs[1].addr = client->addr;
251 msgs[1].flags = client->flags | I2C_M_RD;
252 msgs[1].len = data_len;
253 msgs[1].buf = buffer;
254
255 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
256 if (ret < 0)
257 dev_err(&client->adapter->dev, "i2c read failed\n");
258 else
259 memcpy(data, buffer, data_len);
260
261 kfree(buffer);
262 return ret;
263}
264
265static int acpi_gsb_i2c_write_bytes(struct i2c_client *client,
266 u8 cmd, u8 *data, u8 data_len)
267{
268
269 struct i2c_msg msgs[1];
270 u8 *buffer;
271 int ret = AE_OK;
272
273 buffer = kzalloc(data_len + 1, GFP_KERNEL);
274 if (!buffer)
275 return AE_NO_MEMORY;
276
277 buffer[0] = cmd;
278 memcpy(buffer + 1, data, data_len);
279
280 msgs[0].addr = client->addr;
281 msgs[0].flags = client->flags;
282 msgs[0].len = data_len + 1;
283 msgs[0].buf = buffer;
284
285 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
286 if (ret < 0)
287 dev_err(&client->adapter->dev, "i2c write failed\n");
288
289 kfree(buffer);
290 return ret;
291}
292
293static acpi_status
294acpi_i2c_space_handler(u32 function, acpi_physical_address command,
295 u32 bits, u64 *value64,
296 void *handler_context, void *region_context)
297{
298 struct gsb_buffer *gsb = (struct gsb_buffer *)value64;
299 struct acpi_i2c_handler_data *data = handler_context;
300 struct acpi_connection_info *info = &data->info;
301 struct acpi_resource_i2c_serialbus *sb;
302 struct i2c_adapter *adapter = data->adapter;
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300303 struct i2c_client *client;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200304 struct acpi_resource *ares;
305 u32 accessor_type = function >> 16;
306 u8 action = function & ACPI_IO_MASK;
Wolfram Sang4470c722014-11-18 15:12:43 +0100307 acpi_status ret;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200308 int status;
309
310 ret = acpi_buffer_to_resource(info->connection, info->length, &ares);
311 if (ACPI_FAILURE(ret))
312 return ret;
313
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300314 client = kzalloc(sizeof(*client), GFP_KERNEL);
315 if (!client) {
316 ret = AE_NO_MEMORY;
317 goto err;
318 }
319
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200320 if (!value64 || ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS) {
321 ret = AE_BAD_PARAMETER;
322 goto err;
323 }
324
325 sb = &ares->data.i2c_serial_bus;
326 if (sb->type != ACPI_RESOURCE_SERIAL_TYPE_I2C) {
327 ret = AE_BAD_PARAMETER;
328 goto err;
329 }
330
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300331 client->adapter = adapter;
332 client->addr = sb->slave_address;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200333
334 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300335 client->flags |= I2C_CLIENT_TEN;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200336
337 switch (accessor_type) {
338 case ACPI_GSB_ACCESS_ATTRIB_SEND_RCV:
339 if (action == ACPI_READ) {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300340 status = i2c_smbus_read_byte(client);
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200341 if (status >= 0) {
342 gsb->bdata = status;
343 status = 0;
344 }
345 } else {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300346 status = i2c_smbus_write_byte(client, gsb->bdata);
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200347 }
348 break;
349
350 case ACPI_GSB_ACCESS_ATTRIB_BYTE:
351 if (action == ACPI_READ) {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300352 status = i2c_smbus_read_byte_data(client, command);
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200353 if (status >= 0) {
354 gsb->bdata = status;
355 status = 0;
356 }
357 } else {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300358 status = i2c_smbus_write_byte_data(client, command,
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200359 gsb->bdata);
360 }
361 break;
362
363 case ACPI_GSB_ACCESS_ATTRIB_WORD:
364 if (action == ACPI_READ) {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300365 status = i2c_smbus_read_word_data(client, command);
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200366 if (status >= 0) {
367 gsb->wdata = status;
368 status = 0;
369 }
370 } else {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300371 status = i2c_smbus_write_word_data(client, command,
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200372 gsb->wdata);
373 }
374 break;
375
376 case ACPI_GSB_ACCESS_ATTRIB_BLOCK:
377 if (action == ACPI_READ) {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300378 status = i2c_smbus_read_block_data(client, command,
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200379 gsb->data);
380 if (status >= 0) {
381 gsb->len = status;
382 status = 0;
383 }
384 } else {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300385 status = i2c_smbus_write_block_data(client, command,
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200386 gsb->len, gsb->data);
387 }
388 break;
389
390 case ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE:
391 if (action == ACPI_READ) {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300392 status = acpi_gsb_i2c_read_bytes(client, command,
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200393 gsb->data, info->access_length);
394 if (status > 0)
395 status = 0;
396 } else {
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300397 status = acpi_gsb_i2c_write_bytes(client, command,
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200398 gsb->data, info->access_length);
399 }
400 break;
401
402 default:
403 pr_info("protocol(0x%02x) is not supported.\n", accessor_type);
404 ret = AE_BAD_PARAMETER;
405 goto err;
406 }
407
408 gsb->status = status;
409
410 err:
Jarkko Nikula7ef85f52015-05-20 16:36:52 +0300411 kfree(client);
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200412 ACPI_FREE(ares);
413 return ret;
414}
415
416
417static int acpi_i2c_install_space_handler(struct i2c_adapter *adapter)
418{
Peter Hüwe0aef44e2014-09-12 21:09:47 +0200419 acpi_handle handle;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200420 struct acpi_i2c_handler_data *data;
421 acpi_status status;
422
Peter Hüwe0aef44e2014-09-12 21:09:47 +0200423 if (!adapter->dev.parent)
424 return -ENODEV;
425
426 handle = ACPI_HANDLE(adapter->dev.parent);
427
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200428 if (!handle)
429 return -ENODEV;
430
431 data = kzalloc(sizeof(struct acpi_i2c_handler_data),
432 GFP_KERNEL);
433 if (!data)
434 return -ENOMEM;
435
436 data->adapter = adapter;
437 status = acpi_bus_attach_private_data(handle, (void *)data);
438 if (ACPI_FAILURE(status)) {
439 kfree(data);
440 return -ENOMEM;
441 }
442
443 status = acpi_install_address_space_handler(handle,
444 ACPI_ADR_SPACE_GSBUS,
445 &acpi_i2c_space_handler,
446 NULL,
447 data);
448 if (ACPI_FAILURE(status)) {
449 dev_err(&adapter->dev, "Error installing i2c space handler\n");
450 acpi_bus_detach_private_data(handle);
451 kfree(data);
452 return -ENOMEM;
453 }
454
Lan Tianyu40e7fcb2014-11-23 21:22:54 +0800455 acpi_walk_dep_device_list(handle);
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200456 return 0;
457}
458
459static void acpi_i2c_remove_space_handler(struct i2c_adapter *adapter)
460{
Peter Hüwe0aef44e2014-09-12 21:09:47 +0200461 acpi_handle handle;
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200462 struct acpi_i2c_handler_data *data;
463 acpi_status status;
464
Peter Hüwe0aef44e2014-09-12 21:09:47 +0200465 if (!adapter->dev.parent)
466 return;
467
468 handle = ACPI_HANDLE(adapter->dev.parent);
469
Wolfram Sang17f4a5c2014-09-22 19:41:00 +0200470 if (!handle)
471 return;
472
473 acpi_remove_address_space_handler(handle,
474 ACPI_ADR_SPACE_GSBUS,
475 &acpi_i2c_space_handler);
476
477 status = acpi_bus_get_private_data(handle, (void **)&data);
478 if (ACPI_SUCCESS(status))
479 kfree(data);
480
481 acpi_bus_detach_private_data(handle);
482}
483#else /* CONFIG_ACPI_I2C_OPREGION */
484static inline void acpi_i2c_remove_space_handler(struct i2c_adapter *adapter)
485{ }
486
487static inline int acpi_i2c_install_space_handler(struct i2c_adapter *adapter)
488{ return 0; }
489#endif /* CONFIG_ACPI_I2C_OPREGION */
490
David Brownellf37dd802007-02-13 22:09:00 +0100491/* ------------------------------------------------------------------------- */
492
Jean Delvared2653e92008-04-29 23:11:39 +0200493static const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
494 const struct i2c_client *client)
495{
496 while (id->name[0]) {
497 if (strcmp(client->name, id->name) == 0)
498 return id;
499 id++;
500 }
501 return NULL;
502}
503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504static int i2c_device_match(struct device *dev, struct device_driver *drv)
505{
Jean Delvare51298d12009-09-18 22:45:45 +0200506 struct i2c_client *client = i2c_verify_client(dev);
507 struct i2c_driver *driver;
David Brownell7b4fbc52007-05-01 23:26:30 +0200508
Jean Delvare51298d12009-09-18 22:45:45 +0200509 if (!client)
510 return 0;
511
Grant Likely959e85f2010-06-08 07:48:19 -0600512 /* Attempt an OF style match */
513 if (of_driver_match_device(dev, drv))
514 return 1;
515
Mika Westerberg907ddf82012-11-23 12:23:40 +0100516 /* Then ACPI style match */
517 if (acpi_driver_match_device(dev, drv))
518 return 1;
519
Jean Delvare51298d12009-09-18 22:45:45 +0200520 driver = to_i2c_driver(drv);
Jean Delvared2653e92008-04-29 23:11:39 +0200521 /* match on an id table if there is one */
522 if (driver->id_table)
523 return i2c_match_id(driver->id_table, client) != NULL;
524
Jean Delvareeb8a7902008-05-18 20:49:41 +0200525 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526}
527
Kay Sievers7eff2e72007-08-14 15:15:12 +0200528static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell7b4fbc52007-05-01 23:26:30 +0200529{
Wolfram Sang8dcf3212016-03-23 20:47:02 +0100530 struct i2c_client *client = to_i2c_client(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800531 int rc;
532
533 rc = acpi_device_uevent_modalias(dev, env);
534 if (rc != -ENODEV)
535 return rc;
David Brownell7b4fbc52007-05-01 23:26:30 +0200536
Wolfram Sang8dcf3212016-03-23 20:47:02 +0100537 return add_uevent_var(env, "MODALIAS=%s%s", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200538}
539
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530540/* i2c bus recovery routines */
541static int get_scl_gpio_value(struct i2c_adapter *adap)
542{
543 return gpio_get_value(adap->bus_recovery_info->scl_gpio);
544}
545
546static void set_scl_gpio_value(struct i2c_adapter *adap, int val)
547{
548 gpio_set_value(adap->bus_recovery_info->scl_gpio, val);
549}
550
551static int get_sda_gpio_value(struct i2c_adapter *adap)
552{
553 return gpio_get_value(adap->bus_recovery_info->sda_gpio);
554}
555
556static int i2c_get_gpios_for_recovery(struct i2c_adapter *adap)
557{
558 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
559 struct device *dev = &adap->dev;
560 int ret = 0;
561
562 ret = gpio_request_one(bri->scl_gpio, GPIOF_OPEN_DRAIN |
563 GPIOF_OUT_INIT_HIGH, "i2c-scl");
564 if (ret) {
565 dev_warn(dev, "Can't get SCL gpio: %d\n", bri->scl_gpio);
566 return ret;
567 }
568
569 if (bri->get_sda) {
570 if (gpio_request_one(bri->sda_gpio, GPIOF_IN, "i2c-sda")) {
571 /* work without SDA polling */
572 dev_warn(dev, "Can't get SDA gpio: %d. Not using SDA polling\n",
573 bri->sda_gpio);
574 bri->get_sda = NULL;
575 }
576 }
577
578 return ret;
579}
580
581static void i2c_put_gpios_for_recovery(struct i2c_adapter *adap)
582{
583 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
584
585 if (bri->get_sda)
586 gpio_free(bri->sda_gpio);
587
588 gpio_free(bri->scl_gpio);
589}
590
591/*
592 * We are generating clock pulses. ndelay() determines durating of clk pulses.
593 * We will generate clock with rate 100 KHz and so duration of both clock levels
594 * is: delay in ns = (10^6 / 100) / 2
595 */
596#define RECOVERY_NDELAY 5000
597#define RECOVERY_CLK_CNT 9
598
599static int i2c_generic_recovery(struct i2c_adapter *adap)
600{
601 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
602 int i = 0, val = 1, ret = 0;
603
604 if (bri->prepare_recovery)
Grygorii Strashko2b2190a2015-04-06 15:38:39 +0300605 bri->prepare_recovery(adap);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530606
Jan Luebbe8b062602015-07-08 16:35:06 +0200607 bri->set_scl(adap, val);
608 ndelay(RECOVERY_NDELAY);
609
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530610 /*
611 * By this time SCL is high, as we need to give 9 falling-rising edges
612 */
613 while (i++ < RECOVERY_CLK_CNT * 2) {
614 if (val) {
615 /* Break if SDA is high */
616 if (bri->get_sda && bri->get_sda(adap))
617 break;
618 /* SCL shouldn't be low here */
619 if (!bri->get_scl(adap)) {
620 dev_err(&adap->dev,
621 "SCL is stuck low, exit recovery\n");
622 ret = -EBUSY;
623 break;
624 }
625 }
626
627 val = !val;
628 bri->set_scl(adap, val);
629 ndelay(RECOVERY_NDELAY);
630 }
631
632 if (bri->unprepare_recovery)
Grygorii Strashko2b2190a2015-04-06 15:38:39 +0300633 bri->unprepare_recovery(adap);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530634
635 return ret;
636}
637
638int i2c_generic_scl_recovery(struct i2c_adapter *adap)
639{
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530640 return i2c_generic_recovery(adap);
641}
Mark Brownc1c21f42015-04-15 19:18:39 +0100642EXPORT_SYMBOL_GPL(i2c_generic_scl_recovery);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530643
644int i2c_generic_gpio_recovery(struct i2c_adapter *adap)
645{
646 int ret;
647
648 ret = i2c_get_gpios_for_recovery(adap);
649 if (ret)
650 return ret;
651
652 ret = i2c_generic_recovery(adap);
653 i2c_put_gpios_for_recovery(adap);
654
655 return ret;
656}
Mark Brownc1c21f42015-04-15 19:18:39 +0100657EXPORT_SYMBOL_GPL(i2c_generic_gpio_recovery);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530658
659int i2c_recover_bus(struct i2c_adapter *adap)
660{
661 if (!adap->bus_recovery_info)
662 return -EOPNOTSUPP;
663
664 dev_dbg(&adap->dev, "Trying i2c bus recovery\n");
665 return adap->bus_recovery_info->recover_bus(adap);
666}
Mark Brownc1c21f42015-04-15 19:18:39 +0100667EXPORT_SYMBOL_GPL(i2c_recover_bus);
Viresh Kumar5f9296b2012-02-28 18:26:31 +0530668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669static int i2c_device_probe(struct device *dev)
670{
Jean Delvare51298d12009-09-18 22:45:45 +0200671 struct i2c_client *client = i2c_verify_client(dev);
672 struct i2c_driver *driver;
Hans Verkuil50c33042008-03-12 14:15:00 +0100673 int status;
David Brownell7b4fbc52007-05-01 23:26:30 +0200674
Jean Delvare51298d12009-09-18 22:45:45 +0200675 if (!client)
676 return 0;
677
Mika Westerberg845c8772015-05-06 13:29:08 +0300678 if (!client->irq) {
679 int irq = -ENOENT;
680
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700681 if (dev->of_node) {
682 irq = of_irq_get_byname(dev->of_node, "irq");
683 if (irq == -EINVAL || irq == -ENODATA)
684 irq = of_irq_get(dev->of_node, 0);
685 } else if (ACPI_COMPANION(dev)) {
Mika Westerberg845c8772015-05-06 13:29:08 +0300686 irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700687 }
Geert Uytterhoeven6f34be72014-11-17 12:43:00 +0100688 if (irq == -EPROBE_DEFER)
Laurent Pinchart2fd36c552014-10-30 15:59:38 +0200689 return irq;
Geert Uytterhoeven6f34be72014-11-17 12:43:00 +0100690 if (irq < 0)
691 irq = 0;
Laurent Pinchart2fd36c552014-10-30 15:59:38 +0200692
693 client->irq = irq;
694 }
695
Jean Delvare51298d12009-09-18 22:45:45 +0200696 driver = to_i2c_driver(dev->driver);
Jean Delvaree0457442008-07-14 22:38:30 +0200697 if (!driver->probe || !driver->id_table)
David Brownell7b4fbc52007-05-01 23:26:30 +0200698 return -ENODEV;
Lars-Peter Clausen0acc2b32013-09-29 10:51:06 +0200699
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700700 if (client->flags & I2C_CLIENT_WAKE) {
701 int wakeirq = -ENOENT;
702
703 if (dev->of_node) {
704 wakeirq = of_irq_get_byname(dev->of_node, "wakeup");
705 if (wakeirq == -EPROBE_DEFER)
706 return wakeirq;
707 }
708
709 device_init_wakeup(&client->dev, true);
710
711 if (wakeirq > 0 && wakeirq != client->irq)
712 status = dev_pm_set_dedicated_wake_irq(dev, wakeirq);
713 else if (client->irq > 0)
Grygorii Strashkoc18fba22015-11-12 15:42:26 +0200714 status = dev_pm_set_wake_irq(dev, client->irq);
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700715 else
716 status = 0;
717
718 if (status)
719 dev_warn(&client->dev, "failed to set up wakeup irq");
720 }
721
David Brownell7b4fbc52007-05-01 23:26:30 +0200722 dev_dbg(dev, "probe\n");
Jean Delvared2653e92008-04-29 23:11:39 +0200723
Sylwester Nawrocki86be4082014-06-18 17:29:32 +0200724 status = of_clk_set_defaults(dev->of_node, false);
725 if (status < 0)
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700726 goto err_clear_wakeup_irq;
Sylwester Nawrocki86be4082014-06-18 17:29:32 +0200727
Ulf Hanssone09b0d42014-09-19 20:27:39 +0200728 status = dev_pm_domain_attach(&client->dev, true);
Kieran Bingham74cedd32015-10-12 21:54:43 +0100729 if (status == -EPROBE_DEFER)
730 goto err_clear_wakeup_irq;
731
732 status = driver->probe(client, i2c_match_id(driver->id_table, client));
733 if (status)
734 goto err_detach_pm_domain;
Wolfram Sang72fa8182014-01-21 17:48:34 +0100735
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700736 return 0;
737
738err_detach_pm_domain:
739 dev_pm_domain_detach(&client->dev, true);
740err_clear_wakeup_irq:
741 dev_pm_clear_wake_irq(&client->dev);
742 device_init_wakeup(&client->dev, false);
Hans Verkuil50c33042008-03-12 14:15:00 +0100743 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744}
745
746static int i2c_device_remove(struct device *dev)
747{
Jean Delvare51298d12009-09-18 22:45:45 +0200748 struct i2c_client *client = i2c_verify_client(dev);
David Brownella1d9e6e2007-05-01 23:26:30 +0200749 struct i2c_driver *driver;
Wolfram Sang72fa8182014-01-21 17:48:34 +0100750 int status = 0;
David Brownella1d9e6e2007-05-01 23:26:30 +0200751
Jean Delvare51298d12009-09-18 22:45:45 +0200752 if (!client || !dev->driver)
David Brownella1d9e6e2007-05-01 23:26:30 +0200753 return 0;
754
755 driver = to_i2c_driver(dev->driver);
756 if (driver->remove) {
757 dev_dbg(dev, "remove\n");
758 status = driver->remove(client);
David Brownella1d9e6e2007-05-01 23:26:30 +0200759 }
Wolfram Sang72fa8182014-01-21 17:48:34 +0100760
Ulf Hanssone09b0d42014-09-19 20:27:39 +0200761 dev_pm_domain_detach(&client->dev, true);
Dmitry Torokhov3fffd122015-08-17 23:52:51 -0700762
763 dev_pm_clear_wake_irq(&client->dev);
764 device_init_wakeup(&client->dev, false);
765
David Brownella1d9e6e2007-05-01 23:26:30 +0200766 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767}
768
David Brownellf37dd802007-02-13 22:09:00 +0100769static void i2c_device_shutdown(struct device *dev)
770{
Jean Delvare51298d12009-09-18 22:45:45 +0200771 struct i2c_client *client = i2c_verify_client(dev);
David Brownellf37dd802007-02-13 22:09:00 +0100772 struct i2c_driver *driver;
773
Jean Delvare51298d12009-09-18 22:45:45 +0200774 if (!client || !dev->driver)
David Brownellf37dd802007-02-13 22:09:00 +0100775 return;
776 driver = to_i2c_driver(dev->driver);
777 if (driver->shutdown)
Jean Delvare51298d12009-09-18 22:45:45 +0200778 driver->shutdown(client);
David Brownellf37dd802007-02-13 22:09:00 +0100779}
780
David Brownell9c1600e2007-05-01 23:26:31 +0200781static void i2c_client_dev_release(struct device *dev)
782{
783 kfree(to_i2c_client(dev));
784}
785
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100786static ssize_t
Jean Delvare4f8cf822009-09-18 22:45:46 +0200787show_name(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200788{
Jean Delvare4f8cf822009-09-18 22:45:46 +0200789 return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
790 to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200791}
Wolfram Sanga5eb71b2015-01-19 20:12:24 +0100792static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
David Brownell7b4fbc52007-05-01 23:26:30 +0200793
Zhenwen Xu09b8ce02009-03-28 21:34:46 +0100794static ssize_t
795show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
David Brownell7b4fbc52007-05-01 23:26:30 +0200796{
797 struct i2c_client *client = to_i2c_client(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800798 int len;
799
800 len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
801 if (len != -ENODEV)
802 return len;
803
Jean Delvareeb8a7902008-05-18 20:49:41 +0200804 return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
David Brownell7b4fbc52007-05-01 23:26:30 +0200805}
Jean Delvare51298d12009-09-18 22:45:45 +0200806static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
807
808static struct attribute *i2c_dev_attrs[] = {
809 &dev_attr_name.attr,
David Brownell7b4fbc52007-05-01 23:26:30 +0200810 /* modalias helps coldplug: modprobe $(cat .../modalias) */
Jean Delvare51298d12009-09-18 22:45:45 +0200811 &dev_attr_modalias.attr,
812 NULL
813};
Wolfram Sanga5eb71b2015-01-19 20:12:24 +0100814ATTRIBUTE_GROUPS(i2c_dev);
sonic zhang54067ee2009-12-14 21:17:30 +0100815
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200816struct bus_type i2c_bus_type = {
David Brownellf37dd802007-02-13 22:09:00 +0100817 .name = "i2c",
818 .match = i2c_device_match,
819 .probe = i2c_device_probe,
820 .remove = i2c_device_remove,
821 .shutdown = i2c_device_shutdown,
Russell Kingb864c7d2006-01-05 14:37:50 +0000822};
Jon Smirle9ca9eb2008-07-14 22:38:35 +0200823EXPORT_SYMBOL_GPL(i2c_bus_type);
Russell Kingb864c7d2006-01-05 14:37:50 +0000824
Jean Delvare51298d12009-09-18 22:45:45 +0200825static struct device_type i2c_client_type = {
Wolfram Sanga5eb71b2015-01-19 20:12:24 +0100826 .groups = i2c_dev_groups,
Jean Delvare51298d12009-09-18 22:45:45 +0200827 .uevent = i2c_device_uevent,
828 .release = i2c_client_dev_release,
829};
830
David Brownell9b766b82008-01-27 18:14:51 +0100831
832/**
833 * i2c_verify_client - return parameter as i2c_client, or NULL
834 * @dev: device, probably from some driver model iterator
835 *
836 * When traversing the driver model tree, perhaps using driver model
837 * iterators like @device_for_each_child(), you can't assume very much
838 * about the nodes you find. Use this function to avoid oopses caused
839 * by wrongly treating some non-I2C device as an i2c_client.
840 */
841struct i2c_client *i2c_verify_client(struct device *dev)
842{
Jean Delvare51298d12009-09-18 22:45:45 +0200843 return (dev->type == &i2c_client_type)
David Brownell9b766b82008-01-27 18:14:51 +0100844 ? to_i2c_client(dev)
845 : NULL;
846}
847EXPORT_SYMBOL(i2c_verify_client);
848
849
Wolfram Sangda899f52015-05-18 21:09:12 +0200850/* Return a unique address which takes the flags of the client into account */
851static unsigned short i2c_encode_flags_to_addr(struct i2c_client *client)
852{
853 unsigned short addr = client->addr;
854
855 /* For some client flags, add an arbitrary offset to avoid collisions */
856 if (client->flags & I2C_CLIENT_TEN)
857 addr |= I2C_ADDR_OFFSET_TEN_BIT;
858
859 if (client->flags & I2C_CLIENT_SLAVE)
860 addr |= I2C_ADDR_OFFSET_SLAVE;
861
862 return addr;
863}
864
Jean Delvare3a89db52010-06-03 11:33:52 +0200865/* This is a permissive address validity check, I2C address map constraints
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300866 * are purposely not enforced, except for the general call address. */
Wolfram Sangc4019b72015-07-17 12:50:06 +0200867static int i2c_check_addr_validity(unsigned addr, unsigned short flags)
Jean Delvare3a89db52010-06-03 11:33:52 +0200868{
Wolfram Sangc4019b72015-07-17 12:50:06 +0200869 if (flags & I2C_CLIENT_TEN) {
Jean Delvare3a89db52010-06-03 11:33:52 +0200870 /* 10-bit address, all values are valid */
Wolfram Sangc4019b72015-07-17 12:50:06 +0200871 if (addr > 0x3ff)
Jean Delvare3a89db52010-06-03 11:33:52 +0200872 return -EINVAL;
873 } else {
874 /* 7-bit address, reject the general call address */
Wolfram Sangc4019b72015-07-17 12:50:06 +0200875 if (addr == 0x00 || addr > 0x7f)
Jean Delvare3a89db52010-06-03 11:33:52 +0200876 return -EINVAL;
877 }
878 return 0;
879}
880
Jean Delvare656b8762010-06-03 11:33:53 +0200881/* And this is a strict address validity check, used when probing. If a
882 * device uses a reserved address, then it shouldn't be probed. 7-bit
883 * addressing is assumed, 10-bit address devices are rare and should be
884 * explicitly enumerated. */
Wolfram Sang66be60562015-07-17 12:43:22 +0200885static int i2c_check_7bit_addr_validity_strict(unsigned short addr)
Jean Delvare656b8762010-06-03 11:33:53 +0200886{
887 /*
888 * Reserved addresses per I2C specification:
889 * 0x00 General call address / START byte
890 * 0x01 CBUS address
891 * 0x02 Reserved for different bus format
892 * 0x03 Reserved for future purposes
893 * 0x04-0x07 Hs-mode master code
894 * 0x78-0x7b 10-bit slave addressing
895 * 0x7c-0x7f Reserved for future purposes
896 */
897 if (addr < 0x08 || addr > 0x77)
898 return -EINVAL;
899 return 0;
900}
901
Jean Delvare3b5f7942010-06-03 11:33:55 +0200902static int __i2c_check_addr_busy(struct device *dev, void *addrp)
903{
904 struct i2c_client *client = i2c_verify_client(dev);
905 int addr = *(int *)addrp;
906
Wolfram Sang9bccc702015-07-17 14:48:56 +0200907 if (client && i2c_encode_flags_to_addr(client) == addr)
Jean Delvare3b5f7942010-06-03 11:33:55 +0200908 return -EBUSY;
909 return 0;
910}
911
Michael Lawnick08263742010-08-11 18:21:02 +0200912/* walk up mux tree */
913static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
914{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200915 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200916 int result;
917
918 result = device_for_each_child(&adapter->dev, &addr,
919 __i2c_check_addr_busy);
920
Jean Delvare97cc4d42010-10-24 18:16:57 +0200921 if (!result && parent)
922 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200923
924 return result;
925}
926
927/* recurse down mux tree */
928static int i2c_check_mux_children(struct device *dev, void *addrp)
929{
930 int result;
931
932 if (dev->type == &i2c_adapter_type)
933 result = device_for_each_child(dev, addrp,
934 i2c_check_mux_children);
935 else
936 result = __i2c_check_addr_busy(dev, addrp);
937
938 return result;
939}
940
Jean Delvare3b5f7942010-06-03 11:33:55 +0200941static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
942{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200943 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
Michael Lawnick08263742010-08-11 18:21:02 +0200944 int result = 0;
945
Jean Delvare97cc4d42010-10-24 18:16:57 +0200946 if (parent)
947 result = i2c_check_mux_parents(parent, addr);
Michael Lawnick08263742010-08-11 18:21:02 +0200948
949 if (!result)
950 result = device_for_each_child(&adapter->dev, &addr,
951 i2c_check_mux_children);
952
953 return result;
Jean Delvare3b5f7942010-06-03 11:33:55 +0200954}
955
David Brownell9c1600e2007-05-01 23:26:31 +0200956/**
Peter Rosin8320f492016-05-04 22:15:27 +0200957 * i2c_adapter_lock_bus - Get exclusive access to an I2C bus segment
Jean Delvarefe61e072010-08-11 18:20:58 +0200958 * @adapter: Target I2C bus segment
Peter Rosin8320f492016-05-04 22:15:27 +0200959 * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT
960 * locks only this branch in the adapter tree
Jean Delvarefe61e072010-08-11 18:20:58 +0200961 */
Peter Rosin8320f492016-05-04 22:15:27 +0200962static void i2c_adapter_lock_bus(struct i2c_adapter *adapter,
963 unsigned int flags)
Jean Delvarefe61e072010-08-11 18:20:58 +0200964{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200965 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
966
967 if (parent)
968 i2c_lock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +0200969 else
970 rt_mutex_lock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200971}
Jean Delvarefe61e072010-08-11 18:20:58 +0200972
973/**
Peter Rosin8320f492016-05-04 22:15:27 +0200974 * i2c_adapter_trylock_bus - Try to get exclusive access to an I2C bus segment
Jean Delvarefe61e072010-08-11 18:20:58 +0200975 * @adapter: Target I2C bus segment
Peter Rosin8320f492016-05-04 22:15:27 +0200976 * @flags: I2C_LOCK_ROOT_ADAPTER trylocks the root i2c adapter, I2C_LOCK_SEGMENT
977 * trylocks only this branch in the adapter tree
Jean Delvarefe61e072010-08-11 18:20:58 +0200978 */
Peter Rosin8320f492016-05-04 22:15:27 +0200979static int i2c_adapter_trylock_bus(struct i2c_adapter *adapter,
980 unsigned int flags)
Jean Delvarefe61e072010-08-11 18:20:58 +0200981{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200982 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
983
984 if (parent)
Peter Rosin8320f492016-05-04 22:15:27 +0200985 return parent->trylock_bus(parent, flags);
Michael Lawnick08263742010-08-11 18:21:02 +0200986 else
987 return rt_mutex_trylock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +0200988}
989
990/**
Peter Rosin8320f492016-05-04 22:15:27 +0200991 * i2c_adapter_unlock_bus - Release exclusive access to an I2C bus segment
Jean Delvarefe61e072010-08-11 18:20:58 +0200992 * @adapter: Target I2C bus segment
Peter Rosin8320f492016-05-04 22:15:27 +0200993 * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT
994 * unlocks only this branch in the adapter tree
Jean Delvarefe61e072010-08-11 18:20:58 +0200995 */
Peter Rosin8320f492016-05-04 22:15:27 +0200996static void i2c_adapter_unlock_bus(struct i2c_adapter *adapter,
997 unsigned int flags)
Jean Delvarefe61e072010-08-11 18:20:58 +0200998{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200999 struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
1000
1001 if (parent)
1002 i2c_unlock_adapter(parent);
Michael Lawnick08263742010-08-11 18:21:02 +02001003 else
1004 rt_mutex_unlock(&adapter->bus_lock);
Jean Delvarefe61e072010-08-11 18:20:58 +02001005}
Jean Delvarefe61e072010-08-11 18:20:58 +02001006
Jarkko Nikula70762ab2013-11-14 14:03:52 +02001007static void i2c_dev_set_name(struct i2c_adapter *adap,
1008 struct i2c_client *client)
1009{
1010 struct acpi_device *adev = ACPI_COMPANION(&client->dev);
1011
1012 if (adev) {
1013 dev_set_name(&client->dev, "i2c-%s", acpi_dev_name(adev));
1014 return;
1015 }
1016
Jarkko Nikula70762ab2013-11-14 14:03:52 +02001017 dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
Wolfram Sangda899f52015-05-18 21:09:12 +02001018 i2c_encode_flags_to_addr(client));
Jarkko Nikula70762ab2013-11-14 14:03:52 +02001019}
1020
Jean Delvarefe61e072010-08-11 18:20:58 +02001021/**
Jean Delvaref8a227e2009-06-19 16:58:18 +02001022 * i2c_new_device - instantiate an i2c device
David Brownell9c1600e2007-05-01 23:26:31 +02001023 * @adap: the adapter managing the device
1024 * @info: describes one I2C device; bus_num is ignored
David Brownelld64f73b2007-07-12 14:12:28 +02001025 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +02001026 *
Jean Delvaref8a227e2009-06-19 16:58:18 +02001027 * Create an i2c device. Binding is handled through driver model
1028 * probe()/remove() methods. A driver may be bound to this device when we
1029 * return from this function, or any later moment (e.g. maybe hotplugging will
1030 * load the driver module). This call is not appropriate for use by mainboard
1031 * initialization logic, which usually runs during an arch_initcall() long
1032 * before any i2c_adapter could exist.
David Brownell9c1600e2007-05-01 23:26:31 +02001033 *
1034 * This returns the new i2c client, which may be saved for later use with
1035 * i2c_unregister_device(); or NULL to indicate an error.
1036 */
1037struct i2c_client *
1038i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
1039{
1040 struct i2c_client *client;
1041 int status;
1042
1043 client = kzalloc(sizeof *client, GFP_KERNEL);
1044 if (!client)
1045 return NULL;
1046
1047 client->adapter = adap;
1048
1049 client->dev.platform_data = info->platform_data;
David Brownell3bbb8352007-10-13 23:56:29 +02001050
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +02001051 if (info->archdata)
1052 client->dev.archdata = *info->archdata;
1053
Marc Pignatee354252008-08-28 08:33:22 +02001054 client->flags = info->flags;
David Brownell9c1600e2007-05-01 23:26:31 +02001055 client->addr = info->addr;
1056 client->irq = info->irq;
1057
David Brownell9c1600e2007-05-01 23:26:31 +02001058 strlcpy(client->name, info->type, sizeof(client->name));
1059
Wolfram Sangc4019b72015-07-17 12:50:06 +02001060 status = i2c_check_addr_validity(client->addr, client->flags);
Jean Delvare3a89db52010-06-03 11:33:52 +02001061 if (status) {
1062 dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
1063 client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
1064 goto out_err_silent;
1065 }
1066
Jean Delvaref8a227e2009-06-19 16:58:18 +02001067 /* Check for address business */
Wolfram Sang9bccc702015-07-17 14:48:56 +02001068 status = i2c_check_addr_busy(adap, i2c_encode_flags_to_addr(client));
Jean Delvaref8a227e2009-06-19 16:58:18 +02001069 if (status)
1070 goto out_err;
1071
1072 client->dev.parent = &client->adapter->dev;
1073 client->dev.bus = &i2c_bus_type;
Jean Delvare51298d12009-09-18 22:45:45 +02001074 client->dev.type = &i2c_client_type;
Grant Likelyd12d42f2010-04-13 16:12:28 -07001075 client->dev.of_node = info->of_node;
Rafael J. Wysockice793482015-03-16 23:49:03 +01001076 client->dev.fwnode = info->fwnode;
Jean Delvaref8a227e2009-06-19 16:58:18 +02001077
Jarkko Nikula70762ab2013-11-14 14:03:52 +02001078 i2c_dev_set_name(adap, client);
Jean Delvaref8a227e2009-06-19 16:58:18 +02001079 status = device_register(&client->dev);
1080 if (status)
1081 goto out_err;
1082
Jean Delvaref8a227e2009-06-19 16:58:18 +02001083 dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
1084 client->name, dev_name(&client->dev));
1085
David Brownell9c1600e2007-05-01 23:26:31 +02001086 return client;
Jean Delvaref8a227e2009-06-19 16:58:18 +02001087
1088out_err:
1089 dev_err(&adap->dev, "Failed to register i2c client %s at 0x%02x "
1090 "(%d)\n", client->name, client->addr, status);
Jean Delvare3a89db52010-06-03 11:33:52 +02001091out_err_silent:
Jean Delvaref8a227e2009-06-19 16:58:18 +02001092 kfree(client);
1093 return NULL;
David Brownell9c1600e2007-05-01 23:26:31 +02001094}
1095EXPORT_SYMBOL_GPL(i2c_new_device);
1096
1097
1098/**
1099 * i2c_unregister_device - reverse effect of i2c_new_device()
1100 * @client: value returned from i2c_new_device()
David Brownelld64f73b2007-07-12 14:12:28 +02001101 * Context: can sleep
David Brownell9c1600e2007-05-01 23:26:31 +02001102 */
1103void i2c_unregister_device(struct i2c_client *client)
David Brownella1d9e6e2007-05-01 23:26:30 +02001104{
Pantelis Antoniou4f001fd2015-01-24 09:16:29 +02001105 if (client->dev.of_node)
1106 of_node_clear_flag(client->dev.of_node, OF_POPULATED);
David Brownella1d9e6e2007-05-01 23:26:30 +02001107 device_unregister(&client->dev);
1108}
David Brownell9c1600e2007-05-01 23:26:31 +02001109EXPORT_SYMBOL_GPL(i2c_unregister_device);
David Brownella1d9e6e2007-05-01 23:26:30 +02001110
1111
Jean Delvare60b129d2008-05-11 20:37:06 +02001112static const struct i2c_device_id dummy_id[] = {
1113 { "dummy", 0 },
1114 { },
1115};
1116
Jean Delvared2653e92008-04-29 23:11:39 +02001117static int dummy_probe(struct i2c_client *client,
1118 const struct i2c_device_id *id)
1119{
1120 return 0;
1121}
1122
1123static int dummy_remove(struct i2c_client *client)
David Brownelle9f13732008-01-27 18:14:52 +01001124{
1125 return 0;
1126}
1127
1128static struct i2c_driver dummy_driver = {
1129 .driver.name = "dummy",
Jean Delvared2653e92008-04-29 23:11:39 +02001130 .probe = dummy_probe,
1131 .remove = dummy_remove,
Jean Delvare60b129d2008-05-11 20:37:06 +02001132 .id_table = dummy_id,
David Brownelle9f13732008-01-27 18:14:52 +01001133};
1134
1135/**
1136 * i2c_new_dummy - return a new i2c device bound to a dummy driver
1137 * @adapter: the adapter managing the device
1138 * @address: seven bit address to be used
David Brownelle9f13732008-01-27 18:14:52 +01001139 * Context: can sleep
1140 *
1141 * This returns an I2C client bound to the "dummy" driver, intended for use
1142 * with devices that consume multiple addresses. Examples of such chips
1143 * include various EEPROMS (like 24c04 and 24c08 models).
1144 *
1145 * These dummy devices have two main uses. First, most I2C and SMBus calls
1146 * except i2c_transfer() need a client handle; the dummy will be that handle.
1147 * And second, this prevents the specified address from being bound to a
1148 * different driver.
1149 *
1150 * This returns the new i2c client, which should be saved for later use with
1151 * i2c_unregister_device(); or NULL to indicate an error.
1152 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001153struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
David Brownelle9f13732008-01-27 18:14:52 +01001154{
1155 struct i2c_board_info info = {
Jean Delvare60b129d2008-05-11 20:37:06 +02001156 I2C_BOARD_INFO("dummy", address),
David Brownelle9f13732008-01-27 18:14:52 +01001157 };
1158
David Brownelle9f13732008-01-27 18:14:52 +01001159 return i2c_new_device(adapter, &info);
1160}
1161EXPORT_SYMBOL_GPL(i2c_new_dummy);
1162
David Brownellf37dd802007-02-13 22:09:00 +01001163/* ------------------------------------------------------------------------- */
1164
David Brownell16ffadf2007-05-01 23:26:28 +02001165/* I2C bus adapters -- one roots each I2C or SMBUS segment */
1166
Adrian Bunk83eaaed2007-10-13 23:56:30 +02001167static void i2c_adapter_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168{
David Brownellef2c83212007-05-01 23:26:28 +02001169 struct i2c_adapter *adap = to_i2c_adapter(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 complete(&adap->dev_released);
1171}
1172
Jean Delvare99cd8e22009-06-19 16:58:20 +02001173/*
Jean Delvare390946b2012-09-10 10:14:02 +02001174 * This function is only needed for mutex_lock_nested, so it is never
1175 * called unless locking correctness checking is enabled. Thus we
1176 * make it inline to avoid a compiler warning. That's what gcc ends up
1177 * doing anyway.
1178 */
1179static inline unsigned int i2c_adapter_depth(struct i2c_adapter *adapter)
1180{
1181 unsigned int depth = 0;
1182
1183 while ((adapter = i2c_parent_is_i2c_adapter(adapter)))
1184 depth++;
1185
1186 return depth;
1187}
1188
1189/*
Jean Delvare99cd8e22009-06-19 16:58:20 +02001190 * Let users instantiate I2C devices through sysfs. This can be used when
1191 * platform initialization code doesn't contain the proper data for
1192 * whatever reason. Also useful for drivers that do device detection and
1193 * detection fails, either because the device uses an unexpected address,
1194 * or this is a compatible device with different ID register values.
1195 *
1196 * Parameter checking may look overzealous, but we really don't want
1197 * the user to provide incorrect parameters.
1198 */
1199static ssize_t
1200i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
1201 const char *buf, size_t count)
1202{
1203 struct i2c_adapter *adap = to_i2c_adapter(dev);
1204 struct i2c_board_info info;
1205 struct i2c_client *client;
1206 char *blank, end;
1207 int res;
1208
Jean Delvare99cd8e22009-06-19 16:58:20 +02001209 memset(&info, 0, sizeof(struct i2c_board_info));
1210
1211 blank = strchr(buf, ' ');
1212 if (!blank) {
1213 dev_err(dev, "%s: Missing parameters\n", "new_device");
1214 return -EINVAL;
1215 }
1216 if (blank - buf > I2C_NAME_SIZE - 1) {
1217 dev_err(dev, "%s: Invalid device name\n", "new_device");
1218 return -EINVAL;
1219 }
1220 memcpy(info.type, buf, blank - buf);
1221
1222 /* Parse remaining parameters, reject extra parameters */
1223 res = sscanf(++blank, "%hi%c", &info.addr, &end);
1224 if (res < 1) {
1225 dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
1226 return -EINVAL;
1227 }
1228 if (res > 1 && end != '\n') {
1229 dev_err(dev, "%s: Extra parameters\n", "new_device");
1230 return -EINVAL;
1231 }
1232
Wolfram Sangcfa03272015-07-27 14:03:38 +02001233 if ((info.addr & I2C_ADDR_OFFSET_TEN_BIT) == I2C_ADDR_OFFSET_TEN_BIT) {
1234 info.addr &= ~I2C_ADDR_OFFSET_TEN_BIT;
1235 info.flags |= I2C_CLIENT_TEN;
1236 }
1237
1238 if (info.addr & I2C_ADDR_OFFSET_SLAVE) {
1239 info.addr &= ~I2C_ADDR_OFFSET_SLAVE;
1240 info.flags |= I2C_CLIENT_SLAVE;
1241 }
1242
Jean Delvare99cd8e22009-06-19 16:58:20 +02001243 client = i2c_new_device(adap, &info);
1244 if (!client)
Jean Delvare3a89db52010-06-03 11:33:52 +02001245 return -EINVAL;
Jean Delvare99cd8e22009-06-19 16:58:20 +02001246
1247 /* Keep track of the added device */
Jean Delvaredafc50d2010-08-11 18:21:01 +02001248 mutex_lock(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +02001249 list_add_tail(&client->detected, &adap->userspace_clients);
Jean Delvaredafc50d2010-08-11 18:21:01 +02001250 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +02001251 dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
1252 info.type, info.addr);
1253
1254 return count;
1255}
Wolfram Sanga5eb71b2015-01-19 20:12:24 +01001256static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
Jean Delvare99cd8e22009-06-19 16:58:20 +02001257
1258/*
1259 * And of course let the users delete the devices they instantiated, if
1260 * they got it wrong. This interface can only be used to delete devices
1261 * instantiated by i2c_sysfs_new_device above. This guarantees that we
1262 * don't delete devices to which some kernel code still has references.
1263 *
1264 * Parameter checking may look overzealous, but we really don't want
1265 * the user to delete the wrong device.
1266 */
1267static ssize_t
1268i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
1269 const char *buf, size_t count)
1270{
1271 struct i2c_adapter *adap = to_i2c_adapter(dev);
1272 struct i2c_client *client, *next;
1273 unsigned short addr;
1274 char end;
1275 int res;
1276
1277 /* Parse parameters, reject extra parameters */
1278 res = sscanf(buf, "%hi%c", &addr, &end);
1279 if (res < 1) {
1280 dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
1281 return -EINVAL;
1282 }
1283 if (res > 1 && end != '\n') {
1284 dev_err(dev, "%s: Extra parameters\n", "delete_device");
1285 return -EINVAL;
1286 }
1287
1288 /* Make sure the device was added through sysfs */
1289 res = -ENOENT;
Jean Delvare390946b2012-09-10 10:14:02 +02001290 mutex_lock_nested(&adap->userspace_clients_lock,
1291 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +02001292 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1293 detected) {
Wolfram Sangcfa03272015-07-27 14:03:38 +02001294 if (i2c_encode_flags_to_addr(client) == addr) {
Jean Delvare99cd8e22009-06-19 16:58:20 +02001295 dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
1296 "delete_device", client->name, client->addr);
1297
1298 list_del(&client->detected);
1299 i2c_unregister_device(client);
1300 res = count;
1301 break;
1302 }
1303 }
Jean Delvaredafc50d2010-08-11 18:21:01 +02001304 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvare99cd8e22009-06-19 16:58:20 +02001305
1306 if (res < 0)
1307 dev_err(dev, "%s: Can't find device in list\n",
1308 "delete_device");
1309 return res;
1310}
Alexander Sverdline9b526f2013-05-17 14:56:35 +02001311static DEVICE_ATTR_IGNORE_LOCKDEP(delete_device, S_IWUSR, NULL,
1312 i2c_sysfs_delete_device);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001313
1314static struct attribute *i2c_adapter_attrs[] = {
1315 &dev_attr_name.attr,
1316 &dev_attr_new_device.attr,
1317 &dev_attr_delete_device.attr,
1318 NULL
David Brownell16ffadf2007-05-01 23:26:28 +02001319};
Wolfram Sanga5eb71b2015-01-19 20:12:24 +01001320ATTRIBUTE_GROUPS(i2c_adapter);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001321
Michael Lawnick08263742010-08-11 18:21:02 +02001322struct device_type i2c_adapter_type = {
Wolfram Sanga5eb71b2015-01-19 20:12:24 +01001323 .groups = i2c_adapter_groups,
Jean Delvare4f8cf822009-09-18 22:45:46 +02001324 .release = i2c_adapter_dev_release,
David Brownell16ffadf2007-05-01 23:26:28 +02001325};
Michael Lawnick08263742010-08-11 18:21:02 +02001326EXPORT_SYMBOL_GPL(i2c_adapter_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
Stephen Warren643dd092012-04-17 12:43:33 -06001328/**
1329 * i2c_verify_adapter - return parameter as i2c_adapter or NULL
1330 * @dev: device, probably from some driver model iterator
1331 *
1332 * When traversing the driver model tree, perhaps using driver model
1333 * iterators like @device_for_each_child(), you can't assume very much
1334 * about the nodes you find. Use this function to avoid oopses caused
1335 * by wrongly treating some non-I2C device as an i2c_adapter.
1336 */
1337struct i2c_adapter *i2c_verify_adapter(struct device *dev)
1338{
1339 return (dev->type == &i2c_adapter_type)
1340 ? to_i2c_adapter(dev)
1341 : NULL;
1342}
1343EXPORT_SYMBOL(i2c_verify_adapter);
1344
Jean Delvare2bb50952009-09-18 22:45:46 +02001345#ifdef CONFIG_I2C_COMPAT
1346static struct class_compat *i2c_adapter_compat_class;
1347#endif
1348
David Brownell9c1600e2007-05-01 23:26:31 +02001349static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
1350{
1351 struct i2c_devinfo *devinfo;
1352
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +02001353 down_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +02001354 list_for_each_entry(devinfo, &__i2c_board_list, list) {
1355 if (devinfo->busnum == adapter->nr
1356 && !i2c_new_device(adapter,
1357 &devinfo->board_info))
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01001358 dev_err(&adapter->dev,
1359 "Can't create device at 0x%02x\n",
David Brownell9c1600e2007-05-01 23:26:31 +02001360 devinfo->board_info.addr);
1361 }
Rodolfo Giomettif18c41d2009-06-19 16:58:20 +02001362 up_read(&__i2c_board_lock);
David Brownell9c1600e2007-05-01 23:26:31 +02001363}
1364
Wolfram Sang687b81d2013-07-11 12:56:15 +01001365/* OF support code */
1366
1367#if IS_ENABLED(CONFIG_OF)
Pantelis Antonioua430a3452014-10-28 22:36:02 +02001368static struct i2c_client *of_i2c_register_device(struct i2c_adapter *adap,
1369 struct device_node *node)
1370{
1371 struct i2c_client *result;
1372 struct i2c_board_info info = {};
1373 struct dev_archdata dev_ad = {};
Wolfram Sangb4e2f6a2015-05-19 21:04:40 +02001374 const __be32 *addr_be;
1375 u32 addr;
Pantelis Antonioua430a3452014-10-28 22:36:02 +02001376 int len;
1377
1378 dev_dbg(&adap->dev, "of_i2c: register %s\n", node->full_name);
1379
1380 if (of_modalias_node(node, info.type, sizeof(info.type)) < 0) {
1381 dev_err(&adap->dev, "of_i2c: modalias failure on %s\n",
1382 node->full_name);
1383 return ERR_PTR(-EINVAL);
1384 }
1385
Wolfram Sangb4e2f6a2015-05-19 21:04:40 +02001386 addr_be = of_get_property(node, "reg", &len);
1387 if (!addr_be || (len < sizeof(*addr_be))) {
Pantelis Antonioua430a3452014-10-28 22:36:02 +02001388 dev_err(&adap->dev, "of_i2c: invalid reg on %s\n",
1389 node->full_name);
1390 return ERR_PTR(-EINVAL);
1391 }
1392
Wolfram Sangb4e2f6a2015-05-19 21:04:40 +02001393 addr = be32_to_cpup(addr_be);
1394 if (addr & I2C_TEN_BIT_ADDRESS) {
1395 addr &= ~I2C_TEN_BIT_ADDRESS;
1396 info.flags |= I2C_CLIENT_TEN;
1397 }
1398
1399 if (addr & I2C_OWN_SLAVE_ADDRESS) {
1400 addr &= ~I2C_OWN_SLAVE_ADDRESS;
1401 info.flags |= I2C_CLIENT_SLAVE;
1402 }
1403
1404 if (i2c_check_addr_validity(addr, info.flags)) {
Pantelis Antonioua430a3452014-10-28 22:36:02 +02001405 dev_err(&adap->dev, "of_i2c: invalid addr=%x on %s\n",
1406 info.addr, node->full_name);
1407 return ERR_PTR(-EINVAL);
1408 }
1409
Wolfram Sangb4e2f6a2015-05-19 21:04:40 +02001410 info.addr = addr;
Pantelis Antonioua430a3452014-10-28 22:36:02 +02001411 info.of_node = of_node_get(node);
1412 info.archdata = &dev_ad;
1413
1414 if (of_get_property(node, "wakeup-source", NULL))
1415 info.flags |= I2C_CLIENT_WAKE;
1416
Pantelis Antonioua430a3452014-10-28 22:36:02 +02001417 result = i2c_new_device(adap, &info);
1418 if (result == NULL) {
1419 dev_err(&adap->dev, "of_i2c: Failure registering %s\n",
1420 node->full_name);
1421 of_node_put(node);
Pantelis Antonioua430a3452014-10-28 22:36:02 +02001422 return ERR_PTR(-EINVAL);
1423 }
1424 return result;
1425}
1426
Wolfram Sang687b81d2013-07-11 12:56:15 +01001427static void of_i2c_register_devices(struct i2c_adapter *adap)
1428{
Wolfram Sang687b81d2013-07-11 12:56:15 +01001429 struct device_node *node;
1430
1431 /* Only register child devices if the adapter has a node pointer set */
1432 if (!adap->dev.of_node)
1433 return;
1434
1435 dev_dbg(&adap->dev, "of_i2c: walking child nodes\n");
1436
Pantelis Antoniou4f001fd2015-01-24 09:16:29 +02001437 for_each_available_child_of_node(adap->dev.of_node, node) {
1438 if (of_node_test_and_set_flag(node, OF_POPULATED))
1439 continue;
Pantelis Antonioua430a3452014-10-28 22:36:02 +02001440 of_i2c_register_device(adap, node);
Pantelis Antoniou4f001fd2015-01-24 09:16:29 +02001441 }
Wolfram Sang687b81d2013-07-11 12:56:15 +01001442}
1443
1444static int of_dev_node_match(struct device *dev, void *data)
1445{
1446 return dev->of_node == data;
1447}
1448
1449/* must call put_device() when done with returned i2c_client device */
1450struct i2c_client *of_find_i2c_device_by_node(struct device_node *node)
1451{
1452 struct device *dev;
Vladimir Zapolskiye3311462015-07-27 17:30:48 +03001453 struct i2c_client *client;
Wolfram Sang687b81d2013-07-11 12:56:15 +01001454
Vladimir Zapolskiye3311462015-07-27 17:30:48 +03001455 dev = bus_find_device(&i2c_bus_type, NULL, node, of_dev_node_match);
Wolfram Sang687b81d2013-07-11 12:56:15 +01001456 if (!dev)
1457 return NULL;
1458
Vladimir Zapolskiye3311462015-07-27 17:30:48 +03001459 client = i2c_verify_client(dev);
1460 if (!client)
1461 put_device(dev);
1462
1463 return client;
Wolfram Sang687b81d2013-07-11 12:56:15 +01001464}
1465EXPORT_SYMBOL(of_find_i2c_device_by_node);
1466
1467/* must call put_device() when done with returned i2c_adapter device */
1468struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node)
1469{
1470 struct device *dev;
Vladimir Zapolskiye3311462015-07-27 17:30:48 +03001471 struct i2c_adapter *adapter;
Wolfram Sang687b81d2013-07-11 12:56:15 +01001472
Vladimir Zapolskiye3311462015-07-27 17:30:48 +03001473 dev = bus_find_device(&i2c_bus_type, NULL, node, of_dev_node_match);
Wolfram Sang687b81d2013-07-11 12:56:15 +01001474 if (!dev)
1475 return NULL;
1476
Vladimir Zapolskiye3311462015-07-27 17:30:48 +03001477 adapter = i2c_verify_adapter(dev);
1478 if (!adapter)
1479 put_device(dev);
1480
1481 return adapter;
Wolfram Sang687b81d2013-07-11 12:56:15 +01001482}
1483EXPORT_SYMBOL(of_find_i2c_adapter_by_node);
Vladimir Zapolskiy48e97432015-07-27 17:30:50 +03001484
1485/* must call i2c_put_adapter() when done with returned i2c_adapter device */
1486struct i2c_adapter *of_get_i2c_adapter_by_node(struct device_node *node)
1487{
1488 struct i2c_adapter *adapter;
1489
1490 adapter = of_find_i2c_adapter_by_node(node);
1491 if (!adapter)
1492 return NULL;
1493
1494 if (!try_module_get(adapter->owner)) {
1495 put_device(&adapter->dev);
1496 adapter = NULL;
1497 }
1498
1499 return adapter;
1500}
1501EXPORT_SYMBOL(of_get_i2c_adapter_by_node);
Wolfram Sang687b81d2013-07-11 12:56:15 +01001502#else
1503static void of_i2c_register_devices(struct i2c_adapter *adap) { }
1504#endif /* CONFIG_OF */
1505
Jean Delvare69b00892009-12-06 17:06:27 +01001506static int i2c_do_add_adapter(struct i2c_driver *driver,
1507 struct i2c_adapter *adap)
Jean Delvare026526f2008-01-27 18:14:49 +01001508{
Jean Delvare4735c982008-07-14 22:38:36 +02001509 /* Detect supported devices on that bus, and instantiate them */
1510 i2c_detect(adap, driver);
1511
1512 /* Let legacy drivers scan this bus for matching devices */
Jean Delvare026526f2008-01-27 18:14:49 +01001513 if (driver->attach_adapter) {
Jean Delvarea920ff42011-04-17 10:20:19 +02001514 dev_warn(&adap->dev, "%s: attach_adapter method is deprecated\n",
1515 driver->driver.name);
Jean Delvarefe6fc252011-03-20 14:50:53 +01001516 dev_warn(&adap->dev, "Please use another way to instantiate "
1517 "your i2c_client\n");
Jean Delvare026526f2008-01-27 18:14:49 +01001518 /* We ignore the return code; if it fails, too bad */
1519 driver->attach_adapter(adap);
1520 }
1521 return 0;
1522}
1523
Jean Delvare69b00892009-12-06 17:06:27 +01001524static int __process_new_adapter(struct device_driver *d, void *data)
1525{
1526 return i2c_do_add_adapter(to_i2c_driver(d), data);
1527}
1528
David Brownell6e13e642007-05-01 23:26:31 +02001529static int i2c_register_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530{
Jean Delvared6703282010-08-11 18:20:59 +02001531 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
David Brownell1d0b19c2008-10-14 17:30:05 +02001533 /* Can't register until after driver model init */
Sudip Mukherjee95026652016-03-07 17:19:17 +05301534 if (WARN_ON(!is_registered)) {
Jean Delvare35fc37f2009-06-19 16:58:19 +02001535 res = -EAGAIN;
1536 goto out_list;
1537 }
David Brownell1d0b19c2008-10-14 17:30:05 +02001538
Jean Delvare2236baa2010-11-15 22:40:38 +01001539 /* Sanity checks */
1540 if (unlikely(adap->name[0] == '\0')) {
1541 pr_err("i2c-core: Attempt to register an adapter with "
1542 "no name!\n");
1543 return -EINVAL;
1544 }
1545 if (unlikely(!adap->algo)) {
1546 pr_err("i2c-core: Attempt to register adapter '%s' with "
1547 "no algo!\n", adap->name);
1548 return -EINVAL;
1549 }
1550
Peter Rosin8320f492016-05-04 22:15:27 +02001551 if (!adap->lock_bus) {
1552 adap->lock_bus = i2c_adapter_lock_bus;
1553 adap->trylock_bus = i2c_adapter_trylock_bus;
1554 adap->unlock_bus = i2c_adapter_unlock_bus;
1555 }
1556
Mika Kuoppala194684e2009-12-06 17:06:22 +01001557 rt_mutex_init(&adap->bus_lock);
Jean Delvaredafc50d2010-08-11 18:21:01 +02001558 mutex_init(&adap->userspace_clients_lock);
Jean Delvare6629dcf2010-05-04 11:09:28 +02001559 INIT_LIST_HEAD(&adap->userspace_clients);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Jean Delvare8fcfef62009-03-28 21:34:43 +01001561 /* Set default timeout to 1 second if not already set */
1562 if (adap->timeout == 0)
1563 adap->timeout = HZ;
1564
Kay Sievers27d9c182009-01-07 14:29:16 +01001565 dev_set_name(&adap->dev, "i2c-%d", adap->nr);
Jean Delvare4f8cf822009-09-18 22:45:46 +02001566 adap->dev.bus = &i2c_bus_type;
1567 adap->dev.type = &i2c_adapter_type;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001568 res = device_register(&adap->dev);
1569 if (res)
1570 goto out_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001572 dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
1573
Charles Keepax6ada5c12015-04-16 13:05:19 +01001574 pm_runtime_no_callbacks(&adap->dev);
Linus Walleij04f59142016-04-12 09:57:35 +02001575 pm_suspend_ignore_children(&adap->dev, true);
Wolfram Sang9f924162015-12-23 18:19:28 +01001576 pm_runtime_enable(&adap->dev);
Charles Keepax6ada5c12015-04-16 13:05:19 +01001577
Jean Delvare2bb50952009-09-18 22:45:46 +02001578#ifdef CONFIG_I2C_COMPAT
1579 res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
1580 adap->dev.parent);
1581 if (res)
1582 dev_warn(&adap->dev,
1583 "Failed to create compatibility class link\n");
1584#endif
1585
Viresh Kumar5f9296b2012-02-28 18:26:31 +05301586 /* bus recovery specific initialization */
1587 if (adap->bus_recovery_info) {
1588 struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
1589
1590 if (!bri->recover_bus) {
1591 dev_err(&adap->dev, "No recover_bus() found, not using recovery\n");
1592 adap->bus_recovery_info = NULL;
1593 goto exit_recovery;
1594 }
1595
1596 /* Generic GPIO recovery */
1597 if (bri->recover_bus == i2c_generic_gpio_recovery) {
1598 if (!gpio_is_valid(bri->scl_gpio)) {
1599 dev_err(&adap->dev, "Invalid SCL gpio, not using recovery\n");
1600 adap->bus_recovery_info = NULL;
1601 goto exit_recovery;
1602 }
1603
1604 if (gpio_is_valid(bri->sda_gpio))
1605 bri->get_sda = get_sda_gpio_value;
1606 else
1607 bri->get_sda = NULL;
1608
1609 bri->get_scl = get_scl_gpio_value;
1610 bri->set_scl = set_scl_gpio_value;
1611 } else if (!bri->set_scl || !bri->get_scl) {
1612 /* Generic SCL recovery */
1613 dev_err(&adap->dev, "No {get|set}_gpio() found, not using recovery\n");
1614 adap->bus_recovery_info = NULL;
1615 }
1616 }
1617
1618exit_recovery:
Jean Delvare729d6dd2009-06-19 16:58:18 +02001619 /* create pre-declared device nodes */
Wolfram Sang687b81d2013-07-11 12:56:15 +01001620 of_i2c_register_devices(adap);
Mika Westerberg55e71ed2013-08-21 17:28:23 +03001621 acpi_i2c_register_devices(adap);
Lan Tianyu5d98e612014-05-20 20:59:23 +08001622 acpi_i2c_install_space_handler(adap);
Wolfram Sang687b81d2013-07-11 12:56:15 +01001623
David Brownell6e13e642007-05-01 23:26:31 +02001624 if (adap->nr < __i2c_first_dynamic_bus_num)
1625 i2c_scan_static_board_info(adap);
1626
Jean Delvare4735c982008-07-14 22:38:36 +02001627 /* Notify drivers */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001628 mutex_lock(&core_lock);
Jean Delvared6703282010-08-11 18:20:59 +02001629 bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
Jean Delvarecaada322008-01-27 18:14:49 +01001630 mutex_unlock(&core_lock);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001631
1632 return 0;
Jean Delvareb119c6c2006-08-15 18:26:30 +02001633
Jean Delvareb119c6c2006-08-15 18:26:30 +02001634out_list:
Jean Delvare35fc37f2009-06-19 16:58:19 +02001635 mutex_lock(&core_lock);
Jean Delvareb119c6c2006-08-15 18:26:30 +02001636 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001637 mutex_unlock(&core_lock);
1638 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639}
1640
David Brownell6e13e642007-05-01 23:26:31 +02001641/**
Doug Andersonee5c2742013-03-01 08:57:31 -08001642 * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1
1643 * @adap: the adapter to register (with adap->nr initialized)
1644 * Context: can sleep
1645 *
1646 * See i2c_add_numbered_adapter() for details.
1647 */
1648static int __i2c_add_numbered_adapter(struct i2c_adapter *adap)
1649{
1650 int id;
1651
1652 mutex_lock(&core_lock);
1653 id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1,
1654 GFP_KERNEL);
1655 mutex_unlock(&core_lock);
1656 if (id < 0)
1657 return id == -ENOSPC ? -EBUSY : id;
1658
1659 return i2c_register_adapter(adap);
1660}
1661
1662/**
David Brownell6e13e642007-05-01 23:26:31 +02001663 * i2c_add_adapter - declare i2c adapter, use dynamic bus number
1664 * @adapter: the adapter to add
David Brownelld64f73b2007-07-12 14:12:28 +02001665 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001666 *
1667 * This routine is used to declare an I2C adapter when its bus number
Doug Andersonee5c2742013-03-01 08:57:31 -08001668 * doesn't matter or when its bus number is specified by an dt alias.
1669 * Examples of bases when the bus number doesn't matter: I2C adapters
1670 * dynamically added by USB links or PCI plugin cards.
David Brownell6e13e642007-05-01 23:26:31 +02001671 *
1672 * When this returns zero, a new bus number was allocated and stored
1673 * in adap->nr, and the specified adapter became available for clients.
1674 * Otherwise, a negative errno value is returned.
1675 */
1676int i2c_add_adapter(struct i2c_adapter *adapter)
1677{
Doug Andersonee5c2742013-03-01 08:57:31 -08001678 struct device *dev = &adapter->dev;
Tejun Heo4ae42b0f2013-02-27 17:04:15 -08001679 int id;
David Brownell6e13e642007-05-01 23:26:31 +02001680
Doug Andersonee5c2742013-03-01 08:57:31 -08001681 if (dev->of_node) {
1682 id = of_alias_get_id(dev->of_node, "i2c");
1683 if (id >= 0) {
1684 adapter->nr = id;
1685 return __i2c_add_numbered_adapter(adapter);
1686 }
1687 }
1688
Jean Delvarecaada322008-01-27 18:14:49 +01001689 mutex_lock(&core_lock);
Tejun Heo4ae42b0f2013-02-27 17:04:15 -08001690 id = idr_alloc(&i2c_adapter_idr, adapter,
1691 __i2c_first_dynamic_bus_num, 0, GFP_KERNEL);
Jean Delvarecaada322008-01-27 18:14:49 +01001692 mutex_unlock(&core_lock);
Tejun Heo4ae42b0f2013-02-27 17:04:15 -08001693 if (id < 0)
1694 return id;
David Brownell6e13e642007-05-01 23:26:31 +02001695
1696 adapter->nr = id;
Tejun Heo4ae42b0f2013-02-27 17:04:15 -08001697
David Brownell6e13e642007-05-01 23:26:31 +02001698 return i2c_register_adapter(adapter);
1699}
1700EXPORT_SYMBOL(i2c_add_adapter);
1701
1702/**
1703 * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
1704 * @adap: the adapter to register (with adap->nr initialized)
David Brownelld64f73b2007-07-12 14:12:28 +02001705 * Context: can sleep
David Brownell6e13e642007-05-01 23:26:31 +02001706 *
1707 * This routine is used to declare an I2C adapter when its bus number
Randy Dunlap8c07e462008-03-23 20:28:20 +01001708 * matters. For example, use it for I2C adapters from system-on-chip CPUs,
1709 * or otherwise built in to the system's mainboard, and where i2c_board_info
David Brownell6e13e642007-05-01 23:26:31 +02001710 * is used to properly configure I2C devices.
1711 *
Grant Likely488bf312011-07-25 17:49:43 +02001712 * If the requested bus number is set to -1, then this function will behave
1713 * identically to i2c_add_adapter, and will dynamically assign a bus number.
1714 *
David Brownell6e13e642007-05-01 23:26:31 +02001715 * If no devices have pre-been declared for this bus, then be sure to
1716 * register the adapter before any dynamically allocated ones. Otherwise
1717 * the required bus ID may not be available.
1718 *
1719 * When this returns zero, the specified adapter became available for
1720 * clients using the bus number provided in adap->nr. Also, the table
1721 * of I2C devices pre-declared using i2c_register_board_info() is scanned,
1722 * and the appropriate driver model device nodes are created. Otherwise, a
1723 * negative errno value is returned.
1724 */
1725int i2c_add_numbered_adapter(struct i2c_adapter *adap)
1726{
Grant Likely488bf312011-07-25 17:49:43 +02001727 if (adap->nr == -1) /* -1 means dynamically assign bus id */
1728 return i2c_add_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001729
Doug Andersonee5c2742013-03-01 08:57:31 -08001730 return __i2c_add_numbered_adapter(adap);
David Brownell6e13e642007-05-01 23:26:31 +02001731}
1732EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
1733
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001734static void i2c_do_del_adapter(struct i2c_driver *driver,
Jean Delvare69b00892009-12-06 17:06:27 +01001735 struct i2c_adapter *adapter)
Jean Delvare026526f2008-01-27 18:14:49 +01001736{
Jean Delvare4735c982008-07-14 22:38:36 +02001737 struct i2c_client *client, *_n;
Jean Delvare026526f2008-01-27 18:14:49 +01001738
Jean Delvareacec2112009-03-28 21:34:40 +01001739 /* Remove the devices we created ourselves as the result of hardware
1740 * probing (using a driver's detect method) */
Jean Delvare4735c982008-07-14 22:38:36 +02001741 list_for_each_entry_safe(client, _n, &driver->clients, detected) {
1742 if (client->adapter == adapter) {
1743 dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
1744 client->name, client->addr);
1745 list_del(&client->detected);
1746 i2c_unregister_device(client);
1747 }
1748 }
Jean Delvare026526f2008-01-27 18:14:49 +01001749}
1750
Jean Delvaree549c2b2009-06-19 16:58:19 +02001751static int __unregister_client(struct device *dev, void *dummy)
1752{
1753 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvare5219bf82011-01-14 22:03:49 +01001754 if (client && strcmp(client->name, "dummy"))
1755 i2c_unregister_device(client);
1756 return 0;
1757}
1758
1759static int __unregister_dummy(struct device *dev, void *dummy)
1760{
1761 struct i2c_client *client = i2c_verify_client(dev);
Jean Delvaree549c2b2009-06-19 16:58:19 +02001762 if (client)
1763 i2c_unregister_device(client);
1764 return 0;
1765}
1766
Jean Delvare69b00892009-12-06 17:06:27 +01001767static int __process_removed_adapter(struct device_driver *d, void *data)
1768{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001769 i2c_do_del_adapter(to_i2c_driver(d), data);
1770 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001771}
1772
David Brownelld64f73b2007-07-12 14:12:28 +02001773/**
1774 * i2c_del_adapter - unregister I2C adapter
1775 * @adap: the adapter being unregistered
1776 * Context: can sleep
1777 *
1778 * This unregisters an I2C adapter which was previously registered
1779 * by @i2c_add_adapter or @i2c_add_numbered_adapter.
1780 */
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001781void i2c_del_adapter(struct i2c_adapter *adap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782{
Jean Delvare35fc37f2009-06-19 16:58:19 +02001783 struct i2c_adapter *found;
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001784 struct i2c_client *client, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785
1786 /* First make sure that this adapter was ever added */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001787 mutex_lock(&core_lock);
1788 found = idr_find(&i2c_adapter_idr, adap->nr);
1789 mutex_unlock(&core_lock);
1790 if (found != adap) {
Jean Delvareb6d7b3d2005-07-31 19:02:53 +02001791 pr_debug("i2c-core: attempting to delete unregistered "
1792 "adapter [%s]\n", adap->name);
Lars-Peter Clausen71546302013-03-09 08:16:47 +00001793 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 }
1795
Lan Tianyu5d98e612014-05-20 20:59:23 +08001796 acpi_i2c_remove_space_handler(adap);
Jean Delvare026526f2008-01-27 18:14:49 +01001797 /* Tell drivers about this removal */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001798 mutex_lock(&core_lock);
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001799 bus_for_each_drv(&i2c_bus_type, NULL, adap,
Jean Delvare69b00892009-12-06 17:06:27 +01001800 __process_removed_adapter);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001801 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001803 /* Remove devices instantiated from sysfs */
Jean Delvare390946b2012-09-10 10:14:02 +02001804 mutex_lock_nested(&adap->userspace_clients_lock,
1805 i2c_adapter_depth(adap));
Jean Delvare6629dcf2010-05-04 11:09:28 +02001806 list_for_each_entry_safe(client, next, &adap->userspace_clients,
1807 detected) {
1808 dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
1809 client->addr);
1810 list_del(&client->detected);
1811 i2c_unregister_device(client);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001812 }
Jean Delvaredafc50d2010-08-11 18:21:01 +02001813 mutex_unlock(&adap->userspace_clients_lock);
Jean Delvarebbd2d9c2009-11-26 09:22:33 +01001814
Jean Delvaree549c2b2009-06-19 16:58:19 +02001815 /* Detach any active clients. This can't fail, thus we do not
Jean Delvare5219bf82011-01-14 22:03:49 +01001816 * check the returned value. This is a two-pass process, because
1817 * we can't remove the dummy devices during the first pass: they
1818 * could have been instantiated by real devices wishing to clean
1819 * them up properly, so we give them a chance to do that first. */
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001820 device_for_each_child(&adap->dev, NULL, __unregister_client);
1821 device_for_each_child(&adap->dev, NULL, __unregister_dummy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Jean Delvare2bb50952009-09-18 22:45:46 +02001823#ifdef CONFIG_I2C_COMPAT
1824 class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
1825 adap->dev.parent);
1826#endif
1827
Thadeu Lima de Souza Cascardoc5567522010-01-16 20:43:13 +01001828 /* device name is gone after device_unregister */
1829 dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
1830
Wolfram Sang9f924162015-12-23 18:19:28 +01001831 pm_runtime_disable(&adap->dev);
1832
Wolfram Sang26680ee2015-01-29 22:45:09 +01001833 /* wait until all references to the device are gone
1834 *
1835 * FIXME: This is old code and should ideally be replaced by an
1836 * alternative which results in decoupling the lifetime of the struct
1837 * device from the i2c_adapter, like spi or netdev do. Any solution
Shailendra Verma95cc1e32015-05-18 22:24:01 +05301838 * should be thoroughly tested with DEBUG_KOBJECT_RELEASE enabled!
Wolfram Sang26680ee2015-01-29 22:45:09 +01001839 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 init_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 device_unregister(&adap->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 wait_for_completion(&adap->dev_released);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843
David Brownell6e13e642007-05-01 23:26:31 +02001844 /* free bus id */
Jean Delvare35fc37f2009-06-19 16:58:19 +02001845 mutex_lock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 idr_remove(&i2c_adapter_idr, adap->nr);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001847 mutex_unlock(&core_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848
Jean Delvarebd4bc3db2008-07-16 19:30:05 +02001849 /* Clear the device structure in case this adapter is ever going to be
1850 added again */
1851 memset(&adap->dev, 0, sizeof(adap->dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852}
David Brownellc0564602007-05-01 23:26:31 +02001853EXPORT_SYMBOL(i2c_del_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
Wolfram Sang54177cc2015-12-17 13:32:36 +01001855/**
1856 * i2c_parse_fw_timings - get I2C related timing parameters from firmware
1857 * @dev: The device to scan for I2C timing properties
1858 * @t: the i2c_timings struct to be filled with values
1859 * @use_defaults: bool to use sane defaults derived from the I2C specification
1860 * when properties are not found, otherwise use 0
1861 *
1862 * Scan the device for the generic I2C properties describing timing parameters
1863 * for the signal and fill the given struct with the results. If a property was
1864 * not found and use_defaults was true, then maximum timings are assumed which
1865 * are derived from the I2C specification. If use_defaults is not used, the
1866 * results will be 0, so drivers can apply their own defaults later. The latter
1867 * is mainly intended for avoiding regressions of existing drivers which want
1868 * to switch to this function. New drivers almost always should use the defaults.
1869 */
1870
1871void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults)
1872{
1873 int ret;
1874
1875 memset(t, 0, sizeof(*t));
1876
1877 ret = device_property_read_u32(dev, "clock-frequency", &t->bus_freq_hz);
1878 if (ret && use_defaults)
1879 t->bus_freq_hz = 100000;
1880
1881 ret = device_property_read_u32(dev, "i2c-scl-rising-time-ns", &t->scl_rise_ns);
1882 if (ret && use_defaults) {
1883 if (t->bus_freq_hz <= 100000)
1884 t->scl_rise_ns = 1000;
1885 else if (t->bus_freq_hz <= 400000)
1886 t->scl_rise_ns = 300;
1887 else
1888 t->scl_rise_ns = 120;
1889 }
1890
1891 ret = device_property_read_u32(dev, "i2c-scl-falling-time-ns", &t->scl_fall_ns);
1892 if (ret && use_defaults) {
1893 if (t->bus_freq_hz <= 400000)
1894 t->scl_fall_ns = 300;
1895 else
1896 t->scl_fall_ns = 120;
1897 }
1898
1899 device_property_read_u32(dev, "i2c-scl-internal-delay-ns", &t->scl_int_delay_ns);
1900
1901 ret = device_property_read_u32(dev, "i2c-sda-falling-time-ns", &t->sda_fall_ns);
1902 if (ret && use_defaults)
1903 t->sda_fall_ns = t->scl_fall_ns;
1904}
1905EXPORT_SYMBOL_GPL(i2c_parse_fw_timings);
1906
David Brownell7b4fbc52007-05-01 23:26:30 +02001907/* ------------------------------------------------------------------------- */
1908
Jean Delvare7ae31482011-03-20 14:50:52 +01001909int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *))
1910{
1911 int res;
1912
1913 mutex_lock(&core_lock);
1914 res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn);
1915 mutex_unlock(&core_lock);
1916
1917 return res;
1918}
1919EXPORT_SYMBOL_GPL(i2c_for_each_dev);
1920
Jean Delvare69b00892009-12-06 17:06:27 +01001921static int __process_new_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001922{
Jean Delvare4f8cf822009-09-18 22:45:46 +02001923 if (dev->type != &i2c_adapter_type)
1924 return 0;
Jean Delvare69b00892009-12-06 17:06:27 +01001925 return i2c_do_add_adapter(data, to_i2c_adapter(dev));
Dave Young7f101a92008-07-14 22:38:19 +02001926}
1927
David Brownell7b4fbc52007-05-01 23:26:30 +02001928/*
1929 * An i2c_driver is used with one or more i2c_client (device) nodes to access
Jean Delvare729d6dd2009-06-19 16:58:18 +02001930 * i2c slave chips, on a bus instance associated with some i2c_adapter.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 */
1932
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001933int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934{
Jean Delvare7eebcb72006-02-05 23:28:21 +01001935 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936
David Brownell1d0b19c2008-10-14 17:30:05 +02001937 /* Can't register until after driver model init */
Sudip Mukherjee95026652016-03-07 17:19:17 +05301938 if (WARN_ON(!is_registered))
David Brownell1d0b19c2008-10-14 17:30:05 +02001939 return -EAGAIN;
1940
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 /* add the driver to the list of i2c drivers in the driver core */
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001942 driver->driver.owner = owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 driver->driver.bus = &i2c_bus_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944
Jean Delvare729d6dd2009-06-19 16:58:18 +02001945 /* When registration returns, the driver core
David Brownell6e13e642007-05-01 23:26:31 +02001946 * will have called probe() for all matching-but-unbound devices.
1947 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 res = driver_register(&driver->driver);
1949 if (res)
Jean Delvare7eebcb72006-02-05 23:28:21 +01001950 return res;
David Brownell438d6c22006-12-10 21:21:31 +01001951
Laurent Riffard35d8b2e2005-11-26 20:34:05 +01001952 pr_debug("i2c-core: driver [%s] registered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
Jean Delvare4735c982008-07-14 22:38:36 +02001954 INIT_LIST_HEAD(&driver->clients);
1955 /* Walk the adapters that are already present */
Jean Delvare7ae31482011-03-20 14:50:52 +01001956 i2c_for_each_dev(driver, __process_new_driver);
Jean Delvare35fc37f2009-06-19 16:58:19 +02001957
Jean Delvare7eebcb72006-02-05 23:28:21 +01001958 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959}
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -08001960EXPORT_SYMBOL(i2c_register_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961
Jean Delvare69b00892009-12-06 17:06:27 +01001962static int __process_removed_driver(struct device *dev, void *data)
Dave Young7f101a92008-07-14 22:38:19 +02001963{
Lars-Peter Clausen19baba42013-03-09 08:16:44 +00001964 if (dev->type == &i2c_adapter_type)
1965 i2c_do_del_adapter(data, to_i2c_adapter(dev));
1966 return 0;
Dave Young7f101a92008-07-14 22:38:19 +02001967}
1968
David Brownella1d9e6e2007-05-01 23:26:30 +02001969/**
1970 * i2c_del_driver - unregister I2C driver
1971 * @driver: the driver being unregistered
David Brownelld64f73b2007-07-12 14:12:28 +02001972 * Context: can sleep
David Brownella1d9e6e2007-05-01 23:26:30 +02001973 */
Jean Delvareb3e82092007-05-01 23:26:32 +02001974void i2c_del_driver(struct i2c_driver *driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975{
Jean Delvare7ae31482011-03-20 14:50:52 +01001976 i2c_for_each_dev(driver, __process_removed_driver);
David Brownella1d9e6e2007-05-01 23:26:30 +02001977
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 driver_unregister(&driver->driver);
Laurent Riffard35d8b2e2005-11-26 20:34:05 +01001979 pr_debug("i2c-core: driver [%s] unregistered\n", driver->driver.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980}
David Brownellc0564602007-05-01 23:26:31 +02001981EXPORT_SYMBOL(i2c_del_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982
David Brownell7b4fbc52007-05-01 23:26:30 +02001983/* ------------------------------------------------------------------------- */
1984
Jean Delvaree48d3312008-01-27 18:14:48 +01001985/**
1986 * i2c_use_client - increments the reference count of the i2c client structure
1987 * @client: the client being referenced
1988 *
1989 * Each live reference to a client should be refcounted. The driver model does
1990 * that automatically as part of driver binding, so that most drivers don't
1991 * need to do this explicitly: they hold a reference until they're unbound
1992 * from the device.
1993 *
1994 * A pointer to the client with the incremented reference counter is returned.
1995 */
1996struct i2c_client *i2c_use_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997{
David Brownell6ea438e2008-07-14 22:38:24 +02001998 if (client && get_device(&client->dev))
1999 return client;
2000 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001}
David Brownellc0564602007-05-01 23:26:31 +02002002EXPORT_SYMBOL(i2c_use_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003
Jean Delvaree48d3312008-01-27 18:14:48 +01002004/**
2005 * i2c_release_client - release a use of the i2c client structure
2006 * @client: the client being no longer referenced
2007 *
2008 * Must be called when a user of a client is finished with it.
2009 */
2010void i2c_release_client(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011{
David Brownell6ea438e2008-07-14 22:38:24 +02002012 if (client)
2013 put_device(&client->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014}
David Brownellc0564602007-05-01 23:26:31 +02002015EXPORT_SYMBOL(i2c_release_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016
David Brownell9b766b82008-01-27 18:14:51 +01002017struct i2c_cmd_arg {
2018 unsigned cmd;
2019 void *arg;
2020};
2021
2022static int i2c_cmd(struct device *dev, void *_arg)
2023{
2024 struct i2c_client *client = i2c_verify_client(dev);
2025 struct i2c_cmd_arg *arg = _arg;
Lars-Peter Clausen0acc2b32013-09-29 10:51:06 +02002026 struct i2c_driver *driver;
David Brownell9b766b82008-01-27 18:14:51 +01002027
Lars-Peter Clausen0acc2b32013-09-29 10:51:06 +02002028 if (!client || !client->dev.driver)
2029 return 0;
2030
2031 driver = to_i2c_driver(client->dev.driver);
2032 if (driver->command)
2033 driver->command(client, arg->cmd, arg->arg);
David Brownell9b766b82008-01-27 18:14:51 +01002034 return 0;
2035}
2036
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
2038{
David Brownell9b766b82008-01-27 18:14:51 +01002039 struct i2c_cmd_arg cmd_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
David Brownell9b766b82008-01-27 18:14:51 +01002041 cmd_arg.cmd = cmd;
2042 cmd_arg.arg = arg;
2043 device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044}
David Brownellc0564602007-05-01 23:26:31 +02002045EXPORT_SYMBOL(i2c_clients_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
Pantelis Antoniouea7513b2014-10-28 22:36:03 +02002047#if IS_ENABLED(CONFIG_OF_DYNAMIC)
2048static int of_i2c_notify(struct notifier_block *nb, unsigned long action,
2049 void *arg)
2050{
2051 struct of_reconfig_data *rd = arg;
2052 struct i2c_adapter *adap;
2053 struct i2c_client *client;
2054
2055 switch (of_reconfig_get_state_change(action, rd)) {
2056 case OF_RECONFIG_CHANGE_ADD:
2057 adap = of_find_i2c_adapter_by_node(rd->dn->parent);
2058 if (adap == NULL)
2059 return NOTIFY_OK; /* not for us */
2060
Pantelis Antoniou4f001fd2015-01-24 09:16:29 +02002061 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) {
2062 put_device(&adap->dev);
2063 return NOTIFY_OK;
2064 }
2065
Pantelis Antoniouea7513b2014-10-28 22:36:03 +02002066 client = of_i2c_register_device(adap, rd->dn);
2067 put_device(&adap->dev);
2068
2069 if (IS_ERR(client)) {
2070 pr_err("%s: failed to create for '%s'\n",
2071 __func__, rd->dn->full_name);
2072 return notifier_from_errno(PTR_ERR(client));
2073 }
2074 break;
2075 case OF_RECONFIG_CHANGE_REMOVE:
Pantelis Antoniou4f001fd2015-01-24 09:16:29 +02002076 /* already depopulated? */
2077 if (!of_node_check_flag(rd->dn, OF_POPULATED))
2078 return NOTIFY_OK;
2079
Pantelis Antoniouea7513b2014-10-28 22:36:03 +02002080 /* find our device by node */
2081 client = of_find_i2c_device_by_node(rd->dn);
2082 if (client == NULL)
2083 return NOTIFY_OK; /* no? not meant for us */
2084
2085 /* unregister takes one ref away */
2086 i2c_unregister_device(client);
2087
2088 /* and put the reference of the find */
2089 put_device(&client->dev);
2090 break;
2091 }
2092
2093 return NOTIFY_OK;
2094}
2095static struct notifier_block i2c_of_notifier = {
2096 .notifier_call = of_i2c_notify,
2097};
2098#else
2099extern struct notifier_block i2c_of_notifier;
2100#endif /* CONFIG_OF_DYNAMIC */
2101
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102static int __init i2c_init(void)
2103{
2104 int retval;
2105
Wolfram Sang03bde7c2015-03-12 17:17:59 +01002106 retval = of_alias_get_highest_id("i2c");
2107
2108 down_write(&__i2c_board_lock);
2109 if (retval >= __i2c_first_dynamic_bus_num)
2110 __i2c_first_dynamic_bus_num = retval + 1;
2111 up_write(&__i2c_board_lock);
2112
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 retval = bus_register(&i2c_bus_type);
2114 if (retval)
2115 return retval;
Wolfram Sangb980a262016-03-14 10:41:52 +01002116
2117 is_registered = true;
2118
Jean Delvare2bb50952009-09-18 22:45:46 +02002119#ifdef CONFIG_I2C_COMPAT
2120 i2c_adapter_compat_class = class_compat_register("i2c-adapter");
2121 if (!i2c_adapter_compat_class) {
2122 retval = -ENOMEM;
2123 goto bus_err;
2124 }
2125#endif
David Brownelle9f13732008-01-27 18:14:52 +01002126 retval = i2c_add_driver(&dummy_driver);
2127 if (retval)
Jean Delvare2bb50952009-09-18 22:45:46 +02002128 goto class_err;
Pantelis Antoniouea7513b2014-10-28 22:36:03 +02002129
2130 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
2131 WARN_ON(of_reconfig_notifier_register(&i2c_of_notifier));
2132
David Brownelle9f13732008-01-27 18:14:52 +01002133 return 0;
2134
Jean Delvare2bb50952009-09-18 22:45:46 +02002135class_err:
2136#ifdef CONFIG_I2C_COMPAT
2137 class_compat_unregister(i2c_adapter_compat_class);
David Brownelle9f13732008-01-27 18:14:52 +01002138bus_err:
Jean Delvare2bb50952009-09-18 22:45:46 +02002139#endif
Wolfram Sangb980a262016-03-14 10:41:52 +01002140 is_registered = false;
David Brownelle9f13732008-01-27 18:14:52 +01002141 bus_unregister(&i2c_bus_type);
2142 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143}
2144
2145static void __exit i2c_exit(void)
2146{
Pantelis Antoniouea7513b2014-10-28 22:36:03 +02002147 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
2148 WARN_ON(of_reconfig_notifier_unregister(&i2c_of_notifier));
David Brownelle9f13732008-01-27 18:14:52 +01002149 i2c_del_driver(&dummy_driver);
Jean Delvare2bb50952009-09-18 22:45:46 +02002150#ifdef CONFIG_I2C_COMPAT
2151 class_compat_unregister(i2c_adapter_compat_class);
2152#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 bus_unregister(&i2c_bus_type);
David Howellsd9a83d62014-03-06 13:35:59 +00002154 tracepoint_synchronize_unregister();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155}
2156
David Brownella10f9e72008-10-14 17:30:06 +02002157/* We must initialize early, because some subsystems register i2c drivers
2158 * in subsys_initcall() code, but are linked (and initialized) before i2c.
2159 */
2160postcore_initcall(i2c_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161module_exit(i2c_exit);
2162
2163/* ----------------------------------------------------
2164 * the functional interface to the i2c busses.
2165 * ----------------------------------------------------
2166 */
2167
Wolfram Sangb7f62582015-01-05 23:45:59 +01002168/* Check if val is exceeding the quirk IFF quirk is non 0 */
2169#define i2c_quirk_exceeded(val, quirk) ((quirk) && ((val) > (quirk)))
2170
2171static int i2c_quirk_error(struct i2c_adapter *adap, struct i2c_msg *msg, char *err_msg)
2172{
2173 dev_err_ratelimited(&adap->dev, "adapter quirk: %s (addr 0x%04x, size %u, %s)\n",
2174 err_msg, msg->addr, msg->len,
2175 msg->flags & I2C_M_RD ? "read" : "write");
2176 return -EOPNOTSUPP;
2177}
2178
2179static int i2c_check_for_quirks(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
2180{
2181 const struct i2c_adapter_quirks *q = adap->quirks;
2182 int max_num = q->max_num_msgs, i;
2183 bool do_len_check = true;
2184
2185 if (q->flags & I2C_AQ_COMB) {
2186 max_num = 2;
2187
2188 /* special checks for combined messages */
2189 if (num == 2) {
2190 if (q->flags & I2C_AQ_COMB_WRITE_FIRST && msgs[0].flags & I2C_M_RD)
2191 return i2c_quirk_error(adap, &msgs[0], "1st comb msg must be write");
2192
2193 if (q->flags & I2C_AQ_COMB_READ_SECOND && !(msgs[1].flags & I2C_M_RD))
2194 return i2c_quirk_error(adap, &msgs[1], "2nd comb msg must be read");
2195
2196 if (q->flags & I2C_AQ_COMB_SAME_ADDR && msgs[0].addr != msgs[1].addr)
2197 return i2c_quirk_error(adap, &msgs[0], "comb msg only to same addr");
2198
2199 if (i2c_quirk_exceeded(msgs[0].len, q->max_comb_1st_msg_len))
2200 return i2c_quirk_error(adap, &msgs[0], "msg too long");
2201
2202 if (i2c_quirk_exceeded(msgs[1].len, q->max_comb_2nd_msg_len))
2203 return i2c_quirk_error(adap, &msgs[1], "msg too long");
2204
2205 do_len_check = false;
2206 }
2207 }
2208
2209 if (i2c_quirk_exceeded(num, max_num))
2210 return i2c_quirk_error(adap, &msgs[0], "too many messages");
2211
2212 for (i = 0; i < num; i++) {
2213 u16 len = msgs[i].len;
2214
2215 if (msgs[i].flags & I2C_M_RD) {
2216 if (do_len_check && i2c_quirk_exceeded(len, q->max_read_len))
2217 return i2c_quirk_error(adap, &msgs[i], "msg too long");
2218 } else {
2219 if (do_len_check && i2c_quirk_exceeded(len, q->max_write_len))
2220 return i2c_quirk_error(adap, &msgs[i], "msg too long");
2221 }
2222 }
2223
2224 return 0;
2225}
2226
David Brownella1cdeda2008-07-14 22:38:24 +02002227/**
Jean Delvareb37d2a32012-06-29 07:47:19 -03002228 * __i2c_transfer - unlocked flavor of i2c_transfer
2229 * @adap: Handle to I2C bus
2230 * @msgs: One or more messages to execute before STOP is issued to
2231 * terminate the operation; each message begins with a START.
2232 * @num: Number of messages to be executed.
2233 *
2234 * Returns negative errno, else the number of messages executed.
2235 *
2236 * Adapter lock must be held when calling this function. No debug logging
2237 * takes place. adap->algo->master_xfer existence isn't checked.
2238 */
2239int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
2240{
2241 unsigned long orig_jiffies;
2242 int ret, try;
2243
Wolfram Sangb7f62582015-01-05 23:45:59 +01002244 if (adap->quirks && i2c_check_for_quirks(adap, msgs, num))
2245 return -EOPNOTSUPP;
2246
David Howellsd9a83d62014-03-06 13:35:59 +00002247 /* i2c_trace_msg gets enabled when tracepoint i2c_transfer gets
2248 * enabled. This is an efficient way of keeping the for-loop from
2249 * being executed when not needed.
2250 */
2251 if (static_key_false(&i2c_trace_msg)) {
2252 int i;
2253 for (i = 0; i < num; i++)
2254 if (msgs[i].flags & I2C_M_RD)
2255 trace_i2c_read(adap, &msgs[i], i);
2256 else
2257 trace_i2c_write(adap, &msgs[i], i);
2258 }
2259
Jean Delvareb37d2a32012-06-29 07:47:19 -03002260 /* Retry automatically on arbitration loss */
2261 orig_jiffies = jiffies;
2262 for (ret = 0, try = 0; try <= adap->retries; try++) {
2263 ret = adap->algo->master_xfer(adap, msgs, num);
2264 if (ret != -EAGAIN)
2265 break;
2266 if (time_after(jiffies, orig_jiffies + adap->timeout))
2267 break;
2268 }
2269
David Howellsd9a83d62014-03-06 13:35:59 +00002270 if (static_key_false(&i2c_trace_msg)) {
2271 int i;
2272 for (i = 0; i < ret; i++)
2273 if (msgs[i].flags & I2C_M_RD)
2274 trace_i2c_reply(adap, &msgs[i], i);
2275 trace_i2c_result(adap, i, ret);
2276 }
2277
Jean Delvareb37d2a32012-06-29 07:47:19 -03002278 return ret;
2279}
2280EXPORT_SYMBOL(__i2c_transfer);
2281
2282/**
David Brownella1cdeda2008-07-14 22:38:24 +02002283 * i2c_transfer - execute a single or combined I2C message
2284 * @adap: Handle to I2C bus
2285 * @msgs: One or more messages to execute before STOP is issued to
2286 * terminate the operation; each message begins with a START.
2287 * @num: Number of messages to be executed.
2288 *
2289 * Returns negative errno, else the number of messages executed.
2290 *
2291 * Note that there is no requirement that each message be sent to
2292 * the same slave address, although that is the most common model.
2293 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01002294int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295{
Jean Delvareb37d2a32012-06-29 07:47:19 -03002296 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297
David Brownella1cdeda2008-07-14 22:38:24 +02002298 /* REVISIT the fault reporting model here is weak:
2299 *
2300 * - When we get an error after receiving N bytes from a slave,
2301 * there is no way to report "N".
2302 *
2303 * - When we get a NAK after transmitting N bytes to a slave,
2304 * there is no way to report "N" ... or to let the master
2305 * continue executing the rest of this combined message, if
2306 * that's the appropriate response.
2307 *
2308 * - When for example "num" is two and we successfully complete
2309 * the first message but get an error part way through the
2310 * second, it's unclear whether that should be reported as
2311 * one (discarding status on the second message) or errno
2312 * (discarding status on the first one).
2313 */
2314
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 if (adap->algo->master_xfer) {
2316#ifdef DEBUG
2317 for (ret = 0; ret < num; ret++) {
2318 dev_dbg(&adap->dev, "master_xfer[%d] %c, addr=0x%02x, "
Jean Delvare209d27c2007-05-01 23:26:29 +02002319 "len=%d%s\n", ret, (msgs[ret].flags & I2C_M_RD)
2320 ? 'R' : 'W', msgs[ret].addr, msgs[ret].len,
2321 (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 }
2323#endif
2324
Mike Rapoportcea443a2008-01-27 18:14:50 +01002325 if (in_atomic() || irqs_disabled()) {
Peter Rosin8320f492016-05-04 22:15:27 +02002326 ret = adap->trylock_bus(adap, I2C_LOCK_SEGMENT);
Mike Rapoportcea443a2008-01-27 18:14:50 +01002327 if (!ret)
2328 /* I2C activity is ongoing. */
2329 return -EAGAIN;
2330 } else {
Peter Rosin8320f492016-05-04 22:15:27 +02002331 i2c_lock_bus(adap, I2C_LOCK_SEGMENT);
Mike Rapoportcea443a2008-01-27 18:14:50 +01002332 }
2333
Jean Delvareb37d2a32012-06-29 07:47:19 -03002334 ret = __i2c_transfer(adap, msgs, num);
Peter Rosin8320f492016-05-04 22:15:27 +02002335 i2c_unlock_bus(adap, I2C_LOCK_SEGMENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336
2337 return ret;
2338 } else {
2339 dev_dbg(&adap->dev, "I2C level transfers not supported\n");
David Brownell24a5bb72008-07-14 22:38:23 +02002340 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 }
2342}
David Brownellc0564602007-05-01 23:26:31 +02002343EXPORT_SYMBOL(i2c_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344
David Brownella1cdeda2008-07-14 22:38:24 +02002345/**
2346 * i2c_master_send - issue a single I2C message in master transmit mode
2347 * @client: Handle to slave device
2348 * @buf: Data that will be written to the slave
Zhangfei Gao0c43ea52010-03-02 12:23:49 +01002349 * @count: How many bytes to write, must be less than 64k since msg.len is u16
David Brownella1cdeda2008-07-14 22:38:24 +02002350 *
2351 * Returns negative errno, or else the number of bytes written.
2352 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002353int i2c_master_send(const struct i2c_client *client, const char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354{
2355 int ret;
Farid Hammane7225acf2010-05-21 18:40:58 +02002356 struct i2c_adapter *adap = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 struct i2c_msg msg;
2358
Jean Delvare815f55f2005-05-07 22:58:46 +02002359 msg.addr = client->addr;
2360 msg.flags = client->flags & I2C_M_TEN;
2361 msg.len = count;
2362 msg.buf = (char *)buf;
David Brownell438d6c22006-12-10 21:21:31 +01002363
Jean Delvare815f55f2005-05-07 22:58:46 +02002364 ret = i2c_transfer(adap, &msg, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365
Wolfram Sang834aa6f2012-03-15 18:11:05 +01002366 /*
2367 * If everything went ok (i.e. 1 msg transmitted), return #bytes
2368 * transmitted, else error code.
2369 */
Jean Delvare815f55f2005-05-07 22:58:46 +02002370 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371}
David Brownellc0564602007-05-01 23:26:31 +02002372EXPORT_SYMBOL(i2c_master_send);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373
David Brownella1cdeda2008-07-14 22:38:24 +02002374/**
2375 * i2c_master_recv - issue a single I2C message in master receive mode
2376 * @client: Handle to slave device
2377 * @buf: Where to store data read from slave
Zhangfei Gao0c43ea52010-03-02 12:23:49 +01002378 * @count: How many bytes to read, must be less than 64k since msg.len is u16
David Brownella1cdeda2008-07-14 22:38:24 +02002379 *
2380 * Returns negative errno, or else the number of bytes read.
2381 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002382int i2c_master_recv(const struct i2c_client *client, char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383{
Farid Hammane7225acf2010-05-21 18:40:58 +02002384 struct i2c_adapter *adap = client->adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 struct i2c_msg msg;
2386 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387
Jean Delvare815f55f2005-05-07 22:58:46 +02002388 msg.addr = client->addr;
2389 msg.flags = client->flags & I2C_M_TEN;
2390 msg.flags |= I2C_M_RD;
2391 msg.len = count;
2392 msg.buf = buf;
2393
2394 ret = i2c_transfer(adap, &msg, 1);
2395
Wolfram Sang834aa6f2012-03-15 18:11:05 +01002396 /*
2397 * If everything went ok (i.e. 1 msg received), return #bytes received,
2398 * else error code.
2399 */
Jean Delvare815f55f2005-05-07 22:58:46 +02002400 return (ret == 1) ? count : ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401}
David Brownellc0564602007-05-01 23:26:31 +02002402EXPORT_SYMBOL(i2c_master_recv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404/* ----------------------------------------------------
2405 * the i2c address scanning function
2406 * Will not work for 10-bit addresses!
2407 * ----------------------------------------------------
2408 */
Jean Delvare9fc6adf2005-07-31 21:20:43 +02002409
Jean Delvare63e4e802010-06-03 11:33:51 +02002410/*
2411 * Legacy default probe function, mostly relevant for SMBus. The default
2412 * probe method is a quick write, but it is known to corrupt the 24RF08
2413 * EEPROMs due to a state machine bug, and could also irreversibly
2414 * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
2415 * we use a short byte read instead. Also, some bus drivers don't implement
2416 * quick write, so we fallback to a byte read in that case too.
2417 * On x86, there is another special case for FSC hardware monitoring chips,
2418 * which want regular byte reads (address 0x73.) Fortunately, these are the
2419 * only known chips using this I2C address on PC hardware.
2420 * Returns 1 if probe succeeded, 0 if not.
2421 */
2422static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
2423{
2424 int err;
2425 union i2c_smbus_data dummy;
2426
2427#ifdef CONFIG_X86
2428 if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
2429 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
2430 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
2431 I2C_SMBUS_BYTE_DATA, &dummy);
2432 else
2433#endif
Jean Delvare8031d792010-08-11 18:21:00 +02002434 if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
2435 && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
Jean Delvare63e4e802010-06-03 11:33:51 +02002436 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
2437 I2C_SMBUS_QUICK, NULL);
Jean Delvare8031d792010-08-11 18:21:00 +02002438 else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
2439 err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
2440 I2C_SMBUS_BYTE, &dummy);
2441 else {
Andy Lutomirskid63a9e82013-07-17 13:27:59 -07002442 dev_warn(&adap->dev, "No suitable probing method supported for address 0x%02X\n",
2443 addr);
Jean Delvare8031d792010-08-11 18:21:00 +02002444 err = -EOPNOTSUPP;
2445 }
Jean Delvare63e4e802010-06-03 11:33:51 +02002446
2447 return err >= 0;
2448}
2449
Jean Delvareccfbbd02009-12-06 17:06:25 +01002450static int i2c_detect_address(struct i2c_client *temp_client,
Jean Delvare4735c982008-07-14 22:38:36 +02002451 struct i2c_driver *driver)
2452{
2453 struct i2c_board_info info;
2454 struct i2c_adapter *adapter = temp_client->adapter;
2455 int addr = temp_client->addr;
2456 int err;
2457
2458 /* Make sure the address is valid */
Wolfram Sang66be60562015-07-17 12:43:22 +02002459 err = i2c_check_7bit_addr_validity_strict(addr);
Jean Delvare656b8762010-06-03 11:33:53 +02002460 if (err) {
Jean Delvare4735c982008-07-14 22:38:36 +02002461 dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
2462 addr);
Jean Delvare656b8762010-06-03 11:33:53 +02002463 return err;
Jean Delvare4735c982008-07-14 22:38:36 +02002464 }
2465
Wolfram Sang9bccc702015-07-17 14:48:56 +02002466 /* Skip if already in use (7 bit, no need to encode flags) */
Jean Delvare3b5f7942010-06-03 11:33:55 +02002467 if (i2c_check_addr_busy(adapter, addr))
Jean Delvare4735c982008-07-14 22:38:36 +02002468 return 0;
2469
Jean Delvareccfbbd02009-12-06 17:06:25 +01002470 /* Make sure there is something at this address */
Jean Delvare63e4e802010-06-03 11:33:51 +02002471 if (!i2c_default_probe(adapter, addr))
2472 return 0;
Jean Delvare4735c982008-07-14 22:38:36 +02002473
2474 /* Finally call the custom detection function */
2475 memset(&info, 0, sizeof(struct i2c_board_info));
2476 info.addr = addr;
Jean Delvare310ec792009-12-14 21:17:23 +01002477 err = driver->detect(temp_client, &info);
Jean Delvare4735c982008-07-14 22:38:36 +02002478 if (err) {
2479 /* -ENODEV is returned if the detection fails. We catch it
2480 here as this isn't an error. */
2481 return err == -ENODEV ? 0 : err;
2482 }
2483
2484 /* Consistency check */
2485 if (info.type[0] == '\0') {
2486 dev_err(&adapter->dev, "%s detection function provided "
2487 "no name for 0x%x\n", driver->driver.name,
2488 addr);
2489 } else {
2490 struct i2c_client *client;
2491
2492 /* Detection succeeded, instantiate the device */
Wolfram Sang0c176172014-02-10 11:03:56 +01002493 if (adapter->class & I2C_CLASS_DEPRECATED)
2494 dev_warn(&adapter->dev,
2495 "This adapter will soon drop class based instantiation of devices. "
2496 "Please make sure client 0x%02x gets instantiated by other means. "
2497 "Check 'Documentation/i2c/instantiating-devices' for details.\n",
2498 info.addr);
2499
Jean Delvare4735c982008-07-14 22:38:36 +02002500 dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
2501 info.type, info.addr);
2502 client = i2c_new_device(adapter, &info);
2503 if (client)
2504 list_add_tail(&client->detected, &driver->clients);
2505 else
2506 dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
2507 info.type, info.addr);
2508 }
2509 return 0;
2510}
2511
2512static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
2513{
Jean Delvarec3813d62009-12-14 21:17:25 +01002514 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +02002515 struct i2c_client *temp_client;
2516 int i, err = 0;
2517 int adap_id = i2c_adapter_id(adapter);
2518
Jean Delvarec3813d62009-12-14 21:17:25 +01002519 address_list = driver->address_list;
2520 if (!driver->detect || !address_list)
Jean Delvare4735c982008-07-14 22:38:36 +02002521 return 0;
2522
Wolfram Sang45552272014-07-10 13:46:21 +02002523 /* Warn that the adapter lost class based instantiation */
2524 if (adapter->class == I2C_CLASS_DEPRECATED) {
2525 dev_dbg(&adapter->dev,
2526 "This adapter dropped support for I2C classes and "
2527 "won't auto-detect %s devices anymore. If you need it, check "
2528 "'Documentation/i2c/instantiating-devices' for alternatives.\n",
2529 driver->driver.name);
2530 return 0;
2531 }
2532
Jean Delvare51b54ba2010-10-24 18:16:58 +02002533 /* Stop here if the classes do not match */
2534 if (!(adapter->class & driver->class))
2535 return 0;
2536
Jean Delvare4735c982008-07-14 22:38:36 +02002537 /* Set up a temporary client to help detect callback */
2538 temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
2539 if (!temp_client)
2540 return -ENOMEM;
2541 temp_client->adapter = adapter;
2542
Jean Delvarec3813d62009-12-14 21:17:25 +01002543 for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
Jean Delvare4735c982008-07-14 22:38:36 +02002544 dev_dbg(&adapter->dev, "found normal entry for adapter %d, "
Jean Delvarec3813d62009-12-14 21:17:25 +01002545 "addr 0x%02x\n", adap_id, address_list[i]);
2546 temp_client->addr = address_list[i];
Jean Delvareccfbbd02009-12-06 17:06:25 +01002547 err = i2c_detect_address(temp_client, driver);
Jean Delvare51b54ba2010-10-24 18:16:58 +02002548 if (unlikely(err))
2549 break;
Jean Delvare4735c982008-07-14 22:38:36 +02002550 }
2551
Jean Delvare4735c982008-07-14 22:38:36 +02002552 kfree(temp_client);
2553 return err;
2554}
2555
Jean Delvared44f19d2010-08-11 18:20:57 +02002556int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
2557{
2558 return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
2559 I2C_SMBUS_QUICK, NULL) >= 0;
2560}
2561EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);
2562
Jean Delvare12b5053a2007-05-01 23:26:31 +02002563struct i2c_client *
2564i2c_new_probed_device(struct i2c_adapter *adap,
2565 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +02002566 unsigned short const *addr_list,
2567 int (*probe)(struct i2c_adapter *, unsigned short addr))
Jean Delvare12b5053a2007-05-01 23:26:31 +02002568{
2569 int i;
2570
Jean Delvare8031d792010-08-11 18:21:00 +02002571 if (!probe)
Jean Delvare9a942412010-08-11 18:20:56 +02002572 probe = i2c_default_probe;
Jean Delvare12b5053a2007-05-01 23:26:31 +02002573
Jean Delvare12b5053a2007-05-01 23:26:31 +02002574 for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
2575 /* Check address validity */
Wolfram Sang66be60562015-07-17 12:43:22 +02002576 if (i2c_check_7bit_addr_validity_strict(addr_list[i]) < 0) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02002577 dev_warn(&adap->dev, "Invalid 7-bit address "
2578 "0x%02x\n", addr_list[i]);
2579 continue;
2580 }
2581
Wolfram Sang9bccc702015-07-17 14:48:56 +02002582 /* Check address availability (7 bit, no need to encode flags) */
Jean Delvare3b5f7942010-06-03 11:33:55 +02002583 if (i2c_check_addr_busy(adap, addr_list[i])) {
Jean Delvare12b5053a2007-05-01 23:26:31 +02002584 dev_dbg(&adap->dev, "Address 0x%02x already in "
2585 "use, not probing\n", addr_list[i]);
2586 continue;
2587 }
2588
Jean Delvare63e4e802010-06-03 11:33:51 +02002589 /* Test address responsiveness */
Jean Delvare9a942412010-08-11 18:20:56 +02002590 if (probe(adap, addr_list[i]))
Jean Delvare63e4e802010-06-03 11:33:51 +02002591 break;
Jean Delvare12b5053a2007-05-01 23:26:31 +02002592 }
Jean Delvare12b5053a2007-05-01 23:26:31 +02002593
2594 if (addr_list[i] == I2C_CLIENT_END) {
2595 dev_dbg(&adap->dev, "Probing failed, no device found\n");
2596 return NULL;
2597 }
2598
2599 info->addr = addr_list[i];
2600 return i2c_new_device(adap, info);
2601}
2602EXPORT_SYMBOL_GPL(i2c_new_probed_device);
2603
Jean Delvared735b342011-03-20 14:50:52 +01002604struct i2c_adapter *i2c_get_adapter(int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 struct i2c_adapter *adapter;
David Brownell438d6c22006-12-10 21:21:31 +01002607
Jean Delvarecaada322008-01-27 18:14:49 +01002608 mutex_lock(&core_lock);
Jean Delvared735b342011-03-20 14:50:52 +01002609 adapter = idr_find(&i2c_adapter_idr, nr);
Vladimir Zapolskiy611e12e2015-07-27 17:30:49 +03002610 if (!adapter)
2611 goto exit;
2612
2613 if (try_module_get(adapter->owner))
2614 get_device(&adapter->dev);
2615 else
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04002616 adapter = NULL;
2617
Vladimir Zapolskiy611e12e2015-07-27 17:30:49 +03002618 exit:
Jean Delvarecaada322008-01-27 18:14:49 +01002619 mutex_unlock(&core_lock);
Mark M. Hoffmana0920e12005-06-28 00:21:30 -04002620 return adapter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621}
David Brownellc0564602007-05-01 23:26:31 +02002622EXPORT_SYMBOL(i2c_get_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623
2624void i2c_put_adapter(struct i2c_adapter *adap)
2625{
Vladimir Zapolskiy611e12e2015-07-27 17:30:49 +03002626 if (!adap)
2627 return;
2628
2629 put_device(&adap->dev);
2630 module_put(adap->owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631}
David Brownellc0564602007-05-01 23:26:31 +02002632EXPORT_SYMBOL(i2c_put_adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633
2634/* The SMBus parts */
2635
David Brownell438d6c22006-12-10 21:21:31 +01002636#define POLY (0x1070U << 3)
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01002637static u8 crc8(u16 data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638{
2639 int i;
David Brownell438d6c22006-12-10 21:21:31 +01002640
Farid Hammane7225acf2010-05-21 18:40:58 +02002641 for (i = 0; i < 8; i++) {
David Brownell438d6c22006-12-10 21:21:31 +01002642 if (data & 0x8000)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 data = data ^ POLY;
2644 data = data << 1;
2645 }
2646 return (u8)(data >> 8);
2647}
2648
Jean Delvare421ef472005-10-26 21:28:55 +02002649/* Incremental CRC8 over count bytes in the array pointed to by p */
2650static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651{
2652 int i;
2653
Farid Hammane7225acf2010-05-21 18:40:58 +02002654 for (i = 0; i < count; i++)
Jean Delvare421ef472005-10-26 21:28:55 +02002655 crc = crc8((crc ^ p[i]) << 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656 return crc;
2657}
2658
Jean Delvare421ef472005-10-26 21:28:55 +02002659/* Assume a 7-bit address, which is reasonable for SMBus */
2660static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661{
Jean Delvare421ef472005-10-26 21:28:55 +02002662 /* The address will be sent first */
Wolfram Sang041edda2016-04-03 20:44:46 +02002663 u8 addr = i2c_8bit_addr_from_msg(msg);
Jean Delvare421ef472005-10-26 21:28:55 +02002664 pec = i2c_smbus_pec(pec, &addr, 1);
2665
2666 /* The data buffer follows */
2667 return i2c_smbus_pec(pec, msg->buf, msg->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668}
2669
Jean Delvare421ef472005-10-26 21:28:55 +02002670/* Used for write only transactions */
2671static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672{
Jean Delvare421ef472005-10-26 21:28:55 +02002673 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
2674 msg->len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675}
2676
Jean Delvare421ef472005-10-26 21:28:55 +02002677/* Return <0 on CRC error
2678 If there was a write before this read (most cases) we need to take the
2679 partial CRC from the write part into account.
2680 Note that this function does modify the message (we need to decrease the
2681 message length to hide the CRC byte from the caller). */
2682static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683{
Jean Delvare421ef472005-10-26 21:28:55 +02002684 u8 rpec = msg->buf[--msg->len];
2685 cpec = i2c_smbus_msg_pec(cpec, msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 if (rpec != cpec) {
2688 pr_debug("i2c-core: Bad PEC 0x%02x vs. 0x%02x\n",
2689 rpec, cpec);
David Brownell24a5bb72008-07-14 22:38:23 +02002690 return -EBADMSG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691 }
David Brownell438d6c22006-12-10 21:21:31 +01002692 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693}
2694
David Brownella1cdeda2008-07-14 22:38:24 +02002695/**
2696 * i2c_smbus_read_byte - SMBus "receive byte" protocol
2697 * @client: Handle to slave device
2698 *
2699 * This executes the SMBus "receive byte" protocol, returning negative errno
2700 * else the byte received from the device.
2701 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002702s32 i2c_smbus_read_byte(const struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703{
2704 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002705 int status;
2706
2707 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2708 I2C_SMBUS_READ, 0,
2709 I2C_SMBUS_BYTE, &data);
2710 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711}
David Brownellc0564602007-05-01 23:26:31 +02002712EXPORT_SYMBOL(i2c_smbus_read_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713
David Brownella1cdeda2008-07-14 22:38:24 +02002714/**
2715 * i2c_smbus_write_byte - SMBus "send byte" protocol
2716 * @client: Handle to slave device
2717 * @value: Byte to be sent
2718 *
2719 * This executes the SMBus "send byte" protocol, returning negative errno
2720 * else zero on success.
2721 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002722s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723{
Farid Hammane7225acf2010-05-21 18:40:58 +02002724 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
Jean Delvare421ef472005-10-26 21:28:55 +02002725 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726}
David Brownellc0564602007-05-01 23:26:31 +02002727EXPORT_SYMBOL(i2c_smbus_write_byte);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002728
David Brownella1cdeda2008-07-14 22:38:24 +02002729/**
2730 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
2731 * @client: Handle to slave device
2732 * @command: Byte interpreted by slave
2733 *
2734 * This executes the SMBus "read byte" protocol, returning negative errno
2735 * else a data byte received from the device.
2736 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002737s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738{
2739 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002740 int status;
2741
2742 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2743 I2C_SMBUS_READ, command,
2744 I2C_SMBUS_BYTE_DATA, &data);
2745 return (status < 0) ? status : data.byte;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746}
David Brownellc0564602007-05-01 23:26:31 +02002747EXPORT_SYMBOL(i2c_smbus_read_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002748
David Brownella1cdeda2008-07-14 22:38:24 +02002749/**
2750 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
2751 * @client: Handle to slave device
2752 * @command: Byte interpreted by slave
2753 * @value: Byte being written
2754 *
2755 * This executes the SMBus "write byte" protocol, returning negative errno
2756 * else zero on success.
2757 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002758s32 i2c_smbus_write_byte_data(const struct i2c_client *client, u8 command,
2759 u8 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760{
2761 union i2c_smbus_data data;
2762 data.byte = value;
Farid Hammane7225acf2010-05-21 18:40:58 +02002763 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2764 I2C_SMBUS_WRITE, command,
2765 I2C_SMBUS_BYTE_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766}
David Brownellc0564602007-05-01 23:26:31 +02002767EXPORT_SYMBOL(i2c_smbus_write_byte_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768
David Brownella1cdeda2008-07-14 22:38:24 +02002769/**
2770 * i2c_smbus_read_word_data - SMBus "read word" protocol
2771 * @client: Handle to slave device
2772 * @command: Byte interpreted by slave
2773 *
2774 * This executes the SMBus "read word" protocol, returning negative errno
2775 * else a 16-bit unsigned "word" received from the device.
2776 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002777s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778{
2779 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002780 int status;
2781
2782 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2783 I2C_SMBUS_READ, command,
2784 I2C_SMBUS_WORD_DATA, &data);
2785 return (status < 0) ? status : data.word;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786}
David Brownellc0564602007-05-01 23:26:31 +02002787EXPORT_SYMBOL(i2c_smbus_read_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788
David Brownella1cdeda2008-07-14 22:38:24 +02002789/**
2790 * i2c_smbus_write_word_data - SMBus "write word" protocol
2791 * @client: Handle to slave device
2792 * @command: Byte interpreted by slave
2793 * @value: 16-bit "word" being written
2794 *
2795 * This executes the SMBus "write word" protocol, returning negative errno
2796 * else zero on success.
2797 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002798s32 i2c_smbus_write_word_data(const struct i2c_client *client, u8 command,
2799 u16 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800{
2801 union i2c_smbus_data data;
2802 data.word = value;
Farid Hammane7225acf2010-05-21 18:40:58 +02002803 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2804 I2C_SMBUS_WRITE, command,
2805 I2C_SMBUS_WORD_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806}
David Brownellc0564602007-05-01 23:26:31 +02002807EXPORT_SYMBOL(i2c_smbus_write_word_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808
David Brownella64ec072007-10-13 23:56:31 +02002809/**
David Brownella1cdeda2008-07-14 22:38:24 +02002810 * i2c_smbus_read_block_data - SMBus "block read" protocol
David Brownella64ec072007-10-13 23:56:31 +02002811 * @client: Handle to slave device
David Brownella1cdeda2008-07-14 22:38:24 +02002812 * @command: Byte interpreted by slave
David Brownella64ec072007-10-13 23:56:31 +02002813 * @values: Byte array into which data will be read; big enough to hold
2814 * the data returned by the slave. SMBus allows at most 32 bytes.
2815 *
David Brownella1cdeda2008-07-14 22:38:24 +02002816 * This executes the SMBus "block read" protocol, returning negative errno
2817 * else the number of data bytes in the slave's response.
David Brownella64ec072007-10-13 23:56:31 +02002818 *
2819 * Note that using this function requires that the client's adapter support
2820 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
2821 * support this; its emulation through I2C messaging relies on a specific
2822 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
2823 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002824s32 i2c_smbus_read_block_data(const struct i2c_client *client, u8 command,
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002825 u8 *values)
2826{
2827 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002828 int status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002829
David Brownell24a5bb72008-07-14 22:38:23 +02002830 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2831 I2C_SMBUS_READ, command,
2832 I2C_SMBUS_BLOCK_DATA, &data);
2833 if (status)
2834 return status;
Jean Delvareb86a1bc2007-05-01 23:26:34 +02002835
2836 memcpy(values, &data.block[1], data.block[0]);
2837 return data.block[0];
2838}
2839EXPORT_SYMBOL(i2c_smbus_read_block_data);
2840
David Brownella1cdeda2008-07-14 22:38:24 +02002841/**
2842 * i2c_smbus_write_block_data - SMBus "block write" protocol
2843 * @client: Handle to slave device
2844 * @command: Byte interpreted by slave
2845 * @length: Size of data block; SMBus allows at most 32 bytes
2846 * @values: Byte array which will be written.
2847 *
2848 * This executes the SMBus "block write" protocol, returning negative errno
2849 * else zero on success.
2850 */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002851s32 i2c_smbus_write_block_data(const struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02002852 u8 length, const u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853{
2854 union i2c_smbus_data data;
Jean Delvare76560322006-01-18 23:14:55 +01002855
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 if (length > I2C_SMBUS_BLOCK_MAX)
2857 length = I2C_SMBUS_BLOCK_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858 data.block[0] = length;
Jean Delvare76560322006-01-18 23:14:55 +01002859 memcpy(&data.block[1], values, length);
Farid Hammane7225acf2010-05-21 18:40:58 +02002860 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2861 I2C_SMBUS_WRITE, command,
2862 I2C_SMBUS_BLOCK_DATA, &data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863}
David Brownellc0564602007-05-01 23:26:31 +02002864EXPORT_SYMBOL(i2c_smbus_write_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865
2866/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +01002867s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, u8 command,
Jean Delvare4b2643d2007-07-12 14:12:29 +02002868 u8 length, u8 *values)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869{
2870 union i2c_smbus_data data;
David Brownell24a5bb72008-07-14 22:38:23 +02002871 int status;
Jean Delvare76560322006-01-18 23:14:55 +01002872
Jean Delvare4b2643d2007-07-12 14:12:29 +02002873 if (length > I2C_SMBUS_BLOCK_MAX)
2874 length = I2C_SMBUS_BLOCK_MAX;
2875 data.block[0] = length;
David Brownell24a5bb72008-07-14 22:38:23 +02002876 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2877 I2C_SMBUS_READ, command,
2878 I2C_SMBUS_I2C_BLOCK_DATA, &data);
2879 if (status < 0)
2880 return status;
Jean Delvare76560322006-01-18 23:14:55 +01002881
2882 memcpy(values, &data.block[1], data.block[0]);
2883 return data.block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002884}
David Brownellc0564602007-05-01 23:26:31 +02002885EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886
Jean Delvare0cc43a12011-01-10 22:11:23 +01002887s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, u8 command,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +02002888 u8 length, const u8 *values)
Jean Delvare21bbd692006-01-09 15:19:18 +11002889{
2890 union i2c_smbus_data data;
2891
2892 if (length > I2C_SMBUS_BLOCK_MAX)
2893 length = I2C_SMBUS_BLOCK_MAX;
2894 data.block[0] = length;
2895 memcpy(data.block + 1, values, length);
2896 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
2897 I2C_SMBUS_WRITE, command,
2898 I2C_SMBUS_I2C_BLOCK_DATA, &data);
2899}
David Brownellc0564602007-05-01 23:26:31 +02002900EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
Jean Delvare21bbd692006-01-09 15:19:18 +11002901
David Brownell438d6c22006-12-10 21:21:31 +01002902/* Simulate a SMBus command using the i2c protocol
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903 No checking of parameters is done! */
Farid Hammane7225acf2010-05-21 18:40:58 +02002904static s32 i2c_smbus_xfer_emulated(struct i2c_adapter *adapter, u16 addr,
2905 unsigned short flags,
2906 char read_write, u8 command, int size,
2907 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908{
2909 /* So we need to generate a series of msgs. In the case of writing, we
2910 need to use only one message; when reading, we need two. We initialize
2911 most things with sane defaults, to keep the code below somewhat
2912 simpler. */
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02002913 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
2914 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
Farid Hammane7225acf2010-05-21 18:40:58 +02002915 int num = read_write == I2C_SMBUS_READ ? 2 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916 int i;
Jean Delvare421ef472005-10-26 21:28:55 +02002917 u8 partial_pec = 0;
David Brownell24a5bb72008-07-14 22:38:23 +02002918 int status;
Shubhrajyoti D230da092012-10-05 22:23:52 +02002919 struct i2c_msg msg[2] = {
2920 {
2921 .addr = addr,
2922 .flags = flags,
2923 .len = 1,
2924 .buf = msgbuf0,
2925 }, {
2926 .addr = addr,
2927 .flags = flags | I2C_M_RD,
2928 .len = 0,
2929 .buf = msgbuf1,
2930 },
2931 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932
2933 msgbuf0[0] = command;
Farid Hammane7225acf2010-05-21 18:40:58 +02002934 switch (size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935 case I2C_SMBUS_QUICK:
2936 msg[0].len = 0;
2937 /* Special case: The read/write field is used as data */
Roel Kluinf29d2e02009-02-24 19:19:48 +01002938 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
2939 I2C_M_RD : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940 num = 1;
2941 break;
2942 case I2C_SMBUS_BYTE:
2943 if (read_write == I2C_SMBUS_READ) {
2944 /* Special case: only a read! */
2945 msg[0].flags = I2C_M_RD | flags;
2946 num = 1;
2947 }
2948 break;
2949 case I2C_SMBUS_BYTE_DATA:
2950 if (read_write == I2C_SMBUS_READ)
2951 msg[1].len = 1;
2952 else {
2953 msg[0].len = 2;
2954 msgbuf0[1] = data->byte;
2955 }
2956 break;
2957 case I2C_SMBUS_WORD_DATA:
2958 if (read_write == I2C_SMBUS_READ)
2959 msg[1].len = 2;
2960 else {
Farid Hammane7225acf2010-05-21 18:40:58 +02002961 msg[0].len = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002962 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02002963 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964 }
2965 break;
2966 case I2C_SMBUS_PROC_CALL:
2967 num = 2; /* Special case */
2968 read_write = I2C_SMBUS_READ;
2969 msg[0].len = 3;
2970 msg[1].len = 2;
2971 msgbuf0[1] = data->word & 0xff;
Jean Delvare7eff82c2006-09-03 22:24:00 +02002972 msgbuf0[2] = data->word >> 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002973 break;
2974 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975 if (read_write == I2C_SMBUS_READ) {
Jean Delvare209d27c2007-05-01 23:26:29 +02002976 msg[1].flags |= I2C_M_RECV_LEN;
2977 msg[1].len = 1; /* block length will be added by
2978 the underlying bus driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979 } else {
2980 msg[0].len = data->block[0] + 2;
2981 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
David Brownell24a5bb72008-07-14 22:38:23 +02002982 dev_err(&adapter->dev,
2983 "Invalid block write size %d\n",
2984 data->block[0]);
2985 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986 }
Hideki Iwamoto5c50d182005-09-25 17:01:11 +02002987 for (i = 1; i < msg[0].len; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988 msgbuf0[i] = data->block[i-1];
2989 }
2990 break;
2991 case I2C_SMBUS_BLOCK_PROC_CALL:
Jean Delvare209d27c2007-05-01 23:26:29 +02002992 num = 2; /* Another special case */
2993 read_write = I2C_SMBUS_READ;
2994 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
David Brownell24a5bb72008-07-14 22:38:23 +02002995 dev_err(&adapter->dev,
2996 "Invalid block write size %d\n",
Jean Delvare209d27c2007-05-01 23:26:29 +02002997 data->block[0]);
David Brownell24a5bb72008-07-14 22:38:23 +02002998 return -EINVAL;
Jean Delvare209d27c2007-05-01 23:26:29 +02002999 }
3000 msg[0].len = data->block[0] + 2;
3001 for (i = 1; i < msg[0].len; i++)
3002 msgbuf0[i] = data->block[i-1];
3003 msg[1].flags |= I2C_M_RECV_LEN;
3004 msg[1].len = 1; /* block length will be added by
3005 the underlying bus driver */
3006 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003007 case I2C_SMBUS_I2C_BLOCK_DATA:
3008 if (read_write == I2C_SMBUS_READ) {
Jean Delvare4b2643d2007-07-12 14:12:29 +02003009 msg[1].len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010 } else {
3011 msg[0].len = data->block[0] + 1;
Jean Delvare30dac742005-10-08 00:15:59 +02003012 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 1) {
David Brownell24a5bb72008-07-14 22:38:23 +02003013 dev_err(&adapter->dev,
3014 "Invalid block write size %d\n",
3015 data->block[0]);
3016 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017 }
3018 for (i = 1; i <= data->block[0]; i++)
3019 msgbuf0[i] = data->block[i];
3020 }
3021 break;
3022 default:
David Brownell24a5bb72008-07-14 22:38:23 +02003023 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
3024 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003025 }
3026
Jean Delvare421ef472005-10-26 21:28:55 +02003027 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
3028 && size != I2C_SMBUS_I2C_BLOCK_DATA);
3029 if (i) {
3030 /* Compute PEC if first message is a write */
3031 if (!(msg[0].flags & I2C_M_RD)) {
David Brownell438d6c22006-12-10 21:21:31 +01003032 if (num == 1) /* Write only */
Jean Delvare421ef472005-10-26 21:28:55 +02003033 i2c_smbus_add_pec(&msg[0]);
3034 else /* Write followed by read */
3035 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
3036 }
3037 /* Ask for PEC if last message is a read */
3038 if (msg[num-1].flags & I2C_M_RD)
David Brownell438d6c22006-12-10 21:21:31 +01003039 msg[num-1].len++;
Jean Delvare421ef472005-10-26 21:28:55 +02003040 }
3041
David Brownell24a5bb72008-07-14 22:38:23 +02003042 status = i2c_transfer(adapter, msg, num);
3043 if (status < 0)
3044 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045
Jean Delvare421ef472005-10-26 21:28:55 +02003046 /* Check PEC if last message is a read */
3047 if (i && (msg[num-1].flags & I2C_M_RD)) {
David Brownell24a5bb72008-07-14 22:38:23 +02003048 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
3049 if (status < 0)
3050 return status;
Jean Delvare421ef472005-10-26 21:28:55 +02003051 }
3052
Linus Torvalds1da177e2005-04-16 15:20:36 -07003053 if (read_write == I2C_SMBUS_READ)
Farid Hammane7225acf2010-05-21 18:40:58 +02003054 switch (size) {
3055 case I2C_SMBUS_BYTE:
3056 data->byte = msgbuf0[0];
3057 break;
3058 case I2C_SMBUS_BYTE_DATA:
3059 data->byte = msgbuf1[0];
3060 break;
3061 case I2C_SMBUS_WORD_DATA:
3062 case I2C_SMBUS_PROC_CALL:
3063 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
3064 break;
3065 case I2C_SMBUS_I2C_BLOCK_DATA:
3066 for (i = 0; i < data->block[0]; i++)
3067 data->block[i+1] = msgbuf1[i];
3068 break;
3069 case I2C_SMBUS_BLOCK_DATA:
3070 case I2C_SMBUS_BLOCK_PROC_CALL:
3071 for (i = 0; i < msgbuf1[0] + 1; i++)
3072 data->block[i] = msgbuf1[i];
3073 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074 }
3075 return 0;
3076}
3077
David Brownella1cdeda2008-07-14 22:38:24 +02003078/**
3079 * i2c_smbus_xfer - execute SMBus protocol operations
3080 * @adapter: Handle to I2C bus
3081 * @addr: Address of SMBus slave on that bus
3082 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
3083 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
3084 * @command: Byte interpreted by slave, for protocols which use such bytes
3085 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
3086 * @data: Data to be read or written
3087 *
3088 * This executes an SMBus protocol operation, and returns a negative
3089 * errno code else zero on success.
3090 */
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01003091s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
David Brownella1cdeda2008-07-14 22:38:24 +02003092 char read_write, u8 command, int protocol,
Zhenwen Xu09b8ce02009-03-28 21:34:46 +01003093 union i2c_smbus_data *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094{
Clifford Wolf66b650f2009-06-15 18:01:46 +02003095 unsigned long orig_jiffies;
3096 int try;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097 s32 res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003098
David Howells8a325992014-03-06 13:36:06 +00003099 /* If enabled, the following two tracepoints are conditional on
3100 * read_write and protocol.
3101 */
3102 trace_smbus_write(adapter, addr, flags, read_write,
3103 command, protocol, data);
3104 trace_smbus_read(adapter, addr, flags, read_write,
3105 command, protocol);
3106
Laurent Pinchartd47726c2012-07-24 14:13:59 +02003107 flags &= I2C_M_TEN | I2C_CLIENT_PEC | I2C_CLIENT_SCCB;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003108
3109 if (adapter->algo->smbus_xfer) {
Peter Rosin8320f492016-05-04 22:15:27 +02003110 i2c_lock_bus(adapter, I2C_LOCK_SEGMENT);
Clifford Wolf66b650f2009-06-15 18:01:46 +02003111
3112 /* Retry automatically on arbitration loss */
3113 orig_jiffies = jiffies;
3114 for (res = 0, try = 0; try <= adapter->retries; try++) {
3115 res = adapter->algo->smbus_xfer(adapter, addr, flags,
3116 read_write, command,
3117 protocol, data);
3118 if (res != -EAGAIN)
3119 break;
3120 if (time_after(jiffies,
3121 orig_jiffies + adapter->timeout))
3122 break;
3123 }
Peter Rosin8320f492016-05-04 22:15:27 +02003124 i2c_unlock_bus(adapter, I2C_LOCK_SEGMENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003125
Laurent Pinchart72fc2c72012-07-24 14:13:59 +02003126 if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
David Howells8a325992014-03-06 13:36:06 +00003127 goto trace;
Laurent Pinchart72fc2c72012-07-24 14:13:59 +02003128 /*
3129 * Fall back to i2c_smbus_xfer_emulated if the adapter doesn't
3130 * implement native support for the SMBus operation.
3131 */
3132 }
3133
David Howells8a325992014-03-06 13:36:06 +00003134 res = i2c_smbus_xfer_emulated(adapter, addr, flags, read_write,
3135 command, protocol, data);
3136
3137trace:
3138 /* If enabled, the reply tracepoint is conditional on read_write. */
3139 trace_smbus_reply(adapter, addr, flags, read_write,
3140 command, protocol, data);
3141 trace_smbus_result(adapter, addr, flags, read_write,
3142 command, protocol, res);
3143
3144 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003145}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146EXPORT_SYMBOL(i2c_smbus_xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003147
Irina Tirdea01eef962015-08-12 17:31:33 +03003148/**
3149 * i2c_smbus_read_i2c_block_data_or_emulated - read block or emulate
3150 * @client: Handle to slave device
3151 * @command: Byte interpreted by slave
3152 * @length: Size of data block; SMBus allows at most I2C_SMBUS_BLOCK_MAX bytes
3153 * @values: Byte array into which data will be read; big enough to hold
3154 * the data returned by the slave. SMBus allows at most
3155 * I2C_SMBUS_BLOCK_MAX bytes.
3156 *
3157 * This executes the SMBus "block read" protocol if supported by the adapter.
3158 * If block read is not supported, it emulates it using either word or byte
3159 * read protocols depending on availability.
3160 *
3161 * The addresses of the I2C slave device that are accessed with this function
3162 * must be mapped to a linear region, so that a block read will have the same
3163 * effect as a byte read. Before using this function you must double-check
3164 * if the I2C slave does support exchanging a block transfer with a byte
3165 * transfer.
3166 */
3167s32 i2c_smbus_read_i2c_block_data_or_emulated(const struct i2c_client *client,
3168 u8 command, u8 length, u8 *values)
3169{
3170 u8 i = 0;
3171 int status;
3172
3173 if (length > I2C_SMBUS_BLOCK_MAX)
3174 length = I2C_SMBUS_BLOCK_MAX;
3175
3176 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK))
3177 return i2c_smbus_read_i2c_block_data(client, command, length, values);
3178
3179 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA))
3180 return -EOPNOTSUPP;
3181
3182 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_WORD_DATA)) {
3183 while ((i + 2) <= length) {
3184 status = i2c_smbus_read_word_data(client, command + i);
3185 if (status < 0)
3186 return status;
3187 values[i] = status & 0xff;
3188 values[i + 1] = status >> 8;
3189 i += 2;
3190 }
3191 }
3192
3193 while (i < length) {
3194 status = i2c_smbus_read_byte_data(client, command + i);
3195 if (status < 0)
3196 return status;
3197 values[i] = status;
3198 i++;
3199 }
3200
3201 return i;
3202}
3203EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data_or_emulated);
3204
Jean Delvared5fd1202015-01-26 20:59:31 +01003205#if IS_ENABLED(CONFIG_I2C_SLAVE)
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003206int i2c_slave_register(struct i2c_client *client, i2c_slave_cb_t slave_cb)
3207{
3208 int ret;
3209
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003210 if (!client || !slave_cb) {
3211 WARN(1, "insufficent data\n");
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003212 return -EINVAL;
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003213 }
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003214
Wolfram Sangc6909d62015-08-05 21:12:54 +02003215 if (!(client->flags & I2C_CLIENT_SLAVE))
3216 dev_warn(&client->dev, "%s: client slave flag not set. You might see address collisions\n",
3217 __func__);
3218
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003219 if (!(client->flags & I2C_CLIENT_TEN)) {
3220 /* Enforce stricter address checking */
Wolfram Sang66be60562015-07-17 12:43:22 +02003221 ret = i2c_check_7bit_addr_validity_strict(client->addr);
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003222 if (ret) {
3223 dev_err(&client->dev, "%s: invalid address\n", __func__);
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003224 return ret;
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003225 }
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003226 }
3227
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003228 if (!client->adapter->algo->reg_slave) {
3229 dev_err(&client->dev, "%s: not supported by adapter\n", __func__);
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003230 return -EOPNOTSUPP;
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003231 }
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003232
3233 client->slave_cb = slave_cb;
3234
3235 i2c_lock_adapter(client->adapter);
3236 ret = client->adapter->algo->reg_slave(client);
3237 i2c_unlock_adapter(client->adapter);
3238
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003239 if (ret) {
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003240 client->slave_cb = NULL;
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003241 dev_err(&client->dev, "%s: adapter returned error %d\n", __func__, ret);
3242 }
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003243
3244 return ret;
3245}
3246EXPORT_SYMBOL_GPL(i2c_slave_register);
3247
3248int i2c_slave_unregister(struct i2c_client *client)
3249{
3250 int ret;
3251
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003252 if (!client->adapter->algo->unreg_slave) {
3253 dev_err(&client->dev, "%s: not supported by adapter\n", __func__);
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003254 return -EOPNOTSUPP;
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003255 }
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003256
3257 i2c_lock_adapter(client->adapter);
3258 ret = client->adapter->algo->unreg_slave(client);
3259 i2c_unlock_adapter(client->adapter);
3260
3261 if (ret == 0)
3262 client->slave_cb = NULL;
Wolfram Sang0c7cab92015-05-14 14:40:05 +02003263 else
3264 dev_err(&client->dev, "%s: adapter returned error %d\n", __func__, ret);
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003265
3266 return ret;
3267}
3268EXPORT_SYMBOL_GPL(i2c_slave_unregister);
Jean Delvared5fd1202015-01-26 20:59:31 +01003269#endif
Wolfram Sang4b1acc42014-11-18 17:04:53 +01003270
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
3272MODULE_DESCRIPTION("I2C-Bus main module");
3273MODULE_LICENSE("GPL");