1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * AHCI SATA platform library
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>
11 #include <linux/clk.h>
12 #include <linux/kernel.h>
13 #include <linux/gfp.h>
14 #include <linux/module.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>
27 static void ahci_host_stop(struct ata_host
*host
);
29 struct ata_port_operations ahci_platform_ops
= {
30 .inherits
= &ahci_ops
,
31 .host_stop
= ahci_host_stop
,
33 EXPORT_SYMBOL_GPL(ahci_platform_ops
);
36 * ahci_platform_enable_phys - Enable PHYs
37 * @hpriv: host private area to store config values
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.
44 * 0 on success otherwise a negative error code
46 int ahci_platform_enable_phys(struct ahci_host_priv
*hpriv
)
50 for (i
= 0; i
< hpriv
->nports
; i
++) {
51 rc
= phy_init(hpriv
->phys
[i
]);
55 rc
= phy_set_mode(hpriv
->phys
[i
], PHY_MODE_SATA
);
57 phy_exit(hpriv
->phys
[i
]);
61 rc
= phy_power_on(hpriv
->phys
[i
]);
63 phy_exit(hpriv
->phys
[i
]);
72 phy_power_off(hpriv
->phys
[i
]);
73 phy_exit(hpriv
->phys
[i
]);
77 EXPORT_SYMBOL_GPL(ahci_platform_enable_phys
);
80 * ahci_platform_disable_phys - Disable PHYs
81 * @hpriv: host private area to store config values
83 * This function disables all PHYs found in hpriv->phys.
85 void ahci_platform_disable_phys(struct ahci_host_priv
*hpriv
)
89 for (i
= 0; i
< hpriv
->nports
; i
++) {
90 phy_power_off(hpriv
->phys
[i
]);
91 phy_exit(hpriv
->phys
[i
]);
94 EXPORT_SYMBOL_GPL(ahci_platform_disable_phys
);
97 * ahci_platform_enable_clks - Enable platform clocks
98 * @hpriv: host private area to store config values
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.
105 * 0 on success otherwise a negative error code
107 int ahci_platform_enable_clks(struct ahci_host_priv
*hpriv
)
111 for (c
= 0; c
< AHCI_MAX_CLKS
&& hpriv
->clks
[c
]; c
++) {
112 rc
= clk_prepare_enable(hpriv
->clks
[c
]);
114 goto disable_unprepare_clk
;
118 disable_unprepare_clk
:
120 clk_disable_unprepare(hpriv
->clks
[c
]);
123 EXPORT_SYMBOL_GPL(ahci_platform_enable_clks
);
126 * ahci_platform_disable_clks - Disable platform clocks
127 * @hpriv: host private area to store config values
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).
132 void ahci_platform_disable_clks(struct ahci_host_priv
*hpriv
)
136 for (c
= AHCI_MAX_CLKS
- 1; c
>= 0; c
--)
138 clk_disable_unprepare(hpriv
->clks
[c
]);
140 EXPORT_SYMBOL_GPL(ahci_platform_disable_clks
);
143 * ahci_platform_enable_regulators - Enable regulators
144 * @hpriv: host private area to store config values
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
152 * 0 on success otherwise a negative error code
154 int ahci_platform_enable_regulators(struct ahci_host_priv
*hpriv
)
158 rc
= regulator_enable(hpriv
->ahci_regulator
);
162 rc
= regulator_enable(hpriv
->phy_regulator
);
164 goto disable_ahci_pwrs
;
166 for (i
= 0; i
< hpriv
->nports
; i
++) {
167 if (!hpriv
->target_pwrs
[i
])
170 rc
= regulator_enable(hpriv
->target_pwrs
[i
]);
172 goto disable_target_pwrs
;
179 if (hpriv
->target_pwrs
[i
])
180 regulator_disable(hpriv
->target_pwrs
[i
]);
182 regulator_disable(hpriv
->phy_regulator
);
184 regulator_disable(hpriv
->ahci_regulator
);
187 EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators
);
190 * ahci_platform_disable_regulators - Disable regulators
191 * @hpriv: host private area to store config values
193 * This function disables all regulators found in hpriv->target_pwrs and
196 void ahci_platform_disable_regulators(struct ahci_host_priv
*hpriv
)
200 for (i
= 0; i
< hpriv
->nports
; i
++) {
201 if (!hpriv
->target_pwrs
[i
])
203 regulator_disable(hpriv
->target_pwrs
[i
]);
206 regulator_disable(hpriv
->ahci_regulator
);
207 regulator_disable(hpriv
->phy_regulator
);
209 EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators
);
211 * ahci_platform_enable_resources - Enable platform resources
212 * @hpriv: host private area to store config values
214 * This function enables all ahci_platform managed resources in the
217 * 2) Clocks (through ahci_platform_enable_clks)
221 * If resource enabling fails at any point the previous enabled resources
222 * are disabled in reverse order.
225 * 0 on success otherwise a negative error code
227 int ahci_platform_enable_resources(struct ahci_host_priv
*hpriv
)
231 rc
= ahci_platform_enable_regulators(hpriv
);
235 rc
= ahci_platform_enable_clks(hpriv
);
237 goto disable_regulator
;
239 rc
= reset_control_deassert(hpriv
->rsts
);
243 rc
= ahci_platform_enable_phys(hpriv
);
250 reset_control_assert(hpriv
->rsts
);
253 ahci_platform_disable_clks(hpriv
);
256 ahci_platform_disable_regulators(hpriv
);
260 EXPORT_SYMBOL_GPL(ahci_platform_enable_resources
);
263 * ahci_platform_disable_resources - Disable platform resources
264 * @hpriv: host private area to store config values
266 * This function disables all ahci_platform managed resources in the
270 * 3) Clocks (through ahci_platform_disable_clks)
273 void ahci_platform_disable_resources(struct ahci_host_priv
*hpriv
)
275 ahci_platform_disable_phys(hpriv
);
277 reset_control_assert(hpriv
->rsts
);
279 ahci_platform_disable_clks(hpriv
);
281 ahci_platform_disable_regulators(hpriv
);
283 EXPORT_SYMBOL_GPL(ahci_platform_disable_resources
);
285 static void ahci_platform_put_resources(struct device
*dev
, void *res
)
287 struct ahci_host_priv
*hpriv
= res
;
290 if (hpriv
->got_runtime_pm
) {
291 pm_runtime_put_sync(dev
);
292 pm_runtime_disable(dev
);
295 for (c
= 0; c
< AHCI_MAX_CLKS
&& hpriv
->clks
[c
]; c
++)
296 clk_put(hpriv
->clks
[c
]);
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.
302 for (c
= 0; c
< hpriv
->nports
; c
++)
303 if (hpriv
->target_pwrs
&& hpriv
->target_pwrs
[c
])
304 regulator_put(hpriv
->target_pwrs
[c
]);
306 kfree(hpriv
->target_pwrs
);
309 static int ahci_platform_get_phy(struct ahci_host_priv
*hpriv
, u32 port
,
310 struct device
*dev
, struct device_node
*node
)
314 hpriv
->phys
[port
] = devm_of_phy_get(dev
, node
, NULL
);
316 if (!IS_ERR(hpriv
->phys
[port
]))
319 rc
= PTR_ERR(hpriv
->phys
[port
]);
322 /* No PHY support. Check if PHY is required. */
323 if (of_find_property(node
, "phys", NULL
)) {
325 "couldn't get PHY in node %pOFn: ENOSYS\n",
331 /* continue normally */
332 hpriv
->phys
[port
] = NULL
;
336 /* Do not complain yet */
341 "couldn't get PHY in node %pOFn: %d\n",
350 static int ahci_platform_get_regulator(struct ahci_host_priv
*hpriv
, u32 port
,
353 struct regulator
*target_pwr
;
356 target_pwr
= regulator_get(dev
, "target");
358 if (!IS_ERR(target_pwr
))
359 hpriv
->target_pwrs
[port
] = target_pwr
;
361 rc
= PTR_ERR(target_pwr
);
367 * ahci_platform_get_resources - Get platform resources
368 * @pdev: platform device to get resources for
369 * @flags: bitmap representing the resource to get
371 * This function allocates an ahci_host_priv struct, and gets the following
372 * resources, storing a reference to them inside the returned struct:
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)
383 * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
385 struct ahci_host_priv
*ahci_platform_get_resources(struct platform_device
*pdev
,
388 struct device
*dev
= &pdev
->dev
;
389 struct ahci_host_priv
*hpriv
;
391 struct device_node
*child
;
392 int i
, enabled_ports
= 0, rc
= -ENOMEM
, child_nodes
;
393 u32 mask_port_map
= 0;
395 if (!devres_open_group(dev
, NULL
, GFP_KERNEL
))
396 return ERR_PTR(-ENOMEM
);
398 hpriv
= devres_alloc(ahci_platform_put_resources
, sizeof(*hpriv
),
403 devres_add(dev
, hpriv
);
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
);
412 for (i
= 0; i
< AHCI_MAX_CLKS
; i
++) {
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).
420 clk
= clk_get(dev
, NULL
);
422 clk
= of_clk_get(dev
->of_node
, i
);
426 if (rc
== -EPROBE_DEFER
)
430 hpriv
->clks
[i
] = clk
;
433 hpriv
->ahci_regulator
= devm_regulator_get(dev
, "ahci");
434 if (IS_ERR(hpriv
->ahci_regulator
)) {
435 rc
= PTR_ERR(hpriv
->ahci_regulator
);
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
)
446 hpriv
->phy_regulator
= NULL
;
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
);
457 hpriv
->nports
= child_nodes
= of_get_child_count(dev
->of_node
);
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.
467 hpriv
->phys
= devm_kcalloc(dev
, hpriv
->nports
, sizeof(*hpriv
->phys
), GFP_KERNEL
);
473 * We cannot use devm_ here, since ahci_platform_put_resources() uses
474 * target_pwrs after devm_ have freed memory
476 hpriv
->target_pwrs
= kcalloc(hpriv
->nports
, sizeof(*hpriv
->target_pwrs
), GFP_KERNEL
);
477 if (!hpriv
->target_pwrs
) {
483 for_each_child_of_node(dev
->of_node
, child
) {
485 struct platform_device
*port_dev __maybe_unused
;
487 if (!of_device_is_available(child
))
490 if (of_property_read_u32(child
, "reg", &port
)) {
496 if (port
>= hpriv
->nports
) {
497 dev_warn(dev
, "invalid port number %d\n", port
);
500 mask_port_map
|= BIT(port
);
502 #ifdef CONFIG_OF_ADDRESS
503 of_platform_device_create(child
, NULL
, NULL
);
505 port_dev
= of_find_device_by_node(child
);
508 rc
= ahci_platform_get_regulator(hpriv
, port
,
510 if (rc
== -EPROBE_DEFER
) {
517 rc
= ahci_platform_get_phy(hpriv
, port
, dev
, child
);
525 if (!enabled_ports
) {
526 dev_warn(dev
, "No port enabled\n");
531 if (!hpriv
->mask_port_map
)
532 hpriv
->mask_port_map
= mask_port_map
;
535 * If no sub-node was found, keep this for device tree
538 rc
= ahci_platform_get_phy(hpriv
, 0, dev
, dev
->of_node
);
542 rc
= ahci_platform_get_regulator(hpriv
, 0, dev
);
543 if (rc
== -EPROBE_DEFER
)
546 pm_runtime_enable(dev
);
547 pm_runtime_get_sync(dev
);
548 hpriv
->got_runtime_pm
= true;
550 devres_remove_group(dev
, NULL
);
554 devres_release_group(dev
, NULL
);
557 EXPORT_SYMBOL_GPL(ahci_platform_get_resources
);
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
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.
571 * 0 on success otherwise a negative error code
573 int 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
)
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
;
584 irq
= platform_get_irq(pdev
, 0);
586 if (irq
!= -EPROBE_DEFER
)
587 dev_err(dev
, "no irq\n");
594 pi
.private_data
= (void *)(unsigned long)hpriv
->flags
;
596 ahci_save_initial_config(dev
, hpriv
);
598 if (hpriv
->cap
& HOST_CAP_NCQ
)
599 pi
.flags
|= ATA_FLAG_NCQ
;
601 if (hpriv
->cap
& HOST_CAP_PMP
)
602 pi
.flags
|= ATA_FLAG_PMP
;
604 ahci_set_em_messages(hpriv
, &pi
);
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.
611 n_ports
= max(ahci_nr_ports(hpriv
->cap
), fls(hpriv
->port_map
));
613 host
= ata_host_alloc_pinfo(dev
, ppi
, n_ports
);
617 host
->private_data
= hpriv
;
619 if (!(hpriv
->cap
& HOST_CAP_SSS
) || ahci_ignore_sss
)
620 host
->flags
|= ATA_HOST_PARALLEL_SCAN
;
622 dev_info(dev
, "SSS flag set, parallel bus scan disabled\n");
624 if (pi
.flags
& ATA_FLAG_EM
)
627 for (i
= 0; i
< host
->n_ports
; i
++) {
628 struct ata_port
*ap
= host
->ports
[i
];
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);
634 /* set enclosure management message type */
635 if (ap
->flags
& ATA_FLAG_EM
)
636 ap
->em_message_type
= hpriv
->em_msg_type
;
638 /* disabled/not-implemented port */
639 if (!(hpriv
->port_map
& (1 << i
)))
640 ap
->ops
= &ata_dummy_port_ops
;
643 if (hpriv
->cap
& HOST_CAP_64
) {
644 rc
= dma_coerce_mask_and_coherent(dev
, DMA_BIT_MASK(64));
646 rc
= dma_coerce_mask_and_coherent(dev
,
649 dev_err(dev
, "Failed to enable 64-bit DMA.\n");
652 dev_warn(dev
, "Enable 32-bit DMA instead of 64-bit.\n");
656 rc
= ahci_reset_controller(host
);
660 ahci_init_controller(host
);
661 ahci_print_info(host
, "platform");
663 return ahci_host_activate(host
, sht
);
665 EXPORT_SYMBOL_GPL(ahci_platform_init_host
);
667 static void ahci_host_stop(struct ata_host
*host
)
669 struct ahci_host_priv
*hpriv
= host
->private_data
;
671 ahci_platform_disable_resources(hpriv
);
675 * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
676 * @pdev: platform device pointer for the host
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.
682 void ahci_platform_shutdown(struct platform_device
*pdev
)
684 struct ata_host
*host
= platform_get_drvdata(pdev
);
685 struct ahci_host_priv
*hpriv
= host
->private_data
;
686 void __iomem
*mmio
= hpriv
->mmio
;
689 for (i
= 0; i
< host
->n_ports
; i
++) {
690 struct ata_port
*ap
= host
->ports
[i
];
692 /* Disable port interrupts */
696 /* Stop the port DMA engines */
697 if (ap
->ops
->port_stop
)
698 ap
->ops
->port_stop(ap
);
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
);
706 EXPORT_SYMBOL_GPL(ahci_platform_shutdown
);
708 #ifdef CONFIG_PM_SLEEP
710 * ahci_platform_suspend_host - Suspend an ahci-platform host
711 * @dev: device pointer for the host
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.
718 * 0 on success otherwise a negative error code
720 int ahci_platform_suspend_host(struct device
*dev
)
722 struct ata_host
*host
= dev_get_drvdata(dev
);
723 struct ahci_host_priv
*hpriv
= host
->private_data
;
724 void __iomem
*mmio
= hpriv
->mmio
;
727 if (hpriv
->flags
& AHCI_HFLAG_NO_SUSPEND
) {
728 dev_err(dev
, "firmware update required for suspend/resume\n");
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.
737 ctl
= readl(mmio
+ HOST_CTL
);
739 writel(ctl
, mmio
+ HOST_CTL
);
740 readl(mmio
+ HOST_CTL
); /* flush */
742 if (hpriv
->flags
& AHCI_HFLAG_SUSPEND_PHYS
)
743 ahci_platform_disable_phys(hpriv
);
745 return ata_host_suspend(host
, PMSG_SUSPEND
);
747 EXPORT_SYMBOL_GPL(ahci_platform_suspend_host
);
750 * ahci_platform_resume_host - Resume an ahci-platform host
751 * @dev: device pointer for the host
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.
758 * 0 on success otherwise a negative error code
760 int ahci_platform_resume_host(struct device
*dev
)
762 struct ata_host
*host
= dev_get_drvdata(dev
);
763 struct ahci_host_priv
*hpriv
= host
->private_data
;
766 if (dev
->power
.power_state
.event
== PM_EVENT_SUSPEND
) {
767 rc
= ahci_reset_controller(host
);
771 ahci_init_controller(host
);
774 if (hpriv
->flags
& AHCI_HFLAG_SUSPEND_PHYS
)
775 ahci_platform_enable_phys(hpriv
);
777 ata_host_resume(host
);
781 EXPORT_SYMBOL_GPL(ahci_platform_resume_host
);
784 * ahci_platform_suspend - Suspend an ahci-platform device
785 * @dev: the platform device to suspend
787 * This function suspends the host associated with the device, followed by
788 * disabling all the resources of the device.
791 * 0 on success otherwise a negative error code
793 int ahci_platform_suspend(struct device
*dev
)
795 struct ata_host
*host
= dev_get_drvdata(dev
);
796 struct ahci_host_priv
*hpriv
= host
->private_data
;
799 rc
= ahci_platform_suspend_host(dev
);
803 ahci_platform_disable_resources(hpriv
);
807 EXPORT_SYMBOL_GPL(ahci_platform_suspend
);
810 * ahci_platform_resume - Resume an ahci-platform device
811 * @dev: the platform device to resume
813 * This function enables all the resources of the device followed by
814 * resuming the host associated with the device.
817 * 0 on success otherwise a negative error code
819 int ahci_platform_resume(struct device
*dev
)
821 struct ata_host
*host
= dev_get_drvdata(dev
);
822 struct ahci_host_priv
*hpriv
= host
->private_data
;
825 rc
= ahci_platform_enable_resources(hpriv
);
829 rc
= ahci_platform_resume_host(dev
);
831 goto disable_resources
;
833 /* We resumed so update PM runtime state */
834 pm_runtime_disable(dev
);
835 pm_runtime_set_active(dev
);
836 pm_runtime_enable(dev
);
841 ahci_platform_disable_resources(hpriv
);
845 EXPORT_SYMBOL_GPL(ahci_platform_resume
);
848 MODULE_DESCRIPTION("AHCI SATA platform library");
849 MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
850 MODULE_LICENSE("GPL");