drivers/soc/xilinx/zynqmp_power.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Xilinx Zynq MPSoC Power Management
   4  *
   5  *  Copyright (C) 2014-2018 Xilinx, Inc.
   6  *
   7  *  Davorin Mista <davorin.mista@aggios.com>
   8  *  Jolly Shah <jollys@xilinx.com>
   9  *  Rajan Vaja <rajan.vaja@xilinx.com>
  10  */
  11
  12 #include <linux/mailbox_client.h>
  13 #include <linux/module.h>
  14 #include <linux/platform_device.h>
  15 #include <linux/reboot.h>
  16 #include <linux/suspend.h>
  17
  18 #include <linux/firmware/xlnx-zynqmp.h>
  19
  20 enum pm_suspend_mode {
  21         PM_SUSPEND_MODE_FIRST = 0,
  22         PM_SUSPEND_MODE_STD = PM_SUSPEND_MODE_FIRST,
  23         PM_SUSPEND_MODE_POWER_OFF,
  24 };
  25
  26 #define PM_SUSPEND_MODE_FIRST   PM_SUSPEND_MODE_STD
  27
  28 static const char *const suspend_modes[] = {
  29         [PM_SUSPEND_MODE_STD] = "standard",
  30         [PM_SUSPEND_MODE_POWER_OFF] = "power-off",
  31 };
  32
  33 static enum pm_suspend_mode suspend_mode = PM_SUSPEND_MODE_STD;
  34
  35 enum pm_api_cb_id {
  36         PM_INIT_SUSPEND_CB = 30,
  37         PM_ACKNOWLEDGE_CB,
  38         PM_NOTIFY_CB,
  39 };
  40
  41 static void zynqmp_pm_get_callback_data(u32 *buf)
  42 {
  43         zynqmp_pm_invoke_fn(GET_CALLBACK_DATA, 0, 0, 0, 0, buf);
  44 }
  45
  46 static irqreturn_t zynqmp_pm_isr(int irq, void *data)
  47 {
  48         u32 payload[CB_PAYLOAD_SIZE];
  49
  50         zynqmp_pm_get_callback_data(payload);
  51
  52         /* First element is callback API ID, others are callback arguments */
  53         if (payload[0] == PM_INIT_SUSPEND_CB) {
  54                 switch (payload[1]) {
  55                 case SUSPEND_SYSTEM_SHUTDOWN:
  56                         orderly_poweroff(true);
  57                         break;
  58                 case SUSPEND_POWER_REQUEST:
  59                         pm_suspend(PM_SUSPEND_MEM);
  60                         break;
  61                 default:
  62                         pr_err("%s Unsupported InitSuspendCb reason "
  63                                 "code %d\n", __func__, payload[1]);
  64                 }
  65         }
  66
  67         return IRQ_HANDLED;
  68 }
  69
  70 static ssize_t suspend_mode_show(struct device *dev,
  71                                  struct device_attribute *attr, char *buf)
  72 {
  73         char *s = buf;
  74         int md;
  75
  76         for (md = PM_SUSPEND_MODE_FIRST; md < ARRAY_SIZE(suspend_modes); md++)
  77                 if (suspend_modes[md]) {
  78                         if (md == suspend_mode)
  79                                 s += sprintf(s, "[%s] ", suspend_modes[md]);
  80                         else
  81                                 s += sprintf(s, "%s ", suspend_modes[md]);
  82                 }
  83
  84         /* Convert last space to newline */
  85         if (s != buf)
  86                 *(s - 1) = '\n';
  87         return (s - buf);
  88 }
  89
  90 static ssize_t suspend_mode_store(struct device *dev,
  91                                   struct device_attribute *attr,
  92                                   const char *buf, size_t count)
  93 {
  94         int md, ret = -EINVAL;
  95         const struct zynqmp_eemi_ops *eemi_ops = zynqmp_pm_get_eemi_ops();
  96
  97         if (!eemi_ops || !eemi_ops->set_suspend_mode)
  98                 return ret;
  99
 100         for (md = PM_SUSPEND_MODE_FIRST; md < ARRAY_SIZE(suspend_modes); md++)
 101                 if (suspend_modes[md] &&
 102                     sysfs_streq(suspend_modes[md], buf)) {
 103                         ret = 0;
 104                         break;
 105                 }
 106
 107         if (!ret && md != suspend_mode) {
 108                 ret = eemi_ops->set_suspend_mode(md);
 109                 if (likely(!ret))
 110                         suspend_mode = md;
 111         }
 112
 113         return ret ? ret : count;
 114 }
 115
 116 static DEVICE_ATTR_RW(suspend_mode);
 117
 118 static int zynqmp_pm_probe(struct platform_device *pdev)
 119 {
 120         int ret, irq;
 121         u32 pm_api_version;
 122
 123         const struct zynqmp_eemi_ops *eemi_ops = zynqmp_pm_get_eemi_ops();
 124
 125         if (!eemi_ops || !eemi_ops->get_api_version || !eemi_ops->init_finalize)
 126                 return -ENXIO;
 127
 128         eemi_ops->init_finalize();
 129         eemi_ops->get_api_version(&pm_api_version);
 130
 131         /* Check PM API version number */
 132         if (pm_api_version < ZYNQMP_PM_VERSION)
 133                 return -ENODEV;
 134
 135         irq = platform_get_irq(pdev, 0);
 136         if (irq <= 0)
 137                 return -ENXIO;
 138
 139         ret = devm_request_threaded_irq(&pdev->dev, irq, NULL, zynqmp_pm_isr,
 140                                         IRQF_NO_SUSPEND | IRQF_ONESHOT,
 141                                         dev_name(&pdev->dev), &pdev->dev);
 142         if (ret) {
 143                 dev_err(&pdev->dev, "devm_request_threaded_irq '%d' failed "
 144                         "with %d\n", irq, ret);
 145                 return ret;
 146         }
 147
 148         ret = sysfs_create_file(&pdev->dev.kobj, &dev_attr_suspend_mode.attr);
 149         if (ret) {
 150                 dev_err(&pdev->dev, "unable to create sysfs interface\n");
 151                 return ret;
 152         }
 153
 154         return 0;
 155 }
 156
 157 static int zynqmp_pm_remove(struct platform_device *pdev)
 158 {
 159         sysfs_remove_file(&pdev->dev.kobj, &dev_attr_suspend_mode.attr);
 160
 161         return 0;
 162 }
 163
 164 static const struct of_device_id pm_of_match[] = {
 165         { .compatible = "xlnx,zynqmp-power", },
 166         { /* end of table */ },
 167 };
 168 MODULE_DEVICE_TABLE(of, pm_of_match);
 169
 170 static struct platform_driver zynqmp_pm_platform_driver = {
 171         .probe = zynqmp_pm_probe,
 172         .remove = zynqmp_pm_remove,
 173         .driver = {
 174                 .name = "zynqmp_power",
 175                 .of_match_table = pm_of_match,
 176         },
 177 };
 178 module_platform_driver(zynqmp_pm_platform_driver);