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",
62 /* translate rproc_crash_type to string */
63 static const char *rproc_crash_to_string(enum rproc_crash_type type)
65 if (type < ARRAY_SIZE(rproc_crash_names))
66 return rproc_crash_names[type];
71 * This is the IOMMU fault handler we register with the IOMMU API
72 * (when relevant; not all remote processors access memory through
75 * IOMMU core will invoke this handler whenever the remote processor
76 * will try to access an unmapped device address.
78 static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
79 unsigned long iova, int flags, void *token)
81 struct rproc *rproc = token;
83 dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
85 rproc_report_crash(rproc, RPROC_MMUFAULT);
88 * Let the iommu core know we're not really handling this fault;
89 * we just used it as a recovery trigger.
94 static int rproc_enable_iommu(struct rproc *rproc)
96 struct iommu_domain *domain;
97 struct device *dev = rproc->dev.parent;
100 if (!rproc->has_iommu) {
101 dev_dbg(dev, "iommu not present\n");
105 domain = iommu_domain_alloc(dev->bus);
107 dev_err(dev, "can't alloc iommu domain\n");
111 iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
113 ret = iommu_attach_device(domain, dev);
115 dev_err(dev, "can't attach iommu device: %d\n", ret);
119 rproc->domain = domain;
124 iommu_domain_free(domain);
128 static void rproc_disable_iommu(struct rproc *rproc)
130 struct iommu_domain *domain = rproc->domain;
131 struct device *dev = rproc->dev.parent;
136 iommu_detach_device(domain, dev);
137 iommu_domain_free(domain);
141 * Some remote processors will ask us to allocate them physically contiguous
142 * memory regions (which we call "carveouts"), and map them to specific
143 * device addresses (which are hardcoded in the firmware).
145 * They may then ask us to copy objects into specific device addresses (e.g.
146 * code/data sections) or expose us certain symbols in other device address
147 * (e.g. their trace buffer).
149 * This function is an internal helper with which we can go over the allocated
150 * carveouts and translate specific device address to kernel virtual addresses
151 * so we can access the referenced memory.
153 * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
154 * but only on kernel direct mapped RAM memory. Instead, we're just using
155 * here the output of the DMA API, which should be more correct.
157 void *rproc_da_to_va(struct rproc *rproc, u64 da, int len)
159 struct rproc_mem_entry *carveout;
162 list_for_each_entry(carveout, &rproc->carveouts, node) {
163 int offset = da - carveout->da;
165 /* try next carveout if da is too small */
169 /* try next carveout if da is too large */
170 if (offset + len > carveout->len)
173 ptr = carveout->va + offset;
180 EXPORT_SYMBOL(rproc_da_to_va);
182 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
184 struct rproc *rproc = rvdev->rproc;
185 struct device *dev = &rproc->dev;
186 struct rproc_vring *rvring = &rvdev->vring[i];
187 struct fw_rsc_vdev *rsc;
190 int ret, size, notifyid;
192 /* actual size of vring (in bytes) */
193 size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
196 * Allocate non-cacheable memory for the vring. In the future
197 * this call will also configure the IOMMU for us
199 va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL);
201 dev_err(dev->parent, "dma_alloc_coherent failed\n");
206 * Assign an rproc-wide unique index for this vring
207 * TODO: assign a notifyid for rvdev updates as well
208 * TODO: support predefined notifyids (via resource table)
210 ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
212 dev_err(dev, "idr_alloc failed: %d\n", ret);
213 dma_free_coherent(dev->parent, size, va, dma);
218 dev_dbg(dev, "vring%d: va %p dma %llx size %x idr %d\n", i, va,
219 (unsigned long long)dma, size, notifyid);
223 rvring->notifyid = notifyid;
226 * Let the rproc know the notifyid and da of this vring.
227 * Not all platforms use dma_alloc_coherent to automatically
228 * set up the iommu. In this case the device address (da) will
229 * hold the physical address and not the device address.
231 rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
232 rsc->vring[i].da = dma;
233 rsc->vring[i].notifyid = notifyid;
238 rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
240 struct rproc *rproc = rvdev->rproc;
241 struct device *dev = &rproc->dev;
242 struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
243 struct rproc_vring *rvring = &rvdev->vring[i];
245 dev_dbg(dev, "vdev rsc: vring%d: da %x, qsz %d, align %d\n",
246 i, vring->da, vring->num, vring->align);
248 /* make sure reserved bytes are zeroes */
249 if (vring->reserved) {
250 dev_err(dev, "vring rsc has non zero reserved bytes\n");
254 /* verify queue size and vring alignment are sane */
255 if (!vring->num || !vring->align) {
256 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
257 vring->num, vring->align);
261 rvring->len = vring->num;
262 rvring->align = vring->align;
263 rvring->rvdev = rvdev;
268 void rproc_free_vring(struct rproc_vring *rvring)
270 int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
271 struct rproc *rproc = rvring->rvdev->rproc;
272 int idx = rvring->rvdev->vring - rvring;
273 struct fw_rsc_vdev *rsc;
275 dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
276 idr_remove(&rproc->notifyids, rvring->notifyid);
278 /* reset resource entry info */
279 rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
280 rsc->vring[idx].da = 0;
281 rsc->vring[idx].notifyid = -1;
285 * rproc_handle_vdev() - handle a vdev fw resource
286 * @rproc: the remote processor
287 * @rsc: the vring resource descriptor
288 * @avail: size of available data (for sanity checking the image)
290 * This resource entry requests the host to statically register a virtio
291 * device (vdev), and setup everything needed to support it. It contains
292 * everything needed to make it possible: the virtio device id, virtio
293 * device features, vrings information, virtio config space, etc...
295 * Before registering the vdev, the vrings are allocated from non-cacheable
296 * physically contiguous memory. Currently we only support two vrings per
297 * remote processor (temporary limitation). We might also want to consider
298 * doing the vring allocation only later when ->find_vqs() is invoked, and
299 * then release them upon ->del_vqs().
301 * Note: @da is currently not really handled correctly: we dynamically
302 * allocate it using the DMA API, ignoring requested hard coded addresses,
303 * and we don't take care of any required IOMMU programming. This is all
304 * going to be taken care of when the generic iommu-based DMA API will be
305 * merged. Meanwhile, statically-addressed iommu-based firmware images should
306 * use RSC_DEVMEM resource entries to map their required @da to the physical
307 * address of their base CMA region (ouch, hacky!).
309 * Returns 0 on success, or an appropriate error code otherwise
311 static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
312 int offset, int avail)
314 struct device *dev = &rproc->dev;
315 struct rproc_vdev *rvdev;
318 /* make sure resource isn't truncated */
319 if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
320 + rsc->config_len > avail) {
321 dev_err(dev, "vdev rsc is truncated\n");
325 /* make sure reserved bytes are zeroes */
326 if (rsc->reserved[0] || rsc->reserved[1]) {
327 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
331 dev_dbg(dev, "vdev rsc: id %d, dfeatures %x, cfg len %d, %d vrings\n",
332 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
334 /* we currently support only two vrings per rvdev */
335 if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
336 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
340 rvdev = kzalloc(sizeof(struct rproc_vdev), GFP_KERNEL);
344 rvdev->rproc = rproc;
346 /* parse the vrings */
347 for (i = 0; i < rsc->num_of_vrings; i++) {
348 ret = rproc_parse_vring(rvdev, rsc, i);
353 /* remember the resource offset*/
354 rvdev->rsc_offset = offset;
356 list_add_tail(&rvdev->node, &rproc->rvdevs);
358 /* it is now safe to add the virtio device */
359 ret = rproc_add_virtio_dev(rvdev, rsc->id);
366 list_del(&rvdev->node);
373 * rproc_handle_trace() - handle a shared trace buffer resource
374 * @rproc: the remote processor
375 * @rsc: the trace resource descriptor
376 * @avail: size of available data (for sanity checking the image)
378 * In case the remote processor dumps trace logs into memory,
379 * export it via debugfs.
381 * Currently, the 'da' member of @rsc should contain the device address
382 * where the remote processor is dumping the traces. Later we could also
383 * support dynamically allocating this address using the generic
384 * DMA API (but currently there isn't a use case for that).
386 * Returns 0 on success, or an appropriate error code otherwise
388 static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
389 int offset, int avail)
391 struct rproc_mem_entry *trace;
392 struct device *dev = &rproc->dev;
396 if (sizeof(*rsc) > avail) {
397 dev_err(dev, "trace rsc is truncated\n");
401 /* make sure reserved bytes are zeroes */
403 dev_err(dev, "trace rsc has non zero reserved bytes\n");
407 /* what's the kernel address of this resource ? */
408 ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
410 dev_err(dev, "erroneous trace resource entry\n");
414 trace = kzalloc(sizeof(*trace), GFP_KERNEL);
418 /* set the trace buffer dma properties */
419 trace->len = rsc->len;
422 /* make sure snprintf always null terminates, even if truncating */
423 snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
425 /* create the debugfs entry */
426 trace->priv = rproc_create_trace_file(name, rproc, trace);
433 list_add_tail(&trace->node, &rproc->traces);
437 dev_dbg(dev, "%s added: va %p, da 0x%x, len 0x%x\n", name, ptr,
444 * rproc_handle_devmem() - handle devmem resource entry
445 * @rproc: remote processor handle
446 * @rsc: the devmem resource entry
447 * @avail: size of available data (for sanity checking the image)
449 * Remote processors commonly need to access certain on-chip peripherals.
451 * Some of these remote processors access memory via an iommu device,
452 * and might require us to configure their iommu before they can access
453 * the on-chip peripherals they need.
455 * This resource entry is a request to map such a peripheral device.
457 * These devmem entries will contain the physical address of the device in
458 * the 'pa' member. If a specific device address is expected, then 'da' will
459 * contain it (currently this is the only use case supported). 'len' will
460 * contain the size of the physical region we need to map.
462 * Currently we just "trust" those devmem entries to contain valid physical
463 * addresses, but this is going to change: we want the implementations to
464 * tell us ranges of physical addresses the firmware is allowed to request,
465 * and not allow firmwares to request access to physical addresses that
466 * are outside those ranges.
468 static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
469 int offset, int avail)
471 struct rproc_mem_entry *mapping;
472 struct device *dev = &rproc->dev;
475 /* no point in handling this resource without a valid iommu domain */
479 if (sizeof(*rsc) > avail) {
480 dev_err(dev, "devmem rsc is truncated\n");
484 /* make sure reserved bytes are zeroes */
486 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
490 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
494 ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
496 dev_err(dev, "failed to map devmem: %d\n", ret);
501 * We'll need this info later when we'll want to unmap everything
502 * (e.g. on shutdown).
504 * We can't trust the remote processor not to change the resource
505 * table, so we must maintain this info independently.
507 mapping->da = rsc->da;
508 mapping->len = rsc->len;
509 list_add_tail(&mapping->node, &rproc->mappings);
511 dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
512 rsc->pa, rsc->da, rsc->len);
522 * rproc_handle_carveout() - handle phys contig memory allocation requests
523 * @rproc: rproc handle
524 * @rsc: the resource entry
525 * @avail: size of available data (for image validation)
527 * This function will handle firmware requests for allocation of physically
528 * contiguous memory regions.
530 * These request entries should come first in the firmware's resource table,
531 * as other firmware entries might request placing other data objects inside
532 * these memory regions (e.g. data/code segments, trace resource entries, ...).
534 * Allocating memory this way helps utilizing the reserved physical memory
535 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
536 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
537 * pressure is important; it may have a substantial impact on performance.
539 static int rproc_handle_carveout(struct rproc *rproc,
540 struct fw_rsc_carveout *rsc,
541 int offset, int avail)
544 struct rproc_mem_entry *carveout, *mapping;
545 struct device *dev = &rproc->dev;
550 if (sizeof(*rsc) > avail) {
551 dev_err(dev, "carveout rsc is truncated\n");
555 /* make sure reserved bytes are zeroes */
557 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
561 dev_dbg(dev, "carveout rsc: da %x, pa %x, len %x, flags %x\n",
562 rsc->da, rsc->pa, rsc->len, rsc->flags);
564 carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
568 va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
570 dev_err(dev->parent, "dma_alloc_coherent err: %d\n", rsc->len);
575 dev_dbg(dev, "carveout va %p, dma %llx, len 0x%x\n", va,
576 (unsigned long long)dma, rsc->len);
579 * Ok, this is non-standard.
581 * Sometimes we can't rely on the generic iommu-based DMA API
582 * to dynamically allocate the device address and then set the IOMMU
583 * tables accordingly, because some remote processors might
584 * _require_ us to use hard coded device addresses that their
585 * firmware was compiled with.
587 * In this case, we must use the IOMMU API directly and map
588 * the memory to the device address as expected by the remote
591 * Obviously such remote processor devices should not be configured
592 * to use the iommu-based DMA API: we expect 'dma' to contain the
593 * physical address in this case.
596 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
598 dev_err(dev, "kzalloc mapping failed\n");
603 ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
606 dev_err(dev, "iommu_map failed: %d\n", ret);
611 * We'll need this info later when we'll want to unmap
612 * everything (e.g. on shutdown).
614 * We can't trust the remote processor not to change the
615 * resource table, so we must maintain this info independently.
617 mapping->da = rsc->da;
618 mapping->len = rsc->len;
619 list_add_tail(&mapping->node, &rproc->mappings);
621 dev_dbg(dev, "carveout mapped 0x%x to 0x%llx\n",
622 rsc->da, (unsigned long long)dma);
626 * Some remote processors might need to know the pa
627 * even though they are behind an IOMMU. E.g., OMAP4's
628 * remote M3 processor needs this so it can control
629 * on-chip hardware accelerators that are not behind
630 * the IOMMU, and therefor must know the pa.
632 * Generally we don't want to expose physical addresses
633 * if we don't have to (remote processors are generally
634 * _not_ trusted), so we might want to do this only for
635 * remote processor that _must_ have this (e.g. OMAP4's
636 * dual M3 subsystem).
638 * Non-IOMMU processors might also want to have this info.
639 * In this case, the device address and the physical address
645 carveout->len = rsc->len;
647 carveout->da = rsc->da;
649 list_add_tail(&carveout->node, &rproc->carveouts);
656 dma_free_coherent(dev->parent, rsc->len, va, dma);
662 static int rproc_count_vrings(struct rproc *rproc, struct fw_rsc_vdev *rsc,
663 int offset, int avail)
665 /* Summarize the number of notification IDs */
666 rproc->max_notifyid += rsc->num_of_vrings;
672 * A lookup table for resource handlers. The indices are defined in
673 * enum fw_resource_type.
675 static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
676 [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
677 [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
678 [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
679 [RSC_VDEV] = NULL, /* VDEVs were handled upon registrarion */
682 static rproc_handle_resource_t rproc_vdev_handler[RSC_LAST] = {
683 [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
686 static rproc_handle_resource_t rproc_count_vrings_handler[RSC_LAST] = {
687 [RSC_VDEV] = (rproc_handle_resource_t)rproc_count_vrings,
690 /* handle firmware resource entries before booting the remote processor */
691 static int rproc_handle_resources(struct rproc *rproc, int len,
692 rproc_handle_resource_t handlers[RSC_LAST])
694 struct device *dev = &rproc->dev;
695 rproc_handle_resource_t handler;
698 for (i = 0; i < rproc->table_ptr->num; i++) {
699 int offset = rproc->table_ptr->offset[i];
700 struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
701 int avail = len - offset - sizeof(*hdr);
702 void *rsc = (void *)hdr + sizeof(*hdr);
704 /* make sure table isn't truncated */
706 dev_err(dev, "rsc table is truncated\n");
710 dev_dbg(dev, "rsc: type %d\n", hdr->type);
712 if (hdr->type >= RSC_LAST) {
713 dev_warn(dev, "unsupported resource %d\n", hdr->type);
717 handler = handlers[hdr->type];
721 ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
730 * rproc_resource_cleanup() - clean up and free all acquired resources
731 * @rproc: rproc handle
733 * This function will free all resources acquired for @rproc, and it
734 * is called whenever @rproc either shuts down or fails to boot.
736 static void rproc_resource_cleanup(struct rproc *rproc)
738 struct rproc_mem_entry *entry, *tmp;
739 struct device *dev = &rproc->dev;
741 /* clean up debugfs trace entries */
742 list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
743 rproc_remove_trace_file(entry->priv);
745 list_del(&entry->node);
749 /* clean up iommu mapping entries */
750 list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
753 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
754 if (unmapped != entry->len) {
755 /* nothing much to do besides complaining */
756 dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
760 list_del(&entry->node);
764 /* clean up carveout allocations */
765 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
766 dma_free_coherent(dev->parent, entry->len, entry->va,
768 list_del(&entry->node);
774 * take a firmware and boot a remote processor with it.
776 static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
778 struct device *dev = &rproc->dev;
779 const char *name = rproc->firmware;
780 struct resource_table *table, *loaded_table;
783 if (!rproc->table_ptr)
786 ret = rproc_fw_sanity_check(rproc, fw);
790 dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
793 * if enabling an IOMMU isn't relevant for this rproc, this is
796 ret = rproc_enable_iommu(rproc);
798 dev_err(dev, "can't enable iommu: %d\n", ret);
802 rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
805 /* look for the resource table */
806 table = rproc_find_rsc_table(rproc, fw, &tablesz);
810 /* Verify that resource table in loaded fw is unchanged */
811 if (rproc->table_csum != crc32(0, table, tablesz)) {
812 dev_err(dev, "resource checksum failed, fw changed?\n");
816 /* handle fw resources which are required to boot rproc */
817 ret = rproc_handle_resources(rproc, tablesz, rproc_loading_handlers);
819 dev_err(dev, "Failed to process resources: %d\n", ret);
823 /* load the ELF segments to memory */
824 ret = rproc_load_segments(rproc, fw);
826 dev_err(dev, "Failed to load program segments: %d\n", ret);
831 * The starting device has been given the rproc->cached_table as the
832 * resource table. The address of the vring along with the other
833 * allocated resources (carveouts etc) is stored in cached_table.
834 * In order to pass this information to the remote device we must
835 * copy this information to device memory.
837 loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
843 memcpy(loaded_table, rproc->cached_table, tablesz);
845 /* power up the remote processor */
846 ret = rproc->ops->start(rproc);
848 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
853 * Update table_ptr so that all subsequent vring allocations and
854 * virtio fields manipulation update the actual loaded resource table
857 rproc->table_ptr = loaded_table;
859 rproc->state = RPROC_RUNNING;
861 dev_info(dev, "remote processor %s is now up\n", rproc->name);
866 rproc_resource_cleanup(rproc);
867 rproc_disable_iommu(rproc);
872 * take a firmware and look for virtio devices to register.
874 * Note: this function is called asynchronously upon registration of the
875 * remote processor (so we must wait until it completes before we try
876 * to unregister the device. one other option is just to use kref here,
877 * that might be cleaner).
879 static void rproc_fw_config_virtio(const struct firmware *fw, void *context)
881 struct rproc *rproc = context;
882 struct resource_table *table;
885 if (rproc_fw_sanity_check(rproc, fw) < 0)
888 /* look for the resource table */
889 table = rproc_find_rsc_table(rproc, fw, &tablesz);
893 rproc->table_csum = crc32(0, table, tablesz);
896 * Create a copy of the resource table. When a virtio device starts
897 * and calls vring_new_virtqueue() the address of the allocated vring
898 * will be stored in the cached_table. Before the device is started,
899 * cached_table will be copied into devic memory.
901 rproc->cached_table = kmemdup(table, tablesz, GFP_KERNEL);
902 if (!rproc->cached_table)
905 rproc->table_ptr = rproc->cached_table;
907 /* count the number of notify-ids */
908 rproc->max_notifyid = -1;
909 ret = rproc_handle_resources(rproc, tablesz,
910 rproc_count_vrings_handler);
914 /* look for virtio devices and register them */
915 ret = rproc_handle_resources(rproc, tablesz, rproc_vdev_handler);
918 release_firmware(fw);
919 /* allow rproc_del() contexts, if any, to proceed */
920 complete_all(&rproc->firmware_loading_complete);
923 static int rproc_add_virtio_devices(struct rproc *rproc)
927 /* rproc_del() calls must wait until async loader completes */
928 init_completion(&rproc->firmware_loading_complete);
931 * We must retrieve early virtio configuration info from
932 * the firmware (e.g. whether to register a virtio device,
933 * what virtio features does it support, ...).
935 * We're initiating an asynchronous firmware loading, so we can
936 * be built-in kernel code, without hanging the boot process.
938 ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
939 rproc->firmware, &rproc->dev, GFP_KERNEL,
940 rproc, rproc_fw_config_virtio);
942 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
943 complete_all(&rproc->firmware_loading_complete);
950 * rproc_trigger_recovery() - recover a remoteproc
951 * @rproc: the remote processor
953 * The recovery is done by reseting all the virtio devices, that way all the
954 * rpmsg drivers will be reseted along with the remote processor making the
955 * remoteproc functional again.
957 * This function can sleep, so it cannot be called from atomic context.
959 int rproc_trigger_recovery(struct rproc *rproc)
961 struct rproc_vdev *rvdev, *rvtmp;
963 dev_err(&rproc->dev, "recovering %s\n", rproc->name);
965 init_completion(&rproc->crash_comp);
967 /* clean up remote vdev entries */
968 list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
969 rproc_remove_virtio_dev(rvdev);
971 /* wait until there is no more rproc users */
972 wait_for_completion(&rproc->crash_comp);
974 /* Free the copy of the resource table */
975 kfree(rproc->cached_table);
977 return rproc_add_virtio_devices(rproc);
981 * rproc_crash_handler_work() - handle a crash
983 * This function needs to handle everything related to a crash, like cpu
984 * registers and stack dump, information to help to debug the fatal error, etc.
986 static void rproc_crash_handler_work(struct work_struct *work)
988 struct rproc *rproc = container_of(work, struct rproc, crash_handler);
989 struct device *dev = &rproc->dev;
991 dev_dbg(dev, "enter %s\n", __func__);
993 mutex_lock(&rproc->lock);
995 if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
996 /* handle only the first crash detected */
997 mutex_unlock(&rproc->lock);
1001 rproc->state = RPROC_CRASHED;
1002 dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
1005 mutex_unlock(&rproc->lock);
1007 if (!rproc->recovery_disabled)
1008 rproc_trigger_recovery(rproc);
1012 * rproc_boot() - boot a remote processor
1013 * @rproc: handle of a remote processor
1015 * Boot a remote processor (i.e. load its firmware, power it on, ...).
1017 * If the remote processor is already powered on, this function immediately
1018 * returns (successfully).
1020 * Returns 0 on success, and an appropriate error value otherwise.
1022 int rproc_boot(struct rproc *rproc)
1024 const struct firmware *firmware_p;
1029 pr_err("invalid rproc handle\n");
1035 ret = mutex_lock_interruptible(&rproc->lock);
1037 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1041 /* loading a firmware is required */
1042 if (!rproc->firmware) {
1043 dev_err(dev, "%s: no firmware to load\n", __func__);
1048 /* prevent underlying implementation from being removed */
1049 if (!try_module_get(dev->parent->driver->owner)) {
1050 dev_err(dev, "%s: can't get owner\n", __func__);
1055 /* skip the boot process if rproc is already powered up */
1056 if (atomic_inc_return(&rproc->power) > 1) {
1061 dev_info(dev, "powering up %s\n", rproc->name);
1064 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1066 dev_err(dev, "request_firmware failed: %d\n", ret);
1070 ret = rproc_fw_boot(rproc, firmware_p);
1072 release_firmware(firmware_p);
1076 module_put(dev->parent->driver->owner);
1077 atomic_dec(&rproc->power);
1080 mutex_unlock(&rproc->lock);
1083 EXPORT_SYMBOL(rproc_boot);
1086 * rproc_shutdown() - power off the remote processor
1087 * @rproc: the remote processor
1089 * Power off a remote processor (previously booted with rproc_boot()).
1091 * In case @rproc is still being used by an additional user(s), then
1092 * this function will just decrement the power refcount and exit,
1093 * without really powering off the device.
1095 * Every call to rproc_boot() must (eventually) be accompanied by a call
1096 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1099 * - we're not decrementing the rproc's refcount, only the power refcount.
1100 * which means that the @rproc handle stays valid even after rproc_shutdown()
1101 * returns, and users can still use it with a subsequent rproc_boot(), if
1104 void rproc_shutdown(struct rproc *rproc)
1106 struct device *dev = &rproc->dev;
1109 ret = mutex_lock_interruptible(&rproc->lock);
1111 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1115 /* if the remote proc is still needed, bail out */
1116 if (!atomic_dec_and_test(&rproc->power))
1119 /* power off the remote processor */
1120 ret = rproc->ops->stop(rproc);
1122 atomic_inc(&rproc->power);
1123 dev_err(dev, "can't stop rproc: %d\n", ret);
1127 /* clean up all acquired resources */
1128 rproc_resource_cleanup(rproc);
1130 rproc_disable_iommu(rproc);
1132 /* Give the next start a clean resource table */
1133 rproc->table_ptr = rproc->cached_table;
1135 /* if in crash state, unlock crash handler */
1136 if (rproc->state == RPROC_CRASHED)
1137 complete_all(&rproc->crash_comp);
1139 rproc->state = RPROC_OFFLINE;
1141 dev_info(dev, "stopped remote processor %s\n", rproc->name);
1144 mutex_unlock(&rproc->lock);
1146 module_put(dev->parent->driver->owner);
1148 EXPORT_SYMBOL(rproc_shutdown);
1151 * rproc_get_by_phandle() - find a remote processor by phandle
1152 * @phandle: phandle to the rproc
1154 * Finds an rproc handle using the remote processor's phandle, and then
1155 * return a handle to the rproc.
1157 * This function increments the remote processor's refcount, so always
1158 * use rproc_put() to decrement it back once rproc isn't needed anymore.
1160 * Returns the rproc handle on success, and NULL on failure.
1162 struct rproc *rproc_get_by_phandle(phandle phandle)
1164 struct rproc *rproc = NULL, *r;
1165 struct device_node *np;
1167 np = of_find_node_by_phandle(phandle);
1171 mutex_lock(&rproc_list_mutex);
1172 list_for_each_entry(r, &rproc_list, node) {
1173 if (r->dev.parent && r->dev.parent->of_node == np) {
1175 get_device(&rproc->dev);
1179 mutex_unlock(&rproc_list_mutex);
1185 EXPORT_SYMBOL(rproc_get_by_phandle);
1188 * rproc_add() - register a remote processor
1189 * @rproc: the remote processor handle to register
1191 * Registers @rproc with the remoteproc framework, after it has been
1192 * allocated with rproc_alloc().
1194 * This is called by the platform-specific rproc implementation, whenever
1195 * a new remote processor device is probed.
1197 * Returns 0 on success and an appropriate error code otherwise.
1199 * Note: this function initiates an asynchronous firmware loading
1200 * context, which will look for virtio devices supported by the rproc's
1203 * If found, those virtio devices will be created and added, so as a result
1204 * of registering this remote processor, additional virtio drivers might be
1207 int rproc_add(struct rproc *rproc)
1209 struct device *dev = &rproc->dev;
1212 ret = device_add(dev);
1216 /* expose to rproc_get_by_phandle users */
1217 mutex_lock(&rproc_list_mutex);
1218 list_add(&rproc->node, &rproc_list);
1219 mutex_unlock(&rproc_list_mutex);
1221 dev_info(dev, "%s is available\n", rproc->name);
1223 dev_info(dev, "Note: remoteproc is still under development and considered experimental.\n");
1224 dev_info(dev, "THE BINARY FORMAT IS NOT YET FINALIZED, and backward compatibility isn't yet guaranteed.\n");
1226 /* create debugfs entries */
1227 rproc_create_debug_dir(rproc);
1229 return rproc_add_virtio_devices(rproc);
1231 EXPORT_SYMBOL(rproc_add);
1234 * rproc_type_release() - release a remote processor instance
1235 * @dev: the rproc's device
1237 * This function should _never_ be called directly.
1239 * It will be called by the driver core when no one holds a valid pointer
1242 static void rproc_type_release(struct device *dev)
1244 struct rproc *rproc = container_of(dev, struct rproc, dev);
1246 dev_info(&rproc->dev, "releasing %s\n", rproc->name);
1248 rproc_delete_debug_dir(rproc);
1250 idr_destroy(&rproc->notifyids);
1252 if (rproc->index >= 0)
1253 ida_simple_remove(&rproc_dev_index, rproc->index);
1258 static struct device_type rproc_type = {
1259 .name = "remoteproc",
1260 .release = rproc_type_release,
1264 * rproc_alloc() - allocate a remote processor handle
1265 * @dev: the underlying device
1266 * @name: name of this remote processor
1267 * @ops: platform-specific handlers (mainly start/stop)
1268 * @firmware: name of firmware file to load, can be NULL
1269 * @len: length of private data needed by the rproc driver (in bytes)
1271 * Allocates a new remote processor handle, but does not register
1272 * it yet. if @firmware is NULL, a default name is used.
1274 * This function should be used by rproc implementations during initialization
1275 * of the remote processor.
1277 * After creating an rproc handle using this function, and when ready,
1278 * implementations should then call rproc_add() to complete
1279 * the registration of the remote processor.
1281 * On success the new rproc is returned, and on failure, NULL.
1283 * Note: _never_ directly deallocate @rproc, even if it was not registered
1284 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_put().
1286 struct rproc *rproc_alloc(struct device *dev, const char *name,
1287 const struct rproc_ops *ops,
1288 const char *firmware, int len)
1290 struct rproc *rproc;
1291 char *p, *template = "rproc-%s-fw";
1294 if (!dev || !name || !ops)
1299 * Make room for default firmware name (minus %s plus '\0').
1300 * If the caller didn't pass in a firmware name then
1301 * construct a default name. We're already glomming 'len'
1302 * bytes onto the end of the struct rproc allocation, so do
1303 * a few more for the default firmware name (but only if
1304 * the caller doesn't pass one).
1306 name_len = strlen(name) + strlen(template) - 2 + 1;
1308 rproc = kzalloc(sizeof(struct rproc) + len + name_len, GFP_KERNEL);
1313 p = (char *)rproc + sizeof(struct rproc) + len;
1314 snprintf(p, name_len, template, name);
1316 p = (char *)firmware;
1319 rproc->firmware = p;
1322 rproc->priv = &rproc[1];
1324 device_initialize(&rproc->dev);
1325 rproc->dev.parent = dev;
1326 rproc->dev.type = &rproc_type;
1328 /* Assign a unique device index and name */
1329 rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1330 if (rproc->index < 0) {
1331 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1332 put_device(&rproc->dev);
1336 dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1338 atomic_set(&rproc->power, 0);
1340 /* Set ELF as the default fw_ops handler */
1341 rproc->fw_ops = &rproc_elf_fw_ops;
1343 mutex_init(&rproc->lock);
1345 idr_init(&rproc->notifyids);
1347 INIT_LIST_HEAD(&rproc->carveouts);
1348 INIT_LIST_HEAD(&rproc->mappings);
1349 INIT_LIST_HEAD(&rproc->traces);
1350 INIT_LIST_HEAD(&rproc->rvdevs);
1352 INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
1353 init_completion(&rproc->crash_comp);
1355 rproc->state = RPROC_OFFLINE;
1359 EXPORT_SYMBOL(rproc_alloc);
1362 * rproc_put() - unroll rproc_alloc()
1363 * @rproc: the remote processor handle
1365 * This function decrements the rproc dev refcount.
1367 * If no one holds any reference to rproc anymore, then its refcount would
1368 * now drop to zero, and it would be freed.
1370 void rproc_put(struct rproc *rproc)
1372 put_device(&rproc->dev);
1374 EXPORT_SYMBOL(rproc_put);
1377 * rproc_del() - unregister a remote processor
1378 * @rproc: rproc handle to unregister
1380 * This function should be called when the platform specific rproc
1381 * implementation decides to remove the rproc device. it should
1382 * _only_ be called if a previous invocation of rproc_add()
1383 * has completed successfully.
1385 * After rproc_del() returns, @rproc isn't freed yet, because
1386 * of the outstanding reference created by rproc_alloc. To decrement that
1387 * one last refcount, one still needs to call rproc_put().
1389 * Returns 0 on success and -EINVAL if @rproc isn't valid.
1391 int rproc_del(struct rproc *rproc)
1393 struct rproc_vdev *rvdev, *tmp;
1398 /* if rproc is just being registered, wait */
1399 wait_for_completion(&rproc->firmware_loading_complete);
1401 /* clean up remote vdev entries */
1402 list_for_each_entry_safe(rvdev, tmp, &rproc->rvdevs, node)
1403 rproc_remove_virtio_dev(rvdev);
1405 /* Free the copy of the resource table */
1406 kfree(rproc->cached_table);
1408 /* the rproc is downref'ed as soon as it's removed from the klist */
1409 mutex_lock(&rproc_list_mutex);
1410 list_del(&rproc->node);
1411 mutex_unlock(&rproc_list_mutex);
1413 device_del(&rproc->dev);
1417 EXPORT_SYMBOL(rproc_del);
1420 * rproc_report_crash() - rproc crash reporter function
1421 * @rproc: remote processor
1424 * This function must be called every time a crash is detected by the low-level
1425 * drivers implementing a specific remoteproc. This should not be called from a
1426 * non-remoteproc driver.
1428 * This function can be called from atomic/interrupt context.
1430 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
1433 pr_err("NULL rproc pointer\n");
1437 dev_err(&rproc->dev, "crash detected in %s: type %s\n",
1438 rproc->name, rproc_crash_to_string(type));
1440 /* create a new task to handle the error */
1441 schedule_work(&rproc->crash_handler);
1443 EXPORT_SYMBOL(rproc_report_crash);
1445 static int __init remoteproc_init(void)
1447 rproc_init_debugfs();
1451 module_init(remoteproc_init);
1453 static void __exit remoteproc_exit(void)
1455 rproc_exit_debugfs();
1457 module_exit(remoteproc_exit);
1459 MODULE_LICENSE("GPL v2");
1460 MODULE_DESCRIPTION("Generic Remote Processor Framework");