devicetree: Add DT_CHILD_BY_UNIT_ADDR and DT_CHILD_BY_REG_ADDR

Allow fetching child node identifiers by unit/reg address.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>

Author: pdgendt

include/zephyr/devicetree.h

@@ -435,6 +435,77 @@
  */
 #define DT_CHILD(node_id, child) UTIL_CAT(node_id, DT_S_PREFIX(child))
 
+/**
+ * @brief Get a node identifier for a child node by a reg address
+ *
+ * Example devicetree fragment:
+ *
+ * @code{.dts}
+ *     / {
+ *             soc-label: soc {
+ *                     serial1: serial@40001000 {
+ *                             status = "okay";
+ *                             current-speed = <115200>;
+ *                             reg = <0x40001000 0x1000>;
+ *                             ...
+ *                     };
+ *             };
+ *     };
+ * @endcode
+ *
+ * Example usage with DT_PROP() to get the status of the
+ * `serial@40001000` node:
+ *
+ * @code{.c}
+ *     #define SOC_NODE DT_NODELABEL(soc_label)
+ *     DT_PROP(DT_CHILD_BY_REG_ADDR(SOC_NODE, 0, 0x40001000), status) // "okay"
+ * @endcode
+ *
+ *
+ * @param node_id node identifier
+ * @param idx Register address index for the child node.
+ * @param addr Register address for the child node. Can be hexadecimal (prefix with 0x) or decimal
+ *
+ * @return node identifier for the child node with the reg address at a specified index
+ */
+#define DT_CHILD_BY_REG_ADDR(node_id, idx, addr) \
+	DT_CAT5(node_id, _CHILD_REG_IDX_, idx, _ADDR_, addr)
+
+/**
+ * @brief Get a node identifier for a child node by a unit address
+ *
+ * Example devicetree fragment:
+ *
+ * @code{.dts}
+ *     / {
+ *             soc-label: soc {
+ *                     serial1: serial@40001000 {
+ *                             status = "okay";
+ *                             current-speed = <115200>;
+ *                             reg = <0x40001000 0x1000>;
+ *                             ...
+ *                     };
+ *             };
+ *     };
+ * @endcode
+ *
+ * Example usage with DT_PROP() to get the status of the
+ * `serial@40001000` node:
+ *
+ * @code{.c}
+ *     #define SOC_NODE DT_NODELABEL(soc_label)
+ *     DT_PROP(DT_CHILD_BY_UNIT_ADDR(SOC_NODE, 0x40001000), status) // "okay"
+ * @endcode
+ *
+ *
+ * @param node_id node identifier
+ * @param addr Unit address for the child node. Can be hexadecimal (prefix with 0x) or decimal
+ *
+ * @return node identifier for the child node with the reg address at a specified index
+ */
+#define DT_CHILD_BY_UNIT_ADDR(node_id, addr) \
+	DT_CAT3(node_id, _CHILD_UNIT_ADDR_, addr)
+
 /**
  * @brief Get a node identifier for a status `okay` node with a compatible
  *
@@ -4066,6 +4137,33 @@
 #define DT_INST_CHILD(inst, child) \
 	DT_CHILD(DT_DRV_INST(inst), child)
 
+/**
+ * @brief Get a node identifier for a child node by a reg address of DT_DRV_INST(inst)
+ *
+ * @param inst instance number
+ * @param idx Register address index for the child node.
+ * @param addr Register address for the child node. Can be hexadecimal (prefix with 0x) or decimal
+ *
+ * @return node identifier for the child node with the reg address at a specified index
+ *
+ * @see DT_CHILD_BY_REG_ADDR
+ */
+#define DT_INST_CHILD_BY_REG_ADDR(inst, idx, addr) \
+	DT_CHILD_BY_REG_ADDR(DT_DRV_INST(inst), idx, addr)
+
+/**
+ * @brief Get a node identifier for a child node by a unit address of DT_DRV_INST(inst)
+ *
+ * @param inst instance number
+ * @param addr Unit address for the child node. Can be hexadecimal (prefix with 0x) or decimal
+ *
+ * @return node identifier for the child node with the reg address at a specified index
+ *
+ * @see DT_CHILD_BY_UNIT_ADDR
+ */
+#define DT_INST_CHILD_BY_UNIT_ADDR(inst, addr) \
+	DT_CHILD_BY_UNIT_ADDR(DT_DRV_INST(inst), addr)
+
 /**
  * @brief Get the number of child nodes of a given node
  *

scripts/dts/gen_defines.py

@@ -484,6 +484,35 @@ def write_children(node: edtlib.Node) -> None:
 
     out_dt_define(f"{node.z_path_id}_CHILD_NUM_STATUS_OKAY", ok_nodes_num)
 
+    child_reg_addrs = {}
+    for child in node.children.values():
+        if child.unit_addr is not None:
+            child_reg_addrs.setdefault((-1, child.unit_addr), []).append(child)
+        # Provide a way to query child nodes
+        for idx, reg in enumerate(child.regs):
+            if reg.addr is not None:
+                child_reg_addrs.setdefault((idx, reg.addr), []).append(child)
+
+    for (idx, addr), children in child_reg_addrs.items():
+        if len(children) != 1:
+            # Duplicate addresses for different children, skip
+            continue
+
+        # Decimal and hexadecimal variants
+        if idx == -1:
+            out_dt_define(f"{node.z_path_id}_CHILD_UNIT_ADDR_{addr}", f"DT_{children[0].z_path_id}")
+            out_dt_define(
+                f"{node.z_path_id}_CHILD_UNIT_ADDR_{hex(addr)}", f"DT_{children[0].z_path_id}"
+            )
+        else:
+            out_dt_define(
+                f"{node.z_path_id}_CHILD_REG_IDX_{idx}_ADDR_{addr}", f"DT_{children[0].z_path_id}"
+            )
+            out_dt_define(
+                f"{node.z_path_id}_CHILD_REG_IDX_{idx}_ADDR_{hex(addr)}",
+                f"DT_{children[0].z_path_id}"
+            )
+
     out_dt_define(f"{node.z_path_id}_FOREACH_CHILD(fn)",
             " ".join(f"fn(DT_{child.z_path_id})" for child in
                 node.children.values()))