blob: 0910441321f729bc9ea449c326e83c776c3906df [file] [log] [blame]
Thomas Gleixner8d7c56d2019-05-20 19:08:10 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +01002/*
3 * AHCI SATA platform library
4 *
5 * Copyright 2004-2005 Red Hat, Inc.
6 * Jeff Garzik <jgarzik@pobox.com>
7 * Copyright 2010 MontaVista Software, LLC.
8 * Anton Vorontsov <avorontsov@ru.mvista.com>
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +01009 */
10
11#include <linux/clk.h>
12#include <linux/kernel.h>
13#include <linux/gfp.h>
14#include <linux/module.h>
15#include <linux/pm.h>
16#include <linux/interrupt.h>
17#include <linux/device.h>
18#include <linux/platform_device.h>
19#include <linux/libata.h>
20#include <linux/ahci_platform.h>
21#include <linux/phy/phy.h>
22#include <linux/pm_runtime.h>
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +010023#include <linux/of_platform.h>
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +090024#include <linux/reset.h>
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +010025#include "ahci.h"
26
27static void ahci_host_stop(struct ata_host *host);
28
29struct ata_port_operations ahci_platform_ops = {
30 .inherits = &ahci_ops,
31 .host_stop = ahci_host_stop,
32};
33EXPORT_SYMBOL_GPL(ahci_platform_ops);
34
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +010035/**
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020036 * ahci_platform_enable_phys - Enable PHYs
37 * @hpriv: host private area to store config values
38 *
39 * This function enables all the PHYs found in hpriv->phys, if any.
40 * If a PHY fails to be enabled, it disables all the PHYs already
41 * enabled in reverse order and returns an error.
42 *
43 * RETURNS:
44 * 0 on success otherwise a negative error code
45 */
Florian Fainelli84b032d2019-12-10 10:53:44 -080046int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020047{
48 int rc, i;
49
50 for (i = 0; i < hpriv->nports; i++) {
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020051 rc = phy_init(hpriv->phys[i]);
52 if (rc)
53 goto disable_phys;
54
Miquel Raynal49e54182018-12-04 20:28:25 +010055 rc = phy_set_mode(hpriv->phys[i], PHY_MODE_SATA);
56 if (rc) {
57 phy_exit(hpriv->phys[i]);
58 goto disable_phys;
59 }
60
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020061 rc = phy_power_on(hpriv->phys[i]);
Pali Rohár45aefe32020-10-09 10:42:44 +020062 if (rc && !(rc == -EOPNOTSUPP && (hpriv->flags & AHCI_HFLAG_IGN_NOTSUPP_POWER_ON))) {
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020063 phy_exit(hpriv->phys[i]);
64 goto disable_phys;
65 }
66 }
67
68 return 0;
69
70disable_phys:
71 while (--i >= 0) {
72 phy_power_off(hpriv->phys[i]);
73 phy_exit(hpriv->phys[i]);
74 }
75 return rc;
76}
Florian Fainelli84b032d2019-12-10 10:53:44 -080077EXPORT_SYMBOL_GPL(ahci_platform_enable_phys);
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020078
79/**
80 * ahci_platform_disable_phys - Disable PHYs
81 * @hpriv: host private area to store config values
82 *
83 * This function disables all PHYs found in hpriv->phys.
84 */
Florian Fainelli84b032d2019-12-10 10:53:44 -080085void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020086{
87 int i;
88
89 for (i = 0; i < hpriv->nports; i++) {
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020090 phy_power_off(hpriv->phys[i]);
91 phy_exit(hpriv->phys[i]);
92 }
93}
Florian Fainelli84b032d2019-12-10 10:53:44 -080094EXPORT_SYMBOL_GPL(ahci_platform_disable_phys);
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +020095
96/**
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +010097 * ahci_platform_enable_clks - Enable platform clocks
98 * @hpriv: host private area to store config values
99 *
100 * This function enables all the clks found in hpriv->clks, starting at
101 * index 0. If any clk fails to enable it disables all the clks already
102 * enabled in reverse order, and then returns an error.
103 *
104 * RETURNS:
105 * 0 on success otherwise a negative error code
106 */
107int ahci_platform_enable_clks(struct ahci_host_priv *hpriv)
108{
109 int c, rc;
110
111 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++) {
112 rc = clk_prepare_enable(hpriv->clks[c]);
113 if (rc)
114 goto disable_unprepare_clk;
115 }
116 return 0;
117
118disable_unprepare_clk:
119 while (--c >= 0)
120 clk_disable_unprepare(hpriv->clks[c]);
121 return rc;
122}
123EXPORT_SYMBOL_GPL(ahci_platform_enable_clks);
124
125/**
126 * ahci_platform_disable_clks - Disable platform clocks
127 * @hpriv: host private area to store config values
128 *
129 * This function disables all the clks found in hpriv->clks, in reverse
130 * order of ahci_platform_enable_clks (starting at the end of the array).
131 */
132void ahci_platform_disable_clks(struct ahci_host_priv *hpriv)
133{
134 int c;
135
136 for (c = AHCI_MAX_CLKS - 1; c >= 0; c--)
137 if (hpriv->clks[c])
138 clk_disable_unprepare(hpriv->clks[c]);
139}
140EXPORT_SYMBOL_GPL(ahci_platform_disable_clks);
141
142/**
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100143 * ahci_platform_enable_regulators - Enable regulators
144 * @hpriv: host private area to store config values
145 *
Corentin Labbea37da912018-09-03 12:01:54 +0200146 * This function enables all the regulators found in controller and
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100147 * hpriv->target_pwrs, if any. If a regulator fails to be enabled, it
148 * disables all the regulators already enabled in reverse order and
149 * returns an error.
150 *
151 * RETURNS:
152 * 0 on success otherwise a negative error code
153 */
154int ahci_platform_enable_regulators(struct ahci_host_priv *hpriv)
155{
156 int rc, i;
157
Mark Brown962399b2019-10-16 11:51:05 +0100158 rc = regulator_enable(hpriv->ahci_regulator);
159 if (rc)
160 return rc;
Corentin Labbea37da912018-09-03 12:01:54 +0200161
Mark Brown962399b2019-10-16 11:51:05 +0100162 rc = regulator_enable(hpriv->phy_regulator);
163 if (rc)
164 goto disable_ahci_pwrs;
Corentin Labbef20fb262018-09-03 12:01:56 +0200165
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100166 for (i = 0; i < hpriv->nports; i++) {
167 if (!hpriv->target_pwrs[i])
168 continue;
169
170 rc = regulator_enable(hpriv->target_pwrs[i]);
171 if (rc)
172 goto disable_target_pwrs;
173 }
174
175 return 0;
176
177disable_target_pwrs:
178 while (--i >= 0)
179 if (hpriv->target_pwrs[i])
180 regulator_disable(hpriv->target_pwrs[i]);
181
Mark Brown962399b2019-10-16 11:51:05 +0100182 regulator_disable(hpriv->phy_regulator);
Corentin Labbef20fb262018-09-03 12:01:56 +0200183disable_ahci_pwrs:
Mark Brown962399b2019-10-16 11:51:05 +0100184 regulator_disable(hpriv->ahci_regulator);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100185 return rc;
186}
187EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators);
188
189/**
190 * ahci_platform_disable_regulators - Disable regulators
191 * @hpriv: host private area to store config values
192 *
Corentin Labbea37da912018-09-03 12:01:54 +0200193 * This function disables all regulators found in hpriv->target_pwrs and
194 * AHCI controller.
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100195 */
196void ahci_platform_disable_regulators(struct ahci_host_priv *hpriv)
197{
198 int i;
199
200 for (i = 0; i < hpriv->nports; i++) {
201 if (!hpriv->target_pwrs[i])
202 continue;
203 regulator_disable(hpriv->target_pwrs[i]);
204 }
Corentin Labbea37da912018-09-03 12:01:54 +0200205
Mark Brown962399b2019-10-16 11:51:05 +0100206 regulator_disable(hpriv->ahci_regulator);
207 regulator_disable(hpriv->phy_regulator);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100208}
209EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators);
210/**
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100211 * ahci_platform_enable_resources - Enable platform resources
212 * @hpriv: host private area to store config values
213 *
214 * This function enables all ahci_platform managed resources in the
215 * following order:
216 * 1) Regulator
217 * 2) Clocks (through ahci_platform_enable_clks)
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +0900218 * 3) Resets
219 * 4) Phys
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100220 *
221 * If resource enabling fails at any point the previous enabled resources
222 * are disabled in reverse order.
223 *
224 * RETURNS:
225 * 0 on success otherwise a negative error code
226 */
227int ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
228{
229 int rc;
230
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100231 rc = ahci_platform_enable_regulators(hpriv);
232 if (rc)
233 return rc;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100234
235 rc = ahci_platform_enable_clks(hpriv);
236 if (rc)
237 goto disable_regulator;
238
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +0900239 rc = reset_control_deassert(hpriv->rsts);
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200240 if (rc)
241 goto disable_clks;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100242
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +0900243 rc = ahci_platform_enable_phys(hpriv);
244 if (rc)
245 goto disable_resets;
246
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100247 return 0;
248
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +0900249disable_resets:
250 reset_control_assert(hpriv->rsts);
251
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100252disable_clks:
253 ahci_platform_disable_clks(hpriv);
254
255disable_regulator:
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100256 ahci_platform_disable_regulators(hpriv);
257
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100258 return rc;
259}
260EXPORT_SYMBOL_GPL(ahci_platform_enable_resources);
261
262/**
263 * ahci_platform_disable_resources - Disable platform resources
264 * @hpriv: host private area to store config values
265 *
266 * This function disables all ahci_platform managed resources in the
267 * following order:
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200268 * 1) Phys
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +0900269 * 2) Resets
270 * 3) Clocks (through ahci_platform_disable_clks)
271 * 4) Regulator
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100272 */
273void ahci_platform_disable_resources(struct ahci_host_priv *hpriv)
274{
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200275 ahci_platform_disable_phys(hpriv);
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100276
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +0900277 reset_control_assert(hpriv->rsts);
278
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100279 ahci_platform_disable_clks(hpriv);
280
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100281 ahci_platform_disable_regulators(hpriv);
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100282}
283EXPORT_SYMBOL_GPL(ahci_platform_disable_resources);
284
285static void ahci_platform_put_resources(struct device *dev, void *res)
286{
287 struct ahci_host_priv *hpriv = res;
288 int c;
289
290 if (hpriv->got_runtime_pm) {
Tejun Heoeac7e072018-08-06 10:22:35 -0700291 pm_runtime_put_sync(dev);
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100292 pm_runtime_disable(dev);
293 }
294
295 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++)
296 clk_put(hpriv->clks[c]);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100297 /*
298 * The regulators are tied to child node device and not to the
299 * SATA device itself. So we can't use devm for automatically
300 * releasing them. We have to do it manually here.
301 */
302 for (c = 0; c < hpriv->nports; c++)
303 if (hpriv->target_pwrs && hpriv->target_pwrs[c])
304 regulator_put(hpriv->target_pwrs[c]);
Corentin Labbe04ba9482018-07-17 10:49:35 +0000305
306 kfree(hpriv->target_pwrs);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100307}
308
309static int ahci_platform_get_phy(struct ahci_host_priv *hpriv, u32 port,
310 struct device *dev, struct device_node *node)
311{
312 int rc;
313
314 hpriv->phys[port] = devm_of_phy_get(dev, node, NULL);
315
316 if (!IS_ERR(hpriv->phys[port]))
317 return 0;
318
319 rc = PTR_ERR(hpriv->phys[port]);
320 switch (rc) {
321 case -ENOSYS:
322 /* No PHY support. Check if PHY is required. */
323 if (of_find_property(node, "phys", NULL)) {
324 dev_err(dev,
Rob Herring2ce711f2018-08-27 20:52:10 -0500325 "couldn't get PHY in node %pOFn: ENOSYS\n",
326 node);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100327 break;
328 }
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500329 fallthrough;
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100330 case -ENODEV:
331 /* continue normally */
332 hpriv->phys[port] = NULL;
333 rc = 0;
334 break;
Miquel Raynal090bb802019-07-31 14:26:51 +0200335 case -EPROBE_DEFER:
336 /* Do not complain yet */
337 break;
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100338
339 default:
340 dev_err(dev,
Rob Herring2ce711f2018-08-27 20:52:10 -0500341 "couldn't get PHY in node %pOFn: %d\n",
342 node, rc);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100343
344 break;
345 }
346
347 return rc;
348}
349
350static int ahci_platform_get_regulator(struct ahci_host_priv *hpriv, u32 port,
351 struct device *dev)
352{
353 struct regulator *target_pwr;
354 int rc = 0;
355
Mark Brown962399b2019-10-16 11:51:05 +0100356 target_pwr = regulator_get(dev, "target");
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100357
358 if (!IS_ERR(target_pwr))
359 hpriv->target_pwrs[port] = target_pwr;
360 else
361 rc = PTR_ERR(target_pwr);
362
363 return rc;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100364}
365
366/**
367 * ahci_platform_get_resources - Get platform resources
368 * @pdev: platform device to get resources for
Kunihiko Hayashi16af2d62018-08-22 21:13:01 +0900369 * @flags: bitmap representing the resource to get
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100370 *
371 * This function allocates an ahci_host_priv struct, and gets the following
372 * resources, storing a reference to them inside the returned struct:
373 *
374 * 1) mmio registers (IORESOURCE_MEM 0, mandatory)
375 * 2) regulator for controlling the targets power (optional)
Corentin Labbea37da912018-09-03 12:01:54 +0200376 * regulator for controlling the AHCI controller (optional)
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100377 * 3) 0 - AHCI_MAX_CLKS clocks, as specified in the devs devicetree node,
378 * or for non devicetree enabled platforms a single clock
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +0900379 * 4) resets, if flags has AHCI_PLATFORM_GET_RESETS (optional)
380 * 5) phys (optional)
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100381 *
382 * RETURNS:
383 * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
384 */
Kunihiko Hayashi16af2d62018-08-22 21:13:01 +0900385struct ahci_host_priv *ahci_platform_get_resources(struct platform_device *pdev,
386 unsigned int flags)
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100387{
388 struct device *dev = &pdev->dev;
389 struct ahci_host_priv *hpriv;
390 struct clk *clk;
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200391 struct device_node *child;
Corentin Labbea4b9f5e2018-07-12 11:41:30 +0000392 int i, enabled_ports = 0, rc = -ENOMEM, child_nodes;
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200393 u32 mask_port_map = 0;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100394
395 if (!devres_open_group(dev, NULL, GFP_KERNEL))
396 return ERR_PTR(-ENOMEM);
397
398 hpriv = devres_alloc(ahci_platform_put_resources, sizeof(*hpriv),
399 GFP_KERNEL);
400 if (!hpriv)
401 goto err_out;
402
403 devres_add(dev, hpriv);
404
405 hpriv->mmio = devm_ioremap_resource(dev,
406 platform_get_resource(pdev, IORESOURCE_MEM, 0));
407 if (IS_ERR(hpriv->mmio)) {
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100408 rc = PTR_ERR(hpriv->mmio);
409 goto err_out;
410 }
411
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100412 for (i = 0; i < AHCI_MAX_CLKS; i++) {
413 /*
414 * For now we must use clk_get(dev, NULL) for the first clock,
415 * because some platforms (da850, spear13xx) are not yet
416 * converted to use devicetree for clocks. For new platforms
417 * this is equivalent to of_clk_get(dev->of_node, 0).
418 */
419 if (i == 0)
420 clk = clk_get(dev, NULL);
421 else
422 clk = of_clk_get(dev->of_node, i);
423
424 if (IS_ERR(clk)) {
425 rc = PTR_ERR(clk);
426 if (rc == -EPROBE_DEFER)
427 goto err_out;
428 break;
429 }
430 hpriv->clks[i] = clk;
431 }
432
Mark Brown962399b2019-10-16 11:51:05 +0100433 hpriv->ahci_regulator = devm_regulator_get(dev, "ahci");
Corentin Labbea37da912018-09-03 12:01:54 +0200434 if (IS_ERR(hpriv->ahci_regulator)) {
435 rc = PTR_ERR(hpriv->ahci_regulator);
Mark Brown962399b2019-10-16 11:51:05 +0100436 if (rc != 0)
Corentin Labbea37da912018-09-03 12:01:54 +0200437 goto err_out;
Corentin Labbea37da912018-09-03 12:01:54 +0200438 }
439
Mark Brown962399b2019-10-16 11:51:05 +0100440 hpriv->phy_regulator = devm_regulator_get(dev, "phy");
Corentin Labbef20fb262018-09-03 12:01:56 +0200441 if (IS_ERR(hpriv->phy_regulator)) {
442 rc = PTR_ERR(hpriv->phy_regulator);
Wang Hai776c7502021-10-13 14:16:31 +0800443 goto err_out;
Corentin Labbef20fb262018-09-03 12:01:56 +0200444 }
445
Kunihiko Hayashi9d2ab992018-08-22 21:13:02 +0900446 if (flags & AHCI_PLATFORM_GET_RESETS) {
447 hpriv->rsts = devm_reset_control_array_get_optional_shared(dev);
448 if (IS_ERR(hpriv->rsts)) {
449 rc = PTR_ERR(hpriv->rsts);
450 goto err_out;
451 }
452 }
453
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100454 hpriv->nports = child_nodes = of_get_child_count(dev->of_node);
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200455
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100456 /*
457 * If no sub-node was found, we still need to set nports to
458 * one in order to be able to use the
459 * ahci_platform_[en|dis]able_[phys|regulators] functions.
460 */
461 if (!child_nodes)
462 hpriv->nports = 1;
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200463
Corentin Labbea4b9f5e2018-07-12 11:41:30 +0000464 hpriv->phys = devm_kcalloc(dev, hpriv->nports, sizeof(*hpriv->phys), GFP_KERNEL);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100465 if (!hpriv->phys) {
466 rc = -ENOMEM;
467 goto err_out;
468 }
Corentin Labbe04ba9482018-07-17 10:49:35 +0000469 /*
470 * We cannot use devm_ here, since ahci_platform_put_resources() uses
471 * target_pwrs after devm_ have freed memory
472 */
473 hpriv->target_pwrs = kcalloc(hpriv->nports, sizeof(*hpriv->target_pwrs), GFP_KERNEL);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100474 if (!hpriv->target_pwrs) {
475 rc = -ENOMEM;
476 goto err_out;
477 }
478
479 if (child_nodes) {
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200480 for_each_child_of_node(dev->of_node, child) {
481 u32 port;
Guenter Roeckf627cfde2015-01-31 10:36:22 -0800482 struct platform_device *port_dev __maybe_unused;
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200483
484 if (!of_device_is_available(child))
485 continue;
486
487 if (of_property_read_u32(child, "reg", &port)) {
488 rc = -EINVAL;
Nishka Dasguptad7f76f32019-08-15 11:30:14 +0530489 of_node_put(child);
Mikko Perttunenacbd5732014-06-17 15:07:55 +0300490 goto err_out;
491 }
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100492
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200493 if (port >= hpriv->nports) {
494 dev_warn(dev, "invalid port number %d\n", port);
495 continue;
496 }
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200497 mask_port_map |= BIT(port);
498
Guenter Roeckf627cfde2015-01-31 10:36:22 -0800499#ifdef CONFIG_OF_ADDRESS
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100500 of_platform_device_create(child, NULL, NULL);
501
502 port_dev = of_find_device_by_node(child);
503
504 if (port_dev) {
505 rc = ahci_platform_get_regulator(hpriv, port,
506 &port_dev->dev);
Nishka Dasguptad7f76f32019-08-15 11:30:14 +0530507 if (rc == -EPROBE_DEFER) {
508 of_node_put(child);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100509 goto err_out;
Nishka Dasguptad7f76f32019-08-15 11:30:14 +0530510 }
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200511 }
Guenter Roeckf627cfde2015-01-31 10:36:22 -0800512#endif
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200513
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100514 rc = ahci_platform_get_phy(hpriv, port, dev, child);
Nishka Dasguptad7f76f32019-08-15 11:30:14 +0530515 if (rc) {
516 of_node_put(child);
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100517 goto err_out;
Nishka Dasguptad7f76f32019-08-15 11:30:14 +0530518 }
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100519
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200520 enabled_ports++;
521 }
522 if (!enabled_ports) {
523 dev_warn(dev, "No port enabled\n");
524 rc = -ENODEV;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100525 goto err_out;
526 }
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200527
528 if (!hpriv->mask_port_map)
529 hpriv->mask_port_map = mask_port_map;
530 } else {
531 /*
532 * If no sub-node was found, keep this for device tree
533 * compatibility
534 */
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100535 rc = ahci_platform_get_phy(hpriv, 0, dev, dev->of_node);
536 if (rc)
537 goto err_out;
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200538
Gregory CLEMENTc7d7dde2015-01-15 15:09:37 +0100539 rc = ahci_platform_get_regulator(hpriv, 0, dev);
540 if (rc == -EPROBE_DEFER)
541 goto err_out;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100542 }
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100543 pm_runtime_enable(dev);
Tejun Heoeac7e072018-08-06 10:22:35 -0700544 pm_runtime_get_sync(dev);
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100545 hpriv->got_runtime_pm = true;
546
547 devres_remove_group(dev, NULL);
548 return hpriv;
549
550err_out:
551 devres_release_group(dev, NULL);
552 return ERR_PTR(rc);
553}
554EXPORT_SYMBOL_GPL(ahci_platform_get_resources);
555
556/**
557 * ahci_platform_init_host - Bring up an ahci-platform host
558 * @pdev: platform device pointer for the host
559 * @hpriv: ahci-host private data for the host
560 * @pi_template: template for the ata_port_info to use
Akinobu Mita018d5ef2015-01-29 08:30:29 +0900561 * @sht: scsi_host_template to use when registering
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100562 *
563 * This function does all the usual steps needed to bring up an
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200564 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100565 * must be initialized / enabled before calling this.
566 *
567 * RETURNS:
568 * 0 on success otherwise a negative error code
569 */
570int ahci_platform_init_host(struct platform_device *pdev,
571 struct ahci_host_priv *hpriv,
Akinobu Mita018d5ef2015-01-29 08:30:29 +0900572 const struct ata_port_info *pi_template,
573 struct scsi_host_template *sht)
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100574{
575 struct device *dev = &pdev->dev;
576 struct ata_port_info pi = *pi_template;
577 const struct ata_port_info *ppi[] = { &pi, NULL };
578 struct ata_host *host;
579 int i, irq, n_ports, rc;
580
581 irq = platform_get_irq(pdev, 0);
Sergey Shtylyovb30d0042021-03-15 23:15:06 +0300582 if (irq < 0) {
Thomas Petazzonic0346402017-05-16 14:06:12 +0200583 if (irq != -EPROBE_DEFER)
584 dev_err(dev, "no irq\n");
585 return irq;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100586 }
Sergey Shtylyovb30d0042021-03-15 23:15:06 +0300587 if (!irq)
588 return -EINVAL;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100589
Robert Richter21bfd1a2015-05-31 13:55:18 +0200590 hpriv->irq = irq;
591
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100592 /* prepare host */
Thierry Redingc4121c62014-08-01 16:30:37 +0200593 pi.private_data = (void *)(unsigned long)hpriv->flags;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100594
Antoine Ténart725c7b52014-07-30 20:13:56 +0200595 ahci_save_initial_config(dev, hpriv);
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100596
597 if (hpriv->cap & HOST_CAP_NCQ)
598 pi.flags |= ATA_FLAG_NCQ;
599
600 if (hpriv->cap & HOST_CAP_PMP)
601 pi.flags |= ATA_FLAG_PMP;
602
603 ahci_set_em_messages(hpriv, &pi);
604
605 /* CAP.NP sometimes indicate the index of the last enabled
606 * port, at other times, that of the last possible port, so
607 * determining the maximum port number requires looking at
608 * both CAP.NP and port_map.
609 */
610 n_ports = max(ahci_nr_ports(hpriv->cap), fls(hpriv->port_map));
611
612 host = ata_host_alloc_pinfo(dev, ppi, n_ports);
613 if (!host)
614 return -ENOMEM;
615
616 host->private_data = hpriv;
617
618 if (!(hpriv->cap & HOST_CAP_SSS) || ahci_ignore_sss)
619 host->flags |= ATA_HOST_PARALLEL_SCAN;
620 else
621 dev_info(dev, "SSS flag set, parallel bus scan disabled\n");
622
623 if (pi.flags & ATA_FLAG_EM)
624 ahci_reset_em(host);
625
626 for (i = 0; i < host->n_ports; i++) {
627 struct ata_port *ap = host->ports[i];
628
629 ata_port_desc(ap, "mmio %pR",
630 platform_get_resource(pdev, IORESOURCE_MEM, 0));
631 ata_port_desc(ap, "port 0x%x", 0x100 + ap->port_no * 0x80);
632
633 /* set enclosure management message type */
634 if (ap->flags & ATA_FLAG_EM)
635 ap->em_message_type = hpriv->em_msg_type;
636
637 /* disabled/not-implemented port */
638 if (!(hpriv->port_map & (1 << i)))
639 ap->ops = &ata_dummy_port_ops;
640 }
641
Suravee Suthikulpanitcc7a9e22014-06-12 12:40:23 -0500642 if (hpriv->cap & HOST_CAP_64) {
643 rc = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
644 if (rc) {
645 rc = dma_coerce_mask_and_coherent(dev,
646 DMA_BIT_MASK(32));
647 if (rc) {
648 dev_err(dev, "Failed to enable 64-bit DMA.\n");
649 return rc;
650 }
651 dev_warn(dev, "Enable 32-bit DMA instead of 64-bit.\n");
652 }
653 }
654
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100655 rc = ahci_reset_controller(host);
656 if (rc)
657 return rc;
658
659 ahci_init_controller(host);
660 ahci_print_info(host, "platform");
661
Robert Richter21bfd1a2015-05-31 13:55:18 +0200662 return ahci_host_activate(host, sht);
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100663}
664EXPORT_SYMBOL_GPL(ahci_platform_init_host);
665
666static void ahci_host_stop(struct ata_host *host)
667{
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100668 struct ahci_host_priv *hpriv = host->private_data;
669
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100670 ahci_platform_disable_resources(hpriv);
671}
672
Nate Watterson8eede5b2017-07-20 15:26:24 -0400673/**
674 * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
Corentin Labbe7cf5fc62018-07-12 11:41:29 +0000675 * @pdev: platform device pointer for the host
Nate Watterson8eede5b2017-07-20 15:26:24 -0400676 *
677 * This function is called during system shutdown and performs the minimal
678 * deconfiguration required to ensure that an ahci_platform host cannot
679 * corrupt or otherwise interfere with a new kernel being started with kexec.
680 */
681void ahci_platform_shutdown(struct platform_device *pdev)
682{
683 struct ata_host *host = platform_get_drvdata(pdev);
684 struct ahci_host_priv *hpriv = host->private_data;
685 void __iomem *mmio = hpriv->mmio;
686 int i;
687
688 for (i = 0; i < host->n_ports; i++) {
689 struct ata_port *ap = host->ports[i];
690
691 /* Disable port interrupts */
692 if (ap->ops->freeze)
693 ap->ops->freeze(ap);
694
695 /* Stop the port DMA engines */
696 if (ap->ops->port_stop)
697 ap->ops->port_stop(ap);
698 }
699
700 /* Disable and clear host interrupts */
701 writel(readl(mmio + HOST_CTL) & ~HOST_IRQ_EN, mmio + HOST_CTL);
702 readl(mmio + HOST_CTL); /* flush */
703 writel(GENMASK(host->n_ports, 0), mmio + HOST_IRQ_STAT);
704}
705EXPORT_SYMBOL_GPL(ahci_platform_shutdown);
706
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100707#ifdef CONFIG_PM_SLEEP
708/**
709 * ahci_platform_suspend_host - Suspend an ahci-platform host
710 * @dev: device pointer for the host
711 *
712 * This function does all the usual steps needed to suspend an
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200713 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100714 * must be disabled after calling this.
715 *
716 * RETURNS:
717 * 0 on success otherwise a negative error code
718 */
719int ahci_platform_suspend_host(struct device *dev)
720{
721 struct ata_host *host = dev_get_drvdata(dev);
722 struct ahci_host_priv *hpriv = host->private_data;
723 void __iomem *mmio = hpriv->mmio;
724 u32 ctl;
725
726 if (hpriv->flags & AHCI_HFLAG_NO_SUSPEND) {
727 dev_err(dev, "firmware update required for suspend/resume\n");
728 return -EIO;
729 }
730
731 /*
732 * AHCI spec rev1.1 section 8.3.3:
733 * Software must disable interrupts prior to requesting a
734 * transition of the HBA to D3 state.
735 */
736 ctl = readl(mmio + HOST_CTL);
737 ctl &= ~HOST_IRQ_EN;
738 writel(ctl, mmio + HOST_CTL);
739 readl(mmio + HOST_CTL); /* flush */
740
Miquel Raynal49e54182018-12-04 20:28:25 +0100741 if (hpriv->flags & AHCI_HFLAG_SUSPEND_PHYS)
742 ahci_platform_disable_phys(hpriv);
743
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100744 return ata_host_suspend(host, PMSG_SUSPEND);
745}
746EXPORT_SYMBOL_GPL(ahci_platform_suspend_host);
747
748/**
749 * ahci_platform_resume_host - Resume an ahci-platform host
750 * @dev: device pointer for the host
751 *
752 * This function does all the usual steps needed to resume an ahci-platform
Antoine Ténartb1a9edbd2014-07-30 20:13:57 +0200753 * host, note any necessary resources (ie clks, phys, etc.) must be
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100754 * initialized / enabled before calling this.
755 *
756 * RETURNS:
757 * 0 on success otherwise a negative error code
758 */
759int ahci_platform_resume_host(struct device *dev)
760{
761 struct ata_host *host = dev_get_drvdata(dev);
Miquel Raynal49e54182018-12-04 20:28:25 +0100762 struct ahci_host_priv *hpriv = host->private_data;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100763 int rc;
764
765 if (dev->power.power_state.event == PM_EVENT_SUSPEND) {
766 rc = ahci_reset_controller(host);
767 if (rc)
768 return rc;
769
770 ahci_init_controller(host);
771 }
772
Miquel Raynal49e54182018-12-04 20:28:25 +0100773 if (hpriv->flags & AHCI_HFLAG_SUSPEND_PHYS)
774 ahci_platform_enable_phys(hpriv);
775
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100776 ata_host_resume(host);
777
778 return 0;
779}
780EXPORT_SYMBOL_GPL(ahci_platform_resume_host);
781
Tejun Heoeac7e072018-08-06 10:22:35 -0700782/**
783 * ahci_platform_suspend - Suspend an ahci-platform device
784 * @dev: the platform device to suspend
785 *
786 * This function suspends the host associated with the device, followed by
787 * disabling all the resources of the device.
788 *
789 * RETURNS:
790 * 0 on success otherwise a negative error code
791 */
792int ahci_platform_suspend(struct device *dev)
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100793{
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100794 struct ata_host *host = dev_get_drvdata(dev);
795 struct ahci_host_priv *hpriv = host->private_data;
796 int rc;
797
798 rc = ahci_platform_suspend_host(dev);
799 if (rc)
800 return rc;
801
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100802 ahci_platform_disable_resources(hpriv);
803
804 return 0;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100805}
806EXPORT_SYMBOL_GPL(ahci_platform_suspend);
807
808/**
809 * ahci_platform_resume - Resume an ahci-platform device
810 * @dev: the platform device to resume
811 *
812 * This function enables all the resources of the device followed by
813 * resuming the host associated with the device.
814 *
815 * RETURNS:
816 * 0 on success otherwise a negative error code
817 */
818int ahci_platform_resume(struct device *dev)
819{
Tejun Heoeac7e072018-08-06 10:22:35 -0700820 struct ata_host *host = dev_get_drvdata(dev);
821 struct ahci_host_priv *hpriv = host->private_data;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100822 int rc;
823
Tejun Heoeac7e072018-08-06 10:22:35 -0700824 rc = ahci_platform_enable_resources(hpriv);
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100825 if (rc)
826 return rc;
827
Tejun Heoeac7e072018-08-06 10:22:35 -0700828 rc = ahci_platform_resume_host(dev);
829 if (rc)
830 goto disable_resources;
831
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100832 /* We resumed so update PM runtime state */
833 pm_runtime_disable(dev);
834 pm_runtime_set_active(dev);
835 pm_runtime_enable(dev);
836
837 return 0;
Tejun Heoeac7e072018-08-06 10:22:35 -0700838
839disable_resources:
840 ahci_platform_disable_resources(hpriv);
841
842 return rc;
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100843}
844EXPORT_SYMBOL_GPL(ahci_platform_resume);
Bartlomiej Zolnierkiewiczfd990552014-03-25 19:51:39 +0100845#endif
846
847MODULE_DESCRIPTION("AHCI SATA platform library");
848MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
849MODULE_LICENSE("GPL");