scripts: dts: Use DT_ prefix in generated labels

Almost all labels generated by the extracting script are now prefixed
with DT_. The only exceptions are:
- stuff with 'base_label' specified in yaml bindings
- items specified by 'regs_config' and 'name_config' dictionaries
  in globals.py module
- FLASH related labels generated by flash.extract() called separately
  from generate_node_definitions(), e.g. FLASH_WRITE_BLOCK_SIZE -
  these are used directly, not through fixups, from existing code
  so I didn't want to touch them now

Labels generated for aliases are additionally prefixed with information
from the 'compatible' property, e.g. DT_GPIO_LEDS_LED0_* is generated
instead of LED0_*. To provide backward compatibility for code that uses
LEDx_* and SWx_* labels in their previous forms, a command line option
named 'old-alias-names' is added to the extraction script. This option
causes that the labels for aliases are generated in both old and new
forms. Currently this option is always enabled in dts.cmake.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>

cmake/dts.cmake

@@ -170,6 +170,7 @@ if(CONFIG_HAS_DTS)
     ${DTS_FIXUPS_WITH_FLAG}
     --keyvalue ${GENERATED_DTS_BOARD_CONF}
     --include ${GENERATED_DTS_BOARD_H}
+    --old-alias-names
     )
 
   # Run extract_dts_includes.py to create a .conf and a header file that can be

scripts/dts/extract/clocks.py

@@ -24,7 +24,7 @@ class DTClocks(DTDirective):
         clock_consumer = reduced[node_address]
         clock_consumer_compat = get_compat(node_address)
         clock_consumer_bindings = yaml[clock_consumer_compat]
-        clock_consumer_label = get_node_label(node_address)
+        clock_consumer_label = 'DT_' + get_node_label(node_address)
 
         clock_index = 0
         clock_cell_index = 0
@@ -83,15 +83,29 @@ class DTClocks(DTDirective):
                     else:
                         index = str(clock_index)
                     if node_address in aliases:
-                        for alias in aliases[node_address]:
+                        if clock_cells_string == clock_cell_name:
-                            if clock_cells_string == clock_cell_name:
+                            add_prop_aliases(
-                                clock_alias_label = self.get_label_string([
+                                node_address,
-                                    alias, clock_cells_string, index])
+                                yaml,
-                            else:
+                                lambda alias:
-                                clock_alias_label = self.get_label_string([
+                                    self.get_label_string([
-                                    alias, clock_cells_string,
+                                        alias,
-                                    clock_cell_name, index])
+                                        clock_cells_string,
-                            prop_alias[clock_alias_label] = clock_label
+                                        index]),
+                                clock_label,
+                                prop_alias)
+                        else:
+                            add_prop_aliases(
+                                node_address,
+                                yaml,
+                                lambda alias:
+                                    self.get_label_string([
+                                        alias,
+                                        clock_cells_string,
+                                        clock_cell_name,
+                                        index]),
+                                clock_label,
+                                prop_alias)
                     # alias
                     if i < nr_clock_cells:
                         # clocks info for first clock
@@ -122,10 +136,16 @@ class DTClocks(DTDirective):
                                                          index])
                     prop_def[clock_label] = '"' + clock_provider_label_str + '"'
                     if node_address in aliases:
-                        for alias in aliases[node_address]:
+                        add_prop_aliases(
-                            clock_alias_label = self.get_label_string([
+                            node_address,
-                                alias, clock_cell_name, index])
+                            yaml,
-                            prop_alias[clock_alias_label] = clock_label
+                            lambda alias:
+                                self.get_label_string([
+                                    alias,
+                                    clock_cell_name,
+                                    index]),
+                            clock_label,
+                            prop_alias)
 
                 insert_defs(node_address, prop_def, prop_alias)
 

scripts/dts/extract/default.py

@@ -56,10 +56,13 @@ class DTDefault(DTDirective):
 
             # generate defs for node aliases
             if node_address in aliases:
-                for i in aliases[node_address]:
+                add_prop_aliases(
-                    alias_label = convert_string_to_label(i)
+                    node_address,
-                    alias = alias_label + '_' + prop_name
+                    yaml,
-                    prop_alias[alias] = label
+                    lambda alias:
+                        convert_string_to_label(alias) + '_' + prop_name,
+                    label,
+                    prop_alias)
 
         insert_defs(node_address, prop_def, prop_alias)
 

scripts/dts/extract/globals.py

@@ -15,6 +15,7 @@ chosen = {}
 reduced = {}
 defs = {}
 structs = {}
+old_alias_names = False
 
 regs_config = {
     'zephyr,flash' : 'CONFIG_FLASH',
@@ -267,3 +268,21 @@ def translate_addr(addr, node_address, nr_addr_cells, nr_size_cells):
     range_offset += parent_range_offset
 
     return range_offset
+
+def enable_old_alias_names(enable):
+    global old_alias_names
+    old_alias_names = enable
+
+def add_prop_aliases(node_address, yaml,
+                     alias_label_function, prop_label, prop_aliases):
+    node_compat = get_compat(node_address)
+    new_alias_prefix = 'DT_' + convert_string_to_label(node_compat)
+
+    for alias in aliases[node_address]:
+        old_alias_label = alias_label_function(alias)
+        new_alias_label = new_alias_prefix + '_' + old_alias_label
+
+        if (new_alias_label != prop_label):
+            prop_aliases[new_alias_label] = prop_label
+        if (old_alias_names and old_alias_label != prop_label):
+            prop_aliases[old_alias_label] = prop_label

scripts/dts/extract/interrupts.py

@@ -82,10 +82,14 @@ class DTInterrupts(DTDirective):
                     prop_alias['_'.join(alias_list)] = l_fqn
 
                 if node_address in aliases:
-                    for i in aliases[node_address]:
+                    add_prop_aliases(
-                        alias_label = convert_string_to_label(i)
+                        node_address,
-                        alias_list = [alias_label] + l_cell_prefix + name + l_cell_name
+                        yaml,
-                        prop_alias['_'.join(alias_list)] = l_fqn
+                        lambda alias:
+                            '_'.join([convert_string_to_label(alias)] +
+                                     l_cell_prefix + name + l_cell_name),
+                        l_fqn,
+                        prop_alias)
 
             index += 1
             insert_defs(node_address, prop_def, prop_alias)

scripts/dts/extract/reg.py

@@ -88,12 +88,22 @@ class DTReg(DTDirective):
 
             # generate defs for node aliases
             if node_address in aliases:
-                for i in aliases[node_address]:
+                add_prop_aliases(
-                    alias_label = convert_string_to_label(i)
+                    node_address,
-                    alias_addr = [alias_label] + l_addr + l_idx
+                    yaml,
-                    alias_size = [alias_label] + l_size + l_idx
+                    lambda alias:
-                    prop_alias['_'.join(alias_addr)] = '_'.join(l_base + l_addr + l_idx)
+                        '_'.join([convert_string_to_label(alias)] +
-                    prop_alias['_'.join(alias_size)] = '_'.join(l_base + l_size + l_idx)
+                                 l_addr + l_idx),
+                    l_addr_fqn,
+                    prop_alias)
+                add_prop_aliases(
+                    node_address,
+                    yaml,
+                    lambda alias:
+                        '_'.join([convert_string_to_label(alias)] +
+                                 l_size + l_idx),
+                    l_size_fqn,
+                    prop_alias)
 
             insert_defs(node_address, prop_def, prop_alias)
 

scripts/dts/extract_dts_includes.py

@@ -176,11 +176,13 @@ def extract_controller(node_address, yaml, prop, prop_values, index, def_label,
 
         #generate defs also if node is referenced as an alias in dts
         if node_address in aliases:
-            for i in aliases[node_address]:
+            add_prop_aliases(
-                alias_label = \
+                node_address,
-                    convert_string_to_label(i)
+                yaml,
-                alias = [alias_label] + label[1:]
+                lambda alias:
-                prop_alias['_'.join(alias)] = '_'.join(label)
+                    '_'.join([convert_string_to_label(alias)] + label[1:]),
+                '_'.join(label),
+                prop_alias)
 
         insert_defs(node_address, prop_def, prop_alias)
 
@@ -251,10 +253,13 @@ def extract_cells(node_address, yaml, prop, prop_values, names, index,
 
         # generate defs for node aliases
         if node_address in aliases:
-            for i in aliases[node_address]:
+            add_prop_aliases(
-                alias_label = convert_string_to_label(i)
+                node_address,
-                alias = [alias_label] + label[1:]
+                yaml,
-                prop_alias['_'.join(alias)] = '_'.join(label)
+                lambda alias:
+                    '_'.join([convert_string_to_label(alias)] + label[1:]),
+                '_'.join(label),
+                prop_alias)
 
         insert_defs(node_address, prop_def, prop_alias)
 
@@ -289,10 +294,13 @@ def extract_single(node_address, yaml, prop, key, def_label):
 
         # generate defs for node aliases
         if node_address in aliases:
-            for i in aliases[node_address]:
+            add_prop_aliases(
-                alias_label = convert_string_to_label(i)
+                node_address,
-                alias = alias_label + '_' + k
+                yaml,
-                prop_alias[alias] = label
+                lambda alias:
+                    convert_string_to_label(alias) + '_' + k,
+                label,
+                prop_alias)
 
     insert_defs(node_address, prop_def, prop_alias)
 
@@ -361,7 +369,10 @@ def extract_property(node_compat, yaml, node_address, prop, prop_val, names):
 
             # Generate bus-name define
             extract_single(node_address, yaml, 'parent-label',
-                           'bus-name', def_label)
+                           'bus-name', 'DT_' + def_label)
+
+    if 'base_label' not in yaml[node_compat]:
+        def_label = 'DT_' + def_label
 
     if prop == 'reg':
         reg.extract(node_address, yaml, names, def_label, 1)
@@ -711,11 +722,15 @@ def parse_arguments():
                         help="Generate include file for the build system")
     parser.add_argument("-k", "--keyvalue", nargs=1, required=True,
                         help="Generate config file for the build system")
+    parser.add_argument("--old-alias-names", action='store_true',
+                        help="Generate aliases also in the old way, without "
+                             "compatibility information in their labels")
     return parser.parse_args()
 
 
 def main():
     args = parse_arguments()
+    enable_old_alias_names(args.old_alias_names)
 
     dts = load_and_parse_dts(args.dts[0])