blob: e1a10232a9437b5884e16965d4b5bced5b069ffe [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 */
Heinz Graalfs46f9c2b2013-10-29 09:38:50 +103033static bool rproc_virtio_notify(struct virtqueue *vq)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020034{
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);
Heinz Graalfs46f9c2b2013-10-29 09:38:50 +103042 return true;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020043}
44
45/**
46 * rproc_vq_interrupt() - tell remoteproc that a virtqueue is interrupted
47 * @rproc: handle to the remote processor
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010048 * @notifyid: index of the signalled virtqueue (unique per this @rproc)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020049 *
50 * This function should be called by the platform-specific rproc driver,
51 * when the remote processor signals that a specific virtqueue has pending
52 * messages available.
53 *
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010054 * Returns IRQ_NONE if no message was found in the @notifyid virtqueue,
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020055 * and otherwise returns IRQ_HANDLED.
56 */
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010057irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int notifyid)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020058{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010059 struct rproc_vring *rvring;
60
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +030061 dev_dbg(&rproc->dev, "vq index %d is interrupted\n", notifyid);
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010062
63 rvring = idr_find(&rproc->notifyids, notifyid);
64 if (!rvring || !rvring->vq)
65 return IRQ_NONE;
66
67 return vring_interrupt(0, rvring->vq);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020068}
69EXPORT_SYMBOL(rproc_vq_interrupt);
70
71static struct virtqueue *rp_find_vq(struct virtio_device *vdev,
72 unsigned id,
73 void (*callback)(struct virtqueue *vq),
74 const char *name)
75{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010076 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020077 struct rproc *rproc = vdev_to_rproc(vdev);
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +030078 struct device *dev = &rproc->dev;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010079 struct rproc_vring *rvring;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020080 struct virtqueue *vq;
81 void *addr;
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +030082 int len, size, ret;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020083
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010084 /* we're temporarily limited to two virtqueues per rvdev */
85 if (id >= ARRAY_SIZE(rvdev->vring))
86 return ERR_PTR(-EINVAL);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020087
Michael S. Tsirkin6457f122012-09-05 21:47:45 +030088 if (!name)
89 return NULL;
90
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +030091 ret = rproc_alloc_vring(rvdev, id);
92 if (ret)
93 return ERR_PTR(ret);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020094
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +030095 rvring = &rvdev->vring[id];
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010096 addr = rvring->va;
97 len = rvring->len;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +020098
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +010099 /* zero vring */
100 size = vring_size(len, rvring->align);
101 memset(addr, 0, size);
102
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300103 dev_dbg(dev, "vring%d: va %p qsz %d notifyid %d\n",
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100104 id, addr, len, rvring->notifyid);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200105
Ohad Ben-Cohendd6da1c2012-01-12 09:26:57 +0200106 /*
107 * Create the new vq, and tell virtio we're not interested in
108 * the 'weak' smp barriers, since we're talking with a real device.
109 */
Jason Wang17bb6d42012-08-28 13:54:13 +0200110 vq = vring_new_virtqueue(id, len, rvring->align, vdev, false, addr,
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200111 rproc_virtio_notify, callback, name);
112 if (!vq) {
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300113 dev_err(dev, "vring_new_virtqueue %s failed\n", name);
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +0300114 rproc_free_vring(rvring);
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100115 return ERR_PTR(-ENOMEM);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200116 }
117
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100118 rvring->vq = vq;
119 vq->priv = rvring;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200120
121 return vq;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200122}
123
Ohad Ben-Cohendab55bb2012-11-12 11:13:51 +0200124static void __rproc_virtio_del_vqs(struct virtio_device *vdev)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200125{
126 struct virtqueue *vq, *n;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100127 struct rproc_vring *rvring;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200128
129 list_for_each_entry_safe(vq, n, &vdev->vqs, list) {
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100130 rvring = vq->priv;
131 rvring->vq = NULL;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200132 vring_del_virtqueue(vq);
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +0300133 rproc_free_vring(rvring);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200134 }
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200135}
136
Ohad Ben-Cohendab55bb2012-11-12 11:13:51 +0200137static void rproc_virtio_del_vqs(struct virtio_device *vdev)
138{
139 struct rproc *rproc = vdev_to_rproc(vdev);
140
141 /* power down the remote processor before deleting vqs */
142 rproc_shutdown(rproc);
143
144 __rproc_virtio_del_vqs(vdev);
145}
146
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200147static int rproc_virtio_find_vqs(struct virtio_device *vdev, unsigned nvqs,
148 struct virtqueue *vqs[],
149 vq_callback_t *callbacks[],
150 const char *names[])
151{
152 struct rproc *rproc = vdev_to_rproc(vdev);
153 int i, ret;
154
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200155 for (i = 0; i < nvqs; ++i) {
156 vqs[i] = rp_find_vq(vdev, i, callbacks[i], names[i]);
157 if (IS_ERR(vqs[i])) {
158 ret = PTR_ERR(vqs[i]);
159 goto error;
160 }
161 }
162
Ohad Ben-Cohen41a6ee02012-02-13 09:38:23 +0200163 /* now that the vqs are all set, boot the remote processor */
164 ret = rproc_boot(rproc);
165 if (ret) {
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300166 dev_err(&rproc->dev, "rproc_boot() failed %d\n", ret);
Ohad Ben-Cohen41a6ee02012-02-13 09:38:23 +0200167 goto error;
168 }
169
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200170 return 0;
171
172error:
Ohad Ben-Cohendab55bb2012-11-12 11:13:51 +0200173 __rproc_virtio_del_vqs(vdev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200174 return ret;
175}
176
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200177static u8 rproc_virtio_get_status(struct virtio_device *vdev)
178{
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100179 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
180 struct fw_rsc_vdev *rsc;
181
182 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
183
184 return rsc->status;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200185}
186
187static void rproc_virtio_set_status(struct virtio_device *vdev, u8 status)
188{
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100189 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
190 struct fw_rsc_vdev *rsc;
191
192 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
193
194 rsc->status = status;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100195 dev_dbg(&vdev->dev, "status: %d\n", status);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200196}
197
198static void rproc_virtio_reset(struct virtio_device *vdev)
199{
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100200 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
201 struct fw_rsc_vdev *rsc;
202
203 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
204
205 rsc->status = 0;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200206 dev_dbg(&vdev->dev, "reset !\n");
207}
208
209/* provide the vdev features as retrieved from the firmware */
Michael S. Tsirkind0254772014-10-07 16:39:43 +0200210static u64 rproc_virtio_get_features(struct virtio_device *vdev)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200211{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100212 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100213 struct fw_rsc_vdev *rsc;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200214
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100215 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
216
217 return rsc->dfeatures;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200218}
219
Michael S. Tsirkin5c609a52014-12-04 20:20:27 +0200220static int rproc_virtio_finalize_features(struct virtio_device *vdev)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200221{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100222 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100223 struct fw_rsc_vdev *rsc;
224
225 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200226
227 /* Give virtio_ring a chance to accept features */
228 vring_transport_features(vdev);
229
Michael S. Tsirkin93d389f2014-11-27 13:45:58 +0200230 /* Make sure we don't have any features > 32 bits! */
231 BUG_ON((u32)vdev->features != vdev->features);
232
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200233 /*
234 * Remember the finalized features of our vdev, and provide it
235 * to the remote processor once it is powered on.
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200236 */
Michael S. Tsirkine16e12b2014-10-07 16:39:42 +0200237 rsc->gfeatures = vdev->features;
Michael S. Tsirkin5c609a52014-12-04 20:20:27 +0200238
239 return 0;
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100240}
241
242static void rproc_virtio_get(struct virtio_device *vdev, unsigned offset,
243 void *buf, unsigned len)
244{
245 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
246 struct fw_rsc_vdev *rsc;
247 void *cfg;
248
249 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
250 cfg = &rsc->vring[rsc->num_of_vrings];
251
252 if (offset + len > rsc->config_len || offset + len < len) {
253 dev_err(&vdev->dev, "rproc_virtio_get: access out of bounds\n");
254 return;
255 }
256
257 memcpy(buf, cfg + offset, len);
258}
259
260static void rproc_virtio_set(struct virtio_device *vdev, unsigned offset,
261 const void *buf, unsigned len)
262{
263 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
264 struct fw_rsc_vdev *rsc;
265 void *cfg;
266
267 rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
268 cfg = &rsc->vring[rsc->num_of_vrings];
269
270 if (offset + len > rsc->config_len || offset + len < len) {
271 dev_err(&vdev->dev, "rproc_virtio_set: access out of bounds\n");
272 return;
273 }
274
275 memcpy(cfg + offset, buf, len);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200276}
277
Stephen Hemminger93503932013-02-10 15:57:38 +1030278static const struct virtio_config_ops rproc_virtio_config_ops = {
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200279 .get_features = rproc_virtio_get_features,
280 .finalize_features = rproc_virtio_finalize_features,
281 .find_vqs = rproc_virtio_find_vqs,
282 .del_vqs = rproc_virtio_del_vqs,
283 .reset = rproc_virtio_reset,
284 .set_status = rproc_virtio_set_status,
285 .get_status = rproc_virtio_get_status,
Sjur Brændeland92b38f82013-02-21 18:15:39 +0100286 .get = rproc_virtio_get,
287 .set = rproc_virtio_set,
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200288};
289
290/*
291 * This function is called whenever vdev is released, and is responsible
Ohad Ben-Cohen7183a2a2012-05-30 22:02:24 +0300292 * to decrement the remote processor's refcount which was taken when vdev was
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200293 * added.
294 *
295 * Never call this function directly; it will be called by the driver
296 * core when needed.
297 */
298static void rproc_vdev_release(struct device *dev)
299{
300 struct virtio_device *vdev = dev_to_virtio(dev);
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +0300301 struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200302 struct rproc *rproc = vdev_to_rproc(vdev);
303
Ohad Ben-Cohen6db20ea2012-05-17 14:23:59 +0300304 list_del(&rvdev->node);
305 kfree(rvdev);
306
Ohad Ben-Cohen7183a2a2012-05-30 22:02:24 +0300307 put_device(&rproc->dev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200308}
309
310/**
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100311 * rproc_add_virtio_dev() - register an rproc-induced virtio device
312 * @rvdev: the remote vdev
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200313 *
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100314 * This function registers a virtio device. This vdev's partent is
315 * the rproc device.
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200316 *
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100317 * Returns 0 on success or an appropriate error value otherwise.
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200318 */
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100319int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200320{
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100321 struct rproc *rproc = rvdev->rproc;
Ohad Ben-Cohenb5ab5e22012-05-30 22:01:25 +0300322 struct device *dev = &rproc->dev;
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100323 struct virtio_device *vdev = &rvdev->vdev;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200324 int ret;
325
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100326 vdev->id.device = id,
327 vdev->config = &rproc_virtio_config_ops,
328 vdev->dev.parent = dev;
329 vdev->dev.release = rproc_vdev_release;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200330
331 /*
332 * We're indirectly making a non-temporary copy of the rproc pointer
333 * here, because drivers probed with this vdev will indirectly
334 * access the wrapping rproc.
335 *
336 * Therefore we must increment the rproc refcount here, and decrement
337 * it _only_ when the vdev is released.
338 */
Ohad Ben-Cohen7183a2a2012-05-30 22:02:24 +0300339 get_device(&rproc->dev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200340
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100341 ret = register_virtio_device(vdev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200342 if (ret) {
Ohad Ben-Cohen7183a2a2012-05-30 22:02:24 +0300343 put_device(&rproc->dev);
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200344 dev_err(dev, "failed to register vdev: %d\n", ret);
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100345 goto out;
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200346 }
347
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100348 dev_info(dev, "registered %s (type %d)\n", dev_name(&vdev->dev), id);
349
350out:
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200351 return ret;
352}
353
354/**
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100355 * rproc_remove_virtio_dev() - remove an rproc-induced virtio device
356 * @rvdev: the remote vdev
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200357 *
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100358 * This function unregisters an existing virtio device.
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200359 */
Ohad Ben-Cohen7a186942012-02-13 22:30:39 +0100360void rproc_remove_virtio_dev(struct rproc_vdev *rvdev)
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200361{
Ohad Ben-Cohenac8954a2011-10-20 18:15:13 +0200362 unregister_virtio_device(&rvdev->vdev);
363}