1 // SPDX-License-Identifier: GPL-2.0
3 * Qualcomm Peripheral Image Loader for Q6V5
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.
9 #include <linux/kernel.h>
10 #include <linux/platform_device.h>
11 #include <linux/interconnect.h>
12 #include <linux/interrupt.h>
13 #include <linux/module.h>
14 #include <linux/soc/qcom/qcom_aoss.h>
15 #include <linux/soc/qcom/smem.h>
16 #include <linux/soc/qcom/smem_state.h>
17 #include <linux/remoteproc.h>
18 #include "qcom_common.h"
19 #include "qcom_q6v5.h"
21 #define Q6V5_LOAD_STATE_MSG_LEN 64
22 #define Q6V5_PANIC_DELAY_MS 200
24 static int q6v5_load_state_toggle(struct qcom_q6v5 *q6v5, bool enable)
26 char buf[Q6V5_LOAD_STATE_MSG_LEN];
32 ret = snprintf(buf, sizeof(buf),
33 "{class: image, res: load_state, name: %s, val: %s}",
34 q6v5->load_state, enable ? "on" : "off");
36 WARN_ON(ret >= Q6V5_LOAD_STATE_MSG_LEN);
38 ret = qmp_send(q6v5->qmp, buf, sizeof(buf));
40 dev_err(q6v5->dev, "failed to toggle load state\n");
46 * qcom_q6v5_prepare() - reinitialize the qcom_q6v5 context before start
47 * @q6v5: reference to qcom_q6v5 context to be reinitialized
49 * Return: 0 on success, negative errno on failure
51 int qcom_q6v5_prepare(struct qcom_q6v5 *q6v5)
55 ret = icc_set_bw(q6v5->path, 0, UINT_MAX);
57 dev_err(q6v5->dev, "failed to set bandwidth request\n");
61 ret = q6v5_load_state_toggle(q6v5, true);
63 icc_set_bw(q6v5->path, 0, 0);
67 reinit_completion(&q6v5->start_done);
68 reinit_completion(&q6v5->stop_done);
71 q6v5->handover_issued = false;
73 enable_irq(q6v5->handover_irq);
77 EXPORT_SYMBOL_GPL(qcom_q6v5_prepare);
80 * qcom_q6v5_unprepare() - unprepare the qcom_q6v5 context after stop
81 * @q6v5: reference to qcom_q6v5 context to be unprepared
83 * Return: 0 on success, 1 if handover hasn't yet been called
85 int qcom_q6v5_unprepare(struct qcom_q6v5 *q6v5)
87 disable_irq(q6v5->handover_irq);
88 q6v5_load_state_toggle(q6v5, false);
90 /* Disable interconnect vote, in case handover never happened */
91 icc_set_bw(q6v5->path, 0, 0);
93 return !q6v5->handover_issued;
95 EXPORT_SYMBOL_GPL(qcom_q6v5_unprepare);
97 static irqreturn_t q6v5_wdog_interrupt(int irq, void *data)
99 struct qcom_q6v5 *q6v5 = data;
103 /* Sometimes the stop triggers a watchdog rather than a stop-ack */
104 if (!q6v5->running) {
105 complete(&q6v5->stop_done);
109 msg = qcom_smem_get(QCOM_SMEM_HOST_ANY, q6v5->crash_reason, &len);
110 if (!IS_ERR(msg) && len > 0 && msg[0])
111 dev_err(q6v5->dev, "watchdog received: %s\n", msg);
113 dev_err(q6v5->dev, "watchdog without message\n");
115 q6v5->running = false;
116 rproc_report_crash(q6v5->rproc, RPROC_WATCHDOG);
121 static irqreturn_t q6v5_fatal_interrupt(int irq, void *data)
123 struct qcom_q6v5 *q6v5 = data;
130 msg = qcom_smem_get(QCOM_SMEM_HOST_ANY, q6v5->crash_reason, &len);
131 if (!IS_ERR(msg) && len > 0 && msg[0])
132 dev_err(q6v5->dev, "fatal error received: %s\n", msg);
134 dev_err(q6v5->dev, "fatal error without message\n");
136 q6v5->running = false;
137 rproc_report_crash(q6v5->rproc, RPROC_FATAL_ERROR);
142 static irqreturn_t q6v5_ready_interrupt(int irq, void *data)
144 struct qcom_q6v5 *q6v5 = data;
146 complete(&q6v5->start_done);
152 * qcom_q6v5_wait_for_start() - wait for remote processor start signal
153 * @q6v5: reference to qcom_q6v5 context
154 * @timeout: timeout to wait for the event, in jiffies
156 * qcom_q6v5_unprepare() should not be called when this function fails.
158 * Return: 0 on success, -ETIMEDOUT on timeout
160 int qcom_q6v5_wait_for_start(struct qcom_q6v5 *q6v5, int timeout)
164 ret = wait_for_completion_timeout(&q6v5->start_done, timeout);
166 disable_irq(q6v5->handover_irq);
168 return !ret ? -ETIMEDOUT : 0;
170 EXPORT_SYMBOL_GPL(qcom_q6v5_wait_for_start);
172 static irqreturn_t q6v5_handover_interrupt(int irq, void *data)
174 struct qcom_q6v5 *q6v5 = data;
177 q6v5->handover(q6v5);
179 icc_set_bw(q6v5->path, 0, 0);
181 q6v5->handover_issued = true;
186 static irqreturn_t q6v5_stop_interrupt(int irq, void *data)
188 struct qcom_q6v5 *q6v5 = data;
190 complete(&q6v5->stop_done);
196 * qcom_q6v5_request_stop() - request the remote processor to stop
197 * @q6v5: reference to qcom_q6v5 context
198 * @sysmon: reference to the remote's sysmon instance, or NULL
200 * Return: 0 on success, negative errno on failure
202 int qcom_q6v5_request_stop(struct qcom_q6v5 *q6v5, struct qcom_sysmon *sysmon)
206 q6v5->running = false;
208 /* Don't perform SMP2P dance if sysmon already shut down the remote */
209 if (qcom_sysmon_shutdown_acked(sysmon))
212 qcom_smem_state_update_bits(q6v5->state,
213 BIT(q6v5->stop_bit), BIT(q6v5->stop_bit));
215 ret = wait_for_completion_timeout(&q6v5->stop_done, 5 * HZ);
217 qcom_smem_state_update_bits(q6v5->state, BIT(q6v5->stop_bit), 0);
219 return ret == 0 ? -ETIMEDOUT : 0;
221 EXPORT_SYMBOL_GPL(qcom_q6v5_request_stop);
224 * qcom_q6v5_panic() - panic handler to invoke a stop on the remote
225 * @q6v5: reference to qcom_q6v5 context
227 * Set the stop bit and sleep in order to allow the remote processor to flush
228 * its caches etc for post mortem debugging.
232 unsigned long qcom_q6v5_panic(struct qcom_q6v5 *q6v5)
234 qcom_smem_state_update_bits(q6v5->state,
235 BIT(q6v5->stop_bit), BIT(q6v5->stop_bit));
237 return Q6V5_PANIC_DELAY_MS;
239 EXPORT_SYMBOL_GPL(qcom_q6v5_panic);
242 * qcom_q6v5_init() - initializer of the q6v5 common struct
243 * @q6v5: handle to be initialized
244 * @pdev: platform_device reference for acquiring resources
245 * @rproc: associated remoteproc instance
246 * @crash_reason: SMEM id for crash reason string, or 0 if none
247 * @load_state: load state resource string
248 * @handover: function to be called when proxy resources should be released
250 * Return: 0 on success, negative errno on failure
252 int qcom_q6v5_init(struct qcom_q6v5 *q6v5, struct platform_device *pdev,
253 struct rproc *rproc, int crash_reason, const char *load_state,
254 void (*handover)(struct qcom_q6v5 *q6v5))
259 q6v5->dev = &pdev->dev;
260 q6v5->crash_reason = crash_reason;
261 q6v5->handover = handover;
263 init_completion(&q6v5->start_done);
264 init_completion(&q6v5->stop_done);
266 q6v5->wdog_irq = platform_get_irq_byname(pdev, "wdog");
267 if (q6v5->wdog_irq < 0)
268 return q6v5->wdog_irq;
270 ret = devm_request_threaded_irq(&pdev->dev, q6v5->wdog_irq,
271 NULL, q6v5_wdog_interrupt,
272 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
275 dev_err(&pdev->dev, "failed to acquire wdog IRQ\n");
279 q6v5->fatal_irq = platform_get_irq_byname(pdev, "fatal");
280 if (q6v5->fatal_irq < 0)
281 return q6v5->fatal_irq;
283 ret = devm_request_threaded_irq(&pdev->dev, q6v5->fatal_irq,
284 NULL, q6v5_fatal_interrupt,
285 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
288 dev_err(&pdev->dev, "failed to acquire fatal IRQ\n");
292 q6v5->ready_irq = platform_get_irq_byname(pdev, "ready");
293 if (q6v5->ready_irq < 0)
294 return q6v5->ready_irq;
296 ret = devm_request_threaded_irq(&pdev->dev, q6v5->ready_irq,
297 NULL, q6v5_ready_interrupt,
298 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
301 dev_err(&pdev->dev, "failed to acquire ready IRQ\n");
305 q6v5->handover_irq = platform_get_irq_byname(pdev, "handover");
306 if (q6v5->handover_irq < 0)
307 return q6v5->handover_irq;
309 ret = devm_request_threaded_irq(&pdev->dev, q6v5->handover_irq,
310 NULL, q6v5_handover_interrupt,
311 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
312 "q6v5 handover", q6v5);
314 dev_err(&pdev->dev, "failed to acquire handover IRQ\n");
317 disable_irq(q6v5->handover_irq);
319 q6v5->stop_irq = platform_get_irq_byname(pdev, "stop-ack");
320 if (q6v5->stop_irq < 0)
321 return q6v5->stop_irq;
323 ret = devm_request_threaded_irq(&pdev->dev, q6v5->stop_irq,
324 NULL, q6v5_stop_interrupt,
325 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
328 dev_err(&pdev->dev, "failed to acquire stop-ack IRQ\n");
332 q6v5->state = devm_qcom_smem_state_get(&pdev->dev, "stop", &q6v5->stop_bit);
333 if (IS_ERR(q6v5->state)) {
334 dev_err(&pdev->dev, "failed to acquire stop state\n");
335 return PTR_ERR(q6v5->state);
338 q6v5->load_state = devm_kstrdup_const(&pdev->dev, load_state, GFP_KERNEL);
339 q6v5->qmp = qmp_get(&pdev->dev);
340 if (IS_ERR(q6v5->qmp)) {
341 if (PTR_ERR(q6v5->qmp) != -ENODEV)
342 return dev_err_probe(&pdev->dev, PTR_ERR(q6v5->qmp),
343 "failed to acquire load state\n");
345 } else if (!q6v5->load_state) {
347 dev_err(&pdev->dev, "load state resource string empty\n");
350 return load_state ? -ENOMEM : -EINVAL;
353 q6v5->path = devm_of_icc_get(&pdev->dev, NULL);
354 if (IS_ERR(q6v5->path))
355 return dev_err_probe(&pdev->dev, PTR_ERR(q6v5->path),
356 "failed to acquire interconnect path\n");
360 EXPORT_SYMBOL_GPL(qcom_q6v5_init);
363 * qcom_q6v5_deinit() - deinitialize the q6v5 common struct
364 * @q6v5: reference to qcom_q6v5 context to be deinitialized
366 void qcom_q6v5_deinit(struct qcom_q6v5 *q6v5)
370 EXPORT_SYMBOL_GPL(qcom_q6v5_deinit);
372 MODULE_LICENSE("GPL v2");
373 MODULE_DESCRIPTION("Qualcomm Peripheral Image Loader for Q6V5");