1 // SPDX-License-Identifier: GPL-2.0+
3 * Texas Instruments' K3 DSP Remoteproc driver
5 * Copyright (C) 2018-2020 Texas Instruments Incorporated - http://www.ti.com/
6 * Lokesh Vutla <lokeshvutla@ti.com>
7 * Suman Anna <s-anna@ti.com>
13 #include <remoteproc.h>
18 #include <power-domain.h>
19 #include <dm/device_compat.h>
20 #include <linux/err.h>
21 #include <linux/sizes.h>
22 #include <linux/soc/ti/ti_sci_protocol.h>
23 #include "ti_sci_proc.h"
25 #define KEYSTONE_RPROC_LOCAL_ADDRESS_MASK (SZ_16M - 1)
28 * struct k3_dsp_mem - internal memory structure
29 * @cpu_addr: MPU virtual address of the memory region
30 * @bus_addr: Bus address used to access the memory region
31 * @dev_addr: Device address from remoteproc view
32 * @size: Size of the memory region
35 void __iomem *cpu_addr;
42 * struct k3_dsp_boot_data - internal data structure used for boot
43 * @boot_align_addr: Boot vector address alignment granularity
44 * @uses_lreset: Flag to denote the need for local reset management
46 struct k3_dsp_boot_data {
52 * struct k3_dsp_privdata - Structure representing Remote processor data.
53 * @rproc_rst: rproc reset control data
54 * @tsp: Pointer to TISCI proc contrl handle
55 * @data: Pointer to DSP specific boot data structure
56 * @mem: Array of available memories
57 * @num_mem: Number of available memories
59 struct k3_dsp_privdata {
60 struct reset_ctl dsp_rst;
61 struct ti_sci_proc tsp;
62 struct k3_dsp_boot_data *data;
63 struct k3_dsp_mem *mem;
68 * The C66x DSP cores have a local reset that affects only the CPU, and a
69 * generic module reset that powers on the device and allows the DSP internal
70 * memories to be accessed while the local reset is asserted. This function is
71 * used to release the global reset on C66x DSPs to allow loading into the DSP
72 * internal RAMs. This helper function is invoked in k3_dsp_load() before any
73 * actual firmware loading and is undone only in k3_dsp_stop(). The local reset
74 * on C71x cores is a no-op and the global reset cannot be released on C71x
75 * cores until after the firmware images are loaded, so this function does
76 * nothing for C71x cores.
78 static int k3_dsp_prepare(struct udevice *dev)
80 struct k3_dsp_privdata *dsp = dev_get_priv(dev);
81 struct k3_dsp_boot_data *data = dsp->data;
84 /* local reset is no-op on C71x processors */
85 if (!data->uses_lreset)
88 ret = ti_sci_proc_power_domain_on(&dsp->tsp);
90 dev_err(dev, "cannot enable internal RAM loading, ret = %d\n",
97 * This function is the counterpart to k3_dsp_prepare() and is used to assert
98 * the global reset on C66x DSP cores (no-op for C71x DSP cores). This completes
99 * the second step of powering down the C66x DSP cores. The cores themselves
100 * are halted through the local reset in first step. This function is invoked
101 * in k3_dsp_stop() after the local reset is asserted.
103 static int k3_dsp_unprepare(struct udevice *dev)
105 struct k3_dsp_privdata *dsp = dev_get_priv(dev);
106 struct k3_dsp_boot_data *data = dsp->data;
108 /* local reset is no-op on C71x processors */
109 if (!data->uses_lreset)
112 return ti_sci_proc_power_domain_off(&dsp->tsp);
116 * k3_dsp_load() - Load up the Remote processor image
117 * @dev: rproc device pointer
118 * @addr: Address at which image is available
119 * @size: size of the image
121 * Return: 0 if all goes good, else appropriate error message.
123 static int k3_dsp_load(struct udevice *dev, ulong addr, ulong size)
125 struct k3_dsp_privdata *dsp = dev_get_priv(dev);
126 struct k3_dsp_boot_data *data = dsp->data;
130 dev_dbg(dev, "%s addr = 0x%lx, size = 0x%lx\n", __func__, addr, size);
131 ret = ti_sci_proc_request(&dsp->tsp);
135 ret = k3_dsp_prepare(dev);
137 dev_err(dev, "DSP prepare failed for core %d\n",
142 ret = rproc_elf_load_image(dev, addr, size);
144 dev_err(dev, "Loading elf failed %d\n", ret);
148 boot_vector = rproc_elf_get_boot_addr(dev, addr);
149 if (boot_vector & (data->boot_align_addr - 1)) {
151 dev_err(dev, "Boot vector 0x%x not aligned on 0x%x boundary\n",
152 boot_vector, data->boot_align_addr);
156 dev_dbg(dev, "%s: Boot vector = 0x%x\n", __func__, boot_vector);
158 ret = ti_sci_proc_set_config(&dsp->tsp, boot_vector, 0, 0);
161 k3_dsp_unprepare(dev);
163 ti_sci_proc_release(&dsp->tsp);
168 * k3_dsp_start() - Start the remote processor
169 * @dev: rproc device pointer
171 * Return: 0 if all went ok, else return appropriate error
173 static int k3_dsp_start(struct udevice *dev)
175 struct k3_dsp_privdata *dsp = dev_get_priv(dev);
176 struct k3_dsp_boot_data *data = dsp->data;
179 dev_dbg(dev, "%s\n", __func__);
181 ret = ti_sci_proc_request(&dsp->tsp);
185 if (!data->uses_lreset) {
186 ret = ti_sci_proc_power_domain_on(&dsp->tsp);
191 ret = reset_deassert(&dsp->dsp_rst);
193 if (!data->uses_lreset)
194 ti_sci_proc_power_domain_off(&dsp->tsp);
198 ti_sci_proc_release(&dsp->tsp);
203 static int k3_dsp_stop(struct udevice *dev)
205 struct k3_dsp_privdata *dsp = dev_get_priv(dev);
207 dev_dbg(dev, "%s\n", __func__);
209 ti_sci_proc_request(&dsp->tsp);
210 reset_assert(&dsp->dsp_rst);
211 ti_sci_proc_power_domain_off(&dsp->tsp);
212 ti_sci_proc_release(&dsp->tsp);
218 * k3_dsp_init() - Initialize the remote processor
219 * @dev: rproc device pointer
221 * Return: 0 if all went ok, else return appropriate error
223 static int k3_dsp_init(struct udevice *dev)
225 dev_dbg(dev, "%s\n", __func__);
230 static int k3_dsp_reset(struct udevice *dev)
232 dev_dbg(dev, "%s\n", __func__);
237 static void *k3_dsp_da_to_va(struct udevice *dev, ulong da, ulong len)
239 struct k3_dsp_privdata *dsp = dev_get_priv(dev);
240 phys_addr_t bus_addr, dev_addr;
241 void __iomem *va = NULL;
246 dev_dbg(dev, "%s\n", __func__);
251 for (i = 0; i < dsp->num_mems; i++) {
252 bus_addr = dsp->mem[i].bus_addr;
253 dev_addr = dsp->mem[i].dev_addr;
254 size = dsp->mem[i].size;
256 if (da >= dev_addr && ((da + len) <= (dev_addr + size))) {
257 offset = da - dev_addr;
258 va = dsp->mem[i].cpu_addr + offset;
259 return (__force void *)va;
262 if (da >= bus_addr && (da + len) <= (bus_addr + size)) {
263 offset = da - bus_addr;
264 va = dsp->mem[i].cpu_addr + offset;
265 return (__force void *)va;
269 /* Assume it is DDR region and return da */
270 return map_physmem(da, len, MAP_NOCACHE);
273 static const struct dm_rproc_ops k3_dsp_ops = {
276 .start = k3_dsp_start,
278 .reset = k3_dsp_reset,
279 .device_to_virt = k3_dsp_da_to_va,
282 static int ti_sci_proc_of_to_priv(struct udevice *dev, struct ti_sci_proc *tsp)
287 dev_dbg(dev, "%s\n", __func__);
289 tsp->sci = ti_sci_get_by_phandle(dev, "ti,sci");
290 if (IS_ERR(tsp->sci)) {
291 dev_err(dev, "ti_sci get failed: %ld\n", PTR_ERR(tsp->sci));
292 return PTR_ERR(tsp->sci);
295 ret = dev_read_u32_array(dev, "ti,sci-proc-ids", ids, 2);
297 dev_err(dev, "Proc IDs not populated %d\n", ret);
301 tsp->ops = &tsp->sci->ops.proc_ops;
302 tsp->proc_id = ids[0];
303 tsp->host_id = ids[1];
304 tsp->dev_id = dev_read_u32_default(dev, "ti,sci-dev-id",
305 TI_SCI_RESOURCE_NULL);
306 if (tsp->dev_id == TI_SCI_RESOURCE_NULL) {
307 dev_err(dev, "Device ID not populated %d\n", ret);
314 static int k3_dsp_of_get_memories(struct udevice *dev)
316 static const char * const mem_names[] = {"l2sram", "l1pram", "l1dram"};
317 struct k3_dsp_privdata *dsp = dev_get_priv(dev);
320 dev_dbg(dev, "%s\n", __func__);
322 dsp->num_mems = ARRAY_SIZE(mem_names);
323 dsp->mem = calloc(dsp->num_mems, sizeof(*dsp->mem));
327 for (i = 0; i < dsp->num_mems; i++) {
328 /* C71 cores only have a L1P Cache, there are no L1P SRAMs */
329 if (device_is_compatible(dev, "ti,j721e-c71-dsp") &&
330 !strcmp(mem_names[i], "l1pram")) {
331 dsp->mem[i].bus_addr = FDT_ADDR_T_NONE;
332 dsp->mem[i].dev_addr = FDT_ADDR_T_NONE;
333 dsp->mem[i].cpu_addr = NULL;
334 dsp->mem[i].size = 0;
338 dsp->mem[i].bus_addr = dev_read_addr_size_name(dev, mem_names[i],
339 (fdt_addr_t *)&dsp->mem[i].size);
340 if (dsp->mem[i].bus_addr == FDT_ADDR_T_NONE) {
341 dev_err(dev, "%s bus address not found\n", mem_names[i]);
344 dsp->mem[i].cpu_addr = map_physmem(dsp->mem[i].bus_addr,
347 dsp->mem[i].dev_addr = dsp->mem[i].bus_addr &
348 KEYSTONE_RPROC_LOCAL_ADDRESS_MASK;
350 dev_dbg(dev, "memory %8s: bus addr %pa size 0x%zx va %p da %pa\n",
351 mem_names[i], &dsp->mem[i].bus_addr,
352 dsp->mem[i].size, dsp->mem[i].cpu_addr,
353 &dsp->mem[i].dev_addr);
360 * k3_of_to_priv() - generate private data from device tree
361 * @dev: corresponding k3 dsp processor device
362 * @dsp: pointer to driver specific private data
364 * Return: 0 if all goes good, else appropriate error message.
366 static int k3_dsp_of_to_priv(struct udevice *dev, struct k3_dsp_privdata *dsp)
370 dev_dbg(dev, "%s\n", __func__);
372 ret = reset_get_by_index(dev, 0, &dsp->dsp_rst);
374 dev_err(dev, "reset_get() failed: %d\n", ret);
378 ret = ti_sci_proc_of_to_priv(dev, &dsp->tsp);
382 ret = k3_dsp_of_get_memories(dev);
386 dsp->data = (struct k3_dsp_boot_data *)dev_get_driver_data(dev);
392 * k3_dsp_probe() - Basic probe
393 * @dev: corresponding k3 remote processor device
395 * Return: 0 if all goes good, else appropriate error message.
397 static int k3_dsp_probe(struct udevice *dev)
399 struct k3_dsp_privdata *dsp;
402 dev_dbg(dev, "%s\n", __func__);
404 dsp = dev_get_priv(dev);
406 ret = k3_dsp_of_to_priv(dev, dsp);
408 dev_dbg(dev, "%s: Probe failed with error %d\n", __func__, ret);
413 * The DSP local resets are deasserted by default on Power-On-Reset.
414 * Assert the local resets to ensure the DSPs don't execute bogus code
415 * in .load() callback when the module reset is released to support
416 * internal memory loading. This is needed for C66x DSPs, and is a
417 * no-op on C71x DSPs.
419 reset_assert(&dsp->dsp_rst);
421 dev_dbg(dev, "Remoteproc successfully probed\n");
426 static int k3_dsp_remove(struct udevice *dev)
428 struct k3_dsp_privdata *dsp = dev_get_priv(dev);
435 static const struct k3_dsp_boot_data c66_data = {
436 .boot_align_addr = SZ_1K,
440 static const struct k3_dsp_boot_data c71_data = {
441 .boot_align_addr = SZ_2M,
442 .uses_lreset = false,
445 static const struct udevice_id k3_dsp_ids[] = {
446 { .compatible = "ti,j721e-c66-dsp", .data = (ulong)&c66_data, },
447 { .compatible = "ti,j721e-c71-dsp", .data = (ulong)&c71_data, },
451 U_BOOT_DRIVER(k3_dsp) = {
453 .of_match = k3_dsp_ids,
454 .id = UCLASS_REMOTEPROC,
456 .probe = k3_dsp_probe,
457 .remove = k3_dsp_remove,
458 .priv_auto_alloc_size = sizeof(struct k3_dsp_privdata),