2 * Linux I2C core ACPI support code
4 * Copyright (C) 2014 Intel Corp, Author: Lan Tianyu <tianyu.lan@intel.com>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; either version 2 of the License, or (at your option)
12 #include <linux/acpi.h>
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/i2c.h>
16 #include <linux/list.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
22 struct i2c_acpi_handler_data {
23 struct acpi_connection_info info;
24 struct i2c_adapter *adapter;
37 struct i2c_acpi_lookup {
38 struct i2c_board_info *info;
39 acpi_handle adapter_handle;
40 acpi_handle device_handle;
41 acpi_handle search_handle;
49 static int i2c_acpi_fill_info(struct acpi_resource *ares, void *data)
51 struct i2c_acpi_lookup *lookup = data;
52 struct i2c_board_info *info = lookup->info;
53 struct acpi_resource_i2c_serialbus *sb;
56 if (info->addr || ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
59 sb = &ares->data.i2c_serial_bus;
60 if (sb->type != ACPI_RESOURCE_SERIAL_TYPE_I2C)
63 if (lookup->index != -1 && lookup->n++ != lookup->index)
66 status = acpi_get_handle(lookup->device_handle,
67 sb->resource_source.string_ptr,
68 &lookup->adapter_handle);
69 if (!ACPI_SUCCESS(status))
72 info->addr = sb->slave_address;
73 lookup->speed = sb->connection_speed;
74 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
75 info->flags |= I2C_CLIENT_TEN;
80 static const struct acpi_device_id i2c_acpi_ignored_device_ids[] = {
82 * ACPI video acpi_devices, which are handled by the acpi-video driver
83 * sometimes contain a SERIAL_TYPE_I2C ACPI resource, ignore these.
85 { ACPI_VIDEO_HID, 0 },
89 static int i2c_acpi_do_lookup(struct acpi_device *adev,
90 struct i2c_acpi_lookup *lookup)
92 struct i2c_board_info *info = lookup->info;
93 struct list_head resource_list;
96 if (acpi_bus_get_status(adev) || !adev->status.present ||
97 acpi_device_enumerated(adev))
100 if (acpi_match_device_ids(adev, i2c_acpi_ignored_device_ids) == 0)
103 memset(info, 0, sizeof(*info));
104 lookup->device_handle = acpi_device_handle(adev);
106 /* Look up for I2cSerialBus resource */
107 INIT_LIST_HEAD(&resource_list);
108 ret = acpi_dev_get_resources(adev, &resource_list,
109 i2c_acpi_fill_info, lookup);
110 acpi_dev_free_resource_list(&resource_list);
112 if (ret < 0 || !info->addr)
118 static int i2c_acpi_get_info(struct acpi_device *adev,
119 struct i2c_board_info *info,
120 struct i2c_adapter *adapter,
121 acpi_handle *adapter_handle)
123 struct list_head resource_list;
124 struct resource_entry *entry;
125 struct i2c_acpi_lookup lookup;
128 memset(&lookup, 0, sizeof(lookup));
132 ret = i2c_acpi_do_lookup(adev, &lookup);
137 /* The adapter must match the one in I2cSerialBus() connector */
138 if (ACPI_HANDLE(&adapter->dev) != lookup.adapter_handle)
141 struct acpi_device *adapter_adev;
143 /* The adapter must be present */
144 if (acpi_bus_get_device(lookup.adapter_handle, &adapter_adev))
146 if (acpi_bus_get_status(adapter_adev) ||
147 !adapter_adev->status.present)
151 info->fwnode = acpi_fwnode_handle(adev);
153 *adapter_handle = lookup.adapter_handle;
155 /* Then fill IRQ number if any */
156 INIT_LIST_HEAD(&resource_list);
157 ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
161 resource_list_for_each_entry(entry, &resource_list) {
162 if (resource_type(entry->res) == IORESOURCE_IRQ) {
163 info->irq = entry->res->start;
168 acpi_dev_free_resource_list(&resource_list);
170 acpi_set_modalias(adev, dev_name(&adev->dev), info->type,
176 static void i2c_acpi_register_device(struct i2c_adapter *adapter,
177 struct acpi_device *adev,
178 struct i2c_board_info *info)
180 adev->power.flags.ignore_parent = true;
181 acpi_device_set_enumerated(adev);
183 if (!i2c_new_device(adapter, info)) {
184 adev->power.flags.ignore_parent = false;
185 dev_err(&adapter->dev,
186 "failed to add I2C device %s from ACPI\n",
187 dev_name(&adev->dev));
191 static acpi_status i2c_acpi_add_device(acpi_handle handle, u32 level,
192 void *data, void **return_value)
194 struct i2c_adapter *adapter = data;
195 struct acpi_device *adev;
196 struct i2c_board_info info;
198 if (acpi_bus_get_device(handle, &adev))
201 if (i2c_acpi_get_info(adev, &info, adapter, NULL))
204 i2c_acpi_register_device(adapter, adev, &info);
209 #define I2C_ACPI_MAX_SCAN_DEPTH 32
212 * i2c_acpi_register_devices - enumerate I2C slave devices behind adapter
213 * @adap: pointer to adapter
215 * Enumerate all I2C slave devices behind this adapter by walking the ACPI
216 * namespace. When a device is found it will be added to the Linux device
217 * model and bound to the corresponding ACPI handle.
219 void i2c_acpi_register_devices(struct i2c_adapter *adap)
224 if (!has_acpi_companion(&adap->dev))
227 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
228 I2C_ACPI_MAX_SCAN_DEPTH,
229 i2c_acpi_add_device, NULL,
231 if (ACPI_FAILURE(status))
232 dev_warn(&adap->dev, "failed to enumerate I2C slaves\n");
234 if (!adap->dev.parent)
237 handle = ACPI_HANDLE(adap->dev.parent);
241 acpi_walk_dep_device_list(handle);
244 const struct acpi_device_id *
245 i2c_acpi_match_device(const struct acpi_device_id *matches,
246 struct i2c_client *client)
248 if (!(client && matches))
251 return acpi_match_device(matches, &client->dev);
254 static const struct acpi_device_id i2c_acpi_force_400khz_device_ids[] = {
256 * These Silead touchscreen controllers only work at 400KHz, for
257 * some reason they do not work at 100KHz. On some devices the ACPI
258 * tables list another device at their bus as only being capable
259 * of 100KHz, testing has shown that these other devices work fine
260 * at 400KHz (as can be expected of any recent i2c hw) so we force
261 * the speed of the bus to 400 KHz if a Silead device is present.
267 static acpi_status i2c_acpi_lookup_speed(acpi_handle handle, u32 level,
268 void *data, void **return_value)
270 struct i2c_acpi_lookup *lookup = data;
271 struct acpi_device *adev;
273 if (acpi_bus_get_device(handle, &adev))
276 if (i2c_acpi_do_lookup(adev, lookup))
279 if (lookup->search_handle != lookup->adapter_handle)
282 if (lookup->speed <= lookup->min_speed)
283 lookup->min_speed = lookup->speed;
285 if (acpi_match_device_ids(adev, i2c_acpi_force_400khz_device_ids) == 0)
286 lookup->force_speed = 400000;
292 * i2c_acpi_find_bus_speed - find I2C bus speed from ACPI
293 * @dev: The device owning the bus
295 * Find the I2C bus speed by walking the ACPI namespace for all I2C slaves
296 * devices connected to this bus and use the speed of slowest device.
298 * Returns the speed in Hz or zero
300 u32 i2c_acpi_find_bus_speed(struct device *dev)
302 struct i2c_acpi_lookup lookup;
303 struct i2c_board_info dummy;
306 if (!has_acpi_companion(dev))
309 memset(&lookup, 0, sizeof(lookup));
310 lookup.search_handle = ACPI_HANDLE(dev);
311 lookup.min_speed = UINT_MAX;
312 lookup.info = &dummy;
315 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
316 I2C_ACPI_MAX_SCAN_DEPTH,
317 i2c_acpi_lookup_speed, NULL,
320 if (ACPI_FAILURE(status)) {
321 dev_warn(dev, "unable to find I2C bus speed from ACPI\n");
325 if (lookup.force_speed) {
326 if (lookup.force_speed != lookup.min_speed)
327 dev_warn(dev, FW_BUG "DSDT uses known not-working I2C bus speed %d, forcing it to %d\n",
328 lookup.min_speed, lookup.force_speed);
329 return lookup.force_speed;
330 } else if (lookup.min_speed != UINT_MAX) {
331 return lookup.min_speed;
336 EXPORT_SYMBOL_GPL(i2c_acpi_find_bus_speed);
338 static int i2c_acpi_find_match_adapter(struct device *dev, void *data)
340 struct i2c_adapter *adapter = i2c_verify_adapter(dev);
345 return ACPI_HANDLE(dev) == (acpi_handle)data;
348 static int i2c_acpi_find_match_device(struct device *dev, void *data)
350 return ACPI_COMPANION(dev) == data;
353 static struct i2c_adapter *i2c_acpi_find_adapter_by_handle(acpi_handle handle)
357 dev = bus_find_device(&i2c_bus_type, NULL, handle,
358 i2c_acpi_find_match_adapter);
359 return dev ? i2c_verify_adapter(dev) : NULL;
362 static struct i2c_client *i2c_acpi_find_client_by_adev(struct acpi_device *adev)
365 struct i2c_client *client;
367 dev = bus_find_device(&i2c_bus_type, NULL, adev,
368 i2c_acpi_find_match_device);
372 client = i2c_verify_client(dev);
379 static int i2c_acpi_notify(struct notifier_block *nb, unsigned long value,
382 struct acpi_device *adev = arg;
383 struct i2c_board_info info;
384 acpi_handle adapter_handle;
385 struct i2c_adapter *adapter;
386 struct i2c_client *client;
389 case ACPI_RECONFIG_DEVICE_ADD:
390 if (i2c_acpi_get_info(adev, &info, NULL, &adapter_handle))
393 adapter = i2c_acpi_find_adapter_by_handle(adapter_handle);
397 i2c_acpi_register_device(adapter, adev, &info);
398 put_device(&adapter->dev);
400 case ACPI_RECONFIG_DEVICE_REMOVE:
401 if (!acpi_device_enumerated(adev))
404 client = i2c_acpi_find_client_by_adev(adev);
408 i2c_unregister_device(client);
409 put_device(&client->dev);
416 struct notifier_block i2c_acpi_notifier = {
417 .notifier_call = i2c_acpi_notify,
421 * i2c_acpi_new_device - Create i2c-client for the Nth I2cSerialBus resource
422 * @dev: Device owning the ACPI resources to get the client from
423 * @index: Index of ACPI resource to get
424 * @info: describes the I2C device; note this is modified (addr gets set)
427 * By default the i2c subsys creates an i2c-client for the first I2cSerialBus
428 * resource of an acpi_device, but some acpi_devices have multiple I2cSerialBus
429 * resources, in that case this function can be used to create an i2c-client
430 * for other I2cSerialBus resources in the Current Resource Settings table.
432 * Also see i2c_new_device, which this function calls to create the i2c-client.
434 * Returns a pointer to the new i2c-client, or NULL if the adapter is not found.
436 struct i2c_client *i2c_acpi_new_device(struct device *dev, int index,
437 struct i2c_board_info *info)
439 struct i2c_acpi_lookup lookup;
440 struct i2c_adapter *adapter;
441 struct acpi_device *adev;
442 LIST_HEAD(resource_list);
445 adev = ACPI_COMPANION(dev);
449 memset(&lookup, 0, sizeof(lookup));
451 lookup.device_handle = acpi_device_handle(adev);
452 lookup.index = index;
454 ret = acpi_dev_get_resources(adev, &resource_list,
455 i2c_acpi_fill_info, &lookup);
456 acpi_dev_free_resource_list(&resource_list);
458 if (ret < 0 || !info->addr)
461 adapter = i2c_acpi_find_adapter_by_handle(lookup.adapter_handle);
465 return i2c_new_device(adapter, info);
467 EXPORT_SYMBOL_GPL(i2c_acpi_new_device);
469 #ifdef CONFIG_ACPI_I2C_OPREGION
470 static int acpi_gsb_i2c_read_bytes(struct i2c_client *client,
471 u8 cmd, u8 *data, u8 data_len)
474 struct i2c_msg msgs[2];
478 buffer = kzalloc(data_len, GFP_KERNEL);
482 msgs[0].addr = client->addr;
483 msgs[0].flags = client->flags;
487 msgs[1].addr = client->addr;
488 msgs[1].flags = client->flags | I2C_M_RD;
489 msgs[1].len = data_len;
490 msgs[1].buf = buffer;
492 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
494 /* Getting a NACK is unfortunately normal with some DSTDs */
495 if (ret == -EREMOTEIO)
496 dev_dbg(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
497 data_len, client->addr, cmd, ret);
499 dev_err(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
500 data_len, client->addr, cmd, ret);
501 /* 2 transfers must have completed successfully */
502 } else if (ret == 2) {
503 memcpy(data, buffer, data_len);
513 static int acpi_gsb_i2c_write_bytes(struct i2c_client *client,
514 u8 cmd, u8 *data, u8 data_len)
517 struct i2c_msg msgs[1];
521 buffer = kzalloc(data_len + 1, GFP_KERNEL);
526 memcpy(buffer + 1, data, data_len);
528 msgs[0].addr = client->addr;
529 msgs[0].flags = client->flags;
530 msgs[0].len = data_len + 1;
531 msgs[0].buf = buffer;
533 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
538 dev_err(&client->adapter->dev, "i2c write failed: %d\n", ret);
542 /* 1 transfer must have completed successfully */
543 return (ret == 1) ? 0 : -EIO;
547 i2c_acpi_space_handler(u32 function, acpi_physical_address command,
548 u32 bits, u64 *value64,
549 void *handler_context, void *region_context)
551 struct gsb_buffer *gsb = (struct gsb_buffer *)value64;
552 struct i2c_acpi_handler_data *data = handler_context;
553 struct acpi_connection_info *info = &data->info;
554 struct acpi_resource_i2c_serialbus *sb;
555 struct i2c_adapter *adapter = data->adapter;
556 struct i2c_client *client;
557 struct acpi_resource *ares;
558 u32 accessor_type = function >> 16;
559 u8 action = function & ACPI_IO_MASK;
563 ret = acpi_buffer_to_resource(info->connection, info->length, &ares);
564 if (ACPI_FAILURE(ret))
567 client = kzalloc(sizeof(*client), GFP_KERNEL);
573 if (!value64 || ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS) {
574 ret = AE_BAD_PARAMETER;
578 sb = &ares->data.i2c_serial_bus;
579 if (sb->type != ACPI_RESOURCE_SERIAL_TYPE_I2C) {
580 ret = AE_BAD_PARAMETER;
584 client->adapter = adapter;
585 client->addr = sb->slave_address;
587 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
588 client->flags |= I2C_CLIENT_TEN;
590 switch (accessor_type) {
591 case ACPI_GSB_ACCESS_ATTRIB_SEND_RCV:
592 if (action == ACPI_READ) {
593 status = i2c_smbus_read_byte(client);
599 status = i2c_smbus_write_byte(client, gsb->bdata);
603 case ACPI_GSB_ACCESS_ATTRIB_BYTE:
604 if (action == ACPI_READ) {
605 status = i2c_smbus_read_byte_data(client, command);
611 status = i2c_smbus_write_byte_data(client, command,
616 case ACPI_GSB_ACCESS_ATTRIB_WORD:
617 if (action == ACPI_READ) {
618 status = i2c_smbus_read_word_data(client, command);
624 status = i2c_smbus_write_word_data(client, command,
629 case ACPI_GSB_ACCESS_ATTRIB_BLOCK:
630 if (action == ACPI_READ) {
631 status = i2c_smbus_read_block_data(client, command,
638 status = i2c_smbus_write_block_data(client, command,
639 gsb->len, gsb->data);
643 case ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE:
644 if (action == ACPI_READ) {
645 status = acpi_gsb_i2c_read_bytes(client, command,
646 gsb->data, info->access_length);
648 status = acpi_gsb_i2c_write_bytes(client, command,
649 gsb->data, info->access_length);
654 dev_warn(&adapter->dev, "protocol 0x%02x not supported for client 0x%02x\n",
655 accessor_type, client->addr);
656 ret = AE_BAD_PARAMETER;
660 gsb->status = status;
669 int i2c_acpi_install_space_handler(struct i2c_adapter *adapter)
672 struct i2c_acpi_handler_data *data;
675 if (!adapter->dev.parent)
678 handle = ACPI_HANDLE(adapter->dev.parent);
683 data = kzalloc(sizeof(struct i2c_acpi_handler_data),
688 data->adapter = adapter;
689 status = acpi_bus_attach_private_data(handle, (void *)data);
690 if (ACPI_FAILURE(status)) {
695 status = acpi_install_address_space_handler(handle,
696 ACPI_ADR_SPACE_GSBUS,
697 &i2c_acpi_space_handler,
700 if (ACPI_FAILURE(status)) {
701 dev_err(&adapter->dev, "Error installing i2c space handler\n");
702 acpi_bus_detach_private_data(handle);
710 void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter)
713 struct i2c_acpi_handler_data *data;
716 if (!adapter->dev.parent)
719 handle = ACPI_HANDLE(adapter->dev.parent);
724 acpi_remove_address_space_handler(handle,
725 ACPI_ADR_SPACE_GSBUS,
726 &i2c_acpi_space_handler);
728 status = acpi_bus_get_private_data(handle, (void **)&data);
729 if (ACPI_SUCCESS(status))
732 acpi_bus_detach_private_data(handle);
734 #endif /* CONFIG_ACPI_I2C_OPREGION */