1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Linux I2C core ACPI support code
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_resource_count(struct acpi_resource *ares, void *data)
74 struct acpi_resource_i2c_serialbus *sb;
77 if (i2c_acpi_get_i2c_resource(ares, &sb))
84 * i2c_acpi_client_count - Count the number of I2cSerialBus resources
87 * Returns the number of I2cSerialBus resources in the ACPI-device's
88 * resource-list; or a negative error code.
90 int i2c_acpi_client_count(struct acpi_device *adev)
95 ret = acpi_dev_get_resources(adev, &r, i2c_acpi_resource_count, &count);
99 acpi_dev_free_resource_list(&r);
102 EXPORT_SYMBOL_GPL(i2c_acpi_client_count);
104 static int i2c_acpi_fill_info(struct acpi_resource *ares, void *data)
106 struct i2c_acpi_lookup *lookup = data;
107 struct i2c_board_info *info = lookup->info;
108 struct acpi_resource_i2c_serialbus *sb;
111 if (info->addr || !i2c_acpi_get_i2c_resource(ares, &sb))
114 if (lookup->index != -1 && lookup->n++ != lookup->index)
117 status = acpi_get_handle(lookup->device_handle,
118 sb->resource_source.string_ptr,
119 &lookup->adapter_handle);
120 if (ACPI_FAILURE(status))
123 info->addr = sb->slave_address;
124 lookup->speed = sb->connection_speed;
125 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
126 info->flags |= I2C_CLIENT_TEN;
131 static const struct acpi_device_id i2c_acpi_ignored_device_ids[] = {
133 * ACPI video acpi_devices, which are handled by the acpi-video driver
134 * sometimes contain a SERIAL_TYPE_I2C ACPI resource, ignore these.
136 { ACPI_VIDEO_HID, 0 },
140 static int i2c_acpi_do_lookup(struct acpi_device *adev,
141 struct i2c_acpi_lookup *lookup)
143 struct i2c_board_info *info = lookup->info;
144 struct list_head resource_list;
147 if (acpi_bus_get_status(adev))
150 if (!acpi_dev_ready_for_enumeration(adev))
153 if (acpi_match_device_ids(adev, i2c_acpi_ignored_device_ids) == 0)
156 memset(info, 0, sizeof(*info));
157 lookup->device_handle = acpi_device_handle(adev);
159 /* Look up for I2cSerialBus resource */
160 INIT_LIST_HEAD(&resource_list);
161 ret = acpi_dev_get_resources(adev, &resource_list,
162 i2c_acpi_fill_info, lookup);
163 acpi_dev_free_resource_list(&resource_list);
165 if (ret < 0 || !info->addr)
171 static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data)
176 if (*irq <= 0 && acpi_dev_resource_interrupt(ares, 0, &r))
177 *irq = i2c_dev_irq_from_resources(&r, 1);
179 return 1; /* No need to add resource to the list */
183 * i2c_acpi_get_irq - get device IRQ number from ACPI
184 * @client: Pointer to the I2C client device
186 * Find the IRQ number used by a specific client device.
188 * Return: The IRQ number or an error code.
190 int i2c_acpi_get_irq(struct i2c_client *client)
192 struct acpi_device *adev = ACPI_COMPANION(&client->dev);
193 struct list_head resource_list;
197 INIT_LIST_HEAD(&resource_list);
199 ret = acpi_dev_get_resources(adev, &resource_list,
200 i2c_acpi_add_resource, &irq);
204 acpi_dev_free_resource_list(&resource_list);
207 irq = acpi_dev_gpio_irq_get(adev, 0);
212 static int i2c_acpi_get_info(struct acpi_device *adev,
213 struct i2c_board_info *info,
214 struct i2c_adapter *adapter,
215 acpi_handle *adapter_handle)
217 struct i2c_acpi_lookup lookup;
220 memset(&lookup, 0, sizeof(lookup));
224 if (acpi_device_enumerated(adev))
227 ret = i2c_acpi_do_lookup(adev, &lookup);
232 /* The adapter must match the one in I2cSerialBus() connector */
233 if (ACPI_HANDLE(&adapter->dev) != lookup.adapter_handle)
236 struct acpi_device *adapter_adev;
238 /* The adapter must be present */
239 adapter_adev = acpi_fetch_acpi_dev(lookup.adapter_handle);
242 if (acpi_bus_get_status(adapter_adev) ||
243 !adapter_adev->status.present)
247 info->fwnode = acpi_fwnode_handle(adev);
249 *adapter_handle = lookup.adapter_handle;
251 acpi_set_modalias(adev, dev_name(&adev->dev), info->type,
257 static void i2c_acpi_register_device(struct i2c_adapter *adapter,
258 struct acpi_device *adev,
259 struct i2c_board_info *info)
262 * Skip registration on boards where the ACPI tables are
263 * known to contain bogus I2C devices.
265 if (acpi_quirk_skip_i2c_client_enumeration(adev))
268 adev->power.flags.ignore_parent = true;
269 acpi_device_set_enumerated(adev);
271 if (IS_ERR(i2c_new_client_device(adapter, info)))
272 adev->power.flags.ignore_parent = false;
275 static acpi_status i2c_acpi_add_device(acpi_handle handle, u32 level,
276 void *data, void **return_value)
278 struct i2c_adapter *adapter = data;
279 struct acpi_device *adev = acpi_fetch_acpi_dev(handle);
280 struct i2c_board_info info;
282 if (!adev || i2c_acpi_get_info(adev, &info, adapter, NULL))
285 i2c_acpi_register_device(adapter, adev, &info);
290 #define I2C_ACPI_MAX_SCAN_DEPTH 32
293 * i2c_acpi_register_devices - enumerate I2C slave devices behind adapter
294 * @adap: pointer to adapter
296 * Enumerate all I2C slave devices behind this adapter by walking the ACPI
297 * namespace. When a device is found it will be added to the Linux device
298 * model and bound to the corresponding ACPI handle.
300 void i2c_acpi_register_devices(struct i2c_adapter *adap)
302 struct acpi_device *adev;
305 if (!has_acpi_companion(&adap->dev))
308 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
309 I2C_ACPI_MAX_SCAN_DEPTH,
310 i2c_acpi_add_device, NULL,
312 if (ACPI_FAILURE(status))
313 dev_warn(&adap->dev, "failed to enumerate I2C slaves\n");
315 if (!adap->dev.parent)
318 adev = ACPI_COMPANION(adap->dev.parent);
322 acpi_dev_clear_dependencies(adev);
325 static const struct acpi_device_id i2c_acpi_force_400khz_device_ids[] = {
327 * These Silead touchscreen controllers only work at 400KHz, for
328 * some reason they do not work at 100KHz. On some devices the ACPI
329 * tables list another device at their bus as only being capable
330 * of 100KHz, testing has shown that these other devices work fine
331 * at 400KHz (as can be expected of any recent i2c hw) so we force
332 * the speed of the bus to 400 KHz if a Silead device is present.
338 static acpi_status i2c_acpi_lookup_speed(acpi_handle handle, u32 level,
339 void *data, void **return_value)
341 struct i2c_acpi_lookup *lookup = data;
342 struct acpi_device *adev = acpi_fetch_acpi_dev(handle);
344 if (!adev || i2c_acpi_do_lookup(adev, lookup))
347 if (lookup->search_handle != lookup->adapter_handle)
350 if (lookup->speed <= lookup->min_speed)
351 lookup->min_speed = lookup->speed;
353 if (acpi_match_device_ids(adev, i2c_acpi_force_400khz_device_ids) == 0)
354 lookup->force_speed = I2C_MAX_FAST_MODE_FREQ;
360 * i2c_acpi_find_bus_speed - find I2C bus speed from ACPI
361 * @dev: The device owning the bus
363 * Find the I2C bus speed by walking the ACPI namespace for all I2C slaves
364 * devices connected to this bus and use the speed of slowest device.
366 * Returns the speed in Hz or zero
368 u32 i2c_acpi_find_bus_speed(struct device *dev)
370 struct i2c_acpi_lookup lookup;
371 struct i2c_board_info dummy;
374 if (!has_acpi_companion(dev))
377 memset(&lookup, 0, sizeof(lookup));
378 lookup.search_handle = ACPI_HANDLE(dev);
379 lookup.min_speed = UINT_MAX;
380 lookup.info = &dummy;
383 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
384 I2C_ACPI_MAX_SCAN_DEPTH,
385 i2c_acpi_lookup_speed, NULL,
388 if (ACPI_FAILURE(status)) {
389 dev_warn(dev, "unable to find I2C bus speed from ACPI\n");
393 if (lookup.force_speed) {
394 if (lookup.force_speed != lookup.min_speed)
395 dev_warn(dev, FW_BUG "DSDT uses known not-working I2C bus speed %d, forcing it to %d\n",
396 lookup.min_speed, lookup.force_speed);
397 return lookup.force_speed;
398 } else if (lookup.min_speed != UINT_MAX) {
399 return lookup.min_speed;
404 EXPORT_SYMBOL_GPL(i2c_acpi_find_bus_speed);
406 struct i2c_adapter *i2c_acpi_find_adapter_by_handle(acpi_handle handle)
408 struct i2c_adapter *adapter;
411 dev = bus_find_device(&i2c_bus_type, NULL, handle, device_match_acpi_handle);
415 adapter = i2c_verify_adapter(dev);
421 EXPORT_SYMBOL_GPL(i2c_acpi_find_adapter_by_handle);
423 static struct i2c_client *i2c_acpi_find_client_by_adev(struct acpi_device *adev)
426 struct i2c_client *client;
428 dev = bus_find_device_by_acpi_dev(&i2c_bus_type, adev);
432 client = i2c_verify_client(dev);
439 static int i2c_acpi_notify(struct notifier_block *nb, unsigned long value,
442 struct acpi_device *adev = arg;
443 struct i2c_board_info info;
444 acpi_handle adapter_handle;
445 struct i2c_adapter *adapter;
446 struct i2c_client *client;
449 case ACPI_RECONFIG_DEVICE_ADD:
450 if (i2c_acpi_get_info(adev, &info, NULL, &adapter_handle))
453 adapter = i2c_acpi_find_adapter_by_handle(adapter_handle);
457 i2c_acpi_register_device(adapter, adev, &info);
458 put_device(&adapter->dev);
460 case ACPI_RECONFIG_DEVICE_REMOVE:
461 if (!acpi_device_enumerated(adev))
464 client = i2c_acpi_find_client_by_adev(adev);
468 i2c_unregister_device(client);
469 put_device(&client->dev);
476 struct notifier_block i2c_acpi_notifier = {
477 .notifier_call = i2c_acpi_notify,
481 * i2c_acpi_new_device_by_fwnode - Create i2c-client for the Nth I2cSerialBus resource
482 * @fwnode: fwnode with the ACPI resources to get the client from
483 * @index: Index of ACPI resource to get
484 * @info: describes the I2C device; note this is modified (addr gets set)
487 * By default the i2c subsys creates an i2c-client for the first I2cSerialBus
488 * resource of an acpi_device, but some acpi_devices have multiple I2cSerialBus
489 * resources, in that case this function can be used to create an i2c-client
490 * for other I2cSerialBus resources in the Current Resource Settings table.
492 * Also see i2c_new_client_device, which this function calls to create the
495 * Returns a pointer to the new i2c-client, or error pointer in case of failure.
496 * Specifically, -EPROBE_DEFER is returned if the adapter is not found.
498 struct i2c_client *i2c_acpi_new_device_by_fwnode(struct fwnode_handle *fwnode,
500 struct i2c_board_info *info)
502 struct i2c_acpi_lookup lookup;
503 struct i2c_adapter *adapter;
504 struct acpi_device *adev;
505 LIST_HEAD(resource_list);
508 adev = to_acpi_device_node(fwnode);
510 return ERR_PTR(-ENODEV);
512 memset(&lookup, 0, sizeof(lookup));
514 lookup.device_handle = acpi_device_handle(adev);
515 lookup.index = index;
517 ret = acpi_dev_get_resources(adev, &resource_list,
518 i2c_acpi_fill_info, &lookup);
522 acpi_dev_free_resource_list(&resource_list);
525 return ERR_PTR(-EADDRNOTAVAIL);
527 adapter = i2c_acpi_find_adapter_by_handle(lookup.adapter_handle);
529 return ERR_PTR(-EPROBE_DEFER);
531 return i2c_new_client_device(adapter, info);
533 EXPORT_SYMBOL_GPL(i2c_acpi_new_device_by_fwnode);
535 bool i2c_acpi_waive_d0_probe(struct device *dev)
537 struct i2c_driver *driver = to_i2c_driver(dev->driver);
538 struct acpi_device *adev = ACPI_COMPANION(dev);
540 return driver->flags & I2C_DRV_ACPI_WAIVE_D0_PROBE &&
541 adev && adev->power.state_for_enumeration >= adev->power.state;
543 EXPORT_SYMBOL_GPL(i2c_acpi_waive_d0_probe);
545 #ifdef CONFIG_ACPI_I2C_OPREGION
546 static int acpi_gsb_i2c_read_bytes(struct i2c_client *client,
547 u8 cmd, u8 *data, u8 data_len)
550 struct i2c_msg msgs[2];
554 buffer = kzalloc(data_len, GFP_KERNEL);
558 msgs[0].addr = client->addr;
559 msgs[0].flags = client->flags;
563 msgs[1].addr = client->addr;
564 msgs[1].flags = client->flags | I2C_M_RD;
565 msgs[1].len = data_len;
566 msgs[1].buf = buffer;
568 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
570 /* Getting a NACK is unfortunately normal with some DSTDs */
571 if (ret == -EREMOTEIO)
572 dev_dbg(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
573 data_len, client->addr, cmd, ret);
575 dev_err(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
576 data_len, client->addr, cmd, ret);
577 /* 2 transfers must have completed successfully */
578 } else if (ret == 2) {
579 memcpy(data, buffer, data_len);
589 static int acpi_gsb_i2c_write_bytes(struct i2c_client *client,
590 u8 cmd, u8 *data, u8 data_len)
593 struct i2c_msg msgs[1];
597 buffer = kzalloc(data_len + 1, GFP_KERNEL);
602 memcpy(buffer + 1, data, data_len);
604 msgs[0].addr = client->addr;
605 msgs[0].flags = client->flags;
606 msgs[0].len = data_len + 1;
607 msgs[0].buf = buffer;
609 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
614 dev_err(&client->adapter->dev, "i2c write failed: %d\n", ret);
618 /* 1 transfer must have completed successfully */
619 return (ret == 1) ? 0 : -EIO;
623 i2c_acpi_space_handler(u32 function, acpi_physical_address command,
624 u32 bits, u64 *value64,
625 void *handler_context, void *region_context)
627 struct gsb_buffer *gsb = (struct gsb_buffer *)value64;
628 struct i2c_acpi_handler_data *data = handler_context;
629 struct acpi_connection_info *info = &data->info;
630 struct acpi_resource_i2c_serialbus *sb;
631 struct i2c_adapter *adapter = data->adapter;
632 struct i2c_client *client;
633 struct acpi_resource *ares;
634 u32 accessor_type = function >> 16;
635 u8 action = function & ACPI_IO_MASK;
639 ret = acpi_buffer_to_resource(info->connection, info->length, &ares);
640 if (ACPI_FAILURE(ret))
643 client = kzalloc(sizeof(*client), GFP_KERNEL);
649 if (!value64 || !i2c_acpi_get_i2c_resource(ares, &sb)) {
650 ret = AE_BAD_PARAMETER;
654 client->adapter = adapter;
655 client->addr = sb->slave_address;
657 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
658 client->flags |= I2C_CLIENT_TEN;
660 switch (accessor_type) {
661 case ACPI_GSB_ACCESS_ATTRIB_SEND_RCV:
662 if (action == ACPI_READ) {
663 status = i2c_smbus_read_byte(client);
669 status = i2c_smbus_write_byte(client, gsb->bdata);
673 case ACPI_GSB_ACCESS_ATTRIB_BYTE:
674 if (action == ACPI_READ) {
675 status = i2c_smbus_read_byte_data(client, command);
681 status = i2c_smbus_write_byte_data(client, command,
686 case ACPI_GSB_ACCESS_ATTRIB_WORD:
687 if (action == ACPI_READ) {
688 status = i2c_smbus_read_word_data(client, command);
694 status = i2c_smbus_write_word_data(client, command,
699 case ACPI_GSB_ACCESS_ATTRIB_BLOCK:
700 if (action == ACPI_READ) {
701 status = i2c_smbus_read_block_data(client, command,
708 status = i2c_smbus_write_block_data(client, command,
709 gsb->len, gsb->data);
713 case ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE:
714 if (action == ACPI_READ) {
715 status = acpi_gsb_i2c_read_bytes(client, command,
716 gsb->data, info->access_length);
718 status = acpi_gsb_i2c_write_bytes(client, command,
719 gsb->data, info->access_length);
724 dev_warn(&adapter->dev, "protocol 0x%02x not supported for client 0x%02x\n",
725 accessor_type, client->addr);
726 ret = AE_BAD_PARAMETER;
730 gsb->status = status;
739 int i2c_acpi_install_space_handler(struct i2c_adapter *adapter)
742 struct i2c_acpi_handler_data *data;
745 if (!adapter->dev.parent)
748 handle = ACPI_HANDLE(adapter->dev.parent);
753 data = kzalloc(sizeof(struct i2c_acpi_handler_data),
758 data->adapter = adapter;
759 status = acpi_bus_attach_private_data(handle, (void *)data);
760 if (ACPI_FAILURE(status)) {
765 status = acpi_install_address_space_handler(handle,
766 ACPI_ADR_SPACE_GSBUS,
767 &i2c_acpi_space_handler,
770 if (ACPI_FAILURE(status)) {
771 dev_err(&adapter->dev, "Error installing i2c space handler\n");
772 acpi_bus_detach_private_data(handle);
780 void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter)
783 struct i2c_acpi_handler_data *data;
786 if (!adapter->dev.parent)
789 handle = ACPI_HANDLE(adapter->dev.parent);
794 acpi_remove_address_space_handler(handle,
795 ACPI_ADR_SPACE_GSBUS,
796 &i2c_acpi_space_handler);
798 status = acpi_bus_get_private_data(handle, (void **)&data);
799 if (ACPI_SUCCESS(status))
802 acpi_bus_detach_private_data(handle);
804 #endif /* CONFIG_ACPI_I2C_OPREGION */