2 * Remote processor machine-specific module for DA8XX
4 * Copyright (C) 2013 Texas Instruments, Inc.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * version 2 as published by the Free Software Foundation.
11 #include <linux/bitops.h>
12 #include <linux/clk.h>
13 #include <linux/err.h>
14 #include <linux/interrupt.h>
16 #include <linux/irq.h>
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/of_reserved_mem.h>
20 #include <linux/platform_device.h>
21 #include <linux/remoteproc.h>
23 #include <mach/clock.h> /* for davinci_clk_reset_assert/deassert() */
25 #include "remoteproc_internal.h"
27 static char *da8xx_fw_name;
28 module_param(da8xx_fw_name, charp, 0444);
29 MODULE_PARM_DESC(da8xx_fw_name,
30 "Name of DSP firmware file in /lib/firmware (if not specified defaults to 'rproc-dsp-fw')");
33 * OMAP-L138 Technical References:
34 * http://www.ti.com/product/omap-l138
36 #define SYSCFG_CHIPSIG0 BIT(0)
37 #define SYSCFG_CHIPSIG1 BIT(1)
38 #define SYSCFG_CHIPSIG2 BIT(2)
39 #define SYSCFG_CHIPSIG3 BIT(3)
40 #define SYSCFG_CHIPSIG4 BIT(4)
42 #define DA8XX_RPROC_LOCAL_ADDRESS_MASK (SZ_16M - 1)
45 * struct da8xx_rproc_mem - internal memory structure
46 * @cpu_addr: MPU virtual address of the memory region
47 * @bus_addr: Bus address used to access the memory region
48 * @dev_addr: Device address of the memory region from DSP view
49 * @size: Size of the memory region
51 struct da8xx_rproc_mem {
52 void __iomem *cpu_addr;
59 * struct da8xx_rproc - da8xx remote processor instance state
60 * @rproc: rproc handle
61 * @mem: internal memory regions data
62 * @num_mems: number of internal memory regions
63 * @dsp_clk: placeholder for platform's DSP clk
64 * @ack_fxn: chip-specific ack function for ack'ing irq
65 * @irq_data: ack_fxn function parameter
66 * @chipsig: virt ptr to DSP interrupt registers (CHIPSIG & CHIPSIG_CLR)
67 * @bootreg: virt ptr to DSP boot address register (HOST1CFG)
68 * @irq: irq # used by this instance
72 struct da8xx_rproc_mem *mem;
75 void (*ack_fxn)(struct irq_data *data);
76 struct irq_data *irq_data;
77 void __iomem *chipsig;
78 void __iomem *bootreg;
83 * handle_event() - inbound virtqueue message workqueue function
85 * This function is registered as a kernel thread and is scheduled by the
88 static irqreturn_t handle_event(int irq, void *p)
90 struct rproc *rproc = (struct rproc *)p;
92 /* Process incoming buffers on all our vrings */
93 rproc_vq_interrupt(rproc, 0);
94 rproc_vq_interrupt(rproc, 1);
100 * da8xx_rproc_callback() - inbound virtqueue message handler
102 * This handler is invoked directly by the kernel whenever the remote
103 * core (DSP) has modified the state of a virtqueue. There is no
104 * "payload" message indicating the virtqueue index as is the case with
105 * mailbox-based implementations on OMAP4. As such, this handler "polls"
106 * each known virtqueue index for every invocation.
108 static irqreturn_t da8xx_rproc_callback(int irq, void *p)
110 struct rproc *rproc = (struct rproc *)p;
111 struct da8xx_rproc *drproc = (struct da8xx_rproc *)rproc->priv;
114 chipsig = readl(drproc->chipsig);
115 if (chipsig & SYSCFG_CHIPSIG0) {
116 /* Clear interrupt level source */
117 writel(SYSCFG_CHIPSIG0, drproc->chipsig + 4);
122 * It has already been ack'ed by the kernel before calling
123 * this function, but since the ARM<->DSP interrupts in the
124 * CHIPSIG register are "level" instead of "pulse" variety,
125 * we need to ack it after taking down the level else we'll
126 * be called again immediately after returning.
128 drproc->ack_fxn(drproc->irq_data);
130 return IRQ_WAKE_THREAD;
136 static int da8xx_rproc_start(struct rproc *rproc)
138 struct device *dev = rproc->dev.parent;
139 struct da8xx_rproc *drproc = (struct da8xx_rproc *)rproc->priv;
140 struct clk *dsp_clk = drproc->dsp_clk;
143 /* hw requires the start (boot) address be on 1KB boundary */
144 if (rproc->bootaddr & 0x3ff) {
145 dev_err(dev, "invalid boot address: must be aligned to 1KB\n");
150 writel(rproc->bootaddr, drproc->bootreg);
152 ret = clk_prepare_enable(dsp_clk);
154 dev_err(dev, "clk_prepare_enable() failed: %d\n", ret);
158 davinci_clk_reset_deassert(dsp_clk);
163 static int da8xx_rproc_stop(struct rproc *rproc)
165 struct da8xx_rproc *drproc = rproc->priv;
167 davinci_clk_reset_assert(drproc->dsp_clk);
168 clk_disable_unprepare(drproc->dsp_clk);
173 /* kick a virtqueue */
174 static void da8xx_rproc_kick(struct rproc *rproc, int vqid)
176 struct da8xx_rproc *drproc = (struct da8xx_rproc *)rproc->priv;
178 /* Interrupt remote proc */
179 writel(SYSCFG_CHIPSIG2, drproc->chipsig);
182 static const struct rproc_ops da8xx_rproc_ops = {
183 .start = da8xx_rproc_start,
184 .stop = da8xx_rproc_stop,
185 .kick = da8xx_rproc_kick,
188 static int da8xx_rproc_get_internal_memories(struct platform_device *pdev,
189 struct da8xx_rproc *drproc)
191 static const char * const mem_names[] = {"l2sram", "l1pram", "l1dram"};
192 int num_mems = ARRAY_SIZE(mem_names);
193 struct device *dev = &pdev->dev;
194 struct resource *res;
197 drproc->mem = devm_kcalloc(dev, num_mems, sizeof(*drproc->mem),
202 for (i = 0; i < num_mems; i++) {
203 res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
205 drproc->mem[i].cpu_addr = devm_ioremap_resource(dev, res);
206 if (IS_ERR(drproc->mem[i].cpu_addr)) {
207 dev_err(dev, "failed to parse and map %s memory\n",
209 return PTR_ERR(drproc->mem[i].cpu_addr);
211 drproc->mem[i].bus_addr = res->start;
212 drproc->mem[i].dev_addr =
213 res->start & DA8XX_RPROC_LOCAL_ADDRESS_MASK;
214 drproc->mem[i].size = resource_size(res);
216 dev_dbg(dev, "memory %8s: bus addr %pa size 0x%x va %p da 0x%x\n",
217 mem_names[i], &drproc->mem[i].bus_addr,
218 drproc->mem[i].size, drproc->mem[i].cpu_addr,
219 drproc->mem[i].dev_addr);
221 drproc->num_mems = num_mems;
226 static int da8xx_rproc_probe(struct platform_device *pdev)
228 struct device *dev = &pdev->dev;
229 struct da8xx_rproc *drproc;
231 struct irq_data *irq_data;
232 struct resource *bootreg_res;
233 struct resource *chipsig_res;
235 void __iomem *chipsig;
236 void __iomem *bootreg;
240 irq = platform_get_irq(pdev, 0);
242 dev_err(dev, "platform_get_irq(pdev, 0) error: %d\n", irq);
246 irq_data = irq_get_irq_data(irq);
248 dev_err(dev, "irq_get_irq_data(%d): NULL\n", irq);
252 bootreg_res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
254 bootreg = devm_ioremap_resource(dev, bootreg_res);
256 return PTR_ERR(bootreg);
258 chipsig_res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
260 chipsig = devm_ioremap_resource(dev, chipsig_res);
262 return PTR_ERR(chipsig);
264 dsp_clk = devm_clk_get(dev, NULL);
265 if (IS_ERR(dsp_clk)) {
266 dev_err(dev, "clk_get error: %ld\n", PTR_ERR(dsp_clk));
268 return PTR_ERR(dsp_clk);
272 ret = of_reserved_mem_device_init(dev);
274 dev_err(dev, "device does not have specific CMA pool: %d\n",
280 rproc = rproc_alloc(dev, "dsp", &da8xx_rproc_ops, da8xx_fw_name,
287 drproc = rproc->priv;
288 drproc->rproc = rproc;
289 drproc->dsp_clk = dsp_clk;
290 rproc->has_iommu = false;
292 ret = da8xx_rproc_get_internal_memories(pdev, drproc);
296 platform_set_drvdata(pdev, rproc);
298 /* everything the ISR needs is now setup, so hook it up */
299 ret = devm_request_threaded_irq(dev, irq, da8xx_rproc_callback,
300 handle_event, 0, "da8xx-remoteproc",
303 dev_err(dev, "devm_request_threaded_irq error: %d\n", ret);
308 * rproc_add() can end up enabling the DSP's clk with the DSP
309 * *not* in reset, but da8xx_rproc_start() needs the DSP to be
310 * held in reset at the time it is called.
312 ret = davinci_clk_reset_assert(drproc->dsp_clk);
316 drproc->chipsig = chipsig;
317 drproc->bootreg = bootreg;
318 drproc->ack_fxn = irq_data->chip->irq_ack;
319 drproc->irq_data = irq_data;
322 ret = rproc_add(rproc);
324 dev_err(dev, "rproc_add failed: %d\n", ret);
334 of_reserved_mem_device_release(dev);
338 static int da8xx_rproc_remove(struct platform_device *pdev)
340 struct rproc *rproc = platform_get_drvdata(pdev);
341 struct da8xx_rproc *drproc = (struct da8xx_rproc *)rproc->priv;
342 struct device *dev = &pdev->dev;
345 * The devm subsystem might end up releasing things before
346 * freeing the irq, thus allowing an interrupt to sneak in while
347 * the device is being removed. This should prevent that.
349 disable_irq(drproc->irq);
354 of_reserved_mem_device_release(dev);
359 static const struct of_device_id davinci_rproc_of_match[] __maybe_unused = {
360 { .compatible = "ti,da850-dsp", },
363 MODULE_DEVICE_TABLE(of, davinci_rproc_of_match);
365 static struct platform_driver da8xx_rproc_driver = {
366 .probe = da8xx_rproc_probe,
367 .remove = da8xx_rproc_remove,
369 .name = "davinci-rproc",
370 .of_match_table = of_match_ptr(davinci_rproc_of_match),
374 module_platform_driver(da8xx_rproc_driver);
376 MODULE_LICENSE("GPL v2");
377 MODULE_DESCRIPTION("DA8XX Remote Processor control driver");