st_remoteproc.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * ST's Remote Processor Control Driver
  4. *
  5. * Copyright (C) 2015 STMicroelectronics - All Rights Reserved
  6. *
  7. * Author: Ludovic Barre <ludovic.barre@st.com>
  8. */
  9. #include <linux/clk.h>
  10. #include <linux/dma-mapping.h>
  11. #include <linux/err.h>
  12. #include <linux/interrupt.h>
  13. #include <linux/kernel.h>
  14. #include <linux/mailbox_client.h>
  15. #include <linux/mfd/syscon.h>
  16. #include <linux/module.h>
  17. #include <linux/of.h>
  18. #include <linux/of_address.h>
  19. #include <linux/of_device.h>
  20. #include <linux/of_reserved_mem.h>
  21. #include <linux/platform_device.h>
  22. #include <linux/regmap.h>
  23. #include <linux/remoteproc.h>
  24. #include <linux/reset.h>
  25. #include "remoteproc_internal.h"
  26. #define ST_RPROC_VQ0 0
  27. #define ST_RPROC_VQ1 1
  28. #define ST_RPROC_MAX_VRING 2
  29. #define MBOX_RX 0
  30. #define MBOX_TX 1
  31. #define MBOX_MAX 2
  32. struct st_rproc_config {
  33. bool sw_reset;
  34. bool pwr_reset;
  35. unsigned long bootaddr_mask;
  36. };
  37. struct st_rproc {
  38. struct st_rproc_config *config;
  39. struct reset_control *sw_reset;
  40. struct reset_control *pwr_reset;
  41. struct clk *clk;
  42. u32 clk_rate;
  43. struct regmap *boot_base;
  44. u32 boot_offset;
  45. struct mbox_chan *mbox_chan[ST_RPROC_MAX_VRING * MBOX_MAX];
  46. struct mbox_client mbox_client_vq0;
  47. struct mbox_client mbox_client_vq1;
  48. };
  49. static void st_rproc_mbox_callback(struct device *dev, u32 msg)
  50. {
  51. struct rproc *rproc = dev_get_drvdata(dev);
  52. if (rproc_vq_interrupt(rproc, msg) == IRQ_NONE)
  53. dev_dbg(dev, "no message was found in vqid %d\n", msg);
  54. }
  55. static
  56. void st_rproc_mbox_callback_vq0(struct mbox_client *mbox_client, void *data)
  57. {
  58. st_rproc_mbox_callback(mbox_client->dev, 0);
  59. }
  60. static
  61. void st_rproc_mbox_callback_vq1(struct mbox_client *mbox_client, void *data)
  62. {
  63. st_rproc_mbox_callback(mbox_client->dev, 1);
  64. }
  65. static void st_rproc_kick(struct rproc *rproc, int vqid)
  66. {
  67. struct st_rproc *ddata = rproc->priv;
  68. struct device *dev = rproc->dev.parent;
  69. int ret;
  70. /* send the index of the triggered virtqueue in the mailbox payload */
  71. if (WARN_ON(vqid >= ST_RPROC_MAX_VRING))
  72. return;
  73. ret = mbox_send_message(ddata->mbox_chan[vqid * MBOX_MAX + MBOX_TX],
  74. (void *)&vqid);
  75. if (ret < 0)
  76. dev_err(dev, "failed to send message via mbox: %d\n", ret);
  77. }
  78. static int st_rproc_mem_alloc(struct rproc *rproc,
  79. struct rproc_mem_entry *mem)
  80. {
  81. struct device *dev = rproc->dev.parent;
  82. void *va;
  83. va = ioremap_wc(mem->dma, mem->len);
  84. if (!va) {
  85. dev_err(dev, "Unable to map memory region: %pa+%zx\n",
  86. &mem->dma, mem->len);
  87. return -ENOMEM;
  88. }
  89. /* Update memory entry va */
  90. mem->va = va;
  91. return 0;
  92. }
  93. static int st_rproc_mem_release(struct rproc *rproc,
  94. struct rproc_mem_entry *mem)
  95. {
  96. iounmap(mem->va);
  97. return 0;
  98. }
  99. static int st_rproc_parse_fw(struct rproc *rproc, const struct firmware *fw)
  100. {
  101. struct device *dev = rproc->dev.parent;
  102. struct device_node *np = dev->of_node;
  103. struct rproc_mem_entry *mem;
  104. struct reserved_mem *rmem;
  105. struct of_phandle_iterator it;
  106. int index = 0;
  107. of_phandle_iterator_init(&it, np, "memory-region", NULL, 0);
  108. while (of_phandle_iterator_next(&it) == 0) {
  109. rmem = of_reserved_mem_lookup(it.node);
  110. if (!rmem) {
  111. dev_err(dev, "unable to acquire memory-region\n");
  112. return -EINVAL;
  113. }
  114. /* No need to map vdev buffer */
  115. if (strcmp(it.node->name, "vdev0buffer")) {
  116. /* Register memory region */
  117. mem = rproc_mem_entry_init(dev, NULL,
  118. (dma_addr_t)rmem->base,
  119. rmem->size, rmem->base,
  120. st_rproc_mem_alloc,
  121. st_rproc_mem_release,
  122. it.node->name);
  123. } else {
  124. /* Register reserved memory for vdev buffer allocation */
  125. mem = rproc_of_resm_mem_entry_init(dev, index,
  126. rmem->size,
  127. rmem->base,
  128. it.node->name);
  129. }
  130. if (!mem)
  131. return -ENOMEM;
  132. rproc_add_carveout(rproc, mem);
  133. index++;
  134. }
  135. return rproc_elf_load_rsc_table(rproc, fw);
  136. }
  137. static int st_rproc_start(struct rproc *rproc)
  138. {
  139. struct st_rproc *ddata = rproc->priv;
  140. int err;
  141. regmap_update_bits(ddata->boot_base, ddata->boot_offset,
  142. ddata->config->bootaddr_mask, rproc->bootaddr);
  143. err = clk_enable(ddata->clk);
  144. if (err) {
  145. dev_err(&rproc->dev, "Failed to enable clock\n");
  146. return err;
  147. }
  148. if (ddata->config->sw_reset) {
  149. err = reset_control_deassert(ddata->sw_reset);
  150. if (err) {
  151. dev_err(&rproc->dev, "Failed to deassert S/W Reset\n");
  152. goto sw_reset_fail;
  153. }
  154. }
  155. if (ddata->config->pwr_reset) {
  156. err = reset_control_deassert(ddata->pwr_reset);
  157. if (err) {
  158. dev_err(&rproc->dev, "Failed to deassert Power Reset\n");
  159. goto pwr_reset_fail;
  160. }
  161. }
  162. dev_info(&rproc->dev, "Started from 0x%llx\n", rproc->bootaddr);
  163. return 0;
  164. pwr_reset_fail:
  165. if (ddata->config->pwr_reset)
  166. reset_control_assert(ddata->sw_reset);
  167. sw_reset_fail:
  168. clk_disable(ddata->clk);
  169. return err;
  170. }
  171. static int st_rproc_stop(struct rproc *rproc)
  172. {
  173. struct st_rproc *ddata = rproc->priv;
  174. int sw_err = 0, pwr_err = 0;
  175. if (ddata->config->sw_reset) {
  176. sw_err = reset_control_assert(ddata->sw_reset);
  177. if (sw_err)
  178. dev_err(&rproc->dev, "Failed to assert S/W Reset\n");
  179. }
  180. if (ddata->config->pwr_reset) {
  181. pwr_err = reset_control_assert(ddata->pwr_reset);
  182. if (pwr_err)
  183. dev_err(&rproc->dev, "Failed to assert Power Reset\n");
  184. }
  185. clk_disable(ddata->clk);
  186. return sw_err ?: pwr_err;
  187. }
  188. static const struct rproc_ops st_rproc_ops = {
  189. .kick = st_rproc_kick,
  190. .start = st_rproc_start,
  191. .stop = st_rproc_stop,
  192. .parse_fw = st_rproc_parse_fw,
  193. .load = rproc_elf_load_segments,
  194. .find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table,
  195. .sanity_check = rproc_elf_sanity_check,
  196. .get_boot_addr = rproc_elf_get_boot_addr,
  197. };
  198. /*
  199. * Fetch state of the processor: 0 is off, 1 is on.
  200. */
  201. static int st_rproc_state(struct platform_device *pdev)
  202. {
  203. struct rproc *rproc = platform_get_drvdata(pdev);
  204. struct st_rproc *ddata = rproc->priv;
  205. int reset_sw = 0, reset_pwr = 0;
  206. if (ddata->config->sw_reset)
  207. reset_sw = reset_control_status(ddata->sw_reset);
  208. if (ddata->config->pwr_reset)
  209. reset_pwr = reset_control_status(ddata->pwr_reset);
  210. if (reset_sw < 0 || reset_pwr < 0)
  211. return -EINVAL;
  212. return !reset_sw && !reset_pwr;
  213. }
  214. static const struct st_rproc_config st40_rproc_cfg = {
  215. .sw_reset = true,
  216. .pwr_reset = true,
  217. .bootaddr_mask = GENMASK(28, 1),
  218. };
  219. static const struct st_rproc_config st231_rproc_cfg = {
  220. .sw_reset = true,
  221. .pwr_reset = false,
  222. .bootaddr_mask = GENMASK(31, 6),
  223. };
  224. static const struct of_device_id st_rproc_match[] = {
  225. { .compatible = "st,st40-rproc", .data = &st40_rproc_cfg },
  226. { .compatible = "st,st231-rproc", .data = &st231_rproc_cfg },
  227. {},
  228. };
  229. MODULE_DEVICE_TABLE(of, st_rproc_match);
  230. static int st_rproc_parse_dt(struct platform_device *pdev)
  231. {
  232. struct device *dev = &pdev->dev;
  233. struct rproc *rproc = platform_get_drvdata(pdev);
  234. struct st_rproc *ddata = rproc->priv;
  235. struct device_node *np = dev->of_node;
  236. int err;
  237. if (ddata->config->sw_reset) {
  238. ddata->sw_reset = devm_reset_control_get_exclusive(dev,
  239. "sw_reset");
  240. if (IS_ERR(ddata->sw_reset)) {
  241. dev_err(dev, "Failed to get S/W Reset\n");
  242. return PTR_ERR(ddata->sw_reset);
  243. }
  244. }
  245. if (ddata->config->pwr_reset) {
  246. ddata->pwr_reset = devm_reset_control_get_exclusive(dev,
  247. "pwr_reset");
  248. if (IS_ERR(ddata->pwr_reset)) {
  249. dev_err(dev, "Failed to get Power Reset\n");
  250. return PTR_ERR(ddata->pwr_reset);
  251. }
  252. }
  253. ddata->clk = devm_clk_get(dev, NULL);
  254. if (IS_ERR(ddata->clk)) {
  255. dev_err(dev, "Failed to get clock\n");
  256. return PTR_ERR(ddata->clk);
  257. }
  258. err = of_property_read_u32(np, "clock-frequency", &ddata->clk_rate);
  259. if (err) {
  260. dev_err(dev, "failed to get clock frequency\n");
  261. return err;
  262. }
  263. ddata->boot_base = syscon_regmap_lookup_by_phandle(np, "st,syscfg");
  264. if (IS_ERR(ddata->boot_base)) {
  265. dev_err(dev, "Boot base not found\n");
  266. return PTR_ERR(ddata->boot_base);
  267. }
  268. err = of_property_read_u32_index(np, "st,syscfg", 1,
  269. &ddata->boot_offset);
  270. if (err) {
  271. dev_err(dev, "Boot offset not found\n");
  272. return -EINVAL;
  273. }
  274. err = clk_prepare(ddata->clk);
  275. if (err)
  276. dev_err(dev, "failed to get clock\n");
  277. return err;
  278. }
  279. static int st_rproc_probe(struct platform_device *pdev)
  280. {
  281. struct device *dev = &pdev->dev;
  282. const struct of_device_id *match;
  283. struct st_rproc *ddata;
  284. struct device_node *np = dev->of_node;
  285. struct rproc *rproc;
  286. struct mbox_chan *chan;
  287. int enabled;
  288. int ret, i;
  289. match = of_match_device(st_rproc_match, dev);
  290. if (!match || !match->data) {
  291. dev_err(dev, "No device match found\n");
  292. return -ENODEV;
  293. }
  294. rproc = rproc_alloc(dev, np->name, &st_rproc_ops, NULL, sizeof(*ddata));
  295. if (!rproc)
  296. return -ENOMEM;
  297. rproc->has_iommu = false;
  298. ddata = rproc->priv;
  299. ddata->config = (struct st_rproc_config *)match->data;
  300. platform_set_drvdata(pdev, rproc);
  301. ret = st_rproc_parse_dt(pdev);
  302. if (ret)
  303. goto free_rproc;
  304. enabled = st_rproc_state(pdev);
  305. if (enabled < 0) {
  306. ret = enabled;
  307. goto free_clk;
  308. }
  309. if (enabled) {
  310. atomic_inc(&rproc->power);
  311. rproc->state = RPROC_RUNNING;
  312. } else {
  313. clk_set_rate(ddata->clk, ddata->clk_rate);
  314. }
  315. if (of_get_property(np, "mbox-names", NULL)) {
  316. ddata->mbox_client_vq0.dev = dev;
  317. ddata->mbox_client_vq0.tx_done = NULL;
  318. ddata->mbox_client_vq0.tx_block = false;
  319. ddata->mbox_client_vq0.knows_txdone = false;
  320. ddata->mbox_client_vq0.rx_callback = st_rproc_mbox_callback_vq0;
  321. ddata->mbox_client_vq1.dev = dev;
  322. ddata->mbox_client_vq1.tx_done = NULL;
  323. ddata->mbox_client_vq1.tx_block = false;
  324. ddata->mbox_client_vq1.knows_txdone = false;
  325. ddata->mbox_client_vq1.rx_callback = st_rproc_mbox_callback_vq1;
  326. /*
  327. * To control a co-processor without IPC mechanism.
  328. * This driver can be used without mbox and rpmsg.
  329. */
  330. chan = mbox_request_channel_byname(&ddata->mbox_client_vq0, "vq0_rx");
  331. if (IS_ERR(chan)) {
  332. dev_err(&rproc->dev, "failed to request mbox chan 0\n");
  333. ret = PTR_ERR(chan);
  334. goto free_clk;
  335. }
  336. ddata->mbox_chan[ST_RPROC_VQ0 * MBOX_MAX + MBOX_RX] = chan;
  337. chan = mbox_request_channel_byname(&ddata->mbox_client_vq0, "vq0_tx");
  338. if (IS_ERR(chan)) {
  339. dev_err(&rproc->dev, "failed to request mbox chan 0\n");
  340. ret = PTR_ERR(chan);
  341. goto free_mbox;
  342. }
  343. ddata->mbox_chan[ST_RPROC_VQ0 * MBOX_MAX + MBOX_TX] = chan;
  344. chan = mbox_request_channel_byname(&ddata->mbox_client_vq1, "vq1_rx");
  345. if (IS_ERR(chan)) {
  346. dev_err(&rproc->dev, "failed to request mbox chan 1\n");
  347. ret = PTR_ERR(chan);
  348. goto free_mbox;
  349. }
  350. ddata->mbox_chan[ST_RPROC_VQ1 * MBOX_MAX + MBOX_RX] = chan;
  351. chan = mbox_request_channel_byname(&ddata->mbox_client_vq1, "vq1_tx");
  352. if (IS_ERR(chan)) {
  353. dev_err(&rproc->dev, "failed to request mbox chan 1\n");
  354. ret = PTR_ERR(chan);
  355. goto free_mbox;
  356. }
  357. ddata->mbox_chan[ST_RPROC_VQ1 * MBOX_MAX + MBOX_TX] = chan;
  358. }
  359. ret = rproc_add(rproc);
  360. if (ret)
  361. goto free_mbox;
  362. return 0;
  363. free_mbox:
  364. for (i = 0; i < ST_RPROC_MAX_VRING * MBOX_MAX; i++)
  365. mbox_free_channel(ddata->mbox_chan[i]);
  366. free_clk:
  367. clk_unprepare(ddata->clk);
  368. free_rproc:
  369. rproc_free(rproc);
  370. return ret;
  371. }
  372. static int st_rproc_remove(struct platform_device *pdev)
  373. {
  374. struct rproc *rproc = platform_get_drvdata(pdev);
  375. struct st_rproc *ddata = rproc->priv;
  376. int i;
  377. rproc_del(rproc);
  378. clk_disable_unprepare(ddata->clk);
  379. for (i = 0; i < ST_RPROC_MAX_VRING * MBOX_MAX; i++)
  380. mbox_free_channel(ddata->mbox_chan[i]);
  381. rproc_free(rproc);
  382. return 0;
  383. }
  384. static struct platform_driver st_rproc_driver = {
  385. .probe = st_rproc_probe,
  386. .remove = st_rproc_remove,
  387. .driver = {
  388. .name = "st-rproc",
  389. .of_match_table = of_match_ptr(st_rproc_match),
  390. },
  391. };
  392. module_platform_driver(st_rproc_driver);
  393. MODULE_DESCRIPTION("ST Remote Processor Control Driver");
  394. MODULE_AUTHOR("Ludovic Barre <ludovic.barre@st.com>");
  395. MODULE_LICENSE("GPL v2");