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/klist.h>
40400e64dfSOhad Ben-Cohen #include <linux/elf.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 
47400e64dfSOhad Ben-Cohen static void klist_rproc_get(struct klist_node *n);
48400e64dfSOhad Ben-Cohen static void klist_rproc_put(struct klist_node *n);
49400e64dfSOhad Ben-Cohen 
50400e64dfSOhad Ben-Cohen /*
51400e64dfSOhad Ben-Cohen  * klist of the available remote processors.
52400e64dfSOhad Ben-Cohen  *
53400e64dfSOhad Ben-Cohen  * We need this in order to support name-based lookups (needed by the
54400e64dfSOhad Ben-Cohen  * rproc_get_by_name()).
55400e64dfSOhad Ben-Cohen  *
567a186941SOhad Ben-Cohen  * That said, we don't use rproc_get_by_name() at this point.
577a186941SOhad Ben-Cohen  * The use cases that do require its existence should be
58400e64dfSOhad Ben-Cohen  * scrutinized, and hopefully migrated to rproc_boot() using device-based
59400e64dfSOhad Ben-Cohen  * binding.
60400e64dfSOhad Ben-Cohen  *
61400e64dfSOhad Ben-Cohen  * If/when this materializes, we could drop the klist (and the by_name
62400e64dfSOhad Ben-Cohen  * API).
63400e64dfSOhad Ben-Cohen  */
64400e64dfSOhad Ben-Cohen static DEFINE_KLIST(rprocs, klist_rproc_get, klist_rproc_put);
65400e64dfSOhad Ben-Cohen 
66400e64dfSOhad Ben-Cohen typedef int (*rproc_handle_resources_t)(struct rproc *rproc,
67fd2c15ecSOhad Ben-Cohen 				struct resource_table *table, int len);
68fd2c15ecSOhad Ben-Cohen typedef int (*rproc_handle_resource_t)(struct rproc *rproc, void *, int avail);
69400e64dfSOhad Ben-Cohen 
70b5ab5e24SOhad Ben-Cohen /* Unique indices for remoteproc devices */
71b5ab5e24SOhad Ben-Cohen static DEFINE_IDA(rproc_dev_index);
72b5ab5e24SOhad Ben-Cohen 
73400e64dfSOhad Ben-Cohen /*
74400e64dfSOhad Ben-Cohen  * This is the IOMMU fault handler we register with the IOMMU API
75400e64dfSOhad Ben-Cohen  * (when relevant; not all remote processors access memory through
76400e64dfSOhad Ben-Cohen  * an IOMMU).
77400e64dfSOhad Ben-Cohen  *
78400e64dfSOhad Ben-Cohen  * IOMMU core will invoke this handler whenever the remote processor
79400e64dfSOhad Ben-Cohen  * will try to access an unmapped device address.
80400e64dfSOhad Ben-Cohen  *
81400e64dfSOhad Ben-Cohen  * Currently this is mostly a stub, but it will be later used to trigger
82400e64dfSOhad Ben-Cohen  * the recovery of the remote processor.
83400e64dfSOhad Ben-Cohen  */
84400e64dfSOhad Ben-Cohen static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev,
8577ca2332SOhad Ben-Cohen 		unsigned long iova, int flags, void *token)
86400e64dfSOhad Ben-Cohen {
87400e64dfSOhad Ben-Cohen 	dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags);
88400e64dfSOhad Ben-Cohen 
89400e64dfSOhad Ben-Cohen 	/*
90400e64dfSOhad Ben-Cohen 	 * Let the iommu core know we're not really handling this fault;
91400e64dfSOhad Ben-Cohen 	 * we just plan to use this 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 
102400e64dfSOhad Ben-Cohen 	/*
103400e64dfSOhad Ben-Cohen 	 * We currently use iommu_present() to decide if an IOMMU
104400e64dfSOhad Ben-Cohen 	 * setup is needed.
105400e64dfSOhad Ben-Cohen 	 *
106400e64dfSOhad Ben-Cohen 	 * This works for simple cases, but will easily fail with
107400e64dfSOhad Ben-Cohen 	 * platforms that do have an IOMMU, but not for this specific
108400e64dfSOhad Ben-Cohen 	 * rproc.
109400e64dfSOhad Ben-Cohen 	 *
110400e64dfSOhad Ben-Cohen 	 * This will be easily solved by introducing hw capabilities
111400e64dfSOhad Ben-Cohen 	 * that will be set by the remoteproc driver.
112400e64dfSOhad Ben-Cohen 	 */
113400e64dfSOhad Ben-Cohen 	if (!iommu_present(dev->bus)) {
1140798e1daSMark Grosen 		dev_dbg(dev, "iommu not found\n");
1150798e1daSMark Grosen 		return 0;
116400e64dfSOhad Ben-Cohen 	}
117400e64dfSOhad Ben-Cohen 
118400e64dfSOhad Ben-Cohen 	domain = iommu_domain_alloc(dev->bus);
119400e64dfSOhad Ben-Cohen 	if (!domain) {
120400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't alloc iommu domain\n");
121400e64dfSOhad Ben-Cohen 		return -ENOMEM;
122400e64dfSOhad Ben-Cohen 	}
123400e64dfSOhad Ben-Cohen 
12477ca2332SOhad Ben-Cohen 	iommu_set_fault_handler(domain, rproc_iommu_fault, rproc);
125400e64dfSOhad Ben-Cohen 
126400e64dfSOhad Ben-Cohen 	ret = iommu_attach_device(domain, dev);
127400e64dfSOhad Ben-Cohen 	if (ret) {
128400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't attach iommu device: %d\n", ret);
129400e64dfSOhad Ben-Cohen 		goto free_domain;
130400e64dfSOhad Ben-Cohen 	}
131400e64dfSOhad Ben-Cohen 
132400e64dfSOhad Ben-Cohen 	rproc->domain = domain;
133400e64dfSOhad Ben-Cohen 
134400e64dfSOhad Ben-Cohen 	return 0;
135400e64dfSOhad Ben-Cohen 
136400e64dfSOhad Ben-Cohen free_domain:
137400e64dfSOhad Ben-Cohen 	iommu_domain_free(domain);
138400e64dfSOhad Ben-Cohen 	return ret;
139400e64dfSOhad Ben-Cohen }
140400e64dfSOhad Ben-Cohen 
141400e64dfSOhad Ben-Cohen static void rproc_disable_iommu(struct rproc *rproc)
142400e64dfSOhad Ben-Cohen {
143400e64dfSOhad Ben-Cohen 	struct iommu_domain *domain = rproc->domain;
144b5ab5e24SOhad Ben-Cohen 	struct device *dev = rproc->dev.parent;
145400e64dfSOhad Ben-Cohen 
146400e64dfSOhad Ben-Cohen 	if (!domain)
147400e64dfSOhad Ben-Cohen 		return;
148400e64dfSOhad Ben-Cohen 
149400e64dfSOhad Ben-Cohen 	iommu_detach_device(domain, dev);
150400e64dfSOhad Ben-Cohen 	iommu_domain_free(domain);
151400e64dfSOhad Ben-Cohen 
152400e64dfSOhad Ben-Cohen 	return;
153400e64dfSOhad Ben-Cohen }
154400e64dfSOhad Ben-Cohen 
155400e64dfSOhad Ben-Cohen /*
156400e64dfSOhad Ben-Cohen  * Some remote processors will ask us to allocate them physically contiguous
157400e64dfSOhad Ben-Cohen  * memory regions (which we call "carveouts"), and map them to specific
158400e64dfSOhad Ben-Cohen  * device addresses (which are hardcoded in the firmware).
159400e64dfSOhad Ben-Cohen  *
160400e64dfSOhad Ben-Cohen  * They may then ask us to copy objects into specific device addresses (e.g.
161400e64dfSOhad Ben-Cohen  * code/data sections) or expose us certain symbols in other device address
162400e64dfSOhad Ben-Cohen  * (e.g. their trace buffer).
163400e64dfSOhad Ben-Cohen  *
164400e64dfSOhad Ben-Cohen  * This function is an internal helper with which we can go over the allocated
165400e64dfSOhad Ben-Cohen  * carveouts and translate specific device address to kernel virtual addresses
166400e64dfSOhad Ben-Cohen  * so we can access the referenced memory.
167400e64dfSOhad Ben-Cohen  *
168400e64dfSOhad Ben-Cohen  * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too,
169400e64dfSOhad Ben-Cohen  * but only on kernel direct mapped RAM memory. Instead, we're just using
170400e64dfSOhad Ben-Cohen  * here the output of the DMA API, which should be more correct.
171400e64dfSOhad Ben-Cohen  */
172400e64dfSOhad Ben-Cohen static void *rproc_da_to_va(struct rproc *rproc, u64 da, int len)
173400e64dfSOhad Ben-Cohen {
174400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *carveout;
175400e64dfSOhad Ben-Cohen 	void *ptr = NULL;
176400e64dfSOhad Ben-Cohen 
177400e64dfSOhad Ben-Cohen 	list_for_each_entry(carveout, &rproc->carveouts, node) {
178400e64dfSOhad Ben-Cohen 		int offset = da - carveout->da;
179400e64dfSOhad Ben-Cohen 
180400e64dfSOhad Ben-Cohen 		/* try next carveout if da is too small */
181400e64dfSOhad Ben-Cohen 		if (offset < 0)
182400e64dfSOhad Ben-Cohen 			continue;
183400e64dfSOhad Ben-Cohen 
184400e64dfSOhad Ben-Cohen 		/* try next carveout if da is too large */
185400e64dfSOhad Ben-Cohen 		if (offset + len > carveout->len)
186400e64dfSOhad Ben-Cohen 			continue;
187400e64dfSOhad Ben-Cohen 
188400e64dfSOhad Ben-Cohen 		ptr = carveout->va + offset;
189400e64dfSOhad Ben-Cohen 
190400e64dfSOhad Ben-Cohen 		break;
191400e64dfSOhad Ben-Cohen 	}
192400e64dfSOhad Ben-Cohen 
193400e64dfSOhad Ben-Cohen 	return ptr;
194400e64dfSOhad Ben-Cohen }
195400e64dfSOhad Ben-Cohen 
196400e64dfSOhad Ben-Cohen /**
197400e64dfSOhad Ben-Cohen  * rproc_load_segments() - load firmware segments to memory
198400e64dfSOhad Ben-Cohen  * @rproc: remote processor which will be booted using these fw segments
199400e64dfSOhad Ben-Cohen  * @elf_data: the content of the ELF firmware image
2009bc91231SOhad Ben-Cohen  * @len: firmware size (in bytes)
201400e64dfSOhad Ben-Cohen  *
202400e64dfSOhad Ben-Cohen  * This function loads the firmware segments to memory, where the remote
203400e64dfSOhad Ben-Cohen  * processor expects them.
204400e64dfSOhad Ben-Cohen  *
205400e64dfSOhad Ben-Cohen  * Some remote processors will expect their code and data to be placed
206400e64dfSOhad Ben-Cohen  * in specific device addresses, and can't have them dynamically assigned.
207400e64dfSOhad Ben-Cohen  *
208400e64dfSOhad Ben-Cohen  * We currently support only those kind of remote processors, and expect
209400e64dfSOhad Ben-Cohen  * the program header's paddr member to contain those addresses. We then go
210400e64dfSOhad Ben-Cohen  * through the physically contiguous "carveout" memory regions which we
211400e64dfSOhad Ben-Cohen  * allocated (and mapped) earlier on behalf of the remote processor,
212400e64dfSOhad Ben-Cohen  * and "translate" device address to kernel addresses, so we can copy the
213400e64dfSOhad Ben-Cohen  * segments where they are expected.
214400e64dfSOhad Ben-Cohen  *
215400e64dfSOhad Ben-Cohen  * Currently we only support remote processors that required carveout
216400e64dfSOhad Ben-Cohen  * allocations and got them mapped onto their iommus. Some processors
217400e64dfSOhad Ben-Cohen  * might be different: they might not have iommus, and would prefer to
218400e64dfSOhad Ben-Cohen  * directly allocate memory for every segment/resource. This is not yet
219400e64dfSOhad Ben-Cohen  * supported, though.
220400e64dfSOhad Ben-Cohen  */
2219bc91231SOhad Ben-Cohen static int
2229bc91231SOhad Ben-Cohen rproc_load_segments(struct rproc *rproc, const u8 *elf_data, size_t len)
223400e64dfSOhad Ben-Cohen {
224b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
225400e64dfSOhad Ben-Cohen 	struct elf32_hdr *ehdr;
226400e64dfSOhad Ben-Cohen 	struct elf32_phdr *phdr;
227400e64dfSOhad Ben-Cohen 	int i, ret = 0;
228400e64dfSOhad Ben-Cohen 
229400e64dfSOhad Ben-Cohen 	ehdr = (struct elf32_hdr *)elf_data;
230400e64dfSOhad Ben-Cohen 	phdr = (struct elf32_phdr *)(elf_data + ehdr->e_phoff);
231400e64dfSOhad Ben-Cohen 
232400e64dfSOhad Ben-Cohen 	/* go through the available ELF segments */
233400e64dfSOhad Ben-Cohen 	for (i = 0; i < ehdr->e_phnum; i++, phdr++) {
234400e64dfSOhad Ben-Cohen 		u32 da = phdr->p_paddr;
235400e64dfSOhad Ben-Cohen 		u32 memsz = phdr->p_memsz;
236400e64dfSOhad Ben-Cohen 		u32 filesz = phdr->p_filesz;
2379bc91231SOhad Ben-Cohen 		u32 offset = phdr->p_offset;
238400e64dfSOhad Ben-Cohen 		void *ptr;
239400e64dfSOhad Ben-Cohen 
240400e64dfSOhad Ben-Cohen 		if (phdr->p_type != PT_LOAD)
241400e64dfSOhad Ben-Cohen 			continue;
242400e64dfSOhad Ben-Cohen 
243400e64dfSOhad Ben-Cohen 		dev_dbg(dev, "phdr: type %d da 0x%x memsz 0x%x filesz 0x%x\n",
244400e64dfSOhad Ben-Cohen 					phdr->p_type, da, memsz, filesz);
245400e64dfSOhad Ben-Cohen 
246400e64dfSOhad Ben-Cohen 		if (filesz > memsz) {
247400e64dfSOhad Ben-Cohen 			dev_err(dev, "bad phdr filesz 0x%x memsz 0x%x\n",
248400e64dfSOhad Ben-Cohen 							filesz, memsz);
249400e64dfSOhad Ben-Cohen 			ret = -EINVAL;
250400e64dfSOhad Ben-Cohen 			break;
251400e64dfSOhad Ben-Cohen 		}
252400e64dfSOhad Ben-Cohen 
2539bc91231SOhad Ben-Cohen 		if (offset + filesz > len) {
2549bc91231SOhad Ben-Cohen 			dev_err(dev, "truncated fw: need 0x%x avail 0x%x\n",
2559bc91231SOhad Ben-Cohen 					offset + filesz, len);
2569bc91231SOhad Ben-Cohen 			ret = -EINVAL;
2579bc91231SOhad Ben-Cohen 			break;
2589bc91231SOhad Ben-Cohen 		}
2599bc91231SOhad Ben-Cohen 
260400e64dfSOhad Ben-Cohen 		/* grab the kernel address for this device address */
261400e64dfSOhad Ben-Cohen 		ptr = rproc_da_to_va(rproc, da, memsz);
262400e64dfSOhad Ben-Cohen 		if (!ptr) {
263400e64dfSOhad Ben-Cohen 			dev_err(dev, "bad phdr da 0x%x mem 0x%x\n", da, memsz);
264400e64dfSOhad Ben-Cohen 			ret = -EINVAL;
265400e64dfSOhad Ben-Cohen 			break;
266400e64dfSOhad Ben-Cohen 		}
267400e64dfSOhad Ben-Cohen 
268400e64dfSOhad Ben-Cohen 		/* put the segment where the remote processor expects it */
269400e64dfSOhad Ben-Cohen 		if (phdr->p_filesz)
270400e64dfSOhad Ben-Cohen 			memcpy(ptr, elf_data + phdr->p_offset, filesz);
271400e64dfSOhad Ben-Cohen 
272400e64dfSOhad Ben-Cohen 		/*
273400e64dfSOhad Ben-Cohen 		 * Zero out remaining memory for this segment.
274400e64dfSOhad Ben-Cohen 		 *
275400e64dfSOhad Ben-Cohen 		 * This isn't strictly required since dma_alloc_coherent already
276400e64dfSOhad Ben-Cohen 		 * did this for us. albeit harmless, we may consider removing
277400e64dfSOhad Ben-Cohen 		 * this.
278400e64dfSOhad Ben-Cohen 		 */
279400e64dfSOhad Ben-Cohen 		if (memsz > filesz)
280400e64dfSOhad Ben-Cohen 			memset(ptr + filesz, 0, memsz - filesz);
281400e64dfSOhad Ben-Cohen 	}
282400e64dfSOhad Ben-Cohen 
283400e64dfSOhad Ben-Cohen 	return ret;
284400e64dfSOhad Ben-Cohen }
285400e64dfSOhad Ben-Cohen 
2866db20ea8SOhad Ben-Cohen int rproc_alloc_vring(struct rproc_vdev *rvdev, int i)
2876db20ea8SOhad Ben-Cohen {
2886db20ea8SOhad Ben-Cohen 	struct rproc *rproc = rvdev->rproc;
289b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
2906db20ea8SOhad Ben-Cohen 	struct rproc_vring *rvring = &rvdev->vring[i];
2916db20ea8SOhad Ben-Cohen 	dma_addr_t dma;
2926db20ea8SOhad Ben-Cohen 	void *va;
2936db20ea8SOhad Ben-Cohen 	int ret, size, notifyid;
2946db20ea8SOhad Ben-Cohen 
2956db20ea8SOhad Ben-Cohen 	/* actual size of vring (in bytes) */
2966db20ea8SOhad Ben-Cohen 	size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
2976db20ea8SOhad Ben-Cohen 
2986db20ea8SOhad Ben-Cohen 	if (!idr_pre_get(&rproc->notifyids, GFP_KERNEL)) {
2996db20ea8SOhad Ben-Cohen 		dev_err(dev, "idr_pre_get failed\n");
3006db20ea8SOhad Ben-Cohen 		return -ENOMEM;
3016db20ea8SOhad Ben-Cohen 	}
3026db20ea8SOhad Ben-Cohen 
3036db20ea8SOhad Ben-Cohen 	/*
3046db20ea8SOhad Ben-Cohen 	 * Allocate non-cacheable memory for the vring. In the future
3056db20ea8SOhad Ben-Cohen 	 * this call will also configure the IOMMU for us
3066db20ea8SOhad Ben-Cohen 	 * TODO: let the rproc know the da of this vring
3076db20ea8SOhad Ben-Cohen 	 */
308b5ab5e24SOhad Ben-Cohen 	va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL);
3096db20ea8SOhad Ben-Cohen 	if (!va) {
310b5ab5e24SOhad Ben-Cohen 		dev_err(dev->parent, "dma_alloc_coherent failed\n");
3116db20ea8SOhad Ben-Cohen 		return -EINVAL;
3126db20ea8SOhad Ben-Cohen 	}
3136db20ea8SOhad Ben-Cohen 
3146db20ea8SOhad Ben-Cohen 	/*
3156db20ea8SOhad Ben-Cohen 	 * Assign an rproc-wide unique index for this vring
3166db20ea8SOhad Ben-Cohen 	 * TODO: assign a notifyid for rvdev updates as well
3176db20ea8SOhad Ben-Cohen 	 * TODO: let the rproc know the notifyid of this vring
3186db20ea8SOhad Ben-Cohen 	 * TODO: support predefined notifyids (via resource table)
3196db20ea8SOhad Ben-Cohen 	 */
3206db20ea8SOhad Ben-Cohen 	ret = idr_get_new(&rproc->notifyids, rvring, &notifyid);
3216db20ea8SOhad Ben-Cohen 	if (ret) {
3226db20ea8SOhad Ben-Cohen 		dev_err(dev, "idr_get_new failed: %d\n", ret);
323b5ab5e24SOhad Ben-Cohen 		dma_free_coherent(dev->parent, size, va, dma);
3246db20ea8SOhad Ben-Cohen 		return ret;
3256db20ea8SOhad Ben-Cohen 	}
3266db20ea8SOhad Ben-Cohen 
3276db20ea8SOhad Ben-Cohen 	dev_dbg(dev, "vring%d: va %p dma %x size %x idr %d\n", i, va,
3286db20ea8SOhad Ben-Cohen 					dma, size, notifyid);
3296db20ea8SOhad Ben-Cohen 
3306db20ea8SOhad Ben-Cohen 	rvring->va = va;
3316db20ea8SOhad Ben-Cohen 	rvring->dma = dma;
3326db20ea8SOhad Ben-Cohen 	rvring->notifyid = notifyid;
3336db20ea8SOhad Ben-Cohen 
3346db20ea8SOhad Ben-Cohen 	return 0;
3356db20ea8SOhad Ben-Cohen }
3366db20ea8SOhad Ben-Cohen 
3377a186941SOhad Ben-Cohen static int
3386db20ea8SOhad Ben-Cohen rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i)
339400e64dfSOhad Ben-Cohen {
3407a186941SOhad Ben-Cohen 	struct rproc *rproc = rvdev->rproc;
341b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
3427a186941SOhad Ben-Cohen 	struct fw_rsc_vdev_vring *vring = &rsc->vring[i];
3436db20ea8SOhad Ben-Cohen 	struct rproc_vring *rvring = &rvdev->vring[i];
344400e64dfSOhad Ben-Cohen 
3457a186941SOhad Ben-Cohen 	dev_dbg(dev, "vdev rsc: vring%d: da %x, qsz %d, align %d\n",
3467a186941SOhad Ben-Cohen 				i, vring->da, vring->num, vring->align);
3477a186941SOhad Ben-Cohen 
3487a186941SOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
3497a186941SOhad Ben-Cohen 	if (vring->reserved) {
3507a186941SOhad Ben-Cohen 		dev_err(dev, "vring rsc has non zero reserved bytes\n");
351fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
352fd2c15ecSOhad Ben-Cohen 	}
353fd2c15ecSOhad Ben-Cohen 
35463140e0eSOhad Ben-Cohen 	/* verify queue size and vring alignment are sane */
35563140e0eSOhad Ben-Cohen 	if (!vring->num || !vring->align) {
35663140e0eSOhad Ben-Cohen 		dev_err(dev, "invalid qsz (%d) or alignment (%d)\n",
35763140e0eSOhad Ben-Cohen 						vring->num, vring->align);
358400e64dfSOhad Ben-Cohen 		return -EINVAL;
359400e64dfSOhad Ben-Cohen 	}
360400e64dfSOhad Ben-Cohen 
3616db20ea8SOhad Ben-Cohen 	rvring->len = vring->num;
3626db20ea8SOhad Ben-Cohen 	rvring->align = vring->align;
3636db20ea8SOhad Ben-Cohen 	rvring->rvdev = rvdev;
364400e64dfSOhad Ben-Cohen 
365400e64dfSOhad Ben-Cohen 	return 0;
366400e64dfSOhad Ben-Cohen }
367400e64dfSOhad Ben-Cohen 
3686db20ea8SOhad Ben-Cohen void rproc_free_vring(struct rproc_vring *rvring)
3697a186941SOhad Ben-Cohen {
37063140e0eSOhad Ben-Cohen 	int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align));
3716db20ea8SOhad Ben-Cohen 	struct rproc *rproc = rvring->rvdev->rproc;
3727a186941SOhad Ben-Cohen 
373b5ab5e24SOhad Ben-Cohen 	dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma);
3747a186941SOhad Ben-Cohen 	idr_remove(&rproc->notifyids, rvring->notifyid);
3757a186941SOhad Ben-Cohen }
3767a186941SOhad Ben-Cohen 
377400e64dfSOhad Ben-Cohen /**
378fd2c15ecSOhad Ben-Cohen  * rproc_handle_vdev() - handle a vdev fw resource
379400e64dfSOhad Ben-Cohen  * @rproc: the remote processor
380400e64dfSOhad Ben-Cohen  * @rsc: the vring resource descriptor
381fd2c15ecSOhad Ben-Cohen  * @avail: size of available data (for sanity checking the image)
382400e64dfSOhad Ben-Cohen  *
3837a186941SOhad Ben-Cohen  * This resource entry requests the host to statically register a virtio
3847a186941SOhad Ben-Cohen  * device (vdev), and setup everything needed to support it. It contains
3857a186941SOhad Ben-Cohen  * everything needed to make it possible: the virtio device id, virtio
3867a186941SOhad Ben-Cohen  * device features, vrings information, virtio config space, etc...
387400e64dfSOhad Ben-Cohen  *
3887a186941SOhad Ben-Cohen  * Before registering the vdev, the vrings are allocated from non-cacheable
3897a186941SOhad Ben-Cohen  * physically contiguous memory. Currently we only support two vrings per
3907a186941SOhad Ben-Cohen  * remote processor (temporary limitation). We might also want to consider
3917a186941SOhad Ben-Cohen  * doing the vring allocation only later when ->find_vqs() is invoked, and
3927a186941SOhad Ben-Cohen  * then release them upon ->del_vqs().
393400e64dfSOhad Ben-Cohen  *
3947a186941SOhad Ben-Cohen  * Note: @da is currently not really handled correctly: we dynamically
3957a186941SOhad Ben-Cohen  * allocate it using the DMA API, ignoring requested hard coded addresses,
3967a186941SOhad Ben-Cohen  * and we don't take care of any required IOMMU programming. This is all
3977a186941SOhad Ben-Cohen  * going to be taken care of when the generic iommu-based DMA API will be
3987a186941SOhad Ben-Cohen  * merged. Meanwhile, statically-addressed iommu-based firmware images should
3997a186941SOhad Ben-Cohen  * use RSC_DEVMEM resource entries to map their required @da to the physical
4007a186941SOhad Ben-Cohen  * address of their base CMA region (ouch, hacky!).
401400e64dfSOhad Ben-Cohen  *
402400e64dfSOhad Ben-Cohen  * Returns 0 on success, or an appropriate error code otherwise
403400e64dfSOhad Ben-Cohen  */
404fd2c15ecSOhad Ben-Cohen static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc,
405fd2c15ecSOhad Ben-Cohen 								int avail)
406400e64dfSOhad Ben-Cohen {
407b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
4087a186941SOhad Ben-Cohen 	struct rproc_vdev *rvdev;
4097a186941SOhad Ben-Cohen 	int i, ret;
410fd2c15ecSOhad Ben-Cohen 
411fd2c15ecSOhad Ben-Cohen 	/* make sure resource isn't truncated */
412fd2c15ecSOhad Ben-Cohen 	if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring)
413fd2c15ecSOhad Ben-Cohen 			+ rsc->config_len > avail) {
414b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "vdev rsc is truncated\n");
415fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
416fd2c15ecSOhad Ben-Cohen 	}
417fd2c15ecSOhad Ben-Cohen 
418fd2c15ecSOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
419fd2c15ecSOhad Ben-Cohen 	if (rsc->reserved[0] || rsc->reserved[1]) {
420fd2c15ecSOhad Ben-Cohen 		dev_err(dev, "vdev rsc has non zero reserved bytes\n");
421fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
422fd2c15ecSOhad Ben-Cohen 	}
423fd2c15ecSOhad Ben-Cohen 
424fd2c15ecSOhad Ben-Cohen 	dev_dbg(dev, "vdev rsc: id %d, dfeatures %x, cfg len %d, %d vrings\n",
425fd2c15ecSOhad Ben-Cohen 		rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings);
426400e64dfSOhad Ben-Cohen 
4277a186941SOhad Ben-Cohen 	/* we currently support only two vrings per rvdev */
4287a186941SOhad Ben-Cohen 	if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) {
429fd2c15ecSOhad Ben-Cohen 		dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings);
430400e64dfSOhad Ben-Cohen 		return -EINVAL;
431400e64dfSOhad Ben-Cohen 	}
432400e64dfSOhad Ben-Cohen 
4337a186941SOhad Ben-Cohen 	rvdev = kzalloc(sizeof(struct rproc_vdev), GFP_KERNEL);
4347a186941SOhad Ben-Cohen 	if (!rvdev)
4357a186941SOhad Ben-Cohen 		return -ENOMEM;
4367a186941SOhad Ben-Cohen 
4377a186941SOhad Ben-Cohen 	rvdev->rproc = rproc;
4387a186941SOhad Ben-Cohen 
4396db20ea8SOhad Ben-Cohen 	/* parse the vrings */
440fd2c15ecSOhad Ben-Cohen 	for (i = 0; i < rsc->num_of_vrings; i++) {
4416db20ea8SOhad Ben-Cohen 		ret = rproc_parse_vring(rvdev, rsc, i);
4427a186941SOhad Ben-Cohen 		if (ret)
4436db20ea8SOhad Ben-Cohen 			goto free_rvdev;
444fd2c15ecSOhad Ben-Cohen 	}
445fd2c15ecSOhad Ben-Cohen 
4467a186941SOhad Ben-Cohen 	/* remember the device features */
4477a186941SOhad Ben-Cohen 	rvdev->dfeatures = rsc->dfeatures;
448400e64dfSOhad Ben-Cohen 
4497a186941SOhad Ben-Cohen 	list_add_tail(&rvdev->node, &rproc->rvdevs);
450400e64dfSOhad Ben-Cohen 
4517a186941SOhad Ben-Cohen 	/* it is now safe to add the virtio device */
4527a186941SOhad Ben-Cohen 	ret = rproc_add_virtio_dev(rvdev, rsc->id);
4537a186941SOhad Ben-Cohen 	if (ret)
4546db20ea8SOhad Ben-Cohen 		goto free_rvdev;
455400e64dfSOhad Ben-Cohen 
456400e64dfSOhad Ben-Cohen 	return 0;
4577a186941SOhad Ben-Cohen 
4586db20ea8SOhad Ben-Cohen free_rvdev:
4597a186941SOhad Ben-Cohen 	kfree(rvdev);
4607a186941SOhad Ben-Cohen 	return ret;
461400e64dfSOhad Ben-Cohen }
462400e64dfSOhad Ben-Cohen 
463400e64dfSOhad Ben-Cohen /**
464400e64dfSOhad Ben-Cohen  * rproc_handle_trace() - handle a shared trace buffer resource
465400e64dfSOhad Ben-Cohen  * @rproc: the remote processor
466400e64dfSOhad Ben-Cohen  * @rsc: the trace resource descriptor
467fd2c15ecSOhad Ben-Cohen  * @avail: size of available data (for sanity checking the image)
468400e64dfSOhad Ben-Cohen  *
469400e64dfSOhad Ben-Cohen  * In case the remote processor dumps trace logs into memory,
470400e64dfSOhad Ben-Cohen  * export it via debugfs.
471400e64dfSOhad Ben-Cohen  *
472400e64dfSOhad Ben-Cohen  * Currently, the 'da' member of @rsc should contain the device address
473400e64dfSOhad Ben-Cohen  * where the remote processor is dumping the traces. Later we could also
474400e64dfSOhad Ben-Cohen  * support dynamically allocating this address using the generic
475400e64dfSOhad Ben-Cohen  * DMA API (but currently there isn't a use case for that).
476400e64dfSOhad Ben-Cohen  *
477400e64dfSOhad Ben-Cohen  * Returns 0 on success, or an appropriate error code otherwise
478400e64dfSOhad Ben-Cohen  */
479fd2c15ecSOhad Ben-Cohen static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc,
480fd2c15ecSOhad Ben-Cohen 								int avail)
481400e64dfSOhad Ben-Cohen {
482400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *trace;
483b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
484400e64dfSOhad Ben-Cohen 	void *ptr;
485400e64dfSOhad Ben-Cohen 	char name[15];
486400e64dfSOhad Ben-Cohen 
487fd2c15ecSOhad Ben-Cohen 	if (sizeof(*rsc) > avail) {
488b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "trace rsc is truncated\n");
489fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
490fd2c15ecSOhad Ben-Cohen 	}
491fd2c15ecSOhad Ben-Cohen 
492fd2c15ecSOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
493fd2c15ecSOhad Ben-Cohen 	if (rsc->reserved) {
494fd2c15ecSOhad Ben-Cohen 		dev_err(dev, "trace rsc has non zero reserved bytes\n");
495fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
496fd2c15ecSOhad Ben-Cohen 	}
497fd2c15ecSOhad Ben-Cohen 
498400e64dfSOhad Ben-Cohen 	/* what's the kernel address of this resource ? */
499400e64dfSOhad Ben-Cohen 	ptr = rproc_da_to_va(rproc, rsc->da, rsc->len);
500400e64dfSOhad Ben-Cohen 	if (!ptr) {
501400e64dfSOhad Ben-Cohen 		dev_err(dev, "erroneous trace resource entry\n");
502400e64dfSOhad Ben-Cohen 		return -EINVAL;
503400e64dfSOhad Ben-Cohen 	}
504400e64dfSOhad Ben-Cohen 
505400e64dfSOhad Ben-Cohen 	trace = kzalloc(sizeof(*trace), GFP_KERNEL);
506400e64dfSOhad Ben-Cohen 	if (!trace) {
507400e64dfSOhad Ben-Cohen 		dev_err(dev, "kzalloc trace failed\n");
508400e64dfSOhad Ben-Cohen 		return -ENOMEM;
509400e64dfSOhad Ben-Cohen 	}
510400e64dfSOhad Ben-Cohen 
511400e64dfSOhad Ben-Cohen 	/* set the trace buffer dma properties */
512400e64dfSOhad Ben-Cohen 	trace->len = rsc->len;
513400e64dfSOhad Ben-Cohen 	trace->va = ptr;
514400e64dfSOhad Ben-Cohen 
515400e64dfSOhad Ben-Cohen 	/* make sure snprintf always null terminates, even if truncating */
516400e64dfSOhad Ben-Cohen 	snprintf(name, sizeof(name), "trace%d", rproc->num_traces);
517400e64dfSOhad Ben-Cohen 
518400e64dfSOhad Ben-Cohen 	/* create the debugfs entry */
519400e64dfSOhad Ben-Cohen 	trace->priv = rproc_create_trace_file(name, rproc, trace);
520400e64dfSOhad Ben-Cohen 	if (!trace->priv) {
521400e64dfSOhad Ben-Cohen 		trace->va = NULL;
522400e64dfSOhad Ben-Cohen 		kfree(trace);
523400e64dfSOhad Ben-Cohen 		return -EINVAL;
524400e64dfSOhad Ben-Cohen 	}
525400e64dfSOhad Ben-Cohen 
526400e64dfSOhad Ben-Cohen 	list_add_tail(&trace->node, &rproc->traces);
527400e64dfSOhad Ben-Cohen 
528400e64dfSOhad Ben-Cohen 	rproc->num_traces++;
529400e64dfSOhad Ben-Cohen 
530fd2c15ecSOhad Ben-Cohen 	dev_dbg(dev, "%s added: va %p, da 0x%x, len 0x%x\n", name, ptr,
531400e64dfSOhad Ben-Cohen 						rsc->da, rsc->len);
532400e64dfSOhad Ben-Cohen 
533400e64dfSOhad Ben-Cohen 	return 0;
534400e64dfSOhad Ben-Cohen }
535400e64dfSOhad Ben-Cohen 
536400e64dfSOhad Ben-Cohen /**
537400e64dfSOhad Ben-Cohen  * rproc_handle_devmem() - handle devmem resource entry
538400e64dfSOhad Ben-Cohen  * @rproc: remote processor handle
539400e64dfSOhad Ben-Cohen  * @rsc: the devmem resource entry
540fd2c15ecSOhad Ben-Cohen  * @avail: size of available data (for sanity checking the image)
541400e64dfSOhad Ben-Cohen  *
542400e64dfSOhad Ben-Cohen  * Remote processors commonly need to access certain on-chip peripherals.
543400e64dfSOhad Ben-Cohen  *
544400e64dfSOhad Ben-Cohen  * Some of these remote processors access memory via an iommu device,
545400e64dfSOhad Ben-Cohen  * and might require us to configure their iommu before they can access
546400e64dfSOhad Ben-Cohen  * the on-chip peripherals they need.
547400e64dfSOhad Ben-Cohen  *
548400e64dfSOhad Ben-Cohen  * This resource entry is a request to map such a peripheral device.
549400e64dfSOhad Ben-Cohen  *
550400e64dfSOhad Ben-Cohen  * These devmem entries will contain the physical address of the device in
551400e64dfSOhad Ben-Cohen  * the 'pa' member. If a specific device address is expected, then 'da' will
552400e64dfSOhad Ben-Cohen  * contain it (currently this is the only use case supported). 'len' will
553400e64dfSOhad Ben-Cohen  * contain the size of the physical region we need to map.
554400e64dfSOhad Ben-Cohen  *
555400e64dfSOhad Ben-Cohen  * Currently we just "trust" those devmem entries to contain valid physical
556400e64dfSOhad Ben-Cohen  * addresses, but this is going to change: we want the implementations to
557400e64dfSOhad Ben-Cohen  * tell us ranges of physical addresses the firmware is allowed to request,
558400e64dfSOhad Ben-Cohen  * and not allow firmwares to request access to physical addresses that
559400e64dfSOhad Ben-Cohen  * are outside those ranges.
560400e64dfSOhad Ben-Cohen  */
561fd2c15ecSOhad Ben-Cohen static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc,
562fd2c15ecSOhad Ben-Cohen 								int avail)
563400e64dfSOhad Ben-Cohen {
564400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *mapping;
565b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
566400e64dfSOhad Ben-Cohen 	int ret;
567400e64dfSOhad Ben-Cohen 
568400e64dfSOhad Ben-Cohen 	/* no point in handling this resource without a valid iommu domain */
569400e64dfSOhad Ben-Cohen 	if (!rproc->domain)
570400e64dfSOhad Ben-Cohen 		return -EINVAL;
571400e64dfSOhad Ben-Cohen 
572fd2c15ecSOhad Ben-Cohen 	if (sizeof(*rsc) > avail) {
573b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "devmem rsc is truncated\n");
574fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
575fd2c15ecSOhad Ben-Cohen 	}
576fd2c15ecSOhad Ben-Cohen 
577fd2c15ecSOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
578fd2c15ecSOhad Ben-Cohen 	if (rsc->reserved) {
579b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "devmem rsc has non zero reserved bytes\n");
580fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
581fd2c15ecSOhad Ben-Cohen 	}
582fd2c15ecSOhad Ben-Cohen 
583400e64dfSOhad Ben-Cohen 	mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
584400e64dfSOhad Ben-Cohen 	if (!mapping) {
585b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "kzalloc mapping failed\n");
586400e64dfSOhad Ben-Cohen 		return -ENOMEM;
587400e64dfSOhad Ben-Cohen 	}
588400e64dfSOhad Ben-Cohen 
589400e64dfSOhad Ben-Cohen 	ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags);
590400e64dfSOhad Ben-Cohen 	if (ret) {
591b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "failed to map devmem: %d\n", ret);
592400e64dfSOhad Ben-Cohen 		goto out;
593400e64dfSOhad Ben-Cohen 	}
594400e64dfSOhad Ben-Cohen 
595400e64dfSOhad Ben-Cohen 	/*
596400e64dfSOhad Ben-Cohen 	 * We'll need this info later when we'll want to unmap everything
597400e64dfSOhad Ben-Cohen 	 * (e.g. on shutdown).
598400e64dfSOhad Ben-Cohen 	 *
599400e64dfSOhad Ben-Cohen 	 * We can't trust the remote processor not to change the resource
600400e64dfSOhad Ben-Cohen 	 * table, so we must maintain this info independently.
601400e64dfSOhad Ben-Cohen 	 */
602400e64dfSOhad Ben-Cohen 	mapping->da = rsc->da;
603400e64dfSOhad Ben-Cohen 	mapping->len = rsc->len;
604400e64dfSOhad Ben-Cohen 	list_add_tail(&mapping->node, &rproc->mappings);
605400e64dfSOhad Ben-Cohen 
606b5ab5e24SOhad Ben-Cohen 	dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n",
607400e64dfSOhad Ben-Cohen 					rsc->pa, rsc->da, rsc->len);
608400e64dfSOhad Ben-Cohen 
609400e64dfSOhad Ben-Cohen 	return 0;
610400e64dfSOhad Ben-Cohen 
611400e64dfSOhad Ben-Cohen out:
612400e64dfSOhad Ben-Cohen 	kfree(mapping);
613400e64dfSOhad Ben-Cohen 	return ret;
614400e64dfSOhad Ben-Cohen }
615400e64dfSOhad Ben-Cohen 
616400e64dfSOhad Ben-Cohen /**
617400e64dfSOhad Ben-Cohen  * rproc_handle_carveout() - handle phys contig memory allocation requests
618400e64dfSOhad Ben-Cohen  * @rproc: rproc handle
619400e64dfSOhad Ben-Cohen  * @rsc: the resource entry
620fd2c15ecSOhad Ben-Cohen  * @avail: size of available data (for image validation)
621400e64dfSOhad Ben-Cohen  *
622400e64dfSOhad Ben-Cohen  * This function will handle firmware requests for allocation of physically
623400e64dfSOhad Ben-Cohen  * contiguous memory regions.
624400e64dfSOhad Ben-Cohen  *
625400e64dfSOhad Ben-Cohen  * These request entries should come first in the firmware's resource table,
626400e64dfSOhad Ben-Cohen  * as other firmware entries might request placing other data objects inside
627400e64dfSOhad Ben-Cohen  * these memory regions (e.g. data/code segments, trace resource entries, ...).
628400e64dfSOhad Ben-Cohen  *
629400e64dfSOhad Ben-Cohen  * Allocating memory this way helps utilizing the reserved physical memory
630400e64dfSOhad Ben-Cohen  * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries
631400e64dfSOhad Ben-Cohen  * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB
632400e64dfSOhad Ben-Cohen  * pressure is important; it may have a substantial impact on performance.
633400e64dfSOhad Ben-Cohen  */
634fd2c15ecSOhad Ben-Cohen static int rproc_handle_carveout(struct rproc *rproc,
635fd2c15ecSOhad Ben-Cohen 				struct fw_rsc_carveout *rsc, int avail)
636400e64dfSOhad Ben-Cohen {
637400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *carveout, *mapping;
638b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
639400e64dfSOhad Ben-Cohen 	dma_addr_t dma;
640400e64dfSOhad Ben-Cohen 	void *va;
641400e64dfSOhad Ben-Cohen 	int ret;
642400e64dfSOhad Ben-Cohen 
643fd2c15ecSOhad Ben-Cohen 	if (sizeof(*rsc) > avail) {
644b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "carveout rsc is truncated\n");
645fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
646fd2c15ecSOhad Ben-Cohen 	}
647fd2c15ecSOhad Ben-Cohen 
648fd2c15ecSOhad Ben-Cohen 	/* make sure reserved bytes are zeroes */
649fd2c15ecSOhad Ben-Cohen 	if (rsc->reserved) {
650fd2c15ecSOhad Ben-Cohen 		dev_err(dev, "carveout rsc has non zero reserved bytes\n");
651fd2c15ecSOhad Ben-Cohen 		return -EINVAL;
652fd2c15ecSOhad Ben-Cohen 	}
653fd2c15ecSOhad Ben-Cohen 
654fd2c15ecSOhad Ben-Cohen 	dev_dbg(dev, "carveout rsc: da %x, pa %x, len %x, flags %x\n",
655fd2c15ecSOhad Ben-Cohen 			rsc->da, rsc->pa, rsc->len, rsc->flags);
656fd2c15ecSOhad Ben-Cohen 
657400e64dfSOhad Ben-Cohen 	mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
658400e64dfSOhad Ben-Cohen 	if (!mapping) {
659400e64dfSOhad Ben-Cohen 		dev_err(dev, "kzalloc mapping failed\n");
660400e64dfSOhad Ben-Cohen 		return -ENOMEM;
661400e64dfSOhad Ben-Cohen 	}
662400e64dfSOhad Ben-Cohen 
663400e64dfSOhad Ben-Cohen 	carveout = kzalloc(sizeof(*carveout), GFP_KERNEL);
664400e64dfSOhad Ben-Cohen 	if (!carveout) {
665400e64dfSOhad Ben-Cohen 		dev_err(dev, "kzalloc carveout failed\n");
666400e64dfSOhad Ben-Cohen 		ret = -ENOMEM;
667400e64dfSOhad Ben-Cohen 		goto free_mapping;
668400e64dfSOhad Ben-Cohen 	}
669400e64dfSOhad Ben-Cohen 
670b5ab5e24SOhad Ben-Cohen 	va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL);
671400e64dfSOhad Ben-Cohen 	if (!va) {
672b5ab5e24SOhad Ben-Cohen 		dev_err(dev->parent, "dma_alloc_coherent err: %d\n", rsc->len);
673400e64dfSOhad Ben-Cohen 		ret = -ENOMEM;
674400e64dfSOhad Ben-Cohen 		goto free_carv;
675400e64dfSOhad Ben-Cohen 	}
676400e64dfSOhad Ben-Cohen 
677400e64dfSOhad Ben-Cohen 	dev_dbg(dev, "carveout va %p, dma %x, len 0x%x\n", va, dma, rsc->len);
678400e64dfSOhad Ben-Cohen 
679400e64dfSOhad Ben-Cohen 	/*
680400e64dfSOhad Ben-Cohen 	 * Ok, this is non-standard.
681400e64dfSOhad Ben-Cohen 	 *
682400e64dfSOhad Ben-Cohen 	 * Sometimes we can't rely on the generic iommu-based DMA API
683400e64dfSOhad Ben-Cohen 	 * to dynamically allocate the device address and then set the IOMMU
684400e64dfSOhad Ben-Cohen 	 * tables accordingly, because some remote processors might
685400e64dfSOhad Ben-Cohen 	 * _require_ us to use hard coded device addresses that their
686400e64dfSOhad Ben-Cohen 	 * firmware was compiled with.
687400e64dfSOhad Ben-Cohen 	 *
688400e64dfSOhad Ben-Cohen 	 * In this case, we must use the IOMMU API directly and map
689400e64dfSOhad Ben-Cohen 	 * the memory to the device address as expected by the remote
690400e64dfSOhad Ben-Cohen 	 * processor.
691400e64dfSOhad Ben-Cohen 	 *
692400e64dfSOhad Ben-Cohen 	 * Obviously such remote processor devices should not be configured
693400e64dfSOhad Ben-Cohen 	 * to use the iommu-based DMA API: we expect 'dma' to contain the
694400e64dfSOhad Ben-Cohen 	 * physical address in this case.
695400e64dfSOhad Ben-Cohen 	 */
696400e64dfSOhad Ben-Cohen 	if (rproc->domain) {
697400e64dfSOhad Ben-Cohen 		ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len,
698400e64dfSOhad Ben-Cohen 								rsc->flags);
699400e64dfSOhad Ben-Cohen 		if (ret) {
700400e64dfSOhad Ben-Cohen 			dev_err(dev, "iommu_map failed: %d\n", ret);
701400e64dfSOhad Ben-Cohen 			goto dma_free;
702400e64dfSOhad Ben-Cohen 		}
703400e64dfSOhad Ben-Cohen 
704400e64dfSOhad Ben-Cohen 		/*
705400e64dfSOhad Ben-Cohen 		 * We'll need this info later when we'll want to unmap
706400e64dfSOhad Ben-Cohen 		 * everything (e.g. on shutdown).
707400e64dfSOhad Ben-Cohen 		 *
708400e64dfSOhad Ben-Cohen 		 * We can't trust the remote processor not to change the
709400e64dfSOhad Ben-Cohen 		 * resource table, so we must maintain this info independently.
710400e64dfSOhad Ben-Cohen 		 */
711400e64dfSOhad Ben-Cohen 		mapping->da = rsc->da;
712400e64dfSOhad Ben-Cohen 		mapping->len = rsc->len;
713400e64dfSOhad Ben-Cohen 		list_add_tail(&mapping->node, &rproc->mappings);
714400e64dfSOhad Ben-Cohen 
715fd2c15ecSOhad Ben-Cohen 		dev_dbg(dev, "carveout mapped 0x%x to 0x%x\n", rsc->da, dma);
716400e64dfSOhad Ben-Cohen 
717400e64dfSOhad Ben-Cohen 		/*
718400e64dfSOhad Ben-Cohen 		 * Some remote processors might need to know the pa
719400e64dfSOhad Ben-Cohen 		 * even though they are behind an IOMMU. E.g., OMAP4's
720400e64dfSOhad Ben-Cohen 		 * remote M3 processor needs this so it can control
721400e64dfSOhad Ben-Cohen 		 * on-chip hardware accelerators that are not behind
722400e64dfSOhad Ben-Cohen 		 * the IOMMU, and therefor must know the pa.
723400e64dfSOhad Ben-Cohen 		 *
724400e64dfSOhad Ben-Cohen 		 * Generally we don't want to expose physical addresses
725400e64dfSOhad Ben-Cohen 		 * if we don't have to (remote processors are generally
726400e64dfSOhad Ben-Cohen 		 * _not_ trusted), so we might want to do this only for
727400e64dfSOhad Ben-Cohen 		 * remote processor that _must_ have this (e.g. OMAP4's
728400e64dfSOhad Ben-Cohen 		 * dual M3 subsystem).
729400e64dfSOhad Ben-Cohen 		 */
730400e64dfSOhad Ben-Cohen 		rsc->pa = dma;
731400e64dfSOhad Ben-Cohen 	}
732400e64dfSOhad Ben-Cohen 
733400e64dfSOhad Ben-Cohen 	carveout->va = va;
734400e64dfSOhad Ben-Cohen 	carveout->len = rsc->len;
735400e64dfSOhad Ben-Cohen 	carveout->dma = dma;
736400e64dfSOhad Ben-Cohen 	carveout->da = rsc->da;
737400e64dfSOhad Ben-Cohen 
738400e64dfSOhad Ben-Cohen 	list_add_tail(&carveout->node, &rproc->carveouts);
739400e64dfSOhad Ben-Cohen 
740400e64dfSOhad Ben-Cohen 	return 0;
741400e64dfSOhad Ben-Cohen 
742400e64dfSOhad Ben-Cohen dma_free:
743b5ab5e24SOhad Ben-Cohen 	dma_free_coherent(dev->parent, rsc->len, va, dma);
744400e64dfSOhad Ben-Cohen free_carv:
745400e64dfSOhad Ben-Cohen 	kfree(carveout);
746400e64dfSOhad Ben-Cohen free_mapping:
747400e64dfSOhad Ben-Cohen 	kfree(mapping);
748400e64dfSOhad Ben-Cohen 	return ret;
749400e64dfSOhad Ben-Cohen }
750400e64dfSOhad Ben-Cohen 
751e12bc14bSOhad Ben-Cohen /*
752e12bc14bSOhad Ben-Cohen  * A lookup table for resource handlers. The indices are defined in
753e12bc14bSOhad Ben-Cohen  * enum fw_resource_type.
754e12bc14bSOhad Ben-Cohen  */
755e12bc14bSOhad Ben-Cohen static rproc_handle_resource_t rproc_handle_rsc[] = {
756fd2c15ecSOhad Ben-Cohen 	[RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout,
757fd2c15ecSOhad Ben-Cohen 	[RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem,
758fd2c15ecSOhad Ben-Cohen 	[RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace,
7597a186941SOhad Ben-Cohen 	[RSC_VDEV] = NULL, /* VDEVs were handled upon registrarion */
760e12bc14bSOhad Ben-Cohen };
761e12bc14bSOhad Ben-Cohen 
762400e64dfSOhad Ben-Cohen /* handle firmware resource entries before booting the remote processor */
763400e64dfSOhad Ben-Cohen static int
764fd2c15ecSOhad Ben-Cohen rproc_handle_boot_rsc(struct rproc *rproc, struct resource_table *table, int len)
765400e64dfSOhad Ben-Cohen {
766b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
767e12bc14bSOhad Ben-Cohen 	rproc_handle_resource_t handler;
768fd2c15ecSOhad Ben-Cohen 	int ret = 0, i;
769400e64dfSOhad Ben-Cohen 
770fd2c15ecSOhad Ben-Cohen 	for (i = 0; i < table->num; i++) {
771fd2c15ecSOhad Ben-Cohen 		int offset = table->offset[i];
772fd2c15ecSOhad Ben-Cohen 		struct fw_rsc_hdr *hdr = (void *)table + offset;
773fd2c15ecSOhad Ben-Cohen 		int avail = len - offset - sizeof(*hdr);
774fd2c15ecSOhad Ben-Cohen 		void *rsc = (void *)hdr + sizeof(*hdr);
775400e64dfSOhad Ben-Cohen 
776fd2c15ecSOhad Ben-Cohen 		/* make sure table isn't truncated */
777fd2c15ecSOhad Ben-Cohen 		if (avail < 0) {
778fd2c15ecSOhad Ben-Cohen 			dev_err(dev, "rsc table is truncated\n");
779fd2c15ecSOhad Ben-Cohen 			return -EINVAL;
780fd2c15ecSOhad Ben-Cohen 		}
781fd2c15ecSOhad Ben-Cohen 
782fd2c15ecSOhad Ben-Cohen 		dev_dbg(dev, "rsc: type %d\n", hdr->type);
783fd2c15ecSOhad Ben-Cohen 
784fd2c15ecSOhad Ben-Cohen 		if (hdr->type >= RSC_LAST) {
785fd2c15ecSOhad Ben-Cohen 			dev_warn(dev, "unsupported resource %d\n", hdr->type);
786e12bc14bSOhad Ben-Cohen 			continue;
787400e64dfSOhad Ben-Cohen 		}
788400e64dfSOhad Ben-Cohen 
789fd2c15ecSOhad Ben-Cohen 		handler = rproc_handle_rsc[hdr->type];
790e12bc14bSOhad Ben-Cohen 		if (!handler)
791e12bc14bSOhad Ben-Cohen 			continue;
792e12bc14bSOhad Ben-Cohen 
793fd2c15ecSOhad Ben-Cohen 		ret = handler(rproc, rsc, avail);
794400e64dfSOhad Ben-Cohen 		if (ret)
795400e64dfSOhad Ben-Cohen 			break;
796400e64dfSOhad Ben-Cohen 	}
797400e64dfSOhad Ben-Cohen 
798400e64dfSOhad Ben-Cohen 	return ret;
799400e64dfSOhad Ben-Cohen }
800400e64dfSOhad Ben-Cohen 
801400e64dfSOhad Ben-Cohen /* handle firmware resource entries while registering the remote processor */
802400e64dfSOhad Ben-Cohen static int
803fd2c15ecSOhad Ben-Cohen rproc_handle_virtio_rsc(struct rproc *rproc, struct resource_table *table, int len)
804400e64dfSOhad Ben-Cohen {
805b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
806fd2c15ecSOhad Ben-Cohen 	int ret = 0, i;
807400e64dfSOhad Ben-Cohen 
808fd2c15ecSOhad Ben-Cohen 	for (i = 0; i < table->num; i++) {
809fd2c15ecSOhad Ben-Cohen 		int offset = table->offset[i];
810fd2c15ecSOhad Ben-Cohen 		struct fw_rsc_hdr *hdr = (void *)table + offset;
811fd2c15ecSOhad Ben-Cohen 		int avail = len - offset - sizeof(*hdr);
8127a186941SOhad Ben-Cohen 		struct fw_rsc_vdev *vrsc;
813fd2c15ecSOhad Ben-Cohen 
814fd2c15ecSOhad Ben-Cohen 		/* make sure table isn't truncated */
815fd2c15ecSOhad Ben-Cohen 		if (avail < 0) {
816fd2c15ecSOhad Ben-Cohen 			dev_err(dev, "rsc table is truncated\n");
817fd2c15ecSOhad Ben-Cohen 			return -EINVAL;
818fd2c15ecSOhad Ben-Cohen 		}
819fd2c15ecSOhad Ben-Cohen 
820fd2c15ecSOhad Ben-Cohen 		dev_dbg(dev, "%s: rsc type %d\n", __func__, hdr->type);
821fd2c15ecSOhad Ben-Cohen 
8227a186941SOhad Ben-Cohen 		if (hdr->type != RSC_VDEV)
8237a186941SOhad Ben-Cohen 			continue;
8247a186941SOhad Ben-Cohen 
8257a186941SOhad Ben-Cohen 		vrsc = (struct fw_rsc_vdev *)hdr->data;
8267a186941SOhad Ben-Cohen 
8277a186941SOhad Ben-Cohen 		ret = rproc_handle_vdev(rproc, vrsc, avail);
8287a186941SOhad Ben-Cohen 		if (ret)
829400e64dfSOhad Ben-Cohen 			break;
830400e64dfSOhad Ben-Cohen 	}
831400e64dfSOhad Ben-Cohen 
832400e64dfSOhad Ben-Cohen 	return ret;
833400e64dfSOhad Ben-Cohen }
834400e64dfSOhad Ben-Cohen 
835400e64dfSOhad Ben-Cohen /**
8361e3e2c7cSOhad Ben-Cohen  * rproc_find_rsc_table() - find the resource table
837400e64dfSOhad Ben-Cohen  * @rproc: the rproc handle
838400e64dfSOhad Ben-Cohen  * @elf_data: the content of the ELF firmware image
8399bc91231SOhad Ben-Cohen  * @len: firmware size (in bytes)
8401e3e2c7cSOhad Ben-Cohen  * @tablesz: place holder for providing back the table size
841400e64dfSOhad Ben-Cohen  *
842400e64dfSOhad Ben-Cohen  * This function finds the resource table inside the remote processor's
8431e3e2c7cSOhad Ben-Cohen  * firmware. It is used both upon the registration of @rproc (in order
8441e3e2c7cSOhad Ben-Cohen  * to look for and register the supported virito devices), and when the
8451e3e2c7cSOhad Ben-Cohen  * @rproc is booted.
846400e64dfSOhad Ben-Cohen  *
8471e3e2c7cSOhad Ben-Cohen  * Returns the pointer to the resource table if it is found, and write its
8481e3e2c7cSOhad Ben-Cohen  * size into @tablesz. If a valid table isn't found, NULL is returned
8491e3e2c7cSOhad Ben-Cohen  * (and @tablesz isn't set).
850400e64dfSOhad Ben-Cohen  */
8511e3e2c7cSOhad Ben-Cohen static struct resource_table *
8521e3e2c7cSOhad Ben-Cohen rproc_find_rsc_table(struct rproc *rproc, const u8 *elf_data, size_t len,
8531e3e2c7cSOhad Ben-Cohen 							int *tablesz)
854400e64dfSOhad Ben-Cohen {
855400e64dfSOhad Ben-Cohen 	struct elf32_hdr *ehdr;
856400e64dfSOhad Ben-Cohen 	struct elf32_shdr *shdr;
857400e64dfSOhad Ben-Cohen 	const char *name_table;
858b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
8591e3e2c7cSOhad Ben-Cohen 	struct resource_table *table = NULL;
8601e3e2c7cSOhad Ben-Cohen 	int i;
861400e64dfSOhad Ben-Cohen 
862400e64dfSOhad Ben-Cohen 	ehdr = (struct elf32_hdr *)elf_data;
863400e64dfSOhad Ben-Cohen 	shdr = (struct elf32_shdr *)(elf_data + ehdr->e_shoff);
864400e64dfSOhad Ben-Cohen 	name_table = elf_data + shdr[ehdr->e_shstrndx].sh_offset;
865400e64dfSOhad Ben-Cohen 
866400e64dfSOhad Ben-Cohen 	/* look for the resource table and handle it */
867400e64dfSOhad Ben-Cohen 	for (i = 0; i < ehdr->e_shnum; i++, shdr++) {
868fd2c15ecSOhad Ben-Cohen 		int size = shdr->sh_size;
869fd2c15ecSOhad Ben-Cohen 		int offset = shdr->sh_offset;
870400e64dfSOhad Ben-Cohen 
871fd2c15ecSOhad Ben-Cohen 		if (strcmp(name_table + shdr->sh_name, ".resource_table"))
872fd2c15ecSOhad Ben-Cohen 			continue;
873fd2c15ecSOhad Ben-Cohen 
874fd2c15ecSOhad Ben-Cohen 		table = (struct resource_table *)(elf_data + offset);
875fd2c15ecSOhad Ben-Cohen 
876fd2c15ecSOhad Ben-Cohen 		/* make sure we have the entire table */
877fd2c15ecSOhad Ben-Cohen 		if (offset + size > len) {
878fd2c15ecSOhad Ben-Cohen 			dev_err(dev, "resource table truncated\n");
8791e3e2c7cSOhad Ben-Cohen 			return NULL;
880fd2c15ecSOhad Ben-Cohen 		}
881fd2c15ecSOhad Ben-Cohen 
882fd2c15ecSOhad Ben-Cohen 		/* make sure table has at least the header */
883fd2c15ecSOhad Ben-Cohen 		if (sizeof(struct resource_table) > size) {
884fd2c15ecSOhad Ben-Cohen 			dev_err(dev, "header-less resource table\n");
8851e3e2c7cSOhad Ben-Cohen 			return NULL;
886fd2c15ecSOhad Ben-Cohen 		}
887fd2c15ecSOhad Ben-Cohen 
888fd2c15ecSOhad Ben-Cohen 		/* we don't support any version beyond the first */
889fd2c15ecSOhad Ben-Cohen 		if (table->ver != 1) {
890fd2c15ecSOhad Ben-Cohen 			dev_err(dev, "unsupported fw ver: %d\n", table->ver);
8911e3e2c7cSOhad Ben-Cohen 			return NULL;
892fd2c15ecSOhad Ben-Cohen 		}
893fd2c15ecSOhad Ben-Cohen 
894fd2c15ecSOhad Ben-Cohen 		/* make sure reserved bytes are zeroes */
895fd2c15ecSOhad Ben-Cohen 		if (table->reserved[0] || table->reserved[1]) {
896fd2c15ecSOhad Ben-Cohen 			dev_err(dev, "non zero reserved bytes\n");
8971e3e2c7cSOhad Ben-Cohen 			return NULL;
898fd2c15ecSOhad Ben-Cohen 		}
899fd2c15ecSOhad Ben-Cohen 
900fd2c15ecSOhad Ben-Cohen 		/* make sure the offsets array isn't truncated */
901fd2c15ecSOhad Ben-Cohen 		if (table->num * sizeof(table->offset[0]) +
902fd2c15ecSOhad Ben-Cohen 				sizeof(struct resource_table) > size) {
903fd2c15ecSOhad Ben-Cohen 			dev_err(dev, "resource table incomplete\n");
9041e3e2c7cSOhad Ben-Cohen 			return NULL;
9059bc91231SOhad Ben-Cohen 		}
9069bc91231SOhad Ben-Cohen 
9071e3e2c7cSOhad Ben-Cohen 		*tablesz = shdr->sh_size;
908400e64dfSOhad Ben-Cohen 		break;
909400e64dfSOhad Ben-Cohen 	}
910400e64dfSOhad Ben-Cohen 
9111e3e2c7cSOhad Ben-Cohen 	return table;
912400e64dfSOhad Ben-Cohen }
913400e64dfSOhad Ben-Cohen 
914400e64dfSOhad Ben-Cohen /**
915400e64dfSOhad Ben-Cohen  * rproc_resource_cleanup() - clean up and free all acquired resources
916400e64dfSOhad Ben-Cohen  * @rproc: rproc handle
917400e64dfSOhad Ben-Cohen  *
918400e64dfSOhad Ben-Cohen  * This function will free all resources acquired for @rproc, and it
9197a186941SOhad Ben-Cohen  * is called whenever @rproc either shuts down or fails to boot.
920400e64dfSOhad Ben-Cohen  */
921400e64dfSOhad Ben-Cohen static void rproc_resource_cleanup(struct rproc *rproc)
922400e64dfSOhad Ben-Cohen {
923400e64dfSOhad Ben-Cohen 	struct rproc_mem_entry *entry, *tmp;
924b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
925400e64dfSOhad Ben-Cohen 
926400e64dfSOhad Ben-Cohen 	/* clean up debugfs trace entries */
927400e64dfSOhad Ben-Cohen 	list_for_each_entry_safe(entry, tmp, &rproc->traces, node) {
928400e64dfSOhad Ben-Cohen 		rproc_remove_trace_file(entry->priv);
929400e64dfSOhad Ben-Cohen 		rproc->num_traces--;
930400e64dfSOhad Ben-Cohen 		list_del(&entry->node);
931400e64dfSOhad Ben-Cohen 		kfree(entry);
932400e64dfSOhad Ben-Cohen 	}
933400e64dfSOhad Ben-Cohen 
934400e64dfSOhad Ben-Cohen 	/* clean up carveout allocations */
935400e64dfSOhad Ben-Cohen 	list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) {
936b5ab5e24SOhad Ben-Cohen 		dma_free_coherent(dev->parent, entry->len, entry->va, entry->dma);
937400e64dfSOhad Ben-Cohen 		list_del(&entry->node);
938400e64dfSOhad Ben-Cohen 		kfree(entry);
939400e64dfSOhad Ben-Cohen 	}
940400e64dfSOhad Ben-Cohen 
941400e64dfSOhad Ben-Cohen 	/* clean up iommu mapping entries */
942400e64dfSOhad Ben-Cohen 	list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) {
943400e64dfSOhad Ben-Cohen 		size_t unmapped;
944400e64dfSOhad Ben-Cohen 
945400e64dfSOhad Ben-Cohen 		unmapped = iommu_unmap(rproc->domain, entry->da, entry->len);
946400e64dfSOhad Ben-Cohen 		if (unmapped != entry->len) {
947400e64dfSOhad Ben-Cohen 			/* nothing much to do besides complaining */
948400e64dfSOhad Ben-Cohen 			dev_err(dev, "failed to unmap %u/%u\n", entry->len,
949400e64dfSOhad Ben-Cohen 								unmapped);
950400e64dfSOhad Ben-Cohen 		}
951400e64dfSOhad Ben-Cohen 
952400e64dfSOhad Ben-Cohen 		list_del(&entry->node);
953400e64dfSOhad Ben-Cohen 		kfree(entry);
954400e64dfSOhad Ben-Cohen 	}
955400e64dfSOhad Ben-Cohen }
956400e64dfSOhad Ben-Cohen 
957400e64dfSOhad Ben-Cohen /* make sure this fw image is sane */
958400e64dfSOhad Ben-Cohen static int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
959400e64dfSOhad Ben-Cohen {
960400e64dfSOhad Ben-Cohen 	const char *name = rproc->firmware;
961b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
962400e64dfSOhad Ben-Cohen 	struct elf32_hdr *ehdr;
96340b78b2cSOhad Ben-Cohen 	char class;
964400e64dfSOhad Ben-Cohen 
965400e64dfSOhad Ben-Cohen 	if (!fw) {
966400e64dfSOhad Ben-Cohen 		dev_err(dev, "failed to load %s\n", name);
967400e64dfSOhad Ben-Cohen 		return -EINVAL;
968400e64dfSOhad Ben-Cohen 	}
969400e64dfSOhad Ben-Cohen 
970400e64dfSOhad Ben-Cohen 	if (fw->size < sizeof(struct elf32_hdr)) {
971400e64dfSOhad Ben-Cohen 		dev_err(dev, "Image is too small\n");
972400e64dfSOhad Ben-Cohen 		return -EINVAL;
973400e64dfSOhad Ben-Cohen 	}
974400e64dfSOhad Ben-Cohen 
975400e64dfSOhad Ben-Cohen 	ehdr = (struct elf32_hdr *)fw->data;
976400e64dfSOhad Ben-Cohen 
97740b78b2cSOhad Ben-Cohen 	/* We only support ELF32 at this point */
97840b78b2cSOhad Ben-Cohen 	class = ehdr->e_ident[EI_CLASS];
97940b78b2cSOhad Ben-Cohen 	if (class != ELFCLASS32) {
98040b78b2cSOhad Ben-Cohen 		dev_err(dev, "Unsupported class: %d\n", class);
98140b78b2cSOhad Ben-Cohen 		return -EINVAL;
98240b78b2cSOhad Ben-Cohen 	}
98340b78b2cSOhad Ben-Cohen 
984cf59d3e9SOhad Ben-Cohen 	/* We assume the firmware has the same endianess as the host */
985cf59d3e9SOhad Ben-Cohen # ifdef __LITTLE_ENDIAN
986cf59d3e9SOhad Ben-Cohen 	if (ehdr->e_ident[EI_DATA] != ELFDATA2LSB) {
987cf59d3e9SOhad Ben-Cohen # else /* BIG ENDIAN */
988cf59d3e9SOhad Ben-Cohen 	if (ehdr->e_ident[EI_DATA] != ELFDATA2MSB) {
989cf59d3e9SOhad Ben-Cohen # endif
990cf59d3e9SOhad Ben-Cohen 		dev_err(dev, "Unsupported firmware endianess\n");
991cf59d3e9SOhad Ben-Cohen 		return -EINVAL;
992cf59d3e9SOhad Ben-Cohen 	}
993cf59d3e9SOhad Ben-Cohen 
9949bc91231SOhad Ben-Cohen 	if (fw->size < ehdr->e_shoff + sizeof(struct elf32_shdr)) {
9959bc91231SOhad Ben-Cohen 		dev_err(dev, "Image is too small\n");
9969bc91231SOhad Ben-Cohen 		return -EINVAL;
9979bc91231SOhad Ben-Cohen 	}
9989bc91231SOhad Ben-Cohen 
999400e64dfSOhad Ben-Cohen 	if (memcmp(ehdr->e_ident, ELFMAG, SELFMAG)) {
1000400e64dfSOhad Ben-Cohen 		dev_err(dev, "Image is corrupted (bad magic)\n");
1001400e64dfSOhad Ben-Cohen 		return -EINVAL;
1002400e64dfSOhad Ben-Cohen 	}
1003400e64dfSOhad Ben-Cohen 
1004400e64dfSOhad Ben-Cohen 	if (ehdr->e_phnum == 0) {
1005400e64dfSOhad Ben-Cohen 		dev_err(dev, "No loadable segments\n");
1006400e64dfSOhad Ben-Cohen 		return -EINVAL;
1007400e64dfSOhad Ben-Cohen 	}
1008400e64dfSOhad Ben-Cohen 
1009400e64dfSOhad Ben-Cohen 	if (ehdr->e_phoff > fw->size) {
1010400e64dfSOhad Ben-Cohen 		dev_err(dev, "Firmware size is too small\n");
1011400e64dfSOhad Ben-Cohen 		return -EINVAL;
1012400e64dfSOhad Ben-Cohen 	}
1013400e64dfSOhad Ben-Cohen 
1014400e64dfSOhad Ben-Cohen 	return 0;
1015400e64dfSOhad Ben-Cohen }
1016400e64dfSOhad Ben-Cohen 
1017400e64dfSOhad Ben-Cohen /*
1018400e64dfSOhad Ben-Cohen  * take a firmware and boot a remote processor with it.
1019400e64dfSOhad Ben-Cohen  */
1020400e64dfSOhad Ben-Cohen static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
1021400e64dfSOhad Ben-Cohen {
1022b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
1023400e64dfSOhad Ben-Cohen 	const char *name = rproc->firmware;
1024400e64dfSOhad Ben-Cohen 	struct elf32_hdr *ehdr;
10251e3e2c7cSOhad Ben-Cohen 	struct resource_table *table;
10261e3e2c7cSOhad Ben-Cohen 	int ret, tablesz;
1027400e64dfSOhad Ben-Cohen 
1028400e64dfSOhad Ben-Cohen 	ret = rproc_fw_sanity_check(rproc, fw);
1029400e64dfSOhad Ben-Cohen 	if (ret)
1030400e64dfSOhad Ben-Cohen 		return ret;
1031400e64dfSOhad Ben-Cohen 
1032400e64dfSOhad Ben-Cohen 	ehdr = (struct elf32_hdr *)fw->data;
1033400e64dfSOhad Ben-Cohen 
1034400e64dfSOhad Ben-Cohen 	dev_info(dev, "Booting fw image %s, size %d\n", name, fw->size);
1035400e64dfSOhad Ben-Cohen 
1036400e64dfSOhad Ben-Cohen 	/*
1037400e64dfSOhad Ben-Cohen 	 * if enabling an IOMMU isn't relevant for this rproc, this is
1038400e64dfSOhad Ben-Cohen 	 * just a nop
1039400e64dfSOhad Ben-Cohen 	 */
1040400e64dfSOhad Ben-Cohen 	ret = rproc_enable_iommu(rproc);
1041400e64dfSOhad Ben-Cohen 	if (ret) {
1042400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't enable iommu: %d\n", ret);
1043400e64dfSOhad Ben-Cohen 		return ret;
1044400e64dfSOhad Ben-Cohen 	}
1045400e64dfSOhad Ben-Cohen 
1046400e64dfSOhad Ben-Cohen 	/*
1047400e64dfSOhad Ben-Cohen 	 * The ELF entry point is the rproc's boot addr (though this is not
1048400e64dfSOhad Ben-Cohen 	 * a configurable property of all remote processors: some will always
1049400e64dfSOhad Ben-Cohen 	 * boot at a specific hardcoded address).
1050400e64dfSOhad Ben-Cohen 	 */
1051400e64dfSOhad Ben-Cohen 	rproc->bootaddr = ehdr->e_entry;
1052400e64dfSOhad Ben-Cohen 
10531e3e2c7cSOhad Ben-Cohen 	/* look for the resource table */
10541e3e2c7cSOhad Ben-Cohen 	table = rproc_find_rsc_table(rproc, fw->data, fw->size, &tablesz);
10551e3e2c7cSOhad Ben-Cohen 	if (!table)
10561e3e2c7cSOhad Ben-Cohen 		goto clean_up;
10571e3e2c7cSOhad Ben-Cohen 
1058400e64dfSOhad Ben-Cohen 	/* handle fw resources which are required to boot rproc */
10591e3e2c7cSOhad Ben-Cohen 	ret = rproc_handle_boot_rsc(rproc, table, tablesz);
1060400e64dfSOhad Ben-Cohen 	if (ret) {
1061400e64dfSOhad Ben-Cohen 		dev_err(dev, "Failed to process resources: %d\n", ret);
1062400e64dfSOhad Ben-Cohen 		goto clean_up;
1063400e64dfSOhad Ben-Cohen 	}
1064400e64dfSOhad Ben-Cohen 
1065400e64dfSOhad Ben-Cohen 	/* load the ELF segments to memory */
10669bc91231SOhad Ben-Cohen 	ret = rproc_load_segments(rproc, fw->data, fw->size);
1067400e64dfSOhad Ben-Cohen 	if (ret) {
1068400e64dfSOhad Ben-Cohen 		dev_err(dev, "Failed to load program segments: %d\n", ret);
1069400e64dfSOhad Ben-Cohen 		goto clean_up;
1070400e64dfSOhad Ben-Cohen 	}
1071400e64dfSOhad Ben-Cohen 
1072400e64dfSOhad Ben-Cohen 	/* power up the remote processor */
1073400e64dfSOhad Ben-Cohen 	ret = rproc->ops->start(rproc);
1074400e64dfSOhad Ben-Cohen 	if (ret) {
1075400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret);
1076400e64dfSOhad Ben-Cohen 		goto clean_up;
1077400e64dfSOhad Ben-Cohen 	}
1078400e64dfSOhad Ben-Cohen 
1079400e64dfSOhad Ben-Cohen 	rproc->state = RPROC_RUNNING;
1080400e64dfSOhad Ben-Cohen 
1081400e64dfSOhad Ben-Cohen 	dev_info(dev, "remote processor %s is now up\n", rproc->name);
1082400e64dfSOhad Ben-Cohen 
1083400e64dfSOhad Ben-Cohen 	return 0;
1084400e64dfSOhad Ben-Cohen 
1085400e64dfSOhad Ben-Cohen clean_up:
1086400e64dfSOhad Ben-Cohen 	rproc_resource_cleanup(rproc);
1087400e64dfSOhad Ben-Cohen 	rproc_disable_iommu(rproc);
1088400e64dfSOhad Ben-Cohen 	return ret;
1089400e64dfSOhad Ben-Cohen }
1090400e64dfSOhad Ben-Cohen 
1091400e64dfSOhad Ben-Cohen /*
1092400e64dfSOhad Ben-Cohen  * take a firmware and look for virtio devices to register.
1093400e64dfSOhad Ben-Cohen  *
1094400e64dfSOhad Ben-Cohen  * Note: this function is called asynchronously upon registration of the
1095400e64dfSOhad Ben-Cohen  * remote processor (so we must wait until it completes before we try
1096400e64dfSOhad Ben-Cohen  * to unregister the device. one other option is just to use kref here,
1097400e64dfSOhad Ben-Cohen  * that might be cleaner).
1098400e64dfSOhad Ben-Cohen  */
1099400e64dfSOhad Ben-Cohen static void rproc_fw_config_virtio(const struct firmware *fw, void *context)
1100400e64dfSOhad Ben-Cohen {
1101400e64dfSOhad Ben-Cohen 	struct rproc *rproc = context;
11021e3e2c7cSOhad Ben-Cohen 	struct resource_table *table;
11031e3e2c7cSOhad Ben-Cohen 	int ret, tablesz;
1104400e64dfSOhad Ben-Cohen 
1105400e64dfSOhad Ben-Cohen 	if (rproc_fw_sanity_check(rproc, fw) < 0)
1106400e64dfSOhad Ben-Cohen 		goto out;
1107400e64dfSOhad Ben-Cohen 
11081e3e2c7cSOhad Ben-Cohen 	/* look for the resource table */
11091e3e2c7cSOhad Ben-Cohen 	table = rproc_find_rsc_table(rproc, fw->data, fw->size, &tablesz);
11101e3e2c7cSOhad Ben-Cohen 	if (!table)
1111400e64dfSOhad Ben-Cohen 		goto out;
11121e3e2c7cSOhad Ben-Cohen 
11131e3e2c7cSOhad Ben-Cohen 	/* look for virtio devices and register them */
11141e3e2c7cSOhad Ben-Cohen 	ret = rproc_handle_virtio_rsc(rproc, table, tablesz);
11151e3e2c7cSOhad Ben-Cohen 	if (ret)
11161e3e2c7cSOhad Ben-Cohen 		goto out;
1117400e64dfSOhad Ben-Cohen 
1118400e64dfSOhad Ben-Cohen out:
1119400e64dfSOhad Ben-Cohen 	release_firmware(fw);
1120400e64dfSOhad Ben-Cohen 	/* allow rproc_unregister() contexts, if any, to proceed */
1121400e64dfSOhad Ben-Cohen 	complete_all(&rproc->firmware_loading_complete);
1122400e64dfSOhad Ben-Cohen }
1123400e64dfSOhad Ben-Cohen 
1124400e64dfSOhad Ben-Cohen /**
1125400e64dfSOhad Ben-Cohen  * rproc_boot() - boot a remote processor
1126400e64dfSOhad Ben-Cohen  * @rproc: handle of a remote processor
1127400e64dfSOhad Ben-Cohen  *
1128400e64dfSOhad Ben-Cohen  * Boot a remote processor (i.e. load its firmware, power it on, ...).
1129400e64dfSOhad Ben-Cohen  *
1130400e64dfSOhad Ben-Cohen  * If the remote processor is already powered on, this function immediately
1131400e64dfSOhad Ben-Cohen  * returns (successfully).
1132400e64dfSOhad Ben-Cohen  *
1133400e64dfSOhad Ben-Cohen  * Returns 0 on success, and an appropriate error value otherwise.
1134400e64dfSOhad Ben-Cohen  */
1135400e64dfSOhad Ben-Cohen int rproc_boot(struct rproc *rproc)
1136400e64dfSOhad Ben-Cohen {
1137400e64dfSOhad Ben-Cohen 	const struct firmware *firmware_p;
1138400e64dfSOhad Ben-Cohen 	struct device *dev;
1139400e64dfSOhad Ben-Cohen 	int ret;
1140400e64dfSOhad Ben-Cohen 
1141400e64dfSOhad Ben-Cohen 	if (!rproc) {
1142400e64dfSOhad Ben-Cohen 		pr_err("invalid rproc handle\n");
1143400e64dfSOhad Ben-Cohen 		return -EINVAL;
1144400e64dfSOhad Ben-Cohen 	}
1145400e64dfSOhad Ben-Cohen 
1146b5ab5e24SOhad Ben-Cohen 	dev = &rproc->dev;
1147400e64dfSOhad Ben-Cohen 
1148400e64dfSOhad Ben-Cohen 	ret = mutex_lock_interruptible(&rproc->lock);
1149400e64dfSOhad Ben-Cohen 	if (ret) {
1150400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1151400e64dfSOhad Ben-Cohen 		return ret;
1152400e64dfSOhad Ben-Cohen 	}
1153400e64dfSOhad Ben-Cohen 
1154400e64dfSOhad Ben-Cohen 	/* loading a firmware is required */
1155400e64dfSOhad Ben-Cohen 	if (!rproc->firmware) {
1156400e64dfSOhad Ben-Cohen 		dev_err(dev, "%s: no firmware to load\n", __func__);
1157400e64dfSOhad Ben-Cohen 		ret = -EINVAL;
1158400e64dfSOhad Ben-Cohen 		goto unlock_mutex;
1159400e64dfSOhad Ben-Cohen 	}
1160400e64dfSOhad Ben-Cohen 
1161400e64dfSOhad Ben-Cohen 	/* prevent underlying implementation from being removed */
1162b5ab5e24SOhad Ben-Cohen 	if (!try_module_get(dev->parent->driver->owner)) {
1163400e64dfSOhad Ben-Cohen 		dev_err(dev, "%s: can't get owner\n", __func__);
1164400e64dfSOhad Ben-Cohen 		ret = -EINVAL;
1165400e64dfSOhad Ben-Cohen 		goto unlock_mutex;
1166400e64dfSOhad Ben-Cohen 	}
1167400e64dfSOhad Ben-Cohen 
1168400e64dfSOhad Ben-Cohen 	/* skip the boot process if rproc is already powered up */
1169400e64dfSOhad Ben-Cohen 	if (atomic_inc_return(&rproc->power) > 1) {
1170400e64dfSOhad Ben-Cohen 		ret = 0;
1171400e64dfSOhad Ben-Cohen 		goto unlock_mutex;
1172400e64dfSOhad Ben-Cohen 	}
1173400e64dfSOhad Ben-Cohen 
1174400e64dfSOhad Ben-Cohen 	dev_info(dev, "powering up %s\n", rproc->name);
1175400e64dfSOhad Ben-Cohen 
1176400e64dfSOhad Ben-Cohen 	/* load firmware */
1177400e64dfSOhad Ben-Cohen 	ret = request_firmware(&firmware_p, rproc->firmware, dev);
1178400e64dfSOhad Ben-Cohen 	if (ret < 0) {
1179400e64dfSOhad Ben-Cohen 		dev_err(dev, "request_firmware failed: %d\n", ret);
1180400e64dfSOhad Ben-Cohen 		goto downref_rproc;
1181400e64dfSOhad Ben-Cohen 	}
1182400e64dfSOhad Ben-Cohen 
1183400e64dfSOhad Ben-Cohen 	ret = rproc_fw_boot(rproc, firmware_p);
1184400e64dfSOhad Ben-Cohen 
1185400e64dfSOhad Ben-Cohen 	release_firmware(firmware_p);
1186400e64dfSOhad Ben-Cohen 
1187400e64dfSOhad Ben-Cohen downref_rproc:
1188400e64dfSOhad Ben-Cohen 	if (ret) {
1189b5ab5e24SOhad Ben-Cohen 		module_put(dev->parent->driver->owner);
1190400e64dfSOhad Ben-Cohen 		atomic_dec(&rproc->power);
1191400e64dfSOhad Ben-Cohen 	}
1192400e64dfSOhad Ben-Cohen unlock_mutex:
1193400e64dfSOhad Ben-Cohen 	mutex_unlock(&rproc->lock);
1194400e64dfSOhad Ben-Cohen 	return ret;
1195400e64dfSOhad Ben-Cohen }
1196400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_boot);
1197400e64dfSOhad Ben-Cohen 
1198400e64dfSOhad Ben-Cohen /**
1199400e64dfSOhad Ben-Cohen  * rproc_shutdown() - power off the remote processor
1200400e64dfSOhad Ben-Cohen  * @rproc: the remote processor
1201400e64dfSOhad Ben-Cohen  *
1202400e64dfSOhad Ben-Cohen  * Power off a remote processor (previously booted with rproc_boot()).
1203400e64dfSOhad Ben-Cohen  *
1204400e64dfSOhad Ben-Cohen  * In case @rproc is still being used by an additional user(s), then
1205400e64dfSOhad Ben-Cohen  * this function will just decrement the power refcount and exit,
1206400e64dfSOhad Ben-Cohen  * without really powering off the device.
1207400e64dfSOhad Ben-Cohen  *
1208400e64dfSOhad Ben-Cohen  * Every call to rproc_boot() must (eventually) be accompanied by a call
1209400e64dfSOhad Ben-Cohen  * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug.
1210400e64dfSOhad Ben-Cohen  *
1211400e64dfSOhad Ben-Cohen  * Notes:
1212400e64dfSOhad Ben-Cohen  * - we're not decrementing the rproc's refcount, only the power refcount.
1213400e64dfSOhad Ben-Cohen  *   which means that the @rproc handle stays valid even after rproc_shutdown()
1214400e64dfSOhad Ben-Cohen  *   returns, and users can still use it with a subsequent rproc_boot(), if
1215400e64dfSOhad Ben-Cohen  *   needed.
1216400e64dfSOhad Ben-Cohen  * - don't call rproc_shutdown() to unroll rproc_get_by_name(), exactly
1217400e64dfSOhad Ben-Cohen  *   because rproc_shutdown() _does not_ decrement the refcount of @rproc.
1218400e64dfSOhad Ben-Cohen  *   To decrement the refcount of @rproc, use rproc_put() (but _only_ if
1219400e64dfSOhad Ben-Cohen  *   you acquired @rproc using rproc_get_by_name()).
1220400e64dfSOhad Ben-Cohen  */
1221400e64dfSOhad Ben-Cohen void rproc_shutdown(struct rproc *rproc)
1222400e64dfSOhad Ben-Cohen {
1223b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
1224400e64dfSOhad Ben-Cohen 	int ret;
1225400e64dfSOhad Ben-Cohen 
1226400e64dfSOhad Ben-Cohen 	ret = mutex_lock_interruptible(&rproc->lock);
1227400e64dfSOhad Ben-Cohen 	if (ret) {
1228400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret);
1229400e64dfSOhad Ben-Cohen 		return;
1230400e64dfSOhad Ben-Cohen 	}
1231400e64dfSOhad Ben-Cohen 
1232400e64dfSOhad Ben-Cohen 	/* if the remote proc is still needed, bail out */
1233400e64dfSOhad Ben-Cohen 	if (!atomic_dec_and_test(&rproc->power))
1234400e64dfSOhad Ben-Cohen 		goto out;
1235400e64dfSOhad Ben-Cohen 
1236400e64dfSOhad Ben-Cohen 	/* power off the remote processor */
1237400e64dfSOhad Ben-Cohen 	ret = rproc->ops->stop(rproc);
1238400e64dfSOhad Ben-Cohen 	if (ret) {
1239400e64dfSOhad Ben-Cohen 		atomic_inc(&rproc->power);
1240400e64dfSOhad Ben-Cohen 		dev_err(dev, "can't stop rproc: %d\n", ret);
1241400e64dfSOhad Ben-Cohen 		goto out;
1242400e64dfSOhad Ben-Cohen 	}
1243400e64dfSOhad Ben-Cohen 
1244400e64dfSOhad Ben-Cohen 	/* clean up all acquired resources */
1245400e64dfSOhad Ben-Cohen 	rproc_resource_cleanup(rproc);
1246400e64dfSOhad Ben-Cohen 
1247400e64dfSOhad Ben-Cohen 	rproc_disable_iommu(rproc);
1248400e64dfSOhad Ben-Cohen 
1249400e64dfSOhad Ben-Cohen 	rproc->state = RPROC_OFFLINE;
1250400e64dfSOhad Ben-Cohen 
1251400e64dfSOhad Ben-Cohen 	dev_info(dev, "stopped remote processor %s\n", rproc->name);
1252400e64dfSOhad Ben-Cohen 
1253400e64dfSOhad Ben-Cohen out:
1254400e64dfSOhad Ben-Cohen 	mutex_unlock(&rproc->lock);
1255400e64dfSOhad Ben-Cohen 	if (!ret)
1256b5ab5e24SOhad Ben-Cohen 		module_put(dev->parent->driver->owner);
1257400e64dfSOhad Ben-Cohen }
1258400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_shutdown);
1259400e64dfSOhad Ben-Cohen 
1260400e64dfSOhad Ben-Cohen /* will be called when an rproc is added to the rprocs klist */
1261400e64dfSOhad Ben-Cohen static void klist_rproc_get(struct klist_node *n)
1262400e64dfSOhad Ben-Cohen {
1263400e64dfSOhad Ben-Cohen 	struct rproc *rproc = container_of(n, struct rproc, node);
1264400e64dfSOhad Ben-Cohen 
12657183a2a7SOhad Ben-Cohen 	get_device(&rproc->dev);
1266400e64dfSOhad Ben-Cohen }
1267400e64dfSOhad Ben-Cohen 
1268400e64dfSOhad Ben-Cohen /* will be called when an rproc is removed from the rprocs klist */
1269400e64dfSOhad Ben-Cohen static void klist_rproc_put(struct klist_node *n)
1270400e64dfSOhad Ben-Cohen {
1271400e64dfSOhad Ben-Cohen 	struct rproc *rproc = container_of(n, struct rproc, node);
1272400e64dfSOhad Ben-Cohen 
12737183a2a7SOhad Ben-Cohen 	put_device(&rproc->dev);
1274400e64dfSOhad Ben-Cohen }
1275400e64dfSOhad Ben-Cohen 
1276400e64dfSOhad Ben-Cohen static struct rproc *next_rproc(struct klist_iter *i)
1277400e64dfSOhad Ben-Cohen {
1278400e64dfSOhad Ben-Cohen 	struct klist_node *n;
1279400e64dfSOhad Ben-Cohen 
1280400e64dfSOhad Ben-Cohen 	n = klist_next(i);
1281400e64dfSOhad Ben-Cohen 	if (!n)
1282400e64dfSOhad Ben-Cohen 		return NULL;
1283400e64dfSOhad Ben-Cohen 
1284400e64dfSOhad Ben-Cohen 	return container_of(n, struct rproc, node);
1285400e64dfSOhad Ben-Cohen }
1286400e64dfSOhad Ben-Cohen 
1287400e64dfSOhad Ben-Cohen /**
1288400e64dfSOhad Ben-Cohen  * rproc_get_by_name() - find a remote processor by name and boot it
1289400e64dfSOhad Ben-Cohen  * @name: name of the remote processor
1290400e64dfSOhad Ben-Cohen  *
1291400e64dfSOhad Ben-Cohen  * Finds an rproc handle using the remote processor's name, and then
1292400e64dfSOhad Ben-Cohen  * boot it. If it's already powered on, then just immediately return
1293400e64dfSOhad Ben-Cohen  * (successfully).
1294400e64dfSOhad Ben-Cohen  *
1295400e64dfSOhad Ben-Cohen  * Returns the rproc handle on success, and NULL on failure.
1296400e64dfSOhad Ben-Cohen  *
1297400e64dfSOhad Ben-Cohen  * This function increments the remote processor's refcount, so always
1298400e64dfSOhad Ben-Cohen  * use rproc_put() to decrement it back once rproc isn't needed anymore.
1299400e64dfSOhad Ben-Cohen  *
1300400e64dfSOhad Ben-Cohen  * Note: currently this function (and its counterpart rproc_put()) are not
13017a186941SOhad Ben-Cohen  * being used. We need to scrutinize the use cases
1302400e64dfSOhad Ben-Cohen  * that still need them, and see if we can migrate them to use the non
1303400e64dfSOhad Ben-Cohen  * name-based boot/shutdown interface.
1304400e64dfSOhad Ben-Cohen  */
1305400e64dfSOhad Ben-Cohen struct rproc *rproc_get_by_name(const char *name)
1306400e64dfSOhad Ben-Cohen {
1307400e64dfSOhad Ben-Cohen 	struct rproc *rproc;
1308400e64dfSOhad Ben-Cohen 	struct klist_iter i;
1309400e64dfSOhad Ben-Cohen 	int ret;
1310400e64dfSOhad Ben-Cohen 
1311400e64dfSOhad Ben-Cohen 	/* find the remote processor, and upref its refcount */
1312400e64dfSOhad Ben-Cohen 	klist_iter_init(&rprocs, &i);
1313400e64dfSOhad Ben-Cohen 	while ((rproc = next_rproc(&i)) != NULL)
1314400e64dfSOhad Ben-Cohen 		if (!strcmp(rproc->name, name)) {
13157183a2a7SOhad Ben-Cohen 			get_device(&rproc->dev);
1316400e64dfSOhad Ben-Cohen 			break;
1317400e64dfSOhad Ben-Cohen 		}
1318400e64dfSOhad Ben-Cohen 	klist_iter_exit(&i);
1319400e64dfSOhad Ben-Cohen 
1320400e64dfSOhad Ben-Cohen 	/* can't find this rproc ? */
1321400e64dfSOhad Ben-Cohen 	if (!rproc) {
1322400e64dfSOhad Ben-Cohen 		pr_err("can't find remote processor %s\n", name);
1323400e64dfSOhad Ben-Cohen 		return NULL;
1324400e64dfSOhad Ben-Cohen 	}
1325400e64dfSOhad Ben-Cohen 
1326400e64dfSOhad Ben-Cohen 	ret = rproc_boot(rproc);
1327400e64dfSOhad Ben-Cohen 	if (ret < 0) {
13287183a2a7SOhad Ben-Cohen 		put_device(&rproc->dev);
1329400e64dfSOhad Ben-Cohen 		return NULL;
1330400e64dfSOhad Ben-Cohen 	}
1331400e64dfSOhad Ben-Cohen 
1332400e64dfSOhad Ben-Cohen 	return rproc;
1333400e64dfSOhad Ben-Cohen }
1334400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_get_by_name);
1335400e64dfSOhad Ben-Cohen 
1336400e64dfSOhad Ben-Cohen /**
1337400e64dfSOhad Ben-Cohen  * rproc_put() - decrement the refcount of a remote processor, and shut it down
1338400e64dfSOhad Ben-Cohen  * @rproc: the remote processor
1339400e64dfSOhad Ben-Cohen  *
1340400e64dfSOhad Ben-Cohen  * This function tries to shutdown @rproc, and it then decrements its
1341400e64dfSOhad Ben-Cohen  * refcount.
1342400e64dfSOhad Ben-Cohen  *
1343400e64dfSOhad Ben-Cohen  * After this function returns, @rproc may _not_ be used anymore, and its
1344400e64dfSOhad Ben-Cohen  * handle should be considered invalid.
1345400e64dfSOhad Ben-Cohen  *
1346400e64dfSOhad Ben-Cohen  * This function should be called _iff_ the @rproc handle was grabbed by
1347400e64dfSOhad Ben-Cohen  * calling rproc_get_by_name().
1348400e64dfSOhad Ben-Cohen  */
1349400e64dfSOhad Ben-Cohen void rproc_put(struct rproc *rproc)
1350400e64dfSOhad Ben-Cohen {
1351400e64dfSOhad Ben-Cohen 	/* try to power off the remote processor */
1352400e64dfSOhad Ben-Cohen 	rproc_shutdown(rproc);
1353400e64dfSOhad Ben-Cohen 
1354400e64dfSOhad Ben-Cohen 	/* downref rproc's refcount */
13557183a2a7SOhad Ben-Cohen 	put_device(&rproc->dev);
1356400e64dfSOhad Ben-Cohen }
1357400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_put);
1358400e64dfSOhad Ben-Cohen 
1359400e64dfSOhad Ben-Cohen /**
1360400e64dfSOhad Ben-Cohen  * rproc_register() - register a remote processor
1361400e64dfSOhad Ben-Cohen  * @rproc: the remote processor handle to register
1362400e64dfSOhad Ben-Cohen  *
1363400e64dfSOhad Ben-Cohen  * Registers @rproc with the remoteproc framework, after it has been
1364400e64dfSOhad Ben-Cohen  * allocated with rproc_alloc().
1365400e64dfSOhad Ben-Cohen  *
1366400e64dfSOhad Ben-Cohen  * This is called by the platform-specific rproc implementation, whenever
1367400e64dfSOhad Ben-Cohen  * a new remote processor device is probed.
1368400e64dfSOhad Ben-Cohen  *
1369400e64dfSOhad Ben-Cohen  * Returns 0 on success and an appropriate error code otherwise.
1370400e64dfSOhad Ben-Cohen  *
1371400e64dfSOhad Ben-Cohen  * Note: this function initiates an asynchronous firmware loading
1372400e64dfSOhad Ben-Cohen  * context, which will look for virtio devices supported by the rproc's
1373400e64dfSOhad Ben-Cohen  * firmware.
1374400e64dfSOhad Ben-Cohen  *
1375400e64dfSOhad Ben-Cohen  * If found, those virtio devices will be created and added, so as a result
13767a186941SOhad Ben-Cohen  * of registering this remote processor, additional virtio drivers might be
1377400e64dfSOhad Ben-Cohen  * probed.
1378400e64dfSOhad Ben-Cohen  */
1379400e64dfSOhad Ben-Cohen int rproc_register(struct rproc *rproc)
1380400e64dfSOhad Ben-Cohen {
1381b5ab5e24SOhad Ben-Cohen 	struct device *dev = &rproc->dev;
1382400e64dfSOhad Ben-Cohen 	int ret = 0;
1383400e64dfSOhad Ben-Cohen 
1384b5ab5e24SOhad Ben-Cohen 	ret = device_add(dev);
1385b5ab5e24SOhad Ben-Cohen 	if (ret < 0)
1386b5ab5e24SOhad Ben-Cohen 		return ret;
1387b5ab5e24SOhad Ben-Cohen 
1388400e64dfSOhad Ben-Cohen 	/* expose to rproc_get_by_name users */
1389400e64dfSOhad Ben-Cohen 	klist_add_tail(&rproc->node, &rprocs);
1390400e64dfSOhad Ben-Cohen 
1391b5ab5e24SOhad Ben-Cohen 	dev_info(dev, "%s is available\n", rproc->name);
1392400e64dfSOhad Ben-Cohen 
1393489d129aSOhad Ben-Cohen 	dev_info(dev, "Note: remoteproc is still under development and considered experimental.\n");
1394489d129aSOhad Ben-Cohen 	dev_info(dev, "THE BINARY FORMAT IS NOT YET FINALIZED, and backward compatibility isn't yet guaranteed.\n");
1395489d129aSOhad Ben-Cohen 
1396400e64dfSOhad Ben-Cohen 	/* create debugfs entries */
1397400e64dfSOhad Ben-Cohen 	rproc_create_debug_dir(rproc);
1398400e64dfSOhad Ben-Cohen 
1399400e64dfSOhad Ben-Cohen 	/* rproc_unregister() calls must wait until async loader completes */
1400400e64dfSOhad Ben-Cohen 	init_completion(&rproc->firmware_loading_complete);
1401400e64dfSOhad Ben-Cohen 
1402400e64dfSOhad Ben-Cohen 	/*
1403400e64dfSOhad Ben-Cohen 	 * We must retrieve early virtio configuration info from
14047a186941SOhad Ben-Cohen 	 * the firmware (e.g. whether to register a virtio device,
1405400e64dfSOhad Ben-Cohen 	 * what virtio features does it support, ...).
1406400e64dfSOhad Ben-Cohen 	 *
1407400e64dfSOhad Ben-Cohen 	 * We're initiating an asynchronous firmware loading, so we can
1408400e64dfSOhad Ben-Cohen 	 * be built-in kernel code, without hanging the boot process.
1409400e64dfSOhad Ben-Cohen 	 */
1410400e64dfSOhad Ben-Cohen 	ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG,
1411400e64dfSOhad Ben-Cohen 					rproc->firmware, dev, GFP_KERNEL,
1412400e64dfSOhad Ben-Cohen 					rproc, rproc_fw_config_virtio);
1413400e64dfSOhad Ben-Cohen 	if (ret < 0) {
1414400e64dfSOhad Ben-Cohen 		dev_err(dev, "request_firmware_nowait failed: %d\n", ret);
1415400e64dfSOhad Ben-Cohen 		complete_all(&rproc->firmware_loading_complete);
1416400e64dfSOhad Ben-Cohen 		klist_remove(&rproc->node);
1417400e64dfSOhad Ben-Cohen 	}
1418400e64dfSOhad Ben-Cohen 
1419400e64dfSOhad Ben-Cohen 	return ret;
1420400e64dfSOhad Ben-Cohen }
1421400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_register);
1422400e64dfSOhad Ben-Cohen 
1423400e64dfSOhad Ben-Cohen /**
1424b5ab5e24SOhad Ben-Cohen  * rproc_type_release() - release a remote processor instance
1425b5ab5e24SOhad Ben-Cohen  * @dev: the rproc's device
1426b5ab5e24SOhad Ben-Cohen  *
1427b5ab5e24SOhad Ben-Cohen  * This function should _never_ be called directly.
1428b5ab5e24SOhad Ben-Cohen  *
1429b5ab5e24SOhad Ben-Cohen  * It will be called by the driver core when no one holds a valid pointer
1430b5ab5e24SOhad Ben-Cohen  * to @dev anymore.
1431b5ab5e24SOhad Ben-Cohen  */
1432b5ab5e24SOhad Ben-Cohen static void rproc_type_release(struct device *dev)
1433b5ab5e24SOhad Ben-Cohen {
1434b5ab5e24SOhad Ben-Cohen 	struct rproc *rproc = container_of(dev, struct rproc, dev);
1435b5ab5e24SOhad Ben-Cohen 
14367183a2a7SOhad Ben-Cohen 	dev_info(&rproc->dev, "releasing %s\n", rproc->name);
14377183a2a7SOhad Ben-Cohen 
14387183a2a7SOhad Ben-Cohen 	rproc_delete_debug_dir(rproc);
14397183a2a7SOhad Ben-Cohen 
1440b5ab5e24SOhad Ben-Cohen 	idr_remove_all(&rproc->notifyids);
1441b5ab5e24SOhad Ben-Cohen 	idr_destroy(&rproc->notifyids);
1442b5ab5e24SOhad Ben-Cohen 
1443b5ab5e24SOhad Ben-Cohen 	if (rproc->index >= 0)
1444b5ab5e24SOhad Ben-Cohen 		ida_simple_remove(&rproc_dev_index, rproc->index);
1445b5ab5e24SOhad Ben-Cohen 
1446b5ab5e24SOhad Ben-Cohen 	kfree(rproc);
1447b5ab5e24SOhad Ben-Cohen }
1448b5ab5e24SOhad Ben-Cohen 
1449b5ab5e24SOhad Ben-Cohen static struct device_type rproc_type = {
1450b5ab5e24SOhad Ben-Cohen 	.name		= "remoteproc",
1451b5ab5e24SOhad Ben-Cohen 	.release	= rproc_type_release,
1452b5ab5e24SOhad Ben-Cohen };
1453b5ab5e24SOhad Ben-Cohen 
1454b5ab5e24SOhad Ben-Cohen /**
1455400e64dfSOhad Ben-Cohen  * rproc_alloc() - allocate a remote processor handle
1456400e64dfSOhad Ben-Cohen  * @dev: the underlying device
1457400e64dfSOhad Ben-Cohen  * @name: name of this remote processor
1458400e64dfSOhad Ben-Cohen  * @ops: platform-specific handlers (mainly start/stop)
1459400e64dfSOhad Ben-Cohen  * @firmware: name of firmware file to load
1460400e64dfSOhad Ben-Cohen  * @len: length of private data needed by the rproc driver (in bytes)
1461400e64dfSOhad Ben-Cohen  *
1462400e64dfSOhad Ben-Cohen  * Allocates a new remote processor handle, but does not register
1463400e64dfSOhad Ben-Cohen  * it yet.
1464400e64dfSOhad Ben-Cohen  *
1465400e64dfSOhad Ben-Cohen  * This function should be used by rproc implementations during initialization
1466400e64dfSOhad Ben-Cohen  * of the remote processor.
1467400e64dfSOhad Ben-Cohen  *
1468400e64dfSOhad Ben-Cohen  * After creating an rproc handle using this function, and when ready,
1469400e64dfSOhad Ben-Cohen  * implementations should then call rproc_register() to complete
1470400e64dfSOhad Ben-Cohen  * the registration of the remote processor.
1471400e64dfSOhad Ben-Cohen  *
1472400e64dfSOhad Ben-Cohen  * On success the new rproc is returned, and on failure, NULL.
1473400e64dfSOhad Ben-Cohen  *
1474400e64dfSOhad Ben-Cohen  * Note: _never_ directly deallocate @rproc, even if it was not registered
1475400e64dfSOhad Ben-Cohen  * yet. Instead, if you just need to unroll rproc_alloc(), use rproc_free().
1476400e64dfSOhad Ben-Cohen  */
1477400e64dfSOhad Ben-Cohen struct rproc *rproc_alloc(struct device *dev, const char *name,
1478400e64dfSOhad Ben-Cohen 				const struct rproc_ops *ops,
1479400e64dfSOhad Ben-Cohen 				const char *firmware, int len)
1480400e64dfSOhad Ben-Cohen {
1481400e64dfSOhad Ben-Cohen 	struct rproc *rproc;
1482400e64dfSOhad Ben-Cohen 
1483400e64dfSOhad Ben-Cohen 	if (!dev || !name || !ops)
1484400e64dfSOhad Ben-Cohen 		return NULL;
1485400e64dfSOhad Ben-Cohen 
1486400e64dfSOhad Ben-Cohen 	rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL);
1487400e64dfSOhad Ben-Cohen 	if (!rproc) {
1488400e64dfSOhad Ben-Cohen 		dev_err(dev, "%s: kzalloc failed\n", __func__);
1489400e64dfSOhad Ben-Cohen 		return NULL;
1490400e64dfSOhad Ben-Cohen 	}
1491400e64dfSOhad Ben-Cohen 
1492400e64dfSOhad Ben-Cohen 	rproc->name = name;
1493400e64dfSOhad Ben-Cohen 	rproc->ops = ops;
1494400e64dfSOhad Ben-Cohen 	rproc->firmware = firmware;
1495400e64dfSOhad Ben-Cohen 	rproc->priv = &rproc[1];
1496400e64dfSOhad Ben-Cohen 
1497b5ab5e24SOhad Ben-Cohen 	device_initialize(&rproc->dev);
1498b5ab5e24SOhad Ben-Cohen 	rproc->dev.parent = dev;
1499b5ab5e24SOhad Ben-Cohen 	rproc->dev.type = &rproc_type;
1500b5ab5e24SOhad Ben-Cohen 
1501b5ab5e24SOhad Ben-Cohen 	/* Assign a unique device index and name */
1502b5ab5e24SOhad Ben-Cohen 	rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL);
1503b5ab5e24SOhad Ben-Cohen 	if (rproc->index < 0) {
1504b5ab5e24SOhad Ben-Cohen 		dev_err(dev, "ida_simple_get failed: %d\n", rproc->index);
1505b5ab5e24SOhad Ben-Cohen 		put_device(&rproc->dev);
1506b5ab5e24SOhad Ben-Cohen 		return NULL;
1507b5ab5e24SOhad Ben-Cohen 	}
1508b5ab5e24SOhad Ben-Cohen 
1509b5ab5e24SOhad Ben-Cohen 	dev_set_name(&rproc->dev, "remoteproc%d", rproc->index);
1510b5ab5e24SOhad Ben-Cohen 
1511400e64dfSOhad Ben-Cohen 	atomic_set(&rproc->power, 0);
1512400e64dfSOhad Ben-Cohen 
1513400e64dfSOhad Ben-Cohen 	mutex_init(&rproc->lock);
1514400e64dfSOhad Ben-Cohen 
15157a186941SOhad Ben-Cohen 	idr_init(&rproc->notifyids);
15167a186941SOhad Ben-Cohen 
1517400e64dfSOhad Ben-Cohen 	INIT_LIST_HEAD(&rproc->carveouts);
1518400e64dfSOhad Ben-Cohen 	INIT_LIST_HEAD(&rproc->mappings);
1519400e64dfSOhad Ben-Cohen 	INIT_LIST_HEAD(&rproc->traces);
15207a186941SOhad Ben-Cohen 	INIT_LIST_HEAD(&rproc->rvdevs);
1521400e64dfSOhad Ben-Cohen 
1522400e64dfSOhad Ben-Cohen 	rproc->state = RPROC_OFFLINE;
1523400e64dfSOhad Ben-Cohen 
1524400e64dfSOhad Ben-Cohen 	return rproc;
1525400e64dfSOhad Ben-Cohen }
1526400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_alloc);
1527400e64dfSOhad Ben-Cohen 
1528400e64dfSOhad Ben-Cohen /**
1529400e64dfSOhad Ben-Cohen  * rproc_free() - free an rproc handle that was allocated by rproc_alloc
1530400e64dfSOhad Ben-Cohen  * @rproc: the remote processor handle
1531400e64dfSOhad Ben-Cohen  *
1532400e64dfSOhad Ben-Cohen  * This function should _only_ be used if @rproc was only allocated,
1533400e64dfSOhad Ben-Cohen  * but not registered yet.
1534400e64dfSOhad Ben-Cohen  *
1535400e64dfSOhad Ben-Cohen  * If @rproc was already successfully registered (by calling rproc_register()),
1536400e64dfSOhad Ben-Cohen  * then use rproc_unregister() instead.
1537400e64dfSOhad Ben-Cohen  */
1538400e64dfSOhad Ben-Cohen void rproc_free(struct rproc *rproc)
1539400e64dfSOhad Ben-Cohen {
1540b5ab5e24SOhad Ben-Cohen 	put_device(&rproc->dev);
1541400e64dfSOhad Ben-Cohen }
1542400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_free);
1543400e64dfSOhad Ben-Cohen 
1544400e64dfSOhad Ben-Cohen /**
1545400e64dfSOhad Ben-Cohen  * rproc_unregister() - unregister a remote processor
1546400e64dfSOhad Ben-Cohen  * @rproc: rproc handle to unregister
1547400e64dfSOhad Ben-Cohen  *
1548400e64dfSOhad Ben-Cohen  * Unregisters a remote processor, and decrements its refcount.
1549400e64dfSOhad Ben-Cohen  * If its refcount drops to zero, then @rproc will be freed. If not,
1550400e64dfSOhad Ben-Cohen  * it will be freed later once the last reference is dropped.
1551400e64dfSOhad Ben-Cohen  *
1552400e64dfSOhad Ben-Cohen  * This function should be called when the platform specific rproc
1553400e64dfSOhad Ben-Cohen  * implementation decides to remove the rproc device. it should
1554400e64dfSOhad Ben-Cohen  * _only_ be called if a previous invocation of rproc_register()
1555400e64dfSOhad Ben-Cohen  * has completed successfully.
1556400e64dfSOhad Ben-Cohen  *
1557400e64dfSOhad Ben-Cohen  * After rproc_unregister() returns, @rproc is _not_ valid anymore and
1558400e64dfSOhad Ben-Cohen  * it shouldn't be used. More specifically, don't call rproc_free()
1559400e64dfSOhad Ben-Cohen  * or try to directly free @rproc after rproc_unregister() returns;
1560400e64dfSOhad Ben-Cohen  * none of these are needed, and calling them is a bug.
1561400e64dfSOhad Ben-Cohen  *
1562400e64dfSOhad Ben-Cohen  * Returns 0 on success and -EINVAL if @rproc isn't valid.
1563400e64dfSOhad Ben-Cohen  */
1564400e64dfSOhad Ben-Cohen int rproc_unregister(struct rproc *rproc)
1565400e64dfSOhad Ben-Cohen {
15666db20ea8SOhad Ben-Cohen 	struct rproc_vdev *rvdev, *tmp;
15677a186941SOhad Ben-Cohen 
1568400e64dfSOhad Ben-Cohen 	if (!rproc)
1569400e64dfSOhad Ben-Cohen 		return -EINVAL;
1570400e64dfSOhad Ben-Cohen 
1571400e64dfSOhad Ben-Cohen 	/* if rproc is just being registered, wait */
1572400e64dfSOhad Ben-Cohen 	wait_for_completion(&rproc->firmware_loading_complete);
1573400e64dfSOhad Ben-Cohen 
15747a186941SOhad Ben-Cohen 	/* clean up remote vdev entries */
15756db20ea8SOhad Ben-Cohen 	list_for_each_entry_safe(rvdev, tmp, &rproc->rvdevs, node)
15767a186941SOhad Ben-Cohen 		rproc_remove_virtio_dev(rvdev);
1577400e64dfSOhad Ben-Cohen 
15787a186941SOhad Ben-Cohen 	/* the rproc is downref'ed as soon as it's removed from the klist */
15797a186941SOhad Ben-Cohen 	klist_del(&rproc->node);
1580400e64dfSOhad Ben-Cohen 
1581b5ab5e24SOhad Ben-Cohen 	device_del(&rproc->dev);
1582b5ab5e24SOhad Ben-Cohen 
15837183a2a7SOhad Ben-Cohen 	/* unroll rproc_alloc. TODO: we may want to let the users do that */
15847183a2a7SOhad Ben-Cohen 	put_device(&rproc->dev);
1585400e64dfSOhad Ben-Cohen 
1586400e64dfSOhad Ben-Cohen 	return 0;
1587400e64dfSOhad Ben-Cohen }
1588400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_unregister);
1589400e64dfSOhad Ben-Cohen 
1590400e64dfSOhad Ben-Cohen static int __init remoteproc_init(void)
1591400e64dfSOhad Ben-Cohen {
1592400e64dfSOhad Ben-Cohen 	rproc_init_debugfs();
1593b5ab5e24SOhad Ben-Cohen 
1594400e64dfSOhad Ben-Cohen 	return 0;
1595400e64dfSOhad Ben-Cohen }
1596400e64dfSOhad Ben-Cohen module_init(remoteproc_init);
1597400e64dfSOhad Ben-Cohen 
1598400e64dfSOhad Ben-Cohen static void __exit remoteproc_exit(void)
1599400e64dfSOhad Ben-Cohen {
1600400e64dfSOhad Ben-Cohen 	rproc_exit_debugfs();
1601400e64dfSOhad Ben-Cohen }
1602400e64dfSOhad Ben-Cohen module_exit(remoteproc_exit);
1603400e64dfSOhad Ben-Cohen 
1604400e64dfSOhad Ben-Cohen MODULE_LICENSE("GPL v2");
1605400e64dfSOhad Ben-Cohen MODULE_DESCRIPTION("Generic Remote Processor Framework");
1606