Re: [PATCH v7 4/9] clk: starfive: Add StarFive JH7110 Image-Signal-Process clock driver

From: Xingyu Wu
Date: Wed Jul 12 2023 - 22:15:32 EST

On 2023/7/13 1:59, Emil Renner Berthing wrote:
> On Wed, 12 Jul 2023 at 11:22, Xingyu Wu <xingyu.wu@xxxxxxxxxxxxxxxx> wrote:
>>
>> Add driver for the StarFive JH7110 Image-Signal-Process clock controller.
>> And these clock controllers should power on and enable the clocks from
>> SYSCRG first before registering.
>>
>> Reviewed-by: Hal Feng <hal.feng@xxxxxxxxxxxxxxxx>
>> Signed-off-by: Xingyu Wu <xingyu.wu@xxxxxxxxxxxxxxxx>
>> ---
>> drivers/clk/starfive/Kconfig | 8 +
>> drivers/clk/starfive/Makefile | 1 +
>> .../clk/starfive/clk-starfive-jh7110-isp.c | 232 ++++++++++++++++++
>> drivers/clk/starfive/clk-starfive-jh7110.h | 6 +
>> 4 files changed, 247 insertions(+)
>> create mode 100644 drivers/clk/starfive/clk-starfive-jh7110-isp.c
>>
>> diff --git a/drivers/clk/starfive/Kconfig b/drivers/clk/starfive/Kconfig
>> index eb1023b5e95a..13b4d08cbcd2 100644
>> --- a/drivers/clk/starfive/Kconfig
>> +++ b/drivers/clk/starfive/Kconfig
>> @@ -47,3 +47,11 @@ config CLK_STARFIVE_JH7110_STG
>> help
>> Say yes here to support the System-Top-Group clock controller
>> on the StarFive JH7110 SoC.
>> +
>> +config CLK_STARFIVE_JH7110_ISP
>> + tristate "StarFive JH7110 Image-Signal-Process clock support"
>> + depends on CLK_STARFIVE_JH7110_SYS && JH71XX_PMU
>> + default m if ARCH_STARFIVE
>> + help
>> + Say yes here to support the Image-Signal-Process clock controller
>> + on the StarFive JH7110 SoC.
>> diff --git a/drivers/clk/starfive/Makefile b/drivers/clk/starfive/Makefile
>> index b81e97ee2659..76fb9f8d628b 100644
>> --- a/drivers/clk/starfive/Makefile
>> +++ b/drivers/clk/starfive/Makefile
>> @@ -7,3 +7,4 @@ obj-$(CONFIG_CLK_STARFIVE_JH7100_AUDIO) += clk-starfive-jh7100-audio.o
>> obj-$(CONFIG_CLK_STARFIVE_JH7110_SYS) += clk-starfive-jh7110-sys.o
>> obj-$(CONFIG_CLK_STARFIVE_JH7110_AON) += clk-starfive-jh7110-aon.o
>> obj-$(CONFIG_CLK_STARFIVE_JH7110_STG) += clk-starfive-jh7110-stg.o
>> +obj-$(CONFIG_CLK_STARFIVE_JH7110_ISP) += clk-starfive-jh7110-isp.o
>> diff --git a/drivers/clk/starfive/clk-starfive-jh7110-isp.c b/drivers/clk/starfive/clk-starfive-jh7110-isp.c
>> new file mode 100644
>> index 000000000000..7e51447060fe
>> --- /dev/null
>> +++ b/drivers/clk/starfive/clk-starfive-jh7110-isp.c
>> @@ -0,0 +1,232 @@
>> +// SPDX-License-Identifier: GPL-2.0
>> +/*
>> + * StarFive JH7110 Image-Signal-Process Clock Driver
>> + *
>> + * Copyright (C) 2022-2023 StarFive Technology Co., Ltd.
>> + */
>> +
>> +#include <linux/clk.h>
>> +#include <linux/clk-provider.h>
>> +#include <linux/io.h>
>> +#include <linux/platform_device.h>
>> +#include <linux/pm_runtime.h>
>> +#include <linux/reset.h>
>> +
>> +#include <dt-bindings/clock/starfive,jh7110-crg.h>
>> +
>> +#include "clk-starfive-jh7110.h"
>> +
>> +/* external clocks */
>> +#define JH7110_ISPCLK_ISP_TOP_CORE (JH7110_ISPCLK_END + 0)
>> +#define JH7110_ISPCLK_ISP_TOP_AXI (JH7110_ISPCLK_END + 1)
>> +#define JH7110_ISPCLK_NOC_BUS_ISP_AXI (JH7110_ISPCLK_END + 2)
>> +#define JH7110_ISPCLK_DVP_CLK (JH7110_ISPCLK_END + 3)
>> +#define JH7110_ISPCLK_EXT_END (JH7110_ISPCLK_END + 4)
>> +
>> +static struct clk_bulk_data jh7110_isp_top_clks[] = {
>> + { .id = "isp_top_core" },
>> + { .id = "isp_top_axi" }
>> +};
>> +
>> +static const struct jh71x0_clk_data jh7110_ispclk_data[] = {
>> + /* syscon */
>> + JH71X0__DIV(JH7110_ISPCLK_DOM4_APB_FUNC, "dom4_apb_func", 15,
>> + JH7110_ISPCLK_ISP_TOP_AXI),
>> + JH71X0__DIV(JH7110_ISPCLK_MIPI_RX0_PXL, "mipi_rx0_pxl", 8,
>> + JH7110_ISPCLK_ISP_TOP_CORE),
>> + JH71X0__INV(JH7110_ISPCLK_DVP_INV, "dvp_inv", JH7110_ISPCLK_DVP_CLK),
>> + /* vin */
>> + JH71X0__DIV(JH7110_ISPCLK_M31DPHY_CFG_IN, "m31dphy_cfg_in", 16,
>> + JH7110_ISPCLK_ISP_TOP_CORE),
>> + JH71X0__DIV(JH7110_ISPCLK_M31DPHY_REF_IN, "m31dphy_ref_in", 16,
>> + JH7110_ISPCLK_ISP_TOP_CORE),
>> + JH71X0__DIV(JH7110_ISPCLK_M31DPHY_TX_ESC_LAN0, "m31dphy_tx_esc_lan0", 60,
>> + JH7110_ISPCLK_ISP_TOP_CORE),
>> + JH71X0_GATE(JH7110_ISPCLK_VIN_APB, "vin_apb", 0,
>> + JH7110_ISPCLK_DOM4_APB_FUNC),
>> + JH71X0__DIV(JH7110_ISPCLK_VIN_SYS, "vin_sys", 8, JH7110_ISPCLK_ISP_TOP_CORE),
>> + JH71X0_GATE(JH7110_ISPCLK_VIN_PIXEL_IF0, "vin_pixel_if0", 0,
>> + JH7110_ISPCLK_MIPI_RX0_PXL),
>> + JH71X0_GATE(JH7110_ISPCLK_VIN_PIXEL_IF1, "vin_pixel_if1", 0,
>> + JH7110_ISPCLK_MIPI_RX0_PXL),
>> + JH71X0_GATE(JH7110_ISPCLK_VIN_PIXEL_IF2, "vin_pixel_if2", 0,
>> + JH7110_ISPCLK_MIPI_RX0_PXL),
>> + JH71X0_GATE(JH7110_ISPCLK_VIN_PIXEL_IF3, "vin_pixel_if3", 0,
>> + JH7110_ISPCLK_MIPI_RX0_PXL),
>> + JH71X0__MUX(JH7110_ISPCLK_VIN_P_AXI_WR, "vin_p_axi_wr", 2,
>> + JH7110_ISPCLK_MIPI_RX0_PXL,
>> + JH7110_ISPCLK_DVP_INV),
>> + /* ispv2_top_wrapper */
>> + JH71X0_GMUX(JH7110_ISPCLK_ISPV2_TOP_WRAPPER_C, "ispv2_top_wrapper_c", 0, 2,
>> + JH7110_ISPCLK_MIPI_RX0_PXL,
>> + JH7110_ISPCLK_DVP_INV),
>> +};
>> +
>> +static inline int jh7110_isp_top_rst_init(struct jh71x0_clk_priv *priv)
>> +{
>> + struct reset_control *top_rsts;
>> +
>> + /* The resets should be shared and other ISP modules will use its. */
>> + top_rsts = devm_reset_control_array_get_shared(priv->dev);
>> + if (IS_ERR(top_rsts))
>> + return dev_err_probe(priv->dev, PTR_ERR(top_rsts),
>> + "failed to get top resets\n");
>> +
>> + return reset_control_deassert(top_rsts);
>> +}
>> +
>> +static struct clk_hw *jh7110_ispclk_get(struct of_phandle_args *clkspec, void *data)
>> +{
>> + struct jh71x0_clk_priv *priv = data;
>> + unsigned int idx = clkspec->args[0];
>> +
>> + if (idx < JH7110_ISPCLK_END)
>> + return &priv->reg[idx].hw;
>> +
>> + return ERR_PTR(-EINVAL);
>> +}
>> +
>> +#ifdef CONFIG_PM
>> +static int jh7110_ispcrg_suspend(struct device *dev)
>> +{
>> + struct top_sysclk *top = dev_get_drvdata(dev);
>> +
>> + clk_bulk_disable_unprepare(top->top_clks_num, top->top_clks);
>> +
>> + return 0;
>> +}
>> +
>> +static int jh7110_ispcrg_resume(struct device *dev)
>> +{
>> + struct top_sysclk *top = dev_get_drvdata(dev);
>> +
>> + return clk_bulk_prepare_enable(top->top_clks_num, top->top_clks);
>> +}
>> +#endif
>> +
>> +static const struct dev_pm_ops jh7110_ispcrg_pm_ops = {
>> + SET_RUNTIME_PM_OPS(jh7110_ispcrg_suspend, jh7110_ispcrg_resume, NULL)
>> +};
>> +
>> +static int jh7110_ispcrg_probe(struct platform_device *pdev)
>> +{
>> + struct jh71x0_clk_priv *priv;
>> + struct top_sysclk *top;
>> + unsigned int idx;
>> + int ret;
>> +
>> + priv = devm_kzalloc(&pdev->dev,
>> + struct_size(priv, reg, JH7110_ISPCLK_END),
>> + GFP_KERNEL);
>> + if (!priv)
>> + return -ENOMEM;
>> +
>> + top = devm_kzalloc(&pdev->dev, sizeof(*top), GFP_KERNEL);
>> + if (!top)
>> + return -ENOMEM;
>> +
>> + spin_lock_init(&priv->rmw_lock);
>> + priv->dev = &pdev->dev;
>> + priv->base = devm_platform_ioremap_resource(pdev, 0);
>> + if (IS_ERR(priv->base))
>> + return PTR_ERR(priv->base);
>> +
>> + top->top_clks = jh7110_isp_top_clks;
>> + top->top_clks_num = ARRAY_SIZE(jh7110_isp_top_clks);
>> + ret = devm_clk_bulk_get(priv->dev, top->top_clks_num, top->top_clks);
>> + if (ret)
>> + return dev_err_probe(priv->dev, ret, "failed to get main clocks\n");
>> + dev_set_drvdata(priv->dev, top);
>> +
>> + /* enable power domain and clocks */
>> + pm_runtime_enable(priv->dev);
>> + ret = pm_runtime_get_sync(priv->dev);
>> + if (ret < 0)
>> + return dev_err_probe(priv->dev, ret, "failed to turn on power\n");
>> +
>> + ret = jh7110_isp_top_rst_init(priv);
>> + if (ret)
>> + goto err_exit;
>> +
>> + for (idx = 0; idx < JH7110_ISPCLK_END; idx++) {
>> + u32 max = jh7110_ispclk_data[idx].max;
>> + struct clk_parent_data parents[4] = {};
>> + struct clk_init_data init = {
>> + .name = jh7110_ispclk_data[idx].name,
>> + .ops = starfive_jh71x0_clk_ops(max),
>> + .parent_data = parents,
>> + .num_parents =
>> + ((max & JH71X0_CLK_MUX_MASK) >> JH71X0_CLK_MUX_SHIFT) + 1,
>> + .flags = jh7110_ispclk_data[idx].flags,
>> + };
>> + struct jh71x0_clk *clk = &priv->reg[idx];
>> + unsigned int i;
>> + const char *fw_name[JH7110_ISPCLK_EXT_END - JH7110_ISPCLK_END] = {
>> + "isp_top_core",
>> + "isp_top_axi",
>> + "noc_bus_isp_axi",
>> + "dvp_clk"
>> + };
>> +
>> + for (i = 0; i < init.num_parents; i++) {
>> + unsigned int pidx = jh7110_ispclk_data[idx].parents[i];
>> +
>> + if (pidx < JH7110_ISPCLK_END)
>> + parents[i].hw = &priv->reg[pidx].hw;
>> + else
>> + parents[i].fw_name = fw_name[pidx - JH7110_ISPCLK_END];
>> + }
>> +
>> + clk->hw.init = &init;
>> + clk->idx = idx;
>> + clk->max_div = max & JH71X0_CLK_DIV_MASK;
>> +
>> + ret = devm_clk_hw_register(&pdev->dev, &clk->hw);
>> + if (ret)
>> + goto err_exit;
>> + }
>> +
>> + ret = devm_of_clk_add_hw_provider(&pdev->dev, jh7110_ispclk_get, priv);
>> + if (ret)
>> + goto err_exit;
>> +
>> + ret = jh7110_reset_controller_register(priv, "rst-isp", 3);
>> + if (ret)
>> + goto err_exit;
>> +
>> + return 0;
>> +
>> +err_exit:
>> + pm_runtime_put_sync(priv->dev);
>> + pm_runtime_disable(priv->dev);
>> + return ret;
>> +}
>> +
>> +static int jh7110_ispcrg_remove(struct platform_device *pdev)
>> +{
>> + pm_runtime_put_sync(&pdev->dev);
>> + pm_runtime_disable(&pdev->dev);
>> +
>> + return 0;
>> +}
>> +
>> +static const struct of_device_id jh7110_ispcrg_match[] = {
>> + { .compatible = "starfive,jh7110-ispcrg" },
>> + { /* sentinel */ }
>> +};
>> +MODULE_DEVICE_TABLE(of, jh7110_ispcrg_match);
>> +
>> +static struct platform_driver jh7110_ispcrg_driver = {
>> + .probe = jh7110_ispcrg_probe,
>> + .remove = jh7110_ispcrg_remove,
>> + .driver = {
>> + .name = "clk-starfive-jh7110-isp",
>> + .of_match_table = jh7110_ispcrg_match,
>> + .pm = &jh7110_ispcrg_pm_ops,
>> + },
>> +};
>> +module_platform_driver(jh7110_ispcrg_driver);
>> +
>> +MODULE_AUTHOR("Xingyu Wu <xingyu.wu@xxxxxxxxxxxxxxxx>");
>> +MODULE_DESCRIPTION("StarFive JH7110 Image-Signal-Process clock driver");
>> +MODULE_LICENSE("GPL");
>> diff --git a/drivers/clk/starfive/clk-starfive-jh7110.h b/drivers/clk/starfive/clk-starfive-jh7110.h
>> index f29682b8d400..5425fd89394a 100644
>> --- a/drivers/clk/starfive/clk-starfive-jh7110.h
>> +++ b/drivers/clk/starfive/clk-starfive-jh7110.h
>> @@ -4,6 +4,12 @@
>>
>> #include "clk-starfive-jh71x0.h"
>>
>> +/* top clocks of ISP/VOUT domain from SYSCRG */
>> +struct top_sysclk {
>> + struct clk_bulk_data *top_clks;
>> + int top_clks_num;
>> +};
>> +
>
> When reviewing this I was very confused what data the vout and isp
> clocks need to share. But as far as I can tell they don't actually
> share any data, it's just that they both need a struct like this. I
> guess that's ok to put here, but it should really be prefixed with
> jh7110_ like the function below. Eg. struct jh7110_top_clks { .. }
>
> With that fixed:
> Reviewed-by: Emil Renner Berthing <emil.renner.berthing@xxxxxxxxxxxxx>
>

Will fix. Thanks.

Best regards,
Xingyu Wu

>> int jh7110_reset_controller_register(struct jh71x0_clk_priv *priv,
>> const char *adev_name,
>> u32 adev_id);