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/of_reserved_mem.h>
43 #include <linux/virtio_ids.h>
44 #include <linux/virtio_ring.h>
45 #include <asm/byteorder.h>
46 #include <linux/platform_device.h>
48 #include "remoteproc_internal.h"
50 static DEFINE_MUTEX(rproc_list_mutex
);
51 static LIST_HEAD(rproc_list
);
53 typedef int (*rproc_handle_resources_t
)(struct rproc
*rproc
,
54 struct resource_table
*table
, int len
);
55 typedef int (*rproc_handle_resource_t
)(struct rproc
*rproc
,
56 void *, int offset
, int avail
);
58 static int rproc_alloc_carveout(struct rproc
*rproc
,
59 struct rproc_mem_entry
*mem
);
60 static int rproc_release_carveout(struct rproc
*rproc
,
61 struct rproc_mem_entry
*mem
);
63 /* Unique indices for remoteproc devices */
64 static DEFINE_IDA(rproc_dev_index
);
66 static const char * const rproc_crash_names
[] = {
67 [RPROC_MMUFAULT
] = "mmufault",
68 [RPROC_WATCHDOG
] = "watchdog",
69 [RPROC_FATAL_ERROR
] = "fatal error",
72 /* translate rproc_crash_type to string */
73 static const char *rproc_crash_to_string(enum rproc_crash_type type
)
75 if (type
< ARRAY_SIZE(rproc_crash_names
))
76 return rproc_crash_names
[type
];
81 * This is the IOMMU fault handler we register with the IOMMU API
82 * (when relevant; not all remote processors access memory through
85 * IOMMU core will invoke this handler whenever the remote processor
86 * will try to access an unmapped device address.
88 static int rproc_iommu_fault(struct iommu_domain
*domain
, struct device
*dev
,
89 unsigned long iova
, int flags
, void *token
)
91 struct rproc
*rproc
= token
;
93 dev_err(dev
, "iommu fault: da 0x%lx flags 0x%x\n", iova
, flags
);
95 rproc_report_crash(rproc
, RPROC_MMUFAULT
);
98 * Let the iommu core know we're not really handling this fault;
99 * we just used it as a recovery trigger.
104 static int rproc_enable_iommu(struct rproc
*rproc
)
106 struct iommu_domain
*domain
;
107 struct device
*dev
= rproc
->dev
.parent
;
110 if (!rproc
->has_iommu
) {
111 dev_dbg(dev
, "iommu not present\n");
115 domain
= iommu_domain_alloc(dev
->bus
);
117 dev_err(dev
, "can't alloc iommu domain\n");
121 iommu_set_fault_handler(domain
, rproc_iommu_fault
, rproc
);
123 ret
= iommu_attach_device(domain
, dev
);
125 dev_err(dev
, "can't attach iommu device: %d\n", ret
);
129 rproc
->domain
= domain
;
134 iommu_domain_free(domain
);
138 static void rproc_disable_iommu(struct rproc
*rproc
)
140 struct iommu_domain
*domain
= rproc
->domain
;
141 struct device
*dev
= rproc
->dev
.parent
;
146 iommu_detach_device(domain
, dev
);
147 iommu_domain_free(domain
);
150 phys_addr_t
rproc_va_to_pa(void *cpu_addr
)
153 * Return physical address according to virtual address location
154 * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent
155 * - in kernel: if region allocated in generic dma memory pool
157 if (is_vmalloc_addr(cpu_addr
)) {
158 return page_to_phys(vmalloc_to_page(cpu_addr
)) +
159 offset_in_page(cpu_addr
);
162 WARN_ON(!virt_addr_valid(cpu_addr
));
163 return virt_to_phys(cpu_addr
);
165 EXPORT_SYMBOL(rproc_va_to_pa
);
168 * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address
169 * @rproc: handle of a remote processor
170 * @da: remoteproc device address to translate
171 * @len: length of the memory region @da is pointing to
173 * Some remote processors will ask us to allocate them physically contiguous
174 * memory regions (which we call "carveouts"), and map them to specific
175 * device addresses (which are hardcoded in the firmware). They may also have
176 * dedicated memory regions internal to the processors, and use them either
177 * exclusively or alongside carveouts.
179 * They may then ask us to copy objects into specific device addresses (e.g.
180 * code/data sections) or expose us certain symbols in other device address
181 * (e.g. their trace buffer).
183 * This function is a helper function with which we can go over the allocated
184 * carveouts and translate specific device addresses to kernel virtual addresses
185 * so we can access the referenced memory. This function also allows to perform
186 * translations on the internal remoteproc memory regions through a platform
187 * implementation specific da_to_va ops, if present.
189 * The function returns a valid kernel address on success or NULL on failure.
191 * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
192 * but only on kernel direct mapped RAM memory. Instead, we're just using
193 * here the output of the DMA API for the carveouts, which should be more
196 void *rproc_da_to_va(struct rproc
*rproc
, u64 da
, int len
)
198 struct rproc_mem_entry
*carveout
;
201 if (rproc
->ops
->da_to_va
) {
202 ptr
= rproc
->ops
->da_to_va(rproc
, da
, len
);
207 list_for_each_entry(carveout
, &rproc
->carveouts
, node
) {
208 int offset
= da
- carveout
->da
;
210 /* try next carveout if da is too small */
214 /* try next carveout if da is too large */
215 if (offset
+ len
> carveout
->len
)
218 ptr
= carveout
->va
+ offset
;
226 EXPORT_SYMBOL(rproc_da_to_va
);
229 * rproc_find_carveout_by_name() - lookup the carveout region by a name
230 * @rproc: handle of a remote processor
231 * @name,..: carveout name to find (standard printf format)
233 * Platform driver has the capability to register some pre-allacoted carveout
234 * (physically contiguous memory regions) before rproc firmware loading and
235 * associated resource table analysis. These regions may be dedicated memory
236 * regions internal to the coprocessor or specified DDR region with specific
239 * This function is a helper function with which we can go over the
240 * allocated carveouts and return associated region characteristics like
241 * coprocessor address, length or processor virtual address.
243 * 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 carevout.
280 * Return: 0 if carveout match request else -ENOMEM
282 int rproc_check_carveout_da(struct rproc
*rproc
, struct rproc_mem_entry
*mem
,
285 struct device
*dev
= &rproc
->dev
;
288 /* Check requested resource length */
289 if (len
> mem
->len
) {
290 dev_err(dev
, "Registered carveout doesn't fit len request\n");
294 if (da
!= FW_RSC_ADDR_ANY
&& mem
->da
== FW_RSC_ADDR_ANY
) {
295 /* Update existing carveout da */
297 } else if (da
!= FW_RSC_ADDR_ANY
&& mem
->da
!= FW_RSC_ADDR_ANY
) {
298 delta
= da
- mem
->da
;
300 /* Check requested resource belongs to registered carveout */
303 "Registered carveout doesn't fit da request\n");
307 if (delta
+ len
> mem
->len
) {
309 "Registered carveout doesn't fit len request\n");
317 int rproc_alloc_vring(struct rproc_vdev
*rvdev
, int i
)
319 struct rproc
*rproc
= rvdev
->rproc
;
320 struct device
*dev
= &rproc
->dev
;
321 struct rproc_vring
*rvring
= &rvdev
->vring
[i
];
322 struct fw_rsc_vdev
*rsc
;
323 int ret
, size
, notifyid
;
324 struct rproc_mem_entry
*mem
;
326 /* actual size of vring (in bytes) */
327 size
= PAGE_ALIGN(vring_size(rvring
->len
, rvring
->align
));
329 rsc
= (void *)rproc
->table_ptr
+ rvdev
->rsc_offset
;
331 /* Search for pre-registered carveout */
332 mem
= rproc_find_carveout_by_name(rproc
, "vdev%dvring%d", rvdev
->index
,
335 if (rproc_check_carveout_da(rproc
, mem
, rsc
->vring
[i
].da
, size
))
338 /* Register carveout in in list */
339 mem
= rproc_mem_entry_init(dev
, 0, 0, size
, rsc
->vring
[i
].da
,
340 rproc_alloc_carveout
,
341 rproc_release_carveout
,
345 dev_err(dev
, "Can't allocate memory entry structure\n");
349 rproc_add_carveout(rproc
, mem
);
353 * Assign an rproc-wide unique index for this vring
354 * TODO: assign a notifyid for rvdev updates as well
355 * TODO: support predefined notifyids (via resource table)
357 ret
= idr_alloc(&rproc
->notifyids
, rvring
, 0, 0, GFP_KERNEL
);
359 dev_err(dev
, "idr_alloc failed: %d\n", ret
);
364 /* Potentially bump max_notifyid */
365 if (notifyid
> rproc
->max_notifyid
)
366 rproc
->max_notifyid
= notifyid
;
368 rvring
->notifyid
= notifyid
;
370 /* Let the rproc know the notifyid of this vring.*/
371 rsc
->vring
[i
].notifyid
= notifyid
;
376 rproc_parse_vring(struct rproc_vdev
*rvdev
, struct fw_rsc_vdev
*rsc
, int i
)
378 struct rproc
*rproc
= rvdev
->rproc
;
379 struct device
*dev
= &rproc
->dev
;
380 struct fw_rsc_vdev_vring
*vring
= &rsc
->vring
[i
];
381 struct rproc_vring
*rvring
= &rvdev
->vring
[i
];
383 dev_dbg(dev
, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
384 i
, vring
->da
, vring
->num
, vring
->align
);
386 /* verify queue size and vring alignment are sane */
387 if (!vring
->num
|| !vring
->align
) {
388 dev_err(dev
, "invalid qsz (%d) or alignment (%d)\n",
389 vring
->num
, vring
->align
);
393 rvring
->len
= vring
->num
;
394 rvring
->align
= vring
->align
;
395 rvring
->rvdev
= rvdev
;
400 void rproc_free_vring(struct rproc_vring
*rvring
)
402 struct rproc
*rproc
= rvring
->rvdev
->rproc
;
403 int idx
= rvring
->rvdev
->vring
- rvring
;
404 struct fw_rsc_vdev
*rsc
;
406 idr_remove(&rproc
->notifyids
, rvring
->notifyid
);
408 /* reset resource entry info */
409 rsc
= (void *)rproc
->table_ptr
+ rvring
->rvdev
->rsc_offset
;
410 rsc
->vring
[idx
].da
= 0;
411 rsc
->vring
[idx
].notifyid
= -1;
414 static int rproc_vdev_do_start(struct rproc_subdev
*subdev
)
416 struct rproc_vdev
*rvdev
= container_of(subdev
, struct rproc_vdev
, subdev
);
418 return rproc_add_virtio_dev(rvdev
, rvdev
->id
);
421 static void rproc_vdev_do_stop(struct rproc_subdev
*subdev
, bool crashed
)
423 struct rproc_vdev
*rvdev
= container_of(subdev
, struct rproc_vdev
, subdev
);
425 rproc_remove_virtio_dev(rvdev
);
429 * rproc_rvdev_release() - release the existence of a rvdev
431 * @dev: the subdevice's dev
433 static void rproc_rvdev_release(struct device
*dev
)
435 struct rproc_vdev
*rvdev
= container_of(dev
, struct rproc_vdev
, dev
);
437 of_reserved_mem_device_release(dev
);
443 * rproc_handle_vdev() - handle a vdev fw resource
444 * @rproc: the remote processor
445 * @rsc: the vring resource descriptor
446 * @avail: size of available data (for sanity checking the image)
448 * This resource entry requests the host to statically register a virtio
449 * device (vdev), and setup everything needed to support it. It contains
450 * everything needed to make it possible: the virtio device id, virtio
451 * device features, vrings information, virtio config space, etc...
453 * Before registering the vdev, the vrings are allocated from non-cacheable
454 * physically contiguous memory. Currently we only support two vrings per
455 * remote processor (temporary limitation). We might also want to consider
456 * doing the vring allocation only later when ->find_vqs() is invoked, and
457 * then release them upon ->del_vqs().
459 * Note: @da is currently not really handled correctly: we dynamically
460 * allocate it using the DMA API, ignoring requested hard coded addresses,
461 * and we don't take care of any required IOMMU programming. This is all
462 * going to be taken care of when the generic iommu-based DMA API will be
463 * merged. Meanwhile, statically-addressed iommu-based firmware images should
464 * use RSC_DEVMEM resource entries to map their required @da to the physical
465 * address of their base CMA region (ouch, hacky!).
467 * Returns 0 on success, or an appropriate error code otherwise
469 static int rproc_handle_vdev(struct rproc
*rproc
, struct fw_rsc_vdev
*rsc
,
470 int offset
, int avail
)
472 struct device
*dev
= &rproc
->dev
;
473 struct rproc_vdev
*rvdev
;
477 /* make sure resource isn't truncated */
478 if (sizeof(*rsc
) + rsc
->num_of_vrings
* sizeof(struct fw_rsc_vdev_vring
)
479 + rsc
->config_len
> avail
) {
480 dev_err(dev
, "vdev rsc is truncated\n");
484 /* make sure reserved bytes are zeroes */
485 if (rsc
->reserved
[0] || rsc
->reserved
[1]) {
486 dev_err(dev
, "vdev rsc has non zero reserved bytes\n");
490 dev_dbg(dev
, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
491 rsc
->id
, rsc
->dfeatures
, rsc
->config_len
, rsc
->num_of_vrings
);
493 /* we currently support only two vrings per rvdev */
494 if (rsc
->num_of_vrings
> ARRAY_SIZE(rvdev
->vring
)) {
495 dev_err(dev
, "too many vrings: %d\n", rsc
->num_of_vrings
);
499 rvdev
= kzalloc(sizeof(*rvdev
), GFP_KERNEL
);
503 kref_init(&rvdev
->refcount
);
506 rvdev
->rproc
= rproc
;
507 rvdev
->index
= rproc
->nb_vdev
++;
509 /* Initialise vdev subdevice */
510 snprintf(name
, sizeof(name
), "vdev%dbuffer", rvdev
->index
);
511 rvdev
->dev
.parent
= rproc
->dev
.parent
;
512 rvdev
->dev
.release
= rproc_rvdev_release
;
513 dev_set_name(&rvdev
->dev
, "%s#%s", dev_name(rvdev
->dev
.parent
), name
);
514 dev_set_drvdata(&rvdev
->dev
, rvdev
);
516 ret
= device_register(&rvdev
->dev
);
518 put_device(&rvdev
->dev
);
521 /* Make device dma capable by inheriting from parent's capabilities */
522 set_dma_ops(&rvdev
->dev
, get_dma_ops(rproc
->dev
.parent
));
524 ret
= dma_coerce_mask_and_coherent(&rvdev
->dev
,
525 dma_get_mask(rproc
->dev
.parent
));
528 "Failed to set DMA mask %llx. Trying to continue... %x\n",
529 dma_get_mask(rproc
->dev
.parent
), ret
);
532 /* parse the vrings */
533 for (i
= 0; i
< rsc
->num_of_vrings
; i
++) {
534 ret
= rproc_parse_vring(rvdev
, rsc
, i
);
539 /* remember the resource offset*/
540 rvdev
->rsc_offset
= offset
;
542 /* allocate the vring resources */
543 for (i
= 0; i
< rsc
->num_of_vrings
; i
++) {
544 ret
= rproc_alloc_vring(rvdev
, i
);
546 goto unwind_vring_allocations
;
549 list_add_tail(&rvdev
->node
, &rproc
->rvdevs
);
551 rvdev
->subdev
.start
= rproc_vdev_do_start
;
552 rvdev
->subdev
.stop
= rproc_vdev_do_stop
;
554 rproc_add_subdev(rproc
, &rvdev
->subdev
);
558 unwind_vring_allocations
:
559 for (i
--; i
>= 0; i
--)
560 rproc_free_vring(&rvdev
->vring
[i
]);
562 device_unregister(&rvdev
->dev
);
566 void rproc_vdev_release(struct kref
*ref
)
568 struct rproc_vdev
*rvdev
= container_of(ref
, struct rproc_vdev
, refcount
);
569 struct rproc_vring
*rvring
;
570 struct rproc
*rproc
= rvdev
->rproc
;
573 for (id
= 0; id
< ARRAY_SIZE(rvdev
->vring
); id
++) {
574 rvring
= &rvdev
->vring
[id
];
575 rproc_free_vring(rvring
);
578 rproc_remove_subdev(rproc
, &rvdev
->subdev
);
579 list_del(&rvdev
->node
);
580 device_unregister(&rvdev
->dev
);
584 * rproc_handle_trace() - handle a shared trace buffer resource
585 * @rproc: the remote processor
586 * @rsc: the trace resource descriptor
587 * @avail: size of available data (for sanity checking the image)
589 * In case the remote processor dumps trace logs into memory,
590 * export it via debugfs.
592 * Currently, the 'da' member of @rsc should contain the device address
593 * where the remote processor is dumping the traces. Later we could also
594 * support dynamically allocating this address using the generic
595 * DMA API (but currently there isn't a use case for that).
597 * Returns 0 on success, or an appropriate error code otherwise
599 static int rproc_handle_trace(struct rproc
*rproc
, struct fw_rsc_trace
*rsc
,
600 int offset
, int avail
)
602 struct rproc_mem_entry
*trace
;
603 struct device
*dev
= &rproc
->dev
;
607 if (sizeof(*rsc
) > avail
) {
608 dev_err(dev
, "trace rsc is truncated\n");
612 /* make sure reserved bytes are zeroes */
614 dev_err(dev
, "trace rsc has non zero reserved bytes\n");
618 /* what's the kernel address of this resource ? */
619 ptr
= rproc_da_to_va(rproc
, rsc
->da
, rsc
->len
);
621 dev_err(dev
, "erroneous trace resource entry\n");
625 trace
= kzalloc(sizeof(*trace
), GFP_KERNEL
);
629 /* set the trace buffer dma properties */
630 trace
->len
= rsc
->len
;
633 /* make sure snprintf always null terminates, even if truncating */
634 snprintf(name
, sizeof(name
), "trace%d", rproc
->num_traces
);
636 /* create the debugfs entry */
637 trace
->priv
= rproc_create_trace_file(name
, rproc
, trace
);
644 list_add_tail(&trace
->node
, &rproc
->traces
);
648 dev_dbg(dev
, "%s added: va %pK, da 0x%x, len 0x%x\n",
649 name
, ptr
, rsc
->da
, rsc
->len
);
655 * rproc_handle_devmem() - handle devmem resource entry
656 * @rproc: remote processor handle
657 * @rsc: the devmem resource entry
658 * @avail: size of available data (for sanity checking the image)
660 * Remote processors commonly need to access certain on-chip peripherals.
662 * Some of these remote processors access memory via an iommu device,
663 * and might require us to configure their iommu before they can access
664 * the on-chip peripherals they need.
666 * This resource entry is a request to map such a peripheral device.
668 * These devmem entries will contain the physical address of the device in
669 * the 'pa' member. If a specific device address is expected, then 'da' will
670 * contain it (currently this is the only use case supported). 'len' will
671 * contain the size of the physical region we need to map.
673 * Currently we just "trust" those devmem entries to contain valid physical
674 * addresses, but this is going to change: we want the implementations to
675 * tell us ranges of physical addresses the firmware is allowed to request,
676 * and not allow firmwares to request access to physical addresses that
677 * are outside those ranges.
679 static int rproc_handle_devmem(struct rproc
*rproc
, struct fw_rsc_devmem
*rsc
,
680 int offset
, int avail
)
682 struct rproc_mem_entry
*mapping
;
683 struct device
*dev
= &rproc
->dev
;
686 /* no point in handling this resource without a valid iommu domain */
690 if (sizeof(*rsc
) > avail
) {
691 dev_err(dev
, "devmem rsc is truncated\n");
695 /* make sure reserved bytes are zeroes */
697 dev_err(dev
, "devmem rsc has non zero reserved bytes\n");
701 mapping
= kzalloc(sizeof(*mapping
), GFP_KERNEL
);
705 ret
= iommu_map(rproc
->domain
, rsc
->da
, rsc
->pa
, rsc
->len
, rsc
->flags
);
707 dev_err(dev
, "failed to map devmem: %d\n", ret
);
712 * We'll need this info later when we'll want to unmap everything
713 * (e.g. on shutdown).
715 * We can't trust the remote processor not to change the resource
716 * table, so we must maintain this info independently.
718 mapping
->da
= rsc
->da
;
719 mapping
->len
= rsc
->len
;
720 list_add_tail(&mapping
->node
, &rproc
->mappings
);
722 dev_dbg(dev
, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
723 rsc
->pa
, rsc
->da
, rsc
->len
);
733 * rproc_alloc_carveout() - allocated specified carveout
734 * @rproc: rproc handle
735 * @mem: the memory entry to allocate
737 * This function allocate specified memory entry @mem using
738 * dma_alloc_coherent() as default allocator
740 static int rproc_alloc_carveout(struct rproc
*rproc
,
741 struct rproc_mem_entry
*mem
)
743 struct rproc_mem_entry
*mapping
= NULL
;
744 struct device
*dev
= &rproc
->dev
;
749 va
= dma_alloc_coherent(dev
->parent
, mem
->len
, &dma
, GFP_KERNEL
);
752 "failed to allocate dma memory: len 0x%x\n", mem
->len
);
756 dev_dbg(dev
, "carveout va %pK, dma %pad, len 0x%x\n",
760 * Ok, this is non-standard.
762 * Sometimes we can't rely on the generic iommu-based DMA API
763 * to dynamically allocate the device address and then set the IOMMU
764 * tables accordingly, because some remote processors might
765 * _require_ us to use hard coded device addresses that their
766 * firmware was compiled with.
768 * In this case, we must use the IOMMU API directly and map
769 * the memory to the device address as expected by the remote
772 * Obviously such remote processor devices should not be configured
773 * to use the iommu-based DMA API: we expect 'dma' to contain the
774 * physical address in this case.
777 if (mem
->da
!= FW_RSC_ADDR_ANY
) {
778 if (!rproc
->domain
) {
780 "Bad carveout rsc configuration\n");
785 mapping
= kzalloc(sizeof(*mapping
), GFP_KERNEL
);
791 ret
= iommu_map(rproc
->domain
, mem
->da
, dma
, mem
->len
,
794 dev_err(dev
, "iommu_map failed: %d\n", ret
);
799 * We'll need this info later when we'll want to unmap
800 * everything (e.g. on shutdown).
802 * We can't trust the remote processor not to change the
803 * resource table, so we must maintain this info independently.
805 mapping
->da
= mem
->da
;
806 mapping
->len
= mem
->len
;
807 list_add_tail(&mapping
->node
, &rproc
->mappings
);
809 dev_dbg(dev
, "carveout mapped 0x%x to %pad\n",
823 dma_free_coherent(dev
->parent
, mem
->len
, va
, dma
);
828 * rproc_release_carveout() - release acquired carveout
829 * @rproc: rproc handle
830 * @mem: the memory entry to release
832 * This function releases specified memory entry @mem allocated via
833 * rproc_alloc_carveout() function by @rproc.
835 static int rproc_release_carveout(struct rproc
*rproc
,
836 struct rproc_mem_entry
*mem
)
838 struct device
*dev
= &rproc
->dev
;
840 /* clean up carveout allocations */
841 dma_free_coherent(dev
->parent
, mem
->len
, mem
->va
, mem
->dma
);
846 * rproc_handle_carveout() - handle phys contig memory allocation requests
847 * @rproc: rproc handle
848 * @rsc: the resource entry
849 * @avail: size of available data (for image validation)
851 * This function will handle firmware requests for allocation of physically
852 * contiguous memory regions.
854 * These request entries should come first in the firmware's resource table,
855 * as other firmware entries might request placing other data objects inside
856 * these memory regions (e.g. data/code segments, trace resource entries, ...).
858 * Allocating memory this way helps utilizing the reserved physical memory
859 * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
860 * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
861 * pressure is important; it may have a substantial impact on performance.
863 static int rproc_handle_carveout(struct rproc
*rproc
,
864 struct fw_rsc_carveout
*rsc
,
865 int offset
, int avail
)
867 struct rproc_mem_entry
*carveout
;
868 struct device
*dev
= &rproc
->dev
;
870 if (sizeof(*rsc
) > avail
) {
871 dev_err(dev
, "carveout rsc is truncated\n");
875 /* make sure reserved bytes are zeroes */
877 dev_err(dev
, "carveout rsc has non zero reserved bytes\n");
881 dev_dbg(dev
, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
882 rsc
->name
, rsc
->da
, rsc
->pa
, rsc
->len
, rsc
->flags
);
885 * Check carveout rsc already part of a registered carveout,
886 * Search by name, then check the da and length
888 carveout
= rproc_find_carveout_by_name(rproc
, rsc
->name
);
891 if (carveout
->rsc_offset
!= FW_RSC_ADDR_ANY
) {
893 "Carveout already associated to resource table\n");
897 if (rproc_check_carveout_da(rproc
, carveout
, rsc
->da
, rsc
->len
))
900 /* Update memory carveout with resource table info */
901 carveout
->rsc_offset
= offset
;
902 carveout
->flags
= rsc
->flags
;
907 /* Register carveout in in list */
908 carveout
= rproc_mem_entry_init(dev
, 0, 0, rsc
->len
, rsc
->da
,
909 rproc_alloc_carveout
,
910 rproc_release_carveout
, rsc
->name
);
912 dev_err(dev
, "Can't allocate memory entry structure\n");
916 carveout
->flags
= rsc
->flags
;
917 carveout
->rsc_offset
= offset
;
918 rproc_add_carveout(rproc
, carveout
);
924 * rproc_add_carveout() - register an allocated carveout region
925 * @rproc: rproc handle
926 * @mem: memory entry to register
928 * This function registers specified memory entry in @rproc carveouts list.
929 * Specified carveout should have been allocated before registering.
931 void rproc_add_carveout(struct rproc
*rproc
, struct rproc_mem_entry
*mem
)
933 list_add_tail(&mem
->node
, &rproc
->carveouts
);
935 EXPORT_SYMBOL(rproc_add_carveout
);
938 * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct
939 * @dev: pointer on device struct
940 * @va: virtual address
942 * @len: memory carveout length
943 * @da: device address
944 * @release: memory carveout function
945 * @name: carveout name
947 * This function allocates a rproc_mem_entry struct and fill it with parameters
948 * provided by client.
950 struct rproc_mem_entry
*
951 rproc_mem_entry_init(struct device
*dev
,
952 void *va
, dma_addr_t dma
, int len
, u32 da
,
953 int (*alloc
)(struct rproc
*, struct rproc_mem_entry
*),
954 int (*release
)(struct rproc
*, struct rproc_mem_entry
*),
955 const char *name
, ...)
957 struct rproc_mem_entry
*mem
;
960 mem
= kzalloc(sizeof(*mem
), GFP_KERNEL
);
969 mem
->release
= release
;
970 mem
->rsc_offset
= FW_RSC_ADDR_ANY
;
971 mem
->of_resm_idx
= -1;
973 va_start(args
, name
);
974 vsnprintf(mem
->name
, sizeof(mem
->name
), name
, args
);
979 EXPORT_SYMBOL(rproc_mem_entry_init
);
982 * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct
983 * from a reserved memory phandle
984 * @dev: pointer on device struct
985 * @of_resm_idx: reserved memory phandle index in "memory-region"
986 * @len: memory carveout length
987 * @da: device address
988 * @name: carveout name
990 * This function allocates a rproc_mem_entry struct and fill it with parameters
991 * provided by client.
993 struct rproc_mem_entry
*
994 rproc_of_resm_mem_entry_init(struct device
*dev
, u32 of_resm_idx
, int len
,
995 u32 da
, const char *name
, ...)
997 struct rproc_mem_entry
*mem
;
1000 mem
= kzalloc(sizeof(*mem
), GFP_KERNEL
);
1006 mem
->rsc_offset
= FW_RSC_ADDR_ANY
;
1007 mem
->of_resm_idx
= of_resm_idx
;
1009 va_start(args
, name
);
1010 vsnprintf(mem
->name
, sizeof(mem
->name
), name
, args
);
1015 EXPORT_SYMBOL(rproc_of_resm_mem_entry_init
);
1018 * A lookup table for resource handlers. The indices are defined in
1019 * enum fw_resource_type.
1021 static rproc_handle_resource_t rproc_loading_handlers
[RSC_LAST
] = {
1022 [RSC_CARVEOUT
] = (rproc_handle_resource_t
)rproc_handle_carveout
,
1023 [RSC_DEVMEM
] = (rproc_handle_resource_t
)rproc_handle_devmem
,
1024 [RSC_TRACE
] = (rproc_handle_resource_t
)rproc_handle_trace
,
1025 [RSC_VDEV
] = (rproc_handle_resource_t
)rproc_handle_vdev
,
1028 /* handle firmware resource entries before booting the remote processor */
1029 static int rproc_handle_resources(struct rproc
*rproc
,
1030 rproc_handle_resource_t handlers
[RSC_LAST
])
1032 struct device
*dev
= &rproc
->dev
;
1033 rproc_handle_resource_t handler
;
1036 if (!rproc
->table_ptr
)
1039 for (i
= 0; i
< rproc
->table_ptr
->num
; i
++) {
1040 int offset
= rproc
->table_ptr
->offset
[i
];
1041 struct fw_rsc_hdr
*hdr
= (void *)rproc
->table_ptr
+ offset
;
1042 int avail
= rproc
->table_sz
- offset
- sizeof(*hdr
);
1043 void *rsc
= (void *)hdr
+ sizeof(*hdr
);
1045 /* make sure table isn't truncated */
1047 dev_err(dev
, "rsc table is truncated\n");
1051 dev_dbg(dev
, "rsc: type %d\n", hdr
->type
);
1053 if (hdr
->type
>= RSC_LAST
) {
1054 dev_warn(dev
, "unsupported resource %d\n", hdr
->type
);
1058 handler
= handlers
[hdr
->type
];
1062 ret
= handler(rproc
, rsc
, offset
+ sizeof(*hdr
), avail
);
1070 static int rproc_prepare_subdevices(struct rproc
*rproc
)
1072 struct rproc_subdev
*subdev
;
1075 list_for_each_entry(subdev
, &rproc
->subdevs
, node
) {
1076 if (subdev
->prepare
) {
1077 ret
= subdev
->prepare(subdev
);
1079 goto unroll_preparation
;
1086 list_for_each_entry_continue_reverse(subdev
, &rproc
->subdevs
, node
) {
1087 if (subdev
->unprepare
)
1088 subdev
->unprepare(subdev
);
1094 static int rproc_start_subdevices(struct rproc
*rproc
)
1096 struct rproc_subdev
*subdev
;
1099 list_for_each_entry(subdev
, &rproc
->subdevs
, node
) {
1100 if (subdev
->start
) {
1101 ret
= subdev
->start(subdev
);
1103 goto unroll_registration
;
1109 unroll_registration
:
1110 list_for_each_entry_continue_reverse(subdev
, &rproc
->subdevs
, node
) {
1112 subdev
->stop(subdev
, true);
1118 static void rproc_stop_subdevices(struct rproc
*rproc
, bool crashed
)
1120 struct rproc_subdev
*subdev
;
1122 list_for_each_entry_reverse(subdev
, &rproc
->subdevs
, node
) {
1124 subdev
->stop(subdev
, crashed
);
1128 static void rproc_unprepare_subdevices(struct rproc
*rproc
)
1130 struct rproc_subdev
*subdev
;
1132 list_for_each_entry_reverse(subdev
, &rproc
->subdevs
, node
) {
1133 if (subdev
->unprepare
)
1134 subdev
->unprepare(subdev
);
1139 * rproc_alloc_registered_carveouts() - allocate all carveouts registered
1141 * @rproc: the remote processor handle
1143 * This function parses registered carveout list, performs allocation
1144 * if alloc() ops registered and updates resource table information
1145 * if rsc_offset set.
1147 * Return: 0 on success
1149 static int rproc_alloc_registered_carveouts(struct rproc
*rproc
)
1151 struct rproc_mem_entry
*entry
, *tmp
;
1152 struct fw_rsc_carveout
*rsc
;
1153 struct device
*dev
= &rproc
->dev
;
1156 list_for_each_entry_safe(entry
, tmp
, &rproc
->carveouts
, node
) {
1158 ret
= entry
->alloc(rproc
, entry
);
1160 dev_err(dev
, "Unable to allocate carveout %s: %d\n",
1166 if (entry
->rsc_offset
!= FW_RSC_ADDR_ANY
) {
1167 /* update resource table */
1168 rsc
= (void *)rproc
->table_ptr
+ entry
->rsc_offset
;
1171 * Some remote processors might need to know the pa
1172 * even though they are behind an IOMMU. E.g., OMAP4's
1173 * remote M3 processor needs this so it can control
1174 * on-chip hardware accelerators that are not behind
1175 * the IOMMU, and therefor must know the pa.
1177 * Generally we don't want to expose physical addresses
1178 * if we don't have to (remote processors are generally
1179 * _not_ trusted), so we might want to do this only for
1180 * remote processor that _must_ have this (e.g. OMAP4's
1181 * dual M3 subsystem).
1183 * Non-IOMMU processors might also want to have this info.
1184 * In this case, the device address and the physical address
1188 /* Use va if defined else dma to generate pa */
1190 rsc
->pa
= (u32
)rproc_va_to_pa(entry
->va
);
1192 rsc
->pa
= (u32
)entry
->dma
;
1194 rsc
->da
= entry
->da
;
1195 rsc
->len
= entry
->len
;
1203 * rproc_coredump_cleanup() - clean up dump_segments list
1204 * @rproc: the remote processor handle
1206 static void rproc_coredump_cleanup(struct rproc
*rproc
)
1208 struct rproc_dump_segment
*entry
, *tmp
;
1210 list_for_each_entry_safe(entry
, tmp
, &rproc
->dump_segments
, node
) {
1211 list_del(&entry
->node
);
1217 * rproc_resource_cleanup() - clean up and free all acquired resources
1218 * @rproc: rproc handle
1220 * This function will free all resources acquired for @rproc, and it
1221 * is called whenever @rproc either shuts down or fails to boot.
1223 static void rproc_resource_cleanup(struct rproc
*rproc
)
1225 struct rproc_mem_entry
*entry
, *tmp
;
1226 struct rproc_vdev
*rvdev
, *rvtmp
;
1227 struct device
*dev
= &rproc
->dev
;
1229 /* clean up debugfs trace entries */
1230 list_for_each_entry_safe(entry
, tmp
, &rproc
->traces
, node
) {
1231 rproc_remove_trace_file(entry
->priv
);
1232 rproc
->num_traces
--;
1233 list_del(&entry
->node
);
1237 /* clean up iommu mapping entries */
1238 list_for_each_entry_safe(entry
, tmp
, &rproc
->mappings
, node
) {
1241 unmapped
= iommu_unmap(rproc
->domain
, entry
->da
, entry
->len
);
1242 if (unmapped
!= entry
->len
) {
1243 /* nothing much to do besides complaining */
1244 dev_err(dev
, "failed to unmap %u/%zu\n", entry
->len
,
1248 list_del(&entry
->node
);
1252 /* clean up carveout allocations */
1253 list_for_each_entry_safe(entry
, tmp
, &rproc
->carveouts
, node
) {
1255 entry
->release(rproc
, entry
);
1256 list_del(&entry
->node
);
1260 /* clean up remote vdev entries */
1261 list_for_each_entry_safe(rvdev
, rvtmp
, &rproc
->rvdevs
, node
)
1262 kref_put(&rvdev
->refcount
, rproc_vdev_release
);
1264 rproc_coredump_cleanup(rproc
);
1267 static int rproc_start(struct rproc
*rproc
, const struct firmware
*fw
)
1269 struct resource_table
*loaded_table
;
1270 struct device
*dev
= &rproc
->dev
;
1273 /* load the ELF segments to memory */
1274 ret
= rproc_load_segments(rproc
, fw
);
1276 dev_err(dev
, "Failed to load program segments: %d\n", ret
);
1281 * The starting device has been given the rproc->cached_table as the
1282 * resource table. The address of the vring along with the other
1283 * allocated resources (carveouts etc) is stored in cached_table.
1284 * In order to pass this information to the remote device we must copy
1285 * this information to device memory. We also update the table_ptr so
1286 * that any subsequent changes will be applied to the loaded version.
1288 loaded_table
= rproc_find_loaded_rsc_table(rproc
, fw
);
1290 memcpy(loaded_table
, rproc
->cached_table
, rproc
->table_sz
);
1291 rproc
->table_ptr
= loaded_table
;
1294 ret
= rproc_prepare_subdevices(rproc
);
1296 dev_err(dev
, "failed to prepare subdevices for %s: %d\n",
1298 goto reset_table_ptr
;
1301 /* power up the remote processor */
1302 ret
= rproc
->ops
->start(rproc
);
1304 dev_err(dev
, "can't start rproc %s: %d\n", rproc
->name
, ret
);
1305 goto unprepare_subdevices
;
1308 /* Start any subdevices for the remote processor */
1309 ret
= rproc_start_subdevices(rproc
);
1311 dev_err(dev
, "failed to probe subdevices for %s: %d\n",
1316 rproc
->state
= RPROC_RUNNING
;
1318 dev_info(dev
, "remote processor %s is now up\n", rproc
->name
);
1323 rproc
->ops
->stop(rproc
);
1324 unprepare_subdevices
:
1325 rproc_unprepare_subdevices(rproc
);
1327 rproc
->table_ptr
= rproc
->cached_table
;
1333 * take a firmware and boot a remote processor with it.
1335 static int rproc_fw_boot(struct rproc
*rproc
, const struct firmware
*fw
)
1337 struct device
*dev
= &rproc
->dev
;
1338 const char *name
= rproc
->firmware
;
1341 ret
= rproc_fw_sanity_check(rproc
, fw
);
1345 dev_info(dev
, "Booting fw image %s, size %zd\n", name
, fw
->size
);
1348 * if enabling an IOMMU isn't relevant for this rproc, this is
1351 ret
= rproc_enable_iommu(rproc
);
1353 dev_err(dev
, "can't enable iommu: %d\n", ret
);
1357 rproc
->bootaddr
= rproc_get_boot_addr(rproc
, fw
);
1359 /* Load resource table, core dump segment list etc from the firmware */
1360 ret
= rproc_parse_fw(rproc
, fw
);
1364 /* reset max_notifyid */
1365 rproc
->max_notifyid
= -1;
1367 /* reset handled vdev */
1370 /* handle fw resources which are required to boot rproc */
1371 ret
= rproc_handle_resources(rproc
, rproc_loading_handlers
);
1373 dev_err(dev
, "Failed to process resources: %d\n", ret
);
1374 goto clean_up_resources
;
1377 /* Allocate carveout resources associated to rproc */
1378 ret
= rproc_alloc_registered_carveouts(rproc
);
1380 dev_err(dev
, "Failed to allocate associated carveouts: %d\n",
1382 goto clean_up_resources
;
1385 ret
= rproc_start(rproc
, fw
);
1387 goto clean_up_resources
;
1392 rproc_resource_cleanup(rproc
);
1393 kfree(rproc
->cached_table
);
1394 rproc
->cached_table
= NULL
;
1395 rproc
->table_ptr
= NULL
;
1397 rproc_disable_iommu(rproc
);
1402 * take a firmware and boot it up.
1404 * Note: this function is called asynchronously upon registration of the
1405 * remote processor (so we must wait until it completes before we try
1406 * to unregister the device. one other option is just to use kref here,
1407 * that might be cleaner).
1409 static void rproc_auto_boot_callback(const struct firmware
*fw
, void *context
)
1411 struct rproc
*rproc
= context
;
1415 release_firmware(fw
);
1418 static int rproc_trigger_auto_boot(struct rproc
*rproc
)
1423 * We're initiating an asynchronous firmware loading, so we can
1424 * be built-in kernel code, without hanging the boot process.
1426 ret
= request_firmware_nowait(THIS_MODULE
, FW_ACTION_HOTPLUG
,
1427 rproc
->firmware
, &rproc
->dev
, GFP_KERNEL
,
1428 rproc
, rproc_auto_boot_callback
);
1430 dev_err(&rproc
->dev
, "request_firmware_nowait err: %d\n", ret
);
1435 static int rproc_stop(struct rproc
*rproc
, bool crashed
)
1437 struct device
*dev
= &rproc
->dev
;
1440 /* Stop any subdevices for the remote processor */
1441 rproc_stop_subdevices(rproc
, crashed
);
1443 /* the installed resource table is no longer accessible */
1444 rproc
->table_ptr
= rproc
->cached_table
;
1446 /* power off the remote processor */
1447 ret
= rproc
->ops
->stop(rproc
);
1449 dev_err(dev
, "can't stop rproc: %d\n", ret
);
1453 rproc_unprepare_subdevices(rproc
);
1455 rproc
->state
= RPROC_OFFLINE
;
1457 dev_info(dev
, "stopped remote processor %s\n", rproc
->name
);
1463 * rproc_coredump_add_segment() - add segment of device memory to coredump
1464 * @rproc: handle of a remote processor
1465 * @da: device address
1466 * @size: size of segment
1468 * Add device memory to the list of segments to be included in a coredump for
1471 * Return: 0 on success, negative errno on error.
1473 int rproc_coredump_add_segment(struct rproc
*rproc
, dma_addr_t da
, size_t size
)
1475 struct rproc_dump_segment
*segment
;
1477 segment
= kzalloc(sizeof(*segment
), GFP_KERNEL
);
1482 segment
->size
= size
;
1484 list_add_tail(&segment
->node
, &rproc
->dump_segments
);
1488 EXPORT_SYMBOL(rproc_coredump_add_segment
);
1491 * rproc_coredump_add_custom_segment() - add custom coredump segment
1492 * @rproc: handle of a remote processor
1493 * @da: device address
1494 * @size: size of segment
1495 * @dumpfn: custom dump function called for each segment during coredump
1496 * @priv: private data
1498 * Add device memory to the list of segments to be included in the coredump
1499 * and associate the segment with the given custom dump function and private
1502 * Return: 0 on success, negative errno on error.
1504 int rproc_coredump_add_custom_segment(struct rproc
*rproc
,
1505 dma_addr_t da
, size_t size
,
1506 void (*dumpfn
)(struct rproc
*rproc
,
1507 struct rproc_dump_segment
*segment
,
1511 struct rproc_dump_segment
*segment
;
1513 segment
= kzalloc(sizeof(*segment
), GFP_KERNEL
);
1518 segment
->size
= size
;
1519 segment
->priv
= priv
;
1520 segment
->dump
= dumpfn
;
1522 list_add_tail(&segment
->node
, &rproc
->dump_segments
);
1526 EXPORT_SYMBOL(rproc_coredump_add_custom_segment
);
1529 * rproc_coredump() - perform coredump
1530 * @rproc: rproc handle
1532 * This function will generate an ELF header for the registered segments
1533 * and create a devcoredump device associated with rproc.
1535 static void rproc_coredump(struct rproc
*rproc
)
1537 struct rproc_dump_segment
*segment
;
1538 struct elf32_phdr
*phdr
;
1539 struct elf32_hdr
*ehdr
;
1546 if (list_empty(&rproc
->dump_segments
))
1549 data_size
= sizeof(*ehdr
);
1550 list_for_each_entry(segment
, &rproc
->dump_segments
, node
) {
1551 data_size
+= sizeof(*phdr
) + segment
->size
;
1556 data
= vmalloc(data_size
);
1562 memset(ehdr
, 0, sizeof(*ehdr
));
1563 memcpy(ehdr
->e_ident
, ELFMAG
, SELFMAG
);
1564 ehdr
->e_ident
[EI_CLASS
] = ELFCLASS32
;
1565 ehdr
->e_ident
[EI_DATA
] = ELFDATA2LSB
;
1566 ehdr
->e_ident
[EI_VERSION
] = EV_CURRENT
;
1567 ehdr
->e_ident
[EI_OSABI
] = ELFOSABI_NONE
;
1568 ehdr
->e_type
= ET_CORE
;
1569 ehdr
->e_machine
= EM_NONE
;
1570 ehdr
->e_version
= EV_CURRENT
;
1571 ehdr
->e_entry
= rproc
->bootaddr
;
1572 ehdr
->e_phoff
= sizeof(*ehdr
);
1573 ehdr
->e_ehsize
= sizeof(*ehdr
);
1574 ehdr
->e_phentsize
= sizeof(*phdr
);
1575 ehdr
->e_phnum
= phnum
;
1577 phdr
= data
+ ehdr
->e_phoff
;
1578 offset
= ehdr
->e_phoff
+ sizeof(*phdr
) * ehdr
->e_phnum
;
1579 list_for_each_entry(segment
, &rproc
->dump_segments
, node
) {
1580 memset(phdr
, 0, sizeof(*phdr
));
1581 phdr
->p_type
= PT_LOAD
;
1582 phdr
->p_offset
= offset
;
1583 phdr
->p_vaddr
= segment
->da
;
1584 phdr
->p_paddr
= segment
->da
;
1585 phdr
->p_filesz
= segment
->size
;
1586 phdr
->p_memsz
= segment
->size
;
1587 phdr
->p_flags
= PF_R
| PF_W
| PF_X
;
1590 if (segment
->dump
) {
1591 segment
->dump(rproc
, segment
, data
+ offset
);
1593 ptr
= rproc_da_to_va(rproc
, segment
->da
, segment
->size
);
1595 dev_err(&rproc
->dev
,
1596 "invalid coredump segment (%pad, %zu)\n",
1597 &segment
->da
, segment
->size
);
1598 memset(data
+ offset
, 0xff, segment
->size
);
1600 memcpy(data
+ offset
, ptr
, segment
->size
);
1604 offset
+= phdr
->p_filesz
;
1608 dev_coredumpv(&rproc
->dev
, data
, data_size
, GFP_KERNEL
);
1612 * rproc_trigger_recovery() - recover a remoteproc
1613 * @rproc: the remote processor
1615 * The recovery is done by resetting all the virtio devices, that way all the
1616 * rpmsg drivers will be reseted along with the remote processor making the
1617 * remoteproc functional again.
1619 * This function can sleep, so it cannot be called from atomic context.
1621 int rproc_trigger_recovery(struct rproc
*rproc
)
1623 const struct firmware
*firmware_p
;
1624 struct device
*dev
= &rproc
->dev
;
1627 dev_err(dev
, "recovering %s\n", rproc
->name
);
1629 ret
= mutex_lock_interruptible(&rproc
->lock
);
1633 ret
= rproc_stop(rproc
, true);
1637 /* generate coredump */
1638 rproc_coredump(rproc
);
1641 ret
= request_firmware(&firmware_p
, rproc
->firmware
, dev
);
1643 dev_err(dev
, "request_firmware failed: %d\n", ret
);
1647 /* boot the remote processor up again */
1648 ret
= rproc_start(rproc
, firmware_p
);
1650 release_firmware(firmware_p
);
1653 mutex_unlock(&rproc
->lock
);
1658 * rproc_crash_handler_work() - handle a crash
1660 * This function needs to handle everything related to a crash, like cpu
1661 * registers and stack dump, information to help to debug the fatal error, etc.
1663 static void rproc_crash_handler_work(struct work_struct
*work
)
1665 struct rproc
*rproc
= container_of(work
, struct rproc
, crash_handler
);
1666 struct device
*dev
= &rproc
->dev
;
1668 dev_dbg(dev
, "enter %s\n", __func__
);
1670 mutex_lock(&rproc
->lock
);
1672 if (rproc
->state
== RPROC_CRASHED
|| rproc
->state
== RPROC_OFFLINE
) {
1673 /* handle only the first crash detected */
1674 mutex_unlock(&rproc
->lock
);
1678 rproc
->state
= RPROC_CRASHED
;
1679 dev_err(dev
, "handling crash #%u in %s\n", ++rproc
->crash_cnt
,
1682 mutex_unlock(&rproc
->lock
);
1684 if (!rproc
->recovery_disabled
)
1685 rproc_trigger_recovery(rproc
);
1689 * rproc_boot() - boot a remote processor
1690 * @rproc: handle of a remote processor
1692 * Boot a remote processor (i.e. load its firmware, power it on, ...).
1694 * If the remote processor is already powered on, this function immediately
1695 * returns (successfully).
1697 * Returns 0 on success, and an appropriate error value otherwise.
1699 int rproc_boot(struct rproc
*rproc
)
1701 const struct firmware
*firmware_p
;
1706 pr_err("invalid rproc handle\n");
1712 ret
= mutex_lock_interruptible(&rproc
->lock
);
1714 dev_err(dev
, "can't lock rproc %s: %d\n", rproc
->name
, ret
);
1718 if (rproc
->state
== RPROC_DELETED
) {
1720 dev_err(dev
, "can't boot deleted rproc %s\n", rproc
->name
);
1724 /* skip the boot process if rproc is already powered up */
1725 if (atomic_inc_return(&rproc
->power
) > 1) {
1730 dev_info(dev
, "powering up %s\n", rproc
->name
);
1733 ret
= request_firmware(&firmware_p
, rproc
->firmware
, dev
);
1735 dev_err(dev
, "request_firmware failed: %d\n", ret
);
1739 ret
= rproc_fw_boot(rproc
, firmware_p
);
1741 release_firmware(firmware_p
);
1745 atomic_dec(&rproc
->power
);
1747 mutex_unlock(&rproc
->lock
);
1750 EXPORT_SYMBOL(rproc_boot
);
1753 * rproc_shutdown() - power off the remote processor
1754 * @rproc: the remote processor
1756 * Power off a remote processor (previously booted with rproc_boot()).
1758 * In case @rproc is still being used by an additional user(s), then
1759 * this function will just decrement the power refcount and exit,
1760 * without really powering off the device.
1762 * Every call to rproc_boot() must (eventually) be accompanied by a call
1763 * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1766 * - we're not decrementing the rproc's refcount, only the power refcount.
1767 * which means that the @rproc handle stays valid even after rproc_shutdown()
1768 * returns, and users can still use it with a subsequent rproc_boot(), if
1771 void rproc_shutdown(struct rproc
*rproc
)
1773 struct device
*dev
= &rproc
->dev
;
1776 ret
= mutex_lock_interruptible(&rproc
->lock
);
1778 dev_err(dev
, "can't lock rproc %s: %d\n", rproc
->name
, ret
);
1782 /* if the remote proc is still needed, bail out */
1783 if (!atomic_dec_and_test(&rproc
->power
))
1786 ret
= rproc_stop(rproc
, false);
1788 atomic_inc(&rproc
->power
);
1792 /* clean up all acquired resources */
1793 rproc_resource_cleanup(rproc
);
1795 rproc_disable_iommu(rproc
);
1797 /* Free the copy of the resource table */
1798 kfree(rproc
->cached_table
);
1799 rproc
->cached_table
= NULL
;
1800 rproc
->table_ptr
= NULL
;
1802 mutex_unlock(&rproc
->lock
);
1804 EXPORT_SYMBOL(rproc_shutdown
);
1807 * rproc_get_by_phandle() - find a remote processor by phandle
1808 * @phandle: phandle to the rproc
1810 * Finds an rproc handle using the remote processor's phandle, and then
1811 * return a handle to the rproc.
1813 * This function increments the remote processor's refcount, so always
1814 * use rproc_put() to decrement it back once rproc isn't needed anymore.
1816 * Returns the rproc handle on success, and NULL on failure.
1819 struct rproc
*rproc_get_by_phandle(phandle phandle
)
1821 struct rproc
*rproc
= NULL
, *r
;
1822 struct device_node
*np
;
1824 np
= of_find_node_by_phandle(phandle
);
1828 mutex_lock(&rproc_list_mutex
);
1829 list_for_each_entry(r
, &rproc_list
, node
) {
1830 if (r
->dev
.parent
&& r
->dev
.parent
->of_node
== np
) {
1831 /* prevent underlying implementation from being removed */
1832 if (!try_module_get(r
->dev
.parent
->driver
->owner
)) {
1833 dev_err(&r
->dev
, "can't get owner\n");
1838 get_device(&rproc
->dev
);
1842 mutex_unlock(&rproc_list_mutex
);
1849 struct rproc
*rproc_get_by_phandle(phandle phandle
)
1854 EXPORT_SYMBOL(rproc_get_by_phandle
);
1857 * rproc_add() - register a remote processor
1858 * @rproc: the remote processor handle to register
1860 * Registers @rproc with the remoteproc framework, after it has been
1861 * allocated with rproc_alloc().
1863 * This is called by the platform-specific rproc implementation, whenever
1864 * a new remote processor device is probed.
1866 * Returns 0 on success and an appropriate error code otherwise.
1868 * Note: this function initiates an asynchronous firmware loading
1869 * context, which will look for virtio devices supported by the rproc's
1872 * If found, those virtio devices will be created and added, so as a result
1873 * of registering this remote processor, additional virtio drivers might be
1876 int rproc_add(struct rproc
*rproc
)
1878 struct device
*dev
= &rproc
->dev
;
1881 ret
= device_add(dev
);
1885 dev_info(dev
, "%s is available\n", rproc
->name
);
1887 /* create debugfs entries */
1888 rproc_create_debug_dir(rproc
);
1890 /* if rproc is marked always-on, request it to boot */
1891 if (rproc
->auto_boot
) {
1892 ret
= rproc_trigger_auto_boot(rproc
);
1897 /* expose to rproc_get_by_phandle users */
1898 mutex_lock(&rproc_list_mutex
);
1899 list_add(&rproc
->node
, &rproc_list
);
1900 mutex_unlock(&rproc_list_mutex
);
1904 EXPORT_SYMBOL(rproc_add
);
1907 * rproc_type_release() - release a remote processor instance
1908 * @dev: the rproc's device
1910 * This function should _never_ be called directly.
1912 * It will be called by the driver core when no one holds a valid pointer
1915 static void rproc_type_release(struct device
*dev
)
1917 struct rproc
*rproc
= container_of(dev
, struct rproc
, dev
);
1919 dev_info(&rproc
->dev
, "releasing %s\n", rproc
->name
);
1921 idr_destroy(&rproc
->notifyids
);
1923 if (rproc
->index
>= 0)
1924 ida_simple_remove(&rproc_dev_index
, rproc
->index
);
1926 kfree(rproc
->firmware
);
1931 static const struct device_type rproc_type
= {
1932 .name
= "remoteproc",
1933 .release
= rproc_type_release
,
1937 * rproc_alloc() - allocate a remote processor handle
1938 * @dev: the underlying device
1939 * @name: name of this remote processor
1940 * @ops: platform-specific handlers (mainly start/stop)
1941 * @firmware: name of firmware file to load, can be NULL
1942 * @len: length of private data needed by the rproc driver (in bytes)
1944 * Allocates a new remote processor handle, but does not register
1945 * it yet. if @firmware is NULL, a default name is used.
1947 * This function should be used by rproc implementations during initialization
1948 * of the remote processor.
1950 * After creating an rproc handle using this function, and when ready,
1951 * implementations should then call rproc_add() to complete
1952 * the registration of the remote processor.
1954 * On success the new rproc is returned, and on failure, NULL.
1956 * Note: _never_ directly deallocate @rproc, even if it was not registered
1957 * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
1959 struct rproc
*rproc_alloc(struct device
*dev
, const char *name
,
1960 const struct rproc_ops
*ops
,
1961 const char *firmware
, int len
)
1963 struct rproc
*rproc
;
1964 char *p
, *template = "rproc-%s-fw";
1967 if (!dev
|| !name
|| !ops
)
1972 * If the caller didn't pass in a firmware name then
1973 * construct a default name.
1975 name_len
= strlen(name
) + strlen(template) - 2 + 1;
1976 p
= kmalloc(name_len
, GFP_KERNEL
);
1979 snprintf(p
, name_len
, template, name
);
1981 p
= kstrdup(firmware
, GFP_KERNEL
);
1986 rproc
= kzalloc(sizeof(struct rproc
) + len
, GFP_KERNEL
);
1992 rproc
->ops
= kmemdup(ops
, sizeof(*ops
), GFP_KERNEL
);
1999 rproc
->firmware
= p
;
2001 rproc
->priv
= &rproc
[1];
2002 rproc
->auto_boot
= true;
2004 device_initialize(&rproc
->dev
);
2005 rproc
->dev
.parent
= dev
;
2006 rproc
->dev
.type
= &rproc_type
;
2007 rproc
->dev
.class = &rproc_class
;
2008 rproc
->dev
.driver_data
= rproc
;
2010 /* Assign a unique device index and name */
2011 rproc
->index
= ida_simple_get(&rproc_dev_index
, 0, 0, GFP_KERNEL
);
2012 if (rproc
->index
< 0) {
2013 dev_err(dev
, "ida_simple_get failed: %d\n", rproc
->index
);
2014 put_device(&rproc
->dev
);
2018 dev_set_name(&rproc
->dev
, "remoteproc%d", rproc
->index
);
2020 atomic_set(&rproc
->power
, 0);
2022 /* Default to ELF loader if no load function is specified */
2023 if (!rproc
->ops
->load
) {
2024 rproc
->ops
->load
= rproc_elf_load_segments
;
2025 rproc
->ops
->parse_fw
= rproc_elf_load_rsc_table
;
2026 rproc
->ops
->find_loaded_rsc_table
= rproc_elf_find_loaded_rsc_table
;
2027 rproc
->ops
->sanity_check
= rproc_elf_sanity_check
;
2028 rproc
->ops
->get_boot_addr
= rproc_elf_get_boot_addr
;
2031 mutex_init(&rproc
->lock
);
2033 idr_init(&rproc
->notifyids
);
2035 INIT_LIST_HEAD(&rproc
->carveouts
);
2036 INIT_LIST_HEAD(&rproc
->mappings
);
2037 INIT_LIST_HEAD(&rproc
->traces
);
2038 INIT_LIST_HEAD(&rproc
->rvdevs
);
2039 INIT_LIST_HEAD(&rproc
->subdevs
);
2040 INIT_LIST_HEAD(&rproc
->dump_segments
);
2042 INIT_WORK(&rproc
->crash_handler
, rproc_crash_handler_work
);
2044 rproc
->state
= RPROC_OFFLINE
;
2048 EXPORT_SYMBOL(rproc_alloc
);
2051 * rproc_free() - unroll rproc_alloc()
2052 * @rproc: the remote processor handle
2054 * This function decrements the rproc dev refcount.
2056 * If no one holds any reference to rproc anymore, then its refcount would
2057 * now drop to zero, and it would be freed.
2059 void rproc_free(struct rproc
*rproc
)
2061 put_device(&rproc
->dev
);
2063 EXPORT_SYMBOL(rproc_free
);
2066 * rproc_put() - release rproc reference
2067 * @rproc: the remote processor handle
2069 * This function decrements the rproc dev refcount.
2071 * If no one holds any reference to rproc anymore, then its refcount would
2072 * now drop to zero, and it would be freed.
2074 void rproc_put(struct rproc
*rproc
)
2076 module_put(rproc
->dev
.parent
->driver
->owner
);
2077 put_device(&rproc
->dev
);
2079 EXPORT_SYMBOL(rproc_put
);
2082 * rproc_del() - unregister a remote processor
2083 * @rproc: rproc handle to unregister
2085 * This function should be called when the platform specific rproc
2086 * implementation decides to remove the rproc device. it should
2087 * _only_ be called if a previous invocation of rproc_add()
2088 * has completed successfully.
2090 * After rproc_del() returns, @rproc isn't freed yet, because
2091 * of the outstanding reference created by rproc_alloc. To decrement that
2092 * one last refcount, one still needs to call rproc_free().
2094 * Returns 0 on success and -EINVAL if @rproc isn't valid.
2096 int rproc_del(struct rproc
*rproc
)
2101 /* if rproc is marked always-on, rproc_add() booted it */
2102 /* TODO: make sure this works with rproc->power > 1 */
2103 if (rproc
->auto_boot
)
2104 rproc_shutdown(rproc
);
2106 mutex_lock(&rproc
->lock
);
2107 rproc
->state
= RPROC_DELETED
;
2108 mutex_unlock(&rproc
->lock
);
2110 rproc_delete_debug_dir(rproc
);
2112 /* the rproc is downref'ed as soon as it's removed from the klist */
2113 mutex_lock(&rproc_list_mutex
);
2114 list_del(&rproc
->node
);
2115 mutex_unlock(&rproc_list_mutex
);
2117 device_del(&rproc
->dev
);
2121 EXPORT_SYMBOL(rproc_del
);
2124 * rproc_add_subdev() - add a subdevice to a remoteproc
2125 * @rproc: rproc handle to add the subdevice to
2126 * @subdev: subdev handle to register
2128 * Caller is responsible for populating optional subdevice function pointers.
2130 void rproc_add_subdev(struct rproc
*rproc
, struct rproc_subdev
*subdev
)
2132 list_add_tail(&subdev
->node
, &rproc
->subdevs
);
2134 EXPORT_SYMBOL(rproc_add_subdev
);
2137 * rproc_remove_subdev() - remove a subdevice from a remoteproc
2138 * @rproc: rproc handle to remove the subdevice from
2139 * @subdev: subdev handle, previously registered with rproc_add_subdev()
2141 void rproc_remove_subdev(struct rproc
*rproc
, struct rproc_subdev
*subdev
)
2143 list_del(&subdev
->node
);
2145 EXPORT_SYMBOL(rproc_remove_subdev
);
2148 * rproc_get_by_child() - acquire rproc handle of @dev's ancestor
2149 * @dev: child device to find ancestor of
2151 * Returns the ancestor rproc instance, or NULL if not found.
2153 struct rproc
*rproc_get_by_child(struct device
*dev
)
2155 for (dev
= dev
->parent
; dev
; dev
= dev
->parent
) {
2156 if (dev
->type
== &rproc_type
)
2157 return dev
->driver_data
;
2162 EXPORT_SYMBOL(rproc_get_by_child
);
2165 * rproc_report_crash() - rproc crash reporter function
2166 * @rproc: remote processor
2169 * This function must be called every time a crash is detected by the low-level
2170 * drivers implementing a specific remoteproc. This should not be called from a
2171 * non-remoteproc driver.
2173 * This function can be called from atomic/interrupt context.
2175 void rproc_report_crash(struct rproc
*rproc
, enum rproc_crash_type type
)
2178 pr_err("NULL rproc pointer\n");
2182 dev_err(&rproc
->dev
, "crash detected in %s: type %s\n",
2183 rproc
->name
, rproc_crash_to_string(type
));
2185 /* create a new task to handle the error */
2186 schedule_work(&rproc
->crash_handler
);
2188 EXPORT_SYMBOL(rproc_report_crash
);
2190 static int __init
remoteproc_init(void)
2193 rproc_init_debugfs();
2197 module_init(remoteproc_init
);
2199 static void __exit
remoteproc_exit(void)
2201 ida_destroy(&rproc_dev_index
);
2203 rproc_exit_debugfs();
2206 module_exit(remoteproc_exit
);
2208 MODULE_LICENSE("GPL v2");
2209 MODULE_DESCRIPTION("Generic Remote Processor Framework");