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