1 // SPDX-License-Identifier: GPL-2.0-only
3 * TI K3 DSP Remote Processor(s) driver
5 * Copyright (C) 2018-2020 Texas Instruments Incorporated - https://www.ti.com/
6 * Suman Anna <s-anna@ti.com>
10 #include <linux/mailbox_client.h>
11 #include <linux/module.h>
12 #include <linux/of_device.h>
13 #include <linux/of_reserved_mem.h>
14 #include <linux/omap-mailbox.h>
15 #include <linux/platform_device.h>
16 #include <linux/remoteproc.h>
17 #include <linux/reset.h>
18 #include <linux/slab.h>
20 #include "omap_remoteproc.h"
21 #include "remoteproc_internal.h"
22 #include "ti_sci_proc.h"
24 #define KEYSTONE_RPROC_LOCAL_ADDRESS_MASK (SZ_16M - 1)
27 * struct k3_dsp_mem - internal memory structure
28 * @cpu_addr: MPU virtual address of the memory region
29 * @bus_addr: Bus address used to access the memory region
30 * @dev_addr: Device address of the memory region from DSP view
31 * @size: Size of the memory region
34 void __iomem
*cpu_addr
;
41 * struct k3_dsp_mem_data - memory definitions for a DSP
42 * @name: name for this memory entry
43 * @dev_addr: device address for the memory entry
45 struct k3_dsp_mem_data
{
51 * struct k3_dsp_dev_data - device data structure for a DSP
52 * @mems: pointer to memory definitions for a DSP
53 * @num_mems: number of memory regions in @mems
54 * @boot_align_addr: boot vector address alignment granularity
55 * @uses_lreset: flag to denote the need for local reset management
57 struct k3_dsp_dev_data
{
58 const struct k3_dsp_mem_data
*mems
;
65 * struct k3_dsp_rproc - k3 DSP remote processor driver structure
66 * @dev: cached device pointer
67 * @rproc: remoteproc device handle
68 * @mem: internal memory regions data
69 * @num_mems: number of internal memory regions
70 * @rmem: reserved memory regions data
71 * @num_rmems: number of reserved memory regions
72 * @reset: reset control handle
73 * @data: pointer to DSP-specific device data
74 * @tsp: TI-SCI processor control handle
75 * @ti_sci: TI-SCI handle
76 * @ti_sci_id: TI-SCI device identifier
77 * @mbox: mailbox channel handle
78 * @client: mailbox client to request the mailbox channel
83 struct k3_dsp_mem
*mem
;
85 struct k3_dsp_mem
*rmem
;
87 struct reset_control
*reset
;
88 const struct k3_dsp_dev_data
*data
;
89 struct ti_sci_proc
*tsp
;
90 const struct ti_sci_handle
*ti_sci
;
92 struct mbox_chan
*mbox
;
93 struct mbox_client client
;
97 * k3_dsp_rproc_mbox_callback() - inbound mailbox message handler
98 * @client: mailbox client pointer used for requesting the mailbox channel
99 * @data: mailbox payload
101 * This handler is invoked by the OMAP mailbox driver whenever a mailbox
102 * message is received. Usually, the mailbox payload simply contains
103 * the index of the virtqueue that is kicked by the remote processor,
104 * and we let remoteproc core handle it.
106 * In addition to virtqueue indices, we also have some out-of-band values
107 * that indicate different events. Those values are deliberately very
108 * large so they don't coincide with virtqueue indices.
110 static void k3_dsp_rproc_mbox_callback(struct mbox_client
*client
, void *data
)
112 struct k3_dsp_rproc
*kproc
= container_of(client
, struct k3_dsp_rproc
,
114 struct device
*dev
= kproc
->rproc
->dev
.parent
;
115 const char *name
= kproc
->rproc
->name
;
116 u32 msg
= omap_mbox_message(data
);
118 dev_dbg(dev
, "mbox msg: 0x%x\n", msg
);
123 * remoteproc detected an exception, but error recovery is not
124 * supported. So, just log this for now
126 dev_err(dev
, "K3 DSP rproc %s crashed\n", name
);
128 case RP_MBOX_ECHO_REPLY
:
129 dev_info(dev
, "received echo reply from %s\n", name
);
132 /* silently handle all other valid messages */
133 if (msg
>= RP_MBOX_READY
&& msg
< RP_MBOX_END_MSG
)
135 if (msg
> kproc
->rproc
->max_notifyid
) {
136 dev_dbg(dev
, "dropping unknown message 0x%x", msg
);
139 /* msg contains the index of the triggered vring */
140 if (rproc_vq_interrupt(kproc
->rproc
, msg
) == IRQ_NONE
)
141 dev_dbg(dev
, "no message was found in vqid %d\n", msg
);
146 * Kick the remote processor to notify about pending unprocessed messages.
147 * The vqid usage is not used and is inconsequential, as the kick is performed
148 * through a simulated GPIO (a bit in an IPC interrupt-triggering register),
149 * the remote processor is expected to process both its Tx and Rx virtqueues.
151 static void k3_dsp_rproc_kick(struct rproc
*rproc
, int vqid
)
153 struct k3_dsp_rproc
*kproc
= rproc
->priv
;
154 struct device
*dev
= rproc
->dev
.parent
;
155 mbox_msg_t msg
= (mbox_msg_t
)vqid
;
158 /* send the index of the triggered virtqueue in the mailbox payload */
159 ret
= mbox_send_message(kproc
->mbox
, (void *)msg
);
161 dev_err(dev
, "failed to send mailbox message, status = %d\n",
165 /* Put the DSP processor into reset */
166 static int k3_dsp_rproc_reset(struct k3_dsp_rproc
*kproc
)
168 struct device
*dev
= kproc
->dev
;
171 ret
= reset_control_assert(kproc
->reset
);
173 dev_err(dev
, "local-reset assert failed, ret = %d\n", ret
);
177 if (kproc
->data
->uses_lreset
)
180 ret
= kproc
->ti_sci
->ops
.dev_ops
.put_device(kproc
->ti_sci
,
183 dev_err(dev
, "module-reset assert failed, ret = %d\n", ret
);
184 if (reset_control_deassert(kproc
->reset
))
185 dev_warn(dev
, "local-reset deassert back failed\n");
191 /* Release the DSP processor from reset */
192 static int k3_dsp_rproc_release(struct k3_dsp_rproc
*kproc
)
194 struct device
*dev
= kproc
->dev
;
197 if (kproc
->data
->uses_lreset
)
200 ret
= kproc
->ti_sci
->ops
.dev_ops
.get_device(kproc
->ti_sci
,
203 dev_err(dev
, "module-reset deassert failed, ret = %d\n", ret
);
208 ret
= reset_control_deassert(kproc
->reset
);
210 dev_err(dev
, "local-reset deassert failed, ret = %d\n", ret
);
211 if (kproc
->ti_sci
->ops
.dev_ops
.put_device(kproc
->ti_sci
,
213 dev_warn(dev
, "module-reset assert back failed\n");
220 * The C66x DSP cores have a local reset that affects only the CPU, and a
221 * generic module reset that powers on the device and allows the DSP internal
222 * memories to be accessed while the local reset is asserted. This function is
223 * used to release the global reset on C66x DSPs to allow loading into the DSP
224 * internal RAMs. The .prepare() ops is invoked by remoteproc core before any
225 * firmware loading, and is followed by the .start() ops after loading to
226 * actually let the C66x DSP cores run.
228 static int k3_dsp_rproc_prepare(struct rproc
*rproc
)
230 struct k3_dsp_rproc
*kproc
= rproc
->priv
;
231 struct device
*dev
= kproc
->dev
;
234 ret
= kproc
->ti_sci
->ops
.dev_ops
.get_device(kproc
->ti_sci
,
237 dev_err(dev
, "module-reset deassert failed, cannot enable internal RAM loading, ret = %d\n",
244 * This function implements the .unprepare() ops and performs the complimentary
245 * operations to that of the .prepare() ops. The function is used to assert the
246 * global reset on applicable C66x cores. This completes the second portion of
247 * powering down the C66x DSP cores. The cores themselves are only halted in the
248 * .stop() callback through the local reset, and the .unprepare() ops is invoked
249 * by the remoteproc core after the remoteproc is stopped to balance the global
252 static int k3_dsp_rproc_unprepare(struct rproc
*rproc
)
254 struct k3_dsp_rproc
*kproc
= rproc
->priv
;
255 struct device
*dev
= kproc
->dev
;
258 ret
= kproc
->ti_sci
->ops
.dev_ops
.put_device(kproc
->ti_sci
,
261 dev_err(dev
, "module-reset assert failed, ret = %d\n", ret
);
267 * Power up the DSP remote processor.
269 * This function will be invoked only after the firmware for this rproc
270 * was loaded, parsed successfully, and all of its resource requirements
273 static int k3_dsp_rproc_start(struct rproc
*rproc
)
275 struct k3_dsp_rproc
*kproc
= rproc
->priv
;
276 struct mbox_client
*client
= &kproc
->client
;
277 struct device
*dev
= kproc
->dev
;
282 client
->tx_done
= NULL
;
283 client
->rx_callback
= k3_dsp_rproc_mbox_callback
;
284 client
->tx_block
= false;
285 client
->knows_txdone
= false;
287 kproc
->mbox
= mbox_request_channel(client
, 0);
288 if (IS_ERR(kproc
->mbox
)) {
290 dev_err(dev
, "mbox_request_channel failed: %ld\n",
291 PTR_ERR(kproc
->mbox
));
296 * Ping the remote processor, this is only for sanity-sake for now;
297 * there is no functional effect whatsoever.
299 * Note that the reply will _not_ arrive immediately: this message
300 * will wait in the mailbox fifo until the remote processor is booted.
302 ret
= mbox_send_message(kproc
->mbox
, (void *)RP_MBOX_ECHO_REQUEST
);
304 dev_err(dev
, "mbox_send_message failed: %d\n", ret
);
308 boot_addr
= rproc
->bootaddr
;
309 if (boot_addr
& (kproc
->data
->boot_align_addr
- 1)) {
310 dev_err(dev
, "invalid boot address 0x%x, must be aligned on a 0x%x boundary\n",
311 boot_addr
, kproc
->data
->boot_align_addr
);
316 dev_err(dev
, "booting DSP core using boot addr = 0x%x\n", boot_addr
);
317 ret
= ti_sci_proc_set_config(kproc
->tsp
, boot_addr
, 0, 0);
321 ret
= k3_dsp_rproc_release(kproc
);
328 mbox_free_channel(kproc
->mbox
);
333 * Stop the DSP remote processor.
335 * This function puts the DSP processor into reset, and finishes processing
336 * of any pending messages.
338 static int k3_dsp_rproc_stop(struct rproc
*rproc
)
340 struct k3_dsp_rproc
*kproc
= rproc
->priv
;
342 mbox_free_channel(kproc
->mbox
);
344 k3_dsp_rproc_reset(kproc
);
350 * Custom function to translate a DSP device address (internal RAMs only) to a
351 * kernel virtual address. The DSPs can access their RAMs at either an internal
352 * address visible only from a DSP, or at the SoC-level bus address. Both these
353 * addresses need to be looked through for translation. The translated addresses
354 * can be used either by the remoteproc core for loading (when using kernel
355 * remoteproc loader), or by any rpmsg bus drivers.
357 static void *k3_dsp_rproc_da_to_va(struct rproc
*rproc
, u64 da
, size_t len
)
359 struct k3_dsp_rproc
*kproc
= rproc
->priv
;
360 void __iomem
*va
= NULL
;
361 phys_addr_t bus_addr
;
362 u32 dev_addr
, offset
;
369 for (i
= 0; i
< kproc
->num_mems
; i
++) {
370 bus_addr
= kproc
->mem
[i
].bus_addr
;
371 dev_addr
= kproc
->mem
[i
].dev_addr
;
372 size
= kproc
->mem
[i
].size
;
374 if (da
< KEYSTONE_RPROC_LOCAL_ADDRESS_MASK
) {
375 /* handle DSP-view addresses */
376 if (da
>= dev_addr
&&
377 ((da
+ len
) <= (dev_addr
+ size
))) {
378 offset
= da
- dev_addr
;
379 va
= kproc
->mem
[i
].cpu_addr
+ offset
;
380 return (__force
void *)va
;
383 /* handle SoC-view addresses */
384 if (da
>= bus_addr
&&
385 (da
+ len
) <= (bus_addr
+ size
)) {
386 offset
= da
- bus_addr
;
387 va
= kproc
->mem
[i
].cpu_addr
+ offset
;
388 return (__force
void *)va
;
393 /* handle static DDR reserved memory regions */
394 for (i
= 0; i
< kproc
->num_rmems
; i
++) {
395 dev_addr
= kproc
->rmem
[i
].dev_addr
;
396 size
= kproc
->rmem
[i
].size
;
398 if (da
>= dev_addr
&& ((da
+ len
) <= (dev_addr
+ size
))) {
399 offset
= da
- dev_addr
;
400 va
= kproc
->rmem
[i
].cpu_addr
+ offset
;
401 return (__force
void *)va
;
408 static const struct rproc_ops k3_dsp_rproc_ops
= {
409 .start
= k3_dsp_rproc_start
,
410 .stop
= k3_dsp_rproc_stop
,
411 .kick
= k3_dsp_rproc_kick
,
412 .da_to_va
= k3_dsp_rproc_da_to_va
,
415 static int k3_dsp_rproc_of_get_memories(struct platform_device
*pdev
,
416 struct k3_dsp_rproc
*kproc
)
418 const struct k3_dsp_dev_data
*data
= kproc
->data
;
419 struct device
*dev
= &pdev
->dev
;
420 struct resource
*res
;
424 num_mems
= kproc
->data
->num_mems
;
425 kproc
->mem
= devm_kcalloc(kproc
->dev
, num_mems
,
426 sizeof(*kproc
->mem
), GFP_KERNEL
);
430 for (i
= 0; i
< num_mems
; i
++) {
431 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
,
434 dev_err(dev
, "found no memory resource for %s\n",
438 if (!devm_request_mem_region(dev
, res
->start
,
441 dev_err(dev
, "could not request %s region for resource\n",
446 kproc
->mem
[i
].cpu_addr
= devm_ioremap_wc(dev
, res
->start
,
448 if (!kproc
->mem
[i
].cpu_addr
) {
449 dev_err(dev
, "failed to map %s memory\n",
453 kproc
->mem
[i
].bus_addr
= res
->start
;
454 kproc
->mem
[i
].dev_addr
= data
->mems
[i
].dev_addr
;
455 kproc
->mem
[i
].size
= resource_size(res
);
457 dev_dbg(dev
, "memory %8s: bus addr %pa size 0x%zx va %pK da 0x%x\n",
458 data
->mems
[i
].name
, &kproc
->mem
[i
].bus_addr
,
459 kproc
->mem
[i
].size
, kproc
->mem
[i
].cpu_addr
,
460 kproc
->mem
[i
].dev_addr
);
462 kproc
->num_mems
= num_mems
;
467 static int k3_dsp_reserved_mem_init(struct k3_dsp_rproc
*kproc
)
469 struct device
*dev
= kproc
->dev
;
470 struct device_node
*np
= dev
->of_node
;
471 struct device_node
*rmem_np
;
472 struct reserved_mem
*rmem
;
476 num_rmems
= of_property_count_elems_of_size(np
, "memory-region",
478 if (num_rmems
<= 0) {
479 dev_err(dev
, "device does not reserved memory regions, ret = %d\n",
484 dev_err(dev
, "device needs atleast two memory regions to be defined, num = %d\n",
489 /* use reserved memory region 0 for vring DMA allocations */
490 ret
= of_reserved_mem_device_init_by_idx(dev
, np
, 0);
492 dev_err(dev
, "device cannot initialize DMA pool, ret = %d\n",
498 kproc
->rmem
= kcalloc(num_rmems
, sizeof(*kproc
->rmem
), GFP_KERNEL
);
504 /* use remaining reserved memory regions for static carveouts */
505 for (i
= 0; i
< num_rmems
; i
++) {
506 rmem_np
= of_parse_phandle(np
, "memory-region", i
+ 1);
512 rmem
= of_reserved_mem_lookup(rmem_np
);
514 of_node_put(rmem_np
);
518 of_node_put(rmem_np
);
520 kproc
->rmem
[i
].bus_addr
= rmem
->base
;
521 /* 64-bit address regions currently not supported */
522 kproc
->rmem
[i
].dev_addr
= (u32
)rmem
->base
;
523 kproc
->rmem
[i
].size
= rmem
->size
;
524 kproc
->rmem
[i
].cpu_addr
= ioremap_wc(rmem
->base
, rmem
->size
);
525 if (!kproc
->rmem
[i
].cpu_addr
) {
526 dev_err(dev
, "failed to map reserved memory#%d at %pa of size %pa\n",
527 i
+ 1, &rmem
->base
, &rmem
->size
);
532 dev_dbg(dev
, "reserved memory%d: bus addr %pa size 0x%zx va %pK da 0x%x\n",
533 i
+ 1, &kproc
->rmem
[i
].bus_addr
,
534 kproc
->rmem
[i
].size
, kproc
->rmem
[i
].cpu_addr
,
535 kproc
->rmem
[i
].dev_addr
);
537 kproc
->num_rmems
= num_rmems
;
542 for (i
--; i
>= 0; i
--)
543 iounmap(kproc
->rmem
[i
].cpu_addr
);
546 of_reserved_mem_device_release(kproc
->dev
);
550 static void k3_dsp_reserved_mem_exit(struct k3_dsp_rproc
*kproc
)
554 for (i
= 0; i
< kproc
->num_rmems
; i
++)
555 iounmap(kproc
->rmem
[i
].cpu_addr
);
558 of_reserved_mem_device_release(kproc
->dev
);
562 struct ti_sci_proc
*k3_dsp_rproc_of_get_tsp(struct device
*dev
,
563 const struct ti_sci_handle
*sci
)
565 struct ti_sci_proc
*tsp
;
569 ret
= of_property_read_u32_array(dev
->of_node
, "ti,sci-proc-ids",
574 tsp
= kzalloc(sizeof(*tsp
), GFP_KERNEL
);
576 return ERR_PTR(-ENOMEM
);
580 tsp
->ops
= &sci
->ops
.proc_ops
;
581 tsp
->proc_id
= temp
[0];
582 tsp
->host_id
= temp
[1];
587 static int k3_dsp_rproc_probe(struct platform_device
*pdev
)
589 struct device
*dev
= &pdev
->dev
;
590 struct device_node
*np
= dev
->of_node
;
591 const struct k3_dsp_dev_data
*data
;
592 struct k3_dsp_rproc
*kproc
;
598 data
= of_device_get_match_data(dev
);
602 ret
= rproc_of_parse_firmware(dev
, 0, &fw_name
);
604 dev_err(dev
, "failed to parse firmware-name property, ret = %d\n",
609 rproc
= rproc_alloc(dev
, dev_name(dev
), &k3_dsp_rproc_ops
, fw_name
,
614 rproc
->has_iommu
= false;
615 rproc
->recovery_disabled
= true;
616 if (data
->uses_lreset
) {
617 rproc
->ops
->prepare
= k3_dsp_rproc_prepare
;
618 rproc
->ops
->unprepare
= k3_dsp_rproc_unprepare
;
621 kproc
->rproc
= rproc
;
625 kproc
->ti_sci
= ti_sci_get_by_phandle(np
, "ti,sci");
626 if (IS_ERR(kproc
->ti_sci
)) {
627 ret
= PTR_ERR(kproc
->ti_sci
);
628 if (ret
!= -EPROBE_DEFER
) {
629 dev_err(dev
, "failed to get ti-sci handle, ret = %d\n",
632 kproc
->ti_sci
= NULL
;
636 ret
= of_property_read_u32(np
, "ti,sci-dev-id", &kproc
->ti_sci_id
);
638 dev_err(dev
, "missing 'ti,sci-dev-id' property\n");
642 kproc
->reset
= devm_reset_control_get_exclusive(dev
, NULL
);
643 if (IS_ERR(kproc
->reset
)) {
644 ret
= PTR_ERR(kproc
->reset
);
645 dev_err(dev
, "failed to get reset, status = %d\n", ret
);
649 kproc
->tsp
= k3_dsp_rproc_of_get_tsp(dev
, kproc
->ti_sci
);
650 if (IS_ERR(kproc
->tsp
)) {
651 dev_err(dev
, "failed to construct ti-sci proc control, ret = %d\n",
653 ret
= PTR_ERR(kproc
->tsp
);
657 ret
= ti_sci_proc_request(kproc
->tsp
);
659 dev_err(dev
, "ti_sci_proc_request failed, ret = %d\n", ret
);
663 ret
= k3_dsp_rproc_of_get_memories(pdev
, kproc
);
667 ret
= k3_dsp_reserved_mem_init(kproc
);
669 dev_err(dev
, "reserved memory init failed, ret = %d\n", ret
);
674 * ensure the DSP local reset is asserted to ensure the DSP doesn't
675 * execute bogus code in .prepare() when the module reset is released.
677 if (data
->uses_lreset
) {
678 ret
= reset_control_status(kproc
->reset
);
680 dev_err(dev
, "failed to get reset status, status = %d\n",
683 } else if (ret
== 0) {
684 dev_warn(dev
, "local reset is deasserted for device\n");
685 k3_dsp_rproc_reset(kproc
);
689 ret
= rproc_add(rproc
);
691 dev_err(dev
, "failed to add register device with remoteproc core, status = %d\n",
696 platform_set_drvdata(pdev
, kproc
);
701 k3_dsp_reserved_mem_exit(kproc
);
703 ret1
= ti_sci_proc_release(kproc
->tsp
);
705 dev_err(dev
, "failed to release proc, ret = %d\n", ret1
);
709 ret1
= ti_sci_put_handle(kproc
->ti_sci
);
711 dev_err(dev
, "failed to put ti_sci handle, ret = %d\n", ret1
);
717 static int k3_dsp_rproc_remove(struct platform_device
*pdev
)
719 struct k3_dsp_rproc
*kproc
= platform_get_drvdata(pdev
);
720 struct device
*dev
= &pdev
->dev
;
723 rproc_del(kproc
->rproc
);
725 ret
= ti_sci_proc_release(kproc
->tsp
);
727 dev_err(dev
, "failed to release proc, ret = %d\n", ret
);
731 ret
= ti_sci_put_handle(kproc
->ti_sci
);
733 dev_err(dev
, "failed to put ti_sci handle, ret = %d\n", ret
);
735 k3_dsp_reserved_mem_exit(kproc
);
736 rproc_free(kproc
->rproc
);
741 static const struct k3_dsp_mem_data c66_mems
[] = {
742 { .name
= "l2sram", .dev_addr
= 0x800000 },
743 { .name
= "l1pram", .dev_addr
= 0xe00000 },
744 { .name
= "l1dram", .dev_addr
= 0xf00000 },
747 /* C71x cores only have a L1P Cache, there are no L1P SRAMs */
748 static const struct k3_dsp_mem_data c71_mems
[] = {
749 { .name
= "l2sram", .dev_addr
= 0x800000 },
750 { .name
= "l1dram", .dev_addr
= 0xe00000 },
753 static const struct k3_dsp_dev_data c66_data
= {
755 .num_mems
= ARRAY_SIZE(c66_mems
),
756 .boot_align_addr
= SZ_1K
,
760 static const struct k3_dsp_dev_data c71_data
= {
762 .num_mems
= ARRAY_SIZE(c71_mems
),
763 .boot_align_addr
= SZ_2M
,
764 .uses_lreset
= false,
767 static const struct of_device_id k3_dsp_of_match
[] = {
768 { .compatible
= "ti,j721e-c66-dsp", .data
= &c66_data
, },
769 { .compatible
= "ti,j721e-c71-dsp", .data
= &c71_data
, },
772 MODULE_DEVICE_TABLE(of
, k3_dsp_of_match
);
774 static struct platform_driver k3_dsp_rproc_driver
= {
775 .probe
= k3_dsp_rproc_probe
,
776 .remove
= k3_dsp_rproc_remove
,
778 .name
= "k3-dsp-rproc",
779 .of_match_table
= k3_dsp_of_match
,
783 module_platform_driver(k3_dsp_rproc_driver
);
785 MODULE_AUTHOR("Suman Anna <s-anna@ti.com>");
786 MODULE_LICENSE("GPL v2");
787 MODULE_DESCRIPTION("TI K3 DSP Remoteproc driver");