2 * Universal Flash Storage Host controller Platform bus based glue driver
4 * This code is based on drivers/scsi/ufs/ufshcd-pltfrm.c
5 * Copyright (C) 2011-2013 Samsung India Software Operations
8 * Santosh Yaraganavi <santosh.sy@samsung.com>
9 * Vinayak Holikatti <h.vinayak@samsung.com>
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
15 * See the COPYING file in the top-level directory or visit
16 * <http://www.gnu.org/licenses/gpl-2.0.html>
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * This program is provided "AS IS" and "WITH ALL FAULTS" and
24 * without warranty of any kind. You are solely responsible for
25 * determining the appropriateness of using and distributing
26 * the program and assume all risks associated with your exercise
27 * of rights with respect to the program, including but not limited
28 * to infringement of third party rights, the risks and costs of
29 * program errors, damage to or loss of data, programs or equipment,
30 * and unavailability or interruption of operations. Under no
31 * circumstances will the contributor of this Program be liable for
32 * any damages of any kind arising from your use or distribution of
36 #include <linux/platform_device.h>
37 #include <linux/pm_runtime.h>
43 * ufshcd_pltfrm_suspend - suspend power management function
44 * @dev: pointer to device handle
49 static int ufshcd_pltfrm_suspend(struct device *dev)
51 struct platform_device *pdev = to_platform_device(dev);
52 struct ufs_hba *hba = platform_get_drvdata(pdev);
56 * 1. Call ufshcd_suspend
57 * 2. Do bus specific power management
60 disable_irq(hba->irq);
66 * ufshcd_pltfrm_resume - resume power management function
67 * @dev: pointer to device handle
71 static int ufshcd_pltfrm_resume(struct device *dev)
73 struct platform_device *pdev = to_platform_device(dev);
74 struct ufs_hba *hba = platform_get_drvdata(pdev);
78 * 1. Call ufshcd_resume.
79 * 2. Do bus specific wake up
87 #define ufshcd_pltfrm_suspend NULL
88 #define ufshcd_pltfrm_resume NULL
91 #ifdef CONFIG_PM_RUNTIME
92 static int ufshcd_pltfrm_runtime_suspend(struct device *dev)
94 struct ufs_hba *hba = dev_get_drvdata(dev);
99 return ufshcd_runtime_suspend(hba);
101 static int ufshcd_pltfrm_runtime_resume(struct device *dev)
103 struct ufs_hba *hba = dev_get_drvdata(dev);
108 return ufshcd_runtime_resume(hba);
110 static int ufshcd_pltfrm_runtime_idle(struct device *dev)
112 struct ufs_hba *hba = dev_get_drvdata(dev);
117 return ufshcd_runtime_idle(hba);
119 #else /* !CONFIG_PM_RUNTIME */
120 #define ufshcd_pltfrm_runtime_suspend NULL
121 #define ufshcd_pltfrm_runtime_resume NULL
122 #define ufshcd_pltfrm_runtime_idle NULL
123 #endif /* CONFIG_PM_RUNTIME */
126 * ufshcd_pltfrm_probe - probe routine of the driver
127 * @pdev: pointer to Platform device handle
129 * Returns 0 on success, non-zero value on failure
131 static int ufshcd_pltfrm_probe(struct platform_device *pdev)
134 void __iomem *mmio_base;
135 struct resource *mem_res;
137 struct device *dev = &pdev->dev;
139 mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
141 dev_err(dev, "Memory resource not available\n");
146 mmio_base = devm_ioremap_resource(dev, mem_res);
147 if (IS_ERR(mmio_base)) {
148 err = PTR_ERR(mmio_base);
152 irq = platform_get_irq(pdev, 0);
154 dev_err(dev, "IRQ resource not available\n");
159 pm_runtime_set_active(&pdev->dev);
160 pm_runtime_enable(&pdev->dev);
162 err = ufshcd_init(dev, &hba, mmio_base, irq);
164 dev_err(dev, "Intialization failed\n");
165 goto out_disable_rpm;
168 platform_set_drvdata(pdev, hba);
173 pm_runtime_disable(&pdev->dev);
174 pm_runtime_set_suspended(&pdev->dev);
180 * ufshcd_pltfrm_remove - remove platform driver routine
181 * @pdev: pointer to platform device handle
183 * Returns 0 on success, non-zero value on failure
185 static int ufshcd_pltfrm_remove(struct platform_device *pdev)
187 struct ufs_hba *hba = platform_get_drvdata(pdev);
189 pm_runtime_get_sync(&(pdev)->dev);
194 static const struct of_device_id ufs_of_match[] = {
195 { .compatible = "jedec,ufs-1.1"},
199 static const struct dev_pm_ops ufshcd_dev_pm_ops = {
200 .suspend = ufshcd_pltfrm_suspend,
201 .resume = ufshcd_pltfrm_resume,
202 .runtime_suspend = ufshcd_pltfrm_runtime_suspend,
203 .runtime_resume = ufshcd_pltfrm_runtime_resume,
204 .runtime_idle = ufshcd_pltfrm_runtime_idle,
207 static struct platform_driver ufshcd_pltfrm_driver = {
208 .probe = ufshcd_pltfrm_probe,
209 .remove = ufshcd_pltfrm_remove,
212 .owner = THIS_MODULE,
213 .pm = &ufshcd_dev_pm_ops,
214 .of_match_table = ufs_of_match,
218 module_platform_driver(ufshcd_pltfrm_driver);
220 MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
221 MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
222 MODULE_DESCRIPTION("UFS host controller Pltform bus based glue driver");
223 MODULE_LICENSE("GPL");
224 MODULE_VERSION(UFSHCD_DRIVER_VERSION);