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 static 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
]);
79 * ahci_platform_disable_phys - Disable PHYs
80 * @hpriv: host private area to store config values
82 * This function disables all PHYs found in hpriv->phys.
84 static void ahci_platform_disable_phys(struct ahci_host_priv
*hpriv
)
88 for (i
= 0; i
< hpriv
->nports
; i
++) {
89 phy_power_off(hpriv
->phys
[i
]);
90 phy_exit(hpriv
->phys
[i
]);
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 controller and
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 if (hpriv
->ahci_regulator
) {
157 rc
= regulator_enable(hpriv
->ahci_regulator
);
162 if (hpriv
->phy_regulator
) {
163 rc
= regulator_enable(hpriv
->phy_regulator
);
165 goto disable_ahci_pwrs
;
168 for (i
= 0; i
< hpriv
->nports
; i
++) {
169 if (!hpriv
->target_pwrs
[i
])
172 rc
= regulator_enable(hpriv
->target_pwrs
[i
]);
174 goto disable_target_pwrs
;
181 if (hpriv
->target_pwrs
[i
])
182 regulator_disable(hpriv
->target_pwrs
[i
]);
184 if (hpriv
->phy_regulator
)
185 regulator_disable(hpriv
->phy_regulator
);
187 if (hpriv
->ahci_regulator
)
188 regulator_disable(hpriv
->ahci_regulator
);
191 EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators
);
194 * ahci_platform_disable_regulators - Disable regulators
195 * @hpriv: host private area to store config values
197 * This function disables all regulators found in hpriv->target_pwrs and
200 void ahci_platform_disable_regulators(struct ahci_host_priv
*hpriv
)
204 for (i
= 0; i
< hpriv
->nports
; i
++) {
205 if (!hpriv
->target_pwrs
[i
])
207 regulator_disable(hpriv
->target_pwrs
[i
]);
210 if (hpriv
->ahci_regulator
)
211 regulator_disable(hpriv
->ahci_regulator
);
212 if (hpriv
->phy_regulator
)
213 regulator_disable(hpriv
->phy_regulator
);
215 EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators
);
217 * ahci_platform_enable_resources - Enable platform resources
218 * @hpriv: host private area to store config values
220 * This function enables all ahci_platform managed resources in the
223 * 2) Clocks (through ahci_platform_enable_clks)
227 * If resource enabling fails at any point the previous enabled resources
228 * are disabled in reverse order.
231 * 0 on success otherwise a negative error code
233 int ahci_platform_enable_resources(struct ahci_host_priv
*hpriv
)
237 rc
= ahci_platform_enable_regulators(hpriv
);
241 rc
= ahci_platform_enable_clks(hpriv
);
243 goto disable_regulator
;
245 rc
= reset_control_deassert(hpriv
->rsts
);
249 rc
= ahci_platform_enable_phys(hpriv
);
256 reset_control_assert(hpriv
->rsts
);
259 ahci_platform_disable_clks(hpriv
);
262 ahci_platform_disable_regulators(hpriv
);
266 EXPORT_SYMBOL_GPL(ahci_platform_enable_resources
);
269 * ahci_platform_disable_resources - Disable platform resources
270 * @hpriv: host private area to store config values
272 * This function disables all ahci_platform managed resources in the
276 * 3) Clocks (through ahci_platform_disable_clks)
279 void ahci_platform_disable_resources(struct ahci_host_priv
*hpriv
)
281 ahci_platform_disable_phys(hpriv
);
283 reset_control_assert(hpriv
->rsts
);
285 ahci_platform_disable_clks(hpriv
);
287 ahci_platform_disable_regulators(hpriv
);
289 EXPORT_SYMBOL_GPL(ahci_platform_disable_resources
);
291 static void ahci_platform_put_resources(struct device
*dev
, void *res
)
293 struct ahci_host_priv
*hpriv
= res
;
296 if (hpriv
->got_runtime_pm
) {
297 pm_runtime_put_sync(dev
);
298 pm_runtime_disable(dev
);
301 for (c
= 0; c
< AHCI_MAX_CLKS
&& hpriv
->clks
[c
]; c
++)
302 clk_put(hpriv
->clks
[c
]);
304 * The regulators are tied to child node device and not to the
305 * SATA device itself. So we can't use devm for automatically
306 * releasing them. We have to do it manually here.
308 for (c
= 0; c
< hpriv
->nports
; c
++)
309 if (hpriv
->target_pwrs
&& hpriv
->target_pwrs
[c
])
310 regulator_put(hpriv
->target_pwrs
[c
]);
312 kfree(hpriv
->target_pwrs
);
315 static int ahci_platform_get_phy(struct ahci_host_priv
*hpriv
, u32 port
,
316 struct device
*dev
, struct device_node
*node
)
320 hpriv
->phys
[port
] = devm_of_phy_get(dev
, node
, NULL
);
322 if (!IS_ERR(hpriv
->phys
[port
]))
325 rc
= PTR_ERR(hpriv
->phys
[port
]);
328 /* No PHY support. Check if PHY is required. */
329 if (of_find_property(node
, "phys", NULL
)) {
331 "couldn't get PHY in node %pOFn: ENOSYS\n",
337 /* continue normally */
338 hpriv
->phys
[port
] = NULL
;
344 "couldn't get PHY in node %pOFn: %d\n",
353 static int ahci_platform_get_regulator(struct ahci_host_priv
*hpriv
, u32 port
,
356 struct regulator
*target_pwr
;
359 target_pwr
= regulator_get_optional(dev
, "target");
361 if (!IS_ERR(target_pwr
))
362 hpriv
->target_pwrs
[port
] = target_pwr
;
364 rc
= PTR_ERR(target_pwr
);
370 * ahci_platform_get_resources - Get platform resources
371 * @pdev: platform device to get resources for
372 * @flags: bitmap representing the resource to get
374 * This function allocates an ahci_host_priv struct, and gets the following
375 * resources, storing a reference to them inside the returned struct:
377 * 1) mmio registers (IORESOURCE_MEM 0, mandatory)
378 * 2) regulator for controlling the targets power (optional)
379 * regulator for controlling the AHCI controller (optional)
380 * 3) 0 - AHCI_MAX_CLKS clocks, as specified in the devs devicetree node,
381 * or for non devicetree enabled platforms a single clock
382 * 4) resets, if flags has AHCI_PLATFORM_GET_RESETS (optional)
386 * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
388 struct ahci_host_priv
*ahci_platform_get_resources(struct platform_device
*pdev
,
391 struct device
*dev
= &pdev
->dev
;
392 struct ahci_host_priv
*hpriv
;
394 struct device_node
*child
;
395 int i
, enabled_ports
= 0, rc
= -ENOMEM
, child_nodes
;
396 u32 mask_port_map
= 0;
398 if (!devres_open_group(dev
, NULL
, GFP_KERNEL
))
399 return ERR_PTR(-ENOMEM
);
401 hpriv
= devres_alloc(ahci_platform_put_resources
, sizeof(*hpriv
),
406 devres_add(dev
, hpriv
);
408 hpriv
->mmio
= devm_ioremap_resource(dev
,
409 platform_get_resource(pdev
, IORESOURCE_MEM
, 0));
410 if (IS_ERR(hpriv
->mmio
)) {
411 dev_err(dev
, "no mmio space\n");
412 rc
= PTR_ERR(hpriv
->mmio
);
416 for (i
= 0; i
< AHCI_MAX_CLKS
; i
++) {
418 * For now we must use clk_get(dev, NULL) for the first clock,
419 * because some platforms (da850, spear13xx) are not yet
420 * converted to use devicetree for clocks. For new platforms
421 * this is equivalent to of_clk_get(dev->of_node, 0).
424 clk
= clk_get(dev
, NULL
);
426 clk
= of_clk_get(dev
->of_node
, i
);
430 if (rc
== -EPROBE_DEFER
)
434 hpriv
->clks
[i
] = clk
;
437 hpriv
->ahci_regulator
= devm_regulator_get_optional(dev
, "ahci");
438 if (IS_ERR(hpriv
->ahci_regulator
)) {
439 rc
= PTR_ERR(hpriv
->ahci_regulator
);
440 if (rc
== -EPROBE_DEFER
)
443 hpriv
->ahci_regulator
= NULL
;
446 hpriv
->phy_regulator
= devm_regulator_get_optional(dev
, "phy");
447 if (IS_ERR(hpriv
->phy_regulator
)) {
448 rc
= PTR_ERR(hpriv
->phy_regulator
);
449 if (rc
== -EPROBE_DEFER
)
452 hpriv
->phy_regulator
= NULL
;
455 if (flags
& AHCI_PLATFORM_GET_RESETS
) {
456 hpriv
->rsts
= devm_reset_control_array_get_optional_shared(dev
);
457 if (IS_ERR(hpriv
->rsts
)) {
458 rc
= PTR_ERR(hpriv
->rsts
);
463 hpriv
->nports
= child_nodes
= of_get_child_count(dev
->of_node
);
466 * If no sub-node was found, we still need to set nports to
467 * one in order to be able to use the
468 * ahci_platform_[en|dis]able_[phys|regulators] functions.
473 hpriv
->phys
= devm_kcalloc(dev
, hpriv
->nports
, sizeof(*hpriv
->phys
), GFP_KERNEL
);
479 * We cannot use devm_ here, since ahci_platform_put_resources() uses
480 * target_pwrs after devm_ have freed memory
482 hpriv
->target_pwrs
= kcalloc(hpriv
->nports
, sizeof(*hpriv
->target_pwrs
), GFP_KERNEL
);
483 if (!hpriv
->target_pwrs
) {
489 for_each_child_of_node(dev
->of_node
, child
) {
491 struct platform_device
*port_dev __maybe_unused
;
493 if (!of_device_is_available(child
))
496 if (of_property_read_u32(child
, "reg", &port
)) {
501 if (port
>= hpriv
->nports
) {
502 dev_warn(dev
, "invalid port number %d\n", port
);
505 mask_port_map
|= BIT(port
);
507 #ifdef CONFIG_OF_ADDRESS
508 of_platform_device_create(child
, NULL
, NULL
);
510 port_dev
= of_find_device_by_node(child
);
513 rc
= ahci_platform_get_regulator(hpriv
, port
,
515 if (rc
== -EPROBE_DEFER
)
520 rc
= ahci_platform_get_phy(hpriv
, port
, dev
, child
);
526 if (!enabled_ports
) {
527 dev_warn(dev
, "No port enabled\n");
532 if (!hpriv
->mask_port_map
)
533 hpriv
->mask_port_map
= mask_port_map
;
536 * If no sub-node was found, keep this for device tree
539 rc
= ahci_platform_get_phy(hpriv
, 0, dev
, dev
->of_node
);
543 rc
= ahci_platform_get_regulator(hpriv
, 0, dev
);
544 if (rc
== -EPROBE_DEFER
)
547 pm_runtime_enable(dev
);
548 pm_runtime_get_sync(dev
);
549 hpriv
->got_runtime_pm
= true;
551 devres_remove_group(dev
, NULL
);
555 devres_release_group(dev
, NULL
);
558 EXPORT_SYMBOL_GPL(ahci_platform_get_resources
);
561 * ahci_platform_init_host - Bring up an ahci-platform host
562 * @pdev: platform device pointer for the host
563 * @hpriv: ahci-host private data for the host
564 * @pi_template: template for the ata_port_info to use
565 * @sht: scsi_host_template to use when registering
567 * This function does all the usual steps needed to bring up an
568 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
569 * must be initialized / enabled before calling this.
572 * 0 on success otherwise a negative error code
574 int ahci_platform_init_host(struct platform_device
*pdev
,
575 struct ahci_host_priv
*hpriv
,
576 const struct ata_port_info
*pi_template
,
577 struct scsi_host_template
*sht
)
579 struct device
*dev
= &pdev
->dev
;
580 struct ata_port_info pi
= *pi_template
;
581 const struct ata_port_info
*ppi
[] = { &pi
, NULL
};
582 struct ata_host
*host
;
583 int i
, irq
, n_ports
, rc
;
585 irq
= platform_get_irq(pdev
, 0);
587 if (irq
!= -EPROBE_DEFER
)
588 dev_err(dev
, "no irq\n");
595 pi
.private_data
= (void *)(unsigned long)hpriv
->flags
;
597 ahci_save_initial_config(dev
, hpriv
);
599 if (hpriv
->cap
& HOST_CAP_NCQ
)
600 pi
.flags
|= ATA_FLAG_NCQ
;
602 if (hpriv
->cap
& HOST_CAP_PMP
)
603 pi
.flags
|= ATA_FLAG_PMP
;
605 ahci_set_em_messages(hpriv
, &pi
);
607 /* CAP.NP sometimes indicate the index of the last enabled
608 * port, at other times, that of the last possible port, so
609 * determining the maximum port number requires looking at
610 * both CAP.NP and port_map.
612 n_ports
= max(ahci_nr_ports(hpriv
->cap
), fls(hpriv
->port_map
));
614 host
= ata_host_alloc_pinfo(dev
, ppi
, n_ports
);
618 host
->private_data
= hpriv
;
620 if (!(hpriv
->cap
& HOST_CAP_SSS
) || ahci_ignore_sss
)
621 host
->flags
|= ATA_HOST_PARALLEL_SCAN
;
623 dev_info(dev
, "SSS flag set, parallel bus scan disabled\n");
625 if (pi
.flags
& ATA_FLAG_EM
)
628 for (i
= 0; i
< host
->n_ports
; i
++) {
629 struct ata_port
*ap
= host
->ports
[i
];
631 ata_port_desc(ap
, "mmio %pR",
632 platform_get_resource(pdev
, IORESOURCE_MEM
, 0));
633 ata_port_desc(ap
, "port 0x%x", 0x100 + ap
->port_no
* 0x80);
635 /* set enclosure management message type */
636 if (ap
->flags
& ATA_FLAG_EM
)
637 ap
->em_message_type
= hpriv
->em_msg_type
;
639 /* disabled/not-implemented port */
640 if (!(hpriv
->port_map
& (1 << i
)))
641 ap
->ops
= &ata_dummy_port_ops
;
644 if (hpriv
->cap
& HOST_CAP_64
) {
645 rc
= dma_coerce_mask_and_coherent(dev
, DMA_BIT_MASK(64));
647 rc
= dma_coerce_mask_and_coherent(dev
,
650 dev_err(dev
, "Failed to enable 64-bit DMA.\n");
653 dev_warn(dev
, "Enable 32-bit DMA instead of 64-bit.\n");
657 rc
= ahci_reset_controller(host
);
661 ahci_init_controller(host
);
662 ahci_print_info(host
, "platform");
664 return ahci_host_activate(host
, sht
);
666 EXPORT_SYMBOL_GPL(ahci_platform_init_host
);
668 static void ahci_host_stop(struct ata_host
*host
)
670 struct ahci_host_priv
*hpriv
= host
->private_data
;
672 ahci_platform_disable_resources(hpriv
);
676 * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
677 * @pdev: platform device pointer for the host
679 * This function is called during system shutdown and performs the minimal
680 * deconfiguration required to ensure that an ahci_platform host cannot
681 * corrupt or otherwise interfere with a new kernel being started with kexec.
683 void ahci_platform_shutdown(struct platform_device
*pdev
)
685 struct ata_host
*host
= platform_get_drvdata(pdev
);
686 struct ahci_host_priv
*hpriv
= host
->private_data
;
687 void __iomem
*mmio
= hpriv
->mmio
;
690 for (i
= 0; i
< host
->n_ports
; i
++) {
691 struct ata_port
*ap
= host
->ports
[i
];
693 /* Disable port interrupts */
697 /* Stop the port DMA engines */
698 if (ap
->ops
->port_stop
)
699 ap
->ops
->port_stop(ap
);
702 /* Disable and clear host interrupts */
703 writel(readl(mmio
+ HOST_CTL
) & ~HOST_IRQ_EN
, mmio
+ HOST_CTL
);
704 readl(mmio
+ HOST_CTL
); /* flush */
705 writel(GENMASK(host
->n_ports
, 0), mmio
+ HOST_IRQ_STAT
);
707 EXPORT_SYMBOL_GPL(ahci_platform_shutdown
);
709 #ifdef CONFIG_PM_SLEEP
711 * ahci_platform_suspend_host - Suspend an ahci-platform host
712 * @dev: device pointer for the host
714 * This function does all the usual steps needed to suspend an
715 * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
716 * must be disabled after calling this.
719 * 0 on success otherwise a negative error code
721 int ahci_platform_suspend_host(struct device
*dev
)
723 struct ata_host
*host
= dev_get_drvdata(dev
);
724 struct ahci_host_priv
*hpriv
= host
->private_data
;
725 void __iomem
*mmio
= hpriv
->mmio
;
728 if (hpriv
->flags
& AHCI_HFLAG_NO_SUSPEND
) {
729 dev_err(dev
, "firmware update required for suspend/resume\n");
734 * AHCI spec rev1.1 section 8.3.3:
735 * Software must disable interrupts prior to requesting a
736 * transition of the HBA to D3 state.
738 ctl
= readl(mmio
+ HOST_CTL
);
740 writel(ctl
, mmio
+ HOST_CTL
);
741 readl(mmio
+ HOST_CTL
); /* flush */
743 if (hpriv
->flags
& AHCI_HFLAG_SUSPEND_PHYS
)
744 ahci_platform_disable_phys(hpriv
);
746 return ata_host_suspend(host
, PMSG_SUSPEND
);
748 EXPORT_SYMBOL_GPL(ahci_platform_suspend_host
);
751 * ahci_platform_resume_host - Resume an ahci-platform host
752 * @dev: device pointer for the host
754 * This function does all the usual steps needed to resume an ahci-platform
755 * host, note any necessary resources (ie clks, phys, etc.) must be
756 * initialized / enabled before calling this.
759 * 0 on success otherwise a negative error code
761 int ahci_platform_resume_host(struct device
*dev
)
763 struct ata_host
*host
= dev_get_drvdata(dev
);
764 struct ahci_host_priv
*hpriv
= host
->private_data
;
767 if (dev
->power
.power_state
.event
== PM_EVENT_SUSPEND
) {
768 rc
= ahci_reset_controller(host
);
772 ahci_init_controller(host
);
775 if (hpriv
->flags
& AHCI_HFLAG_SUSPEND_PHYS
)
776 ahci_platform_enable_phys(hpriv
);
778 ata_host_resume(host
);
782 EXPORT_SYMBOL_GPL(ahci_platform_resume_host
);
785 * ahci_platform_suspend - Suspend an ahci-platform device
786 * @dev: the platform device to suspend
788 * This function suspends the host associated with the device, followed by
789 * disabling all the resources of the device.
792 * 0 on success otherwise a negative error code
794 int ahci_platform_suspend(struct device
*dev
)
796 struct ata_host
*host
= dev_get_drvdata(dev
);
797 struct ahci_host_priv
*hpriv
= host
->private_data
;
800 rc
= ahci_platform_suspend_host(dev
);
804 ahci_platform_disable_resources(hpriv
);
808 EXPORT_SYMBOL_GPL(ahci_platform_suspend
);
811 * ahci_platform_resume - Resume an ahci-platform device
812 * @dev: the platform device to resume
814 * This function enables all the resources of the device followed by
815 * resuming the host associated with the device.
818 * 0 on success otherwise a negative error code
820 int ahci_platform_resume(struct device
*dev
)
822 struct ata_host
*host
= dev_get_drvdata(dev
);
823 struct ahci_host_priv
*hpriv
= host
->private_data
;
826 rc
= ahci_platform_enable_resources(hpriv
);
830 rc
= ahci_platform_resume_host(dev
);
832 goto disable_resources
;
834 /* We resumed so update PM runtime state */
835 pm_runtime_disable(dev
);
836 pm_runtime_set_active(dev
);
837 pm_runtime_enable(dev
);
842 ahci_platform_disable_resources(hpriv
);
846 EXPORT_SYMBOL_GPL(ahci_platform_resume
);
849 MODULE_DESCRIPTION("AHCI SATA platform library");
850 MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
851 MODULE_LICENSE("GPL");