Commit | Line | Data |
---|---|---|
1802d0be | 1 | // SPDX-License-Identifier: GPL-2.0-only |
400e64df OBC |
2 | /* |
3 | * Remote Processor Framework | |
4 | * | |
5 | * Copyright (C) 2011 Texas Instruments, Inc. | |
6 | * Copyright (C) 2011 Google, Inc. | |
7 | * | |
8 | * Ohad Ben-Cohen <ohad@wizery.com> | |
9 | * Brian Swetland <swetland@google.com> | |
10 | * Mark Grosen <mgrosen@ti.com> | |
11 | * Fernando Guzman Lugo <fernando.lugo@ti.com> | |
12 | * Suman Anna <s-anna@ti.com> | |
13 | * Robert Tivy <rtivy@ti.com> | |
14 | * Armando Uribe De Leon <x0095078@ti.com> | |
400e64df OBC |
15 | */ |
16 | ||
17 | #define pr_fmt(fmt) "%s: " fmt, __func__ | |
18 | ||
dc5192c4 | 19 | #include <linux/delay.h> |
400e64df OBC |
20 | #include <linux/kernel.h> |
21 | #include <linux/module.h> | |
22 | #include <linux/device.h> | |
f39650de | 23 | #include <linux/panic_notifier.h> |
400e64df OBC |
24 | #include <linux/slab.h> |
25 | #include <linux/mutex.h> | |
26 | #include <linux/dma-mapping.h> | |
27 | #include <linux/firmware.h> | |
28 | #include <linux/string.h> | |
29 | #include <linux/debugfs.h> | |
c0abe2ca | 30 | #include <linux/rculist.h> |
400e64df OBC |
31 | #include <linux/remoteproc.h> |
32 | #include <linux/iommu.h> | |
b5ab5e24 | 33 | #include <linux/idr.h> |
400e64df | 34 | #include <linux/elf.h> |
a2b950ac | 35 | #include <linux/crc32.h> |
086d0872 | 36 | #include <linux/of_reserved_mem.h> |
400e64df OBC |
37 | #include <linux/virtio_ids.h> |
38 | #include <linux/virtio_ring.h> | |
cf59d3e9 | 39 | #include <asm/byteorder.h> |
086d0872 | 40 | #include <linux/platform_device.h> |
400e64df OBC |
41 | |
42 | #include "remoteproc_internal.h" | |
43 | ||
b36de8cf LP |
44 | #define HIGH_BITS_MASK 0xFFFFFFFF00000000ULL |
45 | ||
fec47d86 DG |
46 | static DEFINE_MUTEX(rproc_list_mutex); |
47 | static LIST_HEAD(rproc_list); | |
dc5192c4 | 48 | static struct notifier_block rproc_panic_nb; |
fec47d86 | 49 | |
a2b950ac OBC |
50 | typedef int (*rproc_handle_resource_t)(struct rproc *rproc, |
51 | void *, int offset, int avail); | |
400e64df | 52 | |
c6aed238 LP |
53 | static int rproc_alloc_carveout(struct rproc *rproc, |
54 | struct rproc_mem_entry *mem); | |
55 | static int rproc_release_carveout(struct rproc *rproc, | |
56 | struct rproc_mem_entry *mem); | |
57 | ||
b5ab5e24 OBC |
58 | /* Unique indices for remoteproc devices */ |
59 | static DEFINE_IDA(rproc_dev_index); | |
cab8300b | 60 | static struct workqueue_struct *rproc_recovery_wq; |
b5ab5e24 | 61 | |
8afd519c FGL |
62 | static const char * const rproc_crash_names[] = { |
63 | [RPROC_MMUFAULT] = "mmufault", | |
b3d39032 BA |
64 | [RPROC_WATCHDOG] = "watchdog", |
65 | [RPROC_FATAL_ERROR] = "fatal error", | |
8afd519c FGL |
66 | }; |
67 | ||
68 | /* translate rproc_crash_type to string */ | |
69 | static const char *rproc_crash_to_string(enum rproc_crash_type type) | |
70 | { | |
71 | if (type < ARRAY_SIZE(rproc_crash_names)) | |
72 | return rproc_crash_names[type]; | |
b23f7a09 | 73 | return "unknown"; |
8afd519c FGL |
74 | } |
75 | ||
400e64df OBC |
76 | /* |
77 | * This is the IOMMU fault handler we register with the IOMMU API | |
78 | * (when relevant; not all remote processors access memory through | |
79 | * an IOMMU). | |
80 | * | |
81 | * IOMMU core will invoke this handler whenever the remote processor | |
82 | * will try to access an unmapped device address. | |
400e64df OBC |
83 | */ |
84 | static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev, | |
730f84ce | 85 | unsigned long iova, int flags, void *token) |
400e64df | 86 | { |
8afd519c FGL |
87 | struct rproc *rproc = token; |
88 | ||
400e64df OBC |
89 | dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags); |
90 | ||
8afd519c FGL |
91 | rproc_report_crash(rproc, RPROC_MMUFAULT); |
92 | ||
400e64df OBC |
93 | /* |
94 | * Let the iommu core know we're not really handling this fault; | |
8afd519c | 95 | * we just used it as a recovery trigger. |
400e64df OBC |
96 | */ |
97 | return -ENOSYS; | |
98 | } | |
99 | ||
100 | static int rproc_enable_iommu(struct rproc *rproc) | |
101 | { | |
102 | struct iommu_domain *domain; | |
b5ab5e24 | 103 | struct device *dev = rproc->dev.parent; |
400e64df OBC |
104 | int ret; |
105 | ||
315491e5 SA |
106 | if (!rproc->has_iommu) { |
107 | dev_dbg(dev, "iommu not present\n"); | |
0798e1da | 108 | return 0; |
400e64df OBC |
109 | } |
110 | ||
111 | domain = iommu_domain_alloc(dev->bus); | |
112 | if (!domain) { | |
113 | dev_err(dev, "can't alloc iommu domain\n"); | |
114 | return -ENOMEM; | |
115 | } | |
116 | ||
77ca2332 | 117 | iommu_set_fault_handler(domain, rproc_iommu_fault, rproc); |
400e64df OBC |
118 | |
119 | ret = iommu_attach_device(domain, dev); | |
120 | if (ret) { | |
121 | dev_err(dev, "can't attach iommu device: %d\n", ret); | |
122 | goto free_domain; | |
123 | } | |
124 | ||
125 | rproc->domain = domain; | |
126 | ||
127 | return 0; | |
128 | ||
129 | free_domain: | |
130 | iommu_domain_free(domain); | |
131 | return ret; | |
132 | } | |
133 | ||
134 | static void rproc_disable_iommu(struct rproc *rproc) | |
135 | { | |
136 | struct iommu_domain *domain = rproc->domain; | |
b5ab5e24 | 137 | struct device *dev = rproc->dev.parent; |
400e64df OBC |
138 | |
139 | if (!domain) | |
140 | return; | |
141 | ||
142 | iommu_detach_device(domain, dev); | |
143 | iommu_domain_free(domain); | |
400e64df OBC |
144 | } |
145 | ||
086d0872 | 146 | phys_addr_t rproc_va_to_pa(void *cpu_addr) |
eb30596e LP |
147 | { |
148 | /* | |
149 | * Return physical address according to virtual address location | |
150 | * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent | |
151 | * - in kernel: if region allocated in generic dma memory pool | |
152 | */ | |
153 | if (is_vmalloc_addr(cpu_addr)) { | |
154 | return page_to_phys(vmalloc_to_page(cpu_addr)) + | |
155 | offset_in_page(cpu_addr); | |
156 | } | |
157 | ||
158 | WARN_ON(!virt_addr_valid(cpu_addr)); | |
159 | return virt_to_phys(cpu_addr); | |
160 | } | |
086d0872 | 161 | EXPORT_SYMBOL(rproc_va_to_pa); |
eb30596e | 162 | |
a01f7cd6 SA |
163 | /** |
164 | * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address | |
165 | * @rproc: handle of a remote processor | |
166 | * @da: remoteproc device address to translate | |
167 | * @len: length of the memory region @da is pointing to | |
95347e73 | 168 | * @is_iomem: optional pointer filled in to indicate if @da is iomapped memory |
a01f7cd6 | 169 | * |
400e64df OBC |
170 | * Some remote processors will ask us to allocate them physically contiguous |
171 | * memory regions (which we call "carveouts"), and map them to specific | |
a01f7cd6 SA |
172 | * device addresses (which are hardcoded in the firmware). They may also have |
173 | * dedicated memory regions internal to the processors, and use them either | |
174 | * exclusively or alongside carveouts. | |
400e64df OBC |
175 | * |
176 | * They may then ask us to copy objects into specific device addresses (e.g. | |
177 | * code/data sections) or expose us certain symbols in other device address | |
178 | * (e.g. their trace buffer). | |
179 | * | |
a01f7cd6 SA |
180 | * This function is a helper function with which we can go over the allocated |
181 | * carveouts and translate specific device addresses to kernel virtual addresses | |
182 | * so we can access the referenced memory. This function also allows to perform | |
183 | * translations on the internal remoteproc memory regions through a platform | |
184 | * implementation specific da_to_va ops, if present. | |
185 | * | |
400e64df OBC |
186 | * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too, |
187 | * but only on kernel direct mapped RAM memory. Instead, we're just using | |
a01f7cd6 SA |
188 | * here the output of the DMA API for the carveouts, which should be more |
189 | * correct. | |
f2867434 SA |
190 | * |
191 | * Return: a valid kernel address on success or NULL on failure | |
400e64df | 192 | */ |
40df0a91 | 193 | void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len, bool *is_iomem) |
400e64df OBC |
194 | { |
195 | struct rproc_mem_entry *carveout; | |
196 | void *ptr = NULL; | |
197 | ||
a01f7cd6 | 198 | if (rproc->ops->da_to_va) { |
40df0a91 | 199 | ptr = rproc->ops->da_to_va(rproc, da, len, is_iomem); |
a01f7cd6 SA |
200 | if (ptr) |
201 | goto out; | |
202 | } | |
203 | ||
400e64df OBC |
204 | list_for_each_entry(carveout, &rproc->carveouts, node) { |
205 | int offset = da - carveout->da; | |
206 | ||
74457c40 LP |
207 | /* Verify that carveout is allocated */ |
208 | if (!carveout->va) | |
209 | continue; | |
210 | ||
400e64df OBC |
211 | /* try next carveout if da is too small */ |
212 | if (offset < 0) | |
213 | continue; | |
214 | ||
215 | /* try next carveout if da is too large */ | |
216 | if (offset + len > carveout->len) | |
217 | continue; | |
218 | ||
219 | ptr = carveout->va + offset; | |
220 | ||
40df0a91 PF |
221 | if (is_iomem) |
222 | *is_iomem = carveout->is_iomem; | |
223 | ||
400e64df OBC |
224 | break; |
225 | } | |
226 | ||
a01f7cd6 | 227 | out: |
400e64df OBC |
228 | return ptr; |
229 | } | |
4afc89d6 | 230 | EXPORT_SYMBOL(rproc_da_to_va); |
400e64df | 231 | |
b0019ccd LP |
232 | /** |
233 | * rproc_find_carveout_by_name() - lookup the carveout region by a name | |
234 | * @rproc: handle of a remote processor | |
2e7d4c2c AP |
235 | * @name: carveout name to find (format string) |
236 | * @...: optional parameters matching @name string | |
b0019ccd LP |
237 | * |
238 | * Platform driver has the capability to register some pre-allacoted carveout | |
239 | * (physically contiguous memory regions) before rproc firmware loading and | |
240 | * associated resource table analysis. These regions may be dedicated memory | |
241 | * regions internal to the coprocessor or specified DDR region with specific | |
242 | * attributes | |
243 | * | |
244 | * This function is a helper function with which we can go over the | |
245 | * allocated carveouts and return associated region characteristics like | |
246 | * coprocessor address, length or processor virtual address. | |
247 | * | |
248 | * Return: a valid pointer on carveout entry on success or NULL on failure. | |
249 | */ | |
7e05c8de | 250 | __printf(2, 3) |
b0019ccd LP |
251 | struct rproc_mem_entry * |
252 | rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...) | |
253 | { | |
254 | va_list args; | |
255 | char _name[32]; | |
256 | struct rproc_mem_entry *carveout, *mem = NULL; | |
257 | ||
258 | if (!name) | |
259 | return NULL; | |
260 | ||
261 | va_start(args, name); | |
262 | vsnprintf(_name, sizeof(_name), name, args); | |
263 | va_end(args); | |
264 | ||
265 | list_for_each_entry(carveout, &rproc->carveouts, node) { | |
266 | /* Compare carveout and requested names */ | |
267 | if (!strcmp(carveout->name, _name)) { | |
268 | mem = carveout; | |
269 | break; | |
270 | } | |
271 | } | |
272 | ||
273 | return mem; | |
274 | } | |
275 | ||
c874bf59 LP |
276 | /** |
277 | * rproc_check_carveout_da() - Check specified carveout da configuration | |
278 | * @rproc: handle of a remote processor | |
279 | * @mem: pointer on carveout to check | |
280 | * @da: area device address | |
281 | * @len: associated area size | |
282 | * | |
283 | * This function is a helper function to verify requested device area (couple | |
28d7d5c6 LP |
284 | * da, len) is part of specified carveout. |
285 | * If da is not set (defined as FW_RSC_ADDR_ANY), only requested length is | |
286 | * checked. | |
c874bf59 | 287 | * |
28d7d5c6 | 288 | * Return: 0 if carveout matches request else error |
c874bf59 | 289 | */ |
28d7d5c6 LP |
290 | static int rproc_check_carveout_da(struct rproc *rproc, |
291 | struct rproc_mem_entry *mem, u32 da, u32 len) | |
c874bf59 LP |
292 | { |
293 | struct device *dev = &rproc->dev; | |
28d7d5c6 | 294 | int delta; |
c874bf59 LP |
295 | |
296 | /* Check requested resource length */ | |
297 | if (len > mem->len) { | |
298 | dev_err(dev, "Registered carveout doesn't fit len request\n"); | |
28d7d5c6 | 299 | return -EINVAL; |
c874bf59 LP |
300 | } |
301 | ||
302 | if (da != FW_RSC_ADDR_ANY && mem->da == FW_RSC_ADDR_ANY) { | |
28d7d5c6 LP |
303 | /* Address doesn't match registered carveout configuration */ |
304 | return -EINVAL; | |
c874bf59 LP |
305 | } else if (da != FW_RSC_ADDR_ANY && mem->da != FW_RSC_ADDR_ANY) { |
306 | delta = da - mem->da; | |
307 | ||
308 | /* Check requested resource belongs to registered carveout */ | |
309 | if (delta < 0) { | |
310 | dev_err(dev, | |
311 | "Registered carveout doesn't fit da request\n"); | |
28d7d5c6 | 312 | return -EINVAL; |
c874bf59 LP |
313 | } |
314 | ||
315 | if (delta + len > mem->len) { | |
316 | dev_err(dev, | |
317 | "Registered carveout doesn't fit len request\n"); | |
28d7d5c6 | 318 | return -EINVAL; |
c874bf59 LP |
319 | } |
320 | } | |
321 | ||
322 | return 0; | |
323 | } | |
324 | ||
6db20ea8 | 325 | int rproc_alloc_vring(struct rproc_vdev *rvdev, int i) |
400e64df | 326 | { |
7a186941 | 327 | struct rproc *rproc = rvdev->rproc; |
b5ab5e24 | 328 | struct device *dev = &rproc->dev; |
6db20ea8 | 329 | struct rproc_vring *rvring = &rvdev->vring[i]; |
c0d63157 | 330 | struct fw_rsc_vdev *rsc; |
096ee786 | 331 | int ret, notifyid; |
c6aed238 | 332 | struct rproc_mem_entry *mem; |
096ee786 | 333 | size_t size; |
400e64df | 334 | |
7a186941 | 335 | /* actual size of vring (in bytes) */ |
c2a052a4 | 336 | size = PAGE_ALIGN(vring_size(rvring->num, rvring->align)); |
7a186941 | 337 | |
c6aed238 LP |
338 | rsc = (void *)rproc->table_ptr + rvdev->rsc_offset; |
339 | ||
340 | /* Search for pre-registered carveout */ | |
341 | mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index, | |
342 | i); | |
343 | if (mem) { | |
344 | if (rproc_check_carveout_da(rproc, mem, rsc->vring[i].da, size)) | |
345 | return -ENOMEM; | |
346 | } else { | |
698ae3d7 | 347 | /* Register carveout in list */ |
99cf0361 BDC |
348 | mem = rproc_mem_entry_init(dev, NULL, 0, |
349 | size, rsc->vring[i].da, | |
c6aed238 LP |
350 | rproc_alloc_carveout, |
351 | rproc_release_carveout, | |
352 | "vdev%dvring%d", | |
353 | rvdev->index, i); | |
354 | if (!mem) { | |
355 | dev_err(dev, "Can't allocate memory entry structure\n"); | |
356 | return -ENOMEM; | |
357 | } | |
358 | ||
359 | rproc_add_carveout(rproc, mem); | |
400e64df OBC |
360 | } |
361 | ||
6db20ea8 OBC |
362 | /* |
363 | * Assign an rproc-wide unique index for this vring | |
364 | * TODO: assign a notifyid for rvdev updates as well | |
6db20ea8 OBC |
365 | * TODO: support predefined notifyids (via resource table) |
366 | */ | |
15fc6110 | 367 | ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL); |
b39599b7 | 368 | if (ret < 0) { |
15fc6110 | 369 | dev_err(dev, "idr_alloc failed: %d\n", ret); |
7a186941 OBC |
370 | return ret; |
371 | } | |
15fc6110 | 372 | notifyid = ret; |
400e64df | 373 | |
48f18f89 BA |
374 | /* Potentially bump max_notifyid */ |
375 | if (notifyid > rproc->max_notifyid) | |
376 | rproc->max_notifyid = notifyid; | |
377 | ||
6db20ea8 | 378 | rvring->notifyid = notifyid; |
400e64df | 379 | |
c6aed238 | 380 | /* Let the rproc know the notifyid of this vring.*/ |
c0d63157 | 381 | rsc->vring[i].notifyid = notifyid; |
400e64df OBC |
382 | return 0; |
383 | } | |
384 | ||
9c31255c | 385 | int |
6db20ea8 | 386 | rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i) |
7a186941 OBC |
387 | { |
388 | struct rproc *rproc = rvdev->rproc; | |
b5ab5e24 | 389 | struct device *dev = &rproc->dev; |
6db20ea8 OBC |
390 | struct fw_rsc_vdev_vring *vring = &rsc->vring[i]; |
391 | struct rproc_vring *rvring = &rvdev->vring[i]; | |
7a186941 | 392 | |
9d7814a9 | 393 | dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n", |
730f84ce | 394 | i, vring->da, vring->num, vring->align); |
7a186941 | 395 | |
6db20ea8 OBC |
396 | /* verify queue size and vring alignment are sane */ |
397 | if (!vring->num || !vring->align) { | |
398 | dev_err(dev, "invalid qsz (%d) or alignment (%d)\n", | |
730f84ce | 399 | vring->num, vring->align); |
6db20ea8 | 400 | return -EINVAL; |
7a186941 | 401 | } |
6db20ea8 | 402 | |
c2a052a4 | 403 | rvring->num = vring->num; |
6db20ea8 OBC |
404 | rvring->align = vring->align; |
405 | rvring->rvdev = rvdev; | |
406 | ||
407 | return 0; | |
408 | } | |
409 | ||
410 | void rproc_free_vring(struct rproc_vring *rvring) | |
411 | { | |
6db20ea8 | 412 | struct rproc *rproc = rvring->rvdev->rproc; |
00a0eec5 | 413 | int idx = rvring - rvring->rvdev->vring; |
c0d63157 | 414 | struct fw_rsc_vdev *rsc; |
6db20ea8 | 415 | |
6db20ea8 | 416 | idr_remove(&rproc->notifyids, rvring->notifyid); |
099a3f33 | 417 | |
4d3ebb3b MP |
418 | /* |
419 | * At this point rproc_stop() has been called and the installed resource | |
420 | * table in the remote processor memory may no longer be accessible. As | |
421 | * such and as per rproc_stop(), rproc->table_ptr points to the cached | |
422 | * resource table (rproc->cached_table). The cached resource table is | |
423 | * only available when a remote processor has been booted by the | |
424 | * remoteproc core, otherwise it is NULL. | |
425 | * | |
426 | * Based on the above, reset the virtio device section in the cached | |
427 | * resource table only if there is one to work with. | |
428 | */ | |
429 | if (rproc->table_ptr) { | |
430 | rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset; | |
431 | rsc->vring[idx].da = 0; | |
432 | rsc->vring[idx].notifyid = -1; | |
433 | } | |
7a186941 OBC |
434 | } |
435 | ||
9c31255c | 436 | void rproc_add_rvdev(struct rproc *rproc, struct rproc_vdev *rvdev) |
63badba9 AP |
437 | { |
438 | if (rvdev && rproc) | |
439 | list_add_tail(&rvdev->node, &rproc->rvdevs); | |
440 | } | |
441 | ||
9c31255c | 442 | void rproc_remove_rvdev(struct rproc_vdev *rvdev) |
63badba9 AP |
443 | { |
444 | if (rvdev) | |
445 | list_del(&rvdev->node); | |
446 | } | |
fd28f879 AP |
447 | /** |
448 | * rproc_handle_vdev() - handle a vdev fw resource | |
449 | * @rproc: the remote processor | |
450 | * @ptr: the vring resource descriptor | |
451 | * @offset: offset of the resource entry | |
452 | * @avail: size of available data (for sanity checking the image) | |
453 | * | |
454 | * This resource entry requests the host to statically register a virtio | |
455 | * device (vdev), and setup everything needed to support it. It contains | |
456 | * everything needed to make it possible: the virtio device id, virtio | |
457 | * device features, vrings information, virtio config space, etc... | |
458 | * | |
459 | * Before registering the vdev, the vrings are allocated from non-cacheable | |
460 | * physically contiguous memory. Currently we only support two vrings per | |
461 | * remote processor (temporary limitation). We might also want to consider | |
462 | * doing the vring allocation only later when ->find_vqs() is invoked, and | |
463 | * then release them upon ->del_vqs(). | |
464 | * | |
465 | * Note: @da is currently not really handled correctly: we dynamically | |
466 | * allocate it using the DMA API, ignoring requested hard coded addresses, | |
467 | * and we don't take care of any required IOMMU programming. This is all | |
468 | * going to be taken care of when the generic iommu-based DMA API will be | |
469 | * merged. Meanwhile, statically-addressed iommu-based firmware images should | |
470 | * use RSC_DEVMEM resource entries to map their required @da to the physical | |
471 | * address of their base CMA region (ouch, hacky!). | |
472 | * | |
473 | * Return: 0 on success, or an appropriate error code otherwise | |
474 | */ | |
475 | static int rproc_handle_vdev(struct rproc *rproc, void *ptr, | |
476 | int offset, int avail) | |
477 | { | |
478 | struct fw_rsc_vdev *rsc = ptr; | |
479 | struct device *dev = &rproc->dev; | |
480 | struct rproc_vdev *rvdev; | |
481 | size_t rsc_size; | |
482 | struct rproc_vdev_data rvdev_data; | |
1d7b61c0 | 483 | struct platform_device *pdev; |
fd28f879 AP |
484 | |
485 | /* make sure resource isn't truncated */ | |
486 | rsc_size = struct_size(rsc, vring, rsc->num_of_vrings); | |
487 | if (size_add(rsc_size, rsc->config_len) > avail) { | |
488 | dev_err(dev, "vdev rsc is truncated\n"); | |
489 | return -EINVAL; | |
490 | } | |
491 | ||
492 | /* make sure reserved bytes are zeroes */ | |
493 | if (rsc->reserved[0] || rsc->reserved[1]) { | |
494 | dev_err(dev, "vdev rsc has non zero reserved bytes\n"); | |
495 | return -EINVAL; | |
496 | } | |
497 | ||
498 | dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n", | |
499 | rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings); | |
500 | ||
501 | /* we currently support only two vrings per rvdev */ | |
502 | if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) { | |
503 | dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings); | |
504 | return -EINVAL; | |
505 | } | |
506 | ||
507 | rvdev_data.id = rsc->id; | |
508 | rvdev_data.index = rproc->nb_vdev++; | |
509 | rvdev_data.rsc_offset = offset; | |
510 | rvdev_data.rsc = rsc; | |
511 | ||
65fcf387 SW |
512 | /* |
513 | * When there is more than one remote processor, rproc->nb_vdev number is | |
514 | * same for each separate instances of "rproc". If rvdev_data.index is used | |
515 | * as device id, then we get duplication in sysfs, so need to use | |
516 | * PLATFORM_DEVID_AUTO to auto select device id. | |
517 | */ | |
518 | pdev = platform_device_register_data(dev, "rproc-virtio", PLATFORM_DEVID_AUTO, &rvdev_data, | |
1d7b61c0 AP |
519 | sizeof(rvdev_data)); |
520 | if (IS_ERR(pdev)) { | |
521 | dev_err(dev, "failed to create rproc-virtio device\n"); | |
522 | return PTR_ERR(pdev); | |
523 | } | |
fd28f879 AP |
524 | |
525 | return 0; | |
526 | } | |
527 | ||
400e64df OBC |
528 | /** |
529 | * rproc_handle_trace() - handle a shared trace buffer resource | |
530 | * @rproc: the remote processor | |
2bf23461 | 531 | * @ptr: the trace resource descriptor |
2e7d4c2c | 532 | * @offset: offset of the resource entry |
fd2c15ec | 533 | * @avail: size of available data (for sanity checking the image) |
400e64df OBC |
534 | * |
535 | * In case the remote processor dumps trace logs into memory, | |
536 | * export it via debugfs. | |
537 | * | |
538 | * Currently, the 'da' member of @rsc should contain the device address | |
539 | * where the remote processor is dumping the traces. Later we could also | |
540 | * support dynamically allocating this address using the generic | |
541 | * DMA API (but currently there isn't a use case for that). | |
542 | * | |
f2867434 | 543 | * Return: 0 on success, or an appropriate error code otherwise |
400e64df | 544 | */ |
2bf23461 | 545 | static int rproc_handle_trace(struct rproc *rproc, void *ptr, |
730f84ce | 546 | int offset, int avail) |
400e64df | 547 | { |
2bf23461 | 548 | struct fw_rsc_trace *rsc = ptr; |
a987e6b9 | 549 | struct rproc_debug_trace *trace; |
b5ab5e24 | 550 | struct device *dev = &rproc->dev; |
400e64df OBC |
551 | char name[15]; |
552 | ||
fd2c15ec | 553 | if (sizeof(*rsc) > avail) { |
b5ab5e24 | 554 | dev_err(dev, "trace rsc is truncated\n"); |
fd2c15ec OBC |
555 | return -EINVAL; |
556 | } | |
557 | ||
558 | /* make sure reserved bytes are zeroes */ | |
559 | if (rsc->reserved) { | |
560 | dev_err(dev, "trace rsc has non zero reserved bytes\n"); | |
561 | return -EINVAL; | |
562 | } | |
563 | ||
400e64df | 564 | trace = kzalloc(sizeof(*trace), GFP_KERNEL); |
172e6ab1 | 565 | if (!trace) |
400e64df | 566 | return -ENOMEM; |
400e64df OBC |
567 | |
568 | /* set the trace buffer dma properties */ | |
a987e6b9 LP |
569 | trace->trace_mem.len = rsc->len; |
570 | trace->trace_mem.da = rsc->da; | |
571 | ||
572 | /* set pointer on rproc device */ | |
573 | trace->rproc = rproc; | |
400e64df OBC |
574 | |
575 | /* make sure snprintf always null terminates, even if truncating */ | |
576 | snprintf(name, sizeof(name), "trace%d", rproc->num_traces); | |
577 | ||
578 | /* create the debugfs entry */ | |
a987e6b9 | 579 | trace->tfile = rproc_create_trace_file(name, rproc, trace); |
400e64df OBC |
580 | |
581 | list_add_tail(&trace->node, &rproc->traces); | |
582 | ||
583 | rproc->num_traces++; | |
584 | ||
a987e6b9 LP |
585 | dev_dbg(dev, "%s added: da 0x%x, len 0x%x\n", |
586 | name, rsc->da, rsc->len); | |
400e64df OBC |
587 | |
588 | return 0; | |
589 | } | |
590 | ||
591 | /** | |
592 | * rproc_handle_devmem() - handle devmem resource entry | |
593 | * @rproc: remote processor handle | |
2bf23461 | 594 | * @ptr: the devmem resource entry |
2e7d4c2c | 595 | * @offset: offset of the resource entry |
fd2c15ec | 596 | * @avail: size of available data (for sanity checking the image) |
400e64df OBC |
597 | * |
598 | * Remote processors commonly need to access certain on-chip peripherals. | |
599 | * | |
600 | * Some of these remote processors access memory via an iommu device, | |
601 | * and might require us to configure their iommu before they can access | |
602 | * the on-chip peripherals they need. | |
603 | * | |
604 | * This resource entry is a request to map such a peripheral device. | |
605 | * | |
606 | * These devmem entries will contain the physical address of the device in | |
607 | * the 'pa' member. If a specific device address is expected, then 'da' will | |
608 | * contain it (currently this is the only use case supported). 'len' will | |
609 | * contain the size of the physical region we need to map. | |
610 | * | |
611 | * Currently we just "trust" those devmem entries to contain valid physical | |
612 | * addresses, but this is going to change: we want the implementations to | |
613 | * tell us ranges of physical addresses the firmware is allowed to request, | |
614 | * and not allow firmwares to request access to physical addresses that | |
615 | * are outside those ranges. | |
f2867434 SA |
616 | * |
617 | * Return: 0 on success, or an appropriate error code otherwise | |
400e64df | 618 | */ |
2bf23461 | 619 | static int rproc_handle_devmem(struct rproc *rproc, void *ptr, |
730f84ce | 620 | int offset, int avail) |
400e64df | 621 | { |
2bf23461 | 622 | struct fw_rsc_devmem *rsc = ptr; |
400e64df | 623 | struct rproc_mem_entry *mapping; |
b5ab5e24 | 624 | struct device *dev = &rproc->dev; |
400e64df OBC |
625 | int ret; |
626 | ||
627 | /* no point in handling this resource without a valid iommu domain */ | |
628 | if (!rproc->domain) | |
629 | return -EINVAL; | |
630 | ||
fd2c15ec | 631 | if (sizeof(*rsc) > avail) { |
b5ab5e24 | 632 | dev_err(dev, "devmem rsc is truncated\n"); |
fd2c15ec OBC |
633 | return -EINVAL; |
634 | } | |
635 | ||
636 | /* make sure reserved bytes are zeroes */ | |
637 | if (rsc->reserved) { | |
b5ab5e24 | 638 | dev_err(dev, "devmem rsc has non zero reserved bytes\n"); |
fd2c15ec OBC |
639 | return -EINVAL; |
640 | } | |
641 | ||
400e64df | 642 | mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); |
172e6ab1 | 643 | if (!mapping) |
400e64df | 644 | return -ENOMEM; |
400e64df | 645 | |
1369459b JG |
646 | ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags, |
647 | GFP_KERNEL); | |
400e64df | 648 | if (ret) { |
b5ab5e24 | 649 | dev_err(dev, "failed to map devmem: %d\n", ret); |
400e64df OBC |
650 | goto out; |
651 | } | |
652 | ||
653 | /* | |
654 | * We'll need this info later when we'll want to unmap everything | |
655 | * (e.g. on shutdown). | |
656 | * | |
657 | * We can't trust the remote processor not to change the resource | |
658 | * table, so we must maintain this info independently. | |
659 | */ | |
660 | mapping->da = rsc->da; | |
661 | mapping->len = rsc->len; | |
662 | list_add_tail(&mapping->node, &rproc->mappings); | |
663 | ||
b5ab5e24 | 664 | dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n", |
730f84ce | 665 | rsc->pa, rsc->da, rsc->len); |
400e64df OBC |
666 | |
667 | return 0; | |
668 | ||
669 | out: | |
670 | kfree(mapping); | |
671 | return ret; | |
672 | } | |
673 | ||
f2e74abf | 674 | /** |
d7c51706 | 675 | * rproc_alloc_carveout() - allocated specified carveout |
f2e74abf | 676 | * @rproc: rproc handle |
d7c51706 | 677 | * @mem: the memory entry to allocate |
400e64df | 678 | * |
d7c51706 LP |
679 | * This function allocate specified memory entry @mem using |
680 | * dma_alloc_coherent() as default allocator | |
f2867434 SA |
681 | * |
682 | * Return: 0 on success, or an appropriate error code otherwise | |
400e64df | 683 | */ |
d7c51706 LP |
684 | static int rproc_alloc_carveout(struct rproc *rproc, |
685 | struct rproc_mem_entry *mem) | |
400e64df | 686 | { |
d7c51706 | 687 | struct rproc_mem_entry *mapping = NULL; |
b5ab5e24 | 688 | struct device *dev = &rproc->dev; |
400e64df OBC |
689 | dma_addr_t dma; |
690 | void *va; | |
691 | int ret; | |
692 | ||
d7c51706 | 693 | va = dma_alloc_coherent(dev->parent, mem->len, &dma, GFP_KERNEL); |
400e64df | 694 | if (!va) { |
9c219b23 | 695 | dev_err(dev->parent, |
096ee786 CL |
696 | "failed to allocate dma memory: len 0x%zx\n", |
697 | mem->len); | |
72029c90 | 698 | return -ENOMEM; |
400e64df OBC |
699 | } |
700 | ||
096ee786 | 701 | dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%zx\n", |
d7c51706 | 702 | va, &dma, mem->len); |
400e64df | 703 | |
60f849a5 LP |
704 | if (mem->da != FW_RSC_ADDR_ANY && !rproc->domain) { |
705 | /* | |
706 | * Check requested da is equal to dma address | |
707 | * and print a warn message in case of missalignment. | |
708 | * Don't stop rproc_start sequence as coprocessor may | |
709 | * build pa to da translation on its side. | |
710 | */ | |
711 | if (mem->da != (u32)dma) | |
712 | dev_warn(dev->parent, | |
713 | "Allocated carveout doesn't fit device address request\n"); | |
714 | } | |
715 | ||
400e64df OBC |
716 | /* |
717 | * Ok, this is non-standard. | |
718 | * | |
719 | * Sometimes we can't rely on the generic iommu-based DMA API | |
720 | * to dynamically allocate the device address and then set the IOMMU | |
721 | * tables accordingly, because some remote processors might | |
722 | * _require_ us to use hard coded device addresses that their | |
723 | * firmware was compiled with. | |
724 | * | |
725 | * In this case, we must use the IOMMU API directly and map | |
726 | * the memory to the device address as expected by the remote | |
727 | * processor. | |
728 | * | |
729 | * Obviously such remote processor devices should not be configured | |
730 | * to use the iommu-based DMA API: we expect 'dma' to contain the | |
731 | * physical address in this case. | |
732 | */ | |
60f849a5 | 733 | if (mem->da != FW_RSC_ADDR_ANY && rproc->domain) { |
7168d914 DC |
734 | mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); |
735 | if (!mapping) { | |
7168d914 DC |
736 | ret = -ENOMEM; |
737 | goto dma_free; | |
738 | } | |
739 | ||
d7c51706 | 740 | ret = iommu_map(rproc->domain, mem->da, dma, mem->len, |
1369459b | 741 | mem->flags, GFP_KERNEL); |
400e64df OBC |
742 | if (ret) { |
743 | dev_err(dev, "iommu_map failed: %d\n", ret); | |
7168d914 | 744 | goto free_mapping; |
400e64df OBC |
745 | } |
746 | ||
747 | /* | |
748 | * We'll need this info later when we'll want to unmap | |
749 | * everything (e.g. on shutdown). | |
750 | * | |
751 | * We can't trust the remote processor not to change the | |
752 | * resource table, so we must maintain this info independently. | |
753 | */ | |
d7c51706 LP |
754 | mapping->da = mem->da; |
755 | mapping->len = mem->len; | |
400e64df OBC |
756 | list_add_tail(&mapping->node, &rproc->mappings); |
757 | ||
b605ed8b | 758 | dev_dbg(dev, "carveout mapped 0x%x to %pad\n", |
d7c51706 | 759 | mem->da, &dma); |
60f849a5 LP |
760 | } |
761 | ||
762 | if (mem->da == FW_RSC_ADDR_ANY) { | |
b36de8cf LP |
763 | /* Update device address as undefined by requester */ |
764 | if ((u64)dma & HIGH_BITS_MASK) | |
765 | dev_warn(dev, "DMA address cast in 32bit to fit resource table format\n"); | |
766 | ||
d7c51706 | 767 | mem->da = (u32)dma; |
400e64df OBC |
768 | } |
769 | ||
80137b40 | 770 | mem->dma = dma; |
d7c51706 | 771 | mem->va = va; |
400e64df OBC |
772 | |
773 | return 0; | |
774 | ||
7168d914 DC |
775 | free_mapping: |
776 | kfree(mapping); | |
400e64df | 777 | dma_free: |
d7c51706 | 778 | dma_free_coherent(dev->parent, mem->len, va, dma); |
400e64df OBC |
779 | return ret; |
780 | } | |
781 | ||
d7c51706 LP |
782 | /** |
783 | * rproc_release_carveout() - release acquired carveout | |
784 | * @rproc: rproc handle | |
785 | * @mem: the memory entry to release | |
786 | * | |
787 | * This function releases specified memory entry @mem allocated via | |
788 | * rproc_alloc_carveout() function by @rproc. | |
f2867434 SA |
789 | * |
790 | * Return: 0 on success, or an appropriate error code otherwise | |
d7c51706 LP |
791 | */ |
792 | static int rproc_release_carveout(struct rproc *rproc, | |
793 | struct rproc_mem_entry *mem) | |
794 | { | |
795 | struct device *dev = &rproc->dev; | |
796 | ||
797 | /* clean up carveout allocations */ | |
798 | dma_free_coherent(dev->parent, mem->len, mem->va, mem->dma); | |
799 | return 0; | |
800 | } | |
801 | ||
802 | /** | |
803 | * rproc_handle_carveout() - handle phys contig memory allocation requests | |
804 | * @rproc: rproc handle | |
2bf23461 | 805 | * @ptr: the resource entry |
2e7d4c2c | 806 | * @offset: offset of the resource entry |
d7c51706 LP |
807 | * @avail: size of available data (for image validation) |
808 | * | |
809 | * This function will handle firmware requests for allocation of physically | |
810 | * contiguous memory regions. | |
811 | * | |
812 | * These request entries should come first in the firmware's resource table, | |
813 | * as other firmware entries might request placing other data objects inside | |
814 | * these memory regions (e.g. data/code segments, trace resource entries, ...). | |
815 | * | |
816 | * Allocating memory this way helps utilizing the reserved physical memory | |
817 | * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries | |
818 | * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB | |
819 | * pressure is important; it may have a substantial impact on performance. | |
f2867434 SA |
820 | * |
821 | * Return: 0 on success, or an appropriate error code otherwise | |
d7c51706 LP |
822 | */ |
823 | static int rproc_handle_carveout(struct rproc *rproc, | |
2bf23461 | 824 | void *ptr, int offset, int avail) |
d7c51706 | 825 | { |
2bf23461 | 826 | struct fw_rsc_carveout *rsc = ptr; |
d7c51706 LP |
827 | struct rproc_mem_entry *carveout; |
828 | struct device *dev = &rproc->dev; | |
829 | ||
830 | if (sizeof(*rsc) > avail) { | |
831 | dev_err(dev, "carveout rsc is truncated\n"); | |
832 | return -EINVAL; | |
833 | } | |
834 | ||
835 | /* make sure reserved bytes are zeroes */ | |
836 | if (rsc->reserved) { | |
837 | dev_err(dev, "carveout rsc has non zero reserved bytes\n"); | |
838 | return -EINVAL; | |
839 | } | |
840 | ||
841 | dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n", | |
842 | rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags); | |
843 | ||
ffa5f9c8 LP |
844 | /* |
845 | * Check carveout rsc already part of a registered carveout, | |
846 | * Search by name, then check the da and length | |
847 | */ | |
848 | carveout = rproc_find_carveout_by_name(rproc, rsc->name); | |
849 | ||
850 | if (carveout) { | |
851 | if (carveout->rsc_offset != FW_RSC_ADDR_ANY) { | |
852 | dev_err(dev, | |
853 | "Carveout already associated to resource table\n"); | |
854 | return -ENOMEM; | |
855 | } | |
856 | ||
857 | if (rproc_check_carveout_da(rproc, carveout, rsc->da, rsc->len)) | |
858 | return -ENOMEM; | |
859 | ||
860 | /* Update memory carveout with resource table info */ | |
861 | carveout->rsc_offset = offset; | |
862 | carveout->flags = rsc->flags; | |
863 | ||
864 | return 0; | |
865 | } | |
866 | ||
bf24ecc8 | 867 | /* Register carveout in list */ |
99cf0361 | 868 | carveout = rproc_mem_entry_init(dev, NULL, 0, rsc->len, rsc->da, |
d7c51706 LP |
869 | rproc_alloc_carveout, |
870 | rproc_release_carveout, rsc->name); | |
871 | if (!carveout) { | |
872 | dev_err(dev, "Can't allocate memory entry structure\n"); | |
873 | return -ENOMEM; | |
874 | } | |
875 | ||
876 | carveout->flags = rsc->flags; | |
877 | carveout->rsc_offset = offset; | |
878 | rproc_add_carveout(rproc, carveout); | |
879 | ||
880 | return 0; | |
881 | } | |
882 | ||
15c0b025 LP |
883 | /** |
884 | * rproc_add_carveout() - register an allocated carveout region | |
885 | * @rproc: rproc handle | |
886 | * @mem: memory entry to register | |
887 | * | |
888 | * This function registers specified memory entry in @rproc carveouts list. | |
889 | * Specified carveout should have been allocated before registering. | |
890 | */ | |
891 | void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem) | |
892 | { | |
893 | list_add_tail(&mem->node, &rproc->carveouts); | |
894 | } | |
895 | EXPORT_SYMBOL(rproc_add_carveout); | |
896 | ||
72029c90 LP |
897 | /** |
898 | * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct | |
899 | * @dev: pointer on device struct | |
900 | * @va: virtual address | |
901 | * @dma: dma address | |
902 | * @len: memory carveout length | |
903 | * @da: device address | |
a9f6fe0d LP |
904 | * @alloc: memory carveout allocation function |
905 | * @release: memory carveout release function | |
72029c90 LP |
906 | * @name: carveout name |
907 | * | |
908 | * This function allocates a rproc_mem_entry struct and fill it with parameters | |
909 | * provided by client. | |
f2867434 SA |
910 | * |
911 | * Return: a valid pointer on success, or NULL on failure | |
72029c90 | 912 | */ |
7e05c8de | 913 | __printf(8, 9) |
72029c90 LP |
914 | struct rproc_mem_entry * |
915 | rproc_mem_entry_init(struct device *dev, | |
096ee786 | 916 | void *va, dma_addr_t dma, size_t len, u32 da, |
d7c51706 | 917 | int (*alloc)(struct rproc *, struct rproc_mem_entry *), |
72029c90 LP |
918 | int (*release)(struct rproc *, struct rproc_mem_entry *), |
919 | const char *name, ...) | |
920 | { | |
921 | struct rproc_mem_entry *mem; | |
922 | va_list args; | |
923 | ||
924 | mem = kzalloc(sizeof(*mem), GFP_KERNEL); | |
925 | if (!mem) | |
926 | return mem; | |
927 | ||
928 | mem->va = va; | |
929 | mem->dma = dma; | |
930 | mem->da = da; | |
931 | mem->len = len; | |
d7c51706 | 932 | mem->alloc = alloc; |
72029c90 | 933 | mem->release = release; |
d7c51706 | 934 | mem->rsc_offset = FW_RSC_ADDR_ANY; |
1429cca1 | 935 | mem->of_resm_idx = -1; |
72029c90 LP |
936 | |
937 | va_start(args, name); | |
938 | vsnprintf(mem->name, sizeof(mem->name), name, args); | |
939 | va_end(args); | |
940 | ||
941 | return mem; | |
942 | } | |
943 | EXPORT_SYMBOL(rproc_mem_entry_init); | |
944 | ||
1429cca1 LP |
945 | /** |
946 | * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct | |
947 | * from a reserved memory phandle | |
948 | * @dev: pointer on device struct | |
949 | * @of_resm_idx: reserved memory phandle index in "memory-region" | |
950 | * @len: memory carveout length | |
951 | * @da: device address | |
952 | * @name: carveout name | |
953 | * | |
954 | * This function allocates a rproc_mem_entry struct and fill it with parameters | |
955 | * provided by client. | |
f2867434 SA |
956 | * |
957 | * Return: a valid pointer on success, or NULL on failure | |
1429cca1 | 958 | */ |
7e05c8de | 959 | __printf(5, 6) |
1429cca1 | 960 | struct rproc_mem_entry * |
096ee786 | 961 | rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, size_t len, |
1429cca1 LP |
962 | u32 da, const char *name, ...) |
963 | { | |
964 | struct rproc_mem_entry *mem; | |
965 | va_list args; | |
966 | ||
967 | mem = kzalloc(sizeof(*mem), GFP_KERNEL); | |
968 | if (!mem) | |
969 | return mem; | |
970 | ||
971 | mem->da = da; | |
972 | mem->len = len; | |
973 | mem->rsc_offset = FW_RSC_ADDR_ANY; | |
974 | mem->of_resm_idx = of_resm_idx; | |
975 | ||
976 | va_start(args, name); | |
977 | vsnprintf(mem->name, sizeof(mem->name), name, args); | |
978 | va_end(args); | |
979 | ||
980 | return mem; | |
981 | } | |
982 | EXPORT_SYMBOL(rproc_of_resm_mem_entry_init); | |
983 | ||
a8aa5ee1 SA |
984 | /** |
985 | * rproc_of_parse_firmware() - parse and return the firmware-name | |
986 | * @dev: pointer on device struct representing a rproc | |
987 | * @index: index to use for the firmware-name retrieval | |
988 | * @fw_name: pointer to a character string, in which the firmware | |
989 | * name is returned on success and unmodified otherwise. | |
990 | * | |
991 | * This is an OF helper function that parses a device's DT node for | |
992 | * the "firmware-name" property and returns the firmware name pointer | |
993 | * in @fw_name on success. | |
994 | * | |
995 | * Return: 0 on success, or an appropriate failure. | |
996 | */ | |
997 | int rproc_of_parse_firmware(struct device *dev, int index, const char **fw_name) | |
998 | { | |
999 | int ret; | |
1000 | ||
1001 | ret = of_property_read_string_index(dev->of_node, "firmware-name", | |
1002 | index, fw_name); | |
1003 | return ret ? ret : 0; | |
1004 | } | |
1005 | EXPORT_SYMBOL(rproc_of_parse_firmware); | |
1006 | ||
2e7d4c2c | 1007 | /* |
e12bc14b OBC |
1008 | * A lookup table for resource handlers. The indices are defined in |
1009 | * enum fw_resource_type. | |
1010 | */ | |
232fcdbb | 1011 | static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = { |
2bf23461 JY |
1012 | [RSC_CARVEOUT] = rproc_handle_carveout, |
1013 | [RSC_DEVMEM] = rproc_handle_devmem, | |
1014 | [RSC_TRACE] = rproc_handle_trace, | |
1015 | [RSC_VDEV] = rproc_handle_vdev, | |
232fcdbb SB |
1016 | }; |
1017 | ||
400e64df | 1018 | /* handle firmware resource entries before booting the remote processor */ |
a4b24c75 | 1019 | static int rproc_handle_resources(struct rproc *rproc, |
232fcdbb | 1020 | rproc_handle_resource_t handlers[RSC_LAST]) |
400e64df | 1021 | { |
b5ab5e24 | 1022 | struct device *dev = &rproc->dev; |
e12bc14b | 1023 | rproc_handle_resource_t handler; |
fd2c15ec OBC |
1024 | int ret = 0, i; |
1025 | ||
d4bb86f2 BA |
1026 | if (!rproc->table_ptr) |
1027 | return 0; | |
1028 | ||
a2b950ac OBC |
1029 | for (i = 0; i < rproc->table_ptr->num; i++) { |
1030 | int offset = rproc->table_ptr->offset[i]; | |
1031 | struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset; | |
a4b24c75 | 1032 | int avail = rproc->table_sz - offset - sizeof(*hdr); |
fd2c15ec OBC |
1033 | void *rsc = (void *)hdr + sizeof(*hdr); |
1034 | ||
1035 | /* make sure table isn't truncated */ | |
1036 | if (avail < 0) { | |
1037 | dev_err(dev, "rsc table is truncated\n"); | |
1038 | return -EINVAL; | |
1039 | } | |
400e64df | 1040 | |
fd2c15ec | 1041 | dev_dbg(dev, "rsc: type %d\n", hdr->type); |
400e64df | 1042 | |
b1a17513 CL |
1043 | if (hdr->type >= RSC_VENDOR_START && |
1044 | hdr->type <= RSC_VENDOR_END) { | |
1045 | ret = rproc_handle_rsc(rproc, hdr->type, rsc, | |
1046 | offset + sizeof(*hdr), avail); | |
1047 | if (ret == RSC_HANDLED) | |
1048 | continue; | |
1049 | else if (ret < 0) | |
1050 | break; | |
1051 | ||
1052 | dev_warn(dev, "unsupported vendor resource %d\n", | |
1053 | hdr->type); | |
1054 | continue; | |
1055 | } | |
1056 | ||
fd2c15ec OBC |
1057 | if (hdr->type >= RSC_LAST) { |
1058 | dev_warn(dev, "unsupported resource %d\n", hdr->type); | |
e12bc14b | 1059 | continue; |
400e64df OBC |
1060 | } |
1061 | ||
232fcdbb | 1062 | handler = handlers[hdr->type]; |
e12bc14b OBC |
1063 | if (!handler) |
1064 | continue; | |
1065 | ||
a2b950ac | 1066 | ret = handler(rproc, rsc, offset + sizeof(*hdr), avail); |
7a186941 | 1067 | if (ret) |
400e64df | 1068 | break; |
fd2c15ec | 1069 | } |
400e64df OBC |
1070 | |
1071 | return ret; | |
1072 | } | |
1073 | ||
c455daa4 BA |
1074 | static int rproc_prepare_subdevices(struct rproc *rproc) |
1075 | { | |
1076 | struct rproc_subdev *subdev; | |
1077 | int ret; | |
1078 | ||
1079 | list_for_each_entry(subdev, &rproc->subdevs, node) { | |
1080 | if (subdev->prepare) { | |
1081 | ret = subdev->prepare(subdev); | |
1082 | if (ret) | |
1083 | goto unroll_preparation; | |
1084 | } | |
1085 | } | |
1086 | ||
1087 | return 0; | |
1088 | ||
1089 | unroll_preparation: | |
1090 | list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { | |
1091 | if (subdev->unprepare) | |
1092 | subdev->unprepare(subdev); | |
1093 | } | |
1094 | ||
1095 | return ret; | |
1096 | } | |
1097 | ||
618fcff3 | 1098 | static int rproc_start_subdevices(struct rproc *rproc) |
7bdc9650 BA |
1099 | { |
1100 | struct rproc_subdev *subdev; | |
1101 | int ret; | |
1102 | ||
1103 | list_for_each_entry(subdev, &rproc->subdevs, node) { | |
be37b1e0 BA |
1104 | if (subdev->start) { |
1105 | ret = subdev->start(subdev); | |
1106 | if (ret) | |
1107 | goto unroll_registration; | |
1108 | } | |
7bdc9650 BA |
1109 | } |
1110 | ||
1111 | return 0; | |
1112 | ||
1113 | unroll_registration: | |
be37b1e0 BA |
1114 | list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { |
1115 | if (subdev->stop) | |
1116 | subdev->stop(subdev, true); | |
1117 | } | |
7bdc9650 BA |
1118 | |
1119 | return ret; | |
1120 | } | |
1121 | ||
618fcff3 | 1122 | static void rproc_stop_subdevices(struct rproc *rproc, bool crashed) |
7bdc9650 BA |
1123 | { |
1124 | struct rproc_subdev *subdev; | |
1125 | ||
be37b1e0 BA |
1126 | list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { |
1127 | if (subdev->stop) | |
1128 | subdev->stop(subdev, crashed); | |
1129 | } | |
7bdc9650 BA |
1130 | } |
1131 | ||
c455daa4 BA |
1132 | static void rproc_unprepare_subdevices(struct rproc *rproc) |
1133 | { | |
1134 | struct rproc_subdev *subdev; | |
1135 | ||
1136 | list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { | |
1137 | if (subdev->unprepare) | |
1138 | subdev->unprepare(subdev); | |
1139 | } | |
1140 | } | |
1141 | ||
d7c51706 LP |
1142 | /** |
1143 | * rproc_alloc_registered_carveouts() - allocate all carveouts registered | |
1144 | * in the list | |
1145 | * @rproc: the remote processor handle | |
1146 | * | |
1147 | * This function parses registered carveout list, performs allocation | |
1148 | * if alloc() ops registered and updates resource table information | |
1149 | * if rsc_offset set. | |
1150 | * | |
1151 | * Return: 0 on success | |
1152 | */ | |
1153 | static int rproc_alloc_registered_carveouts(struct rproc *rproc) | |
1154 | { | |
1155 | struct rproc_mem_entry *entry, *tmp; | |
1156 | struct fw_rsc_carveout *rsc; | |
1157 | struct device *dev = &rproc->dev; | |
b36de8cf | 1158 | u64 pa; |
d7c51706 LP |
1159 | int ret; |
1160 | ||
1161 | list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { | |
1162 | if (entry->alloc) { | |
1163 | ret = entry->alloc(rproc, entry); | |
1164 | if (ret) { | |
1165 | dev_err(dev, "Unable to allocate carveout %s: %d\n", | |
1166 | entry->name, ret); | |
1167 | return -ENOMEM; | |
1168 | } | |
1169 | } | |
1170 | ||
1171 | if (entry->rsc_offset != FW_RSC_ADDR_ANY) { | |
1172 | /* update resource table */ | |
1173 | rsc = (void *)rproc->table_ptr + entry->rsc_offset; | |
1174 | ||
1175 | /* | |
1176 | * Some remote processors might need to know the pa | |
1177 | * even though they are behind an IOMMU. E.g., OMAP4's | |
1178 | * remote M3 processor needs this so it can control | |
1179 | * on-chip hardware accelerators that are not behind | |
1180 | * the IOMMU, and therefor must know the pa. | |
1181 | * | |
1182 | * Generally we don't want to expose physical addresses | |
1183 | * if we don't have to (remote processors are generally | |
1184 | * _not_ trusted), so we might want to do this only for | |
1185 | * remote processor that _must_ have this (e.g. OMAP4's | |
1186 | * dual M3 subsystem). | |
1187 | * | |
1188 | * Non-IOMMU processors might also want to have this info. | |
1189 | * In this case, the device address and the physical address | |
1190 | * are the same. | |
1191 | */ | |
ffa5f9c8 LP |
1192 | |
1193 | /* Use va if defined else dma to generate pa */ | |
d7c51706 | 1194 | if (entry->va) |
b36de8cf | 1195 | pa = (u64)rproc_va_to_pa(entry->va); |
ffa5f9c8 | 1196 | else |
b36de8cf LP |
1197 | pa = (u64)entry->dma; |
1198 | ||
1199 | if (((u64)pa) & HIGH_BITS_MASK) | |
1200 | dev_warn(dev, | |
1201 | "Physical address cast in 32bit to fit resource table format\n"); | |
ffa5f9c8 | 1202 | |
b36de8cf | 1203 | rsc->pa = (u32)pa; |
ffa5f9c8 LP |
1204 | rsc->da = entry->da; |
1205 | rsc->len = entry->len; | |
d7c51706 LP |
1206 | } |
1207 | } | |
1208 | ||
1209 | return 0; | |
1210 | } | |
1211 | ||
2666ca91 | 1212 | |
400e64df OBC |
1213 | /** |
1214 | * rproc_resource_cleanup() - clean up and free all acquired resources | |
1215 | * @rproc: rproc handle | |
1216 | * | |
1217 | * This function will free all resources acquired for @rproc, and it | |
7a186941 | 1218 | * is called whenever @rproc either shuts down or fails to boot. |
400e64df | 1219 | */ |
d9473cbf | 1220 | void rproc_resource_cleanup(struct rproc *rproc) |
400e64df OBC |
1221 | { |
1222 | struct rproc_mem_entry *entry, *tmp; | |
a987e6b9 | 1223 | struct rproc_debug_trace *trace, *ttmp; |
d81fb32f | 1224 | struct rproc_vdev *rvdev, *rvtmp; |
b5ab5e24 | 1225 | struct device *dev = &rproc->dev; |
400e64df OBC |
1226 | |
1227 | /* clean up debugfs trace entries */ | |
a987e6b9 LP |
1228 | list_for_each_entry_safe(trace, ttmp, &rproc->traces, node) { |
1229 | rproc_remove_trace_file(trace->tfile); | |
400e64df | 1230 | rproc->num_traces--; |
a987e6b9 LP |
1231 | list_del(&trace->node); |
1232 | kfree(trace); | |
400e64df OBC |
1233 | } |
1234 | ||
400e64df OBC |
1235 | /* clean up iommu mapping entries */ |
1236 | list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) { | |
1237 | size_t unmapped; | |
1238 | ||
1239 | unmapped = iommu_unmap(rproc->domain, entry->da, entry->len); | |
1240 | if (unmapped != entry->len) { | |
1241 | /* nothing much to do besides complaining */ | |
096ee786 | 1242 | dev_err(dev, "failed to unmap %zx/%zu\n", entry->len, |
730f84ce | 1243 | unmapped); |
400e64df OBC |
1244 | } |
1245 | ||
1246 | list_del(&entry->node); | |
1247 | kfree(entry); | |
1248 | } | |
b6356a01 SA |
1249 | |
1250 | /* clean up carveout allocations */ | |
1251 | list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { | |
f2e74abf LP |
1252 | if (entry->release) |
1253 | entry->release(rproc, entry); | |
b6356a01 SA |
1254 | list_del(&entry->node); |
1255 | kfree(entry); | |
1256 | } | |
d81fb32f BA |
1257 | |
1258 | /* clean up remote vdev entries */ | |
f5bcb353 | 1259 | list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node) |
1d7b61c0 | 1260 | platform_device_unregister(rvdev->pdev); |
2666ca91 SJ |
1261 | |
1262 | rproc_coredump_cleanup(rproc); | |
400e64df | 1263 | } |
d9473cbf | 1264 | EXPORT_SYMBOL(rproc_resource_cleanup); |
400e64df | 1265 | |
1efa30d0 SJ |
1266 | static int rproc_start(struct rproc *rproc, const struct firmware *fw) |
1267 | { | |
a4b24c75 | 1268 | struct resource_table *loaded_table; |
1efa30d0 | 1269 | struct device *dev = &rproc->dev; |
a4b24c75 | 1270 | int ret; |
1efa30d0 SJ |
1271 | |
1272 | /* load the ELF segments to memory */ | |
1273 | ret = rproc_load_segments(rproc, fw); | |
1274 | if (ret) { | |
1275 | dev_err(dev, "Failed to load program segments: %d\n", ret); | |
1276 | return ret; | |
1277 | } | |
1278 | ||
1279 | /* | |
1280 | * The starting device has been given the rproc->cached_table as the | |
1281 | * resource table. The address of the vring along with the other | |
1282 | * allocated resources (carveouts etc) is stored in cached_table. | |
1283 | * In order to pass this information to the remote device we must copy | |
1284 | * this information to device memory. We also update the table_ptr so | |
1285 | * that any subsequent changes will be applied to the loaded version. | |
1286 | */ | |
1287 | loaded_table = rproc_find_loaded_rsc_table(rproc, fw); | |
1288 | if (loaded_table) { | |
a4b24c75 | 1289 | memcpy(loaded_table, rproc->cached_table, rproc->table_sz); |
1efa30d0 SJ |
1290 | rproc->table_ptr = loaded_table; |
1291 | } | |
1292 | ||
c455daa4 BA |
1293 | ret = rproc_prepare_subdevices(rproc); |
1294 | if (ret) { | |
1295 | dev_err(dev, "failed to prepare subdevices for %s: %d\n", | |
1296 | rproc->name, ret); | |
f68d51bd | 1297 | goto reset_table_ptr; |
c455daa4 BA |
1298 | } |
1299 | ||
1efa30d0 SJ |
1300 | /* power up the remote processor */ |
1301 | ret = rproc->ops->start(rproc); | |
1302 | if (ret) { | |
1303 | dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret); | |
c455daa4 | 1304 | goto unprepare_subdevices; |
1efa30d0 SJ |
1305 | } |
1306 | ||
618fcff3 BA |
1307 | /* Start any subdevices for the remote processor */ |
1308 | ret = rproc_start_subdevices(rproc); | |
1efa30d0 SJ |
1309 | if (ret) { |
1310 | dev_err(dev, "failed to probe subdevices for %s: %d\n", | |
1311 | rproc->name, ret); | |
c455daa4 | 1312 | goto stop_rproc; |
1efa30d0 SJ |
1313 | } |
1314 | ||
1315 | rproc->state = RPROC_RUNNING; | |
1316 | ||
1317 | dev_info(dev, "remote processor %s is now up\n", rproc->name); | |
1318 | ||
1319 | return 0; | |
c455daa4 BA |
1320 | |
1321 | stop_rproc: | |
1322 | rproc->ops->stop(rproc); | |
c455daa4 BA |
1323 | unprepare_subdevices: |
1324 | rproc_unprepare_subdevices(rproc); | |
f68d51bd SA |
1325 | reset_table_ptr: |
1326 | rproc->table_ptr = rproc->cached_table; | |
c455daa4 BA |
1327 | |
1328 | return ret; | |
1efa30d0 SJ |
1329 | } |
1330 | ||
6a6c4dc0 | 1331 | static int __rproc_attach(struct rproc *rproc) |
d848a481 MP |
1332 | { |
1333 | struct device *dev = &rproc->dev; | |
1334 | int ret; | |
1335 | ||
1336 | ret = rproc_prepare_subdevices(rproc); | |
1337 | if (ret) { | |
1338 | dev_err(dev, "failed to prepare subdevices for %s: %d\n", | |
1339 | rproc->name, ret); | |
1340 | goto out; | |
1341 | } | |
1342 | ||
1343 | /* Attach to the remote processor */ | |
1344 | ret = rproc_attach_device(rproc); | |
1345 | if (ret) { | |
1346 | dev_err(dev, "can't attach to rproc %s: %d\n", | |
1347 | rproc->name, ret); | |
1348 | goto unprepare_subdevices; | |
1349 | } | |
1350 | ||
1351 | /* Start any subdevices for the remote processor */ | |
1352 | ret = rproc_start_subdevices(rproc); | |
1353 | if (ret) { | |
1354 | dev_err(dev, "failed to probe subdevices for %s: %d\n", | |
1355 | rproc->name, ret); | |
1356 | goto stop_rproc; | |
1357 | } | |
1358 | ||
76f4c875 | 1359 | rproc->state = RPROC_ATTACHED; |
d848a481 MP |
1360 | |
1361 | dev_info(dev, "remote processor %s is now attached\n", rproc->name); | |
1362 | ||
1363 | return 0; | |
1364 | ||
1365 | stop_rproc: | |
1366 | rproc->ops->stop(rproc); | |
1367 | unprepare_subdevices: | |
1368 | rproc_unprepare_subdevices(rproc); | |
1369 | out: | |
1370 | return ret; | |
1371 | } | |
1372 | ||
400e64df OBC |
1373 | /* |
1374 | * take a firmware and boot a remote processor with it. | |
1375 | */ | |
1376 | static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw) | |
1377 | { | |
b5ab5e24 | 1378 | struct device *dev = &rproc->dev; |
400e64df | 1379 | const char *name = rproc->firmware; |
58b64090 | 1380 | int ret; |
400e64df OBC |
1381 | |
1382 | ret = rproc_fw_sanity_check(rproc, fw); | |
1383 | if (ret) | |
1384 | return ret; | |
1385 | ||
e981f6d4 | 1386 | dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size); |
400e64df OBC |
1387 | |
1388 | /* | |
1389 | * if enabling an IOMMU isn't relevant for this rproc, this is | |
1390 | * just a nop | |
1391 | */ | |
1392 | ret = rproc_enable_iommu(rproc); | |
1393 | if (ret) { | |
1394 | dev_err(dev, "can't enable iommu: %d\n", ret); | |
49cff125 | 1395 | return ret; |
400e64df OBC |
1396 | } |
1397 | ||
33467ac3 LP |
1398 | /* Prepare rproc for firmware loading if needed */ |
1399 | ret = rproc_prepare_device(rproc); | |
1400 | if (ret) { | |
1401 | dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret); | |
1402 | goto disable_iommu; | |
1403 | } | |
1404 | ||
3e5f9eb5 | 1405 | rproc->bootaddr = rproc_get_boot_addr(rproc, fw); |
988d204c | 1406 | |
c1d35c1a BA |
1407 | /* Load resource table, core dump segment list etc from the firmware */ |
1408 | ret = rproc_parse_fw(rproc, fw); | |
58b64090 | 1409 | if (ret) |
33467ac3 | 1410 | goto unprepare_rproc; |
a0c10687 | 1411 | |
b35d7afc BA |
1412 | /* reset max_notifyid */ |
1413 | rproc->max_notifyid = -1; | |
1414 | ||
c6aed238 LP |
1415 | /* reset handled vdev */ |
1416 | rproc->nb_vdev = 0; | |
1417 | ||
400e64df | 1418 | /* handle fw resources which are required to boot rproc */ |
a4b24c75 | 1419 | ret = rproc_handle_resources(rproc, rproc_loading_handlers); |
400e64df OBC |
1420 | if (ret) { |
1421 | dev_err(dev, "Failed to process resources: %d\n", ret); | |
229b85a6 | 1422 | goto clean_up_resources; |
400e64df OBC |
1423 | } |
1424 | ||
d7c51706 LP |
1425 | /* Allocate carveout resources associated to rproc */ |
1426 | ret = rproc_alloc_registered_carveouts(rproc); | |
1427 | if (ret) { | |
1428 | dev_err(dev, "Failed to allocate associated carveouts: %d\n", | |
1429 | ret); | |
1430 | goto clean_up_resources; | |
1431 | } | |
1432 | ||
1efa30d0 SJ |
1433 | ret = rproc_start(rproc, fw); |
1434 | if (ret) | |
229b85a6 | 1435 | goto clean_up_resources; |
400e64df OBC |
1436 | |
1437 | return 0; | |
1438 | ||
229b85a6 BA |
1439 | clean_up_resources: |
1440 | rproc_resource_cleanup(rproc); | |
a0c10687 BA |
1441 | kfree(rproc->cached_table); |
1442 | rproc->cached_table = NULL; | |
988d204c | 1443 | rproc->table_ptr = NULL; |
33467ac3 LP |
1444 | unprepare_rproc: |
1445 | /* release HW resources if needed */ | |
1446 | rproc_unprepare_device(rproc); | |
58b64090 | 1447 | disable_iommu: |
400e64df OBC |
1448 | rproc_disable_iommu(rproc); |
1449 | return ret; | |
1450 | } | |
1451 | ||
1a631382 MP |
1452 | static int rproc_set_rsc_table(struct rproc *rproc) |
1453 | { | |
1454 | struct resource_table *table_ptr; | |
1455 | struct device *dev = &rproc->dev; | |
1456 | size_t table_sz; | |
1457 | int ret; | |
1458 | ||
1459 | table_ptr = rproc_get_loaded_rsc_table(rproc, &table_sz); | |
1460 | if (!table_ptr) { | |
1461 | /* Not having a resource table is acceptable */ | |
1462 | return 0; | |
1463 | } | |
1464 | ||
1465 | if (IS_ERR(table_ptr)) { | |
1466 | ret = PTR_ERR(table_ptr); | |
1467 | dev_err(dev, "can't load resource table: %d\n", ret); | |
1468 | return ret; | |
1469 | } | |
1470 | ||
9dc9507f MP |
1471 | /* |
1472 | * If it is possible to detach the remote processor, keep an untouched | |
1473 | * copy of the resource table. That way we can start fresh again when | |
1474 | * the remote processor is re-attached, that is: | |
1475 | * | |
1476 | * DETACHED -> ATTACHED -> DETACHED -> ATTACHED | |
1477 | * | |
1478 | * Free'd in rproc_reset_rsc_table_on_detach() and | |
1479 | * rproc_reset_rsc_table_on_stop(). | |
1480 | */ | |
1481 | if (rproc->ops->detach) { | |
1482 | rproc->clean_table = kmemdup(table_ptr, table_sz, GFP_KERNEL); | |
1483 | if (!rproc->clean_table) | |
1484 | return -ENOMEM; | |
1485 | } else { | |
1486 | rproc->clean_table = NULL; | |
1487 | } | |
1488 | ||
1a631382 MP |
1489 | rproc->cached_table = NULL; |
1490 | rproc->table_ptr = table_ptr; | |
1491 | rproc->table_sz = table_sz; | |
1492 | ||
1493 | return 0; | |
1494 | } | |
1495 | ||
9dc9507f MP |
1496 | static int rproc_reset_rsc_table_on_detach(struct rproc *rproc) |
1497 | { | |
1498 | struct resource_table *table_ptr; | |
1499 | ||
1500 | /* A resource table was never retrieved, nothing to do here */ | |
1501 | if (!rproc->table_ptr) | |
1502 | return 0; | |
1503 | ||
1504 | /* | |
1505 | * If we made it to this point a clean_table _must_ have been | |
1506 | * allocated in rproc_set_rsc_table(). If one isn't present | |
1507 | * something went really wrong and we must complain. | |
1508 | */ | |
1509 | if (WARN_ON(!rproc->clean_table)) | |
1510 | return -EINVAL; | |
1511 | ||
1512 | /* Remember where the external entity installed the resource table */ | |
1513 | table_ptr = rproc->table_ptr; | |
1514 | ||
1515 | /* | |
1516 | * If we made it here the remote processor was started by another | |
1517 | * entity and a cache table doesn't exist. As such make a copy of | |
1518 | * the resource table currently used by the remote processor and | |
1519 | * use that for the rest of the shutdown process. The memory | |
1520 | * allocated here is free'd in rproc_detach(). | |
1521 | */ | |
1522 | rproc->cached_table = kmemdup(rproc->table_ptr, | |
1523 | rproc->table_sz, GFP_KERNEL); | |
1524 | if (!rproc->cached_table) | |
1525 | return -ENOMEM; | |
1526 | ||
1527 | /* | |
1528 | * Use a copy of the resource table for the remainder of the | |
1529 | * shutdown process. | |
1530 | */ | |
1531 | rproc->table_ptr = rproc->cached_table; | |
1532 | ||
1533 | /* | |
1534 | * Reset the memory area where the firmware loaded the resource table | |
1535 | * to its original value. That way when we re-attach the remote | |
1536 | * processor the resource table is clean and ready to be used again. | |
1537 | */ | |
1538 | memcpy(table_ptr, rproc->clean_table, rproc->table_sz); | |
1539 | ||
1540 | /* | |
1541 | * The clean resource table is no longer needed. Allocated in | |
1542 | * rproc_set_rsc_table(). | |
1543 | */ | |
1544 | kfree(rproc->clean_table); | |
1545 | ||
1546 | return 0; | |
1547 | } | |
1548 | ||
8088dd4d MP |
1549 | static int rproc_reset_rsc_table_on_stop(struct rproc *rproc) |
1550 | { | |
1551 | /* A resource table was never retrieved, nothing to do here */ | |
1552 | if (!rproc->table_ptr) | |
1553 | return 0; | |
1554 | ||
1555 | /* | |
1556 | * If a cache table exists the remote processor was started by | |
1557 | * the remoteproc core. That cache table should be used for | |
1558 | * the rest of the shutdown process. | |
1559 | */ | |
1560 | if (rproc->cached_table) | |
1561 | goto out; | |
1562 | ||
1563 | /* | |
1564 | * If we made it here the remote processor was started by another | |
1565 | * entity and a cache table doesn't exist. As such make a copy of | |
1566 | * the resource table currently used by the remote processor and | |
1567 | * use that for the rest of the shutdown process. The memory | |
1568 | * allocated here is free'd in rproc_shutdown(). | |
1569 | */ | |
1570 | rproc->cached_table = kmemdup(rproc->table_ptr, | |
1571 | rproc->table_sz, GFP_KERNEL); | |
1572 | if (!rproc->cached_table) | |
1573 | return -ENOMEM; | |
1574 | ||
1575 | /* | |
1576 | * Since the remote processor is being switched off the clean table | |
1577 | * won't be needed. Allocated in rproc_set_rsc_table(). | |
1578 | */ | |
1579 | kfree(rproc->clean_table); | |
1580 | ||
1581 | out: | |
1582 | /* | |
1583 | * Use a copy of the resource table for the remainder of the | |
1584 | * shutdown process. | |
1585 | */ | |
1586 | rproc->table_ptr = rproc->cached_table; | |
1587 | return 0; | |
1588 | } | |
1589 | ||
fdf0e00e MP |
1590 | /* |
1591 | * Attach to remote processor - similar to rproc_fw_boot() but without | |
1592 | * the steps that deal with the firmware image. | |
1593 | */ | |
6a6c4dc0 | 1594 | static int rproc_attach(struct rproc *rproc) |
fdf0e00e MP |
1595 | { |
1596 | struct device *dev = &rproc->dev; | |
1597 | int ret; | |
1598 | ||
1599 | /* | |
1600 | * if enabling an IOMMU isn't relevant for this rproc, this is | |
1601 | * just a nop | |
1602 | */ | |
1603 | ret = rproc_enable_iommu(rproc); | |
1604 | if (ret) { | |
1605 | dev_err(dev, "can't enable iommu: %d\n", ret); | |
1606 | return ret; | |
1607 | } | |
1608 | ||
6e20a051 AP |
1609 | /* Do anything that is needed to boot the remote processor */ |
1610 | ret = rproc_prepare_device(rproc); | |
1611 | if (ret) { | |
1612 | dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret); | |
1613 | goto disable_iommu; | |
1614 | } | |
1615 | ||
1a631382 MP |
1616 | ret = rproc_set_rsc_table(rproc); |
1617 | if (ret) { | |
1618 | dev_err(dev, "can't load resource table: %d\n", ret); | |
6e20a051 | 1619 | goto unprepare_device; |
1a631382 MP |
1620 | } |
1621 | ||
fdf0e00e MP |
1622 | /* reset max_notifyid */ |
1623 | rproc->max_notifyid = -1; | |
1624 | ||
1625 | /* reset handled vdev */ | |
1626 | rproc->nb_vdev = 0; | |
1627 | ||
1628 | /* | |
1629 | * Handle firmware resources required to attach to a remote processor. | |
1630 | * Because we are attaching rather than booting the remote processor, | |
1631 | * we expect the platform driver to properly set rproc->table_ptr. | |
1632 | */ | |
1633 | ret = rproc_handle_resources(rproc, rproc_loading_handlers); | |
1634 | if (ret) { | |
1635 | dev_err(dev, "Failed to process resources: %d\n", ret); | |
6e20a051 | 1636 | goto unprepare_device; |
fdf0e00e MP |
1637 | } |
1638 | ||
1639 | /* Allocate carveout resources associated to rproc */ | |
1640 | ret = rproc_alloc_registered_carveouts(rproc); | |
1641 | if (ret) { | |
1642 | dev_err(dev, "Failed to allocate associated carveouts: %d\n", | |
1643 | ret); | |
1644 | goto clean_up_resources; | |
1645 | } | |
1646 | ||
6a6c4dc0 | 1647 | ret = __rproc_attach(rproc); |
fdf0e00e MP |
1648 | if (ret) |
1649 | goto clean_up_resources; | |
1650 | ||
1651 | return 0; | |
1652 | ||
1653 | clean_up_resources: | |
1654 | rproc_resource_cleanup(rproc); | |
6e20a051 AP |
1655 | unprepare_device: |
1656 | /* release HW resources if needed */ | |
1657 | rproc_unprepare_device(rproc); | |
fdf0e00e MP |
1658 | disable_iommu: |
1659 | rproc_disable_iommu(rproc); | |
1660 | return ret; | |
1661 | } | |
1662 | ||
400e64df | 1663 | /* |
5e6533f7 | 1664 | * take a firmware and boot it up. |
400e64df OBC |
1665 | * |
1666 | * Note: this function is called asynchronously upon registration of the | |
1667 | * remote processor (so we must wait until it completes before we try | |
1668 | * to unregister the device. one other option is just to use kref here, | |
1669 | * that might be cleaner). | |
1670 | */ | |
5e6533f7 | 1671 | static void rproc_auto_boot_callback(const struct firmware *fw, void *context) |
400e64df OBC |
1672 | { |
1673 | struct rproc *rproc = context; | |
a2b950ac | 1674 | |
7a20c64d | 1675 | rproc_boot(rproc); |
ddf71187 | 1676 | |
3cc6e787 | 1677 | release_firmware(fw); |
400e64df OBC |
1678 | } |
1679 | ||
5e6533f7 | 1680 | static int rproc_trigger_auto_boot(struct rproc *rproc) |
70b85ef8 FGL |
1681 | { |
1682 | int ret; | |
1683 | ||
e3d21939 MP |
1684 | /* |
1685 | * Since the remote processor is in a detached state, it has already | |
1686 | * been booted by another entity. As such there is no point in waiting | |
1687 | * for a firmware image to be loaded, we can simply initiate the process | |
1688 | * of attaching to it immediately. | |
1689 | */ | |
1690 | if (rproc->state == RPROC_DETACHED) | |
1691 | return rproc_boot(rproc); | |
1692 | ||
70b85ef8 | 1693 | /* |
70b85ef8 FGL |
1694 | * We're initiating an asynchronous firmware loading, so we can |
1695 | * be built-in kernel code, without hanging the boot process. | |
1696 | */ | |
0733d839 | 1697 | ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_UEVENT, |
70b85ef8 | 1698 | rproc->firmware, &rproc->dev, GFP_KERNEL, |
5e6533f7 | 1699 | rproc, rproc_auto_boot_callback); |
2099c77d | 1700 | if (ret < 0) |
70b85ef8 | 1701 | dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret); |
70b85ef8 FGL |
1702 | |
1703 | return ret; | |
1704 | } | |
1705 | ||
880f5b38 | 1706 | static int rproc_stop(struct rproc *rproc, bool crashed) |
1efa30d0 SJ |
1707 | { |
1708 | struct device *dev = &rproc->dev; | |
1709 | int ret; | |
1710 | ||
d2008a96 MP |
1711 | /* No need to continue if a stop() operation has not been provided */ |
1712 | if (!rproc->ops->stop) | |
1713 | return -EINVAL; | |
1714 | ||
618fcff3 BA |
1715 | /* Stop any subdevices for the remote processor */ |
1716 | rproc_stop_subdevices(rproc, crashed); | |
1efa30d0 | 1717 | |
0a8b81cb | 1718 | /* the installed resource table is no longer accessible */ |
8088dd4d MP |
1719 | ret = rproc_reset_rsc_table_on_stop(rproc); |
1720 | if (ret) { | |
1721 | dev_err(dev, "can't reset resource table: %d\n", ret); | |
1722 | return ret; | |
1723 | } | |
1724 | ||
0a8b81cb | 1725 | |
1efa30d0 SJ |
1726 | /* power off the remote processor */ |
1727 | ret = rproc->ops->stop(rproc); | |
1728 | if (ret) { | |
1729 | dev_err(dev, "can't stop rproc: %d\n", ret); | |
1730 | return ret; | |
1731 | } | |
1732 | ||
c455daa4 BA |
1733 | rproc_unprepare_subdevices(rproc); |
1734 | ||
1efa30d0 SJ |
1735 | rproc->state = RPROC_OFFLINE; |
1736 | ||
1737 | dev_info(dev, "stopped remote processor %s\n", rproc->name); | |
1738 | ||
1739 | return 0; | |
1740 | } | |
1741 | ||
6070203f MP |
1742 | /* |
1743 | * __rproc_detach(): Does the opposite of __rproc_attach() | |
1744 | */ | |
d3962a39 | 1745 | static int __rproc_detach(struct rproc *rproc) |
6070203f MP |
1746 | { |
1747 | struct device *dev = &rproc->dev; | |
1748 | int ret; | |
1749 | ||
1750 | /* No need to continue if a detach() operation has not been provided */ | |
1751 | if (!rproc->ops->detach) | |
1752 | return -EINVAL; | |
1753 | ||
1754 | /* Stop any subdevices for the remote processor */ | |
1755 | rproc_stop_subdevices(rproc, false); | |
1756 | ||
9dc9507f MP |
1757 | /* the installed resource table is no longer accessible */ |
1758 | ret = rproc_reset_rsc_table_on_detach(rproc); | |
1759 | if (ret) { | |
1760 | dev_err(dev, "can't reset resource table: %d\n", ret); | |
1761 | return ret; | |
1762 | } | |
1763 | ||
6070203f MP |
1764 | /* Tell the remote processor the core isn't available anymore */ |
1765 | ret = rproc->ops->detach(rproc); | |
1766 | if (ret) { | |
1767 | dev_err(dev, "can't detach from rproc: %d\n", ret); | |
1768 | return ret; | |
1769 | } | |
1770 | ||
1771 | rproc_unprepare_subdevices(rproc); | |
1772 | ||
1773 | rproc->state = RPROC_DETACHED; | |
1774 | ||
1775 | dev_info(dev, "detached remote processor %s\n", rproc->name); | |
1776 | ||
1777 | return 0; | |
1778 | } | |
2666ca91 | 1779 | |
ba194232 PF |
1780 | static int rproc_attach_recovery(struct rproc *rproc) |
1781 | { | |
1782 | int ret; | |
1783 | ||
1784 | ret = __rproc_detach(rproc); | |
1785 | if (ret) | |
1786 | return ret; | |
1787 | ||
1788 | return __rproc_attach(rproc); | |
1789 | } | |
1790 | ||
1791 | static int rproc_boot_recovery(struct rproc *rproc) | |
1792 | { | |
1793 | const struct firmware *firmware_p; | |
1794 | struct device *dev = &rproc->dev; | |
1795 | int ret; | |
1796 | ||
1797 | ret = rproc_stop(rproc, true); | |
1798 | if (ret) | |
1799 | return ret; | |
1800 | ||
1801 | /* generate coredump */ | |
1802 | rproc->ops->coredump(rproc); | |
1803 | ||
1804 | /* load firmware */ | |
1805 | ret = request_firmware(&firmware_p, rproc->firmware, dev); | |
1806 | if (ret < 0) { | |
1807 | dev_err(dev, "request_firmware failed: %d\n", ret); | |
1808 | return ret; | |
1809 | } | |
1810 | ||
1811 | /* boot the remote processor up again */ | |
1812 | ret = rproc_start(rproc, firmware_p); | |
1813 | ||
1814 | release_firmware(firmware_p); | |
1815 | ||
1816 | return ret; | |
1817 | } | |
1818 | ||
70b85ef8 FGL |
1819 | /** |
1820 | * rproc_trigger_recovery() - recover a remoteproc | |
1821 | * @rproc: the remote processor | |
1822 | * | |
56324d7a | 1823 | * The recovery is done by resetting all the virtio devices, that way all the |
70b85ef8 FGL |
1824 | * rpmsg drivers will be reseted along with the remote processor making the |
1825 | * remoteproc functional again. | |
1826 | * | |
1827 | * This function can sleep, so it cannot be called from atomic context. | |
f2867434 SA |
1828 | * |
1829 | * Return: 0 on success or a negative value upon failure | |
70b85ef8 FGL |
1830 | */ |
1831 | int rproc_trigger_recovery(struct rproc *rproc) | |
1832 | { | |
7e83cab8 SJ |
1833 | struct device *dev = &rproc->dev; |
1834 | int ret; | |
1835 | ||
7e83cab8 SJ |
1836 | ret = mutex_lock_interruptible(&rproc->lock); |
1837 | if (ret) | |
1838 | return ret; | |
1839 | ||
0b145574 AE |
1840 | /* State could have changed before we got the mutex */ |
1841 | if (rproc->state != RPROC_CRASHED) | |
1842 | goto unlock_mutex; | |
1843 | ||
1844 | dev_err(dev, "recovering %s\n", rproc->name); | |
1845 | ||
ba194232 PF |
1846 | if (rproc_has_feature(rproc, RPROC_FEAT_ATTACH_ON_RECOVERY)) |
1847 | ret = rproc_attach_recovery(rproc); | |
1848 | else | |
1849 | ret = rproc_boot_recovery(rproc); | |
7e83cab8 SJ |
1850 | |
1851 | unlock_mutex: | |
1852 | mutex_unlock(&rproc->lock); | |
1853 | return ret; | |
70b85ef8 FGL |
1854 | } |
1855 | ||
8afd519c FGL |
1856 | /** |
1857 | * rproc_crash_handler_work() - handle a crash | |
2e7d4c2c | 1858 | * @work: work treating the crash |
8afd519c FGL |
1859 | * |
1860 | * This function needs to handle everything related to a crash, like cpu | |
1861 | * registers and stack dump, information to help to debug the fatal error, etc. | |
1862 | */ | |
1863 | static void rproc_crash_handler_work(struct work_struct *work) | |
1864 | { | |
1865 | struct rproc *rproc = container_of(work, struct rproc, crash_handler); | |
1866 | struct device *dev = &rproc->dev; | |
1867 | ||
1868 | dev_dbg(dev, "enter %s\n", __func__); | |
1869 | ||
1870 | mutex_lock(&rproc->lock); | |
1871 | ||
11c7f9e3 | 1872 | if (rproc->state == RPROC_CRASHED) { |
8afd519c FGL |
1873 | /* handle only the first crash detected */ |
1874 | mutex_unlock(&rproc->lock); | |
1875 | return; | |
1876 | } | |
1877 | ||
11c7f9e3 MY |
1878 | if (rproc->state == RPROC_OFFLINE) { |
1879 | /* Don't recover if the remote processor was stopped */ | |
1880 | mutex_unlock(&rproc->lock); | |
1881 | goto out; | |
1882 | } | |
1883 | ||
8afd519c FGL |
1884 | rproc->state = RPROC_CRASHED; |
1885 | dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt, | |
1886 | rproc->name); | |
1887 | ||
1888 | mutex_unlock(&rproc->lock); | |
1889 | ||
2e37abb8 FGL |
1890 | if (!rproc->recovery_disabled) |
1891 | rproc_trigger_recovery(rproc); | |
a781e5aa | 1892 | |
11c7f9e3 | 1893 | out: |
a781e5aa | 1894 | pm_relax(rproc->dev.parent); |
8afd519c FGL |
1895 | } |
1896 | ||
400e64df | 1897 | /** |
1b0ef906 | 1898 | * rproc_boot() - boot a remote processor |
400e64df OBC |
1899 | * @rproc: handle of a remote processor |
1900 | * | |
1901 | * Boot a remote processor (i.e. load its firmware, power it on, ...). | |
1902 | * | |
1903 | * If the remote processor is already powered on, this function immediately | |
1904 | * returns (successfully). | |
1905 | * | |
f2867434 | 1906 | * Return: 0 on success, and an appropriate error value otherwise |
400e64df | 1907 | */ |
1b0ef906 | 1908 | int rproc_boot(struct rproc *rproc) |
400e64df OBC |
1909 | { |
1910 | const struct firmware *firmware_p; | |
1911 | struct device *dev; | |
1912 | int ret; | |
1913 | ||
1914 | if (!rproc) { | |
1915 | pr_err("invalid rproc handle\n"); | |
1916 | return -EINVAL; | |
1917 | } | |
1918 | ||
b5ab5e24 | 1919 | dev = &rproc->dev; |
400e64df OBC |
1920 | |
1921 | ret = mutex_lock_interruptible(&rproc->lock); | |
1922 | if (ret) { | |
1923 | dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); | |
1924 | return ret; | |
1925 | } | |
1926 | ||
2099c77d SJ |
1927 | if (rproc->state == RPROC_DELETED) { |
1928 | ret = -ENODEV; | |
1929 | dev_err(dev, "can't boot deleted rproc %s\n", rproc->name); | |
1930 | goto unlock_mutex; | |
1931 | } | |
1932 | ||
0f9dc562 | 1933 | /* skip the boot or attach process if rproc is already powered up */ |
400e64df OBC |
1934 | if (atomic_inc_return(&rproc->power) > 1) { |
1935 | ret = 0; | |
1936 | goto unlock_mutex; | |
1937 | } | |
1938 | ||
0f9dc562 MP |
1939 | if (rproc->state == RPROC_DETACHED) { |
1940 | dev_info(dev, "attaching to %s\n", rproc->name); | |
400e64df | 1941 | |
6a6c4dc0 | 1942 | ret = rproc_attach(rproc); |
0f9dc562 MP |
1943 | } else { |
1944 | dev_info(dev, "powering up %s\n", rproc->name); | |
400e64df | 1945 | |
0f9dc562 MP |
1946 | /* load firmware */ |
1947 | ret = request_firmware(&firmware_p, rproc->firmware, dev); | |
1948 | if (ret < 0) { | |
1949 | dev_err(dev, "request_firmware failed: %d\n", ret); | |
1950 | goto downref_rproc; | |
1951 | } | |
400e64df | 1952 | |
0f9dc562 MP |
1953 | ret = rproc_fw_boot(rproc, firmware_p); |
1954 | ||
1955 | release_firmware(firmware_p); | |
1956 | } | |
400e64df OBC |
1957 | |
1958 | downref_rproc: | |
fbb6aacb | 1959 | if (ret) |
400e64df | 1960 | atomic_dec(&rproc->power); |
400e64df OBC |
1961 | unlock_mutex: |
1962 | mutex_unlock(&rproc->lock); | |
1963 | return ret; | |
1964 | } | |
1965 | EXPORT_SYMBOL(rproc_boot); | |
1966 | ||
1967 | /** | |
1968 | * rproc_shutdown() - power off the remote processor | |
1969 | * @rproc: the remote processor | |
1970 | * | |
1971 | * Power off a remote processor (previously booted with rproc_boot()). | |
1972 | * | |
1973 | * In case @rproc is still being used by an additional user(s), then | |
1974 | * this function will just decrement the power refcount and exit, | |
1975 | * without really powering off the device. | |
1976 | * | |
1977 | * Every call to rproc_boot() must (eventually) be accompanied by a call | |
1978 | * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug. | |
1979 | * | |
1980 | * Notes: | |
1981 | * - we're not decrementing the rproc's refcount, only the power refcount. | |
1982 | * which means that the @rproc handle stays valid even after rproc_shutdown() | |
1983 | * returns, and users can still use it with a subsequent rproc_boot(), if | |
1984 | * needed. | |
c13b780c SA |
1985 | * |
1986 | * Return: 0 on success, and an appropriate error value otherwise | |
400e64df | 1987 | */ |
c13b780c | 1988 | int rproc_shutdown(struct rproc *rproc) |
400e64df | 1989 | { |
b5ab5e24 | 1990 | struct device *dev = &rproc->dev; |
c13b780c | 1991 | int ret = 0; |
400e64df OBC |
1992 | |
1993 | ret = mutex_lock_interruptible(&rproc->lock); | |
1994 | if (ret) { | |
1995 | dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); | |
c13b780c | 1996 | return ret; |
400e64df OBC |
1997 | } |
1998 | ||
5e6a0e05 SW |
1999 | if (rproc->state != RPROC_RUNNING && |
2000 | rproc->state != RPROC_ATTACHED) { | |
2001 | ret = -EINVAL; | |
2002 | goto out; | |
2003 | } | |
2004 | ||
400e64df OBC |
2005 | /* if the remote proc is still needed, bail out */ |
2006 | if (!atomic_dec_and_test(&rproc->power)) | |
2007 | goto out; | |
2008 | ||
fcd58037 | 2009 | ret = rproc_stop(rproc, false); |
400e64df OBC |
2010 | if (ret) { |
2011 | atomic_inc(&rproc->power); | |
400e64df OBC |
2012 | goto out; |
2013 | } | |
2014 | ||
2015 | /* clean up all acquired resources */ | |
2016 | rproc_resource_cleanup(rproc); | |
2017 | ||
33467ac3 LP |
2018 | /* release HW resources if needed */ |
2019 | rproc_unprepare_device(rproc); | |
2020 | ||
400e64df OBC |
2021 | rproc_disable_iommu(rproc); |
2022 | ||
988d204c | 2023 | /* Free the copy of the resource table */ |
a0c10687 BA |
2024 | kfree(rproc->cached_table); |
2025 | rproc->cached_table = NULL; | |
988d204c | 2026 | rproc->table_ptr = NULL; |
400e64df OBC |
2027 | out: |
2028 | mutex_unlock(&rproc->lock); | |
c13b780c | 2029 | return ret; |
400e64df OBC |
2030 | } |
2031 | EXPORT_SYMBOL(rproc_shutdown); | |
2032 | ||
d3962a39 MP |
2033 | /** |
2034 | * rproc_detach() - Detach the remote processor from the | |
2035 | * remoteproc core | |
2036 | * | |
2037 | * @rproc: the remote processor | |
2038 | * | |
2039 | * Detach a remote processor (previously attached to with rproc_attach()). | |
2040 | * | |
2041 | * In case @rproc is still being used by an additional user(s), then | |
2042 | * this function will just decrement the power refcount and exit, | |
2043 | * without disconnecting the device. | |
2044 | * | |
2045 | * Function rproc_detach() calls __rproc_detach() in order to let a remote | |
2046 | * processor know that services provided by the application processor are | |
2047 | * no longer available. From there it should be possible to remove the | |
2048 | * platform driver and even power cycle the application processor (if the HW | |
2049 | * supports it) without needing to switch off the remote processor. | |
f2867434 SA |
2050 | * |
2051 | * Return: 0 on success, and an appropriate error value otherwise | |
d3962a39 MP |
2052 | */ |
2053 | int rproc_detach(struct rproc *rproc) | |
2054 | { | |
2055 | struct device *dev = &rproc->dev; | |
2056 | int ret; | |
2057 | ||
2058 | ret = mutex_lock_interruptible(&rproc->lock); | |
2059 | if (ret) { | |
2060 | dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); | |
2061 | return ret; | |
2062 | } | |
2063 | ||
5e6a0e05 SW |
2064 | if (rproc->state != RPROC_ATTACHED) { |
2065 | ret = -EINVAL; | |
2066 | goto out; | |
2067 | } | |
2068 | ||
d3962a39 MP |
2069 | /* if the remote proc is still needed, bail out */ |
2070 | if (!atomic_dec_and_test(&rproc->power)) { | |
2071 | ret = 0; | |
2072 | goto out; | |
2073 | } | |
2074 | ||
2075 | ret = __rproc_detach(rproc); | |
2076 | if (ret) { | |
2077 | atomic_inc(&rproc->power); | |
2078 | goto out; | |
2079 | } | |
2080 | ||
2081 | /* clean up all acquired resources */ | |
2082 | rproc_resource_cleanup(rproc); | |
2083 | ||
2084 | /* release HW resources if needed */ | |
2085 | rproc_unprepare_device(rproc); | |
2086 | ||
2087 | rproc_disable_iommu(rproc); | |
2088 | ||
9dc9507f MP |
2089 | /* Free the copy of the resource table */ |
2090 | kfree(rproc->cached_table); | |
2091 | rproc->cached_table = NULL; | |
d3962a39 MP |
2092 | rproc->table_ptr = NULL; |
2093 | out: | |
2094 | mutex_unlock(&rproc->lock); | |
2095 | return ret; | |
2096 | } | |
2097 | EXPORT_SYMBOL(rproc_detach); | |
2098 | ||
fec47d86 DG |
2099 | /** |
2100 | * rproc_get_by_phandle() - find a remote processor by phandle | |
2101 | * @phandle: phandle to the rproc | |
2102 | * | |
2103 | * Finds an rproc handle using the remote processor's phandle, and then | |
2104 | * return a handle to the rproc. | |
2105 | * | |
2106 | * This function increments the remote processor's refcount, so always | |
2107 | * use rproc_put() to decrement it back once rproc isn't needed anymore. | |
2108 | * | |
f2867434 | 2109 | * Return: rproc handle on success, and NULL on failure |
fec47d86 | 2110 | */ |
8de3dbd0 | 2111 | #ifdef CONFIG_OF |
fec47d86 DG |
2112 | struct rproc *rproc_get_by_phandle(phandle phandle) |
2113 | { | |
2114 | struct rproc *rproc = NULL, *r; | |
2115 | struct device_node *np; | |
2116 | ||
2117 | np = of_find_node_by_phandle(phandle); | |
2118 | if (!np) | |
2119 | return NULL; | |
2120 | ||
c0abe2ca BA |
2121 | rcu_read_lock(); |
2122 | list_for_each_entry_rcu(r, &rproc_list, node) { | |
e63ae3f8 | 2123 | if (r->dev.parent && device_match_of_node(r->dev.parent, np)) { |
fbb6aacb BA |
2124 | /* prevent underlying implementation from being removed */ |
2125 | if (!try_module_get(r->dev.parent->driver->owner)) { | |
2126 | dev_err(&r->dev, "can't get owner\n"); | |
2127 | break; | |
2128 | } | |
2129 | ||
fec47d86 DG |
2130 | rproc = r; |
2131 | get_device(&rproc->dev); | |
2132 | break; | |
2133 | } | |
2134 | } | |
c0abe2ca | 2135 | rcu_read_unlock(); |
fec47d86 DG |
2136 | |
2137 | of_node_put(np); | |
2138 | ||
2139 | return rproc; | |
2140 | } | |
8de3dbd0 OBC |
2141 | #else |
2142 | struct rproc *rproc_get_by_phandle(phandle phandle) | |
2143 | { | |
2144 | return NULL; | |
2145 | } | |
2146 | #endif | |
fec47d86 DG |
2147 | EXPORT_SYMBOL(rproc_get_by_phandle); |
2148 | ||
4c1ad562 SA |
2149 | /** |
2150 | * rproc_set_firmware() - assign a new firmware | |
2151 | * @rproc: rproc handle to which the new firmware is being assigned | |
2152 | * @fw_name: new firmware name to be assigned | |
2153 | * | |
2154 | * This function allows remoteproc drivers or clients to configure a custom | |
2155 | * firmware name that is different from the default name used during remoteproc | |
2156 | * registration. The function does not trigger a remote processor boot, | |
2157 | * only sets the firmware name used for a subsequent boot. This function | |
2158 | * should also be called only when the remote processor is offline. | |
2159 | * | |
2160 | * This allows either the userspace to configure a different name through | |
2161 | * sysfs or a kernel-level remoteproc or a remoteproc client driver to set | |
2162 | * a specific firmware when it is controlling the boot and shutdown of the | |
2163 | * remote processor. | |
2164 | * | |
2165 | * Return: 0 on success or a negative value upon failure | |
2166 | */ | |
2167 | int rproc_set_firmware(struct rproc *rproc, const char *fw_name) | |
2168 | { | |
2169 | struct device *dev; | |
2170 | int ret, len; | |
2171 | char *p; | |
2172 | ||
2173 | if (!rproc || !fw_name) | |
2174 | return -EINVAL; | |
2175 | ||
2176 | dev = rproc->dev.parent; | |
2177 | ||
2178 | ret = mutex_lock_interruptible(&rproc->lock); | |
2179 | if (ret) { | |
2180 | dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); | |
2181 | return -EINVAL; | |
2182 | } | |
2183 | ||
2184 | if (rproc->state != RPROC_OFFLINE) { | |
2185 | dev_err(dev, "can't change firmware while running\n"); | |
2186 | ret = -EBUSY; | |
2187 | goto out; | |
2188 | } | |
2189 | ||
2190 | len = strcspn(fw_name, "\n"); | |
2191 | if (!len) { | |
2192 | dev_err(dev, "can't provide empty string for firmware name\n"); | |
2193 | ret = -EINVAL; | |
2194 | goto out; | |
2195 | } | |
2196 | ||
2197 | p = kstrndup(fw_name, len, GFP_KERNEL); | |
2198 | if (!p) { | |
2199 | ret = -ENOMEM; | |
2200 | goto out; | |
2201 | } | |
2202 | ||
43d3f2c7 | 2203 | kfree_const(rproc->firmware); |
4c1ad562 SA |
2204 | rproc->firmware = p; |
2205 | ||
2206 | out: | |
2207 | mutex_unlock(&rproc->lock); | |
2208 | return ret; | |
2209 | } | |
2210 | EXPORT_SYMBOL(rproc_set_firmware); | |
2211 | ||
88d3a136 MP |
2212 | static int rproc_validate(struct rproc *rproc) |
2213 | { | |
2214 | switch (rproc->state) { | |
2215 | case RPROC_OFFLINE: | |
2216 | /* | |
2217 | * An offline processor without a start() | |
2218 | * function makes no sense. | |
2219 | */ | |
2220 | if (!rproc->ops->start) | |
2221 | return -EINVAL; | |
2222 | break; | |
2223 | case RPROC_DETACHED: | |
2224 | /* | |
2225 | * A remote processor in a detached state without an | |
2226 | * attach() function makes not sense. | |
2227 | */ | |
2228 | if (!rproc->ops->attach) | |
2229 | return -EINVAL; | |
2230 | /* | |
2231 | * When attaching to a remote processor the device memory | |
2232 | * is already available and as such there is no need to have a | |
2233 | * cached table. | |
2234 | */ | |
2235 | if (rproc->cached_table) | |
2236 | return -EINVAL; | |
2237 | break; | |
2238 | default: | |
2239 | /* | |
2240 | * When adding a remote processor, the state of the device | |
2241 | * can be offline or detached, nothing else. | |
2242 | */ | |
2243 | return -EINVAL; | |
2244 | } | |
2245 | ||
2246 | return 0; | |
2247 | } | |
2248 | ||
400e64df | 2249 | /** |
160e7c84 | 2250 | * rproc_add() - register a remote processor |
400e64df OBC |
2251 | * @rproc: the remote processor handle to register |
2252 | * | |
2253 | * Registers @rproc with the remoteproc framework, after it has been | |
2254 | * allocated with rproc_alloc(). | |
2255 | * | |
2256 | * This is called by the platform-specific rproc implementation, whenever | |
2257 | * a new remote processor device is probed. | |
2258 | * | |
400e64df OBC |
2259 | * Note: this function initiates an asynchronous firmware loading |
2260 | * context, which will look for virtio devices supported by the rproc's | |
2261 | * firmware. | |
2262 | * | |
2263 | * If found, those virtio devices will be created and added, so as a result | |
7a186941 | 2264 | * of registering this remote processor, additional virtio drivers might be |
400e64df | 2265 | * probed. |
f2867434 SA |
2266 | * |
2267 | * Return: 0 on success and an appropriate error code otherwise | |
400e64df | 2268 | */ |
160e7c84 | 2269 | int rproc_add(struct rproc *rproc) |
400e64df | 2270 | { |
b5ab5e24 | 2271 | struct device *dev = &rproc->dev; |
70b85ef8 | 2272 | int ret; |
400e64df | 2273 | |
519346ec | 2274 | ret = rproc_validate(rproc); |
b5ab5e24 OBC |
2275 | if (ret < 0) |
2276 | return ret; | |
400e64df | 2277 | |
519346ec SG |
2278 | /* add char device for this remoteproc */ |
2279 | ret = rproc_char_device_add(rproc); | |
88d3a136 MP |
2280 | if (ret < 0) |
2281 | return ret; | |
2282 | ||
519346ec | 2283 | ret = device_add(dev); |
7dbdb8bd SG |
2284 | if (ret < 0) { |
2285 | put_device(dev); | |
2286 | goto rproc_remove_cdev; | |
2287 | } | |
88d3a136 | 2288 | |
b5ab5e24 | 2289 | dev_info(dev, "%s is available\n", rproc->name); |
400e64df OBC |
2290 | |
2291 | /* create debugfs entries */ | |
2292 | rproc_create_debug_dir(rproc); | |
7a20c64d SJ |
2293 | |
2294 | /* if rproc is marked always-on, request it to boot */ | |
2295 | if (rproc->auto_boot) { | |
5e6533f7 | 2296 | ret = rproc_trigger_auto_boot(rproc); |
7a20c64d | 2297 | if (ret < 0) |
7dbdb8bd | 2298 | goto rproc_remove_dev; |
7a20c64d | 2299 | } |
400e64df | 2300 | |
d2e12e66 DG |
2301 | /* expose to rproc_get_by_phandle users */ |
2302 | mutex_lock(&rproc_list_mutex); | |
c0abe2ca | 2303 | list_add_rcu(&rproc->node, &rproc_list); |
d2e12e66 DG |
2304 | mutex_unlock(&rproc_list_mutex); |
2305 | ||
2306 | return 0; | |
7dbdb8bd SG |
2307 | |
2308 | rproc_remove_dev: | |
2309 | rproc_delete_debug_dir(rproc); | |
2310 | device_del(dev); | |
2311 | rproc_remove_cdev: | |
2312 | rproc_char_device_remove(rproc); | |
2313 | return ret; | |
400e64df | 2314 | } |
160e7c84 | 2315 | EXPORT_SYMBOL(rproc_add); |
400e64df | 2316 | |
305ac5a7 PC |
2317 | static void devm_rproc_remove(void *rproc) |
2318 | { | |
2319 | rproc_del(rproc); | |
2320 | } | |
2321 | ||
2322 | /** | |
2323 | * devm_rproc_add() - resource managed rproc_add() | |
2324 | * @dev: the underlying device | |
2325 | * @rproc: the remote processor handle to register | |
2326 | * | |
2327 | * This function performs like rproc_add() but the registered rproc device will | |
2328 | * automatically be removed on driver detach. | |
2329 | * | |
f2867434 | 2330 | * Return: 0 on success, negative errno on failure |
305ac5a7 PC |
2331 | */ |
2332 | int devm_rproc_add(struct device *dev, struct rproc *rproc) | |
2333 | { | |
2334 | int err; | |
2335 | ||
2336 | err = rproc_add(rproc); | |
2337 | if (err) | |
2338 | return err; | |
2339 | ||
2340 | return devm_add_action_or_reset(dev, devm_rproc_remove, rproc); | |
2341 | } | |
2342 | EXPORT_SYMBOL(devm_rproc_add); | |
2343 | ||
b5ab5e24 OBC |
2344 | /** |
2345 | * rproc_type_release() - release a remote processor instance | |
2346 | * @dev: the rproc's device | |
2347 | * | |
2348 | * This function should _never_ be called directly. | |
2349 | * | |
2350 | * It will be called by the driver core when no one holds a valid pointer | |
2351 | * to @dev anymore. | |
2352 | */ | |
2353 | static void rproc_type_release(struct device *dev) | |
2354 | { | |
2355 | struct rproc *rproc = container_of(dev, struct rproc, dev); | |
2356 | ||
7183a2a7 OBC |
2357 | dev_info(&rproc->dev, "releasing %s\n", rproc->name); |
2358 | ||
b5ab5e24 OBC |
2359 | idr_destroy(&rproc->notifyids); |
2360 | ||
2361 | if (rproc->index >= 0) | |
08333b91 | 2362 | ida_free(&rproc_dev_index, rproc->index); |
b5ab5e24 | 2363 | |
1487deda | 2364 | kfree_const(rproc->firmware); |
db655278 | 2365 | kfree_const(rproc->name); |
fb98e2bd | 2366 | kfree(rproc->ops); |
b5ab5e24 OBC |
2367 | kfree(rproc); |
2368 | } | |
2369 | ||
c42ca04d | 2370 | static const struct device_type rproc_type = { |
b5ab5e24 OBC |
2371 | .name = "remoteproc", |
2372 | .release = rproc_type_release, | |
2373 | }; | |
400e64df | 2374 | |
0c2ae2b1 MP |
2375 | static int rproc_alloc_firmware(struct rproc *rproc, |
2376 | const char *name, const char *firmware) | |
2377 | { | |
1487deda | 2378 | const char *p; |
0c2ae2b1 | 2379 | |
9d5f82c8 MP |
2380 | /* |
2381 | * Allocate a firmware name if the caller gave us one to work | |
2382 | * with. Otherwise construct a new one using a default pattern. | |
2383 | */ | |
2384 | if (firmware) | |
1487deda | 2385 | p = kstrdup_const(firmware, GFP_KERNEL); |
9d5f82c8 MP |
2386 | else |
2387 | p = kasprintf(GFP_KERNEL, "rproc-%s-fw", name); | |
4df4f8be MP |
2388 | |
2389 | if (!p) | |
2390 | return -ENOMEM; | |
0c2ae2b1 MP |
2391 | |
2392 | rproc->firmware = p; | |
2393 | ||
2394 | return 0; | |
2395 | } | |
2396 | ||
bf860aa1 MP |
2397 | static int rproc_alloc_ops(struct rproc *rproc, const struct rproc_ops *ops) |
2398 | { | |
2399 | rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL); | |
2400 | if (!rproc->ops) | |
2401 | return -ENOMEM; | |
2402 | ||
adf60a87 SG |
2403 | /* Default to rproc_coredump if no coredump function is specified */ |
2404 | if (!rproc->ops->coredump) | |
2405 | rproc->ops->coredump = rproc_coredump; | |
2406 | ||
bf860aa1 MP |
2407 | if (rproc->ops->load) |
2408 | return 0; | |
2409 | ||
2410 | /* Default to ELF loader if no load function is specified */ | |
2411 | rproc->ops->load = rproc_elf_load_segments; | |
2412 | rproc->ops->parse_fw = rproc_elf_load_rsc_table; | |
2413 | rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table; | |
e29ff72b | 2414 | rproc->ops->sanity_check = rproc_elf_sanity_check; |
bf860aa1 MP |
2415 | rproc->ops->get_boot_addr = rproc_elf_get_boot_addr; |
2416 | ||
2417 | return 0; | |
2418 | } | |
2419 | ||
400e64df OBC |
2420 | /** |
2421 | * rproc_alloc() - allocate a remote processor handle | |
2422 | * @dev: the underlying device | |
2423 | * @name: name of this remote processor | |
2424 | * @ops: platform-specific handlers (mainly start/stop) | |
8b4aec9a | 2425 | * @firmware: name of firmware file to load, can be NULL |
400e64df OBC |
2426 | * @len: length of private data needed by the rproc driver (in bytes) |
2427 | * | |
2428 | * Allocates a new remote processor handle, but does not register | |
8b4aec9a | 2429 | * it yet. if @firmware is NULL, a default name is used. |
400e64df OBC |
2430 | * |
2431 | * This function should be used by rproc implementations during initialization | |
2432 | * of the remote processor. | |
2433 | * | |
2434 | * After creating an rproc handle using this function, and when ready, | |
160e7c84 | 2435 | * implementations should then call rproc_add() to complete |
400e64df OBC |
2436 | * the registration of the remote processor. |
2437 | * | |
400e64df | 2438 | * Note: _never_ directly deallocate @rproc, even if it was not registered |
433c0e04 | 2439 | * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free(). |
f2867434 SA |
2440 | * |
2441 | * Return: new rproc pointer on success, and NULL on failure | |
400e64df OBC |
2442 | */ |
2443 | struct rproc *rproc_alloc(struct device *dev, const char *name, | |
730f84ce AS |
2444 | const struct rproc_ops *ops, |
2445 | const char *firmware, int len) | |
400e64df OBC |
2446 | { |
2447 | struct rproc *rproc; | |
2448 | ||
2449 | if (!dev || !name || !ops) | |
2450 | return NULL; | |
2451 | ||
0f57dc6a | 2452 | rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL); |
0c2ae2b1 | 2453 | if (!rproc) |
0f57dc6a | 2454 | return NULL; |
0c2ae2b1 | 2455 | |
400e64df | 2456 | rproc->priv = &rproc[1]; |
ddf71187 | 2457 | rproc->auto_boot = true; |
418fd787 CL |
2458 | rproc->elf_class = ELFCLASSNONE; |
2459 | rproc->elf_machine = EM_NONE; | |
400e64df | 2460 | |
b5ab5e24 OBC |
2461 | device_initialize(&rproc->dev); |
2462 | rproc->dev.parent = dev; | |
2463 | rproc->dev.type = &rproc_type; | |
2aefbef0 | 2464 | rproc->dev.class = &rproc_class; |
7c89717f | 2465 | rproc->dev.driver_data = rproc; |
6442df49 | 2466 | idr_init(&rproc->notifyids); |
b5ab5e24 | 2467 | |
db655278 SA |
2468 | rproc->name = kstrdup_const(name, GFP_KERNEL); |
2469 | if (!rproc->name) | |
2470 | goto put_device; | |
2471 | ||
226f5db4 MP |
2472 | if (rproc_alloc_firmware(rproc, name, firmware)) |
2473 | goto put_device; | |
2474 | ||
2475 | if (rproc_alloc_ops(rproc, ops)) | |
2476 | goto put_device; | |
2477 | ||
b5ab5e24 | 2478 | /* Assign a unique device index and name */ |
08333b91 | 2479 | rproc->index = ida_alloc(&rproc_dev_index, GFP_KERNEL); |
b5ab5e24 | 2480 | if (rproc->index < 0) { |
08333b91 | 2481 | dev_err(dev, "ida_alloc failed: %d\n", rproc->index); |
226f5db4 | 2482 | goto put_device; |
b5ab5e24 OBC |
2483 | } |
2484 | ||
2485 | dev_set_name(&rproc->dev, "remoteproc%d", rproc->index); | |
2486 | ||
400e64df OBC |
2487 | atomic_set(&rproc->power, 0); |
2488 | ||
400e64df OBC |
2489 | mutex_init(&rproc->lock); |
2490 | ||
2491 | INIT_LIST_HEAD(&rproc->carveouts); | |
2492 | INIT_LIST_HEAD(&rproc->mappings); | |
2493 | INIT_LIST_HEAD(&rproc->traces); | |
7a186941 | 2494 | INIT_LIST_HEAD(&rproc->rvdevs); |
7bdc9650 | 2495 | INIT_LIST_HEAD(&rproc->subdevs); |
2666ca91 | 2496 | INIT_LIST_HEAD(&rproc->dump_segments); |
400e64df | 2497 | |
8afd519c FGL |
2498 | INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work); |
2499 | ||
400e64df OBC |
2500 | rproc->state = RPROC_OFFLINE; |
2501 | ||
2502 | return rproc; | |
0c2ae2b1 | 2503 | |
226f5db4 MP |
2504 | put_device: |
2505 | put_device(&rproc->dev); | |
0c2ae2b1 | 2506 | return NULL; |
400e64df OBC |
2507 | } |
2508 | EXPORT_SYMBOL(rproc_alloc); | |
2509 | ||
2510 | /** | |
433c0e04 BA |
2511 | * rproc_free() - unroll rproc_alloc() |
2512 | * @rproc: the remote processor handle | |
2513 | * | |
2514 | * This function decrements the rproc dev refcount. | |
2515 | * | |
2516 | * If no one holds any reference to rproc anymore, then its refcount would | |
2517 | * now drop to zero, and it would be freed. | |
2518 | */ | |
2519 | void rproc_free(struct rproc *rproc) | |
2520 | { | |
2521 | put_device(&rproc->dev); | |
2522 | } | |
2523 | EXPORT_SYMBOL(rproc_free); | |
2524 | ||
2525 | /** | |
2526 | * rproc_put() - release rproc reference | |
400e64df OBC |
2527 | * @rproc: the remote processor handle |
2528 | * | |
c6b5a276 | 2529 | * This function decrements the rproc dev refcount. |
400e64df | 2530 | * |
c6b5a276 OBC |
2531 | * If no one holds any reference to rproc anymore, then its refcount would |
2532 | * now drop to zero, and it would be freed. | |
400e64df | 2533 | */ |
160e7c84 | 2534 | void rproc_put(struct rproc *rproc) |
400e64df | 2535 | { |
fbb6aacb | 2536 | module_put(rproc->dev.parent->driver->owner); |
b5ab5e24 | 2537 | put_device(&rproc->dev); |
400e64df | 2538 | } |
160e7c84 | 2539 | EXPORT_SYMBOL(rproc_put); |
400e64df OBC |
2540 | |
2541 | /** | |
160e7c84 | 2542 | * rproc_del() - unregister a remote processor |
400e64df OBC |
2543 | * @rproc: rproc handle to unregister |
2544 | * | |
400e64df OBC |
2545 | * This function should be called when the platform specific rproc |
2546 | * implementation decides to remove the rproc device. it should | |
160e7c84 | 2547 | * _only_ be called if a previous invocation of rproc_add() |
400e64df OBC |
2548 | * has completed successfully. |
2549 | * | |
160e7c84 | 2550 | * After rproc_del() returns, @rproc isn't freed yet, because |
c6b5a276 | 2551 | * of the outstanding reference created by rproc_alloc. To decrement that |
433c0e04 | 2552 | * one last refcount, one still needs to call rproc_free(). |
400e64df | 2553 | * |
f2867434 | 2554 | * Return: 0 on success and -EINVAL if @rproc isn't valid |
400e64df | 2555 | */ |
160e7c84 | 2556 | int rproc_del(struct rproc *rproc) |
400e64df OBC |
2557 | { |
2558 | if (!rproc) | |
2559 | return -EINVAL; | |
2560 | ||
ddf71187 | 2561 | /* TODO: make sure this works with rproc->power > 1 */ |
16324fc8 | 2562 | rproc_shutdown(rproc); |
ddf71187 | 2563 | |
2099c77d SJ |
2564 | mutex_lock(&rproc->lock); |
2565 | rproc->state = RPROC_DELETED; | |
2566 | mutex_unlock(&rproc->lock); | |
2567 | ||
b003d45b SJ |
2568 | rproc_delete_debug_dir(rproc); |
2569 | ||
fec47d86 DG |
2570 | /* the rproc is downref'ed as soon as it's removed from the klist */ |
2571 | mutex_lock(&rproc_list_mutex); | |
c0abe2ca | 2572 | list_del_rcu(&rproc->node); |
fec47d86 DG |
2573 | mutex_unlock(&rproc_list_mutex); |
2574 | ||
c0abe2ca BA |
2575 | /* Ensure that no readers of rproc_list are still active */ |
2576 | synchronize_rcu(); | |
2577 | ||
b5ab5e24 | 2578 | device_del(&rproc->dev); |
930eec0b | 2579 | rproc_char_device_remove(rproc); |
400e64df OBC |
2580 | |
2581 | return 0; | |
2582 | } | |
160e7c84 | 2583 | EXPORT_SYMBOL(rproc_del); |
400e64df | 2584 | |
305ac5a7 PC |
2585 | static void devm_rproc_free(struct device *dev, void *res) |
2586 | { | |
2587 | rproc_free(*(struct rproc **)res); | |
2588 | } | |
2589 | ||
2590 | /** | |
2591 | * devm_rproc_alloc() - resource managed rproc_alloc() | |
2592 | * @dev: the underlying device | |
2593 | * @name: name of this remote processor | |
2594 | * @ops: platform-specific handlers (mainly start/stop) | |
2595 | * @firmware: name of firmware file to load, can be NULL | |
2596 | * @len: length of private data needed by the rproc driver (in bytes) | |
2597 | * | |
2598 | * This function performs like rproc_alloc() but the acquired rproc device will | |
2599 | * automatically be released on driver detach. | |
2600 | * | |
f2867434 | 2601 | * Return: new rproc instance, or NULL on failure |
305ac5a7 PC |
2602 | */ |
2603 | struct rproc *devm_rproc_alloc(struct device *dev, const char *name, | |
2604 | const struct rproc_ops *ops, | |
2605 | const char *firmware, int len) | |
2606 | { | |
2607 | struct rproc **ptr, *rproc; | |
2608 | ||
2609 | ptr = devres_alloc(devm_rproc_free, sizeof(*ptr), GFP_KERNEL); | |
2610 | if (!ptr) | |
7dcef398 | 2611 | return NULL; |
305ac5a7 PC |
2612 | |
2613 | rproc = rproc_alloc(dev, name, ops, firmware, len); | |
2614 | if (rproc) { | |
2615 | *ptr = rproc; | |
2616 | devres_add(dev, ptr); | |
2617 | } else { | |
2618 | devres_free(ptr); | |
2619 | } | |
2620 | ||
2621 | return rproc; | |
2622 | } | |
2623 | EXPORT_SYMBOL(devm_rproc_alloc); | |
2624 | ||
7bdc9650 BA |
2625 | /** |
2626 | * rproc_add_subdev() - add a subdevice to a remoteproc | |
2627 | * @rproc: rproc handle to add the subdevice to | |
2628 | * @subdev: subdev handle to register | |
4902676f BA |
2629 | * |
2630 | * Caller is responsible for populating optional subdevice function pointers. | |
7bdc9650 | 2631 | */ |
4902676f | 2632 | void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev) |
7bdc9650 | 2633 | { |
7bdc9650 BA |
2634 | list_add_tail(&subdev->node, &rproc->subdevs); |
2635 | } | |
2636 | EXPORT_SYMBOL(rproc_add_subdev); | |
2637 | ||
2638 | /** | |
2639 | * rproc_remove_subdev() - remove a subdevice from a remoteproc | |
2640 | * @rproc: rproc handle to remove the subdevice from | |
2641 | * @subdev: subdev handle, previously registered with rproc_add_subdev() | |
2642 | */ | |
2643 | void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev) | |
2644 | { | |
2645 | list_del(&subdev->node); | |
2646 | } | |
2647 | EXPORT_SYMBOL(rproc_remove_subdev); | |
2648 | ||
7c89717f BA |
2649 | /** |
2650 | * rproc_get_by_child() - acquire rproc handle of @dev's ancestor | |
2651 | * @dev: child device to find ancestor of | |
2652 | * | |
f2867434 | 2653 | * Return: the ancestor rproc instance, or NULL if not found |
7c89717f BA |
2654 | */ |
2655 | struct rproc *rproc_get_by_child(struct device *dev) | |
2656 | { | |
2657 | for (dev = dev->parent; dev; dev = dev->parent) { | |
2658 | if (dev->type == &rproc_type) | |
2659 | return dev->driver_data; | |
2660 | } | |
2661 | ||
2662 | return NULL; | |
2663 | } | |
2664 | EXPORT_SYMBOL(rproc_get_by_child); | |
2665 | ||
8afd519c FGL |
2666 | /** |
2667 | * rproc_report_crash() - rproc crash reporter function | |
2668 | * @rproc: remote processor | |
2669 | * @type: crash type | |
2670 | * | |
2671 | * This function must be called every time a crash is detected by the low-level | |
2672 | * drivers implementing a specific remoteproc. This should not be called from a | |
2673 | * non-remoteproc driver. | |
2674 | * | |
2675 | * This function can be called from atomic/interrupt context. | |
2676 | */ | |
2677 | void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type) | |
2678 | { | |
2679 | if (!rproc) { | |
2680 | pr_err("NULL rproc pointer\n"); | |
2681 | return; | |
2682 | } | |
2683 | ||
a781e5aa RB |
2684 | /* Prevent suspend while the remoteproc is being recovered */ |
2685 | pm_stay_awake(rproc->dev.parent); | |
2686 | ||
8afd519c FGL |
2687 | dev_err(&rproc->dev, "crash detected in %s: type %s\n", |
2688 | rproc->name, rproc_crash_to_string(type)); | |
2689 | ||
cab8300b | 2690 | queue_work(rproc_recovery_wq, &rproc->crash_handler); |
8afd519c FGL |
2691 | } |
2692 | EXPORT_SYMBOL(rproc_report_crash); | |
2693 | ||
dc5192c4 BA |
2694 | static int rproc_panic_handler(struct notifier_block *nb, unsigned long event, |
2695 | void *ptr) | |
2696 | { | |
2697 | unsigned int longest = 0; | |
2698 | struct rproc *rproc; | |
2699 | unsigned int d; | |
2700 | ||
2701 | rcu_read_lock(); | |
2702 | list_for_each_entry_rcu(rproc, &rproc_list, node) { | |
800dad00 MP |
2703 | if (!rproc->ops->panic) |
2704 | continue; | |
2705 | ||
2706 | if (rproc->state != RPROC_RUNNING && | |
2707 | rproc->state != RPROC_ATTACHED) | |
dc5192c4 BA |
2708 | continue; |
2709 | ||
2710 | d = rproc->ops->panic(rproc); | |
2711 | longest = max(longest, d); | |
2712 | } | |
2713 | rcu_read_unlock(); | |
2714 | ||
2715 | /* | |
2716 | * Delay for the longest requested duration before returning. This can | |
2717 | * be used by the remoteproc drivers to give the remote processor time | |
2718 | * to perform any requested operations (such as flush caches), when | |
2719 | * it's not possible to signal the Linux side due to the panic. | |
2720 | */ | |
2721 | mdelay(longest); | |
2722 | ||
2723 | return NOTIFY_DONE; | |
2724 | } | |
2725 | ||
2726 | static void __init rproc_init_panic(void) | |
2727 | { | |
2728 | rproc_panic_nb.notifier_call = rproc_panic_handler; | |
2729 | atomic_notifier_chain_register(&panic_notifier_list, &rproc_panic_nb); | |
2730 | } | |
2731 | ||
2732 | static void __exit rproc_exit_panic(void) | |
2733 | { | |
2734 | atomic_notifier_chain_unregister(&panic_notifier_list, &rproc_panic_nb); | |
2735 | } | |
2736 | ||
400e64df OBC |
2737 | static int __init remoteproc_init(void) |
2738 | { | |
cab8300b MO |
2739 | rproc_recovery_wq = alloc_workqueue("rproc_recovery_wq", |
2740 | WQ_UNBOUND | WQ_FREEZABLE, 0); | |
2741 | if (!rproc_recovery_wq) { | |
2742 | pr_err("remoteproc: creation of rproc_recovery_wq failed\n"); | |
2743 | return -ENOMEM; | |
2744 | } | |
2745 | ||
2aefbef0 | 2746 | rproc_init_sysfs(); |
400e64df | 2747 | rproc_init_debugfs(); |
62b8f9e9 | 2748 | rproc_init_cdev(); |
dc5192c4 | 2749 | rproc_init_panic(); |
b5ab5e24 | 2750 | |
400e64df OBC |
2751 | return 0; |
2752 | } | |
a8f40111 | 2753 | subsys_initcall(remoteproc_init); |
400e64df OBC |
2754 | |
2755 | static void __exit remoteproc_exit(void) | |
2756 | { | |
f42f79af SA |
2757 | ida_destroy(&rproc_dev_index); |
2758 | ||
cab8300b MO |
2759 | if (!rproc_recovery_wq) |
2760 | return; | |
2761 | ||
dc5192c4 | 2762 | rproc_exit_panic(); |
400e64df | 2763 | rproc_exit_debugfs(); |
2aefbef0 | 2764 | rproc_exit_sysfs(); |
cab8300b | 2765 | destroy_workqueue(rproc_recovery_wq); |
400e64df OBC |
2766 | } |
2767 | module_exit(remoteproc_exit); | |
2768 | ||
400e64df | 2769 | MODULE_DESCRIPTION("Generic Remote Processor Framework"); |