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