pwm: opencores: Add PWM driver support
PATCH v15 1/1 pwm: opencores: Add PWM driver support
Add driver for OpenCores PWM Controller. And add compatibility code which based on StarFive SoC.
--- MAINTAINERS | 7 ++ drivers/pwm/Kconfig | 12 ++ drivers/pwm/Makefile | 1 + drivers/pwm/pwm-ocores.c | 241 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 261 insertions(+) create mode 100644 drivers/pwm/pwm-ocores.c
MAINTAINERS +7 -0
@@ -17148,6 +17148,13 @@ F: Documentation/i2c/busses/i2c-ocores.rst F: drivers/i2c/busses/i2c-ocores.c F: include/linux/platform_data/i2c-ocores.h +OPENCORES PWM DRIVER +M: William Qiu <[email protected]> +M: Hal Feng <[email protected]> +S: Supported +F: Documentation/devicetree/bindings/pwm/opencores,pwm.yaml +F: drivers/pwm/pwm-ocores.c + OPENRISC ARCHITECTURE M: Jonas Bonn <[email protected]> M: Stefan Kristiansson <[email protected]>
drivers/pwm/Kconfig +12 -0
@@ -464,6 +464,18 @@ config PWM_NTXEC controller found in certain e-book readers designed by the original design manufacturer Netronix. +config PWM_OCORES + tristate "OpenCores PTC PWM support" + depends on HAS_IOMEM && OF + depends on COMMON_CLK + depends on ARCH_STARFIVE || COMPILE_TEST + help + If you say yes to this option, support will be included for the + OpenCores PWM. For details see https://opencores.org/projects/ptc. + + To compile this driver as a module, choose M here: the module + will be called pwm-ocores. + config PWM_OMAP_DMTIMER tristate "OMAP Dual-Mode Timer PWM support" depends on OF
drivers/pwm/Makefile +1 -0
@@ -41,6 +41,7 @@ obj-$(CONFIG_PWM_MICROCHIP_CORE) += pwm-microchip-core.o obj-$(CONFIG_PWM_MTK_DISP) += pwm-mtk-disp.o obj-$(CONFIG_PWM_MXS) += pwm-mxs.o obj-$(CONFIG_PWM_NTXEC) += pwm-ntxec.o +obj-$(CONFIG_PWM_OCORES) += pwm-ocores.o obj-$(CONFIG_PWM_OMAP_DMTIMER) += pwm-omap-dmtimer.o obj-$(CONFIG_PWM_PCA9685) += pwm-pca9685.o obj-$(CONFIG_PWM_PXA) += pwm-pxa.o
drivers/pwm/pwm-ocores.c new file +241 -0
241 lines not on this page · raw message
Signature · 1 line
2.34.1
Hello William,
Quoted 9 lines · William Qiu
drivers/pwm/pwm-ocores.c new file +3
-0@@ -0,0 +1,241 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* OpenCores PWM Driver
drivers/pwm/pwm-ocores.c line 13
Quoted 10 lines
drivers/pwm/pwm-ocores.c new file +10
-0+* +* https://opencores.org/projects/ptc +* +* Copyright (C) 2018-2023 StarFive Technology Co., Ltd. +* +* Limitations: +* - The hardware only supports inverted polarity. +* - The hardware minimum period / duty_cycle is (1 / pwm_apb clock frequency). +* - The hardware maximum period / duty_cycle is (U32_MAX / pwm_apb clock frequency). +* - The output is set to a low level immediately when disabled.
Huh, that's a 100% relative duty cycle. But fine, that gives the opportunity to find bugs in consumer drivers. :-)
drivers/pwm/pwm-ocores.c line 81
Quoted 13 lines
drivers/pwm/pwm-ocores.c new file +10
-0+* - When configuration changes are done, they get active immediately without resetting +* the counter. This might result in one period affected by both old and new settings. +*/ + +static inline void ocores_pwm_writel(struct ocores_pwm_device *ddata, + unsigned int channel, + unsigned int offset, u32 val) +static inline struct ocores_pwm_device *chip_to_ocores(struct pwm_chip *chip) +static void __iomem *starfive_get_ch_base(void __iomem *base, +unsigned int channel)
Would be great if all functions had the same prefix. This simplifies debugging with tracing, because you can just enable traces for "ocores_pwm_*".
Quoted 10 lines
[...]
drivers/pwm/pwm-ocores.c new file +9
-0+static int ocores_pwm_apply (struct pwm_chip *chip, +struct pwm_device *pwm, +const struct pwm_state *state) +{ +struct ocores_pwm_device *ddata =chip_to_ocores (chip); +u32 ctrl_data =0 ; +u64 period_data, duty_data; + +if (state->polarity !=PWM_POLARITY_INVERSED )
drivers/pwm/pwm-ocores.c line 125
Quoted 10 lines
drivers/pwm/pwm-ocores.c new file +10
-0+return -EINVAL ; + + period_data =mul_u64_u32_div (state->period, ddata->clk_rate,NSEC_PER_SEC ); +if (!period_data) +return -EINVAL ; + +if (period_data >U32_MAX ) + period_data =U32_MAX ; + +ocores_pwm_writel (ddata, pwm->hwpwm,REG_OCPWM_LRC , (u32 )period_data);
The cast isn't needed.
drivers/pwm/pwm-ocores.c line 134
Quoted 8 lines
drivers/pwm/pwm-ocores.c new file +8
-0+ duty_data =mul_u64_u32_div (state->duty_cycle, ddata->clk_rate,NSEC_PER_SEC ); +if (!duty_data) +return -EINVAL ; + +if (duty_data >U32_MAX ) + duty_data =U32_MAX ; + +ocores_pwm_writel (ddata, pwm->hwpwm,REG_OCPWM_HRC , (u32 )duty_data);
ditto.
drivers/pwm/pwm-ocores.c line 142
Quoted 7 lines
drivers/pwm/pwm-ocores.c new file +7
-0+ ctrl_data =ocores_pwm_readl (ddata, pwm->hwpwm,REG_OCPWM_CTRL ); +if (state->enabled) +ocores_pwm_writel (ddata, pwm->hwpwm,REG_OCPWM_CTRL , + ctrl_data |REG_OCPWM_CNTR_EN |REG_OCPWM_CNTR_OE ); +else +ocores_pwm_writel (ddata, pwm->hwpwm,REG_OCPWM_CTRL , + ctrl_data & ~(REG_OCPWM_CNTR_EN |REG_OCPWM_CNTR_OE ));
If you're clearing REG_OCPWM_CNTR_OE (Output Enable?), does the output really go low? Or is that due to an external pull down on your board?
Quoted 7 lines
drivers/pwm/pwm-ocores.c new file +6
-0+ +return 0 ; +} +static int ocores_pwm_probe (struct platform_device *pdev) +{ +const struct of_device_id *id;
drivers/pwm/pwm-ocores.c line 181
Quoted 10 lines
drivers/pwm/pwm-ocores.c new file +10
-0+struct device *dev = &pdev->dev; +struct ocores_pwm_device *ddata; +struct pwm_chip *chip; +struct clk *clk; +struct reset_control *rst; +int ret; + + id =of_match_device (ocores_pwm_of_match, dev); +if (!id) +return -EINVAL ;
Error message here? Better use device_get_match_data() here. Then you don't need the of-specific headers (IIUC).
Quoted 24 lines
drivers/pwm/pwm-ocores.c new file +24
-0+ chip =devm_pwmchip_alloc (&pdev->dev,8 ,sizeof (*ddata)); +if (IS_ERR (chip)) +return -ENOMEM ; + + ddata =chip_to_ocores (chip); + ddata->data = id->data; + chip->ops = &ocores_pwm_ops; + + ddata->regs =devm_platform_ioremap_resource (pdev,0 ); +if (IS_ERR (ddata->regs)) +return dev_err_probe (dev,PTR_ERR (ddata->regs), +"Unable to map IO resources\n" ); + + clk =devm_clk_get_enabled (dev,NULL ); +if (IS_ERR (clk)) +return dev_err_probe (dev,PTR_ERR (clk), +"Unable to get pwm's clock\n" ); + + ret =devm_clk_rate_exclusive_get (dev, clk); +if (ret) +return ret; + + rst =devm_reset_control_get_optional_exclusive (dev,NULL ); +if (IS_ERR (rst))
drivers/pwm/pwm-ocores.c line 216
Quoted 10 lines
drivers/pwm/pwm-ocores.c new file +10
-0+return dev_err_probe (dev,PTR_ERR (rst), +"Unable to get pwm's reset\n" ); + + ret =reset_control_deassert (rst); +if (ret) +return ret; + + ret =devm_add_action_or_reset (dev, ocores_pwm_reset_control_assert, rst); +if (ret) +return ret;
If you respin anyhow, switch to devm_reset_control_get_optional_exclusive_deasserted(). Up to now this only exists in next, but I'd care to apply this is a way that doesn't fail to build then.
drivers/pwm/pwm-ocores.c line 227
Quoted 10 lines
drivers/pwm/pwm-ocores.c new file +10
-0+ ddata->clk_rate =clk_get_rate (clk); +if (ddata->clk_rate >NSEC_PER_SEC ) +return -EINVAL ; + + ret =devm_pwmchip_add (dev, chip); +if (ret <0 ) +return dev_err_probe (dev, ret,"Could not register PWM chip\n" ); + +return 0 ; +}
Best regards
Uwe