dts: nxp: Add sleep-output property

This property allows a user to specify the operation of a
pin in sleep mode.
By default, pins are configured to be output low in sleep mode.

Signed-off-by: Mahesh Mahadevan <[email protected]>

Author: mmahadevan108

drivers/pinctrl/pinctrl_mci_io_mux.c

@@ -1,12 +1,14 @@
 /*
- * Copyright 2022 NXP
+ * Copyright 2022, 2025 NXP
  *
  * SPDX-License-Identifier: Apache-2.0
  */
 
 #include <zephyr/drivers/pinctrl.h>
 #include <soc.h>
 
+#define NO_FORCE_OUTPUT 2
+
 static MCI_IO_MUX_Type *mci_iomux =
 	(MCI_IO_MUX_Type *)DT_REG_ADDR(DT_NODELABEL(pinctrl));
 
@@ -59,6 +61,19 @@ static void configure_pin_props(uint32_t pin_mux, uint8_t gpio_idx)
 	/* Set slew rate */
 	set = IOMUX_PAD_GET_SLEW(pin_mux) << ((gpio_idx & 0xF) << 1);
 	*slew_reg = (*slew_reg & ~mask) | set;
+
+	/* Set sleep force enable bit */
+	mask = (0x1 << (gpio_idx & 0x1F));
+	/* Check if we should force the pin to output in sleep mode */
+	if (IOMUX_PAD_GET_SLEEP_FORCE(pin_mux) == NO_FORCE_OUTPUT) {
+		/* Does not force output during sleep */
+		*sleep_force_en = (*sleep_force_en & ~mask);
+	} else {
+		/* Enable forcing output during sleep */
+		*sleep_force_en = (*sleep_force_en | mask);
+		set = (IOMUX_PAD_GET_SLEEP_FORCE_VAL(pin_mux) << (gpio_idx & 0x1F));
+		*sleep_force_val = (*sleep_force_val & ~mask) | set;
+	}
 }
 
 static void select_gpio_mode(uint8_t gpio_idx)

dts/bindings/pinctrl/nxp,mci-io-mux.yaml

@@ -69,3 +69,15 @@ child-binding:
           1 - normal slew rate
           2 - fast slew rate
           3 - fastest slew rate (ultra)
+      sleep-output:
+        type: string
+        default: "low"
+        enum:
+          - "low"
+          - "high"
+          - "disable"
+        description: |
+          Sets pin output level in sleep mode.
+          0 - output level low
+          1 - output level high
+          2 - disable force output in sleep mode.

soc/nxp/rw/pinctrl_defs.h

@@ -74,11 +74,10 @@
 /* Pin configuration settings */
 #define IOMUX_PAD_PULL(x) (((x) & 0x3) << 19)
 #define IOMUX_PAD_SLEW(x) (((x) & 0x3) << 21)
-#define IOMUX_PAD_SLEEP_FORCE(en, val) \
-	((((en) & 0x1) << 24) | (((val) & 0x1) << 23))
+#define IOMUX_PAD_SLEEP_FORCE(en) (((en) & 0x3) << 23)
 #define IOMUX_PAD_GET_PULL(mux) (((mux) >> 19) & 0x3)
 #define IOMUX_PAD_GET_SLEW(mux) (((mux) >> 21) & 0x3)
-#define IOMUX_PAD_GET_SLEEP_FORCE_EN(mux) (((mux) >> 24) & 0x1)
+#define IOMUX_PAD_GET_SLEEP_FORCE(mux) (((mux) >> 23) & 0x3)
 #define IOMUX_PAD_GET_SLEEP_FORCE_VAL(mux) (((mux) >> 23) & 0x1)
 
 /*

soc/nxp/rw/pinctrl_soc.h

@@ -20,17 +20,15 @@ extern "C" {
 
 typedef uint32_t pinctrl_soc_pin_t;
 
-
-#define Z_PINCTRL_IOMUX_PINCFG(node_id)						\
-	(IF_ENABLED(DT_PROP(node_id, bias_pull_down),				\
-	(IOMUX_PAD_PULL(0x2) |)) /* pull down */				\
-	IF_ENABLED(DT_PROP(node_id, bias_pull_up),				\
-	(IOMUX_PAD_PULL(0x1) |)) /* pull up */					\
-	IF_ENABLED(DT_NODE_HAS_PROP(node_id, sleep_output), /* force output */	\
-	IOMUX_PAD_SLEEP_FORCE(0x1, DT_ENUM_IDX(node_id, sleep_output)))		\
+#define Z_PINCTRL_IOMUX_PINCFG(node_id)								\
+	(IF_ENABLED(DT_PROP(node_id, bias_pull_down),						\
+	(IOMUX_PAD_PULL(0x2) |)) /* pull down */						\
+	IF_ENABLED(DT_PROP(node_id, bias_pull_up),						\
+	(IOMUX_PAD_PULL(0x1) |)) /* pull up */							\
+	IF_ENABLED(DT_NODE_HAS_PROP(node_id, sleep_output),					\
+	(IOMUX_PAD_SLEEP_FORCE(DT_ENUM_IDX(node_id, sleep_output)) |)) /* force output */	\
 	IOMUX_PAD_SLEW(DT_ENUM_IDX(node_id, slew_rate))) /* slew rate */
 
-
 #define Z_PINCTRL_STATE_PIN_INIT(group, pin_prop, idx)		\
 	DT_PROP_BY_IDX(group, pin_prop, idx) | Z_PINCTRL_IOMUX_PINCFG(group),