sandbox_testproc.c 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * (C) Copyright 2015
  4. * Texas Instruments Incorporated - http://www.ti.com/
  5. */
  6. #define pr_fmt(fmt) "%s: " fmt, __func__
  7. #include <common.h>
  8. #include <dm.h>
  9. #include <errno.h>
  10. #include <log.h>
  11. #include <remoteproc.h>
  12. #include <asm/io.h>
  13. /**
  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
  20. */
  21. enum sandbox_state {
  22. sb_booted,
  23. sb_init,
  24. sb_reset,
  25. sb_loaded,
  26. sb_running
  27. };
  28. /**
  29. * struct sandbox_test_devdata - private data per device
  30. * @current_state: device current state
  31. */
  32. struct sandbox_test_devdata {
  33. enum sandbox_state current_state;
  34. };
  35. /**
  36. * sandbox_dev_move_to_state() - statemachine for our dummy device
  37. * @dev: device to switch state
  38. * @next_state: next proposed state
  39. *
  40. * This tries to follow the following statemachine:
  41. * Entry
  42. * |
  43. * v
  44. * +-------+
  45. * +---+ init |
  46. * | | | <---------------------+
  47. * | +-------+ |
  48. * | |
  49. * | |
  50. * | +--------+ |
  51. * Load| | reset | |
  52. * | | | <----------+ |
  53. * | +--------+ | |
  54. * | |Load | |
  55. * | | | |
  56. * | +----v----+ reset | |
  57. * +-> | | (opt) | |
  58. * | Loaded +-----------+ |
  59. * | | |
  60. * +----+----+ |
  61. * | Start |
  62. * +---v-----+ (opt) |
  63. * +->| Running | Stop |
  64. * Ping +- | +--------------------+
  65. * (opt) +---------+
  66. *
  67. * (is_running does not change state)
  68. *
  69. * Return: 0 when valid state transition is seen, else returns -EINVAL
  70. */
  71. static int sandbox_dev_move_to_state(struct udevice *dev,
  72. enum sandbox_state next_state)
  73. {
  74. struct sandbox_test_devdata *ddata = dev_get_priv(dev);
  75. /* No state transition is OK */
  76. if (ddata->current_state == next_state)
  77. return 0;
  78. debug("current_state=%d, next_state=%d\n", ddata->current_state,
  79. next_state);
  80. switch (ddata->current_state) {
  81. case sb_booted:
  82. if (next_state == sb_init)
  83. goto ok_state;
  84. break;
  85. case sb_init:
  86. if (next_state == sb_reset || next_state == sb_loaded)
  87. goto ok_state;
  88. break;
  89. case sb_reset:
  90. if (next_state == sb_loaded || next_state == sb_init)
  91. goto ok_state;
  92. break;
  93. case sb_loaded:
  94. if (next_state == sb_reset || next_state == sb_init ||
  95. next_state == sb_running)
  96. goto ok_state;
  97. break;
  98. case sb_running:
  99. if (next_state == sb_reset || next_state == sb_init)
  100. goto ok_state;
  101. break;
  102. };
  103. return -EINVAL;
  104. ok_state:
  105. ddata->current_state = next_state;
  106. return 0;
  107. }
  108. /**
  109. * sandbox_testproc_probe() - basic probe function
  110. * @dev: test proc device that is being probed.
  111. *
  112. * Return: 0 if all went ok, else return appropriate error
  113. */
  114. static int sandbox_testproc_probe(struct udevice *dev)
  115. {
  116. struct dm_rproc_uclass_pdata *uc_pdata;
  117. struct sandbox_test_devdata *ddata;
  118. int ret;
  119. uc_pdata = dev_get_uclass_platdata(dev);
  120. ddata = dev_get_priv(dev);
  121. if (!ddata) {
  122. debug("%s: platform private data missing\n", uc_pdata->name);
  123. return -EINVAL;
  124. }
  125. ret = sandbox_dev_move_to_state(dev, sb_booted);
  126. debug("%s: called(%d)\n", uc_pdata->name, ret);
  127. return ret;
  128. }
  129. /**
  130. * sandbox_testproc_init() - Simple initialization function
  131. * @dev: device to operate upon
  132. *
  133. * Return: 0 if all went ok, else return appropriate error
  134. */
  135. static int sandbox_testproc_init(struct udevice *dev)
  136. {
  137. struct dm_rproc_uclass_pdata *uc_pdata;
  138. int ret;
  139. uc_pdata = dev_get_uclass_platdata(dev);
  140. ret = sandbox_dev_move_to_state(dev, sb_init);
  141. debug("%s: called(%d)\n", uc_pdata->name, ret);
  142. if (ret)
  143. debug("%s init failed\n", uc_pdata->name);
  144. return ret;
  145. }
  146. /**
  147. * sandbox_testproc_reset() - Reset the remote processor
  148. * @dev: device to operate upon
  149. *
  150. * Return: 0 if all went ok, else return appropriate error
  151. */
  152. static int sandbox_testproc_reset(struct udevice *dev)
  153. {
  154. struct dm_rproc_uclass_pdata *uc_pdata;
  155. int ret;
  156. uc_pdata = dev_get_uclass_platdata(dev);
  157. ret = sandbox_dev_move_to_state(dev, sb_reset);
  158. debug("%s: called(%d)\n", uc_pdata->name, ret);
  159. if (ret)
  160. debug("%s reset failed\n", uc_pdata->name);
  161. return ret;
  162. }
  163. /**
  164. * sandbox_testproc_load() - (replace: short desc)
  165. * @dev: device to operate upon
  166. * @addr: Address of the binary image to load
  167. * @size: Size (in bytes) of the binary image to load
  168. *
  169. * Return: 0 if all went ok, else return appropriate error
  170. */
  171. static int sandbox_testproc_load(struct udevice *dev, ulong addr, ulong size)
  172. {
  173. struct dm_rproc_uclass_pdata *uc_pdata;
  174. int ret;
  175. uc_pdata = dev_get_uclass_platdata(dev);
  176. ret = sandbox_dev_move_to_state(dev, sb_loaded);
  177. debug("%s: called(%d) Loading to %08lX %lu size\n",
  178. uc_pdata->name, ret, addr, size);
  179. if (ret)
  180. debug("%s load failed\n", uc_pdata->name);
  181. return ret;
  182. }
  183. /**
  184. * sandbox_testproc_start() - Start the remote processor
  185. * @dev: device to operate upon
  186. *
  187. * Return: 0 if all went ok, else return appropriate error
  188. */
  189. static int sandbox_testproc_start(struct udevice *dev)
  190. {
  191. struct dm_rproc_uclass_pdata *uc_pdata;
  192. int ret;
  193. uc_pdata = dev_get_uclass_platdata(dev);
  194. ret = sandbox_dev_move_to_state(dev, sb_running);
  195. debug("%s: called(%d)\n", uc_pdata->name, ret);
  196. if (ret)
  197. debug("%s start failed\n", uc_pdata->name);
  198. return ret;
  199. }
  200. /**
  201. * sandbox_testproc_stop() - Stop the remote processor
  202. * @dev: device to operate upon
  203. *
  204. * Return: 0 if all went ok, else return appropriate error
  205. */
  206. static int sandbox_testproc_stop(struct udevice *dev)
  207. {
  208. struct dm_rproc_uclass_pdata *uc_pdata;
  209. int ret;
  210. uc_pdata = dev_get_uclass_platdata(dev);
  211. ret = sandbox_dev_move_to_state(dev, sb_init);
  212. debug("%s: called(%d)\n", uc_pdata->name, ret);
  213. if (ret)
  214. debug("%s stop failed\n", uc_pdata->name);
  215. return ret;
  216. }
  217. /**
  218. * sandbox_testproc_is_running() - Check if remote processor is running
  219. * @dev: device to operate upon
  220. *
  221. * Return: 0 if running, 1 if not running
  222. */
  223. static int sandbox_testproc_is_running(struct udevice *dev)
  224. {
  225. struct dm_rproc_uclass_pdata *uc_pdata;
  226. struct sandbox_test_devdata *ddata;
  227. int ret = 1;
  228. uc_pdata = dev_get_uclass_platdata(dev);
  229. ddata = dev_get_priv(dev);
  230. if (ddata->current_state == sb_running)
  231. ret = 0;
  232. debug("%s: called(%d)\n", uc_pdata->name, ret);
  233. return ret;
  234. }
  235. /**
  236. * sandbox_testproc_ping() - Try pinging remote processor
  237. * @dev: device to operate upon
  238. *
  239. * Return: 0 if running, -EINVAL if not running
  240. */
  241. static int sandbox_testproc_ping(struct udevice *dev)
  242. {
  243. struct dm_rproc_uclass_pdata *uc_pdata;
  244. struct sandbox_test_devdata *ddata;
  245. int ret;
  246. uc_pdata = dev_get_uclass_platdata(dev);
  247. ddata = dev_get_priv(dev);
  248. if (ddata->current_state == sb_running)
  249. ret = 0;
  250. else
  251. ret = -EINVAL;
  252. debug("%s: called(%d)\n", uc_pdata->name, ret);
  253. if (ret)
  254. debug("%s: No response.(Not started?)\n", uc_pdata->name);
  255. return ret;
  256. }
  257. #define SANDBOX_RPROC_DEV_TO_PHY_OFFSET 0x1000
  258. /**
  259. * sandbox_testproc_device_to_virt() - Convert device address to virtual address
  260. * @dev: device to operate upon
  261. * @da: device address
  262. * @size: Size of the memory region @da is pointing to
  263. * @return converted virtual address
  264. */
  265. static void *sandbox_testproc_device_to_virt(struct udevice *dev, ulong da,
  266. ulong size)
  267. {
  268. u64 paddr;
  269. /* Use a simple offset conversion */
  270. paddr = da + SANDBOX_RPROC_DEV_TO_PHY_OFFSET;
  271. return phys_to_virt(paddr);
  272. }
  273. static const struct dm_rproc_ops sandbox_testproc_ops = {
  274. .init = sandbox_testproc_init,
  275. .reset = sandbox_testproc_reset,
  276. .load = sandbox_testproc_load,
  277. .start = sandbox_testproc_start,
  278. .stop = sandbox_testproc_stop,
  279. .is_running = sandbox_testproc_is_running,
  280. .ping = sandbox_testproc_ping,
  281. .device_to_virt = sandbox_testproc_device_to_virt,
  282. };
  283. static const struct udevice_id sandbox_ids[] = {
  284. {.compatible = "sandbox,test-processor"},
  285. {}
  286. };
  287. U_BOOT_DRIVER(sandbox_testproc) = {
  288. .name = "sandbox_test_proc",
  289. .of_match = sandbox_ids,
  290. .id = UCLASS_REMOTEPROC,
  291. .ops = &sandbox_testproc_ops,
  292. .probe = sandbox_testproc_probe,
  293. .priv_auto_alloc_size = sizeof(struct sandbox_test_devdata),
  294. };
  295. /* TODO(nm@ti.com): Remove this along with non-DT support */
  296. static struct dm_rproc_uclass_pdata proc_3_test = {
  297. .name = "proc_3_legacy",
  298. .mem_type = RPROC_INTERNAL_MEMORY_MAPPED,
  299. };
  300. U_BOOT_DEVICE(proc_3_demo) = {
  301. .name = "sandbox_test_proc",
  302. .platdata = &proc_3_test,
  303. };