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/slab.h>
24 #include <linux/mutex.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/firmware.h>
27 #include <linux/string.h>
28 #include <linux/debugfs.h>
29 #include <linux/rculist.h>
30 #include <linux/remoteproc.h>
31 #include <linux/iommu.h>
32 #include <linux/idr.h>
33 #include <linux/elf.h>
34 #include <linux/crc32.h>
35 #include <linux/of_reserved_mem.h>
36 #include <linux/virtio_ids.h>
37 #include <linux/virtio_ring.h>
38 #include <asm/byteorder.h>
39 #include <linux/platform_device.h>
41 #include "remoteproc_internal.h"
43 #define HIGH_BITS_MASK 0xFFFFFFFF00000000ULL
45 static DEFINE_MUTEX(rproc_list_mutex);
46 static LIST_HEAD(rproc_list);
47 static struct notifier_block rproc_panic_nb;
49 typedef int (*rproc_handle_resource_t)(struct rproc *rproc,
50 void *, int offset, int avail);
52 static int rproc_alloc_carveout(struct rproc *rproc,
53 struct rproc_mem_entry *mem);
54 static int rproc_release_carveout(struct rproc *rproc,
55 struct rproc_mem_entry *mem);
57 /* Unique indices for remoteproc devices */
58 static DEFINE_IDA(rproc_dev_index);
60 static const char * const rproc_crash_names[] = {
61 [RPROC_MMUFAULT] = "mmufault",
62 [RPROC_WATCHDOG] = "watchdog",
63 [RPROC_FATAL_ERROR] = "fatal error",
66 /* translate rproc_crash_type to string */
67 static const char *rproc_crash_to_string(enum rproc_crash_type type)
69 if (type < ARRAY_SIZE(rproc_crash_names))
70 return rproc_crash_names[type];
75 * This is the IOMMU fault handler we register with the IOMMU API
76 * (when relevant; not all remote processors access memory through
79 * IOMMU core will invoke this handler whenever the remote processor
80 * will try to access an unmapped device address.
82 static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
83 unsigned long iova, int flags, void *token)
85 struct rproc *rproc = token;
87 dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
89 rproc_report_crash(rproc, RPROC_MMUFAULT);
92 * Let the iommu core know we're not really handling this fault;
93 * we just used it as a recovery trigger.
98 static int rproc_enable_iommu(struct rproc *rproc)
100 struct iommu_domain *domain;
101 struct device *dev = rproc->dev.parent;
104 if (!rproc->has_iommu) {
105 dev_dbg(dev, "iommu not present\n");
109 domain = iommu_domain_alloc(dev->bus);
111 dev_err(dev, "can't alloc iommu domain\n");
115 iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
117 ret = iommu_attach_device(domain, dev);
119 dev_err(dev, "can't attach iommu device: %d\n", ret);
123 rproc->domain = domain;
128 iommu_domain_free(domain);
132 static void rproc_disable_iommu(struct rproc *rproc)
134 struct iommu_domain *domain = rproc->domain;
135 struct device *dev = rproc->dev.parent;
140 iommu_detach_device(domain, dev);
141 iommu_domain_free(domain);
144 phys_addr_t rproc_va_to_pa(void *cpu_addr)
147 * Return physical address according to virtual address location
148 * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent
149 * - in kernel: if region allocated in generic dma memory pool
151 if (is_vmalloc_addr(cpu_addr)) {
152 return page_to_phys(vmalloc_to_page(cpu_addr)) +
153 offset_in_page(cpu_addr);
156 WARN_ON(!virt_addr_valid(cpu_addr));
157 return virt_to_phys(cpu_addr);
159 EXPORT_SYMBOL(rproc_va_to_pa);
162 * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address
163 * @rproc: handle of a remote processor
164 * @da: remoteproc device address to translate
165 * @len: length of the memory region @da is pointing to
167 * Some remote processors will ask us to allocate them physically contiguous
168 * memory regions (which we call "carveouts"), and map them to specific
169 * device addresses (which are hardcoded in the firmware). They may also have
170 * dedicated memory regions internal to the processors, and use them either
171 * exclusively or alongside carveouts.
173 * They may then ask us to copy objects into specific device addresses (e.g.
174 * code/data sections) or expose us certain symbols in other device address
175 * (e.g. their trace buffer).
177 * This function is a helper function with which we can go over the allocated
178 * carveouts and translate specific device addresses to kernel virtual addresses
179 * so we can access the referenced memory. This function also allows to perform
180 * translations on the internal remoteproc memory regions through a platform
181 * implementation specific da_to_va ops, if present.
183 * The function returns a valid kernel address on success or NULL on failure.
185 * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
186 * but only on kernel direct mapped RAM memory. Instead, we're just using
187 * here the output of the DMA API for the carveouts, which should be more
190 void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len)
192 struct rproc_mem_entry *carveout;
195 if (rproc->ops->da_to_va) {
196 ptr = rproc->ops->da_to_va(rproc, da, len);
201 list_for_each_entry(carveout, &rproc->carveouts, node) {
202 int offset = da - carveout->da;
204 /* Verify that carveout is allocated */
208 /* try next carveout if da is too small */
212 /* try next carveout if da is too large */
213 if (offset + len > carveout->len)
216 ptr = carveout->va + offset;
224 EXPORT_SYMBOL(rproc_da_to_va);
227 * rproc_find_carveout_by_name() - lookup the carveout region by a name
228 * @rproc: handle of a remote processor
229 * @name: carveout name to find (format string)
230 * @...: optional parameters matching @name string
232 * Platform driver has the capability to register some pre-allacoted carveout
233 * (physically contiguous memory regions) before rproc firmware loading and
234 * associated resource table analysis. These regions may be dedicated memory
235 * regions internal to the coprocessor or specified DDR region with specific
238 * This function is a helper function with which we can go over the
239 * allocated carveouts and return associated region characteristics like
240 * coprocessor address, length or processor virtual address.
242 * Return: a valid pointer on carveout entry on success or NULL on failure.
245 struct rproc_mem_entry *
246 rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...)
250 struct rproc_mem_entry *carveout, *mem = NULL;
255 va_start(args, name);
256 vsnprintf(_name, sizeof(_name), name, args);
259 list_for_each_entry(carveout, &rproc->carveouts, node) {
260 /* Compare carveout and requested names */
261 if (!strcmp(carveout->name, _name)) {
271 * rproc_check_carveout_da() - Check specified carveout da configuration
272 * @rproc: handle of a remote processor
273 * @mem: pointer on carveout to check
274 * @da: area device address
275 * @len: associated area size
277 * This function is a helper function to verify requested device area (couple
278 * da, len) is part of specified carveout.
279 * If da is not set (defined as FW_RSC_ADDR_ANY), only requested length is
282 * Return: 0 if carveout matches request else error
284 static int rproc_check_carveout_da(struct rproc *rproc,
285 struct rproc_mem_entry *mem, u32 da, u32 len)
287 struct device *dev = &rproc->dev;
290 /* Check requested resource length */
291 if (len > mem->len) {
292 dev_err(dev, "Registered carveout doesn't fit len request\n");
296 if (da != FW_RSC_ADDR_ANY && mem->da == FW_RSC_ADDR_ANY) {
297 /* Address doesn't match registered carveout configuration */
299 } else if (da != FW_RSC_ADDR_ANY && mem->da != FW_RSC_ADDR_ANY) {
300 delta = da - mem->da;
302 /* Check requested resource belongs to registered carveout */
305 "Registered carveout doesn't fit da request\n");
309 if (delta + len > mem->len) {
311 "Registered carveout doesn't fit len request\n");
319 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
321 struct rproc *rproc = rvdev->rproc;
322 struct device *dev = &rproc->dev;
323 struct rproc_vring *rvring = &rvdev->vring[i];
324 struct fw_rsc_vdev *rsc;
326 struct rproc_mem_entry *mem;
329 /* actual size of vring (in bytes) */
330 size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
332 rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
334 /* Search for pre-registered carveout */
335 mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index,
338 if (rproc_check_carveout_da(rproc, mem, rsc->vring[i].da, size))
341 /* Register carveout in in list */
342 mem = rproc_mem_entry_init(dev, NULL, 0,
343 size, rsc->vring[i].da,
344 rproc_alloc_carveout,
345 rproc_release_carveout,
349 dev_err(dev, "Can't allocate memory entry structure\n");
353 rproc_add_carveout(rproc, mem);
357 * Assign an rproc-wide unique index for this vring
358 * TODO: assign a notifyid for rvdev updates as well
359 * TODO: support predefined notifyids (via resource table)
361 ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
363 dev_err(dev, "idr_alloc failed: %d\n", ret);
368 /* Potentially bump max_notifyid */
369 if (notifyid > rproc->max_notifyid)
370 rproc->max_notifyid = notifyid;
372 rvring->notifyid = notifyid;
374 /* Let the rproc know the notifyid of this vring.*/
375 rsc->vring[i].notifyid = notifyid;
380 rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
382 struct rproc *rproc = rvdev->rproc;
383 struct device *dev = &rproc->dev;
384 struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
385 struct rproc_vring *rvring = &rvdev->vring[i];
387 dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
388 i, vring->da, vring->num, vring->align);
390 /* verify queue size and vring alignment are sane */
391 if (!vring->num || !vring->align) {
392 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
393 vring->num, vring->align);
397 rvring->len = vring->num;
398 rvring->align = vring->align;
399 rvring->rvdev = rvdev;
404 void rproc_free_vring(struct rproc_vring *rvring)
406 struct rproc *rproc = rvring->rvdev->rproc;
407 int idx = rvring - rvring->rvdev->vring;
408 struct fw_rsc_vdev *rsc;
410 idr_remove(&rproc->notifyids, rvring->notifyid);
413 * At this point rproc_stop() has been called and the installed resource
414 * table in the remote processor memory may no longer be accessible. As
415 * such and as per rproc_stop(), rproc->table_ptr points to the cached
416 * resource table (rproc->cached_table). The cached resource table is
417 * only available when a remote processor has been booted by the
418 * remoteproc core, otherwise it is NULL.
420 * Based on the above, reset the virtio device section in the cached
421 * resource table only if there is one to work with.
423 if (rproc->table_ptr) {
424 rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
425 rsc->vring[idx].da = 0;
426 rsc->vring[idx].notifyid = -1;
430 static int rproc_vdev_do_start(struct rproc_subdev *subdev)
432 struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
434 return rproc_add_virtio_dev(rvdev, rvdev->id);
437 static void rproc_vdev_do_stop(struct rproc_subdev *subdev, bool crashed)
439 struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
442 ret = device_for_each_child(&rvdev->dev, NULL, rproc_remove_virtio_dev);
444 dev_warn(&rvdev->dev, "can't remove vdev child device: %d\n", ret);
448 * rproc_rvdev_release() - release the existence of a rvdev
450 * @dev: the subdevice's dev
452 static void rproc_rvdev_release(struct device *dev)
454 struct rproc_vdev *rvdev = container_of(dev, struct rproc_vdev, dev);
456 of_reserved_mem_device_release(dev);
462 * rproc_handle_vdev() - handle a vdev fw resource
463 * @rproc: the remote processor
464 * @rsc: the vring resource descriptor
465 * @offset: offset of the resource entry
466 * @avail: size of available data (for sanity checking the image)
468 * This resource entry requests the host to statically register a virtio
469 * device (vdev), and setup everything needed to support it. It contains
470 * everything needed to make it possible: the virtio device id, virtio
471 * device features, vrings information, virtio config space, etc...
473 * Before registering the vdev, the vrings are allocated from non-cacheable
474 * physically contiguous memory. Currently we only support two vrings per
475 * remote processor (temporary limitation). We might also want to consider
476 * doing the vring allocation only later when ->find_vqs() is invoked, and
477 * then release them upon ->del_vqs().
479 * Note: @da is currently not really handled correctly: we dynamically
480 * allocate it using the DMA API, ignoring requested hard coded addresses,
481 * and we don't take care of any required IOMMU programming. This is all
482 * going to be taken care of when the generic iommu-based DMA API will be
483 * merged. Meanwhile, statically-addressed iommu-based firmware images should
484 * use RSC_DEVMEM resource entries to map their required @da to the physical
485 * address of their base CMA region (ouch, hacky!).
487 * Returns 0 on success, or an appropriate error code otherwise
489 static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
490 int offset, int avail)
492 struct device *dev = &rproc->dev;
493 struct rproc_vdev *rvdev;
497 /* make sure resource isn't truncated */
498 if (struct_size(rsc, vring, rsc->num_of_vrings) + rsc->config_len >
500 dev_err(dev, "vdev rsc is truncated\n");
504 /* make sure reserved bytes are zeroes */
505 if (rsc->reserved[0] || rsc->reserved[1]) {
506 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
510 dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
511 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
513 /* we currently support only two vrings per rvdev */
514 if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
515 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
519 rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL);
523 kref_init(&rvdev->refcount);
526 rvdev->rproc = rproc;
527 rvdev->index = rproc->nb_vdev++;
529 /* Initialise vdev subdevice */
530 snprintf(name, sizeof(name), "vdev%dbuffer", rvdev->index);
531 rvdev->dev.parent = &rproc->dev;
532 rvdev->dev.dma_pfn_offset = rproc->dev.parent->dma_pfn_offset;
533 rvdev->dev.release = rproc_rvdev_release;
534 dev_set_name(&rvdev->dev, "%s#%s", dev_name(rvdev->dev.parent), name);
535 dev_set_drvdata(&rvdev->dev, rvdev);
537 ret = device_register(&rvdev->dev);
539 put_device(&rvdev->dev);
542 /* Make device dma capable by inheriting from parent's capabilities */
543 set_dma_ops(&rvdev->dev, get_dma_ops(rproc->dev.parent));
545 ret = dma_coerce_mask_and_coherent(&rvdev->dev,
546 dma_get_mask(rproc->dev.parent));
549 "Failed to set DMA mask %llx. Trying to continue... %x\n",
550 dma_get_mask(rproc->dev.parent), ret);
553 /* parse the vrings */
554 for (i = 0; i < rsc->num_of_vrings; i++) {
555 ret = rproc_parse_vring(rvdev, rsc, i);
560 /* remember the resource offset*/
561 rvdev->rsc_offset = offset;
563 /* allocate the vring resources */
564 for (i = 0; i < rsc->num_of_vrings; i++) {
565 ret = rproc_alloc_vring(rvdev, i);
567 goto unwind_vring_allocations;
570 list_add_tail(&rvdev->node, &rproc->rvdevs);
572 rvdev->subdev.start = rproc_vdev_do_start;
573 rvdev->subdev.stop = rproc_vdev_do_stop;
575 rproc_add_subdev(rproc, &rvdev->subdev);
579 unwind_vring_allocations:
580 for (i--; i >= 0; i--)
581 rproc_free_vring(&rvdev->vring[i]);
583 device_unregister(&rvdev->dev);
587 void rproc_vdev_release(struct kref *ref)
589 struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount);
590 struct rproc_vring *rvring;
591 struct rproc *rproc = rvdev->rproc;
594 for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) {
595 rvring = &rvdev->vring[id];
596 rproc_free_vring(rvring);
599 rproc_remove_subdev(rproc, &rvdev->subdev);
600 list_del(&rvdev->node);
601 device_unregister(&rvdev->dev);
605 * rproc_handle_trace() - handle a shared trace buffer resource
606 * @rproc: the remote processor
607 * @rsc: the trace resource descriptor
608 * @offset: offset of the resource entry
609 * @avail: size of available data (for sanity checking the image)
611 * In case the remote processor dumps trace logs into memory,
612 * export it via debugfs.
614 * Currently, the 'da' member of @rsc should contain the device address
615 * where the remote processor is dumping the traces. Later we could also
616 * support dynamically allocating this address using the generic
617 * DMA API (but currently there isn't a use case for that).
619 * Returns 0 on success, or an appropriate error code otherwise
621 static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
622 int offset, int avail)
624 struct rproc_debug_trace *trace;
625 struct device *dev = &rproc->dev;
628 if (sizeof(*rsc) > avail) {
629 dev_err(dev, "trace rsc is truncated\n");
633 /* make sure reserved bytes are zeroes */
635 dev_err(dev, "trace rsc has non zero reserved bytes\n");
639 trace = kzalloc(sizeof(*trace), GFP_KERNEL);
643 /* set the trace buffer dma properties */
644 trace->trace_mem.len = rsc->len;
645 trace->trace_mem.da = rsc->da;
647 /* set pointer on rproc device */
648 trace->rproc = rproc;
650 /* make sure snprintf always null terminates, even if truncating */
651 snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
653 /* create the debugfs entry */
654 trace->tfile = rproc_create_trace_file(name, rproc, trace);
660 list_add_tail(&trace->node, &rproc->traces);
664 dev_dbg(dev, "%s added: da 0x%x, len 0x%x\n",
665 name, rsc->da, rsc->len);
671 * rproc_handle_devmem() - handle devmem resource entry
672 * @rproc: remote processor handle
673 * @rsc: the devmem resource entry
674 * @offset: offset of the resource entry
675 * @avail: size of available data (for sanity checking the image)
677 * Remote processors commonly need to access certain on-chip peripherals.
679 * Some of these remote processors access memory via an iommu device,
680 * and might require us to configure their iommu before they can access
681 * the on-chip peripherals they need.
683 * This resource entry is a request to map such a peripheral device.
685 * These devmem entries will contain the physical address of the device in
686 * the 'pa' member. If a specific device address is expected, then 'da' will
687 * contain it (currently this is the only use case supported). 'len' will
688 * contain the size of the physical region we need to map.
690 * Currently we just "trust" those devmem entries to contain valid physical
691 * addresses, but this is going to change: we want the implementations to
692 * tell us ranges of physical addresses the firmware is allowed to request,
693 * and not allow firmwares to request access to physical addresses that
694 * are outside those ranges.
696 static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
697 int offset, int avail)
699 struct rproc_mem_entry *mapping;
700 struct device *dev = &rproc->dev;
703 /* no point in handling this resource without a valid iommu domain */
707 if (sizeof(*rsc) > avail) {
708 dev_err(dev, "devmem rsc is truncated\n");
712 /* make sure reserved bytes are zeroes */
714 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
718 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
722 ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
724 dev_err(dev, "failed to map devmem: %d\n", ret);
729 * We'll need this info later when we'll want to unmap everything
730 * (e.g. on shutdown).
732 * We can't trust the remote processor not to change the resource
733 * table, so we must maintain this info independently.
735 mapping->da = rsc->da;
736 mapping->len = rsc->len;
737 list_add_tail(&mapping->node, &rproc->mappings);
739 dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
740 rsc->pa, rsc->da, rsc->len);
750 * rproc_alloc_carveout() - allocated specified carveout
751 * @rproc: rproc handle
752 * @mem: the memory entry to allocate
754 * This function allocate specified memory entry @mem using
755 * dma_alloc_coherent() as default allocator
757 static int rproc_alloc_carveout(struct rproc *rproc,
758 struct rproc_mem_entry *mem)
760 struct rproc_mem_entry *mapping = NULL;
761 struct device *dev = &rproc->dev;
766 va = dma_alloc_coherent(dev->parent, mem->len, &dma, GFP_KERNEL);
769 "failed to allocate dma memory: len 0x%zx\n",
774 dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%zx\n",
777 if (mem->da != FW_RSC_ADDR_ANY && !rproc->domain) {
779 * Check requested da is equal to dma address
780 * and print a warn message in case of missalignment.
781 * Don't stop rproc_start sequence as coprocessor may
782 * build pa to da translation on its side.
784 if (mem->da != (u32)dma)
785 dev_warn(dev->parent,
786 "Allocated carveout doesn't fit device address request\n");
790 * Ok, this is non-standard.
792 * Sometimes we can't rely on the generic iommu-based DMA API
793 * to dynamically allocate the device address and then set the IOMMU
794 * tables accordingly, because some remote processors might
795 * _require_ us to use hard coded device addresses that their
796 * firmware was compiled with.
798 * In this case, we must use the IOMMU API directly and map
799 * the memory to the device address as expected by the remote
802 * Obviously such remote processor devices should not be configured
803 * to use the iommu-based DMA API: we expect 'dma' to contain the
804 * physical address in this case.
806 if (mem->da != FW_RSC_ADDR_ANY && rproc->domain) {
807 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
813 ret = iommu_map(rproc->domain, mem->da, dma, mem->len,
816 dev_err(dev, "iommu_map failed: %d\n", ret);
821 * We'll need this info later when we'll want to unmap
822 * everything (e.g. on shutdown).
824 * We can't trust the remote processor not to change the
825 * resource table, so we must maintain this info independently.
827 mapping->da = mem->da;
828 mapping->len = mem->len;
829 list_add_tail(&mapping->node, &rproc->mappings);
831 dev_dbg(dev, "carveout mapped 0x%x to %pad\n",
835 if (mem->da == FW_RSC_ADDR_ANY) {
836 /* Update device address as undefined by requester */
837 if ((u64)dma & HIGH_BITS_MASK)
838 dev_warn(dev, "DMA address cast in 32bit to fit resource table format\n");
851 dma_free_coherent(dev->parent, mem->len, va, dma);
856 * rproc_release_carveout() - release acquired carveout
857 * @rproc: rproc handle
858 * @mem: the memory entry to release
860 * This function releases specified memory entry @mem allocated via
861 * rproc_alloc_carveout() function by @rproc.
863 static int rproc_release_carveout(struct rproc *rproc,
864 struct rproc_mem_entry *mem)
866 struct device *dev = &rproc->dev;
868 /* clean up carveout allocations */
869 dma_free_coherent(dev->parent, mem->len, mem->va, mem->dma);
874 * rproc_handle_carveout() - handle phys contig memory allocation requests
875 * @rproc: rproc handle
876 * @rsc: the resource entry
877 * @offset: offset of the resource entry
878 * @avail: size of available data (for image validation)
880 * This function will handle firmware requests for allocation of physically
881 * contiguous memory regions.
883 * These request entries should come first in the firmware's resource table,
884 * as other firmware entries might request placing other data objects inside
885 * these memory regions (e.g. data/code segments, trace resource entries, ...).
887 * Allocating memory this way helps utilizing the reserved physical memory
888 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
889 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
890 * pressure is important; it may have a substantial impact on performance.
892 static int rproc_handle_carveout(struct rproc *rproc,
893 struct fw_rsc_carveout *rsc,
894 int offset, int avail)
896 struct rproc_mem_entry *carveout;
897 struct device *dev = &rproc->dev;
899 if (sizeof(*rsc) > avail) {
900 dev_err(dev, "carveout rsc is truncated\n");
904 /* make sure reserved bytes are zeroes */
906 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
910 dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
911 rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
914 * Check carveout rsc already part of a registered carveout,
915 * Search by name, then check the da and length
917 carveout = rproc_find_carveout_by_name(rproc, rsc->name);
920 if (carveout->rsc_offset != FW_RSC_ADDR_ANY) {
922 "Carveout already associated to resource table\n");
926 if (rproc_check_carveout_da(rproc, carveout, rsc->da, rsc->len))
929 /* Update memory carveout with resource table info */
930 carveout->rsc_offset = offset;
931 carveout->flags = rsc->flags;
936 /* Register carveout in in list */
937 carveout = rproc_mem_entry_init(dev, NULL, 0, rsc->len, rsc->da,
938 rproc_alloc_carveout,
939 rproc_release_carveout, rsc->name);
941 dev_err(dev, "Can't allocate memory entry structure\n");
945 carveout->flags = rsc->flags;
946 carveout->rsc_offset = offset;
947 rproc_add_carveout(rproc, carveout);
953 * rproc_add_carveout() - register an allocated carveout region
954 * @rproc: rproc handle
955 * @mem: memory entry to register
957 * This function registers specified memory entry in @rproc carveouts list.
958 * Specified carveout should have been allocated before registering.
960 void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem)
962 list_add_tail(&mem->node, &rproc->carveouts);
964 EXPORT_SYMBOL(rproc_add_carveout);
967 * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct
968 * @dev: pointer on device struct
969 * @va: virtual address
971 * @len: memory carveout length
972 * @da: device address
973 * @alloc: memory carveout allocation function
974 * @release: memory carveout release function
975 * @name: carveout name
977 * This function allocates a rproc_mem_entry struct and fill it with parameters
978 * provided by client.
981 struct rproc_mem_entry *
982 rproc_mem_entry_init(struct device *dev,
983 void *va, dma_addr_t dma, size_t len, u32 da,
984 int (*alloc)(struct rproc *, struct rproc_mem_entry *),
985 int (*release)(struct rproc *, struct rproc_mem_entry *),
986 const char *name, ...)
988 struct rproc_mem_entry *mem;
991 mem = kzalloc(sizeof(*mem), GFP_KERNEL);
1000 mem->release = release;
1001 mem->rsc_offset = FW_RSC_ADDR_ANY;
1002 mem->of_resm_idx = -1;
1004 va_start(args, name);
1005 vsnprintf(mem->name, sizeof(mem->name), name, args);
1010 EXPORT_SYMBOL(rproc_mem_entry_init);
1013 * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct
1014 * from a reserved memory phandle
1015 * @dev: pointer on device struct
1016 * @of_resm_idx: reserved memory phandle index in "memory-region"
1017 * @len: memory carveout length
1018 * @da: device address
1019 * @name: carveout name
1021 * This function allocates a rproc_mem_entry struct and fill it with parameters
1022 * provided by client.
1025 struct rproc_mem_entry *
1026 rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, size_t len,
1027 u32 da, const char *name, ...)
1029 struct rproc_mem_entry *mem;
1032 mem = kzalloc(sizeof(*mem), GFP_KERNEL);
1038 mem->rsc_offset = FW_RSC_ADDR_ANY;
1039 mem->of_resm_idx = of_resm_idx;
1041 va_start(args, name);
1042 vsnprintf(mem->name, sizeof(mem->name), name, args);
1047 EXPORT_SYMBOL(rproc_of_resm_mem_entry_init);
1050 * rproc_of_parse_firmware() - parse and return the firmware-name
1051 * @dev: pointer on device struct representing a rproc
1052 * @index: index to use for the firmware-name retrieval
1053 * @fw_name: pointer to a character string, in which the firmware
1054 * name is returned on success and unmodified otherwise.
1056 * This is an OF helper function that parses a device's DT node for
1057 * the "firmware-name" property and returns the firmware name pointer
1058 * in @fw_name on success.
1060 * Return: 0 on success, or an appropriate failure.
1062 int rproc_of_parse_firmware(struct device *dev, int index, const char **fw_name)
1066 ret = of_property_read_string_index(dev->of_node, "firmware-name",
1068 return ret ? ret : 0;
1070 EXPORT_SYMBOL(rproc_of_parse_firmware);
1073 * A lookup table for resource handlers. The indices are defined in
1074 * enum fw_resource_type.
1076 static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
1077 [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
1078 [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
1079 [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
1080 [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
1083 /* handle firmware resource entries before booting the remote processor */
1084 static int rproc_handle_resources(struct rproc *rproc,
1085 rproc_handle_resource_t handlers[RSC_LAST])
1087 struct device *dev = &rproc->dev;
1088 rproc_handle_resource_t handler;
1091 if (!rproc->table_ptr)
1094 for (i = 0; i < rproc->table_ptr->num; i++) {
1095 int offset = rproc->table_ptr->offset[i];
1096 struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
1097 int avail = rproc->table_sz - offset - sizeof(*hdr);
1098 void *rsc = (void *)hdr + sizeof(*hdr);
1100 /* make sure table isn't truncated */
1102 dev_err(dev, "rsc table is truncated\n");
1106 dev_dbg(dev, "rsc: type %d\n", hdr->type);
1108 if (hdr->type >= RSC_VENDOR_START &&
1109 hdr->type <= RSC_VENDOR_END) {
1110 ret = rproc_handle_rsc(rproc, hdr->type, rsc,
1111 offset + sizeof(*hdr), avail);
1112 if (ret == RSC_HANDLED)
1117 dev_warn(dev, "unsupported vendor resource %d\n",
1122 if (hdr->type >= RSC_LAST) {
1123 dev_warn(dev, "unsupported resource %d\n", hdr->type);
1127 handler = handlers[hdr->type];
1131 ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
1139 static int rproc_prepare_subdevices(struct rproc *rproc)
1141 struct rproc_subdev *subdev;
1144 list_for_each_entry(subdev, &rproc->subdevs, node) {
1145 if (subdev->prepare) {
1146 ret = subdev->prepare(subdev);
1148 goto unroll_preparation;
1155 list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) {
1156 if (subdev->unprepare)
1157 subdev->unprepare(subdev);
1163 static int rproc_start_subdevices(struct rproc *rproc)
1165 struct rproc_subdev *subdev;
1168 list_for_each_entry(subdev, &rproc->subdevs, node) {
1169 if (subdev->start) {
1170 ret = subdev->start(subdev);
1172 goto unroll_registration;
1178 unroll_registration:
1179 list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) {
1181 subdev->stop(subdev, true);
1187 static void rproc_stop_subdevices(struct rproc *rproc, bool crashed)
1189 struct rproc_subdev *subdev;
1191 list_for_each_entry_reverse(subdev, &rproc->subdevs, node) {
1193 subdev->stop(subdev, crashed);
1197 static void rproc_unprepare_subdevices(struct rproc *rproc)
1199 struct rproc_subdev *subdev;
1201 list_for_each_entry_reverse(subdev, &rproc->subdevs, node) {
1202 if (subdev->unprepare)
1203 subdev->unprepare(subdev);
1208 * rproc_alloc_registered_carveouts() - allocate all carveouts registered
1210 * @rproc: the remote processor handle
1212 * This function parses registered carveout list, performs allocation
1213 * if alloc() ops registered and updates resource table information
1214 * if rsc_offset set.
1216 * Return: 0 on success
1218 static int rproc_alloc_registered_carveouts(struct rproc *rproc)
1220 struct rproc_mem_entry *entry, *tmp;
1221 struct fw_rsc_carveout *rsc;
1222 struct device *dev = &rproc->dev;
1226 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
1228 ret = entry->alloc(rproc, entry);
1230 dev_err(dev, "Unable to allocate carveout %s: %d\n",
1236 if (entry->rsc_offset != FW_RSC_ADDR_ANY) {
1237 /* update resource table */
1238 rsc = (void *)rproc->table_ptr + entry->rsc_offset;
1241 * Some remote processors might need to know the pa
1242 * even though they are behind an IOMMU. E.g., OMAP4's
1243 * remote M3 processor needs this so it can control
1244 * on-chip hardware accelerators that are not behind
1245 * the IOMMU, and therefor must know the pa.
1247 * Generally we don't want to expose physical addresses
1248 * if we don't have to (remote processors are generally
1249 * _not_ trusted), so we might want to do this only for
1250 * remote processor that _must_ have this (e.g. OMAP4's
1251 * dual M3 subsystem).
1253 * Non-IOMMU processors might also want to have this info.
1254 * In this case, the device address and the physical address
1258 /* Use va if defined else dma to generate pa */
1260 pa = (u64)rproc_va_to_pa(entry->va);
1262 pa = (u64)entry->dma;
1264 if (((u64)pa) & HIGH_BITS_MASK)
1266 "Physical address cast in 32bit to fit resource table format\n");
1269 rsc->da = entry->da;
1270 rsc->len = entry->len;
1279 * rproc_resource_cleanup() - clean up and free all acquired resources
1280 * @rproc: rproc handle
1282 * This function will free all resources acquired for @rproc, and it
1283 * is called whenever @rproc either shuts down or fails to boot.
1285 void rproc_resource_cleanup(struct rproc *rproc)
1287 struct rproc_mem_entry *entry, *tmp;
1288 struct rproc_debug_trace *trace, *ttmp;
1289 struct rproc_vdev *rvdev, *rvtmp;
1290 struct device *dev = &rproc->dev;
1292 /* clean up debugfs trace entries */
1293 list_for_each_entry_safe(trace, ttmp, &rproc->traces, node) {
1294 rproc_remove_trace_file(trace->tfile);
1295 rproc->num_traces--;
1296 list_del(&trace->node);
1300 /* clean up iommu mapping entries */
1301 list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
1304 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
1305 if (unmapped != entry->len) {
1306 /* nothing much to do besides complaining */
1307 dev_err(dev, "failed to unmap %zx/%zu\n", entry->len,
1311 list_del(&entry->node);
1315 /* clean up carveout allocations */
1316 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
1318 entry->release(rproc, entry);
1319 list_del(&entry->node);
1323 /* clean up remote vdev entries */
1324 list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
1325 kref_put(&rvdev->refcount, rproc_vdev_release);
1327 rproc_coredump_cleanup(rproc);
1329 EXPORT_SYMBOL(rproc_resource_cleanup);
1331 static int rproc_start(struct rproc *rproc, const struct firmware *fw)
1333 struct resource_table *loaded_table;
1334 struct device *dev = &rproc->dev;
1337 /* load the ELF segments to memory */
1338 ret = rproc_load_segments(rproc, fw);
1340 dev_err(dev, "Failed to load program segments: %d\n", ret);
1345 * The starting device has been given the rproc->cached_table as the
1346 * resource table. The address of the vring along with the other
1347 * allocated resources (carveouts etc) is stored in cached_table.
1348 * In order to pass this information to the remote device we must copy
1349 * this information to device memory. We also update the table_ptr so
1350 * that any subsequent changes will be applied to the loaded version.
1352 loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
1354 memcpy(loaded_table, rproc->cached_table, rproc->table_sz);
1355 rproc->table_ptr = loaded_table;
1358 ret = rproc_prepare_subdevices(rproc);
1360 dev_err(dev, "failed to prepare subdevices for %s: %d\n",
1362 goto reset_table_ptr;
1365 /* power up the remote processor */
1366 ret = rproc->ops->start(rproc);
1368 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
1369 goto unprepare_subdevices;
1372 /* Start any subdevices for the remote processor */
1373 ret = rproc_start_subdevices(rproc);
1375 dev_err(dev, "failed to probe subdevices for %s: %d\n",
1380 rproc->state = RPROC_RUNNING;
1382 dev_info(dev, "remote processor %s is now up\n", rproc->name);
1387 rproc->ops->stop(rproc);
1388 unprepare_subdevices:
1389 rproc_unprepare_subdevices(rproc);
1391 rproc->table_ptr = rproc->cached_table;
1396 static int rproc_attach(struct rproc *rproc)
1398 struct device *dev = &rproc->dev;
1401 ret = rproc_prepare_subdevices(rproc);
1403 dev_err(dev, "failed to prepare subdevices for %s: %d\n",
1408 /* Attach to the remote processor */
1409 ret = rproc_attach_device(rproc);
1411 dev_err(dev, "can't attach to rproc %s: %d\n",
1413 goto unprepare_subdevices;
1416 /* Start any subdevices for the remote processor */
1417 ret = rproc_start_subdevices(rproc);
1419 dev_err(dev, "failed to probe subdevices for %s: %d\n",
1424 rproc->state = RPROC_RUNNING;
1426 dev_info(dev, "remote processor %s is now attached\n", rproc->name);
1431 rproc->ops->stop(rproc);
1432 unprepare_subdevices:
1433 rproc_unprepare_subdevices(rproc);
1439 * take a firmware and boot a remote processor with it.
1441 static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
1443 struct device *dev = &rproc->dev;
1444 const char *name = rproc->firmware;
1447 ret = rproc_fw_sanity_check(rproc, fw);
1451 dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
1454 * if enabling an IOMMU isn't relevant for this rproc, this is
1457 ret = rproc_enable_iommu(rproc);
1459 dev_err(dev, "can't enable iommu: %d\n", ret);
1463 /* Prepare rproc for firmware loading if needed */
1464 ret = rproc_prepare_device(rproc);
1466 dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret);
1470 rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
1472 /* Load resource table, core dump segment list etc from the firmware */
1473 ret = rproc_parse_fw(rproc, fw);
1475 goto unprepare_rproc;
1477 /* reset max_notifyid */
1478 rproc->max_notifyid = -1;
1480 /* reset handled vdev */
1483 /* handle fw resources which are required to boot rproc */
1484 ret = rproc_handle_resources(rproc, rproc_loading_handlers);
1486 dev_err(dev, "Failed to process resources: %d\n", ret);
1487 goto clean_up_resources;
1490 /* Allocate carveout resources associated to rproc */
1491 ret = rproc_alloc_registered_carveouts(rproc);
1493 dev_err(dev, "Failed to allocate associated carveouts: %d\n",
1495 goto clean_up_resources;
1498 ret = rproc_start(rproc, fw);
1500 goto clean_up_resources;
1505 rproc_resource_cleanup(rproc);
1506 kfree(rproc->cached_table);
1507 rproc->cached_table = NULL;
1508 rproc->table_ptr = NULL;
1510 /* release HW resources if needed */
1511 rproc_unprepare_device(rproc);
1513 rproc_disable_iommu(rproc);
1518 * Attach to remote processor - similar to rproc_fw_boot() but without
1519 * the steps that deal with the firmware image.
1521 static int rproc_actuate(struct rproc *rproc)
1523 struct device *dev = &rproc->dev;
1527 * if enabling an IOMMU isn't relevant for this rproc, this is
1530 ret = rproc_enable_iommu(rproc);
1532 dev_err(dev, "can't enable iommu: %d\n", ret);
1536 /* reset max_notifyid */
1537 rproc->max_notifyid = -1;
1539 /* reset handled vdev */
1543 * Handle firmware resources required to attach to a remote processor.
1544 * Because we are attaching rather than booting the remote processor,
1545 * we expect the platform driver to properly set rproc->table_ptr.
1547 ret = rproc_handle_resources(rproc, rproc_loading_handlers);
1549 dev_err(dev, "Failed to process resources: %d\n", ret);
1553 /* Allocate carveout resources associated to rproc */
1554 ret = rproc_alloc_registered_carveouts(rproc);
1556 dev_err(dev, "Failed to allocate associated carveouts: %d\n",
1558 goto clean_up_resources;
1561 ret = rproc_attach(rproc);
1563 goto clean_up_resources;
1568 rproc_resource_cleanup(rproc);
1570 rproc_disable_iommu(rproc);
1575 * take a firmware and boot it up.
1577 * Note: this function is called asynchronously upon registration of the
1578 * remote processor (so we must wait until it completes before we try
1579 * to unregister the device. one other option is just to use kref here,
1580 * that might be cleaner).
1582 static void rproc_auto_boot_callback(const struct firmware *fw, void *context)
1584 struct rproc *rproc = context;
1588 release_firmware(fw);
1591 static int rproc_trigger_auto_boot(struct rproc *rproc)
1596 * Since the remote processor is in a detached state, it has already
1597 * been booted by another entity. As such there is no point in waiting
1598 * for a firmware image to be loaded, we can simply initiate the process
1599 * of attaching to it immediately.
1601 if (rproc->state == RPROC_DETACHED)
1602 return rproc_boot(rproc);
1605 * We're initiating an asynchronous firmware loading, so we can
1606 * be built-in kernel code, without hanging the boot process.
1608 ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
1609 rproc->firmware, &rproc->dev, GFP_KERNEL,
1610 rproc, rproc_auto_boot_callback);
1612 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
1617 static int rproc_stop(struct rproc *rproc, bool crashed)
1619 struct device *dev = &rproc->dev;
1622 /* Stop any subdevices for the remote processor */
1623 rproc_stop_subdevices(rproc, crashed);
1625 /* the installed resource table is no longer accessible */
1626 rproc->table_ptr = rproc->cached_table;
1628 /* power off the remote processor */
1629 ret = rproc->ops->stop(rproc);
1631 dev_err(dev, "can't stop rproc: %d\n", ret);
1635 rproc_unprepare_subdevices(rproc);
1637 rproc->state = RPROC_OFFLINE;
1640 * The remote processor has been stopped and is now offline, which means
1641 * that the next time it is brought back online the remoteproc core will
1642 * be responsible to load its firmware. As such it is no longer
1645 rproc->autonomous = false;
1647 dev_info(dev, "stopped remote processor %s\n", rproc->name);
1654 * rproc_trigger_recovery() - recover a remoteproc
1655 * @rproc: the remote processor
1657 * The recovery is done by resetting all the virtio devices, that way all the
1658 * rpmsg drivers will be reseted along with the remote processor making the
1659 * remoteproc functional again.
1661 * This function can sleep, so it cannot be called from atomic context.
1663 int rproc_trigger_recovery(struct rproc *rproc)
1665 const struct firmware *firmware_p;
1666 struct device *dev = &rproc->dev;
1669 ret = mutex_lock_interruptible(&rproc->lock);
1673 /* State could have changed before we got the mutex */
1674 if (rproc->state != RPROC_CRASHED)
1677 dev_err(dev, "recovering %s\n", rproc->name);
1679 ret = rproc_stop(rproc, true);
1683 /* generate coredump */
1684 rproc_coredump(rproc);
1687 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1689 dev_err(dev, "request_firmware failed: %d\n", ret);
1693 /* boot the remote processor up again */
1694 ret = rproc_start(rproc, firmware_p);
1696 release_firmware(firmware_p);
1699 mutex_unlock(&rproc->lock);
1704 * rproc_crash_handler_work() - handle a crash
1705 * @work: work treating the crash
1707 * This function needs to handle everything related to a crash, like cpu
1708 * registers and stack dump, information to help to debug the fatal error, etc.
1710 static void rproc_crash_handler_work(struct work_struct *work)
1712 struct rproc *rproc = container_of(work, struct rproc, crash_handler);
1713 struct device *dev = &rproc->dev;
1715 dev_dbg(dev, "enter %s\n", __func__);
1717 mutex_lock(&rproc->lock);
1719 if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
1720 /* handle only the first crash detected */
1721 mutex_unlock(&rproc->lock);
1725 rproc->state = RPROC_CRASHED;
1726 dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
1729 mutex_unlock(&rproc->lock);
1731 if (!rproc->recovery_disabled)
1732 rproc_trigger_recovery(rproc);
1734 pm_relax(rproc->dev.parent);
1738 * rproc_boot() - boot a remote processor
1739 * @rproc: handle of a remote processor
1741 * Boot a remote processor (i.e. load its firmware, power it on, ...).
1743 * If the remote processor is already powered on, this function immediately
1744 * returns (successfully).
1746 * Returns 0 on success, and an appropriate error value otherwise.
1748 int rproc_boot(struct rproc *rproc)
1750 const struct firmware *firmware_p;
1755 pr_err("invalid rproc handle\n");
1761 ret = mutex_lock_interruptible(&rproc->lock);
1763 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1767 if (rproc->state == RPROC_DELETED) {
1769 dev_err(dev, "can't boot deleted rproc %s\n", rproc->name);
1773 /* skip the boot or attach process if rproc is already powered up */
1774 if (atomic_inc_return(&rproc->power) > 1) {
1779 if (rproc->state == RPROC_DETACHED) {
1780 dev_info(dev, "attaching to %s\n", rproc->name);
1782 ret = rproc_actuate(rproc);
1784 dev_info(dev, "powering up %s\n", rproc->name);
1787 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1789 dev_err(dev, "request_firmware failed: %d\n", ret);
1793 ret = rproc_fw_boot(rproc, firmware_p);
1795 release_firmware(firmware_p);
1800 atomic_dec(&rproc->power);
1802 mutex_unlock(&rproc->lock);
1805 EXPORT_SYMBOL(rproc_boot);
1808 * rproc_shutdown() - power off the remote processor
1809 * @rproc: the remote processor
1811 * Power off a remote processor (previously booted with rproc_boot()).
1813 * In case @rproc is still being used by an additional user(s), then
1814 * this function will just decrement the power refcount and exit,
1815 * without really powering off the device.
1817 * Every call to rproc_boot() must (eventually) be accompanied by a call
1818 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1821 * - we're not decrementing the rproc's refcount, only the power refcount.
1822 * which means that the @rproc handle stays valid even after rproc_shutdown()
1823 * returns, and users can still use it with a subsequent rproc_boot(), if
1826 void rproc_shutdown(struct rproc *rproc)
1828 struct device *dev = &rproc->dev;
1831 ret = mutex_lock_interruptible(&rproc->lock);
1833 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1837 /* if the remote proc is still needed, bail out */
1838 if (!atomic_dec_and_test(&rproc->power))
1841 ret = rproc_stop(rproc, false);
1843 atomic_inc(&rproc->power);
1847 /* clean up all acquired resources */
1848 rproc_resource_cleanup(rproc);
1850 /* release HW resources if needed */
1851 rproc_unprepare_device(rproc);
1853 rproc_disable_iommu(rproc);
1855 /* Free the copy of the resource table */
1856 kfree(rproc->cached_table);
1857 rproc->cached_table = NULL;
1858 rproc->table_ptr = NULL;
1860 mutex_unlock(&rproc->lock);
1862 EXPORT_SYMBOL(rproc_shutdown);
1865 * rproc_get_by_phandle() - find a remote processor by phandle
1866 * @phandle: phandle to the rproc
1868 * Finds an rproc handle using the remote processor's phandle, and then
1869 * return a handle to the rproc.
1871 * This function increments the remote processor's refcount, so always
1872 * use rproc_put() to decrement it back once rproc isn't needed anymore.
1874 * Returns the rproc handle on success, and NULL on failure.
1877 struct rproc *rproc_get_by_phandle(phandle phandle)
1879 struct rproc *rproc = NULL, *r;
1880 struct device_node *np;
1882 np = of_find_node_by_phandle(phandle);
1887 list_for_each_entry_rcu(r, &rproc_list, node) {
1888 if (r->dev.parent && r->dev.parent->of_node == np) {
1889 /* prevent underlying implementation from being removed */
1890 if (!try_module_get(r->dev.parent->driver->owner)) {
1891 dev_err(&r->dev, "can't get owner\n");
1896 get_device(&rproc->dev);
1907 struct rproc *rproc_get_by_phandle(phandle phandle)
1912 EXPORT_SYMBOL(rproc_get_by_phandle);
1914 static int rproc_validate(struct rproc *rproc)
1916 switch (rproc->state) {
1919 * An offline processor without a start()
1920 * function makes no sense.
1922 if (!rproc->ops->start)
1925 case RPROC_DETACHED:
1927 * A remote processor in a detached state without an
1928 * attach() function makes not sense.
1930 if (!rproc->ops->attach)
1933 * When attaching to a remote processor the device memory
1934 * is already available and as such there is no need to have a
1937 if (rproc->cached_table)
1942 * When adding a remote processor, the state of the device
1943 * can be offline or detached, nothing else.
1952 * rproc_add() - register a remote processor
1953 * @rproc: the remote processor handle to register
1955 * Registers @rproc with the remoteproc framework, after it has been
1956 * allocated with rproc_alloc().
1958 * This is called by the platform-specific rproc implementation, whenever
1959 * a new remote processor device is probed.
1961 * Returns 0 on success and an appropriate error code otherwise.
1963 * Note: this function initiates an asynchronous firmware loading
1964 * context, which will look for virtio devices supported by the rproc's
1967 * If found, those virtio devices will be created and added, so as a result
1968 * of registering this remote processor, additional virtio drivers might be
1971 int rproc_add(struct rproc *rproc)
1973 struct device *dev = &rproc->dev;
1976 ret = device_add(dev);
1980 ret = rproc_validate(rproc);
1984 dev_info(dev, "%s is available\n", rproc->name);
1986 /* create debugfs entries */
1987 rproc_create_debug_dir(rproc);
1989 /* add char device for this remoteproc */
1990 ret = rproc_char_device_add(rproc);
1995 * Remind ourselves the remote processor has been attached to rather
1996 * than booted by the remoteproc core. This is important because the
1997 * RPROC_DETACHED state will be lost as soon as the remote processor
1998 * has been attached to. Used in firmware_show() and reset in
2001 if (rproc->state == RPROC_DETACHED)
2002 rproc->autonomous = true;
2004 /* if rproc is marked always-on, request it to boot */
2005 if (rproc->auto_boot) {
2006 ret = rproc_trigger_auto_boot(rproc);
2011 /* expose to rproc_get_by_phandle users */
2012 mutex_lock(&rproc_list_mutex);
2013 list_add_rcu(&rproc->node, &rproc_list);
2014 mutex_unlock(&rproc_list_mutex);
2018 EXPORT_SYMBOL(rproc_add);
2020 static void devm_rproc_remove(void *rproc)
2026 * devm_rproc_add() - resource managed rproc_add()
2027 * @dev: the underlying device
2028 * @rproc: the remote processor handle to register
2030 * This function performs like rproc_add() but the registered rproc device will
2031 * automatically be removed on driver detach.
2033 * Returns: 0 on success, negative errno on failure
2035 int devm_rproc_add(struct device *dev, struct rproc *rproc)
2039 err = rproc_add(rproc);
2043 return devm_add_action_or_reset(dev, devm_rproc_remove, rproc);
2045 EXPORT_SYMBOL(devm_rproc_add);
2048 * rproc_type_release() - release a remote processor instance
2049 * @dev: the rproc's device
2051 * This function should _never_ be called directly.
2053 * It will be called by the driver core when no one holds a valid pointer
2056 static void rproc_type_release(struct device *dev)
2058 struct rproc *rproc = container_of(dev, struct rproc, dev);
2060 dev_info(&rproc->dev, "releasing %s\n", rproc->name);
2062 idr_destroy(&rproc->notifyids);
2064 if (rproc->index >= 0)
2065 ida_simple_remove(&rproc_dev_index, rproc->index);
2067 kfree_const(rproc->firmware);
2068 kfree_const(rproc->name);
2073 static const struct device_type rproc_type = {
2074 .name = "remoteproc",
2075 .release = rproc_type_release,
2078 static int rproc_alloc_firmware(struct rproc *rproc,
2079 const char *name, const char *firmware)
2084 * Allocate a firmware name if the caller gave us one to work
2085 * with. Otherwise construct a new one using a default pattern.
2088 p = kstrdup_const(firmware, GFP_KERNEL);
2090 p = kasprintf(GFP_KERNEL, "rproc-%s-fw", name);
2095 rproc->firmware = p;
2100 static int rproc_alloc_ops(struct rproc *rproc, const struct rproc_ops *ops)
2102 rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL);
2106 if (rproc->ops->load)
2109 /* Default to ELF loader if no load function is specified */
2110 rproc->ops->load = rproc_elf_load_segments;
2111 rproc->ops->parse_fw = rproc_elf_load_rsc_table;
2112 rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table;
2113 rproc->ops->sanity_check = rproc_elf_sanity_check;
2114 rproc->ops->get_boot_addr = rproc_elf_get_boot_addr;
2120 * rproc_alloc() - allocate a remote processor handle
2121 * @dev: the underlying device
2122 * @name: name of this remote processor
2123 * @ops: platform-specific handlers (mainly start/stop)
2124 * @firmware: name of firmware file to load, can be NULL
2125 * @len: length of private data needed by the rproc driver (in bytes)
2127 * Allocates a new remote processor handle, but does not register
2128 * it yet. if @firmware is NULL, a default name is used.
2130 * This function should be used by rproc implementations during initialization
2131 * of the remote processor.
2133 * After creating an rproc handle using this function, and when ready,
2134 * implementations should then call rproc_add() to complete
2135 * the registration of the remote processor.
2137 * On success the new rproc is returned, and on failure, NULL.
2139 * Note: _never_ directly deallocate @rproc, even if it was not registered
2140 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
2142 struct rproc *rproc_alloc(struct device *dev, const char *name,
2143 const struct rproc_ops *ops,
2144 const char *firmware, int len)
2146 struct rproc *rproc;
2148 if (!dev || !name || !ops)
2151 rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
2155 rproc->priv = &rproc[1];
2156 rproc->auto_boot = true;
2157 rproc->elf_class = ELFCLASSNONE;
2158 rproc->elf_machine = EM_NONE;
2160 device_initialize(&rproc->dev);
2161 rproc->dev.parent = dev;
2162 rproc->dev.type = &rproc_type;
2163 rproc->dev.class = &rproc_class;
2164 rproc->dev.driver_data = rproc;
2165 idr_init(&rproc->notifyids);
2167 rproc->name = kstrdup_const(name, GFP_KERNEL);
2171 if (rproc_alloc_firmware(rproc, name, firmware))
2174 if (rproc_alloc_ops(rproc, ops))
2177 /* Assign a unique device index and name */
2178 rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
2179 if (rproc->index < 0) {
2180 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
2184 dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
2186 atomic_set(&rproc->power, 0);
2188 mutex_init(&rproc->lock);
2190 INIT_LIST_HEAD(&rproc->carveouts);
2191 INIT_LIST_HEAD(&rproc->mappings);
2192 INIT_LIST_HEAD(&rproc->traces);
2193 INIT_LIST_HEAD(&rproc->rvdevs);
2194 INIT_LIST_HEAD(&rproc->subdevs);
2195 INIT_LIST_HEAD(&rproc->dump_segments);
2197 INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
2199 rproc->state = RPROC_OFFLINE;
2204 put_device(&rproc->dev);
2207 EXPORT_SYMBOL(rproc_alloc);
2210 * rproc_free() - unroll rproc_alloc()
2211 * @rproc: the remote processor handle
2213 * This function decrements the rproc dev refcount.
2215 * If no one holds any reference to rproc anymore, then its refcount would
2216 * now drop to zero, and it would be freed.
2218 void rproc_free(struct rproc *rproc)
2220 put_device(&rproc->dev);
2222 EXPORT_SYMBOL(rproc_free);
2225 * rproc_put() - release rproc reference
2226 * @rproc: the remote processor handle
2228 * This function decrements the rproc dev refcount.
2230 * If no one holds any reference to rproc anymore, then its refcount would
2231 * now drop to zero, and it would be freed.
2233 void rproc_put(struct rproc *rproc)
2235 module_put(rproc->dev.parent->driver->owner);
2236 put_device(&rproc->dev);
2238 EXPORT_SYMBOL(rproc_put);
2241 * rproc_del() - unregister a remote processor
2242 * @rproc: rproc handle to unregister
2244 * This function should be called when the platform specific rproc
2245 * implementation decides to remove the rproc device. it should
2246 * _only_ be called if a previous invocation of rproc_add()
2247 * has completed successfully.
2249 * After rproc_del() returns, @rproc isn't freed yet, because
2250 * of the outstanding reference created by rproc_alloc. To decrement that
2251 * one last refcount, one still needs to call rproc_free().
2253 * Returns 0 on success and -EINVAL if @rproc isn't valid.
2255 int rproc_del(struct rproc *rproc)
2260 /* if rproc is marked always-on, rproc_add() booted it */
2261 /* TODO: make sure this works with rproc->power > 1 */
2262 if (rproc->auto_boot)
2263 rproc_shutdown(rproc);
2265 mutex_lock(&rproc->lock);
2266 rproc->state = RPROC_DELETED;
2267 mutex_unlock(&rproc->lock);
2269 rproc_delete_debug_dir(rproc);
2270 rproc_char_device_remove(rproc);
2272 /* the rproc is downref'ed as soon as it's removed from the klist */
2273 mutex_lock(&rproc_list_mutex);
2274 list_del_rcu(&rproc->node);
2275 mutex_unlock(&rproc_list_mutex);
2277 /* Ensure that no readers of rproc_list are still active */
2280 device_del(&rproc->dev);
2284 EXPORT_SYMBOL(rproc_del);
2286 static void devm_rproc_free(struct device *dev, void *res)
2288 rproc_free(*(struct rproc **)res);
2292 * devm_rproc_alloc() - resource managed rproc_alloc()
2293 * @dev: the underlying device
2294 * @name: name of this remote processor
2295 * @ops: platform-specific handlers (mainly start/stop)
2296 * @firmware: name of firmware file to load, can be NULL
2297 * @len: length of private data needed by the rproc driver (in bytes)
2299 * This function performs like rproc_alloc() but the acquired rproc device will
2300 * automatically be released on driver detach.
2302 * Returns: new rproc instance, or NULL on failure
2304 struct rproc *devm_rproc_alloc(struct device *dev, const char *name,
2305 const struct rproc_ops *ops,
2306 const char *firmware, int len)
2308 struct rproc **ptr, *rproc;
2310 ptr = devres_alloc(devm_rproc_free, sizeof(*ptr), GFP_KERNEL);
2314 rproc = rproc_alloc(dev, name, ops, firmware, len);
2317 devres_add(dev, ptr);
2324 EXPORT_SYMBOL(devm_rproc_alloc);
2327 * rproc_add_subdev() - add a subdevice to a remoteproc
2328 * @rproc: rproc handle to add the subdevice to
2329 * @subdev: subdev handle to register
2331 * Caller is responsible for populating optional subdevice function pointers.
2333 void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
2335 list_add_tail(&subdev->node, &rproc->subdevs);
2337 EXPORT_SYMBOL(rproc_add_subdev);
2340 * rproc_remove_subdev() - remove a subdevice from a remoteproc
2341 * @rproc: rproc handle to remove the subdevice from
2342 * @subdev: subdev handle, previously registered with rproc_add_subdev()
2344 void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
2346 list_del(&subdev->node);
2348 EXPORT_SYMBOL(rproc_remove_subdev);
2351 * rproc_get_by_child() - acquire rproc handle of @dev's ancestor
2352 * @dev: child device to find ancestor of
2354 * Returns the ancestor rproc instance, or NULL if not found.
2356 struct rproc *rproc_get_by_child(struct device *dev)
2358 for (dev = dev->parent; dev; dev = dev->parent) {
2359 if (dev->type == &rproc_type)
2360 return dev->driver_data;
2365 EXPORT_SYMBOL(rproc_get_by_child);
2368 * rproc_report_crash() - rproc crash reporter function
2369 * @rproc: remote processor
2372 * This function must be called every time a crash is detected by the low-level
2373 * drivers implementing a specific remoteproc. This should not be called from a
2374 * non-remoteproc driver.
2376 * This function can be called from atomic/interrupt context.
2378 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
2381 pr_err("NULL rproc pointer\n");
2385 /* Prevent suspend while the remoteproc is being recovered */
2386 pm_stay_awake(rproc->dev.parent);
2388 dev_err(&rproc->dev, "crash detected in %s: type %s\n",
2389 rproc->name, rproc_crash_to_string(type));
2391 /* create a new task to handle the error */
2392 schedule_work(&rproc->crash_handler);
2394 EXPORT_SYMBOL(rproc_report_crash);
2396 static int rproc_panic_handler(struct notifier_block *nb, unsigned long event,
2399 unsigned int longest = 0;
2400 struct rproc *rproc;
2404 list_for_each_entry_rcu(rproc, &rproc_list, node) {
2405 if (!rproc->ops->panic || rproc->state != RPROC_RUNNING)
2408 d = rproc->ops->panic(rproc);
2409 longest = max(longest, d);
2414 * Delay for the longest requested duration before returning. This can
2415 * be used by the remoteproc drivers to give the remote processor time
2416 * to perform any requested operations (such as flush caches), when
2417 * it's not possible to signal the Linux side due to the panic.
2424 static void __init rproc_init_panic(void)
2426 rproc_panic_nb.notifier_call = rproc_panic_handler;
2427 atomic_notifier_chain_register(&panic_notifier_list, &rproc_panic_nb);
2430 static void __exit rproc_exit_panic(void)
2432 atomic_notifier_chain_unregister(&panic_notifier_list, &rproc_panic_nb);
2435 static int __init remoteproc_init(void)
2438 rproc_init_debugfs();
2444 subsys_initcall(remoteproc_init);
2446 static void __exit remoteproc_exit(void)
2448 ida_destroy(&rproc_dev_index);
2451 rproc_exit_debugfs();
2454 module_exit(remoteproc_exit);
2456 MODULE_LICENSE("GPL v2");
2457 MODULE_DESCRIPTION("Generic Remote Processor Framework");