2 * Remote Processor Framework
4 * Copyright (C) 2011 Texas Instruments, Inc.
5 * Copyright (C) 2011 Google, Inc.
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>
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.
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.
25 #define pr_fmt(fmt) "%s: " fmt, __func__
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>
38 #include <linux/idr.h>
39 #include <linux/elf.h>
40 #include <linux/crc32.h>
41 #include <linux/virtio_ids.h>
42 #include <linux/virtio_ring.h>
43 #include <asm/byteorder.h>
45 #include "remoteproc_internal.h"
47 static DEFINE_MUTEX(rproc_list_mutex
);
48 static LIST_HEAD(rproc_list
);
50 typedef int (*rproc_handle_resources_t
)(struct rproc
*rproc
,
51 struct resource_table
*table
, int len
);
52 typedef int (*rproc_handle_resource_t
)(struct rproc
*rproc
,
53 void *, int offset
, int avail
);
55 /* Unique indices for remoteproc devices */
56 static DEFINE_IDA(rproc_dev_index
);
58 static const char * const rproc_crash_names
[] = {
59 [RPROC_MMUFAULT
] = "mmufault",
60 [RPROC_WATCHDOG
] = "watchdog",
61 [RPROC_FATAL_ERROR
] = "fatal error",
64 /* translate rproc_crash_type to string */
65 static const char *rproc_crash_to_string(enum rproc_crash_type type
)
67 if (type
< ARRAY_SIZE(rproc_crash_names
))
68 return rproc_crash_names
[type
];
73 * This is the IOMMU fault handler we register with the IOMMU API
74 * (when relevant; not all remote processors access memory through
77 * IOMMU core will invoke this handler whenever the remote processor
78 * will try to access an unmapped device address.
80 static int rproc_iommu_fault(struct iommu_domain
*domain
, struct device
*dev
,
81 unsigned long iova
, int flags
, void *token
)
83 struct rproc
*rproc
= token
;
85 dev_err(dev
, "iommu fault: da 0x%lx flags 0x%x\n", iova
, flags
);
87 rproc_report_crash(rproc
, RPROC_MMUFAULT
);
90 * Let the iommu core know we're not really handling this fault;
91 * we just used it as a recovery trigger.
96 static int rproc_enable_iommu(struct rproc
*rproc
)
98 struct iommu_domain
*domain
;
99 struct device
*dev
= rproc
->dev
.parent
;
102 if (!rproc
->has_iommu
) {
103 dev_dbg(dev
, "iommu not present\n");
107 domain
= iommu_domain_alloc(dev
->bus
);
109 dev_err(dev
, "can't alloc iommu domain\n");
113 iommu_set_fault_handler(domain
, rproc_iommu_fault
, rproc
);
115 ret
= iommu_attach_device(domain
, dev
);
117 dev_err(dev
, "can't attach iommu device: %d\n", ret
);
121 rproc
->domain
= domain
;
126 iommu_domain_free(domain
);
130 static void rproc_disable_iommu(struct rproc
*rproc
)
132 struct iommu_domain
*domain
= rproc
->domain
;
133 struct device
*dev
= rproc
->dev
.parent
;
138 iommu_detach_device(domain
, dev
);
139 iommu_domain_free(domain
);
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
148 * Some remote processors will ask us to allocate them physically contiguous
149 * memory regions (which we call "carveouts"), and map them to specific
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.
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).
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.
164 * The function returns a valid kernel address on success or NULL on failure.
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
168 * here the output of the DMA API for the carveouts, which should be more
171 void *rproc_da_to_va(struct rproc
*rproc
, u64 da
, int len
)
173 struct rproc_mem_entry
*carveout
;
176 if (rproc
->ops
->da_to_va
) {
177 ptr
= rproc
->ops
->da_to_va(rproc
, da
, len
);
182 list_for_each_entry(carveout
, &rproc
->carveouts
, node
) {
183 int offset
= da
- carveout
->da
;
185 /* try next carveout if da is too small */
189 /* try next carveout if da is too large */
190 if (offset
+ len
> carveout
->len
)
193 ptr
= carveout
->va
+ offset
;
201 EXPORT_SYMBOL(rproc_da_to_va
);
203 int rproc_alloc_vring(struct rproc_vdev
*rvdev
, int i
)
205 struct rproc
*rproc
= rvdev
->rproc
;
206 struct device
*dev
= &rproc
->dev
;
207 struct rproc_vring
*rvring
= &rvdev
->vring
[i
];
208 struct fw_rsc_vdev
*rsc
;
211 int ret
, size
, notifyid
;
213 /* actual size of vring (in bytes) */
214 size
= PAGE_ALIGN(vring_size(rvring
->len
, rvring
->align
));
217 * Allocate non-cacheable memory for the vring. In the future
218 * this call will also configure the IOMMU for us
220 va
= dma_alloc_coherent(dev
->parent
, size
, &dma
, GFP_KERNEL
);
222 dev_err(dev
->parent
, "dma_alloc_coherent failed\n");
227 * Assign an rproc-wide unique index for this vring
228 * TODO: assign a notifyid for rvdev updates as well
229 * TODO: support predefined notifyids (via resource table)
231 ret
= idr_alloc(&rproc
->notifyids
, rvring
, 0, 0, GFP_KERNEL
);
233 dev_err(dev
, "idr_alloc failed: %d\n", ret
);
234 dma_free_coherent(dev
->parent
, size
, va
, dma
);
239 /* Potentially bump max_notifyid */
240 if (notifyid
> rproc
->max_notifyid
)
241 rproc
->max_notifyid
= notifyid
;
243 dev_dbg(dev
, "vring%d: va %p dma %pad size 0x%x idr %d\n",
244 i
, va
, &dma
, size
, notifyid
);
248 rvring
->notifyid
= notifyid
;
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.
256 rsc
= (void *)rproc
->table_ptr
+ rvdev
->rsc_offset
;
257 rsc
->vring
[i
].da
= dma
;
258 rsc
->vring
[i
].notifyid
= notifyid
;
263 rproc_parse_vring(struct rproc_vdev
*rvdev
, struct fw_rsc_vdev
*rsc
, int i
)
265 struct rproc
*rproc
= rvdev
->rproc
;
266 struct device
*dev
= &rproc
->dev
;
267 struct fw_rsc_vdev_vring
*vring
= &rsc
->vring
[i
];
268 struct rproc_vring
*rvring
= &rvdev
->vring
[i
];
270 dev_dbg(dev
, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
271 i
, vring
->da
, vring
->num
, vring
->align
);
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",
276 vring
->num
, vring
->align
);
280 rvring
->len
= vring
->num
;
281 rvring
->align
= vring
->align
;
282 rvring
->rvdev
= rvdev
;
287 void rproc_free_vring(struct rproc_vring
*rvring
)
289 int size
= PAGE_ALIGN(vring_size(rvring
->len
, rvring
->align
));
290 struct rproc
*rproc
= rvring
->rvdev
->rproc
;
291 int idx
= rvring
->rvdev
->vring
- rvring
;
292 struct fw_rsc_vdev
*rsc
;
294 dma_free_coherent(rproc
->dev
.parent
, size
, rvring
->va
, rvring
->dma
);
295 idr_remove(&rproc
->notifyids
, rvring
->notifyid
);
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;
303 static int rproc_vdev_do_probe(struct rproc_subdev
*subdev
)
305 struct rproc_vdev
*rvdev
= container_of(subdev
, struct rproc_vdev
, subdev
);
307 return rproc_add_virtio_dev(rvdev
, rvdev
->id
);
310 static void rproc_vdev_do_remove(struct rproc_subdev
*subdev
)
312 struct rproc_vdev
*rvdev
= container_of(subdev
, struct rproc_vdev
, subdev
);
314 rproc_remove_virtio_dev(rvdev
);
318 * rproc_handle_vdev() - handle a vdev fw resource
319 * @rproc: the remote processor
320 * @rsc: the vring resource descriptor
321 * @avail: size of available data (for sanity checking the image)
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...
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().
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!).
342 * Returns 0 on success, or an appropriate error code otherwise
344 static int rproc_handle_vdev(struct rproc
*rproc
, struct fw_rsc_vdev
*rsc
,
345 int offset
, int avail
)
347 struct device
*dev
= &rproc
->dev
;
348 struct rproc_vdev
*rvdev
;
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
) {
354 dev_err(dev
, "vdev rsc is truncated\n");
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");
364 dev_dbg(dev
, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
365 rsc
->id
, rsc
->dfeatures
, rsc
->config_len
, rsc
->num_of_vrings
);
367 /* we currently support only two vrings per rvdev */
368 if (rsc
->num_of_vrings
> ARRAY_SIZE(rvdev
->vring
)) {
369 dev_err(dev
, "too many vrings: %d\n", rsc
->num_of_vrings
);
373 rvdev
= kzalloc(sizeof(*rvdev
), GFP_KERNEL
);
377 kref_init(&rvdev
->refcount
);
380 rvdev
->rproc
= rproc
;
382 /* parse the vrings */
383 for (i
= 0; i
< rsc
->num_of_vrings
; i
++) {
384 ret
= rproc_parse_vring(rvdev
, rsc
, i
);
389 /* remember the resource offset*/
390 rvdev
->rsc_offset
= offset
;
392 /* allocate the vring resources */
393 for (i
= 0; i
< rsc
->num_of_vrings
; i
++) {
394 ret
= rproc_alloc_vring(rvdev
, i
);
396 goto unwind_vring_allocations
;
399 list_add_tail(&rvdev
->node
, &rproc
->rvdevs
);
401 rproc_add_subdev(rproc
, &rvdev
->subdev
,
402 rproc_vdev_do_probe
, rproc_vdev_do_remove
);
406 unwind_vring_allocations
:
407 for (i
--; i
>= 0; i
--)
408 rproc_free_vring(&rvdev
->vring
[i
]);
414 void rproc_vdev_release(struct kref
*ref
)
416 struct rproc_vdev
*rvdev
= container_of(ref
, struct rproc_vdev
, refcount
);
417 struct rproc_vring
*rvring
;
418 struct rproc
*rproc
= rvdev
->rproc
;
421 for (id
= 0; id
< ARRAY_SIZE(rvdev
->vring
); id
++) {
422 rvring
= &rvdev
->vring
[id
];
426 rproc_free_vring(rvring
);
429 rproc_remove_subdev(rproc
, &rvdev
->subdev
);
430 list_del(&rvdev
->node
);
435 * rproc_handle_trace() - handle a shared trace buffer resource
436 * @rproc: the remote processor
437 * @rsc: the trace resource descriptor
438 * @avail: size of available data (for sanity checking the image)
440 * In case the remote processor dumps trace logs into memory,
441 * export it via debugfs.
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).
448 * Returns 0 on success, or an appropriate error code otherwise
450 static int rproc_handle_trace(struct rproc
*rproc
, struct fw_rsc_trace
*rsc
,
451 int offset
, int avail
)
453 struct rproc_mem_entry
*trace
;
454 struct device
*dev
= &rproc
->dev
;
458 if (sizeof(*rsc
) > avail
) {
459 dev_err(dev
, "trace rsc is truncated\n");
463 /* make sure reserved bytes are zeroes */
465 dev_err(dev
, "trace rsc has non zero reserved bytes\n");
469 /* what's the kernel address of this resource ? */
470 ptr
= rproc_da_to_va(rproc
, rsc
->da
, rsc
->len
);
472 dev_err(dev
, "erroneous trace resource entry\n");
476 trace
= kzalloc(sizeof(*trace
), GFP_KERNEL
);
480 /* set the trace buffer dma properties */
481 trace
->len
= rsc
->len
;
484 /* make sure snprintf always null terminates, even if truncating */
485 snprintf(name
, sizeof(name
), "trace%d", rproc
->num_traces
);
487 /* create the debugfs entry */
488 trace
->priv
= rproc_create_trace_file(name
, rproc
, trace
);
495 list_add_tail(&trace
->node
, &rproc
->traces
);
499 dev_dbg(dev
, "%s added: va %p, da 0x%x, len 0x%x\n",
500 name
, ptr
, rsc
->da
, rsc
->len
);
506 * rproc_handle_devmem() - handle devmem resource entry
507 * @rproc: remote processor handle
508 * @rsc: the devmem resource entry
509 * @avail: size of available data (for sanity checking the image)
511 * Remote processors commonly need to access certain on-chip peripherals.
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.
517 * This resource entry is a request to map such a peripheral device.
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.
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.
530 static int rproc_handle_devmem(struct rproc
*rproc
, struct fw_rsc_devmem
*rsc
,
531 int offset
, int avail
)
533 struct rproc_mem_entry
*mapping
;
534 struct device
*dev
= &rproc
->dev
;
537 /* no point in handling this resource without a valid iommu domain */
541 if (sizeof(*rsc
) > avail
) {
542 dev_err(dev
, "devmem rsc is truncated\n");
546 /* make sure reserved bytes are zeroes */
548 dev_err(dev
, "devmem rsc has non zero reserved bytes\n");
552 mapping
= kzalloc(sizeof(*mapping
), GFP_KERNEL
);
556 ret
= iommu_map(rproc
->domain
, rsc
->da
, rsc
->pa
, rsc
->len
, rsc
->flags
);
558 dev_err(dev
, "failed to map devmem: %d\n", ret
);
563 * We'll need this info later when we'll want to unmap everything
564 * (e.g. on shutdown).
566 * We can't trust the remote processor not to change the resource
567 * table, so we must maintain this info independently.
569 mapping
->da
= rsc
->da
;
570 mapping
->len
= rsc
->len
;
571 list_add_tail(&mapping
->node
, &rproc
->mappings
);
573 dev_dbg(dev
, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
574 rsc
->pa
, rsc
->da
, rsc
->len
);
584 * rproc_handle_carveout() - handle phys contig memory allocation requests
585 * @rproc: rproc handle
586 * @rsc: the resource entry
587 * @avail: size of available data (for image validation)
589 * This function will handle firmware requests for allocation of physically
590 * contiguous memory regions.
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, ...).
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.
601 static int rproc_handle_carveout(struct rproc
*rproc
,
602 struct fw_rsc_carveout
*rsc
,
603 int offset
, int avail
)
605 struct rproc_mem_entry
*carveout
, *mapping
;
606 struct device
*dev
= &rproc
->dev
;
611 if (sizeof(*rsc
) > avail
) {
612 dev_err(dev
, "carveout rsc is truncated\n");
616 /* make sure reserved bytes are zeroes */
618 dev_err(dev
, "carveout rsc has non zero reserved bytes\n");
622 dev_dbg(dev
, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
623 rsc
->name
, rsc
->da
, rsc
->pa
, rsc
->len
, rsc
->flags
);
625 carveout
= kzalloc(sizeof(*carveout
), GFP_KERNEL
);
629 va
= dma_alloc_coherent(dev
->parent
, rsc
->len
, &dma
, GFP_KERNEL
);
632 "failed to allocate dma memory: len 0x%x\n", rsc
->len
);
637 dev_dbg(dev
, "carveout va %p, dma %pad, len 0x%x\n",
641 * Ok, this is non-standard.
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.
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
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.
658 mapping
= kzalloc(sizeof(*mapping
), GFP_KERNEL
);
664 ret
= iommu_map(rproc
->domain
, rsc
->da
, dma
, rsc
->len
,
667 dev_err(dev
, "iommu_map failed: %d\n", ret
);
672 * We'll need this info later when we'll want to unmap
673 * everything (e.g. on shutdown).
675 * We can't trust the remote processor not to change the
676 * resource table, so we must maintain this info independently.
678 mapping
->da
= rsc
->da
;
679 mapping
->len
= rsc
->len
;
680 list_add_tail(&mapping
->node
, &rproc
->mappings
);
682 dev_dbg(dev
, "carveout mapped 0x%x to %pad\n",
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.
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).
699 * Non-IOMMU processors might also want to have this info.
700 * In this case, the device address and the physical address
706 carveout
->len
= rsc
->len
;
708 carveout
->da
= rsc
->da
;
710 list_add_tail(&carveout
->node
, &rproc
->carveouts
);
717 dma_free_coherent(dev
->parent
, rsc
->len
, va
, dma
);
724 * A lookup table for resource handlers. The indices are defined in
725 * enum fw_resource_type.
727 static rproc_handle_resource_t rproc_loading_handlers
[RSC_LAST
] = {
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
,
731 [RSC_VDEV
] = (rproc_handle_resource_t
)rproc_handle_vdev
,
734 /* handle firmware resource entries before booting the remote processor */
735 static int rproc_handle_resources(struct rproc
*rproc
, int len
,
736 rproc_handle_resource_t handlers
[RSC_LAST
])
738 struct device
*dev
= &rproc
->dev
;
739 rproc_handle_resource_t handler
;
742 for (i
= 0; i
< rproc
->table_ptr
->num
; i
++) {
743 int offset
= rproc
->table_ptr
->offset
[i
];
744 struct fw_rsc_hdr
*hdr
= (void *)rproc
->table_ptr
+ offset
;
745 int avail
= len
- offset
- sizeof(*hdr
);
746 void *rsc
= (void *)hdr
+ sizeof(*hdr
);
748 /* make sure table isn't truncated */
750 dev_err(dev
, "rsc table is truncated\n");
754 dev_dbg(dev
, "rsc: type %d\n", hdr
->type
);
756 if (hdr
->type
>= RSC_LAST
) {
757 dev_warn(dev
, "unsupported resource %d\n", hdr
->type
);
761 handler
= handlers
[hdr
->type
];
765 ret
= handler(rproc
, rsc
, offset
+ sizeof(*hdr
), avail
);
773 static int rproc_probe_subdevices(struct rproc
*rproc
)
775 struct rproc_subdev
*subdev
;
778 list_for_each_entry(subdev
, &rproc
->subdevs
, node
) {
779 ret
= subdev
->probe(subdev
);
781 goto unroll_registration
;
787 list_for_each_entry_continue_reverse(subdev
, &rproc
->subdevs
, node
)
788 subdev
->remove(subdev
);
793 static void rproc_remove_subdevices(struct rproc
*rproc
)
795 struct rproc_subdev
*subdev
;
797 list_for_each_entry(subdev
, &rproc
->subdevs
, node
)
798 subdev
->remove(subdev
);
802 * rproc_resource_cleanup() - clean up and free all acquired resources
803 * @rproc: rproc handle
805 * This function will free all resources acquired for @rproc, and it
806 * is called whenever @rproc either shuts down or fails to boot.
808 static void rproc_resource_cleanup(struct rproc
*rproc
)
810 struct rproc_mem_entry
*entry
, *tmp
;
811 struct rproc_vdev
*rvdev
, *rvtmp
;
812 struct device
*dev
= &rproc
->dev
;
814 /* clean up debugfs trace entries */
815 list_for_each_entry_safe(entry
, tmp
, &rproc
->traces
, node
) {
816 rproc_remove_trace_file(entry
->priv
);
818 list_del(&entry
->node
);
822 /* clean up iommu mapping entries */
823 list_for_each_entry_safe(entry
, tmp
, &rproc
->mappings
, node
) {
826 unmapped
= iommu_unmap(rproc
->domain
, entry
->da
, entry
->len
);
827 if (unmapped
!= entry
->len
) {
828 /* nothing much to do besides complaining */
829 dev_err(dev
, "failed to unmap %u/%zu\n", entry
->len
,
833 list_del(&entry
->node
);
837 /* clean up carveout allocations */
838 list_for_each_entry_safe(entry
, tmp
, &rproc
->carveouts
, node
) {
839 dma_free_coherent(dev
->parent
, entry
->len
, entry
->va
,
841 list_del(&entry
->node
);
845 /* clean up remote vdev entries */
846 list_for_each_entry_safe(rvdev
, rvtmp
, &rproc
->rvdevs
, node
)
847 kref_put(&rvdev
->refcount
, rproc_vdev_release
);
851 * take a firmware and boot a remote processor with it.
853 static int rproc_fw_boot(struct rproc
*rproc
, const struct firmware
*fw
)
855 struct device
*dev
= &rproc
->dev
;
856 const char *name
= rproc
->firmware
;
857 struct resource_table
*table
, *loaded_table
;
860 ret
= rproc_fw_sanity_check(rproc
, fw
);
864 dev_info(dev
, "Booting fw image %s, size %zd\n", name
, fw
->size
);
867 * if enabling an IOMMU isn't relevant for this rproc, this is
870 ret
= rproc_enable_iommu(rproc
);
872 dev_err(dev
, "can't enable iommu: %d\n", ret
);
876 rproc
->bootaddr
= rproc_get_boot_addr(rproc
, fw
);
879 /* look for the resource table */
880 table
= rproc_find_rsc_table(rproc
, fw
, &tablesz
);
882 dev_err(dev
, "Failed to find resource table\n");
887 * Create a copy of the resource table. When a virtio device starts
888 * and calls vring_new_virtqueue() the address of the allocated vring
889 * will be stored in the cached_table. Before the device is started,
890 * cached_table will be copied into device memory.
892 rproc
->cached_table
= kmemdup(table
, tablesz
, GFP_KERNEL
);
893 if (!rproc
->cached_table
)
896 rproc
->table_ptr
= rproc
->cached_table
;
898 /* reset max_notifyid */
899 rproc
->max_notifyid
= -1;
901 /* handle fw resources which are required to boot rproc */
902 ret
= rproc_handle_resources(rproc
, tablesz
, rproc_loading_handlers
);
904 dev_err(dev
, "Failed to process resources: %d\n", ret
);
905 goto clean_up_resources
;
908 /* load the ELF segments to memory */
909 ret
= rproc_load_segments(rproc
, fw
);
911 dev_err(dev
, "Failed to load program segments: %d\n", ret
);
912 goto clean_up_resources
;
916 * The starting device has been given the rproc->cached_table as the
917 * resource table. The address of the vring along with the other
918 * allocated resources (carveouts etc) is stored in cached_table.
919 * In order to pass this information to the remote device we must copy
920 * this information to device memory. We also update the table_ptr so
921 * that any subsequent changes will be applied to the loaded version.
923 loaded_table
= rproc_find_loaded_rsc_table(rproc
, fw
);
925 memcpy(loaded_table
, rproc
->cached_table
, tablesz
);
926 rproc
->table_ptr
= loaded_table
;
929 /* power up the remote processor */
930 ret
= rproc
->ops
->start(rproc
);
932 dev_err(dev
, "can't start rproc %s: %d\n", rproc
->name
, ret
);
933 goto clean_up_resources
;
936 /* probe any subdevices for the remote processor */
937 ret
= rproc_probe_subdevices(rproc
);
939 dev_err(dev
, "failed to probe subdevices for %s: %d\n",
944 rproc
->state
= RPROC_RUNNING
;
946 dev_info(dev
, "remote processor %s is now up\n", rproc
->name
);
951 rproc
->ops
->stop(rproc
);
953 rproc_resource_cleanup(rproc
);
955 kfree(rproc
->cached_table
);
956 rproc
->cached_table
= NULL
;
957 rproc
->table_ptr
= NULL
;
959 rproc_disable_iommu(rproc
);
964 * take a firmware and boot it up.
966 * Note: this function is called asynchronously upon registration of the
967 * remote processor (so we must wait until it completes before we try
968 * to unregister the device. one other option is just to use kref here,
969 * that might be cleaner).
971 static void rproc_auto_boot_callback(const struct firmware
*fw
, void *context
)
973 struct rproc
*rproc
= context
;
977 release_firmware(fw
);
980 static int rproc_trigger_auto_boot(struct rproc
*rproc
)
985 * We're initiating an asynchronous firmware loading, so we can
986 * be built-in kernel code, without hanging the boot process.
988 ret
= request_firmware_nowait(THIS_MODULE
, FW_ACTION_HOTPLUG
,
989 rproc
->firmware
, &rproc
->dev
, GFP_KERNEL
,
990 rproc
, rproc_auto_boot_callback
);
992 dev_err(&rproc
->dev
, "request_firmware_nowait err: %d\n", ret
);
998 * rproc_trigger_recovery() - recover a remoteproc
999 * @rproc: the remote processor
1001 * The recovery is done by resetting all the virtio devices, that way all the
1002 * rpmsg drivers will be reseted along with the remote processor making the
1003 * remoteproc functional again.
1005 * This function can sleep, so it cannot be called from atomic context.
1007 int rproc_trigger_recovery(struct rproc
*rproc
)
1009 dev_err(&rproc
->dev
, "recovering %s\n", rproc
->name
);
1011 init_completion(&rproc
->crash_comp
);
1013 /* shut down the remote */
1014 /* TODO: make sure this works with rproc->power > 1 */
1015 rproc_shutdown(rproc
);
1017 /* wait until there is no more rproc users */
1018 wait_for_completion(&rproc
->crash_comp
);
1021 * boot the remote processor up again
1029 * rproc_crash_handler_work() - handle a crash
1031 * This function needs to handle everything related to a crash, like cpu
1032 * registers and stack dump, information to help to debug the fatal error, etc.
1034 static void rproc_crash_handler_work(struct work_struct
*work
)
1036 struct rproc
*rproc
= container_of(work
, struct rproc
, crash_handler
);
1037 struct device
*dev
= &rproc
->dev
;
1039 dev_dbg(dev
, "enter %s\n", __func__
);
1041 mutex_lock(&rproc
->lock
);
1043 if (rproc
->state
== RPROC_CRASHED
|| rproc
->state
== RPROC_OFFLINE
) {
1044 /* handle only the first crash detected */
1045 mutex_unlock(&rproc
->lock
);
1049 rproc
->state
= RPROC_CRASHED
;
1050 dev_err(dev
, "handling crash #%u in %s\n", ++rproc
->crash_cnt
,
1053 mutex_unlock(&rproc
->lock
);
1055 if (!rproc
->recovery_disabled
)
1056 rproc_trigger_recovery(rproc
);
1060 * __rproc_boot() - boot a remote processor
1061 * @rproc: handle of a remote processor
1063 * Boot a remote processor (i.e. load its firmware, power it on, ...).
1065 * If the remote processor is already powered on, this function immediately
1066 * returns (successfully).
1068 * Returns 0 on success, and an appropriate error value otherwise.
1070 static int __rproc_boot(struct rproc
*rproc
)
1072 const struct firmware
*firmware_p
;
1077 pr_err("invalid rproc handle\n");
1083 ret
= mutex_lock_interruptible(&rproc
->lock
);
1085 dev_err(dev
, "can't lock rproc %s: %d\n", rproc
->name
, ret
);
1089 if (rproc
->state
== RPROC_DELETED
) {
1091 dev_err(dev
, "can't boot deleted rproc %s\n", rproc
->name
);
1095 /* skip the boot process if rproc is already powered up */
1096 if (atomic_inc_return(&rproc
->power
) > 1) {
1101 dev_info(dev
, "powering up %s\n", rproc
->name
);
1104 ret
= request_firmware(&firmware_p
, rproc
->firmware
, dev
);
1106 dev_err(dev
, "request_firmware failed: %d\n", ret
);
1110 ret
= rproc_fw_boot(rproc
, firmware_p
);
1112 release_firmware(firmware_p
);
1116 atomic_dec(&rproc
->power
);
1118 mutex_unlock(&rproc
->lock
);
1123 * rproc_boot() - boot a remote processor
1124 * @rproc: handle of a remote processor
1126 int rproc_boot(struct rproc
*rproc
)
1128 return __rproc_boot(rproc
);
1130 EXPORT_SYMBOL(rproc_boot
);
1133 * rproc_shutdown() - power off the remote processor
1134 * @rproc: the remote processor
1136 * Power off a remote processor (previously booted with rproc_boot()).
1138 * In case @rproc is still being used by an additional user(s), then
1139 * this function will just decrement the power refcount and exit,
1140 * without really powering off the device.
1142 * Every call to rproc_boot() must (eventually) be accompanied by a call
1143 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1146 * - we're not decrementing the rproc's refcount, only the power refcount.
1147 * which means that the @rproc handle stays valid even after rproc_shutdown()
1148 * returns, and users can still use it with a subsequent rproc_boot(), if
1151 void rproc_shutdown(struct rproc
*rproc
)
1153 struct device
*dev
= &rproc
->dev
;
1156 ret
= mutex_lock_interruptible(&rproc
->lock
);
1158 dev_err(dev
, "can't lock rproc %s: %d\n", rproc
->name
, ret
);
1162 /* if the remote proc is still needed, bail out */
1163 if (!atomic_dec_and_test(&rproc
->power
))
1166 /* remove any subdevices for the remote processor */
1167 rproc_remove_subdevices(rproc
);
1169 /* power off the remote processor */
1170 ret
= rproc
->ops
->stop(rproc
);
1172 atomic_inc(&rproc
->power
);
1173 dev_err(dev
, "can't stop rproc: %d\n", ret
);
1177 /* clean up all acquired resources */
1178 rproc_resource_cleanup(rproc
);
1180 rproc_disable_iommu(rproc
);
1182 /* Free the copy of the resource table */
1183 kfree(rproc
->cached_table
);
1184 rproc
->cached_table
= NULL
;
1185 rproc
->table_ptr
= NULL
;
1187 /* if in crash state, unlock crash handler */
1188 if (rproc
->state
== RPROC_CRASHED
)
1189 complete_all(&rproc
->crash_comp
);
1191 rproc
->state
= RPROC_OFFLINE
;
1193 dev_info(dev
, "stopped remote processor %s\n", rproc
->name
);
1196 mutex_unlock(&rproc
->lock
);
1198 EXPORT_SYMBOL(rproc_shutdown
);
1201 * rproc_get_by_phandle() - find a remote processor by phandle
1202 * @phandle: phandle to the rproc
1204 * Finds an rproc handle using the remote processor's phandle, and then
1205 * return a handle to the rproc.
1207 * This function increments the remote processor's refcount, so always
1208 * use rproc_put() to decrement it back once rproc isn't needed anymore.
1210 * Returns the rproc handle on success, and NULL on failure.
1213 struct rproc
*rproc_get_by_phandle(phandle phandle
)
1215 struct rproc
*rproc
= NULL
, *r
;
1216 struct device_node
*np
;
1218 np
= of_find_node_by_phandle(phandle
);
1222 mutex_lock(&rproc_list_mutex
);
1223 list_for_each_entry(r
, &rproc_list
, node
) {
1224 if (r
->dev
.parent
&& r
->dev
.parent
->of_node
== np
) {
1225 /* prevent underlying implementation from being removed */
1226 if (!try_module_get(r
->dev
.parent
->driver
->owner
)) {
1227 dev_err(&r
->dev
, "can't get owner\n");
1232 get_device(&rproc
->dev
);
1236 mutex_unlock(&rproc_list_mutex
);
1243 struct rproc
*rproc_get_by_phandle(phandle phandle
)
1248 EXPORT_SYMBOL(rproc_get_by_phandle
);
1251 * rproc_add() - register a remote processor
1252 * @rproc: the remote processor handle to register
1254 * Registers @rproc with the remoteproc framework, after it has been
1255 * allocated with rproc_alloc().
1257 * This is called by the platform-specific rproc implementation, whenever
1258 * a new remote processor device is probed.
1260 * Returns 0 on success and an appropriate error code otherwise.
1262 * Note: this function initiates an asynchronous firmware loading
1263 * context, which will look for virtio devices supported by the rproc's
1266 * If found, those virtio devices will be created and added, so as a result
1267 * of registering this remote processor, additional virtio drivers might be
1270 int rproc_add(struct rproc
*rproc
)
1272 struct device
*dev
= &rproc
->dev
;
1275 ret
= device_add(dev
);
1279 dev_info(dev
, "%s is available\n", rproc
->name
);
1281 /* create debugfs entries */
1282 rproc_create_debug_dir(rproc
);
1284 /* if rproc is marked always-on, request it to boot */
1285 if (rproc
->auto_boot
) {
1286 ret
= rproc_trigger_auto_boot(rproc
);
1291 /* expose to rproc_get_by_phandle users */
1292 mutex_lock(&rproc_list_mutex
);
1293 list_add(&rproc
->node
, &rproc_list
);
1294 mutex_unlock(&rproc_list_mutex
);
1298 EXPORT_SYMBOL(rproc_add
);
1301 * rproc_type_release() - release a remote processor instance
1302 * @dev: the rproc's device
1304 * This function should _never_ be called directly.
1306 * It will be called by the driver core when no one holds a valid pointer
1309 static void rproc_type_release(struct device
*dev
)
1311 struct rproc
*rproc
= container_of(dev
, struct rproc
, dev
);
1313 dev_info(&rproc
->dev
, "releasing %s\n", rproc
->name
);
1315 idr_destroy(&rproc
->notifyids
);
1317 if (rproc
->index
>= 0)
1318 ida_simple_remove(&rproc_dev_index
, rproc
->index
);
1320 kfree(rproc
->firmware
);
1324 static struct device_type rproc_type
= {
1325 .name
= "remoteproc",
1326 .release
= rproc_type_release
,
1330 * rproc_alloc() - allocate a remote processor handle
1331 * @dev: the underlying device
1332 * @name: name of this remote processor
1333 * @ops: platform-specific handlers (mainly start/stop)
1334 * @firmware: name of firmware file to load, can be NULL
1335 * @len: length of private data needed by the rproc driver (in bytes)
1337 * Allocates a new remote processor handle, but does not register
1338 * it yet. if @firmware is NULL, a default name is used.
1340 * This function should be used by rproc implementations during initialization
1341 * of the remote processor.
1343 * After creating an rproc handle using this function, and when ready,
1344 * implementations should then call rproc_add() to complete
1345 * the registration of the remote processor.
1347 * On success the new rproc is returned, and on failure, NULL.
1349 * Note: _never_ directly deallocate @rproc, even if it was not registered
1350 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
1352 struct rproc
*rproc_alloc(struct device
*dev
, const char *name
,
1353 const struct rproc_ops
*ops
,
1354 const char *firmware
, int len
)
1356 struct rproc
*rproc
;
1357 char *p
, *template = "rproc-%s-fw";
1360 if (!dev
|| !name
|| !ops
)
1365 * If the caller didn't pass in a firmware name then
1366 * construct a default name.
1368 name_len
= strlen(name
) + strlen(template) - 2 + 1;
1369 p
= kmalloc(name_len
, GFP_KERNEL
);
1372 snprintf(p
, name_len
, template, name
);
1374 p
= kstrdup(firmware
, GFP_KERNEL
);
1379 rproc
= kzalloc(sizeof(struct rproc
) + len
, GFP_KERNEL
);
1385 rproc
->firmware
= p
;
1388 rproc
->priv
= &rproc
[1];
1389 rproc
->auto_boot
= true;
1391 device_initialize(&rproc
->dev
);
1392 rproc
->dev
.parent
= dev
;
1393 rproc
->dev
.type
= &rproc_type
;
1394 rproc
->dev
.class = &rproc_class
;
1396 /* Assign a unique device index and name */
1397 rproc
->index
= ida_simple_get(&rproc_dev_index
, 0, 0, GFP_KERNEL
);
1398 if (rproc
->index
< 0) {
1399 dev_err(dev
, "ida_simple_get failed: %d\n", rproc
->index
);
1400 put_device(&rproc
->dev
);
1404 dev_set_name(&rproc
->dev
, "remoteproc%d", rproc
->index
);
1406 atomic_set(&rproc
->power
, 0);
1408 /* Set ELF as the default fw_ops handler */
1409 rproc
->fw_ops
= &rproc_elf_fw_ops
;
1411 mutex_init(&rproc
->lock
);
1413 idr_init(&rproc
->notifyids
);
1415 INIT_LIST_HEAD(&rproc
->carveouts
);
1416 INIT_LIST_HEAD(&rproc
->mappings
);
1417 INIT_LIST_HEAD(&rproc
->traces
);
1418 INIT_LIST_HEAD(&rproc
->rvdevs
);
1419 INIT_LIST_HEAD(&rproc
->subdevs
);
1421 INIT_WORK(&rproc
->crash_handler
, rproc_crash_handler_work
);
1422 init_completion(&rproc
->crash_comp
);
1424 rproc
->state
= RPROC_OFFLINE
;
1428 EXPORT_SYMBOL(rproc_alloc
);
1431 * rproc_free() - unroll rproc_alloc()
1432 * @rproc: the remote processor handle
1434 * This function decrements the rproc dev refcount.
1436 * If no one holds any reference to rproc anymore, then its refcount would
1437 * now drop to zero, and it would be freed.
1439 void rproc_free(struct rproc
*rproc
)
1441 put_device(&rproc
->dev
);
1443 EXPORT_SYMBOL(rproc_free
);
1446 * rproc_put() - release rproc reference
1447 * @rproc: the remote processor handle
1449 * This function decrements the rproc dev refcount.
1451 * If no one holds any reference to rproc anymore, then its refcount would
1452 * now drop to zero, and it would be freed.
1454 void rproc_put(struct rproc
*rproc
)
1456 module_put(rproc
->dev
.parent
->driver
->owner
);
1457 put_device(&rproc
->dev
);
1459 EXPORT_SYMBOL(rproc_put
);
1462 * rproc_del() - unregister a remote processor
1463 * @rproc: rproc handle to unregister
1465 * This function should be called when the platform specific rproc
1466 * implementation decides to remove the rproc device. it should
1467 * _only_ be called if a previous invocation of rproc_add()
1468 * has completed successfully.
1470 * After rproc_del() returns, @rproc isn't freed yet, because
1471 * of the outstanding reference created by rproc_alloc. To decrement that
1472 * one last refcount, one still needs to call rproc_free().
1474 * Returns 0 on success and -EINVAL if @rproc isn't valid.
1476 int rproc_del(struct rproc
*rproc
)
1481 /* if rproc is marked always-on, rproc_add() booted it */
1482 /* TODO: make sure this works with rproc->power > 1 */
1483 if (rproc
->auto_boot
)
1484 rproc_shutdown(rproc
);
1486 mutex_lock(&rproc
->lock
);
1487 rproc
->state
= RPROC_DELETED
;
1488 mutex_unlock(&rproc
->lock
);
1490 rproc_delete_debug_dir(rproc
);
1492 /* the rproc is downref'ed as soon as it's removed from the klist */
1493 mutex_lock(&rproc_list_mutex
);
1494 list_del(&rproc
->node
);
1495 mutex_unlock(&rproc_list_mutex
);
1497 device_del(&rproc
->dev
);
1501 EXPORT_SYMBOL(rproc_del
);
1504 * rproc_add_subdev() - add a subdevice to a remoteproc
1505 * @rproc: rproc handle to add the subdevice to
1506 * @subdev: subdev handle to register
1507 * @probe: function to call when the rproc boots
1508 * @remove: function to call when the rproc shuts down
1510 void rproc_add_subdev(struct rproc
*rproc
,
1511 struct rproc_subdev
*subdev
,
1512 int (*probe
)(struct rproc_subdev
*subdev
),
1513 void (*remove
)(struct rproc_subdev
*subdev
))
1515 subdev
->probe
= probe
;
1516 subdev
->remove
= remove
;
1518 list_add_tail(&subdev
->node
, &rproc
->subdevs
);
1520 EXPORT_SYMBOL(rproc_add_subdev
);
1523 * rproc_remove_subdev() - remove a subdevice from a remoteproc
1524 * @rproc: rproc handle to remove the subdevice from
1525 * @subdev: subdev handle, previously registered with rproc_add_subdev()
1527 void rproc_remove_subdev(struct rproc
*rproc
, struct rproc_subdev
*subdev
)
1529 list_del(&subdev
->node
);
1531 EXPORT_SYMBOL(rproc_remove_subdev
);
1534 * rproc_report_crash() - rproc crash reporter function
1535 * @rproc: remote processor
1538 * This function must be called every time a crash is detected by the low-level
1539 * drivers implementing a specific remoteproc. This should not be called from a
1540 * non-remoteproc driver.
1542 * This function can be called from atomic/interrupt context.
1544 void rproc_report_crash(struct rproc
*rproc
, enum rproc_crash_type type
)
1547 pr_err("NULL rproc pointer\n");
1551 dev_err(&rproc
->dev
, "crash detected in %s: type %s\n",
1552 rproc
->name
, rproc_crash_to_string(type
));
1554 /* create a new task to handle the error */
1555 schedule_work(&rproc
->crash_handler
);
1557 EXPORT_SYMBOL(rproc_report_crash
);
1559 static int __init
remoteproc_init(void)
1562 rproc_init_debugfs();
1566 module_init(remoteproc_init
);
1568 static void __exit
remoteproc_exit(void)
1570 ida_destroy(&rproc_dev_index
);
1572 rproc_exit_debugfs();
1575 module_exit(remoteproc_exit
);
1577 MODULE_LICENSE("GPL v2");
1578 MODULE_DESCRIPTION("Generic Remote Processor Framework");