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 dev_dbg(dev, "vring%d: va %p dma %llx size %x idr %d\n", i, va,
240 (unsigned long long)dma, size, notifyid);
244 rvring->notifyid = notifyid;
247 * Let the rproc know the notifyid and da of this vring.
248 * Not all platforms use dma_alloc_coherent to automatically
249 * set up the iommu. In this case the device address (da) will
250 * hold the physical address and not the device address.
252 rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
253 rsc->vring[i].da = dma;
254 rsc->vring[i].notifyid = notifyid;
259 rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
261 struct rproc *rproc = rvdev->rproc;
262 struct device *dev = &rproc->dev;
263 struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
264 struct rproc_vring *rvring = &rvdev->vring[i];
266 dev_dbg(dev, "vdev rsc: vring%d: da %x, qsz %d, align %d\n",
267 i, vring->da, vring->num, vring->align);
269 /* make sure reserved bytes are zeroes */
270 if (vring->reserved) {
271 dev_err(dev, "vring rsc has non zero reserved bytes\n");
275 /* verify queue size and vring alignment are sane */
276 if (!vring->num || !vring->align) {
277 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
278 vring->num, vring->align);
282 rvring->len = vring->num;
283 rvring->align = vring->align;
284 rvring->rvdev = rvdev;
289 void rproc_free_vring(struct rproc_vring *rvring)
291 int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
292 struct rproc *rproc = rvring->rvdev->rproc;
293 int idx = rvring->rvdev->vring - rvring;
294 struct fw_rsc_vdev *rsc;
296 dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
297 idr_remove(&rproc->notifyids, rvring->notifyid);
299 /* reset resource entry info */
300 rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
301 rsc->vring[idx].da = 0;
302 rsc->vring[idx].notifyid = -1;
306 * rproc_handle_vdev() - handle a vdev fw resource
307 * @rproc: the remote processor
308 * @rsc: the vring resource descriptor
309 * @avail: size of available data (for sanity checking the image)
311 * This resource entry requests the host to statically register a virtio
312 * device (vdev), and setup everything needed to support it. It contains
313 * everything needed to make it possible: the virtio device id, virtio
314 * device features, vrings information, virtio config space, etc...
316 * Before registering the vdev, the vrings are allocated from non-cacheable
317 * physically contiguous memory. Currently we only support two vrings per
318 * remote processor (temporary limitation). We might also want to consider
319 * doing the vring allocation only later when ->find_vqs() is invoked, and
320 * then release them upon ->del_vqs().
322 * Note: @da is currently not really handled correctly: we dynamically
323 * allocate it using the DMA API, ignoring requested hard coded addresses,
324 * and we don't take care of any required IOMMU programming. This is all
325 * going to be taken care of when the generic iommu-based DMA API will be
326 * merged. Meanwhile, statically-addressed iommu-based firmware images should
327 * use RSC_DEVMEM resource entries to map their required @da to the physical
328 * address of their base CMA region (ouch, hacky!).
330 * Returns 0 on success, or an appropriate error code otherwise
332 static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
333 int offset, int avail)
335 struct device *dev = &rproc->dev;
336 struct rproc_vdev *rvdev;
339 /* make sure resource isn't truncated */
340 if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
341 + rsc->config_len > avail) {
342 dev_err(dev, "vdev rsc is truncated\n");
346 /* make sure reserved bytes are zeroes */
347 if (rsc->reserved[0] || rsc->reserved[1]) {
348 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
352 dev_dbg(dev, "vdev rsc: id %d, dfeatures %x, cfg len %d, %d vrings\n",
353 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
355 /* we currently support only two vrings per rvdev */
356 if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
357 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
361 rvdev = kzalloc(sizeof(struct rproc_vdev), GFP_KERNEL);
365 rvdev->rproc = rproc;
367 /* parse the vrings */
368 for (i = 0; i < rsc->num_of_vrings; i++) {
369 ret = rproc_parse_vring(rvdev, rsc, i);
374 /* remember the resource offset*/
375 rvdev->rsc_offset = offset;
377 list_add_tail(&rvdev->node, &rproc->rvdevs);
379 /* it is now safe to add the virtio device */
380 ret = rproc_add_virtio_dev(rvdev, rsc->id);
387 list_del(&rvdev->node);
394 * rproc_handle_trace() - handle a shared trace buffer resource
395 * @rproc: the remote processor
396 * @rsc: the trace resource descriptor
397 * @avail: size of available data (for sanity checking the image)
399 * In case the remote processor dumps trace logs into memory,
400 * export it via debugfs.
402 * Currently, the 'da' member of @rsc should contain the device address
403 * where the remote processor is dumping the traces. Later we could also
404 * support dynamically allocating this address using the generic
405 * DMA API (but currently there isn't a use case for that).
407 * Returns 0 on success, or an appropriate error code otherwise
409 static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
410 int offset, int avail)
412 struct rproc_mem_entry *trace;
413 struct device *dev = &rproc->dev;
417 if (sizeof(*rsc) > avail) {
418 dev_err(dev, "trace rsc is truncated\n");
422 /* make sure reserved bytes are zeroes */
424 dev_err(dev, "trace rsc has non zero reserved bytes\n");
428 /* what's the kernel address of this resource ? */
429 ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
431 dev_err(dev, "erroneous trace resource entry\n");
435 trace = kzalloc(sizeof(*trace), GFP_KERNEL);
439 /* set the trace buffer dma properties */
440 trace->len = rsc->len;
443 /* make sure snprintf always null terminates, even if truncating */
444 snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
446 /* create the debugfs entry */
447 trace->priv = rproc_create_trace_file(name, rproc, trace);
454 list_add_tail(&trace->node, &rproc->traces);
458 dev_dbg(dev, "%s added: va %p, da 0x%x, len 0x%x\n",
459 name, ptr, rsc->da, rsc->len);
465 * rproc_handle_devmem() - handle devmem resource entry
466 * @rproc: remote processor handle
467 * @rsc: the devmem resource entry
468 * @avail: size of available data (for sanity checking the image)
470 * Remote processors commonly need to access certain on-chip peripherals.
472 * Some of these remote processors access memory via an iommu device,
473 * and might require us to configure their iommu before they can access
474 * the on-chip peripherals they need.
476 * This resource entry is a request to map such a peripheral device.
478 * These devmem entries will contain the physical address of the device in
479 * the 'pa' member. If a specific device address is expected, then 'da' will
480 * contain it (currently this is the only use case supported). 'len' will
481 * contain the size of the physical region we need to map.
483 * Currently we just "trust" those devmem entries to contain valid physical
484 * addresses, but this is going to change: we want the implementations to
485 * tell us ranges of physical addresses the firmware is allowed to request,
486 * and not allow firmwares to request access to physical addresses that
487 * are outside those ranges.
489 static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
490 int offset, int avail)
492 struct rproc_mem_entry *mapping;
493 struct device *dev = &rproc->dev;
496 /* no point in handling this resource without a valid iommu domain */
500 if (sizeof(*rsc) > avail) {
501 dev_err(dev, "devmem rsc is truncated\n");
505 /* make sure reserved bytes are zeroes */
507 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
511 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
515 ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
517 dev_err(dev, "failed to map devmem: %d\n", ret);
522 * We'll need this info later when we'll want to unmap everything
523 * (e.g. on shutdown).
525 * We can't trust the remote processor not to change the resource
526 * table, so we must maintain this info independently.
528 mapping->da = rsc->da;
529 mapping->len = rsc->len;
530 list_add_tail(&mapping->node, &rproc->mappings);
532 dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
533 rsc->pa, rsc->da, rsc->len);
543 * rproc_handle_carveout() - handle phys contig memory allocation requests
544 * @rproc: rproc handle
545 * @rsc: the resource entry
546 * @avail: size of available data (for image validation)
548 * This function will handle firmware requests for allocation of physically
549 * contiguous memory regions.
551 * These request entries should come first in the firmware's resource table,
552 * as other firmware entries might request placing other data objects inside
553 * these memory regions (e.g. data/code segments, trace resource entries, ...).
555 * Allocating memory this way helps utilizing the reserved physical memory
556 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
557 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
558 * pressure is important; it may have a substantial impact on performance.
560 static int rproc_handle_carveout(struct rproc *rproc,
561 struct fw_rsc_carveout *rsc,
562 int offset, int avail)
565 struct rproc_mem_entry *carveout, *mapping;
566 struct device *dev = &rproc->dev;
571 if (sizeof(*rsc) > avail) {
572 dev_err(dev, "carveout rsc is truncated\n");
576 /* make sure reserved bytes are zeroes */
578 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
582 dev_dbg(dev, "carveout rsc: name: %s, da %x, pa %x, len 0x%x, flags %x\n",
583 rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
585 carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
589 va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
592 "failed to allocate dma memory: len 0x%x\n", rsc->len);
597 dev_dbg(dev, "carveout va %p, dma %llx, len 0x%x\n", va,
598 (unsigned long long)dma, rsc->len);
601 * Ok, this is non-standard.
603 * Sometimes we can't rely on the generic iommu-based DMA API
604 * to dynamically allocate the device address and then set the IOMMU
605 * tables accordingly, because some remote processors might
606 * _require_ us to use hard coded device addresses that their
607 * firmware was compiled with.
609 * In this case, we must use the IOMMU API directly and map
610 * the memory to the device address as expected by the remote
613 * Obviously such remote processor devices should not be configured
614 * to use the iommu-based DMA API: we expect 'dma' to contain the
615 * physical address in this case.
618 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
620 dev_err(dev, "kzalloc mapping failed\n");
625 ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
628 dev_err(dev, "iommu_map failed: %d\n", ret);
633 * We'll need this info later when we'll want to unmap
634 * everything (e.g. on shutdown).
636 * We can't trust the remote processor not to change the
637 * resource table, so we must maintain this info independently.
639 mapping->da = rsc->da;
640 mapping->len = rsc->len;
641 list_add_tail(&mapping->node, &rproc->mappings);
643 dev_dbg(dev, "carveout mapped 0x%x to 0x%llx\n",
644 rsc->da, (unsigned long long)dma);
648 * Some remote processors might need to know the pa
649 * even though they are behind an IOMMU. E.g., OMAP4's
650 * remote M3 processor needs this so it can control
651 * on-chip hardware accelerators that are not behind
652 * the IOMMU, and therefor must know the pa.
654 * Generally we don't want to expose physical addresses
655 * if we don't have to (remote processors are generally
656 * _not_ trusted), so we might want to do this only for
657 * remote processor that _must_ have this (e.g. OMAP4's
658 * dual M3 subsystem).
660 * Non-IOMMU processors might also want to have this info.
661 * In this case, the device address and the physical address
667 carveout->len = rsc->len;
669 carveout->da = rsc->da;
671 list_add_tail(&carveout->node, &rproc->carveouts);
678 dma_free_coherent(dev->parent, rsc->len, va, dma);
684 static int rproc_count_vrings(struct rproc *rproc, struct fw_rsc_vdev *rsc,
685 int offset, int avail)
687 /* Summarize the number of notification IDs */
688 rproc->max_notifyid += rsc->num_of_vrings;
694 * A lookup table for resource handlers. The indices are defined in
695 * enum fw_resource_type.
697 static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
698 [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
699 [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
700 [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
701 [RSC_VDEV] = NULL, /* VDEVs were handled upon registration */
704 static rproc_handle_resource_t rproc_vdev_handler[RSC_LAST] = {
705 [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
708 static rproc_handle_resource_t rproc_count_vrings_handler[RSC_LAST] = {
709 [RSC_VDEV] = (rproc_handle_resource_t)rproc_count_vrings,
712 /* handle firmware resource entries before booting the remote processor */
713 static int rproc_handle_resources(struct rproc *rproc, int len,
714 rproc_handle_resource_t handlers[RSC_LAST])
716 struct device *dev = &rproc->dev;
717 rproc_handle_resource_t handler;
720 for (i = 0; i < rproc->table_ptr->num; i++) {
721 int offset = rproc->table_ptr->offset[i];
722 struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
723 int avail = len - offset - sizeof(*hdr);
724 void *rsc = (void *)hdr + sizeof(*hdr);
726 /* make sure table isn't truncated */
728 dev_err(dev, "rsc table is truncated\n");
732 dev_dbg(dev, "rsc: type %d\n", hdr->type);
734 if (hdr->type >= RSC_LAST) {
735 dev_warn(dev, "unsupported resource %d\n", hdr->type);
739 handler = handlers[hdr->type];
743 ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
752 * rproc_resource_cleanup() - clean up and free all acquired resources
753 * @rproc: rproc handle
755 * This function will free all resources acquired for @rproc, and it
756 * is called whenever @rproc either shuts down or fails to boot.
758 static void rproc_resource_cleanup(struct rproc *rproc)
760 struct rproc_mem_entry *entry, *tmp;
761 struct device *dev = &rproc->dev;
763 /* clean up debugfs trace entries */
764 list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
765 rproc_remove_trace_file(entry->priv);
767 list_del(&entry->node);
771 /* clean up iommu mapping entries */
772 list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
775 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
776 if (unmapped != entry->len) {
777 /* nothing much to do besides complaining */
778 dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
782 list_del(&entry->node);
786 /* clean up carveout allocations */
787 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
788 dma_free_coherent(dev->parent, entry->len, entry->va,
790 list_del(&entry->node);
796 * take a firmware and boot a remote processor with it.
798 static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
800 struct device *dev = &rproc->dev;
801 const char *name = rproc->firmware;
802 struct resource_table *table, *loaded_table;
805 if (!rproc->table_ptr)
808 ret = rproc_fw_sanity_check(rproc, fw);
812 dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
815 * if enabling an IOMMU isn't relevant for this rproc, this is
818 ret = rproc_enable_iommu(rproc);
820 dev_err(dev, "can't enable iommu: %d\n", ret);
824 rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
827 /* look for the resource table */
828 table = rproc_find_rsc_table(rproc, fw, &tablesz);
830 dev_err(dev, "Failed to find resource table\n");
834 /* Verify that resource table in loaded fw is unchanged */
835 if (rproc->table_csum != crc32(0, table, tablesz)) {
836 dev_err(dev, "resource checksum failed, fw changed?\n");
840 /* handle fw resources which are required to boot rproc */
841 ret = rproc_handle_resources(rproc, tablesz, rproc_loading_handlers);
843 dev_err(dev, "Failed to process resources: %d\n", ret);
847 /* load the ELF segments to memory */
848 ret = rproc_load_segments(rproc, fw);
850 dev_err(dev, "Failed to load program segments: %d\n", ret);
855 * The starting device has been given the rproc->cached_table as the
856 * resource table. The address of the vring along with the other
857 * allocated resources (carveouts etc) is stored in cached_table.
858 * In order to pass this information to the remote device we must
859 * copy this information to device memory.
861 loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
863 memcpy(loaded_table, rproc->cached_table, tablesz);
865 /* power up the remote processor */
866 ret = rproc->ops->start(rproc);
868 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
873 * Update table_ptr so that all subsequent vring allocations and
874 * virtio fields manipulation update the actual loaded resource table
877 rproc->table_ptr = loaded_table;
879 rproc->state = RPROC_RUNNING;
881 dev_info(dev, "remote processor %s is now up\n", rproc->name);
886 rproc_resource_cleanup(rproc);
887 rproc_disable_iommu(rproc);
892 * take a firmware and look for virtio devices to register.
894 * Note: this function is called asynchronously upon registration of the
895 * remote processor (so we must wait until it completes before we try
896 * to unregister the device. one other option is just to use kref here,
897 * that might be cleaner).
899 static void rproc_fw_config_virtio(const struct firmware *fw, void *context)
901 struct rproc *rproc = context;
902 struct resource_table *table;
905 if (rproc_fw_sanity_check(rproc, fw) < 0)
908 /* look for the resource table */
909 table = rproc_find_rsc_table(rproc, fw, &tablesz);
913 rproc->table_csum = crc32(0, table, tablesz);
916 * Create a copy of the resource table. When a virtio device starts
917 * and calls vring_new_virtqueue() the address of the allocated vring
918 * will be stored in the cached_table. Before the device is started,
919 * cached_table will be copied into device memory.
921 rproc->cached_table = kmemdup(table, tablesz, GFP_KERNEL);
922 if (!rproc->cached_table)
925 rproc->table_ptr = rproc->cached_table;
927 /* count the number of notify-ids */
928 rproc->max_notifyid = -1;
929 ret = rproc_handle_resources(rproc, tablesz,
930 rproc_count_vrings_handler);
934 /* look for virtio devices and register them */
935 ret = rproc_handle_resources(rproc, tablesz, rproc_vdev_handler);
938 release_firmware(fw);
939 /* allow rproc_del() contexts, if any, to proceed */
940 complete_all(&rproc->firmware_loading_complete);
943 static int rproc_add_virtio_devices(struct rproc *rproc)
947 /* rproc_del() calls must wait until async loader completes */
948 init_completion(&rproc->firmware_loading_complete);
951 * We must retrieve early virtio configuration info from
952 * the firmware (e.g. whether to register a virtio device,
953 * what virtio features does it support, ...).
955 * We're initiating an asynchronous firmware loading, so we can
956 * be built-in kernel code, without hanging the boot process.
958 ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
959 rproc->firmware, &rproc->dev, GFP_KERNEL,
960 rproc, rproc_fw_config_virtio);
962 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
963 complete_all(&rproc->firmware_loading_complete);
970 * rproc_trigger_recovery() - recover a remoteproc
971 * @rproc: the remote processor
973 * The recovery is done by reseting all the virtio devices, that way all the
974 * rpmsg drivers will be reseted along with the remote processor making the
975 * remoteproc functional again.
977 * This function can sleep, so it cannot be called from atomic context.
979 int rproc_trigger_recovery(struct rproc *rproc)
981 struct rproc_vdev *rvdev, *rvtmp;
983 dev_err(&rproc->dev, "recovering %s\n", rproc->name);
985 init_completion(&rproc->crash_comp);
987 /* clean up remote vdev entries */
988 list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
989 rproc_remove_virtio_dev(rvdev);
991 /* wait until there is no more rproc users */
992 wait_for_completion(&rproc->crash_comp);
994 /* Free the copy of the resource table */
995 kfree(rproc->cached_table);
997 return rproc_add_virtio_devices(rproc);
1001 * rproc_crash_handler_work() - handle a crash
1003 * This function needs to handle everything related to a crash, like cpu
1004 * registers and stack dump, information to help to debug the fatal error, etc.
1006 static void rproc_crash_handler_work(struct work_struct *work)
1008 struct rproc *rproc = container_of(work, struct rproc, crash_handler);
1009 struct device *dev = &rproc->dev;
1011 dev_dbg(dev, "enter %s\n", __func__);
1013 mutex_lock(&rproc->lock);
1015 if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
1016 /* handle only the first crash detected */
1017 mutex_unlock(&rproc->lock);
1021 rproc->state = RPROC_CRASHED;
1022 dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
1025 mutex_unlock(&rproc->lock);
1027 if (!rproc->recovery_disabled)
1028 rproc_trigger_recovery(rproc);
1032 * __rproc_boot() - boot a remote processor
1033 * @rproc: handle of a remote processor
1034 * @wait: wait for rproc registration completion
1036 * Boot a remote processor (i.e. load its firmware, power it on, ...).
1038 * If the remote processor is already powered on, this function immediately
1039 * returns (successfully).
1041 * Returns 0 on success, and an appropriate error value otherwise.
1043 static int __rproc_boot(struct rproc *rproc, bool wait)
1045 const struct firmware *firmware_p;
1050 pr_err("invalid rproc handle\n");
1056 ret = mutex_lock_interruptible(&rproc->lock);
1058 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1062 /* loading a firmware is required */
1063 if (!rproc->firmware) {
1064 dev_err(dev, "%s: no firmware to load\n", __func__);
1069 /* prevent underlying implementation from being removed */
1070 if (!try_module_get(dev->parent->driver->owner)) {
1071 dev_err(dev, "%s: can't get owner\n", __func__);
1076 /* skip the boot process if rproc is already powered up */
1077 if (atomic_inc_return(&rproc->power) > 1) {
1082 dev_info(dev, "powering up %s\n", rproc->name);
1085 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1087 dev_err(dev, "request_firmware failed: %d\n", ret);
1091 /* if rproc virtio is not yet configured, wait */
1093 wait_for_completion(&rproc->firmware_loading_complete);
1095 ret = rproc_fw_boot(rproc, firmware_p);
1097 release_firmware(firmware_p);
1101 module_put(dev->parent->driver->owner);
1102 atomic_dec(&rproc->power);
1105 mutex_unlock(&rproc->lock);
1110 * rproc_boot() - boot a remote processor
1111 * @rproc: handle of a remote processor
1113 int rproc_boot(struct rproc *rproc)
1115 return __rproc_boot(rproc, true);
1117 EXPORT_SYMBOL(rproc_boot);
1120 * rproc_boot_nowait() - boot a remote processor
1121 * @rproc: handle of a remote processor
1123 * Same as rproc_boot() but don't wait for rproc registration completion
1125 int rproc_boot_nowait(struct rproc *rproc)
1127 return __rproc_boot(rproc, false);
1131 * rproc_shutdown() - power off the remote processor
1132 * @rproc: the remote processor
1134 * Power off a remote processor (previously booted with rproc_boot()).
1136 * In case @rproc is still being used by an additional user(s), then
1137 * this function will just decrement the power refcount and exit,
1138 * without really powering off the device.
1140 * Every call to rproc_boot() must (eventually) be accompanied by a call
1141 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1144 * - we're not decrementing the rproc's refcount, only the power refcount.
1145 * which means that the @rproc handle stays valid even after rproc_shutdown()
1146 * returns, and users can still use it with a subsequent rproc_boot(), if
1149 void rproc_shutdown(struct rproc *rproc)
1151 struct device *dev = &rproc->dev;
1154 ret = mutex_lock_interruptible(&rproc->lock);
1156 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1160 /* if the remote proc is still needed, bail out */
1161 if (!atomic_dec_and_test(&rproc->power))
1164 /* power off the remote processor */
1165 ret = rproc->ops->stop(rproc);
1167 atomic_inc(&rproc->power);
1168 dev_err(dev, "can't stop rproc: %d\n", ret);
1172 /* clean up all acquired resources */
1173 rproc_resource_cleanup(rproc);
1175 rproc_disable_iommu(rproc);
1177 /* Give the next start a clean resource table */
1178 rproc->table_ptr = rproc->cached_table;
1180 /* if in crash state, unlock crash handler */
1181 if (rproc->state == RPROC_CRASHED)
1182 complete_all(&rproc->crash_comp);
1184 rproc->state = RPROC_OFFLINE;
1186 dev_info(dev, "stopped remote processor %s\n", rproc->name);
1189 mutex_unlock(&rproc->lock);
1191 module_put(dev->parent->driver->owner);
1193 EXPORT_SYMBOL(rproc_shutdown);
1196 * rproc_get_by_phandle() - find a remote processor by phandle
1197 * @phandle: phandle to the rproc
1199 * Finds an rproc handle using the remote processor's phandle, and then
1200 * return a handle to the rproc.
1202 * This function increments the remote processor's refcount, so always
1203 * use rproc_put() to decrement it back once rproc isn't needed anymore.
1205 * Returns the rproc handle on success, and NULL on failure.
1208 struct rproc *rproc_get_by_phandle(phandle phandle)
1210 struct rproc *rproc = NULL, *r;
1211 struct device_node *np;
1213 np = of_find_node_by_phandle(phandle);
1217 mutex_lock(&rproc_list_mutex);
1218 list_for_each_entry(r, &rproc_list, node) {
1219 if (r->dev.parent && r->dev.parent->of_node == np) {
1221 get_device(&rproc->dev);
1225 mutex_unlock(&rproc_list_mutex);
1232 struct rproc *rproc_get_by_phandle(phandle phandle)
1237 EXPORT_SYMBOL(rproc_get_by_phandle);
1240 * rproc_add() - register a remote processor
1241 * @rproc: the remote processor handle to register
1243 * Registers @rproc with the remoteproc framework, after it has been
1244 * allocated with rproc_alloc().
1246 * This is called by the platform-specific rproc implementation, whenever
1247 * a new remote processor device is probed.
1249 * Returns 0 on success and an appropriate error code otherwise.
1251 * Note: this function initiates an asynchronous firmware loading
1252 * context, which will look for virtio devices supported by the rproc's
1255 * If found, those virtio devices will be created and added, so as a result
1256 * of registering this remote processor, additional virtio drivers might be
1259 int rproc_add(struct rproc *rproc)
1261 struct device *dev = &rproc->dev;
1264 ret = device_add(dev);
1268 dev_info(dev, "%s is available\n", rproc->name);
1270 dev_info(dev, "Note: remoteproc is still under development and considered experimental.\n");
1271 dev_info(dev, "THE BINARY FORMAT IS NOT YET FINALIZED, and backward compatibility isn't yet guaranteed.\n");
1273 /* create debugfs entries */
1274 rproc_create_debug_dir(rproc);
1275 ret = rproc_add_virtio_devices(rproc);
1279 /* expose to rproc_get_by_phandle users */
1280 mutex_lock(&rproc_list_mutex);
1281 list_add(&rproc->node, &rproc_list);
1282 mutex_unlock(&rproc_list_mutex);
1286 EXPORT_SYMBOL(rproc_add);
1289 * rproc_type_release() - release a remote processor instance
1290 * @dev: the rproc's device
1292 * This function should _never_ be called directly.
1294 * It will be called by the driver core when no one holds a valid pointer
1297 static void rproc_type_release(struct device *dev)
1299 struct rproc *rproc = container_of(dev, struct rproc, dev);
1301 dev_info(&rproc->dev, "releasing %s\n", rproc->name);
1303 rproc_delete_debug_dir(rproc);
1305 idr_destroy(&rproc->notifyids);
1307 if (rproc->index >= 0)
1308 ida_simple_remove(&rproc_dev_index, rproc->index);
1313 static struct device_type rproc_type = {
1314 .name = "remoteproc",
1315 .release = rproc_type_release,
1319 * rproc_alloc() - allocate a remote processor handle
1320 * @dev: the underlying device
1321 * @name: name of this remote processor
1322 * @ops: platform-specific handlers (mainly start/stop)
1323 * @firmware: name of firmware file to load, can be NULL
1324 * @len: length of private data needed by the rproc driver (in bytes)
1326 * Allocates a new remote processor handle, but does not register
1327 * it yet. if @firmware is NULL, a default name is used.
1329 * This function should be used by rproc implementations during initialization
1330 * of the remote processor.
1332 * After creating an rproc handle using this function, and when ready,
1333 * implementations should then call rproc_add() to complete
1334 * the registration of the remote processor.
1336 * On success the new rproc is returned, and on failure, NULL.
1338 * Note: _never_ directly deallocate @rproc, even if it was not registered
1339 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_put().
1341 struct rproc *rproc_alloc(struct device *dev, const char *name,
1342 const struct rproc_ops *ops,
1343 const char *firmware, int len)
1345 struct rproc *rproc;
1346 char *p, *template = "rproc-%s-fw";
1349 if (!dev || !name || !ops)
1354 * Make room for default firmware name (minus %s plus '\0').
1355 * If the caller didn't pass in a firmware name then
1356 * construct a default name. We're already glomming 'len'
1357 * bytes onto the end of the struct rproc allocation, so do
1358 * a few more for the default firmware name (but only if
1359 * the caller doesn't pass one).
1361 name_len = strlen(name) + strlen(template) - 2 + 1;
1363 rproc = kzalloc(sizeof(struct rproc) + len + name_len, GFP_KERNEL);
1368 p = (char *)rproc + sizeof(struct rproc) + len;
1369 snprintf(p, name_len, template, name);
1371 p = (char *)firmware;
1374 rproc->firmware = p;
1377 rproc->priv = &rproc[1];
1379 device_initialize(&rproc->dev);
1380 rproc->dev.parent = dev;
1381 rproc->dev.type = &rproc_type;
1383 /* Assign a unique device index and name */
1384 rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1385 if (rproc->index < 0) {
1386 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1387 put_device(&rproc->dev);
1391 dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1393 atomic_set(&rproc->power, 0);
1395 /* Set ELF as the default fw_ops handler */
1396 rproc->fw_ops = &rproc_elf_fw_ops;
1398 mutex_init(&rproc->lock);
1400 idr_init(&rproc->notifyids);
1402 INIT_LIST_HEAD(&rproc->carveouts);
1403 INIT_LIST_HEAD(&rproc->mappings);
1404 INIT_LIST_HEAD(&rproc->traces);
1405 INIT_LIST_HEAD(&rproc->rvdevs);
1407 INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
1408 init_completion(&rproc->crash_comp);
1410 rproc->state = RPROC_OFFLINE;
1414 EXPORT_SYMBOL(rproc_alloc);
1417 * rproc_put() - unroll rproc_alloc()
1418 * @rproc: the remote processor handle
1420 * This function decrements the rproc dev refcount.
1422 * If no one holds any reference to rproc anymore, then its refcount would
1423 * now drop to zero, and it would be freed.
1425 void rproc_put(struct rproc *rproc)
1427 put_device(&rproc->dev);
1429 EXPORT_SYMBOL(rproc_put);
1432 * rproc_del() - unregister a remote processor
1433 * @rproc: rproc handle to unregister
1435 * This function should be called when the platform specific rproc
1436 * implementation decides to remove the rproc device. it should
1437 * _only_ be called if a previous invocation of rproc_add()
1438 * has completed successfully.
1440 * After rproc_del() returns, @rproc isn't freed yet, because
1441 * of the outstanding reference created by rproc_alloc. To decrement that
1442 * one last refcount, one still needs to call rproc_put().
1444 * Returns 0 on success and -EINVAL if @rproc isn't valid.
1446 int rproc_del(struct rproc *rproc)
1448 struct rproc_vdev *rvdev, *tmp;
1453 /* if rproc is just being registered, wait */
1454 wait_for_completion(&rproc->firmware_loading_complete);
1456 /* clean up remote vdev entries */
1457 list_for_each_entry_safe(rvdev, tmp, &rproc->rvdevs, node)
1458 rproc_remove_virtio_dev(rvdev);
1460 /* Free the copy of the resource table */
1461 kfree(rproc->cached_table);
1463 /* the rproc is downref'ed as soon as it's removed from the klist */
1464 mutex_lock(&rproc_list_mutex);
1465 list_del(&rproc->node);
1466 mutex_unlock(&rproc_list_mutex);
1468 device_del(&rproc->dev);
1472 EXPORT_SYMBOL(rproc_del);
1475 * rproc_report_crash() - rproc crash reporter function
1476 * @rproc: remote processor
1479 * This function must be called every time a crash is detected by the low-level
1480 * drivers implementing a specific remoteproc. This should not be called from a
1481 * non-remoteproc driver.
1483 * This function can be called from atomic/interrupt context.
1485 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
1488 pr_err("NULL rproc pointer\n");
1492 dev_err(&rproc->dev, "crash detected in %s: type %s\n",
1493 rproc->name, rproc_crash_to_string(type));
1495 /* create a new task to handle the error */
1496 schedule_work(&rproc->crash_handler);
1498 EXPORT_SYMBOL(rproc_report_crash);
1500 static int __init remoteproc_init(void)
1502 rproc_init_debugfs();
1506 module_init(remoteproc_init);
1508 static void __exit remoteproc_exit(void)
1510 ida_destroy(&rproc_dev_index);
1512 rproc_exit_debugfs();
1514 module_exit(remoteproc_exit);
1516 MODULE_LICENSE("GPL v2");
1517 MODULE_DESCRIPTION("Generic Remote Processor Framework");