scripts: extract_dts_includes: fails on multiple includes in yaml bindings file

[b0661]

Inheriting from multiple bindings fails.

inherits:
    !include [binding1.yaml, binding2.yaml]

Following the above the 'node_type' node property does not account for multiple base types.

Loader.include for yaml.SequenceNode and yaml_traverse_inherited seems to be broken.

[galak]

@erwango can you look into this issue.

[erwango]

@b0661 : In order to solve this is a coherent way, do you have any example of use for multiple bindings inclusion?

[b0661]

I tried to model STM32 RCC by combining a clock-provider.yaml and clock-consumer.yaml binding. The node type of the RCC would be both in this case. My suggestion is to make the 'node_type' node property a list. I have a working example available. Sorry no pull request yet.

diff --git a/scripts/dts/extract_dts_includes.py b/scripts/dts/extract_dts_includes.py
index 12a3b6ab6..d966ce231 100755
--- a/scripts/dts/extract_dts_includes.py
+++ b/scripts/dts/extract_dts_includes.py
@@ -54,7 +54,7 @@ class Loader(yaml.Loader):
         elif isinstance(node, yaml.SequenceNode):
             result = []
             for filename in self.construct_sequence(node):
-                result += self.extractFile(filename)
+                result.append(self.extractFile(filename))
             return result
 
         elif isinstance(node, yaml.MappingNode):
@@ -450,15 +450,24 @@ def yaml_traverse_inherited(node):
     :return: node
     """
 
+    if 'node_type' not in node.keys():
+        node['node_type'] = []
     if 'inherits' in node.keys():
-        if 'id' in node['inherits'].keys():
-            node['inherits']['node_type'] = node['inherits']['id']
-            node['inherits'].pop('id')
-        if 'inherits' in node['inherits'].keys():
-            node['inherits'] = yaml_traverse_inherited(node['inherits'])
-        dict_merge(node['inherits'], node)
-        node = node['inherits']
+        if isinstance(node['inherits'], list):
+            inherits_list  = node['inherits']
+        else:
+            inherits_list  = [node['inherits'],]
         node.pop('inherits')
+        for inherits in inherits_list:
+            if 'id' in inherits.keys():
+                node['node_type'].append(inherits['id'])
+                inherits.pop('id')
+            if 'inherits' in inherits.keys():
+                inherits = yaml_traverse_inherited(inherits)
+                if 'node_type' in inherits.keys():
+                    node['node_type'].extend(inherits['node_type'])
+            dict_merge(inherits, node)
+            node = inherits
     return node

Clock consumer

# -- Assigned clock parents and rates --
# Some platforms may require initial configuration of default parent clocks
# and clock frequencies. Such a configuration can be specified in a device tree
# node through assigned-clocks, assigned-clock-parents and assigned-clock-rates
# properties.
---
title: Clock Consumer Base Structure
id: clock-consumer
version: 0.1

description: >
    This binding gives the base structures for all clock consumers.

properties:

    clocks:
      type: array
      category: optional
      description: >
        List of phandle and clock specifier pairs, one pair for each clock
        input to the device. Note - if the clock provider specifies '0' for
        clock-cells, then only the phandle portion of the pair will appear.
      generation: define

    clock-names:
      type: array
      category: optional
      description: >
        List of clock input name strings sorted in the same order as the clocks property.
      generation: define

    clock-ranges:
      type: empty
      category: optional
      description: >
        Empty property indicating that child nodes can inherit named clocks from
        this node. Useful for bus nodes to provide a clock to their children.
      generation: define

    assigned-clocks:
      type: array
      category: optional
      description: >
        List of phandle and clock specifier pairs, one pair for each assigned
        clock input. Note - if the clock provider specifies '0' for
        clock-cells, then only the phandle portion of the pair will appear.
      generation: define

    assigned-clock-parents:
      type: array
      category: optional
      description: >
        List of parent clocks in the form of a phandle and clock
        specifier pair. The list shall correspond to the clocks listed in the
        assigned-clocks directive.
      generation: define

    assigned-clock-rates:
      type: array
      category: optional
      description: >
        List of frequencies in Hz. The list shall correspond to the clocks
        listed in the assigned-clocks directive.
      generation: define
...

Clock provider

---
title: Clock Provider Base Structure
id: clock-provider
version: 0.1

description: >
    This binding gives the base structures for all clock providers.

properties:

    "#clock-cells":
      type: int
      category: optional
      description: >
        If this device will also be providing controllable clocks, the
        clock_cells property needs to be specified.

    clock-output-names:
      type: array
      category: optional
      description: >
        A list of strings of clock output signal names indexed by the first
        cell in the clock specifier.
      generation: define

    clock-indices:
      type: array
      category: optional
      description: >
        The identifying number for the clocks in the node. If it is not linear
        from zero, then this allows the mapping of identifiers into the
        clock-output-names array.
      generation: define
...

[erwango]

@b0661 : Is that ok if we set this ticket as 'enhancement' instead of 'bug'? (Medium priority 'bug' issues are blocking for upcoming release)
This is blocking further advanced development but not breaking anything currently.

[b0661]

@erwango

Is that ok if we set this ticket as 'enhancement' instead of 'bug'?

Yes, shure it is ok to set it to 'enhancement'.