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