remoteproc: Remove null character write of shared mem
[linux-block.git] / drivers / remoteproc / remoteproc_core.c
CommitLineData
400e64df
OBC
1/*
2 * Remote Processor Framework
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 * Mark Grosen <mgrosen@ti.com>
10 * Fernando Guzman Lugo <fernando.lugo@ti.com>
11 * Suman Anna <s-anna@ti.com>
12 * Robert Tivy <rtivy@ti.com>
13 * Armando Uribe De Leon <x0095078@ti.com>
14 *
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * version 2 as published by the Free Software Foundation.
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 */
24
25#define pr_fmt(fmt) "%s: " fmt, __func__
26
27#include <linux/kernel.h>
28#include <linux/module.h>
29#include <linux/device.h>
30#include <linux/slab.h>
31#include <linux/mutex.h>
32#include <linux/dma-mapping.h>
33#include <linux/firmware.h>
34#include <linux/string.h>
35#include <linux/debugfs.h>
36#include <linux/remoteproc.h>
37#include <linux/iommu.h>
b5ab5e24 38#include <linux/idr.h>
400e64df 39#include <linux/elf.h>
a2b950ac 40#include <linux/crc32.h>
400e64df
OBC
41#include <linux/virtio_ids.h>
42#include <linux/virtio_ring.h>
cf59d3e9 43#include <asm/byteorder.h>
400e64df
OBC
44
45#include "remoteproc_internal.h"
46
fec47d86
DG
47static DEFINE_MUTEX(rproc_list_mutex);
48static LIST_HEAD(rproc_list);
49
400e64df 50typedef int (*rproc_handle_resources_t)(struct rproc *rproc,
fd2c15ec 51 struct resource_table *table, int len);
a2b950ac
OBC
52typedef int (*rproc_handle_resource_t)(struct rproc *rproc,
53 void *, int offset, int avail);
400e64df 54
b5ab5e24
OBC
55/* Unique indices for remoteproc devices */
56static DEFINE_IDA(rproc_dev_index);
57
8afd519c
FGL
58static const char * const rproc_crash_names[] = {
59 [RPROC_MMUFAULT] = "mmufault",
b3d39032
BA
60 [RPROC_WATCHDOG] = "watchdog",
61 [RPROC_FATAL_ERROR] = "fatal error",
8afd519c
FGL
62};
63
64/* translate rproc_crash_type to string */
65static const char *rproc_crash_to_string(enum rproc_crash_type type)
66{
67 if (type < ARRAY_SIZE(rproc_crash_names))
68 return rproc_crash_names[type];
b23f7a09 69 return "unknown";
8afd519c
FGL
70}
71
400e64df
OBC
72/*
73 * This is the IOMMU fault handler we register with the IOMMU API
74 * (when relevant; not all remote processors access memory through
75 * an IOMMU).
76 *
77 * IOMMU core will invoke this handler whenever the remote processor
78 * will try to access an unmapped device address.
400e64df
OBC
79 */
80static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
730f84ce 81 unsigned long iova, int flags, void *token)
400e64df 82{
8afd519c
FGL
83 struct rproc *rproc = token;
84
400e64df
OBC
85 dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
86
8afd519c
FGL
87 rproc_report_crash(rproc, RPROC_MMUFAULT);
88
400e64df
OBC
89 /*
90 * Let the iommu core know we're not really handling this fault;
8afd519c 91 * we just used it as a recovery trigger.
400e64df
OBC
92 */
93 return -ENOSYS;
94}
95
96static int rproc_enable_iommu(struct rproc *rproc)
97{
98 struct iommu_domain *domain;
b5ab5e24 99 struct device *dev = rproc->dev.parent;
400e64df
OBC
100 int ret;
101
315491e5
SA
102 if (!rproc->has_iommu) {
103 dev_dbg(dev, "iommu not present\n");
0798e1da 104 return 0;
400e64df
OBC
105 }
106
107 domain = iommu_domain_alloc(dev->bus);
108 if (!domain) {
109 dev_err(dev, "can't alloc iommu domain\n");
110 return -ENOMEM;
111 }
112
77ca2332 113 iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
400e64df
OBC
114
115 ret = iommu_attach_device(domain, dev);
116 if (ret) {
117 dev_err(dev, "can't attach iommu device: %d\n", ret);
118 goto free_domain;
119 }
120
121 rproc->domain = domain;
122
123 return 0;
124
125free_domain:
126 iommu_domain_free(domain);
127 return ret;
128}
129
130static void rproc_disable_iommu(struct rproc *rproc)
131{
132 struct iommu_domain *domain = rproc->domain;
b5ab5e24 133 struct device *dev = rproc->dev.parent;
400e64df
OBC
134
135 if (!domain)
136 return;
137
138 iommu_detach_device(domain, dev);
139 iommu_domain_free(domain);
400e64df
OBC
140}
141
a01f7cd6
SA
142/**
143 * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address
144 * @rproc: handle of a remote processor
145 * @da: remoteproc device address to translate
146 * @len: length of the memory region @da is pointing to
147 *
400e64df
OBC
148 * Some remote processors will ask us to allocate them physically contiguous
149 * memory regions (which we call "carveouts"), and map them to specific
a01f7cd6
SA
150 * device addresses (which are hardcoded in the firmware). They may also have
151 * dedicated memory regions internal to the processors, and use them either
152 * exclusively or alongside carveouts.
400e64df
OBC
153 *
154 * They may then ask us to copy objects into specific device addresses (e.g.
155 * code/data sections) or expose us certain symbols in other device address
156 * (e.g. their trace buffer).
157 *
a01f7cd6
SA
158 * This function is a helper function with which we can go over the allocated
159 * carveouts and translate specific device addresses to kernel virtual addresses
160 * so we can access the referenced memory. This function also allows to perform
161 * translations on the internal remoteproc memory regions through a platform
162 * implementation specific da_to_va ops, if present.
163 *
164 * The function returns a valid kernel address on success or NULL on failure.
400e64df
OBC
165 *
166 * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
167 * but only on kernel direct mapped RAM memory. Instead, we're just using
a01f7cd6
SA
168 * here the output of the DMA API for the carveouts, which should be more
169 * correct.
400e64df 170 */
72854fb0 171void *rproc_da_to_va(struct rproc *rproc, u64 da, int len)
400e64df
OBC
172{
173 struct rproc_mem_entry *carveout;
174 void *ptr = NULL;
175
a01f7cd6
SA
176 if (rproc->ops->da_to_va) {
177 ptr = rproc->ops->da_to_va(rproc, da, len);
178 if (ptr)
179 goto out;
180 }
181
400e64df
OBC
182 list_for_each_entry(carveout, &rproc->carveouts, node) {
183 int offset = da - carveout->da;
184
185 /* try next carveout if da is too small */
186 if (offset < 0)
187 continue;
188
189 /* try next carveout if da is too large */
190 if (offset + len > carveout->len)
191 continue;
192
193 ptr = carveout->va + offset;
194
195 break;
196 }
197
a01f7cd6 198out:
400e64df
OBC
199 return ptr;
200}
4afc89d6 201EXPORT_SYMBOL(rproc_da_to_va);
400e64df 202
6db20ea8 203int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
400e64df 204{
7a186941 205 struct rproc *rproc = rvdev->rproc;
b5ab5e24 206 struct device *dev = &rproc->dev;
6db20ea8 207 struct rproc_vring *rvring = &rvdev->vring[i];
c0d63157 208 struct fw_rsc_vdev *rsc;
7a186941
OBC
209 dma_addr_t dma;
210 void *va;
211 int ret, size, notifyid;
400e64df 212
7a186941 213 /* actual size of vring (in bytes) */
6db20ea8 214 size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
7a186941 215
7a186941
OBC
216 /*
217 * Allocate non-cacheable memory for the vring. In the future
218 * this call will also configure the IOMMU for us
219 */
b5ab5e24 220 va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL);
7a186941 221 if (!va) {
b5ab5e24 222 dev_err(dev->parent, "dma_alloc_coherent failed\n");
400e64df
OBC
223 return -EINVAL;
224 }
225
6db20ea8
OBC
226 /*
227 * Assign an rproc-wide unique index for this vring
228 * TODO: assign a notifyid for rvdev updates as well
6db20ea8
OBC
229 * TODO: support predefined notifyids (via resource table)
230 */
15fc6110 231 ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
b39599b7 232 if (ret < 0) {
15fc6110 233 dev_err(dev, "idr_alloc failed: %d\n", ret);
b5ab5e24 234 dma_free_coherent(dev->parent, size, va, dma);
7a186941
OBC
235 return ret;
236 }
15fc6110 237 notifyid = ret;
400e64df 238
48f18f89
BA
239 /* Potentially bump max_notifyid */
240 if (notifyid > rproc->max_notifyid)
241 rproc->max_notifyid = notifyid;
242
9d7814a9 243 dev_dbg(dev, "vring%d: va %p dma %pad size 0x%x idr %d\n",
b605ed8b 244 i, va, &dma, size, notifyid);
7a186941 245
6db20ea8
OBC
246 rvring->va = va;
247 rvring->dma = dma;
248 rvring->notifyid = notifyid;
400e64df 249
c0d63157
SB
250 /*
251 * Let the rproc know the notifyid and da of this vring.
252 * Not all platforms use dma_alloc_coherent to automatically
253 * set up the iommu. In this case the device address (da) will
254 * hold the physical address and not the device address.
255 */
256 rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
257 rsc->vring[i].da = dma;
258 rsc->vring[i].notifyid = notifyid;
400e64df
OBC
259 return 0;
260}
261
6db20ea8
OBC
262static int
263rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
7a186941
OBC
264{
265 struct rproc *rproc = rvdev->rproc;
b5ab5e24 266 struct device *dev = &rproc->dev;
6db20ea8
OBC
267 struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
268 struct rproc_vring *rvring = &rvdev->vring[i];
7a186941 269
9d7814a9 270 dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
730f84ce 271 i, vring->da, vring->num, vring->align);
7a186941 272
6db20ea8
OBC
273 /* verify queue size and vring alignment are sane */
274 if (!vring->num || !vring->align) {
275 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
730f84ce 276 vring->num, vring->align);
6db20ea8 277 return -EINVAL;
7a186941 278 }
6db20ea8
OBC
279
280 rvring->len = vring->num;
281 rvring->align = vring->align;
282 rvring->rvdev = rvdev;
283
284 return 0;
285}
286
287void rproc_free_vring(struct rproc_vring *rvring)
288{
289 int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
290 struct rproc *rproc = rvring->rvdev->rproc;
c0d63157
SB
291 int idx = rvring->rvdev->vring - rvring;
292 struct fw_rsc_vdev *rsc;
6db20ea8 293
b5ab5e24 294 dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
6db20ea8 295 idr_remove(&rproc->notifyids, rvring->notifyid);
099a3f33 296
c0d63157
SB
297 /* reset resource entry info */
298 rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
299 rsc->vring[idx].da = 0;
300 rsc->vring[idx].notifyid = -1;
7a186941
OBC
301}
302
f5bcb353
BA
303static int rproc_vdev_do_probe(struct rproc_subdev *subdev)
304{
305 struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
306
307 return rproc_add_virtio_dev(rvdev, rvdev->id);
308}
309
310static void rproc_vdev_do_remove(struct rproc_subdev *subdev)
311{
312 struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
313
314 rproc_remove_virtio_dev(rvdev);
315}
316
400e64df 317/**
fd2c15ec 318 * rproc_handle_vdev() - handle a vdev fw resource
400e64df
OBC
319 * @rproc: the remote processor
320 * @rsc: the vring resource descriptor
fd2c15ec 321 * @avail: size of available data (for sanity checking the image)
400e64df 322 *
7a186941
OBC
323 * This resource entry requests the host to statically register a virtio
324 * device (vdev), and setup everything needed to support it. It contains
325 * everything needed to make it possible: the virtio device id, virtio
326 * device features, vrings information, virtio config space, etc...
327 *
328 * Before registering the vdev, the vrings are allocated from non-cacheable
329 * physically contiguous memory. Currently we only support two vrings per
330 * remote processor (temporary limitation). We might also want to consider
331 * doing the vring allocation only later when ->find_vqs() is invoked, and
332 * then release them upon ->del_vqs().
333 *
334 * Note: @da is currently not really handled correctly: we dynamically
335 * allocate it using the DMA API, ignoring requested hard coded addresses,
336 * and we don't take care of any required IOMMU programming. This is all
337 * going to be taken care of when the generic iommu-based DMA API will be
338 * merged. Meanwhile, statically-addressed iommu-based firmware images should
339 * use RSC_DEVMEM resource entries to map their required @da to the physical
340 * address of their base CMA region (ouch, hacky!).
400e64df
OBC
341 *
342 * Returns 0 on success, or an appropriate error code otherwise
343 */
fd2c15ec 344static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
730f84ce 345 int offset, int avail)
400e64df 346{
b5ab5e24 347 struct device *dev = &rproc->dev;
7a186941
OBC
348 struct rproc_vdev *rvdev;
349 int i, ret;
400e64df 350
fd2c15ec
OBC
351 /* make sure resource isn't truncated */
352 if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
353 + rsc->config_len > avail) {
b5ab5e24 354 dev_err(dev, "vdev rsc is truncated\n");
400e64df
OBC
355 return -EINVAL;
356 }
357
fd2c15ec
OBC
358 /* make sure reserved bytes are zeroes */
359 if (rsc->reserved[0] || rsc->reserved[1]) {
360 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
400e64df
OBC
361 return -EINVAL;
362 }
363
9d7814a9 364 dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
fd2c15ec
OBC
365 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
366
7a186941
OBC
367 /* we currently support only two vrings per rvdev */
368 if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
fd2c15ec 369 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
400e64df
OBC
370 return -EINVAL;
371 }
372
899585ad 373 rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL);
7a186941
OBC
374 if (!rvdev)
375 return -ENOMEM;
400e64df 376
aab8d802
BA
377 kref_init(&rvdev->refcount);
378
f5bcb353 379 rvdev->id = rsc->id;
7a186941 380 rvdev->rproc = rproc;
400e64df 381
6db20ea8 382 /* parse the vrings */
7a186941 383 for (i = 0; i < rsc->num_of_vrings; i++) {
6db20ea8 384 ret = rproc_parse_vring(rvdev, rsc, i);
7a186941 385 if (ret)
6db20ea8 386 goto free_rvdev;
7a186941 387 }
400e64df 388
a2b950ac
OBC
389 /* remember the resource offset*/
390 rvdev->rsc_offset = offset;
fd2c15ec 391
a863af5d
BA
392 /* allocate the vring resources */
393 for (i = 0; i < rsc->num_of_vrings; i++) {
394 ret = rproc_alloc_vring(rvdev, i);
395 if (ret)
396 goto unwind_vring_allocations;
397 }
398
7a186941 399 list_add_tail(&rvdev->node, &rproc->rvdevs);
fd2c15ec 400
f5bcb353
BA
401 rproc_add_subdev(rproc, &rvdev->subdev,
402 rproc_vdev_do_probe, rproc_vdev_do_remove);
400e64df
OBC
403
404 return 0;
7a186941 405
a863af5d
BA
406unwind_vring_allocations:
407 for (i--; i >= 0; i--)
408 rproc_free_vring(&rvdev->vring[i]);
6db20ea8 409free_rvdev:
7a186941
OBC
410 kfree(rvdev);
411 return ret;
400e64df
OBC
412}
413
aab8d802
BA
414void rproc_vdev_release(struct kref *ref)
415{
416 struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount);
a863af5d 417 struct rproc_vring *rvring;
f5bcb353 418 struct rproc *rproc = rvdev->rproc;
a863af5d
BA
419 int id;
420
421 for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) {
422 rvring = &rvdev->vring[id];
423 if (!rvring->va)
424 continue;
425
426 rproc_free_vring(rvring);
427 }
aab8d802 428
f5bcb353 429 rproc_remove_subdev(rproc, &rvdev->subdev);
aab8d802
BA
430 list_del(&rvdev->node);
431 kfree(rvdev);
432}
433
400e64df
OBC
434/**
435 * rproc_handle_trace() - handle a shared trace buffer resource
436 * @rproc: the remote processor
437 * @rsc: the trace resource descriptor
fd2c15ec 438 * @avail: size of available data (for sanity checking the image)
400e64df
OBC
439 *
440 * In case the remote processor dumps trace logs into memory,
441 * export it via debugfs.
442 *
443 * Currently, the 'da' member of @rsc should contain the device address
444 * where the remote processor is dumping the traces. Later we could also
445 * support dynamically allocating this address using the generic
446 * DMA API (but currently there isn't a use case for that).
447 *
448 * Returns 0 on success, or an appropriate error code otherwise
449 */
fd2c15ec 450static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
730f84ce 451 int offset, int avail)
400e64df
OBC
452{
453 struct rproc_mem_entry *trace;
b5ab5e24 454 struct device *dev = &rproc->dev;
400e64df
OBC
455 void *ptr;
456 char name[15];
457
fd2c15ec 458 if (sizeof(*rsc) > avail) {
b5ab5e24 459 dev_err(dev, "trace rsc is truncated\n");
fd2c15ec
OBC
460 return -EINVAL;
461 }
462
463 /* make sure reserved bytes are zeroes */
464 if (rsc->reserved) {
465 dev_err(dev, "trace rsc has non zero reserved bytes\n");
466 return -EINVAL;
467 }
468
400e64df
OBC
469 /* what's the kernel address of this resource ? */
470 ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
471 if (!ptr) {
472 dev_err(dev, "erroneous trace resource entry\n");
473 return -EINVAL;
474 }
475
476 trace = kzalloc(sizeof(*trace), GFP_KERNEL);
172e6ab1 477 if (!trace)
400e64df 478 return -ENOMEM;
400e64df
OBC
479
480 /* set the trace buffer dma properties */
481 trace->len = rsc->len;
482 trace->va = ptr;
483
484 /* make sure snprintf always null terminates, even if truncating */
485 snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
486
487 /* create the debugfs entry */
488 trace->priv = rproc_create_trace_file(name, rproc, trace);
489 if (!trace->priv) {
490 trace->va = NULL;
491 kfree(trace);
492 return -EINVAL;
493 }
494
495 list_add_tail(&trace->node, &rproc->traces);
496
497 rproc->num_traces++;
498
35386166
LJ
499 dev_dbg(dev, "%s added: va %p, da 0x%x, len 0x%x\n",
500 name, ptr, rsc->da, rsc->len);
400e64df
OBC
501
502 return 0;
503}
504
505/**
506 * rproc_handle_devmem() - handle devmem resource entry
507 * @rproc: remote processor handle
508 * @rsc: the devmem resource entry
fd2c15ec 509 * @avail: size of available data (for sanity checking the image)
400e64df
OBC
510 *
511 * Remote processors commonly need to access certain on-chip peripherals.
512 *
513 * Some of these remote processors access memory via an iommu device,
514 * and might require us to configure their iommu before they can access
515 * the on-chip peripherals they need.
516 *
517 * This resource entry is a request to map such a peripheral device.
518 *
519 * These devmem entries will contain the physical address of the device in
520 * the 'pa' member. If a specific device address is expected, then 'da' will
521 * contain it (currently this is the only use case supported). 'len' will
522 * contain the size of the physical region we need to map.
523 *
524 * Currently we just "trust" those devmem entries to contain valid physical
525 * addresses, but this is going to change: we want the implementations to
526 * tell us ranges of physical addresses the firmware is allowed to request,
527 * and not allow firmwares to request access to physical addresses that
528 * are outside those ranges.
529 */
fd2c15ec 530static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
730f84ce 531 int offset, int avail)
400e64df
OBC
532{
533 struct rproc_mem_entry *mapping;
b5ab5e24 534 struct device *dev = &rproc->dev;
400e64df
OBC
535 int ret;
536
537 /* no point in handling this resource without a valid iommu domain */
538 if (!rproc->domain)
539 return -EINVAL;
540
fd2c15ec 541 if (sizeof(*rsc) > avail) {
b5ab5e24 542 dev_err(dev, "devmem rsc is truncated\n");
fd2c15ec
OBC
543 return -EINVAL;
544 }
545
546 /* make sure reserved bytes are zeroes */
547 if (rsc->reserved) {
b5ab5e24 548 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
fd2c15ec
OBC
549 return -EINVAL;
550 }
551
400e64df 552 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
172e6ab1 553 if (!mapping)
400e64df 554 return -ENOMEM;
400e64df
OBC
555
556 ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
557 if (ret) {
b5ab5e24 558 dev_err(dev, "failed to map devmem: %d\n", ret);
400e64df
OBC
559 goto out;
560 }
561
562 /*
563 * We'll need this info later when we'll want to unmap everything
564 * (e.g. on shutdown).
565 *
566 * We can't trust the remote processor not to change the resource
567 * table, so we must maintain this info independently.
568 */
569 mapping->da = rsc->da;
570 mapping->len = rsc->len;
571 list_add_tail(&mapping->node, &rproc->mappings);
572
b5ab5e24 573 dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
730f84ce 574 rsc->pa, rsc->da, rsc->len);
400e64df
OBC
575
576 return 0;
577
578out:
579 kfree(mapping);
580 return ret;
581}
582
583/**
584 * rproc_handle_carveout() - handle phys contig memory allocation requests
585 * @rproc: rproc handle
586 * @rsc: the resource entry
fd2c15ec 587 * @avail: size of available data (for image validation)
400e64df
OBC
588 *
589 * This function will handle firmware requests for allocation of physically
590 * contiguous memory regions.
591 *
592 * These request entries should come first in the firmware's resource table,
593 * as other firmware entries might request placing other data objects inside
594 * these memory regions (e.g. data/code segments, trace resource entries, ...).
595 *
596 * Allocating memory this way helps utilizing the reserved physical memory
597 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
598 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
599 * pressure is important; it may have a substantial impact on performance.
600 */
fd2c15ec 601static int rproc_handle_carveout(struct rproc *rproc,
730f84ce
AS
602 struct fw_rsc_carveout *rsc,
603 int offset, int avail)
400e64df
OBC
604{
605 struct rproc_mem_entry *carveout, *mapping;
b5ab5e24 606 struct device *dev = &rproc->dev;
400e64df
OBC
607 dma_addr_t dma;
608 void *va;
609 int ret;
610
fd2c15ec 611 if (sizeof(*rsc) > avail) {
b5ab5e24 612 dev_err(dev, "carveout rsc is truncated\n");
fd2c15ec
OBC
613 return -EINVAL;
614 }
615
616 /* make sure reserved bytes are zeroes */
617 if (rsc->reserved) {
618 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
619 return -EINVAL;
620 }
621
9d7814a9 622 dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
35386166 623 rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
fd2c15ec 624
400e64df 625 carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
172e6ab1 626 if (!carveout)
7168d914 627 return -ENOMEM;
400e64df 628
b5ab5e24 629 va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
400e64df 630 if (!va) {
9c219b23
LJ
631 dev_err(dev->parent,
632 "failed to allocate dma memory: len 0x%x\n", rsc->len);
400e64df
OBC
633 ret = -ENOMEM;
634 goto free_carv;
635 }
636
b605ed8b
AS
637 dev_dbg(dev, "carveout va %p, dma %pad, len 0x%x\n",
638 va, &dma, rsc->len);
400e64df
OBC
639
640 /*
641 * Ok, this is non-standard.
642 *
643 * Sometimes we can't rely on the generic iommu-based DMA API
644 * to dynamically allocate the device address and then set the IOMMU
645 * tables accordingly, because some remote processors might
646 * _require_ us to use hard coded device addresses that their
647 * firmware was compiled with.
648 *
649 * In this case, we must use the IOMMU API directly and map
650 * the memory to the device address as expected by the remote
651 * processor.
652 *
653 * Obviously such remote processor devices should not be configured
654 * to use the iommu-based DMA API: we expect 'dma' to contain the
655 * physical address in this case.
656 */
657 if (rproc->domain) {
7168d914
DC
658 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
659 if (!mapping) {
7168d914
DC
660 ret = -ENOMEM;
661 goto dma_free;
662 }
663
400e64df 664 ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
730f84ce 665 rsc->flags);
400e64df
OBC
666 if (ret) {
667 dev_err(dev, "iommu_map failed: %d\n", ret);
7168d914 668 goto free_mapping;
400e64df
OBC
669 }
670
671 /*
672 * We'll need this info later when we'll want to unmap
673 * everything (e.g. on shutdown).
674 *
675 * We can't trust the remote processor not to change the
676 * resource table, so we must maintain this info independently.
677 */
678 mapping->da = rsc->da;
679 mapping->len = rsc->len;
680 list_add_tail(&mapping->node, &rproc->mappings);
681
b605ed8b
AS
682 dev_dbg(dev, "carveout mapped 0x%x to %pad\n",
683 rsc->da, &dma);
400e64df
OBC
684 }
685
0e49b72c
OBC
686 /*
687 * Some remote processors might need to know the pa
688 * even though they are behind an IOMMU. E.g., OMAP4's
689 * remote M3 processor needs this so it can control
690 * on-chip hardware accelerators that are not behind
691 * the IOMMU, and therefor must know the pa.
692 *
693 * Generally we don't want to expose physical addresses
694 * if we don't have to (remote processors are generally
695 * _not_ trusted), so we might want to do this only for
696 * remote processor that _must_ have this (e.g. OMAP4's
697 * dual M3 subsystem).
698 *
699 * Non-IOMMU processors might also want to have this info.
700 * In this case, the device address and the physical address
701 * are the same.
702 */
703 rsc->pa = dma;
704
400e64df
OBC
705 carveout->va = va;
706 carveout->len = rsc->len;
707 carveout->dma = dma;
708 carveout->da = rsc->da;
709
710 list_add_tail(&carveout->node, &rproc->carveouts);
711
712 return 0;
713
7168d914
DC
714free_mapping:
715 kfree(mapping);
400e64df 716dma_free:
b5ab5e24 717 dma_free_coherent(dev->parent, rsc->len, va, dma);
400e64df
OBC
718free_carv:
719 kfree(carveout);
400e64df
OBC
720 return ret;
721}
722
e12bc14b
OBC
723/*
724 * A lookup table for resource handlers. The indices are defined in
725 * enum fw_resource_type.
726 */
232fcdbb 727static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
fd2c15ec
OBC
728 [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
729 [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
730 [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
232fcdbb
SB
731 [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
732};
733
400e64df 734/* handle firmware resource entries before booting the remote processor */
a4b24c75 735static int rproc_handle_resources(struct rproc *rproc,
232fcdbb 736 rproc_handle_resource_t handlers[RSC_LAST])
400e64df 737{
b5ab5e24 738 struct device *dev = &rproc->dev;
e12bc14b 739 rproc_handle_resource_t handler;
fd2c15ec
OBC
740 int ret = 0, i;
741
d4bb86f2
BA
742 if (!rproc->table_ptr)
743 return 0;
744
a2b950ac
OBC
745 for (i = 0; i < rproc->table_ptr->num; i++) {
746 int offset = rproc->table_ptr->offset[i];
747 struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
a4b24c75 748 int avail = rproc->table_sz - offset - sizeof(*hdr);
fd2c15ec
OBC
749 void *rsc = (void *)hdr + sizeof(*hdr);
750
751 /* make sure table isn't truncated */
752 if (avail < 0) {
753 dev_err(dev, "rsc table is truncated\n");
754 return -EINVAL;
755 }
400e64df 756
fd2c15ec 757 dev_dbg(dev, "rsc: type %d\n", hdr->type);
400e64df 758
fd2c15ec
OBC
759 if (hdr->type >= RSC_LAST) {
760 dev_warn(dev, "unsupported resource %d\n", hdr->type);
e12bc14b 761 continue;
400e64df
OBC
762 }
763
232fcdbb 764 handler = handlers[hdr->type];
e12bc14b
OBC
765 if (!handler)
766 continue;
767
a2b950ac 768 ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
7a186941 769 if (ret)
400e64df 770 break;
fd2c15ec 771 }
400e64df
OBC
772
773 return ret;
774}
775
7bdc9650
BA
776static int rproc_probe_subdevices(struct rproc *rproc)
777{
778 struct rproc_subdev *subdev;
779 int ret;
780
781 list_for_each_entry(subdev, &rproc->subdevs, node) {
782 ret = subdev->probe(subdev);
783 if (ret)
784 goto unroll_registration;
785 }
786
787 return 0;
788
789unroll_registration:
790 list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node)
791 subdev->remove(subdev);
792
793 return ret;
794}
795
796static void rproc_remove_subdevices(struct rproc *rproc)
797{
798 struct rproc_subdev *subdev;
799
f9cbbd25 800 list_for_each_entry_reverse(subdev, &rproc->subdevs, node)
7bdc9650
BA
801 subdev->remove(subdev);
802}
803
400e64df
OBC
804/**
805 * rproc_resource_cleanup() - clean up and free all acquired resources
806 * @rproc: rproc handle
807 *
808 * This function will free all resources acquired for @rproc, and it
7a186941 809 * is called whenever @rproc either shuts down or fails to boot.
400e64df
OBC
810 */
811static void rproc_resource_cleanup(struct rproc *rproc)
812{
813 struct rproc_mem_entry *entry, *tmp;
d81fb32f 814 struct rproc_vdev *rvdev, *rvtmp;
b5ab5e24 815 struct device *dev = &rproc->dev;
400e64df
OBC
816
817 /* clean up debugfs trace entries */
818 list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
819 rproc_remove_trace_file(entry->priv);
820 rproc->num_traces--;
821 list_del(&entry->node);
822 kfree(entry);
823 }
824
400e64df
OBC
825 /* clean up iommu mapping entries */
826 list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
827 size_t unmapped;
828
829 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
830 if (unmapped != entry->len) {
831 /* nothing much to do besides complaining */
e981f6d4 832 dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
730f84ce 833 unmapped);
400e64df
OBC
834 }
835
836 list_del(&entry->node);
837 kfree(entry);
838 }
b6356a01
SA
839
840 /* clean up carveout allocations */
841 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
172e6ab1
SA
842 dma_free_coherent(dev->parent, entry->len, entry->va,
843 entry->dma);
b6356a01
SA
844 list_del(&entry->node);
845 kfree(entry);
846 }
d81fb32f
BA
847
848 /* clean up remote vdev entries */
f5bcb353 849 list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
2b45cef5 850 kref_put(&rvdev->refcount, rproc_vdev_release);
400e64df
OBC
851}
852
1efa30d0
SJ
853static int rproc_start(struct rproc *rproc, const struct firmware *fw)
854{
a4b24c75 855 struct resource_table *loaded_table;
1efa30d0 856 struct device *dev = &rproc->dev;
a4b24c75 857 int ret;
1efa30d0
SJ
858
859 /* load the ELF segments to memory */
860 ret = rproc_load_segments(rproc, fw);
861 if (ret) {
862 dev_err(dev, "Failed to load program segments: %d\n", ret);
863 return ret;
864 }
865
866 /*
867 * The starting device has been given the rproc->cached_table as the
868 * resource table. The address of the vring along with the other
869 * allocated resources (carveouts etc) is stored in cached_table.
870 * In order to pass this information to the remote device we must copy
871 * this information to device memory. We also update the table_ptr so
872 * that any subsequent changes will be applied to the loaded version.
873 */
874 loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
875 if (loaded_table) {
a4b24c75 876 memcpy(loaded_table, rproc->cached_table, rproc->table_sz);
1efa30d0
SJ
877 rproc->table_ptr = loaded_table;
878 }
879
880 /* power up the remote processor */
881 ret = rproc->ops->start(rproc);
882 if (ret) {
883 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
884 return ret;
885 }
886
887 /* probe any subdevices for the remote processor */
888 ret = rproc_probe_subdevices(rproc);
889 if (ret) {
890 dev_err(dev, "failed to probe subdevices for %s: %d\n",
891 rproc->name, ret);
892 rproc->ops->stop(rproc);
893 return ret;
894 }
895
896 rproc->state = RPROC_RUNNING;
897
898 dev_info(dev, "remote processor %s is now up\n", rproc->name);
899
900 return 0;
901}
902
400e64df
OBC
903/*
904 * take a firmware and boot a remote processor with it.
905 */
906static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
907{
b5ab5e24 908 struct device *dev = &rproc->dev;
400e64df 909 const char *name = rproc->firmware;
58b64090 910 int ret;
400e64df
OBC
911
912 ret = rproc_fw_sanity_check(rproc, fw);
913 if (ret)
914 return ret;
915
e981f6d4 916 dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
400e64df
OBC
917
918 /*
919 * if enabling an IOMMU isn't relevant for this rproc, this is
920 * just a nop
921 */
922 ret = rproc_enable_iommu(rproc);
923 if (ret) {
924 dev_err(dev, "can't enable iommu: %d\n", ret);
925 return ret;
926 }
927
3e5f9eb5 928 rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
988d204c 929
58b64090
BA
930 /* load resource table */
931 ret = rproc_load_rsc_table(rproc, fw);
932 if (ret)
933 goto disable_iommu;
a0c10687 934
b35d7afc
BA
935 /* reset max_notifyid */
936 rproc->max_notifyid = -1;
937
400e64df 938 /* handle fw resources which are required to boot rproc */
a4b24c75 939 ret = rproc_handle_resources(rproc, rproc_loading_handlers);
400e64df
OBC
940 if (ret) {
941 dev_err(dev, "Failed to process resources: %d\n", ret);
229b85a6 942 goto clean_up_resources;
400e64df
OBC
943 }
944
1efa30d0
SJ
945 ret = rproc_start(rproc, fw);
946 if (ret)
229b85a6 947 goto clean_up_resources;
400e64df
OBC
948
949 return 0;
950
229b85a6
BA
951clean_up_resources:
952 rproc_resource_cleanup(rproc);
a0c10687
BA
953 kfree(rproc->cached_table);
954 rproc->cached_table = NULL;
988d204c 955 rproc->table_ptr = NULL;
58b64090 956disable_iommu:
400e64df
OBC
957 rproc_disable_iommu(rproc);
958 return ret;
959}
960
961/*
5e6533f7 962 * take a firmware and boot it up.
400e64df
OBC
963 *
964 * Note: this function is called asynchronously upon registration of the
965 * remote processor (so we must wait until it completes before we try
966 * to unregister the device. one other option is just to use kref here,
967 * that might be cleaner).
968 */
5e6533f7 969static void rproc_auto_boot_callback(const struct firmware *fw, void *context)
400e64df
OBC
970{
971 struct rproc *rproc = context;
a2b950ac 972
7a20c64d 973 rproc_boot(rproc);
ddf71187 974
3cc6e787 975 release_firmware(fw);
400e64df
OBC
976}
977
5e6533f7 978static int rproc_trigger_auto_boot(struct rproc *rproc)
70b85ef8
FGL
979{
980 int ret;
981
70b85ef8 982 /*
70b85ef8
FGL
983 * We're initiating an asynchronous firmware loading, so we can
984 * be built-in kernel code, without hanging the boot process.
985 */
986 ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
987 rproc->firmware, &rproc->dev, GFP_KERNEL,
5e6533f7 988 rproc, rproc_auto_boot_callback);
2099c77d 989 if (ret < 0)
70b85ef8 990 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
70b85ef8
FGL
991
992 return ret;
993}
994
1efa30d0
SJ
995static int rproc_stop(struct rproc *rproc)
996{
997 struct device *dev = &rproc->dev;
998 int ret;
999
1000 /* remove any subdevices for the remote processor */
1001 rproc_remove_subdevices(rproc);
1002
0a8b81cb
BA
1003 /* the installed resource table is no longer accessible */
1004 rproc->table_ptr = rproc->cached_table;
1005
1efa30d0
SJ
1006 /* power off the remote processor */
1007 ret = rproc->ops->stop(rproc);
1008 if (ret) {
1009 dev_err(dev, "can't stop rproc: %d\n", ret);
1010 return ret;
1011 }
1012
1efa30d0
SJ
1013 rproc->state = RPROC_OFFLINE;
1014
1015 dev_info(dev, "stopped remote processor %s\n", rproc->name);
1016
1017 return 0;
1018}
1019
70b85ef8
FGL
1020/**
1021 * rproc_trigger_recovery() - recover a remoteproc
1022 * @rproc: the remote processor
1023 *
56324d7a 1024 * The recovery is done by resetting all the virtio devices, that way all the
70b85ef8
FGL
1025 * rpmsg drivers will be reseted along with the remote processor making the
1026 * remoteproc functional again.
1027 *
1028 * This function can sleep, so it cannot be called from atomic context.
1029 */
1030int rproc_trigger_recovery(struct rproc *rproc)
1031{
7e83cab8
SJ
1032 const struct firmware *firmware_p;
1033 struct device *dev = &rproc->dev;
1034 int ret;
1035
1036 dev_err(dev, "recovering %s\n", rproc->name);
70b85ef8 1037
7e83cab8
SJ
1038 ret = mutex_lock_interruptible(&rproc->lock);
1039 if (ret)
1040 return ret;
1041
1042 ret = rproc_stop(rproc);
1043 if (ret)
1044 goto unlock_mutex;
ddf71187 1045
7e83cab8
SJ
1046 /* load firmware */
1047 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1048 if (ret < 0) {
1049 dev_err(dev, "request_firmware failed: %d\n", ret);
1050 goto unlock_mutex;
1051 }
ddf71187 1052
7e83cab8
SJ
1053 /* boot the remote processor up again */
1054 ret = rproc_start(rproc, firmware_p);
1055
1056 release_firmware(firmware_p);
1057
1058unlock_mutex:
1059 mutex_unlock(&rproc->lock);
1060 return ret;
70b85ef8
FGL
1061}
1062
8afd519c
FGL
1063/**
1064 * rproc_crash_handler_work() - handle a crash
1065 *
1066 * This function needs to handle everything related to a crash, like cpu
1067 * registers and stack dump, information to help to debug the fatal error, etc.
1068 */
1069static void rproc_crash_handler_work(struct work_struct *work)
1070{
1071 struct rproc *rproc = container_of(work, struct rproc, crash_handler);
1072 struct device *dev = &rproc->dev;
1073
1074 dev_dbg(dev, "enter %s\n", __func__);
1075
1076 mutex_lock(&rproc->lock);
1077
1078 if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
1079 /* handle only the first crash detected */
1080 mutex_unlock(&rproc->lock);
1081 return;
1082 }
1083
1084 rproc->state = RPROC_CRASHED;
1085 dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
1086 rproc->name);
1087
1088 mutex_unlock(&rproc->lock);
1089
2e37abb8
FGL
1090 if (!rproc->recovery_disabled)
1091 rproc_trigger_recovery(rproc);
8afd519c
FGL
1092}
1093
400e64df 1094/**
1b0ef906 1095 * rproc_boot() - boot a remote processor
400e64df
OBC
1096 * @rproc: handle of a remote processor
1097 *
1098 * Boot a remote processor (i.e. load its firmware, power it on, ...).
1099 *
1100 * If the remote processor is already powered on, this function immediately
1101 * returns (successfully).
1102 *
1103 * Returns 0 on success, and an appropriate error value otherwise.
1104 */
1b0ef906 1105int rproc_boot(struct rproc *rproc)
400e64df
OBC
1106{
1107 const struct firmware *firmware_p;
1108 struct device *dev;
1109 int ret;
1110
1111 if (!rproc) {
1112 pr_err("invalid rproc handle\n");
1113 return -EINVAL;
1114 }
1115
b5ab5e24 1116 dev = &rproc->dev;
400e64df
OBC
1117
1118 ret = mutex_lock_interruptible(&rproc->lock);
1119 if (ret) {
1120 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1121 return ret;
1122 }
1123
2099c77d
SJ
1124 if (rproc->state == RPROC_DELETED) {
1125 ret = -ENODEV;
1126 dev_err(dev, "can't boot deleted rproc %s\n", rproc->name);
1127 goto unlock_mutex;
1128 }
1129
400e64df
OBC
1130 /* skip the boot process if rproc is already powered up */
1131 if (atomic_inc_return(&rproc->power) > 1) {
1132 ret = 0;
1133 goto unlock_mutex;
1134 }
1135
1136 dev_info(dev, "powering up %s\n", rproc->name);
1137
1138 /* load firmware */
1139 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1140 if (ret < 0) {
1141 dev_err(dev, "request_firmware failed: %d\n", ret);
1142 goto downref_rproc;
1143 }
1144
1145 ret = rproc_fw_boot(rproc, firmware_p);
1146
1147 release_firmware(firmware_p);
1148
1149downref_rproc:
fbb6aacb 1150 if (ret)
400e64df 1151 atomic_dec(&rproc->power);
400e64df
OBC
1152unlock_mutex:
1153 mutex_unlock(&rproc->lock);
1154 return ret;
1155}
1156EXPORT_SYMBOL(rproc_boot);
1157
1158/**
1159 * rproc_shutdown() - power off the remote processor
1160 * @rproc: the remote processor
1161 *
1162 * Power off a remote processor (previously booted with rproc_boot()).
1163 *
1164 * In case @rproc is still being used by an additional user(s), then
1165 * this function will just decrement the power refcount and exit,
1166 * without really powering off the device.
1167 *
1168 * Every call to rproc_boot() must (eventually) be accompanied by a call
1169 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1170 *
1171 * Notes:
1172 * - we're not decrementing the rproc's refcount, only the power refcount.
1173 * which means that the @rproc handle stays valid even after rproc_shutdown()
1174 * returns, and users can still use it with a subsequent rproc_boot(), if
1175 * needed.
400e64df
OBC
1176 */
1177void rproc_shutdown(struct rproc *rproc)
1178{
b5ab5e24 1179 struct device *dev = &rproc->dev;
400e64df
OBC
1180 int ret;
1181
1182 ret = mutex_lock_interruptible(&rproc->lock);
1183 if (ret) {
1184 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1185 return;
1186 }
1187
1188 /* if the remote proc is still needed, bail out */
1189 if (!atomic_dec_and_test(&rproc->power))
1190 goto out;
1191
1efa30d0 1192 ret = rproc_stop(rproc);
400e64df
OBC
1193 if (ret) {
1194 atomic_inc(&rproc->power);
400e64df
OBC
1195 goto out;
1196 }
1197
1198 /* clean up all acquired resources */
1199 rproc_resource_cleanup(rproc);
1200
1201 rproc_disable_iommu(rproc);
1202
988d204c 1203 /* Free the copy of the resource table */
a0c10687
BA
1204 kfree(rproc->cached_table);
1205 rproc->cached_table = NULL;
988d204c 1206 rproc->table_ptr = NULL;
400e64df
OBC
1207out:
1208 mutex_unlock(&rproc->lock);
400e64df
OBC
1209}
1210EXPORT_SYMBOL(rproc_shutdown);
1211
fec47d86
DG
1212/**
1213 * rproc_get_by_phandle() - find a remote processor by phandle
1214 * @phandle: phandle to the rproc
1215 *
1216 * Finds an rproc handle using the remote processor's phandle, and then
1217 * return a handle to the rproc.
1218 *
1219 * This function increments the remote processor's refcount, so always
1220 * use rproc_put() to decrement it back once rproc isn't needed anymore.
1221 *
1222 * Returns the rproc handle on success, and NULL on failure.
1223 */
8de3dbd0 1224#ifdef CONFIG_OF
fec47d86
DG
1225struct rproc *rproc_get_by_phandle(phandle phandle)
1226{
1227 struct rproc *rproc = NULL, *r;
1228 struct device_node *np;
1229
1230 np = of_find_node_by_phandle(phandle);
1231 if (!np)
1232 return NULL;
1233
1234 mutex_lock(&rproc_list_mutex);
1235 list_for_each_entry(r, &rproc_list, node) {
1236 if (r->dev.parent && r->dev.parent->of_node == np) {
fbb6aacb
BA
1237 /* prevent underlying implementation from being removed */
1238 if (!try_module_get(r->dev.parent->driver->owner)) {
1239 dev_err(&r->dev, "can't get owner\n");
1240 break;
1241 }
1242
fec47d86
DG
1243 rproc = r;
1244 get_device(&rproc->dev);
1245 break;
1246 }
1247 }
1248 mutex_unlock(&rproc_list_mutex);
1249
1250 of_node_put(np);
1251
1252 return rproc;
1253}
8de3dbd0
OBC
1254#else
1255struct rproc *rproc_get_by_phandle(phandle phandle)
1256{
1257 return NULL;
1258}
1259#endif
fec47d86
DG
1260EXPORT_SYMBOL(rproc_get_by_phandle);
1261
400e64df 1262/**
160e7c84 1263 * rproc_add() - register a remote processor
400e64df
OBC
1264 * @rproc: the remote processor handle to register
1265 *
1266 * Registers @rproc with the remoteproc framework, after it has been
1267 * allocated with rproc_alloc().
1268 *
1269 * This is called by the platform-specific rproc implementation, whenever
1270 * a new remote processor device is probed.
1271 *
1272 * Returns 0 on success and an appropriate error code otherwise.
1273 *
1274 * Note: this function initiates an asynchronous firmware loading
1275 * context, which will look for virtio devices supported by the rproc's
1276 * firmware.
1277 *
1278 * If found, those virtio devices will be created and added, so as a result
7a186941 1279 * of registering this remote processor, additional virtio drivers might be
400e64df 1280 * probed.
400e64df 1281 */
160e7c84 1282int rproc_add(struct rproc *rproc)
400e64df 1283{
b5ab5e24 1284 struct device *dev = &rproc->dev;
70b85ef8 1285 int ret;
400e64df 1286
b5ab5e24
OBC
1287 ret = device_add(dev);
1288 if (ret < 0)
1289 return ret;
400e64df 1290
b5ab5e24 1291 dev_info(dev, "%s is available\n", rproc->name);
400e64df
OBC
1292
1293 /* create debugfs entries */
1294 rproc_create_debug_dir(rproc);
7a20c64d
SJ
1295
1296 /* if rproc is marked always-on, request it to boot */
1297 if (rproc->auto_boot) {
5e6533f7 1298 ret = rproc_trigger_auto_boot(rproc);
7a20c64d
SJ
1299 if (ret < 0)
1300 return ret;
1301 }
400e64df 1302
d2e12e66
DG
1303 /* expose to rproc_get_by_phandle users */
1304 mutex_lock(&rproc_list_mutex);
1305 list_add(&rproc->node, &rproc_list);
1306 mutex_unlock(&rproc_list_mutex);
1307
1308 return 0;
400e64df 1309}
160e7c84 1310EXPORT_SYMBOL(rproc_add);
400e64df 1311
b5ab5e24
OBC
1312/**
1313 * rproc_type_release() - release a remote processor instance
1314 * @dev: the rproc's device
1315 *
1316 * This function should _never_ be called directly.
1317 *
1318 * It will be called by the driver core when no one holds a valid pointer
1319 * to @dev anymore.
1320 */
1321static void rproc_type_release(struct device *dev)
1322{
1323 struct rproc *rproc = container_of(dev, struct rproc, dev);
1324
7183a2a7
OBC
1325 dev_info(&rproc->dev, "releasing %s\n", rproc->name);
1326
b5ab5e24
OBC
1327 idr_destroy(&rproc->notifyids);
1328
1329 if (rproc->index >= 0)
1330 ida_simple_remove(&rproc_dev_index, rproc->index);
1331
0f57dc6a 1332 kfree(rproc->firmware);
fb98e2bd 1333 kfree(rproc->ops);
b5ab5e24
OBC
1334 kfree(rproc);
1335}
1336
c42ca04d 1337static const struct device_type rproc_type = {
b5ab5e24
OBC
1338 .name = "remoteproc",
1339 .release = rproc_type_release,
1340};
400e64df
OBC
1341
1342/**
1343 * rproc_alloc() - allocate a remote processor handle
1344 * @dev: the underlying device
1345 * @name: name of this remote processor
1346 * @ops: platform-specific handlers (mainly start/stop)
8b4aec9a 1347 * @firmware: name of firmware file to load, can be NULL
400e64df
OBC
1348 * @len: length of private data needed by the rproc driver (in bytes)
1349 *
1350 * Allocates a new remote processor handle, but does not register
8b4aec9a 1351 * it yet. if @firmware is NULL, a default name is used.
400e64df
OBC
1352 *
1353 * This function should be used by rproc implementations during initialization
1354 * of the remote processor.
1355 *
1356 * After creating an rproc handle using this function, and when ready,
160e7c84 1357 * implementations should then call rproc_add() to complete
400e64df
OBC
1358 * the registration of the remote processor.
1359 *
1360 * On success the new rproc is returned, and on failure, NULL.
1361 *
1362 * Note: _never_ directly deallocate @rproc, even if it was not registered
433c0e04 1363 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
400e64df
OBC
1364 */
1365struct rproc *rproc_alloc(struct device *dev, const char *name,
730f84ce
AS
1366 const struct rproc_ops *ops,
1367 const char *firmware, int len)
400e64df
OBC
1368{
1369 struct rproc *rproc;
8b4aec9a 1370 char *p, *template = "rproc-%s-fw";
0f57dc6a 1371 int name_len;
400e64df
OBC
1372
1373 if (!dev || !name || !ops)
1374 return NULL;
1375
0f57dc6a 1376 if (!firmware) {
8b4aec9a 1377 /*
8b4aec9a 1378 * If the caller didn't pass in a firmware name then
0f57dc6a 1379 * construct a default name.
8b4aec9a
RT
1380 */
1381 name_len = strlen(name) + strlen(template) - 2 + 1;
0f57dc6a
MR
1382 p = kmalloc(name_len, GFP_KERNEL);
1383 if (!p)
1384 return NULL;
8b4aec9a
RT
1385 snprintf(p, name_len, template, name);
1386 } else {
0f57dc6a
MR
1387 p = kstrdup(firmware, GFP_KERNEL);
1388 if (!p)
1389 return NULL;
1390 }
1391
1392 rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
1393 if (!rproc) {
1394 kfree(p);
1395 return NULL;
8b4aec9a
RT
1396 }
1397
fb98e2bd
BA
1398 rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL);
1399 if (!rproc->ops) {
1400 kfree(p);
1401 kfree(rproc);
1402 return NULL;
1403 }
1404
8b4aec9a 1405 rproc->firmware = p;
400e64df 1406 rproc->name = name;
400e64df 1407 rproc->priv = &rproc[1];
ddf71187 1408 rproc->auto_boot = true;
400e64df 1409
b5ab5e24
OBC
1410 device_initialize(&rproc->dev);
1411 rproc->dev.parent = dev;
1412 rproc->dev.type = &rproc_type;
2aefbef0 1413 rproc->dev.class = &rproc_class;
7c89717f 1414 rproc->dev.driver_data = rproc;
b5ab5e24
OBC
1415
1416 /* Assign a unique device index and name */
1417 rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1418 if (rproc->index < 0) {
1419 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1420 put_device(&rproc->dev);
1421 return NULL;
1422 }
1423
1424 dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1425
400e64df
OBC
1426 atomic_set(&rproc->power, 0);
1427
0f21f9cc
BA
1428 /* Default to ELF loader if no load function is specified */
1429 if (!rproc->ops->load) {
1430 rproc->ops->load = rproc_elf_load_segments;
58b64090 1431 rproc->ops->load_rsc_table = rproc_elf_load_rsc_table;
0f21f9cc
BA
1432 rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table;
1433 rproc->ops->sanity_check = rproc_elf_sanity_check;
1434 rproc->ops->get_boot_addr = rproc_elf_get_boot_addr;
1435 }
400e64df
OBC
1436
1437 mutex_init(&rproc->lock);
1438
7a186941
OBC
1439 idr_init(&rproc->notifyids);
1440
400e64df
OBC
1441 INIT_LIST_HEAD(&rproc->carveouts);
1442 INIT_LIST_HEAD(&rproc->mappings);
1443 INIT_LIST_HEAD(&rproc->traces);
7a186941 1444 INIT_LIST_HEAD(&rproc->rvdevs);
7bdc9650 1445 INIT_LIST_HEAD(&rproc->subdevs);
400e64df 1446
8afd519c
FGL
1447 INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
1448
400e64df
OBC
1449 rproc->state = RPROC_OFFLINE;
1450
1451 return rproc;
1452}
1453EXPORT_SYMBOL(rproc_alloc);
1454
1455/**
433c0e04
BA
1456 * rproc_free() - unroll rproc_alloc()
1457 * @rproc: the remote processor handle
1458 *
1459 * This function decrements the rproc dev refcount.
1460 *
1461 * If no one holds any reference to rproc anymore, then its refcount would
1462 * now drop to zero, and it would be freed.
1463 */
1464void rproc_free(struct rproc *rproc)
1465{
1466 put_device(&rproc->dev);
1467}
1468EXPORT_SYMBOL(rproc_free);
1469
1470/**
1471 * rproc_put() - release rproc reference
400e64df
OBC
1472 * @rproc: the remote processor handle
1473 *
c6b5a276 1474 * This function decrements the rproc dev refcount.
400e64df 1475 *
c6b5a276
OBC
1476 * If no one holds any reference to rproc anymore, then its refcount would
1477 * now drop to zero, and it would be freed.
400e64df 1478 */
160e7c84 1479void rproc_put(struct rproc *rproc)
400e64df 1480{
fbb6aacb 1481 module_put(rproc->dev.parent->driver->owner);
b5ab5e24 1482 put_device(&rproc->dev);
400e64df 1483}
160e7c84 1484EXPORT_SYMBOL(rproc_put);
400e64df
OBC
1485
1486/**
160e7c84 1487 * rproc_del() - unregister a remote processor
400e64df
OBC
1488 * @rproc: rproc handle to unregister
1489 *
400e64df
OBC
1490 * This function should be called when the platform specific rproc
1491 * implementation decides to remove the rproc device. it should
160e7c84 1492 * _only_ be called if a previous invocation of rproc_add()
400e64df
OBC
1493 * has completed successfully.
1494 *
160e7c84 1495 * After rproc_del() returns, @rproc isn't freed yet, because
c6b5a276 1496 * of the outstanding reference created by rproc_alloc. To decrement that
433c0e04 1497 * one last refcount, one still needs to call rproc_free().
400e64df
OBC
1498 *
1499 * Returns 0 on success and -EINVAL if @rproc isn't valid.
1500 */
160e7c84 1501int rproc_del(struct rproc *rproc)
400e64df
OBC
1502{
1503 if (!rproc)
1504 return -EINVAL;
1505
ddf71187
BA
1506 /* if rproc is marked always-on, rproc_add() booted it */
1507 /* TODO: make sure this works with rproc->power > 1 */
1508 if (rproc->auto_boot)
1509 rproc_shutdown(rproc);
1510
2099c77d
SJ
1511 mutex_lock(&rproc->lock);
1512 rproc->state = RPROC_DELETED;
1513 mutex_unlock(&rproc->lock);
1514
b003d45b
SJ
1515 rproc_delete_debug_dir(rproc);
1516
fec47d86
DG
1517 /* the rproc is downref'ed as soon as it's removed from the klist */
1518 mutex_lock(&rproc_list_mutex);
1519 list_del(&rproc->node);
1520 mutex_unlock(&rproc_list_mutex);
1521
b5ab5e24 1522 device_del(&rproc->dev);
400e64df
OBC
1523
1524 return 0;
1525}
160e7c84 1526EXPORT_SYMBOL(rproc_del);
400e64df 1527
7bdc9650
BA
1528/**
1529 * rproc_add_subdev() - add a subdevice to a remoteproc
1530 * @rproc: rproc handle to add the subdevice to
1531 * @subdev: subdev handle to register
1532 * @probe: function to call when the rproc boots
1533 * @remove: function to call when the rproc shuts down
1534 */
1535void rproc_add_subdev(struct rproc *rproc,
1536 struct rproc_subdev *subdev,
1537 int (*probe)(struct rproc_subdev *subdev),
1538 void (*remove)(struct rproc_subdev *subdev))
1539{
1540 subdev->probe = probe;
1541 subdev->remove = remove;
1542
1543 list_add_tail(&subdev->node, &rproc->subdevs);
1544}
1545EXPORT_SYMBOL(rproc_add_subdev);
1546
1547/**
1548 * rproc_remove_subdev() - remove a subdevice from a remoteproc
1549 * @rproc: rproc handle to remove the subdevice from
1550 * @subdev: subdev handle, previously registered with rproc_add_subdev()
1551 */
1552void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
1553{
1554 list_del(&subdev->node);
1555}
1556EXPORT_SYMBOL(rproc_remove_subdev);
1557
7c89717f
BA
1558/**
1559 * rproc_get_by_child() - acquire rproc handle of @dev's ancestor
1560 * @dev: child device to find ancestor of
1561 *
1562 * Returns the ancestor rproc instance, or NULL if not found.
1563 */
1564struct rproc *rproc_get_by_child(struct device *dev)
1565{
1566 for (dev = dev->parent; dev; dev = dev->parent) {
1567 if (dev->type == &rproc_type)
1568 return dev->driver_data;
1569 }
1570
1571 return NULL;
1572}
1573EXPORT_SYMBOL(rproc_get_by_child);
1574
8afd519c
FGL
1575/**
1576 * rproc_report_crash() - rproc crash reporter function
1577 * @rproc: remote processor
1578 * @type: crash type
1579 *
1580 * This function must be called every time a crash is detected by the low-level
1581 * drivers implementing a specific remoteproc. This should not be called from a
1582 * non-remoteproc driver.
1583 *
1584 * This function can be called from atomic/interrupt context.
1585 */
1586void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
1587{
1588 if (!rproc) {
1589 pr_err("NULL rproc pointer\n");
1590 return;
1591 }
1592
1593 dev_err(&rproc->dev, "crash detected in %s: type %s\n",
1594 rproc->name, rproc_crash_to_string(type));
1595
1596 /* create a new task to handle the error */
1597 schedule_work(&rproc->crash_handler);
1598}
1599EXPORT_SYMBOL(rproc_report_crash);
1600
400e64df
OBC
1601static int __init remoteproc_init(void)
1602{
2aefbef0 1603 rproc_init_sysfs();
400e64df 1604 rproc_init_debugfs();
b5ab5e24 1605
400e64df
OBC
1606 return 0;
1607}
1608module_init(remoteproc_init);
1609
1610static void __exit remoteproc_exit(void)
1611{
f42f79af
SA
1612 ida_destroy(&rproc_dev_index);
1613
400e64df 1614 rproc_exit_debugfs();
2aefbef0 1615 rproc_exit_sysfs();
400e64df
OBC
1616}
1617module_exit(remoteproc_exit);
1618
1619MODULE_LICENSE("GPL v2");
1620MODULE_DESCRIPTION("Generic Remote Processor Framework");