Version:  2.0.40 2.2.26 2.4.37 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10

Linux/drivers/scsi/ufs/ufshcd-pltfrm.c

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

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us