devicetree.h: Add DT_NODE_HAS_STATUS()

This macro takes a node identifier and status value and returns 0 or 1
if the status property on the node referred to by the node identifier
matches the status value passed.

We also update DT_HAS_NODE_STATUS_OKAY to utilize DT_NODE_HAS_STATUS

Signed-off-by: Kumar Gala <[email protected]>

Author: galak

doc/guides/dts/macros.bnf

@@ -43,6 +43,8 @@ node-macro =/ %s"DT_N" path-id %s"_IRQ_NAME_" dt-name
 node-macro =/ %s"DT_N" path-id %s"_COMPAT_MATCHES_" dt-name
 ; The node identifier for the node's parent in the devicetree.
 node-macro =/ %s"DT_N" path-id %s"_PARENT"
+; The node identifier for the node's status
+node-macro =/ %s"DT_N" path-id %s"_STATUS_" status
 
 ; --------------------------------------------------------------------
 ; property-macro: a macro related to a node property

include/devicetree.h

@@ -880,6 +880,38 @@
  * @{
  */
 
+/** @internal helper for DT_NODE_HAS_STATUS so we can additional
+ *  macro expansion
+ */
+#define DT_NODE_HAS_STATUS_(node_id, status) \
+	IS_ENABLED(DT_CAT(node_id, _STATUS_##status))
+
+/**
+ * @brief Does a devicetree node match a status?
+ *
+ * Example devicetree fragment:
+ *
+ *     n: node {
+ *             compatible = "generic-device";
+ *             status = "okay";
+ *     }
+ *
+ * Example usages which evaluate to 1:
+ *
+ *     DT_NODE_HAS_STATUS(DT_NODELABEL(n), okay)
+ *
+ * Example usages which evaluate to 0:
+ *
+ *     DT_NODE_HAS_STATUS(DT_NODELABEL(n), disabled)
+ *
+ * @param node_id node identifier
+ * @param status status value to check for
+ * @return 1 if the node's status property matches status,
+ *         0 otherwise.
+ */
+#define DT_NODE_HAS_STATUS(node_id, status) \
+	DT_NODE_HAS_STATUS_(node_id, status)
+
 /**
  * @brief Does a node identifier refer to a usable node?
  *
@@ -898,7 +930,7 @@
  * @return 1 if the node identifier refers to a usable node,
  *         0 otherwise.
  */
-#define DT_HAS_NODE_STATUS_OKAY(node_id) IS_ENABLED(DT_CAT(node_id, _EXISTS))
+#define DT_HAS_NODE_STATUS_OKAY(node_id) DT_NODE_HAS_STATUS(node_id, okay)
 
 /**
  * @brief Does the devicetree have any usable nodes with a compatible?

scripts/dts/gen_defines.py

@@ -241,6 +241,7 @@ def write_special_props(node):
     write_regs(node)
     write_interrupts(node)
     write_compatibles(node)
+    write_status(node)
 
 
 def write_regs(node):
@@ -356,6 +357,21 @@ def write_compatibles(node):
             f"{node.z_path_id}_COMPAT_MATCHES_{str2ident(compat)}", 1)
 
 
+def write_status(node):
+    # Writes a macro that we can utilize to test the "status" of a node
+    # We normalize status = "ok" to "okay", and if there is no "status"
+    # property we treat that as "okay"
+
+    if "status" in node.props:
+        status = node.props["status"].val
+        if status == "ok":
+            status = "okay"
+    else:
+        status = "okay"
+
+    out_dt_define(f"{node.z_path_id}_STATUS_{status}", 1)
+
+
 def write_vanilla_props(node):
     # Writes macros for any and all properties defined in the
     # "properties" section of the binding for the node.

tests/lib/devicetree/app.overlay

@@ -75,6 +75,13 @@
 			status = "disabled";
 		};
 
+		test_no_status: intc_no_status@0 {
+			compatible = "vnd,intc";
+			reg = <0x0 0x1000>;
+			interrupt-controller;
+			#interrupt-cells = <2>;
+		};
+
 		test_nodelabel: TEST_NODELABEL_ALLCAPS: test_gpio_1: gpio@deadbeef {
 			compatible = "vnd,gpio";
 			gpio-controller;

tests/lib/devicetree/src/main.c

@@ -200,6 +200,27 @@ static void test_has_compat(void)
 	zassert_equal(compats, 0x3, "as bit array");
 }
 
+static void test_has_status(void)
+{
+	zassert_equal(DT_NODE_HAS_STATUS(DT_NODELABEL(test_gpio_1), okay),
+		      1, "vnd,gpio okay");
+	zassert_equal(DT_NODE_HAS_STATUS(DT_NODELABEL(test_gpio_1), disabled),
+		      0, "vnd,gpio not disabled");
+
+	zassert_equal(DT_NODE_HAS_STATUS(DT_NODELABEL(test_no_status), okay),
+		      1, "vnd,gpio okay");
+	zassert_equal(DT_NODE_HAS_STATUS(DT_NODELABEL(test_no_status), disabled),
+		      0, "vnd,gpio not disabled");
+
+/* Disabled for now until we generate something for non-"enabled" nodes */
+#if 0
+	zassert_equal(DT_NODE_HAS_STATUS(DT_NODELABEL(disabled_gpio), disabled),
+		      1, "vnd,disabled-compat disabled");
+	zassert_equal(DT_NODE_HAS_STATUS(DT_NODELABEL(disabled_gpio), okay),
+		      0, "vnd,disabled-compat not okay");
+#endif
+}
+
 #define TEST_I2C_DEV DT_PATH(test, i2c_11112222, test_i2c_dev_10)
 #define TEST_I2C_BUS DT_BUS(TEST_I2C_DEV)
 
@@ -1381,6 +1402,7 @@ void test_main(void)
 			 ztest_unit_test(test_inst_checks),
 			 ztest_unit_test(test_has_nodelabel),
 			 ztest_unit_test(test_has_compat),
+			 ztest_unit_test(test_has_status),
 			 ztest_unit_test(test_bus),
 			 ztest_unit_test(test_reg),
 			 ztest_unit_test(test_irq),