1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments Incorporated - http://www.ti.com/
6 #define pr_fmt(fmt) "%s: " fmt, __func__
10 #include <remoteproc.h>
14 * enum sandbox_state - different device states
15 * @sb_booted: Entry condition, just booted
16 * @sb_init: Initialized (basic environment is ready)
17 * @sb_reset: Held in reset (accessible, but not running)
18 * @sb_loaded: Loaded with image (but not running)
19 * @sb_running: Processor is running
30 * struct sandbox_test_devdata - private data per device
31 * @current_state: device current state
33 struct sandbox_test_devdata {
34 enum sandbox_state current_state;
38 * sandbox_dev_move_to_state() - statemachine for our dummy device
39 * @dev: device to switch state
40 * @next_state: next proposed state
42 * This tries to follow the following statemachine:
48 * | | | <---------------------+
54 * | | | <----------+ |
58 * | +----v----+ reset | |
60 * | Loaded +-----------+ |
65 * +->| Running | Stop |
66 * Ping +- | +--------------------+
69 * (is_running does not change state)
71 * Return: 0 when valid state transition is seen, else returns -EINVAL
73 static int sandbox_dev_move_to_state(struct udevice *dev,
74 enum sandbox_state next_state)
76 struct sandbox_test_devdata *ddata = dev_get_priv(dev);
78 /* No state transition is OK */
79 if (ddata->current_state == next_state)
82 debug("current_state=%d, next_state=%d\n", ddata->current_state,
84 switch (ddata->current_state) {
86 if (next_state == sb_init)
91 if (next_state == sb_reset || next_state == sb_loaded)
96 if (next_state == sb_loaded || next_state == sb_init)
101 if (next_state == sb_reset || next_state == sb_init ||
102 next_state == sb_running)
107 if (next_state == sb_reset || next_state == sb_init)
114 ddata->current_state = next_state;
119 * sandbox_testproc_probe() - basic probe function
120 * @dev: test proc device that is being probed.
122 * Return: 0 if all went ok, else return appropriate error
124 static int sandbox_testproc_probe(struct udevice *dev)
126 struct dm_rproc_uclass_pdata *uc_pdata;
127 struct sandbox_test_devdata *ddata;
130 uc_pdata = dev_get_uclass_platdata(dev);
131 ddata = dev_get_priv(dev);
133 debug("%s: platform private data missing\n", uc_pdata->name);
136 ret = sandbox_dev_move_to_state(dev, sb_booted);
137 debug("%s: called(%d)\n", uc_pdata->name, ret);
143 * sandbox_testproc_init() - Simple initialization function
144 * @dev: device to operate upon
146 * Return: 0 if all went ok, else return appropriate error
148 static int sandbox_testproc_init(struct udevice *dev)
150 struct dm_rproc_uclass_pdata *uc_pdata;
153 uc_pdata = dev_get_uclass_platdata(dev);
155 ret = sandbox_dev_move_to_state(dev, sb_init);
157 debug("%s: called(%d)\n", uc_pdata->name, ret);
159 debug("%s init failed\n", uc_pdata->name);
165 * sandbox_testproc_reset() - Reset the remote processor
166 * @dev: device to operate upon
168 * Return: 0 if all went ok, else return appropriate error
170 static int sandbox_testproc_reset(struct udevice *dev)
172 struct dm_rproc_uclass_pdata *uc_pdata;
175 uc_pdata = dev_get_uclass_platdata(dev);
177 ret = sandbox_dev_move_to_state(dev, sb_reset);
179 debug("%s: called(%d)\n", uc_pdata->name, ret);
182 debug("%s reset failed\n", uc_pdata->name);
187 * sandbox_testproc_load() - (replace: short desc)
188 * @dev: device to operate upon
189 * @addr: Address of the binary image to load
190 * @size: Size (in bytes) of the binary image to load
192 * Return: 0 if all went ok, else return appropriate error
194 static int sandbox_testproc_load(struct udevice *dev, ulong addr, ulong size)
196 struct dm_rproc_uclass_pdata *uc_pdata;
199 uc_pdata = dev_get_uclass_platdata(dev);
201 ret = sandbox_dev_move_to_state(dev, sb_loaded);
203 debug("%s: called(%d) Loading to %08lX %lu size\n",
204 uc_pdata->name, ret, addr, size);
207 debug("%s load failed\n", uc_pdata->name);
212 * sandbox_testproc_start() - Start the remote processor
213 * @dev: device to operate upon
215 * Return: 0 if all went ok, else return appropriate error
217 static int sandbox_testproc_start(struct udevice *dev)
219 struct dm_rproc_uclass_pdata *uc_pdata;
222 uc_pdata = dev_get_uclass_platdata(dev);
224 ret = sandbox_dev_move_to_state(dev, sb_running);
226 debug("%s: called(%d)\n", uc_pdata->name, ret);
229 debug("%s start failed\n", uc_pdata->name);
234 * sandbox_testproc_stop() - Stop the remote processor
235 * @dev: device to operate upon
237 * Return: 0 if all went ok, else return appropriate error
239 static int sandbox_testproc_stop(struct udevice *dev)
241 struct dm_rproc_uclass_pdata *uc_pdata;
244 uc_pdata = dev_get_uclass_platdata(dev);
246 ret = sandbox_dev_move_to_state(dev, sb_init);
248 debug("%s: called(%d)\n", uc_pdata->name, ret);
251 debug("%s stop failed\n", uc_pdata->name);
256 * sandbox_testproc_is_running() - Check if remote processor is running
257 * @dev: device to operate upon
259 * Return: 0 if running, 1 if not running
261 static int sandbox_testproc_is_running(struct udevice *dev)
263 struct dm_rproc_uclass_pdata *uc_pdata;
264 struct sandbox_test_devdata *ddata;
267 uc_pdata = dev_get_uclass_platdata(dev);
268 ddata = dev_get_priv(dev);
270 if (ddata->current_state == sb_running)
272 debug("%s: called(%d)\n", uc_pdata->name, ret);
278 * sandbox_testproc_ping() - Try pinging remote processor
279 * @dev: device to operate upon
281 * Return: 0 if running, -EINVAL if not running
283 static int sandbox_testproc_ping(struct udevice *dev)
285 struct dm_rproc_uclass_pdata *uc_pdata;
286 struct sandbox_test_devdata *ddata;
289 uc_pdata = dev_get_uclass_platdata(dev);
290 ddata = dev_get_priv(dev);
292 if (ddata->current_state == sb_running)
297 debug("%s: called(%d)\n", uc_pdata->name, ret);
299 debug("%s: No response.(Not started?)\n", uc_pdata->name);
304 #define SANDBOX_RPROC_DEV_TO_PHY_OFFSET 0x1000
306 * sandbox_testproc_device_to_virt() - Convert device address to virtual address
307 * @dev: device to operate upon
308 * @da: device address
309 * @return converted virtual address
311 static void *sandbox_testproc_device_to_virt(struct udevice *dev, ulong da)
315 /* Use a simple offset conversion */
316 paddr = da + SANDBOX_RPROC_DEV_TO_PHY_OFFSET;
318 return phys_to_virt(paddr);
321 static const struct dm_rproc_ops sandbox_testproc_ops = {
322 .init = sandbox_testproc_init,
323 .reset = sandbox_testproc_reset,
324 .load = sandbox_testproc_load,
325 .start = sandbox_testproc_start,
326 .stop = sandbox_testproc_stop,
327 .is_running = sandbox_testproc_is_running,
328 .ping = sandbox_testproc_ping,
329 .device_to_virt = sandbox_testproc_device_to_virt,
332 static const struct udevice_id sandbox_ids[] = {
333 {.compatible = "sandbox,test-processor"},
337 U_BOOT_DRIVER(sandbox_testproc) = {
338 .name = "sandbox_test_proc",
339 .of_match = sandbox_ids,
340 .id = UCLASS_REMOTEPROC,
341 .ops = &sandbox_testproc_ops,
342 .probe = sandbox_testproc_probe,
343 .priv_auto_alloc_size = sizeof(struct sandbox_test_devdata),
346 /* TODO(nm@ti.com): Remove this along with non-DT support */
347 static struct dm_rproc_uclass_pdata proc_3_test = {
348 .name = "proc_3_legacy",
349 .mem_type = RPROC_INTERNAL_MEMORY_MAPPED,
352 U_BOOT_DEVICE(proc_3_demo) = {
353 .name = "sandbox_test_proc",
354 .platdata = &proc_3_test,