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
)
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 const struct acpi_device_id
*
280 i2c_acpi_match_device(const struct acpi_device_id
*matches
,
281 struct i2c_client
*client
)
283 if (!(client
&& matches
))
286 return acpi_match_device(matches
, &client
->dev
);
289 static const struct acpi_device_id i2c_acpi_force_400khz_device_ids
[] = {
291 * These Silead touchscreen controllers only work at 400KHz, for
292 * some reason they do not work at 100KHz. On some devices the ACPI
293 * tables list another device at their bus as only being capable
294 * of 100KHz, testing has shown that these other devices work fine
295 * at 400KHz (as can be expected of any recent i2c hw) so we force
296 * the speed of the bus to 400 KHz if a Silead device is present.
302 static acpi_status
i2c_acpi_lookup_speed(acpi_handle handle
, u32 level
,
303 void *data
, void **return_value
)
305 struct i2c_acpi_lookup
*lookup
= data
;
306 struct acpi_device
*adev
;
308 if (acpi_bus_get_device(handle
, &adev
))
311 if (i2c_acpi_do_lookup(adev
, lookup
))
314 if (lookup
->search_handle
!= lookup
->adapter_handle
)
317 if (lookup
->speed
<= lookup
->min_speed
)
318 lookup
->min_speed
= lookup
->speed
;
320 if (acpi_match_device_ids(adev
, i2c_acpi_force_400khz_device_ids
) == 0)
321 lookup
->force_speed
= 400000;
327 * i2c_acpi_find_bus_speed - find I2C bus speed from ACPI
328 * @dev: The device owning the bus
330 * Find the I2C bus speed by walking the ACPI namespace for all I2C slaves
331 * devices connected to this bus and use the speed of slowest device.
333 * Returns the speed in Hz or zero
335 u32
i2c_acpi_find_bus_speed(struct device
*dev
)
337 struct i2c_acpi_lookup lookup
;
338 struct i2c_board_info dummy
;
341 if (!has_acpi_companion(dev
))
344 memset(&lookup
, 0, sizeof(lookup
));
345 lookup
.search_handle
= ACPI_HANDLE(dev
);
346 lookup
.min_speed
= UINT_MAX
;
347 lookup
.info
= &dummy
;
350 status
= acpi_walk_namespace(ACPI_TYPE_DEVICE
, ACPI_ROOT_OBJECT
,
351 I2C_ACPI_MAX_SCAN_DEPTH
,
352 i2c_acpi_lookup_speed
, NULL
,
355 if (ACPI_FAILURE(status
)) {
356 dev_warn(dev
, "unable to find I2C bus speed from ACPI\n");
360 if (lookup
.force_speed
) {
361 if (lookup
.force_speed
!= lookup
.min_speed
)
362 dev_warn(dev
, FW_BUG
"DSDT uses known not-working I2C bus speed %d, forcing it to %d\n",
363 lookup
.min_speed
, lookup
.force_speed
);
364 return lookup
.force_speed
;
365 } else if (lookup
.min_speed
!= UINT_MAX
) {
366 return lookup
.min_speed
;
371 EXPORT_SYMBOL_GPL(i2c_acpi_find_bus_speed
);
373 static int i2c_acpi_find_match_adapter(struct device
*dev
, const void *data
)
375 struct i2c_adapter
*adapter
= i2c_verify_adapter(dev
);
380 return ACPI_HANDLE(dev
) == (acpi_handle
)data
;
383 struct i2c_adapter
*i2c_acpi_find_adapter_by_handle(acpi_handle handle
)
387 dev
= bus_find_device(&i2c_bus_type
, NULL
, handle
,
388 i2c_acpi_find_match_adapter
);
390 return dev
? i2c_verify_adapter(dev
) : NULL
;
392 EXPORT_SYMBOL_GPL(i2c_acpi_find_adapter_by_handle
);
394 static struct i2c_client
*i2c_acpi_find_client_by_adev(struct acpi_device
*adev
)
398 dev
= bus_find_device_by_acpi_dev(&i2c_bus_type
, adev
);
399 return dev
? i2c_verify_client(dev
) : NULL
;
402 static int i2c_acpi_notify(struct notifier_block
*nb
, unsigned long value
,
405 struct acpi_device
*adev
= arg
;
406 struct i2c_board_info info
;
407 acpi_handle adapter_handle
;
408 struct i2c_adapter
*adapter
;
409 struct i2c_client
*client
;
412 case ACPI_RECONFIG_DEVICE_ADD
:
413 if (i2c_acpi_get_info(adev
, &info
, NULL
, &adapter_handle
))
416 adapter
= i2c_acpi_find_adapter_by_handle(adapter_handle
);
420 i2c_acpi_register_device(adapter
, adev
, &info
);
422 case ACPI_RECONFIG_DEVICE_REMOVE
:
423 if (!acpi_device_enumerated(adev
))
426 client
= i2c_acpi_find_client_by_adev(adev
);
430 i2c_unregister_device(client
);
431 put_device(&client
->dev
);
438 struct notifier_block i2c_acpi_notifier
= {
439 .notifier_call
= i2c_acpi_notify
,
443 * i2c_acpi_new_device - Create i2c-client for the Nth I2cSerialBus resource
444 * @dev: Device owning the ACPI resources to get the client from
445 * @index: Index of ACPI resource to get
446 * @info: describes the I2C device; note this is modified (addr gets set)
449 * By default the i2c subsys creates an i2c-client for the first I2cSerialBus
450 * resource of an acpi_device, but some acpi_devices have multiple I2cSerialBus
451 * resources, in that case this function can be used to create an i2c-client
452 * for other I2cSerialBus resources in the Current Resource Settings table.
454 * Also see i2c_new_device, which this function calls to create the i2c-client.
456 * Returns a pointer to the new i2c-client, or error pointer in case of failure.
457 * Specifically, -EPROBE_DEFER is returned if the adapter is not found.
459 struct i2c_client
*i2c_acpi_new_device(struct device
*dev
, int index
,
460 struct i2c_board_info
*info
)
462 struct i2c_acpi_lookup lookup
;
463 struct i2c_adapter
*adapter
;
464 struct i2c_client
*client
;
465 struct acpi_device
*adev
;
466 LIST_HEAD(resource_list
);
469 adev
= ACPI_COMPANION(dev
);
471 return ERR_PTR(-EINVAL
);
473 memset(&lookup
, 0, sizeof(lookup
));
475 lookup
.device_handle
= acpi_device_handle(adev
);
476 lookup
.index
= index
;
478 ret
= acpi_dev_get_resources(adev
, &resource_list
,
479 i2c_acpi_fill_info
, &lookup
);
483 acpi_dev_free_resource_list(&resource_list
);
486 return ERR_PTR(-EADDRNOTAVAIL
);
488 adapter
= i2c_acpi_find_adapter_by_handle(lookup
.adapter_handle
);
490 return ERR_PTR(-EPROBE_DEFER
);
492 client
= i2c_new_device(adapter
, info
);
494 return ERR_PTR(-ENODEV
);
498 EXPORT_SYMBOL_GPL(i2c_acpi_new_device
);
500 #ifdef CONFIG_ACPI_I2C_OPREGION
501 static int acpi_gsb_i2c_read_bytes(struct i2c_client
*client
,
502 u8 cmd
, u8
*data
, u8 data_len
)
505 struct i2c_msg msgs
[2];
509 buffer
= kzalloc(data_len
, GFP_KERNEL
);
513 msgs
[0].addr
= client
->addr
;
514 msgs
[0].flags
= client
->flags
;
518 msgs
[1].addr
= client
->addr
;
519 msgs
[1].flags
= client
->flags
| I2C_M_RD
;
520 msgs
[1].len
= data_len
;
521 msgs
[1].buf
= buffer
;
523 ret
= i2c_transfer(client
->adapter
, msgs
, ARRAY_SIZE(msgs
));
525 /* Getting a NACK is unfortunately normal with some DSTDs */
526 if (ret
== -EREMOTEIO
)
527 dev_dbg(&client
->adapter
->dev
, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
528 data_len
, client
->addr
, cmd
, ret
);
530 dev_err(&client
->adapter
->dev
, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
531 data_len
, client
->addr
, cmd
, ret
);
532 /* 2 transfers must have completed successfully */
533 } else if (ret
== 2) {
534 memcpy(data
, buffer
, data_len
);
544 static int acpi_gsb_i2c_write_bytes(struct i2c_client
*client
,
545 u8 cmd
, u8
*data
, u8 data_len
)
548 struct i2c_msg msgs
[1];
552 buffer
= kzalloc(data_len
+ 1, GFP_KERNEL
);
557 memcpy(buffer
+ 1, data
, data_len
);
559 msgs
[0].addr
= client
->addr
;
560 msgs
[0].flags
= client
->flags
;
561 msgs
[0].len
= data_len
+ 1;
562 msgs
[0].buf
= buffer
;
564 ret
= i2c_transfer(client
->adapter
, msgs
, ARRAY_SIZE(msgs
));
569 dev_err(&client
->adapter
->dev
, "i2c write failed: %d\n", ret
);
573 /* 1 transfer must have completed successfully */
574 return (ret
== 1) ? 0 : -EIO
;
578 i2c_acpi_space_handler(u32 function
, acpi_physical_address command
,
579 u32 bits
, u64
*value64
,
580 void *handler_context
, void *region_context
)
582 struct gsb_buffer
*gsb
= (struct gsb_buffer
*)value64
;
583 struct i2c_acpi_handler_data
*data
= handler_context
;
584 struct acpi_connection_info
*info
= &data
->info
;
585 struct acpi_resource_i2c_serialbus
*sb
;
586 struct i2c_adapter
*adapter
= data
->adapter
;
587 struct i2c_client
*client
;
588 struct acpi_resource
*ares
;
589 u32 accessor_type
= function
>> 16;
590 u8 action
= function
& ACPI_IO_MASK
;
594 ret
= acpi_buffer_to_resource(info
->connection
, info
->length
, &ares
);
595 if (ACPI_FAILURE(ret
))
598 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
604 if (!value64
|| !i2c_acpi_get_i2c_resource(ares
, &sb
)) {
605 ret
= AE_BAD_PARAMETER
;
609 client
->adapter
= adapter
;
610 client
->addr
= sb
->slave_address
;
612 if (sb
->access_mode
== ACPI_I2C_10BIT_MODE
)
613 client
->flags
|= I2C_CLIENT_TEN
;
615 switch (accessor_type
) {
616 case ACPI_GSB_ACCESS_ATTRIB_SEND_RCV
:
617 if (action
== ACPI_READ
) {
618 status
= i2c_smbus_read_byte(client
);
624 status
= i2c_smbus_write_byte(client
, gsb
->bdata
);
628 case ACPI_GSB_ACCESS_ATTRIB_BYTE
:
629 if (action
== ACPI_READ
) {
630 status
= i2c_smbus_read_byte_data(client
, command
);
636 status
= i2c_smbus_write_byte_data(client
, command
,
641 case ACPI_GSB_ACCESS_ATTRIB_WORD
:
642 if (action
== ACPI_READ
) {
643 status
= i2c_smbus_read_word_data(client
, command
);
649 status
= i2c_smbus_write_word_data(client
, command
,
654 case ACPI_GSB_ACCESS_ATTRIB_BLOCK
:
655 if (action
== ACPI_READ
) {
656 status
= i2c_smbus_read_block_data(client
, command
,
663 status
= i2c_smbus_write_block_data(client
, command
,
664 gsb
->len
, gsb
->data
);
668 case ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE
:
669 if (action
== ACPI_READ
) {
670 status
= acpi_gsb_i2c_read_bytes(client
, command
,
671 gsb
->data
, info
->access_length
);
673 status
= acpi_gsb_i2c_write_bytes(client
, command
,
674 gsb
->data
, info
->access_length
);
679 dev_warn(&adapter
->dev
, "protocol 0x%02x not supported for client 0x%02x\n",
680 accessor_type
, client
->addr
);
681 ret
= AE_BAD_PARAMETER
;
685 gsb
->status
= status
;
694 int i2c_acpi_install_space_handler(struct i2c_adapter
*adapter
)
697 struct i2c_acpi_handler_data
*data
;
700 if (!adapter
->dev
.parent
)
703 handle
= ACPI_HANDLE(adapter
->dev
.parent
);
708 data
= kzalloc(sizeof(struct i2c_acpi_handler_data
),
713 data
->adapter
= adapter
;
714 status
= acpi_bus_attach_private_data(handle
, (void *)data
);
715 if (ACPI_FAILURE(status
)) {
720 status
= acpi_install_address_space_handler(handle
,
721 ACPI_ADR_SPACE_GSBUS
,
722 &i2c_acpi_space_handler
,
725 if (ACPI_FAILURE(status
)) {
726 dev_err(&adapter
->dev
, "Error installing i2c space handler\n");
727 acpi_bus_detach_private_data(handle
);
732 acpi_walk_dep_device_list(handle
);
736 void i2c_acpi_remove_space_handler(struct i2c_adapter
*adapter
)
739 struct i2c_acpi_handler_data
*data
;
742 if (!adapter
->dev
.parent
)
745 handle
= ACPI_HANDLE(adapter
->dev
.parent
);
750 acpi_remove_address_space_handler(handle
,
751 ACPI_ADR_SPACE_GSBUS
,
752 &i2c_acpi_space_handler
);
754 status
= acpi_bus_get_private_data(handle
, (void **)&data
);
755 if (ACPI_SUCCESS(status
))
758 acpi_bus_detach_private_data(handle
);
760 #endif /* CONFIG_ACPI_I2C_OPREGION */