1/*
2 * Universal Flash Storage Host controller Platform bus based glue driver
3 *
4 * This code is based on drivers/scsi/ufs/ufshcd-pltfrm.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 <linux/platform_device.h>
37#include <linux/pm_runtime.h>
38#include <linux/of.h>
39
40#include "ufshcd.h"
41#include "ufshcd-pltfrm.h"
42
43static int ufshcd_parse_clock_info(struct ufs_hba *hba)
44{
45	int ret = 0;
46	int cnt;
47	int i;
48	struct device *dev = hba->dev;
49	struct device_node *np = dev->of_node;
50	char *name;
51	u32 *clkfreq = NULL;
52	struct ufs_clk_info *clki;
53	int len = 0;
54	size_t sz = 0;
55
56	if (!np)
57		goto out;
58
59	INIT_LIST_HEAD(&hba->clk_list_head);
60
61	cnt = of_property_count_strings(np, "clock-names");
62	if (!cnt || (cnt == -EINVAL)) {
63		dev_info(dev, "%s: Unable to find clocks, assuming enabled\n",
64				__func__);
65	} else if (cnt < 0) {
66		dev_err(dev, "%s: count clock strings failed, err %d\n",
67				__func__, cnt);
68		ret = cnt;
69	}
70
71	if (cnt <= 0)
72		goto out;
73
74	if (!of_get_property(np, "freq-table-hz", &len)) {
75		dev_info(dev, "freq-table-hz property not specified\n");
76		goto out;
77	}
78
79	if (len <= 0)
80		goto out;
81
82	sz = len / sizeof(*clkfreq);
83	if (sz != 2 * cnt) {
84		dev_err(dev, "%s len mismatch\n", "freq-table-hz");
85		ret = -EINVAL;
86		goto out;
87	}
88
89	clkfreq = devm_kzalloc(dev, sz * sizeof(*clkfreq),
90			GFP_KERNEL);
91	if (!clkfreq) {
92		ret = -ENOMEM;
93		goto out;
94	}
95
96	ret = of_property_read_u32_array(np, "freq-table-hz",
97			clkfreq, sz);
98	if (ret && (ret != -EINVAL)) {
99		dev_err(dev, "%s: error reading array %d\n",
100				"freq-table-hz", ret);
101		return ret;
102	}
103
104	for (i = 0; i < sz; i += 2) {
105		ret = of_property_read_string_index(np,
106				"clock-names", i/2, (const char **)&name);
107		if (ret)
108			goto out;
109
110		clki = devm_kzalloc(dev, sizeof(*clki), GFP_KERNEL);
111		if (!clki) {
112			ret = -ENOMEM;
113			goto out;
114		}
115
116		clki->min_freq = clkfreq[i];
117		clki->max_freq = clkfreq[i+1];
118		clki->name = kstrdup(name, GFP_KERNEL);
119		dev_dbg(dev, "%s: min %u max %u name %s\n", "freq-table-hz",
120				clki->min_freq, clki->max_freq, clki->name);
121		list_add_tail(&clki->list, &hba->clk_list_head);
122	}
123out:
124	return ret;
125}
126
127#define MAX_PROP_SIZE 32
128static int ufshcd_populate_vreg(struct device *dev, const char *name,
129		struct ufs_vreg **out_vreg)
130{
131	int ret = 0;
132	char prop_name[MAX_PROP_SIZE];
133	struct ufs_vreg *vreg = NULL;
134	struct device_node *np = dev->of_node;
135
136	if (!np) {
137		dev_err(dev, "%s: non DT initialization\n", __func__);
138		goto out;
139	}
140
141	snprintf(prop_name, MAX_PROP_SIZE, "%s-supply", name);
142	if (!of_parse_phandle(np, prop_name, 0)) {
143		dev_info(dev, "%s: Unable to find %s regulator, assuming enabled\n",
144				__func__, prop_name);
145		goto out;
146	}
147
148	vreg = devm_kzalloc(dev, sizeof(*vreg), GFP_KERNEL);
149	if (!vreg)
150		return -ENOMEM;
151
152	vreg->name = kstrdup(name, GFP_KERNEL);
153
154	/* if fixed regulator no need further initialization */
155	snprintf(prop_name, MAX_PROP_SIZE, "%s-fixed-regulator", name);
156	if (of_property_read_bool(np, prop_name))
157		goto out;
158
159	snprintf(prop_name, MAX_PROP_SIZE, "%s-max-microamp", name);
160	ret = of_property_read_u32(np, prop_name, &vreg->max_uA);
161	if (ret) {
162		dev_err(dev, "%s: unable to find %s err %d\n",
163				__func__, prop_name, ret);
164		goto out_free;
165	}
166
167	vreg->min_uA = 0;
168	if (!strcmp(name, "vcc")) {
169		if (of_property_read_bool(np, "vcc-supply-1p8")) {
170			vreg->min_uV = UFS_VREG_VCC_1P8_MIN_UV;
171			vreg->max_uV = UFS_VREG_VCC_1P8_MAX_UV;
172		} else {
173			vreg->min_uV = UFS_VREG_VCC_MIN_UV;
174			vreg->max_uV = UFS_VREG_VCC_MAX_UV;
175		}
176	} else if (!strcmp(name, "vccq")) {
177		vreg->min_uV = UFS_VREG_VCCQ_MIN_UV;
178		vreg->max_uV = UFS_VREG_VCCQ_MAX_UV;
179	} else if (!strcmp(name, "vccq2")) {
180		vreg->min_uV = UFS_VREG_VCCQ2_MIN_UV;
181		vreg->max_uV = UFS_VREG_VCCQ2_MAX_UV;
182	}
183
184	goto out;
185
186out_free:
187	devm_kfree(dev, vreg);
188	vreg = NULL;
189out:
190	if (!ret)
191		*out_vreg = vreg;
192	return ret;
193}
194
195/**
196 * ufshcd_parse_regulator_info - get regulator info from device tree
197 * @hba: per adapter instance
198 *
199 * Get regulator info from device tree for vcc, vccq, vccq2 power supplies.
200 * If any of the supplies are not defined it is assumed that they are always-on
201 * and hence return zero. If the property is defined but parsing is failed
202 * then return corresponding error.
203 */
204static int ufshcd_parse_regulator_info(struct ufs_hba *hba)
205{
206	int err;
207	struct device *dev = hba->dev;
208	struct ufs_vreg_info *info = &hba->vreg_info;
209
210	err = ufshcd_populate_vreg(dev, "vdd-hba", &info->vdd_hba);
211	if (err)
212		goto out;
213
214	err = ufshcd_populate_vreg(dev, "vcc", &info->vcc);
215	if (err)
216		goto out;
217
218	err = ufshcd_populate_vreg(dev, "vccq", &info->vccq);
219	if (err)
220		goto out;
221
222	err = ufshcd_populate_vreg(dev, "vccq2", &info->vccq2);
223out:
224	return err;
225}
226
227#ifdef CONFIG_PM
228/**
229 * ufshcd_pltfrm_suspend - suspend power management function
230 * @dev: pointer to device handle
231 *
232 * Returns 0 if successful
233 * Returns non-zero otherwise
234 */
235int ufshcd_pltfrm_suspend(struct device *dev)
236{
237	return ufshcd_system_suspend(dev_get_drvdata(dev));
238}
239EXPORT_SYMBOL_GPL(ufshcd_pltfrm_suspend);
240
241/**
242 * ufshcd_pltfrm_resume - resume power management function
243 * @dev: pointer to device handle
244 *
245 * Returns 0 if successful
246 * Returns non-zero otherwise
247 */
248int ufshcd_pltfrm_resume(struct device *dev)
249{
250	return ufshcd_system_resume(dev_get_drvdata(dev));
251}
252EXPORT_SYMBOL_GPL(ufshcd_pltfrm_resume);
253
254int ufshcd_pltfrm_runtime_suspend(struct device *dev)
255{
256	return ufshcd_runtime_suspend(dev_get_drvdata(dev));
257}
258EXPORT_SYMBOL_GPL(ufshcd_pltfrm_runtime_suspend);
259
260int ufshcd_pltfrm_runtime_resume(struct device *dev)
261{
262	return ufshcd_runtime_resume(dev_get_drvdata(dev));
263}
264EXPORT_SYMBOL_GPL(ufshcd_pltfrm_runtime_resume);
265
266int ufshcd_pltfrm_runtime_idle(struct device *dev)
267{
268	return ufshcd_runtime_idle(dev_get_drvdata(dev));
269}
270EXPORT_SYMBOL_GPL(ufshcd_pltfrm_runtime_idle);
271
272#endif /* CONFIG_PM */
273
274void ufshcd_pltfrm_shutdown(struct platform_device *pdev)
275{
276	ufshcd_shutdown((struct ufs_hba *)platform_get_drvdata(pdev));
277}
278EXPORT_SYMBOL_GPL(ufshcd_pltfrm_shutdown);
279
280/**
281 * ufshcd_pltfrm_init - probe routine of the driver
282 * @pdev: pointer to Platform device handle
283 * @vops: pointer to variant ops
284 *
285 * Returns 0 on success, non-zero value on failure
286 */
287int ufshcd_pltfrm_init(struct platform_device *pdev,
288		       struct ufs_hba_variant_ops *vops)
289{
290	struct ufs_hba *hba;
291	void __iomem *mmio_base;
292	struct resource *mem_res;
293	int irq, err;
294	struct device *dev = &pdev->dev;
295
296	mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
297	mmio_base = devm_ioremap_resource(dev, mem_res);
298	if (IS_ERR(*(void **)&mmio_base)) {
299		err = PTR_ERR(*(void **)&mmio_base);
300		goto out;
301	}
302
303	irq = platform_get_irq(pdev, 0);
304	if (irq < 0) {
305		dev_err(dev, "IRQ resource not available\n");
306		err = -ENODEV;
307		goto out;
308	}
309
310	err = ufshcd_alloc_host(dev, &hba);
311	if (err) {
312		dev_err(&pdev->dev, "Allocation failed\n");
313		goto out;
314	}
315
316	hba->vops = vops;
317
318	err = ufshcd_parse_clock_info(hba);
319	if (err) {
320		dev_err(&pdev->dev, "%s: clock parse failed %d\n",
321				__func__, err);
322		goto dealloc_host;
323	}
324	err = ufshcd_parse_regulator_info(hba);
325	if (err) {
326		dev_err(&pdev->dev, "%s: regulator init failed %d\n",
327				__func__, err);
328		goto dealloc_host;
329	}
330
331	pm_runtime_set_active(&pdev->dev);
332	pm_runtime_enable(&pdev->dev);
333
334	err = ufshcd_init(hba, mmio_base, irq);
335	if (err) {
336		dev_err(dev, "Intialization failed\n");
337		goto out_disable_rpm;
338	}
339
340	platform_set_drvdata(pdev, hba);
341
342	return 0;
343
344out_disable_rpm:
345	pm_runtime_disable(&pdev->dev);
346	pm_runtime_set_suspended(&pdev->dev);
347dealloc_host:
348	ufshcd_dealloc_host(hba);
349out:
350	return err;
351}
352EXPORT_SYMBOL_GPL(ufshcd_pltfrm_init);
353
354MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
355MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
356MODULE_DESCRIPTION("UFS host controller Pltform bus based glue driver");
357MODULE_LICENSE("GPL");
358MODULE_VERSION(UFSHCD_DRIVER_VERSION);
359