Skip to contentSkip to conversation

I2C IRQ Probe Improvements

PATCH Superseded Charles Keepax 3 participants 13 messages Jun 21, 2019 – Jun 26, 2019

Subsystems (4)

v6 of 8 Superseded Latest is v8 →

lore
Share & tools
lore
#0 lore raw

v6 cover I2C IRQ Probe Improvements

This series attempts to align as much IRQ handling into the probe path as possible. Note that I don't have a great setup for testing these patches so they are mostly just build tested and need careful review and testing before any of them are merged.

The series brings the ACPI path inline with the way the device tree path handles the IRQ entirely at probe time. However, it still leaves any IRQ specified through the board_info as being handled at device time. In that case we need to cache something from the board_info until probe time, which leaves any alternative solution with something basically the same as the current handling although perhaps caching more stuff.

Thanks,
Charles

See previous discussions:
- https://lkml.org/lkml/2019/2/15/989
- https://www.spinics.net/lists/linux-i2c/msg39541.html

Charles Keepax (7):
i2c: core: Allow whole core to use i2c_dev_irq_from_resources
i2c: acpi: Use available IRQ helper functions
i2c: acpi: Factor out getting the IRQ from ACPI
i2c: core: Make i2c_acpi_get_irq available to the rest of the I2C core
i2c: core: Move ACPI IRQ handling to probe time
i2c: core: Move ACPI gpio IRQ handling into i2c_acpi_get_irq
i2c: core: Tidy up handling of init_irq

 drivers/i2c/i2c-core-acpi.c | 59 ++++++++++++++++++++++++++++++++-------------
 drivers/i2c/i2c-core-base.c | 11 +++++----
 drivers/i2c/i2c-core.h      |  9 +++++++
 3 files changed, 57 insertions(+), 22 deletions(-)
Signature · 1 line
2.11.0
#1 lore raw

PATCH v6 1/7 i2c: core: Allow whole core to use i2c_dev_irq_from_resources

Remove the static from i2c_dev_irq_from _resources so that other parts of the core code can use this helper function.

---

No changes since v5.

Thanks,
Charles

 drivers/i2c/i2c-core-base.c | 4 ++--
 drivers/i2c/i2c-core.h      | 2 ++
 2 files changed, 4 insertions(+), 2 deletions(-)
drivers/i2c/i2c-core-base.c +2 -2
index 2569e97f9bf35..8a303246d534b 100644
@@ -679,8 +679,8 @@ static void i2c_dev_set_name(struct i2c_adapter *adap,
 		     i2c_encode_flags_to_addr(client));
 }
 
-static int i2c_dev_irq_from_resources(const struct resource *resources,
-				      unsigned int num_resources)
+int i2c_dev_irq_from_resources(const struct resource *resources,
+			       unsigned int num_resources)
 {
 	struct irq_data *irqd;
 	int i;
drivers/i2c/i2c-core.h +2 -0
index 851c11b4c0f3a..2a3b28bf826b1 100644
@@ -19,6 +19,8 @@ extern struct list_head	__i2c_board_list;
 extern int		__i2c_first_dynamic_bus_num;
 
 int i2c_check_7bit_addr_validity_strict(unsigned short addr);
+int i2c_dev_irq_from_resources(const struct resource *resources,
+			       unsigned int num_resources);
 
 /*
  * We only allow atomic transfers for very late communication, e.g. to send
Signature · 1 line
2.11.0
#2 lore raw

PATCH v6 2/7 i2c: acpi: Use available IRQ helper functions

In reply to Charles Keepax

Use the available IRQ helper functions, most of the functions have additional helpful side affects like configuring the trigger type of the IRQ.

---

Changes since v5:
- Pass info->irq to i2c_acpi_add_resource directly
- Remove call to acpi_dev_free_resource_list since we never add anything to the list.

Thanks,
Charles

 drivers/i2c/i2c-core-acpi.c | 25 ++++++++++++++-----------
 1 file changed, 14 insertions(+), 11 deletions(-)
drivers/i2c/i2c-core-acpi.c +14 -11
index f1d648962b223..3951e352317ff 100644
@@ -133,13 +133,24 @@ static int i2c_acpi_do_lookup(struct acpi_device *adev,
 	return 0;
 }
 
+static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data)
+{
+	int *irq = data;
+	struct resource r;
+
+	if (*irq <= 0 && acpi_dev_resource_interrupt(ares, 0, &r))
+		*irq = i2c_dev_irq_from_resources(&r, 1);
+
+	/* No need to add resource to the list, free list if this changes */
+	return 1;
+}
+
 static int i2c_acpi_get_info(struct acpi_device *adev,
 			     struct i2c_board_info *info,
 			     struct i2c_adapter *adapter,
 			     acpi_handle *adapter_handle)
 {
 	struct list_head resource_list;
-	struct resource_entry *entry;
 	struct i2c_acpi_lookup lookup;
 	int ret;
 
@@ -172,19 +183,11 @@ static int i2c_acpi_get_info(struct acpi_device *adev,
 
 	/* Then fill IRQ number if any */
 	INIT_LIST_HEAD(&resource_list);
-	ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
+	ret = acpi_dev_get_resources(adev, &resource_list,
+				     i2c_acpi_add_resource, &info->irq);
 	if (ret < 0)
 		return -EINVAL;
 
-	resource_list_for_each_entry(entry, &resource_list) {
-		if (resource_type(entry->res) == IORESOURCE_IRQ) {
-			info->irq = entry->res->start;
-			break;
-		}
-	}
-
-	acpi_dev_free_resource_list(&resource_list);
-
 	acpi_set_modalias(adev, dev_name(&adev->dev), info->type,
 			  sizeof(info->type));
 
Signature · 1 line
2.11.0
#3 lore raw

PATCH v6 3/7 i2c: acpi: Factor out getting the IRQ from ACPI

In reply to Charles Keepax

In preparation for future refactoring factor out the fetch of the IRQ into its own helper function. Whilst we are at it update the handling to return the actual error code returned from acpi_dev_get_resources as well.

---

Changes since v5:
- Return error code from acpi_dev_get_resources
- Bail out if i2c_acpi_get_irq fails

Thanks,
Charles

 drivers/i2c/i2c-core-acpi.c | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)
drivers/i2c/i2c-core-acpi.c +21 -6
index 3951e352317ff..c91492eaacd93 100644
@@ -145,12 +145,29 @@ static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data)
 	return 1;
 }
 
+static int i2c_acpi_get_irq(struct acpi_device *adev)
+{
+	struct list_head resource_list;
+	int irq = -ENOENT;
+	int ret;
+
+	INIT_LIST_HEAD(&resource_list);
+
+	ret = acpi_dev_get_resources(adev, &resource_list,
+				     i2c_acpi_add_resource, &irq);
+	if (ret < 0)
+		return ret;
+
+	acpi_dev_free_resource_list(&resource_list);
+
+	return irq;
+}
+
 static int i2c_acpi_get_info(struct acpi_device *adev,
 			     struct i2c_board_info *info,
 			     struct i2c_adapter *adapter,
 			     acpi_handle *adapter_handle)
 {
-	struct list_head resource_list;
 	struct i2c_acpi_lookup lookup;
 	int ret;
 
@@ -182,11 +199,9 @@ static int i2c_acpi_get_info(struct acpi_device *adev,
 		*adapter_handle = lookup.adapter_handle;
 
 	/* Then fill IRQ number if any */
-	INIT_LIST_HEAD(&resource_list);
-	ret = acpi_dev_get_resources(adev, &resource_list,
-				     i2c_acpi_add_resource, &info->irq);
-	if (ret < 0)
-		return -EINVAL;
+	info->irq = i2c_acpi_get_irq(adev);
+	if (info->irq < 0)
+		return info->irq;
 
 	acpi_set_modalias(adev, dev_name(&adev->dev), info->type,
 			  sizeof(info->type));
Signature · 1 line
2.11.0
#4 lore raw

PATCH v6 4/7 i2c: core: Make i2c_acpi_get_irq available to the rest of the I2C core

In reply to Charles Keepax

In preparation for more refactoring make i2c_acpi_get_irq available outside i2c-core-acpi.c.

---

Changes since v5:
- Pass a struct device rather than acpi_device to i2c_acpi_get_irq, note this is more awkward than I would have liked as I am very unconvinced that adev->dev can actually be passed to ACPI_COMPANION. If anyone can answer that for sure that would be very helpful.

Thanks,
Charles

 drivers/i2c/i2c-core-acpi.c | 13 +++++++++++--
 drivers/i2c/i2c-core.h      |  7 +++++++
 2 files changed, 18 insertions(+), 2 deletions(-)
drivers/i2c/i2c-core-acpi.c +11 -2
index c91492eaacd93..37bf80b35365f 100644
@@ -145,8 +145,17 @@ static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data)
 	return 1;
 }
 
-static int i2c_acpi_get_irq(struct acpi_device *adev)
+/**
+ * i2c_acpi_get_irq - get device IRQ number from ACPI
+ * @client: Pointer to the I2C client device
+ *
+ * Find the IRQ number used by a specific client device.
+ *
+ * Return: The IRQ number or an error code.
+ */
+int i2c_acpi_get_irq(struct device *dev)
 {
+	struct acpi_device *adev = container_of(dev, struct acpi_device, dev);
 	struct list_head resource_list;
 	int irq = -ENOENT;
 	int ret;
@@ -199,7 +208,7 @@ static int i2c_acpi_get_info(struct acpi_device *adev,
 		*adapter_handle = lookup.adapter_handle;
 
 	/* Then fill IRQ number if any */
-	info->irq = i2c_acpi_get_irq(adev);
+	info->irq = i2c_acpi_get_irq(&adev->dev);
 	if (info->irq < 0)
 		return info->irq;
 
drivers/i2c/i2c-core.h +7 -0
index 2a3b28bf826b1..1735ac17a957a 100644
@@ -63,6 +63,8 @@ const struct acpi_device_id *
 i2c_acpi_match_device(const struct acpi_device_id *matches,
 		      struct i2c_client *client);
 void i2c_acpi_register_devices(struct i2c_adapter *adap);
+
+int i2c_acpi_get_irq(struct device *dev);
 #else /* CONFIG_ACPI */
 static inline void i2c_acpi_register_devices(struct i2c_adapter *adap) { }
 static inline const struct acpi_device_id *
@@ -71,6 +73,11 @@ i2c_acpi_match_device(const struct acpi_device_id *matches,
 {
 	return NULL;
 }
+
+static inline int i2c_acpi_get_irq(struct device *dev)
+{
+	return 0;
+}
 #endif /* CONFIG_ACPI */
 extern struct notifier_block i2c_acpi_notifier;
 
Signature · 1 line
2.11.0
#5 lore raw

Re: [PATCH v6 4/7] i2c: core: Make i2c_acpi_get_irq available to the rest of the I2C core

Quoted 4 lines · Charles Keepax

In preparation for more refactoring make i2c_acpi_get_irq available outside i2c-core-acpi.c.

Quoted 8 lines

---

Changes since v5:
- Pass a struct device rather than acpi_device to i2c_acpi_get_irq, note this is more awkward than I would have liked as I am very unconvinced that adev->dev can actually be passed to ACPI_COMPANION. If anyone can answer that for sure that would be very helpful.

Sounds you are right. I stand corrected.
We can not use ACPI_COMPANION() against &adev->dev.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#6 lore raw

Re: [PATCH v6 4/7] i2c: core: Make i2c_acpi_get_irq available to the rest of the I2C core

In reply to Charles Keepax
Quoted 4 lines · Charles Keepax

In preparation for more refactoring make i2c_acpi_get_irq available outside i2c-core-acpi.c.

Quoted 8 lines

---

Changes since v5:
- Pass a struct device rather than acpi_device to i2c_acpi_get_irq, note this is more awkward than I would have liked as I am very unconvinced that adev->dev can actually be passed to ACPI_COMPANION. If anyone can answer that for sure that would be very helpful.

I don't think you can do that.

I probably missed some previous discussion but what's wrong passing struct i2c_client instead and use ACPI_COMPANION() for that?

Quoted 13 lines

Thanks,
Charles

 drivers/i2c/i2c-core-acpi.c | 13 +++++++++++--
 drivers/i2c/i2c-core.h      |  7 +++++++
 2 files changed, 18 insertions(+), 2 deletions(-)
drivers/i2c/i2c-core-acpi.c +0 -0
index c91492eaacd93..37bf80b35365f 100644

drivers/i2c/i2c-core-acpi.c static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data) · line 150

Quoted 7 lines
drivers/i2c/i2c-core-acpi.c +3 -1
@@ -145,8 +145,17 @@ static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data)
 	return 1;
 }
 
-static int i2c_acpi_get_irq(struct acpi_device *adev)
+/**
+ * i2c_acpi_get_irq - get device IRQ number from ACPI
+ * @client: Pointer to the I2C client device

I think this should be @dev now.

Quoted 47 lines
drivers/i2c/i2c-core-acpi.c +8 -1
+ *
+ * Find the IRQ number used by a specific client device.
+ *
+ * Return: The IRQ number or an error code.
+ */
+int i2c_acpi_get_irq(struct device *dev)
 {
+	struct acpi_device *adev = container_of(dev, struct acpi_device, dev);
 	struct list_head resource_list;
 	int irq = -ENOENT;
 	int ret;
@@ -199,7 +208,7 @@ static int i2c_acpi_get_info(struct acpi_device *adev,
 		*adapter_handle = lookup.adapter_handle;
 
 	/* Then fill IRQ number if any */
-	info->irq = i2c_acpi_get_irq(adev);
+	info->irq = i2c_acpi_get_irq(&adev->dev);
 	if (info->irq < 0)
 		return info->irq;
 
drivers/i2c/i2c-core.h +7 -0
index 2a3b28bf826b1..1735ac17a957a 100644
@@ -63,6 +63,8 @@ const struct acpi_device_id *
 i2c_acpi_match_device(const struct acpi_device_id *matches,
 		      struct i2c_client *client);
 void i2c_acpi_register_devices(struct i2c_adapter *adap);
+
+int i2c_acpi_get_irq(struct device *dev);
 #else /* CONFIG_ACPI */
 static inline void i2c_acpi_register_devices(struct i2c_adapter *adap) { }
 static inline const struct acpi_device_id *
@@ -71,6 +73,11 @@ i2c_acpi_match_device(const struct acpi_device_id *matches,
 {
 	return NULL;
 }
+
+static inline int i2c_acpi_get_irq(struct device *dev)
+{
+	return 0;
+}
 #endif /* CONFIG_ACPI */
 extern struct notifier_block i2c_acpi_notifier;
 
Signature · 1 line
2.11.0
#7 lore raw

Re: [PATCH v6 4/7] i2c: core: Make i2c_acpi_get_irq available to the rest of the I2C core

Quoted 7 lines · Mika Westerberg
Quoted 6 lines · Charles Keepax

In preparation for more refactoring make i2c_acpi_get_irq available outside i2c-core-acpi.c.

---

Quoted 9 lines
Quoted 6 lines

Changes since v5:
- Pass a struct device rather than acpi_device to i2c_acpi_get_irq, note this is more awkward than I would have liked as I am very unconvinced that adev->dev can actually be passed to ACPI_COMPANION. If anyone can answer that for sure that would be very helpful.

I don't think you can do that.

Yeah I think we are pretty sure that is not possible, although not what is done in the patch, was just responding to on an earlier comment.

Quoted 3 lines

I probably missed some previous discussion but what's wrong passing struct i2c_client instead and use ACPI_COMPANION() for that?

Really this is all about the splitting out the original patch into two patches, one to export the function and one to move its use to probe time. There isn't really any nice way to do it as two patches and still pass the i2c_client struct. Hence we ended up on this system with struct device.

I would be happy to squash the two patches, and go back to the i2c_client approach, if that was preferred and as long as Andy doesn't mind.

Quoted 16 lines
Quoted 16 lines

Thanks,
Charles

 drivers/i2c/i2c-core-acpi.c | 13 +++++++++++--
 drivers/i2c/i2c-core.h      |  7 +++++++
 2 files changed, 18 insertions(+), 2 deletions(-)
drivers/i2c/i2c-core-acpi.c +0 -0
index c91492eaacd93..37bf80b35365f 100644
@@ -145,8 +145,17 @@ static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data)
 	return 1;
 }
 
Quoted 7 lines

drivers/i2c/i2c-core-acpi.c static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data) · line 150

Quoted 4 lines
drivers/i2c/i2c-core-acpi.c +3 -1
-static int i2c_acpi_get_irq(struct acpi_device *adev)
+/**
+ * i2c_acpi_get_irq - get device IRQ number from ACPI
+ * @client: Pointer to the I2C client device

I think this should be @dev now.

Yes it should, sorry will fix that.

Thanks,
Charles

#8 lore raw

Re: [PATCH v6 4/7] i2c: core: Make i2c_acpi_get_irq available to the rest of the I2C core

Quoted 5 lines · Charles Keepax

On Tue, Jun 25, 2019 at 02:50:11PM +0300, Mika Westerberg wrote:

I would be happy to squash the two patches, and go back to the i2c_client approach, if that was preferred and as long as Andy doesn't mind.

I don't.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#9 lore raw

Re: [PATCH v6 4/7] i2c: core: Make i2c_acpi_get_irq available to the rest of the I2C core

Quoted 9 lines · Andy Shevchenko
Quoted 5 lines · Charles Keepax

On Tue, Jun 25, 2019 at 02:50:11PM +0300, Mika Westerberg wrote:

I would be happy to squash the two patches, and go back to the i2c_client approach, if that was preferred and as long as Andy doesn't mind.

I don't.

Groovy alright think I will squash these two patches and return to the i2c_client interface.

Thanks,
Charles

#10 lore raw

PATCH v6 5/7 i2c: core: Move ACPI IRQ handling to probe time

In reply to Charles Keepax

Bring the ACPI path in sync with the device tree path and handle all the IRQ fetching at probe time. This leaves the only IRQ handling at device registration time being that which is passed directly through the board info as either a resource or an actual IRQ number.

---

Changes since v5:
- Pass a struct device rather than acpi_device to i2c_acpi_get_irq.

Thanks,
Charles

 drivers/i2c/i2c-core-acpi.c | 7 +------
 drivers/i2c/i2c-core-base.c | 5 ++++-
 2 files changed, 5 insertions(+), 7 deletions(-)
drivers/i2c/i2c-core-acpi.c +1 -6
index 37bf80b35365f..aaca1e216be66 100644
@@ -155,7 +155,7 @@ static int i2c_acpi_add_resource(struct acpi_resource *ares, void *data)
  */
 int i2c_acpi_get_irq(struct device *dev)
 {
-	struct acpi_device *adev = container_of(dev, struct acpi_device, dev);
+	struct acpi_device *adev = ACPI_COMPANION(dev);
 	struct list_head resource_list;
 	int irq = -ENOENT;
 	int ret;
@@ -207,11 +207,6 @@ static int i2c_acpi_get_info(struct acpi_device *adev,
 	if (adapter_handle)
 		*adapter_handle = lookup.adapter_handle;
 
-	/* Then fill IRQ number if any */
-	info->irq = i2c_acpi_get_irq(&adev->dev);
-	if (info->irq < 0)
-		return info->irq;
-
 	acpi_set_modalias(adev, dev_name(&adev->dev), info->type,
 			  sizeof(info->type));
 
drivers/i2c/i2c-core-base.c +4 -1
index 8a303246d534b..34de732598533 100644
@@ -327,7 +327,10 @@ static int i2c_device_probe(struct device *dev)
 			if (irq == -EINVAL || irq == -ENODATA)
 				irq = of_irq_get(dev->of_node, 0);
 		} else if (ACPI_COMPANION(dev)) {
-			irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
+			irq = i2c_acpi_get_irq(dev);
+
+			if (irq == -ENOENT)
+				irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
 		}
 		if (irq == -EPROBE_DEFER)
 			return irq;
Signature · 1 line
2.11.0
#11 lore raw

PATCH v6 6/7 i2c: core: Move ACPI gpio IRQ handling into i2c_acpi_get_irq

In reply to Charles Keepax

It makes sense to contain all the ACPI IRQ handling in a single helper function.

---
 drivers/i2c/i2c-core-acpi.c | 3 +++
 drivers/i2c/i2c-core-base.c | 3 ---
 2 files changed, 3 insertions(+), 3 deletions(-)
drivers/i2c/i2c-core-acpi.c +3 -0
index aaca1e216be66..042c1cb148bc6 100644
@@ -169,6 +169,9 @@ int i2c_acpi_get_irq(struct device *dev)
 
 	acpi_dev_free_resource_list(&resource_list);
 
+	if (irq == -ENOENT)
+		irq = acpi_dev_gpio_irq_get(adev, 0);
+
 	return irq;
 }
 
drivers/i2c/i2c-core-base.c +0 -3
index 34de732598533..87a2ad8f41a76 100644
@@ -328,9 +328,6 @@ static int i2c_device_probe(struct device *dev)
 				irq = of_irq_get(dev->of_node, 0);
 		} else if (ACPI_COMPANION(dev)) {
 			irq = i2c_acpi_get_irq(dev);
-
-			if (irq == -ENOENT)
-				irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
 		}
 		if (irq == -EPROBE_DEFER)
 			return irq;
Signature · 1 line
2.11.0
#12 lore raw

PATCH v6 7/7 i2c: core: Tidy up handling of init_irq

In reply to Charles Keepax

Only set init_irq during i2c_device_new and only handle client->irq on the probe/remove paths.

---

No changes since v5.

Thanks,
Charles

 drivers/i2c/i2c-core-base.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/i2c/i2c-core-base.c +3 -2
index 87a2ad8f41a76..b3cc581f6465b 100644
@@ -314,6 +314,8 @@ static int i2c_device_probe(struct device *dev)
 
 	driver = to_i2c_driver(dev->driver);
 
+	client->irq = client->init_irq;
+
 	if (!client->irq && !driver->disable_i2c_core_irq_mapping) {
 		int irq = -ENOENT;
 
@@ -424,7 +426,7 @@ static int i2c_device_remove(struct device *dev)
 	dev_pm_clear_wake_irq(&client->dev);
 	device_init_wakeup(&client->dev, false);
 
-	client->irq = client->init_irq;
+	client->irq = 0;
 	if (client->flags & I2C_CLIENT_HOST_NOTIFY)
 		pm_runtime_put(&client->adapter->dev);
 
@@ -741,7 +743,6 @@ i2c_new_client_device(struct i2c_adapter *adap, struct i2c_board_info const *inf
 	if (!client->init_irq)
 		client->init_irq = i2c_dev_irq_from_resources(info->resources,
 							 info->num_resources);
-	client->irq = client->init_irq;
 
 	strlcpy(client->name, info->type, sizeof(client->name));
 
Signature · 1 line
2.11.0