remoteproc: add an api to do pa to da conversion
[rpmsg/rpmsg.git] / drivers / remoteproc / remoteproc_core.c
1 /*
2  * Remote Processor Framework
3  *
4  * Copyright (C) 2011 Texas Instruments, Inc.
5  * Copyright (C) 2011 Google, Inc.
6  *
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>
14  *
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.
18  *
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.
23  */
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 <linux/of.h>
45 #include <linux/platform_device.h>
46 #include <asm/byteorder.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 /* Unique indices for remoteproc devices */
59 static DEFINE_IDA(rproc_dev_index);
61 static const char * const rproc_crash_names[] = {
62         [RPROC_MMUFAULT]        = "mmufault",
63         [RPROC_WATCHDOG]        = "watchdog",
64         [RPROC_FATAL_ERROR]     = "fatal error",
65 };
67 /* translate rproc_crash_type to string */
68 static const char *rproc_crash_to_string(enum rproc_crash_type type)
69 {
70         if (type < ARRAY_SIZE(rproc_crash_names))
71                 return rproc_crash_names[type];
72         return "unknown";
73 }
75 /*
76  * This is the IOMMU fault handler we register with the IOMMU API
77  * (when relevant; not all remote processors access memory through
78  * an IOMMU).
79  *
80  * IOMMU core will invoke this handler whenever the remote processor
81  * will try to access an unmapped device address.
82  */
83 static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
84                              unsigned long iova, int flags, void *token)
85 {
86         struct rproc *rproc = token;
88         dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
90         rproc_report_crash(rproc, RPROC_MMUFAULT);
92         /*
93          * Let the iommu core know we're not really handling this fault;
94          * we just used it as a recovery trigger.
95          */
96         return -ENOSYS;
97 }
99 static int rproc_enable_iommu(struct rproc *rproc)
101         struct iommu_domain *domain;
102         struct device *dev = rproc->dev.parent;
103         int ret;
105         if (!rproc->has_iommu) {
106                 dev_dbg(dev, "iommu not present\n");
107                 return 0;
108         }
110         domain = iommu_domain_alloc(dev->bus);
111         if (!domain) {
112                 dev_err(dev, "can't alloc iommu domain\n");
113                 return -ENOMEM;
114         }
116         iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
118         ret = iommu_attach_device(domain, dev);
119         if (ret) {
120                 dev_err(dev, "can't attach iommu device: %d\n", ret);
121                 goto free_domain;
122         }
124         rproc->domain = domain;
126         return 0;
128 free_domain:
129         iommu_domain_free(domain);
130         return ret;
133 static void rproc_disable_iommu(struct rproc *rproc)
135         struct iommu_domain *domain = rproc->domain;
136         struct device *dev = rproc->dev.parent;
138         if (!domain)
139                 return;
141         iommu_detach_device(domain, dev);
142         iommu_domain_free(domain);
145 /**
146  * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address
147  * @rproc: handle of a remote processor
148  * @da: remoteproc device address to translate
149  * @len: length of the memory region @da is pointing to
150  *
151  * Some remote processors will ask us to allocate them physically contiguous
152  * memory regions (which we call "carveouts"), and map them to specific
153  * device addresses (which are hardcoded in the firmware). They may also have
154  * dedicated memory regions internal to the processors, and use them either
155  * exclusively or alongside carveouts.
156  *
157  * They may then ask us to copy objects into specific device addresses (e.g.
158  * code/data sections) or expose us certain symbols in other device address
159  * (e.g. their trace buffer).
160  *
161  * This function is a helper function with which we can go over the allocated
162  * carveouts and translate specific device addresses to kernel virtual addresses
163  * so we can access the referenced memory. This function also allows to perform
164  * translations on the internal remoteproc memory regions through a platform
165  * implementation specific da_to_va ops, if present.
166  *
167  * The function returns a valid kernel address on success or NULL on failure.
168  *
169  * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
170  * but only on kernel direct mapped RAM memory. Instead, we're just using
171  * here the output of the DMA API for the carveouts, which should be more
172  * correct.
173  */
174 void *rproc_da_to_va(struct rproc *rproc, u64 da, int len)
176         struct rproc_mem_entry *carveout;
177         void *ptr = NULL;
179         if (rproc->ops->da_to_va) {
180                 ptr = rproc->ops->da_to_va(rproc, da, len);
181                 if (ptr)
182                         goto out;
183         }
185         list_for_each_entry(carveout, &rproc->carveouts, node) {
186                 int offset = da - carveout->da;
188                 /* try next carveout if da is too small */
189                 if (offset < 0)
190                         continue;
192                 /* try next carveout if da is too large */
193                 if (offset + len > carveout->len)
194                         continue;
196                 ptr = carveout->va + offset;
198                 break;
199         }
201 out:
202         return ptr;
204 EXPORT_SYMBOL(rproc_da_to_va);
206 /**
207  * rproc_pa_to_da() - lookup the rproc device address for a physical address
208  * @rproc: handle of a remote processor
209  * @pa: physical address of the buffer to translate
210  * @da: device address to return
211  *
212  * Communication clients of remote processors usually would need a means to
213  * convert a host buffer pointer to an equivalent device virtual address pointer
214  * that the code running on the remote processor can operate on. These buffer
215  * pointers can either be from the physically contiguous memory regions (or
216  * "carveouts") or can be some memory-mapped Device IO memory. This function
217  * provides a means to translate a given physical address to its associated
218  * device address.
219  *
220  * The function looks through both the carveouts and the device memory mappings
221  * since both of them are stored in separate lists.
222  *
223  * Returns 0 on success, or an appropriate error code otherwise. The translated
224  * device address is returned through the appropriate function argument.
225  */
226 int rproc_pa_to_da(struct rproc *rproc, phys_addr_t pa, u64 *da)
228         int ret = -EINVAL;
229         struct rproc_mem_entry *maps = NULL;
231         if (!rproc || !da)
232                 return -EINVAL;
234         if (mutex_lock_interruptible(&rproc->lock))
235                 return -EINTR;
237         if (rproc->state == RPROC_RUNNING || rproc->state == RPROC_SUSPENDED) {
238                 /* Look in the mappings first */
239                 list_for_each_entry(maps, &rproc->mappings, node) {
240                         if (pa >= maps->dma && pa < (maps->dma + maps->len)) {
241                                 *da = maps->da + (pa - maps->dma);
242                                 ret = 0;
243                                 goto exit;
244                         }
245                 }
246                 /* If not, check in the carveouts */
247                 list_for_each_entry(maps, &rproc->carveouts, node) {
248                         if (pa >= maps->dma && pa < (maps->dma + maps->len)) {
249                                 *da = maps->da + (pa - maps->dma);
250                                 ret = 0;
251                                 break;
252                         }
253                 }
254         }
255 exit:
256         mutex_unlock(&rproc->lock);
257         return ret;
259 EXPORT_SYMBOL(rproc_pa_to_da);
261 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
263         struct rproc *rproc = rvdev->rproc;
264         struct device *dev = &rproc->dev;
265         struct rproc_vring *rvring = &rvdev->vring[i];
266         struct fw_rsc_vdev *rsc;
267         dma_addr_t dma;
268         void *va;
269         int ret, size, notifyid;
271         /* actual size of vring (in bytes) */
272         size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
274         /*
275          * Allocate non-cacheable memory for the vring. In the future
276          * this call will also configure the IOMMU for us
277          */
278         va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL);
279         if (!va) {
280                 dev_err(dev->parent, "dma_alloc_coherent failed\n");
281                 return -EINVAL;
282         }
284         /*
285          * Assign an rproc-wide unique index for this vring
286          * TODO: assign a notifyid for rvdev updates as well
287          * TODO: support predefined notifyids (via resource table)
288          */
289         ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
290         if (ret < 0) {
291                 dev_err(dev, "idr_alloc failed: %d\n", ret);
292                 dma_free_coherent(dev->parent, size, va, dma);
293                 return ret;
294         }
295         notifyid = ret;
297         /* Potentially bump max_notifyid */
298         if (notifyid > rproc->max_notifyid)
299                 rproc->max_notifyid = notifyid;
301         dev_dbg(dev, "vring%d: va %pK dma %pad size 0x%x idr %d\n",
302                 i, va, &dma, size, notifyid);
304         rvring->va = va;
305         rvring->dma = dma;
306         rvring->notifyid = notifyid;
308         /*
309          * Let the rproc know the notifyid and da of this vring.
310          * Not all platforms use dma_alloc_coherent to automatically
311          * set up the iommu. In this case the device address (da) will
312          * hold the physical address and not the device address.
313          */
314         rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
315         rsc->vring[i].da = dma;
316         rsc->vring[i].notifyid = notifyid;
317         return 0;
320 static int
321 rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
323         struct rproc *rproc = rvdev->rproc;
324         struct device *dev = &rproc->dev;
325         struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
326         struct rproc_vring *rvring = &rvdev->vring[i];
328         dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
329                 i, vring->da, vring->num, vring->align);
331         /* verify queue size and vring alignment are sane */
332         if (!vring->num || !vring->align) {
333                 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
334                         vring->num, vring->align);
335                 return -EINVAL;
336         }
338         rvring->len = vring->num;
339         rvring->align = vring->align;
340         rvring->rvdev = rvdev;
342         return 0;
345 void rproc_free_vring(struct rproc_vring *rvring)
347         int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
348         struct rproc *rproc = rvring->rvdev->rproc;
349         int idx = rvring->rvdev->vring - rvring;
350         struct fw_rsc_vdev *rsc;
352         dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
353         idr_remove(&rproc->notifyids, rvring->notifyid);
355         /* reset resource entry info */
356         rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
357         rsc->vring[idx].da = 0;
358         rsc->vring[idx].notifyid = -1;
361 static int rproc_vdev_do_start(struct rproc_subdev *subdev)
363         struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
365         return rproc_add_virtio_dev(rvdev, rvdev->id);
368 static void rproc_vdev_do_stop(struct rproc_subdev *subdev, bool crashed)
370         struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
372         rproc_remove_virtio_dev(rvdev);
375 /**
376  * rproc_handle_vdev() - handle a vdev fw resource
377  * @rproc: the remote processor
378  * @rsc: the vring resource descriptor
379  * @avail: size of available data (for sanity checking the image)
380  *
381  * This resource entry requests the host to statically register a virtio
382  * device (vdev), and setup everything needed to support it. It contains
383  * everything needed to make it possible: the virtio device id, virtio
384  * device features, vrings information, virtio config space, etc...
385  *
386  * Before registering the vdev, the vrings are allocated from non-cacheable
387  * physically contiguous memory. Currently we only support two vrings per
388  * remote processor (temporary limitation). We might also want to consider
389  * doing the vring allocation only later when ->find_vqs() is invoked, and
390  * then release them upon ->del_vqs().
391  *
392  * Note: @da is currently not really handled correctly: we dynamically
393  * allocate it using the DMA API, ignoring requested hard coded addresses,
394  * and we don't take care of any required IOMMU programming. This is all
395  * going to be taken care of when the generic iommu-based DMA API will be
396  * merged. Meanwhile, statically-addressed iommu-based firmware images should
397  * use RSC_DEVMEM resource entries to map their required @da to the physical
398  * address of their base CMA region (ouch, hacky!).
399  *
400  * Returns 0 on success, or an appropriate error code otherwise
401  */
402 static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
403                              int offset, int avail)
405         struct device *dev = &rproc->dev;
406         struct rproc_vdev *rvdev;
407         int i, ret;
409         /* make sure resource isn't truncated */
410         if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
411                         + rsc->config_len > avail) {
412                 dev_err(dev, "vdev rsc is truncated\n");
413                 return -EINVAL;
414         }
416         /* make sure reserved bytes are zeroes */
417         if (rsc->reserved[0] || rsc->reserved[1]) {
418                 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
419                 return -EINVAL;
420         }
422         dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
423                 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
425         /* we currently support only two vrings per rvdev */
426         if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
427                 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
428                 return -EINVAL;
429         }
431         rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL);
432         if (!rvdev)
433                 return -ENOMEM;
435         kref_init(&rvdev->refcount);
437         rvdev->id = rsc->id;
438         rvdev->rproc = rproc;
440         /* parse the vrings */
441         for (i = 0; i < rsc->num_of_vrings; i++) {
442                 ret = rproc_parse_vring(rvdev, rsc, i);
443                 if (ret)
444                         goto free_rvdev;
445         }
447         /* remember the resource offset*/
448         rvdev->rsc_offset = offset;
450         /* allocate the vring resources */
451         for (i = 0; i < rsc->num_of_vrings; i++) {
452                 ret = rproc_alloc_vring(rvdev, i);
453                 if (ret)
454                         goto unwind_vring_allocations;
455         }
457         list_add_tail(&rvdev->node, &rproc->rvdevs);
459         rvdev->subdev.start = rproc_vdev_do_start;
460         rvdev->subdev.stop = rproc_vdev_do_stop;
462         rproc_add_subdev(rproc, &rvdev->subdev);
464         return 0;
466 unwind_vring_allocations:
467         for (i--; i >= 0; i--)
468                 rproc_free_vring(&rvdev->vring[i]);
469 free_rvdev:
470         kfree(rvdev);
471         return ret;
474 void rproc_vdev_release(struct kref *ref)
476         struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount);
477         struct rproc_vring *rvring;
478         struct rproc *rproc = rvdev->rproc;
479         int id;
481         for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) {
482                 rvring = &rvdev->vring[id];
483                 if (!rvring->va)
484                         continue;
486                 rproc_free_vring(rvring);
487         }
489         rproc_remove_subdev(rproc, &rvdev->subdev);
490         list_del(&rvdev->node);
491         kfree(rvdev);
494 /**
495  * rproc_handle_trace() - handle a shared trace buffer resource
496  * @rproc: the remote processor
497  * @rsc: the trace resource descriptor
498  * @avail: size of available data (for sanity checking the image)
499  *
500  * In case the remote processor dumps trace logs into memory,
501  * export it via debugfs.
502  *
503  * Currently, the 'da' member of @rsc should contain the device address
504  * where the remote processor is dumping the traces. Later we could also
505  * support dynamically allocating this address using the generic
506  * DMA API (but currently there isn't a use case for that).
507  *
508  * Returns 0 on success, or an appropriate error code otherwise
509  */
510 static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
511                               int offset, int avail)
513         struct rproc_mem_entry *trace;
514         struct device *dev = &rproc->dev;
515         void *ptr;
516         char name[15];
518         if (sizeof(*rsc) > avail) {
519                 dev_err(dev, "trace rsc is truncated\n");
520                 return -EINVAL;
521         }
523         /* make sure reserved bytes are zeroes */
524         if (rsc->reserved) {
525                 dev_err(dev, "trace rsc has non zero reserved bytes\n");
526                 return -EINVAL;
527         }
529         /* what's the kernel address of this resource ? */
530         ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
531         if (!ptr) {
532                 dev_err(dev, "erroneous trace resource entry\n");
533                 return -EINVAL;
534         }
536         trace = kzalloc(sizeof(*trace), GFP_KERNEL);
537         if (!trace)
538                 return -ENOMEM;
540         /* set the trace buffer dma properties */
541         trace->len = rsc->len;
542         trace->va = ptr;
544         /* make sure snprintf always null terminates, even if truncating */
545         snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
547         /* create the debugfs entry */
548         trace->priv = rproc_create_trace_file(name, rproc, trace);
549         if (!trace->priv) {
550                 trace->va = NULL;
551                 kfree(trace);
552                 return -EINVAL;
553         }
555         list_add_tail(&trace->node, &rproc->traces);
557         rproc->num_traces++;
559         dev_dbg(dev, "%s added: va %pK, da 0x%x, len 0x%x\n",
560                 name, ptr, rsc->da, rsc->len);
562         return 0;
565 /**
566  * rproc_handle_devmem() - handle devmem resource entry
567  * @rproc: remote processor handle
568  * @rsc: the devmem resource entry
569  * @avail: size of available data (for sanity checking the image)
570  *
571  * Remote processors commonly need to access certain on-chip peripherals.
572  *
573  * Some of these remote processors access memory via an iommu device,
574  * and might require us to configure their iommu before they can access
575  * the on-chip peripherals they need.
576  *
577  * This resource entry is a request to map such a peripheral device.
578  *
579  * These devmem entries will contain the physical address of the device in
580  * the 'pa' member. If a specific device address is expected, then 'da' will
581  * contain it (currently this is the only use case supported). 'len' will
582  * contain the size of the physical region we need to map.
583  *
584  * Currently we just "trust" those devmem entries to contain valid physical
585  * addresses, but this is going to change: we want the implementations to
586  * tell us ranges of physical addresses the firmware is allowed to request,
587  * and not allow firmwares to request access to physical addresses that
588  * are outside those ranges.
589  */
590 static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
591                                int offset, int avail)
593         struct rproc_mem_entry *mapping;
594         struct device *dev = &rproc->dev;
595         int ret;
597         /* no point in handling this resource without a valid iommu domain */
598         if (!rproc->domain)
599                 return -EINVAL;
601         if (sizeof(*rsc) > avail) {
602                 dev_err(dev, "devmem rsc is truncated\n");
603                 return -EINVAL;
604         }
606         /* make sure reserved bytes are zeroes */
607         if (rsc->reserved) {
608                 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
609                 return -EINVAL;
610         }
612         mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
613         if (!mapping)
614                 return -ENOMEM;
616         ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
617         if (ret) {
618                 dev_err(dev, "failed to map devmem: %d\n", ret);
619                 goto out;
620         }
622         /*
623          * We'll need this info later when we'll want to unmap everything
624          * (e.g. on shutdown).
625          *
626          * We can't trust the remote processor not to change the resource
627          * table, so we must maintain this info independently.
628          */
629         mapping->dma = rsc->pa;
630         mapping->da = rsc->da;
631         mapping->len = rsc->len;
632         list_add_tail(&mapping->node, &rproc->mappings);
634         dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
635                 rsc->pa, rsc->da, rsc->len);
637         return 0;
639 out:
640         kfree(mapping);
641         return ret;
644 /**
645  * rproc_handle_carveout() - handle phys contig memory allocation requests
646  * @rproc: rproc handle
647  * @rsc: the resource entry
648  * @avail: size of available data (for image validation)
649  *
650  * This function will handle firmware requests for allocation of physically
651  * contiguous memory regions.
652  *
653  * These request entries should come first in the firmware's resource table,
654  * as other firmware entries might request placing other data objects inside
655  * these memory regions (e.g. data/code segments, trace resource entries, ...).
656  *
657  * Allocating memory this way helps utilizing the reserved physical memory
658  * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
659  * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
660  * pressure is important; it may have a substantial impact on performance.
661  */
662 static int rproc_handle_carveout(struct rproc *rproc,
663                                  struct fw_rsc_carveout *rsc,
664                                  int offset, int avail)
666         struct rproc_mem_entry *carveout, *mapping;
667         struct device *dev = &rproc->dev;
668         dma_addr_t dma;
669         void *va;
670         int ret;
672         if (sizeof(*rsc) > avail) {
673                 dev_err(dev, "carveout rsc is truncated\n");
674                 return -EINVAL;
675         }
677         /* make sure reserved bytes are zeroes */
678         if (rsc->reserved) {
679                 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
680                 return -EINVAL;
681         }
683         dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
684                 rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
686         carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
687         if (!carveout)
688                 return -ENOMEM;
690         va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
691         if (!va) {
692                 dev_err(dev->parent,
693                         "failed to allocate dma memory: len 0x%x\n", rsc->len);
694                 ret = -ENOMEM;
695                 goto free_carv;
696         }
698         dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%x\n",
699                 va, &dma, rsc->len);
701         /*
702          * Ok, this is non-standard.
703          *
704          * Sometimes we can't rely on the generic iommu-based DMA API
705          * to dynamically allocate the device address and then set the IOMMU
706          * tables accordingly, because some remote processors might
707          * _require_ us to use hard coded device addresses that their
708          * firmware was compiled with.
709          *
710          * In this case, we must use the IOMMU API directly and map
711          * the memory to the device address as expected by the remote
712          * processor.
713          *
714          * Obviously such remote processor devices should not be configured
715          * to use the iommu-based DMA API: we expect 'dma' to contain the
716          * physical address in this case.
717          */
718         if (rproc->domain) {
719                 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
720                 if (!mapping) {
721                         ret = -ENOMEM;
722                         goto dma_free;
723                 }
725                 ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
726                                 rsc->flags);
727                 if (ret) {
728                         dev_err(dev, "iommu_map failed: %d\n", ret);
729                         goto free_mapping;
730                 }
732                 /*
733                  * We'll need this info later when we'll want to unmap
734                  * everything (e.g. on shutdown).
735                  *
736                  * We can't trust the remote processor not to change the
737                  * resource table, so we must maintain this info independently.
738                  */
739                 mapping->da = rsc->da;
740                 mapping->len = rsc->len;
741                 list_add_tail(&mapping->node, &rproc->mappings);
743                 dev_dbg(dev, "carveout mapped 0x%x to %pad\n",
744                         rsc->da, &dma);
745         }
747         /*
748          * Some remote processors might need to know the pa
749          * even though they are behind an IOMMU. E.g., OMAP4's
750          * remote M3 processor needs this so it can control
751          * on-chip hardware accelerators that are not behind
752          * the IOMMU, and therefor must know the pa.
753          *
754          * Generally we don't want to expose physical addresses
755          * if we don't have to (remote processors are generally
756          * _not_ trusted), so we might want to do this only for
757          * remote processor that _must_ have this (e.g. OMAP4's
758          * dual M3 subsystem).
759          *
760          * Non-IOMMU processors might also want to have this info.
761          * In this case, the device address and the physical address
762          * are the same.
763          */
764         rsc->pa = dma;
766         carveout->va = va;
767         carveout->len = rsc->len;
768         carveout->dma = dma;
769         carveout->da = rsc->da;
770         strlcpy(carveout->name, rsc->name, sizeof(carveout->name));
772         list_add_tail(&carveout->node, &rproc->carveouts);
774         return 0;
776 free_mapping:
777         kfree(mapping);
778 dma_free:
779         dma_free_coherent(dev->parent, rsc->len, va, dma);
780 free_carv:
781         kfree(carveout);
782         return ret;
785 /*
786  * A lookup table for resource handlers. The indices are defined in
787  * enum fw_resource_type.
788  */
789 static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
790         [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
791         [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
792         [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
793         [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
794 };
796 /* handle firmware resource entries before booting the remote processor */
797 static int rproc_handle_resources(struct rproc *rproc,
798                                   rproc_handle_resource_t handlers[RSC_LAST])
800         struct device *dev = &rproc->dev;
801         rproc_handle_resource_t handler;
802         int ret = 0, i;
804         if (!rproc->table_ptr)
805                 return 0;
807         for (i = 0; i < rproc->table_ptr->num; i++) {
808                 int offset = rproc->table_ptr->offset[i];
809                 struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
810                 int avail = rproc->table_sz - offset - sizeof(*hdr);
811                 void *rsc = (void *)hdr + sizeof(*hdr);
813                 /* make sure table isn't truncated */
814                 if (avail < 0) {
815                         dev_err(dev, "rsc table is truncated\n");
816                         return -EINVAL;
817                 }
819                 dev_dbg(dev, "rsc: type %d\n", hdr->type);
821                 if (hdr->type >= RSC_LAST) {
822                         dev_warn(dev, "unsupported resource %d\n", hdr->type);
823                         continue;
824                 }
826                 handler = handlers[hdr->type];
827                 if (!handler)
828                         continue;
830                 ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
831                 if (ret)
832                         break;
833         }
835         return ret;
838 static int rproc_prepare_subdevices(struct rproc *rproc)
840         struct rproc_subdev *subdev;
841         int ret;
843         list_for_each_entry(subdev, &rproc->subdevs, node) {
844                 if (subdev->prepare) {
845                         ret = subdev->prepare(subdev);
846                         if (ret)
847                                 goto unroll_preparation;
848                 }
849         }
851         return 0;
853 unroll_preparation:
854         list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) {
855                 if (subdev->unprepare)
856                         subdev->unprepare(subdev);
857         }
859         return ret;
862 static int rproc_start_subdevices(struct rproc *rproc)
864         struct rproc_subdev *subdev;
865         int ret;
867         list_for_each_entry(subdev, &rproc->subdevs, node) {
868                 if (subdev->start) {
869                         ret = subdev->start(subdev);
870                         if (ret)
871                                 goto unroll_registration;
872                 }
873         }
875         return 0;
877 unroll_registration:
878         list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) {
879                 if (subdev->stop)
880                         subdev->stop(subdev, true);
881         }
883         return ret;
886 static void rproc_stop_subdevices(struct rproc *rproc, bool crashed)
888         struct rproc_subdev *subdev;
890         list_for_each_entry_reverse(subdev, &rproc->subdevs, node) {
891                 if (subdev->stop)
892                         subdev->stop(subdev, crashed);
893         }
896 static void rproc_unprepare_subdevices(struct rproc *rproc)
898         struct rproc_subdev *subdev;
900         list_for_each_entry_reverse(subdev, &rproc->subdevs, node) {
901                 if (subdev->unprepare)
902                         subdev->unprepare(subdev);
903         }
906 /**
907  * rproc_coredump_cleanup() - clean up dump_segments list
908  * @rproc: the remote processor handle
909  */
910 static void rproc_coredump_cleanup(struct rproc *rproc)
912         struct rproc_dump_segment *entry, *tmp;
914         list_for_each_entry_safe(entry, tmp, &rproc->dump_segments, node) {
915                 list_del(&entry->node);
916                 kfree(entry);
917         }
920 /**
921  * rproc_resource_cleanup() - clean up and free all acquired resources
922  * @rproc: rproc handle
923  *
924  * This function will free all resources acquired for @rproc, and it
925  * is called whenever @rproc either shuts down or fails to boot.
926  */
927 static void rproc_resource_cleanup(struct rproc *rproc)
929         struct rproc_mem_entry *entry, *tmp;
930         struct rproc_vdev *rvdev, *rvtmp;
931         struct device *dev = &rproc->dev;
933         /* clean up debugfs trace entries */
934         list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
935                 rproc_remove_trace_file(entry->priv);
936                 rproc->num_traces--;
937                 list_del(&entry->node);
938                 kfree(entry);
939         }
941         /* clean up iommu mapping entries */
942         list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
943                 size_t unmapped;
945                 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
946                 if (unmapped != entry->len) {
947                         /* nothing much to do besides complaining */
948                         dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
949                                 unmapped);
950                 }
952                 list_del(&entry->node);
953                 kfree(entry);
954         }
956         /* clean up carveout allocations */
957         list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
958                 dma_free_coherent(dev->parent, entry->len, entry->va,
959                                   entry->dma);
960                 list_del(&entry->node);
961                 kfree(entry);
962         }
964         /* clean up remote vdev entries */
965         list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
966                 kref_put(&rvdev->refcount, rproc_vdev_release);
968         rproc_coredump_cleanup(rproc);
971 static int rproc_start(struct rproc *rproc, const struct firmware *fw)
973         struct resource_table *loaded_table;
974         struct device *dev = &rproc->dev;
975         int ret;
977         /* load the ELF segments to memory */
978         ret = rproc_load_segments(rproc, fw);
979         if (ret) {
980                 dev_err(dev, "Failed to load program segments: %d\n", ret);
981                 return ret;
982         }
984         /*
985          * The starting device has been given the rproc->cached_table as the
986          * resource table. The address of the vring along with the other
987          * allocated resources (carveouts etc) is stored in cached_table.
988          * In order to pass this information to the remote device we must copy
989          * this information to device memory. We also update the table_ptr so
990          * that any subsequent changes will be applied to the loaded version.
991          */
992         loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
993         if (loaded_table) {
994                 memcpy(loaded_table, rproc->cached_table, rproc->table_sz);
995                 rproc->table_ptr = loaded_table;
996         }
998         ret = rproc_prepare_subdevices(rproc);
999         if (ret) {
1000                 dev_err(dev, "failed to prepare subdevices for %s: %d\n",
1001                         rproc->name, ret);
1002                 goto reset_table_ptr;
1003         }
1005         /* power up the remote processor */
1006         ret = rproc->ops->start(rproc);
1007         if (ret) {
1008                 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
1009                 goto unprepare_subdevices;
1010         }
1012         /* Start any subdevices for the remote processor */
1013         ret = rproc_start_subdevices(rproc);
1014         if (ret) {
1015                 dev_err(dev, "failed to probe subdevices for %s: %d\n",
1016                         rproc->name, ret);
1017                 goto stop_rproc;
1018         }
1020         rproc->state = RPROC_RUNNING;
1022         dev_info(dev, "remote processor %s is now up\n", rproc->name);
1024         return 0;
1026 stop_rproc:
1027         rproc->ops->stop(rproc);
1028 unprepare_subdevices:
1029         rproc_unprepare_subdevices(rproc);
1030 reset_table_ptr:
1031         rproc->table_ptr = rproc->cached_table;
1033         return ret;
1036 /*
1037  * take a firmware and boot a remote processor with it.
1038  */
1039 static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
1041         struct device *dev = &rproc->dev;
1042         const char *name = rproc->firmware;
1043         int ret;
1045         ret = rproc_fw_sanity_check(rproc, fw);
1046         if (ret)
1047                 return ret;
1049         dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
1051         /*
1052          * if enabling an IOMMU isn't relevant for this rproc, this is
1053          * just a nop
1054          */
1055         ret = rproc_enable_iommu(rproc);
1056         if (ret) {
1057                 dev_err(dev, "can't enable iommu: %d\n", ret);
1058                 return ret;
1059         }
1061         rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
1063         /* Load resource table, core dump segment list etc from the firmware */
1064         ret = rproc_parse_fw(rproc, fw);
1065         if (ret)
1066                 goto disable_iommu;
1068         /* reset max_notifyid */
1069         rproc->max_notifyid = -1;
1071         /* handle fw resources which are required to boot rproc */
1072         ret = rproc_handle_resources(rproc, rproc_loading_handlers);
1073         if (ret) {
1074                 dev_err(dev, "Failed to process resources: %d\n", ret);
1075                 goto clean_up_resources;
1076         }
1078         ret = rproc_start(rproc, fw);
1079         if (ret)
1080                 goto clean_up_resources;
1082         return 0;
1084 clean_up_resources:
1085         rproc_resource_cleanup(rproc);
1086         kfree(rproc->cached_table);
1087         rproc->cached_table = NULL;
1088         rproc->table_ptr = NULL;
1089 disable_iommu:
1090         rproc_disable_iommu(rproc);
1091         return ret;
1094 /*
1095  * take a firmware and boot it up.
1096  *
1097  * Note: this function is called asynchronously upon registration of the
1098  * remote processor (so we must wait until it completes before we try
1099  * to unregister the device. one other option is just to use kref here,
1100  * that might be cleaner).
1101  */
1102 static void rproc_auto_boot_callback(const struct firmware *fw, void *context)
1104         struct rproc *rproc = context;
1106         rproc_boot(rproc);
1108         release_firmware(fw);
1111 static int rproc_trigger_auto_boot(struct rproc *rproc)
1113         int ret;
1115         /*
1116          * We're initiating an asynchronous firmware loading, so we can
1117          * be built-in kernel code, without hanging the boot process.
1118          */
1119         ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
1120                                       rproc->firmware, &rproc->dev, GFP_KERNEL,
1121                                       rproc, rproc_auto_boot_callback);
1122         if (ret < 0)
1123                 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
1125         return ret;
1128 static int rproc_stop(struct rproc *rproc, bool crashed)
1130         struct device *dev = &rproc->dev;
1131         int ret;
1133         /* Stop any subdevices for the remote processor */
1134         rproc_stop_subdevices(rproc, crashed);
1136         /* the installed resource table is no longer accessible */
1137         rproc->table_ptr = rproc->cached_table;
1139         /* power off the remote processor */
1140         ret = rproc->ops->stop(rproc);
1141         if (ret) {
1142                 dev_err(dev, "can't stop rproc: %d\n", ret);
1143                 return ret;
1144         }
1146         rproc_unprepare_subdevices(rproc);
1148         rproc->state = RPROC_OFFLINE;
1150         dev_info(dev, "stopped remote processor %s\n", rproc->name);
1152         return 0;
1155 /**
1156  * rproc_coredump_add_segment() - add segment of device memory to coredump
1157  * @rproc:      handle of a remote processor
1158  * @da:         device address
1159  * @size:       size of segment
1160  *
1161  * Add device memory to the list of segments to be included in a coredump for
1162  * the remoteproc.
1163  *
1164  * Return: 0 on success, negative errno on error.
1165  */
1166 int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size)
1168         struct rproc_dump_segment *segment;
1170         segment = kzalloc(sizeof(*segment), GFP_KERNEL);
1171         if (!segment)
1172                 return -ENOMEM;
1174         segment->da = da;
1175         segment->size = size;
1177         list_add_tail(&segment->node, &rproc->dump_segments);
1179         return 0;
1181 EXPORT_SYMBOL(rproc_coredump_add_segment);
1183 /**
1184  * rproc_coredump() - perform coredump
1185  * @rproc:      rproc handle
1186  *
1187  * This function will generate an ELF header for the registered segments
1188  * and create a devcoredump device associated with rproc.
1189  */
1190 static void rproc_coredump(struct rproc *rproc)
1192         struct rproc_dump_segment *segment;
1193         struct elf32_phdr *phdr;
1194         struct elf32_hdr *ehdr;
1195         size_t data_size;
1196         size_t offset;
1197         void *data;
1198         void *ptr;
1199         int phnum = 0;
1201         if (list_empty(&rproc->dump_segments))
1202                 return;
1204         data_size = sizeof(*ehdr);
1205         list_for_each_entry(segment, &rproc->dump_segments, node) {
1206                 data_size += sizeof(*phdr) + segment->size;
1208                 phnum++;
1209         }
1211         data = vmalloc(data_size);
1212         if (!data)
1213                 return;
1215         ehdr = data;
1217         memset(ehdr, 0, sizeof(*ehdr));
1218         memcpy(ehdr->e_ident, ELFMAG, SELFMAG);
1219         ehdr->e_ident[EI_CLASS] = ELFCLASS32;
1220         ehdr->e_ident[EI_DATA] = ELFDATA2LSB;
1221         ehdr->e_ident[EI_VERSION] = EV_CURRENT;
1222         ehdr->e_ident[EI_OSABI] = ELFOSABI_NONE;
1223         ehdr->e_type = ET_CORE;
1224         ehdr->e_machine = EM_NONE;
1225         ehdr->e_version = EV_CURRENT;
1226         ehdr->e_entry = rproc->bootaddr;
1227         ehdr->e_phoff = sizeof(*ehdr);
1228         ehdr->e_ehsize = sizeof(*ehdr);
1229         ehdr->e_phentsize = sizeof(*phdr);
1230         ehdr->e_phnum = phnum;
1232         phdr = data + ehdr->e_phoff;
1233         offset = ehdr->e_phoff + sizeof(*phdr) * ehdr->e_phnum;
1234         list_for_each_entry(segment, &rproc->dump_segments, node) {
1235                 memset(phdr, 0, sizeof(*phdr));
1236                 phdr->p_type = PT_LOAD;
1237                 phdr->p_offset = offset;
1238                 phdr->p_vaddr = segment->da;
1239                 phdr->p_paddr = segment->da;
1240                 phdr->p_filesz = segment->size;
1241                 phdr->p_memsz = segment->size;
1242                 phdr->p_flags = PF_R | PF_W | PF_X;
1243                 phdr->p_align = 0;
1245                 ptr = rproc_da_to_va(rproc, segment->da, segment->size);
1246                 if (!ptr) {
1247                         dev_err(&rproc->dev,
1248                                 "invalid coredump segment (%pad, %zu)\n",
1249                                 &segment->da, segment->size);
1250                         memset(data + offset, 0xff, segment->size);
1251                 } else {
1252                         memcpy(data + offset, ptr, segment->size);
1253                 }
1255                 offset += phdr->p_filesz;
1256                 phdr++;
1257         }
1259         dev_coredumpv(&rproc->dev, data, data_size, GFP_KERNEL);
1262 /**
1263  * rproc_trigger_recovery() - recover a remoteproc
1264  * @rproc: the remote processor
1265  *
1266  * The recovery is done by resetting all the virtio devices, that way all the
1267  * rpmsg drivers will be reseted along with the remote processor making the
1268  * remoteproc functional again.
1269  *
1270  * This function can sleep, so it cannot be called from atomic context.
1271  */
1272 int rproc_trigger_recovery(struct rproc *rproc)
1274         const struct firmware *firmware_p;
1275         struct device *dev = &rproc->dev;
1276         int ret;
1278         dev_err(dev, "recovering %s\n", rproc->name);
1280         ret = mutex_lock_interruptible(&rproc->lock);
1281         if (ret)
1282                 return ret;
1284         ret = rproc_stop(rproc, true);
1285         if (ret)
1286                 goto unlock_mutex;
1288         /* generate coredump */
1289         rproc_coredump(rproc);
1291         /* load firmware */
1292         ret = request_firmware(&firmware_p, rproc->firmware, dev);
1293         if (ret < 0) {
1294                 dev_err(dev, "request_firmware failed: %d\n", ret);
1295                 goto unlock_mutex;
1296         }
1298         /* boot the remote processor up again */
1299         ret = rproc_start(rproc, firmware_p);
1301         release_firmware(firmware_p);
1303 unlock_mutex:
1304         mutex_unlock(&rproc->lock);
1305         return ret;
1308 /**
1309  * rproc_crash_handler_work() - handle a crash
1310  *
1311  * This function needs to handle everything related to a crash, like cpu
1312  * registers and stack dump, information to help to debug the fatal error, etc.
1313  */
1314 static void rproc_crash_handler_work(struct work_struct *work)
1316         struct rproc *rproc = container_of(work, struct rproc, crash_handler);
1317         struct device *dev = &rproc->dev;
1319         dev_dbg(dev, "enter %s\n", __func__);
1321         mutex_lock(&rproc->lock);
1323         if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
1324                 /* handle only the first crash detected */
1325                 mutex_unlock(&rproc->lock);
1326                 return;
1327         }
1329         rproc->state = RPROC_CRASHED;
1330         dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
1331                 rproc->name);
1333         mutex_unlock(&rproc->lock);
1335         if (!rproc->recovery_disabled)
1336                 rproc_trigger_recovery(rproc);
1339 /**
1340  * rproc_get_id() - return the id for the rproc device
1341  * @rproc: handle of a remote processor
1342  *
1343  * Each rproc device is associated with a platform device, which is created
1344  * either from device tree (majority newer platforms) or using legacy style
1345  * platform device creation (fewer legacy platforms). This function retrieves
1346  * an unique id for each remote processor and is useful for clients needing
1347  * to distinguish each of the remoteprocs. This unique id is derived using
1348  * the platform device id for non-DT devices, or an alternate alias id for
1349  * DT devices (since they do not have a valid platform device id). It is
1350  * assumed that the platform devices were created with known ids or were
1351  * given proper alias ids using the stem "rproc".
1352  *
1353  * Return: alias id for DT devices or platform device id for non-DT devices
1354  * associated with the rproc
1355  */
1356 int rproc_get_id(struct rproc *rproc)
1358         struct device *dev = rproc->dev.parent;
1359         struct device_node *np = dev->of_node;
1360         struct platform_device *pdev = to_platform_device(dev);
1362         if (np)
1363                 return of_alias_get_id(np, "rproc");
1364         else
1365                 return pdev->id;
1367 EXPORT_SYMBOL(rproc_get_id);
1369 /**
1370  * rproc_boot() - boot a remote processor
1371  * @rproc: handle of a remote processor
1372  *
1373  * Boot a remote processor (i.e. load its firmware, power it on, ...).
1374  *
1375  * If the remote processor is already powered on, this function immediately
1376  * returns (successfully).
1377  *
1378  * Returns 0 on success, and an appropriate error value otherwise.
1379  */
1380 int rproc_boot(struct rproc *rproc)
1382         const struct firmware *firmware_p;
1383         struct device *dev;
1384         int ret;
1386         if (!rproc) {
1387                 pr_err("invalid rproc handle\n");
1388                 return -EINVAL;
1389         }
1391         dev = &rproc->dev;
1393         ret = mutex_lock_interruptible(&rproc->lock);
1394         if (ret) {
1395                 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1396                 return ret;
1397         }
1399         if (rproc->state == RPROC_DELETED) {
1400                 ret = -ENODEV;
1401                 dev_err(dev, "can't boot deleted rproc %s\n", rproc->name);
1402                 goto unlock_mutex;
1403         }
1405         /* skip the boot process if rproc is already powered up */
1406         if (atomic_inc_return(&rproc->power) > 1) {
1407                 ret = 0;
1408                 goto unlock_mutex;
1409         }
1411         dev_info(dev, "powering up %s\n", rproc->name);
1413         /* load firmware */
1414         ret = request_firmware(&firmware_p, rproc->firmware, dev);
1415         if (ret < 0) {
1416                 dev_err(dev, "request_firmware failed: %d\n", ret);
1417                 goto downref_rproc;
1418         }
1420         ret = rproc_fw_boot(rproc, firmware_p);
1422         release_firmware(firmware_p);
1424 downref_rproc:
1425         if (ret)
1426                 atomic_dec(&rproc->power);
1427 unlock_mutex:
1428         mutex_unlock(&rproc->lock);
1429         return ret;
1431 EXPORT_SYMBOL(rproc_boot);
1433 /**
1434  * rproc_shutdown() - power off the remote processor
1435  * @rproc: the remote processor
1436  *
1437  * Power off a remote processor (previously booted with rproc_boot()).
1438  *
1439  * In case @rproc is still being used by an additional user(s), then
1440  * this function will just decrement the power refcount and exit,
1441  * without really powering off the device.
1442  *
1443  * Every call to rproc_boot() must (eventually) be accompanied by a call
1444  * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1445  *
1446  * Notes:
1447  * - we're not decrementing the rproc's refcount, only the power refcount.
1448  *   which means that the @rproc handle stays valid even after rproc_shutdown()
1449  *   returns, and users can still use it with a subsequent rproc_boot(), if
1450  *   needed.
1451  */
1452 void rproc_shutdown(struct rproc *rproc)
1454         struct device *dev = &rproc->dev;
1455         int ret;
1457         ret = mutex_lock_interruptible(&rproc->lock);
1458         if (ret) {
1459                 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1460                 return;
1461         }
1463         /* if the remote proc is still needed, bail out */
1464         if (!atomic_dec_and_test(&rproc->power))
1465                 goto out;
1467         ret = rproc_stop(rproc, false);
1468         if (ret) {
1469                 atomic_inc(&rproc->power);
1470                 goto out;
1471         }
1473         /* clean up all acquired resources */
1474         rproc_resource_cleanup(rproc);
1476         rproc_disable_iommu(rproc);
1478         /* Free the copy of the resource table */
1479         kfree(rproc->cached_table);
1480         rproc->cached_table = NULL;
1481         rproc->table_ptr = NULL;
1482 out:
1483         mutex_unlock(&rproc->lock);
1485 EXPORT_SYMBOL(rproc_shutdown);
1487 /**
1488  * rproc_get_by_phandle() - find a remote processor by phandle
1489  * @phandle: phandle to the rproc
1490  *
1491  * Finds an rproc handle using the remote processor's phandle, and then
1492  * return a handle to the rproc.
1493  *
1494  * This function increments the remote processor's refcount, so always
1495  * use rproc_put() to decrement it back once rproc isn't needed anymore.
1496  *
1497  * Returns the rproc handle on success, and NULL on failure.
1498  */
1499 #ifdef CONFIG_OF
1500 struct rproc *rproc_get_by_phandle(phandle phandle)
1502         struct rproc *rproc = NULL, *r;
1503         struct device_node *np;
1505         np = of_find_node_by_phandle(phandle);
1506         if (!np)
1507                 return NULL;
1509         mutex_lock(&rproc_list_mutex);
1510         list_for_each_entry(r, &rproc_list, node) {
1511                 if (r->dev.parent && r->dev.parent->of_node == np) {
1512                         /* prevent underlying implementation from being removed */
1513                         if (!try_module_get(r->dev.parent->driver->owner)) {
1514                                 dev_err(&r->dev, "can't get owner\n");
1515                                 break;
1516                         }
1518                         rproc = r;
1519                         get_device(&rproc->dev);
1520                         break;
1521                 }
1522         }
1523         mutex_unlock(&rproc_list_mutex);
1525         of_node_put(np);
1527         return rproc;
1529 #else
1530 struct rproc *rproc_get_by_phandle(phandle phandle)
1532         return NULL;
1534 #endif
1535 EXPORT_SYMBOL(rproc_get_by_phandle);
1537 /**
1538  * rproc_add() - register a remote processor
1539  * @rproc: the remote processor handle to register
1540  *
1541  * Registers @rproc with the remoteproc framework, after it has been
1542  * allocated with rproc_alloc().
1543  *
1544  * This is called by the platform-specific rproc implementation, whenever
1545  * a new remote processor device is probed.
1546  *
1547  * Returns 0 on success and an appropriate error code otherwise.
1548  *
1549  * Note: this function initiates an asynchronous firmware loading
1550  * context, which will look for virtio devices supported by the rproc's
1551  * firmware.
1552  *
1553  * If found, those virtio devices will be created and added, so as a result
1554  * of registering this remote processor, additional virtio drivers might be
1555  * probed.
1556  */
1557 int rproc_add(struct rproc *rproc)
1559         struct device *dev = &rproc->dev;
1560         int ret;
1562         ret = device_add(dev);
1563         if (ret < 0)
1564                 return ret;
1566         dev_info(dev, "%s is available\n", rproc->name);
1568         /* create debugfs entries */
1569         rproc_create_debug_dir(rproc);
1571         /* if rproc is marked always-on, request it to boot */
1572         if (rproc->auto_boot) {
1573                 ret = rproc_trigger_auto_boot(rproc);
1574                 if (ret < 0)
1575                         return ret;
1576         }
1578         /* expose to rproc_get_by_phandle users */
1579         mutex_lock(&rproc_list_mutex);
1580         list_add(&rproc->node, &rproc_list);
1581         mutex_unlock(&rproc_list_mutex);
1583         return 0;
1585 EXPORT_SYMBOL(rproc_add);
1587 /**
1588  * rproc_type_release() - release a remote processor instance
1589  * @dev: the rproc's device
1590  *
1591  * This function should _never_ be called directly.
1592  *
1593  * It will be called by the driver core when no one holds a valid pointer
1594  * to @dev anymore.
1595  */
1596 static void rproc_type_release(struct device *dev)
1598         struct rproc *rproc = container_of(dev, struct rproc, dev);
1600         dev_info(&rproc->dev, "releasing %s\n", rproc->name);
1602         idr_destroy(&rproc->notifyids);
1604         if (rproc->index >= 0)
1605                 ida_simple_remove(&rproc_dev_index, rproc->index);
1607         kfree(rproc->firmware);
1608         kfree(rproc->ops);
1609         kfree(rproc);
1612 static const struct device_type rproc_type = {
1613         .name           = "remoteproc",
1614         .release        = rproc_type_release,
1615 };
1617 /**
1618  * rproc_alloc() - allocate a remote processor handle
1619  * @dev: the underlying device
1620  * @name: name of this remote processor
1621  * @ops: platform-specific handlers (mainly start/stop)
1622  * @firmware: name of firmware file to load, can be NULL
1623  * @len: length of private data needed by the rproc driver (in bytes)
1624  *
1625  * Allocates a new remote processor handle, but does not register
1626  * it yet. if @firmware is NULL, a default name is used.
1627  *
1628  * This function should be used by rproc implementations during initialization
1629  * of the remote processor.
1630  *
1631  * After creating an rproc handle using this function, and when ready,
1632  * implementations should then call rproc_add() to complete
1633  * the registration of the remote processor.
1634  *
1635  * On success the new rproc is returned, and on failure, NULL.
1636  *
1637  * Note: _never_ directly deallocate @rproc, even if it was not registered
1638  * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
1639  */
1640 struct rproc *rproc_alloc(struct device *dev, const char *name,
1641                           const struct rproc_ops *ops,
1642                           const char *firmware, int len)
1644         struct rproc *rproc;
1645         char *p, *template = "rproc-%s-fw";
1646         int name_len;
1648         if (!dev || !name || !ops)
1649                 return NULL;
1651         if (!firmware) {
1652                 /*
1653                  * If the caller didn't pass in a firmware name then
1654                  * construct a default name.
1655                  */
1656                 name_len = strlen(name) + strlen(template) - 2 + 1;
1657                 p = kmalloc(name_len, GFP_KERNEL);
1658                 if (!p)
1659                         return NULL;
1660                 snprintf(p, name_len, template, name);
1661         } else {
1662                 p = kstrdup(firmware, GFP_KERNEL);
1663                 if (!p)
1664                         return NULL;
1665         }
1667         rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
1668         if (!rproc) {
1669                 kfree(p);
1670                 return NULL;
1671         }
1673         rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL);
1674         if (!rproc->ops) {
1675                 kfree(p);
1676                 kfree(rproc);
1677                 return NULL;
1678         }
1680         rproc->firmware = p;
1681         rproc->name = name;
1682         rproc->priv = &rproc[1];
1683         rproc->auto_boot = true;
1685         device_initialize(&rproc->dev);
1686         rproc->dev.parent = dev;
1687         rproc->dev.type = &rproc_type;
1688         rproc->dev.class = &rproc_class;
1689         rproc->dev.driver_data = rproc;
1691         /* Assign a unique device index and name */
1692         rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1693         if (rproc->index < 0) {
1694                 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1695                 put_device(&rproc->dev);
1696                 return NULL;
1697         }
1699         dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1701         atomic_set(&rproc->power, 0);
1703         /* Default to ELF loader if no load function is specified */
1704         if (!rproc->ops->load) {
1705                 rproc->ops->load = rproc_elf_load_segments;
1706                 rproc->ops->parse_fw = rproc_elf_load_rsc_table;
1707                 rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table;
1708                 rproc->ops->sanity_check = rproc_elf_sanity_check;
1709                 rproc->ops->get_boot_addr = rproc_elf_get_boot_addr;
1710         }
1712         mutex_init(&rproc->lock);
1714         idr_init(&rproc->notifyids);
1716         INIT_LIST_HEAD(&rproc->carveouts);
1717         INIT_LIST_HEAD(&rproc->mappings);
1718         INIT_LIST_HEAD(&rproc->traces);
1719         INIT_LIST_HEAD(&rproc->rvdevs);
1720         INIT_LIST_HEAD(&rproc->subdevs);
1721         INIT_LIST_HEAD(&rproc->dump_segments);
1723         INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
1725         rproc->state = RPROC_OFFLINE;
1727         return rproc;
1729 EXPORT_SYMBOL(rproc_alloc);
1731 /**
1732  * rproc_free() - unroll rproc_alloc()
1733  * @rproc: the remote processor handle
1734  *
1735  * This function decrements the rproc dev refcount.
1736  *
1737  * If no one holds any reference to rproc anymore, then its refcount would
1738  * now drop to zero, and it would be freed.
1739  */
1740 void rproc_free(struct rproc *rproc)
1742         put_device(&rproc->dev);
1744 EXPORT_SYMBOL(rproc_free);
1746 /**
1747  * rproc_put() - release rproc reference
1748  * @rproc: the remote processor handle
1749  *
1750  * This function decrements the rproc dev refcount.
1751  *
1752  * If no one holds any reference to rproc anymore, then its refcount would
1753  * now drop to zero, and it would be freed.
1754  */
1755 void rproc_put(struct rproc *rproc)
1757         module_put(rproc->dev.parent->driver->owner);
1758         put_device(&rproc->dev);
1760 EXPORT_SYMBOL(rproc_put);
1762 /**
1763  * rproc_del() - unregister a remote processor
1764  * @rproc: rproc handle to unregister
1765  *
1766  * This function should be called when the platform specific rproc
1767  * implementation decides to remove the rproc device. it should
1768  * _only_ be called if a previous invocation of rproc_add()
1769  * has completed successfully.
1770  *
1771  * After rproc_del() returns, @rproc isn't freed yet, because
1772  * of the outstanding reference created by rproc_alloc. To decrement that
1773  * one last refcount, one still needs to call rproc_free().
1774  *
1775  * Returns 0 on success and -EINVAL if @rproc isn't valid.
1776  */
1777 int rproc_del(struct rproc *rproc)
1779         if (!rproc)
1780                 return -EINVAL;
1782         /* if rproc is marked always-on, rproc_add() booted it */
1783         /* TODO: make sure this works with rproc->power > 1 */
1784         if (rproc->auto_boot)
1785                 rproc_shutdown(rproc);
1787         mutex_lock(&rproc->lock);
1788         rproc->state = RPROC_DELETED;
1789         mutex_unlock(&rproc->lock);
1791         rproc_delete_debug_dir(rproc);
1793         /* the rproc is downref'ed as soon as it's removed from the klist */
1794         mutex_lock(&rproc_list_mutex);
1795         list_del(&rproc->node);
1796         mutex_unlock(&rproc_list_mutex);
1798         device_del(&rproc->dev);
1800         return 0;
1802 EXPORT_SYMBOL(rproc_del);
1804 /**
1805  * rproc_add_subdev() - add a subdevice to a remoteproc
1806  * @rproc: rproc handle to add the subdevice to
1807  * @subdev: subdev handle to register
1808  *
1809  * Caller is responsible for populating optional subdevice function pointers.
1810  */
1811 void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
1813         list_add_tail(&subdev->node, &rproc->subdevs);
1815 EXPORT_SYMBOL(rproc_add_subdev);
1817 /**
1818  * rproc_remove_subdev() - remove a subdevice from a remoteproc
1819  * @rproc: rproc handle to remove the subdevice from
1820  * @subdev: subdev handle, previously registered with rproc_add_subdev()
1821  */
1822 void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
1824         list_del(&subdev->node);
1826 EXPORT_SYMBOL(rproc_remove_subdev);
1828 /**
1829  * rproc_get_by_child() - acquire rproc handle of @dev's ancestor
1830  * @dev:        child device to find ancestor of
1831  *
1832  * Returns the ancestor rproc instance, or NULL if not found.
1833  */
1834 struct rproc *rproc_get_by_child(struct device *dev)
1836         for (dev = dev->parent; dev; dev = dev->parent) {
1837                 if (dev->type == &rproc_type)
1838                         return dev->driver_data;
1839         }
1841         return NULL;
1843 EXPORT_SYMBOL(rproc_get_by_child);
1845 /**
1846  * rproc_report_crash() - rproc crash reporter function
1847  * @rproc: remote processor
1848  * @type: crash type
1849  *
1850  * This function must be called every time a crash is detected by the low-level
1851  * drivers implementing a specific remoteproc. This should not be called from a
1852  * non-remoteproc driver.
1853  *
1854  * This function can be called from atomic/interrupt context.
1855  */
1856 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
1858         if (!rproc) {
1859                 pr_err("NULL rproc pointer\n");
1860                 return;
1861         }
1863         dev_err(&rproc->dev, "crash detected in %s: type %s\n",
1864                 rproc->name, rproc_crash_to_string(type));
1866         /* create a new task to handle the error */
1867         schedule_work(&rproc->crash_handler);
1869 EXPORT_SYMBOL(rproc_report_crash);
1871 static int __init remoteproc_init(void)
1873         rproc_init_sysfs();
1874         rproc_init_debugfs();
1876         return 0;
1878 module_init(remoteproc_init);
1880 static void __exit remoteproc_exit(void)
1882         ida_destroy(&rproc_dev_index);
1884         rproc_exit_debugfs();
1885         rproc_exit_sysfs();
1887 module_exit(remoteproc_exit);
1889 MODULE_LICENSE("GPL v2");
1890 MODULE_DESCRIPTION("Generic Remote Processor Framework");