Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
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>
9 */
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>
23#include <linux/of_platform.h>
24#include <linux/reset.h>
25#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
35/**
36 * 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 */
46int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
47{
48 int rc, i;
49
50 for (i = 0; i < hpriv->nports; i++) {
51 rc = phy_init(hpriv->phys[i]);
52 if (rc)
53 goto disable_phys;
54
55 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
61 rc = phy_power_on(hpriv->phys[i]);
62 if (rc) {
63 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}
77EXPORT_SYMBOL_GPL(ahci_platform_enable_phys);
78
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 */
85void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
86{
87 int i;
88
89 for (i = 0; i < hpriv->nports; i++) {
90 phy_power_off(hpriv->phys[i]);
91 phy_exit(hpriv->phys[i]);
92 }
93}
94EXPORT_SYMBOL_GPL(ahci_platform_disable_phys);
95
96/**
97 * 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/**
143 * ahci_platform_enable_regulators - Enable regulators
144 * @hpriv: host private area to store config values
145 *
146 * This function enables all the regulators found in controller and
147 * 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
158 rc = regulator_enable(hpriv->ahci_regulator);
159 if (rc)
160 return rc;
161
162 rc = regulator_enable(hpriv->phy_regulator);
163 if (rc)
164 goto disable_ahci_pwrs;
165
166 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
182 regulator_disable(hpriv->phy_regulator);
183disable_ahci_pwrs:
184 regulator_disable(hpriv->ahci_regulator);
185 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 *
193 * This function disables all regulators found in hpriv->target_pwrs and
194 * AHCI controller.
195 */
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 }
205
206 regulator_disable(hpriv->ahci_regulator);
207 regulator_disable(hpriv->phy_regulator);
208}
209EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators);
210/**
211 * 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)
218 * 3) Resets
219 * 4) Phys
220 *
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
231 rc = ahci_platform_enable_regulators(hpriv);
232 if (rc)
233 return rc;
234
235 rc = ahci_platform_enable_clks(hpriv);
236 if (rc)
237 goto disable_regulator;
238
239 rc = reset_control_deassert(hpriv->rsts);
240 if (rc)
241 goto disable_clks;
242
243 rc = ahci_platform_enable_phys(hpriv);
244 if (rc)
245 goto disable_resets;
246
247 return 0;
248
249disable_resets:
250 reset_control_assert(hpriv->rsts);
251
252disable_clks:
253 ahci_platform_disable_clks(hpriv);
254
255disable_regulator:
256 ahci_platform_disable_regulators(hpriv);
257
258 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:
268 * 1) Phys
269 * 2) Resets
270 * 3) Clocks (through ahci_platform_disable_clks)
271 * 4) Regulator
272 */
273void ahci_platform_disable_resources(struct ahci_host_priv *hpriv)
274{
275 ahci_platform_disable_phys(hpriv);
276
277 reset_control_assert(hpriv->rsts);
278
279 ahci_platform_disable_clks(hpriv);
280
281 ahci_platform_disable_regulators(hpriv);
282}
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) {
291 pm_runtime_put_sync(dev);
292 pm_runtime_disable(dev);
293 }
294
295 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++)
296 clk_put(hpriv->clks[c]);
297 /*
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]);
305
306 kfree(hpriv->target_pwrs);
307}
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,
325 "couldn't get PHY in node %pOFn: ENOSYS\n",
326 node);
327 break;
328 }
329 fallthrough;
330 case -ENODEV:
331 /* continue normally */
332 hpriv->phys[port] = NULL;
333 rc = 0;
334 break;
335 case -EPROBE_DEFER:
336 /* Do not complain yet */
337 break;
338
339 default:
340 dev_err(dev,
341 "couldn't get PHY in node %pOFn: %d\n",
342 node, rc);
343
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
356 target_pwr = regulator_get(dev, "target");
357
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;
364}
365
366/**
367 * ahci_platform_get_resources - Get platform resources
368 * @pdev: platform device to get resources for
369 * @flags: bitmap representing the resource to get
370 *
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)
376 * regulator for controlling the AHCI controller (optional)
377 * 3) 0 - AHCI_MAX_CLKS clocks, as specified in the devs devicetree node,
378 * or for non devicetree enabled platforms a single clock
379 * 4) resets, if flags has AHCI_PLATFORM_GET_RESETS (optional)
380 * 5) phys (optional)
381 *
382 * RETURNS:
383 * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
384 */
385struct ahci_host_priv *ahci_platform_get_resources(struct platform_device *pdev,
386 unsigned int flags)
387{
388 struct device *dev = &pdev->dev;
389 struct ahci_host_priv *hpriv;
390 struct clk *clk;
391 struct device_node *child;
392 int i, enabled_ports = 0, rc = -ENOMEM, child_nodes;
393 u32 mask_port_map = 0;
394
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)) {
408 rc = PTR_ERR(hpriv->mmio);
409 goto err_out;
410 }
411
412 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
433 hpriv->ahci_regulator = devm_regulator_get(dev, "ahci");
434 if (IS_ERR(hpriv->ahci_regulator)) {
435 rc = PTR_ERR(hpriv->ahci_regulator);
436 if (rc != 0)
437 goto err_out;
438 }
439
440 hpriv->phy_regulator = devm_regulator_get(dev, "phy");
441 if (IS_ERR(hpriv->phy_regulator)) {
442 rc = PTR_ERR(hpriv->phy_regulator);
443 if (rc == -EPROBE_DEFER)
444 goto err_out;
445 rc = 0;
446 hpriv->phy_regulator = NULL;
447 }
448
449 if (flags & AHCI_PLATFORM_GET_RESETS) {
450 hpriv->rsts = devm_reset_control_array_get_optional_shared(dev);
451 if (IS_ERR(hpriv->rsts)) {
452 rc = PTR_ERR(hpriv->rsts);
453 goto err_out;
454 }
455 }
456
457 hpriv->nports = child_nodes = of_get_child_count(dev->of_node);
458
459 /*
460 * If no sub-node was found, we still need to set nports to
461 * one in order to be able to use the
462 * ahci_platform_[en|dis]able_[phys|regulators] functions.
463 */
464 if (!child_nodes)
465 hpriv->nports = 1;
466
467 hpriv->phys = devm_kcalloc(dev, hpriv->nports, sizeof(*hpriv->phys), GFP_KERNEL);
468 if (!hpriv->phys) {
469 rc = -ENOMEM;
470 goto err_out;
471 }
472 /*
473 * We cannot use devm_ here, since ahci_platform_put_resources() uses
474 * target_pwrs after devm_ have freed memory
475 */
476 hpriv->target_pwrs = kcalloc(hpriv->nports, sizeof(*hpriv->target_pwrs), GFP_KERNEL);
477 if (!hpriv->target_pwrs) {
478 rc = -ENOMEM;
479 goto err_out;
480 }
481
482 if (child_nodes) {
483 for_each_child_of_node(dev->of_node, child) {
484 u32 port;
485 struct platform_device *port_dev __maybe_unused;
486
487 if (!of_device_is_available(child))
488 continue;
489
490 if (of_property_read_u32(child, "reg", &port)) {
491 rc = -EINVAL;
492 of_node_put(child);
493 goto err_out;
494 }
495
496 if (port >= hpriv->nports) {
497 dev_warn(dev, "invalid port number %d\n", port);
498 continue;
499 }
500 mask_port_map |= BIT(port);
501
502#ifdef CONFIG_OF_ADDRESS
503 of_platform_device_create(child, NULL, NULL);
504
505 port_dev = of_find_device_by_node(child);
506
507 if (port_dev) {
508 rc = ahci_platform_get_regulator(hpriv, port,
509 &port_dev->dev);
510 if (rc == -EPROBE_DEFER) {
511 of_node_put(child);
512 goto err_out;
513 }
514 }
515#endif
516
517 rc = ahci_platform_get_phy(hpriv, port, dev, child);
518 if (rc) {
519 of_node_put(child);
520 goto err_out;
521 }
522
523 enabled_ports++;
524 }
525 if (!enabled_ports) {
526 dev_warn(dev, "No port enabled\n");
527 rc = -ENODEV;
528 goto err_out;
529 }
530
531 if (!hpriv->mask_port_map)
532 hpriv->mask_port_map = mask_port_map;
533 } else {
534 /*
535 * If no sub-node was found, keep this for device tree
536 * compatibility
537 */
538 rc = ahci_platform_get_phy(hpriv, 0, dev, dev->of_node);
539 if (rc)
540 goto err_out;
541
542 rc = ahci_platform_get_regulator(hpriv, 0, dev);
543 if (rc == -EPROBE_DEFER)
544 goto err_out;
545 }
546 pm_runtime_enable(dev);
547 pm_runtime_get_sync(dev);
548 hpriv->got_runtime_pm = true;
549
550 devres_remove_group(dev, NULL);
551 return hpriv;
552
553err_out:
554 devres_release_group(dev, NULL);
555 return ERR_PTR(rc);
556}
557EXPORT_SYMBOL_GPL(ahci_platform_get_resources);
558
559/**
560 * ahci_platform_init_host - Bring up an ahci-platform host
561 * @pdev: platform device pointer for the host
562 * @hpriv: ahci-host private data for the host
563 * @pi_template: template for the ata_port_info to use
564 * @sht: scsi_host_template to use when registering
565 *
566 * This function does all the usual steps needed to bring up an
567 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
568 * must be initialized / enabled before calling this.
569 *
570 * RETURNS:
571 * 0 on success otherwise a negative error code
572 */
573int ahci_platform_init_host(struct platform_device *pdev,
574 struct ahci_host_priv *hpriv,
575 const struct ata_port_info *pi_template,
576 struct scsi_host_template *sht)
577{
578 struct device *dev = &pdev->dev;
579 struct ata_port_info pi = *pi_template;
580 const struct ata_port_info *ppi[] = { &pi, NULL };
581 struct ata_host *host;
582 int i, irq, n_ports, rc;
583
584 irq = platform_get_irq(pdev, 0);
585 if (irq <= 0) {
586 if (irq != -EPROBE_DEFER)
587 dev_err(dev, "no irq\n");
588 return irq;
589 }
590
591 hpriv->irq = irq;
592
593 /* prepare host */
594 pi.private_data = (void *)(unsigned long)hpriv->flags;
595
596 ahci_save_initial_config(dev, hpriv);
597
598 if (hpriv->cap & HOST_CAP_NCQ)
599 pi.flags |= ATA_FLAG_NCQ;
600
601 if (hpriv->cap & HOST_CAP_PMP)
602 pi.flags |= ATA_FLAG_PMP;
603
604 ahci_set_em_messages(hpriv, &pi);
605
606 /* CAP.NP sometimes indicate the index of the last enabled
607 * port, at other times, that of the last possible port, so
608 * determining the maximum port number requires looking at
609 * both CAP.NP and port_map.
610 */
611 n_ports = max(ahci_nr_ports(hpriv->cap), fls(hpriv->port_map));
612
613 host = ata_host_alloc_pinfo(dev, ppi, n_ports);
614 if (!host)
615 return -ENOMEM;
616
617 host->private_data = hpriv;
618
619 if (!(hpriv->cap & HOST_CAP_SSS) || ahci_ignore_sss)
620 host->flags |= ATA_HOST_PARALLEL_SCAN;
621 else
622 dev_info(dev, "SSS flag set, parallel bus scan disabled\n");
623
624 if (pi.flags & ATA_FLAG_EM)
625 ahci_reset_em(host);
626
627 for (i = 0; i < host->n_ports; i++) {
628 struct ata_port *ap = host->ports[i];
629
630 ata_port_desc(ap, "mmio %pR",
631 platform_get_resource(pdev, IORESOURCE_MEM, 0));
632 ata_port_desc(ap, "port 0x%x", 0x100 + ap->port_no * 0x80);
633
634 /* set enclosure management message type */
635 if (ap->flags & ATA_FLAG_EM)
636 ap->em_message_type = hpriv->em_msg_type;
637
638 /* disabled/not-implemented port */
639 if (!(hpriv->port_map & (1 << i)))
640 ap->ops = &ata_dummy_port_ops;
641 }
642
643 if (hpriv->cap & HOST_CAP_64) {
644 rc = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
645 if (rc) {
646 rc = dma_coerce_mask_and_coherent(dev,
647 DMA_BIT_MASK(32));
648 if (rc) {
649 dev_err(dev, "Failed to enable 64-bit DMA.\n");
650 return rc;
651 }
652 dev_warn(dev, "Enable 32-bit DMA instead of 64-bit.\n");
653 }
654 }
655
656 rc = ahci_reset_controller(host);
657 if (rc)
658 return rc;
659
660 ahci_init_controller(host);
661 ahci_print_info(host, "platform");
662
663 return ahci_host_activate(host, sht);
664}
665EXPORT_SYMBOL_GPL(ahci_platform_init_host);
666
667static void ahci_host_stop(struct ata_host *host)
668{
669 struct ahci_host_priv *hpriv = host->private_data;
670
671 ahci_platform_disable_resources(hpriv);
672}
673
674/**
675 * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
676 * @pdev: platform device pointer for the host
677 *
678 * This function is called during system shutdown and performs the minimal
679 * deconfiguration required to ensure that an ahci_platform host cannot
680 * corrupt or otherwise interfere with a new kernel being started with kexec.
681 */
682void ahci_platform_shutdown(struct platform_device *pdev)
683{
684 struct ata_host *host = platform_get_drvdata(pdev);
685 struct ahci_host_priv *hpriv = host->private_data;
686 void __iomem *mmio = hpriv->mmio;
687 int i;
688
689 for (i = 0; i < host->n_ports; i++) {
690 struct ata_port *ap = host->ports[i];
691
692 /* Disable port interrupts */
693 if (ap->ops->freeze)
694 ap->ops->freeze(ap);
695
696 /* Stop the port DMA engines */
697 if (ap->ops->port_stop)
698 ap->ops->port_stop(ap);
699 }
700
701 /* Disable and clear host interrupts */
702 writel(readl(mmio + HOST_CTL) & ~HOST_IRQ_EN, mmio + HOST_CTL);
703 readl(mmio + HOST_CTL); /* flush */
704 writel(GENMASK(host->n_ports, 0), mmio + HOST_IRQ_STAT);
705}
706EXPORT_SYMBOL_GPL(ahci_platform_shutdown);
707
708#ifdef CONFIG_PM_SLEEP
709/**
710 * ahci_platform_suspend_host - Suspend an ahci-platform host
711 * @dev: device pointer for the host
712 *
713 * This function does all the usual steps needed to suspend an
714 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
715 * must be disabled after calling this.
716 *
717 * RETURNS:
718 * 0 on success otherwise a negative error code
719 */
720int ahci_platform_suspend_host(struct device *dev)
721{
722 struct ata_host *host = dev_get_drvdata(dev);
723 struct ahci_host_priv *hpriv = host->private_data;
724 void __iomem *mmio = hpriv->mmio;
725 u32 ctl;
726
727 if (hpriv->flags & AHCI_HFLAG_NO_SUSPEND) {
728 dev_err(dev, "firmware update required for suspend/resume\n");
729 return -EIO;
730 }
731
732 /*
733 * AHCI spec rev1.1 section 8.3.3:
734 * Software must disable interrupts prior to requesting a
735 * transition of the HBA to D3 state.
736 */
737 ctl = readl(mmio + HOST_CTL);
738 ctl &= ~HOST_IRQ_EN;
739 writel(ctl, mmio + HOST_CTL);
740 readl(mmio + HOST_CTL); /* flush */
741
742 if (hpriv->flags & AHCI_HFLAG_SUSPEND_PHYS)
743 ahci_platform_disable_phys(hpriv);
744
745 return ata_host_suspend(host, PMSG_SUSPEND);
746}
747EXPORT_SYMBOL_GPL(ahci_platform_suspend_host);
748
749/**
750 * ahci_platform_resume_host - Resume an ahci-platform host
751 * @dev: device pointer for the host
752 *
753 * This function does all the usual steps needed to resume an ahci-platform
754 * host, note any necessary resources (ie clks, phys, etc.) must be
755 * initialized / enabled before calling this.
756 *
757 * RETURNS:
758 * 0 on success otherwise a negative error code
759 */
760int ahci_platform_resume_host(struct device *dev)
761{
762 struct ata_host *host = dev_get_drvdata(dev);
763 struct ahci_host_priv *hpriv = host->private_data;
764 int rc;
765
766 if (dev->power.power_state.event == PM_EVENT_SUSPEND) {
767 rc = ahci_reset_controller(host);
768 if (rc)
769 return rc;
770
771 ahci_init_controller(host);
772 }
773
774 if (hpriv->flags & AHCI_HFLAG_SUSPEND_PHYS)
775 ahci_platform_enable_phys(hpriv);
776
777 ata_host_resume(host);
778
779 return 0;
780}
781EXPORT_SYMBOL_GPL(ahci_platform_resume_host);
782
783/**
784 * ahci_platform_suspend - Suspend an ahci-platform device
785 * @dev: the platform device to suspend
786 *
787 * This function suspends the host associated with the device, followed by
788 * disabling all the resources of the device.
789 *
790 * RETURNS:
791 * 0 on success otherwise a negative error code
792 */
793int ahci_platform_suspend(struct device *dev)
794{
795 struct ata_host *host = dev_get_drvdata(dev);
796 struct ahci_host_priv *hpriv = host->private_data;
797 int rc;
798
799 rc = ahci_platform_suspend_host(dev);
800 if (rc)
801 return rc;
802
803 ahci_platform_disable_resources(hpriv);
804
805 return 0;
806}
807EXPORT_SYMBOL_GPL(ahci_platform_suspend);
808
809/**
810 * ahci_platform_resume - Resume an ahci-platform device
811 * @dev: the platform device to resume
812 *
813 * This function enables all the resources of the device followed by
814 * resuming the host associated with the device.
815 *
816 * RETURNS:
817 * 0 on success otherwise a negative error code
818 */
819int ahci_platform_resume(struct device *dev)
820{
821 struct ata_host *host = dev_get_drvdata(dev);
822 struct ahci_host_priv *hpriv = host->private_data;
823 int rc;
824
825 rc = ahci_platform_enable_resources(hpriv);
826 if (rc)
827 return rc;
828
829 rc = ahci_platform_resume_host(dev);
830 if (rc)
831 goto disable_resources;
832
833 /* We resumed so update PM runtime state */
834 pm_runtime_disable(dev);
835 pm_runtime_set_active(dev);
836 pm_runtime_enable(dev);
837
838 return 0;
839
840disable_resources:
841 ahci_platform_disable_resources(hpriv);
842
843 return rc;
844}
845EXPORT_SYMBOL_GPL(ahci_platform_resume);
846#endif
847
848MODULE_DESCRIPTION("AHCI SATA platform library");
849MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
850MODULE_LICENSE("GPL");
1/*
2 * AHCI SATA platform library
3 *
4 * Copyright 2004-2005 Red Hat, Inc.
5 * Jeff Garzik <jgarzik@pobox.com>
6 * Copyright 2010 MontaVista Software, LLC.
7 * Anton Vorontsov <avorontsov@ru.mvista.com>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2, or (at your option)
12 * any later version.
13 */
14
15#include <linux/clk.h>
16#include <linux/kernel.h>
17#include <linux/gfp.h>
18#include <linux/module.h>
19#include <linux/pm.h>
20#include <linux/interrupt.h>
21#include <linux/device.h>
22#include <linux/platform_device.h>
23#include <linux/libata.h>
24#include <linux/ahci_platform.h>
25#include <linux/phy/phy.h>
26#include <linux/pm_runtime.h>
27#include <linux/of_platform.h>
28#include "ahci.h"
29
30static void ahci_host_stop(struct ata_host *host);
31
32struct ata_port_operations ahci_platform_ops = {
33 .inherits = &ahci_ops,
34 .host_stop = ahci_host_stop,
35};
36EXPORT_SYMBOL_GPL(ahci_platform_ops);
37
38/**
39 * ahci_platform_enable_phys - Enable PHYs
40 * @hpriv: host private area to store config values
41 *
42 * This function enables all the PHYs found in hpriv->phys, if any.
43 * If a PHY fails to be enabled, it disables all the PHYs already
44 * enabled in reverse order and returns an error.
45 *
46 * RETURNS:
47 * 0 on success otherwise a negative error code
48 */
49static int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
50{
51 int rc, i;
52
53 for (i = 0; i < hpriv->nports; i++) {
54 rc = phy_init(hpriv->phys[i]);
55 if (rc)
56 goto disable_phys;
57
58 rc = phy_power_on(hpriv->phys[i]);
59 if (rc) {
60 phy_exit(hpriv->phys[i]);
61 goto disable_phys;
62 }
63 }
64
65 return 0;
66
67disable_phys:
68 while (--i >= 0) {
69 phy_power_off(hpriv->phys[i]);
70 phy_exit(hpriv->phys[i]);
71 }
72 return rc;
73}
74
75/**
76 * ahci_platform_disable_phys - Disable PHYs
77 * @hpriv: host private area to store config values
78 *
79 * This function disables all PHYs found in hpriv->phys.
80 */
81static void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
82{
83 int i;
84
85 for (i = 0; i < hpriv->nports; i++) {
86 phy_power_off(hpriv->phys[i]);
87 phy_exit(hpriv->phys[i]);
88 }
89}
90
91/**
92 * ahci_platform_enable_clks - Enable platform clocks
93 * @hpriv: host private area to store config values
94 *
95 * This function enables all the clks found in hpriv->clks, starting at
96 * index 0. If any clk fails to enable it disables all the clks already
97 * enabled in reverse order, and then returns an error.
98 *
99 * RETURNS:
100 * 0 on success otherwise a negative error code
101 */
102int ahci_platform_enable_clks(struct ahci_host_priv *hpriv)
103{
104 int c, rc;
105
106 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++) {
107 rc = clk_prepare_enable(hpriv->clks[c]);
108 if (rc)
109 goto disable_unprepare_clk;
110 }
111 return 0;
112
113disable_unprepare_clk:
114 while (--c >= 0)
115 clk_disable_unprepare(hpriv->clks[c]);
116 return rc;
117}
118EXPORT_SYMBOL_GPL(ahci_platform_enable_clks);
119
120/**
121 * ahci_platform_disable_clks - Disable platform clocks
122 * @hpriv: host private area to store config values
123 *
124 * This function disables all the clks found in hpriv->clks, in reverse
125 * order of ahci_platform_enable_clks (starting at the end of the array).
126 */
127void ahci_platform_disable_clks(struct ahci_host_priv *hpriv)
128{
129 int c;
130
131 for (c = AHCI_MAX_CLKS - 1; c >= 0; c--)
132 if (hpriv->clks[c])
133 clk_disable_unprepare(hpriv->clks[c]);
134}
135EXPORT_SYMBOL_GPL(ahci_platform_disable_clks);
136
137/**
138 * ahci_platform_enable_regulators - Enable regulators
139 * @hpriv: host private area to store config values
140 *
141 * This function enables all the regulators found in
142 * hpriv->target_pwrs, if any. If a regulator fails to be enabled, it
143 * disables all the regulators already enabled in reverse order and
144 * returns an error.
145 *
146 * RETURNS:
147 * 0 on success otherwise a negative error code
148 */
149int ahci_platform_enable_regulators(struct ahci_host_priv *hpriv)
150{
151 int rc, i;
152
153 for (i = 0; i < hpriv->nports; i++) {
154 if (!hpriv->target_pwrs[i])
155 continue;
156
157 rc = regulator_enable(hpriv->target_pwrs[i]);
158 if (rc)
159 goto disable_target_pwrs;
160 }
161
162 return 0;
163
164disable_target_pwrs:
165 while (--i >= 0)
166 if (hpriv->target_pwrs[i])
167 regulator_disable(hpriv->target_pwrs[i]);
168
169 return rc;
170}
171EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators);
172
173/**
174 * ahci_platform_disable_regulators - Disable regulators
175 * @hpriv: host private area to store config values
176 *
177 * This function disables all regulators found in hpriv->target_pwrs.
178 */
179void ahci_platform_disable_regulators(struct ahci_host_priv *hpriv)
180{
181 int i;
182
183 for (i = 0; i < hpriv->nports; i++) {
184 if (!hpriv->target_pwrs[i])
185 continue;
186 regulator_disable(hpriv->target_pwrs[i]);
187 }
188}
189EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators);
190/**
191 * ahci_platform_enable_resources - Enable platform resources
192 * @hpriv: host private area to store config values
193 *
194 * This function enables all ahci_platform managed resources in the
195 * following order:
196 * 1) Regulator
197 * 2) Clocks (through ahci_platform_enable_clks)
198 * 3) Phys
199 *
200 * If resource enabling fails at any point the previous enabled resources
201 * are disabled in reverse order.
202 *
203 * RETURNS:
204 * 0 on success otherwise a negative error code
205 */
206int ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
207{
208 int rc;
209
210 rc = ahci_platform_enable_regulators(hpriv);
211 if (rc)
212 return rc;
213
214 rc = ahci_platform_enable_clks(hpriv);
215 if (rc)
216 goto disable_regulator;
217
218 rc = ahci_platform_enable_phys(hpriv);
219 if (rc)
220 goto disable_clks;
221
222 return 0;
223
224disable_clks:
225 ahci_platform_disable_clks(hpriv);
226
227disable_regulator:
228 ahci_platform_disable_regulators(hpriv);
229
230 return rc;
231}
232EXPORT_SYMBOL_GPL(ahci_platform_enable_resources);
233
234/**
235 * ahci_platform_disable_resources - Disable platform resources
236 * @hpriv: host private area to store config values
237 *
238 * This function disables all ahci_platform managed resources in the
239 * following order:
240 * 1) Phys
241 * 2) Clocks (through ahci_platform_disable_clks)
242 * 3) Regulator
243 */
244void ahci_platform_disable_resources(struct ahci_host_priv *hpriv)
245{
246 ahci_platform_disable_phys(hpriv);
247
248 ahci_platform_disable_clks(hpriv);
249
250 ahci_platform_disable_regulators(hpriv);
251}
252EXPORT_SYMBOL_GPL(ahci_platform_disable_resources);
253
254static void ahci_platform_put_resources(struct device *dev, void *res)
255{
256 struct ahci_host_priv *hpriv = res;
257 int c;
258
259 if (hpriv->got_runtime_pm) {
260 pm_runtime_put_sync(dev);
261 pm_runtime_disable(dev);
262 }
263
264 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++)
265 clk_put(hpriv->clks[c]);
266 /*
267 * The regulators are tied to child node device and not to the
268 * SATA device itself. So we can't use devm for automatically
269 * releasing them. We have to do it manually here.
270 */
271 for (c = 0; c < hpriv->nports; c++)
272 if (hpriv->target_pwrs && hpriv->target_pwrs[c])
273 regulator_put(hpriv->target_pwrs[c]);
274
275 kfree(hpriv->target_pwrs);
276}
277
278static int ahci_platform_get_phy(struct ahci_host_priv *hpriv, u32 port,
279 struct device *dev, struct device_node *node)
280{
281 int rc;
282
283 hpriv->phys[port] = devm_of_phy_get(dev, node, NULL);
284
285 if (!IS_ERR(hpriv->phys[port]))
286 return 0;
287
288 rc = PTR_ERR(hpriv->phys[port]);
289 switch (rc) {
290 case -ENOSYS:
291 /* No PHY support. Check if PHY is required. */
292 if (of_find_property(node, "phys", NULL)) {
293 dev_err(dev,
294 "couldn't get PHY in node %s: ENOSYS\n",
295 node->name);
296 break;
297 }
298 /* fall through */
299 case -ENODEV:
300 /* continue normally */
301 hpriv->phys[port] = NULL;
302 rc = 0;
303 break;
304
305 default:
306 dev_err(dev,
307 "couldn't get PHY in node %s: %d\n",
308 node->name, rc);
309
310 break;
311 }
312
313 return rc;
314}
315
316static int ahci_platform_get_regulator(struct ahci_host_priv *hpriv, u32 port,
317 struct device *dev)
318{
319 struct regulator *target_pwr;
320 int rc = 0;
321
322 target_pwr = regulator_get_optional(dev, "target");
323
324 if (!IS_ERR(target_pwr))
325 hpriv->target_pwrs[port] = target_pwr;
326 else
327 rc = PTR_ERR(target_pwr);
328
329 return rc;
330}
331
332/**
333 * ahci_platform_get_resources - Get platform resources
334 * @pdev: platform device to get resources for
335 *
336 * This function allocates an ahci_host_priv struct, and gets the following
337 * resources, storing a reference to them inside the returned struct:
338 *
339 * 1) mmio registers (IORESOURCE_MEM 0, mandatory)
340 * 2) regulator for controlling the targets power (optional)
341 * 3) 0 - AHCI_MAX_CLKS clocks, as specified in the devs devicetree node,
342 * or for non devicetree enabled platforms a single clock
343 * 4) phys (optional)
344 *
345 * RETURNS:
346 * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
347 */
348struct ahci_host_priv *ahci_platform_get_resources(struct platform_device *pdev)
349{
350 struct device *dev = &pdev->dev;
351 struct ahci_host_priv *hpriv;
352 struct clk *clk;
353 struct device_node *child;
354 int i, sz, enabled_ports = 0, rc = -ENOMEM, child_nodes;
355 u32 mask_port_map = 0;
356
357 if (!devres_open_group(dev, NULL, GFP_KERNEL))
358 return ERR_PTR(-ENOMEM);
359
360 hpriv = devres_alloc(ahci_platform_put_resources, sizeof(*hpriv),
361 GFP_KERNEL);
362 if (!hpriv)
363 goto err_out;
364
365 devres_add(dev, hpriv);
366
367 hpriv->mmio = devm_ioremap_resource(dev,
368 platform_get_resource(pdev, IORESOURCE_MEM, 0));
369 if (IS_ERR(hpriv->mmio)) {
370 dev_err(dev, "no mmio space\n");
371 rc = PTR_ERR(hpriv->mmio);
372 goto err_out;
373 }
374
375 for (i = 0; i < AHCI_MAX_CLKS; i++) {
376 /*
377 * For now we must use clk_get(dev, NULL) for the first clock,
378 * because some platforms (da850, spear13xx) are not yet
379 * converted to use devicetree for clocks. For new platforms
380 * this is equivalent to of_clk_get(dev->of_node, 0).
381 */
382 if (i == 0)
383 clk = clk_get(dev, NULL);
384 else
385 clk = of_clk_get(dev->of_node, i);
386
387 if (IS_ERR(clk)) {
388 rc = PTR_ERR(clk);
389 if (rc == -EPROBE_DEFER)
390 goto err_out;
391 break;
392 }
393 hpriv->clks[i] = clk;
394 }
395
396 hpriv->nports = child_nodes = of_get_child_count(dev->of_node);
397
398 /*
399 * If no sub-node was found, we still need to set nports to
400 * one in order to be able to use the
401 * ahci_platform_[en|dis]able_[phys|regulators] functions.
402 */
403 if (!child_nodes)
404 hpriv->nports = 1;
405
406 sz = hpriv->nports * sizeof(*hpriv->phys);
407 hpriv->phys = devm_kzalloc(dev, sz, GFP_KERNEL);
408 if (!hpriv->phys) {
409 rc = -ENOMEM;
410 goto err_out;
411 }
412 sz = hpriv->nports * sizeof(*hpriv->target_pwrs);
413 hpriv->target_pwrs = kzalloc(sz, GFP_KERNEL);
414 if (!hpriv->target_pwrs) {
415 rc = -ENOMEM;
416 goto err_out;
417 }
418
419 if (child_nodes) {
420 for_each_child_of_node(dev->of_node, child) {
421 u32 port;
422 struct platform_device *port_dev __maybe_unused;
423
424 if (!of_device_is_available(child))
425 continue;
426
427 if (of_property_read_u32(child, "reg", &port)) {
428 rc = -EINVAL;
429 goto err_out;
430 }
431
432 if (port >= hpriv->nports) {
433 dev_warn(dev, "invalid port number %d\n", port);
434 continue;
435 }
436 mask_port_map |= BIT(port);
437
438#ifdef CONFIG_OF_ADDRESS
439 of_platform_device_create(child, NULL, NULL);
440
441 port_dev = of_find_device_by_node(child);
442
443 if (port_dev) {
444 rc = ahci_platform_get_regulator(hpriv, port,
445 &port_dev->dev);
446 if (rc == -EPROBE_DEFER)
447 goto err_out;
448 }
449#endif
450
451 rc = ahci_platform_get_phy(hpriv, port, dev, child);
452 if (rc)
453 goto err_out;
454
455 enabled_ports++;
456 }
457 if (!enabled_ports) {
458 dev_warn(dev, "No port enabled\n");
459 rc = -ENODEV;
460 goto err_out;
461 }
462
463 if (!hpriv->mask_port_map)
464 hpriv->mask_port_map = mask_port_map;
465 } else {
466 /*
467 * If no sub-node was found, keep this for device tree
468 * compatibility
469 */
470 rc = ahci_platform_get_phy(hpriv, 0, dev, dev->of_node);
471 if (rc)
472 goto err_out;
473
474 rc = ahci_platform_get_regulator(hpriv, 0, dev);
475 if (rc == -EPROBE_DEFER)
476 goto err_out;
477 }
478 pm_runtime_enable(dev);
479 pm_runtime_get_sync(dev);
480 hpriv->got_runtime_pm = true;
481
482 devres_remove_group(dev, NULL);
483 return hpriv;
484
485err_out:
486 devres_release_group(dev, NULL);
487 return ERR_PTR(rc);
488}
489EXPORT_SYMBOL_GPL(ahci_platform_get_resources);
490
491/**
492 * ahci_platform_init_host - Bring up an ahci-platform host
493 * @pdev: platform device pointer for the host
494 * @hpriv: ahci-host private data for the host
495 * @pi_template: template for the ata_port_info to use
496 * @sht: scsi_host_template to use when registering
497 *
498 * This function does all the usual steps needed to bring up an
499 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
500 * must be initialized / enabled before calling this.
501 *
502 * RETURNS:
503 * 0 on success otherwise a negative error code
504 */
505int ahci_platform_init_host(struct platform_device *pdev,
506 struct ahci_host_priv *hpriv,
507 const struct ata_port_info *pi_template,
508 struct scsi_host_template *sht)
509{
510 struct device *dev = &pdev->dev;
511 struct ata_port_info pi = *pi_template;
512 const struct ata_port_info *ppi[] = { &pi, NULL };
513 struct ata_host *host;
514 int i, irq, n_ports, rc;
515
516 irq = platform_get_irq(pdev, 0);
517 if (irq <= 0) {
518 if (irq != -EPROBE_DEFER)
519 dev_err(dev, "no irq\n");
520 return irq;
521 }
522
523 hpriv->irq = irq;
524
525 /* prepare host */
526 pi.private_data = (void *)(unsigned long)hpriv->flags;
527
528 ahci_save_initial_config(dev, hpriv);
529
530 if (hpriv->cap & HOST_CAP_NCQ)
531 pi.flags |= ATA_FLAG_NCQ;
532
533 if (hpriv->cap & HOST_CAP_PMP)
534 pi.flags |= ATA_FLAG_PMP;
535
536 ahci_set_em_messages(hpriv, &pi);
537
538 /* CAP.NP sometimes indicate the index of the last enabled
539 * port, at other times, that of the last possible port, so
540 * determining the maximum port number requires looking at
541 * both CAP.NP and port_map.
542 */
543 n_ports = max(ahci_nr_ports(hpriv->cap), fls(hpriv->port_map));
544
545 host = ata_host_alloc_pinfo(dev, ppi, n_ports);
546 if (!host)
547 return -ENOMEM;
548
549 host->private_data = hpriv;
550
551 if (!(hpriv->cap & HOST_CAP_SSS) || ahci_ignore_sss)
552 host->flags |= ATA_HOST_PARALLEL_SCAN;
553 else
554 dev_info(dev, "SSS flag set, parallel bus scan disabled\n");
555
556 if (pi.flags & ATA_FLAG_EM)
557 ahci_reset_em(host);
558
559 for (i = 0; i < host->n_ports; i++) {
560 struct ata_port *ap = host->ports[i];
561
562 ata_port_desc(ap, "mmio %pR",
563 platform_get_resource(pdev, IORESOURCE_MEM, 0));
564 ata_port_desc(ap, "port 0x%x", 0x100 + ap->port_no * 0x80);
565
566 /* set enclosure management message type */
567 if (ap->flags & ATA_FLAG_EM)
568 ap->em_message_type = hpriv->em_msg_type;
569
570 /* disabled/not-implemented port */
571 if (!(hpriv->port_map & (1 << i)))
572 ap->ops = &ata_dummy_port_ops;
573 }
574
575 if (hpriv->cap & HOST_CAP_64) {
576 rc = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
577 if (rc) {
578 rc = dma_coerce_mask_and_coherent(dev,
579 DMA_BIT_MASK(32));
580 if (rc) {
581 dev_err(dev, "Failed to enable 64-bit DMA.\n");
582 return rc;
583 }
584 dev_warn(dev, "Enable 32-bit DMA instead of 64-bit.\n");
585 }
586 }
587
588 rc = ahci_reset_controller(host);
589 if (rc)
590 return rc;
591
592 ahci_init_controller(host);
593 ahci_print_info(host, "platform");
594
595 return ahci_host_activate(host, sht);
596}
597EXPORT_SYMBOL_GPL(ahci_platform_init_host);
598
599static void ahci_host_stop(struct ata_host *host)
600{
601 struct ahci_host_priv *hpriv = host->private_data;
602
603 ahci_platform_disable_resources(hpriv);
604}
605
606/**
607 * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
608 * @dev: platform device pointer for the host
609 *
610 * This function is called during system shutdown and performs the minimal
611 * deconfiguration required to ensure that an ahci_platform host cannot
612 * corrupt or otherwise interfere with a new kernel being started with kexec.
613 */
614void ahci_platform_shutdown(struct platform_device *pdev)
615{
616 struct ata_host *host = platform_get_drvdata(pdev);
617 struct ahci_host_priv *hpriv = host->private_data;
618 void __iomem *mmio = hpriv->mmio;
619 int i;
620
621 for (i = 0; i < host->n_ports; i++) {
622 struct ata_port *ap = host->ports[i];
623
624 /* Disable port interrupts */
625 if (ap->ops->freeze)
626 ap->ops->freeze(ap);
627
628 /* Stop the port DMA engines */
629 if (ap->ops->port_stop)
630 ap->ops->port_stop(ap);
631 }
632
633 /* Disable and clear host interrupts */
634 writel(readl(mmio + HOST_CTL) & ~HOST_IRQ_EN, mmio + HOST_CTL);
635 readl(mmio + HOST_CTL); /* flush */
636 writel(GENMASK(host->n_ports, 0), mmio + HOST_IRQ_STAT);
637}
638EXPORT_SYMBOL_GPL(ahci_platform_shutdown);
639
640#ifdef CONFIG_PM_SLEEP
641/**
642 * ahci_platform_suspend_host - Suspend an ahci-platform host
643 * @dev: device pointer for the host
644 *
645 * This function does all the usual steps needed to suspend an
646 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
647 * must be disabled after calling this.
648 *
649 * RETURNS:
650 * 0 on success otherwise a negative error code
651 */
652int ahci_platform_suspend_host(struct device *dev)
653{
654 struct ata_host *host = dev_get_drvdata(dev);
655 struct ahci_host_priv *hpriv = host->private_data;
656 void __iomem *mmio = hpriv->mmio;
657 u32 ctl;
658
659 if (hpriv->flags & AHCI_HFLAG_NO_SUSPEND) {
660 dev_err(dev, "firmware update required for suspend/resume\n");
661 return -EIO;
662 }
663
664 /*
665 * AHCI spec rev1.1 section 8.3.3:
666 * Software must disable interrupts prior to requesting a
667 * transition of the HBA to D3 state.
668 */
669 ctl = readl(mmio + HOST_CTL);
670 ctl &= ~HOST_IRQ_EN;
671 writel(ctl, mmio + HOST_CTL);
672 readl(mmio + HOST_CTL); /* flush */
673
674 return ata_host_suspend(host, PMSG_SUSPEND);
675}
676EXPORT_SYMBOL_GPL(ahci_platform_suspend_host);
677
678/**
679 * ahci_platform_resume_host - Resume an ahci-platform host
680 * @dev: device pointer for the host
681 *
682 * This function does all the usual steps needed to resume an ahci-platform
683 * host, note any necessary resources (ie clks, phys, etc.) must be
684 * initialized / enabled before calling this.
685 *
686 * RETURNS:
687 * 0 on success otherwise a negative error code
688 */
689int ahci_platform_resume_host(struct device *dev)
690{
691 struct ata_host *host = dev_get_drvdata(dev);
692 int rc;
693
694 if (dev->power.power_state.event == PM_EVENT_SUSPEND) {
695 rc = ahci_reset_controller(host);
696 if (rc)
697 return rc;
698
699 ahci_init_controller(host);
700 }
701
702 ata_host_resume(host);
703
704 return 0;
705}
706EXPORT_SYMBOL_GPL(ahci_platform_resume_host);
707
708/**
709 * ahci_platform_suspend - Suspend an ahci-platform device
710 * @dev: the platform device to suspend
711 *
712 * This function suspends the host associated with the device, followed by
713 * disabling all the resources of the device.
714 *
715 * RETURNS:
716 * 0 on success otherwise a negative error code
717 */
718int ahci_platform_suspend(struct device *dev)
719{
720 struct ata_host *host = dev_get_drvdata(dev);
721 struct ahci_host_priv *hpriv = host->private_data;
722 int rc;
723
724 rc = ahci_platform_suspend_host(dev);
725 if (rc)
726 return rc;
727
728 ahci_platform_disable_resources(hpriv);
729
730 return 0;
731}
732EXPORT_SYMBOL_GPL(ahci_platform_suspend);
733
734/**
735 * ahci_platform_resume - Resume an ahci-platform device
736 * @dev: the platform device to resume
737 *
738 * This function enables all the resources of the device followed by
739 * resuming the host associated with the device.
740 *
741 * RETURNS:
742 * 0 on success otherwise a negative error code
743 */
744int ahci_platform_resume(struct device *dev)
745{
746 struct ata_host *host = dev_get_drvdata(dev);
747 struct ahci_host_priv *hpriv = host->private_data;
748 int rc;
749
750 rc = ahci_platform_enable_resources(hpriv);
751 if (rc)
752 return rc;
753
754 rc = ahci_platform_resume_host(dev);
755 if (rc)
756 goto disable_resources;
757
758 /* We resumed so update PM runtime state */
759 pm_runtime_disable(dev);
760 pm_runtime_set_active(dev);
761 pm_runtime_enable(dev);
762
763 return 0;
764
765disable_resources:
766 ahci_platform_disable_resources(hpriv);
767
768 return rc;
769}
770EXPORT_SYMBOL_GPL(ahci_platform_resume);
771#endif
772
773MODULE_DESCRIPTION("AHCI SATA platform library");
774MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
775MODULE_LICENSE("GPL");