zephyr/drivers/pwm/pwm_shell.c
Gerard Marull-Paretas 667eeb11fb shell: fix MISRA 5.7 violations on struct shell
MISRA Rule 5.7 requires uniqueness of tag identifiers. Shell is
frequently problematic because many code uses `const struct shell
*shell`. This causes CI noise every time one of these shell files is
edited, so let's update all of them with `const struct shell *sh`
instead.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-04-14 12:21:08 +02:00

140 lines
3.1 KiB
C

/*
* Copyright (c) 2019 Vestas Wind Systems A/S
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief PWM shell commands.
*/
#include <zephyr/shell/shell.h>
#include <zephyr/drivers/pwm.h>
#include <stdlib.h>
struct args_index {
uint8_t device;
uint8_t channel;
uint8_t period;
uint8_t pulse;
uint8_t flags;
};
static const struct args_index args_indx = {
.device = 1,
.channel = 2,
.period = 3,
.pulse = 4,
.flags = 5,
};
static int cmd_cycles(const struct shell *sh, size_t argc, char **argv)
{
pwm_flags_t flags = 0;
const struct device *dev;
uint32_t period;
uint32_t pulse;
uint32_t channel;
int err;
dev = device_get_binding(argv[args_indx.device]);
if (!dev) {
shell_error(sh, "PWM device not found");
return -EINVAL;
}
channel = strtoul(argv[args_indx.channel], NULL, 0);
period = strtoul(argv[args_indx.period], NULL, 0);
pulse = strtoul(argv[args_indx.pulse], NULL, 0);
if (argc == (args_indx.flags + 1)) {
flags = strtoul(argv[args_indx.flags], NULL, 0);
}
err = pwm_set_cycles(dev, channel, period, pulse, flags);
if (err) {
shell_error(sh, "failed to setup PWM (err %d)",
err);
return err;
}
return 0;
}
static int cmd_usec(const struct shell *sh, size_t argc, char **argv)
{
pwm_flags_t flags = 0;
const struct device *dev;
uint32_t period;
uint32_t pulse;
uint32_t channel;
int err;
dev = device_get_binding(argv[args_indx.device]);
if (!dev) {
shell_error(sh, "PWM device not found");
return -EINVAL;
}
channel = strtoul(argv[args_indx.channel], NULL, 0);
period = strtoul(argv[args_indx.period], NULL, 0);
pulse = strtoul(argv[args_indx.pulse], NULL, 0);
if (argc == (args_indx.flags + 1)) {
flags = strtoul(argv[args_indx.flags], NULL, 0);
}
err = pwm_set(dev, channel, PWM_USEC(period), PWM_USEC(pulse), flags);
if (err) {
shell_error(sh, "failed to setup PWM (err %d)", err);
return err;
}
return 0;
}
static int cmd_nsec(const struct shell *sh, size_t argc, char **argv)
{
pwm_flags_t flags = 0;
const struct device *dev;
uint32_t period;
uint32_t pulse;
uint32_t channel;
int err;
dev = device_get_binding(argv[args_indx.device]);
if (!dev) {
shell_error(sh, "PWM device not found");
return -EINVAL;
}
channel = strtoul(argv[args_indx.channel], NULL, 0);
period = strtoul(argv[args_indx.period], NULL, 0);
pulse = strtoul(argv[args_indx.pulse], NULL, 0);
if (argc == (args_indx.flags + 1)) {
flags = strtoul(argv[args_indx.flags], NULL, 0);
}
err = pwm_set(dev, channel, period, pulse, flags);
if (err) {
shell_error(sh, "failed to setup PWM (err %d)", err);
return err;
}
return 0;
}
SHELL_STATIC_SUBCMD_SET_CREATE(pwm_cmds,
SHELL_CMD_ARG(cycles, NULL, "<device> <channel> <period in cycles> "
"<pulse width in cycles> [flags]", cmd_cycles, 5, 1),
SHELL_CMD_ARG(usec, NULL, "<device> <channel> <period in usec> "
"<pulse width in usec> [flags]", cmd_usec, 5, 1),
SHELL_CMD_ARG(nsec, NULL, "<device> <channel> <period in nsec> "
"<pulse width in nsec> [flags]", cmd_nsec, 5, 1),
SHELL_SUBCMD_SET_END
);
SHELL_CMD_REGISTER(pwm, &pwm_cmds, "PWM shell commands", NULL);