xref: /linux/drivers/remoteproc/remoteproc_core.c (revision 7e83cab824a86704cdbd7735c19d34e0ce423dc5)
1400e64dfSOhad Ben-Cohen /*
2400e64dfSOhad Ben-Cohen  * Remote Processor Framework
3400e64dfSOhad Ben-Cohen  *
4400e64dfSOhad Ben-Cohen  * Copyright (C) 2011 Texas Instruments, Inc.
5400e64dfSOhad Ben-Cohen  * Copyright (C) 2011 Google, Inc.
6400e64dfSOhad Ben-Cohen  *
7400e64dfSOhad Ben-Cohen  * Ohad Ben-Cohen <ohad@wizery.com>
8400e64dfSOhad Ben-Cohen  * Brian Swetland <swetland@google.com>
9400e64dfSOhad Ben-Cohen  * Mark Grosen <mgrosen@ti.com>
10400e64dfSOhad Ben-Cohen  * Fernando Guzman Lugo <fernando.lugo@ti.com>
11400e64dfSOhad Ben-Cohen  * Suman Anna <s-anna@ti.com>
12400e64dfSOhad Ben-Cohen  * Robert Tivy <rtivy@ti.com>
13400e64dfSOhad Ben-Cohen  * Armando Uribe De Leon <x0095078@ti.com>
14400e64dfSOhad Ben-Cohen  *
15400e64dfSOhad Ben-Cohen  * This program is free software; you can redistribute it and/or
16400e64dfSOhad Ben-Cohen  * modify it under the terms of the GNU General Public License
17400e64dfSOhad Ben-Cohen  * version 2 as published by the Free Software Foundation.
18400e64dfSOhad Ben-Cohen  *
19400e64dfSOhad Ben-Cohen  * This program is distributed in the hope that it will be useful,
20400e64dfSOhad Ben-Cohen  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21400e64dfSOhad Ben-Cohen  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22400e64dfSOhad Ben-Cohen  * GNU General Public License for more details.
23400e64dfSOhad Ben-Cohen  */
24400e64dfSOhad Ben-Cohen 
25400e64dfSOhad Ben-Cohen #define pr_fmt(fmt)    "%s: " fmt, __func__
26400e64dfSOhad Ben-Cohen 
27400e64dfSOhad Ben-Cohen #include <linux/kernel.h>
28400e64dfSOhad Ben-Cohen #include <linux/module.h>
29400e64dfSOhad Ben-Cohen #include <linux/device.h>
30400e64dfSOhad Ben-Cohen #include <linux/slab.h>
31400e64dfSOhad Ben-Cohen #include <linux/mutex.h>
32400e64dfSOhad Ben-Cohen #include <linux/dma-mapping.h>
33400e64dfSOhad Ben-Cohen #include <linux/firmware.h>
34400e64dfSOhad Ben-Cohen #include <linux/string.h>
35400e64dfSOhad Ben-Cohen #include <linux/debugfs.h>
36400e64dfSOhad Ben-Cohen #include <linux/remoteproc.h>
37400e64dfSOhad Ben-Cohen #include <linux/iommu.h>
38b5ab5e24SOhad Ben-Cohen #include <linux/idr.h>
39400e64dfSOhad Ben-Cohen #include <linux/elf.h>
40a2b950acSOhad Ben-Cohen #include <linux/crc32.h>
41400e64dfSOhad Ben-Cohen #include <linux/virtio_ids.h>
42400e64dfSOhad Ben-Cohen #include <linux/virtio_ring.h>
43cf59d3e9SOhad Ben-Cohen #include <asm/byteorder.h>
44400e64dfSOhad Ben-Cohen 
45400e64dfSOhad Ben-Cohen #include "remoteproc_internal.h"
46400e64dfSOhad Ben-Cohen 
47fec47d86SDave Gerlach static DEFINE_MUTEX(rproc_list_mutex);
48fec47d86SDave Gerlach static LIST_HEAD(rproc_list);
49fec47d86SDave Gerlach 
50400e64dfSOhad Ben-Cohen typedef int (*rproc_handle_resources_t)(struct rproc *rproc,
51fd2c15ecSOhad Ben-Cohen 				struct resource_table *table, int len);
52a2b950acSOhad Ben-Cohen typedef int (*rproc_handle_resource_t)(struct rproc *rproc,
53a2b950acSOhad Ben-Cohen 				 void *, int offset, int avail);
54400e64dfSOhad Ben-Cohen 
55b5ab5e24SOhad Ben-Cohen /* Unique indices for remoteproc devices */
56b5ab5e24SOhad Ben-Cohen static DEFINE_IDA(rproc_dev_index);
57b5ab5e24SOhad Ben-Cohen 
588afd519cSFernando Guzman Lugo static const char * const rproc_crash_names[] = {
598afd519cSFernando Guzman Lugo 	[RPROC_MMUFAULT]	= "mmufault",
60b3d39032SBjorn Andersson 	[RPROC_WATCHDOG]	= "watchdog",
61b3d39032SBjorn Andersson 	[RPROC_FATAL_ERROR]	= "fatal error",
628afd519cSFernando Guzman Lugo };
638afd519cSFernando Guzman Lugo 
648afd519cSFernando Guzman Lugo /* translate rproc_crash_type to string */
658afd519cSFernando Guzman Lugo static const char *rproc_crash_to_string(enum rproc_crash_type type)
668afd519cSFernando Guzman Lugo {
678afd519cSFernando Guzman Lugo 	if (type < ARRAY_SIZE(rproc_crash_names))
688afd519cSFernando Guzman Lugo 		return rproc_crash_names[type];
69b23f7a09SMasanari Iida 	return "unknown";
708afd519cSFernando Guzman Lugo }
718afd519cSFernando Guzman Lugo 
72400e64dfSOhad Ben-Cohen /*
73400e64dfSOhad Ben-Cohen  * This is the IOMMU fault handler we register with the IOMMU API
74400e64dfSOhad Ben-Cohen  * (when relevant; not all remote processors access memory through
75400e64dfSOhad Ben-Cohen  * an IOMMU).
76400e64dfSOhad Ben-Cohen  *
77400e64dfSOhad Ben-Cohen  * IOMMU core will invoke this handler whenever the remote processor
78400e64dfSOhad Ben-Cohen  * will try to access an unmapped device address.
79400e64dfSOhad Ben-Cohen  */
80400e64dfSOhad Ben-Cohen static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
8177ca2332SOhad Ben-Cohen 			     unsigned long iova, int flags, void *token)
82400e64dfSOhad Ben-Cohen {
838afd519cSFernando Guzman Lugo 	struct rproc *rproc = token;
848afd519cSFernando Guzman Lugo 
85400e64dfSOhad Ben-Cohen 	dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
86400e64dfSOhad Ben-Cohen 
878afd519cSFernando Guzman Lugo 	rproc_report_crash(rproc, RPROC_MMUFAULT);
888afd519cSFernando Guzman Lugo 
89400e64dfSOhad Ben-Cohen 	/*
90400e64dfSOhad Ben-Cohen 	 * Let the iommu core know we're not really handling this fault;
918afd519cSFernando Guzman Lugo 	 * we just used it as a recovery trigger.
92400e64dfSOhad Ben-Cohen 	 */
93400e64dfSOhad Ben-Cohen 	return -ENOSYS;
94400e64dfSOhad Ben-Cohen }
95400e64dfSOhad Ben-Cohen 
96400e64dfSOhad Ben-Cohen static int rproc_enable_iommu(struct rproc *rproc)
97400e64dfSOhad Ben-Cohen {
98400e64dfSOhad Ben-Cohen 	struct iommu_domain *domain;
99b5ab5e24SOhad Ben-Cohen 	struct device *dev = rproc->dev.parent;
100400e64dfSOhad Ben-Cohen 	int ret;
101400e64dfSOhad Ben-Cohen 
102315491e5SSuman Anna 	if (!rproc->has_iommu) {
103315491e5SSuman Anna 		dev_dbg(dev, "iommu not present\n");
1040798e1daSMark Grosen 		return 0;
105400e64dfSOhad Ben-Cohen 	}
106400e64dfSOhad Ben-Cohen 
107400e64dfSOhad Ben-Cohen 	domain = iommu_domain_alloc(dev->bus);
108400e64dfSOhad Ben-Cohen 	if (!domain) {
109400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't alloc iommu domain\n");
110400e64dfSOhad Ben-Cohen 		return -ENOMEM;
111400e64dfSOhad Ben-Cohen 	}
112400e64dfSOhad Ben-Cohen 
11377ca2332SOhad Ben-Cohen 	iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
114400e64dfSOhad Ben-Cohen 
115400e64dfSOhad Ben-Cohen 	ret = iommu_attach_device(domain, dev);
116400e64dfSOhad Ben-Cohen 	if (ret) {
117400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't attach iommu device: %d\n", ret);
118400e64dfSOhad Ben-Cohen 		goto free_domain;
119400e64dfSOhad Ben-Cohen 	}
120400e64dfSOhad Ben-Cohen 
121400e64dfSOhad Ben-Cohen 	rproc->domain = domain;
122400e64dfSOhad Ben-Cohen 
123400e64dfSOhad Ben-Cohen 	return 0;
124400e64dfSOhad Ben-Cohen 
125400e64dfSOhad Ben-Cohen free_domain:
126400e64dfSOhad Ben-Cohen 	iommu_domain_free(domain);
127400e64dfSOhad Ben-Cohen 	return ret;
128400e64dfSOhad Ben-Cohen }
129400e64dfSOhad Ben-Cohen 
130400e64dfSOhad Ben-Cohen static void rproc_disable_iommu(struct rproc *rproc)
131400e64dfSOhad Ben-Cohen {
132400e64dfSOhad Ben-Cohen 	struct iommu_domain *domain = rproc->domain;
133b5ab5e24SOhad Ben-Cohen 	struct device *dev = rproc->dev.parent;
134400e64dfSOhad Ben-Cohen 
135400e64dfSOhad Ben-Cohen 	if (!domain)
136400e64dfSOhad Ben-Cohen 		return;
137400e64dfSOhad Ben-Cohen 
138400e64dfSOhad Ben-Cohen 	iommu_detach_device(domain, dev);
139400e64dfSOhad Ben-Cohen 	iommu_domain_free(domain);
140400e64dfSOhad Ben-Cohen }
141400e64dfSOhad Ben-Cohen 
142a01f7cd6SSuman Anna /**
143a01f7cd6SSuman Anna  * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address
144a01f7cd6SSuman Anna  * @rproc: handle of a remote processor
145a01f7cd6SSuman Anna  * @da: remoteproc device address to translate
146a01f7cd6SSuman Anna  * @len: length of the memory region @da is pointing to
147a01f7cd6SSuman Anna  *
148400e64dfSOhad Ben-Cohen  * Some remote processors will ask us to allocate them physically contiguous
149400e64dfSOhad Ben-Cohen  * memory regions (which we call "carveouts"), and map them to specific
150a01f7cd6SSuman Anna  * device addresses (which are hardcoded in the firmware). They may also have
151a01f7cd6SSuman Anna  * dedicated memory regions internal to the processors, and use them either
152a01f7cd6SSuman Anna  * exclusively or alongside carveouts.
153400e64dfSOhad Ben-Cohen  *
154400e64dfSOhad Ben-Cohen  * They may then ask us to copy objects into specific device addresses (e.g.
155400e64dfSOhad Ben-Cohen  * code/data sections) or expose us certain symbols in other device address
156400e64dfSOhad Ben-Cohen  * (e.g. their trace buffer).
157400e64dfSOhad Ben-Cohen  *
158a01f7cd6SSuman Anna  * This function is a helper function with which we can go over the allocated
159a01f7cd6SSuman Anna  * carveouts and translate specific device addresses to kernel virtual addresses
160a01f7cd6SSuman Anna  * so we can access the referenced memory. This function also allows to perform
161a01f7cd6SSuman Anna  * translations on the internal remoteproc memory regions through a platform
162a01f7cd6SSuman Anna  * implementation specific da_to_va ops, if present.
163a01f7cd6SSuman Anna  *
164a01f7cd6SSuman Anna  * The function returns a valid kernel address on success or NULL on failure.
165400e64dfSOhad Ben-Cohen  *
166400e64dfSOhad Ben-Cohen  * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
167400e64dfSOhad Ben-Cohen  * but only on kernel direct mapped RAM memory. Instead, we're just using
168a01f7cd6SSuman Anna  * here the output of the DMA API for the carveouts, which should be more
169a01f7cd6SSuman Anna  * correct.
170400e64dfSOhad Ben-Cohen  */
17172854fb0SSjur Brændeland void *rproc_da_to_va(struct rproc *rproc, u64 da, int len)
172400e64dfSOhad Ben-Cohen {
173400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *carveout;
174400e64dfSOhad Ben-Cohen 	void *ptr = NULL;
175400e64dfSOhad Ben-Cohen 
176a01f7cd6SSuman Anna 	if (rproc->ops->da_to_va) {
177a01f7cd6SSuman Anna 		ptr = rproc->ops->da_to_va(rproc, da, len);
178a01f7cd6SSuman Anna 		if (ptr)
179a01f7cd6SSuman Anna 			goto out;
180a01f7cd6SSuman Anna 	}
181a01f7cd6SSuman Anna 
182400e64dfSOhad Ben-Cohen 	list_for_each_entry(carveout, &rproc->carveouts, node) {
183400e64dfSOhad Ben-Cohen 		int offset = da - carveout->da;
184400e64dfSOhad Ben-Cohen 
185400e64dfSOhad Ben-Cohen 		/* try next carveout if da is too small */
186400e64dfSOhad Ben-Cohen 		if (offset < 0)
187400e64dfSOhad Ben-Cohen 			continue;
188400e64dfSOhad Ben-Cohen 
189400e64dfSOhad Ben-Cohen 		/* try next carveout if da is too large */
190400e64dfSOhad Ben-Cohen 		if (offset + len > carveout->len)
191400e64dfSOhad Ben-Cohen 			continue;
192400e64dfSOhad Ben-Cohen 
193400e64dfSOhad Ben-Cohen 		ptr = carveout->va + offset;
194400e64dfSOhad Ben-Cohen 
195400e64dfSOhad Ben-Cohen 		break;
196400e64dfSOhad Ben-Cohen 	}
197400e64dfSOhad Ben-Cohen 
198a01f7cd6SSuman Anna out:
199400e64dfSOhad Ben-Cohen 	return ptr;
200400e64dfSOhad Ben-Cohen }
2014afc89d6SSjur Brændeland EXPORT_SYMBOL(rproc_da_to_va);
202400e64dfSOhad Ben-Cohen 
2036db20ea8SOhad Ben-Cohen int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
204400e64dfSOhad Ben-Cohen {
2057a186941SOhad Ben-Cohen 	struct rproc *rproc = rvdev->rproc;
206b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
2076db20ea8SOhad Ben-Cohen 	struct rproc_vring *rvring = &rvdev->vring[i];
208c0d63157SSjur Brændeland 	struct fw_rsc_vdev *rsc;
2097a186941SOhad Ben-Cohen 	dma_addr_t dma;
2107a186941SOhad Ben-Cohen 	void *va;
2117a186941SOhad Ben-Cohen 	int ret, size, notifyid;
212400e64dfSOhad Ben-Cohen 
2136db20ea8SOhad Ben-Cohen 	/* actual size of vring (in bytes) */
2146db20ea8SOhad Ben-Cohen 	size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
2156db20ea8SOhad Ben-Cohen 
2166db20ea8SOhad Ben-Cohen 	/*
2176db20ea8SOhad Ben-Cohen 	 * Allocate non-cacheable memory for the vring. In the future
2186db20ea8SOhad Ben-Cohen 	 * this call will also configure the IOMMU for us
2196db20ea8SOhad Ben-Cohen 	 */
220b5ab5e24SOhad Ben-Cohen 	va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL);
2216db20ea8SOhad Ben-Cohen 	if (!va) {
222b5ab5e24SOhad Ben-Cohen 		dev_err(dev->parent, "dma_alloc_coherent failed\n");
2236db20ea8SOhad Ben-Cohen 		return -EINVAL;
2246db20ea8SOhad Ben-Cohen 	}
2256db20ea8SOhad Ben-Cohen 
2266db20ea8SOhad Ben-Cohen 	/*
2276db20ea8SOhad Ben-Cohen 	 * Assign an rproc-wide unique index for this vring
2286db20ea8SOhad Ben-Cohen 	 * TODO: assign a notifyid for rvdev updates as well
2296db20ea8SOhad Ben-Cohen 	 * TODO: support predefined notifyids (via resource table)
2306db20ea8SOhad Ben-Cohen 	 */
23115fc6110STejun Heo 	ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL);
232b39599b7SSuman Anna 	if (ret < 0) {
23315fc6110STejun Heo 		dev_err(dev, "idr_alloc failed: %d\n", ret);
234b5ab5e24SOhad Ben-Cohen 		dma_free_coherent(dev->parent, size, va, dma);
2356db20ea8SOhad Ben-Cohen 		return ret;
2366db20ea8SOhad Ben-Cohen 	}
23715fc6110STejun Heo 	notifyid = ret;
2386db20ea8SOhad Ben-Cohen 
23948f18f89SBjorn Andersson 	/* Potentially bump max_notifyid */
24048f18f89SBjorn Andersson 	if (notifyid > rproc->max_notifyid)
24148f18f89SBjorn Andersson 		rproc->max_notifyid = notifyid;
24248f18f89SBjorn Andersson 
2439d7814a9SAnna, Suman 	dev_dbg(dev, "vring%d: va %p dma %pad size 0x%x idr %d\n",
244b605ed8bSAnna, Suman 		i, va, &dma, size, notifyid);
2456db20ea8SOhad Ben-Cohen 
2466db20ea8SOhad Ben-Cohen 	rvring->va = va;
2476db20ea8SOhad Ben-Cohen 	rvring->dma = dma;
2486db20ea8SOhad Ben-Cohen 	rvring->notifyid = notifyid;
2496db20ea8SOhad Ben-Cohen 
250c0d63157SSjur Brændeland 	/*
251c0d63157SSjur Brændeland 	 * Let the rproc know the notifyid and da of this vring.
252c0d63157SSjur Brændeland 	 * Not all platforms use dma_alloc_coherent to automatically
253c0d63157SSjur Brændeland 	 * set up the iommu. In this case the device address (da) will
254c0d63157SSjur Brændeland 	 * hold the physical address and not the device address.
255c0d63157SSjur Brændeland 	 */
256c0d63157SSjur Brændeland 	rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
257c0d63157SSjur Brændeland 	rsc->vring[i].da = dma;
258c0d63157SSjur Brændeland 	rsc->vring[i].notifyid = notifyid;
2596db20ea8SOhad Ben-Cohen 	return 0;
2606db20ea8SOhad Ben-Cohen }
2616db20ea8SOhad Ben-Cohen 
262400e64dfSOhad Ben-Cohen static int
2636db20ea8SOhad Ben-Cohen rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
264400e64dfSOhad Ben-Cohen {
265400e64dfSOhad Ben-Cohen 	struct rproc *rproc = rvdev->rproc;
266b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
267400e64dfSOhad Ben-Cohen 	struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
2686db20ea8SOhad Ben-Cohen 	struct rproc_vring *rvring = &rvdev->vring[i];
269400e64dfSOhad Ben-Cohen 
2709d7814a9SAnna, Suman 	dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n",
2717a186941SOhad Ben-Cohen 		i, vring->da, vring->num, vring->align);
2727a186941SOhad Ben-Cohen 
27363140e0eSOhad Ben-Cohen 	/* verify queue size and vring alignment are sane */
27463140e0eSOhad Ben-Cohen 	if (!vring->num || !vring->align) {
27563140e0eSOhad Ben-Cohen 		dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
27663140e0eSOhad Ben-Cohen 			vring->num, vring->align);
277400e64dfSOhad Ben-Cohen 		return -EINVAL;
278400e64dfSOhad Ben-Cohen 	}
279400e64dfSOhad Ben-Cohen 
2806db20ea8SOhad Ben-Cohen 	rvring->len = vring->num;
2816db20ea8SOhad Ben-Cohen 	rvring->align = vring->align;
2826db20ea8SOhad Ben-Cohen 	rvring->rvdev = rvdev;
283400e64dfSOhad Ben-Cohen 
284400e64dfSOhad Ben-Cohen 	return 0;
285400e64dfSOhad Ben-Cohen }
286400e64dfSOhad Ben-Cohen 
2876db20ea8SOhad Ben-Cohen void rproc_free_vring(struct rproc_vring *rvring)
2887a186941SOhad Ben-Cohen {
28963140e0eSOhad Ben-Cohen 	int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
2906db20ea8SOhad Ben-Cohen 	struct rproc *rproc = rvring->rvdev->rproc;
291c0d63157SSjur Brændeland 	int idx = rvring->rvdev->vring - rvring;
292c0d63157SSjur Brændeland 	struct fw_rsc_vdev *rsc;
2937a186941SOhad Ben-Cohen 
294b5ab5e24SOhad Ben-Cohen 	dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
2957a186941SOhad Ben-Cohen 	idr_remove(&rproc->notifyids, rvring->notifyid);
296099a3f33SSjur Brændeland 
297c0d63157SSjur Brændeland 	/* reset resource entry info */
298c0d63157SSjur Brændeland 	rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset;
299c0d63157SSjur Brændeland 	rsc->vring[idx].da = 0;
300c0d63157SSjur Brændeland 	rsc->vring[idx].notifyid = -1;
3017a186941SOhad Ben-Cohen }
3027a186941SOhad Ben-Cohen 
303f5bcb353SBjorn Andersson static int rproc_vdev_do_probe(struct rproc_subdev *subdev)
304f5bcb353SBjorn Andersson {
305f5bcb353SBjorn Andersson 	struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
306f5bcb353SBjorn Andersson 
307f5bcb353SBjorn Andersson 	return rproc_add_virtio_dev(rvdev, rvdev->id);
308f5bcb353SBjorn Andersson }
309f5bcb353SBjorn Andersson 
310f5bcb353SBjorn Andersson static void rproc_vdev_do_remove(struct rproc_subdev *subdev)
311f5bcb353SBjorn Andersson {
312f5bcb353SBjorn Andersson 	struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev);
313f5bcb353SBjorn Andersson 
314f5bcb353SBjorn Andersson 	rproc_remove_virtio_dev(rvdev);
315f5bcb353SBjorn Andersson }
316f5bcb353SBjorn Andersson 
317400e64dfSOhad Ben-Cohen /**
318fd2c15ecSOhad Ben-Cohen  * rproc_handle_vdev() - handle a vdev fw resource
319400e64dfSOhad Ben-Cohen  * @rproc: the remote processor
320400e64dfSOhad Ben-Cohen  * @rsc: the vring resource descriptor
321fd2c15ecSOhad Ben-Cohen  * @avail: size of available data (for sanity checking the image)
322400e64dfSOhad Ben-Cohen  *
3237a186941SOhad Ben-Cohen  * This resource entry requests the host to statically register a virtio
3247a186941SOhad Ben-Cohen  * device (vdev), and setup everything needed to support it. It contains
3257a186941SOhad Ben-Cohen  * everything needed to make it possible: the virtio device id, virtio
3267a186941SOhad Ben-Cohen  * device features, vrings information, virtio config space, etc...
327400e64dfSOhad Ben-Cohen  *
3287a186941SOhad Ben-Cohen  * Before registering the vdev, the vrings are allocated from non-cacheable
3297a186941SOhad Ben-Cohen  * physically contiguous memory. Currently we only support two vrings per
3307a186941SOhad Ben-Cohen  * remote processor (temporary limitation). We might also want to consider
3317a186941SOhad Ben-Cohen  * doing the vring allocation only later when ->find_vqs() is invoked, and
3327a186941SOhad Ben-Cohen  * then release them upon ->del_vqs().
333400e64dfSOhad Ben-Cohen  *
3347a186941SOhad Ben-Cohen  * Note: @da is currently not really handled correctly: we dynamically
3357a186941SOhad Ben-Cohen  * allocate it using the DMA API, ignoring requested hard coded addresses,
3367a186941SOhad Ben-Cohen  * and we don't take care of any required IOMMU programming. This is all
3377a186941SOhad Ben-Cohen  * going to be taken care of when the generic iommu-based DMA API will be
3387a186941SOhad Ben-Cohen  * merged. Meanwhile, statically-addressed iommu-based firmware images should
3397a186941SOhad Ben-Cohen  * use RSC_DEVMEM resource entries to map their required @da to the physical
3407a186941SOhad Ben-Cohen  * address of their base CMA region (ouch, hacky!).
341400e64dfSOhad Ben-Cohen  *
342400e64dfSOhad Ben-Cohen  * Returns 0 on success, or an appropriate error code otherwise
343400e64dfSOhad Ben-Cohen  */
344fd2c15ecSOhad Ben-Cohen static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
345a2b950acSOhad Ben-Cohen 			     int offset, int avail)
346400e64dfSOhad Ben-Cohen {
347b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
3487a186941SOhad Ben-Cohen 	struct rproc_vdev *rvdev;
3497a186941SOhad Ben-Cohen 	int i, ret;
350fd2c15ecSOhad Ben-Cohen 
351fd2c15ecSOhad Ben-Cohen 	/* make sure resource isn't truncated */
352fd2c15ecSOhad Ben-Cohen 	if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
353fd2c15ecSOhad Ben-Cohen 			+ rsc->config_len > avail) {
354b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "vdev rsc is truncated\n");
355fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
356fd2c15ecSOhad Ben-Cohen 	}
357fd2c15ecSOhad Ben-Cohen 
358fd2c15ecSOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
359fd2c15ecSOhad Ben-Cohen 	if (rsc->reserved[0] || rsc->reserved[1]) {
360fd2c15ecSOhad Ben-Cohen 		dev_err(dev, "vdev rsc has non zero reserved bytes\n");
361fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
362fd2c15ecSOhad Ben-Cohen 	}
363fd2c15ecSOhad Ben-Cohen 
3649d7814a9SAnna, Suman 	dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n",
365fd2c15ecSOhad Ben-Cohen 		rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
366400e64dfSOhad Ben-Cohen 
3677a186941SOhad Ben-Cohen 	/* we currently support only two vrings per rvdev */
3687a186941SOhad Ben-Cohen 	if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
369fd2c15ecSOhad Ben-Cohen 		dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
370400e64dfSOhad Ben-Cohen 		return -EINVAL;
371400e64dfSOhad Ben-Cohen 	}
372400e64dfSOhad Ben-Cohen 
373899585adSAnna, Suman 	rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL);
3747a186941SOhad Ben-Cohen 	if (!rvdev)
3757a186941SOhad Ben-Cohen 		return -ENOMEM;
3767a186941SOhad Ben-Cohen 
377aab8d802SBjorn Andersson 	kref_init(&rvdev->refcount);
378aab8d802SBjorn Andersson 
379f5bcb353SBjorn Andersson 	rvdev->id = rsc->id;
3807a186941SOhad Ben-Cohen 	rvdev->rproc = rproc;
3817a186941SOhad Ben-Cohen 
3826db20ea8SOhad Ben-Cohen 	/* parse the vrings */
383fd2c15ecSOhad Ben-Cohen 	for (i = 0; i < rsc->num_of_vrings; i++) {
3846db20ea8SOhad Ben-Cohen 		ret = rproc_parse_vring(rvdev, rsc, i);
3857a186941SOhad Ben-Cohen 		if (ret)
3866db20ea8SOhad Ben-Cohen 			goto free_rvdev;
387fd2c15ecSOhad Ben-Cohen 	}
388fd2c15ecSOhad Ben-Cohen 
389a2b950acSOhad Ben-Cohen 	/* remember the resource offset*/
390a2b950acSOhad Ben-Cohen 	rvdev->rsc_offset = offset;
391400e64dfSOhad Ben-Cohen 
392a863af5dSBjorn Andersson 	/* allocate the vring resources */
393a863af5dSBjorn Andersson 	for (i = 0; i < rsc->num_of_vrings; i++) {
394a863af5dSBjorn Andersson 		ret = rproc_alloc_vring(rvdev, i);
395a863af5dSBjorn Andersson 		if (ret)
396a863af5dSBjorn Andersson 			goto unwind_vring_allocations;
397a863af5dSBjorn Andersson 	}
398a863af5dSBjorn Andersson 
3997a186941SOhad Ben-Cohen 	list_add_tail(&rvdev->node, &rproc->rvdevs);
400400e64dfSOhad Ben-Cohen 
401f5bcb353SBjorn Andersson 	rproc_add_subdev(rproc, &rvdev->subdev,
402f5bcb353SBjorn Andersson 			 rproc_vdev_do_probe, rproc_vdev_do_remove);
403400e64dfSOhad Ben-Cohen 
404400e64dfSOhad Ben-Cohen 	return 0;
4057a186941SOhad Ben-Cohen 
406a863af5dSBjorn Andersson unwind_vring_allocations:
407a863af5dSBjorn Andersson 	for (i--; i >= 0; i--)
408a863af5dSBjorn Andersson 		rproc_free_vring(&rvdev->vring[i]);
4096db20ea8SOhad Ben-Cohen free_rvdev:
4107a186941SOhad Ben-Cohen 	kfree(rvdev);
4117a186941SOhad Ben-Cohen 	return ret;
412400e64dfSOhad Ben-Cohen }
413400e64dfSOhad Ben-Cohen 
414aab8d802SBjorn Andersson void rproc_vdev_release(struct kref *ref)
415aab8d802SBjorn Andersson {
416aab8d802SBjorn Andersson 	struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount);
417a863af5dSBjorn Andersson 	struct rproc_vring *rvring;
418f5bcb353SBjorn Andersson 	struct rproc *rproc = rvdev->rproc;
419a863af5dSBjorn Andersson 	int id;
420a863af5dSBjorn Andersson 
421a863af5dSBjorn Andersson 	for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) {
422a863af5dSBjorn Andersson 		rvring = &rvdev->vring[id];
423a863af5dSBjorn Andersson 		if (!rvring->va)
424a863af5dSBjorn Andersson 			continue;
425a863af5dSBjorn Andersson 
426a863af5dSBjorn Andersson 		rproc_free_vring(rvring);
427a863af5dSBjorn Andersson 	}
428aab8d802SBjorn Andersson 
429f5bcb353SBjorn Andersson 	rproc_remove_subdev(rproc, &rvdev->subdev);
430aab8d802SBjorn Andersson 	list_del(&rvdev->node);
431aab8d802SBjorn Andersson 	kfree(rvdev);
432aab8d802SBjorn Andersson }
433aab8d802SBjorn Andersson 
434400e64dfSOhad Ben-Cohen /**
435400e64dfSOhad Ben-Cohen  * rproc_handle_trace() - handle a shared trace buffer resource
436400e64dfSOhad Ben-Cohen  * @rproc: the remote processor
437400e64dfSOhad Ben-Cohen  * @rsc: the trace resource descriptor
438fd2c15ecSOhad Ben-Cohen  * @avail: size of available data (for sanity checking the image)
439400e64dfSOhad Ben-Cohen  *
440400e64dfSOhad Ben-Cohen  * In case the remote processor dumps trace logs into memory,
441400e64dfSOhad Ben-Cohen  * export it via debugfs.
442400e64dfSOhad Ben-Cohen  *
443400e64dfSOhad Ben-Cohen  * Currently, the 'da' member of @rsc should contain the device address
444400e64dfSOhad Ben-Cohen  * where the remote processor is dumping the traces. Later we could also
445400e64dfSOhad Ben-Cohen  * support dynamically allocating this address using the generic
446400e64dfSOhad Ben-Cohen  * DMA API (but currently there isn't a use case for that).
447400e64dfSOhad Ben-Cohen  *
448400e64dfSOhad Ben-Cohen  * Returns 0 on success, or an appropriate error code otherwise
449400e64dfSOhad Ben-Cohen  */
450fd2c15ecSOhad Ben-Cohen static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
451a2b950acSOhad Ben-Cohen 			      int offset, int avail)
452400e64dfSOhad Ben-Cohen {
453400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *trace;
454b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
455400e64dfSOhad Ben-Cohen 	void *ptr;
456400e64dfSOhad Ben-Cohen 	char name[15];
457400e64dfSOhad Ben-Cohen 
458fd2c15ecSOhad Ben-Cohen 	if (sizeof(*rsc) > avail) {
459b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "trace rsc is truncated\n");
460fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
461fd2c15ecSOhad Ben-Cohen 	}
462fd2c15ecSOhad Ben-Cohen 
463fd2c15ecSOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
464fd2c15ecSOhad Ben-Cohen 	if (rsc->reserved) {
465fd2c15ecSOhad Ben-Cohen 		dev_err(dev, "trace rsc has non zero reserved bytes\n");
466fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
467fd2c15ecSOhad Ben-Cohen 	}
468fd2c15ecSOhad Ben-Cohen 
469400e64dfSOhad Ben-Cohen 	/* what's the kernel address of this resource ? */
470400e64dfSOhad Ben-Cohen 	ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
471400e64dfSOhad Ben-Cohen 	if (!ptr) {
472400e64dfSOhad Ben-Cohen 		dev_err(dev, "erroneous trace resource entry\n");
473400e64dfSOhad Ben-Cohen 		return -EINVAL;
474400e64dfSOhad Ben-Cohen 	}
475400e64dfSOhad Ben-Cohen 
476400e64dfSOhad Ben-Cohen 	trace = kzalloc(sizeof(*trace), GFP_KERNEL);
477172e6ab1SSuman Anna 	if (!trace)
478400e64dfSOhad Ben-Cohen 		return -ENOMEM;
479400e64dfSOhad Ben-Cohen 
480400e64dfSOhad Ben-Cohen 	/* set the trace buffer dma properties */
481400e64dfSOhad Ben-Cohen 	trace->len = rsc->len;
482400e64dfSOhad Ben-Cohen 	trace->va = ptr;
483400e64dfSOhad Ben-Cohen 
484400e64dfSOhad Ben-Cohen 	/* make sure snprintf always null terminates, even if truncating */
485400e64dfSOhad Ben-Cohen 	snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
486400e64dfSOhad Ben-Cohen 
487400e64dfSOhad Ben-Cohen 	/* create the debugfs entry */
488400e64dfSOhad Ben-Cohen 	trace->priv = rproc_create_trace_file(name, rproc, trace);
489400e64dfSOhad Ben-Cohen 	if (!trace->priv) {
490400e64dfSOhad Ben-Cohen 		trace->va = NULL;
491400e64dfSOhad Ben-Cohen 		kfree(trace);
492400e64dfSOhad Ben-Cohen 		return -EINVAL;
493400e64dfSOhad Ben-Cohen 	}
494400e64dfSOhad Ben-Cohen 
495400e64dfSOhad Ben-Cohen 	list_add_tail(&trace->node, &rproc->traces);
496400e64dfSOhad Ben-Cohen 
497400e64dfSOhad Ben-Cohen 	rproc->num_traces++;
498400e64dfSOhad Ben-Cohen 
49935386166SLee Jones 	dev_dbg(dev, "%s added: va %p, da 0x%x, len 0x%x\n",
50035386166SLee Jones 		name, ptr, rsc->da, rsc->len);
501400e64dfSOhad Ben-Cohen 
502400e64dfSOhad Ben-Cohen 	return 0;
503400e64dfSOhad Ben-Cohen }
504400e64dfSOhad Ben-Cohen 
505400e64dfSOhad Ben-Cohen /**
506400e64dfSOhad Ben-Cohen  * rproc_handle_devmem() - handle devmem resource entry
507400e64dfSOhad Ben-Cohen  * @rproc: remote processor handle
508400e64dfSOhad Ben-Cohen  * @rsc: the devmem resource entry
509fd2c15ecSOhad Ben-Cohen  * @avail: size of available data (for sanity checking the image)
510400e64dfSOhad Ben-Cohen  *
511400e64dfSOhad Ben-Cohen  * Remote processors commonly need to access certain on-chip peripherals.
512400e64dfSOhad Ben-Cohen  *
513400e64dfSOhad Ben-Cohen  * Some of these remote processors access memory via an iommu device,
514400e64dfSOhad Ben-Cohen  * and might require us to configure their iommu before they can access
515400e64dfSOhad Ben-Cohen  * the on-chip peripherals they need.
516400e64dfSOhad Ben-Cohen  *
517400e64dfSOhad Ben-Cohen  * This resource entry is a request to map such a peripheral device.
518400e64dfSOhad Ben-Cohen  *
519400e64dfSOhad Ben-Cohen  * These devmem entries will contain the physical address of the device in
520400e64dfSOhad Ben-Cohen  * the 'pa' member. If a specific device address is expected, then 'da' will
521400e64dfSOhad Ben-Cohen  * contain it (currently this is the only use case supported). 'len' will
522400e64dfSOhad Ben-Cohen  * contain the size of the physical region we need to map.
523400e64dfSOhad Ben-Cohen  *
524400e64dfSOhad Ben-Cohen  * Currently we just "trust" those devmem entries to contain valid physical
525400e64dfSOhad Ben-Cohen  * addresses, but this is going to change: we want the implementations to
526400e64dfSOhad Ben-Cohen  * tell us ranges of physical addresses the firmware is allowed to request,
527400e64dfSOhad Ben-Cohen  * and not allow firmwares to request access to physical addresses that
528400e64dfSOhad Ben-Cohen  * are outside those ranges.
529400e64dfSOhad Ben-Cohen  */
530fd2c15ecSOhad Ben-Cohen static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
531a2b950acSOhad Ben-Cohen 			       int offset, int avail)
532400e64dfSOhad Ben-Cohen {
533400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *mapping;
534b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
535400e64dfSOhad Ben-Cohen 	int ret;
536400e64dfSOhad Ben-Cohen 
537400e64dfSOhad Ben-Cohen 	/* no point in handling this resource without a valid iommu domain */
538400e64dfSOhad Ben-Cohen 	if (!rproc->domain)
539400e64dfSOhad Ben-Cohen 		return -EINVAL;
540400e64dfSOhad Ben-Cohen 
541fd2c15ecSOhad Ben-Cohen 	if (sizeof(*rsc) > avail) {
542b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "devmem rsc is truncated\n");
543fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
544fd2c15ecSOhad Ben-Cohen 	}
545fd2c15ecSOhad Ben-Cohen 
546fd2c15ecSOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
547fd2c15ecSOhad Ben-Cohen 	if (rsc->reserved) {
548b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "devmem rsc has non zero reserved bytes\n");
549fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
550fd2c15ecSOhad Ben-Cohen 	}
551fd2c15ecSOhad Ben-Cohen 
552400e64dfSOhad Ben-Cohen 	mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
553172e6ab1SSuman Anna 	if (!mapping)
554400e64dfSOhad Ben-Cohen 		return -ENOMEM;
555400e64dfSOhad Ben-Cohen 
556400e64dfSOhad Ben-Cohen 	ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
557400e64dfSOhad Ben-Cohen 	if (ret) {
558b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "failed to map devmem: %d\n", ret);
559400e64dfSOhad Ben-Cohen 		goto out;
560400e64dfSOhad Ben-Cohen 	}
561400e64dfSOhad Ben-Cohen 
562400e64dfSOhad Ben-Cohen 	/*
563400e64dfSOhad Ben-Cohen 	 * We'll need this info later when we'll want to unmap everything
564400e64dfSOhad Ben-Cohen 	 * (e.g. on shutdown).
565400e64dfSOhad Ben-Cohen 	 *
566400e64dfSOhad Ben-Cohen 	 * We can't trust the remote processor not to change the resource
567400e64dfSOhad Ben-Cohen 	 * table, so we must maintain this info independently.
568400e64dfSOhad Ben-Cohen 	 */
569400e64dfSOhad Ben-Cohen 	mapping->da = rsc->da;
570400e64dfSOhad Ben-Cohen 	mapping->len = rsc->len;
571400e64dfSOhad Ben-Cohen 	list_add_tail(&mapping->node, &rproc->mappings);
572400e64dfSOhad Ben-Cohen 
573b5ab5e24SOhad Ben-Cohen 	dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
574400e64dfSOhad Ben-Cohen 		rsc->pa, rsc->da, rsc->len);
575400e64dfSOhad Ben-Cohen 
576400e64dfSOhad Ben-Cohen 	return 0;
577400e64dfSOhad Ben-Cohen 
578400e64dfSOhad Ben-Cohen out:
579400e64dfSOhad Ben-Cohen 	kfree(mapping);
580400e64dfSOhad Ben-Cohen 	return ret;
581400e64dfSOhad Ben-Cohen }
582400e64dfSOhad Ben-Cohen 
583400e64dfSOhad Ben-Cohen /**
584400e64dfSOhad Ben-Cohen  * rproc_handle_carveout() - handle phys contig memory allocation requests
585400e64dfSOhad Ben-Cohen  * @rproc: rproc handle
586400e64dfSOhad Ben-Cohen  * @rsc: the resource entry
587fd2c15ecSOhad Ben-Cohen  * @avail: size of available data (for image validation)
588400e64dfSOhad Ben-Cohen  *
589400e64dfSOhad Ben-Cohen  * This function will handle firmware requests for allocation of physically
590400e64dfSOhad Ben-Cohen  * contiguous memory regions.
591400e64dfSOhad Ben-Cohen  *
592400e64dfSOhad Ben-Cohen  * These request entries should come first in the firmware's resource table,
593400e64dfSOhad Ben-Cohen  * as other firmware entries might request placing other data objects inside
594400e64dfSOhad Ben-Cohen  * these memory regions (e.g. data/code segments, trace resource entries, ...).
595400e64dfSOhad Ben-Cohen  *
596400e64dfSOhad Ben-Cohen  * Allocating memory this way helps utilizing the reserved physical memory
597400e64dfSOhad Ben-Cohen  * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
598400e64dfSOhad Ben-Cohen  * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
599400e64dfSOhad Ben-Cohen  * pressure is important; it may have a substantial impact on performance.
600400e64dfSOhad Ben-Cohen  */
601fd2c15ecSOhad Ben-Cohen static int rproc_handle_carveout(struct rproc *rproc,
602a2b950acSOhad Ben-Cohen 				 struct fw_rsc_carveout *rsc,
603a2b950acSOhad Ben-Cohen 				 int offset, int avail)
604400e64dfSOhad Ben-Cohen {
605400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *carveout, *mapping;
606b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
607400e64dfSOhad Ben-Cohen 	dma_addr_t dma;
608400e64dfSOhad Ben-Cohen 	void *va;
609400e64dfSOhad Ben-Cohen 	int ret;
610400e64dfSOhad Ben-Cohen 
611fd2c15ecSOhad Ben-Cohen 	if (sizeof(*rsc) > avail) {
612b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "carveout rsc is truncated\n");
613fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
614fd2c15ecSOhad Ben-Cohen 	}
615fd2c15ecSOhad Ben-Cohen 
616fd2c15ecSOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
617fd2c15ecSOhad Ben-Cohen 	if (rsc->reserved) {
618fd2c15ecSOhad Ben-Cohen 		dev_err(dev, "carveout rsc has non zero reserved bytes\n");
619fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
620fd2c15ecSOhad Ben-Cohen 	}
621fd2c15ecSOhad Ben-Cohen 
6229d7814a9SAnna, Suman 	dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n",
62335386166SLee Jones 		rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags);
624fd2c15ecSOhad Ben-Cohen 
625400e64dfSOhad Ben-Cohen 	carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
626172e6ab1SSuman Anna 	if (!carveout)
6277168d914SDan Carpenter 		return -ENOMEM;
628400e64dfSOhad Ben-Cohen 
629b5ab5e24SOhad Ben-Cohen 	va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
630400e64dfSOhad Ben-Cohen 	if (!va) {
6319c219b23SLee Jones 		dev_err(dev->parent,
6329c219b23SLee Jones 			"failed to allocate dma memory: len 0x%x\n", rsc->len);
633400e64dfSOhad Ben-Cohen 		ret = -ENOMEM;
634400e64dfSOhad Ben-Cohen 		goto free_carv;
635400e64dfSOhad Ben-Cohen 	}
636400e64dfSOhad Ben-Cohen 
637b605ed8bSAnna, Suman 	dev_dbg(dev, "carveout va %p, dma %pad, len 0x%x\n",
638b605ed8bSAnna, Suman 		va, &dma, rsc->len);
639400e64dfSOhad Ben-Cohen 
640400e64dfSOhad Ben-Cohen 	/*
641400e64dfSOhad Ben-Cohen 	 * Ok, this is non-standard.
642400e64dfSOhad Ben-Cohen 	 *
643400e64dfSOhad Ben-Cohen 	 * Sometimes we can't rely on the generic iommu-based DMA API
644400e64dfSOhad Ben-Cohen 	 * to dynamically allocate the device address and then set the IOMMU
645400e64dfSOhad Ben-Cohen 	 * tables accordingly, because some remote processors might
646400e64dfSOhad Ben-Cohen 	 * _require_ us to use hard coded device addresses that their
647400e64dfSOhad Ben-Cohen 	 * firmware was compiled with.
648400e64dfSOhad Ben-Cohen 	 *
649400e64dfSOhad Ben-Cohen 	 * In this case, we must use the IOMMU API directly and map
650400e64dfSOhad Ben-Cohen 	 * the memory to the device address as expected by the remote
651400e64dfSOhad Ben-Cohen 	 * processor.
652400e64dfSOhad Ben-Cohen 	 *
653400e64dfSOhad Ben-Cohen 	 * Obviously such remote processor devices should not be configured
654400e64dfSOhad Ben-Cohen 	 * to use the iommu-based DMA API: we expect 'dma' to contain the
655400e64dfSOhad Ben-Cohen 	 * physical address in this case.
656400e64dfSOhad Ben-Cohen 	 */
657400e64dfSOhad Ben-Cohen 	if (rproc->domain) {
6587168d914SDan Carpenter 		mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
6597168d914SDan Carpenter 		if (!mapping) {
6607168d914SDan Carpenter 			ret = -ENOMEM;
6617168d914SDan Carpenter 			goto dma_free;
6627168d914SDan Carpenter 		}
6637168d914SDan Carpenter 
664400e64dfSOhad Ben-Cohen 		ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
665400e64dfSOhad Ben-Cohen 				rsc->flags);
666400e64dfSOhad Ben-Cohen 		if (ret) {
667400e64dfSOhad Ben-Cohen 			dev_err(dev, "iommu_map failed: %d\n", ret);
6687168d914SDan Carpenter 			goto free_mapping;
669400e64dfSOhad Ben-Cohen 		}
670400e64dfSOhad Ben-Cohen 
671400e64dfSOhad Ben-Cohen 		/*
672400e64dfSOhad Ben-Cohen 		 * We'll need this info later when we'll want to unmap
673400e64dfSOhad Ben-Cohen 		 * everything (e.g. on shutdown).
674400e64dfSOhad Ben-Cohen 		 *
675400e64dfSOhad Ben-Cohen 		 * We can't trust the remote processor not to change the
676400e64dfSOhad Ben-Cohen 		 * resource table, so we must maintain this info independently.
677400e64dfSOhad Ben-Cohen 		 */
678400e64dfSOhad Ben-Cohen 		mapping->da = rsc->da;
679400e64dfSOhad Ben-Cohen 		mapping->len = rsc->len;
680400e64dfSOhad Ben-Cohen 		list_add_tail(&mapping->node, &rproc->mappings);
681400e64dfSOhad Ben-Cohen 
682b605ed8bSAnna, Suman 		dev_dbg(dev, "carveout mapped 0x%x to %pad\n",
683b605ed8bSAnna, Suman 			rsc->da, &dma);
6840e49b72cSOhad Ben-Cohen 	}
685400e64dfSOhad Ben-Cohen 
686400e64dfSOhad Ben-Cohen 	/*
687400e64dfSOhad Ben-Cohen 	 * Some remote processors might need to know the pa
688400e64dfSOhad Ben-Cohen 	 * even though they are behind an IOMMU. E.g., OMAP4's
689400e64dfSOhad Ben-Cohen 	 * remote M3 processor needs this so it can control
690400e64dfSOhad Ben-Cohen 	 * on-chip hardware accelerators that are not behind
691400e64dfSOhad Ben-Cohen 	 * the IOMMU, and therefor must know the pa.
692400e64dfSOhad Ben-Cohen 	 *
693400e64dfSOhad Ben-Cohen 	 * Generally we don't want to expose physical addresses
694400e64dfSOhad Ben-Cohen 	 * if we don't have to (remote processors are generally
695400e64dfSOhad Ben-Cohen 	 * _not_ trusted), so we might want to do this only for
696400e64dfSOhad Ben-Cohen 	 * remote processor that _must_ have this (e.g. OMAP4's
697400e64dfSOhad Ben-Cohen 	 * dual M3 subsystem).
6980e49b72cSOhad Ben-Cohen 	 *
6990e49b72cSOhad Ben-Cohen 	 * Non-IOMMU processors might also want to have this info.
7000e49b72cSOhad Ben-Cohen 	 * In this case, the device address and the physical address
7010e49b72cSOhad Ben-Cohen 	 * are the same.
702400e64dfSOhad Ben-Cohen 	 */
703400e64dfSOhad Ben-Cohen 	rsc->pa = dma;
704400e64dfSOhad Ben-Cohen 
705400e64dfSOhad Ben-Cohen 	carveout->va = va;
706400e64dfSOhad Ben-Cohen 	carveout->len = rsc->len;
707400e64dfSOhad Ben-Cohen 	carveout->dma = dma;
708400e64dfSOhad Ben-Cohen 	carveout->da = rsc->da;
709400e64dfSOhad Ben-Cohen 
710400e64dfSOhad Ben-Cohen 	list_add_tail(&carveout->node, &rproc->carveouts);
711400e64dfSOhad Ben-Cohen 
712400e64dfSOhad Ben-Cohen 	return 0;
713400e64dfSOhad Ben-Cohen 
7147168d914SDan Carpenter free_mapping:
7157168d914SDan Carpenter 	kfree(mapping);
716400e64dfSOhad Ben-Cohen dma_free:
717b5ab5e24SOhad Ben-Cohen 	dma_free_coherent(dev->parent, rsc->len, va, dma);
718400e64dfSOhad Ben-Cohen free_carv:
719400e64dfSOhad Ben-Cohen 	kfree(carveout);
720400e64dfSOhad Ben-Cohen 	return ret;
721400e64dfSOhad Ben-Cohen }
722400e64dfSOhad Ben-Cohen 
723e12bc14bSOhad Ben-Cohen /*
724e12bc14bSOhad Ben-Cohen  * A lookup table for resource handlers. The indices are defined in
725e12bc14bSOhad Ben-Cohen  * enum fw_resource_type.
726e12bc14bSOhad Ben-Cohen  */
727232fcdbbSSjur Brændeland static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = {
728fd2c15ecSOhad Ben-Cohen 	[RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
729fd2c15ecSOhad Ben-Cohen 	[RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
730fd2c15ecSOhad Ben-Cohen 	[RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
731232fcdbbSSjur Brændeland 	[RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev,
732232fcdbbSSjur Brændeland };
733232fcdbbSSjur Brændeland 
734400e64dfSOhad Ben-Cohen /* handle firmware resource entries before booting the remote processor */
735a2b950acSOhad Ben-Cohen static int rproc_handle_resources(struct rproc *rproc, int len,
736232fcdbbSSjur Brændeland 				  rproc_handle_resource_t handlers[RSC_LAST])
737400e64dfSOhad Ben-Cohen {
738b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
739e12bc14bSOhad Ben-Cohen 	rproc_handle_resource_t handler;
740fd2c15ecSOhad Ben-Cohen 	int ret = 0, i;
741400e64dfSOhad Ben-Cohen 
742a2b950acSOhad Ben-Cohen 	for (i = 0; i < rproc->table_ptr->num; i++) {
743a2b950acSOhad Ben-Cohen 		int offset = rproc->table_ptr->offset[i];
744a2b950acSOhad Ben-Cohen 		struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset;
745fd2c15ecSOhad Ben-Cohen 		int avail = len - offset - sizeof(*hdr);
746fd2c15ecSOhad Ben-Cohen 		void *rsc = (void *)hdr + sizeof(*hdr);
747400e64dfSOhad Ben-Cohen 
748fd2c15ecSOhad Ben-Cohen 		/* make sure table isn't truncated */
749fd2c15ecSOhad Ben-Cohen 		if (avail < 0) {
750fd2c15ecSOhad Ben-Cohen 			dev_err(dev, "rsc table is truncated\n");
751fd2c15ecSOhad Ben-Cohen 			return -EINVAL;
752fd2c15ecSOhad Ben-Cohen 		}
753fd2c15ecSOhad Ben-Cohen 
754fd2c15ecSOhad Ben-Cohen 		dev_dbg(dev, "rsc: type %d\n", hdr->type);
755fd2c15ecSOhad Ben-Cohen 
756fd2c15ecSOhad Ben-Cohen 		if (hdr->type >= RSC_LAST) {
757fd2c15ecSOhad Ben-Cohen 			dev_warn(dev, "unsupported resource %d\n", hdr->type);
758e12bc14bSOhad Ben-Cohen 			continue;
759400e64dfSOhad Ben-Cohen 		}
760400e64dfSOhad Ben-Cohen 
761232fcdbbSSjur Brændeland 		handler = handlers[hdr->type];
762e12bc14bSOhad Ben-Cohen 		if (!handler)
763e12bc14bSOhad Ben-Cohen 			continue;
764e12bc14bSOhad Ben-Cohen 
765a2b950acSOhad Ben-Cohen 		ret = handler(rproc, rsc, offset + sizeof(*hdr), avail);
7667a186941SOhad Ben-Cohen 		if (ret)
767400e64dfSOhad Ben-Cohen 			break;
768400e64dfSOhad Ben-Cohen 	}
769400e64dfSOhad Ben-Cohen 
770400e64dfSOhad Ben-Cohen 	return ret;
771400e64dfSOhad Ben-Cohen }
772400e64dfSOhad Ben-Cohen 
7737bdc9650SBjorn Andersson static int rproc_probe_subdevices(struct rproc *rproc)
7747bdc9650SBjorn Andersson {
7757bdc9650SBjorn Andersson 	struct rproc_subdev *subdev;
7767bdc9650SBjorn Andersson 	int ret;
7777bdc9650SBjorn Andersson 
7787bdc9650SBjorn Andersson 	list_for_each_entry(subdev, &rproc->subdevs, node) {
7797bdc9650SBjorn Andersson 		ret = subdev->probe(subdev);
7807bdc9650SBjorn Andersson 		if (ret)
7817bdc9650SBjorn Andersson 			goto unroll_registration;
7827bdc9650SBjorn Andersson 	}
7837bdc9650SBjorn Andersson 
7847bdc9650SBjorn Andersson 	return 0;
7857bdc9650SBjorn Andersson 
7867bdc9650SBjorn Andersson unroll_registration:
7877bdc9650SBjorn Andersson 	list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node)
7887bdc9650SBjorn Andersson 		subdev->remove(subdev);
7897bdc9650SBjorn Andersson 
7907bdc9650SBjorn Andersson 	return ret;
7917bdc9650SBjorn Andersson }
7927bdc9650SBjorn Andersson 
7937bdc9650SBjorn Andersson static void rproc_remove_subdevices(struct rproc *rproc)
7947bdc9650SBjorn Andersson {
7957bdc9650SBjorn Andersson 	struct rproc_subdev *subdev;
7967bdc9650SBjorn Andersson 
7977bdc9650SBjorn Andersson 	list_for_each_entry(subdev, &rproc->subdevs, node)
7987bdc9650SBjorn Andersson 		subdev->remove(subdev);
7997bdc9650SBjorn Andersson }
8007bdc9650SBjorn Andersson 
801400e64dfSOhad Ben-Cohen /**
802400e64dfSOhad Ben-Cohen  * rproc_resource_cleanup() - clean up and free all acquired resources
803400e64dfSOhad Ben-Cohen  * @rproc: rproc handle
804400e64dfSOhad Ben-Cohen  *
805400e64dfSOhad Ben-Cohen  * This function will free all resources acquired for @rproc, and it
8067a186941SOhad Ben-Cohen  * is called whenever @rproc either shuts down or fails to boot.
807400e64dfSOhad Ben-Cohen  */
808400e64dfSOhad Ben-Cohen static void rproc_resource_cleanup(struct rproc *rproc)
809400e64dfSOhad Ben-Cohen {
810400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *entry, *tmp;
811d81fb32fSBjorn Andersson 	struct rproc_vdev *rvdev, *rvtmp;
812b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
813400e64dfSOhad Ben-Cohen 
814400e64dfSOhad Ben-Cohen 	/* clean up debugfs trace entries */
815400e64dfSOhad Ben-Cohen 	list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
816400e64dfSOhad Ben-Cohen 		rproc_remove_trace_file(entry->priv);
817400e64dfSOhad Ben-Cohen 		rproc->num_traces--;
818400e64dfSOhad Ben-Cohen 		list_del(&entry->node);
819400e64dfSOhad Ben-Cohen 		kfree(entry);
820400e64dfSOhad Ben-Cohen 	}
821400e64dfSOhad Ben-Cohen 
822400e64dfSOhad Ben-Cohen 	/* clean up iommu mapping entries */
823400e64dfSOhad Ben-Cohen 	list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
824400e64dfSOhad Ben-Cohen 		size_t unmapped;
825400e64dfSOhad Ben-Cohen 
826400e64dfSOhad Ben-Cohen 		unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
827400e64dfSOhad Ben-Cohen 		if (unmapped != entry->len) {
828400e64dfSOhad Ben-Cohen 			/* nothing much to do besides complaining */
829e981f6d4SSjur Brændeland 			dev_err(dev, "failed to unmap %u/%zu\n", entry->len,
830400e64dfSOhad Ben-Cohen 				unmapped);
831400e64dfSOhad Ben-Cohen 		}
832400e64dfSOhad Ben-Cohen 
833400e64dfSOhad Ben-Cohen 		list_del(&entry->node);
834400e64dfSOhad Ben-Cohen 		kfree(entry);
835400e64dfSOhad Ben-Cohen 	}
836b6356a01SSuman Anna 
837b6356a01SSuman Anna 	/* clean up carveout allocations */
838b6356a01SSuman Anna 	list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
839172e6ab1SSuman Anna 		dma_free_coherent(dev->parent, entry->len, entry->va,
840172e6ab1SSuman Anna 				  entry->dma);
841b6356a01SSuman Anna 		list_del(&entry->node);
842b6356a01SSuman Anna 		kfree(entry);
843b6356a01SSuman Anna 	}
844d81fb32fSBjorn Andersson 
845d81fb32fSBjorn Andersson 	/* clean up remote vdev entries */
846f5bcb353SBjorn Andersson 	list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node)
8472b45cef5SBjorn Andersson 		kref_put(&rvdev->refcount, rproc_vdev_release);
8482b45cef5SBjorn Andersson }
849400e64dfSOhad Ben-Cohen 
8501efa30d0SSarangdhar Joshi static int rproc_start(struct rproc *rproc, const struct firmware *fw)
8511efa30d0SSarangdhar Joshi {
8521efa30d0SSarangdhar Joshi 	struct resource_table *table, *loaded_table;
8531efa30d0SSarangdhar Joshi 	struct device *dev = &rproc->dev;
8541efa30d0SSarangdhar Joshi 	int ret, tablesz;
8551efa30d0SSarangdhar Joshi 
8561efa30d0SSarangdhar Joshi 	/* look for the resource table */
8571efa30d0SSarangdhar Joshi 	table = rproc_find_rsc_table(rproc, fw, &tablesz);
8581efa30d0SSarangdhar Joshi 	if (!table) {
8591efa30d0SSarangdhar Joshi 		dev_err(dev, "Resouce table look up failed\n");
8601efa30d0SSarangdhar Joshi 		return -EINVAL;
8611efa30d0SSarangdhar Joshi 	}
8621efa30d0SSarangdhar Joshi 
8631efa30d0SSarangdhar Joshi 	/* load the ELF segments to memory */
8641efa30d0SSarangdhar Joshi 	ret = rproc_load_segments(rproc, fw);
8651efa30d0SSarangdhar Joshi 	if (ret) {
8661efa30d0SSarangdhar Joshi 		dev_err(dev, "Failed to load program segments: %d\n", ret);
8671efa30d0SSarangdhar Joshi 		return ret;
8681efa30d0SSarangdhar Joshi 	}
8691efa30d0SSarangdhar Joshi 
8701efa30d0SSarangdhar Joshi 	/*
8711efa30d0SSarangdhar Joshi 	 * The starting device has been given the rproc->cached_table as the
8721efa30d0SSarangdhar Joshi 	 * resource table. The address of the vring along with the other
8731efa30d0SSarangdhar Joshi 	 * allocated resources (carveouts etc) is stored in cached_table.
8741efa30d0SSarangdhar Joshi 	 * In order to pass this information to the remote device we must copy
8751efa30d0SSarangdhar Joshi 	 * this information to device memory. We also update the table_ptr so
8761efa30d0SSarangdhar Joshi 	 * that any subsequent changes will be applied to the loaded version.
8771efa30d0SSarangdhar Joshi 	 */
8781efa30d0SSarangdhar Joshi 	loaded_table = rproc_find_loaded_rsc_table(rproc, fw);
8791efa30d0SSarangdhar Joshi 	if (loaded_table) {
8801efa30d0SSarangdhar Joshi 		memcpy(loaded_table, rproc->cached_table, tablesz);
8811efa30d0SSarangdhar Joshi 		rproc->table_ptr = loaded_table;
8821efa30d0SSarangdhar Joshi 	}
8831efa30d0SSarangdhar Joshi 
8841efa30d0SSarangdhar Joshi 	/* power up the remote processor */
8851efa30d0SSarangdhar Joshi 	ret = rproc->ops->start(rproc);
8861efa30d0SSarangdhar Joshi 	if (ret) {
8871efa30d0SSarangdhar Joshi 		dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
8881efa30d0SSarangdhar Joshi 		return ret;
8891efa30d0SSarangdhar Joshi 	}
8901efa30d0SSarangdhar Joshi 
8911efa30d0SSarangdhar Joshi 	/* probe any subdevices for the remote processor */
8921efa30d0SSarangdhar Joshi 	ret = rproc_probe_subdevices(rproc);
8931efa30d0SSarangdhar Joshi 	if (ret) {
8941efa30d0SSarangdhar Joshi 		dev_err(dev, "failed to probe subdevices for %s: %d\n",
8951efa30d0SSarangdhar Joshi 			rproc->name, ret);
8961efa30d0SSarangdhar Joshi 		rproc->ops->stop(rproc);
8971efa30d0SSarangdhar Joshi 		return ret;
8981efa30d0SSarangdhar Joshi 	}
8991efa30d0SSarangdhar Joshi 
9001efa30d0SSarangdhar Joshi 	rproc->state = RPROC_RUNNING;
9011efa30d0SSarangdhar Joshi 
9021efa30d0SSarangdhar Joshi 	dev_info(dev, "remote processor %s is now up\n", rproc->name);
9031efa30d0SSarangdhar Joshi 
9041efa30d0SSarangdhar Joshi 	return 0;
9051efa30d0SSarangdhar Joshi }
9061efa30d0SSarangdhar Joshi 
907400e64dfSOhad Ben-Cohen /*
908400e64dfSOhad Ben-Cohen  * take a firmware and boot a remote processor with it.
909400e64dfSOhad Ben-Cohen  */
910400e64dfSOhad Ben-Cohen static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
911400e64dfSOhad Ben-Cohen {
912b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
913400e64dfSOhad Ben-Cohen 	const char *name = rproc->firmware;
9141efa30d0SSarangdhar Joshi 	struct resource_table *table;
9151e3e2c7cSOhad Ben-Cohen 	int ret, tablesz;
916400e64dfSOhad Ben-Cohen 
917400e64dfSOhad Ben-Cohen 	ret = rproc_fw_sanity_check(rproc, fw);
918400e64dfSOhad Ben-Cohen 	if (ret)
919400e64dfSOhad Ben-Cohen 		return ret;
920400e64dfSOhad Ben-Cohen 
921e981f6d4SSjur Brændeland 	dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size);
922400e64dfSOhad Ben-Cohen 
923400e64dfSOhad Ben-Cohen 	/*
924400e64dfSOhad Ben-Cohen 	 * if enabling an IOMMU isn't relevant for this rproc, this is
925400e64dfSOhad Ben-Cohen 	 * just a nop
926400e64dfSOhad Ben-Cohen 	 */
927400e64dfSOhad Ben-Cohen 	ret = rproc_enable_iommu(rproc);
928400e64dfSOhad Ben-Cohen 	if (ret) {
929400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't enable iommu: %d\n", ret);
930400e64dfSOhad Ben-Cohen 		return ret;
931400e64dfSOhad Ben-Cohen 	}
932400e64dfSOhad Ben-Cohen 
9333e5f9eb5SSjur Brændeland 	rproc->bootaddr = rproc_get_boot_addr(rproc, fw);
93489970d28SWei Yongjun 	ret = -EINVAL;
935400e64dfSOhad Ben-Cohen 
9361e3e2c7cSOhad Ben-Cohen 	/* look for the resource table */
937bd484984SSjur Brændeland 	table = rproc_find_rsc_table(rproc, fw, &tablesz);
938a66a5114SStefan Agner 	if (!table) {
939a66a5114SStefan Agner 		dev_err(dev, "Failed to find resource table\n");
9401e3e2c7cSOhad Ben-Cohen 		goto clean_up;
941a66a5114SStefan Agner 	}
9421e3e2c7cSOhad Ben-Cohen 
943988d204cSBjorn Andersson 	/*
944988d204cSBjorn Andersson 	 * Create a copy of the resource table. When a virtio device starts
945988d204cSBjorn Andersson 	 * and calls vring_new_virtqueue() the address of the allocated vring
946a0c10687SBjorn Andersson 	 * will be stored in the cached_table. Before the device is started,
947a0c10687SBjorn Andersson 	 * cached_table will be copied into device memory.
948988d204cSBjorn Andersson 	 */
949a0c10687SBjorn Andersson 	rproc->cached_table = kmemdup(table, tablesz, GFP_KERNEL);
950a0c10687SBjorn Andersson 	if (!rproc->cached_table)
951a2b950acSOhad Ben-Cohen 		goto clean_up;
952988d204cSBjorn Andersson 
953a0c10687SBjorn Andersson 	rproc->table_ptr = rproc->cached_table;
954a0c10687SBjorn Andersson 
955b35d7afcSBjorn Andersson 	/* reset max_notifyid */
956b35d7afcSBjorn Andersson 	rproc->max_notifyid = -1;
957b35d7afcSBjorn Andersson 
958400e64dfSOhad Ben-Cohen 	/* handle fw resources which are required to boot rproc */
959a2b950acSOhad Ben-Cohen 	ret = rproc_handle_resources(rproc, tablesz, rproc_loading_handlers);
960400e64dfSOhad Ben-Cohen 	if (ret) {
961400e64dfSOhad Ben-Cohen 		dev_err(dev, "Failed to process resources: %d\n", ret);
962229b85a6SBjorn Andersson 		goto clean_up_resources;
963400e64dfSOhad Ben-Cohen 	}
964400e64dfSOhad Ben-Cohen 
9651efa30d0SSarangdhar Joshi 	ret = rproc_start(rproc, fw);
9661efa30d0SSarangdhar Joshi 	if (ret)
967229b85a6SBjorn Andersson 		goto clean_up_resources;
968400e64dfSOhad Ben-Cohen 
969400e64dfSOhad Ben-Cohen 	return 0;
970400e64dfSOhad Ben-Cohen 
971229b85a6SBjorn Andersson clean_up_resources:
972229b85a6SBjorn Andersson 	rproc_resource_cleanup(rproc);
973400e64dfSOhad Ben-Cohen clean_up:
974a0c10687SBjorn Andersson 	kfree(rproc->cached_table);
975a0c10687SBjorn Andersson 	rproc->cached_table = NULL;
976988d204cSBjorn Andersson 	rproc->table_ptr = NULL;
977988d204cSBjorn Andersson 
978400e64dfSOhad Ben-Cohen 	rproc_disable_iommu(rproc);
979400e64dfSOhad Ben-Cohen 	return ret;
980400e64dfSOhad Ben-Cohen }
981400e64dfSOhad Ben-Cohen 
982400e64dfSOhad Ben-Cohen /*
9835e6533f7SSarangdhar Joshi  * take a firmware and boot it up.
984400e64dfSOhad Ben-Cohen  *
985400e64dfSOhad Ben-Cohen  * Note: this function is called asynchronously upon registration of the
986400e64dfSOhad Ben-Cohen  * remote processor (so we must wait until it completes before we try
987400e64dfSOhad Ben-Cohen  * to unregister the device. one other option is just to use kref here,
988400e64dfSOhad Ben-Cohen  * that might be cleaner).
989400e64dfSOhad Ben-Cohen  */
9905e6533f7SSarangdhar Joshi static void rproc_auto_boot_callback(const struct firmware *fw, void *context)
991400e64dfSOhad Ben-Cohen {
992400e64dfSOhad Ben-Cohen 	struct rproc *rproc = context;
993a2b950acSOhad Ben-Cohen 
9942bfc311aSBjorn Andersson 	rproc_boot(rproc);
995ddf71187SBjorn Andersson 
996400e64dfSOhad Ben-Cohen 	release_firmware(fw);
997400e64dfSOhad Ben-Cohen }
998400e64dfSOhad Ben-Cohen 
9995e6533f7SSarangdhar Joshi static int rproc_trigger_auto_boot(struct rproc *rproc)
100070b85ef8SFernando Guzman Lugo {
100170b85ef8SFernando Guzman Lugo 	int ret;
100270b85ef8SFernando Guzman Lugo 
100370b85ef8SFernando Guzman Lugo 	/*
100470b85ef8SFernando Guzman Lugo 	 * We're initiating an asynchronous firmware loading, so we can
100570b85ef8SFernando Guzman Lugo 	 * be built-in kernel code, without hanging the boot process.
100670b85ef8SFernando Guzman Lugo 	 */
100770b85ef8SFernando Guzman Lugo 	ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
100870b85ef8SFernando Guzman Lugo 				      rproc->firmware, &rproc->dev, GFP_KERNEL,
10095e6533f7SSarangdhar Joshi 				      rproc, rproc_auto_boot_callback);
10102099c77dSSarangdhar Joshi 	if (ret < 0)
101170b85ef8SFernando Guzman Lugo 		dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret);
101270b85ef8SFernando Guzman Lugo 
101370b85ef8SFernando Guzman Lugo 	return ret;
101470b85ef8SFernando Guzman Lugo }
101570b85ef8SFernando Guzman Lugo 
10161efa30d0SSarangdhar Joshi static int rproc_stop(struct rproc *rproc)
10171efa30d0SSarangdhar Joshi {
10181efa30d0SSarangdhar Joshi 	struct device *dev = &rproc->dev;
10191efa30d0SSarangdhar Joshi 	int ret;
10201efa30d0SSarangdhar Joshi 
10211efa30d0SSarangdhar Joshi 	/* remove any subdevices for the remote processor */
10221efa30d0SSarangdhar Joshi 	rproc_remove_subdevices(rproc);
10231efa30d0SSarangdhar Joshi 
10241efa30d0SSarangdhar Joshi 	/* power off the remote processor */
10251efa30d0SSarangdhar Joshi 	ret = rproc->ops->stop(rproc);
10261efa30d0SSarangdhar Joshi 	if (ret) {
10271efa30d0SSarangdhar Joshi 		dev_err(dev, "can't stop rproc: %d\n", ret);
10281efa30d0SSarangdhar Joshi 		return ret;
10291efa30d0SSarangdhar Joshi 	}
10301efa30d0SSarangdhar Joshi 
10311efa30d0SSarangdhar Joshi 	/* if in crash state, unlock crash handler */
10321efa30d0SSarangdhar Joshi 	if (rproc->state == RPROC_CRASHED)
10331efa30d0SSarangdhar Joshi 		complete_all(&rproc->crash_comp);
10341efa30d0SSarangdhar Joshi 
10351efa30d0SSarangdhar Joshi 	rproc->state = RPROC_OFFLINE;
10361efa30d0SSarangdhar Joshi 
10371efa30d0SSarangdhar Joshi 	dev_info(dev, "stopped remote processor %s\n", rproc->name);
10381efa30d0SSarangdhar Joshi 
10391efa30d0SSarangdhar Joshi 	return 0;
10401efa30d0SSarangdhar Joshi }
10411efa30d0SSarangdhar Joshi 
104270b85ef8SFernando Guzman Lugo /**
104370b85ef8SFernando Guzman Lugo  * rproc_trigger_recovery() - recover a remoteproc
104470b85ef8SFernando Guzman Lugo  * @rproc: the remote processor
104570b85ef8SFernando Guzman Lugo  *
104656324d7aSAnna, Suman  * The recovery is done by resetting all the virtio devices, that way all the
104770b85ef8SFernando Guzman Lugo  * rpmsg drivers will be reseted along with the remote processor making the
104870b85ef8SFernando Guzman Lugo  * remoteproc functional again.
104970b85ef8SFernando Guzman Lugo  *
105070b85ef8SFernando Guzman Lugo  * This function can sleep, so it cannot be called from atomic context.
105170b85ef8SFernando Guzman Lugo  */
105270b85ef8SFernando Guzman Lugo int rproc_trigger_recovery(struct rproc *rproc)
105370b85ef8SFernando Guzman Lugo {
1054*7e83cab8SSarangdhar Joshi 	const struct firmware *firmware_p;
1055*7e83cab8SSarangdhar Joshi 	struct device *dev = &rproc->dev;
1056*7e83cab8SSarangdhar Joshi 	int ret;
1057*7e83cab8SSarangdhar Joshi 
1058*7e83cab8SSarangdhar Joshi 	dev_err(dev, "recovering %s\n", rproc->name);
105970b85ef8SFernando Guzman Lugo 
106070b85ef8SFernando Guzman Lugo 	init_completion(&rproc->crash_comp);
106170b85ef8SFernando Guzman Lugo 
1062*7e83cab8SSarangdhar Joshi 	ret = mutex_lock_interruptible(&rproc->lock);
1063*7e83cab8SSarangdhar Joshi 	if (ret)
1064*7e83cab8SSarangdhar Joshi 		return ret;
1065*7e83cab8SSarangdhar Joshi 
1066*7e83cab8SSarangdhar Joshi 	ret = rproc_stop(rproc);
1067*7e83cab8SSarangdhar Joshi 	if (ret)
1068*7e83cab8SSarangdhar Joshi 		goto unlock_mutex;
1069ddf71187SBjorn Andersson 
107070b85ef8SFernando Guzman Lugo 	/* wait until there is no more rproc users */
107170b85ef8SFernando Guzman Lugo 	wait_for_completion(&rproc->crash_comp);
107270b85ef8SFernando Guzman Lugo 
1073*7e83cab8SSarangdhar Joshi 	/* load firmware */
1074*7e83cab8SSarangdhar Joshi 	ret = request_firmware(&firmware_p, rproc->firmware, dev);
1075*7e83cab8SSarangdhar Joshi 	if (ret < 0) {
1076*7e83cab8SSarangdhar Joshi 		dev_err(dev, "request_firmware failed: %d\n", ret);
1077*7e83cab8SSarangdhar Joshi 		goto unlock_mutex;
1078*7e83cab8SSarangdhar Joshi 	}
1079ddf71187SBjorn Andersson 
1080*7e83cab8SSarangdhar Joshi 	/* boot the remote processor up again */
1081*7e83cab8SSarangdhar Joshi 	ret = rproc_start(rproc, firmware_p);
1082*7e83cab8SSarangdhar Joshi 
1083*7e83cab8SSarangdhar Joshi 	release_firmware(firmware_p);
1084*7e83cab8SSarangdhar Joshi 
1085*7e83cab8SSarangdhar Joshi unlock_mutex:
1086*7e83cab8SSarangdhar Joshi 	mutex_unlock(&rproc->lock);
1087*7e83cab8SSarangdhar Joshi 	return ret;
108870b85ef8SFernando Guzman Lugo }
108970b85ef8SFernando Guzman Lugo 
1090400e64dfSOhad Ben-Cohen /**
10918afd519cSFernando Guzman Lugo  * rproc_crash_handler_work() - handle a crash
10928afd519cSFernando Guzman Lugo  *
10938afd519cSFernando Guzman Lugo  * This function needs to handle everything related to a crash, like cpu
10948afd519cSFernando Guzman Lugo  * registers and stack dump, information to help to debug the fatal error, etc.
10958afd519cSFernando Guzman Lugo  */
10968afd519cSFernando Guzman Lugo static void rproc_crash_handler_work(struct work_struct *work)
10978afd519cSFernando Guzman Lugo {
10988afd519cSFernando Guzman Lugo 	struct rproc *rproc = container_of(work, struct rproc, crash_handler);
10998afd519cSFernando Guzman Lugo 	struct device *dev = &rproc->dev;
11008afd519cSFernando Guzman Lugo 
11018afd519cSFernando Guzman Lugo 	dev_dbg(dev, "enter %s\n", __func__);
11028afd519cSFernando Guzman Lugo 
11038afd519cSFernando Guzman Lugo 	mutex_lock(&rproc->lock);
11048afd519cSFernando Guzman Lugo 
11058afd519cSFernando Guzman Lugo 	if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) {
11068afd519cSFernando Guzman Lugo 		/* handle only the first crash detected */
11078afd519cSFernando Guzman Lugo 		mutex_unlock(&rproc->lock);
11088afd519cSFernando Guzman Lugo 		return;
11098afd519cSFernando Guzman Lugo 	}
11108afd519cSFernando Guzman Lugo 
11118afd519cSFernando Guzman Lugo 	rproc->state = RPROC_CRASHED;
11128afd519cSFernando Guzman Lugo 	dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt,
11138afd519cSFernando Guzman Lugo 		rproc->name);
11148afd519cSFernando Guzman Lugo 
11158afd519cSFernando Guzman Lugo 	mutex_unlock(&rproc->lock);
11168afd519cSFernando Guzman Lugo 
11172e37abb8SFernando Guzman Lugo 	if (!rproc->recovery_disabled)
111870b85ef8SFernando Guzman Lugo 		rproc_trigger_recovery(rproc);
11198afd519cSFernando Guzman Lugo }
11208afd519cSFernando Guzman Lugo 
11218afd519cSFernando Guzman Lugo /**
11223d87fa1dSLee Jones  * __rproc_boot() - boot a remote processor
1123400e64dfSOhad Ben-Cohen  * @rproc: handle of a remote processor
1124400e64dfSOhad Ben-Cohen  *
1125400e64dfSOhad Ben-Cohen  * Boot a remote processor (i.e. load its firmware, power it on, ...).
1126400e64dfSOhad Ben-Cohen  *
1127400e64dfSOhad Ben-Cohen  * If the remote processor is already powered on, this function immediately
1128400e64dfSOhad Ben-Cohen  * returns (successfully).
1129400e64dfSOhad Ben-Cohen  *
1130400e64dfSOhad Ben-Cohen  * Returns 0 on success, and an appropriate error value otherwise.
1131400e64dfSOhad Ben-Cohen  */
11322bfc311aSBjorn Andersson static int __rproc_boot(struct rproc *rproc)
1133400e64dfSOhad Ben-Cohen {
1134400e64dfSOhad Ben-Cohen 	const struct firmware *firmware_p;
1135400e64dfSOhad Ben-Cohen 	struct device *dev;
1136400e64dfSOhad Ben-Cohen 	int ret;
1137400e64dfSOhad Ben-Cohen 
1138400e64dfSOhad Ben-Cohen 	if (!rproc) {
1139400e64dfSOhad Ben-Cohen 		pr_err("invalid rproc handle\n");
1140400e64dfSOhad Ben-Cohen 		return -EINVAL;
1141400e64dfSOhad Ben-Cohen 	}
1142400e64dfSOhad Ben-Cohen 
1143b5ab5e24SOhad Ben-Cohen 	dev = &rproc->dev;
1144400e64dfSOhad Ben-Cohen 
1145400e64dfSOhad Ben-Cohen 	ret = mutex_lock_interruptible(&rproc->lock);
1146400e64dfSOhad Ben-Cohen 	if (ret) {
1147400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1148400e64dfSOhad Ben-Cohen 		return ret;
1149400e64dfSOhad Ben-Cohen 	}
1150400e64dfSOhad Ben-Cohen 
11512099c77dSSarangdhar Joshi 	if (rproc->state == RPROC_DELETED) {
11522099c77dSSarangdhar Joshi 		ret = -ENODEV;
11532099c77dSSarangdhar Joshi 		dev_err(dev, "can't boot deleted rproc %s\n", rproc->name);
11542099c77dSSarangdhar Joshi 		goto unlock_mutex;
11552099c77dSSarangdhar Joshi 	}
11562099c77dSSarangdhar Joshi 
1157400e64dfSOhad Ben-Cohen 	/* skip the boot process if rproc is already powered up */
1158400e64dfSOhad Ben-Cohen 	if (atomic_inc_return(&rproc->power) > 1) {
1159400e64dfSOhad Ben-Cohen 		ret = 0;
1160400e64dfSOhad Ben-Cohen 		goto unlock_mutex;
1161400e64dfSOhad Ben-Cohen 	}
1162400e64dfSOhad Ben-Cohen 
1163400e64dfSOhad Ben-Cohen 	dev_info(dev, "powering up %s\n", rproc->name);
1164400e64dfSOhad Ben-Cohen 
1165400e64dfSOhad Ben-Cohen 	/* load firmware */
1166400e64dfSOhad Ben-Cohen 	ret = request_firmware(&firmware_p, rproc->firmware, dev);
1167400e64dfSOhad Ben-Cohen 	if (ret < 0) {
1168400e64dfSOhad Ben-Cohen 		dev_err(dev, "request_firmware failed: %d\n", ret);
1169400e64dfSOhad Ben-Cohen 		goto downref_rproc;
1170400e64dfSOhad Ben-Cohen 	}
1171400e64dfSOhad Ben-Cohen 
1172400e64dfSOhad Ben-Cohen 	ret = rproc_fw_boot(rproc, firmware_p);
1173400e64dfSOhad Ben-Cohen 
1174400e64dfSOhad Ben-Cohen 	release_firmware(firmware_p);
1175400e64dfSOhad Ben-Cohen 
1176400e64dfSOhad Ben-Cohen downref_rproc:
1177fbb6aacbSBjorn Andersson 	if (ret)
1178400e64dfSOhad Ben-Cohen 		atomic_dec(&rproc->power);
1179400e64dfSOhad Ben-Cohen unlock_mutex:
1180400e64dfSOhad Ben-Cohen 	mutex_unlock(&rproc->lock);
1181400e64dfSOhad Ben-Cohen 	return ret;
1182400e64dfSOhad Ben-Cohen }
11833d87fa1dSLee Jones 
11843d87fa1dSLee Jones /**
11853d87fa1dSLee Jones  * rproc_boot() - boot a remote processor
11863d87fa1dSLee Jones  * @rproc: handle of a remote processor
11873d87fa1dSLee Jones  */
11883d87fa1dSLee Jones int rproc_boot(struct rproc *rproc)
11893d87fa1dSLee Jones {
11902bfc311aSBjorn Andersson 	return __rproc_boot(rproc);
11913d87fa1dSLee Jones }
1192400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_boot);
1193400e64dfSOhad Ben-Cohen 
1194400e64dfSOhad Ben-Cohen /**
1195400e64dfSOhad Ben-Cohen  * rproc_shutdown() - power off the remote processor
1196400e64dfSOhad Ben-Cohen  * @rproc: the remote processor
1197400e64dfSOhad Ben-Cohen  *
1198400e64dfSOhad Ben-Cohen  * Power off a remote processor (previously booted with rproc_boot()).
1199400e64dfSOhad Ben-Cohen  *
1200400e64dfSOhad Ben-Cohen  * In case @rproc is still being used by an additional user(s), then
1201400e64dfSOhad Ben-Cohen  * this function will just decrement the power refcount and exit,
1202400e64dfSOhad Ben-Cohen  * without really powering off the device.
1203400e64dfSOhad Ben-Cohen  *
1204400e64dfSOhad Ben-Cohen  * Every call to rproc_boot() must (eventually) be accompanied by a call
1205400e64dfSOhad Ben-Cohen  * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1206400e64dfSOhad Ben-Cohen  *
1207400e64dfSOhad Ben-Cohen  * Notes:
1208400e64dfSOhad Ben-Cohen  * - we're not decrementing the rproc's refcount, only the power refcount.
1209400e64dfSOhad Ben-Cohen  *   which means that the @rproc handle stays valid even after rproc_shutdown()
1210400e64dfSOhad Ben-Cohen  *   returns, and users can still use it with a subsequent rproc_boot(), if
1211400e64dfSOhad Ben-Cohen  *   needed.
1212400e64dfSOhad Ben-Cohen  */
1213400e64dfSOhad Ben-Cohen void rproc_shutdown(struct rproc *rproc)
1214400e64dfSOhad Ben-Cohen {
1215b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
1216400e64dfSOhad Ben-Cohen 	int ret;
1217400e64dfSOhad Ben-Cohen 
1218400e64dfSOhad Ben-Cohen 	ret = mutex_lock_interruptible(&rproc->lock);
1219400e64dfSOhad Ben-Cohen 	if (ret) {
1220400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1221400e64dfSOhad Ben-Cohen 		return;
1222400e64dfSOhad Ben-Cohen 	}
1223400e64dfSOhad Ben-Cohen 
1224400e64dfSOhad Ben-Cohen 	/* if the remote proc is still needed, bail out */
1225400e64dfSOhad Ben-Cohen 	if (!atomic_dec_and_test(&rproc->power))
1226400e64dfSOhad Ben-Cohen 		goto out;
1227400e64dfSOhad Ben-Cohen 
12281efa30d0SSarangdhar Joshi 	ret = rproc_stop(rproc);
1229400e64dfSOhad Ben-Cohen 	if (ret) {
1230400e64dfSOhad Ben-Cohen 		atomic_inc(&rproc->power);
1231400e64dfSOhad Ben-Cohen 		goto out;
1232400e64dfSOhad Ben-Cohen 	}
1233400e64dfSOhad Ben-Cohen 
1234400e64dfSOhad Ben-Cohen 	/* clean up all acquired resources */
1235400e64dfSOhad Ben-Cohen 	rproc_resource_cleanup(rproc);
1236400e64dfSOhad Ben-Cohen 
1237400e64dfSOhad Ben-Cohen 	rproc_disable_iommu(rproc);
1238400e64dfSOhad Ben-Cohen 
1239988d204cSBjorn Andersson 	/* Free the copy of the resource table */
1240a0c10687SBjorn Andersson 	kfree(rproc->cached_table);
1241a0c10687SBjorn Andersson 	rproc->cached_table = NULL;
1242988d204cSBjorn Andersson 	rproc->table_ptr = NULL;
1243400e64dfSOhad Ben-Cohen out:
1244400e64dfSOhad Ben-Cohen 	mutex_unlock(&rproc->lock);
1245400e64dfSOhad Ben-Cohen }
1246400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_shutdown);
1247400e64dfSOhad Ben-Cohen 
1248400e64dfSOhad Ben-Cohen /**
1249fec47d86SDave Gerlach  * rproc_get_by_phandle() - find a remote processor by phandle
1250fec47d86SDave Gerlach  * @phandle: phandle to the rproc
1251fec47d86SDave Gerlach  *
1252fec47d86SDave Gerlach  * Finds an rproc handle using the remote processor's phandle, and then
1253fec47d86SDave Gerlach  * return a handle to the rproc.
1254fec47d86SDave Gerlach  *
1255fec47d86SDave Gerlach  * This function increments the remote processor's refcount, so always
1256fec47d86SDave Gerlach  * use rproc_put() to decrement it back once rproc isn't needed anymore.
1257fec47d86SDave Gerlach  *
1258fec47d86SDave Gerlach  * Returns the rproc handle on success, and NULL on failure.
1259fec47d86SDave Gerlach  */
12608de3dbd0SOhad Ben-Cohen #ifdef CONFIG_OF
1261fec47d86SDave Gerlach struct rproc *rproc_get_by_phandle(phandle phandle)
1262fec47d86SDave Gerlach {
1263fec47d86SDave Gerlach 	struct rproc *rproc = NULL, *r;
1264fec47d86SDave Gerlach 	struct device_node *np;
1265fec47d86SDave Gerlach 
1266fec47d86SDave Gerlach 	np = of_find_node_by_phandle(phandle);
1267fec47d86SDave Gerlach 	if (!np)
1268fec47d86SDave Gerlach 		return NULL;
1269fec47d86SDave Gerlach 
1270fec47d86SDave Gerlach 	mutex_lock(&rproc_list_mutex);
1271fec47d86SDave Gerlach 	list_for_each_entry(r, &rproc_list, node) {
1272fec47d86SDave Gerlach 		if (r->dev.parent && r->dev.parent->of_node == np) {
1273fbb6aacbSBjorn Andersson 			/* prevent underlying implementation from being removed */
1274fbb6aacbSBjorn Andersson 			if (!try_module_get(r->dev.parent->driver->owner)) {
1275fbb6aacbSBjorn Andersson 				dev_err(&r->dev, "can't get owner\n");
1276fbb6aacbSBjorn Andersson 				break;
1277fbb6aacbSBjorn Andersson 			}
1278fbb6aacbSBjorn Andersson 
1279fec47d86SDave Gerlach 			rproc = r;
1280fec47d86SDave Gerlach 			get_device(&rproc->dev);
1281fec47d86SDave Gerlach 			break;
1282fec47d86SDave Gerlach 		}
1283fec47d86SDave Gerlach 	}
1284fec47d86SDave Gerlach 	mutex_unlock(&rproc_list_mutex);
1285fec47d86SDave Gerlach 
1286fec47d86SDave Gerlach 	of_node_put(np);
1287fec47d86SDave Gerlach 
1288fec47d86SDave Gerlach 	return rproc;
1289fec47d86SDave Gerlach }
12908de3dbd0SOhad Ben-Cohen #else
12918de3dbd0SOhad Ben-Cohen struct rproc *rproc_get_by_phandle(phandle phandle)
12928de3dbd0SOhad Ben-Cohen {
12938de3dbd0SOhad Ben-Cohen 	return NULL;
12948de3dbd0SOhad Ben-Cohen }
12958de3dbd0SOhad Ben-Cohen #endif
1296fec47d86SDave Gerlach EXPORT_SYMBOL(rproc_get_by_phandle);
1297fec47d86SDave Gerlach 
1298fec47d86SDave Gerlach /**
1299160e7c84SOhad Ben-Cohen  * rproc_add() - register a remote processor
1300400e64dfSOhad Ben-Cohen  * @rproc: the remote processor handle to register
1301400e64dfSOhad Ben-Cohen  *
1302400e64dfSOhad Ben-Cohen  * Registers @rproc with the remoteproc framework, after it has been
1303400e64dfSOhad Ben-Cohen  * allocated with rproc_alloc().
1304400e64dfSOhad Ben-Cohen  *
1305400e64dfSOhad Ben-Cohen  * This is called by the platform-specific rproc implementation, whenever
1306400e64dfSOhad Ben-Cohen  * a new remote processor device is probed.
1307400e64dfSOhad Ben-Cohen  *
1308400e64dfSOhad Ben-Cohen  * Returns 0 on success and an appropriate error code otherwise.
1309400e64dfSOhad Ben-Cohen  *
1310400e64dfSOhad Ben-Cohen  * Note: this function initiates an asynchronous firmware loading
1311400e64dfSOhad Ben-Cohen  * context, which will look for virtio devices supported by the rproc's
1312400e64dfSOhad Ben-Cohen  * firmware.
1313400e64dfSOhad Ben-Cohen  *
1314400e64dfSOhad Ben-Cohen  * If found, those virtio devices will be created and added, so as a result
13157a186941SOhad Ben-Cohen  * of registering this remote processor, additional virtio drivers might be
1316400e64dfSOhad Ben-Cohen  * probed.
1317400e64dfSOhad Ben-Cohen  */
1318160e7c84SOhad Ben-Cohen int rproc_add(struct rproc *rproc)
1319400e64dfSOhad Ben-Cohen {
1320b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
132170b85ef8SFernando Guzman Lugo 	int ret;
1322400e64dfSOhad Ben-Cohen 
1323b5ab5e24SOhad Ben-Cohen 	ret = device_add(dev);
1324b5ab5e24SOhad Ben-Cohen 	if (ret < 0)
1325b5ab5e24SOhad Ben-Cohen 		return ret;
1326400e64dfSOhad Ben-Cohen 
1327b5ab5e24SOhad Ben-Cohen 	dev_info(dev, "%s is available\n", rproc->name);
1328400e64dfSOhad Ben-Cohen 
1329400e64dfSOhad Ben-Cohen 	/* create debugfs entries */
1330400e64dfSOhad Ben-Cohen 	rproc_create_debug_dir(rproc);
13317a20c64dSSarangdhar Joshi 
13327a20c64dSSarangdhar Joshi 	/* if rproc is marked always-on, request it to boot */
13337a20c64dSSarangdhar Joshi 	if (rproc->auto_boot) {
13345e6533f7SSarangdhar Joshi 		ret = rproc_trigger_auto_boot(rproc);
1335d2e12e66SDave Gerlach 		if (ret < 0)
1336d2e12e66SDave Gerlach 			return ret;
13377a20c64dSSarangdhar Joshi 	}
1338400e64dfSOhad Ben-Cohen 
1339d2e12e66SDave Gerlach 	/* expose to rproc_get_by_phandle users */
1340d2e12e66SDave Gerlach 	mutex_lock(&rproc_list_mutex);
1341d2e12e66SDave Gerlach 	list_add(&rproc->node, &rproc_list);
1342d2e12e66SDave Gerlach 	mutex_unlock(&rproc_list_mutex);
1343d2e12e66SDave Gerlach 
1344d2e12e66SDave Gerlach 	return 0;
1345400e64dfSOhad Ben-Cohen }
1346160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_add);
1347400e64dfSOhad Ben-Cohen 
1348400e64dfSOhad Ben-Cohen /**
1349b5ab5e24SOhad Ben-Cohen  * rproc_type_release() - release a remote processor instance
1350b5ab5e24SOhad Ben-Cohen  * @dev: the rproc's device
1351b5ab5e24SOhad Ben-Cohen  *
1352b5ab5e24SOhad Ben-Cohen  * This function should _never_ be called directly.
1353b5ab5e24SOhad Ben-Cohen  *
1354b5ab5e24SOhad Ben-Cohen  * It will be called by the driver core when no one holds a valid pointer
1355b5ab5e24SOhad Ben-Cohen  * to @dev anymore.
1356b5ab5e24SOhad Ben-Cohen  */
1357b5ab5e24SOhad Ben-Cohen static void rproc_type_release(struct device *dev)
1358b5ab5e24SOhad Ben-Cohen {
1359b5ab5e24SOhad Ben-Cohen 	struct rproc *rproc = container_of(dev, struct rproc, dev);
1360b5ab5e24SOhad Ben-Cohen 
13617183a2a7SOhad Ben-Cohen 	dev_info(&rproc->dev, "releasing %s\n", rproc->name);
13627183a2a7SOhad Ben-Cohen 
1363b5ab5e24SOhad Ben-Cohen 	idr_destroy(&rproc->notifyids);
1364b5ab5e24SOhad Ben-Cohen 
1365b5ab5e24SOhad Ben-Cohen 	if (rproc->index >= 0)
1366b5ab5e24SOhad Ben-Cohen 		ida_simple_remove(&rproc_dev_index, rproc->index);
1367b5ab5e24SOhad Ben-Cohen 
13680f57dc6aSMatt Redfearn 	kfree(rproc->firmware);
1369b5ab5e24SOhad Ben-Cohen 	kfree(rproc);
1370b5ab5e24SOhad Ben-Cohen }
1371b5ab5e24SOhad Ben-Cohen 
1372b5ab5e24SOhad Ben-Cohen static struct device_type rproc_type = {
1373b5ab5e24SOhad Ben-Cohen 	.name		= "remoteproc",
1374b5ab5e24SOhad Ben-Cohen 	.release	= rproc_type_release,
1375b5ab5e24SOhad Ben-Cohen };
1376400e64dfSOhad Ben-Cohen 
1377400e64dfSOhad Ben-Cohen /**
1378400e64dfSOhad Ben-Cohen  * rproc_alloc() - allocate a remote processor handle
1379400e64dfSOhad Ben-Cohen  * @dev: the underlying device
1380400e64dfSOhad Ben-Cohen  * @name: name of this remote processor
1381400e64dfSOhad Ben-Cohen  * @ops: platform-specific handlers (mainly start/stop)
13828b4aec9aSRobert Tivy  * @firmware: name of firmware file to load, can be NULL
1383400e64dfSOhad Ben-Cohen  * @len: length of private data needed by the rproc driver (in bytes)
1384400e64dfSOhad Ben-Cohen  *
1385400e64dfSOhad Ben-Cohen  * Allocates a new remote processor handle, but does not register
13868b4aec9aSRobert Tivy  * it yet. if @firmware is NULL, a default name is used.
1387400e64dfSOhad Ben-Cohen  *
1388400e64dfSOhad Ben-Cohen  * This function should be used by rproc implementations during initialization
1389400e64dfSOhad Ben-Cohen  * of the remote processor.
1390400e64dfSOhad Ben-Cohen  *
1391400e64dfSOhad Ben-Cohen  * After creating an rproc handle using this function, and when ready,
1392160e7c84SOhad Ben-Cohen  * implementations should then call rproc_add() to complete
1393400e64dfSOhad Ben-Cohen  * the registration of the remote processor.
1394400e64dfSOhad Ben-Cohen  *
1395400e64dfSOhad Ben-Cohen  * On success the new rproc is returned, and on failure, NULL.
1396400e64dfSOhad Ben-Cohen  *
1397400e64dfSOhad Ben-Cohen  * Note: _never_ directly deallocate @rproc, even if it was not registered
1398433c0e04SBjorn Andersson  * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
1399400e64dfSOhad Ben-Cohen  */
1400400e64dfSOhad Ben-Cohen struct rproc *rproc_alloc(struct device *dev, const char *name,
1401400e64dfSOhad Ben-Cohen 			  const struct rproc_ops *ops,
1402400e64dfSOhad Ben-Cohen 			  const char *firmware, int len)
1403400e64dfSOhad Ben-Cohen {
1404400e64dfSOhad Ben-Cohen 	struct rproc *rproc;
14058b4aec9aSRobert Tivy 	char *p, *template = "rproc-%s-fw";
14060f57dc6aSMatt Redfearn 	int name_len;
1407400e64dfSOhad Ben-Cohen 
1408400e64dfSOhad Ben-Cohen 	if (!dev || !name || !ops)
1409400e64dfSOhad Ben-Cohen 		return NULL;
1410400e64dfSOhad Ben-Cohen 
14110f57dc6aSMatt Redfearn 	if (!firmware) {
14128b4aec9aSRobert Tivy 		/*
14138b4aec9aSRobert Tivy 		 * If the caller didn't pass in a firmware name then
14140f57dc6aSMatt Redfearn 		 * construct a default name.
14158b4aec9aSRobert Tivy 		 */
14168b4aec9aSRobert Tivy 		name_len = strlen(name) + strlen(template) - 2 + 1;
14170f57dc6aSMatt Redfearn 		p = kmalloc(name_len, GFP_KERNEL);
14180f57dc6aSMatt Redfearn 		if (!p)
1419400e64dfSOhad Ben-Cohen 			return NULL;
14208b4aec9aSRobert Tivy 		snprintf(p, name_len, template, name);
14218b4aec9aSRobert Tivy 	} else {
14220f57dc6aSMatt Redfearn 		p = kstrdup(firmware, GFP_KERNEL);
14230f57dc6aSMatt Redfearn 		if (!p)
14240f57dc6aSMatt Redfearn 			return NULL;
14250f57dc6aSMatt Redfearn 	}
14260f57dc6aSMatt Redfearn 
14270f57dc6aSMatt Redfearn 	rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
14280f57dc6aSMatt Redfearn 	if (!rproc) {
14290f57dc6aSMatt Redfearn 		kfree(p);
14300f57dc6aSMatt Redfearn 		return NULL;
14318b4aec9aSRobert Tivy 	}
14328b4aec9aSRobert Tivy 
14338b4aec9aSRobert Tivy 	rproc->firmware = p;
1434400e64dfSOhad Ben-Cohen 	rproc->name = name;
1435400e64dfSOhad Ben-Cohen 	rproc->ops = ops;
1436400e64dfSOhad Ben-Cohen 	rproc->priv = &rproc[1];
1437ddf71187SBjorn Andersson 	rproc->auto_boot = true;
1438400e64dfSOhad Ben-Cohen 
1439b5ab5e24SOhad Ben-Cohen 	device_initialize(&rproc->dev);
1440b5ab5e24SOhad Ben-Cohen 	rproc->dev.parent = dev;
1441b5ab5e24SOhad Ben-Cohen 	rproc->dev.type = &rproc_type;
14422aefbef0SMatt Redfearn 	rproc->dev.class = &rproc_class;
1443b5ab5e24SOhad Ben-Cohen 
1444b5ab5e24SOhad Ben-Cohen 	/* Assign a unique device index and name */
1445b5ab5e24SOhad Ben-Cohen 	rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1446b5ab5e24SOhad Ben-Cohen 	if (rproc->index < 0) {
1447b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1448b5ab5e24SOhad Ben-Cohen 		put_device(&rproc->dev);
1449b5ab5e24SOhad Ben-Cohen 		return NULL;
1450b5ab5e24SOhad Ben-Cohen 	}
1451b5ab5e24SOhad Ben-Cohen 
1452b5ab5e24SOhad Ben-Cohen 	dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1453b5ab5e24SOhad Ben-Cohen 
1454400e64dfSOhad Ben-Cohen 	atomic_set(&rproc->power, 0);
1455400e64dfSOhad Ben-Cohen 
14564afc89d6SSjur Brændeland 	/* Set ELF as the default fw_ops handler */
14574afc89d6SSjur Brændeland 	rproc->fw_ops = &rproc_elf_fw_ops;
1458400e64dfSOhad Ben-Cohen 
1459400e64dfSOhad Ben-Cohen 	mutex_init(&rproc->lock);
1460400e64dfSOhad Ben-Cohen 
14617a186941SOhad Ben-Cohen 	idr_init(&rproc->notifyids);
14627a186941SOhad Ben-Cohen 
1463400e64dfSOhad Ben-Cohen 	INIT_LIST_HEAD(&rproc->carveouts);
1464400e64dfSOhad Ben-Cohen 	INIT_LIST_HEAD(&rproc->mappings);
1465400e64dfSOhad Ben-Cohen 	INIT_LIST_HEAD(&rproc->traces);
14667a186941SOhad Ben-Cohen 	INIT_LIST_HEAD(&rproc->rvdevs);
14677bdc9650SBjorn Andersson 	INIT_LIST_HEAD(&rproc->subdevs);
1468400e64dfSOhad Ben-Cohen 
14698afd519cSFernando Guzman Lugo 	INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work);
147070b85ef8SFernando Guzman Lugo 	init_completion(&rproc->crash_comp);
14718afd519cSFernando Guzman Lugo 
1472400e64dfSOhad Ben-Cohen 	rproc->state = RPROC_OFFLINE;
1473400e64dfSOhad Ben-Cohen 
1474400e64dfSOhad Ben-Cohen 	return rproc;
1475400e64dfSOhad Ben-Cohen }
1476400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_alloc);
1477400e64dfSOhad Ben-Cohen 
1478400e64dfSOhad Ben-Cohen /**
1479433c0e04SBjorn Andersson  * rproc_free() - unroll rproc_alloc()
1480433c0e04SBjorn Andersson  * @rproc: the remote processor handle
1481433c0e04SBjorn Andersson  *
1482433c0e04SBjorn Andersson  * This function decrements the rproc dev refcount.
1483433c0e04SBjorn Andersson  *
1484433c0e04SBjorn Andersson  * If no one holds any reference to rproc anymore, then its refcount would
1485433c0e04SBjorn Andersson  * now drop to zero, and it would be freed.
1486433c0e04SBjorn Andersson  */
1487433c0e04SBjorn Andersson void rproc_free(struct rproc *rproc)
1488433c0e04SBjorn Andersson {
1489433c0e04SBjorn Andersson 	put_device(&rproc->dev);
1490433c0e04SBjorn Andersson }
1491433c0e04SBjorn Andersson EXPORT_SYMBOL(rproc_free);
1492433c0e04SBjorn Andersson 
1493433c0e04SBjorn Andersson /**
1494433c0e04SBjorn Andersson  * rproc_put() - release rproc reference
1495400e64dfSOhad Ben-Cohen  * @rproc: the remote processor handle
1496400e64dfSOhad Ben-Cohen  *
1497c6b5a276SOhad Ben-Cohen  * This function decrements the rproc dev refcount.
1498400e64dfSOhad Ben-Cohen  *
1499c6b5a276SOhad Ben-Cohen  * If no one holds any reference to rproc anymore, then its refcount would
1500c6b5a276SOhad Ben-Cohen  * now drop to zero, and it would be freed.
1501400e64dfSOhad Ben-Cohen  */
1502160e7c84SOhad Ben-Cohen void rproc_put(struct rproc *rproc)
1503400e64dfSOhad Ben-Cohen {
1504fbb6aacbSBjorn Andersson 	module_put(rproc->dev.parent->driver->owner);
1505b5ab5e24SOhad Ben-Cohen 	put_device(&rproc->dev);
1506400e64dfSOhad Ben-Cohen }
1507160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_put);
1508400e64dfSOhad Ben-Cohen 
1509400e64dfSOhad Ben-Cohen /**
1510160e7c84SOhad Ben-Cohen  * rproc_del() - unregister a remote processor
1511400e64dfSOhad Ben-Cohen  * @rproc: rproc handle to unregister
1512400e64dfSOhad Ben-Cohen  *
1513400e64dfSOhad Ben-Cohen  * This function should be called when the platform specific rproc
1514400e64dfSOhad Ben-Cohen  * implementation decides to remove the rproc device. it should
1515160e7c84SOhad Ben-Cohen  * _only_ be called if a previous invocation of rproc_add()
1516400e64dfSOhad Ben-Cohen  * has completed successfully.
1517400e64dfSOhad Ben-Cohen  *
1518160e7c84SOhad Ben-Cohen  * After rproc_del() returns, @rproc isn't freed yet, because
1519c6b5a276SOhad Ben-Cohen  * of the outstanding reference created by rproc_alloc. To decrement that
1520433c0e04SBjorn Andersson  * one last refcount, one still needs to call rproc_free().
1521400e64dfSOhad Ben-Cohen  *
1522400e64dfSOhad Ben-Cohen  * Returns 0 on success and -EINVAL if @rproc isn't valid.
1523400e64dfSOhad Ben-Cohen  */
1524160e7c84SOhad Ben-Cohen int rproc_del(struct rproc *rproc)
1525400e64dfSOhad Ben-Cohen {
1526400e64dfSOhad Ben-Cohen 	if (!rproc)
1527400e64dfSOhad Ben-Cohen 		return -EINVAL;
1528400e64dfSOhad Ben-Cohen 
1529ddf71187SBjorn Andersson 	/* if rproc is marked always-on, rproc_add() booted it */
1530ddf71187SBjorn Andersson 	/* TODO: make sure this works with rproc->power > 1 */
1531ddf71187SBjorn Andersson 	if (rproc->auto_boot)
1532ddf71187SBjorn Andersson 		rproc_shutdown(rproc);
1533ddf71187SBjorn Andersson 
15342099c77dSSarangdhar Joshi 	mutex_lock(&rproc->lock);
15352099c77dSSarangdhar Joshi 	rproc->state = RPROC_DELETED;
15362099c77dSSarangdhar Joshi 	mutex_unlock(&rproc->lock);
15372099c77dSSarangdhar Joshi 
1538b003d45bSSarangdhar Joshi 	rproc_delete_debug_dir(rproc);
1539b003d45bSSarangdhar Joshi 
1540fec47d86SDave Gerlach 	/* the rproc is downref'ed as soon as it's removed from the klist */
1541fec47d86SDave Gerlach 	mutex_lock(&rproc_list_mutex);
1542fec47d86SDave Gerlach 	list_del(&rproc->node);
1543fec47d86SDave Gerlach 	mutex_unlock(&rproc_list_mutex);
1544fec47d86SDave Gerlach 
1545b5ab5e24SOhad Ben-Cohen 	device_del(&rproc->dev);
1546400e64dfSOhad Ben-Cohen 
1547400e64dfSOhad Ben-Cohen 	return 0;
1548400e64dfSOhad Ben-Cohen }
1549160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_del);
1550400e64dfSOhad Ben-Cohen 
15518afd519cSFernando Guzman Lugo /**
15527bdc9650SBjorn Andersson  * rproc_add_subdev() - add a subdevice to a remoteproc
15537bdc9650SBjorn Andersson  * @rproc: rproc handle to add the subdevice to
15547bdc9650SBjorn Andersson  * @subdev: subdev handle to register
15557bdc9650SBjorn Andersson  * @probe: function to call when the rproc boots
15567bdc9650SBjorn Andersson  * @remove: function to call when the rproc shuts down
15577bdc9650SBjorn Andersson  */
15587bdc9650SBjorn Andersson void rproc_add_subdev(struct rproc *rproc,
15597bdc9650SBjorn Andersson 		      struct rproc_subdev *subdev,
15607bdc9650SBjorn Andersson 		      int (*probe)(struct rproc_subdev *subdev),
15617bdc9650SBjorn Andersson 		      void (*remove)(struct rproc_subdev *subdev))
15627bdc9650SBjorn Andersson {
15637bdc9650SBjorn Andersson 	subdev->probe = probe;
15647bdc9650SBjorn Andersson 	subdev->remove = remove;
15657bdc9650SBjorn Andersson 
15667bdc9650SBjorn Andersson 	list_add_tail(&subdev->node, &rproc->subdevs);
15677bdc9650SBjorn Andersson }
15687bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_add_subdev);
15697bdc9650SBjorn Andersson 
15707bdc9650SBjorn Andersson /**
15717bdc9650SBjorn Andersson  * rproc_remove_subdev() - remove a subdevice from a remoteproc
15727bdc9650SBjorn Andersson  * @rproc: rproc handle to remove the subdevice from
15737bdc9650SBjorn Andersson  * @subdev: subdev handle, previously registered with rproc_add_subdev()
15747bdc9650SBjorn Andersson  */
15757bdc9650SBjorn Andersson void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev)
15767bdc9650SBjorn Andersson {
15777bdc9650SBjorn Andersson 	list_del(&subdev->node);
15787bdc9650SBjorn Andersson }
15797bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_remove_subdev);
15807bdc9650SBjorn Andersson 
15817bdc9650SBjorn Andersson /**
15828afd519cSFernando Guzman Lugo  * rproc_report_crash() - rproc crash reporter function
15838afd519cSFernando Guzman Lugo  * @rproc: remote processor
15848afd519cSFernando Guzman Lugo  * @type: crash type
15858afd519cSFernando Guzman Lugo  *
15868afd519cSFernando Guzman Lugo  * This function must be called every time a crash is detected by the low-level
15878afd519cSFernando Guzman Lugo  * drivers implementing a specific remoteproc. This should not be called from a
15888afd519cSFernando Guzman Lugo  * non-remoteproc driver.
15898afd519cSFernando Guzman Lugo  *
15908afd519cSFernando Guzman Lugo  * This function can be called from atomic/interrupt context.
15918afd519cSFernando Guzman Lugo  */
15928afd519cSFernando Guzman Lugo void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type)
15938afd519cSFernando Guzman Lugo {
15948afd519cSFernando Guzman Lugo 	if (!rproc) {
15958afd519cSFernando Guzman Lugo 		pr_err("NULL rproc pointer\n");
15968afd519cSFernando Guzman Lugo 		return;
15978afd519cSFernando Guzman Lugo 	}
15988afd519cSFernando Guzman Lugo 
15998afd519cSFernando Guzman Lugo 	dev_err(&rproc->dev, "crash detected in %s: type %s\n",
16008afd519cSFernando Guzman Lugo 		rproc->name, rproc_crash_to_string(type));
16018afd519cSFernando Guzman Lugo 
16028afd519cSFernando Guzman Lugo 	/* create a new task to handle the error */
16038afd519cSFernando Guzman Lugo 	schedule_work(&rproc->crash_handler);
16048afd519cSFernando Guzman Lugo }
16058afd519cSFernando Guzman Lugo EXPORT_SYMBOL(rproc_report_crash);
16068afd519cSFernando Guzman Lugo 
1607400e64dfSOhad Ben-Cohen static int __init remoteproc_init(void)
1608400e64dfSOhad Ben-Cohen {
16092aefbef0SMatt Redfearn 	rproc_init_sysfs();
1610400e64dfSOhad Ben-Cohen 	rproc_init_debugfs();
1611b5ab5e24SOhad Ben-Cohen 
1612400e64dfSOhad Ben-Cohen 	return 0;
1613400e64dfSOhad Ben-Cohen }
1614400e64dfSOhad Ben-Cohen module_init(remoteproc_init);
1615400e64dfSOhad Ben-Cohen 
1616400e64dfSOhad Ben-Cohen static void __exit remoteproc_exit(void)
1617400e64dfSOhad Ben-Cohen {
1618f42f79afSSuman Anna 	ida_destroy(&rproc_dev_index);
1619f42f79afSSuman Anna 
1620400e64dfSOhad Ben-Cohen 	rproc_exit_debugfs();
16212aefbef0SMatt Redfearn 	rproc_exit_sysfs();
1622400e64dfSOhad Ben-Cohen }
1623400e64dfSOhad Ben-Cohen module_exit(remoteproc_exit);
1624400e64dfSOhad Ben-Cohen 
1625400e64dfSOhad Ben-Cohen MODULE_LICENSE("GPL v2");
1626400e64dfSOhad Ben-Cohen MODULE_DESCRIPTION("Generic Remote Processor Framework");
1627