drivers: regulator: add regulator shell

Add shell for interacting with regulator devices, to enable
users to test power management settings quickly and verify that their
regulator is functioning as expected. Also allows users to interact with
regulator PMIC devices

Signed-off-by: Daniel DeGrasse <[email protected]>

Author: danieldegrasse

drivers/regulator/CMakeLists.txt

@@ -5,3 +5,4 @@ zephyr_library()
 
 zephyr_library_sources_ifdef(CONFIG_REGULATOR_FIXED regulator_fixed.c)
 zephyr_library_sources_ifdef(CONFIG_REGULATOR_PMIC regulator_pmic.c)
+zephyr_library_sources_ifdef(CONFIG_REGULATOR_SHELL regulator_shell.c)

drivers/regulator/Kconfig

@@ -9,6 +9,14 @@ menuconfig REGULATOR
 
 if REGULATOR
 
+config REGULATOR_SHELL
+	bool "Regulator shell"
+	default y
+	depends on SHELL
+	help
+	  Enable regulator shell framework, for interacting with regulators via
+	  the shell interface
+
 module = REGULATOR
 module-str = regulator
 source "subsys/logging/Kconfig.template.log_config"

drivers/regulator/Kconfig.pmic

@@ -11,8 +11,8 @@ config REGULATOR_PMIC
 
 config PMIC_REGULATOR_INIT_PRIORITY
 	int "Regulator Init priority"
-	depends on REGULATOR_PMIC
 	default 75
+	depends on REGULATOR_PMIC
 	help
 	  I2C based regulator init priority.
 	  Must be greater than KERNEL_INIT_PRIORITY_DEVICE so I2C is initialized,

drivers/regulator/regulator_shell.c

@@ -0,0 +1,142 @@
+/*
+ * Copyright 2022 NXP
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/kernel.h>
+#include <zephyr/shell/shell.h>
+#include <zephyr/drivers/uart.h>
+#include <zephyr/drivers/regulator.h>
+#if CONFIG_REGULATOR_PMIC
+#include <zephyr/drivers/regulator/consumer.h>
+#endif
+
+LOG_MODULE_REGISTER(regulator_shell, CONFIG_REGULATOR_LOG_LEVEL);
+
+static int cmd_reg_en(const struct shell *sh, size_t argc, char **argv)
+{
+	struct onoff_client cli;
+	const struct device *reg_dev;
+	int ret;
+
+	reg_dev = device_get_binding(argv[1]);
+	if (!device_is_ready(reg_dev)) {
+		shell_error(sh, "regulator device %s not available", argv[1]);
+		return -ENODEV;
+	}
+
+	ret = regulator_enable(reg_dev, &cli);
+	if (ret < 0) {
+		shell_error(sh, "failed to enable regulator, error %d", ret);
+		return ret;
+	}
+	shell_print(sh, "enabled regulator");
+	return 0;
+}
+
+
+static int cmd_reg_dis(const struct shell *sh, size_t argc, char **argv)
+{
+	const struct device *reg_dev;
+	int ret;
+
+	reg_dev = device_get_binding(argv[1]);
+	if (!device_is_ready(reg_dev)) {
+		shell_error(sh, "regulator device %s not available", argv[1]);
+		return -ENODEV;
+	}
+
+	ret = regulator_disable(reg_dev);
+	if (ret < 0) {
+		shell_error(sh, "failed  to disable regulator, error %d", ret);
+		return ret;
+	}
+	shell_print(sh, "disabled regulator");
+	return 0;
+}
+
+
+#if CONFIG_REGULATOR_PMIC
+static int cmd_pmic_set_vol(const struct shell *sh, size_t argc, char **argv)
+{
+	int lvol, uvol, ret;
+	const struct device *reg_dev;
+
+	reg_dev = device_get_binding(argv[1]);
+	if (!device_is_ready(reg_dev)) {
+		shell_error(sh, "regulator device %s not available", argv[1]);
+		return -ENODEV;
+	}
+
+	lvol = atoi(argv[2]) * 1000;
+	uvol = atoi(argv[3]) * 1000;
+	shell_print(sh, "Setting range to %d-%d uV", lvol, uvol);
+	ret = regulator_set_voltage(reg_dev, lvol, uvol);
+	if (ret < 0) {
+		shell_error(sh, "failed to set voltage, error %d", ret);
+		return ret;
+	}
+	ret = regulator_get_voltage(reg_dev);
+	if (ret < 0) {
+		shell_error(sh, "failed to read voltage, error %d", ret);
+		return ret;
+	}
+	shell_print(sh, "set voltage to %d uV", ret);
+	return 0;
+}
+
+static int cmd_pmic_set_ilim(const struct shell *sh, size_t argc, char **argv)
+{
+	int lcur, ucur, ret;
+	const struct device *reg_dev;
+
+	reg_dev = device_get_binding(argv[1]);
+	if (!device_is_ready(reg_dev)) {
+		shell_error(sh, "regulator device %s not available", argv[1]);
+		return -ENODEV;
+	}
+
+	lcur = atoi(argv[2]) * 1000;
+	ucur = atoi(argv[3]) * 1000;
+	shell_print(sh, "Setting range to %d-%d uA", lcur, ucur);
+	ret = regulator_set_current_limit(reg_dev, lcur, ucur);
+	if (ret < 0) {
+		shell_error(sh, "failed to set current, error %d", ret);
+		return ret;
+	}
+	ret = regulator_get_current_limit(reg_dev);
+	if (ret < 0) {
+		shell_error(sh, "failed to read current, error %d", ret);
+		return ret;
+	}
+	shell_print(sh, "set current limit to %d uA", ret);
+	return 0;
+}
+
+SHELL_STATIC_SUBCMD_SET_CREATE(pmic_set,
+	SHELL_CMD_ARG(set_vol, NULL, "Set voltage (in mV)\n"
+		"Usage: set_vol <device> <low limit (uV)> <high limit (uV)>",
+		cmd_pmic_set_vol, 4, 0),
+	SHELL_CMD_ARG(set_current, NULL, "Set current limit( in mA)\n"
+		"Usage: set_current <device> <low limit (uA)> <high limit (uA)>",
+		cmd_pmic_set_ilim, 4, 0),
+	SHELL_SUBCMD_SET_END
+);
+
+#endif /* CONFIG_REGULATOR_PMIC */
+
+SHELL_STATIC_SUBCMD_SET_CREATE(regulator_set,
+	SHELL_CMD_ARG(enable, NULL,
+		"Enable regulator\n"
+		"Usage: enable <device>", cmd_reg_en, 2, 0),
+	SHELL_CMD_ARG(disable, NULL,
+		"Disable regulator\n"
+		"Usage: disable <device>", cmd_reg_dis, 2, 0),
+#if CONFIG_REGULATOR_PMIC
+	SHELL_CMD(pmic, &pmic_set, "PMIC management", NULL),
+#endif
+	SHELL_SUBCMD_SET_END
+);
+
+SHELL_CMD_REGISTER(regulator, &regulator_set, "Regulator Management", NULL);