1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Linux I2C core ACPI support code
5 * Copyright (C) 2014 Intel Corp, Author: Lan Tianyu <tianyu.lan@intel.com>
8 #include <linux/acpi.h>
9 #include <linux/device.h>
10 #include <linux/err.h>
11 #include <linux/i2c.h>
12 #include <linux/list.h>
13 #include <linux/module.h>
14 #include <linux/slab.h>
18 struct i2c_acpi_handler_data {
19 struct acpi_connection_info info;
20 struct i2c_adapter *adapter;
33 struct i2c_acpi_lookup {
34 struct i2c_board_info *info;
35 acpi_handle adapter_handle;
36 acpi_handle device_handle;
37 acpi_handle search_handle;
46 * i2c_acpi_get_i2c_resource - Gets I2cSerialBus resource if type matches
47 * @ares: ACPI resource
48 * @i2c: Pointer to I2cSerialBus resource will be returned here
50 * Checks if the given ACPI resource is of type I2cSerialBus.
51 * In this case, returns a pointer to it to the caller.
53 * Returns true if resource type is of I2cSerialBus, otherwise false.
55 bool i2c_acpi_get_i2c_resource(struct acpi_resource *ares,
56 struct acpi_resource_i2c_serialbus **i2c)
58 struct acpi_resource_i2c_serialbus *sb;
60 if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
63 sb = &ares->data.i2c_serial_bus;
64 if (sb->type != ACPI_RESOURCE_SERIAL_TYPE_I2C)
70 EXPORT_SYMBOL_GPL(i2c_acpi_get_i2c_resource);
72 static int i2c_acpi_fill_info(struct acpi_resource *ares, void *data)
74 struct i2c_acpi_lookup *lookup = data;
75 struct i2c_board_info *info = lookup->info;
76 struct acpi_resource_i2c_serialbus *sb;
79 if (info->addr || !i2c_acpi_get_i2c_resource(ares, &sb))
82 if (lookup->index != -1 && lookup->n++ != lookup->index)
85 status = acpi_get_handle(lookup->device_handle,
86 sb->resource_source.string_ptr,
87 &lookup->adapter_handle);
88 if (ACPI_FAILURE(status))
91 info->addr = sb->slave_address;
92 lookup->speed = sb->connection_speed;
93 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
94 info->flags |= I2C_CLIENT_TEN;
99 static const struct acpi_device_id i2c_acpi_ignored_device_ids[] = {
101 * ACPI video acpi_devices, which are handled by the acpi-video driver
102 * sometimes contain a SERIAL_TYPE_I2C ACPI resource, ignore these.
104 { ACPI_VIDEO_HID, 0 },
108 static int i2c_acpi_do_lookup(struct acpi_device *adev,
109 struct i2c_acpi_lookup *lookup)
111 struct i2c_board_info *info = lookup->info;
112 struct list_head resource_list;
115 if (acpi_bus_get_status(adev) || !adev->status.present)
118 if (acpi_match_device_ids(adev, i2c_acpi_ignored_device_ids) == 0)
121 memset(info, 0, sizeof(*info));
122 lookup->device_handle = acpi_device_handle(adev);
124 /* Look up for I2cSerialBus resource */
125 INIT_LIST_HEAD(&resource_list);
126 ret = acpi_dev_get_resources(adev, &resource_list,
127 i2c_acpi_fill_info, lookup);
128 acpi_dev_free_resource_list(&resource_list);
130 if (ret < 0 || !info->addr)
136 static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data)
141 if (*irq <= 0 && acpi_dev_resource_interrupt(ares, 0, &r))
142 *irq = i2c_dev_irq_from_resources(&r, 1);
144 return 1; /* No need to add resource to the list */
148 * i2c_acpi_get_irq - get device IRQ number from ACPI
149 * @client: Pointer to the I2C client device
151 * Find the IRQ number used by a specific client device.
153 * Return: The IRQ number or an error code.
155 int i2c_acpi_get_irq(struct i2c_client *client)
157 struct acpi_device *adev = ACPI_COMPANION(&client->dev);
158 struct list_head resource_list;
162 INIT_LIST_HEAD(&resource_list);
164 ret = acpi_dev_get_resources(adev, &resource_list,
165 i2c_acpi_add_resource, &irq);
169 acpi_dev_free_resource_list(&resource_list);
172 irq = acpi_dev_gpio_irq_get(adev, 0);
177 static int i2c_acpi_get_info(struct acpi_device *adev,
178 struct i2c_board_info *info,
179 struct i2c_adapter *adapter,
180 acpi_handle *adapter_handle)
182 struct i2c_acpi_lookup lookup;
185 memset(&lookup, 0, sizeof(lookup));
189 if (acpi_device_enumerated(adev))
192 ret = i2c_acpi_do_lookup(adev, &lookup);
197 /* The adapter must match the one in I2cSerialBus() connector */
198 if (ACPI_HANDLE(&adapter->dev) != lookup.adapter_handle)
201 struct acpi_device *adapter_adev;
203 /* The adapter must be present */
204 if (acpi_bus_get_device(lookup.adapter_handle, &adapter_adev))
206 if (acpi_bus_get_status(adapter_adev) ||
207 !adapter_adev->status.present)
211 info->fwnode = acpi_fwnode_handle(adev);
213 *adapter_handle = lookup.adapter_handle;
215 acpi_set_modalias(adev, dev_name(&adev->dev), info->type,
221 static void i2c_acpi_register_device(struct i2c_adapter *adapter,
222 struct acpi_device *adev,
223 struct i2c_board_info *info)
225 adev->power.flags.ignore_parent = true;
226 acpi_device_set_enumerated(adev);
228 if (!i2c_new_device(adapter, info)) {
229 adev->power.flags.ignore_parent = false;
230 dev_err(&adapter->dev,
231 "failed to add I2C device %s from ACPI\n",
232 dev_name(&adev->dev));
236 static acpi_status i2c_acpi_add_device(acpi_handle handle, u32 level,
237 void *data, void **return_value)
239 struct i2c_adapter *adapter = data;
240 struct acpi_device *adev;
241 struct i2c_board_info info;
243 if (acpi_bus_get_device(handle, &adev))
246 if (i2c_acpi_get_info(adev, &info, adapter, NULL))
249 i2c_acpi_register_device(adapter, adev, &info);
254 #define I2C_ACPI_MAX_SCAN_DEPTH 32
257 * i2c_acpi_register_devices - enumerate I2C slave devices behind adapter
258 * @adap: pointer to adapter
260 * Enumerate all I2C slave devices behind this adapter by walking the ACPI
261 * namespace. When a device is found it will be added to the Linux device
262 * model and bound to the corresponding ACPI handle.
264 void i2c_acpi_register_devices(struct i2c_adapter *adap)
269 if (!has_acpi_companion(&adap->dev))
272 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
273 I2C_ACPI_MAX_SCAN_DEPTH,
274 i2c_acpi_add_device, NULL,
276 if (ACPI_FAILURE(status))
277 dev_warn(&adap->dev, "failed to enumerate I2C slaves\n");
279 if (!adap->dev.parent)
282 handle = ACPI_HANDLE(adap->dev.parent);
286 acpi_walk_dep_device_list(handle);
289 const struct acpi_device_id *
290 i2c_acpi_match_device(const struct acpi_device_id *matches,
291 struct i2c_client *client)
293 if (!(client && matches))
296 return acpi_match_device(matches, &client->dev);
299 static const struct acpi_device_id i2c_acpi_force_400khz_device_ids[] = {
301 * These Silead touchscreen controllers only work at 400KHz, for
302 * some reason they do not work at 100KHz. On some devices the ACPI
303 * tables list another device at their bus as only being capable
304 * of 100KHz, testing has shown that these other devices work fine
305 * at 400KHz (as can be expected of any recent i2c hw) so we force
306 * the speed of the bus to 400 KHz if a Silead device is present.
312 static acpi_status i2c_acpi_lookup_speed(acpi_handle handle, u32 level,
313 void *data, void **return_value)
315 struct i2c_acpi_lookup *lookup = data;
316 struct acpi_device *adev;
318 if (acpi_bus_get_device(handle, &adev))
321 if (i2c_acpi_do_lookup(adev, lookup))
324 if (lookup->search_handle != lookup->adapter_handle)
327 if (lookup->speed <= lookup->min_speed)
328 lookup->min_speed = lookup->speed;
330 if (acpi_match_device_ids(adev, i2c_acpi_force_400khz_device_ids) == 0)
331 lookup->force_speed = 400000;
337 * i2c_acpi_find_bus_speed - find I2C bus speed from ACPI
338 * @dev: The device owning the bus
340 * Find the I2C bus speed by walking the ACPI namespace for all I2C slaves
341 * devices connected to this bus and use the speed of slowest device.
343 * Returns the speed in Hz or zero
345 u32 i2c_acpi_find_bus_speed(struct device *dev)
347 struct i2c_acpi_lookup lookup;
348 struct i2c_board_info dummy;
351 if (!has_acpi_companion(dev))
354 memset(&lookup, 0, sizeof(lookup));
355 lookup.search_handle = ACPI_HANDLE(dev);
356 lookup.min_speed = UINT_MAX;
357 lookup.info = &dummy;
360 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
361 I2C_ACPI_MAX_SCAN_DEPTH,
362 i2c_acpi_lookup_speed, NULL,
365 if (ACPI_FAILURE(status)) {
366 dev_warn(dev, "unable to find I2C bus speed from ACPI\n");
370 if (lookup.force_speed) {
371 if (lookup.force_speed != lookup.min_speed)
372 dev_warn(dev, FW_BUG "DSDT uses known not-working I2C bus speed %d, forcing it to %d\n",
373 lookup.min_speed, lookup.force_speed);
374 return lookup.force_speed;
375 } else if (lookup.min_speed != UINT_MAX) {
376 return lookup.min_speed;
381 EXPORT_SYMBOL_GPL(i2c_acpi_find_bus_speed);
383 static int i2c_acpi_find_match_adapter(struct device *dev, const void *data)
385 struct i2c_adapter *adapter = i2c_verify_adapter(dev);
390 return ACPI_HANDLE(dev) == (acpi_handle)data;
393 struct i2c_adapter *i2c_acpi_find_adapter_by_handle(acpi_handle handle)
397 dev = bus_find_device(&i2c_bus_type, NULL, handle,
398 i2c_acpi_find_match_adapter);
400 return dev ? i2c_verify_adapter(dev) : NULL;
402 EXPORT_SYMBOL_GPL(i2c_acpi_find_adapter_by_handle);
404 static struct i2c_client *i2c_acpi_find_client_by_adev(struct acpi_device *adev)
407 struct i2c_client *client;
409 dev = bus_find_device_by_acpi_dev(&i2c_bus_type, adev);
413 client = i2c_verify_client(dev);
420 static int i2c_acpi_notify(struct notifier_block *nb, unsigned long value,
423 struct acpi_device *adev = arg;
424 struct i2c_board_info info;
425 acpi_handle adapter_handle;
426 struct i2c_adapter *adapter;
427 struct i2c_client *client;
430 case ACPI_RECONFIG_DEVICE_ADD:
431 if (i2c_acpi_get_info(adev, &info, NULL, &adapter_handle))
434 adapter = i2c_acpi_find_adapter_by_handle(adapter_handle);
438 i2c_acpi_register_device(adapter, adev, &info);
439 put_device(&adapter->dev);
441 case ACPI_RECONFIG_DEVICE_REMOVE:
442 if (!acpi_device_enumerated(adev))
445 client = i2c_acpi_find_client_by_adev(adev);
449 i2c_unregister_device(client);
450 put_device(&client->dev);
457 struct notifier_block i2c_acpi_notifier = {
458 .notifier_call = i2c_acpi_notify,
462 * i2c_acpi_new_device - Create i2c-client for the Nth I2cSerialBus resource
463 * @dev: Device owning the ACPI resources to get the client from
464 * @index: Index of ACPI resource to get
465 * @info: describes the I2C device; note this is modified (addr gets set)
468 * By default the i2c subsys creates an i2c-client for the first I2cSerialBus
469 * resource of an acpi_device, but some acpi_devices have multiple I2cSerialBus
470 * resources, in that case this function can be used to create an i2c-client
471 * for other I2cSerialBus resources in the Current Resource Settings table.
473 * Also see i2c_new_device, which this function calls to create the i2c-client.
475 * Returns a pointer to the new i2c-client, or error pointer in case of failure.
476 * Specifically, -EPROBE_DEFER is returned if the adapter is not found.
478 struct i2c_client *i2c_acpi_new_device(struct device *dev, int index,
479 struct i2c_board_info *info)
481 struct i2c_acpi_lookup lookup;
482 struct i2c_adapter *adapter;
483 struct i2c_client *client;
484 struct acpi_device *adev;
485 LIST_HEAD(resource_list);
488 adev = ACPI_COMPANION(dev);
490 return ERR_PTR(-EINVAL);
492 memset(&lookup, 0, sizeof(lookup));
494 lookup.device_handle = acpi_device_handle(adev);
495 lookup.index = index;
497 ret = acpi_dev_get_resources(adev, &resource_list,
498 i2c_acpi_fill_info, &lookup);
502 acpi_dev_free_resource_list(&resource_list);
505 return ERR_PTR(-EADDRNOTAVAIL);
507 adapter = i2c_acpi_find_adapter_by_handle(lookup.adapter_handle);
509 return ERR_PTR(-EPROBE_DEFER);
511 client = i2c_new_device(adapter, info);
513 return ERR_PTR(-ENODEV);
517 EXPORT_SYMBOL_GPL(i2c_acpi_new_device);
519 #ifdef CONFIG_ACPI_I2C_OPREGION
520 static int acpi_gsb_i2c_read_bytes(struct i2c_client *client,
521 u8 cmd, u8 *data, u8 data_len)
524 struct i2c_msg msgs[2];
528 buffer = kzalloc(data_len, GFP_KERNEL);
532 msgs[0].addr = client->addr;
533 msgs[0].flags = client->flags;
537 msgs[1].addr = client->addr;
538 msgs[1].flags = client->flags | I2C_M_RD;
539 msgs[1].len = data_len;
540 msgs[1].buf = buffer;
542 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
544 /* Getting a NACK is unfortunately normal with some DSTDs */
545 if (ret == -EREMOTEIO)
546 dev_dbg(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
547 data_len, client->addr, cmd, ret);
549 dev_err(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
550 data_len, client->addr, cmd, ret);
551 /* 2 transfers must have completed successfully */
552 } else if (ret == 2) {
553 memcpy(data, buffer, data_len);
563 static int acpi_gsb_i2c_write_bytes(struct i2c_client *client,
564 u8 cmd, u8 *data, u8 data_len)
567 struct i2c_msg msgs[1];
571 buffer = kzalloc(data_len + 1, GFP_KERNEL);
576 memcpy(buffer + 1, data, data_len);
578 msgs[0].addr = client->addr;
579 msgs[0].flags = client->flags;
580 msgs[0].len = data_len + 1;
581 msgs[0].buf = buffer;
583 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
588 dev_err(&client->adapter->dev, "i2c write failed: %d\n", ret);
592 /* 1 transfer must have completed successfully */
593 return (ret == 1) ? 0 : -EIO;
597 i2c_acpi_space_handler(u32 function, acpi_physical_address command,
598 u32 bits, u64 *value64,
599 void *handler_context, void *region_context)
601 struct gsb_buffer *gsb = (struct gsb_buffer *)value64;
602 struct i2c_acpi_handler_data *data = handler_context;
603 struct acpi_connection_info *info = &data->info;
604 struct acpi_resource_i2c_serialbus *sb;
605 struct i2c_adapter *adapter = data->adapter;
606 struct i2c_client *client;
607 struct acpi_resource *ares;
608 u32 accessor_type = function >> 16;
609 u8 action = function & ACPI_IO_MASK;
613 ret = acpi_buffer_to_resource(info->connection, info->length, &ares);
614 if (ACPI_FAILURE(ret))
617 client = kzalloc(sizeof(*client), GFP_KERNEL);
623 if (!value64 || !i2c_acpi_get_i2c_resource(ares, &sb)) {
624 ret = AE_BAD_PARAMETER;
628 client->adapter = adapter;
629 client->addr = sb->slave_address;
631 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
632 client->flags |= I2C_CLIENT_TEN;
634 switch (accessor_type) {
635 case ACPI_GSB_ACCESS_ATTRIB_SEND_RCV:
636 if (action == ACPI_READ) {
637 status = i2c_smbus_read_byte(client);
643 status = i2c_smbus_write_byte(client, gsb->bdata);
647 case ACPI_GSB_ACCESS_ATTRIB_BYTE:
648 if (action == ACPI_READ) {
649 status = i2c_smbus_read_byte_data(client, command);
655 status = i2c_smbus_write_byte_data(client, command,
660 case ACPI_GSB_ACCESS_ATTRIB_WORD:
661 if (action == ACPI_READ) {
662 status = i2c_smbus_read_word_data(client, command);
668 status = i2c_smbus_write_word_data(client, command,
673 case ACPI_GSB_ACCESS_ATTRIB_BLOCK:
674 if (action == ACPI_READ) {
675 status = i2c_smbus_read_block_data(client, command,
682 status = i2c_smbus_write_block_data(client, command,
683 gsb->len, gsb->data);
687 case ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE:
688 if (action == ACPI_READ) {
689 status = acpi_gsb_i2c_read_bytes(client, command,
690 gsb->data, info->access_length);
692 status = acpi_gsb_i2c_write_bytes(client, command,
693 gsb->data, info->access_length);
698 dev_warn(&adapter->dev, "protocol 0x%02x not supported for client 0x%02x\n",
699 accessor_type, client->addr);
700 ret = AE_BAD_PARAMETER;
704 gsb->status = status;
713 int i2c_acpi_install_space_handler(struct i2c_adapter *adapter)
716 struct i2c_acpi_handler_data *data;
719 if (!adapter->dev.parent)
722 handle = ACPI_HANDLE(adapter->dev.parent);
727 data = kzalloc(sizeof(struct i2c_acpi_handler_data),
732 data->adapter = adapter;
733 status = acpi_bus_attach_private_data(handle, (void *)data);
734 if (ACPI_FAILURE(status)) {
739 status = acpi_install_address_space_handler(handle,
740 ACPI_ADR_SPACE_GSBUS,
741 &i2c_acpi_space_handler,
744 if (ACPI_FAILURE(status)) {
745 dev_err(&adapter->dev, "Error installing i2c space handler\n");
746 acpi_bus_detach_private_data(handle);
754 void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter)
757 struct i2c_acpi_handler_data *data;
760 if (!adapter->dev.parent)
763 handle = ACPI_HANDLE(adapter->dev.parent);
768 acpi_remove_address_space_handler(handle,
769 ACPI_ADR_SPACE_GSBUS,
770 &i2c_acpi_space_handler);
772 status = acpi_bus_get_private_data(handle, (void **)&data);
773 if (ACPI_SUCCESS(status))
776 acpi_bus_detach_private_data(handle);
778 #endif /* CONFIG_ACPI_I2C_OPREGION */