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, | |
72 | unsigned id, | |
73 | void (*callback)(struct virtqueue *vq), | |
74 | const char *name) | |
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; |
7a186941 | 79 | struct rproc_vring *rvring; |
ac8954a4 OBC |
80 | struct virtqueue *vq; |
81 | void *addr; | |
6db20ea8 | 82 | int len, size, ret; |
ac8954a4 | 83 | |
7a186941 OBC |
84 | /* we're temporarily limited to two virtqueues per rvdev */ |
85 | if (id >= ARRAY_SIZE(rvdev->vring)) | |
86 | return ERR_PTR(-EINVAL); | |
87 | ||
6457f126 MT |
88 | if (!name) |
89 | return NULL; | |
90 | ||
6db20ea8 OBC |
91 | ret = rproc_alloc_vring(rvdev, id); |
92 | if (ret) | |
93 | return ERR_PTR(ret); | |
ac8954a4 | 94 | |
6db20ea8 | 95 | rvring = &rvdev->vring[id]; |
7a186941 OBC |
96 | addr = rvring->va; |
97 | len = rvring->len; | |
ac8954a4 | 98 | |
7a186941 OBC |
99 | /* zero vring */ |
100 | size = vring_size(len, rvring->align); | |
101 | memset(addr, 0, size); | |
ac8954a4 | 102 | |
b5ab5e24 | 103 | dev_dbg(dev, "vring%d: va %p qsz %d notifyid %d\n", |
7a186941 | 104 | id, addr, len, rvring->notifyid); |
ac8954a4 | 105 | |
dd6da1c5 OBC |
106 | /* |
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 | */ | |
17bb6d40 | 110 | vq = vring_new_virtqueue(id, len, rvring->align, vdev, false, addr, |
ac8954a4 OBC |
111 | rproc_virtio_notify, callback, name); |
112 | if (!vq) { | |
b5ab5e24 | 113 | dev_err(dev, "vring_new_virtqueue %s failed\n", name); |
6db20ea8 | 114 | rproc_free_vring(rvring); |
7a186941 | 115 | return ERR_PTR(-ENOMEM); |
ac8954a4 OBC |
116 | } |
117 | ||
7a186941 OBC |
118 | rvring->vq = vq; |
119 | vq->priv = rvring; | |
ac8954a4 OBC |
120 | |
121 | return vq; | |
ac8954a4 OBC |
122 | } |
123 | ||
dab55bba | 124 | static void __rproc_virtio_del_vqs(struct virtio_device *vdev) |
ac8954a4 OBC |
125 | { |
126 | struct virtqueue *vq, *n; | |
7a186941 | 127 | struct rproc_vring *rvring; |
ac8954a4 OBC |
128 | |
129 | list_for_each_entry_safe(vq, n, &vdev->vqs, list) { | |
7a186941 OBC |
130 | rvring = vq->priv; |
131 | rvring->vq = NULL; | |
ac8954a4 | 132 | vring_del_virtqueue(vq); |
6db20ea8 | 133 | rproc_free_vring(rvring); |
ac8954a4 | 134 | } |
ac8954a4 OBC |
135 | } |
136 | ||
dab55bba OBC |
137 | static 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 | ||
ac8954a4 OBC |
147 | static 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 | ||
ac8954a4 OBC |
155 | 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 | ||
41a6ee09 OBC |
163 | /* now that the vqs are all set, boot the remote processor */ |
164 | ret = rproc_boot(rproc); | |
165 | if (ret) { | |
b5ab5e24 | 166 | dev_err(&rproc->dev, "rproc_boot() failed %d\n", ret); |
41a6ee09 OBC |
167 | goto error; |
168 | } | |
169 | ||
ac8954a4 OBC |
170 | return 0; |
171 | ||
172 | error: | |
dab55bba | 173 | __rproc_virtio_del_vqs(vdev); |
ac8954a4 OBC |
174 | return ret; |
175 | } | |
176 | ||
ac8954a4 OBC |
177 | static u8 rproc_virtio_get_status(struct virtio_device *vdev) |
178 | { | |
92b38f85 SB |
179 | 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; | |
ac8954a4 OBC |
185 | } |
186 | ||
187 | static void rproc_virtio_set_status(struct virtio_device *vdev, u8 status) | |
188 | { | |
92b38f85 SB |
189 | 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; | |
7a186941 | 195 | dev_dbg(&vdev->dev, "status: %d\n", status); |
ac8954a4 OBC |
196 | } |
197 | ||
198 | static void rproc_virtio_reset(struct virtio_device *vdev) | |
199 | { | |
92b38f85 SB |
200 | 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; | |
ac8954a4 OBC |
206 | dev_dbg(&vdev->dev, "reset !\n"); |
207 | } | |
208 | ||
209 | /* provide the vdev features as retrieved from the firmware */ | |
d0254773 | 210 | static u64 rproc_virtio_get_features(struct virtio_device *vdev) |
ac8954a4 | 211 | { |
7a186941 | 212 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
92b38f85 SB |
213 | struct fw_rsc_vdev *rsc; |
214 | ||
215 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
ac8954a4 | 216 | |
92b38f85 | 217 | return rsc->dfeatures; |
ac8954a4 OBC |
218 | } |
219 | ||
5c609a5e | 220 | static int rproc_virtio_finalize_features(struct virtio_device *vdev) |
ac8954a4 | 221 | { |
7a186941 | 222 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
92b38f85 SB |
223 | struct fw_rsc_vdev *rsc; |
224 | ||
225 | rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset; | |
ac8954a4 OBC |
226 | |
227 | /* Give virtio_ring a chance to accept features */ | |
228 | vring_transport_features(vdev); | |
229 | ||
93d389f8 MT |
230 | /* Make sure we don't have any features > 32 bits! */ |
231 | BUG_ON((u32)vdev->features != vdev->features); | |
232 | ||
ac8954a4 OBC |
233 | /* |
234 | * Remember the finalized features of our vdev, and provide it | |
235 | * to the remote processor once it is powered on. | |
ac8954a4 | 236 | */ |
e16e12be | 237 | rsc->gfeatures = vdev->features; |
5c609a5e MT |
238 | |
239 | return 0; | |
92b38f85 SB |
240 | } |
241 | ||
242 | static 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 | ||
260 | static 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); | |
ac8954a4 OBC |
276 | } |
277 | ||
93503932 | 278 | static const struct virtio_config_ops rproc_virtio_config_ops = { |
ac8954a4 OBC |
279 | .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, | |
92b38f85 SB |
286 | .get = rproc_virtio_get, |
287 | .set = rproc_virtio_set, | |
ac8954a4 OBC |
288 | }; |
289 | ||
290 | /* | |
291 | * This function is called whenever vdev is released, and is responsible | |
7183a2a7 | 292 | * to decrement the remote processor's refcount which was taken when vdev was |
ac8954a4 OBC |
293 | * added. |
294 | * | |
295 | * Never call this function directly; it will be called by the driver | |
296 | * core when needed. | |
297 | */ | |
298 | static void rproc_vdev_release(struct device *dev) | |
299 | { | |
300 | struct virtio_device *vdev = dev_to_virtio(dev); | |
6db20ea8 | 301 | struct rproc_vdev *rvdev = vdev_to_rvdev(vdev); |
ac8954a4 OBC |
302 | struct rproc *rproc = vdev_to_rproc(vdev); |
303 | ||
6db20ea8 OBC |
304 | list_del(&rvdev->node); |
305 | kfree(rvdev); | |
306 | ||
7183a2a7 | 307 | put_device(&rproc->dev); |
ac8954a4 OBC |
308 | } |
309 | ||
310 | /** | |
7a186941 OBC |
311 | * rproc_add_virtio_dev() - register an rproc-induced virtio device |
312 | * @rvdev: the remote vdev | |
ac8954a4 | 313 | * |
7a186941 OBC |
314 | * This function registers a virtio device. This vdev's partent is |
315 | * the rproc device. | |
ac8954a4 | 316 | * |
7a186941 | 317 | * Returns 0 on success or an appropriate error value otherwise. |
ac8954a4 | 318 | */ |
7a186941 | 319 | int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id) |
ac8954a4 | 320 | { |
7a186941 | 321 | struct rproc *rproc = rvdev->rproc; |
b5ab5e24 | 322 | struct device *dev = &rproc->dev; |
7a186941 | 323 | struct virtio_device *vdev = &rvdev->vdev; |
ac8954a4 OBC |
324 | int ret; |
325 | ||
7a186941 OBC |
326 | vdev->id.device = id, |
327 | vdev->config = &rproc_virtio_config_ops, | |
328 | vdev->dev.parent = dev; | |
329 | vdev->dev.release = rproc_vdev_release; | |
ac8954a4 OBC |
330 | |
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 | */ | |
7183a2a7 | 339 | get_device(&rproc->dev); |
ac8954a4 | 340 | |
7a186941 | 341 | ret = register_virtio_device(vdev); |
ac8954a4 | 342 | if (ret) { |
7183a2a7 | 343 | put_device(&rproc->dev); |
ac8954a4 | 344 | dev_err(dev, "failed to register vdev: %d\n", ret); |
7a186941 | 345 | goto out; |
ac8954a4 OBC |
346 | } |
347 | ||
7a186941 OBC |
348 | dev_info(dev, "registered %s (type %d)\n", dev_name(&vdev->dev), id); |
349 | ||
350 | out: | |
ac8954a4 OBC |
351 | return ret; |
352 | } | |
353 | ||
354 | /** | |
7a186941 OBC |
355 | * rproc_remove_virtio_dev() - remove an rproc-induced virtio device |
356 | * @rvdev: the remote vdev | |
ac8954a4 | 357 | * |
7a186941 | 358 | * This function unregisters an existing virtio device. |
ac8954a4 | 359 | */ |
7a186941 | 360 | void rproc_remove_virtio_dev(struct rproc_vdev *rvdev) |
ac8954a4 | 361 | { |
ac8954a4 OBC |
362 | unregister_virtio_device(&rvdev->vdev); |
363 | } |