remoteproc: fix spelling mistake: "Resouce" -> "Resource"
[sfrench/cifs-2.6.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  */
24
25 #define pr_fmt(fmt)    "%s: " fmt, __func__
26
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/remoteproc.h>
37 #include <linux/iommu.h>
38 #include <linux/idr.h>
39 #include <linux/elf.h>
40 #include <linux/crc32.h>
41 #include <linux/virtio_ids.h>
42 #include <linux/virtio_ring.h>
43 #include <asm/byteorder.h>
44
45 #include "remoteproc_internal.h"
46
47 static DEFINE_MUTEX(rproc_list_mutex);
48 static LIST_HEAD(rproc_list);
49
50 typedef int (*rproc_handle_resources_t)(struct rproc *rproc,
51                                 struct resource_table *table, int len);
52 typedef int (*rproc_handle_resource_t)(struct rproc *rproc,
53                                  void *, int offset, int avail);
54
55 /* Unique indices for remoteproc devices */
56 static DEFINE_IDA(rproc_dev_index);
57
58 static const char * const rproc_crash_names[] = {
59         [RPROC_MMUFAULT]        = "mmufault",
60         [RPROC_WATCHDOG]        = "watchdog",
61         [RPROC_FATAL_ERROR]     = "fatal error",
62 };
63
64 /* translate rproc_crash_type to string */
65 static const char *rproc_crash_to_string(enum rproc_crash_type type)
66 {
67         if (type < ARRAY_SIZE(rproc_crash_names))
68                 return rproc_crash_names[type];
69         return "unknown";
70 }
71
72 /*
73  * This is the IOMMU fault handler we register with the IOMMU API
74  * (when relevant; not all remote processors access memory through
75  * an IOMMU).
76  *
77  * IOMMU core will invoke this handler whenever the remote processor
78  * will try to access an unmapped device address.
79  */
80 static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
81                              unsigned long iova, int flags, void *token)
82 {
83         struct rproc *rproc = token;
84
85         dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
86
87         rproc_report_crash(rproc, RPROC_MMUFAULT);
88
89         /*
90          * Let the iommu core know we're not really handling this fault;
91          * we just used it as a recovery trigger.
92          */
93         return -ENOSYS;
94 }
95
96 static int rproc_enable_iommu(struct rproc *rproc)
97 {
98         struct iommu_domain *domain;
99         struct device *dev = rproc->dev.parent;
100         int ret;
101
102         if (!rproc->has_iommu) {
103                 dev_dbg(dev, "iommu not present\n");
104                 return 0;
105         }
106
107         domain = iommu_domain_alloc(dev->bus);
108         if (!domain) {
109                 dev_err(dev, "can't alloc iommu domain\n");
110                 return -ENOMEM;
111         }
112
113         iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
114
115         ret = iommu_attach_device(domain, dev);
116         if (ret) {
117                 dev_err(dev, "can't attach iommu device: %d\n", ret);
118                 goto free_domain;
119         }
120
121         rproc->domain = domain;
122
123         return 0;
124
125 free_domain:
126         iommu_domain_free(domain);
127         return ret;
128 }
129
130 static void rproc_disable_iommu(struct rproc *rproc)
131 {
132         struct iommu_domain *domain = rproc->domain;
133         struct device *dev = rproc->dev.parent;
134
135         if (!domain)
136                 return;
137
138         iommu_detach_device(domain, dev);
139         iommu_domain_free(domain);
140 }
141
142 /**
143  * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address
144  * @rproc: handle of a remote processor
145  * @da: remoteproc device address to translate
146  * @len: length of the memory region @da is pointing to
147  *
148  * Some remote processors will ask us to allocate them physically contiguous
149  * memory regions (which we call "carveouts"), and map them to specific
150  * device addresses (which are hardcoded in the firmware). They may also have
151  * dedicated memory regions internal to the processors, and use them either
152  * exclusively or alongside carveouts.
153  *
154  * They may then ask us to copy objects into specific device addresses (e.g.
155  * code/data sections) or expose us certain symbols in other device address
156  * (e.g. their trace buffer).
157  *
158  * This function is a helper function with which we can go over the allocated
159  * carveouts and translate specific device addresses to kernel virtual addresses
160  * so we can access the referenced memory. This function also allows to perform
161  * translations on the internal remoteproc memory regions through a platform
162  * implementation specific da_to_va ops, if present.
163  *
164  * The function returns a valid kernel address on success or NULL on failure.
165  *
166  * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
167  * but only on kernel direct mapped RAM memory. Instead, we're just using
168  * here the output of the DMA API for the carveouts, which should be more
169  * correct.
170  */
171 void *rproc_da_to_va(struct rproc *rproc, u64 da, int len)
172 {
173         struct rproc_mem_entry *carveout;
174         void *ptr = NULL;
175
176         if (rproc->ops->da_to_va) {
177                 ptr = rproc->ops->da_to_va(rproc, da, len);
178                 if (ptr)
179                         goto out;
180         }
181
182         list_for_each_entry(carveout, &rproc->carveouts, node) {
183                 int offset = da - carveout->da;
184
185                 /* try next carveout if da is too small */
186                 if (offset < 0)
187                         continue;
188
189                 /* try next carveout if da is too large */
190                 if (offset + len > carveout->len)
191                         continue;
192
193                 ptr = carveout->va + offset;
194
195                 break;
196         }
197
198 out:
199         return ptr;
200 }
201 EXPORT_SYMBOL(rproc_da_to_va);
202
203 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
204 {
205         struct rproc *rproc = rvdev->rproc;
206         struct device *dev = &rproc->dev;
207         struct rproc_vring *rvring = &rvdev->vring[i];
208         struct fw_rsc_vdev *rsc;
209         dma_addr_t dma;
210         void *va;
211         int ret, size, notifyid;
212
213         /* actual size of vring (in bytes) */
214         size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
215
216         /*
217          * Allocate non-cacheable memory for the vring. In the future
218          * this call will also configure the IOMMU for us
219          */
220         va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL);
221         if (!va) {
222                 dev_err(dev->parent, "dma_alloc_coherent failed\n");
223                 return -EINVAL;
224         }
225
226         /*
227          * Assign an rproc-wide unique index for this vring
228          * TODO: assign a notifyid for rvdev updates as well
229          * TODO: support predefined notifyids (via resource table)
230          */
231         ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
232         if (ret < 0) {
233                 dev_err(dev, "idr_alloc failed: %d\n", ret);
234                 dma_free_coherent(dev->parent, size, va, dma);
235                 return ret;
236         }
237         notifyid = ret;
238
239         /* Potentially bump max_notifyid */
240         if (notifyid > rproc->max_notifyid)
241                 rproc->max_notifyid = notifyid;
242
243         dev_dbg(dev, "vring%d: va %p dma %pad size 0x%x idr %d\n",
244                 i, va, &dma, size, notifyid);
245
246         rvring->va = va;
247         rvring->dma = dma;
248         rvring->notifyid = notifyid;
249
250         /*
251          * Let the rproc know the notifyid and da of this vring.
252          * Not all platforms use dma_alloc_coherent to automatically
253          * set up the iommu. In this case the device address (da) will
254          * hold the physical address and not the device address.
255          */
256         rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
257         rsc->vring[i].da = dma;
258         rsc->vring[i].notifyid = notifyid;
259         return 0;
260 }
261
262 static int
263 rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
264 {
265         struct rproc *rproc = rvdev->rproc;
266         struct device *dev = &rproc->dev;
267         struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
268         struct rproc_vring *rvring = &rvdev->vring[i];
269
270         dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
271                 i, vring->da, vring->num, vring->align);
272
273         /* verify queue size and vring alignment are sane */
274         if (!vring->num || !vring->align) {
275                 dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
276                         vring->num, vring->align);
277                 return -EINVAL;
278         }
279
280         rvring->len = vring->num;
281         rvring->align = vring->align;
282         rvring->rvdev = rvdev;
283
284         return 0;
285 }
286
287 void rproc_free_vring(struct rproc_vring *rvring)
288 {
289         int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
290         struct rproc *rproc = rvring->rvdev->rproc;
291         int idx = rvring->rvdev->vring - rvring;
292         struct fw_rsc_vdev *rsc;
293
294         dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
295         idr_remove(&rproc->notifyids, rvring->notifyid);
296
297         /* reset resource entry info */
298         rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
299         rsc->vring[idx].da = 0;
300         rsc->vring[idx].notifyid = -1;
301 }
302
303 static int rproc_vdev_do_probe(struct rproc_subdev *subdev)
304 {
305         struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
306
307         return rproc_add_virtio_dev(rvdev, rvdev->id);
308 }
309
310 static void rproc_vdev_do_remove(struct rproc_subdev *subdev)
311 {
312         struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
313
314         rproc_remove_virtio_dev(rvdev);
315 }
316
317 /**
318  * rproc_handle_vdev() - handle a vdev fw resource
319  * @rproc: the remote processor
320  * @rsc: the vring resource descriptor
321  * @avail: size of available data (for sanity checking the image)
322  *
323  * This resource entry requests the host to statically register a virtio
324  * device (vdev), and setup everything needed to support it. It contains
325  * everything needed to make it possible: the virtio device id, virtio
326  * device features, vrings information, virtio config space, etc...
327  *
328  * Before registering the vdev, the vrings are allocated from non-cacheable
329  * physically contiguous memory. Currently we only support two vrings per
330  * remote processor (temporary limitation). We might also want to consider
331  * doing the vring allocation only later when ->find_vqs() is invoked, and
332  * then release them upon ->del_vqs().
333  *
334  * Note: @da is currently not really handled correctly: we dynamically
335  * allocate it using the DMA API, ignoring requested hard coded addresses,
336  * and we don't take care of any required IOMMU programming. This is all
337  * going to be taken care of when the generic iommu-based DMA API will be
338  * merged. Meanwhile, statically-addressed iommu-based firmware images should
339  * use RSC_DEVMEM resource entries to map their required @da to the physical
340  * address of their base CMA region (ouch, hacky!).
341  *
342  * Returns 0 on success, or an appropriate error code otherwise
343  */
344 static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
345                              int offset, int avail)
346 {
347         struct device *dev = &rproc->dev;
348         struct rproc_vdev *rvdev;
349         int i, ret;
350
351         /* make sure resource isn't truncated */
352         if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
353                         + rsc->config_len > avail) {
354                 dev_err(dev, "vdev rsc is truncated\n");
355                 return -EINVAL;
356         }
357
358         /* make sure reserved bytes are zeroes */
359         if (rsc->reserved[0] || rsc->reserved[1]) {
360                 dev_err(dev, "vdev rsc has non zero reserved bytes\n");
361                 return -EINVAL;
362         }
363
364         dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
365                 rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
366
367         /* we currently support only two vrings per rvdev */
368         if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
369                 dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
370                 return -EINVAL;
371         }
372
373         rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL);
374         if (!rvdev)
375                 return -ENOMEM;
376
377         kref_init(&rvdev->refcount);
378
379         rvdev->id = rsc->id;
380         rvdev->rproc = rproc;
381
382         /* parse the vrings */
383         for (i = 0; i < rsc->num_of_vrings; i++) {
384                 ret = rproc_parse_vring(rvdev, rsc, i);
385                 if (ret)
386                         goto free_rvdev;
387         }
388
389         /* remember the resource offset*/
390         rvdev->rsc_offset = offset;
391
392         /* allocate the vring resources */
393         for (i = 0; i < rsc->num_of_vrings; i++) {
394                 ret = rproc_alloc_vring(rvdev, i);
395                 if (ret)
396                         goto unwind_vring_allocations;
397         }
398
399         list_add_tail(&rvdev->node, &rproc->rvdevs);
400
401         rproc_add_subdev(rproc, &rvdev->subdev,
402                          rproc_vdev_do_probe, rproc_vdev_do_remove);
403
404         return 0;
405
406 unwind_vring_allocations:
407         for (i--; i >= 0; i--)
408                 rproc_free_vring(&rvdev->vring[i]);
409 free_rvdev:
410         kfree(rvdev);
411         return ret;
412 }
413
414 void rproc_vdev_release(struct kref *ref)
415 {
416         struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount);
417         struct rproc_vring *rvring;
418         struct rproc *rproc = rvdev->rproc;
419         int id;
420
421         for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) {
422                 rvring = &rvdev->vring[id];
423                 if (!rvring->va)
424                         continue;
425
426                 rproc_free_vring(rvring);
427         }
428
429         rproc_remove_subdev(rproc, &rvdev->subdev);
430         list_del(&rvdev->node);
431         kfree(rvdev);
432 }
433
434 /**
435  * rproc_handle_trace() - handle a shared trace buffer resource
436  * @rproc: the remote processor
437  * @rsc: the trace resource descriptor
438  * @avail: size of available data (for sanity checking the image)
439  *
440  * In case the remote processor dumps trace logs into memory,
441  * export it via debugfs.
442  *
443  * Currently, the 'da' member of @rsc should contain the device address
444  * where the remote processor is dumping the traces. Later we could also
445  * support dynamically allocating this address using the generic
446  * DMA API (but currently there isn't a use case for that).
447  *
448  * Returns 0 on success, or an appropriate error code otherwise
449  */
450 static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
451                               int offset, int avail)
452 {
453         struct rproc_mem_entry *trace;
454         struct device *dev = &rproc->dev;
455         void *ptr;
456         char name[15];
457
458         if (sizeof(*rsc) > avail) {
459                 dev_err(dev, "trace rsc is truncated\n");
460                 return -EINVAL;
461         }
462
463         /* make sure reserved bytes are zeroes */
464         if (rsc->reserved) {
465                 dev_err(dev, "trace rsc has non zero reserved bytes\n");
466                 return -EINVAL;
467         }
468
469         /* what's the kernel address of this resource ? */
470         ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
471         if (!ptr) {
472                 dev_err(dev, "erroneous trace resource entry\n");
473                 return -EINVAL;
474         }
475
476         trace = kzalloc(sizeof(*trace), GFP_KERNEL);
477         if (!trace)
478                 return -ENOMEM;
479
480         /* set the trace buffer dma properties */
481         trace->len = rsc->len;
482         trace->va = ptr;
483
484         /* make sure snprintf always null terminates, even if truncating */
485         snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
486
487         /* create the debugfs entry */
488         trace->priv = rproc_create_trace_file(name, rproc, trace);
489         if (!trace->priv) {
490                 trace->va = NULL;
491                 kfree(trace);
492                 return -EINVAL;
493         }
494
495         list_add_tail(&trace->node, &rproc->traces);
496
497         rproc->num_traces++;
498
499         dev_dbg(dev, "%s added: va %p, da 0x%x, len 0x%x\n",
500                 name, ptr, rsc->da, rsc->len);
501
502         return 0;
503 }
504
505 /**
506  * rproc_handle_devmem() - handle devmem resource entry
507  * @rproc: remote processor handle
508  * @rsc: the devmem resource entry
509  * @avail: size of available data (for sanity checking the image)
510  *
511  * Remote processors commonly need to access certain on-chip peripherals.
512  *
513  * Some of these remote processors access memory via an iommu device,
514  * and might require us to configure their iommu before they can access
515  * the on-chip peripherals they need.
516  *
517  * This resource entry is a request to map such a peripheral device.
518  *
519  * These devmem entries will contain the physical address of the device in
520  * the 'pa' member. If a specific device address is expected, then 'da' will
521  * contain it (currently this is the only use case supported). 'len' will
522  * contain the size of the physical region we need to map.
523  *
524  * Currently we just "trust" those devmem entries to contain valid physical
525  * addresses, but this is going to change: we want the implementations to
526  * tell us ranges of physical addresses the firmware is allowed to request,
527  * and not allow firmwares to request access to physical addresses that
528  * are outside those ranges.
529  */
530 static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
531                                int offset, int avail)
532 {
533         struct rproc_mem_entry *mapping;
534         struct device *dev = &rproc->dev;
535         int ret;
536
537         /* no point in handling this resource without a valid iommu domain */
538         if (!rproc->domain)
539                 return -EINVAL;
540
541         if (sizeof(*rsc) > avail) {
542                 dev_err(dev, "devmem rsc is truncated\n");
543                 return -EINVAL;
544         }
545
546         /* make sure reserved bytes are zeroes */
547         if (rsc->reserved) {
548                 dev_err(dev, "devmem rsc has non zero reserved bytes\n");
549                 return -EINVAL;
550         }
551
552         mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
553         if (!mapping)
554                 return -ENOMEM;
555
556         ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
557         if (ret) {
558                 dev_err(dev, "failed to map devmem: %d\n", ret);
559                 goto out;
560         }
561
562         /*
563          * We'll need this info later when we'll want to unmap everything
564          * (e.g. on shutdown).
565          *
566          * We can't trust the remote processor not to change the resource
567          * table, so we must maintain this info independently.
568          */
569         mapping->da = rsc->da;
570         mapping->len = rsc->len;
571         list_add_tail(&mapping->node, &rproc->mappings);
572
573         dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
574                 rsc->pa, rsc->da, rsc->len);
575
576         return 0;
577
578 out:
579         kfree(mapping);
580         return ret;
581 }
582
583 /**
584  * rproc_handle_carveout() - handle phys contig memory allocation requests
585  * @rproc: rproc handle
586  * @rsc: the resource entry
587  * @avail: size of available data (for image validation)
588  *
589  * This function will handle firmware requests for allocation of physically
590  * contiguous memory regions.
591  *
592  * These request entries should come first in the firmware's resource table,
593  * as other firmware entries might request placing other data objects inside
594  * these memory regions (e.g. data/code segments, trace resource entries, ...).
595  *
596  * Allocating memory this way helps utilizing the reserved physical memory
597  * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
598  * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
599  * pressure is important; it may have a substantial impact on performance.
600  */
601 static int rproc_handle_carveout(struct rproc *rproc,
602                                  struct fw_rsc_carveout *rsc,
603                                  int offset, int avail)
604 {
605         struct rproc_mem_entry *carveout, *mapping;
606         struct device *dev = &rproc->dev;
607         dma_addr_t dma;
608         void *va;
609         int ret;
610
611         if (sizeof(*rsc) > avail) {
612                 dev_err(dev, "carveout rsc is truncated\n");
613                 return -EINVAL;
614         }
615
616         /* make sure reserved bytes are zeroes */
617         if (rsc->reserved) {
618                 dev_err(dev, "carveout rsc has non zero reserved bytes\n");
619                 return -EINVAL;
620         }
621
622         dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
623                 rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
624
625         carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
626         if (!carveout)
627                 return -ENOMEM;
628
629         va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
630         if (!va) {
631                 dev_err(dev->parent,
632                         "failed to allocate dma memory: len 0x%x\n", rsc->len);
633                 ret = -ENOMEM;
634                 goto free_carv;
635         }
636
637         dev_dbg(dev, "carveout va %p, dma %pad, len 0x%x\n",
638                 va, &dma, rsc->len);
639
640         /*
641          * Ok, this is non-standard.
642          *
643          * Sometimes we can't rely on the generic iommu-based DMA API
644          * to dynamically allocate the device address and then set the IOMMU
645          * tables accordingly, because some remote processors might
646          * _require_ us to use hard coded device addresses that their
647          * firmware was compiled with.
648          *
649          * In this case, we must use the IOMMU API directly and map
650          * the memory to the device address as expected by the remote
651          * processor.
652          *
653          * Obviously such remote processor devices should not be configured
654          * to use the iommu-based DMA API: we expect 'dma' to contain the
655          * physical address in this case.
656          */
657         if (rproc->domain) {
658                 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
659                 if (!mapping) {
660                         ret = -ENOMEM;
661                         goto dma_free;
662                 }
663
664                 ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
665                                 rsc->flags);
666                 if (ret) {
667                         dev_err(dev, "iommu_map failed: %d\n", ret);
668                         goto free_mapping;
669                 }
670
671                 /*
672                  * We'll need this info later when we'll want to unmap
673                  * everything (e.g. on shutdown).
674                  *
675                  * We can't trust the remote processor not to change the
676                  * resource table, so we must maintain this info independently.
677                  */
678                 mapping->da = rsc->da;
679                 mapping->len = rsc->len;
680                 list_add_tail(&mapping->node, &rproc->mappings);
681
682                 dev_dbg(dev, "carveout mapped 0x%x to %pad\n",
683                         rsc->da, &dma);
684         }
685
686         /*
687          * Some remote processors might need to know the pa
688          * even though they are behind an IOMMU. E.g., OMAP4's
689          * remote M3 processor needs this so it can control
690          * on-chip hardware accelerators that are not behind
691          * the IOMMU, and therefor must know the pa.
692          *
693          * Generally we don't want to expose physical addresses
694          * if we don't have to (remote processors are generally
695          * _not_ trusted), so we might want to do this only for
696          * remote processor that _must_ have this (e.g. OMAP4's
697          * dual M3 subsystem).
698          *
699          * Non-IOMMU processors might also want to have this info.
700          * In this case, the device address and the physical address
701          * are the same.
702          */
703         rsc->pa = dma;
704
705         carveout->va = va;
706         carveout->len = rsc->len;
707         carveout->dma = dma;
708         carveout->da = rsc->da;
709
710         list_add_tail(&carveout->node, &rproc->carveouts);
711
712         return 0;
713
714 free_mapping:
715         kfree(mapping);
716 dma_free:
717         dma_free_coherent(dev->parent, rsc->len, va, dma);
718 free_carv:
719         kfree(carveout);
720         return ret;
721 }
722
723 /*
724  * A lookup table for resource handlers. The indices are defined in
725  * enum fw_resource_type.
726  */
727 static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
728         [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
729         [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
730         [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
731         [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
732 };
733
734 /* handle firmware resource entries before booting the remote processor */
735 static int rproc_handle_resources(struct rproc *rproc, int len,
736                                   rproc_handle_resource_t handlers[RSC_LAST])
737 {
738         struct device *dev = &rproc->dev;
739         rproc_handle_resource_t handler;
740         int ret = 0, i;
741
742         for (i = 0; i < rproc->table_ptr->num; i++) {
743                 int offset = rproc->table_ptr->offset[i];
744                 struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
745                 int avail = len - offset - sizeof(*hdr);
746                 void *rsc = (void *)hdr + sizeof(*hdr);
747
748                 /* make sure table isn't truncated */
749                 if (avail < 0) {
750                         dev_err(dev, "rsc table is truncated\n");
751                         return -EINVAL;
752                 }
753
754                 dev_dbg(dev, "rsc: type %d\n", hdr->type);
755
756                 if (hdr->type >= RSC_LAST) {
757                         dev_warn(dev, "unsupported resource %d\n", hdr->type);
758                         continue;
759                 }
760
761                 handler = handlers[hdr->type];
762                 if (!handler)
763                         continue;
764
765                 ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
766                 if (ret)
767                         break;
768         }
769
770         return ret;
771 }
772
773 static int rproc_probe_subdevices(struct rproc *rproc)
774 {
775         struct rproc_subdev *subdev;
776         int ret;
777
778         list_for_each_entry(subdev, &rproc->subdevs, node) {
779                 ret = subdev->probe(subdev);
780                 if (ret)
781                         goto unroll_registration;
782         }
783
784         return 0;
785
786 unroll_registration:
787         list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node)
788                 subdev->remove(subdev);
789
790         return ret;
791 }
792
793 static void rproc_remove_subdevices(struct rproc *rproc)
794 {
795         struct rproc_subdev *subdev;
796
797         list_for_each_entry(subdev, &rproc->subdevs, node)
798                 subdev->remove(subdev);
799 }
800
801 /**
802  * rproc_resource_cleanup() - clean up and free all acquired resources
803  * @rproc: rproc handle
804  *
805  * This function will free all resources acquired for @rproc, and it
806  * is called whenever @rproc either shuts down or fails to boot.
807  */
808 static void rproc_resource_cleanup(struct rproc *rproc)
809 {
810         struct rproc_mem_entry *entry, *tmp;
811         struct rproc_vdev *rvdev, *rvtmp;
812         struct device *dev = &rproc->dev;
813
814         /* clean up debugfs trace entries */
815         list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
816                 rproc_remove_trace_file(entry->priv);
817                 rproc->num_traces--;
818                 list_del(&entry->node);
819                 kfree(entry);
820         }
821
822         /* clean up iommu mapping entries */
823         list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
824                 size_t unmapped;
825
826                 unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
827                 if (unmapped != entry->len) {
828                         /* nothing much to do besides complaining */
829                         dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
830                                 unmapped);
831                 }
832
833                 list_del(&entry->node);
834                 kfree(entry);
835         }
836
837         /* clean up carveout allocations */
838         list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
839                 dma_free_coherent(dev->parent, entry->len, entry->va,
840                                   entry->dma);
841                 list_del(&entry->node);
842                 kfree(entry);
843         }
844
845         /* clean up remote vdev entries */
846         list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
847                 kref_put(&rvdev->refcount, rproc_vdev_release);
848 }
849
850 static int rproc_start(struct rproc *rproc, const struct firmware *fw)
851 {
852         struct resource_table *table, *loaded_table;
853         struct device *dev = &rproc->dev;
854         int ret, tablesz;
855
856         /* look for the resource table */
857         table = rproc_find_rsc_table(rproc, fw, &tablesz);
858         if (!table) {
859                 dev_err(dev, "Resource table look up failed\n");
860                 return -EINVAL;
861         }
862
863         /* load the ELF segments to memory */
864         ret = rproc_load_segments(rproc, fw);
865         if (ret) {
866                 dev_err(dev, "Failed to load program segments: %d\n", ret);
867                 return ret;
868         }
869
870         /*
871          * The starting device has been given the rproc->cached_table as the
872          * resource table. The address of the vring along with the other
873          * allocated resources (carveouts etc) is stored in cached_table.
874          * In order to pass this information to the remote device we must copy
875          * this information to device memory. We also update the table_ptr so
876          * that any subsequent changes will be applied to the loaded version.
877          */
878         loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
879         if (loaded_table) {
880                 memcpy(loaded_table, rproc->cached_table, tablesz);
881                 rproc->table_ptr = loaded_table;
882         }
883
884         /* power up the remote processor */
885         ret = rproc->ops->start(rproc);
886         if (ret) {
887                 dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
888                 return ret;
889         }
890
891         /* probe any subdevices for the remote processor */
892         ret = rproc_probe_subdevices(rproc);
893         if (ret) {
894                 dev_err(dev, "failed to probe subdevices for %s: %d\n",
895                         rproc->name, ret);
896                 rproc->ops->stop(rproc);
897                 return ret;
898         }
899
900         rproc->state = RPROC_RUNNING;
901
902         dev_info(dev, "remote processor %s is now up\n", rproc->name);
903
904         return 0;
905 }
906
907 /*
908  * take a firmware and boot a remote processor with it.
909  */
910 static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
911 {
912         struct device *dev = &rproc->dev;
913         const char *name = rproc->firmware;
914         struct resource_table *table;
915         int ret, tablesz;
916
917         ret = rproc_fw_sanity_check(rproc, fw);
918         if (ret)
919                 return ret;
920
921         dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
922
923         /*
924          * if enabling an IOMMU isn't relevant for this rproc, this is
925          * just a nop
926          */
927         ret = rproc_enable_iommu(rproc);
928         if (ret) {
929                 dev_err(dev, "can't enable iommu: %d\n", ret);
930                 return ret;
931         }
932
933         rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
934         ret = -EINVAL;
935
936         /* look for the resource table */
937         table = rproc_find_rsc_table(rproc, fw, &tablesz);
938         if (!table) {
939                 dev_err(dev, "Failed to find resource table\n");
940                 goto clean_up;
941         }
942
943         /*
944          * Create a copy of the resource table. When a virtio device starts
945          * and calls vring_new_virtqueue() the address of the allocated vring
946          * will be stored in the cached_table. Before the device is started,
947          * cached_table will be copied into device memory.
948          */
949         rproc->cached_table = kmemdup(table, tablesz, GFP_KERNEL);
950         if (!rproc->cached_table)
951                 goto clean_up;
952
953         rproc->table_ptr = rproc->cached_table;
954
955         /* reset max_notifyid */
956         rproc->max_notifyid = -1;
957
958         /* handle fw resources which are required to boot rproc */
959         ret = rproc_handle_resources(rproc, tablesz, rproc_loading_handlers);
960         if (ret) {
961                 dev_err(dev, "Failed to process resources: %d\n", ret);
962                 goto clean_up_resources;
963         }
964
965         ret = rproc_start(rproc, fw);
966         if (ret)
967                 goto clean_up_resources;
968
969         return 0;
970
971 clean_up_resources:
972         rproc_resource_cleanup(rproc);
973 clean_up:
974         kfree(rproc->cached_table);
975         rproc->cached_table = NULL;
976         rproc->table_ptr = NULL;
977
978         rproc_disable_iommu(rproc);
979         return ret;
980 }
981
982 /*
983  * take a firmware and boot it up.
984  *
985  * Note: this function is called asynchronously upon registration of the
986  * remote processor (so we must wait until it completes before we try
987  * to unregister the device. one other option is just to use kref here,
988  * that might be cleaner).
989  */
990 static void rproc_auto_boot_callback(const struct firmware *fw, void *context)
991 {
992         struct rproc *rproc = context;
993
994         rproc_boot(rproc);
995
996         release_firmware(fw);
997 }
998
999 static int rproc_trigger_auto_boot(struct rproc *rproc)
1000 {
1001         int ret;
1002
1003         /*
1004          * We're initiating an asynchronous firmware loading, so we can
1005          * be built-in kernel code, without hanging the boot process.
1006          */
1007         ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
1008                                       rproc->firmware, &rproc->dev, GFP_KERNEL,
1009                                       rproc, rproc_auto_boot_callback);
1010         if (ret < 0)
1011                 dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
1012
1013         return ret;
1014 }
1015
1016 static int rproc_stop(struct rproc *rproc)
1017 {
1018         struct device *dev = &rproc->dev;
1019         int ret;
1020
1021         /* remove any subdevices for the remote processor */
1022         rproc_remove_subdevices(rproc);
1023
1024         /* power off the remote processor */
1025         ret = rproc->ops->stop(rproc);
1026         if (ret) {
1027                 dev_err(dev, "can't stop rproc: %d\n", ret);
1028                 return ret;
1029         }
1030
1031         /* if in crash state, unlock crash handler */
1032         if (rproc->state == RPROC_CRASHED)
1033                 complete_all(&rproc->crash_comp);
1034
1035         rproc->state = RPROC_OFFLINE;
1036
1037         dev_info(dev, "stopped remote processor %s\n", rproc->name);
1038
1039         return 0;
1040 }
1041
1042 /**
1043  * rproc_trigger_recovery() - recover a remoteproc
1044  * @rproc: the remote processor
1045  *
1046  * The recovery is done by resetting all the virtio devices, that way all the
1047  * rpmsg drivers will be reseted along with the remote processor making the
1048  * remoteproc functional again.
1049  *
1050  * This function can sleep, so it cannot be called from atomic context.
1051  */
1052 int rproc_trigger_recovery(struct rproc *rproc)
1053 {
1054         const struct firmware *firmware_p;
1055         struct device *dev = &rproc->dev;
1056         int ret;
1057
1058         dev_err(dev, "recovering %s\n", rproc->name);
1059
1060         init_completion(&rproc->crash_comp);
1061
1062         ret = mutex_lock_interruptible(&rproc->lock);
1063         if (ret)
1064                 return ret;
1065
1066         ret = rproc_stop(rproc);
1067         if (ret)
1068                 goto unlock_mutex;
1069
1070         /* wait until there is no more rproc users */
1071         wait_for_completion(&rproc->crash_comp);
1072
1073         /* load firmware */
1074         ret = request_firmware(&firmware_p, rproc->firmware, dev);
1075         if (ret < 0) {
1076                 dev_err(dev, "request_firmware failed: %d\n", ret);
1077                 goto unlock_mutex;
1078         }
1079
1080         /* boot the remote processor up again */
1081         ret = rproc_start(rproc, firmware_p);
1082
1083         release_firmware(firmware_p);
1084
1085 unlock_mutex:
1086         mutex_unlock(&rproc->lock);
1087         return ret;
1088 }
1089
1090 /**
1091  * rproc_crash_handler_work() - handle a crash
1092  *
1093  * This function needs to handle everything related to a crash, like cpu
1094  * registers and stack dump, information to help to debug the fatal error, etc.
1095  */
1096 static void rproc_crash_handler_work(struct work_struct *work)
1097 {
1098         struct rproc *rproc = container_of(work, struct rproc, crash_handler);
1099         struct device *dev = &rproc->dev;
1100
1101         dev_dbg(dev, "enter %s\n", __func__);
1102
1103         mutex_lock(&rproc->lock);
1104
1105         if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
1106                 /* handle only the first crash detected */
1107                 mutex_unlock(&rproc->lock);
1108                 return;
1109         }
1110
1111         rproc->state = RPROC_CRASHED;
1112         dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
1113                 rproc->name);
1114
1115         mutex_unlock(&rproc->lock);
1116
1117         if (!rproc->recovery_disabled)
1118                 rproc_trigger_recovery(rproc);
1119 }
1120
1121 /**
1122  * __rproc_boot() - boot a remote processor
1123  * @rproc: handle of a remote processor
1124  *
1125  * Boot a remote processor (i.e. load its firmware, power it on, ...).
1126  *
1127  * If the remote processor is already powered on, this function immediately
1128  * returns (successfully).
1129  *
1130  * Returns 0 on success, and an appropriate error value otherwise.
1131  */
1132 static int __rproc_boot(struct rproc *rproc)
1133 {
1134         const struct firmware *firmware_p;
1135         struct device *dev;
1136         int ret;
1137
1138         if (!rproc) {
1139                 pr_err("invalid rproc handle\n");
1140                 return -EINVAL;
1141         }
1142
1143         dev = &rproc->dev;
1144
1145         ret = mutex_lock_interruptible(&rproc->lock);
1146         if (ret) {
1147                 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1148                 return ret;
1149         }
1150
1151         if (rproc->state == RPROC_DELETED) {
1152                 ret = -ENODEV;
1153                 dev_err(dev, "can't boot deleted rproc %s\n", rproc->name);
1154                 goto unlock_mutex;
1155         }
1156
1157         /* skip the boot process if rproc is already powered up */
1158         if (atomic_inc_return(&rproc->power) > 1) {
1159                 ret = 0;
1160                 goto unlock_mutex;
1161         }
1162
1163         dev_info(dev, "powering up %s\n", rproc->name);
1164
1165         /* load firmware */
1166         ret = request_firmware(&firmware_p, rproc->firmware, dev);
1167         if (ret < 0) {
1168                 dev_err(dev, "request_firmware failed: %d\n", ret);
1169                 goto downref_rproc;
1170         }
1171
1172         ret = rproc_fw_boot(rproc, firmware_p);
1173
1174         release_firmware(firmware_p);
1175
1176 downref_rproc:
1177         if (ret)
1178                 atomic_dec(&rproc->power);
1179 unlock_mutex:
1180         mutex_unlock(&rproc->lock);
1181         return ret;
1182 }
1183
1184 /**
1185  * rproc_boot() - boot a remote processor
1186  * @rproc: handle of a remote processor
1187  */
1188 int rproc_boot(struct rproc *rproc)
1189 {
1190         return __rproc_boot(rproc);
1191 }
1192 EXPORT_SYMBOL(rproc_boot);
1193
1194 /**
1195  * rproc_shutdown() - power off the remote processor
1196  * @rproc: the remote processor
1197  *
1198  * Power off a remote processor (previously booted with rproc_boot()).
1199  *
1200  * In case @rproc is still being used by an additional user(s), then
1201  * this function will just decrement the power refcount and exit,
1202  * without really powering off the device.
1203  *
1204  * Every call to rproc_boot() must (eventually) be accompanied by a call
1205  * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1206  *
1207  * Notes:
1208  * - we're not decrementing the rproc's refcount, only the power refcount.
1209  *   which means that the @rproc handle stays valid even after rproc_shutdown()
1210  *   returns, and users can still use it with a subsequent rproc_boot(), if
1211  *   needed.
1212  */
1213 void rproc_shutdown(struct rproc *rproc)
1214 {
1215         struct device *dev = &rproc->dev;
1216         int ret;
1217
1218         ret = mutex_lock_interruptible(&rproc->lock);
1219         if (ret) {
1220                 dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1221                 return;
1222         }
1223
1224         /* if the remote proc is still needed, bail out */
1225         if (!atomic_dec_and_test(&rproc->power))
1226                 goto out;
1227
1228         ret = rproc_stop(rproc);
1229         if (ret) {
1230                 atomic_inc(&rproc->power);
1231                 goto out;
1232         }
1233
1234         /* clean up all acquired resources */
1235         rproc_resource_cleanup(rproc);
1236
1237         rproc_disable_iommu(rproc);
1238
1239         /* Free the copy of the resource table */
1240         kfree(rproc->cached_table);
1241         rproc->cached_table = NULL;
1242         rproc->table_ptr = NULL;
1243 out:
1244         mutex_unlock(&rproc->lock);
1245 }
1246 EXPORT_SYMBOL(rproc_shutdown);
1247
1248 /**
1249  * rproc_get_by_phandle() - find a remote processor by phandle
1250  * @phandle: phandle to the rproc
1251  *
1252  * Finds an rproc handle using the remote processor's phandle, and then
1253  * return a handle to the rproc.
1254  *
1255  * This function increments the remote processor's refcount, so always
1256  * use rproc_put() to decrement it back once rproc isn't needed anymore.
1257  *
1258  * Returns the rproc handle on success, and NULL on failure.
1259  */
1260 #ifdef CONFIG_OF
1261 struct rproc *rproc_get_by_phandle(phandle phandle)
1262 {
1263         struct rproc *rproc = NULL, *r;
1264         struct device_node *np;
1265
1266         np = of_find_node_by_phandle(phandle);
1267         if (!np)
1268                 return NULL;
1269
1270         mutex_lock(&rproc_list_mutex);
1271         list_for_each_entry(r, &rproc_list, node) {
1272                 if (r->dev.parent && r->dev.parent->of_node == np) {
1273                         /* prevent underlying implementation from being removed */
1274                         if (!try_module_get(r->dev.parent->driver->owner)) {
1275                                 dev_err(&r->dev, "can't get owner\n");
1276                                 break;
1277                         }
1278
1279                         rproc = r;
1280                         get_device(&rproc->dev);
1281                         break;
1282                 }
1283         }
1284         mutex_unlock(&rproc_list_mutex);
1285
1286         of_node_put(np);
1287
1288         return rproc;
1289 }
1290 #else
1291 struct rproc *rproc_get_by_phandle(phandle phandle)
1292 {
1293         return NULL;
1294 }
1295 #endif
1296 EXPORT_SYMBOL(rproc_get_by_phandle);
1297
1298 /**
1299  * rproc_add() - register a remote processor
1300  * @rproc: the remote processor handle to register
1301  *
1302  * Registers @rproc with the remoteproc framework, after it has been
1303  * allocated with rproc_alloc().
1304  *
1305  * This is called by the platform-specific rproc implementation, whenever
1306  * a new remote processor device is probed.
1307  *
1308  * Returns 0 on success and an appropriate error code otherwise.
1309  *
1310  * Note: this function initiates an asynchronous firmware loading
1311  * context, which will look for virtio devices supported by the rproc's
1312  * firmware.
1313  *
1314  * If found, those virtio devices will be created and added, so as a result
1315  * of registering this remote processor, additional virtio drivers might be
1316  * probed.
1317  */
1318 int rproc_add(struct rproc *rproc)
1319 {
1320         struct device *dev = &rproc->dev;
1321         int ret;
1322
1323         ret = device_add(dev);
1324         if (ret < 0)
1325                 return ret;
1326
1327         dev_info(dev, "%s is available\n", rproc->name);
1328
1329         /* create debugfs entries */
1330         rproc_create_debug_dir(rproc);
1331
1332         /* if rproc is marked always-on, request it to boot */
1333         if (rproc->auto_boot) {
1334                 ret = rproc_trigger_auto_boot(rproc);
1335                 if (ret < 0)
1336                         return ret;
1337         }
1338
1339         /* expose to rproc_get_by_phandle users */
1340         mutex_lock(&rproc_list_mutex);
1341         list_add(&rproc->node, &rproc_list);
1342         mutex_unlock(&rproc_list_mutex);
1343
1344         return 0;
1345 }
1346 EXPORT_SYMBOL(rproc_add);
1347
1348 /**
1349  * rproc_type_release() - release a remote processor instance
1350  * @dev: the rproc's device
1351  *
1352  * This function should _never_ be called directly.
1353  *
1354  * It will be called by the driver core when no one holds a valid pointer
1355  * to @dev anymore.
1356  */
1357 static void rproc_type_release(struct device *dev)
1358 {
1359         struct rproc *rproc = container_of(dev, struct rproc, dev);
1360
1361         dev_info(&rproc->dev, "releasing %s\n", rproc->name);
1362
1363         idr_destroy(&rproc->notifyids);
1364
1365         if (rproc->index >= 0)
1366                 ida_simple_remove(&rproc_dev_index, rproc->index);
1367
1368         kfree(rproc->firmware);
1369         kfree(rproc);
1370 }
1371
1372 static struct device_type rproc_type = {
1373         .name           = "remoteproc",
1374         .release        = rproc_type_release,
1375 };
1376
1377 /**
1378  * rproc_alloc() - allocate a remote processor handle
1379  * @dev: the underlying device
1380  * @name: name of this remote processor
1381  * @ops: platform-specific handlers (mainly start/stop)
1382  * @firmware: name of firmware file to load, can be NULL
1383  * @len: length of private data needed by the rproc driver (in bytes)
1384  *
1385  * Allocates a new remote processor handle, but does not register
1386  * it yet. if @firmware is NULL, a default name is used.
1387  *
1388  * This function should be used by rproc implementations during initialization
1389  * of the remote processor.
1390  *
1391  * After creating an rproc handle using this function, and when ready,
1392  * implementations should then call rproc_add() to complete
1393  * the registration of the remote processor.
1394  *
1395  * On success the new rproc is returned, and on failure, NULL.
1396  *
1397  * Note: _never_ directly deallocate @rproc, even if it was not registered
1398  * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
1399  */
1400 struct rproc *rproc_alloc(struct device *dev, const char *name,
1401                           const struct rproc_ops *ops,
1402                           const char *firmware, int len)
1403 {
1404         struct rproc *rproc;
1405         char *p, *template = "rproc-%s-fw";
1406         int name_len;
1407
1408         if (!dev || !name || !ops)
1409                 return NULL;
1410
1411         if (!firmware) {
1412                 /*
1413                  * If the caller didn't pass in a firmware name then
1414                  * construct a default name.
1415                  */
1416                 name_len = strlen(name) + strlen(template) - 2 + 1;
1417                 p = kmalloc(name_len, GFP_KERNEL);
1418                 if (!p)
1419                         return NULL;
1420                 snprintf(p, name_len, template, name);
1421         } else {
1422                 p = kstrdup(firmware, GFP_KERNEL);
1423                 if (!p)
1424                         return NULL;
1425         }
1426
1427         rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
1428         if (!rproc) {
1429                 kfree(p);
1430                 return NULL;
1431         }
1432
1433         rproc->firmware = p;
1434         rproc->name = name;
1435         rproc->ops = ops;
1436         rproc->priv = &rproc[1];
1437         rproc->auto_boot = true;
1438
1439         device_initialize(&rproc->dev);
1440         rproc->dev.parent = dev;
1441         rproc->dev.type = &rproc_type;
1442         rproc->dev.class = &rproc_class;
1443
1444         /* Assign a unique device index and name */
1445         rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1446         if (rproc->index < 0) {
1447                 dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1448                 put_device(&rproc->dev);
1449                 return NULL;
1450         }
1451
1452         dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1453
1454         atomic_set(&rproc->power, 0);
1455
1456         /* Set ELF as the default fw_ops handler */
1457         rproc->fw_ops = &rproc_elf_fw_ops;
1458
1459         mutex_init(&rproc->lock);
1460
1461         idr_init(&rproc->notifyids);
1462
1463         INIT_LIST_HEAD(&rproc->carveouts);
1464         INIT_LIST_HEAD(&rproc->mappings);
1465         INIT_LIST_HEAD(&rproc->traces);
1466         INIT_LIST_HEAD(&rproc->rvdevs);
1467         INIT_LIST_HEAD(&rproc->subdevs);
1468
1469         INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
1470         init_completion(&rproc->crash_comp);
1471
1472         rproc->state = RPROC_OFFLINE;
1473
1474         return rproc;
1475 }
1476 EXPORT_SYMBOL(rproc_alloc);
1477
1478 /**
1479  * rproc_free() - unroll rproc_alloc()
1480  * @rproc: the remote processor handle
1481  *
1482  * This function decrements the rproc dev refcount.
1483  *
1484  * If no one holds any reference to rproc anymore, then its refcount would
1485  * now drop to zero, and it would be freed.
1486  */
1487 void rproc_free(struct rproc *rproc)
1488 {
1489         put_device(&rproc->dev);
1490 }
1491 EXPORT_SYMBOL(rproc_free);
1492
1493 /**
1494  * rproc_put() - release rproc reference
1495  * @rproc: the remote processor handle
1496  *
1497  * This function decrements the rproc dev refcount.
1498  *
1499  * If no one holds any reference to rproc anymore, then its refcount would
1500  * now drop to zero, and it would be freed.
1501  */
1502 void rproc_put(struct rproc *rproc)
1503 {
1504         module_put(rproc->dev.parent->driver->owner);
1505         put_device(&rproc->dev);
1506 }
1507 EXPORT_SYMBOL(rproc_put);
1508
1509 /**
1510  * rproc_del() - unregister a remote processor
1511  * @rproc: rproc handle to unregister
1512  *
1513  * This function should be called when the platform specific rproc
1514  * implementation decides to remove the rproc device. it should
1515  * _only_ be called if a previous invocation of rproc_add()
1516  * has completed successfully.
1517  *
1518  * After rproc_del() returns, @rproc isn't freed yet, because
1519  * of the outstanding reference created by rproc_alloc. To decrement that
1520  * one last refcount, one still needs to call rproc_free().
1521  *
1522  * Returns 0 on success and -EINVAL if @rproc isn't valid.
1523  */
1524 int rproc_del(struct rproc *rproc)
1525 {
1526         if (!rproc)
1527                 return -EINVAL;
1528
1529         /* if rproc is marked always-on, rproc_add() booted it */
1530         /* TODO: make sure this works with rproc->power > 1 */
1531         if (rproc->auto_boot)
1532                 rproc_shutdown(rproc);
1533
1534         mutex_lock(&rproc->lock);
1535         rproc->state = RPROC_DELETED;
1536         mutex_unlock(&rproc->lock);
1537
1538         rproc_delete_debug_dir(rproc);
1539
1540         /* the rproc is downref'ed as soon as it's removed from the klist */
1541         mutex_lock(&rproc_list_mutex);
1542         list_del(&rproc->node);
1543         mutex_unlock(&rproc_list_mutex);
1544
1545         device_del(&rproc->dev);
1546
1547         return 0;
1548 }
1549 EXPORT_SYMBOL(rproc_del);
1550
1551 /**
1552  * rproc_add_subdev() - add a subdevice to a remoteproc
1553  * @rproc: rproc handle to add the subdevice to
1554  * @subdev: subdev handle to register
1555  * @probe: function to call when the rproc boots
1556  * @remove: function to call when the rproc shuts down
1557  */
1558 void rproc_add_subdev(struct rproc *rproc,
1559                       struct rproc_subdev *subdev,
1560                       int (*probe)(struct rproc_subdev *subdev),
1561                       void (*remove)(struct rproc_subdev *subdev))
1562 {
1563         subdev->probe = probe;
1564         subdev->remove = remove;
1565
1566         list_add_tail(&subdev->node, &rproc->subdevs);
1567 }
1568 EXPORT_SYMBOL(rproc_add_subdev);
1569
1570 /**
1571  * rproc_remove_subdev() - remove a subdevice from a remoteproc
1572  * @rproc: rproc handle to remove the subdevice from
1573  * @subdev: subdev handle, previously registered with rproc_add_subdev()
1574  */
1575 void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
1576 {
1577         list_del(&subdev->node);
1578 }
1579 EXPORT_SYMBOL(rproc_remove_subdev);
1580
1581 /**
1582  * rproc_report_crash() - rproc crash reporter function
1583  * @rproc: remote processor
1584  * @type: crash type
1585  *
1586  * This function must be called every time a crash is detected by the low-level
1587  * drivers implementing a specific remoteproc. This should not be called from a
1588  * non-remoteproc driver.
1589  *
1590  * This function can be called from atomic/interrupt context.
1591  */
1592 void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
1593 {
1594         if (!rproc) {
1595                 pr_err("NULL rproc pointer\n");
1596                 return;
1597         }
1598
1599         dev_err(&rproc->dev, "crash detected in %s: type %s\n",
1600                 rproc->name, rproc_crash_to_string(type));
1601
1602         /* create a new task to handle the error */
1603         schedule_work(&rproc->crash_handler);
1604 }
1605 EXPORT_SYMBOL(rproc_report_crash);
1606
1607 static int __init remoteproc_init(void)
1608 {
1609         rproc_init_sysfs();
1610         rproc_init_debugfs();
1611
1612         return 0;
1613 }
1614 module_init(remoteproc_init);
1615
1616 static void __exit remoteproc_exit(void)
1617 {
1618         ida_destroy(&rproc_dev_index);
1619
1620         rproc_exit_debugfs();
1621         rproc_exit_sysfs();
1622 }
1623 module_exit(remoteproc_exit);
1624
1625 MODULE_LICENSE("GPL v2");
1626 MODULE_DESCRIPTION("Generic Remote Processor Framework");