2 * OMAP Remote Processor driver
4 * Copyright (C) 2011 Texas Instruments, Inc.
5 * Copyright (C) 2011 Google, Inc.
7 * Ohad Ben-Cohen <ohad@wizery.com>
8 * Brian Swetland <swetland@google.com>
9 * Fernando Guzman Lugo <fernando.lugo@ti.com>
10 * Mark Grosen <mgrosen@ti.com>
11 * Suman Anna <s-anna@ti.com>
12 * Hari Kanigeri <h-kanigeri2@ti.com>
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * version 2 as published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
24 #include <linux/kernel.h>
25 #include <linux/module.h>
26 #include <linux/err.h>
27 #include <linux/platform_device.h>
28 #include <linux/dma-mapping.h>
29 #include <linux/remoteproc.h>
30 #include <linux/mailbox_client.h>
31 #include <linux/omap-mailbox.h>
33 #include <linux/platform_data/remoteproc-omap.h>
35 #include "omap_remoteproc.h"
36 #include "remoteproc_internal.h"
39 * struct omap_rproc - omap remote processor state
40 * @mbox: mailbox channel handle
41 * @client: mailbox client to request the mailbox channel
42 * @rproc: rproc handle
45 struct mbox_chan *mbox;
46 struct mbox_client client;
51 * omap_rproc_mbox_callback() - inbound mailbox message handler
52 * @client: mailbox client pointer used for requesting the mailbox channel
53 * @data: mailbox payload
55 * This handler is invoked by omap's mailbox driver whenever a mailbox
56 * message is received. Usually, the mailbox payload simply contains
57 * the index of the virtqueue that is kicked by the remote processor,
58 * and we let remoteproc core handle it.
60 * In addition to virtqueue indices, we also have some out-of-band values
61 * that indicates different events. Those values are deliberately very
62 * big so they don't coincide with virtqueue indices.
64 static void omap_rproc_mbox_callback(struct mbox_client *client, void *data)
66 struct omap_rproc *oproc = container_of(client, struct omap_rproc,
68 struct device *dev = oproc->rproc->dev.parent;
69 const char *name = oproc->rproc->name;
72 dev_dbg(dev, "mbox msg: 0x%x\n", msg);
76 /* just log this for now. later, we'll also do recovery */
77 dev_err(dev, "omap rproc %s crashed\n", name);
79 case RP_MBOX_ECHO_REPLY:
80 dev_info(dev, "received echo reply from %s\n", name);
83 /* msg contains the index of the triggered vring */
84 if (rproc_vq_interrupt(oproc->rproc, msg) == IRQ_NONE)
85 dev_dbg(dev, "no message was found in vqid %d\n", msg);
89 /* kick a virtqueue */
90 static void omap_rproc_kick(struct rproc *rproc, int vqid)
92 struct omap_rproc *oproc = rproc->priv;
93 struct device *dev = rproc->dev.parent;
96 /* send the index of the triggered virtqueue in the mailbox payload */
97 ret = mbox_send_message(oproc->mbox, (void *)vqid);
99 dev_err(dev, "omap_mbox_msg_send failed: %d\n", ret);
103 * Power up the remote processor.
105 * This function will be invoked only after the firmware for this rproc
106 * was loaded, parsed successfully, and all of its resource requirements
109 static int omap_rproc_start(struct rproc *rproc)
111 struct omap_rproc *oproc = rproc->priv;
112 struct device *dev = rproc->dev.parent;
113 struct platform_device *pdev = to_platform_device(dev);
114 struct omap_rproc_pdata *pdata = pdev->dev.platform_data;
116 struct mbox_client *client = &oproc->client;
118 if (pdata->set_bootaddr)
119 pdata->set_bootaddr(rproc->bootaddr);
122 client->tx_done = NULL;
123 client->rx_callback = omap_rproc_mbox_callback;
124 client->tx_block = false;
125 client->knows_txdone = false;
127 oproc->mbox = omap_mbox_request_channel(client, pdata->mbox_name);
128 if (IS_ERR(oproc->mbox)) {
130 dev_err(dev, "mbox_request_channel failed: %ld\n",
131 PTR_ERR(oproc->mbox));
136 * Ping the remote processor. this is only for sanity-sake;
137 * there is no functional effect whatsoever.
139 * Note that the reply will _not_ arrive immediately: this message
140 * will wait in the mailbox fifo until the remote processor is booted.
142 ret = mbox_send_message(oproc->mbox, (void *)RP_MBOX_ECHO_REQUEST);
144 dev_err(dev, "mbox_send_message failed: %d\n", ret);
148 ret = pdata->device_enable(pdev);
150 dev_err(dev, "omap_device_enable failed: %d\n", ret);
157 mbox_free_channel(oproc->mbox);
161 /* power off the remote processor */
162 static int omap_rproc_stop(struct rproc *rproc)
164 struct device *dev = rproc->dev.parent;
165 struct platform_device *pdev = to_platform_device(dev);
166 struct omap_rproc_pdata *pdata = pdev->dev.platform_data;
167 struct omap_rproc *oproc = rproc->priv;
170 ret = pdata->device_shutdown(pdev);
174 mbox_free_channel(oproc->mbox);
179 static struct rproc_ops omap_rproc_ops = {
180 .start = omap_rproc_start,
181 .stop = omap_rproc_stop,
182 .kick = omap_rproc_kick,
185 static int omap_rproc_probe(struct platform_device *pdev)
187 struct omap_rproc_pdata *pdata = pdev->dev.platform_data;
188 struct omap_rproc *oproc;
192 ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
194 dev_err(&pdev->dev, "dma_set_coherent_mask: %d\n", ret);
198 rproc = rproc_alloc(&pdev->dev, pdata->name, &omap_rproc_ops,
199 pdata->firmware, sizeof(*oproc));
204 oproc->rproc = rproc;
206 platform_set_drvdata(pdev, rproc);
208 ret = rproc_add(rproc);
219 static int omap_rproc_remove(struct platform_device *pdev)
221 struct rproc *rproc = platform_get_drvdata(pdev);
229 static struct platform_driver omap_rproc_driver = {
230 .probe = omap_rproc_probe,
231 .remove = omap_rproc_remove,
233 .name = "omap-rproc",
234 .owner = THIS_MODULE,
238 module_platform_driver(omap_rproc_driver);
240 MODULE_LICENSE("GPL v2");
241 MODULE_DESCRIPTION("OMAP Remote Processor control driver");