Commit | Line | Data |
---|---|---|
ac8954a4 OBC |
1 | /* |
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> | |
ac8954a4 OBC |
22 | #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 | ||
ac8954a4 | 32 | /* kick the remote processor, and let it know which virtqueue to poke at */ |
46f9c2b9 | 33 | static bool rproc_virtio_notify(struct virtqueue *vq) |
ac8954a4 | 34 | { |
7a186941 OBC |
35 | struct rproc_vring *rvring = vq->priv; |
36 | struct rproc *rproc = rvring->rvdev->rproc; | |
37 | int notifyid = rvring->notifyid; | |
ac8954a4 | 38 | |
b5ab5e24 | 39 | dev_dbg(&rproc->dev, "kicking vq index: %d\n", notifyid); |
ac8954a4 | 40 | |
7a186941 | 41 | rproc->ops->kick(rproc, notifyid); |
46f9c2b9 | 42 | return true; |
ac8954a4 OBC |
43 | } |
44 | ||
45 | /** | |
46 | * rproc_vq_interrupt() - tell remoteproc that a virtqueue is interrupted | |
47 | * @rproc: handle to the remote processor | |
7a186941 | 48 | * @notifyid: index of the signalled virtqueue (unique per this @rproc) |
ac8954a4 OBC |
49 | * |
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 | * | |
7a186941 | 54 | * Returns IRQ_NONE if no message was found in the @notifyid virtqueue, |
ac8954a4 OBC |
55 | * and otherwise returns IRQ_HANDLED. |
56 | */ | |
7a186941 | 57 | irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int notifyid) |
ac8954a4 | 58 | { |
7a186941 OBC |
59 | struct rproc_vring *rvring; |
60 | ||
b5ab5e24 | 61 | dev_dbg(&rproc->dev, "vq index %d is interrupted\n", notifyid); |
7a186941 OBC |
62 | |
63 | rvring = idr_find(&rproc->notifyids, notifyid); | |
64 | if (!rvring || !rvring->vq) | |
65 | return IRQ_NONE; | |
66 | ||
67 | return vring_interrupt(0, rvring->vq); | |
ac8954a4 OBC |
68 | } |
69 | EXPORT_SYMBOL(rproc_vq_interrupt); | |
70 | ||
71 | static struct virtqueue *rp_find_vq(struct virtio_device *vdev, | |
f145928d | 72 | unsigned int id, |
ac8954a4 | 73 | void (*callback)(struct virtqueue *vq), |
f94682dd | 74 | const char *name, bool ctx) |
ac8954a4 | 75 | { |
7a186941 | 76 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
ac8954a4 | 77 | struct rproc *rproc = vdev_to_rproc(vdev); |
b5ab5e24 | 78 | struct device *dev = &rproc->dev; |
c6aed238 | 79 | struct rproc_mem_entry *mem; |
7a186941 | 80 | struct rproc_vring *rvring; |
c6aed238 | 81 | struct fw_rsc_vdev *rsc; |
ac8954a4 OBC |
82 | struct virtqueue *vq; |
83 | void *addr; | |
a863af5d | 84 | int len, size; |
ac8954a4 | 85 | |
7a186941 OBC |
86 | /* we're temporarily limited to two virtqueues per rvdev */ |
87 | if (id >= ARRAY_SIZE(rvdev->vring)) | |
88 | return ERR_PTR(-EINVAL); | |
89 | ||
6457f126 MT |
90 | if (!name) |
91 | return NULL; | |
92 | ||
c6aed238 LP |
93 | /* Search allocated memory region by name */ |
94 | mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index, | |
95 | id); | |
96 | if (!mem || !mem->va) | |
97 | return ERR_PTR(-ENOMEM); | |
98 | ||
6db20ea8 | 99 | rvring = &rvdev->vring[id]; |
c6aed238 | 100 | addr = mem->va; |
7a186941 | 101 | len = rvring->len; |
ac8954a4 | 102 | |
7a186941 OBC |
103 | /* zero vring */ |
104 | size = vring_size(len, rvring->align); | |
105 | memset(addr, 0, size); | |
ac8954a4 | 106 | |
276ec993 | 107 | dev_dbg(dev, "vring%d: va %pK qsz %d notifyid %d\n", |
730f84ce | 108 | id, addr, len, rvring->notifyid); |
ac8954a4 | 109 | |
dd6da1c5 OBC |
110 | /* |
111 | * Create the new vq, and tell virtio we're not interested in | |
112 | * the 'weak' smp barriers, since we're talking with a real device. | |
113 | */ | |
f94682dd MT |
114 | vq = vring_new_virtqueue(id, len, rvring->align, vdev, false, ctx, |
115 | addr, rproc_virtio_notify, callback, name); | |
ac8954a4 | 116 | if (!vq) { |
b5ab5e24 | 117 | dev_err(dev, "vring_new_virtqueue %s failed\n", name); |
6db20ea8 | 118 | rproc_free_vring(rvring); |
7a186941 | 119 | return ERR_PTR(-ENOMEM); |
ac8954a4 OBC |
120 | } |
121 | ||
7a186941 OBC |
122 | rvring->vq = vq; |
123 | vq->priv = rvring; | |
ac8954a4 | 124 | |
c6aed238 LP |
125 | /* Update vring in resource table */ |
126 | rsc = (void *)rproc->table_ptr + rvdev->rsc_offset; | |
127 | rsc->vring[id].da = mem->da; | |
128 | ||
ac8954a4 | 129 | return vq; |
ac8954a4 OBC |
130 | } |
131 | ||
dab55bba | 132 | static void __rproc_virtio_del_vqs(struct virtio_device *vdev) |
ac8954a4 OBC |
133 | { |
134 | struct virtqueue *vq, *n; | |
7a186941 | 135 | struct rproc_vring *rvring; |
ac8954a4 OBC |
136 | |
137 | list_for_each_entry_safe(vq, n, &vdev->vqs, list) { | |
7a186941 OBC |
138 | rvring = vq->priv; |
139 | rvring->vq = NULL; | |
ac8954a4 | 140 | vring_del_virtqueue(vq); |
ac8954a4 | 141 | } |
ac8954a4 OBC |
142 | } |
143 | ||
dab55bba OBC |
144 | static void rproc_virtio_del_vqs(struct virtio_device *vdev) |
145 | { | |
dab55bba OBC |
146 | __rproc_virtio_del_vqs(vdev); |
147 | } | |
148 | ||
f145928d | 149 | static int rproc_virtio_find_vqs(struct virtio_device *vdev, unsigned int nvqs, |
730f84ce AS |
150 | struct virtqueue *vqs[], |
151 | vq_callback_t *callbacks[], | |
fb5e31d9 | 152 | const char * const names[], |
f94682dd | 153 | const bool * ctx, |
fb5e31d9 | 154 | struct irq_affinity *desc) |
ac8954a4 | 155 | { |
ac8954a4 OBC |
156 | int i, ret; |
157 | ||
ac8954a4 | 158 | for (i = 0; i < nvqs; ++i) { |
f94682dd MT |
159 | vqs[i] = rp_find_vq(vdev, i, callbacks[i], names[i], |
160 | ctx ? ctx[i] : false); | |
ac8954a4 OBC |
161 | if (IS_ERR(vqs[i])) { |
162 | ret = PTR_ERR(vqs[i]); | |
163 | goto error; | |
164 | } | |
165 | } | |
166 | ||
167 | return 0; | |
168 | ||
169 | error: | |
dab55bba | 170 | __rproc_virtio_del_vqs(vdev); |
ac8954a4 OBC |
171 | return ret; |
172 | } | |
173 | ||
ac8954a4 OBC |
174 | static u8 rproc_virtio_get_status(struct virtio_device *vdev) |
175 | { | |
92b38f85 SB |
176 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
177 | struct fw_rsc_vdev *rsc; | |
178 | ||
179 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
180 | ||
181 | return rsc->status; | |
ac8954a4 OBC |
182 | } |
183 | ||
184 | static void rproc_virtio_set_status(struct virtio_device *vdev, u8 status) | |
185 | { | |
92b38f85 SB |
186 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
187 | struct fw_rsc_vdev *rsc; | |
188 | ||
189 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
190 | ||
191 | rsc->status = status; | |
7a186941 | 192 | dev_dbg(&vdev->dev, "status: %d\n", status); |
ac8954a4 OBC |
193 | } |
194 | ||
195 | static void rproc_virtio_reset(struct virtio_device *vdev) | |
196 | { | |
92b38f85 SB |
197 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
198 | struct fw_rsc_vdev *rsc; | |
199 | ||
200 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
201 | ||
202 | rsc->status = 0; | |
ac8954a4 OBC |
203 | dev_dbg(&vdev->dev, "reset !\n"); |
204 | } | |
205 | ||
206 | /* provide the vdev features as retrieved from the firmware */ | |
d0254773 | 207 | static u64 rproc_virtio_get_features(struct virtio_device *vdev) |
ac8954a4 | 208 | { |
7a186941 | 209 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
92b38f85 SB |
210 | struct fw_rsc_vdev *rsc; |
211 | ||
212 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
ac8954a4 | 213 | |
92b38f85 | 214 | return rsc->dfeatures; |
ac8954a4 OBC |
215 | } |
216 | ||
3a814fdf TB |
217 | static void rproc_transport_features(struct virtio_device *vdev) |
218 | { | |
219 | /* | |
220 | * Packed ring isn't enabled on remoteproc for now, | |
221 | * because remoteproc uses vring_new_virtqueue() which | |
222 | * creates virtio rings on preallocated memory. | |
223 | */ | |
224 | __virtio_clear_bit(vdev, VIRTIO_F_RING_PACKED); | |
225 | } | |
226 | ||
5c609a5e | 227 | static int rproc_virtio_finalize_features(struct virtio_device *vdev) |
ac8954a4 | 228 | { |
7a186941 | 229 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
92b38f85 SB |
230 | struct fw_rsc_vdev *rsc; |
231 | ||
232 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
ac8954a4 OBC |
233 | |
234 | /* Give virtio_ring a chance to accept features */ | |
235 | vring_transport_features(vdev); | |
236 | ||
3a814fdf TB |
237 | /* Give virtio_rproc a chance to accept features. */ |
238 | rproc_transport_features(vdev); | |
239 | ||
93d389f8 MT |
240 | /* Make sure we don't have any features > 32 bits! */ |
241 | BUG_ON((u32)vdev->features != vdev->features); | |
242 | ||
ac8954a4 OBC |
243 | /* |
244 | * Remember the finalized features of our vdev, and provide it | |
245 | * to the remote processor once it is powered on. | |
ac8954a4 | 246 | */ |
e16e12be | 247 | rsc->gfeatures = vdev->features; |
5c609a5e MT |
248 | |
249 | return 0; | |
92b38f85 SB |
250 | } |
251 | ||
f145928d AS |
252 | static void rproc_virtio_get(struct virtio_device *vdev, unsigned int offset, |
253 | void *buf, unsigned int len) | |
92b38f85 SB |
254 | { |
255 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); | |
256 | struct fw_rsc_vdev *rsc; | |
257 | void *cfg; | |
258 | ||
259 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
260 | cfg = &rsc->vring[rsc->num_of_vrings]; | |
261 | ||
262 | if (offset + len > rsc->config_len || offset + len < len) { | |
263 | dev_err(&vdev->dev, "rproc_virtio_get: access out of bounds\n"); | |
264 | return; | |
265 | } | |
266 | ||
267 | memcpy(buf, cfg + offset, len); | |
268 | } | |
269 | ||
f145928d AS |
270 | static void rproc_virtio_set(struct virtio_device *vdev, unsigned int offset, |
271 | const void *buf, unsigned int len) | |
92b38f85 SB |
272 | { |
273 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); | |
274 | struct fw_rsc_vdev *rsc; | |
275 | void *cfg; | |
276 | ||
277 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
278 | cfg = &rsc->vring[rsc->num_of_vrings]; | |
279 | ||
280 | if (offset + len > rsc->config_len || offset + len < len) { | |
281 | dev_err(&vdev->dev, "rproc_virtio_set: access out of bounds\n"); | |
282 | return; | |
283 | } | |
284 | ||
285 | memcpy(cfg + offset, buf, len); | |
ac8954a4 OBC |
286 | } |
287 | ||
93503932 | 288 | static const struct virtio_config_ops rproc_virtio_config_ops = { |
ac8954a4 OBC |
289 | .get_features = rproc_virtio_get_features, |
290 | .finalize_features = rproc_virtio_finalize_features, | |
291 | .find_vqs = rproc_virtio_find_vqs, | |
292 | .del_vqs = rproc_virtio_del_vqs, | |
293 | .reset = rproc_virtio_reset, | |
294 | .set_status = rproc_virtio_set_status, | |
295 | .get_status = rproc_virtio_get_status, | |
92b38f85 SB |
296 | .get = rproc_virtio_get, |
297 | .set = rproc_virtio_set, | |
ac8954a4 OBC |
298 | }; |
299 | ||
300 | /* | |
301 | * This function is called whenever vdev is released, and is responsible | |
7183a2a7 | 302 | * to decrement the remote processor's refcount which was taken when vdev was |
ac8954a4 OBC |
303 | * added. |
304 | * | |
305 | * Never call this function directly; it will be called by the driver | |
306 | * core when needed. | |
307 | */ | |
aab8d802 | 308 | static void rproc_virtio_dev_release(struct device *dev) |
ac8954a4 OBC |
309 | { |
310 | struct virtio_device *vdev = dev_to_virtio(dev); | |
6db20ea8 | 311 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
ac8954a4 OBC |
312 | struct rproc *rproc = vdev_to_rproc(vdev); |
313 | ||
aab8d802 | 314 | kref_put(&rvdev->refcount, rproc_vdev_release); |
6db20ea8 | 315 | |
7183a2a7 | 316 | put_device(&rproc->dev); |
ac8954a4 OBC |
317 | } |
318 | ||
319 | /** | |
7a186941 OBC |
320 | * rproc_add_virtio_dev() - register an rproc-induced virtio device |
321 | * @rvdev: the remote vdev | |
ac8954a4 | 322 | * |
7a186941 OBC |
323 | * This function registers a virtio device. This vdev's partent is |
324 | * the rproc device. | |
ac8954a4 | 325 | * |
7a186941 | 326 | * Returns 0 on success or an appropriate error value otherwise. |
ac8954a4 | 327 | */ |
7a186941 | 328 | int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id) |
ac8954a4 | 329 | { |
7a186941 | 330 | struct rproc *rproc = rvdev->rproc; |
b5ab5e24 | 331 | struct device *dev = &rproc->dev; |
7a186941 | 332 | struct virtio_device *vdev = &rvdev->vdev; |
ac8954a4 OBC |
333 | int ret; |
334 | ||
7a186941 OBC |
335 | vdev->id.device = id, |
336 | vdev->config = &rproc_virtio_config_ops, | |
337 | vdev->dev.parent = dev; | |
aab8d802 | 338 | vdev->dev.release = rproc_virtio_dev_release; |
ac8954a4 OBC |
339 | |
340 | /* | |
341 | * We're indirectly making a non-temporary copy of the rproc pointer | |
342 | * here, because drivers probed with this vdev will indirectly | |
343 | * access the wrapping rproc. | |
344 | * | |
345 | * Therefore we must increment the rproc refcount here, and decrement | |
346 | * it _only_ when the vdev is released. | |
347 | */ | |
7183a2a7 | 348 | get_device(&rproc->dev); |
ac8954a4 | 349 | |
aab8d802 BA |
350 | /* Reference the vdev and vring allocations */ |
351 | kref_get(&rvdev->refcount); | |
352 | ||
7a186941 | 353 | ret = register_virtio_device(vdev); |
ac8954a4 | 354 | if (ret) { |
900a163e | 355 | put_device(&vdev->dev); |
ac8954a4 | 356 | dev_err(dev, "failed to register vdev: %d\n", ret); |
7a186941 | 357 | goto out; |
ac8954a4 OBC |
358 | } |
359 | ||
7a186941 OBC |
360 | dev_info(dev, "registered %s (type %d)\n", dev_name(&vdev->dev), id); |
361 | ||
362 | out: | |
ac8954a4 OBC |
363 | return ret; |
364 | } | |
365 | ||
366 | /** | |
7a186941 OBC |
367 | * rproc_remove_virtio_dev() - remove an rproc-induced virtio device |
368 | * @rvdev: the remote vdev | |
ac8954a4 | 369 | * |
7a186941 | 370 | * This function unregisters an existing virtio device. |
ac8954a4 | 371 | */ |
7a186941 | 372 | void rproc_remove_virtio_dev(struct rproc_vdev *rvdev) |
ac8954a4 | 373 | { |
ac8954a4 OBC |
374 | unregister_virtio_device(&rvdev->vdev); |
375 | } |