1 // SPDX-License-Identifier: GPL-2.0
3 * Platform UFS Host driver for Cadence controller
5 * Copyright (C) 2018 Cadence Design Systems, Inc.
8 * Jan Kotas <jank@cadence.com>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/platform_device.h>
16 #include <linux/time.h>
18 #include "ufshcd-pltfrm.h"
20 #define CDNS_UFS_REG_HCLKDIV 0xFC
21 #define CDNS_UFS_REG_PHY_XCFGD1 0x113C
24 * Sets HCLKDIV register value based on the core_clk
25 * @hba: host controller instance
27 * Return zero for success and non-zero for failure
29 static int cdns_ufs_set_hclkdiv(struct ufs_hba *hba)
31 struct ufs_clk_info *clki;
32 struct list_head *head = &hba->clk_list_head;
33 unsigned long core_clk_rate = 0;
39 list_for_each_entry(clki, head, list) {
40 if (IS_ERR_OR_NULL(clki->clk))
42 if (!strcmp(clki->name, "core_clk"))
43 core_clk_rate = clk_get_rate(clki->clk);
47 dev_err(hba->dev, "%s: unable to find core_clk rate\n",
52 core_clk_div = core_clk_rate / USEC_PER_SEC;
54 ufshcd_writel(hba, core_clk_div, CDNS_UFS_REG_HCLKDIV);
56 * Make sure the register was updated,
57 * UniPro layer will not work with an incorrect value.
65 * Called before and after HCE enable bit is set.
66 * @hba: host controller instance
67 * @status: notify stage (pre, post change)
69 * Return zero for success and non-zero for failure
71 static int cdns_ufs_hce_enable_notify(struct ufs_hba *hba,
72 enum ufs_notify_change_status status)
74 if (status != PRE_CHANGE)
77 return cdns_ufs_set_hclkdiv(hba);
81 * Called before and after Link startup is carried out.
82 * @hba: host controller instance
83 * @status: notify stage (pre, post change)
85 * Return zero for success and non-zero for failure
87 static int cdns_ufs_link_startup_notify(struct ufs_hba *hba,
88 enum ufs_notify_change_status status)
90 if (status != PRE_CHANGE)
94 * Some UFS devices have issues if LCC is enabled.
95 * So we are setting PA_Local_TX_LCC_Enable to 0
96 * before link startup which will make sure that both host
97 * and device TX LCC are disabled once link startup is
100 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_LOCAL_TX_LCC_ENABLE), 0);
106 * cdns_ufs_init - performs additional ufs initialization
107 * @hba: host controller instance
109 * Returns status of initialization
111 static int cdns_ufs_init(struct ufs_hba *hba)
115 if (hba->vops && hba->vops->phy_initialization)
116 status = hba->vops->phy_initialization(hba);
122 * cdns_ufs_m31_16nm_phy_initialization - performs m31 phy initialization
123 * @hba: host controller instance
127 static int cdns_ufs_m31_16nm_phy_initialization(struct ufs_hba *hba)
131 /* Increase RX_Advanced_Min_ActivateTime_Capability */
132 data = ufshcd_readl(hba, CDNS_UFS_REG_PHY_XCFGD1);
134 ufshcd_writel(hba, data, CDNS_UFS_REG_PHY_XCFGD1);
139 static const struct ufs_hba_variant_ops cdns_ufs_pltfm_hba_vops = {
140 .name = "cdns-ufs-pltfm",
141 .hce_enable_notify = cdns_ufs_hce_enable_notify,
142 .link_startup_notify = cdns_ufs_link_startup_notify,
145 static const struct ufs_hba_variant_ops cdns_ufs_m31_16nm_pltfm_hba_vops = {
146 .name = "cdns-ufs-pltfm",
147 .init = cdns_ufs_init,
148 .hce_enable_notify = cdns_ufs_hce_enable_notify,
149 .link_startup_notify = cdns_ufs_link_startup_notify,
150 .phy_initialization = cdns_ufs_m31_16nm_phy_initialization,
153 static const struct of_device_id cdns_ufs_of_match[] = {
155 .compatible = "cdns,ufshc",
156 .data = &cdns_ufs_pltfm_hba_vops,
159 .compatible = "cdns,ufshc-m31-16nm",
160 .data = &cdns_ufs_m31_16nm_pltfm_hba_vops,
165 MODULE_DEVICE_TABLE(of, cdns_ufs_of_match);
168 * cdns_ufs_pltfrm_probe - probe routine of the driver
169 * @pdev: pointer to platform device handle
171 * Return zero for success and non-zero for failure
173 static int cdns_ufs_pltfrm_probe(struct platform_device *pdev)
176 const struct of_device_id *of_id;
177 struct ufs_hba_variant_ops *vops;
178 struct device *dev = &pdev->dev;
180 of_id = of_match_node(cdns_ufs_of_match, dev->of_node);
181 vops = (struct ufs_hba_variant_ops *)of_id->data;
183 /* Perform generic probe */
184 err = ufshcd_pltfrm_init(pdev, vops);
186 dev_err(dev, "ufshcd_pltfrm_init() failed %d\n", err);
192 * cdns_ufs_pltfrm_remove - removes the ufs driver
193 * @pdev: pointer to platform device handle
197 static int cdns_ufs_pltfrm_remove(struct platform_device *pdev)
199 struct ufs_hba *hba = platform_get_drvdata(pdev);
205 static const struct dev_pm_ops cdns_ufs_dev_pm_ops = {
206 .suspend = ufshcd_pltfrm_suspend,
207 .resume = ufshcd_pltfrm_resume,
208 .runtime_suspend = ufshcd_pltfrm_runtime_suspend,
209 .runtime_resume = ufshcd_pltfrm_runtime_resume,
210 .runtime_idle = ufshcd_pltfrm_runtime_idle,
213 static struct platform_driver cdns_ufs_pltfrm_driver = {
214 .probe = cdns_ufs_pltfrm_probe,
215 .remove = cdns_ufs_pltfrm_remove,
217 .name = "cdns-ufshcd",
218 .pm = &cdns_ufs_dev_pm_ops,
219 .of_match_table = cdns_ufs_of_match,
223 module_platform_driver(cdns_ufs_pltfrm_driver);
225 MODULE_AUTHOR("Jan Kotas <jank@cadence.com>");
226 MODULE_DESCRIPTION("Cadence UFS host controller platform driver");
227 MODULE_LICENSE("GPL v2");
228 MODULE_VERSION(UFSHCD_DRIVER_VERSION);