1 /*
2 * Universal Flash Storage Host controller PCI glue driver
3 *
4 * This code is based on drivers/scsi/ufs/ufshcd-pci.c
5 * Copyright (C) 2011-2013 Samsung India Software Operations
6 *
7 * Authors:
8 * Santosh Yaraganavi <santosh.sy@samsung.com>
9 * Vinayak Holikatti <h.vinayak@samsung.com>
10 *
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>
17 *
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.
22 *
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
33 * this program.
34 */
35
36 #include "ufshcd.h"
37 #include <linux/pci.h>
38 #include <linux/pm_runtime.h>
39
ufs_intel_disable_lcc(struct ufs_hba * hba)40 static int ufs_intel_disable_lcc(struct ufs_hba *hba)
41 {
42 u32 attr = UIC_ARG_MIB(PA_LOCAL_TX_LCC_ENABLE);
43 u32 lcc_enable = 0;
44
45 ufshcd_dme_get(hba, attr, &lcc_enable);
46 if (lcc_enable)
47 ufshcd_disable_host_tx_lcc(hba);
48
49 return 0;
50 }
51
ufs_intel_link_startup_notify(struct ufs_hba * hba,enum ufs_notify_change_status status)52 static int ufs_intel_link_startup_notify(struct ufs_hba *hba,
53 enum ufs_notify_change_status status)
54 {
55 int err = 0;
56
57 switch (status) {
58 case PRE_CHANGE:
59 err = ufs_intel_disable_lcc(hba);
60 break;
61 case POST_CHANGE:
62 break;
63 default:
64 break;
65 }
66
67 return err;
68 }
69
70 static struct ufs_hba_variant_ops ufs_intel_cnl_hba_vops = {
71 .name = "intel-pci",
72 .link_startup_notify = ufs_intel_link_startup_notify,
73 };
74
75 #ifdef CONFIG_PM_SLEEP
76 /**
77 * ufshcd_pci_suspend - suspend power management function
78 * @dev: pointer to PCI device handle
79 *
80 * Returns 0 if successful
81 * Returns non-zero otherwise
82 */
ufshcd_pci_suspend(struct device * dev)83 static int ufshcd_pci_suspend(struct device *dev)
84 {
85 return ufshcd_system_suspend(dev_get_drvdata(dev));
86 }
87
88 /**
89 * ufshcd_pci_resume - resume power management function
90 * @dev: pointer to PCI device handle
91 *
92 * Returns 0 if successful
93 * Returns non-zero otherwise
94 */
ufshcd_pci_resume(struct device * dev)95 static int ufshcd_pci_resume(struct device *dev)
96 {
97 return ufshcd_system_resume(dev_get_drvdata(dev));
98 }
99
100 /**
101 * ufshcd_pci_poweroff - suspend-to-disk poweroff function
102 * @dev: pointer to PCI device handle
103 *
104 * Returns 0 if successful
105 * Returns non-zero otherwise
106 */
ufshcd_pci_poweroff(struct device * dev)107 static int ufshcd_pci_poweroff(struct device *dev)
108 {
109 struct ufs_hba *hba = dev_get_drvdata(dev);
110 int spm_lvl = hba->spm_lvl;
111 int ret;
112
113 /*
114 * For poweroff we need to set the UFS device to PowerDown mode.
115 * Force spm_lvl to ensure that.
116 */
117 hba->spm_lvl = 5;
118 ret = ufshcd_system_suspend(hba);
119 hba->spm_lvl = spm_lvl;
120 return ret;
121 }
122
123 #endif /* !CONFIG_PM_SLEEP */
124
125 #ifdef CONFIG_PM
ufshcd_pci_runtime_suspend(struct device * dev)126 static int ufshcd_pci_runtime_suspend(struct device *dev)
127 {
128 return ufshcd_runtime_suspend(dev_get_drvdata(dev));
129 }
ufshcd_pci_runtime_resume(struct device * dev)130 static int ufshcd_pci_runtime_resume(struct device *dev)
131 {
132 return ufshcd_runtime_resume(dev_get_drvdata(dev));
133 }
ufshcd_pci_runtime_idle(struct device * dev)134 static int ufshcd_pci_runtime_idle(struct device *dev)
135 {
136 return ufshcd_runtime_idle(dev_get_drvdata(dev));
137 }
138 #endif /* !CONFIG_PM */
139
140 /**
141 * ufshcd_pci_shutdown - main function to put the controller in reset state
142 * @pdev: pointer to PCI device handle
143 */
ufshcd_pci_shutdown(struct pci_dev * pdev)144 static void ufshcd_pci_shutdown(struct pci_dev *pdev)
145 {
146 ufshcd_shutdown((struct ufs_hba *)pci_get_drvdata(pdev));
147 }
148
149 /**
150 * ufshcd_pci_remove - de-allocate PCI/SCSI host and host memory space
151 * data structure memory
152 * @pdev: pointer to PCI handle
153 */
ufshcd_pci_remove(struct pci_dev * pdev)154 static void ufshcd_pci_remove(struct pci_dev *pdev)
155 {
156 struct ufs_hba *hba = pci_get_drvdata(pdev);
157
158 pm_runtime_forbid(&pdev->dev);
159 pm_runtime_get_noresume(&pdev->dev);
160 ufshcd_remove(hba);
161 ufshcd_dealloc_host(hba);
162 }
163
164 /**
165 * ufshcd_pci_probe - probe routine of the driver
166 * @pdev: pointer to PCI device handle
167 * @id: PCI device id
168 *
169 * Returns 0 on success, non-zero value on failure
170 */
171 static int
ufshcd_pci_probe(struct pci_dev * pdev,const struct pci_device_id * id)172 ufshcd_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
173 {
174 struct ufs_hba *hba;
175 void __iomem *mmio_base;
176 int err;
177
178 err = pcim_enable_device(pdev);
179 if (err) {
180 dev_err(&pdev->dev, "pcim_enable_device failed\n");
181 return err;
182 }
183
184 pci_set_master(pdev);
185
186 err = pcim_iomap_regions(pdev, 1 << 0, UFSHCD);
187 if (err < 0) {
188 dev_err(&pdev->dev, "request and iomap failed\n");
189 return err;
190 }
191
192 mmio_base = pcim_iomap_table(pdev)[0];
193
194 err = ufshcd_alloc_host(&pdev->dev, &hba);
195 if (err) {
196 dev_err(&pdev->dev, "Allocation failed\n");
197 return err;
198 }
199
200 hba->vops = (struct ufs_hba_variant_ops *)id->driver_data;
201
202 err = ufshcd_init(hba, mmio_base, pdev->irq);
203 if (err) {
204 dev_err(&pdev->dev, "Initialization failed\n");
205 ufshcd_dealloc_host(hba);
206 return err;
207 }
208
209 pci_set_drvdata(pdev, hba);
210 pm_runtime_put_noidle(&pdev->dev);
211 pm_runtime_allow(&pdev->dev);
212
213 return 0;
214 }
215
216 static const struct dev_pm_ops ufshcd_pci_pm_ops = {
217 #ifdef CONFIG_PM_SLEEP
218 .suspend = ufshcd_pci_suspend,
219 .resume = ufshcd_pci_resume,
220 .freeze = ufshcd_pci_suspend,
221 .thaw = ufshcd_pci_resume,
222 .poweroff = ufshcd_pci_poweroff,
223 .restore = ufshcd_pci_resume,
224 #endif
225 SET_RUNTIME_PM_OPS(ufshcd_pci_runtime_suspend,
226 ufshcd_pci_runtime_resume,
227 ufshcd_pci_runtime_idle)
228 };
229
230 static const struct pci_device_id ufshcd_pci_tbl[] = {
231 { PCI_VENDOR_ID_SAMSUNG, 0xC00C, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
232 { PCI_VDEVICE(INTEL, 0x9DFA), (kernel_ulong_t)&ufs_intel_cnl_hba_vops },
233 { PCI_VDEVICE(INTEL, 0x4B41), (kernel_ulong_t)&ufs_intel_cnl_hba_vops },
234 { PCI_VDEVICE(INTEL, 0x4B43), (kernel_ulong_t)&ufs_intel_cnl_hba_vops },
235 { } /* terminate list */
236 };
237
238 MODULE_DEVICE_TABLE(pci, ufshcd_pci_tbl);
239
240 static struct pci_driver ufshcd_pci_driver = {
241 .name = UFSHCD,
242 .id_table = ufshcd_pci_tbl,
243 .probe = ufshcd_pci_probe,
244 .remove = ufshcd_pci_remove,
245 .shutdown = ufshcd_pci_shutdown,
246 .driver = {
247 .pm = &ufshcd_pci_pm_ops
248 },
249 };
250
251 module_pci_driver(ufshcd_pci_driver);
252
253 MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
254 MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
255 MODULE_DESCRIPTION("UFS host controller PCI glue driver");
256 MODULE_LICENSE("GPL");
257 MODULE_VERSION(UFSHCD_DRIVER_VERSION);
258