2 * Qualcomm Peripheral Image Loader
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/kernel.h>
19 #include <linux/module.h>
20 #include <linux/platform_device.h>
21 #include <linux/dma-mapping.h>
22 #include <linux/firmware.h>
23 #include <linux/remoteproc.h>
24 #include <linux/interrupt.h>
25 #include <linux/memblock.h>
26 #include <linux/gpio/consumer.h>
28 #include <linux/elf.h>
29 #include <linux/of_address.h>
30 #include <linux/of_device.h>
32 #include <linux/delay.h>
33 #include <linux/clk.h>
34 #include <linux/slab.h>
35 #include <linux/regulator/consumer.h>
36 #include <linux/soc/qcom/smem.h>
37 #include <linux/soc/qcom/smem_state.h>
38 #include <linux/reset.h>
40 #include "remoteproc_internal.h"
41 #include "qcom_mdt_loader.h"
43 #include <linux/qcom_scm.h>
45 #define MBA_FIRMWARE_NAME "mba.b00"
46 #define MPSS_FIRMWARE_NAME "modem.mdt"
48 #define MPSS_CRASH_REASON_SMEM 421
50 #define VDD_MSS_UV_MIN 1000000
51 #define VDD_MSS_UV_MAX 1150000
52 #define VDD_MSS_UA 100000
54 /* AXI Halting Registers */
55 #define MSS_Q6_HALT_BASE 0x180
56 #define MSS_MODEM_HALT_BASE 0x200
57 #define MSS_NC_HALT_BASE 0x280
59 /* RMB Status Register Values */
60 #define RMB_PBL_SUCCESS 0x1
62 #define RMB_MBA_XPU_UNLOCKED 0x1
63 #define RMB_MBA_XPU_UNLOCKED_SCRIBBLED 0x2
64 #define RMB_MBA_META_DATA_AUTH_SUCCESS 0x3
65 #define RMB_MBA_AUTH_COMPLETE 0x4
67 /* PBL/MBA interface registers */
68 #define RMB_MBA_IMAGE_REG 0x00
69 #define RMB_PBL_STATUS_REG 0x04
70 #define RMB_MBA_COMMAND_REG 0x08
71 #define RMB_MBA_STATUS_REG 0x0C
72 #define RMB_PMI_META_DATA_REG 0x10
73 #define RMB_PMI_CODE_START_REG 0x14
74 #define RMB_PMI_CODE_LENGTH_REG 0x18
76 #define RMB_CMD_META_DATA_READY 0x1
77 #define RMB_CMD_LOAD_READY 0x2
79 /* QDSP6SS Register Offsets */
80 #define QDSP6SS_RESET_REG 0x014
81 #define QDSP6SS_GFMUX_CTL_REG 0x020
82 #define QDSP6SS_PWR_CTL_REG 0x030
84 /* AXI Halt Register Offsets */
85 #define AXI_HALTREQ_REG 0x0
86 #define AXI_HALTACK_REG 0x4
87 #define AXI_IDLE_REG 0x8
89 #define HALT_ACK_TIMEOUT_MS 100
92 #define Q6SS_STOP_CORE BIT(0)
93 #define Q6SS_CORE_ARES BIT(1)
94 #define Q6SS_BUS_ARES_ENABLE BIT(2)
96 /* QDSP6SS_GFMUX_CTL */
97 #define Q6SS_CLK_ENABLE BIT(1)
100 #define Q6SS_L2DATA_SLP_NRET_N_0 BIT(0)
101 #define Q6SS_L2DATA_SLP_NRET_N_1 BIT(1)
102 #define Q6SS_L2DATA_SLP_NRET_N_2 BIT(2)
103 #define Q6SS_L2TAG_SLP_NRET_N BIT(16)
104 #define Q6SS_ETB_SLP_NRET_N BIT(17)
105 #define Q6SS_L2DATA_STBY_N BIT(18)
106 #define Q6SS_SLP_RET_N BIT(19)
107 #define Q6SS_CLAMP_IO BIT(20)
108 #define QDSS_BHS_ON BIT(21)
109 #define QDSS_LDO_BYP BIT(22)
115 void __iomem *reg_base;
116 void __iomem *halt_base;
117 void __iomem *rmb_base;
119 struct reset_control *mss_restart;
121 struct qcom_smem_state *state;
124 struct regulator *vdd;
130 struct completion start_done;
132 phys_addr_t mba_phys;
136 phys_addr_t mpss_phys;
141 static int q6v5_load(struct rproc *rproc, const struct firmware *fw)
143 struct q6v5 *qproc = rproc->priv;
145 memcpy(qproc->mba_region, fw->data, fw->size);
150 static const struct rproc_fw_ops q6v5_fw_ops = {
151 .find_rsc_table = qcom_mdt_find_rsc_table,
155 static int q6v5_rmb_pbl_wait(struct q6v5 *qproc, int ms)
157 unsigned long timeout;
160 timeout = jiffies + msecs_to_jiffies(ms);
162 val = readl(qproc->rmb_base + RMB_PBL_STATUS_REG);
166 if (time_after(jiffies, timeout))
175 static int q6v5_rmb_mba_wait(struct q6v5 *qproc, u32 status, int ms)
178 unsigned long timeout;
181 timeout = jiffies + msecs_to_jiffies(ms);
183 val = readl(qproc->rmb_base + RMB_MBA_STATUS_REG);
189 else if (status && val == status)
192 if (time_after(jiffies, timeout))
201 static void q6v5proc_reset(struct q6v5 *qproc)
205 /* Assert resets, stop core */
206 val = readl(qproc->reg_base + QDSP6SS_RESET_REG);
207 val |= (Q6SS_CORE_ARES | Q6SS_BUS_ARES_ENABLE | Q6SS_STOP_CORE);
208 writel(val, qproc->reg_base + QDSP6SS_RESET_REG);
210 /* Enable power block headswitch, and wait for it to stabilize */
211 val = readl(qproc->reg_base + QDSP6SS_PWR_CTL_REG);
212 val |= QDSS_BHS_ON | QDSS_LDO_BYP;
213 writel(val, qproc->reg_base + QDSP6SS_PWR_CTL_REG);
218 * Turn on memories. L2 banks should be done individually
219 * to minimize inrush current.
221 val = readl(qproc->reg_base + QDSP6SS_PWR_CTL_REG);
222 val |= Q6SS_SLP_RET_N | Q6SS_L2TAG_SLP_NRET_N |
223 Q6SS_ETB_SLP_NRET_N | Q6SS_L2DATA_STBY_N;
224 writel(val, qproc->reg_base + QDSP6SS_PWR_CTL_REG);
225 val |= Q6SS_L2DATA_SLP_NRET_N_2;
226 writel(val, qproc->reg_base + QDSP6SS_PWR_CTL_REG);
227 val |= Q6SS_L2DATA_SLP_NRET_N_1;
228 writel(val, qproc->reg_base + QDSP6SS_PWR_CTL_REG);
229 val |= Q6SS_L2DATA_SLP_NRET_N_0;
230 writel(val, qproc->reg_base + QDSP6SS_PWR_CTL_REG);
232 /* Remove IO clamp */
233 val &= ~Q6SS_CLAMP_IO;
234 writel(val, qproc->reg_base + QDSP6SS_PWR_CTL_REG);
236 /* Bring core out of reset */
237 val = readl(qproc->reg_base + QDSP6SS_RESET_REG);
238 val &= ~Q6SS_CORE_ARES;
239 writel(val, qproc->reg_base + QDSP6SS_RESET_REG);
241 /* Turn on core clock */
242 val = readl(qproc->reg_base + QDSP6SS_GFMUX_CTL_REG);
243 val |= Q6SS_CLK_ENABLE;
244 writel(val, qproc->reg_base + QDSP6SS_GFMUX_CTL_REG);
246 /* Start core execution */
247 val = readl(qproc->reg_base + QDSP6SS_RESET_REG);
248 val &= ~Q6SS_STOP_CORE;
249 writel(val, qproc->reg_base + QDSP6SS_RESET_REG);
252 static void q6v5proc_halt_axi_port(struct q6v5 *qproc, void __iomem *halt)
254 unsigned long timeout;
257 /* Check if we're already idle */
258 if (readl(halt + AXI_IDLE_REG))
261 /* Assert halt request */
262 writel(1, halt + AXI_HALTREQ_REG);
265 timeout = jiffies + msecs_to_jiffies(HALT_ACK_TIMEOUT_MS);
267 val = readl(halt + AXI_HALTACK_REG);
268 if (val || time_after(jiffies, timeout))
274 if (!readl(halt + AXI_IDLE_REG))
275 dev_err(qproc->dev, "port %pa failed halt\n", &halt);
277 /* Clear halt request (port will remain halted until reset) */
278 writel(0, halt + AXI_HALTREQ_REG);
281 static int q6v5_mpss_init_image(struct q6v5 *qproc, const struct firmware *fw)
285 /* Use mpss memory as scratch buffer for the mdt validation */
286 memcpy(qproc->mpss_region, fw->data, fw->size);
288 writel(qproc->mpss_phys, qproc->rmb_base + RMB_PMI_META_DATA_REG);
289 writel(RMB_CMD_META_DATA_READY, qproc->rmb_base + RMB_MBA_COMMAND_REG);
291 ret = q6v5_rmb_mba_wait(qproc, RMB_MBA_META_DATA_AUTH_SUCCESS, 1000);
292 if (ret == -ETIMEDOUT)
293 dev_err(qproc->dev, "MBA header authentication timed out\n");
295 dev_err(qproc->dev, "MBA returned error %d for MDT header\n", ret);
297 return ret < 0 ? ret : 0;
300 static int q6v5_mpss_validate(struct q6v5 *qproc, const struct firmware *fw)
302 const struct elf32_phdr *phdrs;
303 const struct elf32_phdr *phdr;
304 struct elf32_hdr *ehdr;
309 ehdr = (struct elf32_hdr *)fw->data;
310 phdrs = (struct elf32_phdr *)(ehdr + 1);
311 for (i = 0; i < ehdr->e_phnum; i++, phdr++) {
314 if (phdr->p_type != PT_LOAD)
317 if ((phdr->p_flags & QCOM_MDT_TYPE_MASK) == QCOM_MDT_TYPE_HASH)
323 size = readl(qproc->rmb_base + RMB_PMI_CODE_LENGTH_REG);
325 writel(qproc->mpss_phys, qproc->rmb_base + RMB_PMI_CODE_START_REG);
326 writel(RMB_CMD_LOAD_READY, qproc->rmb_base + RMB_MBA_COMMAND_REG);
329 size += phdr->p_memsz;
330 writel(size, qproc->rmb_base + RMB_PMI_CODE_LENGTH_REG);
333 val = readl(qproc->rmb_base + RMB_MBA_STATUS_REG);
334 return val < 0 ? val : 0;
337 static int q6v5_mpss_load(struct q6v5 *qproc)
339 const struct firmware *fw;
345 ret = request_firmware(&fw, MPSS_FIRMWARE_NAME, qproc->dev);
347 dev_err(qproc->dev, "unable to load " MPSS_FIRMWARE_NAME "\n");
351 ret = qcom_mdt_parse(fw, &fw_addr, &fw_size, &relocate);
353 dev_err(qproc->dev, "failed to parse mdt header\n");
357 /* Initialize the RMB validator */
358 writel(0, qproc->rmb_base + RMB_PMI_CODE_LENGTH_REG);
360 ret = q6v5_mpss_init_image(qproc, fw);
362 goto release_firmware;
364 ret = qcom_mdt_load(qproc->rproc, fw, MPSS_FIRMWARE_NAME, fw_addr, qproc->mpss_region, qproc->mpss_size);
366 goto release_firmware;
368 ret = q6v5_mpss_validate(qproc, fw);
370 goto release_firmware;
372 ret = q6v5_rmb_mba_wait(qproc, RMB_MBA_AUTH_COMPLETE, 10000);
373 if (ret == -ETIMEDOUT)
374 dev_err(qproc->dev, "MBA authentication timed out\n");
376 dev_err(qproc->dev, "MBA returned error %d\n", ret);
379 release_firmware(fw);
381 return ret < 0 ? ret : 0;
384 static int q6v5_start(struct rproc *rproc)
386 struct q6v5 *qproc = (struct q6v5 *)rproc->priv;
389 ret = regulator_enable(qproc->vdd);
391 dev_err(qproc->dev, "failed to enable mss vdd\n");
395 ret = reset_control_deassert(qproc->mss_restart);
397 dev_err(qproc->dev, "failed to deassert mss restart\n");
401 ret = clk_prepare_enable(qproc->ahb_clk);
405 ret = clk_prepare_enable(qproc->axi_clk);
407 goto disable_ahb_clk;
409 ret = clk_prepare_enable(qproc->rom_clk);
411 goto disable_axi_clk;
413 writel(qproc->mba_phys, qproc->rmb_base + RMB_MBA_IMAGE_REG);
415 q6v5proc_reset(qproc);
417 ret = q6v5_rmb_pbl_wait(qproc, 1000);
418 if (ret == -ETIMEDOUT) {
419 dev_err(qproc->dev, "PBL boot timed out\n");
421 } else if (ret != RMB_PBL_SUCCESS) {
422 dev_err(qproc->dev, "PBL returned unexpected status %d\n", ret);
427 ret = q6v5_rmb_mba_wait(qproc, 0, 5000);
428 if (ret == -ETIMEDOUT) {
429 dev_err(qproc->dev, "MBA boot timed out\n");
431 } else if (ret != RMB_MBA_XPU_UNLOCKED && ret != RMB_MBA_XPU_UNLOCKED_SCRIBBLED) {
432 dev_err(qproc->dev, "MBA returned unexpected status %d\n", ret);
437 dev_info(qproc->dev, "MBA booted, loading mpss\n");
439 ret = q6v5_mpss_load(qproc);
443 ret = wait_for_completion_timeout(&qproc->start_done,
444 msecs_to_jiffies(5000));
446 dev_err(qproc->dev, "start timed out\n");
451 /* All done, release the handover resources */
456 q6v5proc_halt_axi_port(qproc, qproc->halt_base + MSS_Q6_HALT_BASE);
457 q6v5proc_halt_axi_port(qproc, qproc->halt_base + MSS_MODEM_HALT_BASE);
458 q6v5proc_halt_axi_port(qproc, qproc->halt_base + MSS_NC_HALT_BASE);
460 clk_disable_unprepare(qproc->axi_clk);
462 clk_disable_unprepare(qproc->ahb_clk);
464 reset_control_assert(qproc->mss_restart);
466 regulator_disable(qproc->vdd);
471 static int q6v5_stop(struct rproc *rproc)
473 struct q6v5 *qproc = (struct q6v5 *)rproc->priv;
475 q6v5proc_halt_axi_port(qproc, qproc->halt_base + MSS_Q6_HALT_BASE);
476 q6v5proc_halt_axi_port(qproc, qproc->halt_base + MSS_MODEM_HALT_BASE);
477 q6v5proc_halt_axi_port(qproc, qproc->halt_base + MSS_NC_HALT_BASE);
479 reset_control_assert(qproc->mss_restart);
480 clk_disable_unprepare(qproc->axi_clk);
481 clk_disable_unprepare(qproc->ahb_clk);
482 regulator_disable(qproc->vdd);
487 static const struct rproc_ops q6v5_ops = {
492 static irqreturn_t q6v5_wdog_interrupt(int irq, void *dev)
494 struct q6v5 *qproc = dev;
498 msg = qcom_smem_get(QCOM_SMEM_HOST_ANY, MPSS_CRASH_REASON_SMEM, &len);
499 if (!IS_ERR(msg) && len > 0 && msg[0])
500 dev_err(qproc->dev, "watchdog received: %s\n", msg);
502 dev_err(qproc->dev, "watchdog without message\n");
504 rproc_report_crash(qproc->rproc, RPROC_WATCHDOG);
512 static irqreturn_t q6v5_fatal_interrupt(int irq, void *dev)
514 struct q6v5 *qproc = dev;
518 msg = qcom_smem_get(QCOM_SMEM_HOST_ANY, MPSS_CRASH_REASON_SMEM, &len);
519 if (!IS_ERR(msg) && len > 0 && msg[0])
520 dev_err(qproc->dev, "fatal error received: %s\n", msg);
522 dev_err(qproc->dev, "fatal error without message\n");
524 rproc_report_crash(qproc->rproc, RPROC_FATAL_ERROR);
532 static irqreturn_t q6v5_handover_interrupt(int irq, void *dev)
534 struct q6v5 *qproc = dev;
536 complete(&qproc->start_done);
540 static irqreturn_t q6v5_stop_ack_interrupt(int irq, void *dev)
545 static int q6v5_init_mem(struct q6v5 *qproc, struct platform_device *pdev)
547 struct resource *res;
549 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qdsp6_base");
550 qproc->reg_base = devm_ioremap_resource(&pdev->dev, res);
551 if (IS_ERR(qproc->reg_base)) {
552 dev_err(qproc->dev, "failed to get qdsp6_base\n");
553 return PTR_ERR(qproc->reg_base);
556 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "halt_base");
557 qproc->halt_base = devm_ioremap_resource(&pdev->dev, res);
558 if (IS_ERR(qproc->halt_base)) {
559 dev_err(qproc->dev, "failed to get halt_base\n");
560 return PTR_ERR(qproc->halt_base);
563 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "rmb_base");
564 qproc->rmb_base = devm_ioremap_resource(&pdev->dev, res);
565 if (IS_ERR(qproc->rmb_base)) {
566 dev_err(qproc->dev, "failed to get rmb_base\n");
567 return PTR_ERR(qproc->rmb_base);
573 static int q6v5_init_clocks(struct q6v5 *qproc)
575 qproc->ahb_clk = devm_clk_get(qproc->dev, "iface");
576 if (IS_ERR(qproc->ahb_clk)) {
577 dev_err(qproc->dev, "failed to get iface clock\n");
578 return PTR_ERR(qproc->ahb_clk);
581 qproc->axi_clk = devm_clk_get(qproc->dev, "bus");
582 if (IS_ERR(qproc->axi_clk)) {
583 dev_err(qproc->dev, "failed to get bus clock\n");
584 return PTR_ERR(qproc->axi_clk);
587 qproc->rom_clk = devm_clk_get(qproc->dev, "mem");
588 if (IS_ERR(qproc->rom_clk)) {
589 dev_err(qproc->dev, "failed to get mem clock\n");
590 return PTR_ERR(qproc->rom_clk);
596 static int q6v5_init_regulators(struct q6v5 *qproc)
598 qproc->vdd = devm_regulator_get(qproc->dev, "vdd");
599 if (IS_ERR(qproc->vdd)) {
600 dev_err(qproc->dev, "failed to get vdd supply\n");
601 return PTR_ERR(qproc->vdd);
604 regulator_set_voltage(qproc->vdd, VDD_MSS_UV_MIN, VDD_MSS_UV_MAX);
605 regulator_set_load(qproc->vdd, VDD_MSS_UA);
610 static int q6v5_init_reset(struct q6v5 *qproc)
612 qproc->mss_restart = devm_reset_control_get(qproc->dev, NULL);
613 if (IS_ERR(qproc->mss_restart)) {
614 dev_err(qproc->dev, "failed to acquire mss restart\n");
615 return PTR_ERR(qproc->mss_restart);
621 static int q6v5_request_irq(struct q6v5 *qproc,
622 struct platform_device *pdev,
624 irq_handler_t thread_fn)
628 ret = platform_get_irq_byname(pdev, name);
630 dev_err(&pdev->dev, "no %s IRQ defined\n", name);
634 ret = devm_request_threaded_irq(&pdev->dev, ret,
636 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
639 dev_err(&pdev->dev, "request %s IRQ failed\n", name);
643 static int q6v5_alloc_memory_region(struct q6v5 *qproc)
645 struct device_node *child;
646 struct device_node *node;
650 child = of_get_child_by_name(qproc->dev->of_node, "mba");
651 node = of_parse_phandle(child, "memory-region", 0);
652 ret = of_address_to_resource(node, 0, &r);
654 dev_err(qproc->dev, "unable to resolve mba region\n");
658 qproc->mba_phys = r.start;
659 qproc->mba_size = resource_size(&r);
660 qproc->mba_region = devm_ioremap_wc(qproc->dev, qproc->mba_phys, qproc->mba_size);
661 if (!qproc->mba_region) {
662 dev_err(qproc->dev, "unable to map memory region: %pa+%zx\n",
663 &r.start, qproc->mba_size);
667 child = of_get_child_by_name(qproc->dev->of_node, "mpss");
668 node = of_parse_phandle(child, "memory-region", 0);
669 ret = of_address_to_resource(node, 0, &r);
671 dev_err(qproc->dev, "unable to resolve mpss region\n");
675 qproc->mpss_phys = r.start;
676 qproc->mpss_size = resource_size(&r);
677 qproc->mpss_region = devm_ioremap_wc(qproc->dev, qproc->mpss_phys, qproc->mpss_size);
678 if (!qproc->mpss_region) {
679 dev_err(qproc->dev, "unable to map memory region: %pa+%zx\n",
680 &r.start, qproc->mpss_size);
687 static int q6v5_probe(struct platform_device *pdev)
693 rproc = rproc_alloc(&pdev->dev, pdev->name, &q6v5_ops,
694 MBA_FIRMWARE_NAME, sizeof(*qproc));
696 dev_err(&pdev->dev, "failed to allocate rproc\n");
700 rproc->fw_ops = &q6v5_fw_ops;
702 qproc = (struct q6v5 *)rproc->priv;
703 qproc->dev = &pdev->dev;
704 qproc->rproc = rproc;
705 platform_set_drvdata(pdev, qproc);
707 init_completion(&qproc->start_done);
709 ret = q6v5_init_mem(qproc, pdev);
713 ret = q6v5_alloc_memory_region(qproc);
717 ret = q6v5_init_clocks(qproc);
721 ret = q6v5_init_regulators(qproc);
725 ret = q6v5_init_reset(qproc);
729 ret = q6v5_request_irq(qproc, pdev, "wdog", q6v5_wdog_interrupt);
733 ret = q6v5_request_irq(qproc, pdev, "fatal", q6v5_fatal_interrupt);
737 ret = q6v5_request_irq(qproc, pdev, "handover", q6v5_handover_interrupt);
741 ret = q6v5_request_irq(qproc, pdev, "stop-ack", q6v5_stop_ack_interrupt);
745 qproc->state = qcom_smem_state_get(&pdev->dev, "stop", &qproc->stop_bit);
746 if (IS_ERR(qproc->state))
749 ret = rproc_add(rproc);
761 static int q6v5_remove(struct platform_device *pdev)
763 struct q6v5 *qproc = platform_get_drvdata(pdev);
765 rproc_del(qproc->rproc);
766 rproc_put(qproc->rproc);
771 static const struct of_device_id q6v5_of_match[] = {
772 { .compatible = "qcom,q6v5-pil", },
776 static struct platform_driver q6v5_driver = {
778 .remove = q6v5_remove,
780 .name = "qcom-q6v5-pil",
781 .of_match_table = q6v5_of_match,
785 module_platform_driver(q6v5_driver);