1*83d290c5STom Rini // SPDX-License-Identifier: GPL-2.0+
23df0b8b4SNishanth Menon /*
33df0b8b4SNishanth Menon * (C) Copyright 2015
43df0b8b4SNishanth Menon * Texas Instruments Incorporated - http://www.ti.com/
53df0b8b4SNishanth Menon */
63df0b8b4SNishanth Menon #define pr_fmt(fmt) "%s: " fmt, __func__
73df0b8b4SNishanth Menon #include <common.h>
83df0b8b4SNishanth Menon #include <dm.h>
93df0b8b4SNishanth Menon #include <errno.h>
103df0b8b4SNishanth Menon #include <remoteproc.h>
113df0b8b4SNishanth Menon
123df0b8b4SNishanth Menon /**
133df0b8b4SNishanth Menon * enum sandbox_state - different device states
143df0b8b4SNishanth Menon * @sb_booted: Entry condition, just booted
153df0b8b4SNishanth Menon * @sb_init: Initialized (basic environment is ready)
163df0b8b4SNishanth Menon * @sb_reset: Held in reset (accessible, but not running)
173df0b8b4SNishanth Menon * @sb_loaded: Loaded with image (but not running)
183df0b8b4SNishanth Menon * @sb_running: Processor is running
193df0b8b4SNishanth Menon */
203df0b8b4SNishanth Menon enum sandbox_state {
213df0b8b4SNishanth Menon sb_booted,
223df0b8b4SNishanth Menon sb_init,
233df0b8b4SNishanth Menon sb_reset,
243df0b8b4SNishanth Menon sb_loaded,
253df0b8b4SNishanth Menon sb_running
263df0b8b4SNishanth Menon };
273df0b8b4SNishanth Menon
283df0b8b4SNishanth Menon /**
293df0b8b4SNishanth Menon * struct sandbox_test_devdata - private data per device
303df0b8b4SNishanth Menon * @current_state: device current state
313df0b8b4SNishanth Menon */
323df0b8b4SNishanth Menon struct sandbox_test_devdata {
333df0b8b4SNishanth Menon enum sandbox_state current_state;
343df0b8b4SNishanth Menon };
353df0b8b4SNishanth Menon
363df0b8b4SNishanth Menon /**
373df0b8b4SNishanth Menon * sandbox_dev_move_to_state() - statemachine for our dummy device
383df0b8b4SNishanth Menon * @dev: device to switch state
393df0b8b4SNishanth Menon * @next_state: next proposed state
403df0b8b4SNishanth Menon *
413df0b8b4SNishanth Menon * This tries to follow the following statemachine:
423df0b8b4SNishanth Menon * Entry
433df0b8b4SNishanth Menon * |
443df0b8b4SNishanth Menon * v
453df0b8b4SNishanth Menon * +-------+
463df0b8b4SNishanth Menon * +---+ init |
473df0b8b4SNishanth Menon * | | | <---------------------+
483df0b8b4SNishanth Menon * | +-------+ |
493df0b8b4SNishanth Menon * | |
503df0b8b4SNishanth Menon * | |
513df0b8b4SNishanth Menon * | +--------+ |
523df0b8b4SNishanth Menon * Load| | reset | |
533df0b8b4SNishanth Menon * | | | <----------+ |
543df0b8b4SNishanth Menon * | +--------+ | |
553df0b8b4SNishanth Menon * | |Load | |
563df0b8b4SNishanth Menon * | | | |
573df0b8b4SNishanth Menon * | +----v----+ reset | |
583df0b8b4SNishanth Menon * +-> | | (opt) | |
593df0b8b4SNishanth Menon * | Loaded +-----------+ |
603df0b8b4SNishanth Menon * | | |
613df0b8b4SNishanth Menon * +----+----+ |
623df0b8b4SNishanth Menon * | Start |
633df0b8b4SNishanth Menon * +---v-----+ (opt) |
643df0b8b4SNishanth Menon * +->| Running | Stop |
653df0b8b4SNishanth Menon * Ping +- | +--------------------+
663df0b8b4SNishanth Menon * (opt) +---------+
673df0b8b4SNishanth Menon *
683df0b8b4SNishanth Menon * (is_running does not change state)
693df0b8b4SNishanth Menon *
703df0b8b4SNishanth Menon * Return: 0 when valid state transition is seen, else returns -EINVAL
713df0b8b4SNishanth Menon */
sandbox_dev_move_to_state(struct udevice * dev,enum sandbox_state next_state)723df0b8b4SNishanth Menon static int sandbox_dev_move_to_state(struct udevice *dev,
733df0b8b4SNishanth Menon enum sandbox_state next_state)
743df0b8b4SNishanth Menon {
753df0b8b4SNishanth Menon struct sandbox_test_devdata *ddata = dev_get_priv(dev);
763df0b8b4SNishanth Menon
773df0b8b4SNishanth Menon /* No state transition is OK */
783df0b8b4SNishanth Menon if (ddata->current_state == next_state)
793df0b8b4SNishanth Menon return 0;
803df0b8b4SNishanth Menon
813df0b8b4SNishanth Menon debug("current_state=%d, next_state=%d\n", ddata->current_state,
823df0b8b4SNishanth Menon next_state);
833df0b8b4SNishanth Menon switch (ddata->current_state) {
843df0b8b4SNishanth Menon case sb_booted:
853df0b8b4SNishanth Menon if (next_state == sb_init)
863df0b8b4SNishanth Menon goto ok_state;
873df0b8b4SNishanth Menon break;
883df0b8b4SNishanth Menon
893df0b8b4SNishanth Menon case sb_init:
903df0b8b4SNishanth Menon if (next_state == sb_reset || next_state == sb_loaded)
913df0b8b4SNishanth Menon goto ok_state;
923df0b8b4SNishanth Menon break;
933df0b8b4SNishanth Menon
943df0b8b4SNishanth Menon case sb_reset:
953df0b8b4SNishanth Menon if (next_state == sb_loaded || next_state == sb_init)
963df0b8b4SNishanth Menon goto ok_state;
973df0b8b4SNishanth Menon break;
983df0b8b4SNishanth Menon
993df0b8b4SNishanth Menon case sb_loaded:
1003df0b8b4SNishanth Menon if (next_state == sb_reset || next_state == sb_init ||
1013df0b8b4SNishanth Menon next_state == sb_running)
1023df0b8b4SNishanth Menon goto ok_state;
1033df0b8b4SNishanth Menon break;
1043df0b8b4SNishanth Menon
1053df0b8b4SNishanth Menon case sb_running:
1063df0b8b4SNishanth Menon if (next_state == sb_reset || next_state == sb_init)
1073df0b8b4SNishanth Menon goto ok_state;
1083df0b8b4SNishanth Menon break;
1093df0b8b4SNishanth Menon };
1103df0b8b4SNishanth Menon return -EINVAL;
1113df0b8b4SNishanth Menon
1123df0b8b4SNishanth Menon ok_state:
1133df0b8b4SNishanth Menon ddata->current_state = next_state;
1143df0b8b4SNishanth Menon return 0;
1153df0b8b4SNishanth Menon }
1163df0b8b4SNishanth Menon
1173df0b8b4SNishanth Menon /**
1183df0b8b4SNishanth Menon * sandbox_testproc_probe() - basic probe function
1193df0b8b4SNishanth Menon * @dev: test proc device that is being probed.
1203df0b8b4SNishanth Menon *
1213df0b8b4SNishanth Menon * Return: 0 if all went ok, else return appropriate error
1223df0b8b4SNishanth Menon */
sandbox_testproc_probe(struct udevice * dev)1233df0b8b4SNishanth Menon static int sandbox_testproc_probe(struct udevice *dev)
1243df0b8b4SNishanth Menon {
1253df0b8b4SNishanth Menon struct dm_rproc_uclass_pdata *uc_pdata;
1263df0b8b4SNishanth Menon struct sandbox_test_devdata *ddata;
1273df0b8b4SNishanth Menon int ret;
1283df0b8b4SNishanth Menon
1293df0b8b4SNishanth Menon uc_pdata = dev_get_uclass_platdata(dev);
1303df0b8b4SNishanth Menon ddata = dev_get_priv(dev);
1313df0b8b4SNishanth Menon if (!ddata) {
1323df0b8b4SNishanth Menon debug("%s: platform private data missing\n", uc_pdata->name);
1333df0b8b4SNishanth Menon return -EINVAL;
1343df0b8b4SNishanth Menon }
1353df0b8b4SNishanth Menon ret = sandbox_dev_move_to_state(dev, sb_booted);
1363df0b8b4SNishanth Menon debug("%s: called(%d)\n", uc_pdata->name, ret);
1373df0b8b4SNishanth Menon
1383df0b8b4SNishanth Menon return ret;
1393df0b8b4SNishanth Menon }
1403df0b8b4SNishanth Menon
1413df0b8b4SNishanth Menon /**
1423df0b8b4SNishanth Menon * sandbox_testproc_init() - Simple initialization function
1433df0b8b4SNishanth Menon * @dev: device to operate upon
1443df0b8b4SNishanth Menon *
1453df0b8b4SNishanth Menon * Return: 0 if all went ok, else return appropriate error
1463df0b8b4SNishanth Menon */
sandbox_testproc_init(struct udevice * dev)1473df0b8b4SNishanth Menon static int sandbox_testproc_init(struct udevice *dev)
1483df0b8b4SNishanth Menon {
1493df0b8b4SNishanth Menon struct dm_rproc_uclass_pdata *uc_pdata;
1503df0b8b4SNishanth Menon int ret;
1513df0b8b4SNishanth Menon
1523df0b8b4SNishanth Menon uc_pdata = dev_get_uclass_platdata(dev);
1533df0b8b4SNishanth Menon
1543df0b8b4SNishanth Menon ret = sandbox_dev_move_to_state(dev, sb_init);
1553df0b8b4SNishanth Menon
1563df0b8b4SNishanth Menon debug("%s: called(%d)\n", uc_pdata->name, ret);
1573df0b8b4SNishanth Menon if (ret)
1583df0b8b4SNishanth Menon debug("%s init failed\n", uc_pdata->name);
1593df0b8b4SNishanth Menon
1603df0b8b4SNishanth Menon return ret;
1613df0b8b4SNishanth Menon }
1623df0b8b4SNishanth Menon
1633df0b8b4SNishanth Menon /**
1643df0b8b4SNishanth Menon * sandbox_testproc_reset() - Reset the remote processor
1653df0b8b4SNishanth Menon * @dev: device to operate upon
1663df0b8b4SNishanth Menon *
1673df0b8b4SNishanth Menon * Return: 0 if all went ok, else return appropriate error
1683df0b8b4SNishanth Menon */
sandbox_testproc_reset(struct udevice * dev)1693df0b8b4SNishanth Menon static int sandbox_testproc_reset(struct udevice *dev)
1703df0b8b4SNishanth Menon {
1713df0b8b4SNishanth Menon struct dm_rproc_uclass_pdata *uc_pdata;
1723df0b8b4SNishanth Menon int ret;
1733df0b8b4SNishanth Menon
1743df0b8b4SNishanth Menon uc_pdata = dev_get_uclass_platdata(dev);
1753df0b8b4SNishanth Menon
1763df0b8b4SNishanth Menon ret = sandbox_dev_move_to_state(dev, sb_reset);
1773df0b8b4SNishanth Menon
1783df0b8b4SNishanth Menon debug("%s: called(%d)\n", uc_pdata->name, ret);
1793df0b8b4SNishanth Menon
1803df0b8b4SNishanth Menon if (ret)
1813df0b8b4SNishanth Menon debug("%s reset failed\n", uc_pdata->name);
1823df0b8b4SNishanth Menon return ret;
1833df0b8b4SNishanth Menon }
1843df0b8b4SNishanth Menon
1853df0b8b4SNishanth Menon /**
1863df0b8b4SNishanth Menon * sandbox_testproc_load() - (replace: short desc)
1873df0b8b4SNishanth Menon * @dev: device to operate upon
1883df0b8b4SNishanth Menon * @addr: Address of the binary image to load
1893df0b8b4SNishanth Menon * @size: Size (in bytes) of the binary image to load
1903df0b8b4SNishanth Menon *
1913df0b8b4SNishanth Menon * Return: 0 if all went ok, else return appropriate error
1923df0b8b4SNishanth Menon */
sandbox_testproc_load(struct udevice * dev,ulong addr,ulong size)1933df0b8b4SNishanth Menon static int sandbox_testproc_load(struct udevice *dev, ulong addr, ulong size)
1943df0b8b4SNishanth Menon {
1953df0b8b4SNishanth Menon struct dm_rproc_uclass_pdata *uc_pdata;
1963df0b8b4SNishanth Menon int ret;
1973df0b8b4SNishanth Menon
1983df0b8b4SNishanth Menon uc_pdata = dev_get_uclass_platdata(dev);
1993df0b8b4SNishanth Menon
2003df0b8b4SNishanth Menon ret = sandbox_dev_move_to_state(dev, sb_loaded);
2013df0b8b4SNishanth Menon
2023df0b8b4SNishanth Menon debug("%s: called(%d) Loading to %08lX %lu size\n",
2033df0b8b4SNishanth Menon uc_pdata->name, ret, addr, size);
2043df0b8b4SNishanth Menon
2053df0b8b4SNishanth Menon if (ret)
2063df0b8b4SNishanth Menon debug("%s load failed\n", uc_pdata->name);
2073df0b8b4SNishanth Menon return ret;
2083df0b8b4SNishanth Menon }
2093df0b8b4SNishanth Menon
2103df0b8b4SNishanth Menon /**
2113df0b8b4SNishanth Menon * sandbox_testproc_start() - Start the remote processor
2123df0b8b4SNishanth Menon * @dev: device to operate upon
2133df0b8b4SNishanth Menon *
2143df0b8b4SNishanth Menon * Return: 0 if all went ok, else return appropriate error
2153df0b8b4SNishanth Menon */
sandbox_testproc_start(struct udevice * dev)2163df0b8b4SNishanth Menon static int sandbox_testproc_start(struct udevice *dev)
2173df0b8b4SNishanth Menon {
2183df0b8b4SNishanth Menon struct dm_rproc_uclass_pdata *uc_pdata;
2193df0b8b4SNishanth Menon int ret;
2203df0b8b4SNishanth Menon
2213df0b8b4SNishanth Menon uc_pdata = dev_get_uclass_platdata(dev);
2223df0b8b4SNishanth Menon
2233df0b8b4SNishanth Menon ret = sandbox_dev_move_to_state(dev, sb_running);
2243df0b8b4SNishanth Menon
2253df0b8b4SNishanth Menon debug("%s: called(%d)\n", uc_pdata->name, ret);
2263df0b8b4SNishanth Menon
2273df0b8b4SNishanth Menon if (ret)
2283df0b8b4SNishanth Menon debug("%s start failed\n", uc_pdata->name);
2293df0b8b4SNishanth Menon return ret;
2303df0b8b4SNishanth Menon }
2313df0b8b4SNishanth Menon
2323df0b8b4SNishanth Menon /**
2333df0b8b4SNishanth Menon * sandbox_testproc_stop() - Stop the remote processor
2343df0b8b4SNishanth Menon * @dev: device to operate upon
2353df0b8b4SNishanth Menon *
2363df0b8b4SNishanth Menon * Return: 0 if all went ok, else return appropriate error
2373df0b8b4SNishanth Menon */
sandbox_testproc_stop(struct udevice * dev)2383df0b8b4SNishanth Menon static int sandbox_testproc_stop(struct udevice *dev)
2393df0b8b4SNishanth Menon {
2403df0b8b4SNishanth Menon struct dm_rproc_uclass_pdata *uc_pdata;
2413df0b8b4SNishanth Menon int ret;
2423df0b8b4SNishanth Menon
2433df0b8b4SNishanth Menon uc_pdata = dev_get_uclass_platdata(dev);
2443df0b8b4SNishanth Menon
2453df0b8b4SNishanth Menon ret = sandbox_dev_move_to_state(dev, sb_init);
2463df0b8b4SNishanth Menon
2473df0b8b4SNishanth Menon debug("%s: called(%d)\n", uc_pdata->name, ret);
2483df0b8b4SNishanth Menon
2493df0b8b4SNishanth Menon if (ret)
2503df0b8b4SNishanth Menon debug("%s stop failed\n", uc_pdata->name);
2513df0b8b4SNishanth Menon return ret;
2523df0b8b4SNishanth Menon }
2533df0b8b4SNishanth Menon
2543df0b8b4SNishanth Menon /**
2553df0b8b4SNishanth Menon * sandbox_testproc_is_running() - Check if remote processor is running
2563df0b8b4SNishanth Menon * @dev: device to operate upon
2573df0b8b4SNishanth Menon *
2583df0b8b4SNishanth Menon * Return: 0 if running, 1 if not running
2593df0b8b4SNishanth Menon */
sandbox_testproc_is_running(struct udevice * dev)2603df0b8b4SNishanth Menon static int sandbox_testproc_is_running(struct udevice *dev)
2613df0b8b4SNishanth Menon {
2623df0b8b4SNishanth Menon struct dm_rproc_uclass_pdata *uc_pdata;
2633df0b8b4SNishanth Menon struct sandbox_test_devdata *ddata;
2643df0b8b4SNishanth Menon int ret = 1;
2653df0b8b4SNishanth Menon
2663df0b8b4SNishanth Menon uc_pdata = dev_get_uclass_platdata(dev);
2673df0b8b4SNishanth Menon ddata = dev_get_priv(dev);
2683df0b8b4SNishanth Menon
2693df0b8b4SNishanth Menon if (ddata->current_state == sb_running)
2703df0b8b4SNishanth Menon ret = 0;
2713df0b8b4SNishanth Menon debug("%s: called(%d)\n", uc_pdata->name, ret);
2723df0b8b4SNishanth Menon
2733df0b8b4SNishanth Menon return ret;
2743df0b8b4SNishanth Menon }
2753df0b8b4SNishanth Menon
2763df0b8b4SNishanth Menon /**
2773df0b8b4SNishanth Menon * sandbox_testproc_ping() - Try pinging remote processor
2783df0b8b4SNishanth Menon * @dev: device to operate upon
2793df0b8b4SNishanth Menon *
2803df0b8b4SNishanth Menon * Return: 0 if running, -EINVAL if not running
2813df0b8b4SNishanth Menon */
sandbox_testproc_ping(struct udevice * dev)2823df0b8b4SNishanth Menon static int sandbox_testproc_ping(struct udevice *dev)
2833df0b8b4SNishanth Menon {
2843df0b8b4SNishanth Menon struct dm_rproc_uclass_pdata *uc_pdata;
2853df0b8b4SNishanth Menon struct sandbox_test_devdata *ddata;
2863df0b8b4SNishanth Menon int ret;
2873df0b8b4SNishanth Menon
2883df0b8b4SNishanth Menon uc_pdata = dev_get_uclass_platdata(dev);
2893df0b8b4SNishanth Menon ddata = dev_get_priv(dev);
2903df0b8b4SNishanth Menon
2913df0b8b4SNishanth Menon if (ddata->current_state == sb_running)
2923df0b8b4SNishanth Menon ret = 0;
2933df0b8b4SNishanth Menon else
2943df0b8b4SNishanth Menon ret = -EINVAL;
2953df0b8b4SNishanth Menon
2963df0b8b4SNishanth Menon debug("%s: called(%d)\n", uc_pdata->name, ret);
2973df0b8b4SNishanth Menon if (ret)
2983df0b8b4SNishanth Menon debug("%s: No response.(Not started?)\n", uc_pdata->name);
2993df0b8b4SNishanth Menon
3003df0b8b4SNishanth Menon return ret;
3013df0b8b4SNishanth Menon }
3023df0b8b4SNishanth Menon
3033df0b8b4SNishanth Menon static const struct dm_rproc_ops sandbox_testproc_ops = {
3043df0b8b4SNishanth Menon .init = sandbox_testproc_init,
3053df0b8b4SNishanth Menon .reset = sandbox_testproc_reset,
3063df0b8b4SNishanth Menon .load = sandbox_testproc_load,
3073df0b8b4SNishanth Menon .start = sandbox_testproc_start,
3083df0b8b4SNishanth Menon .stop = sandbox_testproc_stop,
3093df0b8b4SNishanth Menon .is_running = sandbox_testproc_is_running,
3103df0b8b4SNishanth Menon .ping = sandbox_testproc_ping,
3113df0b8b4SNishanth Menon };
3123df0b8b4SNishanth Menon
3133df0b8b4SNishanth Menon static const struct udevice_id sandbox_ids[] = {
3143df0b8b4SNishanth Menon {.compatible = "sandbox,test-processor"},
3153df0b8b4SNishanth Menon {}
3163df0b8b4SNishanth Menon };
3173df0b8b4SNishanth Menon
3183df0b8b4SNishanth Menon U_BOOT_DRIVER(sandbox_testproc) = {
3193df0b8b4SNishanth Menon .name = "sandbox_test_proc",
3203df0b8b4SNishanth Menon .of_match = sandbox_ids,
3213df0b8b4SNishanth Menon .id = UCLASS_REMOTEPROC,
3223df0b8b4SNishanth Menon .ops = &sandbox_testproc_ops,
3233df0b8b4SNishanth Menon .probe = sandbox_testproc_probe,
3243df0b8b4SNishanth Menon .priv_auto_alloc_size = sizeof(struct sandbox_test_devdata),
3253df0b8b4SNishanth Menon };
3263df0b8b4SNishanth Menon
3273df0b8b4SNishanth Menon /* TODO(nm@ti.com): Remove this along with non-DT support */
3283df0b8b4SNishanth Menon static struct dm_rproc_uclass_pdata proc_3_test = {
3293df0b8b4SNishanth Menon .name = "proc_3_legacy",
3303df0b8b4SNishanth Menon .mem_type = RPROC_INTERNAL_MEMORY_MAPPED,
3313df0b8b4SNishanth Menon };
3323df0b8b4SNishanth Menon
3333df0b8b4SNishanth Menon U_BOOT_DEVICE(proc_3_demo) = {
3343df0b8b4SNishanth Menon .name = "sandbox_test_proc",
3353df0b8b4SNishanth Menon .platdata = &proc_3_test,
3363df0b8b4SNishanth Menon };
337