Re: [PATCH v5 6/7] scsi: ufs: rockchip: initial support for UFS

Shawn Lin
2024-11-25T03:57:03Z

在 2024/11/23 13:01, Manivannan Sadhasivam 写道:
> On Fri, Nov 08, 2024 at 02:56:25PM +0800, Shawn Lin wrote:
>> RK3576 SoC contains a UFS controller, add initial support for it.
>> The features are:
>> (1) support UFS 2.0 features
>> (2) High speed up to HS-G3
>> (3) 2RX-2TX lanes
>> (4) auto H8 entry and exit
>>
>> Software limitation:
>> (1) HCE procedure: enable controller->enable intr->dme_reset->dme_enable
>> (2) disable unipro timeout values before power mode change
>>
>> Signed-off-by: Shawn Lin <shawn.lin@rock-chips.com>
>> ---
>>
>> Changes in v5:
>> - use device_set_awake_path() and disable ref_out_clk in suspend
>> - remove pd_id from header
>> - recontruct ufs_rockchip_hce_enable_notify() to workaround hce enable
>> without using new quirk
>>
>> Changes in v4:
>> - deal with power domain of rpm and spm suggested by Ulf
>> - Fix typo and disable clks in ufs_rockchip_remove
>> - remove clk_disable_unprepare(host->ref_out_clk) from
>> ufs_rockchip_remove
>>
>> Changes in v3:
>> - reword Kconfig description
>> - elaborate more about controller in commit msg
>> - use rockchip,rk3576-ufshc for compatible
>> - remove useless header file
>> - remove inline for ufshcd_is_device_present
>> - use usleep_range instead
>> - remove initialization, reverse Xmas order
>> - remove useless varibles
>> - check vops for null
>> - other small fixes for err path
>> - remove pm_runtime_set_active
>> - fix the active and inactive reset-gpios logic
>> - fix rpm_lvl and spm_lvl to 5 and move to end of probe path
>> - remove unnecessary system PM callbacks
>> - use UFSHCI_QUIRK_DME_RESET_ENABLE_AFTER_HCE instead
>> of UFSHCI_QUIRK_BROKEN_HCE
>>
>> Changes in v2: None
>>
>> drivers/ufs/host/Kconfig | 12 ++
>> drivers/ufs/host/Makefile | 1 +
>> drivers/ufs/host/ufs-rockchip.c | 368 ++++++++++++++++++++++++++++++++++++++++
>> drivers/ufs/host/ufs-rockchip.h | 48 ++++++
>> 4 files changed, 429 insertions(+)
>> create mode 100644 drivers/ufs/host/ufs-rockchip.c
>> create mode 100644 drivers/ufs/host/ufs-rockchip.h
>>
>> diff --git a/drivers/ufs/host/Kconfig b/drivers/ufs/host/Kconfig
>> index 580c8d0..191fbd7 100644
>> --- a/drivers/ufs/host/Kconfig
>> +++ b/drivers/ufs/host/Kconfig
>> @@ -142,3 +142,15 @@ config SCSI_UFS_SPRD
>>
>> Select this if you have UFS controller on Unisoc chipset.
>> If unsure, say N.
>> +
>> +config SCSI_UFS_ROCKCHIP
>> + tristate "Rockchip UFS host controller driver"
>> + depends on SCSI_UFSHCD_PLATFORM && (ARCH_ROCKCHIP || COMPILE_TEST)
>> + help
>> + This selects the Rockchip specific additions to UFSHCD platform driver.
>> + UFS host on Rockchip needs some vendor specific configuration before
>> + accessing the hardware which includes PHY configuration and vendor
>> + specific registers.
>> +
>> + Select this if you have UFS controller on Rockchip chipset.
>> + If unsure, say N.
>> diff --git a/drivers/ufs/host/Makefile b/drivers/ufs/host/Makefile
>> index 4573aea..2f97feb 100644
>> --- a/drivers/ufs/host/Makefile
>> +++ b/drivers/ufs/host/Makefile
>> @@ -10,5 +10,6 @@ obj-$(CONFIG_SCSI_UFSHCD_PLATFORM) += ufshcd-pltfrm.o
>> obj-$(CONFIG_SCSI_UFS_HISI) += ufs-hisi.o
>> obj-$(CONFIG_SCSI_UFS_MEDIATEK) += ufs-mediatek.o
>> obj-$(CONFIG_SCSI_UFS_RENESAS) += ufs-renesas.o
>> +obj-$(CONFIG_SCSI_UFS_ROCKCHIP) += ufs-rockchip.o
>> obj-$(CONFIG_SCSI_UFS_SPRD) += ufs-sprd.o
>> obj-$(CONFIG_SCSI_UFS_TI_J721E) += ti-j721e-ufs.o
>> diff --git a/drivers/ufs/host/ufs-rockchip.c b/drivers/ufs/host/ufs-rockchip.c
>> new file mode 100644
>> index 0000000..b087ce0
>> --- /dev/null
>> +++ b/drivers/ufs/host/ufs-rockchip.c
>
> [...]
>
>> +
>> + host->clks[0].id = "core";
>> + host->clks[1].id = "pclk";
>> + host->clks[2].id = "pclk_mphy";
>> + err = devm_clk_bulk_get_optional(dev, UFS_MAX_CLKS, host->clks);
>
> Still not using clk_bulk_get_all()? as suggested previously?

I missed the comment, will fix.

>
>> + if (err)
>> + return dev_err_probe(dev, err, "failed to get clocks\n");
>> +
>> + err = clk_bulk_prepare_enable(UFS_MAX_CLKS, host->clks);
>> + if (err)
>> + return dev_err_probe(dev, err, "failed to enable clocks\n");
>> +
>> + host->hba = hba;
>> +
>> + ufshcd_set_variant(hba, host);
>> +
>> + return 0;
>> +}
>> +
>> +static int ufs_rockchip_rk3576_init(struct ufs_hba *hba)
>> +{
>> + struct device *dev = hba->dev;
>> + int ret;
>> +
>> + hba->quirks = UFSHCD_QUIRK_SKIP_DEF_UNIPRO_TIMEOUT_SETTING;
>> +
>> + /* Enable BKOPS when suspend */
>> + hba->caps |= UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
>> + /* Enable putting device into deep sleep */
>> + hba->caps |= UFSHCD_CAP_DEEPSLEEP;
>> + /* Enable devfreq of UFS */
>> + hba->caps |= UFSHCD_CAP_CLK_SCALING;
>> + /* Enable WriteBooster */
>> + hba->caps |= UFSHCD_CAP_WB_EN;
>> +
>> + ret = ufs_rockchip_common_init(hba);
>> + if (ret)
>> + return dev_err_probe(dev, ret, "ufs common init fail\n");
>> +
>> + return 0;
>> +}
>> +
>> +static int ufs_rockchip_device_reset(struct ufs_hba *hba)
>> +{
>> + struct ufs_rockchip_host *host = ufshcd_get_variant(hba);
>> +
>> + /* Active the reset-gpios */
>> + gpiod_set_value_cansleep(host->rst_gpio, 1);
>> + usleep_range(20, 25);
>> +
>> + /* Inactive the reset-gpios */
>> + gpiod_set_value_cansleep(host->rst_gpio, 0);
>> + usleep_range(20, 25);
>> +
>> + return 0;
>> +}
>> +
>> +static const struct ufs_hba_variant_ops ufs_hba_rk3576_vops = {
>> + .name = "rk3576",
>> + .init = ufs_rockchip_rk3576_init,
>> + .device_reset = ufs_rockchip_device_reset,
>> + .hce_enable_notify = ufs_rockchip_hce_enable_notify,
>> + .phy_initialization = ufs_rockchip_rk3576_phy_init,
>> +};
>> +
>> +static const struct of_device_id ufs_rockchip_of_match[] = {
>> + { .compatible = "rockchip,rk3576-ufshc", .data = &ufs_hba_rk3576_vops },
>> +};
>> +MODULE_DEVICE_TABLE(of, ufs_rockchip_of_match);
>> +
>> +static int ufs_rockchip_probe(struct platform_device *pdev)
>> +{
>> + struct device *dev = &pdev->dev;
>> + const struct ufs_hba_variant_ops *vops;
>> + struct ufs_hba *hba;
>> + int err;
>> +
>> + vops = device_get_match_data(dev);
>> + if (!vops)
>> + return dev_err_probe(dev, -EINVAL, "ufs_hba_variant_ops not defined.\n");
>> +
>> + err = ufshcd_pltfrm_init(pdev, vops);
>> + if (err)
>> + return dev_err_probe(dev, err, "ufshcd_pltfrm_init failed\n");
>> +
>> + hba = platform_get_drvdata(pdev);
>> + /* Set the default desired pm level in case no users set via sysfs */
>> + ufs_rockchip_set_pm_lvl(hba);
>
> Is it possible to move this to ufs_rockchip_rk3576_init()?

Sure.

>
>> +
>> + return 0;
>> +}
>> +
>> +static void ufs_rockchip_remove(struct platform_device *pdev)
>> +{
>> + struct ufs_hba *hba = platform_get_drvdata(pdev);
>> + struct ufs_rockchip_host *host = ufshcd_get_variant(hba);
>> +
>> + pm_runtime_forbid(&pdev->dev);
>> + pm_runtime_get_noresume(&pdev->dev);
>> + ufshcd_remove(hba);
>> + ufshcd_dealloc_host(hba);
>
> You wouldn't need these if you rebase this series on top of scsi/for-next.
>
>> + clk_bulk_disable_unprepare(UFS_MAX_CLKS, host->clks);
>> +}
>> +
>> +#ifdef CONFIG_PM
>> +static int ufs_rockchip_runtime_suspend(struct device *dev)
>> +{
>> + struct ufs_hba *hba = dev_get_drvdata(dev);
>> + struct ufs_rockchip_host *host = ufshcd_get_variant(hba);
>> +
>> + clk_disable_unprepare(host->ref_out_clk);
>> +
>> + /* Shouldn't power down if rpm_lvl is less than level 5. */
>> + dev_pm_genpd_rpm_always_on(dev, hba->rpm_lvl < UFS_PM_LVL_5 ? true : false);
>> +
>> + return ufshcd_runtime_suspend(dev);
>> +}
>> +
>> +static int ufs_rockchip_runtime_resume(struct device *dev)
>> +{
>> + struct ufs_hba *hba = dev_get_drvdata(dev);
>> + struct ufs_rockchip_host *host = ufshcd_get_variant(hba);
>> + int err;
>> +
>> + err = clk_prepare_enable(host->ref_out_clk);
>> + if (err) {
>> + dev_err(hba->dev, "failed to enable ref out clock %d\n", err);
>> + return err;
>> + }
>> +
>> + reset_control_assert(host->rst);
>> + usleep_range(1, 2);
>> + reset_control_deassert(host->rst);
>> +
>> + return ufshcd_runtime_resume(dev);
>> +}
>> +#endif
>> +
>> +#ifdef CONFIG_PM_SLEEP
>> +static int ufs_rockchip_system_suspend(struct device *dev)
>> +{
>> + struct ufs_hba *hba = dev_get_drvdata(dev);
>> + struct ufs_rockchip_host *host = ufshcd_get_variant(hba);
>> + int err;
>> +
>> + if (hba->spm_lvl < UFS_PM_LVL_5)
>> + device_set_awake_path(dev);
>
> It'd be worth adding a comment here as the API naming is not very clear now.
>

Will add. Thanks.

> - Mani
>