2 * Qualcomm ADSP/SLPI Peripheral Image Loader for MSM8974 and MSM8996
4 * Copyright (C) 2016 Linaro Ltd
5 * Copyright (C) 2014 Sony Mobile Communications AB
6 * Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #include <linux/clk.h>
19 #include <linux/firmware.h>
20 #include <linux/interrupt.h>
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/of_address.h>
24 #include <linux/of_device.h>
25 #include <linux/platform_device.h>
26 #include <linux/qcom_scm.h>
27 #include <linux/regulator/consumer.h>
28 #include <linux/remoteproc.h>
29 #include <linux/soc/qcom/mdt_loader.h>
30 #include <linux/soc/qcom/smem.h>
31 #include <linux/soc/qcom/smem_state.h>
33 #include "qcom_common.h"
34 #include "remoteproc_internal.h"
37 int crash_reason_smem;
38 const char *firmware_name;
53 struct qcom_smem_state *state;
57 struct clk *aggre2_clk;
59 struct regulator *cx_supply;
60 struct regulator *px_supply;
63 int crash_reason_smem;
66 struct completion start_done;
67 struct completion stop_done;
70 phys_addr_t mem_reloc;
74 struct qcom_rproc_glink glink_subdev;
75 struct qcom_rproc_subdev smd_subdev;
78 static int adsp_load(struct rproc *rproc, const struct firmware *fw)
80 struct qcom_adsp *adsp = (struct qcom_adsp *)rproc->priv;
82 return qcom_mdt_load(adsp->dev, fw, rproc->firmware, adsp->pas_id,
83 adsp->mem_region, adsp->mem_phys, adsp->mem_size);
86 static const struct rproc_fw_ops adsp_fw_ops = {
87 .find_rsc_table = qcom_mdt_find_rsc_table,
91 static int adsp_start(struct rproc *rproc)
93 struct qcom_adsp *adsp = (struct qcom_adsp *)rproc->priv;
96 ret = clk_prepare_enable(adsp->xo);
100 ret = clk_prepare_enable(adsp->aggre2_clk);
104 ret = regulator_enable(adsp->cx_supply);
106 goto disable_aggre2_clk;
108 ret = regulator_enable(adsp->px_supply);
110 goto disable_cx_supply;
112 ret = qcom_scm_pas_auth_and_reset(adsp->pas_id);
115 "failed to authenticate image and release reset\n");
116 goto disable_px_supply;
119 ret = wait_for_completion_timeout(&adsp->start_done,
120 msecs_to_jiffies(5000));
122 dev_err(adsp->dev, "start timed out\n");
123 qcom_scm_pas_shutdown(adsp->pas_id);
125 goto disable_px_supply;
131 regulator_disable(adsp->px_supply);
133 regulator_disable(adsp->cx_supply);
135 clk_disable_unprepare(adsp->aggre2_clk);
137 clk_disable_unprepare(adsp->xo);
142 static int adsp_stop(struct rproc *rproc)
144 struct qcom_adsp *adsp = (struct qcom_adsp *)rproc->priv;
147 qcom_smem_state_update_bits(adsp->state,
149 BIT(adsp->stop_bit));
151 ret = wait_for_completion_timeout(&adsp->stop_done,
152 msecs_to_jiffies(5000));
154 dev_err(adsp->dev, "timed out on wait\n");
156 qcom_smem_state_update_bits(adsp->state,
160 ret = qcom_scm_pas_shutdown(adsp->pas_id);
162 dev_err(adsp->dev, "failed to shutdown: %d\n", ret);
167 static void *adsp_da_to_va(struct rproc *rproc, u64 da, int len)
169 struct qcom_adsp *adsp = (struct qcom_adsp *)rproc->priv;
172 offset = da - adsp->mem_reloc;
173 if (offset < 0 || offset + len > adsp->mem_size)
176 return adsp->mem_region + offset;
179 static const struct rproc_ops adsp_ops = {
182 .da_to_va = adsp_da_to_va,
185 static irqreturn_t adsp_wdog_interrupt(int irq, void *dev)
187 struct qcom_adsp *adsp = dev;
189 rproc_report_crash(adsp->rproc, RPROC_WATCHDOG);
194 static irqreturn_t adsp_fatal_interrupt(int irq, void *dev)
196 struct qcom_adsp *adsp = dev;
200 msg = qcom_smem_get(QCOM_SMEM_HOST_ANY, adsp->crash_reason_smem, &len);
201 if (!IS_ERR(msg) && len > 0 && msg[0])
202 dev_err(adsp->dev, "fatal error received: %s\n", msg);
204 rproc_report_crash(adsp->rproc, RPROC_FATAL_ERROR);
212 static irqreturn_t adsp_ready_interrupt(int irq, void *dev)
217 static irqreturn_t adsp_handover_interrupt(int irq, void *dev)
219 struct qcom_adsp *adsp = dev;
221 complete(&adsp->start_done);
226 static irqreturn_t adsp_stop_ack_interrupt(int irq, void *dev)
228 struct qcom_adsp *adsp = dev;
230 complete(&adsp->stop_done);
235 static int adsp_init_clock(struct qcom_adsp *adsp)
239 adsp->xo = devm_clk_get(adsp->dev, "xo");
240 if (IS_ERR(adsp->xo)) {
241 ret = PTR_ERR(adsp->xo);
242 if (ret != -EPROBE_DEFER)
243 dev_err(adsp->dev, "failed to get xo clock");
247 if (adsp->has_aggre2_clk) {
248 adsp->aggre2_clk = devm_clk_get(adsp->dev, "aggre2");
249 if (IS_ERR(adsp->aggre2_clk)) {
250 ret = PTR_ERR(adsp->aggre2_clk);
251 if (ret != -EPROBE_DEFER)
253 "failed to get aggre2 clock");
261 static int adsp_init_regulator(struct qcom_adsp *adsp)
263 adsp->cx_supply = devm_regulator_get(adsp->dev, "cx");
264 if (IS_ERR(adsp->cx_supply))
265 return PTR_ERR(adsp->cx_supply);
267 regulator_set_load(adsp->cx_supply, 100000);
269 adsp->px_supply = devm_regulator_get(adsp->dev, "px");
270 if (IS_ERR(adsp->px_supply))
271 return PTR_ERR(adsp->px_supply);
276 static int adsp_request_irq(struct qcom_adsp *adsp,
277 struct platform_device *pdev,
279 irq_handler_t thread_fn)
283 ret = platform_get_irq_byname(pdev, name);
285 dev_err(&pdev->dev, "no %s IRQ defined\n", name);
289 ret = devm_request_threaded_irq(&pdev->dev, ret,
294 dev_err(&pdev->dev, "request %s IRQ failed\n", name);
299 static int adsp_alloc_memory_region(struct qcom_adsp *adsp)
301 struct device_node *node;
305 node = of_parse_phandle(adsp->dev->of_node, "memory-region", 0);
307 dev_err(adsp->dev, "no memory-region specified\n");
311 ret = of_address_to_resource(node, 0, &r);
315 adsp->mem_phys = adsp->mem_reloc = r.start;
316 adsp->mem_size = resource_size(&r);
317 adsp->mem_region = devm_ioremap_wc(adsp->dev, adsp->mem_phys, adsp->mem_size);
318 if (!adsp->mem_region) {
319 dev_err(adsp->dev, "unable to map memory region: %pa+%zx\n",
320 &r.start, adsp->mem_size);
327 static int adsp_probe(struct platform_device *pdev)
329 const struct adsp_data *desc;
330 struct qcom_adsp *adsp;
334 desc = of_device_get_match_data(&pdev->dev);
338 if (!qcom_scm_is_available())
339 return -EPROBE_DEFER;
341 rproc = rproc_alloc(&pdev->dev, pdev->name, &adsp_ops,
342 desc->firmware_name, sizeof(*adsp));
344 dev_err(&pdev->dev, "unable to allocate remoteproc\n");
348 rproc->fw_ops = &adsp_fw_ops;
350 adsp = (struct qcom_adsp *)rproc->priv;
351 adsp->dev = &pdev->dev;
353 adsp->pas_id = desc->pas_id;
354 adsp->crash_reason_smem = desc->crash_reason_smem;
355 adsp->has_aggre2_clk = desc->has_aggre2_clk;
356 platform_set_drvdata(pdev, adsp);
358 init_completion(&adsp->start_done);
359 init_completion(&adsp->stop_done);
361 ret = adsp_alloc_memory_region(adsp);
365 ret = adsp_init_clock(adsp);
369 ret = adsp_init_regulator(adsp);
373 ret = adsp_request_irq(adsp, pdev, "wdog", adsp_wdog_interrupt);
376 adsp->wdog_irq = ret;
378 ret = adsp_request_irq(adsp, pdev, "fatal", adsp_fatal_interrupt);
381 adsp->fatal_irq = ret;
383 ret = adsp_request_irq(adsp, pdev, "ready", adsp_ready_interrupt);
386 adsp->ready_irq = ret;
388 ret = adsp_request_irq(adsp, pdev, "handover", adsp_handover_interrupt);
391 adsp->handover_irq = ret;
393 ret = adsp_request_irq(adsp, pdev, "stop-ack", adsp_stop_ack_interrupt);
396 adsp->stop_ack_irq = ret;
398 adsp->state = qcom_smem_state_get(&pdev->dev, "stop",
400 if (IS_ERR(adsp->state)) {
401 ret = PTR_ERR(adsp->state);
405 qcom_add_glink_subdev(rproc, &adsp->glink_subdev);
406 qcom_add_smd_subdev(rproc, &adsp->smd_subdev);
408 ret = rproc_add(rproc);
420 static int adsp_remove(struct platform_device *pdev)
422 struct qcom_adsp *adsp = platform_get_drvdata(pdev);
424 qcom_smem_state_put(adsp->state);
425 rproc_del(adsp->rproc);
427 qcom_remove_glink_subdev(adsp->rproc, &adsp->glink_subdev);
428 qcom_remove_smd_subdev(adsp->rproc, &adsp->smd_subdev);
429 rproc_free(adsp->rproc);
434 static const struct adsp_data adsp_resource_init = {
435 .crash_reason_smem = 423,
436 .firmware_name = "adsp.mdt",
438 .has_aggre2_clk = false,
441 static const struct adsp_data slpi_resource_init = {
442 .crash_reason_smem = 424,
443 .firmware_name = "slpi.mdt",
445 .has_aggre2_clk = true,
448 static const struct of_device_id adsp_of_match[] = {
449 { .compatible = "qcom,msm8974-adsp-pil", .data = &adsp_resource_init},
450 { .compatible = "qcom,msm8996-adsp-pil", .data = &adsp_resource_init},
451 { .compatible = "qcom,msm8996-slpi-pil", .data = &slpi_resource_init},
454 MODULE_DEVICE_TABLE(of, adsp_of_match);
456 static struct platform_driver adsp_driver = {
458 .remove = adsp_remove,
460 .name = "qcom_adsp_pil",
461 .of_match_table = adsp_of_match,
465 module_platform_driver(adsp_driver);
466 MODULE_DESCRIPTION("Qualcomm MSM8974/MSM8996 ADSP Peripherial Image Loader");
467 MODULE_LICENSE("GPL v2");