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_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 (IS_ERR(i2c_new_client_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)
268 if (!has_acpi_companion(&adap->dev))
271 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
272 I2C_ACPI_MAX_SCAN_DEPTH,
273 i2c_acpi_add_device, NULL,
275 if (ACPI_FAILURE(status))
276 dev_warn(&adap->dev, "failed to enumerate I2C slaves\n");
279 static const struct acpi_device_id i2c_acpi_force_400khz_device_ids[] = {
281 * These Silead touchscreen controllers only work at 400KHz, for
282 * some reason they do not work at 100KHz. On some devices the ACPI
283 * tables list another device at their bus as only being capable
284 * of 100KHz, testing has shown that these other devices work fine
285 * at 400KHz (as can be expected of any recent i2c hw) so we force
286 * the speed of the bus to 400 KHz if a Silead device is present.
292 static acpi_status i2c_acpi_lookup_speed(acpi_handle handle, u32 level,
293 void *data, void **return_value)
295 struct i2c_acpi_lookup *lookup = data;
296 struct acpi_device *adev;
298 if (acpi_bus_get_device(handle, &adev))
301 if (i2c_acpi_do_lookup(adev, lookup))
304 if (lookup->search_handle != lookup->adapter_handle)
307 if (lookup->speed <= lookup->min_speed)
308 lookup->min_speed = lookup->speed;
310 if (acpi_match_device_ids(adev, i2c_acpi_force_400khz_device_ids) == 0)
311 lookup->force_speed = I2C_MAX_FAST_MODE_FREQ;
317 * i2c_acpi_find_bus_speed - find I2C bus speed from ACPI
318 * @dev: The device owning the bus
320 * Find the I2C bus speed by walking the ACPI namespace for all I2C slaves
321 * devices connected to this bus and use the speed of slowest device.
323 * Returns the speed in Hz or zero
325 u32 i2c_acpi_find_bus_speed(struct device *dev)
327 struct i2c_acpi_lookup lookup;
328 struct i2c_board_info dummy;
331 if (!has_acpi_companion(dev))
334 memset(&lookup, 0, sizeof(lookup));
335 lookup.search_handle = ACPI_HANDLE(dev);
336 lookup.min_speed = UINT_MAX;
337 lookup.info = &dummy;
340 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
341 I2C_ACPI_MAX_SCAN_DEPTH,
342 i2c_acpi_lookup_speed, NULL,
345 if (ACPI_FAILURE(status)) {
346 dev_warn(dev, "unable to find I2C bus speed from ACPI\n");
350 if (lookup.force_speed) {
351 if (lookup.force_speed != lookup.min_speed)
352 dev_warn(dev, FW_BUG "DSDT uses known not-working I2C bus speed %d, forcing it to %d\n",
353 lookup.min_speed, lookup.force_speed);
354 return lookup.force_speed;
355 } else if (lookup.min_speed != UINT_MAX) {
356 return lookup.min_speed;
361 EXPORT_SYMBOL_GPL(i2c_acpi_find_bus_speed);
363 static int i2c_acpi_find_match_adapter(struct device *dev, const void *data)
365 struct i2c_adapter *adapter = i2c_verify_adapter(dev);
370 return ACPI_HANDLE(dev) == (acpi_handle)data;
373 struct i2c_adapter *i2c_acpi_find_adapter_by_handle(acpi_handle handle)
377 dev = bus_find_device(&i2c_bus_type, NULL, handle,
378 i2c_acpi_find_match_adapter);
380 return dev ? i2c_verify_adapter(dev) : NULL;
382 EXPORT_SYMBOL_GPL(i2c_acpi_find_adapter_by_handle);
384 static struct i2c_client *i2c_acpi_find_client_by_adev(struct acpi_device *adev)
387 struct i2c_client *client;
389 dev = bus_find_device_by_acpi_dev(&i2c_bus_type, adev);
393 client = i2c_verify_client(dev);
400 static int i2c_acpi_notify(struct notifier_block *nb, unsigned long value,
403 struct acpi_device *adev = arg;
404 struct i2c_board_info info;
405 acpi_handle adapter_handle;
406 struct i2c_adapter *adapter;
407 struct i2c_client *client;
410 case ACPI_RECONFIG_DEVICE_ADD:
411 if (i2c_acpi_get_info(adev, &info, NULL, &adapter_handle))
414 adapter = i2c_acpi_find_adapter_by_handle(adapter_handle);
418 i2c_acpi_register_device(adapter, adev, &info);
420 case ACPI_RECONFIG_DEVICE_REMOVE:
421 if (!acpi_device_enumerated(adev))
424 client = i2c_acpi_find_client_by_adev(adev);
428 i2c_unregister_device(client);
429 put_device(&client->dev);
436 struct notifier_block i2c_acpi_notifier = {
437 .notifier_call = i2c_acpi_notify,
441 * i2c_acpi_new_device - Create i2c-client for the Nth I2cSerialBus resource
442 * @dev: Device owning the ACPI resources to get the client from
443 * @index: Index of ACPI resource to get
444 * @info: describes the I2C device; note this is modified (addr gets set)
447 * By default the i2c subsys creates an i2c-client for the first I2cSerialBus
448 * resource of an acpi_device, but some acpi_devices have multiple I2cSerialBus
449 * resources, in that case this function can be used to create an i2c-client
450 * for other I2cSerialBus resources in the Current Resource Settings table.
452 * Also see i2c_new_client_device, which this function calls to create the
455 * Returns a pointer to the new i2c-client, or error pointer in case of failure.
456 * Specifically, -EPROBE_DEFER is returned if the adapter is not found.
458 struct i2c_client *i2c_acpi_new_device(struct device *dev, int index,
459 struct i2c_board_info *info)
461 struct acpi_device *adev = ACPI_COMPANION(dev);
462 struct i2c_acpi_lookup lookup;
463 struct i2c_adapter *adapter;
464 LIST_HEAD(resource_list);
467 memset(&lookup, 0, sizeof(lookup));
469 lookup.device_handle = acpi_device_handle(adev);
470 lookup.index = index;
472 ret = acpi_dev_get_resources(adev, &resource_list,
473 i2c_acpi_fill_info, &lookup);
477 acpi_dev_free_resource_list(&resource_list);
480 return ERR_PTR(-EADDRNOTAVAIL);
482 adapter = i2c_acpi_find_adapter_by_handle(lookup.adapter_handle);
484 return ERR_PTR(-EPROBE_DEFER);
486 return i2c_new_client_device(adapter, info);
488 EXPORT_SYMBOL_GPL(i2c_acpi_new_device);
490 #ifdef CONFIG_ACPI_I2C_OPREGION
491 static int acpi_gsb_i2c_read_bytes(struct i2c_client *client,
492 u8 cmd, u8 *data, u8 data_len)
495 struct i2c_msg msgs[2];
499 buffer = kzalloc(data_len, GFP_KERNEL);
503 msgs[0].addr = client->addr;
504 msgs[0].flags = client->flags;
508 msgs[1].addr = client->addr;
509 msgs[1].flags = client->flags | I2C_M_RD;
510 msgs[1].len = data_len;
511 msgs[1].buf = buffer;
513 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
515 /* Getting a NACK is unfortunately normal with some DSTDs */
516 if (ret == -EREMOTEIO)
517 dev_dbg(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
518 data_len, client->addr, cmd, ret);
520 dev_err(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
521 data_len, client->addr, cmd, ret);
522 /* 2 transfers must have completed successfully */
523 } else if (ret == 2) {
524 memcpy(data, buffer, data_len);
534 static int acpi_gsb_i2c_write_bytes(struct i2c_client *client,
535 u8 cmd, u8 *data, u8 data_len)
538 struct i2c_msg msgs[1];
542 buffer = kzalloc(data_len + 1, GFP_KERNEL);
547 memcpy(buffer + 1, data, data_len);
549 msgs[0].addr = client->addr;
550 msgs[0].flags = client->flags;
551 msgs[0].len = data_len + 1;
552 msgs[0].buf = buffer;
554 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
559 dev_err(&client->adapter->dev, "i2c write failed: %d\n", ret);
563 /* 1 transfer must have completed successfully */
564 return (ret == 1) ? 0 : -EIO;
568 i2c_acpi_space_handler(u32 function, acpi_physical_address command,
569 u32 bits, u64 *value64,
570 void *handler_context, void *region_context)
572 struct gsb_buffer *gsb = (struct gsb_buffer *)value64;
573 struct i2c_acpi_handler_data *data = handler_context;
574 struct acpi_connection_info *info = &data->info;
575 struct acpi_resource_i2c_serialbus *sb;
576 struct i2c_adapter *adapter = data->adapter;
577 struct i2c_client *client;
578 struct acpi_resource *ares;
579 u32 accessor_type = function >> 16;
580 u8 action = function & ACPI_IO_MASK;
584 ret = acpi_buffer_to_resource(info->connection, info->length, &ares);
585 if (ACPI_FAILURE(ret))
588 client = kzalloc(sizeof(*client), GFP_KERNEL);
594 if (!value64 || !i2c_acpi_get_i2c_resource(ares, &sb)) {
595 ret = AE_BAD_PARAMETER;
599 client->adapter = adapter;
600 client->addr = sb->slave_address;
602 if (sb->access_mode == ACPI_I2C_10BIT_MODE)
603 client->flags |= I2C_CLIENT_TEN;
605 switch (accessor_type) {
606 case ACPI_GSB_ACCESS_ATTRIB_SEND_RCV:
607 if (action == ACPI_READ) {
608 status = i2c_smbus_read_byte(client);
614 status = i2c_smbus_write_byte(client, gsb->bdata);
618 case ACPI_GSB_ACCESS_ATTRIB_BYTE:
619 if (action == ACPI_READ) {
620 status = i2c_smbus_read_byte_data(client, command);
626 status = i2c_smbus_write_byte_data(client, command,
631 case ACPI_GSB_ACCESS_ATTRIB_WORD:
632 if (action == ACPI_READ) {
633 status = i2c_smbus_read_word_data(client, command);
639 status = i2c_smbus_write_word_data(client, command,
644 case ACPI_GSB_ACCESS_ATTRIB_BLOCK:
645 if (action == ACPI_READ) {
646 status = i2c_smbus_read_block_data(client, command,
653 status = i2c_smbus_write_block_data(client, command,
654 gsb->len, gsb->data);
658 case ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE:
659 if (action == ACPI_READ) {
660 status = acpi_gsb_i2c_read_bytes(client, command,
661 gsb->data, info->access_length);
663 status = acpi_gsb_i2c_write_bytes(client, command,
664 gsb->data, info->access_length);
669 dev_warn(&adapter->dev, "protocol 0x%02x not supported for client 0x%02x\n",
670 accessor_type, client->addr);
671 ret = AE_BAD_PARAMETER;
675 gsb->status = status;
684 int i2c_acpi_install_space_handler(struct i2c_adapter *adapter)
687 struct i2c_acpi_handler_data *data;
690 if (!adapter->dev.parent)
693 handle = ACPI_HANDLE(adapter->dev.parent);
698 data = kzalloc(sizeof(struct i2c_acpi_handler_data),
703 data->adapter = adapter;
704 status = acpi_bus_attach_private_data(handle, (void *)data);
705 if (ACPI_FAILURE(status)) {
710 status = acpi_install_address_space_handler(handle,
711 ACPI_ADR_SPACE_GSBUS,
712 &i2c_acpi_space_handler,
715 if (ACPI_FAILURE(status)) {
716 dev_err(&adapter->dev, "Error installing i2c space handler\n");
717 acpi_bus_detach_private_data(handle);
722 acpi_walk_dep_device_list(handle);
726 void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter)
729 struct i2c_acpi_handler_data *data;
732 if (!adapter->dev.parent)
735 handle = ACPI_HANDLE(adapter->dev.parent);
740 acpi_remove_address_space_handler(handle,
741 ACPI_ADR_SPACE_GSBUS,
742 &i2c_acpi_space_handler);
744 status = acpi_bus_get_private_data(handle, (void **)&data);
745 if (ACPI_SUCCESS(status))
748 acpi_bus_detach_private_data(handle);
750 #endif /* CONFIG_ACPI_I2C_OPREGION */