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>
30 static void ahci_host_stop(struct ata_host *host);
32 struct ata_port_operations ahci_platform_ops = {
33 .inherits = &ahci_ops,
34 .host_stop = ahci_host_stop,
36 EXPORT_SYMBOL_GPL(ahci_platform_ops);
39 * ahci_platform_enable_phys - Enable PHYs
40 * @hpriv: host private area to store config values
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.
47 * 0 on success otherwise a negative error code
49 static int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
53 for (i = 0; i < hpriv->nports; i++) {
54 rc = phy_init(hpriv->phys[i]);
58 rc = phy_power_on(hpriv->phys[i]);
60 phy_exit(hpriv->phys[i]);
69 phy_power_off(hpriv->phys[i]);
70 phy_exit(hpriv->phys[i]);
76 * ahci_platform_disable_phys - Disable PHYs
77 * @hpriv: host private area to store config values
79 * This function disables all PHYs found in hpriv->phys.
81 static void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
85 for (i = 0; i < hpriv->nports; i++) {
86 phy_power_off(hpriv->phys[i]);
87 phy_exit(hpriv->phys[i]);
92 * ahci_platform_enable_clks - Enable platform clocks
93 * @hpriv: host private area to store config values
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.
100 * 0 on success otherwise a negative error code
102 int ahci_platform_enable_clks(struct ahci_host_priv *hpriv)
106 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++) {
107 rc = clk_prepare_enable(hpriv->clks[c]);
109 goto disable_unprepare_clk;
113 disable_unprepare_clk:
115 clk_disable_unprepare(hpriv->clks[c]);
118 EXPORT_SYMBOL_GPL(ahci_platform_enable_clks);
121 * ahci_platform_disable_clks - Disable platform clocks
122 * @hpriv: host private area to store config values
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).
127 void ahci_platform_disable_clks(struct ahci_host_priv *hpriv)
131 for (c = AHCI_MAX_CLKS - 1; c >= 0; c--)
133 clk_disable_unprepare(hpriv->clks[c]);
135 EXPORT_SYMBOL_GPL(ahci_platform_disable_clks);
138 * ahci_platform_enable_regulators - Enable regulators
139 * @hpriv: host private area to store config values
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
147 * 0 on success otherwise a negative error code
149 int ahci_platform_enable_regulators(struct ahci_host_priv *hpriv)
153 for (i = 0; i < hpriv->nports; i++) {
154 if (!hpriv->target_pwrs[i])
157 rc = regulator_enable(hpriv->target_pwrs[i]);
159 goto disable_target_pwrs;
166 if (hpriv->target_pwrs[i])
167 regulator_disable(hpriv->target_pwrs[i]);
171 EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators);
174 * ahci_platform_disable_regulators - Disable regulators
175 * @hpriv: host private area to store config values
177 * This function disables all regulators found in hpriv->target_pwrs.
179 void ahci_platform_disable_regulators(struct ahci_host_priv *hpriv)
183 for (i = 0; i < hpriv->nports; i++) {
184 if (!hpriv->target_pwrs[i])
186 regulator_disable(hpriv->target_pwrs[i]);
189 EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators);
191 * ahci_platform_enable_resources - Enable platform resources
192 * @hpriv: host private area to store config values
194 * This function enables all ahci_platform managed resources in the
197 * 2) Clocks (through ahci_platform_enable_clks)
200 * If resource enabling fails at any point the previous enabled resources
201 * are disabled in reverse order.
204 * 0 on success otherwise a negative error code
206 int ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
210 rc = ahci_platform_enable_regulators(hpriv);
214 rc = ahci_platform_enable_clks(hpriv);
216 goto disable_regulator;
218 rc = ahci_platform_enable_phys(hpriv);
225 ahci_platform_disable_clks(hpriv);
228 ahci_platform_disable_regulators(hpriv);
232 EXPORT_SYMBOL_GPL(ahci_platform_enable_resources);
235 * ahci_platform_disable_resources - Disable platform resources
236 * @hpriv: host private area to store config values
238 * This function disables all ahci_platform managed resources in the
241 * 2) Clocks (through ahci_platform_disable_clks)
244 void ahci_platform_disable_resources(struct ahci_host_priv *hpriv)
246 ahci_platform_disable_phys(hpriv);
248 ahci_platform_disable_clks(hpriv);
250 ahci_platform_disable_regulators(hpriv);
252 EXPORT_SYMBOL_GPL(ahci_platform_disable_resources);
254 static void ahci_platform_put_resources(struct device *dev, void *res)
256 struct ahci_host_priv *hpriv = res;
259 if (hpriv->got_runtime_pm) {
260 pm_runtime_put_sync(dev);
261 pm_runtime_disable(dev);
264 for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++)
265 clk_put(hpriv->clks[c]);
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.
271 for (c = 0; c < hpriv->nports; c++)
272 if (hpriv->target_pwrs && hpriv->target_pwrs[c])
273 regulator_put(hpriv->target_pwrs[c]);
275 kfree(hpriv->target_pwrs);
278 static int ahci_platform_get_phy(struct ahci_host_priv *hpriv, u32 port,
279 struct device *dev, struct device_node *node)
283 hpriv->phys[port] = devm_of_phy_get(dev, node, NULL);
285 if (!IS_ERR(hpriv->phys[port]))
288 rc = PTR_ERR(hpriv->phys[port]);
291 /* No PHY support. Check if PHY is required. */
292 if (of_find_property(node, "phys", NULL)) {
294 "couldn't get PHY in node %s: ENOSYS\n",
300 /* continue normally */
301 hpriv->phys[port] = NULL;
307 "couldn't get PHY in node %s: %d\n",
316 static int ahci_platform_get_regulator(struct ahci_host_priv *hpriv, u32 port,
319 struct regulator *target_pwr;
322 target_pwr = regulator_get_optional(dev, "target");
324 if (!IS_ERR(target_pwr))
325 hpriv->target_pwrs[port] = target_pwr;
327 rc = PTR_ERR(target_pwr);
333 * ahci_platform_get_resources - Get platform resources
334 * @pdev: platform device to get resources for
336 * This function allocates an ahci_host_priv struct, and gets the following
337 * resources, storing a reference to them inside the returned struct:
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
346 * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
348 struct ahci_host_priv *ahci_platform_get_resources(struct platform_device *pdev)
350 struct device *dev = &pdev->dev;
351 struct ahci_host_priv *hpriv;
353 struct device_node *child;
354 int i, sz, enabled_ports = 0, rc = -ENOMEM, child_nodes;
355 u32 mask_port_map = 0;
357 if (!devres_open_group(dev, NULL, GFP_KERNEL))
358 return ERR_PTR(-ENOMEM);
360 hpriv = devres_alloc(ahci_platform_put_resources, sizeof(*hpriv),
365 devres_add(dev, hpriv);
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);
375 for (i = 0; i < AHCI_MAX_CLKS; i++) {
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).
383 clk = clk_get(dev, NULL);
385 clk = of_clk_get(dev->of_node, i);
389 if (rc == -EPROBE_DEFER)
393 hpriv->clks[i] = clk;
396 hpriv->nports = child_nodes = of_get_child_count(dev->of_node);
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.
406 sz = hpriv->nports * sizeof(*hpriv->phys);
407 hpriv->phys = devm_kzalloc(dev, sz, GFP_KERNEL);
412 sz = hpriv->nports * sizeof(*hpriv->target_pwrs);
413 hpriv->target_pwrs = kzalloc(sz, GFP_KERNEL);
414 if (!hpriv->target_pwrs) {
420 for_each_child_of_node(dev->of_node, child) {
422 struct platform_device *port_dev __maybe_unused;
424 if (!of_device_is_available(child))
427 if (of_property_read_u32(child, "reg", &port)) {
432 if (port >= hpriv->nports) {
433 dev_warn(dev, "invalid port number %d\n", port);
436 mask_port_map |= BIT(port);
438 #ifdef CONFIG_OF_ADDRESS
439 of_platform_device_create(child, NULL, NULL);
441 port_dev = of_find_device_by_node(child);
444 rc = ahci_platform_get_regulator(hpriv, port,
446 if (rc == -EPROBE_DEFER)
451 rc = ahci_platform_get_phy(hpriv, port, dev, child);
457 if (!enabled_ports) {
458 dev_warn(dev, "No port enabled\n");
463 if (!hpriv->mask_port_map)
464 hpriv->mask_port_map = mask_port_map;
467 * If no sub-node was found, keep this for device tree
470 rc = ahci_platform_get_phy(hpriv, 0, dev, dev->of_node);
474 rc = ahci_platform_get_regulator(hpriv, 0, dev);
475 if (rc == -EPROBE_DEFER)
478 pm_runtime_enable(dev);
479 pm_runtime_get_sync(dev);
480 hpriv->got_runtime_pm = true;
482 devres_remove_group(dev, NULL);
486 devres_release_group(dev, NULL);
489 EXPORT_SYMBOL_GPL(ahci_platform_get_resources);
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
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.
503 * 0 on success otherwise a negative error code
505 int 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)
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;
516 irq = platform_get_irq(pdev, 0);
518 if (irq != -EPROBE_DEFER)
519 dev_err(dev, "no irq\n");
526 pi.private_data = (void *)(unsigned long)hpriv->flags;
528 ahci_save_initial_config(dev, hpriv);
530 if (hpriv->cap & HOST_CAP_NCQ)
531 pi.flags |= ATA_FLAG_NCQ;
533 if (hpriv->cap & HOST_CAP_PMP)
534 pi.flags |= ATA_FLAG_PMP;
536 ahci_set_em_messages(hpriv, &pi);
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.
543 n_ports = max(ahci_nr_ports(hpriv->cap), fls(hpriv->port_map));
545 host = ata_host_alloc_pinfo(dev, ppi, n_ports);
549 host->private_data = hpriv;
551 if (!(hpriv->cap & HOST_CAP_SSS) || ahci_ignore_sss)
552 host->flags |= ATA_HOST_PARALLEL_SCAN;
554 dev_info(dev, "SSS flag set, parallel bus scan disabled\n");
556 if (pi.flags & ATA_FLAG_EM)
559 for (i = 0; i < host->n_ports; i++) {
560 struct ata_port *ap = host->ports[i];
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);
566 /* set enclosure management message type */
567 if (ap->flags & ATA_FLAG_EM)
568 ap->em_message_type = hpriv->em_msg_type;
570 /* disabled/not-implemented port */
571 if (!(hpriv->port_map & (1 << i)))
572 ap->ops = &ata_dummy_port_ops;
575 if (hpriv->cap & HOST_CAP_64) {
576 rc = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
578 rc = dma_coerce_mask_and_coherent(dev,
581 dev_err(dev, "Failed to enable 64-bit DMA.\n");
584 dev_warn(dev, "Enable 32-bit DMA instead of 64-bit.\n");
588 rc = ahci_reset_controller(host);
592 ahci_init_controller(host);
593 ahci_print_info(host, "platform");
595 return ahci_host_activate(host, sht);
597 EXPORT_SYMBOL_GPL(ahci_platform_init_host);
599 static void ahci_host_stop(struct ata_host *host)
601 struct ahci_host_priv *hpriv = host->private_data;
603 ahci_platform_disable_resources(hpriv);
607 * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
608 * @dev: platform device pointer for the host
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.
614 void ahci_platform_shutdown(struct platform_device *pdev)
616 struct ata_host *host = platform_get_drvdata(pdev);
617 struct ahci_host_priv *hpriv = host->private_data;
618 void __iomem *mmio = hpriv->mmio;
621 for (i = 0; i < host->n_ports; i++) {
622 struct ata_port *ap = host->ports[i];
624 /* Disable port interrupts */
628 /* Stop the port DMA engines */
629 if (ap->ops->port_stop)
630 ap->ops->port_stop(ap);
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);
638 EXPORT_SYMBOL_GPL(ahci_platform_shutdown);
640 #ifdef CONFIG_PM_SLEEP
642 * ahci_platform_suspend_host - Suspend an ahci-platform host
643 * @dev: device pointer for the host
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.
650 * 0 on success otherwise a negative error code
652 int ahci_platform_suspend_host(struct device *dev)
654 struct ata_host *host = dev_get_drvdata(dev);
655 struct ahci_host_priv *hpriv = host->private_data;
656 void __iomem *mmio = hpriv->mmio;
659 if (hpriv->flags & AHCI_HFLAG_NO_SUSPEND) {
660 dev_err(dev, "firmware update required for suspend/resume\n");
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.
669 ctl = readl(mmio + HOST_CTL);
671 writel(ctl, mmio + HOST_CTL);
672 readl(mmio + HOST_CTL); /* flush */
674 return ata_host_suspend(host, PMSG_SUSPEND);
676 EXPORT_SYMBOL_GPL(ahci_platform_suspend_host);
679 * ahci_platform_resume_host - Resume an ahci-platform host
680 * @dev: device pointer for the host
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.
687 * 0 on success otherwise a negative error code
689 int ahci_platform_resume_host(struct device *dev)
691 struct ata_host *host = dev_get_drvdata(dev);
694 if (dev->power.power_state.event == PM_EVENT_SUSPEND) {
695 rc = ahci_reset_controller(host);
699 ahci_init_controller(host);
702 ata_host_resume(host);
706 EXPORT_SYMBOL_GPL(ahci_platform_resume_host);
709 * ahci_platform_suspend - Suspend an ahci-platform device
710 * @dev: the platform device to suspend
712 * This function suspends the host associated with the device, followed by
713 * disabling all the resources of the device.
716 * 0 on success otherwise a negative error code
718 int ahci_platform_suspend(struct device *dev)
720 struct ata_host *host = dev_get_drvdata(dev);
721 struct ahci_host_priv *hpriv = host->private_data;
724 rc = ahci_platform_suspend_host(dev);
728 ahci_platform_disable_resources(hpriv);
732 EXPORT_SYMBOL_GPL(ahci_platform_suspend);
735 * ahci_platform_resume - Resume an ahci-platform device
736 * @dev: the platform device to resume
738 * This function enables all the resources of the device followed by
739 * resuming the host associated with the device.
742 * 0 on success otherwise a negative error code
744 int ahci_platform_resume(struct device *dev)
746 struct ata_host *host = dev_get_drvdata(dev);
747 struct ahci_host_priv *hpriv = host->private_data;
750 rc = ahci_platform_enable_resources(hpriv);
754 rc = ahci_platform_resume_host(dev);
756 goto disable_resources;
758 /* We resumed so update PM runtime state */
759 pm_runtime_disable(dev);
760 pm_runtime_set_active(dev);
761 pm_runtime_enable(dev);
766 ahci_platform_disable_resources(hpriv);
770 EXPORT_SYMBOL_GPL(ahci_platform_resume);
773 MODULE_DESCRIPTION("AHCI SATA platform library");
774 MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
775 MODULE_LICENSE("GPL");