diff mbox series

[v2] pwm: add MediaTek display PWM driver

Message ID 20260902-mtk-pwm-disp-backlight-v2-1-e68c64d29bcd@baylibre.com
State New
Delegated to: David Lechner
Headers show
Series [v2] pwm: add MediaTek display PWM driver | expand

Commit Message

David Lechner Sept. 2, 2026, 2:44 p.m. UTC
Add a new driver for MediaTek display PWM controller. This is generally
used for backlight control on MediaTek SoCs.

Signed-off-by: David Lechner <dlechner@baylibre.com>
---
This driver will be used by MediaTek Genio 360 EVK that we are currently
working on bringing up.
---
Changes in v2:
- Credit the original author of the Linux driver.
- Use uint instead of u32 for the ops parameters to match struct pwm_ops.
- Reject a non-zero channel number.
- Reject duty_ns greater than period_ns.
- Check the value returned by clk_get_rate().
- Use FIELD_MAX() instead of FIELD_FIT() to range-check clk_div since
  FIELD_FIT() truncates the 64-bit value on 32-bit builds.
- Use clrsetbits_le32() and friends instead of open-coded
  read-modify-write helpers.
- Move the double buffer/manual mode setup to probe() so that it does not
  depend on set_config() being called before set_enable().
- Disable the main clock if enabling the mm clock fails.
- Print an error message on the probe() failure paths.
- Link to v1: https://patch.msgid.link/20260814-mtk-pwm-disp-backlight-v1-1-847992f0b815@baylibre.com
---
 drivers/pwm/Kconfig        |   8 ++
 drivers/pwm/Makefile       |   1 +
 drivers/pwm/pwm-mtk-disp.c | 187 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 196 insertions(+)


---
base-commit: d3e8597e46b635ec556a057bc42f0b0859654bdf
change-id: 20260814-mtk-pwm-disp-backlight-3951aeb966f7

Best regards,
--  
David Lechner <dlechner@baylibre.com>
diff mbox series

Patch

diff --git a/drivers/pwm/Kconfig b/drivers/pwm/Kconfig
index a69fe37caff..8a2b140fe97 100644
--- a/drivers/pwm/Kconfig
+++ b/drivers/pwm/Kconfig
@@ -74,6 +74,14 @@  config PWM_MTK
 	  This PWM is found on MT7622, MT7623, and MT7629. It supports a
 	  programmable period and duty cycle.
 
+config PWM_MTK_DISP
+	bool "Enable support for MediaTek display PWM"
+	depends on ARCH_MEDIATEK
+	help
+	  This PWM is found on the display subsystem of several MediaTek
+	  SoCs (e.g. MT8183, MT8366). It is typically used to drive the
+	  backlight of a display panel.
+
 config PWM_ROCKCHIP
 	bool "Enable support for the Rockchip PWM"
 	depends on ARCH_ROCKCHIP
diff --git a/drivers/pwm/Makefile b/drivers/pwm/Makefile
index 2682c536c6f..7c409c3c620 100644
--- a/drivers/pwm/Makefile
+++ b/drivers/pwm/Makefile
@@ -18,6 +18,7 @@  obj-$(CONFIG_PWM_EXYNOS)	+= exynos_pwm.o
 obj-$(CONFIG_PWM_IMX)		+= pwm-imx.o
 obj-$(CONFIG_PWM_MESON)		+= pwm-meson.o
 obj-$(CONFIG_PWM_MTK)		+= pwm-mtk.o
+obj-$(CONFIG_PWM_MTK_DISP)	+= pwm-mtk-disp.o
 obj-$(CONFIG_PWM_ROCKCHIP)	+= rk_pwm.o
 obj-$(CONFIG_PWM_SANDBOX)	+= sandbox_pwm.o
 obj-$(CONFIG_PWM_SIFIVE)	+= pwm-sifive.o
diff --git a/drivers/pwm/pwm-mtk-disp.c b/drivers/pwm/pwm-mtk-disp.c
new file mode 100644
index 00000000000..aeaae006a45
--- /dev/null
+++ b/drivers/pwm/pwm-mtk-disp.c
@@ -0,0 +1,187 @@ 
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * MediaTek display pulse-width-modulation controller driver.
+ *
+ * Copyright (c) 2015 MediaTek Inc.
+ * Author: YH Huang <yh.huang@mediatek.com>
+ *
+ * Copyright (C) 2026 BayLibre, SAS
+ */
+
+#include <clk.h>
+#include <dm.h>
+#include <pwm.h>
+#include <asm/io.h>
+#include <dm/device_compat.h>
+#include <linux/bitfield.h>
+#include <linux/bitops.h>
+#include <linux/err.h>
+#include <linux/errno.h>
+#include <linux/time.h>
+
+#define DISP_PWM_EN		0x00
+
+#define PWM_CLKDIV_MASK		GENMASK(25, 16)
+
+#define PWM_PERIOD_BIT_WIDTH	12
+#define PWM_PERIOD_MASK		GENMASK(PWM_PERIOD_BIT_WIDTH - 1, 0)
+
+#define PWM_HIGH_WIDTH_MASK	GENMASK(28, 16)
+
+struct mtk_disp_pwm_data {
+	u32 enable_mask;
+	u32 con0;
+	u32 con0_sel;
+	u32 con1;
+	bool has_commit;
+	u32 commit;
+	u32 commit_mask;
+	u32 bls_debug;
+	u32 bls_debug_mask;
+};
+
+struct mtk_disp_pwm_priv {
+	void __iomem *base;
+	struct clk clk_main;
+	struct clk clk_mm;
+	const struct mtk_disp_pwm_data *data;
+};
+
+static int mtk_disp_pwm_set_config(struct udevice *dev, uint channel,
+				   uint period_ns, uint duty_ns)
+{
+	struct mtk_disp_pwm_priv *priv = dev_get_priv(dev);
+	const struct mtk_disp_pwm_data *data = priv->data;
+	u64 div, clk_div, period, high_width;
+	ulong rate;
+
+	if (channel)
+		return -EINVAL;
+
+	if (duty_ns > period_ns)
+		return -EINVAL;
+
+	rate = clk_get_rate(&priv->clk_main);
+	if (IS_ERR_VALUE(rate) || !rate)
+		return -EINVAL;
+
+	/*
+	 * period_ns = 10^9 * (clk_div + 1) * (period + 1) / rate
+	 * duty_ns = 10^9 * (clk_div + 1) * high_width / rate
+	 */
+	clk_div = (((u64)period_ns * rate) / NSEC_PER_SEC) >> PWM_PERIOD_BIT_WIDTH;
+	if (clk_div > FIELD_MAX(PWM_CLKDIV_MASK))
+		return -EINVAL;
+
+	div = NSEC_PER_SEC * (clk_div + 1);
+	period = ((u64)period_ns * rate) / div;
+	if (period > 0)
+		period--;
+
+	high_width = ((u64)duty_ns * rate) / div;
+
+	clrsetbits_le32(priv->base + data->con0, PWM_CLKDIV_MASK,
+			FIELD_PREP(PWM_CLKDIV_MASK, clk_div));
+	clrsetbits_le32(priv->base + data->con1,
+			PWM_PERIOD_MASK | PWM_HIGH_WIDTH_MASK,
+			FIELD_PREP(PWM_PERIOD_MASK, period) |
+			FIELD_PREP(PWM_HIGH_WIDTH_MASK, high_width));
+
+	if (data->has_commit) {
+		setbits_le32(priv->base + data->commit, data->commit_mask);
+		clrbits_le32(priv->base + data->commit, data->commit_mask);
+	}
+
+	return 0;
+}
+
+static int mtk_disp_pwm_set_enable(struct udevice *dev, uint channel, bool enable)
+{
+	struct mtk_disp_pwm_priv *priv = dev_get_priv(dev);
+
+	if (channel)
+		return -EINVAL;
+
+	clrsetbits_le32(priv->base + DISP_PWM_EN, priv->data->enable_mask,
+			field_prep(priv->data->enable_mask, enable));
+
+	return 0;
+}
+
+static int mtk_disp_pwm_probe(struct udevice *dev)
+{
+	struct mtk_disp_pwm_priv *priv = dev_get_priv(dev);
+	const struct mtk_disp_pwm_data *data;
+	int ret;
+
+	data = (const void *)dev_get_driver_data(dev);
+	priv->data = data;
+
+	priv->base = dev_read_addr_ptr(dev);
+	if (!priv->base) {
+		dev_err(dev, "failed to get base address\n");
+		return -EINVAL;
+	}
+
+	ret = clk_get_by_name(dev, "main", &priv->clk_main);
+	if (ret) {
+		dev_err(dev, "failed to get main clock: %d\n", ret);
+		return ret;
+	}
+
+	ret = clk_get_by_name(dev, "mm", &priv->clk_mm);
+	if (ret) {
+		dev_err(dev, "failed to get mm clock: %d\n", ret);
+		return ret;
+	}
+
+	ret = clk_enable(&priv->clk_main);
+	if (ret) {
+		dev_err(dev, "failed to enable main clock: %d\n", ret);
+		return ret;
+	}
+
+	ret = clk_enable(&priv->clk_mm);
+	if (ret) {
+		dev_err(dev, "failed to enable mm clock: %d\n", ret);
+		clk_disable(&priv->clk_main);
+		return ret;
+	}
+
+	if (data->bls_debug && !data->has_commit) {
+		/* Disable double buffer and select manual mode */
+		setbits_le32(priv->base + data->bls_debug, data->bls_debug_mask);
+		setbits_le32(priv->base + data->con0, data->con0_sel);
+	}
+
+	return 0;
+}
+
+static const struct pwm_ops mtk_disp_pwm_ops = {
+	.set_config = mtk_disp_pwm_set_config,
+	.set_enable = mtk_disp_pwm_set_enable,
+};
+
+static const struct mtk_disp_pwm_data mt8183_pwm_data = {
+	.enable_mask = BIT(0),
+	.con0 = 0x18,
+	.con0_sel = 0x0,
+	.con1 = 0x1c,
+	.has_commit = false,
+	.bls_debug = 0x80,
+	.bls_debug_mask = GENMASK(1, 0),
+};
+
+static const struct udevice_id mtk_disp_pwm_ids[] = {
+	{ .compatible = "mediatek,mt8183-disp-pwm", .data = (ulong)&mt8183_pwm_data },
+	{ }
+};
+
+U_BOOT_DRIVER(mtk_disp_pwm) = {
+	.name		= "mtk_disp_pwm",
+	.id		= UCLASS_PWM,
+	.of_match	= mtk_disp_pwm_ids,
+	.ops		= &mtk_disp_pwm_ops,
+	.probe		= mtk_disp_pwm_probe,
+	.priv_auto	= sizeof(struct mtk_disp_pwm_priv),
+};