Skip to contentSkip to conversation

dt-bindings: touchscreen: silead gsl1680: Document all compatibles

PATCH New Hans de Goede 4 participants 7 messages Aug 17, 2016 – Aug 21, 2016

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 dt-bindings: touchscreen: silead gsl1680: Document all compatibles

The silead gsl1680 driver / binding supports a whole series of devices, list the compatibles for all of them in the binding.

---
Changes in v2:
-Drop the "silead,mssl1680" compatible thing, the "mssl1680" name is an
ACPI thing and does not belong in the dt bindings

---
 .../devicetree/bindings/input/touchscreen/silead_gsl1680.txt          | 4 ++++
 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +4 -0
index b0eca54..ad7f41a 100644
@@ -2,6 +2,10 @@
 
 Required properties:
 - compatible		  : "silead,gsl1680"
+			or: "silead,gsl1688"
+			or: "silead,gsl3670"
+			or: "silead,gsl3675"
+			or: "silead,gsl3692"
 - reg			  : I2C slave address of the chip (0x40)
 - interrupt-parent	  : a phandle pointing to the interrupt controller
 			    serving the interrupt for this chip
Signature · 1 line
2.7.4
maintainer
#1 lore raw

PATCH v2 1/1 dt-bindings: touchscreen: silead gsl1680: Document all compatibles

Quoted 11 lines · Hans de Goede

The silead gsl1680 driver / binding supports a whole series of devices, list the compatibles for all of them in the binding.

---
Changes in v2:
-Drop the "silead,mssl1680" compatible thing, the "mssl1680" name is an
ACPI thing and does not belong in the dt bindings

---
 .../devicetree/bindings/input/touchscreen/silead_gsl1680.txt          | 4 ++++
 1 file changed, 4 insertions(+)
maintainer
#2 lore raw

PATCH v2 1/1 dt-bindings: touchscreen: silead gsl1680: Document all compatibles

In reply to Hans de Goede
Quoted 17 lines · Hans de Goede

The silead gsl1680 driver / binding supports a whole series of devices, list the compatibles for all of them in the binding.

---
Changes in v2:

(quoted diff) +0 -2
-Drop the "silead,mssl1680" compatible thing, the "mssl1680" name is an
 ACPI thing and does not belong in the dt bindings
---
 .../devicetree/bindings/input/touchscreen/silead_gsl1680.txt          | 4 ++++
 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +0 -0
index b0eca54..ad7f41a 100644

Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt line 8

Quoted 7 lines
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +4 -0
@@ -2,6 +2,10 @@
 
 Required properties:
 - compatible		  : "silead,gsl1680"
+			or: "silead,gsl1688"
+			or: "silead,gsl3670"
+			or: "silead,gsl3675"
+			or: "silead,gsl3692"

Hmm, why do we need to document all compatible strings? We usually have only least common denominator in drievr, and device tree uses form:

	compatible = "silead,<exact model>", "silead,gsl1680";

Rob?

BTW, I do not see OF match table in the driver, did I manage to drop it?

Thanks.

Signature · 1 line
Dmitry
#3 lore raw

PATCH v2 1/1 dt-bindings: touchscreen: silead gsl1680: Document all compatibles

Quoted 29 lines · Dmitry Torokhov
Quoted 17 lines · Hans de Goede

The silead gsl1680 driver / binding supports a whole series of devices, list the compatibles for all of them in the binding.

---
Changes in v2:

(quoted diff) +0 -2
-Drop the "silead,mssl1680" compatible thing, the "mssl1680" name is an
 ACPI thing and does not belong in the dt bindings
---
 .../devicetree/bindings/input/touchscreen/silead_gsl1680.txt          | 4 ++++
 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +0 -0
index b0eca54..ad7f41a 100644

Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt line 8

Quoted 7 lines
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +4 -0
@@ -2,6 +2,10 @@
 
 Required properties:
 - compatible           : "silead,gsl1680"
+                     or: "silead,gsl1688"
+                     or: "silead,gsl3670"
+                     or: "silead,gsl3675"
+                     or: "silead,gsl3692"

Hmm, why do we need to document all compatible strings? We usually have only least common denominator in drievr, and device tree uses form:

Quoted 3 lines
        compatible = "silead,<exact model>", "silead,gsl1680";

Rob?

Because we require them in dts files even if the OS only uses the fallback.

Quoted 2 lines

BTW, I do not see OF match table in the driver, did I manage to drop it?

If it is i2c, i2c has the quirk that it will match drv name to compatible string with vendor prefix dropped. But that would imply one of these is a fallback and the doc doesn't say that.

Rob

maintainer
#4 lore raw

PATCH v2 1/1 dt-bindings: touchscreen: silead gsl1680: Document all compatibles

Quoted 31 lines · Rob Herring
Quoted 29 lines · Dmitry Torokhov
Quoted 17 lines · Hans de Goede

The silead gsl1680 driver / binding supports a whole series of devices, list the compatibles for all of them in the binding.

---
Changes in v2:

(quoted diff) +0 -2
-Drop the "silead,mssl1680" compatible thing, the "mssl1680" name is an
 ACPI thing and does not belong in the dt bindings
---
 .../devicetree/bindings/input/touchscreen/silead_gsl1680.txt          | 4 ++++
 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +0 -0
index b0eca54..ad7f41a 100644

Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt line 8

Quoted 7 lines
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +4 -0
@@ -2,6 +2,10 @@
 
 Required properties:
 - compatible           : "silead,gsl1680"
+                     or: "silead,gsl1688"
+                     or: "silead,gsl3670"
+                     or: "silead,gsl3675"
+                     or: "silead,gsl3692"

Hmm, why do we need to document all compatible strings? We usually have only least common denominator in drievr, and device tree uses form:

Quoted 5 lines
Quoted 3 lines
        compatible = "silead,<exact model>", "silead,gsl1680";

Rob?

Because we require them in dts files even if the OS only uses the fallback.

So how exactly should it be documented? I mean if there were more than 1 OS they might have been using different fallbacks. How do we decide which entry should be "true" fallback?

Quoted 6 lines
Quoted 3 lines

BTW, I do not see OF match table in the driver, did I manage to drop it?

If it is i2c, i2c has the quirk that it will match drv name to compatible string with vendor prefix dropped.

I think this is implementation quirk of I2C bus and I hope we'll fix it one of these days... Same with modalias dropping vendor prefix so we have to repeat OF data (sans vendor prefix) in I2C ID table if we want module auto-loading to work.

Quoted 2 lines

But that would imply one
of these is a fallback and the doc doesn't say that.

Thanks.

Signature · 1 line
Dmitry
#5 lore raw

PATCH v2 1/1 dt-bindings: touchscreen: silead gsl1680: Document all compatibles

Quoted 34 lines · Dmitry Torokhov
Quoted 33 lines · Rob Herring
Quoted 31 lines · Dmitry Torokhov
Quoted 17 lines · Hans de Goede

The silead gsl1680 driver / binding supports a whole series of devices, list the compatibles for all of them in the binding.

---
Changes in v2:

(quoted diff) +0 -2
-Drop the "silead,mssl1680" compatible thing, the "mssl1680" name is an
 ACPI thing and does not belong in the dt bindings
---
 .../devicetree/bindings/input/touchscreen/silead_gsl1680.txt          | 4 ++++
 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +0 -0
index b0eca54..ad7f41a 100644

Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt line 8

Quoted 7 lines
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +4 -0
@@ -2,6 +2,10 @@
 
 Required properties:
 - compatible           : "silead,gsl1680"
+                     or: "silead,gsl1688"
+                     or: "silead,gsl3670"
+                     or: "silead,gsl3675"
+                     or: "silead,gsl3692"

Hmm, why do we need to document all compatible strings? We usually have only least common denominator in drievr, and device tree uses form:

        compatible = "silead,<exact model>", "silead,gsl1680";
Quoted 7 lines
Quoted 3 lines
Quoted 1 line

Rob?

Because we require them in dts files even if the OS only uses the fallback.

So how exactly should it be documented? I mean if there were more than 1 OS they might have been using different fallbacks. How do we decide which entry should be "true" fallback?

It shouldn't matter which one an OS uses. There's typically only the specific one and then a generic or 1st compatible chip one.

This is exactly why they need to be documented (and in a single place, looking at you u-boot), so there is no confusion as to what compatibles are allowed/valid for each platform.

Rob

maintainer
#6 lore raw

PATCH v2 1/1 dt-bindings: touchscreen: silead gsl1680: Document all compatibles

Quoted 50 lines · Rob Herring
Quoted 5 lines · Dmitry Torokhov
Quoted 4 lines · Rob Herring
Quoted 2 lines · Dmitry Torokhov
Quoted 1 line · Hans de Goede

The silead gsl1680 driver / binding supports a whole series of

devices,

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

list the compatibles for all of them in the binding.

---
Changes in v2:
-Drop the "silead,mssl1680" compatible thing, the "mssl1680" name

is an

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

ACPI thing and does not belong in the dt bindings
---
.../devicetree/bindings/input/touchscreen/silead_gsl1680.txt

    | 4 ++++
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
 1 file changed, 4 insertions(+)

diff --git

a/Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt b/Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

index b0eca54..ad7f41a 100644
---

a/Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt

Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

+++

b/Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt

Quoted 10 lines
Quoted 10 lines
Quoted 10 lines

Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt line 8

Quoted 8 lines
Documentation/devicetree/bindings/input/touchscreen/silead_gsl1680.txt +4 -0
@@ -2,6 +2,10 @@
 
 Required properties:
 - compatible           : "silead,gsl1680"
+                     or: "silead,gsl1688"
+                     or: "silead,gsl3670"
+                     or: "silead,gsl3675"
+                     or: "silead,gsl3692"

Hmm, why do we need to document all compatible strings? We usually

have

Quoted 1 line
Quoted 1 line
Quoted 1 line

only least common denominator in drievr, and device tree uses

form:

Quoted 6 lines
Quoted 6 lines
Quoted 4 lines
        compatible = "silead,<exact model>", "silead,gsl1680";

Rob?

Because we require them in dts files even if the OS only uses the

fallback.

Quoted 1 line
Quoted 7 lines
Quoted 1 line

So how exactly should it be documented? I mean if there were more

than 1

Quoted 2 lines

OS they might have been using different fallbacks. How do we decide which entry should be "true" fallback?

It shouldn't matter which one an OS uses. There's typically only the specific one and then a generic or 1st compatible chip one.

When you are saying "first compatible chip" do you mean first as it was created by the vendor or first that was added to a given os? Because we quite often have no idea what the first compatible chip in a series was and start with whatever the first submitter of a driver used in their product.

Quoted 4 lines

This is exactly why they need to be documented (and in a single place, looking at you u-boot), so there is no confusion as to what compatibles are allowed/valid for each platform.

What do you mean when you say platform?

We have uboot, core boot, Linux, free BSD, in whatever combinations. How do we make sure we all use the same fallback?

Thanks.

Signature · 1 line
Dmitry