2 * AHCI SATA platform library
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>
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)
15 #include <linux/clk.h>
16 #include <linux/kernel.h>
17 #include <linux/gfp.h>
18 #include <linux/module.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 <linux/reset.h>
31 static void ahci_host_stop(struct ata_host *host);
33 struct ata_port_operations ahci_platform_ops = {
34 .inherits = &ahci_ops,
35 .host_stop = ahci_host_stop,
37 EXPORT_SYMBOL_GPL(ahci_platform_ops);
40 * ahci_platform_enable_phys - Enable PHYs
41 * @hpriv: host private area to store config values
43 * This function enables all the PHYs found in hpriv->phys, if any.
44 * If a PHY fails to be enabled, it disables all the PHYs already
45 * enabled in reverse order and returns an error.
48 * 0 on success otherwise a negative error code
50 static int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
54 for (i = 0; i < hpriv->nports; i++) {
55 rc = phy_init(hpriv->phys[i]);
59 rc = phy_power_on(hpriv->phys[i]);
61 phy_exit(hpriv->phys[i]);
70 phy_power_off(hpriv->phys[i]);
71 phy_exit(hpriv->phys[i]);
77 * ahci_platform_disable_phys - Disable PHYs
78 * @hpriv: host private area to store config values
80 * This function disables all PHYs found in hpriv->phys.
82 static void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
86 for (i = 0; i < hpriv->nports; i++) {
87 phy_power_off(hpriv->phys[i]);
88 phy_exit(hpriv->phys[i]);
93 * ahci_platform_enable_clks - Enable platform clocks
94 * @hpriv: host private area to store config values
96 * This function enables all the clks found in hpriv->clks, starting at
97 * index 0. If any clk fails to enable it disables all the clks already
98 * enabled in reverse order, and then returns an error.
101 * 0 on success otherwise a negative error code
103 int ahci_platform_enable_clks(struct ahci_host_priv *hpriv)
107 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++) {
108 rc = clk_prepare_enable(hpriv->clks[c]);
110 goto disable_unprepare_clk;
114 disable_unprepare_clk:
116 clk_disable_unprepare(hpriv->clks[c]);
119 EXPORT_SYMBOL_GPL(ahci_platform_enable_clks);
122 * ahci_platform_disable_clks - Disable platform clocks
123 * @hpriv: host private area to store config values
125 * This function disables all the clks found in hpriv->clks, in reverse
126 * order of ahci_platform_enable_clks (starting at the end of the array).
128 void ahci_platform_disable_clks(struct ahci_host_priv *hpriv)
132 for (c = AHCI_MAX_CLKS - 1; c >= 0; c--)
134 clk_disable_unprepare(hpriv->clks[c]);
136 EXPORT_SYMBOL_GPL(ahci_platform_disable_clks);
139 * ahci_platform_enable_regulators - Enable regulators
140 * @hpriv: host private area to store config values
142 * This function enables all the regulators found in
143 * hpriv->target_pwrs, if any. If a regulator fails to be enabled, it
144 * disables all the regulators already enabled in reverse order and
148 * 0 on success otherwise a negative error code
150 int ahci_platform_enable_regulators(struct ahci_host_priv *hpriv)
154 for (i = 0; i < hpriv->nports; i++) {
155 if (!hpriv->target_pwrs[i])
158 rc = regulator_enable(hpriv->target_pwrs[i]);
160 goto disable_target_pwrs;
167 if (hpriv->target_pwrs[i])
168 regulator_disable(hpriv->target_pwrs[i]);
172 EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators);
175 * ahci_platform_disable_regulators - Disable regulators
176 * @hpriv: host private area to store config values
178 * This function disables all regulators found in hpriv->target_pwrs.
180 void ahci_platform_disable_regulators(struct ahci_host_priv *hpriv)
184 for (i = 0; i < hpriv->nports; i++) {
185 if (!hpriv->target_pwrs[i])
187 regulator_disable(hpriv->target_pwrs[i]);
190 EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators);
192 * ahci_platform_enable_resources - Enable platform resources
193 * @hpriv: host private area to store config values
195 * This function enables all ahci_platform managed resources in the
198 * 2) Clocks (through ahci_platform_enable_clks)
202 * If resource enabling fails at any point the previous enabled resources
203 * are disabled in reverse order.
206 * 0 on success otherwise a negative error code
208 int ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
212 rc = ahci_platform_enable_regulators(hpriv);
216 rc = ahci_platform_enable_clks(hpriv);
218 goto disable_regulator;
220 rc = reset_control_deassert(hpriv->rsts);
224 rc = ahci_platform_enable_phys(hpriv);
231 reset_control_assert(hpriv->rsts);
234 ahci_platform_disable_clks(hpriv);
237 ahci_platform_disable_regulators(hpriv);
241 EXPORT_SYMBOL_GPL(ahci_platform_enable_resources);
244 * ahci_platform_disable_resources - Disable platform resources
245 * @hpriv: host private area to store config values
247 * This function disables all ahci_platform managed resources in the
250 * 2) Clocks (through ahci_platform_disable_clks)
254 void ahci_platform_disable_resources(struct ahci_host_priv *hpriv)
256 ahci_platform_disable_phys(hpriv);
258 reset_control_assert(hpriv->rsts);
260 ahci_platform_disable_clks(hpriv);
262 ahci_platform_disable_regulators(hpriv);
264 EXPORT_SYMBOL_GPL(ahci_platform_disable_resources);
266 static void ahci_platform_put_resources(struct device *dev, void *res)
268 struct ahci_host_priv *hpriv = res;
271 if (hpriv->got_runtime_pm) {
272 pm_runtime_put_sync(dev);
273 pm_runtime_disable(dev);
276 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++)
277 clk_put(hpriv->clks[c]);
279 * The regulators are tied to child node device and not to the
280 * SATA device itself. So we can't use devm for automatically
281 * releasing them. We have to do it manually here.
283 for (c = 0; c < hpriv->nports; c++)
284 if (hpriv->target_pwrs && hpriv->target_pwrs[c])
285 regulator_put(hpriv->target_pwrs[c]);
287 kfree(hpriv->target_pwrs);
290 static int ahci_platform_get_phy(struct ahci_host_priv *hpriv, u32 port,
291 struct device *dev, struct device_node *node)
295 hpriv->phys[port] = devm_of_phy_get(dev, node, NULL);
297 if (!IS_ERR(hpriv->phys[port]))
300 rc = PTR_ERR(hpriv->phys[port]);
303 /* No PHY support. Check if PHY is required. */
304 if (of_find_property(node, "phys", NULL)) {
306 "couldn't get PHY in node %s: ENOSYS\n",
312 /* continue normally */
313 hpriv->phys[port] = NULL;
319 "couldn't get PHY in node %s: %d\n",
328 static int ahci_platform_get_regulator(struct ahci_host_priv *hpriv, u32 port,
331 struct regulator *target_pwr;
334 target_pwr = regulator_get_optional(dev, "target");
336 if (!IS_ERR(target_pwr))
337 hpriv->target_pwrs[port] = target_pwr;
339 rc = PTR_ERR(target_pwr);
345 * ahci_platform_get_resources - Get platform resources
346 * @pdev: platform device to get resources for
348 * This function allocates an ahci_host_priv struct, and gets the following
349 * resources, storing a reference to them inside the returned struct:
351 * 1) mmio registers (IORESOURCE_MEM 0, mandatory)
352 * 2) regulator for controlling the targets power (optional)
353 * 3) 0 - AHCI_MAX_CLKS clocks, as specified in the devs devicetree node,
354 * or for non devicetree enabled platforms a single clock
358 * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
360 struct ahci_host_priv *ahci_platform_get_resources(struct platform_device *pdev)
362 struct device *dev = &pdev->dev;
363 struct ahci_host_priv *hpriv;
365 struct device_node *child;
366 int i, sz, enabled_ports = 0, rc = -ENOMEM, child_nodes;
367 u32 mask_port_map = 0;
369 if (!devres_open_group(dev, NULL, GFP_KERNEL))
370 return ERR_PTR(-ENOMEM);
372 hpriv = devres_alloc(ahci_platform_put_resources, sizeof(*hpriv),
377 devres_add(dev, hpriv);
379 hpriv->mmio = devm_ioremap_resource(dev,
380 platform_get_resource(pdev, IORESOURCE_MEM, 0));
381 if (IS_ERR(hpriv->mmio)) {
382 dev_err(dev, "no mmio space\n");
383 rc = PTR_ERR(hpriv->mmio);
387 for (i = 0; i < AHCI_MAX_CLKS; i++) {
389 * For now we must use clk_get(dev, NULL) for the first clock,
390 * because some platforms (da850, spear13xx) are not yet
391 * converted to use devicetree for clocks. For new platforms
392 * this is equivalent to of_clk_get(dev->of_node, 0).
395 clk = clk_get(dev, NULL);
397 clk = of_clk_get(dev->of_node, i);
401 if (rc == -EPROBE_DEFER)
405 hpriv->clks[i] = clk;
408 hpriv->rsts = devm_reset_control_array_get_optional_shared(dev);
409 if (IS_ERR(hpriv->rsts)) {
410 rc = PTR_ERR(hpriv->rsts);
414 hpriv->nports = child_nodes = of_get_child_count(dev->of_node);
417 * If no sub-node was found, we still need to set nports to
418 * one in order to be able to use the
419 * ahci_platform_[en|dis]able_[phys|regulators] functions.
424 sz = hpriv->nports * sizeof(*hpriv->phys);
425 hpriv->phys = devm_kzalloc(dev, sz, GFP_KERNEL);
430 sz = hpriv->nports * sizeof(*hpriv->target_pwrs);
431 hpriv->target_pwrs = kzalloc(sz, GFP_KERNEL);
432 if (!hpriv->target_pwrs) {
438 for_each_child_of_node(dev->of_node, child) {
440 struct platform_device *port_dev __maybe_unused;
442 if (!of_device_is_available(child))
445 if (of_property_read_u32(child, "reg", &port)) {
450 if (port >= hpriv->nports) {
451 dev_warn(dev, "invalid port number %d\n", port);
454 mask_port_map |= BIT(port);
456 #ifdef CONFIG_OF_ADDRESS
457 of_platform_device_create(child, NULL, NULL);
459 port_dev = of_find_device_by_node(child);
462 rc = ahci_platform_get_regulator(hpriv, port,
464 if (rc == -EPROBE_DEFER)
469 rc = ahci_platform_get_phy(hpriv, port, dev, child);
475 if (!enabled_ports) {
476 dev_warn(dev, "No port enabled\n");
481 if (!hpriv->mask_port_map)
482 hpriv->mask_port_map = mask_port_map;
485 * If no sub-node was found, keep this for device tree
488 rc = ahci_platform_get_phy(hpriv, 0, dev, dev->of_node);
492 rc = ahci_platform_get_regulator(hpriv, 0, dev);
493 if (rc == -EPROBE_DEFER)
496 pm_runtime_enable(dev);
497 pm_runtime_get_sync(dev);
498 hpriv->got_runtime_pm = true;
500 devres_remove_group(dev, NULL);
504 devres_release_group(dev, NULL);
507 EXPORT_SYMBOL_GPL(ahci_platform_get_resources);
510 * ahci_platform_init_host - Bring up an ahci-platform host
511 * @pdev: platform device pointer for the host
512 * @hpriv: ahci-host private data for the host
513 * @pi_template: template for the ata_port_info to use
514 * @sht: scsi_host_template to use when registering
516 * This function does all the usual steps needed to bring up an
517 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
518 * must be initialized / enabled before calling this.
521 * 0 on success otherwise a negative error code
523 int ahci_platform_init_host(struct platform_device *pdev,
524 struct ahci_host_priv *hpriv,
525 const struct ata_port_info *pi_template,
526 struct scsi_host_template *sht)
528 struct device *dev = &pdev->dev;
529 struct ata_port_info pi = *pi_template;
530 const struct ata_port_info *ppi[] = { &pi, NULL };
531 struct ata_host *host;
532 int i, irq, n_ports, rc;
534 irq = platform_get_irq(pdev, 0);
536 if (irq != -EPROBE_DEFER)
537 dev_err(dev, "no irq\n");
544 pi.private_data = (void *)(unsigned long)hpriv->flags;
546 ahci_save_initial_config(dev, hpriv);
548 if (hpriv->cap & HOST_CAP_NCQ)
549 pi.flags |= ATA_FLAG_NCQ;
551 if (hpriv->cap & HOST_CAP_PMP)
552 pi.flags |= ATA_FLAG_PMP;
554 ahci_set_em_messages(hpriv, &pi);
556 /* CAP.NP sometimes indicate the index of the last enabled
557 * port, at other times, that of the last possible port, so
558 * determining the maximum port number requires looking at
559 * both CAP.NP and port_map.
561 n_ports = max(ahci_nr_ports(hpriv->cap), fls(hpriv->port_map));
563 host = ata_host_alloc_pinfo(dev, ppi, n_ports);
567 host->private_data = hpriv;
569 if (!(hpriv->cap & HOST_CAP_SSS) || ahci_ignore_sss)
570 host->flags |= ATA_HOST_PARALLEL_SCAN;
572 dev_info(dev, "SSS flag set, parallel bus scan disabled\n");
574 if (pi.flags & ATA_FLAG_EM)
577 for (i = 0; i < host->n_ports; i++) {
578 struct ata_port *ap = host->ports[i];
580 ata_port_desc(ap, "mmio %pR",
581 platform_get_resource(pdev, IORESOURCE_MEM, 0));
582 ata_port_desc(ap, "port 0x%x", 0x100 + ap->port_no * 0x80);
584 /* set enclosure management message type */
585 if (ap->flags & ATA_FLAG_EM)
586 ap->em_message_type = hpriv->em_msg_type;
588 /* disabled/not-implemented port */
589 if (!(hpriv->port_map & (1 << i)))
590 ap->ops = &ata_dummy_port_ops;
593 if (hpriv->cap & HOST_CAP_64) {
594 rc = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
596 rc = dma_coerce_mask_and_coherent(dev,
599 dev_err(dev, "Failed to enable 64-bit DMA.\n");
602 dev_warn(dev, "Enable 32-bit DMA instead of 64-bit.\n");
606 rc = ahci_reset_controller(host);
610 ahci_init_controller(host);
611 ahci_print_info(host, "platform");
613 return ahci_host_activate(host, sht);
615 EXPORT_SYMBOL_GPL(ahci_platform_init_host);
617 static void ahci_host_stop(struct ata_host *host)
619 struct ahci_host_priv *hpriv = host->private_data;
621 ahci_platform_disable_resources(hpriv);
625 * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
626 * @dev: platform device pointer for the host
628 * This function is called during system shutdown and performs the minimal
629 * deconfiguration required to ensure that an ahci_platform host cannot
630 * corrupt or otherwise interfere with a new kernel being started with kexec.
632 void ahci_platform_shutdown(struct platform_device *pdev)
634 struct ata_host *host = platform_get_drvdata(pdev);
635 struct ahci_host_priv *hpriv = host->private_data;
636 void __iomem *mmio = hpriv->mmio;
639 for (i = 0; i < host->n_ports; i++) {
640 struct ata_port *ap = host->ports[i];
642 /* Disable port interrupts */
646 /* Stop the port DMA engines */
647 if (ap->ops->port_stop)
648 ap->ops->port_stop(ap);
651 /* Disable and clear host interrupts */
652 writel(readl(mmio + HOST_CTL) & ~HOST_IRQ_EN, mmio + HOST_CTL);
653 readl(mmio + HOST_CTL); /* flush */
654 writel(GENMASK(host->n_ports, 0), mmio + HOST_IRQ_STAT);
656 EXPORT_SYMBOL_GPL(ahci_platform_shutdown);
658 #ifdef CONFIG_PM_SLEEP
660 * ahci_platform_suspend_host - Suspend an ahci-platform host
661 * @dev: device pointer for the host
663 * This function does all the usual steps needed to suspend an
664 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
665 * must be disabled after calling this.
668 * 0 on success otherwise a negative error code
670 int ahci_platform_suspend_host(struct device *dev)
672 struct ata_host *host = dev_get_drvdata(dev);
673 struct ahci_host_priv *hpriv = host->private_data;
674 void __iomem *mmio = hpriv->mmio;
677 if (hpriv->flags & AHCI_HFLAG_NO_SUSPEND) {
678 dev_err(dev, "firmware update required for suspend/resume\n");
683 * AHCI spec rev1.1 section 8.3.3:
684 * Software must disable interrupts prior to requesting a
685 * transition of the HBA to D3 state.
687 ctl = readl(mmio + HOST_CTL);
689 writel(ctl, mmio + HOST_CTL);
690 readl(mmio + HOST_CTL); /* flush */
692 return ata_host_suspend(host, PMSG_SUSPEND);
694 EXPORT_SYMBOL_GPL(ahci_platform_suspend_host);
697 * ahci_platform_resume_host - Resume an ahci-platform host
698 * @dev: device pointer for the host
700 * This function does all the usual steps needed to resume an ahci-platform
701 * host, note any necessary resources (ie clks, phys, etc.) must be
702 * initialized / enabled before calling this.
705 * 0 on success otherwise a negative error code
707 int ahci_platform_resume_host(struct device *dev)
709 struct ata_host *host = dev_get_drvdata(dev);
712 if (dev->power.power_state.event == PM_EVENT_SUSPEND) {
713 rc = ahci_reset_controller(host);
717 ahci_init_controller(host);
720 ata_host_resume(host);
724 EXPORT_SYMBOL_GPL(ahci_platform_resume_host);
727 * ahci_platform_suspend - Suspend an ahci-platform device
728 * @dev: the platform device to suspend
730 * This function suspends the host associated with the device, followed by
731 * disabling all the resources of the device.
734 * 0 on success otherwise a negative error code
736 int ahci_platform_suspend(struct device *dev)
738 struct ata_host *host = dev_get_drvdata(dev);
739 struct ahci_host_priv *hpriv = host->private_data;
742 rc = ahci_platform_suspend_host(dev);
746 ahci_platform_disable_resources(hpriv);
750 EXPORT_SYMBOL_GPL(ahci_platform_suspend);
753 * ahci_platform_resume - Resume an ahci-platform device
754 * @dev: the platform device to resume
756 * This function enables all the resources of the device followed by
757 * resuming the host associated with the device.
760 * 0 on success otherwise a negative error code
762 int ahci_platform_resume(struct device *dev)
764 struct ata_host *host = dev_get_drvdata(dev);
765 struct ahci_host_priv *hpriv = host->private_data;
768 rc = ahci_platform_enable_resources(hpriv);
772 rc = ahci_platform_resume_host(dev);
774 goto disable_resources;
776 /* We resumed so update PM runtime state */
777 pm_runtime_disable(dev);
778 pm_runtime_set_active(dev);
779 pm_runtime_enable(dev);
784 ahci_platform_disable_resources(hpriv);
788 EXPORT_SYMBOL_GPL(ahci_platform_resume);
791 MODULE_DESCRIPTION("AHCI SATA platform library");
792 MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
793 MODULE_LICENSE("GPL");