blob: b09c75c21b609c51569e4088d8aba51769bec8a4 [file] [log] [blame]
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +02001/*
2 * Remote processor messaging transport (OMAP platform-specific bits)
3 *
4 * Copyright (C) 2011 Texas Instruments, Inc.
5 * Copyright (C) 2011 Google, Inc.
6 *
7 * Ohad Ben-Cohen <ohad@wizery.com>
8 * Brian Swetland <swetland@google.com>
9 *
10 * This software is licensed under the terms of the GNU General Public
11 * License version 2, as published by the Free Software Foundation, and
12 * may be copied, distributed, and modified under those terms.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 */
19
20#include <linux/export.h>
21#include <linux/remoteproc.h>
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020022#include <linux/virtio.h>
23#include <linux/virtio_config.h>
24#include <linux/virtio_ids.h>
25#include <linux/virtio_ring.h>
26#include <linux/err.h>
27#include <linux/kref.h>
28#include <linux/slab.h>
29
30#include "remoteproc_internal.h"
31
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020032/* kick the remote processor, and let it know which virtqueue to poke at */
33static void rproc_virtio_notify(struct virtqueue *vq)
34{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010035 struct rproc_vring *rvring = vq->priv;
36 struct rproc *rproc = rvring->rvdev->rproc;
37 int notifyid = rvring->notifyid;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020038
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +030039 dev_dbg(&rproc->dev, "kicking vq index: %d\n", notifyid);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020040
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010041 rproc->ops->kick(rproc, notifyid);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020042}
43
44/**
45 * rproc_vq_interrupt() - tell remoteproc that a virtqueue is interrupted
46 * @rproc: handle to the remote processor
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010047 * @notifyid: index of the signalled virtqueue (unique per this @rproc)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020048 *
49 * This function should be called by the platform-specific rproc driver,
50 * when the remote processor signals that a specific virtqueue has pending
51 * messages available.
52 *
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010053 * Returns IRQ_NONE if no message was found in the @notifyid virtqueue,
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020054 * and otherwise returns IRQ_HANDLED.
55 */
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010056irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int notifyid)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020057{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010058 struct rproc_vring *rvring;
59
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +030060 dev_dbg(&rproc->dev, "vq index %d is interrupted\n", notifyid);
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010061
62 rvring = idr_find(&rproc->notifyids, notifyid);
63 if (!rvring || !rvring->vq)
64 return IRQ_NONE;
65
66 return vring_interrupt(0, rvring->vq);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020067}
68EXPORT_SYMBOL(rproc_vq_interrupt);
69
70static struct virtqueue *rp_find_vq(struct virtio_device *vdev,
71 unsigned id,
72 void (*callback)(struct virtqueue *vq),
73 const char *name)
74{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010075 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020076 struct rproc *rproc = vdev_to_rproc(vdev);
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +030077 struct device *dev = &rproc->dev;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010078 struct rproc_vring *rvring;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020079 struct virtqueue *vq;
80 void *addr;
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +030081 int len, size, ret;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020082
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010083 /* we're temporarily limited to two virtqueues per rvdev */
84 if (id >= ARRAY_SIZE(rvdev->vring))
85 return ERR_PTR(-EINVAL);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020086
Michael S. Tsirkin6457f122012-09-05 21:47:45 +030087 if (!name)
88 return NULL;
89
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +030090 ret = rproc_alloc_vring(rvdev, id);
91 if (ret)
92 return ERR_PTR(ret);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020093
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +030094 rvring = &rvdev->vring[id];
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010095 addr = rvring->va;
96 len = rvring->len;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020097
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010098 /* zero vring */
99 size = vring_size(len, rvring->align);
100 memset(addr, 0, size);
101
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300102 dev_dbg(dev, "vring%d: va %p qsz %d notifyid %d\n",
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100103 id, addr, len, rvring->notifyid);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200104
Ohad Ben-Cohendd6da1c2012-01-12 09:26:57 +0200105 /*
106 * Create the new vq, and tell virtio we're not interested in
107 * the 'weak' smp barriers, since we're talking with a real device.
108 */
Jason Wang17bb6d42012-08-28 13:54:13 +0200109 vq = vring_new_virtqueue(id, len, rvring->align, vdev, false, addr,
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200110 rproc_virtio_notify, callback, name);
111 if (!vq) {
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300112 dev_err(dev, "vring_new_virtqueue %s failed\n", name);
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +0300113 rproc_free_vring(rvring);
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100114 return ERR_PTR(-ENOMEM);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200115 }
116
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100117 rvring->vq = vq;
118 vq->priv = rvring;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200119
120 return vq;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200121}
122
Ohad Ben-Cohendab55bb2012-11-12 11:13:51 +0200123static void __rproc_virtio_del_vqs(struct virtio_device *vdev)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200124{
125 struct virtqueue *vq, *n;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100126 struct rproc_vring *rvring;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200127
128 list_for_each_entry_safe(vq, n, &vdev->vqs, list) {
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100129 rvring = vq->priv;
130 rvring->vq = NULL;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200131 vring_del_virtqueue(vq);
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +0300132 rproc_free_vring(rvring);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200133 }
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200134}
135
Ohad Ben-Cohendab55bb2012-11-12 11:13:51 +0200136static void rproc_virtio_del_vqs(struct virtio_device *vdev)
137{
138 struct rproc *rproc = vdev_to_rproc(vdev);
139
140 /* power down the remote processor before deleting vqs */
141 rproc_shutdown(rproc);
142
143 __rproc_virtio_del_vqs(vdev);
144}
145
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200146static int rproc_virtio_find_vqs(struct virtio_device *vdev, unsigned nvqs,
147 struct virtqueue *vqs[],
148 vq_callback_t *callbacks[],
149 const char *names[])
150{
151 struct rproc *rproc = vdev_to_rproc(vdev);
152 int i, ret;
153
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200154 for (i = 0; i < nvqs; ++i) {
155 vqs[i] = rp_find_vq(vdev, i, callbacks[i], names[i]);
156 if (IS_ERR(vqs[i])) {
157 ret = PTR_ERR(vqs[i]);
158 goto error;
159 }
160 }
161
Ohad Ben-Cohen41a6ee02012-02-13 09:38:23 +0200162 /* now that the vqs are all set, boot the remote processor */
163 ret = rproc_boot(rproc);
164 if (ret) {
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300165 dev_err(&rproc->dev, "rproc_boot() failed %d\n", ret);
Ohad Ben-Cohen41a6ee02012-02-13 09:38:23 +0200166 goto error;
167 }
168
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200169 return 0;
170
171error:
Ohad Ben-Cohendab55bb2012-11-12 11:13:51 +0200172 __rproc_virtio_del_vqs(vdev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200173 return ret;
174}
175
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200176static u8 rproc_virtio_get_status(struct virtio_device *vdev)
177{
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100178 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
179 struct fw_rsc_vdev *rsc;
180
181 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
182
183 return rsc->status;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200184}
185
186static void rproc_virtio_set_status(struct virtio_device *vdev, u8 status)
187{
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100188 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
189 struct fw_rsc_vdev *rsc;
190
191 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
192
193 rsc->status = status;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100194 dev_dbg(&vdev->dev, "status: %d\n", status);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200195}
196
197static void rproc_virtio_reset(struct virtio_device *vdev)
198{
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100199 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
200 struct fw_rsc_vdev *rsc;
201
202 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
203
204 rsc->status = 0;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200205 dev_dbg(&vdev->dev, "reset !\n");
206}
207
208/* provide the vdev features as retrieved from the firmware */
209static u32 rproc_virtio_get_features(struct virtio_device *vdev)
210{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100211 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100212 struct fw_rsc_vdev *rsc;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200213
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100214 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
215
216 return rsc->dfeatures;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200217}
218
219static void rproc_virtio_finalize_features(struct virtio_device *vdev)
220{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100221 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100222 struct fw_rsc_vdev *rsc;
223
224 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200225
226 /* Give virtio_ring a chance to accept features */
227 vring_transport_features(vdev);
228
229 /*
230 * Remember the finalized features of our vdev, and provide it
231 * to the remote processor once it is powered on.
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200232 */
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100233 rsc->gfeatures = vdev->features[0];
234}
235
236static void rproc_virtio_get(struct virtio_device *vdev, unsigned offset,
237 void *buf, unsigned len)
238{
239 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
240 struct fw_rsc_vdev *rsc;
241 void *cfg;
242
243 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
244 cfg = &rsc->vring[rsc->num_of_vrings];
245
246 if (offset + len > rsc->config_len || offset + len < len) {
247 dev_err(&vdev->dev, "rproc_virtio_get: access out of bounds\n");
248 return;
249 }
250
251 memcpy(buf, cfg + offset, len);
252}
253
254static void rproc_virtio_set(struct virtio_device *vdev, unsigned offset,
255 const void *buf, unsigned len)
256{
257 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
258 struct fw_rsc_vdev *rsc;
259 void *cfg;
260
261 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
262 cfg = &rsc->vring[rsc->num_of_vrings];
263
264 if (offset + len > rsc->config_len || offset + len < len) {
265 dev_err(&vdev->dev, "rproc_virtio_set: access out of bounds\n");
266 return;
267 }
268
269 memcpy(cfg + offset, buf, len);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200270}
271
Stephen Hemminger93503932013-02-10 15:57:38 +1030272static const struct virtio_config_ops rproc_virtio_config_ops = {
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200273 .get_features = rproc_virtio_get_features,
274 .finalize_features = rproc_virtio_finalize_features,
275 .find_vqs = rproc_virtio_find_vqs,
276 .del_vqs = rproc_virtio_del_vqs,
277 .reset = rproc_virtio_reset,
278 .set_status = rproc_virtio_set_status,
279 .get_status = rproc_virtio_get_status,
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100280 .get = rproc_virtio_get,
281 .set = rproc_virtio_set,
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200282};
283
284/*
285 * This function is called whenever vdev is released, and is responsible
Ohad Ben-Cohen7183a2a2012-05-30 22:02:24 +0300286 * to decrement the remote processor's refcount which was taken when vdev was
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200287 * added.
288 *
289 * Never call this function directly; it will be called by the driver
290 * core when needed.
291 */
292static void rproc_vdev_release(struct device *dev)
293{
294 struct virtio_device *vdev = dev_to_virtio(dev);
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +0300295 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200296 struct rproc *rproc = vdev_to_rproc(vdev);
297
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +0300298 list_del(&rvdev->node);
299 kfree(rvdev);
300
Ohad Ben-Cohen7183a2a2012-05-30 22:02:24 +0300301 put_device(&rproc->dev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200302}
303
304/**
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100305 * rproc_add_virtio_dev() - register an rproc-induced virtio device
306 * @rvdev: the remote vdev
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200307 *
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100308 * This function registers a virtio device. This vdev's partent is
309 * the rproc device.
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200310 *
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100311 * Returns 0 on success or an appropriate error value otherwise.
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200312 */
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100313int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200314{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100315 struct rproc *rproc = rvdev->rproc;
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300316 struct device *dev = &rproc->dev;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100317 struct virtio_device *vdev = &rvdev->vdev;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200318 int ret;
319
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100320 vdev->id.device = id,
321 vdev->config = &rproc_virtio_config_ops,
322 vdev->dev.parent = dev;
323 vdev->dev.release = rproc_vdev_release;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200324
325 /*
326 * We're indirectly making a non-temporary copy of the rproc pointer
327 * here, because drivers probed with this vdev will indirectly
328 * access the wrapping rproc.
329 *
330 * Therefore we must increment the rproc refcount here, and decrement
331 * it _only_ when the vdev is released.
332 */
Ohad Ben-Cohen7183a2a2012-05-30 22:02:24 +0300333 get_device(&rproc->dev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200334
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100335 ret = register_virtio_device(vdev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200336 if (ret) {
Ohad Ben-Cohen7183a2a2012-05-30 22:02:24 +0300337 put_device(&rproc->dev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200338 dev_err(dev, "failed to register vdev: %d\n", ret);
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100339 goto out;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200340 }
341
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100342 dev_info(dev, "registered %s (type %d)\n", dev_name(&vdev->dev), id);
343
344out:
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200345 return ret;
346}
347
348/**
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100349 * rproc_remove_virtio_dev() - remove an rproc-induced virtio device
350 * @rvdev: the remote vdev
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200351 *
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100352 * This function unregisters an existing virtio device.
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200353 */
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100354void rproc_remove_virtio_dev(struct rproc_vdev *rvdev)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200355{
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200356 unregister_virtio_device(&rvdev->vdev);
357}