regulator: npm1300: convert regulator GPIOs to array

Convert the enable, pwm, and retention `gpios` properties away from the
GPIO specifier space to an integer array.

While this is a less specific type than the GPIO property, it has the
advantage of not requiring the PMIC gpios node to be both present and
enabled.

Signed-off-by: Jordan Yates <[email protected]>

Author: JordanYates

doc/releases/migration-guide-4.2.rst

@@ -114,6 +114,15 @@ DMA
 * Renamed the devicetree property ``nxp,a_on`` to ``nxp,a-on``.
 * Renamed the devicetree property ``dma_channels`` to ``dma-channels``.
 
+Regulator
+=========
+
+* :dtcompatible:`nordic,npm1300-regulator` BUCK and LDO node GPIO properties are now specified as an
+  integer array without a GPIO controller, removing the requirement for a
+  :dtcompatible:`nordic,npm1300-gpio` node to be present and enabled for GPIO control of the output
+  rails. For example, ``enable-gpios = <&pmic_gpios 3 GPIO_ACTIVE_LOW>;`` is now specified as
+  ``enable-gpio-config = <3 GPIO_ACTIVE_LOW>;``.
+
 Counter
 =======
 

drivers/regulator/regulator_npm1300.c

@@ -73,6 +73,13 @@ enum npm1300_gpio_type {
 #define LDSW2_SOFTSTART_MASK  0x30U
 #define LDSW2_SOFTSTART_SHIFT 4U
 
+#define NPM1300_GPIO_UNUSED UINT8_MAX
+
+struct npm1300_gpio_info {
+	uint8_t pin;
+	bool invert;
+};
+
 struct regulator_npm1300_pconfig {
 	const struct device *mfd;
 	struct gpio_dt_spec dvs_state_pins[5];
@@ -83,9 +90,9 @@ struct regulator_npm1300_config {
 	const struct device *mfd;
 	uint8_t source;
 	int32_t retention_uv;
-	struct gpio_dt_spec enable_gpios;
-	struct gpio_dt_spec retention_gpios;
-	struct gpio_dt_spec pwm_gpios;
+	struct npm1300_gpio_info enable_gpios;
+	struct npm1300_gpio_info retention_gpios;
+	struct npm1300_gpio_info pwm_gpios;
 	uint8_t soft_start;
 	bool ldo_disable_workaround;
 };
@@ -407,22 +414,24 @@ int regulator_npm1300_disable(const struct device *dev)
 	}
 }
 
-static int regulator_npm1300_set_buck_pin_ctrl(const struct device *dev, uint8_t chan, uint8_t pin,
-					       uint8_t inv, enum npm1300_gpio_type type)
+static int regulator_npm1300_set_buck_pin_ctrl(const struct device *dev, uint8_t chan,
+					       const struct npm1300_gpio_info *pin_info,
+					       enum npm1300_gpio_type type)
 {
 	const struct regulator_npm1300_config *config = dev->config;
+	uint8_t inv = pin_info->invert ? 1 : 0;
 	uint8_t ctrl;
 	uint8_t mask;
 
 	switch (chan) {
 	case 0:
 		/* Invert control in bit 6, pin control in bits 2-0 */
-		ctrl = (inv << 6U) | (pin + 1U);
+		ctrl = (inv << 6U) | (pin_info->pin + 1U);
 		mask = BIT(6U) | BIT_MASK(3U);
 		break;
 	case 1:
 		/* Invert control in bit 7, pin control in bits 5-3 */
-		ctrl = (inv << 7U) | ((pin + 1U) << 3U);
+		ctrl = (inv << 7U) | ((pin_info->pin + 1U) << 3U);
 		mask = BIT(7U) | (BIT_MASK(3U) << 3U);
 		break;
 	default:
@@ -444,42 +453,41 @@ static int regulator_npm1300_set_buck_pin_ctrl(const struct device *dev, uint8_t
 	}
 }
 
-static int regulator_npm1300_set_ldsw_pin_ctrl(const struct device *dev, uint8_t chan, uint8_t pin,
-					       uint8_t inv, enum npm1300_gpio_type type)
+static int regulator_npm1300_set_ldsw_pin_ctrl(const struct device *dev, uint8_t chan,
+					       const struct npm1300_gpio_info *pin_info,
+					       enum npm1300_gpio_type type)
 {
 	const struct regulator_npm1300_config *config = dev->config;
+	uint8_t inv = pin_info->invert ? 1 : 0;
 	uint8_t ctrl;
 
 	if (type != NPM1300_GPIO_TYPE_ENABLE) {
 		return -ENOTSUP;
 	}
 
-	ctrl = (pin + 1U) | (inv << 3U);
+	ctrl = (pin_info->pin + 1U) | (inv << 3U);
 
 	return mfd_npm1300_reg_write(config->mfd, LDSW_BASE, LDSW_OFFSET_GPISEL + chan, ctrl);
 }
 
-int regulator_npm1300_set_pin_ctrl(const struct device *dev, const struct gpio_dt_spec *spec,
+int regulator_npm1300_set_pin_ctrl(const struct device *dev, const struct npm1300_gpio_info *info,
 				   enum npm1300_gpio_type type)
 {
 	const struct regulator_npm1300_config *config = dev->config;
-	uint8_t inv;
 
-	if (spec->port == NULL) {
+	if (info->pin == NPM1300_GPIO_UNUSED) {
 		return 0;
 	}
 
-	inv = (spec->dt_flags & GPIO_ACTIVE_LOW) != 0U;
-
 	switch (config->source) {
 	case NPM1300_SOURCE_BUCK1:
-		return regulator_npm1300_set_buck_pin_ctrl(dev, 0, spec->pin, inv, type);
+		return regulator_npm1300_set_buck_pin_ctrl(dev, 0, info, type);
 	case NPM1300_SOURCE_BUCK2:
-		return regulator_npm1300_set_buck_pin_ctrl(dev, 1, spec->pin, inv, type);
+		return regulator_npm1300_set_buck_pin_ctrl(dev, 1, info, type);
 	case NPM1300_SOURCE_LDO1:
-		return regulator_npm1300_set_ldsw_pin_ctrl(dev, 0, spec->pin, inv, type);
+		return regulator_npm1300_set_ldsw_pin_ctrl(dev, 0, info, type);
 	case NPM1300_SOURCE_LDO2:
-		return regulator_npm1300_set_ldsw_pin_ctrl(dev, 1, spec->pin, inv, type);
+		return regulator_npm1300_set_ldsw_pin_ctrl(dev, 1, info, type);
 	default:
 		return -ENODEV;
 	}
@@ -661,7 +669,16 @@ static DEVICE_API(regulator, api) = {
 	.set_mode = regulator_npm1300_set_mode,
 };
 
+#define GPIO_CONFIG_DEFINE(node_id, prop)                                                          \
+	COND_CODE_1(DT_NODE_HAS_PROP(node_id, prop),                                               \
+		    ({DT_PROP_BY_IDX(node_id, prop, 0),                                            \
+		      !!(DT_PROP_BY_IDX(node_id, prop, 1) & GPIO_ACTIVE_LOW)}),                    \
+		    ({NPM1300_GPIO_UNUSED, false}))
+
 #define REGULATOR_NPM1300_DEFINE(node_id, id, _source)                                             \
+	BUILD_ASSERT(DT_PROP_LEN_OR(node_id, enable_gpio_config, 2) == 2);                         \
+	BUILD_ASSERT(DT_PROP_LEN_OR(node_id, retention_gpio_config, 2) == 2);                      \
+	BUILD_ASSERT(DT_PROP_LEN_OR(node_id, pwm_gpio_config, 2) == 2);                            \
 	static struct regulator_npm1300_data data_##id;                                            \
                                                                                                    \
 	static const struct regulator_npm1300_config config_##id = {                               \
@@ -670,9 +687,9 @@ static DEVICE_API(regulator, api) = {
 		.source = _source,                                                                 \
 		.retention_uv = DT_PROP_OR(node_id, retention_microvolt, 0),                       \
 		.soft_start = DT_ENUM_IDX_OR(node_id, soft_start_microamp, UINT8_MAX),             \
-		.enable_gpios = GPIO_DT_SPEC_GET_OR(node_id, enable_gpios, {0}),                   \
-		.retention_gpios = GPIO_DT_SPEC_GET_OR(node_id, retention_gpios, {0}),             \
-		.pwm_gpios = GPIO_DT_SPEC_GET_OR(node_id, pwm_gpios, {0}),                         \
+		.enable_gpios = GPIO_CONFIG_DEFINE(node_id, enable_gpio_config),                   \
+		.retention_gpios = GPIO_CONFIG_DEFINE(node_id, retention_gpio_config),             \
+		.pwm_gpios = GPIO_CONFIG_DEFINE(node_id, pwm_gpio_config),                         \
 		.ldo_disable_workaround = DT_PROP(node_id, nordic_anomaly38_disable_workaround)};  \
                                                                                                    \
 	DEVICE_DT_DEFINE(node_id, regulator_npm1300_init, NULL, &data_##id, &config_##id,          \

dts/bindings/regulator/nordic,npm1300-regulator.yaml

@@ -70,22 +70,22 @@ child-binding:
       description: |
         Retention mode voltage in microvolts.
 
-    enable-gpios:
-      type: phandle-array
+    enable-gpio-config:
+      type: array
       description: |
-        Regulator enable controlled by specified regulator GPIO pin.
+        Regulator enable controlled by specified GPIO pin <idx flags>.
         When set regulator must be enabled/disabled using set_dvs_mode.
 
-    pwm-gpios:
-      type: phandle-array
+    pwm-gpio-config:
+      type: array
       description: |
-        Regulator enable controlled by specified regulator GPIO pin.
+        Regulator enable controlled by specified GPIO pin <idx flags>.
         When set regulator must be enabled/disabled using set_dvs_mode.
 
-    retention-gpios:
-      type: phandle-array
+    retention-gpio-config:
+      type: array
       description: |
-        Retention mode controlled by specified regulator GPIO pin.
+        Retention mode controlled by specified GPIO pin <idx flags>.
 
     soft-start-microamp:
       type: int