devicetree: add binding support for variant compatibles #20289

pabigot · 2019-11-02T12:31:42Z

This is a step towards #19904. The motivation is removing redundant bindings from dts/ that aren't associated with their own driver implementation, and eliminating the annoying checkpatch warnings when an unspecified compatible is added in a commit.

Knowledge of the variants may also assist in addressing #20287.

zephyrbot · 2019-11-02T12:37:57Z

All checks are passing now.

Tip: The bot edits this comment instead of posting a new one, so you can check the comment's history to see earlier messages.

ulfalizer

Should check the format of variant-compatible too. Search for all(isinstance in edtlib.py for examples of how it's done for other keys.

ulfalizer · 2019-11-02T14:42:14Z

dts/binding-template.yaml

@@ -29,6 +29,11 @@ compatible: "manufacturer,device"
 #
 # If more than one binding for a compatible is found, an error is raised.

+# Used to identify variants known to work with the driver for 'compatible'


If we go with this, this ought to explain that variant-compatible isn't used by the code, and is just a "syntaxified comment" in a sense. Otherwise, I'd wonder how it's used.

Think I'm fine with it as long as that's clear. Might help bring some structure.

(Could update the comment later if/when it gets used for other stuff. As long as it's unused, it's nice to document it, to avoid confusion.)

ulfalizer · 2019-11-02T14:43:38Z

scripts/dts/edtlib.py

@@ -416,7 +416,8 @@ def _check_binding(self, binding, binding_path):
                _err("missing, malformed, or empty '{}' in {}"
                     .format(prop, binding_path))

-        ok_top = {"title", "description", "compatible", "properties", "#cells",
+        ok_top = {"title", "description", "compatible", "variant-compatible",
+                  "properties", "#cells",


Could reflow all of ok_top, or put on separate lines if you're worried about history (though I wonder if the vertical spam is worthwhile).

ulfalizer · 2019-11-03T14:17:37Z

scripts/dts/edtlib.py

+            if prop == "variant-compatible":
+                if not all(isinstance(elm, str) for elm in binding[prop]):
+                    _err("all elements in '{}:' in {} should be strings"
+                         .format(prop, binding_path))


Should verify that it's a list as well, or it'll pass for variant-compatible: "foo" by iterating over "f", "o", "o".

Could maybe put it outside the loop. Think some other stuff was:

if "variant-compatible" in binding: var_comp = binding["variant_compatible"] if not (isinstance(var_comp, list) and all(isinstance(elm, str) for elm in var_comp)): _err("... should be a list of strings")

Could put it next to the

if "child-binding" in binding: .... if "sub-node" in binding: ... if "#cells" in binding: ...

stuff below.

avisconti · 2019-11-04T10:12:36Z

boards/shields/x_nucleo_iks01a2/x_nucleo_iks01a2.overlay

@@ -27,7 +27,7 @@
 	};

 	lsm303agr-magn@1e {
-		compatible = "st,lis2mdl","st,lsm303agr-magn";
+		compatible = "st,lsm303agr-magn", "st,lis2mdl";


What is the reason to invert the devices in the compatible list?

Because standard practice is to order them from most-specific to least-specific, selecting the first one that is supported. There is no lsm303agr-magn driver right now, but there is a lis2mdl that works with that device.

Historically Zephyr only paid attention to the first entry, but that was fixed some months ago so we can now be consistent with other devicetree usage.

binding-template specifies the order, but does not explain why it's that way.

@avisconti please revisit this; note @galak's non-verbal support for this change.

avisconti · 2019-11-04T10:15:20Z

boards/shields/x_nucleo_iks01a2/x_nucleo_iks01a2.overlay

@@ -34,7 +34,7 @@
 	};

 	lsm303agr-accel@19 {
-		compatible = "st,lis2dh", "st,lsm303agr-accel";
+		compatible = "st,lsm303agr-accel", "st,lis2dh";


avisconti · 2019-11-04T10:15:32Z

boards/arm/stm32f3_disco/stm32f3_disco.dts

@@ -94,7 +94,7 @@
 	};

 	lsm303dlhc-accel@19 {
-		compatible = "st,lis2dh", "st,lsm303dlhc-accel";
+		compatible = "st,lsm303dlhc-accel", "st,lis2dh";


ulfalizer

Fine with me.

ulfalizer · 2019-11-05T18:01:11Z

scripts/dts/edtlib.py

+            if not (isinstance(var_comp, list) and
+                    all(isinstance(elm, str) for elm in var_comp)):
+                _err("malformed 'variant-compatible:' in {}, expected "
+                     " list of strings".format(binding_path))


Nit: Accidental two spaces between "expected" and "list".

ulfalizer

Fine with me.

ulfalizer

Fine with me.

ulfalizer

Fine with me.

ulfalizer

Fine with me.

ulfalizer · 2019-11-05T18:11:04Z

Heh... GitHub bugged out for a moment there.

ulfalizer · 2019-11-05T18:11:07Z

Heh... GitHub bugged out for a moment there.

ulfalizer · 2019-11-05T18:40:21Z

Heh... GitHub bugged out for a moment there.

pabigot · 2020-07-20T13:08:20Z

This PR is too out of data and there seems to be little interest in the cleanup it provides.

pabigot added the area: Devicetree label Nov 2, 2019

pabigot requested review from ulfalizer and galak November 2, 2019 12:31

pabigot force-pushed the dts/20191102b branch 2 times, most recently from adf43ef to 0340856 Compare November 2, 2019 12:33

zephyrbot added the area: Boards label Nov 2, 2019

pabigot mentioned this pull request Nov 2, 2019

[TOPIC-GPIO] Update the PCAL9535A driver and rename it to PCA95XX #20268

Merged

ulfalizer reviewed Nov 2, 2019

View reviewed changes

pabigot force-pushed the dts/20191102b branch 2 times, most recently from 5856bb5 to 4c5baad Compare November 2, 2019 21:13

pabigot marked this pull request as ready for review November 2, 2019 22:31

pabigot requested review from avisconti, erwango, Mani-Sadhasivam and ydamigos as code owners November 2, 2019 22:31

ulfalizer reviewed Nov 3, 2019

View reviewed changes

pabigot force-pushed the dts/20191102b branch from 4c5baad to 0323e15 Compare November 3, 2019 16:19

pabigot changed the title ~~[RFC] add binding support for variant compatibles~~ devicetree: add binding support for variant compatibles Nov 3, 2019

pabigot force-pushed the dts/20191102b branch from 0323e15 to d65ebcb Compare November 3, 2019 18:50

avisconti previously requested changes Nov 4, 2019

View reviewed changes

galak requested a review from avisconti November 4, 2019 13:56

ulfalizer approved these changes Nov 5, 2019

View reviewed changes

This was referenced Nov 15, 2019

devicetree bindings: improve support for multiple compatibles #19904

Open

Devicetree: allow one binding to match multiple compatibles #20669

Open

galak added area: Devicetree Tooling PR modifies or adds a Device Tree tooling and removed area: Devicetree labels Jan 30, 2020

github-actions bot added area: Devicetree has-conflicts Issue/PR has conflicts with another issue/PR area: Device Tree area: Devicetree Binding PR modifies or adds a Device Tree binding labels Jun 29, 2020

galak removed the area: Device Tree label Jul 1, 2020

github-actions bot added has-conflicts Issue/PR has conflicts with another issue/PR area: Shields Shields (add-on boards) platform: STM32 ST Micro STM32 and removed has-conflicts Issue/PR has conflicts with another issue/PR labels Jul 1, 2020

pabigot closed this Jul 20, 2020

pabigot deleted the dts/20191102b branch July 20, 2020 13:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

devicetree: add binding support for variant compatibles #20289

devicetree: add binding support for variant compatibles #20289

pabigot commented Nov 2, 2019 •

edited

Loading

zephyrbot commented Nov 2, 2019 •

edited

Loading

ulfalizer left a comment

ulfalizer Nov 2, 2019

ulfalizer Nov 2, 2019

ulfalizer Nov 2, 2019

ulfalizer Nov 3, 2019

ulfalizer Nov 3, 2019

ulfalizer Nov 3, 2019

avisconti Nov 4, 2019

pabigot Nov 4, 2019

pabigot Nov 6, 2019

avisconti Nov 4, 2019

avisconti Nov 4, 2019

ulfalizer left a comment

ulfalizer Nov 5, 2019

ulfalizer left a comment

ulfalizer left a comment

ulfalizer left a comment

ulfalizer left a comment

ulfalizer commented Nov 5, 2019

ulfalizer commented Nov 5, 2019

ulfalizer commented Nov 5, 2019

pabigot commented Jul 20, 2020

devicetree: add binding support for variant compatibles #20289

devicetree: add binding support for variant compatibles #20289

Conversation

pabigot commented Nov 2, 2019 • edited Loading

zephyrbot commented Nov 2, 2019 • edited Loading

ulfalizer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ulfalizer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ulfalizer left a comment

Choose a reason for hiding this comment

ulfalizer left a comment

Choose a reason for hiding this comment

ulfalizer left a comment

Choose a reason for hiding this comment

ulfalizer left a comment

Choose a reason for hiding this comment

ulfalizer commented Nov 5, 2019

ulfalizer commented Nov 5, 2019

ulfalizer commented Nov 5, 2019

pabigot commented Jul 20, 2020

pabigot commented Nov 2, 2019 •

edited

Loading

zephyrbot commented Nov 2, 2019 •

edited

Loading