1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments Incorporated - http://www.ti.com/
6 #define pr_fmt(fmt) "%s: " fmt, __func__
11 #include <remoteproc.h>
15 * enum sandbox_state - different device states
16 * @sb_booted: Entry condition, just booted
17 * @sb_init: Initialized (basic environment is ready)
18 * @sb_reset: Held in reset (accessible, but not running)
19 * @sb_loaded: Loaded with image (but not running)
20 * @sb_running: Processor is running
31 * struct sandbox_test_devdata - private data per device
32 * @current_state: device current state
34 struct sandbox_test_devdata {
35 enum sandbox_state current_state;
39 * sandbox_dev_move_to_state() - statemachine for our dummy device
40 * @dev: device to switch state
41 * @next_state: next proposed state
43 * This tries to follow the following statemachine:
49 * | | | <---------------------+
55 * | | | <----------+ |
59 * | +----v----+ reset | |
61 * | Loaded +-----------+ |
66 * +->| Running | Stop |
67 * Ping +- | +--------------------+
70 * (is_running does not change state)
72 * Return: 0 when valid state transition is seen, else returns -EINVAL
74 static int sandbox_dev_move_to_state(struct udevice *dev,
75 enum sandbox_state next_state)
77 struct sandbox_test_devdata *ddata = dev_get_priv(dev);
79 /* No state transition is OK */
80 if (ddata->current_state == next_state)
83 debug("current_state=%d, next_state=%d\n", ddata->current_state,
85 switch (ddata->current_state) {
87 if (next_state == sb_init)
92 if (next_state == sb_reset || next_state == sb_loaded)
97 if (next_state == sb_loaded || next_state == sb_init)
102 if (next_state == sb_reset || next_state == sb_init ||
103 next_state == sb_running)
108 if (next_state == sb_reset || next_state == sb_init)
115 ddata->current_state = next_state;
120 * sandbox_testproc_probe() - basic probe function
121 * @dev: test proc device that is being probed.
123 * Return: 0 if all went ok, else return appropriate error
125 static int sandbox_testproc_probe(struct udevice *dev)
127 struct dm_rproc_uclass_pdata *uc_pdata;
128 struct sandbox_test_devdata *ddata;
131 uc_pdata = dev_get_uclass_platdata(dev);
132 ddata = dev_get_priv(dev);
134 debug("%s: platform private data missing\n", uc_pdata->name);
137 ret = sandbox_dev_move_to_state(dev, sb_booted);
138 debug("%s: called(%d)\n", uc_pdata->name, ret);
144 * sandbox_testproc_init() - Simple initialization function
145 * @dev: device to operate upon
147 * Return: 0 if all went ok, else return appropriate error
149 static int sandbox_testproc_init(struct udevice *dev)
151 struct dm_rproc_uclass_pdata *uc_pdata;
154 uc_pdata = dev_get_uclass_platdata(dev);
156 ret = sandbox_dev_move_to_state(dev, sb_init);
158 debug("%s: called(%d)\n", uc_pdata->name, ret);
160 debug("%s init failed\n", uc_pdata->name);
166 * sandbox_testproc_reset() - Reset the remote processor
167 * @dev: device to operate upon
169 * Return: 0 if all went ok, else return appropriate error
171 static int sandbox_testproc_reset(struct udevice *dev)
173 struct dm_rproc_uclass_pdata *uc_pdata;
176 uc_pdata = dev_get_uclass_platdata(dev);
178 ret = sandbox_dev_move_to_state(dev, sb_reset);
180 debug("%s: called(%d)\n", uc_pdata->name, ret);
183 debug("%s reset failed\n", uc_pdata->name);
188 * sandbox_testproc_load() - (replace: short desc)
189 * @dev: device to operate upon
190 * @addr: Address of the binary image to load
191 * @size: Size (in bytes) of the binary image to load
193 * Return: 0 if all went ok, else return appropriate error
195 static int sandbox_testproc_load(struct udevice *dev, ulong addr, ulong size)
197 struct dm_rproc_uclass_pdata *uc_pdata;
200 uc_pdata = dev_get_uclass_platdata(dev);
202 ret = sandbox_dev_move_to_state(dev, sb_loaded);
204 debug("%s: called(%d) Loading to %08lX %lu size\n",
205 uc_pdata->name, ret, addr, size);
208 debug("%s load failed\n", uc_pdata->name);
213 * sandbox_testproc_start() - Start the remote processor
214 * @dev: device to operate upon
216 * Return: 0 if all went ok, else return appropriate error
218 static int sandbox_testproc_start(struct udevice *dev)
220 struct dm_rproc_uclass_pdata *uc_pdata;
223 uc_pdata = dev_get_uclass_platdata(dev);
225 ret = sandbox_dev_move_to_state(dev, sb_running);
227 debug("%s: called(%d)\n", uc_pdata->name, ret);
230 debug("%s start failed\n", uc_pdata->name);
235 * sandbox_testproc_stop() - Stop the remote processor
236 * @dev: device to operate upon
238 * Return: 0 if all went ok, else return appropriate error
240 static int sandbox_testproc_stop(struct udevice *dev)
242 struct dm_rproc_uclass_pdata *uc_pdata;
245 uc_pdata = dev_get_uclass_platdata(dev);
247 ret = sandbox_dev_move_to_state(dev, sb_init);
249 debug("%s: called(%d)\n", uc_pdata->name, ret);
252 debug("%s stop failed\n", uc_pdata->name);
257 * sandbox_testproc_is_running() - Check if remote processor is running
258 * @dev: device to operate upon
260 * Return: 0 if running, 1 if not running
262 static int sandbox_testproc_is_running(struct udevice *dev)
264 struct dm_rproc_uclass_pdata *uc_pdata;
265 struct sandbox_test_devdata *ddata;
268 uc_pdata = dev_get_uclass_platdata(dev);
269 ddata = dev_get_priv(dev);
271 if (ddata->current_state == sb_running)
273 debug("%s: called(%d)\n", uc_pdata->name, ret);
279 * sandbox_testproc_ping() - Try pinging remote processor
280 * @dev: device to operate upon
282 * Return: 0 if running, -EINVAL if not running
284 static int sandbox_testproc_ping(struct udevice *dev)
286 struct dm_rproc_uclass_pdata *uc_pdata;
287 struct sandbox_test_devdata *ddata;
290 uc_pdata = dev_get_uclass_platdata(dev);
291 ddata = dev_get_priv(dev);
293 if (ddata->current_state == sb_running)
298 debug("%s: called(%d)\n", uc_pdata->name, ret);
300 debug("%s: No response.(Not started?)\n", uc_pdata->name);
305 #define SANDBOX_RPROC_DEV_TO_PHY_OFFSET 0x1000
307 * sandbox_testproc_device_to_virt() - Convert device address to virtual address
308 * @dev: device to operate upon
309 * @da: device address
310 * @size: Size of the memory region @da is pointing to
311 * @return converted virtual address
313 static void *sandbox_testproc_device_to_virt(struct udevice *dev, ulong da,
318 /* Use a simple offset conversion */
319 paddr = da + SANDBOX_RPROC_DEV_TO_PHY_OFFSET;
321 return phys_to_virt(paddr);
324 static const struct dm_rproc_ops sandbox_testproc_ops = {
325 .init = sandbox_testproc_init,
326 .reset = sandbox_testproc_reset,
327 .load = sandbox_testproc_load,
328 .start = sandbox_testproc_start,
329 .stop = sandbox_testproc_stop,
330 .is_running = sandbox_testproc_is_running,
331 .ping = sandbox_testproc_ping,
332 .device_to_virt = sandbox_testproc_device_to_virt,
335 static const struct udevice_id sandbox_ids[] = {
336 {.compatible = "sandbox,test-processor"},
340 U_BOOT_DRIVER(sandbox_testproc) = {
341 .name = "sandbox_test_proc",
342 .of_match = sandbox_ids,
343 .id = UCLASS_REMOTEPROC,
344 .ops = &sandbox_testproc_ops,
345 .probe = sandbox_testproc_probe,
346 .priv_auto_alloc_size = sizeof(struct sandbox_test_devdata),
349 /* TODO(nm@ti.com): Remove this along with non-DT support */
350 static struct dm_rproc_uclass_pdata proc_3_test = {
351 .name = "proc_3_legacy",
352 .mem_type = RPROC_INTERNAL_MEMORY_MAPPED,
355 U_BOOT_DEVICE(proc_3_demo) = {
356 .name = "sandbox_test_proc",
357 .platdata = &proc_3_test,