1 // SPDX-License-Identifier: GPL-2.0-only
3 * Remote Processor Framework
5 * Copyright (C) 2011 Texas Instruments, Inc.
6 * Copyright (C) 2011 Google, Inc.
8 * Ohad Ben-Cohen <ohad@wizery.com>
9 * Brian Swetland <swetland@google.com>
10 * Mark Grosen <mgrosen@ti.com>
11 * Fernando Guzman Lugo <fernando.lugo@ti.com>
12 * Suman Anna <s-anna@ti.com>
13 * Robert Tivy <rtivy@ti.com>
14 * Armando Uribe De Leon <x0095078@ti.com>
17 #define pr_fmt(fmt) "%s: " fmt, __func__
19 #include <linux/delay.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/device.h>
23 #include <linux/panic_notifier.h>
24 #include <linux/slab.h>
25 #include <linux/mutex.h>
26 #include <linux/dma-map-ops.h>
27 #include <linux/dma-mapping.h>
28 #include <linux/dma-direct.h> /* XXX: pokes into bus_dma_range */
29 #include <linux/firmware.h>
30 #include <linux/string.h>
31 #include <linux/debugfs.h>
32 #include <linux/rculist.h>
33 #include <linux/remoteproc.h>
34 #include <linux/iommu.h>
35 #include <linux/idr.h>
36 #include <linux/elf.h>
37 #include <linux/crc32.h>
38 #include <linux/of_reserved_mem.h>
39 #include <linux/virtio_ids.h>
40 #include <linux/virtio_ring.h>
41 #include <asm/byteorder.h>
42 #include <linux/platform_device.h>
44 #include "remoteproc_internal.h"
46 #define HIGH_BITS_MASK 0xFFFFFFFF00000000ULL
48 static DEFINE_MUTEX(rproc_list_mutex);
49 static LIST_HEAD(rproc_list);
50 static struct notifier_block rproc_panic_nb;
52 typedef int (*rproc_handle_resource_t)(struct rproc *rproc,
53 void *, int offset, int avail);
55 static int rproc_alloc_carveout(struct rproc *rproc,
56 struct rproc_mem_entry *mem);
57 static int rproc_release_carveout(struct rproc *rproc,
58 struct rproc_mem_entry *mem);
60 /* Unique indices for remoteproc devices */
61 static DEFINE_IDA(rproc_dev_index);
63 static const char * const rproc_crash_names[] = {
64 [RPROC_MMUFAULT] = "mmufault",
65 [RPROC_WATCHDOG] = "watchdog",
66 [RPROC_FATAL_ERROR] = "fatal error",
69 /* translate rproc_crash_type to string */
70 static const char *rproc_crash_to_string(enum rproc_crash_type type)
72 if (type < ARRAY_SIZE(rproc_crash_names))
73 return rproc_crash_names[type];
78 * This is the IOMMU fault handler we register with the IOMMU API
79 * (when relevant; not all remote processors access memory through
82 * IOMMU core will invoke this handler whenever the remote processor
83 * will try to access an unmapped device address.
85 static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
86 unsigned long iova, int flags, void *token)
88 struct rproc *rproc = token;
90 dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
92 rproc_report_crash(rproc, RPROC_MMUFAULT);
95 * Let the iommu core know we're not really handling this fault;
96 * we just used it as a recovery trigger.
101 static int rproc_enable_iommu(struct rproc *rproc)
103 struct iommu_domain *domain;
104 struct device *dev = rproc->dev.parent;
107 if (!rproc->has_iommu) {
108 dev_dbg(dev, "iommu not present\n");
112 domain = iommu_domain_alloc(dev->bus);
114 dev_err(dev, "can't alloc iommu domain\n");
118 iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
120 ret = iommu_attach_device(domain, dev);
122 dev_err(dev, "can't attach iommu device: %d\n", ret);
126 rproc->domain = domain;
131 iommu_domain_free(domain);
135 static void rproc_disable_iommu(struct rproc *rproc)
137 struct iommu_domain *domain = rproc->domain;
138 struct device *dev = rproc->dev.parent;
143 iommu_detach_device(domain, dev);
144 iommu_domain_free(domain);
147 phys_addr_t rproc_va_to_pa(void *cpu_addr)
150 * Return physical address according to virtual address location
151 * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent
152 * - in kernel: if region allocated in generic dma memory pool
154 if (is_vmalloc_addr(cpu_addr)) {
155 return page_to_phys(vmalloc_to_page(cpu_addr)) +
156 offset_in_page(cpu_addr);
159 WARN_ON(!virt_addr_valid(cpu_addr));
160 return virt_to_phys(cpu_addr);
162 EXPORT_SYMBOL(rproc_va_to_pa);
165 * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address
166 * @rproc: handle of a remote processor
167 * @da: remoteproc device address to translate
168 * @len: length of the memory region @da is pointing to
170 * Some remote processors will ask us to allocate them physically contiguous
171 * memory regions (which we call "carveouts"), and map them to specific
172 * device addresses (which are hardcoded in the firmware). They may also have
173 * dedicated memory regions internal to the processors, and use them either
174 * exclusively or alongside carveouts.
176 * They may then ask us to copy objects into specific device addresses (e.g.
177 * code/data sections) or expose us certain symbols in other device address
178 * (e.g. their trace buffer).
180 * This function is a helper function with which we can go over the allocated
181 * carveouts and translate specific device addresses to kernel virtual addresses
182 * so we can access the referenced memory. This function also allows to perform
183 * translations on the internal remoteproc memory regions through a platform
184 * implementation specific da_to_va ops, if present.
186 * The function returns a valid kernel address on success or NULL on failure.
188 * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
189 * but only on kernel direct mapped RAM memory. Instead, we're just using
190 * here the output of the DMA API for the carveouts, which should be more
193 void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len, bool *is_iomem)
195 struct rproc_mem_entry *carveout;
198 if (rproc->ops->da_to_va) {
199 ptr = rproc->ops->da_to_va(rproc, da, len, is_iomem);
204 list_for_each_entry(carveout, &rproc->carveouts, node) {
205 int offset = da - carveout->da;
207 /* Verify that carveout is allocated */
211 /* try next carveout if da is too small */
215 /* try next carveout if da is too large */
216 if (offset + len > carveout->len)
219 ptr = carveout->va + offset;
222 *is_iomem = carveout->is_iomem;
230 EXPORT_SYMBOL(rproc_da_to_va);
233 * rproc_find_carveout_by_name() - lookup the carveout region by a name
234 * @rproc: handle of a remote processor
235 * @name: carveout name to find (format string)
236 * @...: optional parameters matching @name string
238 * Platform driver has the capability to register some pre-allacoted carveout
239 * (physically contiguous memory regions) before rproc firmware loading and
240 * associated resource table analysis. These regions may be dedicated memory
241 * regions internal to the coprocessor or specified DDR region with specific
244 * This function is a helper function with which we can go over the
245 * allocated carveouts and return associated region characteristics like
246 * coprocessor address, length or processor virtual address.
248 * Return: a valid pointer on carveout entry on success or NULL on failure.
251 struct rproc_mem_entry *
252 rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...)
256 struct rproc_mem_entry *carveout, *mem = NULL;
261 va_start(args, name);
262 vsnprintf(_name, sizeof(_name), name, args);
265 list_for_each_entry(carveout, &rproc->carveouts, node) {
266 /* Compare carveout and requested names */
267 if (!strcmp(carveout->name, _name)) {
277 * rproc_check_carveout_da() - Check specified carveout da configuration
278 * @rproc: handle of a remote processor
279 * @mem: pointer on carveout to check
280 * @da: area device address
281 * @len: associated area size
283 * This function is a helper function to verify requested device area (couple
284 * da, len) is part of specified carveout.
285 * If da is not set (defined as FW_RSC_ADDR_ANY), only requested length is
288 * Return: 0 if carveout matches request else error
290 static int rproc_check_carveout_da(struct rproc *rproc,
291 struct rproc_mem_entry *mem, u32 da, u32 len)
293 struct device *dev = &rproc->dev;
296 /* Check requested resource length */
297 if (len > mem->len) {
298 dev_err(dev, "Registered carveout doesn't fit len request\n");
302 if (da != FW_RSC_ADDR_ANY && mem->da == FW_RSC_ADDR_ANY) {
303 /* Address doesn't match registered carveout configuration */
305 } else if (da != FW_RSC_ADDR_ANY && mem->da != FW_RSC_ADDR_ANY) {
306 delta = da - mem->da;
308 /* Check requested resource belongs to registered carveout */
311 "Registered carveout doesn't fit da request\n");
315 if (delta + len > mem->len) {
317 "Registered carveout doesn't fit len request\n");
325 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
327 struct rproc *rproc = rvdev->rproc;
328 struct device *dev = &rproc->dev;
329 struct rproc_vring *rvring = &rvdev->vring[i];
330 struct fw_rsc_vdev *rsc;
332 struct rproc_mem_entry *mem;
335 /* actual size of vring (in bytes) */
336 size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
338 rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
340 /* Search for pre-registered carveout */
341 mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index,
344 if (rproc_check_carveout_da(rproc, mem, rsc->vring[i].da, size))
347 /* Register carveout in in list */
348 mem = rproc_mem_entry_init(dev, NULL, 0,
349 size, rsc->vring[i].da,
350 rproc_alloc_carveout,
351 rproc_release_carveout,
355 dev_err(dev, "Can't allocate memory entry structure\n");
359 rproc_add_carveout(rproc, mem);
363 * Assign an rproc-wide unique index for this vring
364 * TODO: assign a notifyid for rvdev updates as well
365 * TODO: support predefined notifyids (via resource table)
367 ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
369 dev_err(dev, "idr_alloc failed: %d\n", ret);
374 /* Potentially bump max_notifyid */
375 if (notifyid > rproc->max_notifyid)
376 rproc->max_notifyid = notifyid;
378 rvring->notifyid = notifyid;
380 /* Let the rproc know the notifyid of this vring.*/
381 rsc->vring[i].notifyid = notifyid;
386 rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
388 struct rproc *rproc = rvdev->rproc;
389 struct device *dev = &rproc->dev;
390 struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
391 struct rproc_vring *rvring = &rvdev->vring[i];
393 dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
394 i, vring->da, vring->num, vring->align);
396 /* verify queue size and vring alignment are sane */
397 if (!vring->num || !vring->align) {
398 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
399 vring->num, vring->align);
403 rvring->len = vring->num;
404 rvring->align = vring->align;
405 rvring->rvdev = rvdev;
410 void rproc_free_vring(struct rproc_vring *rvring)
412 struct rproc *rproc = rvring->rvdev->rproc;
413 int idx = rvring - rvring->rvdev->vring;
414 struct fw_rsc_vdev *rsc;
416 idr_remove(&rproc->notifyids, rvring->notifyid);
419 * At this point rproc_stop() has been called and the installed resource
420 * table in the remote processor memory may no longer be accessible. As
421 * such and as per rproc_stop(), rproc->table_ptr points to the cached
422 * resource table (rproc->cached_table). The cached resource table is
423 * only available when a remote processor has been booted by the
424 * remoteproc core, otherwise it is NULL.
426 * Based on the above, reset the virtio device section in the cached
427 * resource table only if there is one to work with.
429 if (rproc->table_ptr) {
430 rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
431 rsc->vring[idx].da = 0;
432 rsc->vring[idx].notifyid = -1;
436 static int rproc_vdev_do_start(struct rproc_subdev *subdev)
438 struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
440 return rproc_add_virtio_dev(rvdev, rvdev->id);
443 static void rproc_vdev_do_stop(struct rproc_subdev *subdev, bool crashed)
445 struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
448 ret = device_for_each_child(&rvdev->dev, NULL, rproc_remove_virtio_dev);
450 dev_warn(&rvdev->dev, "can't remove vdev child device: %d\n", ret);
454 * rproc_rvdev_release() - release the existence of a rvdev
456 * @dev: the subdevice's dev
458 static void rproc_rvdev_release(struct device *dev)
460 struct rproc_vdev *rvdev = container_of(dev, struct rproc_vdev, dev);
462 of_reserved_mem_device_release(dev);
467 static int copy_dma_range_map(struct device *to, struct device *from)
469 const struct bus_dma_region *map = from->dma_range_map, *new_map, *r;
475 for (r = map; r->size; r++)
478 new_map = kmemdup(map, array_size(num_ranges + 1, sizeof(*map)),
482 to->dma_range_map = new_map;
487 * rproc_handle_vdev() - handle a vdev fw resource
488 * @rproc: the remote processor
489 * @ptr: the vring resource descriptor
490 * @offset: offset of the resource entry
491 * @avail: size of available data (for sanity checking the image)
493 * This resource entry requests the host to statically register a virtio
494 * device (vdev), and setup everything needed to support it. It contains
495 * everything needed to make it possible: the virtio device id, virtio
496 * device features, vrings information, virtio config space, etc...
498 * Before registering the vdev, the vrings are allocated from non-cacheable
499 * physically contiguous memory. Currently we only support two vrings per
500 * remote processor (temporary limitation). We might also want to consider
501 * doing the vring allocation only later when ->find_vqs() is invoked, and
502 * then release them upon ->del_vqs().
504 * Note: @da is currently not really handled correctly: we dynamically
505 * allocate it using the DMA API, ignoring requested hard coded addresses,
506 * and we don't take care of any required IOMMU programming. This is all
507 * going to be taken care of when the generic iommu-based DMA API will be
508 * merged. Meanwhile, statically-addressed iommu-based firmware images should
509 * use RSC_DEVMEM resource entries to map their required @da to the physical
510 * address of their base CMA region (ouch, hacky!).
512 * Returns 0 on success, or an appropriate error code otherwise
514 static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
515 int offset, int avail)
517 struct fw_rsc_vdev *rsc = ptr;
518 struct device *dev = &rproc->dev;
519 struct rproc_vdev *rvdev;
523 /* make sure resource isn't truncated */
524 if (struct_size(rsc, vring, rsc->num_of_vrings) + rsc->config_len >
526 dev_err(dev, "vdev rsc is truncated\n");
530 /* make sure reserved bytes are zeroes */
531 if (rsc->reserved[0] || rsc->reserved[1]) {
532 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
536 dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
537 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
539 /* we currently support only two vrings per rvdev */
540 if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
541 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
545 rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL);
549 kref_init(&rvdev->refcount);
552 rvdev->rproc = rproc;
553 rvdev->index = rproc->nb_vdev++;
555 /* Initialise vdev subdevice */
556 snprintf(name, sizeof(name), "vdev%dbuffer", rvdev->index);
557 rvdev->dev.parent = &rproc->dev;
558 ret = copy_dma_range_map(&rvdev->dev, rproc->dev.parent);
561 rvdev->dev.release = rproc_rvdev_release;
562 dev_set_name(&rvdev->dev, "%s#%s", dev_name(rvdev->dev.parent), name);
563 dev_set_drvdata(&rvdev->dev, rvdev);
565 ret = device_register(&rvdev->dev);
567 put_device(&rvdev->dev);
570 /* Make device dma capable by inheriting from parent's capabilities */
571 set_dma_ops(&rvdev->dev, get_dma_ops(rproc->dev.parent));
573 ret = dma_coerce_mask_and_coherent(&rvdev->dev,
574 dma_get_mask(rproc->dev.parent));
577 "Failed to set DMA mask %llx. Trying to continue... %x\n",
578 dma_get_mask(rproc->dev.parent), ret);
581 /* parse the vrings */
582 for (i = 0; i < rsc->num_of_vrings; i++) {
583 ret = rproc_parse_vring(rvdev, rsc, i);
588 /* remember the resource offset*/
589 rvdev->rsc_offset = offset;
591 /* allocate the vring resources */
592 for (i = 0; i < rsc->num_of_vrings; i++) {
593 ret = rproc_alloc_vring(rvdev, i);
595 goto unwind_vring_allocations;
598 list_add_tail(&rvdev->node, &rproc->rvdevs);
600 rvdev->subdev.start = rproc_vdev_do_start;
601 rvdev->subdev.stop = rproc_vdev_do_stop;
603 rproc_add_subdev(rproc, &rvdev->subdev);
607 unwind_vring_allocations:
608 for (i--; i >= 0; i--)
609 rproc_free_vring(&rvdev->vring[i]);
611 device_unregister(&rvdev->dev);
615 void rproc_vdev_release(struct kref *ref)
617 struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount);
618 struct rproc_vring *rvring;
619 struct rproc *rproc = rvdev->rproc;
622 for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) {
623 rvring = &rvdev->vring[id];
624 rproc_free_vring(rvring);
627 rproc_remove_subdev(rproc, &rvdev->subdev);
628 list_del(&rvdev->node);
629 device_unregister(&rvdev->dev);
633 * rproc_handle_trace() - handle a shared trace buffer resource
634 * @rproc: the remote processor
635 * @ptr: the trace resource descriptor
636 * @offset: offset of the resource entry
637 * @avail: size of available data (for sanity checking the image)
639 * In case the remote processor dumps trace logs into memory,
640 * export it via debugfs.
642 * Currently, the 'da' member of @rsc should contain the device address
643 * where the remote processor is dumping the traces. Later we could also
644 * support dynamically allocating this address using the generic
645 * DMA API (but currently there isn't a use case for that).
647 * Returns 0 on success, or an appropriate error code otherwise
649 static int rproc_handle_trace(struct rproc *rproc, void *ptr,
650 int offset, int avail)
652 struct fw_rsc_trace *rsc = ptr;
653 struct rproc_debug_trace *trace;
654 struct device *dev = &rproc->dev;
657 if (sizeof(*rsc) > avail) {
658 dev_err(dev, "trace rsc is truncated\n");
662 /* make sure reserved bytes are zeroes */
664 dev_err(dev, "trace rsc has non zero reserved bytes\n");
668 trace = kzalloc(sizeof(*trace), GFP_KERNEL);
672 /* set the trace buffer dma properties */
673 trace->trace_mem.len = rsc->len;
674 trace->trace_mem.da = rsc->da;
676 /* set pointer on rproc device */
677 trace->rproc = rproc;
679 /* make sure snprintf always null terminates, even if truncating */
680 snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
682 /* create the debugfs entry */
683 trace->tfile = rproc_create_trace_file(name, rproc, trace);
689 list_add_tail(&trace->node, &rproc->traces);
693 dev_dbg(dev, "%s added: da 0x%x, len 0x%x\n",
694 name, rsc->da, rsc->len);
700 * rproc_handle_devmem() - handle devmem resource entry
701 * @rproc: remote processor handle
702 * @ptr: the devmem resource entry
703 * @offset: offset of the resource entry
704 * @avail: size of available data (for sanity checking the image)
706 * Remote processors commonly need to access certain on-chip peripherals.
708 * Some of these remote processors access memory via an iommu device,
709 * and might require us to configure their iommu before they can access
710 * the on-chip peripherals they need.
712 * This resource entry is a request to map such a peripheral device.
714 * These devmem entries will contain the physical address of the device in
715 * the 'pa' member. If a specific device address is expected, then 'da' will
716 * contain it (currently this is the only use case supported). 'len' will
717 * contain the size of the physical region we need to map.
719 * Currently we just "trust" those devmem entries to contain valid physical
720 * addresses, but this is going to change: we want the implementations to
721 * tell us ranges of physical addresses the firmware is allowed to request,
722 * and not allow firmwares to request access to physical addresses that
723 * are outside those ranges.
725 static int rproc_handle_devmem(struct rproc *rproc, void *ptr,
726 int offset, int avail)
728 struct fw_rsc_devmem *rsc = ptr;
729 struct rproc_mem_entry *mapping;
730 struct device *dev = &rproc->dev;
733 /* no point in handling this resource without a valid iommu domain */
737 if (sizeof(*rsc) > avail) {
738 dev_err(dev, "devmem rsc is truncated\n");
742 /* make sure reserved bytes are zeroes */
744 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
748 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
752 ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
754 dev_err(dev, "failed to map devmem: %d\n", ret);
759 * We'll need this info later when we'll want to unmap everything
760 * (e.g. on shutdown).
762 * We can't trust the remote processor not to change the resource
763 * table, so we must maintain this info independently.
765 mapping->da = rsc->da;
766 mapping->len = rsc->len;
767 list_add_tail(&mapping->node, &rproc->mappings);
769 dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
770 rsc->pa, rsc->da, rsc->len);
780 * rproc_alloc_carveout() - allocated specified carveout
781 * @rproc: rproc handle
782 * @mem: the memory entry to allocate
784 * This function allocate specified memory entry @mem using
785 * dma_alloc_coherent() as default allocator
787 static int rproc_alloc_carveout(struct rproc *rproc,
788 struct rproc_mem_entry *mem)
790 struct rproc_mem_entry *mapping = NULL;
791 struct device *dev = &rproc->dev;
796 va = dma_alloc_coherent(dev->parent, mem->len, &dma, GFP_KERNEL);
799 "failed to allocate dma memory: len 0x%zx\n",
804 dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%zx\n",
807 if (mem->da != FW_RSC_ADDR_ANY && !rproc->domain) {
809 * Check requested da is equal to dma address
810 * and print a warn message in case of missalignment.
811 * Don't stop rproc_start sequence as coprocessor may
812 * build pa to da translation on its side.
814 if (mem->da != (u32)dma)
815 dev_warn(dev->parent,
816 "Allocated carveout doesn't fit device address request\n");
820 * Ok, this is non-standard.
822 * Sometimes we can't rely on the generic iommu-based DMA API
823 * to dynamically allocate the device address and then set the IOMMU
824 * tables accordingly, because some remote processors might
825 * _require_ us to use hard coded device addresses that their
826 * firmware was compiled with.
828 * In this case, we must use the IOMMU API directly and map
829 * the memory to the device address as expected by the remote
832 * Obviously such remote processor devices should not be configured
833 * to use the iommu-based DMA API: we expect 'dma' to contain the
834 * physical address in this case.
836 if (mem->da != FW_RSC_ADDR_ANY && rproc->domain) {
837 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
843 ret = iommu_map(rproc->domain, mem->da, dma, mem->len,
846 dev_err(dev, "iommu_map failed: %d\n", ret);
851 * We'll need this info later when we'll want to unmap
852 * everything (e.g. on shutdown).
854 * We can't trust the remote processor not to change the
855 * resource table, so we must maintain this info independently.
857 mapping->da = mem->da;
858 mapping->len = mem->len;
859 list_add_tail(&mapping->node, &rproc->mappings);
861 dev_dbg(dev, "carveout mapped 0x%x to %pad\n",
865 if (mem->da == FW_RSC_ADDR_ANY) {
866 /* Update device address as undefined by requester */
867 if ((u64)dma & HIGH_BITS_MASK)
868 dev_warn(dev, "DMA address cast in 32bit to fit resource table format\n");
881 dma_free_coherent(dev->parent, mem->len, va, dma);
886 * rproc_release_carveout() - release acquired carveout
887 * @rproc: rproc handle
888 * @mem: the memory entry to release
890 * This function releases specified memory entry @mem allocated via
891 * rproc_alloc_carveout() function by @rproc.
893 static int rproc_release_carveout(struct rproc *rproc,
894 struct rproc_mem_entry *mem)
896 struct device *dev = &rproc->dev;
898 /* clean up carveout allocations */
899 dma_free_coherent(dev->parent, mem->len, mem->va, mem->dma);
904 * rproc_handle_carveout() - handle phys contig memory allocation requests
905 * @rproc: rproc handle
906 * @ptr: the resource entry
907 * @offset: offset of the resource entry
908 * @avail: size of available data (for image validation)
910 * This function will handle firmware requests for allocation of physically
911 * contiguous memory regions.
913 * These request entries should come first in the firmware's resource table,
914 * as other firmware entries might request placing other data objects inside
915 * these memory regions (e.g. data/code segments, trace resource entries, ...).
917 * Allocating memory this way helps utilizing the reserved physical memory
918 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
919 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
920 * pressure is important; it may have a substantial impact on performance.
922 static int rproc_handle_carveout(struct rproc *rproc,
923 void *ptr, int offset, int avail)
925 struct fw_rsc_carveout *rsc = ptr;
926 struct rproc_mem_entry *carveout;
927 struct device *dev = &rproc->dev;
929 if (sizeof(*rsc) > avail) {
930 dev_err(dev, "carveout rsc is truncated\n");
934 /* make sure reserved bytes are zeroes */
936 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
940 dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
941 rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
944 * Check carveout rsc already part of a registered carveout,
945 * Search by name, then check the da and length
947 carveout = rproc_find_carveout_by_name(rproc, rsc->name);
950 if (carveout->rsc_offset != FW_RSC_ADDR_ANY) {
952 "Carveout already associated to resource table\n");
956 if (rproc_check_carveout_da(rproc, carveout, rsc->da, rsc->len))
959 /* Update memory carveout with resource table info */
960 carveout->rsc_offset = offset;
961 carveout->flags = rsc->flags;
966 /* Register carveout in in list */
967 carveout = rproc_mem_entry_init(dev, NULL, 0, rsc->len, rsc->da,
968 rproc_alloc_carveout,
969 rproc_release_carveout, rsc->name);
971 dev_err(dev, "Can't allocate memory entry structure\n");
975 carveout->flags = rsc->flags;
976 carveout->rsc_offset = offset;
977 rproc_add_carveout(rproc, carveout);
983 * rproc_add_carveout() - register an allocated carveout region
984 * @rproc: rproc handle
985 * @mem: memory entry to register
987 * This function registers specified memory entry in @rproc carveouts list.
988 * Specified carveout should have been allocated before registering.
990 void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem)
992 list_add_tail(&mem->node, &rproc->carveouts);
994 EXPORT_SYMBOL(rproc_add_carveout);
997 * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct
998 * @dev: pointer on device struct
999 * @va: virtual address
1001 * @len: memory carveout length
1002 * @da: device address
1003 * @alloc: memory carveout allocation function
1004 * @release: memory carveout release function
1005 * @name: carveout name
1007 * This function allocates a rproc_mem_entry struct and fill it with parameters
1008 * provided by client.
1011 struct rproc_mem_entry *
1012 rproc_mem_entry_init(struct device *dev,
1013 void *va, dma_addr_t dma, size_t len, u32 da,
1014 int (*alloc)(struct rproc *, struct rproc_mem_entry *),
1015 int (*release)(struct rproc *, struct rproc_mem_entry *),
1016 const char *name, ...)
1018 struct rproc_mem_entry *mem;
1021 mem = kzalloc(sizeof(*mem), GFP_KERNEL);
1030 mem->release = release;
1031 mem->rsc_offset = FW_RSC_ADDR_ANY;
1032 mem->of_resm_idx = -1;
1034 va_start(args, name);
1035 vsnprintf(mem->name, sizeof(mem->name), name, args);
1040 EXPORT_SYMBOL(rproc_mem_entry_init);
1043 * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct
1044 * from a reserved memory phandle
1045 * @dev: pointer on device struct
1046 * @of_resm_idx: reserved memory phandle index in "memory-region"
1047 * @len: memory carveout length
1048 * @da: device address
1049 * @name: carveout name
1051 * This function allocates a rproc_mem_entry struct and fill it with parameters
1052 * provided by client.
1055 struct rproc_mem_entry *
1056 rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, size_t len,
1057 u32 da, const char *name, ...)
1059 struct rproc_mem_entry *mem;
1062 mem = kzalloc(sizeof(*mem), GFP_KERNEL);
1068 mem->rsc_offset = FW_RSC_ADDR_ANY;
1069 mem->of_resm_idx = of_resm_idx;
1071 va_start(args, name);
1072 vsnprintf(mem->name, sizeof(mem->name), name, args);
1077 EXPORT_SYMBOL(rproc_of_resm_mem_entry_init);
1080 * rproc_of_parse_firmware() - parse and return the firmware-name
1081 * @dev: pointer on device struct representing a rproc
1082 * @index: index to use for the firmware-name retrieval
1083 * @fw_name: pointer to a character string, in which the firmware
1084 * name is returned on success and unmodified otherwise.
1086 * This is an OF helper function that parses a device's DT node for
1087 * the "firmware-name" property and returns the firmware name pointer
1088 * in @fw_name on success.
1090 * Return: 0 on success, or an appropriate failure.
1092 int rproc_of_parse_firmware(struct device *dev, int index, const char **fw_name)
1096 ret = of_property_read_string_index(dev->of_node, "firmware-name",
1098 return ret ? ret : 0;
1100 EXPORT_SYMBOL(rproc_of_parse_firmware);
1103 * A lookup table for resource handlers. The indices are defined in
1104 * enum fw_resource_type.
1106 static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
1107 [RSC_CARVEOUT] = rproc_handle_carveout,
1108 [RSC_DEVMEM] = rproc_handle_devmem,
1109 [RSC_TRACE] = rproc_handle_trace,
1110 [RSC_VDEV] = rproc_handle_vdev,
1113 /* handle firmware resource entries before booting the remote processor */
1114 static int rproc_handle_resources(struct rproc *rproc,
1115 rproc_handle_resource_t handlers[RSC_LAST])
1117 struct device *dev = &rproc->dev;
1118 rproc_handle_resource_t handler;
1121 if (!rproc->table_ptr)
1124 for (i = 0; i < rproc->table_ptr->num; i++) {
1125 int offset = rproc->table_ptr->offset[i];
1126 struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
1127 int avail = rproc->table_sz - offset - sizeof(*hdr);
1128 void *rsc = (void *)hdr + sizeof(*hdr);
1130 /* make sure table isn't truncated */
1132 dev_err(dev, "rsc table is truncated\n");
1136 dev_dbg(dev, "rsc: type %d\n", hdr->type);
1138 if (hdr->type >= RSC_VENDOR_START &&
1139 hdr->type <= RSC_VENDOR_END) {
1140 ret = rproc_handle_rsc(rproc, hdr->type, rsc,
1141 offset + sizeof(*hdr), avail);
1142 if (ret == RSC_HANDLED)
1147 dev_warn(dev, "unsupported vendor resource %d\n",
1152 if (hdr->type >= RSC_LAST) {
1153 dev_warn(dev, "unsupported resource %d\n", hdr->type);
1157 handler = handlers[hdr->type];
1161 ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
1169 static int rproc_prepare_subdevices(struct rproc *rproc)
1171 struct rproc_subdev *subdev;
1174 list_for_each_entry(subdev, &rproc->subdevs, node) {
1175 if (subdev->prepare) {
1176 ret = subdev->prepare(subdev);
1178 goto unroll_preparation;
1185 list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) {
1186 if (subdev->unprepare)
1187 subdev->unprepare(subdev);
1193 static int rproc_start_subdevices(struct rproc *rproc)
1195 struct rproc_subdev *subdev;
1198 list_for_each_entry(subdev, &rproc->subdevs, node) {
1199 if (subdev->start) {
1200 ret = subdev->start(subdev);
1202 goto unroll_registration;
1208 unroll_registration:
1209 list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) {
1211 subdev->stop(subdev, true);
1217 static void rproc_stop_subdevices(struct rproc *rproc, bool crashed)
1219 struct rproc_subdev *subdev;
1221 list_for_each_entry_reverse(subdev, &rproc->subdevs, node) {
1223 subdev->stop(subdev, crashed);
1227 static void rproc_unprepare_subdevices(struct rproc *rproc)
1229 struct rproc_subdev *subdev;
1231 list_for_each_entry_reverse(subdev, &rproc->subdevs, node) {
1232 if (subdev->unprepare)
1233 subdev->unprepare(subdev);
1238 * rproc_alloc_registered_carveouts() - allocate all carveouts registered
1240 * @rproc: the remote processor handle
1242 * This function parses registered carveout list, performs allocation
1243 * if alloc() ops registered and updates resource table information
1244 * if rsc_offset set.
1246 * Return: 0 on success
1248 static int rproc_alloc_registered_carveouts(struct rproc *rproc)
1250 struct rproc_mem_entry *entry, *tmp;
1251 struct fw_rsc_carveout *rsc;
1252 struct device *dev = &rproc->dev;
1256 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
1258 ret = entry->alloc(rproc, entry);
1260 dev_err(dev, "Unable to allocate carveout %s: %d\n",
1266 if (entry->rsc_offset != FW_RSC_ADDR_ANY) {
1267 /* update resource table */
1268 rsc = (void *)rproc->table_ptr + entry->rsc_offset;
1271 * Some remote processors might need to know the pa
1272 * even though they are behind an IOMMU. E.g., OMAP4's
1273 * remote M3 processor needs this so it can control
1274 * on-chip hardware accelerators that are not behind
1275 * the IOMMU, and therefor must know the pa.
1277 * Generally we don't want to expose physical addresses
1278 * if we don't have to (remote processors are generally
1279 * _not_ trusted), so we might want to do this only for
1280 * remote processor that _must_ have this (e.g. OMAP4's
1281 * dual M3 subsystem).
1283 * Non-IOMMU processors might also want to have this info.
1284 * In this case, the device address and the physical address
1288 /* Use va if defined else dma to generate pa */
1290 pa = (u64)rproc_va_to_pa(entry->va);
1292 pa = (u64)entry->dma;
1294 if (((u64)pa) & HIGH_BITS_MASK)
1296 "Physical address cast in 32bit to fit resource table format\n");
1299 rsc->da = entry->da;
1300 rsc->len = entry->len;
1309 * rproc_resource_cleanup() - clean up and free all acquired resources
1310 * @rproc: rproc handle
1312 * This function will free all resources acquired for @rproc, and it
1313 * is called whenever @rproc either shuts down or fails to boot.
1315 void rproc_resource_cleanup(struct rproc *rproc)
1317 struct rproc_mem_entry *entry, *tmp;
1318 struct rproc_debug_trace *trace, *ttmp;
1319 struct rproc_vdev *rvdev, *rvtmp;
1320 struct device *dev = &rproc->dev;
1322 /* clean up debugfs trace entries */
1323 list_for_each_entry_safe(trace, ttmp, &rproc->traces, node) {
1324 rproc_remove_trace_file(trace->tfile);
1325 rproc->num_traces--;
1326 list_del(&trace->node);
1330 /* clean up iommu mapping entries */
1331 list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
1334 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
1335 if (unmapped != entry->len) {
1336 /* nothing much to do besides complaining */
1337 dev_err(dev, "failed to unmap %zx/%zu\n", entry->len,
1341 list_del(&entry->node);
1345 /* clean up carveout allocations */
1346 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
1348 entry->release(rproc, entry);
1349 list_del(&entry->node);
1353 /* clean up remote vdev entries */
1354 list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
1355 kref_put(&rvdev->refcount, rproc_vdev_release);
1357 rproc_coredump_cleanup(rproc);
1359 EXPORT_SYMBOL(rproc_resource_cleanup);
1361 static int rproc_start(struct rproc *rproc, const struct firmware *fw)
1363 struct resource_table *loaded_table;
1364 struct device *dev = &rproc->dev;
1367 /* load the ELF segments to memory */
1368 ret = rproc_load_segments(rproc, fw);
1370 dev_err(dev, "Failed to load program segments: %d\n", ret);
1375 * The starting device has been given the rproc->cached_table as the
1376 * resource table. The address of the vring along with the other
1377 * allocated resources (carveouts etc) is stored in cached_table.
1378 * In order to pass this information to the remote device we must copy
1379 * this information to device memory. We also update the table_ptr so
1380 * that any subsequent changes will be applied to the loaded version.
1382 loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
1384 memcpy(loaded_table, rproc->cached_table, rproc->table_sz);
1385 rproc->table_ptr = loaded_table;
1388 ret = rproc_prepare_subdevices(rproc);
1390 dev_err(dev, "failed to prepare subdevices for %s: %d\n",
1392 goto reset_table_ptr;
1395 /* power up the remote processor */
1396 ret = rproc->ops->start(rproc);
1398 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
1399 goto unprepare_subdevices;
1402 /* Start any subdevices for the remote processor */
1403 ret = rproc_start_subdevices(rproc);
1405 dev_err(dev, "failed to probe subdevices for %s: %d\n",
1410 rproc->state = RPROC_RUNNING;
1412 dev_info(dev, "remote processor %s is now up\n", rproc->name);
1417 rproc->ops->stop(rproc);
1418 unprepare_subdevices:
1419 rproc_unprepare_subdevices(rproc);
1421 rproc->table_ptr = rproc->cached_table;
1426 static int __rproc_attach(struct rproc *rproc)
1428 struct device *dev = &rproc->dev;
1431 ret = rproc_prepare_subdevices(rproc);
1433 dev_err(dev, "failed to prepare subdevices for %s: %d\n",
1438 /* Attach to the remote processor */
1439 ret = rproc_attach_device(rproc);
1441 dev_err(dev, "can't attach to rproc %s: %d\n",
1443 goto unprepare_subdevices;
1446 /* Start any subdevices for the remote processor */
1447 ret = rproc_start_subdevices(rproc);
1449 dev_err(dev, "failed to probe subdevices for %s: %d\n",
1454 rproc->state = RPROC_ATTACHED;
1456 dev_info(dev, "remote processor %s is now attached\n", rproc->name);
1461 rproc->ops->stop(rproc);
1462 unprepare_subdevices:
1463 rproc_unprepare_subdevices(rproc);
1469 * take a firmware and boot a remote processor with it.
1471 static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
1473 struct device *dev = &rproc->dev;
1474 const char *name = rproc->firmware;
1477 ret = rproc_fw_sanity_check(rproc, fw);
1481 dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
1484 * if enabling an IOMMU isn't relevant for this rproc, this is
1487 ret = rproc_enable_iommu(rproc);
1489 dev_err(dev, "can't enable iommu: %d\n", ret);
1493 /* Prepare rproc for firmware loading if needed */
1494 ret = rproc_prepare_device(rproc);
1496 dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret);
1500 rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
1502 /* Load resource table, core dump segment list etc from the firmware */
1503 ret = rproc_parse_fw(rproc, fw);
1505 goto unprepare_rproc;
1507 /* reset max_notifyid */
1508 rproc->max_notifyid = -1;
1510 /* reset handled vdev */
1513 /* handle fw resources which are required to boot rproc */
1514 ret = rproc_handle_resources(rproc, rproc_loading_handlers);
1516 dev_err(dev, "Failed to process resources: %d\n", ret);
1517 goto clean_up_resources;
1520 /* Allocate carveout resources associated to rproc */
1521 ret = rproc_alloc_registered_carveouts(rproc);
1523 dev_err(dev, "Failed to allocate associated carveouts: %d\n",
1525 goto clean_up_resources;
1528 ret = rproc_start(rproc, fw);
1530 goto clean_up_resources;
1535 rproc_resource_cleanup(rproc);
1536 kfree(rproc->cached_table);
1537 rproc->cached_table = NULL;
1538 rproc->table_ptr = NULL;
1540 /* release HW resources if needed */
1541 rproc_unprepare_device(rproc);
1543 rproc_disable_iommu(rproc);
1547 static int rproc_set_rsc_table(struct rproc *rproc)
1549 struct resource_table *table_ptr;
1550 struct device *dev = &rproc->dev;
1554 table_ptr = rproc_get_loaded_rsc_table(rproc, &table_sz);
1556 /* Not having a resource table is acceptable */
1560 if (IS_ERR(table_ptr)) {
1561 ret = PTR_ERR(table_ptr);
1562 dev_err(dev, "can't load resource table: %d\n", ret);
1567 * If it is possible to detach the remote processor, keep an untouched
1568 * copy of the resource table. That way we can start fresh again when
1569 * the remote processor is re-attached, that is:
1571 * DETACHED -> ATTACHED -> DETACHED -> ATTACHED
1573 * Free'd in rproc_reset_rsc_table_on_detach() and
1574 * rproc_reset_rsc_table_on_stop().
1576 if (rproc->ops->detach) {
1577 rproc->clean_table = kmemdup(table_ptr, table_sz, GFP_KERNEL);
1578 if (!rproc->clean_table)
1581 rproc->clean_table = NULL;
1584 rproc->cached_table = NULL;
1585 rproc->table_ptr = table_ptr;
1586 rproc->table_sz = table_sz;
1591 static int rproc_reset_rsc_table_on_detach(struct rproc *rproc)
1593 struct resource_table *table_ptr;
1595 /* A resource table was never retrieved, nothing to do here */
1596 if (!rproc->table_ptr)
1600 * If we made it to this point a clean_table _must_ have been
1601 * allocated in rproc_set_rsc_table(). If one isn't present
1602 * something went really wrong and we must complain.
1604 if (WARN_ON(!rproc->clean_table))
1607 /* Remember where the external entity installed the resource table */
1608 table_ptr = rproc->table_ptr;
1611 * If we made it here the remote processor was started by another
1612 * entity and a cache table doesn't exist. As such make a copy of
1613 * the resource table currently used by the remote processor and
1614 * use that for the rest of the shutdown process. The memory
1615 * allocated here is free'd in rproc_detach().
1617 rproc->cached_table = kmemdup(rproc->table_ptr,
1618 rproc->table_sz, GFP_KERNEL);
1619 if (!rproc->cached_table)
1623 * Use a copy of the resource table for the remainder of the
1626 rproc->table_ptr = rproc->cached_table;
1629 * Reset the memory area where the firmware loaded the resource table
1630 * to its original value. That way when we re-attach the remote
1631 * processor the resource table is clean and ready to be used again.
1633 memcpy(table_ptr, rproc->clean_table, rproc->table_sz);
1636 * The clean resource table is no longer needed. Allocated in
1637 * rproc_set_rsc_table().
1639 kfree(rproc->clean_table);
1644 static int rproc_reset_rsc_table_on_stop(struct rproc *rproc)
1646 /* A resource table was never retrieved, nothing to do here */
1647 if (!rproc->table_ptr)
1651 * If a cache table exists the remote processor was started by
1652 * the remoteproc core. That cache table should be used for
1653 * the rest of the shutdown process.
1655 if (rproc->cached_table)
1659 * If we made it here the remote processor was started by another
1660 * entity and a cache table doesn't exist. As such make a copy of
1661 * the resource table currently used by the remote processor and
1662 * use that for the rest of the shutdown process. The memory
1663 * allocated here is free'd in rproc_shutdown().
1665 rproc->cached_table = kmemdup(rproc->table_ptr,
1666 rproc->table_sz, GFP_KERNEL);
1667 if (!rproc->cached_table)
1671 * Since the remote processor is being switched off the clean table
1672 * won't be needed. Allocated in rproc_set_rsc_table().
1674 kfree(rproc->clean_table);
1678 * Use a copy of the resource table for the remainder of the
1681 rproc->table_ptr = rproc->cached_table;
1686 * Attach to remote processor - similar to rproc_fw_boot() but without
1687 * the steps that deal with the firmware image.
1689 static int rproc_attach(struct rproc *rproc)
1691 struct device *dev = &rproc->dev;
1695 * if enabling an IOMMU isn't relevant for this rproc, this is
1698 ret = rproc_enable_iommu(rproc);
1700 dev_err(dev, "can't enable iommu: %d\n", ret);
1704 /* Do anything that is needed to boot the remote processor */
1705 ret = rproc_prepare_device(rproc);
1707 dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret);
1711 ret = rproc_set_rsc_table(rproc);
1713 dev_err(dev, "can't load resource table: %d\n", ret);
1714 goto unprepare_device;
1717 /* reset max_notifyid */
1718 rproc->max_notifyid = -1;
1720 /* reset handled vdev */
1724 * Handle firmware resources required to attach to a remote processor.
1725 * Because we are attaching rather than booting the remote processor,
1726 * we expect the platform driver to properly set rproc->table_ptr.
1728 ret = rproc_handle_resources(rproc, rproc_loading_handlers);
1730 dev_err(dev, "Failed to process resources: %d\n", ret);
1731 goto unprepare_device;
1734 /* Allocate carveout resources associated to rproc */
1735 ret = rproc_alloc_registered_carveouts(rproc);
1737 dev_err(dev, "Failed to allocate associated carveouts: %d\n",
1739 goto clean_up_resources;
1742 ret = __rproc_attach(rproc);
1744 goto clean_up_resources;
1749 rproc_resource_cleanup(rproc);
1751 /* release HW resources if needed */
1752 rproc_unprepare_device(rproc);
1754 rproc_disable_iommu(rproc);
1759 * take a firmware and boot it up.
1761 * Note: this function is called asynchronously upon registration of the
1762 * remote processor (so we must wait until it completes before we try
1763 * to unregister the device. one other option is just to use kref here,
1764 * that might be cleaner).
1766 static void rproc_auto_boot_callback(const struct firmware *fw, void *context)
1768 struct rproc *rproc = context;
1772 release_firmware(fw);
1775 static int rproc_trigger_auto_boot(struct rproc *rproc)
1780 * Since the remote processor is in a detached state, it has already
1781 * been booted by another entity. As such there is no point in waiting
1782 * for a firmware image to be loaded, we can simply initiate the process
1783 * of attaching to it immediately.
1785 if (rproc->state == RPROC_DETACHED)
1786 return rproc_boot(rproc);
1789 * We're initiating an asynchronous firmware loading, so we can
1790 * be built-in kernel code, without hanging the boot process.
1792 ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
1793 rproc->firmware, &rproc->dev, GFP_KERNEL,
1794 rproc, rproc_auto_boot_callback);
1796 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
1801 static int rproc_stop(struct rproc *rproc, bool crashed)
1803 struct device *dev = &rproc->dev;
1806 /* No need to continue if a stop() operation has not been provided */
1807 if (!rproc->ops->stop)
1810 /* Stop any subdevices for the remote processor */
1811 rproc_stop_subdevices(rproc, crashed);
1813 /* the installed resource table is no longer accessible */
1814 ret = rproc_reset_rsc_table_on_stop(rproc);
1816 dev_err(dev, "can't reset resource table: %d\n", ret);
1821 /* power off the remote processor */
1822 ret = rproc->ops->stop(rproc);
1824 dev_err(dev, "can't stop rproc: %d\n", ret);
1828 rproc_unprepare_subdevices(rproc);
1830 rproc->state = RPROC_OFFLINE;
1832 dev_info(dev, "stopped remote processor %s\n", rproc->name);
1838 * __rproc_detach(): Does the opposite of __rproc_attach()
1840 static int __rproc_detach(struct rproc *rproc)
1842 struct device *dev = &rproc->dev;
1845 /* No need to continue if a detach() operation has not been provided */
1846 if (!rproc->ops->detach)
1849 /* Stop any subdevices for the remote processor */
1850 rproc_stop_subdevices(rproc, false);
1852 /* the installed resource table is no longer accessible */
1853 ret = rproc_reset_rsc_table_on_detach(rproc);
1855 dev_err(dev, "can't reset resource table: %d\n", ret);
1859 /* Tell the remote processor the core isn't available anymore */
1860 ret = rproc->ops->detach(rproc);
1862 dev_err(dev, "can't detach from rproc: %d\n", ret);
1866 rproc_unprepare_subdevices(rproc);
1868 rproc->state = RPROC_DETACHED;
1870 dev_info(dev, "detached remote processor %s\n", rproc->name);
1876 * rproc_trigger_recovery() - recover a remoteproc
1877 * @rproc: the remote processor
1879 * The recovery is done by resetting all the virtio devices, that way all the
1880 * rpmsg drivers will be reseted along with the remote processor making the
1881 * remoteproc functional again.
1883 * This function can sleep, so it cannot be called from atomic context.
1885 int rproc_trigger_recovery(struct rproc *rproc)
1887 const struct firmware *firmware_p;
1888 struct device *dev = &rproc->dev;
1891 ret = mutex_lock_interruptible(&rproc->lock);
1895 /* State could have changed before we got the mutex */
1896 if (rproc->state != RPROC_CRASHED)
1899 dev_err(dev, "recovering %s\n", rproc->name);
1901 ret = rproc_stop(rproc, true);
1905 /* generate coredump */
1906 rproc->ops->coredump(rproc);
1909 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1911 dev_err(dev, "request_firmware failed: %d\n", ret);
1915 /* boot the remote processor up again */
1916 ret = rproc_start(rproc, firmware_p);
1918 release_firmware(firmware_p);
1921 mutex_unlock(&rproc->lock);
1926 * rproc_crash_handler_work() - handle a crash
1927 * @work: work treating the crash
1929 * This function needs to handle everything related to a crash, like cpu
1930 * registers and stack dump, information to help to debug the fatal error, etc.
1932 static void rproc_crash_handler_work(struct work_struct *work)
1934 struct rproc *rproc = container_of(work, struct rproc, crash_handler);
1935 struct device *dev = &rproc->dev;
1937 dev_dbg(dev, "enter %s\n", __func__);
1939 mutex_lock(&rproc->lock);
1941 if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
1942 /* handle only the first crash detected */
1943 mutex_unlock(&rproc->lock);
1947 rproc->state = RPROC_CRASHED;
1948 dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
1951 mutex_unlock(&rproc->lock);
1953 if (!rproc->recovery_disabled)
1954 rproc_trigger_recovery(rproc);
1956 pm_relax(rproc->dev.parent);
1960 * rproc_boot() - boot a remote processor
1961 * @rproc: handle of a remote processor
1963 * Boot a remote processor (i.e. load its firmware, power it on, ...).
1965 * If the remote processor is already powered on, this function immediately
1966 * returns (successfully).
1968 * Returns 0 on success, and an appropriate error value otherwise.
1970 int rproc_boot(struct rproc *rproc)
1972 const struct firmware *firmware_p;
1977 pr_err("invalid rproc handle\n");
1983 ret = mutex_lock_interruptible(&rproc->lock);
1985 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1989 if (rproc->state == RPROC_DELETED) {
1991 dev_err(dev, "can't boot deleted rproc %s\n", rproc->name);
1995 /* skip the boot or attach process if rproc is already powered up */
1996 if (atomic_inc_return(&rproc->power) > 1) {
2001 if (rproc->state == RPROC_DETACHED) {
2002 dev_info(dev, "attaching to %s\n", rproc->name);
2004 ret = rproc_attach(rproc);
2006 dev_info(dev, "powering up %s\n", rproc->name);
2009 ret = request_firmware(&firmware_p, rproc->firmware, dev);
2011 dev_err(dev, "request_firmware failed: %d\n", ret);
2015 ret = rproc_fw_boot(rproc, firmware_p);
2017 release_firmware(firmware_p);
2022 atomic_dec(&rproc->power);
2024 mutex_unlock(&rproc->lock);
2027 EXPORT_SYMBOL(rproc_boot);
2030 * rproc_shutdown() - power off the remote processor
2031 * @rproc: the remote processor
2033 * Power off a remote processor (previously booted with rproc_boot()).
2035 * In case @rproc is still being used by an additional user(s), then
2036 * this function will just decrement the power refcount and exit,
2037 * without really powering off the device.
2039 * Every call to rproc_boot() must (eventually) be accompanied by a call
2040 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
2043 * - we're not decrementing the rproc's refcount, only the power refcount.
2044 * which means that the @rproc handle stays valid even after rproc_shutdown()
2045 * returns, and users can still use it with a subsequent rproc_boot(), if
2048 void rproc_shutdown(struct rproc *rproc)
2050 struct device *dev = &rproc->dev;
2053 ret = mutex_lock_interruptible(&rproc->lock);
2055 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
2059 /* if the remote proc is still needed, bail out */
2060 if (!atomic_dec_and_test(&rproc->power))
2063 ret = rproc_stop(rproc, false);
2065 atomic_inc(&rproc->power);
2069 /* clean up all acquired resources */
2070 rproc_resource_cleanup(rproc);
2072 /* release HW resources if needed */
2073 rproc_unprepare_device(rproc);
2075 rproc_disable_iommu(rproc);
2077 /* Free the copy of the resource table */
2078 kfree(rproc->cached_table);
2079 rproc->cached_table = NULL;
2080 rproc->table_ptr = NULL;
2082 mutex_unlock(&rproc->lock);
2084 EXPORT_SYMBOL(rproc_shutdown);
2087 * rproc_detach() - Detach the remote processor from the
2090 * @rproc: the remote processor
2092 * Detach a remote processor (previously attached to with rproc_attach()).
2094 * In case @rproc is still being used by an additional user(s), then
2095 * this function will just decrement the power refcount and exit,
2096 * without disconnecting the device.
2098 * Function rproc_detach() calls __rproc_detach() in order to let a remote
2099 * processor know that services provided by the application processor are
2100 * no longer available. From there it should be possible to remove the
2101 * platform driver and even power cycle the application processor (if the HW
2102 * supports it) without needing to switch off the remote processor.
2104 int rproc_detach(struct rproc *rproc)
2106 struct device *dev = &rproc->dev;
2109 ret = mutex_lock_interruptible(&rproc->lock);
2111 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
2115 /* if the remote proc is still needed, bail out */
2116 if (!atomic_dec_and_test(&rproc->power)) {
2121 ret = __rproc_detach(rproc);
2123 atomic_inc(&rproc->power);
2127 /* clean up all acquired resources */
2128 rproc_resource_cleanup(rproc);
2130 /* release HW resources if needed */
2131 rproc_unprepare_device(rproc);
2133 rproc_disable_iommu(rproc);
2135 /* Free the copy of the resource table */
2136 kfree(rproc->cached_table);
2137 rproc->cached_table = NULL;
2138 rproc->table_ptr = NULL;
2140 mutex_unlock(&rproc->lock);
2143 EXPORT_SYMBOL(rproc_detach);
2146 * rproc_get_by_phandle() - find a remote processor by phandle
2147 * @phandle: phandle to the rproc
2149 * Finds an rproc handle using the remote processor's phandle, and then
2150 * return a handle to the rproc.
2152 * This function increments the remote processor's refcount, so always
2153 * use rproc_put() to decrement it back once rproc isn't needed anymore.
2155 * Returns the rproc handle on success, and NULL on failure.
2158 struct rproc *rproc_get_by_phandle(phandle phandle)
2160 struct rproc *rproc = NULL, *r;
2161 struct device_node *np;
2163 np = of_find_node_by_phandle(phandle);
2168 list_for_each_entry_rcu(r, &rproc_list, node) {
2169 if (r->dev.parent && r->dev.parent->of_node == np) {
2170 /* prevent underlying implementation from being removed */
2171 if (!try_module_get(r->dev.parent->driver->owner)) {
2172 dev_err(&r->dev, "can't get owner\n");
2177 get_device(&rproc->dev);
2188 struct rproc *rproc_get_by_phandle(phandle phandle)
2193 EXPORT_SYMBOL(rproc_get_by_phandle);
2196 * rproc_set_firmware() - assign a new firmware
2197 * @rproc: rproc handle to which the new firmware is being assigned
2198 * @fw_name: new firmware name to be assigned
2200 * This function allows remoteproc drivers or clients to configure a custom
2201 * firmware name that is different from the default name used during remoteproc
2202 * registration. The function does not trigger a remote processor boot,
2203 * only sets the firmware name used for a subsequent boot. This function
2204 * should also be called only when the remote processor is offline.
2206 * This allows either the userspace to configure a different name through
2207 * sysfs or a kernel-level remoteproc or a remoteproc client driver to set
2208 * a specific firmware when it is controlling the boot and shutdown of the
2211 * Return: 0 on success or a negative value upon failure
2213 int rproc_set_firmware(struct rproc *rproc, const char *fw_name)
2219 if (!rproc || !fw_name)
2222 dev = rproc->dev.parent;
2224 ret = mutex_lock_interruptible(&rproc->lock);
2226 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
2230 if (rproc->state != RPROC_OFFLINE) {
2231 dev_err(dev, "can't change firmware while running\n");
2236 len = strcspn(fw_name, "\n");
2238 dev_err(dev, "can't provide empty string for firmware name\n");
2243 p = kstrndup(fw_name, len, GFP_KERNEL);
2249 kfree_const(rproc->firmware);
2250 rproc->firmware = p;
2253 mutex_unlock(&rproc->lock);
2256 EXPORT_SYMBOL(rproc_set_firmware);
2258 static int rproc_validate(struct rproc *rproc)
2260 switch (rproc->state) {
2263 * An offline processor without a start()
2264 * function makes no sense.
2266 if (!rproc->ops->start)
2269 case RPROC_DETACHED:
2271 * A remote processor in a detached state without an
2272 * attach() function makes not sense.
2274 if (!rproc->ops->attach)
2277 * When attaching to a remote processor the device memory
2278 * is already available and as such there is no need to have a
2281 if (rproc->cached_table)
2286 * When adding a remote processor, the state of the device
2287 * can be offline or detached, nothing else.
2296 * rproc_add() - register a remote processor
2297 * @rproc: the remote processor handle to register
2299 * Registers @rproc with the remoteproc framework, after it has been
2300 * allocated with rproc_alloc().
2302 * This is called by the platform-specific rproc implementation, whenever
2303 * a new remote processor device is probed.
2305 * Returns 0 on success and an appropriate error code otherwise.
2307 * Note: this function initiates an asynchronous firmware loading
2308 * context, which will look for virtio devices supported by the rproc's
2311 * If found, those virtio devices will be created and added, so as a result
2312 * of registering this remote processor, additional virtio drivers might be
2315 int rproc_add(struct rproc *rproc)
2317 struct device *dev = &rproc->dev;
2320 ret = device_add(dev);
2324 ret = rproc_validate(rproc);
2328 dev_info(dev, "%s is available\n", rproc->name);
2330 /* create debugfs entries */
2331 rproc_create_debug_dir(rproc);
2333 /* add char device for this remoteproc */
2334 ret = rproc_char_device_add(rproc);
2338 /* if rproc is marked always-on, request it to boot */
2339 if (rproc->auto_boot) {
2340 ret = rproc_trigger_auto_boot(rproc);
2345 /* expose to rproc_get_by_phandle users */
2346 mutex_lock(&rproc_list_mutex);
2347 list_add_rcu(&rproc->node, &rproc_list);
2348 mutex_unlock(&rproc_list_mutex);
2352 EXPORT_SYMBOL(rproc_add);
2354 static void devm_rproc_remove(void *rproc)
2360 * devm_rproc_add() - resource managed rproc_add()
2361 * @dev: the underlying device
2362 * @rproc: the remote processor handle to register
2364 * This function performs like rproc_add() but the registered rproc device will
2365 * automatically be removed on driver detach.
2367 * Returns: 0 on success, negative errno on failure
2369 int devm_rproc_add(struct device *dev, struct rproc *rproc)
2373 err = rproc_add(rproc);
2377 return devm_add_action_or_reset(dev, devm_rproc_remove, rproc);
2379 EXPORT_SYMBOL(devm_rproc_add);
2382 * rproc_type_release() - release a remote processor instance
2383 * @dev: the rproc's device
2385 * This function should _never_ be called directly.
2387 * It will be called by the driver core when no one holds a valid pointer
2390 static void rproc_type_release(struct device *dev)
2392 struct rproc *rproc = container_of(dev, struct rproc, dev);
2394 dev_info(&rproc->dev, "releasing %s\n", rproc->name);
2396 idr_destroy(&rproc->notifyids);
2398 if (rproc->index >= 0)
2399 ida_simple_remove(&rproc_dev_index, rproc->index);
2401 kfree_const(rproc->firmware);
2402 kfree_const(rproc->name);
2407 static const struct device_type rproc_type = {
2408 .name = "remoteproc",
2409 .release = rproc_type_release,
2412 static int rproc_alloc_firmware(struct rproc *rproc,
2413 const char *name, const char *firmware)
2418 * Allocate a firmware name if the caller gave us one to work
2419 * with. Otherwise construct a new one using a default pattern.
2422 p = kstrdup_const(firmware, GFP_KERNEL);
2424 p = kasprintf(GFP_KERNEL, "rproc-%s-fw", name);
2429 rproc->firmware = p;
2434 static int rproc_alloc_ops(struct rproc *rproc, const struct rproc_ops *ops)
2436 rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL);
2440 /* Default to rproc_coredump if no coredump function is specified */
2441 if (!rproc->ops->coredump)
2442 rproc->ops->coredump = rproc_coredump;
2444 if (rproc->ops->load)
2447 /* Default to ELF loader if no load function is specified */
2448 rproc->ops->load = rproc_elf_load_segments;
2449 rproc->ops->parse_fw = rproc_elf_load_rsc_table;
2450 rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table;
2451 rproc->ops->sanity_check = rproc_elf_sanity_check;
2452 rproc->ops->get_boot_addr = rproc_elf_get_boot_addr;
2458 * rproc_alloc() - allocate a remote processor handle
2459 * @dev: the underlying device
2460 * @name: name of this remote processor
2461 * @ops: platform-specific handlers (mainly start/stop)
2462 * @firmware: name of firmware file to load, can be NULL
2463 * @len: length of private data needed by the rproc driver (in bytes)
2465 * Allocates a new remote processor handle, but does not register
2466 * it yet. if @firmware is NULL, a default name is used.
2468 * This function should be used by rproc implementations during initialization
2469 * of the remote processor.
2471 * After creating an rproc handle using this function, and when ready,
2472 * implementations should then call rproc_add() to complete
2473 * the registration of the remote processor.
2475 * On success the new rproc is returned, and on failure, NULL.
2477 * Note: _never_ directly deallocate @rproc, even if it was not registered
2478 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
2480 struct rproc *rproc_alloc(struct device *dev, const char *name,
2481 const struct rproc_ops *ops,
2482 const char *firmware, int len)
2484 struct rproc *rproc;
2486 if (!dev || !name || !ops)
2489 rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
2493 rproc->priv = &rproc[1];
2494 rproc->auto_boot = true;
2495 rproc->elf_class = ELFCLASSNONE;
2496 rproc->elf_machine = EM_NONE;
2498 device_initialize(&rproc->dev);
2499 rproc->dev.parent = dev;
2500 rproc->dev.type = &rproc_type;
2501 rproc->dev.class = &rproc_class;
2502 rproc->dev.driver_data = rproc;
2503 idr_init(&rproc->notifyids);
2505 rproc->name = kstrdup_const(name, GFP_KERNEL);
2509 if (rproc_alloc_firmware(rproc, name, firmware))
2512 if (rproc_alloc_ops(rproc, ops))
2515 /* Assign a unique device index and name */
2516 rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
2517 if (rproc->index < 0) {
2518 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
2522 dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
2524 atomic_set(&rproc->power, 0);
2526 mutex_init(&rproc->lock);
2528 INIT_LIST_HEAD(&rproc->carveouts);
2529 INIT_LIST_HEAD(&rproc->mappings);
2530 INIT_LIST_HEAD(&rproc->traces);
2531 INIT_LIST_HEAD(&rproc->rvdevs);
2532 INIT_LIST_HEAD(&rproc->subdevs);
2533 INIT_LIST_HEAD(&rproc->dump_segments);
2535 INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
2537 rproc->state = RPROC_OFFLINE;
2542 put_device(&rproc->dev);
2545 EXPORT_SYMBOL(rproc_alloc);
2548 * rproc_free() - unroll rproc_alloc()
2549 * @rproc: the remote processor handle
2551 * This function decrements the rproc dev refcount.
2553 * If no one holds any reference to rproc anymore, then its refcount would
2554 * now drop to zero, and it would be freed.
2556 void rproc_free(struct rproc *rproc)
2558 put_device(&rproc->dev);
2560 EXPORT_SYMBOL(rproc_free);
2563 * rproc_put() - release rproc reference
2564 * @rproc: the remote processor handle
2566 * This function decrements the rproc dev refcount.
2568 * If no one holds any reference to rproc anymore, then its refcount would
2569 * now drop to zero, and it would be freed.
2571 void rproc_put(struct rproc *rproc)
2573 module_put(rproc->dev.parent->driver->owner);
2574 put_device(&rproc->dev);
2576 EXPORT_SYMBOL(rproc_put);
2579 * rproc_del() - unregister a remote processor
2580 * @rproc: rproc handle to unregister
2582 * This function should be called when the platform specific rproc
2583 * implementation decides to remove the rproc device. it should
2584 * _only_ be called if a previous invocation of rproc_add()
2585 * has completed successfully.
2587 * After rproc_del() returns, @rproc isn't freed yet, because
2588 * of the outstanding reference created by rproc_alloc. To decrement that
2589 * one last refcount, one still needs to call rproc_free().
2591 * Returns 0 on success and -EINVAL if @rproc isn't valid.
2593 int rproc_del(struct rproc *rproc)
2598 /* TODO: make sure this works with rproc->power > 1 */
2599 rproc_shutdown(rproc);
2601 mutex_lock(&rproc->lock);
2602 rproc->state = RPROC_DELETED;
2603 mutex_unlock(&rproc->lock);
2605 rproc_delete_debug_dir(rproc);
2606 rproc_char_device_remove(rproc);
2608 /* the rproc is downref'ed as soon as it's removed from the klist */
2609 mutex_lock(&rproc_list_mutex);
2610 list_del_rcu(&rproc->node);
2611 mutex_unlock(&rproc_list_mutex);
2613 /* Ensure that no readers of rproc_list are still active */
2616 device_del(&rproc->dev);
2620 EXPORT_SYMBOL(rproc_del);
2622 static void devm_rproc_free(struct device *dev, void *res)
2624 rproc_free(*(struct rproc **)res);
2628 * devm_rproc_alloc() - resource managed rproc_alloc()
2629 * @dev: the underlying device
2630 * @name: name of this remote processor
2631 * @ops: platform-specific handlers (mainly start/stop)
2632 * @firmware: name of firmware file to load, can be NULL
2633 * @len: length of private data needed by the rproc driver (in bytes)
2635 * This function performs like rproc_alloc() but the acquired rproc device will
2636 * automatically be released on driver detach.
2638 * Returns: new rproc instance, or NULL on failure
2640 struct rproc *devm_rproc_alloc(struct device *dev, const char *name,
2641 const struct rproc_ops *ops,
2642 const char *firmware, int len)
2644 struct rproc **ptr, *rproc;
2646 ptr = devres_alloc(devm_rproc_free, sizeof(*ptr), GFP_KERNEL);
2650 rproc = rproc_alloc(dev, name, ops, firmware, len);
2653 devres_add(dev, ptr);
2660 EXPORT_SYMBOL(devm_rproc_alloc);
2663 * rproc_add_subdev() - add a subdevice to a remoteproc
2664 * @rproc: rproc handle to add the subdevice to
2665 * @subdev: subdev handle to register
2667 * Caller is responsible for populating optional subdevice function pointers.
2669 void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
2671 list_add_tail(&subdev->node, &rproc->subdevs);
2673 EXPORT_SYMBOL(rproc_add_subdev);
2676 * rproc_remove_subdev() - remove a subdevice from a remoteproc
2677 * @rproc: rproc handle to remove the subdevice from
2678 * @subdev: subdev handle, previously registered with rproc_add_subdev()
2680 void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
2682 list_del(&subdev->node);
2684 EXPORT_SYMBOL(rproc_remove_subdev);
2687 * rproc_get_by_child() - acquire rproc handle of @dev's ancestor
2688 * @dev: child device to find ancestor of
2690 * Returns the ancestor rproc instance, or NULL if not found.
2692 struct rproc *rproc_get_by_child(struct device *dev)
2694 for (dev = dev->parent; dev; dev = dev->parent) {
2695 if (dev->type == &rproc_type)
2696 return dev->driver_data;
2701 EXPORT_SYMBOL(rproc_get_by_child);
2704 * rproc_report_crash() - rproc crash reporter function
2705 * @rproc: remote processor
2708 * This function must be called every time a crash is detected by the low-level
2709 * drivers implementing a specific remoteproc. This should not be called from a
2710 * non-remoteproc driver.
2712 * This function can be called from atomic/interrupt context.
2714 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
2717 pr_err("NULL rproc pointer\n");
2721 /* Prevent suspend while the remoteproc is being recovered */
2722 pm_stay_awake(rproc->dev.parent);
2724 dev_err(&rproc->dev, "crash detected in %s: type %s\n",
2725 rproc->name, rproc_crash_to_string(type));
2727 /* create a new task to handle the error */
2728 schedule_work(&rproc->crash_handler);
2730 EXPORT_SYMBOL(rproc_report_crash);
2732 static int rproc_panic_handler(struct notifier_block *nb, unsigned long event,
2735 unsigned int longest = 0;
2736 struct rproc *rproc;
2740 list_for_each_entry_rcu(rproc, &rproc_list, node) {
2741 if (!rproc->ops->panic)
2744 if (rproc->state != RPROC_RUNNING &&
2745 rproc->state != RPROC_ATTACHED)
2748 d = rproc->ops->panic(rproc);
2749 longest = max(longest, d);
2754 * Delay for the longest requested duration before returning. This can
2755 * be used by the remoteproc drivers to give the remote processor time
2756 * to perform any requested operations (such as flush caches), when
2757 * it's not possible to signal the Linux side due to the panic.
2764 static void __init rproc_init_panic(void)
2766 rproc_panic_nb.notifier_call = rproc_panic_handler;
2767 atomic_notifier_chain_register(&panic_notifier_list, &rproc_panic_nb);
2770 static void __exit rproc_exit_panic(void)
2772 atomic_notifier_chain_unregister(&panic_notifier_list, &rproc_panic_nb);
2775 static int __init remoteproc_init(void)
2778 rproc_init_debugfs();
2784 subsys_initcall(remoteproc_init);
2786 static void __exit remoteproc_exit(void)
2788 ida_destroy(&rproc_dev_index);
2791 rproc_exit_debugfs();
2794 module_exit(remoteproc_exit);
2796 MODULE_LICENSE("GPL v2");
2797 MODULE_DESCRIPTION("Generic Remote Processor Framework");