sandbox_testproc.c 8.6 KB

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