RZ/G2L General PWM Timer (GPT) composed of 8 channels with 32-bit timer (GPT32E). It supports the following functions * 32 bits × 8 channels * Up-counting or down-counting (saw waves) or up/down-counting (triangle waves) for each counter. * Clock sources independently selectable for each channel * Two I/O pins per channel * Two output compare/input capture registers per channel * For the two output compare/input capture registers of each channel, four registers are provided as buffer registers and are capable of operating as comparison registers when buffering is not in use. * In output compare operation, buffer switching can be at crests or troughs, enabling the generation of laterally asymmetric PWM waveforms. * Registers for setting up frame cycles in each channel (with capability for generating interrupts at overflow or underflow) * Generation of dead times in PWM operation * Synchronous starting, stopping and clearing counters for arbitrary channels * Starting, stopping, clearing and up/down counters in response to input level comparison * Starting, clearing, stopping and up/down counters in response to a maximum of four external triggers * Output pin disable function by dead time error and detected short-circuits between output pins * A/D converter start triggers can be generated (GPT32E0 to GPT32E3) * Enables the noise filter for input capture and external trigger operation This patch adds basic pwm support for RZ/G2L GPT driver by creating separate logical channels for each IOs. Signed-off-by: Biju Das <biju.das.jz@xxxxxxxxxxxxxx> --- v1->v2: * Added Limitations section * dropped "_MASK" from the define names. * used named initializer for struct phase * Added gpt_pwm_device into a flexible array member in rzg2l_gpt_chip * Revised the logic for prescale * Added .get_state callback * Improved error handling in rzg2l_gpt_apply * Removed .remove callback * Tested driver with PWM_DEBUG enabled RFC->V1: * Updated macros * replaced rzg2l_gpt_write_mask()->rzg2l_gpt_modify() * Added rzg2l_gpt_read() --- drivers/pwm/Kconfig | 11 ++ drivers/pwm/Makefile | 1 + drivers/pwm/pwm-rzg2l-gpt.c | 351 ++++++++++++++++++++++++++++++++++++ 3 files changed, 363 insertions(+) create mode 100644 drivers/pwm/pwm-rzg2l-gpt.c diff --git a/drivers/pwm/Kconfig b/drivers/pwm/Kconfig index 904de8d61828..a6cf24cb31e0 100644 --- a/drivers/pwm/Kconfig +++ b/drivers/pwm/Kconfig @@ -471,6 +471,17 @@ config PWM_ROCKCHIP Generic PWM framework driver for the PWM controller found on Rockchip SoCs. +config PWM_RZG2L_GPT + tristate "Renesas RZ/G2L General PWM Timer support" + depends on ARCH_RENESAS || COMPILE_TEST + depends on HAS_IOMEM + help + This driver exposes the General PWM Timer controller found in Renesas + RZ/G2L like chips through the PWM API. + + To compile this driver as a module, choose M here: the module + will be called pwm-rzg2l-gpt. + config PWM_SAMSUNG tristate "Samsung PWM support" depends on PLAT_SAMSUNG || ARCH_S5PV210 || ARCH_EXYNOS || COMPILE_TEST diff --git a/drivers/pwm/Makefile b/drivers/pwm/Makefile index 5c08bdb817b4..12bc2a005e24 100644 --- a/drivers/pwm/Makefile +++ b/drivers/pwm/Makefile @@ -43,6 +43,7 @@ obj-$(CONFIG_PWM_RASPBERRYPI_POE) += pwm-raspberrypi-poe.o obj-$(CONFIG_PWM_RCAR) += pwm-rcar.o obj-$(CONFIG_PWM_RENESAS_TPU) += pwm-renesas-tpu.o obj-$(CONFIG_PWM_ROCKCHIP) += pwm-rockchip.o +obj-$(CONFIG_PWM_RZG2L_GPT) += pwm-rzg2l-gpt.o obj-$(CONFIG_PWM_SAMSUNG) += pwm-samsung.o obj-$(CONFIG_PWM_SIFIVE) += pwm-sifive.o obj-$(CONFIG_PWM_SL28CPLD) += pwm-sl28cpld.o diff --git a/drivers/pwm/pwm-rzg2l-gpt.c b/drivers/pwm/pwm-rzg2l-gpt.c new file mode 100644 index 000000000000..f83ba2d5c219 --- /dev/null +++ b/drivers/pwm/pwm-rzg2l-gpt.c @@ -0,0 +1,351 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Renesas RZ/G2L General PWM Timer (GPT) driver + * + * Copyright (C) 2022 Renesas Electronics Corporation + * + * Limitations: + * - Mode and Prescalar must be set, while the GTCNT is stopped. + * - Configured for Output low on GTIOCx pin when counting stops. + */ + +#include <linux/bitfield.h> +#include <linux/clk.h> +#include <linux/io.h> +#include <linux/module.h> +#include <linux/of.h> +#include <linux/platform_device.h> +#include <linux/pm_runtime.h> +#include <linux/pwm.h> +#include <linux/reset.h> +#include <linux/time.h> + +#define GPT_IO_PER_CHANNEL 2 + +#define GTPR_MAX_VALUE 0xFFFFFFFF +#define GTCR 0x2c +#define GTUDDTYC 0x30 +#define GTIOR 0x34 +#define GTBER 0x40 +#define GTCNT 0x48 +#define GTCCRA 0x4c +#define GTCCRB 0x50 +#define GTPR 0x64 + +#define GTCR_CST BIT(0) +#define GTCR_MD GENMASK(18, 16) +#define GTCR_TPCS GENMASK(26, 24) + +#define GTCR_MD_SAW_WAVE_PWM_MODE FIELD_PREP(GTCR_MD, 0) + +#define GTUDDTYC_UP BIT(0) +#define GTUDDTYC_UDF BIT(1) +#define UP_COUNTING (GTUDDTYC_UP | GTUDDTYC_UDF) + +#define GTIOR_GTIOA GENMASK(4, 0) +#define GTIOR_GTIOB GENMASK(20, 16) +#define GTIOR_OAE BIT(8) +#define GTIOR_OBE BIT(24) + +#define INIT_OUT_LO_OUT_LO_END_TOGGLE 0x07 +#define INIT_OUT_HI_OUT_HI_END_TOGGLE 0x1b + +#define GTIOR_GTIOA_OUT_HI_END_TOGGLE_CMP_MATCH (INIT_OUT_HI_OUT_HI_END_TOGGLE | GTIOR_OAE) +#define GTIOR_GTIOA_OUT_LO_END_TOGGLE_CMP_MATCH (INIT_OUT_LO_OUT_LO_END_TOGGLE | GTIOR_OAE) +#define GTIOR_GTIOB_OUT_HI_END_TOGGLE_CMP_MATCH ((INIT_OUT_HI_OUT_HI_END_TOGGLE << 16) | GTIOR_OBE) +#define GTIOR_GTIOB_OUT_LO_END_TOGGLE_CMP_MATCH ((INIT_OUT_LO_OUT_LO_END_TOGGLE << 16) | GTIOR_OBE) + +struct phase { + u32 value; + u32 mask; + u32 duty_reg_offset; +}; + +static const struct phase phase_params[] = { + /* Setting for phase A */ + { + .value = GTIOR_GTIOA_OUT_HI_END_TOGGLE_CMP_MATCH, + .mask = GTIOR_GTIOA | GTIOR_OAE, + .duty_reg_offset = GTCCRA, + }, + /* Setting for phase B */ + { + .value = GTIOR_GTIOB_OUT_HI_END_TOGGLE_CMP_MATCH, + .mask = GTIOR_GTIOB | GTIOR_OBE, + .duty_reg_offset = GTCCRB, + }, +}; + +struct gpt_pwm_device { + const struct phase *ph; +}; + +struct rzg2l_gpt_chip { + struct pwm_chip chip; + void __iomem *mmio; + struct reset_control *rstc; + struct clk *clk; + struct gpt_pwm_device gpt[2]; +}; + +static inline struct rzg2l_gpt_chip *to_rzg2l_gpt_chip(struct pwm_chip *chip) +{ + return container_of(chip, struct rzg2l_gpt_chip, chip); +} + +static void rzg2l_gpt_write(struct rzg2l_gpt_chip *pc, u32 reg, u32 data) +{ + iowrite32(data, pc->mmio + reg); +} + +static u32 rzg2l_gpt_read(struct rzg2l_gpt_chip *pc, u32 reg) +{ + return ioread32(pc->mmio + reg); +} + +static void rzg2l_gpt_modify(struct rzg2l_gpt_chip *pc, u32 reg, u32 clr, u32 set) +{ + rzg2l_gpt_write(pc, reg, (rzg2l_gpt_read(pc, reg) & ~clr) | set); +} + +static u8 rzg2l_calculate_prescale(struct rzg2l_gpt_chip *pc, u64 period_cycles) +{ + u16 i, prod; + u8 prescale; + + prescale = 5; + /* prescale 1, 4, 16, 64, 256 and 1024 */ + for (i = 0; i < 6; i++) { + prod = 1 << (2 * i); + if ((period_cycles / (1ULL * GTPR_MAX_VALUE * prod)) == 0) { + prescale = i; + break; + } + } + + return prescale; +} + +static int rzg2l_gpt_request(struct pwm_chip *chip, struct pwm_device *pwm) +{ + struct rzg2l_gpt_chip *pc = to_rzg2l_gpt_chip(chip); + struct gpt_pwm_device *gpt; + + if (pwm->hwpwm >= GPT_IO_PER_CHANNEL) + return -EINVAL; + + gpt = &pc->gpt[pwm->hwpwm]; + gpt->ph = &phase_params[pwm->hwpwm]; + pwm_set_chip_data(pwm, gpt); + + pm_runtime_get_sync(chip->dev); + + return 0; +} + +static void rzg2l_gpt_free(struct pwm_chip *chip, struct pwm_device *pwm) +{ + pm_runtime_put(chip->dev); +} + +static int rzg2l_gpt_enable(struct rzg2l_gpt_chip *pc) +{ + /* Start count */ + rzg2l_gpt_modify(pc, GTCR, GTCR_CST, GTCR_CST); + + return 0; +} + +static void rzg2l_gpt_disable(struct rzg2l_gpt_chip *pc) +{ + /* Stop count, Output low on GTIOCx pin when counting stops */ + rzg2l_gpt_modify(pc, GTCR, GTCR_CST, 0); +} + +static int rzg2l_gpt_config(struct pwm_chip *chip, struct pwm_device *pwm, + u64 duty_ns, u64 period_ns) +{ + struct gpt_pwm_device *gpt = pwm_get_chip_data(pwm); + struct rzg2l_gpt_chip *pc = to_rzg2l_gpt_chip(chip); + unsigned long rate, pv, dc; + u64 period_cycles; + u8 prescale; + + rate = clk_get_rate(pc->clk); + /* + * Refuse clk rates > 1 GHz to prevent overflowing the following + * calculation. + */ + if (rate > NSEC_PER_SEC) + return -EINVAL; + + period_cycles = mul_u64_u64_div_u64(rate, period_ns, NSEC_PER_SEC); + prescale = rzg2l_calculate_prescale(pc, period_cycles); + + pv = round_down(period_cycles >> (2 * prescale), 1 >> (2 * prescale)); + period_cycles = mul_u64_u64_div_u64(rate, duty_ns, NSEC_PER_SEC); + dc = round_down(period_cycles >> (2 * prescale), 1 >> (2 * prescale)); + + /* Mode and Prescalar must be set, while the GTCNT is stopped. */ + if (rzg2l_gpt_read(pc, GTCR) & GTCR_CST) + rzg2l_gpt_disable(pc); + + /* GPT set operating mode (saw-wave up-counting) */ + rzg2l_gpt_modify(pc, GTCR, GTCR_MD, GTCR_MD_SAW_WAVE_PWM_MODE); + + /* Set count direction */ + rzg2l_gpt_write(pc, GTUDDTYC, UP_COUNTING); + + /* Select count clock */ + rzg2l_gpt_modify(pc, GTCR, GTCR_TPCS, FIELD_PREP(GTCR_TPCS, prescale & 0x3)); + + /* Set cycle */ + rzg2l_gpt_write(pc, GTPR, pv); + + /* Set duty cycle */ + rzg2l_gpt_write(pc, gpt->ph->duty_reg_offset, dc); + + /* Set initial value for counter */ + rzg2l_gpt_write(pc, GTCNT, 0); + + /* Set no buffer operation */ + rzg2l_gpt_write(pc, GTBER, 0); + + /* Enable pin output */ + rzg2l_gpt_modify(pc, GTIOR, gpt->ph->mask, gpt->ph->value); + + return 0; +} + +static void rzg2l_gpt_get_state(struct pwm_chip *chip, struct pwm_device *pwm, + struct pwm_state *state) +{ + struct rzg2l_gpt_chip *pc = to_rzg2l_gpt_chip(chip); + struct gpt_pwm_device *gpt = pwm_get_chip_data(pwm); + unsigned long rate; + u8 prescale; + u32 val; + + val = rzg2l_gpt_read(pc, GTCR); + state->enabled = val & GTCR_CST; + if (state->enabled) { + rate = clk_get_rate(pc->clk); + prescale = FIELD_GET(GTCR_TPCS, val); + + val = rzg2l_gpt_read(pc, GTPR); + state->period = div_u64(val, rate) << (2 * prescale); + + val = rzg2l_gpt_read(pc, gpt->ph->duty_reg_offset); + state->duty_cycle = div_u64(val, rate) << (2 * prescale); + } else { + state->period = GTPR_MAX_VALUE; + state->duty_cycle = 0; + } + + state->polarity = PWM_POLARITY_NORMAL; +} + +static int rzg2l_gpt_apply(struct pwm_chip *chip, struct pwm_device *pwm, + const struct pwm_state *state) +{ + struct rzg2l_gpt_chip *pc = to_rzg2l_gpt_chip(chip); + int ret = 0; + + if (state->polarity != PWM_POLARITY_NORMAL) + return -EINVAL; + + if (!state->enabled) + goto err; + + ret = rzg2l_gpt_config(chip, pwm, state->duty_cycle, state->period); + if (ret) + goto err; + + return rzg2l_gpt_enable(pc); +err: + rzg2l_gpt_disable(pc); + return ret; +} + +static const struct pwm_ops rzg2l_gpt_ops = { + .request = rzg2l_gpt_request, + .free = rzg2l_gpt_free, + .get_state = rzg2l_gpt_get_state, + .apply = rzg2l_gpt_apply, + .owner = THIS_MODULE, +}; + +static const struct of_device_id rzg2l_gpt_of_table[] = { + { .compatible = "renesas,rzg2l-gpt", }, + { /* Sentinel */ }, +}; +MODULE_DEVICE_TABLE(of, rzg2l_gpt_of_table); + +static void rzg2l_gpt_reset_assert_pm_disable(void *data) +{ + struct rzg2l_gpt_chip *pc = data; + + pm_runtime_disable(pc->chip.dev); + reset_control_assert(pc->rstc); +} + +static int rzg2l_gpt_probe(struct platform_device *pdev) +{ + struct rzg2l_gpt_chip *rzg2l_gpt; + int ret; + + rzg2l_gpt = devm_kzalloc(&pdev->dev, sizeof(*rzg2l_gpt), GFP_KERNEL); + if (!rzg2l_gpt) + return -ENOMEM; + + rzg2l_gpt->mmio = devm_platform_ioremap_resource(pdev, 0); + if (IS_ERR(rzg2l_gpt->mmio)) + return PTR_ERR(rzg2l_gpt->mmio); + + rzg2l_gpt->rstc = devm_reset_control_get_exclusive(&pdev->dev, NULL); + if (IS_ERR(rzg2l_gpt->rstc)) + return dev_err_probe(&pdev->dev, PTR_ERR(rzg2l_gpt->rstc), + "get reset failed\n"); + + rzg2l_gpt->clk = devm_clk_get(&pdev->dev, NULL); + if (IS_ERR(rzg2l_gpt->clk)) + return dev_err_probe(&pdev->dev, PTR_ERR(rzg2l_gpt->clk), + "cannot get clock\n"); + + platform_set_drvdata(pdev, rzg2l_gpt); + + ret = reset_control_deassert(rzg2l_gpt->rstc); + if (ret) { + dev_err(&pdev->dev, "cannot deassert reset control: %pe\n", + ERR_PTR(ret)); + return ret; + } + + pm_runtime_enable(&pdev->dev); + + ret = devm_add_action_or_reset(&pdev->dev, + rzg2l_gpt_reset_assert_pm_disable, + rzg2l_gpt); + if (ret < 0) + return ret; + + rzg2l_gpt->chip.dev = &pdev->dev; + rzg2l_gpt->chip.ops = &rzg2l_gpt_ops; + rzg2l_gpt->chip.npwm = GPT_IO_PER_CHANNEL; + + return devm_pwmchip_add(&pdev->dev, &rzg2l_gpt->chip); +} + +static struct platform_driver rzg2l_gpt_driver = { + .driver = { + .name = "pwm-rzg2l-gpt", + .of_match_table = of_match_ptr(rzg2l_gpt_of_table), + }, + .probe = rzg2l_gpt_probe, +}; +module_platform_driver(rzg2l_gpt_driver); + +MODULE_AUTHOR("Biju Das <biju.das.jz@xxxxxxxxxxxxxx>"); +MODULE_DESCRIPTION("Renesas RZ/G2L General PWM Timer (GPT) Driver"); +MODULE_LICENSE("GPL"); +MODULE_ALIAS("platform:pwm-rzg2l-gpt"); -- 2.25.1