1 // SPDX-License-Identifier: GPL-2.0-only
3 * ST's Remote Processor Control Driver
5 * Copyright (C) 2015 STMicroelectronics - All Rights Reserved
7 * Author: Ludovic Barre <ludovic.barre@st.com>
10 #include <linux/clk.h>
11 #include <linux/dma-mapping.h>
12 #include <linux/err.h>
13 #include <linux/interrupt.h>
14 #include <linux/kernel.h>
15 #include <linux/mailbox_client.h>
16 #include <linux/mfd/syscon.h>
17 #include <linux/module.h>
19 #include <linux/of_address.h>
20 #include <linux/of_device.h>
21 #include <linux/of_reserved_mem.h>
22 #include <linux/platform_device.h>
23 #include <linux/regmap.h>
24 #include <linux/remoteproc.h>
25 #include <linux/reset.h>
27 #include "remoteproc_internal.h"
29 #define ST_RPROC_VQ0 0
30 #define ST_RPROC_VQ1 1
31 #define ST_RPROC_MAX_VRING 2
37 struct st_rproc_config {
40 unsigned long bootaddr_mask;
44 struct st_rproc_config *config;
45 struct reset_control *sw_reset;
46 struct reset_control *pwr_reset;
49 struct regmap *boot_base;
51 struct mbox_chan *mbox_chan[ST_RPROC_MAX_VRING * MBOX_MAX];
52 struct mbox_client mbox_client_vq0;
53 struct mbox_client mbox_client_vq1;
56 static void st_rproc_mbox_callback(struct device *dev, u32 msg)
58 struct rproc *rproc = dev_get_drvdata(dev);
60 if (rproc_vq_interrupt(rproc, msg) == IRQ_NONE)
61 dev_dbg(dev, "no message was found in vqid %d\n", msg);
65 void st_rproc_mbox_callback_vq0(struct mbox_client *mbox_client, void *data)
67 st_rproc_mbox_callback(mbox_client->dev, 0);
71 void st_rproc_mbox_callback_vq1(struct mbox_client *mbox_client, void *data)
73 st_rproc_mbox_callback(mbox_client->dev, 1);
76 static void st_rproc_kick(struct rproc *rproc, int vqid)
78 struct st_rproc *ddata = rproc->priv;
79 struct device *dev = rproc->dev.parent;
82 /* send the index of the triggered virtqueue in the mailbox payload */
83 if (WARN_ON(vqid >= ST_RPROC_MAX_VRING))
86 ret = mbox_send_message(ddata->mbox_chan[vqid * MBOX_MAX + MBOX_TX],
89 dev_err(dev, "failed to send message via mbox: %d\n", ret);
92 static int st_rproc_mem_alloc(struct rproc *rproc,
93 struct rproc_mem_entry *mem)
95 struct device *dev = rproc->dev.parent;
98 va = ioremap_wc(mem->dma, mem->len);
100 dev_err(dev, "Unable to map memory region: %pa+%zx\n",
101 &mem->dma, mem->len);
105 /* Update memory entry va */
111 static int st_rproc_mem_release(struct rproc *rproc,
112 struct rproc_mem_entry *mem)
119 static int st_rproc_parse_fw(struct rproc *rproc, const struct firmware *fw)
121 struct device *dev = rproc->dev.parent;
122 struct device_node *np = dev->of_node;
123 struct rproc_mem_entry *mem;
124 struct reserved_mem *rmem;
125 struct of_phandle_iterator it;
128 of_phandle_iterator_init(&it, np, "memory-region", NULL, 0);
129 while (of_phandle_iterator_next(&it) == 0) {
130 rmem = of_reserved_mem_lookup(it.node);
132 dev_err(dev, "unable to acquire memory-region\n");
136 /* No need to map vdev buffer */
137 if (strcmp(it.node->name, "vdev0buffer")) {
138 /* Register memory region */
139 mem = rproc_mem_entry_init(dev, NULL,
140 (dma_addr_t)rmem->base,
141 rmem->size, rmem->base,
143 st_rproc_mem_release,
146 /* Register reserved memory for vdev buffer allocation */
147 mem = rproc_of_resm_mem_entry_init(dev, index,
156 rproc_add_carveout(rproc, mem);
160 return rproc_elf_load_rsc_table(rproc, fw);
163 static int st_rproc_start(struct rproc *rproc)
165 struct st_rproc *ddata = rproc->priv;
168 regmap_update_bits(ddata->boot_base, ddata->boot_offset,
169 ddata->config->bootaddr_mask, rproc->bootaddr);
171 err = clk_enable(ddata->clk);
173 dev_err(&rproc->dev, "Failed to enable clock\n");
177 if (ddata->config->sw_reset) {
178 err = reset_control_deassert(ddata->sw_reset);
180 dev_err(&rproc->dev, "Failed to deassert S/W Reset\n");
185 if (ddata->config->pwr_reset) {
186 err = reset_control_deassert(ddata->pwr_reset);
188 dev_err(&rproc->dev, "Failed to deassert Power Reset\n");
193 dev_info(&rproc->dev, "Started from 0x%llx\n", rproc->bootaddr);
199 if (ddata->config->pwr_reset)
200 reset_control_assert(ddata->sw_reset);
202 clk_disable(ddata->clk);
207 static int st_rproc_stop(struct rproc *rproc)
209 struct st_rproc *ddata = rproc->priv;
210 int sw_err = 0, pwr_err = 0;
212 if (ddata->config->sw_reset) {
213 sw_err = reset_control_assert(ddata->sw_reset);
215 dev_err(&rproc->dev, "Failed to assert S/W Reset\n");
218 if (ddata->config->pwr_reset) {
219 pwr_err = reset_control_assert(ddata->pwr_reset);
221 dev_err(&rproc->dev, "Failed to assert Power Reset\n");
224 clk_disable(ddata->clk);
226 return sw_err ?: pwr_err;
229 static const struct rproc_ops st_rproc_ops = {
230 .kick = st_rproc_kick,
231 .start = st_rproc_start,
232 .stop = st_rproc_stop,
233 .parse_fw = st_rproc_parse_fw,
234 .load = rproc_elf_load_segments,
235 .find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table,
236 .sanity_check = rproc_elf_sanity_check,
237 .get_boot_addr = rproc_elf_get_boot_addr,
241 * Fetch state of the processor: 0 is off, 1 is on.
243 static int st_rproc_state(struct platform_device *pdev)
245 struct rproc *rproc = platform_get_drvdata(pdev);
246 struct st_rproc *ddata = rproc->priv;
247 int reset_sw = 0, reset_pwr = 0;
249 if (ddata->config->sw_reset)
250 reset_sw = reset_control_status(ddata->sw_reset);
252 if (ddata->config->pwr_reset)
253 reset_pwr = reset_control_status(ddata->pwr_reset);
255 if (reset_sw < 0 || reset_pwr < 0)
258 return !reset_sw && !reset_pwr;
261 static const struct st_rproc_config st40_rproc_cfg = {
264 .bootaddr_mask = GENMASK(28, 1),
267 static const struct st_rproc_config st231_rproc_cfg = {
270 .bootaddr_mask = GENMASK(31, 6),
273 static const struct of_device_id st_rproc_match[] = {
274 { .compatible = "st,st40-rproc", .data = &st40_rproc_cfg },
275 { .compatible = "st,st231-rproc", .data = &st231_rproc_cfg },
278 MODULE_DEVICE_TABLE(of, st_rproc_match);
280 static int st_rproc_parse_dt(struct platform_device *pdev)
282 struct device *dev = &pdev->dev;
283 struct rproc *rproc = platform_get_drvdata(pdev);
284 struct st_rproc *ddata = rproc->priv;
285 struct device_node *np = dev->of_node;
288 if (ddata->config->sw_reset) {
289 ddata->sw_reset = devm_reset_control_get_exclusive(dev,
291 if (IS_ERR(ddata->sw_reset)) {
292 dev_err(dev, "Failed to get S/W Reset\n");
293 return PTR_ERR(ddata->sw_reset);
297 if (ddata->config->pwr_reset) {
298 ddata->pwr_reset = devm_reset_control_get_exclusive(dev,
300 if (IS_ERR(ddata->pwr_reset)) {
301 dev_err(dev, "Failed to get Power Reset\n");
302 return PTR_ERR(ddata->pwr_reset);
306 ddata->clk = devm_clk_get(dev, NULL);
307 if (IS_ERR(ddata->clk)) {
308 dev_err(dev, "Failed to get clock\n");
309 return PTR_ERR(ddata->clk);
312 err = of_property_read_u32(np, "clock-frequency", &ddata->clk_rate);
314 dev_err(dev, "failed to get clock frequency\n");
318 ddata->boot_base = syscon_regmap_lookup_by_phandle(np, "st,syscfg");
319 if (IS_ERR(ddata->boot_base)) {
320 dev_err(dev, "Boot base not found\n");
321 return PTR_ERR(ddata->boot_base);
324 err = of_property_read_u32_index(np, "st,syscfg", 1,
325 &ddata->boot_offset);
327 dev_err(dev, "Boot offset not found\n");
331 err = clk_prepare(ddata->clk);
333 dev_err(dev, "failed to get clock\n");
338 static int st_rproc_probe(struct platform_device *pdev)
340 struct device *dev = &pdev->dev;
341 const struct of_device_id *match;
342 struct st_rproc *ddata;
343 struct device_node *np = dev->of_node;
345 struct mbox_chan *chan;
349 match = of_match_device(st_rproc_match, dev);
350 if (!match || !match->data) {
351 dev_err(dev, "No device match found\n");
355 rproc = rproc_alloc(dev, np->name, &st_rproc_ops, NULL, sizeof(*ddata));
359 rproc->has_iommu = false;
361 ddata->config = (struct st_rproc_config *)match->data;
363 platform_set_drvdata(pdev, rproc);
365 ret = st_rproc_parse_dt(pdev);
369 enabled = st_rproc_state(pdev);
376 atomic_inc(&rproc->power);
377 rproc->state = RPROC_RUNNING;
379 clk_set_rate(ddata->clk, ddata->clk_rate);
382 if (of_get_property(np, "mbox-names", NULL)) {
383 ddata->mbox_client_vq0.dev = dev;
384 ddata->mbox_client_vq0.tx_done = NULL;
385 ddata->mbox_client_vq0.tx_block = false;
386 ddata->mbox_client_vq0.knows_txdone = false;
387 ddata->mbox_client_vq0.rx_callback = st_rproc_mbox_callback_vq0;
389 ddata->mbox_client_vq1.dev = dev;
390 ddata->mbox_client_vq1.tx_done = NULL;
391 ddata->mbox_client_vq1.tx_block = false;
392 ddata->mbox_client_vq1.knows_txdone = false;
393 ddata->mbox_client_vq1.rx_callback = st_rproc_mbox_callback_vq1;
396 * To control a co-processor without IPC mechanism.
397 * This driver can be used without mbox and rpmsg.
399 chan = mbox_request_channel_byname(&ddata->mbox_client_vq0, "vq0_rx");
401 dev_err(&rproc->dev, "failed to request mbox chan 0\n");
405 ddata->mbox_chan[ST_RPROC_VQ0 * MBOX_MAX + MBOX_RX] = chan;
407 chan = mbox_request_channel_byname(&ddata->mbox_client_vq0, "vq0_tx");
409 dev_err(&rproc->dev, "failed to request mbox chan 0\n");
413 ddata->mbox_chan[ST_RPROC_VQ0 * MBOX_MAX + MBOX_TX] = chan;
415 chan = mbox_request_channel_byname(&ddata->mbox_client_vq1, "vq1_rx");
417 dev_err(&rproc->dev, "failed to request mbox chan 1\n");
421 ddata->mbox_chan[ST_RPROC_VQ1 * MBOX_MAX + MBOX_RX] = chan;
423 chan = mbox_request_channel_byname(&ddata->mbox_client_vq1, "vq1_tx");
425 dev_err(&rproc->dev, "failed to request mbox chan 1\n");
429 ddata->mbox_chan[ST_RPROC_VQ1 * MBOX_MAX + MBOX_TX] = chan;
432 ret = rproc_add(rproc);
439 for (i = 0; i < ST_RPROC_MAX_VRING * MBOX_MAX; i++)
440 mbox_free_channel(ddata->mbox_chan[i]);
442 clk_unprepare(ddata->clk);
448 static int st_rproc_remove(struct platform_device *pdev)
450 struct rproc *rproc = platform_get_drvdata(pdev);
451 struct st_rproc *ddata = rproc->priv;
456 clk_disable_unprepare(ddata->clk);
458 for (i = 0; i < ST_RPROC_MAX_VRING * MBOX_MAX; i++)
459 mbox_free_channel(ddata->mbox_chan[i]);
466 static struct platform_driver st_rproc_driver = {
467 .probe = st_rproc_probe,
468 .remove = st_rproc_remove,
471 .of_match_table = of_match_ptr(st_rproc_match),
474 module_platform_driver(st_rproc_driver);
476 MODULE_DESCRIPTION("ST Remote Processor Control Driver");
477 MODULE_AUTHOR("Ludovic Barre <ludovic.barre@st.com>");
478 MODULE_LICENSE("GPL v2");