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 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]);
75 EXPORT_SYMBOL_GPL(ahci_platform_enable_phys);
78 * ahci_platform_disable_phys - Disable PHYs
79 * @hpriv: host private area to store config values
81 * This function disables all PHYs found in hpriv->phys.
83 void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
87 for (i = 0; i < hpriv->nports; i++) {
88 phy_power_off(hpriv->phys[i]);
89 phy_exit(hpriv->phys[i]);
92 EXPORT_SYMBOL_GPL(ahci_platform_disable_phys);
95 * ahci_platform_enable_clks - Enable platform clocks
96 * @hpriv: host private area to store config values
98 * This function enables all the clks found in hpriv->clks, starting at
99 * index 0. If any clk fails to enable it disables all the clks already
100 * enabled in reverse order, and then returns an error.
103 * 0 on success otherwise a negative error code
105 int ahci_platform_enable_clks(struct ahci_host_priv *hpriv)
109 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++) {
110 rc = clk_prepare_enable(hpriv->clks[c]);
112 goto disable_unprepare_clk;
116 disable_unprepare_clk:
118 clk_disable_unprepare(hpriv->clks[c]);
121 EXPORT_SYMBOL_GPL(ahci_platform_enable_clks);
124 * ahci_platform_disable_clks - Disable platform clocks
125 * @hpriv: host private area to store config values
127 * This function disables all the clks found in hpriv->clks, in reverse
128 * order of ahci_platform_enable_clks (starting at the end of the array).
130 void ahci_platform_disable_clks(struct ahci_host_priv *hpriv)
134 for (c = AHCI_MAX_CLKS - 1; c >= 0; c--)
136 clk_disable_unprepare(hpriv->clks[c]);
138 EXPORT_SYMBOL_GPL(ahci_platform_disable_clks);
141 * ahci_platform_enable_regulators - Enable regulators
142 * @hpriv: host private area to store config values
144 * This function enables all the regulators found in
145 * hpriv->target_pwrs, if any. If a regulator fails to be enabled, it
146 * disables all the regulators already enabled in reverse order and
150 * 0 on success otherwise a negative error code
152 int ahci_platform_enable_regulators(struct ahci_host_priv *hpriv)
156 for (i = 0; i < hpriv->nports; i++) {
157 if (!hpriv->target_pwrs[i])
160 rc = regulator_enable(hpriv->target_pwrs[i]);
162 goto disable_target_pwrs;
169 if (hpriv->target_pwrs[i])
170 regulator_disable(hpriv->target_pwrs[i]);
174 EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators);
177 * ahci_platform_disable_regulators - Disable regulators
178 * @hpriv: host private area to store config values
180 * This function disables all regulators found in hpriv->target_pwrs.
182 void ahci_platform_disable_regulators(struct ahci_host_priv *hpriv)
186 for (i = 0; i < hpriv->nports; i++) {
187 if (!hpriv->target_pwrs[i])
189 regulator_disable(hpriv->target_pwrs[i]);
192 EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators);
194 * ahci_platform_enable_resources - Enable platform resources
195 * @hpriv: host private area to store config values
197 * This function enables all ahci_platform managed resources in the
200 * 2) Clocks (through ahci_platform_enable_clks)
204 * If resource enabling fails at any point the previous enabled resources
205 * are disabled in reverse order.
208 * 0 on success otherwise a negative error code
210 int ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
214 rc = ahci_platform_enable_regulators(hpriv);
218 rc = ahci_platform_enable_clks(hpriv);
220 goto disable_regulator;
222 rc = reset_control_deassert(hpriv->rsts);
226 rc = ahci_platform_enable_phys(hpriv);
233 reset_control_assert(hpriv->rsts);
236 ahci_platform_disable_clks(hpriv);
239 ahci_platform_disable_regulators(hpriv);
243 EXPORT_SYMBOL_GPL(ahci_platform_enable_resources);
246 * ahci_platform_disable_resources - Disable platform resources
247 * @hpriv: host private area to store config values
249 * This function disables all ahci_platform managed resources in the
253 * 3) Clocks (through ahci_platform_disable_clks)
256 void ahci_platform_disable_resources(struct ahci_host_priv *hpriv)
258 ahci_platform_disable_phys(hpriv);
260 reset_control_assert(hpriv->rsts);
262 ahci_platform_disable_clks(hpriv);
264 ahci_platform_disable_regulators(hpriv);
266 EXPORT_SYMBOL_GPL(ahci_platform_disable_resources);
268 static void ahci_platform_put_resources(struct device *dev, void *res)
270 struct ahci_host_priv *hpriv = res;
273 if (hpriv->got_runtime_pm) {
274 pm_runtime_put_sync(dev);
275 pm_runtime_disable(dev);
278 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++)
279 clk_put(hpriv->clks[c]);
281 * The regulators are tied to child node device and not to the
282 * SATA device itself. So we can't use devm for automatically
283 * releasing them. We have to do it manually here.
285 for (c = 0; c < hpriv->nports; c++)
286 if (hpriv->target_pwrs && hpriv->target_pwrs[c])
287 regulator_put(hpriv->target_pwrs[c]);
289 kfree(hpriv->target_pwrs);
292 static int ahci_platform_get_phy(struct ahci_host_priv *hpriv, u32 port,
293 struct device *dev, struct device_node *node)
297 hpriv->phys[port] = devm_of_phy_get(dev, node, NULL);
299 if (!IS_ERR(hpriv->phys[port]))
302 rc = PTR_ERR(hpriv->phys[port]);
305 /* No PHY support. Check if PHY is required. */
306 if (of_find_property(node, "phys", NULL)) {
308 "couldn't get PHY in node %s: ENOSYS\n",
314 /* continue normally */
315 hpriv->phys[port] = NULL;
319 /* Do not complain yet */
324 "couldn't get PHY in node %s: %d\n",
333 static int ahci_platform_get_regulator(struct ahci_host_priv *hpriv, u32 port,
336 struct regulator *target_pwr;
339 target_pwr = regulator_get_optional(dev, "target");
341 if (!IS_ERR(target_pwr))
342 hpriv->target_pwrs[port] = target_pwr;
344 rc = PTR_ERR(target_pwr);
350 * ahci_platform_get_resources - Get platform resources
351 * @pdev: platform device to get resources for
352 * @flags: bitmap representing the resource to get
354 * This function allocates an ahci_host_priv struct, and gets the following
355 * resources, storing a reference to them inside the returned struct:
357 * 1) mmio registers (IORESOURCE_MEM 0, mandatory)
358 * 2) regulator for controlling the targets power (optional)
359 * 3) 0 - AHCI_MAX_CLKS clocks, as specified in the devs devicetree node,
360 * or for non devicetree enabled platforms a single clock
361 * 4) resets, if flags has AHCI_PLATFORM_GET_RESETS (optional)
365 * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
367 struct ahci_host_priv *ahci_platform_get_resources(struct platform_device *pdev,
370 struct device *dev = &pdev->dev;
371 struct ahci_host_priv *hpriv;
373 struct device_node *child;
374 int i, enabled_ports = 0, rc = -ENOMEM, child_nodes;
375 u32 mask_port_map = 0;
377 if (!devres_open_group(dev, NULL, GFP_KERNEL))
378 return ERR_PTR(-ENOMEM);
380 hpriv = devres_alloc(ahci_platform_put_resources, sizeof(*hpriv),
385 devres_add(dev, hpriv);
387 hpriv->mmio = devm_ioremap_resource(dev,
388 platform_get_resource(pdev, IORESOURCE_MEM, 0));
389 if (IS_ERR(hpriv->mmio)) {
390 dev_err(dev, "no mmio space\n");
391 rc = PTR_ERR(hpriv->mmio);
395 for (i = 0; i < AHCI_MAX_CLKS; i++) {
397 * For now we must use clk_get(dev, NULL) for the first clock,
398 * because some platforms (da850, spear13xx) are not yet
399 * converted to use devicetree for clocks. For new platforms
400 * this is equivalent to of_clk_get(dev->of_node, 0).
403 clk = clk_get(dev, NULL);
405 clk = of_clk_get(dev->of_node, i);
409 if (rc == -EPROBE_DEFER)
413 hpriv->clks[i] = clk;
416 if (flags & AHCI_PLATFORM_GET_RESETS) {
417 hpriv->rsts = devm_reset_control_array_get_optional_shared(dev);
418 if (IS_ERR(hpriv->rsts)) {
419 rc = PTR_ERR(hpriv->rsts);
425 * Too many sub-nodes most likely means having something wrong with
428 child_nodes = of_get_child_count(dev->of_node);
429 if (child_nodes > AHCI_MAX_PORTS) {
435 * If no sub-node was found, we still need to set nports to
436 * one in order to be able to use the
437 * ahci_platform_[en|dis]able_[phys|regulators] functions.
440 hpriv->nports = child_nodes;
444 hpriv->phys = devm_kcalloc(dev, hpriv->nports, sizeof(*hpriv->phys), GFP_KERNEL);
450 * We cannot use devm_ here, since ahci_platform_put_resources() uses
451 * target_pwrs after devm_ have freed memory
453 hpriv->target_pwrs = kcalloc(hpriv->nports, sizeof(*hpriv->target_pwrs), GFP_KERNEL);
454 if (!hpriv->target_pwrs) {
460 for_each_child_of_node(dev->of_node, child) {
462 struct platform_device *port_dev __maybe_unused;
464 if (!of_device_is_available(child))
467 if (of_property_read_u32(child, "reg", &port)) {
472 if (port >= hpriv->nports) {
473 dev_warn(dev, "invalid port number %d\n", port);
476 mask_port_map |= BIT(port);
478 #ifdef CONFIG_OF_ADDRESS
479 of_platform_device_create(child, NULL, NULL);
481 port_dev = of_find_device_by_node(child);
484 rc = ahci_platform_get_regulator(hpriv, port,
486 if (rc == -EPROBE_DEFER)
491 rc = ahci_platform_get_phy(hpriv, port, dev, child);
497 if (!enabled_ports) {
498 dev_warn(dev, "No port enabled\n");
503 if (!hpriv->mask_port_map)
504 hpriv->mask_port_map = mask_port_map;
507 * If no sub-node was found, keep this for device tree
510 rc = ahci_platform_get_phy(hpriv, 0, dev, dev->of_node);
514 rc = ahci_platform_get_regulator(hpriv, 0, dev);
515 if (rc == -EPROBE_DEFER)
518 pm_runtime_enable(dev);
519 pm_runtime_get_sync(dev);
520 hpriv->got_runtime_pm = true;
522 devres_remove_group(dev, NULL);
526 devres_release_group(dev, NULL);
529 EXPORT_SYMBOL_GPL(ahci_platform_get_resources);
532 * ahci_platform_init_host - Bring up an ahci-platform host
533 * @pdev: platform device pointer for the host
534 * @hpriv: ahci-host private data for the host
535 * @pi_template: template for the ata_port_info to use
536 * @sht: scsi_host_template to use when registering
538 * This function does all the usual steps needed to bring up an
539 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
540 * must be initialized / enabled before calling this.
543 * 0 on success otherwise a negative error code
545 int ahci_platform_init_host(struct platform_device *pdev,
546 struct ahci_host_priv *hpriv,
547 const struct ata_port_info *pi_template,
548 struct scsi_host_template *sht)
550 struct device *dev = &pdev->dev;
551 struct ata_port_info pi = *pi_template;
552 const struct ata_port_info *ppi[] = { &pi, NULL };
553 struct ata_host *host;
554 int i, irq, n_ports, rc;
556 irq = platform_get_irq(pdev, 0);
558 if (irq != -EPROBE_DEFER)
559 dev_err(dev, "no irq\n");
568 pi.private_data = (void *)(unsigned long)hpriv->flags;
570 ahci_save_initial_config(dev, hpriv);
572 if (hpriv->cap & HOST_CAP_NCQ)
573 pi.flags |= ATA_FLAG_NCQ;
575 if (hpriv->cap & HOST_CAP_PMP)
576 pi.flags |= ATA_FLAG_PMP;
578 ahci_set_em_messages(hpriv, &pi);
580 /* CAP.NP sometimes indicate the index of the last enabled
581 * port, at other times, that of the last possible port, so
582 * determining the maximum port number requires looking at
583 * both CAP.NP and port_map.
585 n_ports = max(ahci_nr_ports(hpriv->cap), fls(hpriv->port_map));
587 host = ata_host_alloc_pinfo(dev, ppi, n_ports);
591 host->private_data = hpriv;
593 if (!(hpriv->cap & HOST_CAP_SSS) || ahci_ignore_sss)
594 host->flags |= ATA_HOST_PARALLEL_SCAN;
596 dev_info(dev, "SSS flag set, parallel bus scan disabled\n");
598 if (pi.flags & ATA_FLAG_EM)
601 for (i = 0; i < host->n_ports; i++) {
602 struct ata_port *ap = host->ports[i];
604 ata_port_desc(ap, "mmio %pR",
605 platform_get_resource(pdev, IORESOURCE_MEM, 0));
606 ata_port_desc(ap, "port 0x%x", 0x100 + ap->port_no * 0x80);
608 /* set enclosure management message type */
609 if (ap->flags & ATA_FLAG_EM)
610 ap->em_message_type = hpriv->em_msg_type;
612 /* disabled/not-implemented port */
613 if (!(hpriv->port_map & (1 << i)))
614 ap->ops = &ata_dummy_port_ops;
617 if (hpriv->cap & HOST_CAP_64) {
618 rc = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
620 rc = dma_coerce_mask_and_coherent(dev,
623 dev_err(dev, "Failed to enable 64-bit DMA.\n");
626 dev_warn(dev, "Enable 32-bit DMA instead of 64-bit.\n");
630 rc = ahci_reset_controller(host);
634 ahci_init_controller(host);
635 ahci_print_info(host, "platform");
637 return ahci_host_activate(host, sht);
639 EXPORT_SYMBOL_GPL(ahci_platform_init_host);
641 static void ahci_host_stop(struct ata_host *host)
643 struct ahci_host_priv *hpriv = host->private_data;
645 ahci_platform_disable_resources(hpriv);
649 * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
650 * @pdev: platform device pointer for the host
652 * This function is called during system shutdown and performs the minimal
653 * deconfiguration required to ensure that an ahci_platform host cannot
654 * corrupt or otherwise interfere with a new kernel being started with kexec.
656 void ahci_platform_shutdown(struct platform_device *pdev)
658 struct ata_host *host = platform_get_drvdata(pdev);
659 struct ahci_host_priv *hpriv = host->private_data;
660 void __iomem *mmio = hpriv->mmio;
663 for (i = 0; i < host->n_ports; i++) {
664 struct ata_port *ap = host->ports[i];
666 /* Disable port interrupts */
670 /* Stop the port DMA engines */
671 if (ap->ops->port_stop)
672 ap->ops->port_stop(ap);
675 /* Disable and clear host interrupts */
676 writel(readl(mmio + HOST_CTL) & ~HOST_IRQ_EN, mmio + HOST_CTL);
677 readl(mmio + HOST_CTL); /* flush */
678 writel(GENMASK(host->n_ports, 0), mmio + HOST_IRQ_STAT);
680 EXPORT_SYMBOL_GPL(ahci_platform_shutdown);
682 #ifdef CONFIG_PM_SLEEP
684 * ahci_platform_suspend_host - Suspend an ahci-platform host
685 * @dev: device pointer for the host
687 * This function does all the usual steps needed to suspend an
688 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
689 * must be disabled after calling this.
692 * 0 on success otherwise a negative error code
694 int ahci_platform_suspend_host(struct device *dev)
696 struct ata_host *host = dev_get_drvdata(dev);
697 struct ahci_host_priv *hpriv = host->private_data;
698 void __iomem *mmio = hpriv->mmio;
701 if (hpriv->flags & AHCI_HFLAG_NO_SUSPEND) {
702 dev_err(dev, "firmware update required for suspend/resume\n");
707 * AHCI spec rev1.1 section 8.3.3:
708 * Software must disable interrupts prior to requesting a
709 * transition of the HBA to D3 state.
711 ctl = readl(mmio + HOST_CTL);
713 writel(ctl, mmio + HOST_CTL);
714 readl(mmio + HOST_CTL); /* flush */
716 return ata_host_suspend(host, PMSG_SUSPEND);
718 EXPORT_SYMBOL_GPL(ahci_platform_suspend_host);
721 * ahci_platform_resume_host - Resume an ahci-platform host
722 * @dev: device pointer for the host
724 * This function does all the usual steps needed to resume an ahci-platform
725 * host, note any necessary resources (ie clks, phys, etc.) must be
726 * initialized / enabled before calling this.
729 * 0 on success otherwise a negative error code
731 int ahci_platform_resume_host(struct device *dev)
733 struct ata_host *host = dev_get_drvdata(dev);
736 if (dev->power.power_state.event == PM_EVENT_SUSPEND) {
737 rc = ahci_reset_controller(host);
741 ahci_init_controller(host);
744 ata_host_resume(host);
748 EXPORT_SYMBOL_GPL(ahci_platform_resume_host);
751 * ahci_platform_suspend - Suspend an ahci-platform device
752 * @dev: the platform device to suspend
754 * This function suspends the host associated with the device, followed by
755 * disabling all the resources of the device.
758 * 0 on success otherwise a negative error code
760 int ahci_platform_suspend(struct device *dev)
762 struct ata_host *host = dev_get_drvdata(dev);
763 struct ahci_host_priv *hpriv = host->private_data;
766 rc = ahci_platform_suspend_host(dev);
770 ahci_platform_disable_resources(hpriv);
774 EXPORT_SYMBOL_GPL(ahci_platform_suspend);
777 * ahci_platform_resume - Resume an ahci-platform device
778 * @dev: the platform device to resume
780 * This function enables all the resources of the device followed by
781 * resuming the host associated with the device.
784 * 0 on success otherwise a negative error code
786 int ahci_platform_resume(struct device *dev)
788 struct ata_host *host = dev_get_drvdata(dev);
789 struct ahci_host_priv *hpriv = host->private_data;
792 rc = ahci_platform_enable_resources(hpriv);
796 rc = ahci_platform_resume_host(dev);
798 goto disable_resources;
800 /* We resumed so update PM runtime state */
801 pm_runtime_disable(dev);
802 pm_runtime_set_active(dev);
803 pm_runtime_enable(dev);
808 ahci_platform_disable_resources(hpriv);
812 EXPORT_SYMBOL_GPL(ahci_platform_resume);
815 MODULE_DESCRIPTION("AHCI SATA platform library");
816 MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
817 MODULE_LICENSE("GPL");