dts: edtlib: extract clock inputs and clock outputs

Extract clock inputs ('clocks') and clock outputs ('clock-output-names')
properties.

Extend the Node class with properties for:

  clocks:
    A list of ControllerAndData objects for the clock inputs on the
    node, sorted by index. The list is empty if the node does not have a
    clocks property.

  clock_outputs:
    A list of ControllerAndData objects for the clock outputs on the
    node, sorted by index. The list is empty if the node does not have a
    \#clock-cells property.

Signed-off-by: Bobby Noelte <[email protected]>

Author: b0661

scripts/dts/edtlib.py

@@ -509,6 +509,7 @@ def _init_nodes(self):
             # run them separately
             node._init_props()
             node._init_interrupts()
+            node._init_clock_outputs()
             node._init_gpio_ranges()
 
         for node in self.nodes:
@@ -783,6 +784,16 @@ class Node:
     aliases:
       A list of aliases for the node. This is fetched from the /aliases node.
 
+    clocks:
+      A list of ControllerAndData objects for the clock inputs on the
+      node, sorted by index. The list is empty if the node does not have a
+      clocks property.
+
+    clock_outputs:
+      A list of ControllerAndData objects for the clock outputs on the
+      node, sorted by index. The list is empty if the node does not have a
+      #clock-cells property.
+
     interrupts:
       A list of ControllerAndData objects for the interrupts generated by the
       node. The list is empty if the node does not generate interrupts.
@@ -947,6 +958,14 @@ def bus(self):
 
         return None
 
+    @property
+    def clocks(self):
+        "See the class docstring"
+
+        if "clocks" not in self.props:
+            return []
+        return self.props["clocks"].val
+
     @property
     def on_bus(self):
         "See the class docstring"
@@ -1289,6 +1308,84 @@ def _init_gpio_ranges(self):
                 prop_value.controller.pinctrl_gpio_ranges = []
             prop_value.controller.pinctrl_gpio_ranges.append(entry)
 
+    def _init_clock_outputs_append_entry(self, clock_index,
+                                clock_outputs_name_indices, clock_output_names,
+                                clock_frequency, clock_accuracy):
+        # Append entry to clock_outputs
+
+        entry = ControllerAndData()
+        entry.node = self
+        entry.controller = self
+        entry.data = {}
+        clock_output_name_index = clock_outputs_name_indices[clock_index]
+        if clock_output_name_index is None:
+            entry.name = None
+        else:
+            entry.name = clock_output_names[clock_output_name_index]
+        if clock_frequency is not None:
+            entry.data["clock-frequency"] = clock_frequency
+        if clock_accuracy is not None:
+            entry.data["clock-accuracy"] = clock_accuracy
+        self.clock_outputs.append(entry)
+
+    def _init_clock_outputs(self):
+       # Initialize self.clock_outputs
+
+        self.clock_outputs = []
+
+        node = self._node
+        if "#clock-cells" not in node.props:
+            return
+
+        clock_cells = node.props["#clock-cells"].to_num()
+
+        if "clock-output-names" in node.props:
+            clock_output_names = node.props.get("clock-output-names") \
+                                 .to_strings()
+            clock_count = len(clock_output_names)
+        else:
+            clock_output_names = []
+            if clock_cells == 0:
+                # clock-cells of 0 indicates one clock
+                clock_count = 1
+            else:
+                # unknown number of output clocks -> assume one
+                clock_count = 1
+                self.edt._warn("no clock-output-names property in clock "
+                    "provider {!r} - assuming one clock output".format(node))
+
+        if "clock-indices" in node.props:
+            clock_indices = clock_indices.to_nums()
+            if not clock_output_names:
+                _err("clock-indices ({}) given without clock-output-names"
+                    " in clock provider {!r}.".format(clock_indices, self.node))
+            if len(clock_output_names) != len(clock_indices):
+                _err("clock-output-names count ({}) does not match"
+                    " clock-indices count ({}) in clock provider {!r}."
+                    .format(len(clock_output_names), len(clock_indices),
+                                self.node))
+            # Increase clock count in case there is a higher clock index
+            clock_count = max(clock_count, max(clock_indices) + 1)
+        else:
+            clock_indices = None
+
+        if "clock-frequency" in node.props:
+            clock_frequency = node.props.get("clock-frequency").to_num()
+        else:
+            clock_frequency = None
+
+        if "clock-accuracy" in node.props:
+            clock_accuracy = node.props.get("clock-accuracy").to_num()
+        else:
+            clock_accuracy = None
+
+        clock_outputs_name_indices = _clock_outputs_name_indices(clock_count,
+                                            clock_indices, clock_output_names)
+        for clock_index in range(0, clock_count):
+            self._init_clock_outputs_append_entry(clock_index,
+                                clock_outputs_name_indices, clock_output_names,
+                                clock_frequency, clock_accuracy)
+
     def _init_regs(self):
         # Initializes self.regs
 
@@ -2185,6 +2282,25 @@ def _add_names(node, names_ident, objs):
             obj.name = None
 
 
+def _clock_outputs_name_indices(clock_count, clock_indices, clock_output_names):
+    # Create a table that indexes to clock output name by clock output index
+
+    if clock_indices is not None:
+        # Make full output name indices table from sparse table given by DTS
+        clock_outputs_name_indices = [None for x in range(0, clock_count)]
+        for clock_output_name_index, clock_index in enumerate(clock_indices):
+            clock_outputs_name_indices[clock_index] = clock_output_name_index
+    else:
+        clock_outputs_name_indices = []
+        for clock_index in range(0, clock_count):
+            if clock_index < len(clock_output_names):
+                clock_outputs_name_indices.append(clock_index)
+            else:
+                clock_outputs_name_indices.append(None)
+
+    return clock_outputs_name_indices
+
+
 def _pincfg_check_type(pincfg_node, prop):
     # Check pin configuration property type to be inline with expectations.
     # Bindings may specify different types for certain properties.