Skip to contentSkip to conversation

platform/x86: int3472: Call "reset" GPIO "enable" for INT347E

PATCH In review Sakari Ailus 4 participants 9 messages Jan 22, 2025 – Jan 23, 2025

Subsystems (3)
lore
Share & tools
lore

Sakari Ailus

author maintainer
#0 lore raw

PATCH v3 1/1 platform/x86: int3472: Call "reset" GPIO "enable" for INT347E

The DT bindings for ov7251 specify "enable" GPIO (xshutdown in documentation) but the int3472 indiscriminately provides this as a "reset" GPIO to sensor drivers. Take this into account by assigning it as "enable" with active high polarity for INT347E devices, i.e. ov7251. "reset" with active low polarity remains the default GPIO name for other devices.

---
since v2:

- Implement a more generic GPIO mangling capability, as suggested by Hans de Goede.

- Include linux/array_size.h for ARRAY_SIZE().

 drivers/platform/x86/intel/int3472/discrete.c | 43 +++++++++++++++++--
 1 file changed, 40 insertions(+), 3 deletions(-)
drivers/platform/x86/intel/int3472/discrete.c +40 -3
index d881b2cfcdfc..181675e57c39 100644
@@ -2,6 +2,7 @@
 /* Author: Dan Scally <[email protected]> */
 
 #include <linux/acpi.h>
+#include <linux/array_size.h>
 #include <linux/bitfield.h>
 #include <linux/device.h>
 #include <linux/gpio/consumer.h>
@@ -122,9 +123,44 @@ skl_int3472_gpiod_get_from_temp_lookup(struct int3472_discrete_device *int3472,
 	return desc;
 }
 
-static void int3472_get_func_and_polarity(u8 type, const char **func, u32 *polarity)
+/**
+ * struct int3472_gpio_map - Map GPIOs to whatever is expected by the
+ * sensor driver (as in DT bindings)
+ * @hid: The ACPI HID of the device without the instance number e.g. i2c-INT347E
+ * @type_from: The GPIO type from ACPI ?SDT
+ * @type_to: The assigned GPIO type, typically same as type_from
+ * @func: The function, e.g. "enable"
+ * @polarity: GPIO_ACTIVE_{HIGH,LOW}
+ */
+struct int3472_gpio_map {
+	const char *hid;
+	u8 type_from;
+	u8 type_to;
+	const char *func;
+	unsigned int polarity;
+};
+
+static const struct int3472_gpio_map int3472_gpio_map[] = {
+	{ "INT347E", INT3472_GPIO_TYPE_RESET, INT3472_GPIO_TYPE_RESET, "enable", GPIO_ACTIVE_HIGH },
+};
+
+static void int3472_get_func_and_polarity(struct acpi_device *adev, u8 *type,
+					  const char **func, u32 *polarity)
 {
-	switch (type) {
+	unsigned int i;
+
+	for (i = 0; i < ARRAY_SIZE(int3472_gpio_map); i++) {
+		if (*type != int3472_gpio_map[i].type_from ||
+		    !acpi_dev_hid_uid_match(adev, int3472_gpio_map[i].hid, NULL))
+			continue;
+
+		*type = int3472_gpio_map[i].type_to;
+		*func = int3472_gpio_map[i].func;
+		*polarity = int3472_gpio_map[i].polarity;
+		return;
+	}
+
+	switch (*type) {
 	case INT3472_GPIO_TYPE_RESET:
 		*func = "reset";
 		*polarity = GPIO_ACTIVE_LOW;
@@ -217,7 +253,8 @@ static int skl_int3472_handle_gpio_resources(struct acpi_resource *ares,
 
 	type = FIELD_GET(INT3472_GPIO_DSM_TYPE, obj->integer.value);
 
-	int3472_get_func_and_polarity(type, &func, &polarity);
+	int3472_get_func_and_polarity(int3472->sensor, &type, &func,
+				      &polarity);
 
 	pin = FIELD_GET(INT3472_GPIO_DSM_PIN, obj->integer.value);
 	if (pin != agpio->pin_table[0])
Signature · 1 line
2.39.5
Reviewed-by on v3 1/1
#1 lore raw

Hi Sakari,

Quoted 6 lines · Sakari Ailus

The DT bindings for ov7251 specify "enable" GPIO (xshutdown in documentation) but the int3472 indiscriminately provides this as a "reset" GPIO to sensor drivers. Take this into account by assigning it as "enable" with active high polarity for INT347E devices, i.e. ov7251. "reset" with active low polarity remains the default GPIO name for other devices.

Quoted 8 lines

---
since v2:

- Implement a more generic GPIO mangling capability, as suggested by Hans de Goede.

- Include linux/array_size.h for ARRAY_SIZE().

Thank you for the new version.

This looks good to me now:

Regards,

Hans

Quoted 73 lines
 drivers/platform/x86/intel/int3472/discrete.c | 43 +++++++++++++++++--
 1 file changed, 40 insertions(+), 3 deletions(-)
drivers/platform/x86/intel/int3472/discrete.c +40 -3
index d881b2cfcdfc..181675e57c39 100644
@@ -2,6 +2,7 @@
 /* Author: Dan Scally <[email protected]> */
 
 #include <linux/acpi.h>
+#include <linux/array_size.h>
 #include <linux/bitfield.h>
 #include <linux/device.h>
 #include <linux/gpio/consumer.h>
@@ -122,9 +123,44 @@ skl_int3472_gpiod_get_from_temp_lookup(struct int3472_discrete_device *int3472,
 	return desc;
 }
 
-static void int3472_get_func_and_polarity(u8 type, const char **func, u32 *polarity)
+/**
+ * struct int3472_gpio_map - Map GPIOs to whatever is expected by the
+ * sensor driver (as in DT bindings)
+ * @hid: The ACPI HID of the device without the instance number e.g. i2c-INT347E
+ * @type_from: The GPIO type from ACPI ?SDT
+ * @type_to: The assigned GPIO type, typically same as type_from
+ * @func: The function, e.g. "enable"
+ * @polarity: GPIO_ACTIVE_{HIGH,LOW}
+ */
+struct int3472_gpio_map {
+	const char *hid;
+	u8 type_from;
+	u8 type_to;
+	const char *func;
+	unsigned int polarity;
+};
+
+static const struct int3472_gpio_map int3472_gpio_map[] = {
+	{ "INT347E", INT3472_GPIO_TYPE_RESET, INT3472_GPIO_TYPE_RESET, "enable", GPIO_ACTIVE_HIGH },
+};
+
+static void int3472_get_func_and_polarity(struct acpi_device *adev, u8 *type,
+					  const char **func, u32 *polarity)
 {
-	switch (type) {
+	unsigned int i;
+
+	for (i = 0; i < ARRAY_SIZE(int3472_gpio_map); i++) {
+		if (*type != int3472_gpio_map[i].type_from ||
+		    !acpi_dev_hid_uid_match(adev, int3472_gpio_map[i].hid, NULL))
+			continue;
+
+		*type = int3472_gpio_map[i].type_to;
+		*func = int3472_gpio_map[i].func;
+		*polarity = int3472_gpio_map[i].polarity;
+		return;
+	}
+
+	switch (*type) {
 	case INT3472_GPIO_TYPE_RESET:
 		*func = "reset";
 		*polarity = GPIO_ACTIVE_LOW;
@@ -217,7 +253,8 @@ static int skl_int3472_handle_gpio_resources(struct acpi_resource *ares,
 
 	type = FIELD_GET(INT3472_GPIO_DSM_TYPE, obj->integer.value);
 
-	int3472_get_func_and_polarity(type, &func, &polarity);
+	int3472_get_func_and_polarity(int3472->sensor, &type, &func,
+				      &polarity);
 
 	pin = FIELD_GET(INT3472_GPIO_DSM_PIN, obj->integer.value);
 	if (pin != agpio->pin_table[0])
#2 lore raw
In reply to Sakari Ailus
Quoted 5 lines · Sakari Ailus

The DT bindings for ov7251 specify "enable" GPIO (xshutdown in documentation) but the int3472 indiscriminately provides this as a "reset" GPIO to sensor drivers. Take this into account by assigning it as "enable" with active high polarity for INT347E devices, i.e. ov7251. "reset" with active low polarity remains the default GPIO name for other devices.

...

Quoted 4 lines

+/**
+ * struct int3472_gpio_map - Map GPIOs to whatever is expected by the
+ * sensor driver (as in DT bindings)
+ * @hid: The ACPI HID of the device without the instance number e.g. i2c-INT347E

W/o "i2c-" part.

Quoted 2 lines

+ * @type_from: The GPIO type from ACPI ?SDT
+ * @type_to: The assigned GPIO type, typically same as type_from

@type_from

Quoted 1 line

+ * @func: The function, e.g. "enable"

Should we speak in terms of GPIOLIB, like connection ID ?

Quoted 1 line

+ * @polarity: GPIO_ACTIVE_{HIGH,LOW}

Please, avoid using patterns with the defined constants. It's better to have this written as

* @polarity: One of %GPIO_ACTIVE_HIGH, %GPIO_ACTIVE_LOW

drivers/platform/x86/intel/int3472/discrete.c skl_int3472_gpiod_get_from_temp_lookup(struct int3472_discrete_device *int3472, · line 140

Quoted 7 lines

+ */

drivers/platform/x86/intel/int3472/discrete.c +5 -0
+	const char *hid;
+	u8 type_from;
+	u8 type_to;
+	const char *func;
+	unsigned int polarity;

Hmm... In other cases we usually use

	bool active_low;

Can we do the same here?

Quoted 1 line

+};

...

drivers/platform/x86/intel/int3472/discrete.c static int skl_int3472_handle_gpio_resources(struct acpi_resource *ares, · line 257

Quoted 3 lines
drivers/platform/x86/intel/int3472/discrete.c +2 -1
-	int3472_get_func_and_polarity(type, &func, &polarity);
+	int3472_get_func_and_polarity(int3472->sensor, &type, &func,
+				      &polarity);

AFAIK, we don't have hard attachment to the 80-[character limit rule, please use more room on the previous line.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
author maintainer
#3 lore raw

Hi Andy,

Quoted 14 lines · Andy Shevchenko
Quoted 5 lines · Sakari Ailus

The DT bindings for ov7251 specify "enable" GPIO (xshutdown in documentation) but the int3472 indiscriminately provides this as a "reset" GPIO to sensor drivers. Take this into account by assigning it as "enable" with active high polarity for INT347E devices, i.e. ov7251. "reset" with active low polarity remains the default GPIO name for other devices.

...

Quoted 4 lines

+/**
+ * struct int3472_gpio_map - Map GPIOs to whatever is expected by the
+ * sensor driver (as in DT bindings)
+ * @hid: The ACPI HID of the device without the instance number e.g. i2c-INT347E

Quoted 6 lines

W/o "i2c-" part.

Quoted 2 lines

+ * @type_from: The GPIO type from ACPI ?SDT
+ * @type_to: The assigned GPIO type, typically same as type_from

@type_from

Agreed.

Quoted 4 lines
Quoted 2 lines

+ * @func: The function, e.g. "enable"

Should we speak in terms of GPIOLIB, like connection ID ?

That rename should be done in the entire driver probably then. I can post a patch if Hans agrees, after this one.

Quoted 7 lines
Quoted 2 lines

+ * @polarity: GPIO_ACTIVE_{HIGH,LOW}

Please, avoid using patterns with the defined constants. It's better to have this written as

* @polarity: One of %GPIO_ACTIVE_HIGH, %GPIO_ACTIVE_LOW

Sounds good.

Quoted 11 lines

drivers/platform/x86/intel/int3472/discrete.c skl_int3472_gpiod_get_from_temp_lookup(struct int3472_discrete_device *int3472, · line 140

Quoted 8 lines

+ */

drivers/platform/x86/intel/int3472/discrete.c +5 -0
+	const char *hid;
+	u8 type_from;
+	u8 type_to;
+	const char *func;
+	unsigned int polarity;

Hmm... In other cases we usually use

Quoted 3 lines
	bool active_low;

Can we do the same here?

This goes to the flags field of struct gpiod_lookup. Bool is a poor choice for that (but u32 isn't correct either). We can put polarity here but pass GPIO_ACTIVE_{HIGH,LOW} to GPIO_LOOKUP().

Putting polarity before function would same some bytes, too. Hans, any thoughts?

Quoted 11 lines
Quoted 2 lines

+};

...

drivers/platform/x86/intel/int3472/discrete.c static int skl_int3472_handle_gpio_resources(struct acpi_resource *ares, · line 257

Quoted 3 lines
drivers/platform/x86/intel/int3472/discrete.c +2 -1
-	int3472_get_func_and_polarity(type, &func, &polarity);
+	int3472_get_func_and_polarity(int3472->sensor, &type, &func,
+				      &polarity);

AFAIK, we don't have hard attachment to the 80-[character limit rule, please use more room on the previous line.

There's no reason for the line to be above 80 characters.

Signature · 3 lines
Regards,

Sakari Ailus
#4 lore raw

Hi Sakari,

Quoted 27 lines · Sakari Ailus

Hi Andy,

Quoted 14 lines · Andy Shevchenko
Quoted 5 lines · Sakari Ailus

The DT bindings for ov7251 specify "enable" GPIO (xshutdown in documentation) but the int3472 indiscriminately provides this as a "reset" GPIO to sensor drivers. Take this into account by assigning it as "enable" with active high polarity for INT347E devices, i.e. ov7251. "reset" with active low polarity remains the default GPIO name for other devices.

...

Quoted 4 lines

+/**
+ * struct int3472_gpio_map - Map GPIOs to whatever is expected by the
+ * sensor driver (as in DT bindings)
+ * @hid: The ACPI HID of the device without the instance number e.g. i2c-INT347E

Quoted 6 lines

W/o "i2c-" part.

Quoted 2 lines

+ * @type_from: The GPIO type from ACPI ?SDT
+ * @type_to: The assigned GPIO type, typically same as type_from

@type_from

Agreed.

Quoted 1 line
Quoted 6 lines
Quoted 3 lines
Quoted 1 line

+ * @func: The function, e.g. "enable"

Should we speak in terms of GPIOLIB, like connection ID ?

That rename should be done in the entire driver probably then. I can post a patch if Hans agrees, after this one.

Yes renaming func to con_id makes sense, but that should indeed be a separate change in a follow-up patch.

Regards,

Hans

maintainer
#5 lore raw
In reply to Sakari Ailus
Quoted 71 lines · Sakari Ailus

Hi Andy,

Quoted 14 lines · Andy Shevchenko
Quoted 5 lines · Sakari Ailus

The DT bindings for ov7251 specify "enable" GPIO (xshutdown in documentation) but the int3472 indiscriminately provides this as a "reset" GPIO to sensor drivers. Take this into account by assigning it as "enable" with active high polarity for INT347E devices, i.e. ov7251. "reset" with active low polarity remains the default GPIO name for other devices.

...

Quoted 4 lines

+/**
+ * struct int3472_gpio_map - Map GPIOs to whatever is expected by the
+ * sensor driver (as in DT bindings)
+ * @hid: The ACPI HID of the device without the instance number e.g. i2c-INT347E

Quoted 6 lines

W/o "i2c-" part.

Quoted 2 lines

+ * @type_from: The GPIO type from ACPI ?SDT
+ * @type_to: The assigned GPIO type, typically same as type_from

@type_from

Agreed.

Quoted 4 lines
Quoted 2 lines

+ * @func: The function, e.g. "enable"

Should we speak in terms of GPIOLIB, like connection ID ?

That rename should be done in the entire driver probably then. I can post a patch if Hans agrees, after this one.

Quoted 7 lines
Quoted 2 lines

+ * @polarity: GPIO_ACTIVE_{HIGH,LOW}

Please, avoid using patterns with the defined constants. It's better to have this written as

* @polarity: One of %GPIO_ACTIVE_HIGH, %GPIO_ACTIVE_LOW

Sounds good.

Quoted 11 lines

drivers/platform/x86/intel/int3472/discrete.c skl_int3472_gpiod_get_from_temp_lookup(struct int3472_discrete_device *int3472, · line 140

Quoted 8 lines

+ */

drivers/platform/x86/intel/int3472/discrete.c +5 -0
+	const char *hid;
+	u8 type_from;
+	u8 type_to;
+	const char *func;
+	unsigned int polarity;

Hmm... In other cases we usually use

Quoted 3 lines
	bool active_low;

Can we do the same here?

This goes to the flags field of struct gpiod_lookup. Bool is a poor choice for that (but u32 isn't correct either). We can put polarity here but pass GPIO_ACTIVE_{HIGH,LOW} to GPIO_LOOKUP().

Putting polarity before function would same some bytes, too. Hans, any thoughts?

Quoted 5 lines
Quoted 2 lines

+};

...

Quoted 8 lines
Quoted 6 lines

drivers/platform/x86/intel/int3472/discrete.c static int skl_int3472_handle_gpio_resources(struct acpi_resource *ares, · line 257

Quoted 3 lines
drivers/platform/x86/intel/int3472/discrete.c +2 -1
-	int3472_get_func_and_polarity(type, &func, &polarity);
+	int3472_get_func_and_polarity(int3472->sensor, &type, &func,
+				      &polarity);

AFAIK, we don't have hard attachment to the 80-[character limit rule, please use more room on the previous line.

There's no reason for the line to be above 80 characters.

Do you mean that on a single line it would not exceed 80 characters (or that you just did not count at all)? :-)

I'm like 'What?' ...I don't know why you guys are arguing about breaking the 80 chars limit. :-D

Signature · 1 line
 i.
#6 lore raw
Quoted 1 line · Ilpo Järvinen

On Thu, 23 Jan 2025, Sakari Ailus wrote:

...

Quoted 2 lines

I'm like 'What?' ...I don't know why you guys are arguing about breaking the 80 chars limit. :-D

Sakari is too pedantic about this, and I'm the opposite. It's our main disagreement on the kernel code during the reviews.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#7 lore raw
In reply to Sakari Ailus
Quoted 2 lines · Sakari Ailus
Quoted 1 line · Andy Shevchenko

On Wed, Jan 22, 2025 at 12:43:44PM +0200, Sakari Ailus wrote:

...

Quoted 6 lines
Quoted 3 lines
Quoted 1 line

+ * @func: The function, e.g. "enable"

Should we speak in terms of GPIOLIB, like connection ID ?

That rename should be done in the entire driver probably then. I can post a patch if Hans agrees, after this one.

Ah, this makes sense. I didn't pay attention that this is already in use in the driver.

...

Quoted 11 lines
Quoted 7 lines

drivers/platform/x86/intel/int3472/discrete.c skl_int3472_gpiod_get_from_temp_lookup(struct int3472_discrete_device *int3472, · line 140

Quoted 1 line
drivers/platform/x86/intel/int3472/discrete.c +1 -0
+	unsigned int polarity;

Hmm... In other cases we usually use

	bool active_low;

Can we do the same here?

This goes to the flags field of struct gpiod_lookup. Bool is a poor choice for that (but u32 isn't correct either). We can put polarity here but pass GPIO_ACTIVE_{HIGH,LOW} to GPIO_LOOKUP().

Maybe then name it as gpio_flags or so to match that structure member?

...

Quoted 2 lines

Putting polarity before function would same some bytes, too. Hans, any thoughts?

I'm fine with that. I would also save bytes in the cases when it doesn't affect code generation (and here seems the case). Also, if we talk about readability of the each quirk entry the current implementation calls for a macro to make it neater. In such a case, we save double type and may put macro's arguments in a better order than structure, which may be optimised for size.

...

Quoted 8 lines
Quoted 6 lines

drivers/platform/x86/intel/int3472/discrete.c static int skl_int3472_handle_gpio_resources(struct acpi_resource *ares, · line 257

Quoted 3 lines
drivers/platform/x86/intel/int3472/discrete.c +2 -1
-	int3472_get_func_and_polarity(type, &func, &polarity);
+	int3472_get_func_and_polarity(int3472->sensor, &type, &func,
+				      &polarity);

AFAIK, we don't have hard attachment to the 80-[character limit rule, please use more room on the previous line.

There's no reason for the line to be above 80 characters.

It's the opposite. There is no reason to make it two lines. It's not a v4l2 subsystem, we are not cargo-cult here, I believe. I.o.w. a common sense should be the first one to be considered.

Now, I even tried myself, and...

	int3472_get_func_and_polarity(int3472->sensor, &type, &func, &polarity);

...ha-ha, it's exactly 80 characters! What's wrong with your editor settings?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#8 lore raw
In reply to Sakari Ailus

Hi Sakari,

Quoted 4 lines · Sakari Ailus

Hi Andy,

Quoted 1 line · Andy Shevchenko

On Wed, Jan 22, 2025 at 12:43:44PM +0200, Sakari Ailus wrote:

....

Quoted 8 lines
Quoted 6 lines

drivers/platform/x86/intel/int3472/discrete.c static int skl_int3472_handle_gpio_resources(struct acpi_resource *ares, · line 257

Quoted 3 lines
drivers/platform/x86/intel/int3472/discrete.c +2 -1
-	int3472_get_func_and_polarity(type, &func, &polarity);
+	int3472_get_func_and_polarity(int3472->sensor, &type, &func,
+				      &polarity);

AFAIK, we don't have hard attachment to the 80-[character limit rule, please use more room on the previous line.

There's no reason for the line to be above 80 characters.

I known that under drivers/media the consensus is to try and stick to the 80 chars length limit. But under drivers/platform/x86 we have embraced the new 100 chars limit and we prefer to use the full 100 chars over unnecessarily splitting statements over 2 lines.

We are of the opinion that a single slightly longer line is easier to read then a statement split over 2 lines, so please change this to:

	int3472_get_func_and_polarity(int3472->sensor, &type, &func, &polarity);

Regards,

Hans