2 * Remote Processor Framework
4 * Copyright (C) 2011 Texas Instruments, Inc.
5 * Copyright (C) 2011 Google, Inc.
7 * Ohad Ben-Cohen <ohad@wizery.com>
8 * Brian Swetland <swetland@google.com>
9 * Mark Grosen <mgrosen@ti.com>
10 * Fernando Guzman Lugo <fernando.lugo@ti.com>
11 * Suman Anna <s-anna@ti.com>
12 * Robert Tivy <rtivy@ti.com>
13 * Armando Uribe De Leon <x0095078@ti.com>
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * version 2 as published by the Free Software Foundation.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
25 #define pr_fmt(fmt) "%s: " fmt, __func__
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/device.h>
30 #include <linux/slab.h>
31 #include <linux/mutex.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/firmware.h>
34 #include <linux/string.h>
35 #include <linux/debugfs.h>
36 #include <linux/devcoredump.h>
37 #include <linux/remoteproc.h>
38 #include <linux/iommu.h>
39 #include <linux/idr.h>
40 #include <linux/elf.h>
41 #include <linux/crc32.h>
42 #include <linux/virtio_ids.h>
43 #include <linux/virtio_ring.h>
44 #include <asm/byteorder.h>
46 #include "remoteproc_internal.h"
48 static DEFINE_MUTEX(rproc_list_mutex);
49 static LIST_HEAD(rproc_list);
51 typedef int (*rproc_handle_resources_t)(struct rproc *rproc,
52 struct resource_table *table, int len);
53 typedef int (*rproc_handle_resource_t)(struct rproc *rproc,
54 void *, int offset, int avail);
56 static int rproc_alloc_carveout(struct rproc *rproc,
57 struct rproc_mem_entry *mem);
58 static int rproc_release_carveout(struct rproc *rproc,
59 struct rproc_mem_entry *mem);
61 /* Unique indices for remoteproc devices */
62 static DEFINE_IDA(rproc_dev_index);
64 static const char * const rproc_crash_names[] = {
65 [RPROC_MMUFAULT] = "mmufault",
66 [RPROC_WATCHDOG] = "watchdog",
67 [RPROC_FATAL_ERROR] = "fatal error",
70 /* translate rproc_crash_type to string */
71 static const char *rproc_crash_to_string(enum rproc_crash_type type)
73 if (type < ARRAY_SIZE(rproc_crash_names))
74 return rproc_crash_names[type];
79 * This is the IOMMU fault handler we register with the IOMMU API
80 * (when relevant; not all remote processors access memory through
83 * IOMMU core will invoke this handler whenever the remote processor
84 * will try to access an unmapped device address.
86 static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
87 unsigned long iova, int flags, void *token)
89 struct rproc *rproc = token;
91 dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
93 rproc_report_crash(rproc, RPROC_MMUFAULT);
96 * Let the iommu core know we're not really handling this fault;
97 * we just used it as a recovery trigger.
102 static int rproc_enable_iommu(struct rproc *rproc)
104 struct iommu_domain *domain;
105 struct device *dev = rproc->dev.parent;
108 if (!rproc->has_iommu) {
109 dev_dbg(dev, "iommu not present\n");
113 domain = iommu_domain_alloc(dev->bus);
115 dev_err(dev, "can't alloc iommu domain\n");
119 iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
121 ret = iommu_attach_device(domain, dev);
123 dev_err(dev, "can't attach iommu device: %d\n", ret);
127 rproc->domain = domain;
132 iommu_domain_free(domain);
136 static void rproc_disable_iommu(struct rproc *rproc)
138 struct iommu_domain *domain = rproc->domain;
139 struct device *dev = rproc->dev.parent;
144 iommu_detach_device(domain, dev);
145 iommu_domain_free(domain);
148 static phys_addr_t rproc_va_to_pa(void *cpu_addr)
151 * Return physical address according to virtual address location
152 * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent
153 * - in kernel: if region allocated in generic dma memory pool
155 if (is_vmalloc_addr(cpu_addr)) {
156 return page_to_phys(vmalloc_to_page(cpu_addr)) +
157 offset_in_page(cpu_addr);
160 WARN_ON(!virt_addr_valid(cpu_addr));
161 return virt_to_phys(cpu_addr);
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, int len)
195 struct rproc_mem_entry *carveout;
198 if (rproc->ops->da_to_va) {
199 ptr = rproc->ops->da_to_va(rproc, da, len);
204 list_for_each_entry(carveout, &rproc->carveouts, node) {
205 int offset = da - carveout->da;
207 /* try next carveout if da is too small */
211 /* try next carveout if da is too large */
212 if (offset + len > carveout->len)
215 ptr = carveout->va + offset;
223 EXPORT_SYMBOL(rproc_da_to_va);
226 * rproc_find_carveout_by_name() - lookup the carveout region by a name
227 * @rproc: handle of a remote processor
228 * @name,..: carveout name to find (standard printf format)
230 * Platform driver has the capability to register some pre-allacoted carveout
231 * (physically contiguous memory regions) before rproc firmware loading and
232 * associated resource table analysis. These regions may be dedicated memory
233 * regions internal to the coprocessor or specified DDR region with specific
236 * This function is a helper function with which we can go over the
237 * allocated carveouts and return associated region characteristics like
238 * coprocessor address, length or processor virtual address.
240 * Return: a valid pointer on carveout entry on success or NULL on failure.
242 struct rproc_mem_entry *
243 rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...)
247 struct rproc_mem_entry *carveout, *mem = NULL;
252 va_start(args, name);
253 vsnprintf(_name, sizeof(_name), name, args);
256 list_for_each_entry(carveout, &rproc->carveouts, node) {
257 /* Compare carveout and requested names */
258 if (!strcmp(carveout->name, _name)) {
268 * rproc_check_carveout_da() - Check specified carveout da configuration
269 * @rproc: handle of a remote processor
270 * @mem: pointer on carveout to check
271 * @da: area device address
272 * @len: associated area size
274 * This function is a helper function to verify requested device area (couple
275 * da, len) is part of specified carevout.
277 * Return: 0 if carveout match request else -ENOMEM
279 int rproc_check_carveout_da(struct rproc *rproc, struct rproc_mem_entry *mem,
282 struct device *dev = &rproc->dev;
285 /* Check requested resource length */
286 if (len > mem->len) {
287 dev_err(dev, "Registered carveout doesn't fit len request\n");
291 if (da != FW_RSC_ADDR_ANY && mem->da == FW_RSC_ADDR_ANY) {
292 /* Update existing carveout da */
294 } else if (da != FW_RSC_ADDR_ANY && mem->da != FW_RSC_ADDR_ANY) {
295 delta = da - mem->da;
297 /* Check requested resource belongs to registered carveout */
300 "Registered carveout doesn't fit da request\n");
304 if (delta + len > mem->len) {
306 "Registered carveout doesn't fit len request\n");
314 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
316 struct rproc *rproc = rvdev->rproc;
317 struct device *dev = &rproc->dev;
318 struct rproc_vring *rvring = &rvdev->vring[i];
319 struct fw_rsc_vdev *rsc;
320 int ret, size, notifyid;
321 struct rproc_mem_entry *mem;
323 /* actual size of vring (in bytes) */
324 size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
326 rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
328 /* Search for pre-registered carveout */
329 mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index,
332 if (rproc_check_carveout_da(rproc, mem, rsc->vring[i].da, size))
335 /* Register carveout in in list */
336 mem = rproc_mem_entry_init(dev, 0, 0, size, rsc->vring[i].da,
337 rproc_alloc_carveout,
338 rproc_release_carveout,
342 dev_err(dev, "Can't allocate memory entry structure\n");
346 rproc_add_carveout(rproc, mem);
350 * Assign an rproc-wide unique index for this vring
351 * TODO: assign a notifyid for rvdev updates as well
352 * TODO: support predefined notifyids (via resource table)
354 ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
356 dev_err(dev, "idr_alloc failed: %d\n", ret);
361 /* Potentially bump max_notifyid */
362 if (notifyid > rproc->max_notifyid)
363 rproc->max_notifyid = notifyid;
365 rvring->notifyid = notifyid;
367 /* Let the rproc know the notifyid of this vring.*/
368 rsc->vring[i].notifyid = notifyid;
373 rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
375 struct rproc *rproc = rvdev->rproc;
376 struct device *dev = &rproc->dev;
377 struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
378 struct rproc_vring *rvring = &rvdev->vring[i];
380 dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
381 i, vring->da, vring->num, vring->align);
383 /* verify queue size and vring alignment are sane */
384 if (!vring->num || !vring->align) {
385 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
386 vring->num, vring->align);
390 rvring->len = vring->num;
391 rvring->align = vring->align;
392 rvring->rvdev = rvdev;
397 void rproc_free_vring(struct rproc_vring *rvring)
399 struct rproc *rproc = rvring->rvdev->rproc;
400 int idx = rvring->rvdev->vring - rvring;
401 struct fw_rsc_vdev *rsc;
403 idr_remove(&rproc->notifyids, rvring->notifyid);
405 /* reset resource entry info */
406 rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
407 rsc->vring[idx].da = 0;
408 rsc->vring[idx].notifyid = -1;
411 static int rproc_vdev_do_start(struct rproc_subdev *subdev)
413 struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
415 return rproc_add_virtio_dev(rvdev, rvdev->id);
418 static void rproc_vdev_do_stop(struct rproc_subdev *subdev, bool crashed)
420 struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
422 rproc_remove_virtio_dev(rvdev);
426 * rproc_handle_vdev() - handle a vdev fw resource
427 * @rproc: the remote processor
428 * @rsc: the vring resource descriptor
429 * @avail: size of available data (for sanity checking the image)
431 * This resource entry requests the host to statically register a virtio
432 * device (vdev), and setup everything needed to support it. It contains
433 * everything needed to make it possible: the virtio device id, virtio
434 * device features, vrings information, virtio config space, etc...
436 * Before registering the vdev, the vrings are allocated from non-cacheable
437 * physically contiguous memory. Currently we only support two vrings per
438 * remote processor (temporary limitation). We might also want to consider
439 * doing the vring allocation only later when ->find_vqs() is invoked, and
440 * then release them upon ->del_vqs().
442 * Note: @da is currently not really handled correctly: we dynamically
443 * allocate it using the DMA API, ignoring requested hard coded addresses,
444 * and we don't take care of any required IOMMU programming. This is all
445 * going to be taken care of when the generic iommu-based DMA API will be
446 * merged. Meanwhile, statically-addressed iommu-based firmware images should
447 * use RSC_DEVMEM resource entries to map their required @da to the physical
448 * address of their base CMA region (ouch, hacky!).
450 * Returns 0 on success, or an appropriate error code otherwise
452 static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
453 int offset, int avail)
455 struct device *dev = &rproc->dev;
456 struct rproc_vdev *rvdev;
459 /* make sure resource isn't truncated */
460 if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
461 + rsc->config_len > avail) {
462 dev_err(dev, "vdev rsc is truncated\n");
466 /* make sure reserved bytes are zeroes */
467 if (rsc->reserved[0] || rsc->reserved[1]) {
468 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
472 dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
473 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
475 /* we currently support only two vrings per rvdev */
476 if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
477 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
481 rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL);
485 kref_init(&rvdev->refcount);
488 rvdev->rproc = rproc;
489 rvdev->index = rproc->nb_vdev++;
491 /* parse the vrings */
492 for (i = 0; i < rsc->num_of_vrings; i++) {
493 ret = rproc_parse_vring(rvdev, rsc, i);
498 /* remember the resource offset*/
499 rvdev->rsc_offset = offset;
501 /* allocate the vring resources */
502 for (i = 0; i < rsc->num_of_vrings; i++) {
503 ret = rproc_alloc_vring(rvdev, i);
505 goto unwind_vring_allocations;
508 list_add_tail(&rvdev->node, &rproc->rvdevs);
510 rvdev->subdev.start = rproc_vdev_do_start;
511 rvdev->subdev.stop = rproc_vdev_do_stop;
513 rproc_add_subdev(rproc, &rvdev->subdev);
517 unwind_vring_allocations:
518 for (i--; i >= 0; i--)
519 rproc_free_vring(&rvdev->vring[i]);
525 void rproc_vdev_release(struct kref *ref)
527 struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount);
528 struct rproc_vring *rvring;
529 struct rproc *rproc = rvdev->rproc;
532 for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) {
533 rvring = &rvdev->vring[id];
534 rproc_free_vring(rvring);
537 rproc_remove_subdev(rproc, &rvdev->subdev);
538 list_del(&rvdev->node);
543 * rproc_handle_trace() - handle a shared trace buffer resource
544 * @rproc: the remote processor
545 * @rsc: the trace resource descriptor
546 * @avail: size of available data (for sanity checking the image)
548 * In case the remote processor dumps trace logs into memory,
549 * export it via debugfs.
551 * Currently, the 'da' member of @rsc should contain the device address
552 * where the remote processor is dumping the traces. Later we could also
553 * support dynamically allocating this address using the generic
554 * DMA API (but currently there isn't a use case for that).
556 * Returns 0 on success, or an appropriate error code otherwise
558 static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
559 int offset, int avail)
561 struct rproc_mem_entry *trace;
562 struct device *dev = &rproc->dev;
566 if (sizeof(*rsc) > avail) {
567 dev_err(dev, "trace rsc is truncated\n");
571 /* make sure reserved bytes are zeroes */
573 dev_err(dev, "trace rsc has non zero reserved bytes\n");
577 /* what's the kernel address of this resource ? */
578 ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
580 dev_err(dev, "erroneous trace resource entry\n");
584 trace = kzalloc(sizeof(*trace), GFP_KERNEL);
588 /* set the trace buffer dma properties */
589 trace->len = rsc->len;
592 /* make sure snprintf always null terminates, even if truncating */
593 snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
595 /* create the debugfs entry */
596 trace->priv = rproc_create_trace_file(name, rproc, trace);
603 list_add_tail(&trace->node, &rproc->traces);
607 dev_dbg(dev, "%s added: va %pK, da 0x%x, len 0x%x\n",
608 name, ptr, rsc->da, rsc->len);
614 * rproc_handle_devmem() - handle devmem resource entry
615 * @rproc: remote processor handle
616 * @rsc: the devmem resource entry
617 * @avail: size of available data (for sanity checking the image)
619 * Remote processors commonly need to access certain on-chip peripherals.
621 * Some of these remote processors access memory via an iommu device,
622 * and might require us to configure their iommu before they can access
623 * the on-chip peripherals they need.
625 * This resource entry is a request to map such a peripheral device.
627 * These devmem entries will contain the physical address of the device in
628 * the 'pa' member. If a specific device address is expected, then 'da' will
629 * contain it (currently this is the only use case supported). 'len' will
630 * contain the size of the physical region we need to map.
632 * Currently we just "trust" those devmem entries to contain valid physical
633 * addresses, but this is going to change: we want the implementations to
634 * tell us ranges of physical addresses the firmware is allowed to request,
635 * and not allow firmwares to request access to physical addresses that
636 * are outside those ranges.
638 static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
639 int offset, int avail)
641 struct rproc_mem_entry *mapping;
642 struct device *dev = &rproc->dev;
645 /* no point in handling this resource without a valid iommu domain */
649 if (sizeof(*rsc) > avail) {
650 dev_err(dev, "devmem rsc is truncated\n");
654 /* make sure reserved bytes are zeroes */
656 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
660 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
664 ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
666 dev_err(dev, "failed to map devmem: %d\n", ret);
671 * We'll need this info later when we'll want to unmap everything
672 * (e.g. on shutdown).
674 * We can't trust the remote processor not to change the resource
675 * table, so we must maintain this info independently.
677 mapping->da = rsc->da;
678 mapping->len = rsc->len;
679 list_add_tail(&mapping->node, &rproc->mappings);
681 dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
682 rsc->pa, rsc->da, rsc->len);
692 * rproc_alloc_carveout() - allocated specified carveout
693 * @rproc: rproc handle
694 * @mem: the memory entry to allocate
696 * This function allocate specified memory entry @mem using
697 * dma_alloc_coherent() as default allocator
699 static int rproc_alloc_carveout(struct rproc *rproc,
700 struct rproc_mem_entry *mem)
702 struct rproc_mem_entry *mapping = NULL;
703 struct device *dev = &rproc->dev;
708 va = dma_alloc_coherent(dev->parent, mem->len, &dma, GFP_KERNEL);
711 "failed to allocate dma memory: len 0x%x\n", mem->len);
715 dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%x\n",
719 * Ok, this is non-standard.
721 * Sometimes we can't rely on the generic iommu-based DMA API
722 * to dynamically allocate the device address and then set the IOMMU
723 * tables accordingly, because some remote processors might
724 * _require_ us to use hard coded device addresses that their
725 * firmware was compiled with.
727 * In this case, we must use the IOMMU API directly and map
728 * the memory to the device address as expected by the remote
731 * Obviously such remote processor devices should not be configured
732 * to use the iommu-based DMA API: we expect 'dma' to contain the
733 * physical address in this case.
736 if (mem->da != FW_RSC_ADDR_ANY) {
737 if (!rproc->domain) {
739 "Bad carveout rsc configuration\n");
744 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
750 ret = iommu_map(rproc->domain, mem->da, dma, mem->len,
753 dev_err(dev, "iommu_map failed: %d\n", ret);
758 * We'll need this info later when we'll want to unmap
759 * everything (e.g. on shutdown).
761 * We can't trust the remote processor not to change the
762 * resource table, so we must maintain this info independently.
764 mapping->da = mem->da;
765 mapping->len = mem->len;
766 list_add_tail(&mapping->node, &rproc->mappings);
768 dev_dbg(dev, "carveout mapped 0x%x to %pad\n",
782 dma_free_coherent(dev->parent, mem->len, va, dma);
787 * rproc_release_carveout() - release acquired carveout
788 * @rproc: rproc handle
789 * @mem: the memory entry to release
791 * This function releases specified memory entry @mem allocated via
792 * rproc_alloc_carveout() function by @rproc.
794 static int rproc_release_carveout(struct rproc *rproc,
795 struct rproc_mem_entry *mem)
797 struct device *dev = &rproc->dev;
799 /* clean up carveout allocations */
800 dma_free_coherent(dev->parent, mem->len, mem->va, mem->dma);
805 * rproc_handle_carveout() - handle phys contig memory allocation requests
806 * @rproc: rproc handle
807 * @rsc: the resource entry
808 * @avail: size of available data (for image validation)
810 * This function will handle firmware requests for allocation of physically
811 * contiguous memory regions.
813 * These request entries should come first in the firmware's resource table,
814 * as other firmware entries might request placing other data objects inside
815 * these memory regions (e.g. data/code segments, trace resource entries, ...).
817 * Allocating memory this way helps utilizing the reserved physical memory
818 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
819 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
820 * pressure is important; it may have a substantial impact on performance.
822 static int rproc_handle_carveout(struct rproc *rproc,
823 struct fw_rsc_carveout *rsc,
824 int offset, int avail)
826 struct rproc_mem_entry *carveout;
827 struct device *dev = &rproc->dev;
829 if (sizeof(*rsc) > avail) {
830 dev_err(dev, "carveout rsc is truncated\n");
834 /* make sure reserved bytes are zeroes */
836 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
840 dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
841 rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
844 * Check carveout rsc already part of a registered carveout,
845 * Search by name, then check the da and length
847 carveout = rproc_find_carveout_by_name(rproc, rsc->name);
850 if (carveout->rsc_offset != FW_RSC_ADDR_ANY) {
852 "Carveout already associated to resource table\n");
856 if (rproc_check_carveout_da(rproc, carveout, rsc->da, rsc->len))
859 /* Update memory carveout with resource table info */
860 carveout->rsc_offset = offset;
861 carveout->flags = rsc->flags;
866 /* Register carveout in in list */
867 carveout = rproc_mem_entry_init(dev, 0, 0, rsc->len, rsc->da,
868 rproc_alloc_carveout,
869 rproc_release_carveout, rsc->name);
871 dev_err(dev, "Can't allocate memory entry structure\n");
875 carveout->flags = rsc->flags;
876 carveout->rsc_offset = offset;
877 rproc_add_carveout(rproc, carveout);
883 * rproc_add_carveout() - register an allocated carveout region
884 * @rproc: rproc handle
885 * @mem: memory entry to register
887 * This function registers specified memory entry in @rproc carveouts list.
888 * Specified carveout should have been allocated before registering.
890 void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem)
892 list_add_tail(&mem->node, &rproc->carveouts);
894 EXPORT_SYMBOL(rproc_add_carveout);
897 * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct
898 * @dev: pointer on device struct
899 * @va: virtual address
901 * @len: memory carveout length
902 * @da: device address
903 * @release: memory carveout function
904 * @name: carveout name
906 * This function allocates a rproc_mem_entry struct and fill it with parameters
907 * provided by client.
909 struct rproc_mem_entry *
910 rproc_mem_entry_init(struct device *dev,
911 void *va, dma_addr_t dma, int len, u32 da,
912 int (*alloc)(struct rproc *, struct rproc_mem_entry *),
913 int (*release)(struct rproc *, struct rproc_mem_entry *),
914 const char *name, ...)
916 struct rproc_mem_entry *mem;
919 mem = kzalloc(sizeof(*mem), GFP_KERNEL);
928 mem->release = release;
929 mem->rsc_offset = FW_RSC_ADDR_ANY;
930 mem->of_resm_idx = -1;
932 va_start(args, name);
933 vsnprintf(mem->name, sizeof(mem->name), name, args);
938 EXPORT_SYMBOL(rproc_mem_entry_init);
941 * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct
942 * from a reserved memory phandle
943 * @dev: pointer on device struct
944 * @of_resm_idx: reserved memory phandle index in "memory-region"
945 * @len: memory carveout length
946 * @da: device address
947 * @name: carveout name
949 * This function allocates a rproc_mem_entry struct and fill it with parameters
950 * provided by client.
952 struct rproc_mem_entry *
953 rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, int len,
954 u32 da, const char *name, ...)
956 struct rproc_mem_entry *mem;
959 mem = kzalloc(sizeof(*mem), GFP_KERNEL);
965 mem->rsc_offset = FW_RSC_ADDR_ANY;
966 mem->of_resm_idx = of_resm_idx;
968 va_start(args, name);
969 vsnprintf(mem->name, sizeof(mem->name), name, args);
974 EXPORT_SYMBOL(rproc_of_resm_mem_entry_init);
977 * A lookup table for resource handlers. The indices are defined in
978 * enum fw_resource_type.
980 static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
981 [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
982 [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
983 [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
984 [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
987 /* handle firmware resource entries before booting the remote processor */
988 static int rproc_handle_resources(struct rproc *rproc,
989 rproc_handle_resource_t handlers[RSC_LAST])
991 struct device *dev = &rproc->dev;
992 rproc_handle_resource_t handler;
995 if (!rproc->table_ptr)
998 for (i = 0; i < rproc->table_ptr->num; i++) {
999 int offset = rproc->table_ptr->offset[i];
1000 struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
1001 int avail = rproc->table_sz - offset - sizeof(*hdr);
1002 void *rsc = (void *)hdr + sizeof(*hdr);
1004 /* make sure table isn't truncated */
1006 dev_err(dev, "rsc table is truncated\n");
1010 dev_dbg(dev, "rsc: type %d\n", hdr->type);
1012 if (hdr->type >= RSC_LAST) {
1013 dev_warn(dev, "unsupported resource %d\n", hdr->type);
1017 handler = handlers[hdr->type];
1021 ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
1029 static int rproc_prepare_subdevices(struct rproc *rproc)
1031 struct rproc_subdev *subdev;
1034 list_for_each_entry(subdev, &rproc->subdevs, node) {
1035 if (subdev->prepare) {
1036 ret = subdev->prepare(subdev);
1038 goto unroll_preparation;
1045 list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) {
1046 if (subdev->unprepare)
1047 subdev->unprepare(subdev);
1053 static int rproc_start_subdevices(struct rproc *rproc)
1055 struct rproc_subdev *subdev;
1058 list_for_each_entry(subdev, &rproc->subdevs, node) {
1059 if (subdev->start) {
1060 ret = subdev->start(subdev);
1062 goto unroll_registration;
1068 unroll_registration:
1069 list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) {
1071 subdev->stop(subdev, true);
1077 static void rproc_stop_subdevices(struct rproc *rproc, bool crashed)
1079 struct rproc_subdev *subdev;
1081 list_for_each_entry_reverse(subdev, &rproc->subdevs, node) {
1083 subdev->stop(subdev, crashed);
1087 static void rproc_unprepare_subdevices(struct rproc *rproc)
1089 struct rproc_subdev *subdev;
1091 list_for_each_entry_reverse(subdev, &rproc->subdevs, node) {
1092 if (subdev->unprepare)
1093 subdev->unprepare(subdev);
1098 * rproc_alloc_registered_carveouts() - allocate all carveouts registered
1100 * @rproc: the remote processor handle
1102 * This function parses registered carveout list, performs allocation
1103 * if alloc() ops registered and updates resource table information
1104 * if rsc_offset set.
1106 * Return: 0 on success
1108 static int rproc_alloc_registered_carveouts(struct rproc *rproc)
1110 struct rproc_mem_entry *entry, *tmp;
1111 struct fw_rsc_carveout *rsc;
1112 struct device *dev = &rproc->dev;
1115 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
1117 ret = entry->alloc(rproc, entry);
1119 dev_err(dev, "Unable to allocate carveout %s: %d\n",
1125 if (entry->rsc_offset != FW_RSC_ADDR_ANY) {
1126 /* update resource table */
1127 rsc = (void *)rproc->table_ptr + entry->rsc_offset;
1130 * Some remote processors might need to know the pa
1131 * even though they are behind an IOMMU. E.g., OMAP4's
1132 * remote M3 processor needs this so it can control
1133 * on-chip hardware accelerators that are not behind
1134 * the IOMMU, and therefor must know the pa.
1136 * Generally we don't want to expose physical addresses
1137 * if we don't have to (remote processors are generally
1138 * _not_ trusted), so we might want to do this only for
1139 * remote processor that _must_ have this (e.g. OMAP4's
1140 * dual M3 subsystem).
1142 * Non-IOMMU processors might also want to have this info.
1143 * In this case, the device address and the physical address
1147 /* Use va if defined else dma to generate pa */
1149 rsc->pa = (u32)rproc_va_to_pa(entry->va);
1151 rsc->pa = (u32)entry->dma;
1153 rsc->da = entry->da;
1154 rsc->len = entry->len;
1162 * rproc_coredump_cleanup() - clean up dump_segments list
1163 * @rproc: the remote processor handle
1165 static void rproc_coredump_cleanup(struct rproc *rproc)
1167 struct rproc_dump_segment *entry, *tmp;
1169 list_for_each_entry_safe(entry, tmp, &rproc->dump_segments, node) {
1170 list_del(&entry->node);
1176 * rproc_resource_cleanup() - clean up and free all acquired resources
1177 * @rproc: rproc handle
1179 * This function will free all resources acquired for @rproc, and it
1180 * is called whenever @rproc either shuts down or fails to boot.
1182 static void rproc_resource_cleanup(struct rproc *rproc)
1184 struct rproc_mem_entry *entry, *tmp;
1185 struct rproc_vdev *rvdev, *rvtmp;
1186 struct device *dev = &rproc->dev;
1188 /* clean up debugfs trace entries */
1189 list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
1190 rproc_remove_trace_file(entry->priv);
1191 rproc->num_traces--;
1192 list_del(&entry->node);
1196 /* clean up iommu mapping entries */
1197 list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
1200 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
1201 if (unmapped != entry->len) {
1202 /* nothing much to do besides complaining */
1203 dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
1207 list_del(&entry->node);
1211 /* clean up carveout allocations */
1212 list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
1214 entry->release(rproc, entry);
1215 list_del(&entry->node);
1219 /* clean up remote vdev entries */
1220 list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
1221 kref_put(&rvdev->refcount, rproc_vdev_release);
1223 rproc_coredump_cleanup(rproc);
1226 static int rproc_start(struct rproc *rproc, const struct firmware *fw)
1228 struct resource_table *loaded_table;
1229 struct device *dev = &rproc->dev;
1232 /* load the ELF segments to memory */
1233 ret = rproc_load_segments(rproc, fw);
1235 dev_err(dev, "Failed to load program segments: %d\n", ret);
1240 * The starting device has been given the rproc->cached_table as the
1241 * resource table. The address of the vring along with the other
1242 * allocated resources (carveouts etc) is stored in cached_table.
1243 * In order to pass this information to the remote device we must copy
1244 * this information to device memory. We also update the table_ptr so
1245 * that any subsequent changes will be applied to the loaded version.
1247 loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
1249 memcpy(loaded_table, rproc->cached_table, rproc->table_sz);
1250 rproc->table_ptr = loaded_table;
1253 ret = rproc_prepare_subdevices(rproc);
1255 dev_err(dev, "failed to prepare subdevices for %s: %d\n",
1257 goto reset_table_ptr;
1260 /* power up the remote processor */
1261 ret = rproc->ops->start(rproc);
1263 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
1264 goto unprepare_subdevices;
1267 /* Start any subdevices for the remote processor */
1268 ret = rproc_start_subdevices(rproc);
1270 dev_err(dev, "failed to probe subdevices for %s: %d\n",
1275 rproc->state = RPROC_RUNNING;
1277 dev_info(dev, "remote processor %s is now up\n", rproc->name);
1282 rproc->ops->stop(rproc);
1283 unprepare_subdevices:
1284 rproc_unprepare_subdevices(rproc);
1286 rproc->table_ptr = rproc->cached_table;
1292 * take a firmware and boot a remote processor with it.
1294 static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
1296 struct device *dev = &rproc->dev;
1297 const char *name = rproc->firmware;
1300 ret = rproc_fw_sanity_check(rproc, fw);
1304 dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
1307 * if enabling an IOMMU isn't relevant for this rproc, this is
1310 ret = rproc_enable_iommu(rproc);
1312 dev_err(dev, "can't enable iommu: %d\n", ret);
1316 rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
1318 /* Load resource table, core dump segment list etc from the firmware */
1319 ret = rproc_parse_fw(rproc, fw);
1323 /* reset max_notifyid */
1324 rproc->max_notifyid = -1;
1326 /* reset handled vdev */
1329 /* handle fw resources which are required to boot rproc */
1330 ret = rproc_handle_resources(rproc, rproc_loading_handlers);
1332 dev_err(dev, "Failed to process resources: %d\n", ret);
1333 goto clean_up_resources;
1336 /* Allocate carveout resources associated to rproc */
1337 ret = rproc_alloc_registered_carveouts(rproc);
1339 dev_err(dev, "Failed to allocate associated carveouts: %d\n",
1341 goto clean_up_resources;
1344 ret = rproc_start(rproc, fw);
1346 goto clean_up_resources;
1351 rproc_resource_cleanup(rproc);
1352 kfree(rproc->cached_table);
1353 rproc->cached_table = NULL;
1354 rproc->table_ptr = NULL;
1356 rproc_disable_iommu(rproc);
1361 * take a firmware and boot it up.
1363 * Note: this function is called asynchronously upon registration of the
1364 * remote processor (so we must wait until it completes before we try
1365 * to unregister the device. one other option is just to use kref here,
1366 * that might be cleaner).
1368 static void rproc_auto_boot_callback(const struct firmware *fw, void *context)
1370 struct rproc *rproc = context;
1374 release_firmware(fw);
1377 static int rproc_trigger_auto_boot(struct rproc *rproc)
1382 * We're initiating an asynchronous firmware loading, so we can
1383 * be built-in kernel code, without hanging the boot process.
1385 ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
1386 rproc->firmware, &rproc->dev, GFP_KERNEL,
1387 rproc, rproc_auto_boot_callback);
1389 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
1394 static int rproc_stop(struct rproc *rproc, bool crashed)
1396 struct device *dev = &rproc->dev;
1399 /* Stop any subdevices for the remote processor */
1400 rproc_stop_subdevices(rproc, crashed);
1402 /* the installed resource table is no longer accessible */
1403 rproc->table_ptr = rproc->cached_table;
1405 /* power off the remote processor */
1406 ret = rproc->ops->stop(rproc);
1408 dev_err(dev, "can't stop rproc: %d\n", ret);
1412 rproc_unprepare_subdevices(rproc);
1414 rproc->state = RPROC_OFFLINE;
1416 dev_info(dev, "stopped remote processor %s\n", rproc->name);
1422 * rproc_coredump_add_segment() - add segment of device memory to coredump
1423 * @rproc: handle of a remote processor
1424 * @da: device address
1425 * @size: size of segment
1427 * Add device memory to the list of segments to be included in a coredump for
1430 * Return: 0 on success, negative errno on error.
1432 int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size)
1434 struct rproc_dump_segment *segment;
1436 segment = kzalloc(sizeof(*segment), GFP_KERNEL);
1441 segment->size = size;
1443 list_add_tail(&segment->node, &rproc->dump_segments);
1447 EXPORT_SYMBOL(rproc_coredump_add_segment);
1450 * rproc_coredump_add_custom_segment() - add custom coredump segment
1451 * @rproc: handle of a remote processor
1452 * @da: device address
1453 * @size: size of segment
1454 * @dumpfn: custom dump function called for each segment during coredump
1455 * @priv: private data
1457 * Add device memory to the list of segments to be included in the coredump
1458 * and associate the segment with the given custom dump function and private
1461 * Return: 0 on success, negative errno on error.
1463 int rproc_coredump_add_custom_segment(struct rproc *rproc,
1464 dma_addr_t da, size_t size,
1465 void (*dumpfn)(struct rproc *rproc,
1466 struct rproc_dump_segment *segment,
1470 struct rproc_dump_segment *segment;
1472 segment = kzalloc(sizeof(*segment), GFP_KERNEL);
1477 segment->size = size;
1478 segment->priv = priv;
1479 segment->dump = dumpfn;
1481 list_add_tail(&segment->node, &rproc->dump_segments);
1485 EXPORT_SYMBOL(rproc_coredump_add_custom_segment);
1488 * rproc_coredump() - perform coredump
1489 * @rproc: rproc handle
1491 * This function will generate an ELF header for the registered segments
1492 * and create a devcoredump device associated with rproc.
1494 static void rproc_coredump(struct rproc *rproc)
1496 struct rproc_dump_segment *segment;
1497 struct elf32_phdr *phdr;
1498 struct elf32_hdr *ehdr;
1505 if (list_empty(&rproc->dump_segments))
1508 data_size = sizeof(*ehdr);
1509 list_for_each_entry(segment, &rproc->dump_segments, node) {
1510 data_size += sizeof(*phdr) + segment->size;
1515 data = vmalloc(data_size);
1521 memset(ehdr, 0, sizeof(*ehdr));
1522 memcpy(ehdr->e_ident, ELFMAG, SELFMAG);
1523 ehdr->e_ident[EI_CLASS] = ELFCLASS32;
1524 ehdr->e_ident[EI_DATA] = ELFDATA2LSB;
1525 ehdr->e_ident[EI_VERSION] = EV_CURRENT;
1526 ehdr->e_ident[EI_OSABI] = ELFOSABI_NONE;
1527 ehdr->e_type = ET_CORE;
1528 ehdr->e_machine = EM_NONE;
1529 ehdr->e_version = EV_CURRENT;
1530 ehdr->e_entry = rproc->bootaddr;
1531 ehdr->e_phoff = sizeof(*ehdr);
1532 ehdr->e_ehsize = sizeof(*ehdr);
1533 ehdr->e_phentsize = sizeof(*phdr);
1534 ehdr->e_phnum = phnum;
1536 phdr = data + ehdr->e_phoff;
1537 offset = ehdr->e_phoff + sizeof(*phdr) * ehdr->e_phnum;
1538 list_for_each_entry(segment, &rproc->dump_segments, node) {
1539 memset(phdr, 0, sizeof(*phdr));
1540 phdr->p_type = PT_LOAD;
1541 phdr->p_offset = offset;
1542 phdr->p_vaddr = segment->da;
1543 phdr->p_paddr = segment->da;
1544 phdr->p_filesz = segment->size;
1545 phdr->p_memsz = segment->size;
1546 phdr->p_flags = PF_R | PF_W | PF_X;
1549 if (segment->dump) {
1550 segment->dump(rproc, segment, data + offset);
1552 ptr = rproc_da_to_va(rproc, segment->da, segment->size);
1554 dev_err(&rproc->dev,
1555 "invalid coredump segment (%pad, %zu)\n",
1556 &segment->da, segment->size);
1557 memset(data + offset, 0xff, segment->size);
1559 memcpy(data + offset, ptr, segment->size);
1563 offset += phdr->p_filesz;
1567 dev_coredumpv(&rproc->dev, data, data_size, GFP_KERNEL);
1571 * rproc_trigger_recovery() - recover a remoteproc
1572 * @rproc: the remote processor
1574 * The recovery is done by resetting all the virtio devices, that way all the
1575 * rpmsg drivers will be reseted along with the remote processor making the
1576 * remoteproc functional again.
1578 * This function can sleep, so it cannot be called from atomic context.
1580 int rproc_trigger_recovery(struct rproc *rproc)
1582 const struct firmware *firmware_p;
1583 struct device *dev = &rproc->dev;
1586 dev_err(dev, "recovering %s\n", rproc->name);
1588 ret = mutex_lock_interruptible(&rproc->lock);
1592 ret = rproc_stop(rproc, true);
1596 /* generate coredump */
1597 rproc_coredump(rproc);
1600 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1602 dev_err(dev, "request_firmware failed: %d\n", ret);
1606 /* boot the remote processor up again */
1607 ret = rproc_start(rproc, firmware_p);
1609 release_firmware(firmware_p);
1612 mutex_unlock(&rproc->lock);
1617 * rproc_crash_handler_work() - handle a crash
1619 * This function needs to handle everything related to a crash, like cpu
1620 * registers and stack dump, information to help to debug the fatal error, etc.
1622 static void rproc_crash_handler_work(struct work_struct *work)
1624 struct rproc *rproc = container_of(work, struct rproc, crash_handler);
1625 struct device *dev = &rproc->dev;
1627 dev_dbg(dev, "enter %s\n", __func__);
1629 mutex_lock(&rproc->lock);
1631 if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
1632 /* handle only the first crash detected */
1633 mutex_unlock(&rproc->lock);
1637 rproc->state = RPROC_CRASHED;
1638 dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
1641 mutex_unlock(&rproc->lock);
1643 if (!rproc->recovery_disabled)
1644 rproc_trigger_recovery(rproc);
1648 * rproc_boot() - boot a remote processor
1649 * @rproc: handle of a remote processor
1651 * Boot a remote processor (i.e. load its firmware, power it on, ...).
1653 * If the remote processor is already powered on, this function immediately
1654 * returns (successfully).
1656 * Returns 0 on success, and an appropriate error value otherwise.
1658 int rproc_boot(struct rproc *rproc)
1660 const struct firmware *firmware_p;
1665 pr_err("invalid rproc handle\n");
1671 ret = mutex_lock_interruptible(&rproc->lock);
1673 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1677 if (rproc->state == RPROC_DELETED) {
1679 dev_err(dev, "can't boot deleted rproc %s\n", rproc->name);
1683 /* skip the boot process if rproc is already powered up */
1684 if (atomic_inc_return(&rproc->power) > 1) {
1689 dev_info(dev, "powering up %s\n", rproc->name);
1692 ret = request_firmware(&firmware_p, rproc->firmware, dev);
1694 dev_err(dev, "request_firmware failed: %d\n", ret);
1698 ret = rproc_fw_boot(rproc, firmware_p);
1700 release_firmware(firmware_p);
1704 atomic_dec(&rproc->power);
1706 mutex_unlock(&rproc->lock);
1709 EXPORT_SYMBOL(rproc_boot);
1712 * rproc_shutdown() - power off the remote processor
1713 * @rproc: the remote processor
1715 * Power off a remote processor (previously booted with rproc_boot()).
1717 * In case @rproc is still being used by an additional user(s), then
1718 * this function will just decrement the power refcount and exit,
1719 * without really powering off the device.
1721 * Every call to rproc_boot() must (eventually) be accompanied by a call
1722 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1725 * - we're not decrementing the rproc's refcount, only the power refcount.
1726 * which means that the @rproc handle stays valid even after rproc_shutdown()
1727 * returns, and users can still use it with a subsequent rproc_boot(), if
1730 void rproc_shutdown(struct rproc *rproc)
1732 struct device *dev = &rproc->dev;
1735 ret = mutex_lock_interruptible(&rproc->lock);
1737 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1741 /* if the remote proc is still needed, bail out */
1742 if (!atomic_dec_and_test(&rproc->power))
1745 ret = rproc_stop(rproc, false);
1747 atomic_inc(&rproc->power);
1751 /* clean up all acquired resources */
1752 rproc_resource_cleanup(rproc);
1754 rproc_disable_iommu(rproc);
1756 /* Free the copy of the resource table */
1757 kfree(rproc->cached_table);
1758 rproc->cached_table = NULL;
1759 rproc->table_ptr = NULL;
1761 mutex_unlock(&rproc->lock);
1763 EXPORT_SYMBOL(rproc_shutdown);
1766 * rproc_get_by_phandle() - find a remote processor by phandle
1767 * @phandle: phandle to the rproc
1769 * Finds an rproc handle using the remote processor's phandle, and then
1770 * return a handle to the rproc.
1772 * This function increments the remote processor's refcount, so always
1773 * use rproc_put() to decrement it back once rproc isn't needed anymore.
1775 * Returns the rproc handle on success, and NULL on failure.
1778 struct rproc *rproc_get_by_phandle(phandle phandle)
1780 struct rproc *rproc = NULL, *r;
1781 struct device_node *np;
1783 np = of_find_node_by_phandle(phandle);
1787 mutex_lock(&rproc_list_mutex);
1788 list_for_each_entry(r, &rproc_list, node) {
1789 if (r->dev.parent && r->dev.parent->of_node == np) {
1790 /* prevent underlying implementation from being removed */
1791 if (!try_module_get(r->dev.parent->driver->owner)) {
1792 dev_err(&r->dev, "can't get owner\n");
1797 get_device(&rproc->dev);
1801 mutex_unlock(&rproc_list_mutex);
1808 struct rproc *rproc_get_by_phandle(phandle phandle)
1813 EXPORT_SYMBOL(rproc_get_by_phandle);
1816 * rproc_add() - register a remote processor
1817 * @rproc: the remote processor handle to register
1819 * Registers @rproc with the remoteproc framework, after it has been
1820 * allocated with rproc_alloc().
1822 * This is called by the platform-specific rproc implementation, whenever
1823 * a new remote processor device is probed.
1825 * Returns 0 on success and an appropriate error code otherwise.
1827 * Note: this function initiates an asynchronous firmware loading
1828 * context, which will look for virtio devices supported by the rproc's
1831 * If found, those virtio devices will be created and added, so as a result
1832 * of registering this remote processor, additional virtio drivers might be
1835 int rproc_add(struct rproc *rproc)
1837 struct device *dev = &rproc->dev;
1840 ret = device_add(dev);
1844 dev_info(dev, "%s is available\n", rproc->name);
1846 /* create debugfs entries */
1847 rproc_create_debug_dir(rproc);
1849 /* if rproc is marked always-on, request it to boot */
1850 if (rproc->auto_boot) {
1851 ret = rproc_trigger_auto_boot(rproc);
1856 /* expose to rproc_get_by_phandle users */
1857 mutex_lock(&rproc_list_mutex);
1858 list_add(&rproc->node, &rproc_list);
1859 mutex_unlock(&rproc_list_mutex);
1863 EXPORT_SYMBOL(rproc_add);
1866 * rproc_type_release() - release a remote processor instance
1867 * @dev: the rproc's device
1869 * This function should _never_ be called directly.
1871 * It will be called by the driver core when no one holds a valid pointer
1874 static void rproc_type_release(struct device *dev)
1876 struct rproc *rproc = container_of(dev, struct rproc, dev);
1878 dev_info(&rproc->dev, "releasing %s\n", rproc->name);
1880 idr_destroy(&rproc->notifyids);
1882 if (rproc->index >= 0)
1883 ida_simple_remove(&rproc_dev_index, rproc->index);
1885 kfree(rproc->firmware);
1890 static const struct device_type rproc_type = {
1891 .name = "remoteproc",
1892 .release = rproc_type_release,
1896 * rproc_alloc() - allocate a remote processor handle
1897 * @dev: the underlying device
1898 * @name: name of this remote processor
1899 * @ops: platform-specific handlers (mainly start/stop)
1900 * @firmware: name of firmware file to load, can be NULL
1901 * @len: length of private data needed by the rproc driver (in bytes)
1903 * Allocates a new remote processor handle, but does not register
1904 * it yet. if @firmware is NULL, a default name is used.
1906 * This function should be used by rproc implementations during initialization
1907 * of the remote processor.
1909 * After creating an rproc handle using this function, and when ready,
1910 * implementations should then call rproc_add() to complete
1911 * the registration of the remote processor.
1913 * On success the new rproc is returned, and on failure, NULL.
1915 * Note: _never_ directly deallocate @rproc, even if it was not registered
1916 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
1918 struct rproc *rproc_alloc(struct device *dev, const char *name,
1919 const struct rproc_ops *ops,
1920 const char *firmware, int len)
1922 struct rproc *rproc;
1923 char *p, *template = "rproc-%s-fw";
1926 if (!dev || !name || !ops)
1931 * If the caller didn't pass in a firmware name then
1932 * construct a default name.
1934 name_len = strlen(name) + strlen(template) - 2 + 1;
1935 p = kmalloc(name_len, GFP_KERNEL);
1938 snprintf(p, name_len, template, name);
1940 p = kstrdup(firmware, GFP_KERNEL);
1945 rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
1951 rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL);
1958 rproc->firmware = p;
1960 rproc->priv = &rproc[1];
1961 rproc->auto_boot = true;
1963 device_initialize(&rproc->dev);
1964 rproc->dev.parent = dev;
1965 rproc->dev.type = &rproc_type;
1966 rproc->dev.class = &rproc_class;
1967 rproc->dev.driver_data = rproc;
1969 /* Assign a unique device index and name */
1970 rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1971 if (rproc->index < 0) {
1972 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1973 put_device(&rproc->dev);
1977 dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1979 atomic_set(&rproc->power, 0);
1981 /* Default to ELF loader if no load function is specified */
1982 if (!rproc->ops->load) {
1983 rproc->ops->load = rproc_elf_load_segments;
1984 rproc->ops->parse_fw = rproc_elf_load_rsc_table;
1985 rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table;
1986 rproc->ops->sanity_check = rproc_elf_sanity_check;
1987 rproc->ops->get_boot_addr = rproc_elf_get_boot_addr;
1990 mutex_init(&rproc->lock);
1992 idr_init(&rproc->notifyids);
1994 INIT_LIST_HEAD(&rproc->carveouts);
1995 INIT_LIST_HEAD(&rproc->mappings);
1996 INIT_LIST_HEAD(&rproc->traces);
1997 INIT_LIST_HEAD(&rproc->rvdevs);
1998 INIT_LIST_HEAD(&rproc->subdevs);
1999 INIT_LIST_HEAD(&rproc->dump_segments);
2001 INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
2003 rproc->state = RPROC_OFFLINE;
2007 EXPORT_SYMBOL(rproc_alloc);
2010 * rproc_free() - unroll rproc_alloc()
2011 * @rproc: the remote processor handle
2013 * This function decrements the rproc dev refcount.
2015 * If no one holds any reference to rproc anymore, then its refcount would
2016 * now drop to zero, and it would be freed.
2018 void rproc_free(struct rproc *rproc)
2020 put_device(&rproc->dev);
2022 EXPORT_SYMBOL(rproc_free);
2025 * rproc_put() - release rproc reference
2026 * @rproc: the remote processor handle
2028 * This function decrements the rproc dev refcount.
2030 * If no one holds any reference to rproc anymore, then its refcount would
2031 * now drop to zero, and it would be freed.
2033 void rproc_put(struct rproc *rproc)
2035 module_put(rproc->dev.parent->driver->owner);
2036 put_device(&rproc->dev);
2038 EXPORT_SYMBOL(rproc_put);
2041 * rproc_del() - unregister a remote processor
2042 * @rproc: rproc handle to unregister
2044 * This function should be called when the platform specific rproc
2045 * implementation decides to remove the rproc device. it should
2046 * _only_ be called if a previous invocation of rproc_add()
2047 * has completed successfully.
2049 * After rproc_del() returns, @rproc isn't freed yet, because
2050 * of the outstanding reference created by rproc_alloc. To decrement that
2051 * one last refcount, one still needs to call rproc_free().
2053 * Returns 0 on success and -EINVAL if @rproc isn't valid.
2055 int rproc_del(struct rproc *rproc)
2060 /* if rproc is marked always-on, rproc_add() booted it */
2061 /* TODO: make sure this works with rproc->power > 1 */
2062 if (rproc->auto_boot)
2063 rproc_shutdown(rproc);
2065 mutex_lock(&rproc->lock);
2066 rproc->state = RPROC_DELETED;
2067 mutex_unlock(&rproc->lock);
2069 rproc_delete_debug_dir(rproc);
2071 /* the rproc is downref'ed as soon as it's removed from the klist */
2072 mutex_lock(&rproc_list_mutex);
2073 list_del(&rproc->node);
2074 mutex_unlock(&rproc_list_mutex);
2076 device_del(&rproc->dev);
2080 EXPORT_SYMBOL(rproc_del);
2083 * rproc_add_subdev() - add a subdevice to a remoteproc
2084 * @rproc: rproc handle to add the subdevice to
2085 * @subdev: subdev handle to register
2087 * Caller is responsible for populating optional subdevice function pointers.
2089 void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
2091 list_add_tail(&subdev->node, &rproc->subdevs);
2093 EXPORT_SYMBOL(rproc_add_subdev);
2096 * rproc_remove_subdev() - remove a subdevice from a remoteproc
2097 * @rproc: rproc handle to remove the subdevice from
2098 * @subdev: subdev handle, previously registered with rproc_add_subdev()
2100 void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
2102 list_del(&subdev->node);
2104 EXPORT_SYMBOL(rproc_remove_subdev);
2107 * rproc_get_by_child() - acquire rproc handle of @dev's ancestor
2108 * @dev: child device to find ancestor of
2110 * Returns the ancestor rproc instance, or NULL if not found.
2112 struct rproc *rproc_get_by_child(struct device *dev)
2114 for (dev = dev->parent; dev; dev = dev->parent) {
2115 if (dev->type == &rproc_type)
2116 return dev->driver_data;
2121 EXPORT_SYMBOL(rproc_get_by_child);
2124 * rproc_report_crash() - rproc crash reporter function
2125 * @rproc: remote processor
2128 * This function must be called every time a crash is detected by the low-level
2129 * drivers implementing a specific remoteproc. This should not be called from a
2130 * non-remoteproc driver.
2132 * This function can be called from atomic/interrupt context.
2134 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
2137 pr_err("NULL rproc pointer\n");
2141 dev_err(&rproc->dev, "crash detected in %s: type %s\n",
2142 rproc->name, rproc_crash_to_string(type));
2144 /* create a new task to handle the error */
2145 schedule_work(&rproc->crash_handler);
2147 EXPORT_SYMBOL(rproc_report_crash);
2149 static int __init remoteproc_init(void)
2152 rproc_init_debugfs();
2156 module_init(remoteproc_init);
2158 static void __exit remoteproc_exit(void)
2160 ida_destroy(&rproc_dev_index);
2162 rproc_exit_debugfs();
2165 module_exit(remoteproc_exit);
2167 MODULE_LICENSE("GPL v2");
2168 MODULE_DESCRIPTION("Generic Remote Processor Framework");