drivers/remoteproc/qcom_q6v5.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Qualcomm Peripheral Image Loader for Q6V5
   4  *
   5  * Copyright (C) 2016-2018 Linaro Ltd.
   6  * Copyright (C) 2014 Sony Mobile Communications AB
   7  * Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
   8  */
   9 #include <linux/kernel.h>
  10 #include <linux/platform_device.h>
  11 #include <linux/interrupt.h>
  12 #include <linux/module.h>
  13 #include <linux/soc/qcom/smem.h>
  14 #include <linux/soc/qcom/smem_state.h>
  15 #include <linux/remoteproc.h>
  16 #include "qcom_q6v5.h"
  17
  18 /**
  19  * qcom_q6v5_prepare() - reinitialize the qcom_q6v5 context before start
  20  * @q6v5:       reference to qcom_q6v5 context to be reinitialized
  21  *
  22  * Return: 0 on success, negative errno on failure
  23  */
  24 int qcom_q6v5_prepare(struct qcom_q6v5 *q6v5)
  25 {
  26         reinit_completion(&q6v5->start_done);
  27         reinit_completion(&q6v5->stop_done);
  28
  29         q6v5->running = true;
  30         q6v5->handover_issued = false;
  31
  32         enable_irq(q6v5->handover_irq);
  33
  34         return 0;
  35 }
  36 EXPORT_SYMBOL_GPL(qcom_q6v5_prepare);
  37
  38 /**
  39  * qcom_q6v5_unprepare() - unprepare the qcom_q6v5 context after stop
  40  * @q6v5:       reference to qcom_q6v5 context to be unprepared
  41  *
  42  * Return: 0 on success, 1 if handover hasn't yet been called
  43  */
  44 int qcom_q6v5_unprepare(struct qcom_q6v5 *q6v5)
  45 {
  46         disable_irq(q6v5->handover_irq);
  47
  48         return !q6v5->handover_issued;
  49 }
  50 EXPORT_SYMBOL_GPL(qcom_q6v5_unprepare);
  51
  52 static irqreturn_t q6v5_wdog_interrupt(int irq, void *data)
  53 {
  54         struct qcom_q6v5 *q6v5 = data;
  55         size_t len;
  56         char *msg;
  57
  58         /* Sometimes the stop triggers a watchdog rather than a stop-ack */
  59         if (!q6v5->running) {
  60                 complete(&q6v5->stop_done);
  61                 return IRQ_HANDLED;
  62         }
  63
  64         msg = qcom_smem_get(QCOM_SMEM_HOST_ANY, q6v5->crash_reason, &len);
  65         if (!IS_ERR(msg) && len > 0 && msg[0])
  66                 dev_err(q6v5->dev, "watchdog received: %s\n", msg);
  67         else
  68                 dev_err(q6v5->dev, "watchdog without message\n");
  69
  70         rproc_report_crash(q6v5->rproc, RPROC_WATCHDOG);
  71
  72         return IRQ_HANDLED;
  73 }
  74
  75 static irqreturn_t q6v5_fatal_interrupt(int irq, void *data)
  76 {
  77         struct qcom_q6v5 *q6v5 = data;
  78         size_t len;
  79         char *msg;
  80
  81         msg = qcom_smem_get(QCOM_SMEM_HOST_ANY, q6v5->crash_reason, &len);
  82         if (!IS_ERR(msg) && len > 0 && msg[0])
  83                 dev_err(q6v5->dev, "fatal error received: %s\n", msg);
  84         else
  85                 dev_err(q6v5->dev, "fatal error without message\n");
  86
  87         q6v5->running = false;
  88         rproc_report_crash(q6v5->rproc, RPROC_FATAL_ERROR);
  89
  90         return IRQ_HANDLED;
  91 }
  92
  93 static irqreturn_t q6v5_ready_interrupt(int irq, void *data)
  94 {
  95         struct qcom_q6v5 *q6v5 = data;
  96
  97         complete(&q6v5->start_done);
  98
  99         return IRQ_HANDLED;
 100 }
 101
 102 /**
 103  * qcom_q6v5_wait_for_start() - wait for remote processor start signal
 104  * @q6v5:       reference to qcom_q6v5 context
 105  * @timeout:    timeout to wait for the event, in jiffies
 106  *
 107  * qcom_q6v5_unprepare() should not be called when this function fails.
 108  *
 109  * Return: 0 on success, -ETIMEDOUT on timeout
 110  */
 111 int qcom_q6v5_wait_for_start(struct qcom_q6v5 *q6v5, int timeout)
 112 {
 113         int ret;
 114
 115         ret = wait_for_completion_timeout(&q6v5->start_done, timeout);
 116         if (!ret)
 117                 disable_irq(q6v5->handover_irq);
 118
 119         return !ret ? -ETIMEDOUT : 0;
 120 }
 121 EXPORT_SYMBOL_GPL(qcom_q6v5_wait_for_start);
 122
 123 static irqreturn_t q6v5_handover_interrupt(int irq, void *data)
 124 {
 125         struct qcom_q6v5 *q6v5 = data;
 126
 127         if (q6v5->handover)
 128                 q6v5->handover(q6v5);
 129
 130         q6v5->handover_issued = true;
 131
 132         return IRQ_HANDLED;
 133 }
 134
 135 static irqreturn_t q6v5_stop_interrupt(int irq, void *data)
 136 {
 137         struct qcom_q6v5 *q6v5 = data;
 138
 139         complete(&q6v5->stop_done);
 140
 141         return IRQ_HANDLED;
 142 }
 143
 144 /**
 145  * qcom_q6v5_request_stop() - request the remote processor to stop
 146  * @q6v5:       reference to qcom_q6v5 context
 147  *
 148  * Return: 0 on success, negative errno on failure
 149  */
 150 int qcom_q6v5_request_stop(struct qcom_q6v5 *q6v5)
 151 {
 152         int ret;
 153
 154         q6v5->running = false;
 155
 156         qcom_smem_state_update_bits(q6v5->state,
 157                                     BIT(q6v5->stop_bit), BIT(q6v5->stop_bit));
 158
 159         ret = wait_for_completion_timeout(&q6v5->stop_done, 5 * HZ);
 160
 161         qcom_smem_state_update_bits(q6v5->state, BIT(q6v5->stop_bit), 0);
 162
 163         return ret == 0 ? -ETIMEDOUT : 0;
 164 }
 165 EXPORT_SYMBOL_GPL(qcom_q6v5_request_stop);
 166
 167 /**
 168  * qcom_q6v5_init() - initializer of the q6v5 common struct
 169  * @q6v5:       handle to be initialized
 170  * @pdev:       platform_device reference for acquiring resources
 171  * @rproc:      associated remoteproc instance
 172  * @crash_reason: SMEM id for crash reason string, or 0 if none
 173  * @handover:   function to be called when proxy resources should be released
 174  *
 175  * Return: 0 on success, negative errno on failure
 176  */
 177 int qcom_q6v5_init(struct qcom_q6v5 *q6v5, struct platform_device *pdev,
 178                    struct rproc *rproc, int crash_reason,
 179                    void (*handover)(struct qcom_q6v5 *q6v5))
 180 {
 181         int ret;
 182
 183         q6v5->rproc = rproc;
 184         q6v5->dev = &pdev->dev;
 185         q6v5->crash_reason = crash_reason;
 186         q6v5->handover = handover;
 187
 188         init_completion(&q6v5->start_done);
 189         init_completion(&q6v5->stop_done);
 190
 191         q6v5->wdog_irq = platform_get_irq_byname(pdev, "wdog");
 192         if (q6v5->wdog_irq < 0) {
 193                 if (q6v5->wdog_irq != -EPROBE_DEFER)
 194                         dev_err(&pdev->dev,
 195                                 "failed to retrieve wdog IRQ: %d\n",
 196                                 q6v5->wdog_irq);
 197                 return q6v5->wdog_irq;
 198         }
 199
 200         ret = devm_request_threaded_irq(&pdev->dev, q6v5->wdog_irq,
 201                                         NULL, q6v5_wdog_interrupt,
 202                                         IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 203                                         "q6v5 wdog", q6v5);
 204         if (ret) {
 205                 dev_err(&pdev->dev, "failed to acquire wdog IRQ\n");
 206                 return ret;
 207         }
 208
 209         q6v5->fatal_irq = platform_get_irq_byname(pdev, "fatal");
 210         if (q6v5->fatal_irq < 0) {
 211                 if (q6v5->fatal_irq != -EPROBE_DEFER)
 212                         dev_err(&pdev->dev,
 213                                 "failed to retrieve fatal IRQ: %d\n",
 214                                 q6v5->fatal_irq);
 215                 return q6v5->fatal_irq;
 216         }
 217
 218         ret = devm_request_threaded_irq(&pdev->dev, q6v5->fatal_irq,
 219                                         NULL, q6v5_fatal_interrupt,
 220                                         IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 221                                         "q6v5 fatal", q6v5);
 222         if (ret) {
 223                 dev_err(&pdev->dev, "failed to acquire fatal IRQ\n");
 224                 return ret;
 225         }
 226
 227         q6v5->ready_irq = platform_get_irq_byname(pdev, "ready");
 228         if (q6v5->ready_irq < 0) {
 229                 if (q6v5->ready_irq != -EPROBE_DEFER)
 230                         dev_err(&pdev->dev,
 231                                 "failed to retrieve ready IRQ: %d\n",
 232                                 q6v5->ready_irq);
 233                 return q6v5->ready_irq;
 234         }
 235
 236         ret = devm_request_threaded_irq(&pdev->dev, q6v5->ready_irq,
 237                                         NULL, q6v5_ready_interrupt,
 238                                         IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 239                                         "q6v5 ready", q6v5);
 240         if (ret) {
 241                 dev_err(&pdev->dev, "failed to acquire ready IRQ\n");
 242                 return ret;
 243         }
 244
 245         q6v5->handover_irq = platform_get_irq_byname(pdev, "handover");
 246         if (q6v5->handover_irq < 0) {
 247                 if (q6v5->handover_irq != -EPROBE_DEFER)
 248                         dev_err(&pdev->dev,
 249                                 "failed to retrieve handover IRQ: %d\n",
 250                                 q6v5->handover_irq);
 251                 return q6v5->handover_irq;
 252         }
 253
 254         ret = devm_request_threaded_irq(&pdev->dev, q6v5->handover_irq,
 255                                         NULL, q6v5_handover_interrupt,
 256                                         IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 257                                         "q6v5 handover", q6v5);
 258         if (ret) {
 259                 dev_err(&pdev->dev, "failed to acquire handover IRQ\n");
 260                 return ret;
 261         }
 262         disable_irq(q6v5->handover_irq);
 263
 264         q6v5->stop_irq = platform_get_irq_byname(pdev, "stop-ack");
 265         if (q6v5->stop_irq < 0) {
 266                 if (q6v5->stop_irq != -EPROBE_DEFER)
 267                         dev_err(&pdev->dev,
 268                                 "failed to retrieve stop-ack IRQ: %d\n",
 269                                 q6v5->stop_irq);
 270                 return q6v5->stop_irq;
 271         }
 272
 273         ret = devm_request_threaded_irq(&pdev->dev, q6v5->stop_irq,
 274                                         NULL, q6v5_stop_interrupt,
 275                                         IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 276                                         "q6v5 stop", q6v5);
 277         if (ret) {
 278                 dev_err(&pdev->dev, "failed to acquire stop-ack IRQ\n");
 279                 return ret;
 280         }
 281
 282         q6v5->state = qcom_smem_state_get(&pdev->dev, "stop", &q6v5->stop_bit);
 283         if (IS_ERR(q6v5->state)) {
 284                 dev_err(&pdev->dev, "failed to acquire stop state\n");
 285                 return PTR_ERR(q6v5->state);
 286         }
 287
 288         return 0;
 289 }
 290 EXPORT_SYMBOL_GPL(qcom_q6v5_init);
 291
 292 MODULE_LICENSE("GPL v2");
 293 MODULE_DESCRIPTION("Qualcomm Peripheral Image Loader for Q6V5");