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/virtio_ids.h>
41 #include <linux/virtio_ring.h>
42 #include <asm/byteorder.h>
44 #include "remoteproc_internal.h"
46 typedef int (*rproc_handle_resources_t)(struct rproc *rproc,
47 struct resource_table *table, int len);
48 typedef int (*rproc_handle_resource_t)(struct rproc *rproc, void *, int avail);
50 /* Unique indices for remoteproc devices */
51 static DEFINE_IDA(rproc_dev_index);
53 static const char * const rproc_crash_names[] = {
54 [RPROC_MMUFAULT] = "mmufault",
57 /* translate rproc_crash_type to string */
58 static const char *rproc_crash_to_string(enum rproc_crash_type type)
60 if (type < ARRAY_SIZE(rproc_crash_names))
61 return rproc_crash_names[type];
66 * This is the IOMMU fault handler we register with the IOMMU API
67 * (when relevant; not all remote processors access memory through
70 * IOMMU core will invoke this handler whenever the remote processor
71 * will try to access an unmapped device address.
73 static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
74 unsigned long iova, int flags, void *token)
76 struct rproc *rproc = token;
78 dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
80 rproc_report_crash(rproc, RPROC_MMUFAULT);
83 * Let the iommu core know we're not really handling this fault;
84 * we just used it as a recovery trigger.
89 static int rproc_enable_iommu(struct rproc *rproc)
91 struct iommu_domain *domain;
92 struct device *dev = rproc->dev.parent;
96 * We currently use iommu_present() to decide if an IOMMU
99 * This works for simple cases, but will easily fail with
100 * platforms that do have an IOMMU, but not for this specific
103 * This will be easily solved by introducing hw capabilities
104 * that will be set by the remoteproc driver.
106 if (!iommu_present(dev->bus)) {
107 dev_dbg(dev, "iommu not found\n");
111 domain = iommu_domain_alloc(dev->bus);
113 dev_err(dev, "can't alloc iommu domain\n");
117 iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
119 ret = iommu_attach_device(domain, dev);
121 dev_err(dev, "can't attach iommu device: %d\n", ret);
125 rproc->domain = domain;
130 iommu_domain_free(domain);
134 static void rproc_disable_iommu(struct rproc *rproc)
136 struct iommu_domain *domain = rproc->domain;
137 struct device *dev = rproc->dev.parent;
142 iommu_detach_device(domain, dev);
143 iommu_domain_free(domain);
149 * Some remote processors will ask us to allocate them physically contiguous
150 * memory regions (which we call "carveouts"), and map them to specific
151 * device addresses (which are hardcoded in the firmware).
153 * They may then ask us to copy objects into specific device addresses (e.g.
154 * code/data sections) or expose us certain symbols in other device address
155 * (e.g. their trace buffer).
157 * This function is an internal helper with which we can go over the allocated
158 * carveouts and translate specific device address to kernel virtual addresses
159 * so we can access the referenced memory.
161 * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
162 * but only on kernel direct mapped RAM memory. Instead, we're just using
163 * here the output of the DMA API, which should be more correct.
165 void *rproc_da_to_va(struct rproc *rproc, u64 da, int len)
167 struct rproc_mem_entry *carveout;
170 list_for_each_entry(carveout, &rproc->carveouts, node) {
171 int offset = da - carveout->da;
173 /* try next carveout if da is too small */
177 /* try next carveout if da is too large */
178 if (offset + len > carveout->len)
181 ptr = carveout->va + offset;
188 EXPORT_SYMBOL(rproc_da_to_va);
190 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
192 struct rproc *rproc = rvdev->rproc;
193 struct device *dev = &rproc->dev;
194 struct rproc_vring *rvring = &rvdev->vring[i];
197 int ret, size, notifyid;
199 /* actual size of vring (in bytes) */
200 size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
203 * Allocate non-cacheable memory for the vring. In the future
204 * this call will also configure the IOMMU for us
205 * TODO: let the rproc know the da of this vring
207 va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL);
209 dev_err(dev->parent, "dma_alloc_coherent failed\n");
214 * Assign an rproc-wide unique index for this vring
215 * TODO: assign a notifyid for rvdev updates as well
216 * TODO: let the rproc know the notifyid of this vring
217 * TODO: support predefined notifyids (via resource table)
219 ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
221 dev_err(dev, "idr_alloc failed: %d\n", ret);
222 dma_free_coherent(dev->parent, size, va, dma);
227 /* Store largest notifyid */
228 rproc->max_notifyid = max(rproc->max_notifyid, notifyid);
230 dev_dbg(dev, "vring%d: va %p dma %llx size %x idr %d\n", i, va,
231 (unsigned long long)dma, size, notifyid);
235 rvring->notifyid = notifyid;
241 rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
243 struct rproc *rproc = rvdev->rproc;
244 struct device *dev = &rproc->dev;
245 struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
246 struct rproc_vring *rvring = &rvdev->vring[i];
248 dev_dbg(dev, "vdev rsc: vring%d: da %x, qsz %d, align %d\n",
249 i, vring->da, vring->num, vring->align);
251 /* make sure reserved bytes are zeroes */
252 if (vring->reserved) {
253 dev_err(dev, "vring rsc has non zero reserved bytes\n");
257 /* verify queue size and vring alignment are sane */
258 if (!vring->num || !vring->align) {
259 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
260 vring->num, vring->align);
264 rvring->len = vring->num;
265 rvring->align = vring->align;
266 rvring->rvdev = rvdev;
271 static int rproc_max_notifyid(int id, void *p, void *data)
274 *maxid = max(*maxid, id);
278 void rproc_free_vring(struct rproc_vring *rvring)
280 int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
281 struct rproc *rproc = rvring->rvdev->rproc;
284 dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
285 idr_remove(&rproc->notifyids, rvring->notifyid);
287 /* Find the largest remaining notifyid */
288 idr_for_each(&rproc->notifyids, rproc_max_notifyid, &maxid);
289 rproc->max_notifyid = maxid;
293 * rproc_handle_vdev() - handle a vdev fw resource
294 * @rproc: the remote processor
295 * @rsc: the vring resource descriptor
296 * @avail: size of available data (for sanity checking the image)
298 * This resource entry requests the host to statically register a virtio
299 * device (vdev), and setup everything needed to support it. It contains
300 * everything needed to make it possible: the virtio device id, virtio
301 * device features, vrings information, virtio config space, etc...
303 * Before registering the vdev, the vrings are allocated from non-cacheable
304 * physically contiguous memory. Currently we only support two vrings per
305 * remote processor (temporary limitation). We might also want to consider
306 * doing the vring allocation only later when ->find_vqs() is invoked, and
307 * then release them upon ->del_vqs().
309 * Note: @da is currently not really handled correctly: we dynamically
310 * allocate it using the DMA API, ignoring requested hard coded addresses,
311 * and we don't take care of any required IOMMU programming. This is all
312 * going to be taken care of when the generic iommu-based DMA API will be
313 * merged. Meanwhile, statically-addressed iommu-based firmware images should
314 * use RSC_DEVMEM resource entries to map their required @da to the physical
315 * address of their base CMA region (ouch, hacky!).
317 * Returns 0 on success, or an appropriate error code otherwise
319 static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
322 struct device *dev = &rproc->dev;
323 struct rproc_vdev *rvdev;
326 /* make sure resource isn't truncated */
327 if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
328 + rsc->config_len > avail) {
329 dev_err(dev, "vdev rsc is truncated\n");
333 /* make sure reserved bytes are zeroes */
334 if (rsc->reserved[0] || rsc->reserved[1]) {
335 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
339 dev_dbg(dev, "vdev rsc: id %d, dfeatures %x, cfg len %d, %d vrings\n",
340 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
342 /* we currently support only two vrings per rvdev */
343 if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
344 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
348 rvdev = kzalloc(sizeof(struct rproc_vdev), GFP_KERNEL);
352 rvdev->rproc = rproc;
354 /* parse the vrings */
355 for (i = 0; i < rsc->num_of_vrings; i++) {
356 ret = rproc_parse_vring(rvdev, rsc, i);
361 /* remember the device features */
362 rvdev->dfeatures = rsc->dfeatures;
364 list_add_tail(&rvdev->node, &rproc->rvdevs);
366 /* it is now safe to add the virtio device */
367 ret = rproc_add_virtio_dev(rvdev, rsc->id);
379 * rproc_handle_trace() - handle a shared trace buffer resource
380 * @rproc: the remote processor
381 * @rsc: the trace resource descriptor
382 * @avail: size of available data (for sanity checking the image)
384 * In case the remote processor dumps trace logs into memory,
385 * export it via debugfs.
387 * Currently, the 'da' member of @rsc should contain the device address
388 * where the remote processor is dumping the traces. Later we could also
389 * support dynamically allocating this address using the generic
390 * DMA API (but currently there isn't a use case for that).
392 * Returns 0 on success, or an appropriate error code otherwise
394 static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
397 struct rproc_mem_entry *trace;
398 struct device *dev = &rproc->dev;
402 if (sizeof(*rsc) > avail) {
403 dev_err(dev, "trace rsc is truncated\n");
407 /* make sure reserved bytes are zeroes */
409 dev_err(dev, "trace rsc has non zero reserved bytes\n");
413 /* what's the kernel address of this resource ? */
414 ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
416 dev_err(dev, "erroneous trace resource entry\n");
420 trace = kzalloc(sizeof(*trace), GFP_KERNEL);
422 dev_err(dev, "kzalloc trace failed\n");
426 /* set the trace buffer dma properties */
427 trace->len = rsc->len;
430 /* make sure snprintf always null terminates, even if truncating */
431 snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
433 /* create the debugfs entry */
434 trace->priv = rproc_create_trace_file(name, rproc, trace);
441 list_add_tail(&trace->node, &rproc->traces);
445 dev_dbg(dev, "%s added: va %p, da 0x%x, len 0x%x\n", name, ptr,
452 * rproc_handle_devmem() - handle devmem resource entry
453 * @rproc: remote processor handle
454 * @rsc: the devmem resource entry
455 * @avail: size of available data (for sanity checking the image)
457 * Remote processors commonly need to access certain on-chip peripherals.
459 * Some of these remote processors access memory via an iommu device,
460 * and might require us to configure their iommu before they can access
461 * the on-chip peripherals they need.
463 * This resource entry is a request to map such a peripheral device.
465 * These devmem entries will contain the physical address of the device in
466 * the 'pa' member. If a specific device address is expected, then 'da' will
467 * contain it (currently this is the only use case supported). 'len' will
468 * contain the size of the physical region we need to map.
470 * Currently we just "trust" those devmem entries to contain valid physical
471 * addresses, but this is going to change: we want the implementations to
472 * tell us ranges of physical addresses the firmware is allowed to request,
473 * and not allow firmwares to request access to physical addresses that
474 * are outside those ranges.
476 static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
479 struct rproc_mem_entry *mapping;
480 struct device *dev = &rproc->dev;
483 /* no point in handling this resource without a valid iommu domain */
487 if (sizeof(*rsc) > avail) {
488 dev_err(dev, "devmem rsc is truncated\n");
492 /* make sure reserved bytes are zeroes */
494 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
498 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
500 dev_err(dev, "kzalloc mapping failed\n");
504 ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
506 dev_err(dev, "failed to map devmem: %d\n", ret);
511 * We'll need this info later when we'll want to unmap everything
512 * (e.g. on shutdown).
514 * We can't trust the remote processor not to change the resource
515 * table, so we must maintain this info independently.
517 mapping->da = rsc->da;
518 mapping->len = rsc->len;
519 list_add_tail(&mapping->node, &rproc->mappings);
521 dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
522 rsc->pa, rsc->da, rsc->len);
532 * rproc_handle_carveout() - handle phys contig memory allocation requests
533 * @rproc: rproc handle
534 * @rsc: the resource entry
535 * @avail: size of available data (for image validation)
537 * This function will handle firmware requests for allocation of physically
538 * contiguous memory regions.
540 * These request entries should come first in the firmware's resource table,
541 * as other firmware entries might request placing other data objects inside
542 * these memory regions (e.g. data/code segments, trace resource entries, ...).
544 * Allocating memory this way helps utilizing the reserved physical memory
545 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
546 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
547 * pressure is important; it may have a substantial impact on performance.
549 static int rproc_handle_carveout(struct rproc *rproc,
550 struct fw_rsc_carveout *rsc, int avail)
552 struct rproc_mem_entry *carveout, *mapping;
553 struct device *dev = &rproc->dev;
558 if (sizeof(*rsc) > avail) {
559 dev_err(dev, "carveout rsc is truncated\n");
563 /* make sure reserved bytes are zeroes */
565 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
569 dev_dbg(dev, "carveout rsc: da %x, pa %x, len %x, flags %x\n",
570 rsc->da, rsc->pa, rsc->len, rsc->flags);
572 carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
574 dev_err(dev, "kzalloc carveout failed\n");
578 va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
580 dev_err(dev->parent, "dma_alloc_coherent err: %d\n", rsc->len);
585 dev_dbg(dev, "carveout va %p, dma %llx, len 0x%x\n", va,
586 (unsigned long long)dma, rsc->len);
589 * Ok, this is non-standard.
591 * Sometimes we can't rely on the generic iommu-based DMA API
592 * to dynamically allocate the device address and then set the IOMMU
593 * tables accordingly, because some remote processors might
594 * _require_ us to use hard coded device addresses that their
595 * firmware was compiled with.
597 * In this case, we must use the IOMMU API directly and map
598 * the memory to the device address as expected by the remote
601 * Obviously such remote processor devices should not be configured
602 * to use the iommu-based DMA API: we expect 'dma' to contain the
603 * physical address in this case.
606 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
608 dev_err(dev, "kzalloc mapping failed\n");
613 ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
616 dev_err(dev, "iommu_map failed: %d\n", ret);
621 * We'll need this info later when we'll want to unmap
622 * everything (e.g. on shutdown).
624 * We can't trust the remote processor not to change the
625 * resource table, so we must maintain this info independently.
627 mapping->da = rsc->da;
628 mapping->len = rsc->len;
629 list_add_tail(&mapping->node, &rproc->mappings);
631 dev_dbg(dev, "carveout mapped 0x%x to 0x%llx\n",
632 rsc->da, (unsigned long long)dma);
636 * Some remote processors might need to know the pa
637 * even though they are behind an IOMMU. E.g., OMAP4's
638 * remote M3 processor needs this so it can control
639 * on-chip hardware accelerators that are not behind
640 * the IOMMU, and therefor must know the pa.
642 * Generally we don't want to expose physical addresses
643 * if we don't have to (remote processors are generally
644 * _not_ trusted), so we might want to do this only for
645 * remote processor that _must_ have this (e.g. OMAP4's
646 * dual M3 subsystem).
648 * Non-IOMMU processors might also want to have this info.
649 * In this case, the device address and the physical address
655 carveout->len = rsc->len;
657 carveout->da = rsc->da;
659 list_add_tail(&carveout->node, &rproc->carveouts);
666 dma_free_coherent(dev->parent, rsc->len, va, dma);
673 * A lookup table for resource handlers. The indices are defined in
674 * enum fw_resource_type.
676 static rproc_handle_resource_t rproc_handle_rsc[] = {
677 [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
678 [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
679 [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
680 [RSC_VDEV] = NULL, /* VDEVs were handled upon registrarion */
683 /* handle firmware resource entries before booting the remote processor */
685 rproc_handle_boot_rsc(struct rproc *rproc, struct resource_table *table, int len)
687 struct device *dev = &rproc->dev;
688 rproc_handle_resource_t handler;
691 for (i = 0; i < table->num; i++) {
692 int offset = table->offset[i];
693 struct fw_rsc_hdr *hdr = (void *)table + offset;
694 int avail = len - offset - sizeof(*hdr);
695 void *rsc = (void *)hdr + sizeof(*hdr);
697 /* make sure table isn't truncated */
699 dev_err(dev, "rsc table is truncated\n");
703 dev_dbg(dev, "rsc: type %d\n", hdr->type);
705 if (hdr->type >= RSC_LAST) {
706 dev_warn(dev, "unsupported resource %d\n", hdr->type);
710 handler = rproc_handle_rsc[hdr->type];
714 ret = handler(rproc, rsc, avail);
722 /* handle firmware resource entries while registering the remote processor */
724 rproc_handle_virtio_rsc(struct rproc *rproc, struct resource_table *table, int len)
726 struct device *dev = &rproc->dev;
729 for (i = 0; i < table->num; i++) {
730 int offset = table->offset[i];
731 struct fw_rsc_hdr *hdr = (void *)table + offset;
732 int avail = len - offset - sizeof(*hdr);
733 struct fw_rsc_vdev *vrsc;
735 /* make sure table isn't truncated */
737 dev_err(dev, "rsc table is truncated\n");
741 dev_dbg(dev, "%s: rsc type %d\n", __func__, hdr->type);
743 if (hdr->type != RSC_VDEV)
746 vrsc = (struct fw_rsc_vdev *)hdr->data;
748 ret = rproc_handle_vdev(rproc, vrsc, avail);
757 * rproc_resource_cleanup() - clean up and free all acquired resources
758 * @rproc: rproc handle
760 * This function will free all resources acquired for @rproc, and it
761 * is called whenever @rproc either shuts down or fails to boot.
763 static void rproc_resource_cleanup(struct rproc *rproc)
765 struct rproc_mem_entry *entry, *tmp;
766 struct device *dev = &rproc->dev;
768 /* clean up debugfs trace entries */
769 list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
770 rproc_remove_trace_file(entry->priv);
772 list_del(&entry->node);
776 /* clean up carveout allocations */
777 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
778 dma_free_coherent(dev->parent, entry->len, entry->va, entry->dma);
779 list_del(&entry->node);
783 /* clean up iommu mapping entries */
784 list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
787 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
788 if (unmapped != entry->len) {
789 /* nothing much to do besides complaining */
790 dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
794 list_del(&entry->node);
800 * take a firmware and boot a remote processor with it.
802 static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
804 struct device *dev = &rproc->dev;
805 const char *name = rproc->firmware;
806 struct resource_table *table;
809 ret = rproc_fw_sanity_check(rproc, fw);
813 dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
816 * if enabling an IOMMU isn't relevant for this rproc, this is
819 ret = rproc_enable_iommu(rproc);
821 dev_err(dev, "can't enable iommu: %d\n", ret);
825 rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
827 /* look for the resource table */
828 table = rproc_find_rsc_table(rproc, fw, &tablesz);
834 /* handle fw resources which are required to boot rproc */
835 ret = rproc_handle_boot_rsc(rproc, table, tablesz);
837 dev_err(dev, "Failed to process resources: %d\n", ret);
841 /* load the ELF segments to memory */
842 ret = rproc_load_segments(rproc, fw);
844 dev_err(dev, "Failed to load program segments: %d\n", ret);
848 /* power up the remote processor */
849 ret = rproc->ops->start(rproc);
851 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
855 rproc->state = RPROC_RUNNING;
857 dev_info(dev, "remote processor %s is now up\n", rproc->name);
862 rproc_resource_cleanup(rproc);
863 rproc_disable_iommu(rproc);
868 * take a firmware and look for virtio devices to register.
870 * Note: this function is called asynchronously upon registration of the
871 * remote processor (so we must wait until it completes before we try
872 * to unregister the device. one other option is just to use kref here,
873 * that might be cleaner).
875 static void rproc_fw_config_virtio(const struct firmware *fw, void *context)
877 struct rproc *rproc = context;
878 struct resource_table *table;
881 if (rproc_fw_sanity_check(rproc, fw) < 0)
884 /* look for the resource table */
885 table = rproc_find_rsc_table(rproc, fw, &tablesz);
889 /* look for virtio devices and register them */
890 ret = rproc_handle_virtio_rsc(rproc, table, tablesz);
895 release_firmware(fw);
896 /* allow rproc_del() contexts, if any, to proceed */
897 complete_all(&rproc->firmware_loading_complete);
900 static int rproc_add_virtio_devices(struct rproc *rproc)
904 /* rproc_del() calls must wait until async loader completes */
905 init_completion(&rproc->firmware_loading_complete);
908 * We must retrieve early virtio configuration info from
909 * the firmware (e.g. whether to register a virtio device,
910 * what virtio features does it support, ...).
912 * We're initiating an asynchronous firmware loading, so we can
913 * be built-in kernel code, without hanging the boot process.
915 ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
916 rproc->firmware, &rproc->dev, GFP_KERNEL,
917 rproc, rproc_fw_config_virtio);
919 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
920 complete_all(&rproc->firmware_loading_complete);
927 * rproc_trigger_recovery() - recover a remoteproc
928 * @rproc: the remote processor
930 * The recovery is done by reseting all the virtio devices, that way all the
931 * rpmsg drivers will be reseted along with the remote processor making the
932 * remoteproc functional again.
934 * This function can sleep, so it cannot be called from atomic context.
936 int rproc_trigger_recovery(struct rproc *rproc)
938 struct rproc_vdev *rvdev, *rvtmp;
940 dev_err(&rproc->dev, "recovering %s\n", rproc->name);
942 init_completion(&rproc->crash_comp);
944 /* clean up remote vdev entries */
945 list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
946 rproc_remove_virtio_dev(rvdev);
948 /* wait until there is no more rproc users */
949 wait_for_completion(&rproc->crash_comp);
951 return rproc_add_virtio_devices(rproc);
955 * rproc_crash_handler_work() - handle a crash
957 * This function needs to handle everything related to a crash, like cpu
958 * registers and stack dump, information to help to debug the fatal error, etc.
960 static void rproc_crash_handler_work(struct work_struct *work)
962 struct rproc *rproc = container_of(work, struct rproc, crash_handler);
963 struct device *dev = &rproc->dev;
965 dev_dbg(dev, "enter %s\n", __func__);
967 mutex_lock(&rproc->lock);
969 if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
970 /* handle only the first crash detected */
971 mutex_unlock(&rproc->lock);
975 rproc->state = RPROC_CRASHED;
976 dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
979 mutex_unlock(&rproc->lock);
981 if (!rproc->recovery_disabled)
982 rproc_trigger_recovery(rproc);
986 * rproc_boot() - boot a remote processor
987 * @rproc: handle of a remote processor
989 * Boot a remote processor (i.e. load its firmware, power it on, ...).
991 * If the remote processor is already powered on, this function immediately
992 * returns (successfully).
994 * Returns 0 on success, and an appropriate error value otherwise.
996 int rproc_boot(struct rproc *rproc)
998 const struct firmware *firmware_p;
1003 pr_err("invalid rproc handle\n");
1009 ret = mutex_lock_interruptible(&rproc->lock);
1011 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1015 /* loading a firmware is required */
1016 if (!rproc->firmware) {
1017 dev_err(dev, "%s: no firmware to load\n", __func__);
1022 /* prevent underlying implementation from being removed */
1023 if (!try_module_get(dev->parent->driver->owner)) {
1024 dev_err(dev, "%s: can't get owner\n", __func__);
1029 /* skip the boot process if rproc is already powered up */
1030 if (atomic_inc_return(&rproc->power) > 1) {
1035 dev_info(dev, "powering up %s\n", rproc->name);
1038 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1040 dev_err(dev, "request_firmware failed: %d\n", ret);
1044 ret = rproc_fw_boot(rproc, firmware_p);
1046 release_firmware(firmware_p);
1050 module_put(dev->parent->driver->owner);
1051 atomic_dec(&rproc->power);
1054 mutex_unlock(&rproc->lock);
1057 EXPORT_SYMBOL(rproc_boot);
1060 * rproc_shutdown() - power off the remote processor
1061 * @rproc: the remote processor
1063 * Power off a remote processor (previously booted with rproc_boot()).
1065 * In case @rproc is still being used by an additional user(s), then
1066 * this function will just decrement the power refcount and exit,
1067 * without really powering off the device.
1069 * Every call to rproc_boot() must (eventually) be accompanied by a call
1070 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1073 * - we're not decrementing the rproc's refcount, only the power refcount.
1074 * which means that the @rproc handle stays valid even after rproc_shutdown()
1075 * returns, and users can still use it with a subsequent rproc_boot(), if
1078 void rproc_shutdown(struct rproc *rproc)
1080 struct device *dev = &rproc->dev;
1083 ret = mutex_lock_interruptible(&rproc->lock);
1085 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1089 /* if the remote proc is still needed, bail out */
1090 if (!atomic_dec_and_test(&rproc->power))
1093 /* power off the remote processor */
1094 ret = rproc->ops->stop(rproc);
1096 atomic_inc(&rproc->power);
1097 dev_err(dev, "can't stop rproc: %d\n", ret);
1101 /* clean up all acquired resources */
1102 rproc_resource_cleanup(rproc);
1104 rproc_disable_iommu(rproc);
1106 /* if in crash state, unlock crash handler */
1107 if (rproc->state == RPROC_CRASHED)
1108 complete_all(&rproc->crash_comp);
1110 rproc->state = RPROC_OFFLINE;
1112 dev_info(dev, "stopped remote processor %s\n", rproc->name);
1115 mutex_unlock(&rproc->lock);
1117 module_put(dev->parent->driver->owner);
1119 EXPORT_SYMBOL(rproc_shutdown);
1122 * rproc_add() - register a remote processor
1123 * @rproc: the remote processor handle to register
1125 * Registers @rproc with the remoteproc framework, after it has been
1126 * allocated with rproc_alloc().
1128 * This is called by the platform-specific rproc implementation, whenever
1129 * a new remote processor device is probed.
1131 * Returns 0 on success and an appropriate error code otherwise.
1133 * Note: this function initiates an asynchronous firmware loading
1134 * context, which will look for virtio devices supported by the rproc's
1137 * If found, those virtio devices will be created and added, so as a result
1138 * of registering this remote processor, additional virtio drivers might be
1141 int rproc_add(struct rproc *rproc)
1143 struct device *dev = &rproc->dev;
1146 ret = device_add(dev);
1150 dev_info(dev, "%s is available\n", rproc->name);
1152 dev_info(dev, "Note: remoteproc is still under development and considered experimental.\n");
1153 dev_info(dev, "THE BINARY FORMAT IS NOT YET FINALIZED, and backward compatibility isn't yet guaranteed.\n");
1155 /* create debugfs entries */
1156 rproc_create_debug_dir(rproc);
1158 return rproc_add_virtio_devices(rproc);
1160 EXPORT_SYMBOL(rproc_add);
1163 * rproc_type_release() - release a remote processor instance
1164 * @dev: the rproc's device
1166 * This function should _never_ be called directly.
1168 * It will be called by the driver core when no one holds a valid pointer
1171 static void rproc_type_release(struct device *dev)
1173 struct rproc *rproc = container_of(dev, struct rproc, dev);
1175 dev_info(&rproc->dev, "releasing %s\n", rproc->name);
1177 rproc_delete_debug_dir(rproc);
1179 idr_destroy(&rproc->notifyids);
1181 if (rproc->index >= 0)
1182 ida_simple_remove(&rproc_dev_index, rproc->index);
1187 static struct device_type rproc_type = {
1188 .name = "remoteproc",
1189 .release = rproc_type_release,
1193 * rproc_alloc() - allocate a remote processor handle
1194 * @dev: the underlying device
1195 * @name: name of this remote processor
1196 * @ops: platform-specific handlers (mainly start/stop)
1197 * @firmware: name of firmware file to load
1198 * @len: length of private data needed by the rproc driver (in bytes)
1200 * Allocates a new remote processor handle, but does not register
1203 * This function should be used by rproc implementations during initialization
1204 * of the remote processor.
1206 * After creating an rproc handle using this function, and when ready,
1207 * implementations should then call rproc_add() to complete
1208 * the registration of the remote processor.
1210 * On success the new rproc is returned, and on failure, NULL.
1212 * Note: _never_ directly deallocate @rproc, even if it was not registered
1213 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_put().
1215 struct rproc *rproc_alloc(struct device *dev, const char *name,
1216 const struct rproc_ops *ops,
1217 const char *firmware, int len)
1219 struct rproc *rproc;
1221 if (!dev || !name || !ops)
1224 rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
1226 dev_err(dev, "%s: kzalloc failed\n", __func__);
1232 rproc->firmware = firmware;
1233 rproc->priv = &rproc[1];
1235 device_initialize(&rproc->dev);
1236 rproc->dev.parent = dev;
1237 rproc->dev.type = &rproc_type;
1239 /* Assign a unique device index and name */
1240 rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1241 if (rproc->index < 0) {
1242 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1243 put_device(&rproc->dev);
1247 dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1249 atomic_set(&rproc->power, 0);
1251 /* Set ELF as the default fw_ops handler */
1252 rproc->fw_ops = &rproc_elf_fw_ops;
1254 mutex_init(&rproc->lock);
1256 idr_init(&rproc->notifyids);
1258 INIT_LIST_HEAD(&rproc->carveouts);
1259 INIT_LIST_HEAD(&rproc->mappings);
1260 INIT_LIST_HEAD(&rproc->traces);
1261 INIT_LIST_HEAD(&rproc->rvdevs);
1263 INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
1264 init_completion(&rproc->crash_comp);
1266 rproc->state = RPROC_OFFLINE;
1270 EXPORT_SYMBOL(rproc_alloc);
1273 * rproc_put() - unroll rproc_alloc()
1274 * @rproc: the remote processor handle
1276 * This function decrements the rproc dev refcount.
1278 * If no one holds any reference to rproc anymore, then its refcount would
1279 * now drop to zero, and it would be freed.
1281 void rproc_put(struct rproc *rproc)
1283 put_device(&rproc->dev);
1285 EXPORT_SYMBOL(rproc_put);
1288 * rproc_del() - unregister a remote processor
1289 * @rproc: rproc handle to unregister
1291 * This function should be called when the platform specific rproc
1292 * implementation decides to remove the rproc device. it should
1293 * _only_ be called if a previous invocation of rproc_add()
1294 * has completed successfully.
1296 * After rproc_del() returns, @rproc isn't freed yet, because
1297 * of the outstanding reference created by rproc_alloc. To decrement that
1298 * one last refcount, one still needs to call rproc_put().
1300 * Returns 0 on success and -EINVAL if @rproc isn't valid.
1302 int rproc_del(struct rproc *rproc)
1304 struct rproc_vdev *rvdev, *tmp;
1309 /* if rproc is just being registered, wait */
1310 wait_for_completion(&rproc->firmware_loading_complete);
1312 /* clean up remote vdev entries */
1313 list_for_each_entry_safe(rvdev, tmp, &rproc->rvdevs, node)
1314 rproc_remove_virtio_dev(rvdev);
1316 device_del(&rproc->dev);
1320 EXPORT_SYMBOL(rproc_del);
1323 * rproc_report_crash() - rproc crash reporter function
1324 * @rproc: remote processor
1327 * This function must be called every time a crash is detected by the low-level
1328 * drivers implementing a specific remoteproc. This should not be called from a
1329 * non-remoteproc driver.
1331 * This function can be called from atomic/interrupt context.
1333 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
1336 pr_err("NULL rproc pointer\n");
1340 dev_err(&rproc->dev, "crash detected in %s: type %s\n",
1341 rproc->name, rproc_crash_to_string(type));
1343 /* create a new task to handle the error */
1344 schedule_work(&rproc->crash_handler);
1346 EXPORT_SYMBOL(rproc_report_crash);
1348 static int __init remoteproc_init(void)
1350 rproc_init_debugfs();
1354 module_init(remoteproc_init);
1356 static void __exit remoteproc_exit(void)
1358 rproc_exit_debugfs();
1360 module_exit(remoteproc_exit);
1362 MODULE_LICENSE("GPL v2");
1363 MODULE_DESCRIPTION("Generic Remote Processor Framework");