1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * AHCI SATA platform library
4  *
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>
9  */
10 
11 #include <linux/clk.h>
12 #include <linux/kernel.h>
13 #include <linux/gfp.h>
14 #include <linux/module.h>
15 #include <linux/pm.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>
25 #include "ahci.h"
26 
27 static void ahci_host_stop(struct ata_host *host);
28 
29 struct ata_port_operations ahci_platform_ops = {
30 	.inherits	= &ahci_ops,
31 	.host_stop	= ahci_host_stop,
32 };
33 EXPORT_SYMBOL_GPL(ahci_platform_ops);
34 
35 /**
36  * ahci_platform_enable_phys - Enable PHYs
37  * @hpriv: host private area to store config values
38  *
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.
42  *
43  * RETURNS:
44  * 0 on success otherwise a negative error code
45  */
46 static int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
47 {
48 	int rc, i;
49 
50 	for (i = 0; i < hpriv->nports; i++) {
51 		rc = phy_init(hpriv->phys[i]);
52 		if (rc)
53 			goto disable_phys;
54 
55 		rc = phy_set_mode(hpriv->phys[i], PHY_MODE_SATA);
56 		if (rc) {
57 			phy_exit(hpriv->phys[i]);
58 			goto disable_phys;
59 		}
60 
61 		rc = phy_power_on(hpriv->phys[i]);
62 		if (rc) {
63 			phy_exit(hpriv->phys[i]);
64 			goto disable_phys;
65 		}
66 	}
67 
68 	return 0;
69 
70 disable_phys:
71 	while (--i >= 0) {
72 		phy_power_off(hpriv->phys[i]);
73 		phy_exit(hpriv->phys[i]);
74 	}
75 	return rc;
76 }
77 
78 /**
79  * ahci_platform_disable_phys - Disable PHYs
80  * @hpriv: host private area to store config values
81  *
82  * This function disables all PHYs found in hpriv->phys.
83  */
84 static void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
85 {
86 	int i;
87 
88 	for (i = 0; i < hpriv->nports; i++) {
89 		phy_power_off(hpriv->phys[i]);
90 		phy_exit(hpriv->phys[i]);
91 	}
92 }
93 
94 /**
95  * ahci_platform_enable_clks - Enable platform clocks
96  * @hpriv: host private area to store config values
97  *
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.
101  *
102  * RETURNS:
103  * 0 on success otherwise a negative error code
104  */
105 int ahci_platform_enable_clks(struct ahci_host_priv *hpriv)
106 {
107 	int c, rc;
108 
109 	for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++) {
110 		rc = clk_prepare_enable(hpriv->clks[c]);
111 		if (rc)
112 			goto disable_unprepare_clk;
113 	}
114 	return 0;
115 
116 disable_unprepare_clk:
117 	while (--c >= 0)
118 		clk_disable_unprepare(hpriv->clks[c]);
119 	return rc;
120 }
121 EXPORT_SYMBOL_GPL(ahci_platform_enable_clks);
122 
123 /**
124  * ahci_platform_disable_clks - Disable platform clocks
125  * @hpriv: host private area to store config values
126  *
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).
129  */
130 void ahci_platform_disable_clks(struct ahci_host_priv *hpriv)
131 {
132 	int c;
133 
134 	for (c = AHCI_MAX_CLKS - 1; c >= 0; c--)
135 		if (hpriv->clks[c])
136 			clk_disable_unprepare(hpriv->clks[c]);
137 }
138 EXPORT_SYMBOL_GPL(ahci_platform_disable_clks);
139 
140 /**
141  * ahci_platform_enable_regulators - Enable regulators
142  * @hpriv: host private area to store config values
143  *
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
147  * returns an error.
148  *
149  * RETURNS:
150  * 0 on success otherwise a negative error code
151  */
152 int ahci_platform_enable_regulators(struct ahci_host_priv *hpriv)
153 {
154 	int rc, i;
155 
156 	if (hpriv->ahci_regulator) {
157 		rc = regulator_enable(hpriv->ahci_regulator);
158 		if (rc)
159 			return rc;
160 	}
161 
162 	if (hpriv->phy_regulator) {
163 		rc = regulator_enable(hpriv->phy_regulator);
164 		if (rc)
165 			goto disable_ahci_pwrs;
166 	}
167 
168 	for (i = 0; i < hpriv->nports; i++) {
169 		if (!hpriv->target_pwrs[i])
170 			continue;
171 
172 		rc = regulator_enable(hpriv->target_pwrs[i]);
173 		if (rc)
174 			goto disable_target_pwrs;
175 	}
176 
177 	return 0;
178 
179 disable_target_pwrs:
180 	while (--i >= 0)
181 		if (hpriv->target_pwrs[i])
182 			regulator_disable(hpriv->target_pwrs[i]);
183 
184 	if (hpriv->phy_regulator)
185 		regulator_disable(hpriv->phy_regulator);
186 disable_ahci_pwrs:
187 	if (hpriv->ahci_regulator)
188 		regulator_disable(hpriv->ahci_regulator);
189 	return rc;
190 }
191 EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators);
192 
193 /**
194  * ahci_platform_disable_regulators - Disable regulators
195  * @hpriv: host private area to store config values
196  *
197  * This function disables all regulators found in hpriv->target_pwrs and
198  * AHCI controller.
199  */
200 void ahci_platform_disable_regulators(struct ahci_host_priv *hpriv)
201 {
202 	int i;
203 
204 	for (i = 0; i < hpriv->nports; i++) {
205 		if (!hpriv->target_pwrs[i])
206 			continue;
207 		regulator_disable(hpriv->target_pwrs[i]);
208 	}
209 
210 	if (hpriv->ahci_regulator)
211 		regulator_disable(hpriv->ahci_regulator);
212 	if (hpriv->phy_regulator)
213 		regulator_disable(hpriv->phy_regulator);
214 }
215 EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators);
216 /**
217  * ahci_platform_enable_resources - Enable platform resources
218  * @hpriv: host private area to store config values
219  *
220  * This function enables all ahci_platform managed resources in the
221  * following order:
222  * 1) Regulator
223  * 2) Clocks (through ahci_platform_enable_clks)
224  * 3) Resets
225  * 4) Phys
226  *
227  * If resource enabling fails at any point the previous enabled resources
228  * are disabled in reverse order.
229  *
230  * RETURNS:
231  * 0 on success otherwise a negative error code
232  */
233 int ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
234 {
235 	int rc;
236 
237 	rc = ahci_platform_enable_regulators(hpriv);
238 	if (rc)
239 		return rc;
240 
241 	rc = ahci_platform_enable_clks(hpriv);
242 	if (rc)
243 		goto disable_regulator;
244 
245 	rc = reset_control_deassert(hpriv->rsts);
246 	if (rc)
247 		goto disable_clks;
248 
249 	rc = ahci_platform_enable_phys(hpriv);
250 	if (rc)
251 		goto disable_resets;
252 
253 	return 0;
254 
255 disable_resets:
256 	reset_control_assert(hpriv->rsts);
257 
258 disable_clks:
259 	ahci_platform_disable_clks(hpriv);
260 
261 disable_regulator:
262 	ahci_platform_disable_regulators(hpriv);
263 
264 	return rc;
265 }
266 EXPORT_SYMBOL_GPL(ahci_platform_enable_resources);
267 
268 /**
269  * ahci_platform_disable_resources - Disable platform resources
270  * @hpriv: host private area to store config values
271  *
272  * This function disables all ahci_platform managed resources in the
273  * following order:
274  * 1) Phys
275  * 2) Resets
276  * 3) Clocks (through ahci_platform_disable_clks)
277  * 4) Regulator
278  */
279 void ahci_platform_disable_resources(struct ahci_host_priv *hpriv)
280 {
281 	ahci_platform_disable_phys(hpriv);
282 
283 	reset_control_assert(hpriv->rsts);
284 
285 	ahci_platform_disable_clks(hpriv);
286 
287 	ahci_platform_disable_regulators(hpriv);
288 }
289 EXPORT_SYMBOL_GPL(ahci_platform_disable_resources);
290 
291 static void ahci_platform_put_resources(struct device *dev, void *res)
292 {
293 	struct ahci_host_priv *hpriv = res;
294 	int c;
295 
296 	if (hpriv->got_runtime_pm) {
297 		pm_runtime_put_sync(dev);
298 		pm_runtime_disable(dev);
299 	}
300 
301 	for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++)
302 		clk_put(hpriv->clks[c]);
303 	/*
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.
307 	 */
308 	for (c = 0; c < hpriv->nports; c++)
309 		if (hpriv->target_pwrs && hpriv->target_pwrs[c])
310 			regulator_put(hpriv->target_pwrs[c]);
311 
312 	kfree(hpriv->target_pwrs);
313 }
314 
315 static int ahci_platform_get_phy(struct ahci_host_priv *hpriv, u32 port,
316 				struct device *dev, struct device_node *node)
317 {
318 	int rc;
319 
320 	hpriv->phys[port] = devm_of_phy_get(dev, node, NULL);
321 
322 	if (!IS_ERR(hpriv->phys[port]))
323 		return 0;
324 
325 	rc = PTR_ERR(hpriv->phys[port]);
326 	switch (rc) {
327 	case -ENOSYS:
328 		/* No PHY support. Check if PHY is required. */
329 		if (of_find_property(node, "phys", NULL)) {
330 			dev_err(dev,
331 				"couldn't get PHY in node %pOFn: ENOSYS\n",
332 				node);
333 			break;
334 		}
335 		/* fall through */
336 	case -ENODEV:
337 		/* continue normally */
338 		hpriv->phys[port] = NULL;
339 		rc = 0;
340 		break;
341 	case -EPROBE_DEFER:
342 		/* Do not complain yet */
343 		break;
344 
345 	default:
346 		dev_err(dev,
347 			"couldn't get PHY in node %pOFn: %d\n",
348 			node, rc);
349 
350 		break;
351 	}
352 
353 	return rc;
354 }
355 
356 static int ahci_platform_get_regulator(struct ahci_host_priv *hpriv, u32 port,
357 				struct device *dev)
358 {
359 	struct regulator *target_pwr;
360 	int rc = 0;
361 
362 	target_pwr = regulator_get_optional(dev, "target");
363 
364 	if (!IS_ERR(target_pwr))
365 		hpriv->target_pwrs[port] = target_pwr;
366 	else
367 		rc = PTR_ERR(target_pwr);
368 
369 	return rc;
370 }
371 
372 /**
373  * ahci_platform_get_resources - Get platform resources
374  * @pdev: platform device to get resources for
375  * @flags: bitmap representing the resource to get
376  *
377  * This function allocates an ahci_host_priv struct, and gets the following
378  * resources, storing a reference to them inside the returned struct:
379  *
380  * 1) mmio registers (IORESOURCE_MEM 0, mandatory)
381  * 2) regulator for controlling the targets power (optional)
382  *    regulator for controlling the AHCI controller (optional)
383  * 3) 0 - AHCI_MAX_CLKS clocks, as specified in the devs devicetree node,
384  *    or for non devicetree enabled platforms a single clock
385  * 4) resets, if flags has AHCI_PLATFORM_GET_RESETS (optional)
386  * 5) phys (optional)
387  *
388  * RETURNS:
389  * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
390  */
391 struct ahci_host_priv *ahci_platform_get_resources(struct platform_device *pdev,
392 						   unsigned int flags)
393 {
394 	struct device *dev = &pdev->dev;
395 	struct ahci_host_priv *hpriv;
396 	struct clk *clk;
397 	struct device_node *child;
398 	int i, enabled_ports = 0, rc = -ENOMEM, child_nodes;
399 	u32 mask_port_map = 0;
400 
401 	if (!devres_open_group(dev, NULL, GFP_KERNEL))
402 		return ERR_PTR(-ENOMEM);
403 
404 	hpriv = devres_alloc(ahci_platform_put_resources, sizeof(*hpriv),
405 			     GFP_KERNEL);
406 	if (!hpriv)
407 		goto err_out;
408 
409 	devres_add(dev, hpriv);
410 
411 	hpriv->mmio = devm_ioremap_resource(dev,
412 			      platform_get_resource(pdev, IORESOURCE_MEM, 0));
413 	if (IS_ERR(hpriv->mmio)) {
414 		rc = PTR_ERR(hpriv->mmio);
415 		goto err_out;
416 	}
417 
418 	for (i = 0; i < AHCI_MAX_CLKS; i++) {
419 		/*
420 		 * For now we must use clk_get(dev, NULL) for the first clock,
421 		 * because some platforms (da850, spear13xx) are not yet
422 		 * converted to use devicetree for clocks.  For new platforms
423 		 * this is equivalent to of_clk_get(dev->of_node, 0).
424 		 */
425 		if (i == 0)
426 			clk = clk_get(dev, NULL);
427 		else
428 			clk = of_clk_get(dev->of_node, i);
429 
430 		if (IS_ERR(clk)) {
431 			rc = PTR_ERR(clk);
432 			if (rc == -EPROBE_DEFER)
433 				goto err_out;
434 			break;
435 		}
436 		hpriv->clks[i] = clk;
437 	}
438 
439 	hpriv->ahci_regulator = devm_regulator_get_optional(dev, "ahci");
440 	if (IS_ERR(hpriv->ahci_regulator)) {
441 		rc = PTR_ERR(hpriv->ahci_regulator);
442 		if (rc == -EPROBE_DEFER)
443 			goto err_out;
444 		rc = 0;
445 		hpriv->ahci_regulator = NULL;
446 	}
447 
448 	hpriv->phy_regulator = devm_regulator_get_optional(dev, "phy");
449 	if (IS_ERR(hpriv->phy_regulator)) {
450 		rc = PTR_ERR(hpriv->phy_regulator);
451 		if (rc == -EPROBE_DEFER)
452 			goto err_out;
453 		rc = 0;
454 		hpriv->phy_regulator = NULL;
455 	}
456 
457 	if (flags & AHCI_PLATFORM_GET_RESETS) {
458 		hpriv->rsts = devm_reset_control_array_get_optional_shared(dev);
459 		if (IS_ERR(hpriv->rsts)) {
460 			rc = PTR_ERR(hpriv->rsts);
461 			goto err_out;
462 		}
463 	}
464 
465 	hpriv->nports = child_nodes = of_get_child_count(dev->of_node);
466 
467 	/*
468 	 * If no sub-node was found, we still need to set nports to
469 	 * one in order to be able to use the
470 	 * ahci_platform_[en|dis]able_[phys|regulators] functions.
471 	 */
472 	if (!child_nodes)
473 		hpriv->nports = 1;
474 
475 	hpriv->phys = devm_kcalloc(dev, hpriv->nports, sizeof(*hpriv->phys), GFP_KERNEL);
476 	if (!hpriv->phys) {
477 		rc = -ENOMEM;
478 		goto err_out;
479 	}
480 	/*
481 	 * We cannot use devm_ here, since ahci_platform_put_resources() uses
482 	 * target_pwrs after devm_ have freed memory
483 	 */
484 	hpriv->target_pwrs = kcalloc(hpriv->nports, sizeof(*hpriv->target_pwrs), GFP_KERNEL);
485 	if (!hpriv->target_pwrs) {
486 		rc = -ENOMEM;
487 		goto err_out;
488 	}
489 
490 	if (child_nodes) {
491 		for_each_child_of_node(dev->of_node, child) {
492 			u32 port;
493 			struct platform_device *port_dev __maybe_unused;
494 
495 			if (!of_device_is_available(child))
496 				continue;
497 
498 			if (of_property_read_u32(child, "reg", &port)) {
499 				rc = -EINVAL;
500 				goto err_out;
501 			}
502 
503 			if (port >= hpriv->nports) {
504 				dev_warn(dev, "invalid port number %d\n", port);
505 				continue;
506 			}
507 			mask_port_map |= BIT(port);
508 
509 #ifdef CONFIG_OF_ADDRESS
510 			of_platform_device_create(child, NULL, NULL);
511 
512 			port_dev = of_find_device_by_node(child);
513 
514 			if (port_dev) {
515 				rc = ahci_platform_get_regulator(hpriv, port,
516 								&port_dev->dev);
517 				if (rc == -EPROBE_DEFER)
518 					goto err_out;
519 			}
520 #endif
521 
522 			rc = ahci_platform_get_phy(hpriv, port, dev, child);
523 			if (rc)
524 				goto err_out;
525 
526 			enabled_ports++;
527 		}
528 		if (!enabled_ports) {
529 			dev_warn(dev, "No port enabled\n");
530 			rc = -ENODEV;
531 			goto err_out;
532 		}
533 
534 		if (!hpriv->mask_port_map)
535 			hpriv->mask_port_map = mask_port_map;
536 	} else {
537 		/*
538 		 * If no sub-node was found, keep this for device tree
539 		 * compatibility
540 		 */
541 		rc = ahci_platform_get_phy(hpriv, 0, dev, dev->of_node);
542 		if (rc)
543 			goto err_out;
544 
545 		rc = ahci_platform_get_regulator(hpriv, 0, dev);
546 		if (rc == -EPROBE_DEFER)
547 			goto err_out;
548 	}
549 	pm_runtime_enable(dev);
550 	pm_runtime_get_sync(dev);
551 	hpriv->got_runtime_pm = true;
552 
553 	devres_remove_group(dev, NULL);
554 	return hpriv;
555 
556 err_out:
557 	devres_release_group(dev, NULL);
558 	return ERR_PTR(rc);
559 }
560 EXPORT_SYMBOL_GPL(ahci_platform_get_resources);
561 
562 /**
563  * ahci_platform_init_host - Bring up an ahci-platform host
564  * @pdev: platform device pointer for the host
565  * @hpriv: ahci-host private data for the host
566  * @pi_template: template for the ata_port_info to use
567  * @sht: scsi_host_template to use when registering
568  *
569  * This function does all the usual steps needed to bring up an
570  * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
571  * must be initialized / enabled before calling this.
572  *
573  * RETURNS:
574  * 0 on success otherwise a negative error code
575  */
576 int ahci_platform_init_host(struct platform_device *pdev,
577 			    struct ahci_host_priv *hpriv,
578 			    const struct ata_port_info *pi_template,
579 			    struct scsi_host_template *sht)
580 {
581 	struct device *dev = &pdev->dev;
582 	struct ata_port_info pi = *pi_template;
583 	const struct ata_port_info *ppi[] = { &pi, NULL };
584 	struct ata_host *host;
585 	int i, irq, n_ports, rc;
586 
587 	irq = platform_get_irq(pdev, 0);
588 	if (irq <= 0) {
589 		if (irq != -EPROBE_DEFER)
590 			dev_err(dev, "no irq\n");
591 		return irq;
592 	}
593 
594 	hpriv->irq = irq;
595 
596 	/* prepare host */
597 	pi.private_data = (void *)(unsigned long)hpriv->flags;
598 
599 	ahci_save_initial_config(dev, hpriv);
600 
601 	if (hpriv->cap & HOST_CAP_NCQ)
602 		pi.flags |= ATA_FLAG_NCQ;
603 
604 	if (hpriv->cap & HOST_CAP_PMP)
605 		pi.flags |= ATA_FLAG_PMP;
606 
607 	ahci_set_em_messages(hpriv, &pi);
608 
609 	/* CAP.NP sometimes indicate the index of the last enabled
610 	 * port, at other times, that of the last possible port, so
611 	 * determining the maximum port number requires looking at
612 	 * both CAP.NP and port_map.
613 	 */
614 	n_ports = max(ahci_nr_ports(hpriv->cap), fls(hpriv->port_map));
615 
616 	host = ata_host_alloc_pinfo(dev, ppi, n_ports);
617 	if (!host)
618 		return -ENOMEM;
619 
620 	host->private_data = hpriv;
621 
622 	if (!(hpriv->cap & HOST_CAP_SSS) || ahci_ignore_sss)
623 		host->flags |= ATA_HOST_PARALLEL_SCAN;
624 	else
625 		dev_info(dev, "SSS flag set, parallel bus scan disabled\n");
626 
627 	if (pi.flags & ATA_FLAG_EM)
628 		ahci_reset_em(host);
629 
630 	for (i = 0; i < host->n_ports; i++) {
631 		struct ata_port *ap = host->ports[i];
632 
633 		ata_port_desc(ap, "mmio %pR",
634 			      platform_get_resource(pdev, IORESOURCE_MEM, 0));
635 		ata_port_desc(ap, "port 0x%x", 0x100 + ap->port_no * 0x80);
636 
637 		/* set enclosure management message type */
638 		if (ap->flags & ATA_FLAG_EM)
639 			ap->em_message_type = hpriv->em_msg_type;
640 
641 		/* disabled/not-implemented port */
642 		if (!(hpriv->port_map & (1 << i)))
643 			ap->ops = &ata_dummy_port_ops;
644 	}
645 
646 	if (hpriv->cap & HOST_CAP_64) {
647 		rc = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
648 		if (rc) {
649 			rc = dma_coerce_mask_and_coherent(dev,
650 							  DMA_BIT_MASK(32));
651 			if (rc) {
652 				dev_err(dev, "Failed to enable 64-bit DMA.\n");
653 				return rc;
654 			}
655 			dev_warn(dev, "Enable 32-bit DMA instead of 64-bit.\n");
656 		}
657 	}
658 
659 	rc = ahci_reset_controller(host);
660 	if (rc)
661 		return rc;
662 
663 	ahci_init_controller(host);
664 	ahci_print_info(host, "platform");
665 
666 	return ahci_host_activate(host, sht);
667 }
668 EXPORT_SYMBOL_GPL(ahci_platform_init_host);
669 
670 static void ahci_host_stop(struct ata_host *host)
671 {
672 	struct ahci_host_priv *hpriv = host->private_data;
673 
674 	ahci_platform_disable_resources(hpriv);
675 }
676 
677 /**
678  * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
679  * @pdev: platform device pointer for the host
680  *
681  * This function is called during system shutdown and performs the minimal
682  * deconfiguration required to ensure that an ahci_platform host cannot
683  * corrupt or otherwise interfere with a new kernel being started with kexec.
684  */
685 void ahci_platform_shutdown(struct platform_device *pdev)
686 {
687 	struct ata_host *host = platform_get_drvdata(pdev);
688 	struct ahci_host_priv *hpriv = host->private_data;
689 	void __iomem *mmio = hpriv->mmio;
690 	int i;
691 
692 	for (i = 0; i < host->n_ports; i++) {
693 		struct ata_port *ap = host->ports[i];
694 
695 		/* Disable port interrupts */
696 		if (ap->ops->freeze)
697 			ap->ops->freeze(ap);
698 
699 		/* Stop the port DMA engines */
700 		if (ap->ops->port_stop)
701 			ap->ops->port_stop(ap);
702 	}
703 
704 	/* Disable and clear host interrupts */
705 	writel(readl(mmio + HOST_CTL) & ~HOST_IRQ_EN, mmio + HOST_CTL);
706 	readl(mmio + HOST_CTL); /* flush */
707 	writel(GENMASK(host->n_ports, 0), mmio + HOST_IRQ_STAT);
708 }
709 EXPORT_SYMBOL_GPL(ahci_platform_shutdown);
710 
711 #ifdef CONFIG_PM_SLEEP
712 /**
713  * ahci_platform_suspend_host - Suspend an ahci-platform host
714  * @dev: device pointer for the host
715  *
716  * This function does all the usual steps needed to suspend an
717  * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
718  * must be disabled after calling this.
719  *
720  * RETURNS:
721  * 0 on success otherwise a negative error code
722  */
723 int ahci_platform_suspend_host(struct device *dev)
724 {
725 	struct ata_host *host = dev_get_drvdata(dev);
726 	struct ahci_host_priv *hpriv = host->private_data;
727 	void __iomem *mmio = hpriv->mmio;
728 	u32 ctl;
729 
730 	if (hpriv->flags & AHCI_HFLAG_NO_SUSPEND) {
731 		dev_err(dev, "firmware update required for suspend/resume\n");
732 		return -EIO;
733 	}
734 
735 	/*
736 	 * AHCI spec rev1.1 section 8.3.3:
737 	 * Software must disable interrupts prior to requesting a
738 	 * transition of the HBA to D3 state.
739 	 */
740 	ctl = readl(mmio + HOST_CTL);
741 	ctl &= ~HOST_IRQ_EN;
742 	writel(ctl, mmio + HOST_CTL);
743 	readl(mmio + HOST_CTL); /* flush */
744 
745 	if (hpriv->flags & AHCI_HFLAG_SUSPEND_PHYS)
746 		ahci_platform_disable_phys(hpriv);
747 
748 	return ata_host_suspend(host, PMSG_SUSPEND);
749 }
750 EXPORT_SYMBOL_GPL(ahci_platform_suspend_host);
751 
752 /**
753  * ahci_platform_resume_host - Resume an ahci-platform host
754  * @dev: device pointer for the host
755  *
756  * This function does all the usual steps needed to resume an ahci-platform
757  * host, note any necessary resources (ie clks, phys, etc.)  must be
758  * initialized / enabled before calling this.
759  *
760  * RETURNS:
761  * 0 on success otherwise a negative error code
762  */
763 int ahci_platform_resume_host(struct device *dev)
764 {
765 	struct ata_host *host = dev_get_drvdata(dev);
766 	struct ahci_host_priv *hpriv = host->private_data;
767 	int rc;
768 
769 	if (dev->power.power_state.event == PM_EVENT_SUSPEND) {
770 		rc = ahci_reset_controller(host);
771 		if (rc)
772 			return rc;
773 
774 		ahci_init_controller(host);
775 	}
776 
777 	if (hpriv->flags & AHCI_HFLAG_SUSPEND_PHYS)
778 		ahci_platform_enable_phys(hpriv);
779 
780 	ata_host_resume(host);
781 
782 	return 0;
783 }
784 EXPORT_SYMBOL_GPL(ahci_platform_resume_host);
785 
786 /**
787  * ahci_platform_suspend - Suspend an ahci-platform device
788  * @dev: the platform device to suspend
789  *
790  * This function suspends the host associated with the device, followed by
791  * disabling all the resources of the device.
792  *
793  * RETURNS:
794  * 0 on success otherwise a negative error code
795  */
796 int ahci_platform_suspend(struct device *dev)
797 {
798 	struct ata_host *host = dev_get_drvdata(dev);
799 	struct ahci_host_priv *hpriv = host->private_data;
800 	int rc;
801 
802 	rc = ahci_platform_suspend_host(dev);
803 	if (rc)
804 		return rc;
805 
806 	ahci_platform_disable_resources(hpriv);
807 
808 	return 0;
809 }
810 EXPORT_SYMBOL_GPL(ahci_platform_suspend);
811 
812 /**
813  * ahci_platform_resume - Resume an ahci-platform device
814  * @dev: the platform device to resume
815  *
816  * This function enables all the resources of the device followed by
817  * resuming the host associated with the device.
818  *
819  * RETURNS:
820  * 0 on success otherwise a negative error code
821  */
822 int ahci_platform_resume(struct device *dev)
823 {
824 	struct ata_host *host = dev_get_drvdata(dev);
825 	struct ahci_host_priv *hpriv = host->private_data;
826 	int rc;
827 
828 	rc = ahci_platform_enable_resources(hpriv);
829 	if (rc)
830 		return rc;
831 
832 	rc = ahci_platform_resume_host(dev);
833 	if (rc)
834 		goto disable_resources;
835 
836 	/* We resumed so update PM runtime state */
837 	pm_runtime_disable(dev);
838 	pm_runtime_set_active(dev);
839 	pm_runtime_enable(dev);
840 
841 	return 0;
842 
843 disable_resources:
844 	ahci_platform_disable_resources(hpriv);
845 
846 	return rc;
847 }
848 EXPORT_SYMBOL_GPL(ahci_platform_resume);
849 #endif
850 
851 MODULE_DESCRIPTION("AHCI SATA platform library");
852 MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
853 MODULE_LICENSE("GPL");
854