11802d0beSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 2400e64dfSOhad Ben-Cohen /* 3400e64dfSOhad Ben-Cohen * Remote Processor Framework 4400e64dfSOhad Ben-Cohen * 5400e64dfSOhad Ben-Cohen * Copyright (C) 2011 Texas Instruments, Inc. 6400e64dfSOhad Ben-Cohen * Copyright (C) 2011 Google, Inc. 7400e64dfSOhad Ben-Cohen * 8400e64dfSOhad Ben-Cohen * Ohad Ben-Cohen <ohad@wizery.com> 9400e64dfSOhad Ben-Cohen * Brian Swetland <swetland@google.com> 10400e64dfSOhad Ben-Cohen * Mark Grosen <mgrosen@ti.com> 11400e64dfSOhad Ben-Cohen * Fernando Guzman Lugo <fernando.lugo@ti.com> 12400e64dfSOhad Ben-Cohen * Suman Anna <s-anna@ti.com> 13400e64dfSOhad Ben-Cohen * Robert Tivy <rtivy@ti.com> 14400e64dfSOhad Ben-Cohen * Armando Uribe De Leon <x0095078@ti.com> 15400e64dfSOhad Ben-Cohen */ 16400e64dfSOhad Ben-Cohen 17400e64dfSOhad Ben-Cohen #define pr_fmt(fmt) "%s: " fmt, __func__ 18400e64dfSOhad Ben-Cohen 19400e64dfSOhad Ben-Cohen #include <linux/kernel.h> 20400e64dfSOhad Ben-Cohen #include <linux/module.h> 21400e64dfSOhad Ben-Cohen #include <linux/device.h> 22400e64dfSOhad Ben-Cohen #include <linux/slab.h> 23400e64dfSOhad Ben-Cohen #include <linux/mutex.h> 24400e64dfSOhad Ben-Cohen #include <linux/dma-mapping.h> 25400e64dfSOhad Ben-Cohen #include <linux/firmware.h> 26400e64dfSOhad Ben-Cohen #include <linux/string.h> 27400e64dfSOhad Ben-Cohen #include <linux/debugfs.h> 282666ca91SSarangdhar Joshi #include <linux/devcoredump.h> 29400e64dfSOhad Ben-Cohen #include <linux/remoteproc.h> 30400e64dfSOhad Ben-Cohen #include <linux/iommu.h> 31b5ab5e24SOhad Ben-Cohen #include <linux/idr.h> 32400e64dfSOhad Ben-Cohen #include <linux/elf.h> 33a2b950acSOhad Ben-Cohen #include <linux/crc32.h> 34086d0872SLoic Pallardy #include <linux/of_reserved_mem.h> 35400e64dfSOhad Ben-Cohen #include <linux/virtio_ids.h> 36400e64dfSOhad Ben-Cohen #include <linux/virtio_ring.h> 37cf59d3e9SOhad Ben-Cohen #include <asm/byteorder.h> 38086d0872SLoic Pallardy #include <linux/platform_device.h> 39400e64dfSOhad Ben-Cohen 40400e64dfSOhad Ben-Cohen #include "remoteproc_internal.h" 41400e64dfSOhad Ben-Cohen 42b36de8cfSLoic Pallardy #define HIGH_BITS_MASK 0xFFFFFFFF00000000ULL 43b36de8cfSLoic Pallardy 44fec47d86SDave Gerlach static DEFINE_MUTEX(rproc_list_mutex); 45fec47d86SDave Gerlach static LIST_HEAD(rproc_list); 46fec47d86SDave Gerlach 47400e64dfSOhad Ben-Cohen typedef int (*rproc_handle_resources_t)(struct rproc *rproc, 48fd2c15ecSOhad Ben-Cohen struct resource_table *table, int len); 49a2b950acSOhad Ben-Cohen typedef int (*rproc_handle_resource_t)(struct rproc *rproc, 50a2b950acSOhad Ben-Cohen void *, int offset, int avail); 51400e64dfSOhad Ben-Cohen 52c6aed238SLoic Pallardy static int rproc_alloc_carveout(struct rproc *rproc, 53c6aed238SLoic Pallardy struct rproc_mem_entry *mem); 54c6aed238SLoic Pallardy static int rproc_release_carveout(struct rproc *rproc, 55c6aed238SLoic Pallardy struct rproc_mem_entry *mem); 56c6aed238SLoic Pallardy 57b5ab5e24SOhad Ben-Cohen /* Unique indices for remoteproc devices */ 58b5ab5e24SOhad Ben-Cohen static DEFINE_IDA(rproc_dev_index); 59b5ab5e24SOhad Ben-Cohen 608afd519cSFernando Guzman Lugo static const char * const rproc_crash_names[] = { 618afd519cSFernando Guzman Lugo [RPROC_MMUFAULT] = "mmufault", 62b3d39032SBjorn Andersson [RPROC_WATCHDOG] = "watchdog", 63b3d39032SBjorn Andersson [RPROC_FATAL_ERROR] = "fatal error", 648afd519cSFernando Guzman Lugo }; 658afd519cSFernando Guzman Lugo 668afd519cSFernando Guzman Lugo /* translate rproc_crash_type to string */ 678afd519cSFernando Guzman Lugo static const char *rproc_crash_to_string(enum rproc_crash_type type) 688afd519cSFernando Guzman Lugo { 698afd519cSFernando Guzman Lugo if (type < ARRAY_SIZE(rproc_crash_names)) 708afd519cSFernando Guzman Lugo return rproc_crash_names[type]; 71b23f7a09SMasanari Iida return "unknown"; 728afd519cSFernando Guzman Lugo } 738afd519cSFernando Guzman Lugo 74400e64dfSOhad Ben-Cohen /* 75400e64dfSOhad Ben-Cohen * This is the IOMMU fault handler we register with the IOMMU API 76400e64dfSOhad Ben-Cohen * (when relevant; not all remote processors access memory through 77400e64dfSOhad Ben-Cohen * an IOMMU). 78400e64dfSOhad Ben-Cohen * 79400e64dfSOhad Ben-Cohen * IOMMU core will invoke this handler whenever the remote processor 80400e64dfSOhad Ben-Cohen * will try to access an unmapped device address. 81400e64dfSOhad Ben-Cohen */ 82400e64dfSOhad Ben-Cohen static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev, 8377ca2332SOhad Ben-Cohen unsigned long iova, int flags, void *token) 84400e64dfSOhad Ben-Cohen { 858afd519cSFernando Guzman Lugo struct rproc *rproc = token; 868afd519cSFernando Guzman Lugo 87400e64dfSOhad Ben-Cohen dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags); 88400e64dfSOhad Ben-Cohen 898afd519cSFernando Guzman Lugo rproc_report_crash(rproc, RPROC_MMUFAULT); 908afd519cSFernando Guzman Lugo 91400e64dfSOhad Ben-Cohen /* 92400e64dfSOhad Ben-Cohen * Let the iommu core know we're not really handling this fault; 938afd519cSFernando Guzman Lugo * we just used it as a recovery trigger. 94400e64dfSOhad Ben-Cohen */ 95400e64dfSOhad Ben-Cohen return -ENOSYS; 96400e64dfSOhad Ben-Cohen } 97400e64dfSOhad Ben-Cohen 98400e64dfSOhad Ben-Cohen static int rproc_enable_iommu(struct rproc *rproc) 99400e64dfSOhad Ben-Cohen { 100400e64dfSOhad Ben-Cohen struct iommu_domain *domain; 101b5ab5e24SOhad Ben-Cohen struct device *dev = rproc->dev.parent; 102400e64dfSOhad Ben-Cohen int ret; 103400e64dfSOhad Ben-Cohen 104315491e5SSuman Anna if (!rproc->has_iommu) { 105315491e5SSuman Anna dev_dbg(dev, "iommu not present\n"); 1060798e1daSMark Grosen return 0; 107400e64dfSOhad Ben-Cohen } 108400e64dfSOhad Ben-Cohen 109400e64dfSOhad Ben-Cohen domain = iommu_domain_alloc(dev->bus); 110400e64dfSOhad Ben-Cohen if (!domain) { 111400e64dfSOhad Ben-Cohen dev_err(dev, "can't alloc iommu domain\n"); 112400e64dfSOhad Ben-Cohen return -ENOMEM; 113400e64dfSOhad Ben-Cohen } 114400e64dfSOhad Ben-Cohen 11577ca2332SOhad Ben-Cohen iommu_set_fault_handler(domain, rproc_iommu_fault, rproc); 116400e64dfSOhad Ben-Cohen 117400e64dfSOhad Ben-Cohen ret = iommu_attach_device(domain, dev); 118400e64dfSOhad Ben-Cohen if (ret) { 119400e64dfSOhad Ben-Cohen dev_err(dev, "can't attach iommu device: %d\n", ret); 120400e64dfSOhad Ben-Cohen goto free_domain; 121400e64dfSOhad Ben-Cohen } 122400e64dfSOhad Ben-Cohen 123400e64dfSOhad Ben-Cohen rproc->domain = domain; 124400e64dfSOhad Ben-Cohen 125400e64dfSOhad Ben-Cohen return 0; 126400e64dfSOhad Ben-Cohen 127400e64dfSOhad Ben-Cohen free_domain: 128400e64dfSOhad Ben-Cohen iommu_domain_free(domain); 129400e64dfSOhad Ben-Cohen return ret; 130400e64dfSOhad Ben-Cohen } 131400e64dfSOhad Ben-Cohen 132400e64dfSOhad Ben-Cohen static void rproc_disable_iommu(struct rproc *rproc) 133400e64dfSOhad Ben-Cohen { 134400e64dfSOhad Ben-Cohen struct iommu_domain *domain = rproc->domain; 135b5ab5e24SOhad Ben-Cohen struct device *dev = rproc->dev.parent; 136400e64dfSOhad Ben-Cohen 137400e64dfSOhad Ben-Cohen if (!domain) 138400e64dfSOhad Ben-Cohen return; 139400e64dfSOhad Ben-Cohen 140400e64dfSOhad Ben-Cohen iommu_detach_device(domain, dev); 141400e64dfSOhad Ben-Cohen iommu_domain_free(domain); 142400e64dfSOhad Ben-Cohen } 143400e64dfSOhad Ben-Cohen 144086d0872SLoic Pallardy phys_addr_t rproc_va_to_pa(void *cpu_addr) 145eb30596eSLoic Pallardy { 146eb30596eSLoic Pallardy /* 147eb30596eSLoic Pallardy * Return physical address according to virtual address location 148eb30596eSLoic Pallardy * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent 149eb30596eSLoic Pallardy * - in kernel: if region allocated in generic dma memory pool 150eb30596eSLoic Pallardy */ 151eb30596eSLoic Pallardy if (is_vmalloc_addr(cpu_addr)) { 152eb30596eSLoic Pallardy return page_to_phys(vmalloc_to_page(cpu_addr)) + 153eb30596eSLoic Pallardy offset_in_page(cpu_addr); 154eb30596eSLoic Pallardy } 155eb30596eSLoic Pallardy 156eb30596eSLoic Pallardy WARN_ON(!virt_addr_valid(cpu_addr)); 157eb30596eSLoic Pallardy return virt_to_phys(cpu_addr); 158eb30596eSLoic Pallardy } 159086d0872SLoic Pallardy EXPORT_SYMBOL(rproc_va_to_pa); 160eb30596eSLoic Pallardy 161a01f7cd6SSuman Anna /** 162a01f7cd6SSuman Anna * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address 163a01f7cd6SSuman Anna * @rproc: handle of a remote processor 164a01f7cd6SSuman Anna * @da: remoteproc device address to translate 165a01f7cd6SSuman Anna * @len: length of the memory region @da is pointing to 166a01f7cd6SSuman Anna * 167400e64dfSOhad Ben-Cohen * Some remote processors will ask us to allocate them physically contiguous 168400e64dfSOhad Ben-Cohen * memory regions (which we call "carveouts"), and map them to specific 169a01f7cd6SSuman Anna * device addresses (which are hardcoded in the firmware). They may also have 170a01f7cd6SSuman Anna * dedicated memory regions internal to the processors, and use them either 171a01f7cd6SSuman Anna * exclusively or alongside carveouts. 172400e64dfSOhad Ben-Cohen * 173400e64dfSOhad Ben-Cohen * They may then ask us to copy objects into specific device addresses (e.g. 174400e64dfSOhad Ben-Cohen * code/data sections) or expose us certain symbols in other device address 175400e64dfSOhad Ben-Cohen * (e.g. their trace buffer). 176400e64dfSOhad Ben-Cohen * 177a01f7cd6SSuman Anna * This function is a helper function with which we can go over the allocated 178a01f7cd6SSuman Anna * carveouts and translate specific device addresses to kernel virtual addresses 179a01f7cd6SSuman Anna * so we can access the referenced memory. This function also allows to perform 180a01f7cd6SSuman Anna * translations on the internal remoteproc memory regions through a platform 181a01f7cd6SSuman Anna * implementation specific da_to_va ops, if present. 182a01f7cd6SSuman Anna * 183a01f7cd6SSuman Anna * The function returns a valid kernel address on success or NULL on failure. 184400e64dfSOhad Ben-Cohen * 185400e64dfSOhad Ben-Cohen * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too, 186400e64dfSOhad Ben-Cohen * but only on kernel direct mapped RAM memory. Instead, we're just using 187a01f7cd6SSuman Anna * here the output of the DMA API for the carveouts, which should be more 188a01f7cd6SSuman Anna * correct. 189400e64dfSOhad Ben-Cohen */ 19072854fb0SSjur Brændeland void *rproc_da_to_va(struct rproc *rproc, u64 da, int len) 191400e64dfSOhad Ben-Cohen { 192400e64dfSOhad Ben-Cohen struct rproc_mem_entry *carveout; 193400e64dfSOhad Ben-Cohen void *ptr = NULL; 194400e64dfSOhad Ben-Cohen 195a01f7cd6SSuman Anna if (rproc->ops->da_to_va) { 196a01f7cd6SSuman Anna ptr = rproc->ops->da_to_va(rproc, da, len); 197a01f7cd6SSuman Anna if (ptr) 198a01f7cd6SSuman Anna goto out; 199a01f7cd6SSuman Anna } 200a01f7cd6SSuman Anna 201400e64dfSOhad Ben-Cohen list_for_each_entry(carveout, &rproc->carveouts, node) { 202400e64dfSOhad Ben-Cohen int offset = da - carveout->da; 203400e64dfSOhad Ben-Cohen 20474457c40SLoic Pallardy /* Verify that carveout is allocated */ 20574457c40SLoic Pallardy if (!carveout->va) 20674457c40SLoic Pallardy continue; 20774457c40SLoic Pallardy 208400e64dfSOhad Ben-Cohen /* try next carveout if da is too small */ 209400e64dfSOhad Ben-Cohen if (offset < 0) 210400e64dfSOhad Ben-Cohen continue; 211400e64dfSOhad Ben-Cohen 212400e64dfSOhad Ben-Cohen /* try next carveout if da is too large */ 213400e64dfSOhad Ben-Cohen if (offset + len > carveout->len) 214400e64dfSOhad Ben-Cohen continue; 215400e64dfSOhad Ben-Cohen 216400e64dfSOhad Ben-Cohen ptr = carveout->va + offset; 217400e64dfSOhad Ben-Cohen 218400e64dfSOhad Ben-Cohen break; 219400e64dfSOhad Ben-Cohen } 220400e64dfSOhad Ben-Cohen 221a01f7cd6SSuman Anna out: 222400e64dfSOhad Ben-Cohen return ptr; 223400e64dfSOhad Ben-Cohen } 2244afc89d6SSjur Brændeland EXPORT_SYMBOL(rproc_da_to_va); 225400e64dfSOhad Ben-Cohen 226b0019ccdSLoic Pallardy /** 227b0019ccdSLoic Pallardy * rproc_find_carveout_by_name() - lookup the carveout region by a name 228b0019ccdSLoic Pallardy * @rproc: handle of a remote processor 229b0019ccdSLoic Pallardy * @name,..: carveout name to find (standard printf format) 230b0019ccdSLoic Pallardy * 231b0019ccdSLoic Pallardy * Platform driver has the capability to register some pre-allacoted carveout 232b0019ccdSLoic Pallardy * (physically contiguous memory regions) before rproc firmware loading and 233b0019ccdSLoic Pallardy * associated resource table analysis. These regions may be dedicated memory 234b0019ccdSLoic Pallardy * regions internal to the coprocessor or specified DDR region with specific 235b0019ccdSLoic Pallardy * attributes 236b0019ccdSLoic Pallardy * 237b0019ccdSLoic Pallardy * This function is a helper function with which we can go over the 238b0019ccdSLoic Pallardy * allocated carveouts and return associated region characteristics like 239b0019ccdSLoic Pallardy * coprocessor address, length or processor virtual address. 240b0019ccdSLoic Pallardy * 241b0019ccdSLoic Pallardy * Return: a valid pointer on carveout entry on success or NULL on failure. 242b0019ccdSLoic Pallardy */ 243b0019ccdSLoic Pallardy struct rproc_mem_entry * 244b0019ccdSLoic Pallardy rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...) 245b0019ccdSLoic Pallardy { 246b0019ccdSLoic Pallardy va_list args; 247b0019ccdSLoic Pallardy char _name[32]; 248b0019ccdSLoic Pallardy struct rproc_mem_entry *carveout, *mem = NULL; 249b0019ccdSLoic Pallardy 250b0019ccdSLoic Pallardy if (!name) 251b0019ccdSLoic Pallardy return NULL; 252b0019ccdSLoic Pallardy 253b0019ccdSLoic Pallardy va_start(args, name); 254b0019ccdSLoic Pallardy vsnprintf(_name, sizeof(_name), name, args); 255b0019ccdSLoic Pallardy va_end(args); 256b0019ccdSLoic Pallardy 257b0019ccdSLoic Pallardy list_for_each_entry(carveout, &rproc->carveouts, node) { 258b0019ccdSLoic Pallardy /* Compare carveout and requested names */ 259b0019ccdSLoic Pallardy if (!strcmp(carveout->name, _name)) { 260b0019ccdSLoic Pallardy mem = carveout; 261b0019ccdSLoic Pallardy break; 262b0019ccdSLoic Pallardy } 263b0019ccdSLoic Pallardy } 264b0019ccdSLoic Pallardy 265b0019ccdSLoic Pallardy return mem; 266b0019ccdSLoic Pallardy } 267b0019ccdSLoic Pallardy 268c874bf59SLoic Pallardy /** 269c874bf59SLoic Pallardy * rproc_check_carveout_da() - Check specified carveout da configuration 270c874bf59SLoic Pallardy * @rproc: handle of a remote processor 271c874bf59SLoic Pallardy * @mem: pointer on carveout to check 272c874bf59SLoic Pallardy * @da: area device address 273c874bf59SLoic Pallardy * @len: associated area size 274c874bf59SLoic Pallardy * 275c874bf59SLoic Pallardy * This function is a helper function to verify requested device area (couple 27628d7d5c6SLoic Pallardy * da, len) is part of specified carveout. 27728d7d5c6SLoic Pallardy * If da is not set (defined as FW_RSC_ADDR_ANY), only requested length is 27828d7d5c6SLoic Pallardy * checked. 279c874bf59SLoic Pallardy * 28028d7d5c6SLoic Pallardy * Return: 0 if carveout matches request else error 281c874bf59SLoic Pallardy */ 28228d7d5c6SLoic Pallardy static int rproc_check_carveout_da(struct rproc *rproc, 28328d7d5c6SLoic Pallardy struct rproc_mem_entry *mem, u32 da, u32 len) 284c874bf59SLoic Pallardy { 285c874bf59SLoic Pallardy struct device *dev = &rproc->dev; 28628d7d5c6SLoic Pallardy int delta; 287c874bf59SLoic Pallardy 288c874bf59SLoic Pallardy /* Check requested resource length */ 289c874bf59SLoic Pallardy if (len > mem->len) { 290c874bf59SLoic Pallardy dev_err(dev, "Registered carveout doesn't fit len request\n"); 29128d7d5c6SLoic Pallardy return -EINVAL; 292c874bf59SLoic Pallardy } 293c874bf59SLoic Pallardy 294c874bf59SLoic Pallardy if (da != FW_RSC_ADDR_ANY && mem->da == FW_RSC_ADDR_ANY) { 29528d7d5c6SLoic Pallardy /* Address doesn't match registered carveout configuration */ 29628d7d5c6SLoic Pallardy return -EINVAL; 297c874bf59SLoic Pallardy } else if (da != FW_RSC_ADDR_ANY && mem->da != FW_RSC_ADDR_ANY) { 298c874bf59SLoic Pallardy delta = da - mem->da; 299c874bf59SLoic Pallardy 300c874bf59SLoic Pallardy /* Check requested resource belongs to registered carveout */ 301c874bf59SLoic Pallardy if (delta < 0) { 302c874bf59SLoic Pallardy dev_err(dev, 303c874bf59SLoic Pallardy "Registered carveout doesn't fit da request\n"); 30428d7d5c6SLoic Pallardy return -EINVAL; 305c874bf59SLoic Pallardy } 306c874bf59SLoic Pallardy 307c874bf59SLoic Pallardy if (delta + len > mem->len) { 308c874bf59SLoic Pallardy dev_err(dev, 309c874bf59SLoic Pallardy "Registered carveout doesn't fit len request\n"); 31028d7d5c6SLoic Pallardy return -EINVAL; 311c874bf59SLoic Pallardy } 312c874bf59SLoic Pallardy } 313c874bf59SLoic Pallardy 314c874bf59SLoic Pallardy return 0; 315c874bf59SLoic Pallardy } 316c874bf59SLoic Pallardy 3176db20ea8SOhad Ben-Cohen int rproc_alloc_vring(struct rproc_vdev *rvdev, int i) 318400e64dfSOhad Ben-Cohen { 3197a186941SOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 320b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 3216db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 322c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 3237a186941SOhad Ben-Cohen int ret, size, notifyid; 324c6aed238SLoic Pallardy struct rproc_mem_entry *mem; 325400e64dfSOhad Ben-Cohen 3266db20ea8SOhad Ben-Cohen /* actual size of vring (in bytes) */ 3276db20ea8SOhad Ben-Cohen size = PAGE_ALIGN(vring_size(rvring->len, rvring->align)); 3286db20ea8SOhad Ben-Cohen 329c6aed238SLoic Pallardy rsc = (void *)rproc->table_ptr + rvdev->rsc_offset; 330c6aed238SLoic Pallardy 331c6aed238SLoic Pallardy /* Search for pre-registered carveout */ 332c6aed238SLoic Pallardy mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index, 333c6aed238SLoic Pallardy i); 334c6aed238SLoic Pallardy if (mem) { 335c6aed238SLoic Pallardy if (rproc_check_carveout_da(rproc, mem, rsc->vring[i].da, size)) 336c6aed238SLoic Pallardy return -ENOMEM; 337c6aed238SLoic Pallardy } else { 338c6aed238SLoic Pallardy /* Register carveout in in list */ 339c6aed238SLoic Pallardy mem = rproc_mem_entry_init(dev, 0, 0, size, rsc->vring[i].da, 340c6aed238SLoic Pallardy rproc_alloc_carveout, 341c6aed238SLoic Pallardy rproc_release_carveout, 342c6aed238SLoic Pallardy "vdev%dvring%d", 343c6aed238SLoic Pallardy rvdev->index, i); 344c6aed238SLoic Pallardy if (!mem) { 345c6aed238SLoic Pallardy dev_err(dev, "Can't allocate memory entry structure\n"); 346c6aed238SLoic Pallardy return -ENOMEM; 347c6aed238SLoic Pallardy } 348c6aed238SLoic Pallardy 349c6aed238SLoic Pallardy rproc_add_carveout(rproc, mem); 3506db20ea8SOhad Ben-Cohen } 3516db20ea8SOhad Ben-Cohen 3526db20ea8SOhad Ben-Cohen /* 3536db20ea8SOhad Ben-Cohen * Assign an rproc-wide unique index for this vring 3546db20ea8SOhad Ben-Cohen * TODO: assign a notifyid for rvdev updates as well 3556db20ea8SOhad Ben-Cohen * TODO: support predefined notifyids (via resource table) 3566db20ea8SOhad Ben-Cohen */ 35715fc6110STejun Heo ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL); 358b39599b7SSuman Anna if (ret < 0) { 35915fc6110STejun Heo dev_err(dev, "idr_alloc failed: %d\n", ret); 3606db20ea8SOhad Ben-Cohen return ret; 3616db20ea8SOhad Ben-Cohen } 36215fc6110STejun Heo notifyid = ret; 3636db20ea8SOhad Ben-Cohen 36448f18f89SBjorn Andersson /* Potentially bump max_notifyid */ 36548f18f89SBjorn Andersson if (notifyid > rproc->max_notifyid) 36648f18f89SBjorn Andersson rproc->max_notifyid = notifyid; 36748f18f89SBjorn Andersson 3686db20ea8SOhad Ben-Cohen rvring->notifyid = notifyid; 3696db20ea8SOhad Ben-Cohen 370c6aed238SLoic Pallardy /* Let the rproc know the notifyid of this vring.*/ 371c0d63157SSjur Brændeland rsc->vring[i].notifyid = notifyid; 3726db20ea8SOhad Ben-Cohen return 0; 3736db20ea8SOhad Ben-Cohen } 3746db20ea8SOhad Ben-Cohen 375400e64dfSOhad Ben-Cohen static int 3766db20ea8SOhad Ben-Cohen rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i) 377400e64dfSOhad Ben-Cohen { 378400e64dfSOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 379b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 380400e64dfSOhad Ben-Cohen struct fw_rsc_vdev_vring *vring = &rsc->vring[i]; 3816db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 382400e64dfSOhad Ben-Cohen 3839d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n", 3847a186941SOhad Ben-Cohen i, vring->da, vring->num, vring->align); 3857a186941SOhad Ben-Cohen 38663140e0eSOhad Ben-Cohen /* verify queue size and vring alignment are sane */ 38763140e0eSOhad Ben-Cohen if (!vring->num || !vring->align) { 38863140e0eSOhad Ben-Cohen dev_err(dev, "invalid qsz (%d) or alignment (%d)\n", 38963140e0eSOhad Ben-Cohen vring->num, vring->align); 390400e64dfSOhad Ben-Cohen return -EINVAL; 391400e64dfSOhad Ben-Cohen } 392400e64dfSOhad Ben-Cohen 3936db20ea8SOhad Ben-Cohen rvring->len = vring->num; 3946db20ea8SOhad Ben-Cohen rvring->align = vring->align; 3956db20ea8SOhad Ben-Cohen rvring->rvdev = rvdev; 396400e64dfSOhad Ben-Cohen 397400e64dfSOhad Ben-Cohen return 0; 398400e64dfSOhad Ben-Cohen } 399400e64dfSOhad Ben-Cohen 4006db20ea8SOhad Ben-Cohen void rproc_free_vring(struct rproc_vring *rvring) 4017a186941SOhad Ben-Cohen { 4026db20ea8SOhad Ben-Cohen struct rproc *rproc = rvring->rvdev->rproc; 403c0d63157SSjur Brændeland int idx = rvring->rvdev->vring - rvring; 404c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 4057a186941SOhad Ben-Cohen 4067a186941SOhad Ben-Cohen idr_remove(&rproc->notifyids, rvring->notifyid); 407099a3f33SSjur Brændeland 408c0d63157SSjur Brændeland /* reset resource entry info */ 409c0d63157SSjur Brændeland rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset; 410c0d63157SSjur Brændeland rsc->vring[idx].da = 0; 411c0d63157SSjur Brændeland rsc->vring[idx].notifyid = -1; 4127a186941SOhad Ben-Cohen } 4137a186941SOhad Ben-Cohen 4146f8b0373SAlex Elder static int rproc_vdev_do_start(struct rproc_subdev *subdev) 415f5bcb353SBjorn Andersson { 416f5bcb353SBjorn Andersson struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev); 417f5bcb353SBjorn Andersson 418f5bcb353SBjorn Andersson return rproc_add_virtio_dev(rvdev, rvdev->id); 419f5bcb353SBjorn Andersson } 420f5bcb353SBjorn Andersson 4216f8b0373SAlex Elder static void rproc_vdev_do_stop(struct rproc_subdev *subdev, bool crashed) 422f5bcb353SBjorn Andersson { 423f5bcb353SBjorn Andersson struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev); 424d4c036feSLoic Pallardy int ret; 425f5bcb353SBjorn Andersson 426d4c036feSLoic Pallardy ret = device_for_each_child(&rvdev->dev, NULL, rproc_remove_virtio_dev); 427d4c036feSLoic Pallardy if (ret) 428d4c036feSLoic Pallardy dev_warn(&rvdev->dev, "can't remove vdev child device: %d\n", ret); 429f5bcb353SBjorn Andersson } 430f5bcb353SBjorn Andersson 431400e64dfSOhad Ben-Cohen /** 432086d0872SLoic Pallardy * rproc_rvdev_release() - release the existence of a rvdev 433086d0872SLoic Pallardy * 434086d0872SLoic Pallardy * @dev: the subdevice's dev 435086d0872SLoic Pallardy */ 436086d0872SLoic Pallardy static void rproc_rvdev_release(struct device *dev) 437086d0872SLoic Pallardy { 438086d0872SLoic Pallardy struct rproc_vdev *rvdev = container_of(dev, struct rproc_vdev, dev); 439086d0872SLoic Pallardy 440086d0872SLoic Pallardy of_reserved_mem_device_release(dev); 441086d0872SLoic Pallardy 442086d0872SLoic Pallardy kfree(rvdev); 443086d0872SLoic Pallardy } 444086d0872SLoic Pallardy 445086d0872SLoic Pallardy /** 446fd2c15ecSOhad Ben-Cohen * rproc_handle_vdev() - handle a vdev fw resource 447400e64dfSOhad Ben-Cohen * @rproc: the remote processor 448400e64dfSOhad Ben-Cohen * @rsc: the vring resource descriptor 449fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 450400e64dfSOhad Ben-Cohen * 4517a186941SOhad Ben-Cohen * This resource entry requests the host to statically register a virtio 4527a186941SOhad Ben-Cohen * device (vdev), and setup everything needed to support it. It contains 4537a186941SOhad Ben-Cohen * everything needed to make it possible: the virtio device id, virtio 4547a186941SOhad Ben-Cohen * device features, vrings information, virtio config space, etc... 455400e64dfSOhad Ben-Cohen * 4567a186941SOhad Ben-Cohen * Before registering the vdev, the vrings are allocated from non-cacheable 4577a186941SOhad Ben-Cohen * physically contiguous memory. Currently we only support two vrings per 4587a186941SOhad Ben-Cohen * remote processor (temporary limitation). We might also want to consider 4597a186941SOhad Ben-Cohen * doing the vring allocation only later when ->find_vqs() is invoked, and 4607a186941SOhad Ben-Cohen * then release them upon ->del_vqs(). 461400e64dfSOhad Ben-Cohen * 4627a186941SOhad Ben-Cohen * Note: @da is currently not really handled correctly: we dynamically 4637a186941SOhad Ben-Cohen * allocate it using the DMA API, ignoring requested hard coded addresses, 4647a186941SOhad Ben-Cohen * and we don't take care of any required IOMMU programming. This is all 4657a186941SOhad Ben-Cohen * going to be taken care of when the generic iommu-based DMA API will be 4667a186941SOhad Ben-Cohen * merged. Meanwhile, statically-addressed iommu-based firmware images should 4677a186941SOhad Ben-Cohen * use RSC_DEVMEM resource entries to map their required @da to the physical 4687a186941SOhad Ben-Cohen * address of their base CMA region (ouch, hacky!). 469400e64dfSOhad Ben-Cohen * 470400e64dfSOhad Ben-Cohen * Returns 0 on success, or an appropriate error code otherwise 471400e64dfSOhad Ben-Cohen */ 472fd2c15ecSOhad Ben-Cohen static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc, 473a2b950acSOhad Ben-Cohen int offset, int avail) 474400e64dfSOhad Ben-Cohen { 475b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 4767a186941SOhad Ben-Cohen struct rproc_vdev *rvdev; 4777a186941SOhad Ben-Cohen int i, ret; 478086d0872SLoic Pallardy char name[16]; 479fd2c15ecSOhad Ben-Cohen 480fd2c15ecSOhad Ben-Cohen /* make sure resource isn't truncated */ 481fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring) 482fd2c15ecSOhad Ben-Cohen + rsc->config_len > avail) { 483b5ab5e24SOhad Ben-Cohen dev_err(dev, "vdev rsc is truncated\n"); 484fd2c15ecSOhad Ben-Cohen return -EINVAL; 485fd2c15ecSOhad Ben-Cohen } 486fd2c15ecSOhad Ben-Cohen 487fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 488fd2c15ecSOhad Ben-Cohen if (rsc->reserved[0] || rsc->reserved[1]) { 489fd2c15ecSOhad Ben-Cohen dev_err(dev, "vdev rsc has non zero reserved bytes\n"); 490fd2c15ecSOhad Ben-Cohen return -EINVAL; 491fd2c15ecSOhad Ben-Cohen } 492fd2c15ecSOhad Ben-Cohen 4939d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n", 494fd2c15ecSOhad Ben-Cohen rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings); 495400e64dfSOhad Ben-Cohen 4967a186941SOhad Ben-Cohen /* we currently support only two vrings per rvdev */ 4977a186941SOhad Ben-Cohen if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) { 498fd2c15ecSOhad Ben-Cohen dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings); 499400e64dfSOhad Ben-Cohen return -EINVAL; 500400e64dfSOhad Ben-Cohen } 501400e64dfSOhad Ben-Cohen 502899585adSAnna, Suman rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL); 5037a186941SOhad Ben-Cohen if (!rvdev) 5047a186941SOhad Ben-Cohen return -ENOMEM; 5057a186941SOhad Ben-Cohen 506aab8d802SBjorn Andersson kref_init(&rvdev->refcount); 507aab8d802SBjorn Andersson 508f5bcb353SBjorn Andersson rvdev->id = rsc->id; 5097a186941SOhad Ben-Cohen rvdev->rproc = rproc; 510c6aed238SLoic Pallardy rvdev->index = rproc->nb_vdev++; 5117a186941SOhad Ben-Cohen 512086d0872SLoic Pallardy /* Initialise vdev subdevice */ 513086d0872SLoic Pallardy snprintf(name, sizeof(name), "vdev%dbuffer", rvdev->index); 514086d0872SLoic Pallardy rvdev->dev.parent = rproc->dev.parent; 515086d0872SLoic Pallardy rvdev->dev.release = rproc_rvdev_release; 516086d0872SLoic Pallardy dev_set_name(&rvdev->dev, "%s#%s", dev_name(rvdev->dev.parent), name); 517086d0872SLoic Pallardy dev_set_drvdata(&rvdev->dev, rvdev); 518086d0872SLoic Pallardy 519086d0872SLoic Pallardy ret = device_register(&rvdev->dev); 520086d0872SLoic Pallardy if (ret) { 521086d0872SLoic Pallardy put_device(&rvdev->dev); 522086d0872SLoic Pallardy return ret; 523086d0872SLoic Pallardy } 524086d0872SLoic Pallardy /* Make device dma capable by inheriting from parent's capabilities */ 525086d0872SLoic Pallardy set_dma_ops(&rvdev->dev, get_dma_ops(rproc->dev.parent)); 526086d0872SLoic Pallardy 527086d0872SLoic Pallardy ret = dma_coerce_mask_and_coherent(&rvdev->dev, 528086d0872SLoic Pallardy dma_get_mask(rproc->dev.parent)); 529086d0872SLoic Pallardy if (ret) { 530086d0872SLoic Pallardy dev_warn(dev, 531086d0872SLoic Pallardy "Failed to set DMA mask %llx. Trying to continue... %x\n", 532086d0872SLoic Pallardy dma_get_mask(rproc->dev.parent), ret); 533086d0872SLoic Pallardy } 534086d0872SLoic Pallardy 5356db20ea8SOhad Ben-Cohen /* parse the vrings */ 536fd2c15ecSOhad Ben-Cohen for (i = 0; i < rsc->num_of_vrings; i++) { 5376db20ea8SOhad Ben-Cohen ret = rproc_parse_vring(rvdev, rsc, i); 5387a186941SOhad Ben-Cohen if (ret) 5396db20ea8SOhad Ben-Cohen goto free_rvdev; 540fd2c15ecSOhad Ben-Cohen } 541fd2c15ecSOhad Ben-Cohen 542a2b950acSOhad Ben-Cohen /* remember the resource offset*/ 543a2b950acSOhad Ben-Cohen rvdev->rsc_offset = offset; 544400e64dfSOhad Ben-Cohen 545a863af5dSBjorn Andersson /* allocate the vring resources */ 546a863af5dSBjorn Andersson for (i = 0; i < rsc->num_of_vrings; i++) { 547a863af5dSBjorn Andersson ret = rproc_alloc_vring(rvdev, i); 548a863af5dSBjorn Andersson if (ret) 549a863af5dSBjorn Andersson goto unwind_vring_allocations; 550a863af5dSBjorn Andersson } 551a863af5dSBjorn Andersson 5527a186941SOhad Ben-Cohen list_add_tail(&rvdev->node, &rproc->rvdevs); 553400e64dfSOhad Ben-Cohen 5546f8b0373SAlex Elder rvdev->subdev.start = rproc_vdev_do_start; 5556f8b0373SAlex Elder rvdev->subdev.stop = rproc_vdev_do_stop; 5564902676fSBjorn Andersson 5574902676fSBjorn Andersson rproc_add_subdev(rproc, &rvdev->subdev); 558400e64dfSOhad Ben-Cohen 559400e64dfSOhad Ben-Cohen return 0; 5607a186941SOhad Ben-Cohen 561a863af5dSBjorn Andersson unwind_vring_allocations: 562a863af5dSBjorn Andersson for (i--; i >= 0; i--) 563a863af5dSBjorn Andersson rproc_free_vring(&rvdev->vring[i]); 5646db20ea8SOhad Ben-Cohen free_rvdev: 565086d0872SLoic Pallardy device_unregister(&rvdev->dev); 5667a186941SOhad Ben-Cohen return ret; 567400e64dfSOhad Ben-Cohen } 568400e64dfSOhad Ben-Cohen 569aab8d802SBjorn Andersson void rproc_vdev_release(struct kref *ref) 570aab8d802SBjorn Andersson { 571aab8d802SBjorn Andersson struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount); 572a863af5dSBjorn Andersson struct rproc_vring *rvring; 573f5bcb353SBjorn Andersson struct rproc *rproc = rvdev->rproc; 574a863af5dSBjorn Andersson int id; 575a863af5dSBjorn Andersson 576a863af5dSBjorn Andersson for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) { 577a863af5dSBjorn Andersson rvring = &rvdev->vring[id]; 578a863af5dSBjorn Andersson rproc_free_vring(rvring); 579a863af5dSBjorn Andersson } 580aab8d802SBjorn Andersson 581f5bcb353SBjorn Andersson rproc_remove_subdev(rproc, &rvdev->subdev); 582aab8d802SBjorn Andersson list_del(&rvdev->node); 583086d0872SLoic Pallardy device_unregister(&rvdev->dev); 584aab8d802SBjorn Andersson } 585aab8d802SBjorn Andersson 586400e64dfSOhad Ben-Cohen /** 587400e64dfSOhad Ben-Cohen * rproc_handle_trace() - handle a shared trace buffer resource 588400e64dfSOhad Ben-Cohen * @rproc: the remote processor 589400e64dfSOhad Ben-Cohen * @rsc: the trace resource descriptor 590fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 591400e64dfSOhad Ben-Cohen * 592400e64dfSOhad Ben-Cohen * In case the remote processor dumps trace logs into memory, 593400e64dfSOhad Ben-Cohen * export it via debugfs. 594400e64dfSOhad Ben-Cohen * 595400e64dfSOhad Ben-Cohen * Currently, the 'da' member of @rsc should contain the device address 596400e64dfSOhad Ben-Cohen * where the remote processor is dumping the traces. Later we could also 597400e64dfSOhad Ben-Cohen * support dynamically allocating this address using the generic 598400e64dfSOhad Ben-Cohen * DMA API (but currently there isn't a use case for that). 599400e64dfSOhad Ben-Cohen * 600400e64dfSOhad Ben-Cohen * Returns 0 on success, or an appropriate error code otherwise 601400e64dfSOhad Ben-Cohen */ 602fd2c15ecSOhad Ben-Cohen static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc, 603a2b950acSOhad Ben-Cohen int offset, int avail) 604400e64dfSOhad Ben-Cohen { 605a987e6b9SLoic Pallardy struct rproc_debug_trace *trace; 606b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 607400e64dfSOhad Ben-Cohen char name[15]; 608400e64dfSOhad Ben-Cohen 609fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 610b5ab5e24SOhad Ben-Cohen dev_err(dev, "trace rsc is truncated\n"); 611fd2c15ecSOhad Ben-Cohen return -EINVAL; 612fd2c15ecSOhad Ben-Cohen } 613fd2c15ecSOhad Ben-Cohen 614fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 615fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 616fd2c15ecSOhad Ben-Cohen dev_err(dev, "trace rsc has non zero reserved bytes\n"); 617fd2c15ecSOhad Ben-Cohen return -EINVAL; 618fd2c15ecSOhad Ben-Cohen } 619fd2c15ecSOhad Ben-Cohen 620400e64dfSOhad Ben-Cohen trace = kzalloc(sizeof(*trace), GFP_KERNEL); 621172e6ab1SSuman Anna if (!trace) 622400e64dfSOhad Ben-Cohen return -ENOMEM; 623400e64dfSOhad Ben-Cohen 624400e64dfSOhad Ben-Cohen /* set the trace buffer dma properties */ 625a987e6b9SLoic Pallardy trace->trace_mem.len = rsc->len; 626a987e6b9SLoic Pallardy trace->trace_mem.da = rsc->da; 627a987e6b9SLoic Pallardy 628a987e6b9SLoic Pallardy /* set pointer on rproc device */ 629a987e6b9SLoic Pallardy trace->rproc = rproc; 630400e64dfSOhad Ben-Cohen 631400e64dfSOhad Ben-Cohen /* make sure snprintf always null terminates, even if truncating */ 632400e64dfSOhad Ben-Cohen snprintf(name, sizeof(name), "trace%d", rproc->num_traces); 633400e64dfSOhad Ben-Cohen 634400e64dfSOhad Ben-Cohen /* create the debugfs entry */ 635a987e6b9SLoic Pallardy trace->tfile = rproc_create_trace_file(name, rproc, trace); 636a987e6b9SLoic Pallardy if (!trace->tfile) { 637400e64dfSOhad Ben-Cohen kfree(trace); 638400e64dfSOhad Ben-Cohen return -EINVAL; 639400e64dfSOhad Ben-Cohen } 640400e64dfSOhad Ben-Cohen 641400e64dfSOhad Ben-Cohen list_add_tail(&trace->node, &rproc->traces); 642400e64dfSOhad Ben-Cohen 643400e64dfSOhad Ben-Cohen rproc->num_traces++; 644400e64dfSOhad Ben-Cohen 645a987e6b9SLoic Pallardy dev_dbg(dev, "%s added: da 0x%x, len 0x%x\n", 646a987e6b9SLoic Pallardy name, rsc->da, rsc->len); 647400e64dfSOhad Ben-Cohen 648400e64dfSOhad Ben-Cohen return 0; 649400e64dfSOhad Ben-Cohen } 650400e64dfSOhad Ben-Cohen 651400e64dfSOhad Ben-Cohen /** 652400e64dfSOhad Ben-Cohen * rproc_handle_devmem() - handle devmem resource entry 653400e64dfSOhad Ben-Cohen * @rproc: remote processor handle 654400e64dfSOhad Ben-Cohen * @rsc: the devmem resource entry 655fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 656400e64dfSOhad Ben-Cohen * 657400e64dfSOhad Ben-Cohen * Remote processors commonly need to access certain on-chip peripherals. 658400e64dfSOhad Ben-Cohen * 659400e64dfSOhad Ben-Cohen * Some of these remote processors access memory via an iommu device, 660400e64dfSOhad Ben-Cohen * and might require us to configure their iommu before they can access 661400e64dfSOhad Ben-Cohen * the on-chip peripherals they need. 662400e64dfSOhad Ben-Cohen * 663400e64dfSOhad Ben-Cohen * This resource entry is a request to map such a peripheral device. 664400e64dfSOhad Ben-Cohen * 665400e64dfSOhad Ben-Cohen * These devmem entries will contain the physical address of the device in 666400e64dfSOhad Ben-Cohen * the 'pa' member. If a specific device address is expected, then 'da' will 667400e64dfSOhad Ben-Cohen * contain it (currently this is the only use case supported). 'len' will 668400e64dfSOhad Ben-Cohen * contain the size of the physical region we need to map. 669400e64dfSOhad Ben-Cohen * 670400e64dfSOhad Ben-Cohen * Currently we just "trust" those devmem entries to contain valid physical 671400e64dfSOhad Ben-Cohen * addresses, but this is going to change: we want the implementations to 672400e64dfSOhad Ben-Cohen * tell us ranges of physical addresses the firmware is allowed to request, 673400e64dfSOhad Ben-Cohen * and not allow firmwares to request access to physical addresses that 674400e64dfSOhad Ben-Cohen * are outside those ranges. 675400e64dfSOhad Ben-Cohen */ 676fd2c15ecSOhad Ben-Cohen static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc, 677a2b950acSOhad Ben-Cohen int offset, int avail) 678400e64dfSOhad Ben-Cohen { 679400e64dfSOhad Ben-Cohen struct rproc_mem_entry *mapping; 680b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 681400e64dfSOhad Ben-Cohen int ret; 682400e64dfSOhad Ben-Cohen 683400e64dfSOhad Ben-Cohen /* no point in handling this resource without a valid iommu domain */ 684400e64dfSOhad Ben-Cohen if (!rproc->domain) 685400e64dfSOhad Ben-Cohen return -EINVAL; 686400e64dfSOhad Ben-Cohen 687fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 688b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc is truncated\n"); 689fd2c15ecSOhad Ben-Cohen return -EINVAL; 690fd2c15ecSOhad Ben-Cohen } 691fd2c15ecSOhad Ben-Cohen 692fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 693fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 694b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc has non zero reserved bytes\n"); 695fd2c15ecSOhad Ben-Cohen return -EINVAL; 696fd2c15ecSOhad Ben-Cohen } 697fd2c15ecSOhad Ben-Cohen 698400e64dfSOhad Ben-Cohen mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 699172e6ab1SSuman Anna if (!mapping) 700400e64dfSOhad Ben-Cohen return -ENOMEM; 701400e64dfSOhad Ben-Cohen 702400e64dfSOhad Ben-Cohen ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags); 703400e64dfSOhad Ben-Cohen if (ret) { 704b5ab5e24SOhad Ben-Cohen dev_err(dev, "failed to map devmem: %d\n", ret); 705400e64dfSOhad Ben-Cohen goto out; 706400e64dfSOhad Ben-Cohen } 707400e64dfSOhad Ben-Cohen 708400e64dfSOhad Ben-Cohen /* 709400e64dfSOhad Ben-Cohen * We'll need this info later when we'll want to unmap everything 710400e64dfSOhad Ben-Cohen * (e.g. on shutdown). 711400e64dfSOhad Ben-Cohen * 712400e64dfSOhad Ben-Cohen * We can't trust the remote processor not to change the resource 713400e64dfSOhad Ben-Cohen * table, so we must maintain this info independently. 714400e64dfSOhad Ben-Cohen */ 715400e64dfSOhad Ben-Cohen mapping->da = rsc->da; 716400e64dfSOhad Ben-Cohen mapping->len = rsc->len; 717400e64dfSOhad Ben-Cohen list_add_tail(&mapping->node, &rproc->mappings); 718400e64dfSOhad Ben-Cohen 719b5ab5e24SOhad Ben-Cohen dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n", 720400e64dfSOhad Ben-Cohen rsc->pa, rsc->da, rsc->len); 721400e64dfSOhad Ben-Cohen 722400e64dfSOhad Ben-Cohen return 0; 723400e64dfSOhad Ben-Cohen 724400e64dfSOhad Ben-Cohen out: 725400e64dfSOhad Ben-Cohen kfree(mapping); 726400e64dfSOhad Ben-Cohen return ret; 727400e64dfSOhad Ben-Cohen } 728400e64dfSOhad Ben-Cohen 729400e64dfSOhad Ben-Cohen /** 730d7c51706SLoic Pallardy * rproc_alloc_carveout() - allocated specified carveout 731d7c51706SLoic Pallardy * @rproc: rproc handle 732d7c51706SLoic Pallardy * @mem: the memory entry to allocate 733d7c51706SLoic Pallardy * 734d7c51706SLoic Pallardy * This function allocate specified memory entry @mem using 735d7c51706SLoic Pallardy * dma_alloc_coherent() as default allocator 736d7c51706SLoic Pallardy */ 737d7c51706SLoic Pallardy static int rproc_alloc_carveout(struct rproc *rproc, 738d7c51706SLoic Pallardy struct rproc_mem_entry *mem) 739d7c51706SLoic Pallardy { 740d7c51706SLoic Pallardy struct rproc_mem_entry *mapping = NULL; 741d7c51706SLoic Pallardy struct device *dev = &rproc->dev; 742d7c51706SLoic Pallardy dma_addr_t dma; 743d7c51706SLoic Pallardy void *va; 744d7c51706SLoic Pallardy int ret; 745d7c51706SLoic Pallardy 746d7c51706SLoic Pallardy va = dma_alloc_coherent(dev->parent, mem->len, &dma, GFP_KERNEL); 747d7c51706SLoic Pallardy if (!va) { 748d7c51706SLoic Pallardy dev_err(dev->parent, 749d7c51706SLoic Pallardy "failed to allocate dma memory: len 0x%x\n", mem->len); 750d7c51706SLoic Pallardy return -ENOMEM; 751d7c51706SLoic Pallardy } 752d7c51706SLoic Pallardy 753d7c51706SLoic Pallardy dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%x\n", 754d7c51706SLoic Pallardy va, &dma, mem->len); 755d7c51706SLoic Pallardy 75660f849a5SLoic Pallardy if (mem->da != FW_RSC_ADDR_ANY && !rproc->domain) { 75760f849a5SLoic Pallardy /* 75860f849a5SLoic Pallardy * Check requested da is equal to dma address 75960f849a5SLoic Pallardy * and print a warn message in case of missalignment. 76060f849a5SLoic Pallardy * Don't stop rproc_start sequence as coprocessor may 76160f849a5SLoic Pallardy * build pa to da translation on its side. 76260f849a5SLoic Pallardy */ 76360f849a5SLoic Pallardy if (mem->da != (u32)dma) 76460f849a5SLoic Pallardy dev_warn(dev->parent, 76560f849a5SLoic Pallardy "Allocated carveout doesn't fit device address request\n"); 76660f849a5SLoic Pallardy } 76760f849a5SLoic Pallardy 768d7c51706SLoic Pallardy /* 769d7c51706SLoic Pallardy * Ok, this is non-standard. 770d7c51706SLoic Pallardy * 771d7c51706SLoic Pallardy * Sometimes we can't rely on the generic iommu-based DMA API 772d7c51706SLoic Pallardy * to dynamically allocate the device address and then set the IOMMU 773d7c51706SLoic Pallardy * tables accordingly, because some remote processors might 774d7c51706SLoic Pallardy * _require_ us to use hard coded device addresses that their 775d7c51706SLoic Pallardy * firmware was compiled with. 776d7c51706SLoic Pallardy * 777d7c51706SLoic Pallardy * In this case, we must use the IOMMU API directly and map 778d7c51706SLoic Pallardy * the memory to the device address as expected by the remote 779d7c51706SLoic Pallardy * processor. 780d7c51706SLoic Pallardy * 781d7c51706SLoic Pallardy * Obviously such remote processor devices should not be configured 782d7c51706SLoic Pallardy * to use the iommu-based DMA API: we expect 'dma' to contain the 783d7c51706SLoic Pallardy * physical address in this case. 784d7c51706SLoic Pallardy */ 78560f849a5SLoic Pallardy if (mem->da != FW_RSC_ADDR_ANY && rproc->domain) { 786d7c51706SLoic Pallardy mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 787d7c51706SLoic Pallardy if (!mapping) { 788d7c51706SLoic Pallardy ret = -ENOMEM; 789d7c51706SLoic Pallardy goto dma_free; 790d7c51706SLoic Pallardy } 791d7c51706SLoic Pallardy 792d7c51706SLoic Pallardy ret = iommu_map(rproc->domain, mem->da, dma, mem->len, 793d7c51706SLoic Pallardy mem->flags); 794d7c51706SLoic Pallardy if (ret) { 795d7c51706SLoic Pallardy dev_err(dev, "iommu_map failed: %d\n", ret); 796d7c51706SLoic Pallardy goto free_mapping; 797d7c51706SLoic Pallardy } 798d7c51706SLoic Pallardy 799d7c51706SLoic Pallardy /* 800d7c51706SLoic Pallardy * We'll need this info later when we'll want to unmap 801d7c51706SLoic Pallardy * everything (e.g. on shutdown). 802d7c51706SLoic Pallardy * 803d7c51706SLoic Pallardy * We can't trust the remote processor not to change the 804d7c51706SLoic Pallardy * resource table, so we must maintain this info independently. 805d7c51706SLoic Pallardy */ 806d7c51706SLoic Pallardy mapping->da = mem->da; 807d7c51706SLoic Pallardy mapping->len = mem->len; 808d7c51706SLoic Pallardy list_add_tail(&mapping->node, &rproc->mappings); 809d7c51706SLoic Pallardy 810d7c51706SLoic Pallardy dev_dbg(dev, "carveout mapped 0x%x to %pad\n", 811d7c51706SLoic Pallardy mem->da, &dma); 81260f849a5SLoic Pallardy } 81360f849a5SLoic Pallardy 81460f849a5SLoic Pallardy if (mem->da == FW_RSC_ADDR_ANY) { 815b36de8cfSLoic Pallardy /* Update device address as undefined by requester */ 816b36de8cfSLoic Pallardy if ((u64)dma & HIGH_BITS_MASK) 817b36de8cfSLoic Pallardy dev_warn(dev, "DMA address cast in 32bit to fit resource table format\n"); 818b36de8cfSLoic Pallardy 819d7c51706SLoic Pallardy mem->da = (u32)dma; 820d7c51706SLoic Pallardy } 821d7c51706SLoic Pallardy 82280137b40SLoic Pallardy mem->dma = dma; 823d7c51706SLoic Pallardy mem->va = va; 824d7c51706SLoic Pallardy 825d7c51706SLoic Pallardy return 0; 826d7c51706SLoic Pallardy 827d7c51706SLoic Pallardy free_mapping: 828d7c51706SLoic Pallardy kfree(mapping); 829d7c51706SLoic Pallardy dma_free: 830d7c51706SLoic Pallardy dma_free_coherent(dev->parent, mem->len, va, dma); 831d7c51706SLoic Pallardy return ret; 832d7c51706SLoic Pallardy } 833d7c51706SLoic Pallardy 834d7c51706SLoic Pallardy /** 835f2e74abfSLoic Pallardy * rproc_release_carveout() - release acquired carveout 836f2e74abfSLoic Pallardy * @rproc: rproc handle 837f2e74abfSLoic Pallardy * @mem: the memory entry to release 838f2e74abfSLoic Pallardy * 839f2e74abfSLoic Pallardy * This function releases specified memory entry @mem allocated via 840d7c51706SLoic Pallardy * rproc_alloc_carveout() function by @rproc. 841f2e74abfSLoic Pallardy */ 842f2e74abfSLoic Pallardy static int rproc_release_carveout(struct rproc *rproc, 843f2e74abfSLoic Pallardy struct rproc_mem_entry *mem) 844f2e74abfSLoic Pallardy { 845f2e74abfSLoic Pallardy struct device *dev = &rproc->dev; 846f2e74abfSLoic Pallardy 847f2e74abfSLoic Pallardy /* clean up carveout allocations */ 848f2e74abfSLoic Pallardy dma_free_coherent(dev->parent, mem->len, mem->va, mem->dma); 849f2e74abfSLoic Pallardy return 0; 850f2e74abfSLoic Pallardy } 851f2e74abfSLoic Pallardy 852f2e74abfSLoic Pallardy /** 853400e64dfSOhad Ben-Cohen * rproc_handle_carveout() - handle phys contig memory allocation requests 854400e64dfSOhad Ben-Cohen * @rproc: rproc handle 855400e64dfSOhad Ben-Cohen * @rsc: the resource entry 856fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for image validation) 857400e64dfSOhad Ben-Cohen * 858400e64dfSOhad Ben-Cohen * This function will handle firmware requests for allocation of physically 859400e64dfSOhad Ben-Cohen * contiguous memory regions. 860400e64dfSOhad Ben-Cohen * 861400e64dfSOhad Ben-Cohen * These request entries should come first in the firmware's resource table, 862400e64dfSOhad Ben-Cohen * as other firmware entries might request placing other data objects inside 863400e64dfSOhad Ben-Cohen * these memory regions (e.g. data/code segments, trace resource entries, ...). 864400e64dfSOhad Ben-Cohen * 865400e64dfSOhad Ben-Cohen * Allocating memory this way helps utilizing the reserved physical memory 866400e64dfSOhad Ben-Cohen * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries 867400e64dfSOhad Ben-Cohen * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB 868400e64dfSOhad Ben-Cohen * pressure is important; it may have a substantial impact on performance. 869400e64dfSOhad Ben-Cohen */ 870fd2c15ecSOhad Ben-Cohen static int rproc_handle_carveout(struct rproc *rproc, 871a2b950acSOhad Ben-Cohen struct fw_rsc_carveout *rsc, 872a2b950acSOhad Ben-Cohen int offset, int avail) 873400e64dfSOhad Ben-Cohen { 874d7c51706SLoic Pallardy struct rproc_mem_entry *carveout; 875b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 876400e64dfSOhad Ben-Cohen 877fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 878b5ab5e24SOhad Ben-Cohen dev_err(dev, "carveout rsc is truncated\n"); 879fd2c15ecSOhad Ben-Cohen return -EINVAL; 880fd2c15ecSOhad Ben-Cohen } 881fd2c15ecSOhad Ben-Cohen 882fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 883fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 884fd2c15ecSOhad Ben-Cohen dev_err(dev, "carveout rsc has non zero reserved bytes\n"); 885fd2c15ecSOhad Ben-Cohen return -EINVAL; 886fd2c15ecSOhad Ben-Cohen } 887fd2c15ecSOhad Ben-Cohen 8889d7814a9SAnna, Suman dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n", 88935386166SLee Jones rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags); 890fd2c15ecSOhad Ben-Cohen 891ffa5f9c8SLoic Pallardy /* 892ffa5f9c8SLoic Pallardy * Check carveout rsc already part of a registered carveout, 893ffa5f9c8SLoic Pallardy * Search by name, then check the da and length 894ffa5f9c8SLoic Pallardy */ 895ffa5f9c8SLoic Pallardy carveout = rproc_find_carveout_by_name(rproc, rsc->name); 896ffa5f9c8SLoic Pallardy 897ffa5f9c8SLoic Pallardy if (carveout) { 898ffa5f9c8SLoic Pallardy if (carveout->rsc_offset != FW_RSC_ADDR_ANY) { 899ffa5f9c8SLoic Pallardy dev_err(dev, 900ffa5f9c8SLoic Pallardy "Carveout already associated to resource table\n"); 901ffa5f9c8SLoic Pallardy return -ENOMEM; 902ffa5f9c8SLoic Pallardy } 903ffa5f9c8SLoic Pallardy 904ffa5f9c8SLoic Pallardy if (rproc_check_carveout_da(rproc, carveout, rsc->da, rsc->len)) 905ffa5f9c8SLoic Pallardy return -ENOMEM; 906ffa5f9c8SLoic Pallardy 907ffa5f9c8SLoic Pallardy /* Update memory carveout with resource table info */ 908ffa5f9c8SLoic Pallardy carveout->rsc_offset = offset; 909ffa5f9c8SLoic Pallardy carveout->flags = rsc->flags; 910ffa5f9c8SLoic Pallardy 911ffa5f9c8SLoic Pallardy return 0; 912ffa5f9c8SLoic Pallardy } 913ffa5f9c8SLoic Pallardy 914d7c51706SLoic Pallardy /* Register carveout in in list */ 915d7c51706SLoic Pallardy carveout = rproc_mem_entry_init(dev, 0, 0, rsc->len, rsc->da, 916d7c51706SLoic Pallardy rproc_alloc_carveout, 917d7c51706SLoic Pallardy rproc_release_carveout, rsc->name); 918d7c51706SLoic Pallardy if (!carveout) { 919d7c51706SLoic Pallardy dev_err(dev, "Can't allocate memory entry structure\n"); 92072029c90SLoic Pallardy return -ENOMEM; 921400e64dfSOhad Ben-Cohen } 922400e64dfSOhad Ben-Cohen 923d7c51706SLoic Pallardy carveout->flags = rsc->flags; 924d7c51706SLoic Pallardy carveout->rsc_offset = offset; 92515c0b025SLoic Pallardy rproc_add_carveout(rproc, carveout); 926400e64dfSOhad Ben-Cohen 927400e64dfSOhad Ben-Cohen return 0; 928400e64dfSOhad Ben-Cohen } 929400e64dfSOhad Ben-Cohen 93072029c90SLoic Pallardy /** 93115c0b025SLoic Pallardy * rproc_add_carveout() - register an allocated carveout region 93215c0b025SLoic Pallardy * @rproc: rproc handle 93315c0b025SLoic Pallardy * @mem: memory entry to register 93415c0b025SLoic Pallardy * 93515c0b025SLoic Pallardy * This function registers specified memory entry in @rproc carveouts list. 93615c0b025SLoic Pallardy * Specified carveout should have been allocated before registering. 93715c0b025SLoic Pallardy */ 93815c0b025SLoic Pallardy void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem) 93915c0b025SLoic Pallardy { 94015c0b025SLoic Pallardy list_add_tail(&mem->node, &rproc->carveouts); 94115c0b025SLoic Pallardy } 94215c0b025SLoic Pallardy EXPORT_SYMBOL(rproc_add_carveout); 94315c0b025SLoic Pallardy 94415c0b025SLoic Pallardy /** 94572029c90SLoic Pallardy * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct 94672029c90SLoic Pallardy * @dev: pointer on device struct 94772029c90SLoic Pallardy * @va: virtual address 94872029c90SLoic Pallardy * @dma: dma address 94972029c90SLoic Pallardy * @len: memory carveout length 95072029c90SLoic Pallardy * @da: device address 951a9f6fe0dSLoic Pallardy * @alloc: memory carveout allocation function 952a9f6fe0dSLoic Pallardy * @release: memory carveout release function 95372029c90SLoic Pallardy * @name: carveout name 95472029c90SLoic Pallardy * 95572029c90SLoic Pallardy * This function allocates a rproc_mem_entry struct and fill it with parameters 95672029c90SLoic Pallardy * provided by client. 95772029c90SLoic Pallardy */ 95872029c90SLoic Pallardy struct rproc_mem_entry * 95972029c90SLoic Pallardy rproc_mem_entry_init(struct device *dev, 96072029c90SLoic Pallardy void *va, dma_addr_t dma, int len, u32 da, 961d7c51706SLoic Pallardy int (*alloc)(struct rproc *, struct rproc_mem_entry *), 96272029c90SLoic Pallardy int (*release)(struct rproc *, struct rproc_mem_entry *), 96372029c90SLoic Pallardy const char *name, ...) 96472029c90SLoic Pallardy { 96572029c90SLoic Pallardy struct rproc_mem_entry *mem; 96672029c90SLoic Pallardy va_list args; 96772029c90SLoic Pallardy 96872029c90SLoic Pallardy mem = kzalloc(sizeof(*mem), GFP_KERNEL); 96972029c90SLoic Pallardy if (!mem) 97072029c90SLoic Pallardy return mem; 97172029c90SLoic Pallardy 97272029c90SLoic Pallardy mem->va = va; 97372029c90SLoic Pallardy mem->dma = dma; 97472029c90SLoic Pallardy mem->da = da; 97572029c90SLoic Pallardy mem->len = len; 976d7c51706SLoic Pallardy mem->alloc = alloc; 97772029c90SLoic Pallardy mem->release = release; 978d7c51706SLoic Pallardy mem->rsc_offset = FW_RSC_ADDR_ANY; 9791429cca1SLoic Pallardy mem->of_resm_idx = -1; 98072029c90SLoic Pallardy 98172029c90SLoic Pallardy va_start(args, name); 98272029c90SLoic Pallardy vsnprintf(mem->name, sizeof(mem->name), name, args); 98372029c90SLoic Pallardy va_end(args); 98472029c90SLoic Pallardy 98572029c90SLoic Pallardy return mem; 98672029c90SLoic Pallardy } 98772029c90SLoic Pallardy EXPORT_SYMBOL(rproc_mem_entry_init); 98872029c90SLoic Pallardy 98972029c90SLoic Pallardy /** 9901429cca1SLoic Pallardy * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct 9911429cca1SLoic Pallardy * from a reserved memory phandle 9921429cca1SLoic Pallardy * @dev: pointer on device struct 9931429cca1SLoic Pallardy * @of_resm_idx: reserved memory phandle index in "memory-region" 9941429cca1SLoic Pallardy * @len: memory carveout length 9951429cca1SLoic Pallardy * @da: device address 9961429cca1SLoic Pallardy * @name: carveout name 9971429cca1SLoic Pallardy * 9981429cca1SLoic Pallardy * This function allocates a rproc_mem_entry struct and fill it with parameters 9991429cca1SLoic Pallardy * provided by client. 10001429cca1SLoic Pallardy */ 10011429cca1SLoic Pallardy struct rproc_mem_entry * 10021429cca1SLoic Pallardy rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, int len, 10031429cca1SLoic Pallardy u32 da, const char *name, ...) 10041429cca1SLoic Pallardy { 10051429cca1SLoic Pallardy struct rproc_mem_entry *mem; 10061429cca1SLoic Pallardy va_list args; 10071429cca1SLoic Pallardy 10081429cca1SLoic Pallardy mem = kzalloc(sizeof(*mem), GFP_KERNEL); 10091429cca1SLoic Pallardy if (!mem) 10101429cca1SLoic Pallardy return mem; 10111429cca1SLoic Pallardy 10121429cca1SLoic Pallardy mem->da = da; 10131429cca1SLoic Pallardy mem->len = len; 10141429cca1SLoic Pallardy mem->rsc_offset = FW_RSC_ADDR_ANY; 10151429cca1SLoic Pallardy mem->of_resm_idx = of_resm_idx; 10161429cca1SLoic Pallardy 10171429cca1SLoic Pallardy va_start(args, name); 10181429cca1SLoic Pallardy vsnprintf(mem->name, sizeof(mem->name), name, args); 10191429cca1SLoic Pallardy va_end(args); 10201429cca1SLoic Pallardy 10211429cca1SLoic Pallardy return mem; 10221429cca1SLoic Pallardy } 10231429cca1SLoic Pallardy EXPORT_SYMBOL(rproc_of_resm_mem_entry_init); 10241429cca1SLoic Pallardy 10251429cca1SLoic Pallardy /** 1026e12bc14bSOhad Ben-Cohen * A lookup table for resource handlers. The indices are defined in 1027e12bc14bSOhad Ben-Cohen * enum fw_resource_type. 1028e12bc14bSOhad Ben-Cohen */ 1029232fcdbbSSjur Brændeland static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = { 1030fd2c15ecSOhad Ben-Cohen [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout, 1031fd2c15ecSOhad Ben-Cohen [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem, 1032fd2c15ecSOhad Ben-Cohen [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace, 1033232fcdbbSSjur Brændeland [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev, 1034232fcdbbSSjur Brændeland }; 1035232fcdbbSSjur Brændeland 1036400e64dfSOhad Ben-Cohen /* handle firmware resource entries before booting the remote processor */ 1037a4b24c75SBjorn Andersson static int rproc_handle_resources(struct rproc *rproc, 1038232fcdbbSSjur Brændeland rproc_handle_resource_t handlers[RSC_LAST]) 1039400e64dfSOhad Ben-Cohen { 1040b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1041e12bc14bSOhad Ben-Cohen rproc_handle_resource_t handler; 1042fd2c15ecSOhad Ben-Cohen int ret = 0, i; 1043400e64dfSOhad Ben-Cohen 1044d4bb86f2SBjorn Andersson if (!rproc->table_ptr) 1045d4bb86f2SBjorn Andersson return 0; 1046d4bb86f2SBjorn Andersson 1047a2b950acSOhad Ben-Cohen for (i = 0; i < rproc->table_ptr->num; i++) { 1048a2b950acSOhad Ben-Cohen int offset = rproc->table_ptr->offset[i]; 1049a2b950acSOhad Ben-Cohen struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset; 1050a4b24c75SBjorn Andersson int avail = rproc->table_sz - offset - sizeof(*hdr); 1051fd2c15ecSOhad Ben-Cohen void *rsc = (void *)hdr + sizeof(*hdr); 1052400e64dfSOhad Ben-Cohen 1053fd2c15ecSOhad Ben-Cohen /* make sure table isn't truncated */ 1054fd2c15ecSOhad Ben-Cohen if (avail < 0) { 1055fd2c15ecSOhad Ben-Cohen dev_err(dev, "rsc table is truncated\n"); 1056fd2c15ecSOhad Ben-Cohen return -EINVAL; 1057fd2c15ecSOhad Ben-Cohen } 1058fd2c15ecSOhad Ben-Cohen 1059fd2c15ecSOhad Ben-Cohen dev_dbg(dev, "rsc: type %d\n", hdr->type); 1060fd2c15ecSOhad Ben-Cohen 1061fd2c15ecSOhad Ben-Cohen if (hdr->type >= RSC_LAST) { 1062fd2c15ecSOhad Ben-Cohen dev_warn(dev, "unsupported resource %d\n", hdr->type); 1063e12bc14bSOhad Ben-Cohen continue; 1064400e64dfSOhad Ben-Cohen } 1065400e64dfSOhad Ben-Cohen 1066232fcdbbSSjur Brændeland handler = handlers[hdr->type]; 1067e12bc14bSOhad Ben-Cohen if (!handler) 1068e12bc14bSOhad Ben-Cohen continue; 1069e12bc14bSOhad Ben-Cohen 1070a2b950acSOhad Ben-Cohen ret = handler(rproc, rsc, offset + sizeof(*hdr), avail); 10717a186941SOhad Ben-Cohen if (ret) 1072400e64dfSOhad Ben-Cohen break; 1073400e64dfSOhad Ben-Cohen } 1074400e64dfSOhad Ben-Cohen 1075400e64dfSOhad Ben-Cohen return ret; 1076400e64dfSOhad Ben-Cohen } 1077400e64dfSOhad Ben-Cohen 1078c455daa4SBjorn Andersson static int rproc_prepare_subdevices(struct rproc *rproc) 1079c455daa4SBjorn Andersson { 1080c455daa4SBjorn Andersson struct rproc_subdev *subdev; 1081c455daa4SBjorn Andersson int ret; 1082c455daa4SBjorn Andersson 1083c455daa4SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 1084c455daa4SBjorn Andersson if (subdev->prepare) { 1085c455daa4SBjorn Andersson ret = subdev->prepare(subdev); 1086c455daa4SBjorn Andersson if (ret) 1087c455daa4SBjorn Andersson goto unroll_preparation; 1088c455daa4SBjorn Andersson } 1089c455daa4SBjorn Andersson } 1090c455daa4SBjorn Andersson 1091c455daa4SBjorn Andersson return 0; 1092c455daa4SBjorn Andersson 1093c455daa4SBjorn Andersson unroll_preparation: 1094c455daa4SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 1095c455daa4SBjorn Andersson if (subdev->unprepare) 1096c455daa4SBjorn Andersson subdev->unprepare(subdev); 1097c455daa4SBjorn Andersson } 1098c455daa4SBjorn Andersson 1099c455daa4SBjorn Andersson return ret; 1100c455daa4SBjorn Andersson } 1101c455daa4SBjorn Andersson 1102618fcff3SBjorn Andersson static int rproc_start_subdevices(struct rproc *rproc) 11037bdc9650SBjorn Andersson { 11047bdc9650SBjorn Andersson struct rproc_subdev *subdev; 11057bdc9650SBjorn Andersson int ret; 11067bdc9650SBjorn Andersson 11077bdc9650SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 1108be37b1e0SBjorn Andersson if (subdev->start) { 1109618fcff3SBjorn Andersson ret = subdev->start(subdev); 11107bdc9650SBjorn Andersson if (ret) 11117bdc9650SBjorn Andersson goto unroll_registration; 11127bdc9650SBjorn Andersson } 1113be37b1e0SBjorn Andersson } 11147bdc9650SBjorn Andersson 11157bdc9650SBjorn Andersson return 0; 11167bdc9650SBjorn Andersson 11177bdc9650SBjorn Andersson unroll_registration: 1118be37b1e0SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 1119be37b1e0SBjorn Andersson if (subdev->stop) 1120618fcff3SBjorn Andersson subdev->stop(subdev, true); 1121be37b1e0SBjorn Andersson } 11227bdc9650SBjorn Andersson 11237bdc9650SBjorn Andersson return ret; 11247bdc9650SBjorn Andersson } 11257bdc9650SBjorn Andersson 1126618fcff3SBjorn Andersson static void rproc_stop_subdevices(struct rproc *rproc, bool crashed) 11277bdc9650SBjorn Andersson { 11287bdc9650SBjorn Andersson struct rproc_subdev *subdev; 11297bdc9650SBjorn Andersson 1130be37b1e0SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 1131be37b1e0SBjorn Andersson if (subdev->stop) 1132618fcff3SBjorn Andersson subdev->stop(subdev, crashed); 11337bdc9650SBjorn Andersson } 1134be37b1e0SBjorn Andersson } 11357bdc9650SBjorn Andersson 1136c455daa4SBjorn Andersson static void rproc_unprepare_subdevices(struct rproc *rproc) 1137c455daa4SBjorn Andersson { 1138c455daa4SBjorn Andersson struct rproc_subdev *subdev; 1139c455daa4SBjorn Andersson 1140c455daa4SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 1141c455daa4SBjorn Andersson if (subdev->unprepare) 1142c455daa4SBjorn Andersson subdev->unprepare(subdev); 1143c455daa4SBjorn Andersson } 1144c455daa4SBjorn Andersson } 1145c455daa4SBjorn Andersson 1146400e64dfSOhad Ben-Cohen /** 1147d7c51706SLoic Pallardy * rproc_alloc_registered_carveouts() - allocate all carveouts registered 1148d7c51706SLoic Pallardy * in the list 1149d7c51706SLoic Pallardy * @rproc: the remote processor handle 1150d7c51706SLoic Pallardy * 1151d7c51706SLoic Pallardy * This function parses registered carveout list, performs allocation 1152d7c51706SLoic Pallardy * if alloc() ops registered and updates resource table information 1153d7c51706SLoic Pallardy * if rsc_offset set. 1154d7c51706SLoic Pallardy * 1155d7c51706SLoic Pallardy * Return: 0 on success 1156d7c51706SLoic Pallardy */ 1157d7c51706SLoic Pallardy static int rproc_alloc_registered_carveouts(struct rproc *rproc) 1158d7c51706SLoic Pallardy { 1159d7c51706SLoic Pallardy struct rproc_mem_entry *entry, *tmp; 1160d7c51706SLoic Pallardy struct fw_rsc_carveout *rsc; 1161d7c51706SLoic Pallardy struct device *dev = &rproc->dev; 1162b36de8cfSLoic Pallardy u64 pa; 1163d7c51706SLoic Pallardy int ret; 1164d7c51706SLoic Pallardy 1165d7c51706SLoic Pallardy list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 1166d7c51706SLoic Pallardy if (entry->alloc) { 1167d7c51706SLoic Pallardy ret = entry->alloc(rproc, entry); 1168d7c51706SLoic Pallardy if (ret) { 1169d7c51706SLoic Pallardy dev_err(dev, "Unable to allocate carveout %s: %d\n", 1170d7c51706SLoic Pallardy entry->name, ret); 1171d7c51706SLoic Pallardy return -ENOMEM; 1172d7c51706SLoic Pallardy } 1173d7c51706SLoic Pallardy } 1174d7c51706SLoic Pallardy 1175d7c51706SLoic Pallardy if (entry->rsc_offset != FW_RSC_ADDR_ANY) { 1176d7c51706SLoic Pallardy /* update resource table */ 1177d7c51706SLoic Pallardy rsc = (void *)rproc->table_ptr + entry->rsc_offset; 1178d7c51706SLoic Pallardy 1179d7c51706SLoic Pallardy /* 1180d7c51706SLoic Pallardy * Some remote processors might need to know the pa 1181d7c51706SLoic Pallardy * even though they are behind an IOMMU. E.g., OMAP4's 1182d7c51706SLoic Pallardy * remote M3 processor needs this so it can control 1183d7c51706SLoic Pallardy * on-chip hardware accelerators that are not behind 1184d7c51706SLoic Pallardy * the IOMMU, and therefor must know the pa. 1185d7c51706SLoic Pallardy * 1186d7c51706SLoic Pallardy * Generally we don't want to expose physical addresses 1187d7c51706SLoic Pallardy * if we don't have to (remote processors are generally 1188d7c51706SLoic Pallardy * _not_ trusted), so we might want to do this only for 1189d7c51706SLoic Pallardy * remote processor that _must_ have this (e.g. OMAP4's 1190d7c51706SLoic Pallardy * dual M3 subsystem). 1191d7c51706SLoic Pallardy * 1192d7c51706SLoic Pallardy * Non-IOMMU processors might also want to have this info. 1193d7c51706SLoic Pallardy * In this case, the device address and the physical address 1194d7c51706SLoic Pallardy * are the same. 1195d7c51706SLoic Pallardy */ 1196ffa5f9c8SLoic Pallardy 1197ffa5f9c8SLoic Pallardy /* Use va if defined else dma to generate pa */ 1198d7c51706SLoic Pallardy if (entry->va) 1199b36de8cfSLoic Pallardy pa = (u64)rproc_va_to_pa(entry->va); 1200ffa5f9c8SLoic Pallardy else 1201b36de8cfSLoic Pallardy pa = (u64)entry->dma; 1202ffa5f9c8SLoic Pallardy 1203b36de8cfSLoic Pallardy if (((u64)pa) & HIGH_BITS_MASK) 1204b36de8cfSLoic Pallardy dev_warn(dev, 1205b36de8cfSLoic Pallardy "Physical address cast in 32bit to fit resource table format\n"); 1206b36de8cfSLoic Pallardy 1207b36de8cfSLoic Pallardy rsc->pa = (u32)pa; 1208ffa5f9c8SLoic Pallardy rsc->da = entry->da; 1209ffa5f9c8SLoic Pallardy rsc->len = entry->len; 1210d7c51706SLoic Pallardy } 1211d7c51706SLoic Pallardy } 1212d7c51706SLoic Pallardy 1213d7c51706SLoic Pallardy return 0; 1214d7c51706SLoic Pallardy } 1215d7c51706SLoic Pallardy 1216d7c51706SLoic Pallardy /** 12172666ca91SSarangdhar Joshi * rproc_coredump_cleanup() - clean up dump_segments list 12182666ca91SSarangdhar Joshi * @rproc: the remote processor handle 12192666ca91SSarangdhar Joshi */ 12202666ca91SSarangdhar Joshi static void rproc_coredump_cleanup(struct rproc *rproc) 12212666ca91SSarangdhar Joshi { 12222666ca91SSarangdhar Joshi struct rproc_dump_segment *entry, *tmp; 12232666ca91SSarangdhar Joshi 12242666ca91SSarangdhar Joshi list_for_each_entry_safe(entry, tmp, &rproc->dump_segments, node) { 12252666ca91SSarangdhar Joshi list_del(&entry->node); 12262666ca91SSarangdhar Joshi kfree(entry); 12272666ca91SSarangdhar Joshi } 12282666ca91SSarangdhar Joshi } 12292666ca91SSarangdhar Joshi 12302666ca91SSarangdhar Joshi /** 1231400e64dfSOhad Ben-Cohen * rproc_resource_cleanup() - clean up and free all acquired resources 1232400e64dfSOhad Ben-Cohen * @rproc: rproc handle 1233400e64dfSOhad Ben-Cohen * 1234400e64dfSOhad Ben-Cohen * This function will free all resources acquired for @rproc, and it 12357a186941SOhad Ben-Cohen * is called whenever @rproc either shuts down or fails to boot. 1236400e64dfSOhad Ben-Cohen */ 1237400e64dfSOhad Ben-Cohen static void rproc_resource_cleanup(struct rproc *rproc) 1238400e64dfSOhad Ben-Cohen { 1239400e64dfSOhad Ben-Cohen struct rproc_mem_entry *entry, *tmp; 1240a987e6b9SLoic Pallardy struct rproc_debug_trace *trace, *ttmp; 1241d81fb32fSBjorn Andersson struct rproc_vdev *rvdev, *rvtmp; 1242b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1243400e64dfSOhad Ben-Cohen 1244400e64dfSOhad Ben-Cohen /* clean up debugfs trace entries */ 1245a987e6b9SLoic Pallardy list_for_each_entry_safe(trace, ttmp, &rproc->traces, node) { 1246a987e6b9SLoic Pallardy rproc_remove_trace_file(trace->tfile); 1247400e64dfSOhad Ben-Cohen rproc->num_traces--; 1248a987e6b9SLoic Pallardy list_del(&trace->node); 1249a987e6b9SLoic Pallardy kfree(trace); 1250400e64dfSOhad Ben-Cohen } 1251400e64dfSOhad Ben-Cohen 1252400e64dfSOhad Ben-Cohen /* clean up iommu mapping entries */ 1253400e64dfSOhad Ben-Cohen list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) { 1254400e64dfSOhad Ben-Cohen size_t unmapped; 1255400e64dfSOhad Ben-Cohen 1256400e64dfSOhad Ben-Cohen unmapped = iommu_unmap(rproc->domain, entry->da, entry->len); 1257400e64dfSOhad Ben-Cohen if (unmapped != entry->len) { 1258400e64dfSOhad Ben-Cohen /* nothing much to do besides complaining */ 1259e981f6d4SSjur Brændeland dev_err(dev, "failed to unmap %u/%zu\n", entry->len, 1260400e64dfSOhad Ben-Cohen unmapped); 1261400e64dfSOhad Ben-Cohen } 1262400e64dfSOhad Ben-Cohen 1263400e64dfSOhad Ben-Cohen list_del(&entry->node); 1264400e64dfSOhad Ben-Cohen kfree(entry); 1265400e64dfSOhad Ben-Cohen } 1266b6356a01SSuman Anna 1267b6356a01SSuman Anna /* clean up carveout allocations */ 1268b6356a01SSuman Anna list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 1269f2e74abfSLoic Pallardy if (entry->release) 1270f2e74abfSLoic Pallardy entry->release(rproc, entry); 1271b6356a01SSuman Anna list_del(&entry->node); 1272b6356a01SSuman Anna kfree(entry); 1273b6356a01SSuman Anna } 1274d81fb32fSBjorn Andersson 1275d81fb32fSBjorn Andersson /* clean up remote vdev entries */ 1276f5bcb353SBjorn Andersson list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node) 12772b45cef5SBjorn Andersson kref_put(&rvdev->refcount, rproc_vdev_release); 12782666ca91SSarangdhar Joshi 12792666ca91SSarangdhar Joshi rproc_coredump_cleanup(rproc); 12802b45cef5SBjorn Andersson } 1281400e64dfSOhad Ben-Cohen 12821efa30d0SSarangdhar Joshi static int rproc_start(struct rproc *rproc, const struct firmware *fw) 12831efa30d0SSarangdhar Joshi { 1284a4b24c75SBjorn Andersson struct resource_table *loaded_table; 12851efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 1286a4b24c75SBjorn Andersson int ret; 12871efa30d0SSarangdhar Joshi 12881efa30d0SSarangdhar Joshi /* load the ELF segments to memory */ 12891efa30d0SSarangdhar Joshi ret = rproc_load_segments(rproc, fw); 12901efa30d0SSarangdhar Joshi if (ret) { 12911efa30d0SSarangdhar Joshi dev_err(dev, "Failed to load program segments: %d\n", ret); 12921efa30d0SSarangdhar Joshi return ret; 12931efa30d0SSarangdhar Joshi } 12941efa30d0SSarangdhar Joshi 12951efa30d0SSarangdhar Joshi /* 12961efa30d0SSarangdhar Joshi * The starting device has been given the rproc->cached_table as the 12971efa30d0SSarangdhar Joshi * resource table. The address of the vring along with the other 12981efa30d0SSarangdhar Joshi * allocated resources (carveouts etc) is stored in cached_table. 12991efa30d0SSarangdhar Joshi * In order to pass this information to the remote device we must copy 13001efa30d0SSarangdhar Joshi * this information to device memory. We also update the table_ptr so 13011efa30d0SSarangdhar Joshi * that any subsequent changes will be applied to the loaded version. 13021efa30d0SSarangdhar Joshi */ 13031efa30d0SSarangdhar Joshi loaded_table = rproc_find_loaded_rsc_table(rproc, fw); 13041efa30d0SSarangdhar Joshi if (loaded_table) { 1305a4b24c75SBjorn Andersson memcpy(loaded_table, rproc->cached_table, rproc->table_sz); 13061efa30d0SSarangdhar Joshi rproc->table_ptr = loaded_table; 13071efa30d0SSarangdhar Joshi } 13081efa30d0SSarangdhar Joshi 1309c455daa4SBjorn Andersson ret = rproc_prepare_subdevices(rproc); 1310c455daa4SBjorn Andersson if (ret) { 1311c455daa4SBjorn Andersson dev_err(dev, "failed to prepare subdevices for %s: %d\n", 1312c455daa4SBjorn Andersson rproc->name, ret); 1313f68d51bdSSuman Anna goto reset_table_ptr; 1314c455daa4SBjorn Andersson } 1315c455daa4SBjorn Andersson 13161efa30d0SSarangdhar Joshi /* power up the remote processor */ 13171efa30d0SSarangdhar Joshi ret = rproc->ops->start(rproc); 13181efa30d0SSarangdhar Joshi if (ret) { 13191efa30d0SSarangdhar Joshi dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret); 1320c455daa4SBjorn Andersson goto unprepare_subdevices; 13211efa30d0SSarangdhar Joshi } 13221efa30d0SSarangdhar Joshi 1323618fcff3SBjorn Andersson /* Start any subdevices for the remote processor */ 1324618fcff3SBjorn Andersson ret = rproc_start_subdevices(rproc); 13251efa30d0SSarangdhar Joshi if (ret) { 13261efa30d0SSarangdhar Joshi dev_err(dev, "failed to probe subdevices for %s: %d\n", 13271efa30d0SSarangdhar Joshi rproc->name, ret); 1328c455daa4SBjorn Andersson goto stop_rproc; 13291efa30d0SSarangdhar Joshi } 13301efa30d0SSarangdhar Joshi 13311efa30d0SSarangdhar Joshi rproc->state = RPROC_RUNNING; 13321efa30d0SSarangdhar Joshi 13331efa30d0SSarangdhar Joshi dev_info(dev, "remote processor %s is now up\n", rproc->name); 13341efa30d0SSarangdhar Joshi 13351efa30d0SSarangdhar Joshi return 0; 1336c455daa4SBjorn Andersson 1337c455daa4SBjorn Andersson stop_rproc: 1338c455daa4SBjorn Andersson rproc->ops->stop(rproc); 1339c455daa4SBjorn Andersson unprepare_subdevices: 1340c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1341f68d51bdSSuman Anna reset_table_ptr: 1342f68d51bdSSuman Anna rproc->table_ptr = rproc->cached_table; 1343c455daa4SBjorn Andersson 1344c455daa4SBjorn Andersson return ret; 13451efa30d0SSarangdhar Joshi } 13461efa30d0SSarangdhar Joshi 1347400e64dfSOhad Ben-Cohen /* 1348400e64dfSOhad Ben-Cohen * take a firmware and boot a remote processor with it. 1349400e64dfSOhad Ben-Cohen */ 1350400e64dfSOhad Ben-Cohen static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw) 1351400e64dfSOhad Ben-Cohen { 1352b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1353400e64dfSOhad Ben-Cohen const char *name = rproc->firmware; 135458b64090SBjorn Andersson int ret; 1355400e64dfSOhad Ben-Cohen 1356400e64dfSOhad Ben-Cohen ret = rproc_fw_sanity_check(rproc, fw); 1357400e64dfSOhad Ben-Cohen if (ret) 1358400e64dfSOhad Ben-Cohen return ret; 1359400e64dfSOhad Ben-Cohen 1360e981f6d4SSjur Brændeland dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size); 1361400e64dfSOhad Ben-Cohen 1362400e64dfSOhad Ben-Cohen /* 1363400e64dfSOhad Ben-Cohen * if enabling an IOMMU isn't relevant for this rproc, this is 1364400e64dfSOhad Ben-Cohen * just a nop 1365400e64dfSOhad Ben-Cohen */ 1366400e64dfSOhad Ben-Cohen ret = rproc_enable_iommu(rproc); 1367400e64dfSOhad Ben-Cohen if (ret) { 1368400e64dfSOhad Ben-Cohen dev_err(dev, "can't enable iommu: %d\n", ret); 1369400e64dfSOhad Ben-Cohen return ret; 1370400e64dfSOhad Ben-Cohen } 1371400e64dfSOhad Ben-Cohen 13723e5f9eb5SSjur Brændeland rproc->bootaddr = rproc_get_boot_addr(rproc, fw); 1373400e64dfSOhad Ben-Cohen 1374c1d35c1aSBjorn Andersson /* Load resource table, core dump segment list etc from the firmware */ 1375c1d35c1aSBjorn Andersson ret = rproc_parse_fw(rproc, fw); 137658b64090SBjorn Andersson if (ret) 137758b64090SBjorn Andersson goto disable_iommu; 1378a0c10687SBjorn Andersson 1379b35d7afcSBjorn Andersson /* reset max_notifyid */ 1380b35d7afcSBjorn Andersson rproc->max_notifyid = -1; 1381b35d7afcSBjorn Andersson 1382c6aed238SLoic Pallardy /* reset handled vdev */ 1383c6aed238SLoic Pallardy rproc->nb_vdev = 0; 1384c6aed238SLoic Pallardy 1385400e64dfSOhad Ben-Cohen /* handle fw resources which are required to boot rproc */ 1386a4b24c75SBjorn Andersson ret = rproc_handle_resources(rproc, rproc_loading_handlers); 1387400e64dfSOhad Ben-Cohen if (ret) { 1388400e64dfSOhad Ben-Cohen dev_err(dev, "Failed to process resources: %d\n", ret); 1389229b85a6SBjorn Andersson goto clean_up_resources; 1390400e64dfSOhad Ben-Cohen } 1391400e64dfSOhad Ben-Cohen 1392d7c51706SLoic Pallardy /* Allocate carveout resources associated to rproc */ 1393d7c51706SLoic Pallardy ret = rproc_alloc_registered_carveouts(rproc); 1394d7c51706SLoic Pallardy if (ret) { 1395d7c51706SLoic Pallardy dev_err(dev, "Failed to allocate associated carveouts: %d\n", 1396d7c51706SLoic Pallardy ret); 1397d7c51706SLoic Pallardy goto clean_up_resources; 1398d7c51706SLoic Pallardy } 1399d7c51706SLoic Pallardy 14001efa30d0SSarangdhar Joshi ret = rproc_start(rproc, fw); 14011efa30d0SSarangdhar Joshi if (ret) 1402229b85a6SBjorn Andersson goto clean_up_resources; 1403400e64dfSOhad Ben-Cohen 1404400e64dfSOhad Ben-Cohen return 0; 1405400e64dfSOhad Ben-Cohen 1406229b85a6SBjorn Andersson clean_up_resources: 1407229b85a6SBjorn Andersson rproc_resource_cleanup(rproc); 1408a0c10687SBjorn Andersson kfree(rproc->cached_table); 1409a0c10687SBjorn Andersson rproc->cached_table = NULL; 1410988d204cSBjorn Andersson rproc->table_ptr = NULL; 141158b64090SBjorn Andersson disable_iommu: 1412400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 1413400e64dfSOhad Ben-Cohen return ret; 1414400e64dfSOhad Ben-Cohen } 1415400e64dfSOhad Ben-Cohen 1416400e64dfSOhad Ben-Cohen /* 14175e6533f7SSarangdhar Joshi * take a firmware and boot it up. 1418400e64dfSOhad Ben-Cohen * 1419400e64dfSOhad Ben-Cohen * Note: this function is called asynchronously upon registration of the 1420400e64dfSOhad Ben-Cohen * remote processor (so we must wait until it completes before we try 1421400e64dfSOhad Ben-Cohen * to unregister the device. one other option is just to use kref here, 1422400e64dfSOhad Ben-Cohen * that might be cleaner). 1423400e64dfSOhad Ben-Cohen */ 14245e6533f7SSarangdhar Joshi static void rproc_auto_boot_callback(const struct firmware *fw, void *context) 1425400e64dfSOhad Ben-Cohen { 1426400e64dfSOhad Ben-Cohen struct rproc *rproc = context; 1427a2b950acSOhad Ben-Cohen 14282bfc311aSBjorn Andersson rproc_boot(rproc); 1429ddf71187SBjorn Andersson 1430400e64dfSOhad Ben-Cohen release_firmware(fw); 1431400e64dfSOhad Ben-Cohen } 1432400e64dfSOhad Ben-Cohen 14335e6533f7SSarangdhar Joshi static int rproc_trigger_auto_boot(struct rproc *rproc) 143470b85ef8SFernando Guzman Lugo { 143570b85ef8SFernando Guzman Lugo int ret; 143670b85ef8SFernando Guzman Lugo 143770b85ef8SFernando Guzman Lugo /* 143870b85ef8SFernando Guzman Lugo * We're initiating an asynchronous firmware loading, so we can 143970b85ef8SFernando Guzman Lugo * be built-in kernel code, without hanging the boot process. 144070b85ef8SFernando Guzman Lugo */ 144170b85ef8SFernando Guzman Lugo ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG, 144270b85ef8SFernando Guzman Lugo rproc->firmware, &rproc->dev, GFP_KERNEL, 14435e6533f7SSarangdhar Joshi rproc, rproc_auto_boot_callback); 14442099c77dSSarangdhar Joshi if (ret < 0) 144570b85ef8SFernando Guzman Lugo dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret); 144670b85ef8SFernando Guzman Lugo 144770b85ef8SFernando Guzman Lugo return ret; 144870b85ef8SFernando Guzman Lugo } 144970b85ef8SFernando Guzman Lugo 1450880f5b38SBjorn Andersson static int rproc_stop(struct rproc *rproc, bool crashed) 14511efa30d0SSarangdhar Joshi { 14521efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 14531efa30d0SSarangdhar Joshi int ret; 14541efa30d0SSarangdhar Joshi 1455618fcff3SBjorn Andersson /* Stop any subdevices for the remote processor */ 1456618fcff3SBjorn Andersson rproc_stop_subdevices(rproc, crashed); 14571efa30d0SSarangdhar Joshi 14580a8b81cbSBjorn Andersson /* the installed resource table is no longer accessible */ 14590a8b81cbSBjorn Andersson rproc->table_ptr = rproc->cached_table; 14600a8b81cbSBjorn Andersson 14611efa30d0SSarangdhar Joshi /* power off the remote processor */ 14621efa30d0SSarangdhar Joshi ret = rproc->ops->stop(rproc); 14631efa30d0SSarangdhar Joshi if (ret) { 14641efa30d0SSarangdhar Joshi dev_err(dev, "can't stop rproc: %d\n", ret); 14651efa30d0SSarangdhar Joshi return ret; 14661efa30d0SSarangdhar Joshi } 14671efa30d0SSarangdhar Joshi 1468c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1469c455daa4SBjorn Andersson 14701efa30d0SSarangdhar Joshi rproc->state = RPROC_OFFLINE; 14711efa30d0SSarangdhar Joshi 14721efa30d0SSarangdhar Joshi dev_info(dev, "stopped remote processor %s\n", rproc->name); 14731efa30d0SSarangdhar Joshi 14741efa30d0SSarangdhar Joshi return 0; 14751efa30d0SSarangdhar Joshi } 14761efa30d0SSarangdhar Joshi 147770b85ef8SFernando Guzman Lugo /** 14782666ca91SSarangdhar Joshi * rproc_coredump_add_segment() - add segment of device memory to coredump 14792666ca91SSarangdhar Joshi * @rproc: handle of a remote processor 14802666ca91SSarangdhar Joshi * @da: device address 14812666ca91SSarangdhar Joshi * @size: size of segment 14822666ca91SSarangdhar Joshi * 14832666ca91SSarangdhar Joshi * Add device memory to the list of segments to be included in a coredump for 14842666ca91SSarangdhar Joshi * the remoteproc. 14852666ca91SSarangdhar Joshi * 14862666ca91SSarangdhar Joshi * Return: 0 on success, negative errno on error. 14872666ca91SSarangdhar Joshi */ 14882666ca91SSarangdhar Joshi int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size) 14892666ca91SSarangdhar Joshi { 14902666ca91SSarangdhar Joshi struct rproc_dump_segment *segment; 14912666ca91SSarangdhar Joshi 14922666ca91SSarangdhar Joshi segment = kzalloc(sizeof(*segment), GFP_KERNEL); 14932666ca91SSarangdhar Joshi if (!segment) 14942666ca91SSarangdhar Joshi return -ENOMEM; 14952666ca91SSarangdhar Joshi 14962666ca91SSarangdhar Joshi segment->da = da; 14972666ca91SSarangdhar Joshi segment->size = size; 14982666ca91SSarangdhar Joshi 14992666ca91SSarangdhar Joshi list_add_tail(&segment->node, &rproc->dump_segments); 15002666ca91SSarangdhar Joshi 15012666ca91SSarangdhar Joshi return 0; 15022666ca91SSarangdhar Joshi } 15032666ca91SSarangdhar Joshi EXPORT_SYMBOL(rproc_coredump_add_segment); 15042666ca91SSarangdhar Joshi 15052666ca91SSarangdhar Joshi /** 1506ab8f873bSSibi Sankar * rproc_coredump_add_custom_segment() - add custom coredump segment 1507ab8f873bSSibi Sankar * @rproc: handle of a remote processor 1508ab8f873bSSibi Sankar * @da: device address 1509ab8f873bSSibi Sankar * @size: size of segment 1510ab8f873bSSibi Sankar * @dumpfn: custom dump function called for each segment during coredump 1511ab8f873bSSibi Sankar * @priv: private data 1512ab8f873bSSibi Sankar * 1513ab8f873bSSibi Sankar * Add device memory to the list of segments to be included in the coredump 1514ab8f873bSSibi Sankar * and associate the segment with the given custom dump function and private 1515ab8f873bSSibi Sankar * data. 1516ab8f873bSSibi Sankar * 1517ab8f873bSSibi Sankar * Return: 0 on success, negative errno on error. 1518ab8f873bSSibi Sankar */ 1519ab8f873bSSibi Sankar int rproc_coredump_add_custom_segment(struct rproc *rproc, 1520ab8f873bSSibi Sankar dma_addr_t da, size_t size, 1521ab8f873bSSibi Sankar void (*dumpfn)(struct rproc *rproc, 1522ab8f873bSSibi Sankar struct rproc_dump_segment *segment, 1523ab8f873bSSibi Sankar void *dest), 1524ab8f873bSSibi Sankar void *priv) 1525ab8f873bSSibi Sankar { 1526ab8f873bSSibi Sankar struct rproc_dump_segment *segment; 1527ab8f873bSSibi Sankar 1528ab8f873bSSibi Sankar segment = kzalloc(sizeof(*segment), GFP_KERNEL); 1529ab8f873bSSibi Sankar if (!segment) 1530ab8f873bSSibi Sankar return -ENOMEM; 1531ab8f873bSSibi Sankar 1532ab8f873bSSibi Sankar segment->da = da; 1533ab8f873bSSibi Sankar segment->size = size; 1534ab8f873bSSibi Sankar segment->priv = priv; 1535ab8f873bSSibi Sankar segment->dump = dumpfn; 1536ab8f873bSSibi Sankar 1537ab8f873bSSibi Sankar list_add_tail(&segment->node, &rproc->dump_segments); 1538ab8f873bSSibi Sankar 1539ab8f873bSSibi Sankar return 0; 1540ab8f873bSSibi Sankar } 1541ab8f873bSSibi Sankar EXPORT_SYMBOL(rproc_coredump_add_custom_segment); 1542ab8f873bSSibi Sankar 1543ab8f873bSSibi Sankar /** 15442666ca91SSarangdhar Joshi * rproc_coredump() - perform coredump 15452666ca91SSarangdhar Joshi * @rproc: rproc handle 15462666ca91SSarangdhar Joshi * 15472666ca91SSarangdhar Joshi * This function will generate an ELF header for the registered segments 15482666ca91SSarangdhar Joshi * and create a devcoredump device associated with rproc. 15492666ca91SSarangdhar Joshi */ 15502666ca91SSarangdhar Joshi static void rproc_coredump(struct rproc *rproc) 15512666ca91SSarangdhar Joshi { 15522666ca91SSarangdhar Joshi struct rproc_dump_segment *segment; 15532666ca91SSarangdhar Joshi struct elf32_phdr *phdr; 15542666ca91SSarangdhar Joshi struct elf32_hdr *ehdr; 15552666ca91SSarangdhar Joshi size_t data_size; 15562666ca91SSarangdhar Joshi size_t offset; 15572666ca91SSarangdhar Joshi void *data; 15582666ca91SSarangdhar Joshi void *ptr; 15592666ca91SSarangdhar Joshi int phnum = 0; 15602666ca91SSarangdhar Joshi 15612666ca91SSarangdhar Joshi if (list_empty(&rproc->dump_segments)) 15622666ca91SSarangdhar Joshi return; 15632666ca91SSarangdhar Joshi 15642666ca91SSarangdhar Joshi data_size = sizeof(*ehdr); 15652666ca91SSarangdhar Joshi list_for_each_entry(segment, &rproc->dump_segments, node) { 15662666ca91SSarangdhar Joshi data_size += sizeof(*phdr) + segment->size; 15672666ca91SSarangdhar Joshi 15682666ca91SSarangdhar Joshi phnum++; 15692666ca91SSarangdhar Joshi } 15702666ca91SSarangdhar Joshi 15712666ca91SSarangdhar Joshi data = vmalloc(data_size); 15722666ca91SSarangdhar Joshi if (!data) 15732666ca91SSarangdhar Joshi return; 15742666ca91SSarangdhar Joshi 15752666ca91SSarangdhar Joshi ehdr = data; 15762666ca91SSarangdhar Joshi 15772666ca91SSarangdhar Joshi memset(ehdr, 0, sizeof(*ehdr)); 15782666ca91SSarangdhar Joshi memcpy(ehdr->e_ident, ELFMAG, SELFMAG); 15792666ca91SSarangdhar Joshi ehdr->e_ident[EI_CLASS] = ELFCLASS32; 15802666ca91SSarangdhar Joshi ehdr->e_ident[EI_DATA] = ELFDATA2LSB; 15812666ca91SSarangdhar Joshi ehdr->e_ident[EI_VERSION] = EV_CURRENT; 15822666ca91SSarangdhar Joshi ehdr->e_ident[EI_OSABI] = ELFOSABI_NONE; 15832666ca91SSarangdhar Joshi ehdr->e_type = ET_CORE; 15842666ca91SSarangdhar Joshi ehdr->e_machine = EM_NONE; 15852666ca91SSarangdhar Joshi ehdr->e_version = EV_CURRENT; 15862666ca91SSarangdhar Joshi ehdr->e_entry = rproc->bootaddr; 15872666ca91SSarangdhar Joshi ehdr->e_phoff = sizeof(*ehdr); 15882666ca91SSarangdhar Joshi ehdr->e_ehsize = sizeof(*ehdr); 15892666ca91SSarangdhar Joshi ehdr->e_phentsize = sizeof(*phdr); 15902666ca91SSarangdhar Joshi ehdr->e_phnum = phnum; 15912666ca91SSarangdhar Joshi 15922666ca91SSarangdhar Joshi phdr = data + ehdr->e_phoff; 15932666ca91SSarangdhar Joshi offset = ehdr->e_phoff + sizeof(*phdr) * ehdr->e_phnum; 15942666ca91SSarangdhar Joshi list_for_each_entry(segment, &rproc->dump_segments, node) { 15952666ca91SSarangdhar Joshi memset(phdr, 0, sizeof(*phdr)); 15962666ca91SSarangdhar Joshi phdr->p_type = PT_LOAD; 15972666ca91SSarangdhar Joshi phdr->p_offset = offset; 15982666ca91SSarangdhar Joshi phdr->p_vaddr = segment->da; 15992666ca91SSarangdhar Joshi phdr->p_paddr = segment->da; 16002666ca91SSarangdhar Joshi phdr->p_filesz = segment->size; 16012666ca91SSarangdhar Joshi phdr->p_memsz = segment->size; 16022666ca91SSarangdhar Joshi phdr->p_flags = PF_R | PF_W | PF_X; 16032666ca91SSarangdhar Joshi phdr->p_align = 0; 16042666ca91SSarangdhar Joshi 16053952105dSSibi Sankar if (segment->dump) { 16063952105dSSibi Sankar segment->dump(rproc, segment, data + offset); 16073952105dSSibi Sankar } else { 16082666ca91SSarangdhar Joshi ptr = rproc_da_to_va(rproc, segment->da, segment->size); 16092666ca91SSarangdhar Joshi if (!ptr) { 16102666ca91SSarangdhar Joshi dev_err(&rproc->dev, 16112666ca91SSarangdhar Joshi "invalid coredump segment (%pad, %zu)\n", 16122666ca91SSarangdhar Joshi &segment->da, segment->size); 16132666ca91SSarangdhar Joshi memset(data + offset, 0xff, segment->size); 16142666ca91SSarangdhar Joshi } else { 16152666ca91SSarangdhar Joshi memcpy(data + offset, ptr, segment->size); 16162666ca91SSarangdhar Joshi } 16173952105dSSibi Sankar } 16182666ca91SSarangdhar Joshi 16192666ca91SSarangdhar Joshi offset += phdr->p_filesz; 16202666ca91SSarangdhar Joshi phdr++; 16212666ca91SSarangdhar Joshi } 16222666ca91SSarangdhar Joshi 16232666ca91SSarangdhar Joshi dev_coredumpv(&rproc->dev, data, data_size, GFP_KERNEL); 16242666ca91SSarangdhar Joshi } 16252666ca91SSarangdhar Joshi 16262666ca91SSarangdhar Joshi /** 162770b85ef8SFernando Guzman Lugo * rproc_trigger_recovery() - recover a remoteproc 162870b85ef8SFernando Guzman Lugo * @rproc: the remote processor 162970b85ef8SFernando Guzman Lugo * 163056324d7aSAnna, Suman * The recovery is done by resetting all the virtio devices, that way all the 163170b85ef8SFernando Guzman Lugo * rpmsg drivers will be reseted along with the remote processor making the 163270b85ef8SFernando Guzman Lugo * remoteproc functional again. 163370b85ef8SFernando Guzman Lugo * 163470b85ef8SFernando Guzman Lugo * This function can sleep, so it cannot be called from atomic context. 163570b85ef8SFernando Guzman Lugo */ 163670b85ef8SFernando Guzman Lugo int rproc_trigger_recovery(struct rproc *rproc) 163770b85ef8SFernando Guzman Lugo { 16387e83cab8SSarangdhar Joshi const struct firmware *firmware_p; 16397e83cab8SSarangdhar Joshi struct device *dev = &rproc->dev; 16407e83cab8SSarangdhar Joshi int ret; 16417e83cab8SSarangdhar Joshi 16427e83cab8SSarangdhar Joshi dev_err(dev, "recovering %s\n", rproc->name); 164370b85ef8SFernando Guzman Lugo 16447e83cab8SSarangdhar Joshi ret = mutex_lock_interruptible(&rproc->lock); 16457e83cab8SSarangdhar Joshi if (ret) 16467e83cab8SSarangdhar Joshi return ret; 16477e83cab8SSarangdhar Joshi 1648fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, true); 16497e83cab8SSarangdhar Joshi if (ret) 16507e83cab8SSarangdhar Joshi goto unlock_mutex; 1651ddf71187SBjorn Andersson 16522666ca91SSarangdhar Joshi /* generate coredump */ 16532666ca91SSarangdhar Joshi rproc_coredump(rproc); 16542666ca91SSarangdhar Joshi 16557e83cab8SSarangdhar Joshi /* load firmware */ 16567e83cab8SSarangdhar Joshi ret = request_firmware(&firmware_p, rproc->firmware, dev); 16577e83cab8SSarangdhar Joshi if (ret < 0) { 16587e83cab8SSarangdhar Joshi dev_err(dev, "request_firmware failed: %d\n", ret); 16597e83cab8SSarangdhar Joshi goto unlock_mutex; 16607e83cab8SSarangdhar Joshi } 1661ddf71187SBjorn Andersson 16627e83cab8SSarangdhar Joshi /* boot the remote processor up again */ 16637e83cab8SSarangdhar Joshi ret = rproc_start(rproc, firmware_p); 16647e83cab8SSarangdhar Joshi 16657e83cab8SSarangdhar Joshi release_firmware(firmware_p); 16667e83cab8SSarangdhar Joshi 16677e83cab8SSarangdhar Joshi unlock_mutex: 16687e83cab8SSarangdhar Joshi mutex_unlock(&rproc->lock); 16697e83cab8SSarangdhar Joshi return ret; 167070b85ef8SFernando Guzman Lugo } 167170b85ef8SFernando Guzman Lugo 1672400e64dfSOhad Ben-Cohen /** 16738afd519cSFernando Guzman Lugo * rproc_crash_handler_work() - handle a crash 16748afd519cSFernando Guzman Lugo * 16758afd519cSFernando Guzman Lugo * This function needs to handle everything related to a crash, like cpu 16768afd519cSFernando Guzman Lugo * registers and stack dump, information to help to debug the fatal error, etc. 16778afd519cSFernando Guzman Lugo */ 16788afd519cSFernando Guzman Lugo static void rproc_crash_handler_work(struct work_struct *work) 16798afd519cSFernando Guzman Lugo { 16808afd519cSFernando Guzman Lugo struct rproc *rproc = container_of(work, struct rproc, crash_handler); 16818afd519cSFernando Guzman Lugo struct device *dev = &rproc->dev; 16828afd519cSFernando Guzman Lugo 16838afd519cSFernando Guzman Lugo dev_dbg(dev, "enter %s\n", __func__); 16848afd519cSFernando Guzman Lugo 16858afd519cSFernando Guzman Lugo mutex_lock(&rproc->lock); 16868afd519cSFernando Guzman Lugo 16878afd519cSFernando Guzman Lugo if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) { 16888afd519cSFernando Guzman Lugo /* handle only the first crash detected */ 16898afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 16908afd519cSFernando Guzman Lugo return; 16918afd519cSFernando Guzman Lugo } 16928afd519cSFernando Guzman Lugo 16938afd519cSFernando Guzman Lugo rproc->state = RPROC_CRASHED; 16948afd519cSFernando Guzman Lugo dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt, 16958afd519cSFernando Guzman Lugo rproc->name); 16968afd519cSFernando Guzman Lugo 16978afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 16988afd519cSFernando Guzman Lugo 16992e37abb8SFernando Guzman Lugo if (!rproc->recovery_disabled) 170070b85ef8SFernando Guzman Lugo rproc_trigger_recovery(rproc); 17018afd519cSFernando Guzman Lugo } 17028afd519cSFernando Guzman Lugo 17038afd519cSFernando Guzman Lugo /** 17041b0ef906SSuman Anna * rproc_boot() - boot a remote processor 1705400e64dfSOhad Ben-Cohen * @rproc: handle of a remote processor 1706400e64dfSOhad Ben-Cohen * 1707400e64dfSOhad Ben-Cohen * Boot a remote processor (i.e. load its firmware, power it on, ...). 1708400e64dfSOhad Ben-Cohen * 1709400e64dfSOhad Ben-Cohen * If the remote processor is already powered on, this function immediately 1710400e64dfSOhad Ben-Cohen * returns (successfully). 1711400e64dfSOhad Ben-Cohen * 1712400e64dfSOhad Ben-Cohen * Returns 0 on success, and an appropriate error value otherwise. 1713400e64dfSOhad Ben-Cohen */ 17141b0ef906SSuman Anna int rproc_boot(struct rproc *rproc) 1715400e64dfSOhad Ben-Cohen { 1716400e64dfSOhad Ben-Cohen const struct firmware *firmware_p; 1717400e64dfSOhad Ben-Cohen struct device *dev; 1718400e64dfSOhad Ben-Cohen int ret; 1719400e64dfSOhad Ben-Cohen 1720400e64dfSOhad Ben-Cohen if (!rproc) { 1721400e64dfSOhad Ben-Cohen pr_err("invalid rproc handle\n"); 1722400e64dfSOhad Ben-Cohen return -EINVAL; 1723400e64dfSOhad Ben-Cohen } 1724400e64dfSOhad Ben-Cohen 1725b5ab5e24SOhad Ben-Cohen dev = &rproc->dev; 1726400e64dfSOhad Ben-Cohen 1727400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1728400e64dfSOhad Ben-Cohen if (ret) { 1729400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1730400e64dfSOhad Ben-Cohen return ret; 1731400e64dfSOhad Ben-Cohen } 1732400e64dfSOhad Ben-Cohen 17332099c77dSSarangdhar Joshi if (rproc->state == RPROC_DELETED) { 17342099c77dSSarangdhar Joshi ret = -ENODEV; 17352099c77dSSarangdhar Joshi dev_err(dev, "can't boot deleted rproc %s\n", rproc->name); 17362099c77dSSarangdhar Joshi goto unlock_mutex; 17372099c77dSSarangdhar Joshi } 17382099c77dSSarangdhar Joshi 1739400e64dfSOhad Ben-Cohen /* skip the boot process if rproc is already powered up */ 1740400e64dfSOhad Ben-Cohen if (atomic_inc_return(&rproc->power) > 1) { 1741400e64dfSOhad Ben-Cohen ret = 0; 1742400e64dfSOhad Ben-Cohen goto unlock_mutex; 1743400e64dfSOhad Ben-Cohen } 1744400e64dfSOhad Ben-Cohen 1745400e64dfSOhad Ben-Cohen dev_info(dev, "powering up %s\n", rproc->name); 1746400e64dfSOhad Ben-Cohen 1747400e64dfSOhad Ben-Cohen /* load firmware */ 1748400e64dfSOhad Ben-Cohen ret = request_firmware(&firmware_p, rproc->firmware, dev); 1749400e64dfSOhad Ben-Cohen if (ret < 0) { 1750400e64dfSOhad Ben-Cohen dev_err(dev, "request_firmware failed: %d\n", ret); 1751400e64dfSOhad Ben-Cohen goto downref_rproc; 1752400e64dfSOhad Ben-Cohen } 1753400e64dfSOhad Ben-Cohen 1754400e64dfSOhad Ben-Cohen ret = rproc_fw_boot(rproc, firmware_p); 1755400e64dfSOhad Ben-Cohen 1756400e64dfSOhad Ben-Cohen release_firmware(firmware_p); 1757400e64dfSOhad Ben-Cohen 1758400e64dfSOhad Ben-Cohen downref_rproc: 1759fbb6aacbSBjorn Andersson if (ret) 1760400e64dfSOhad Ben-Cohen atomic_dec(&rproc->power); 1761400e64dfSOhad Ben-Cohen unlock_mutex: 1762400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 1763400e64dfSOhad Ben-Cohen return ret; 1764400e64dfSOhad Ben-Cohen } 1765400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_boot); 1766400e64dfSOhad Ben-Cohen 1767400e64dfSOhad Ben-Cohen /** 1768400e64dfSOhad Ben-Cohen * rproc_shutdown() - power off the remote processor 1769400e64dfSOhad Ben-Cohen * @rproc: the remote processor 1770400e64dfSOhad Ben-Cohen * 1771400e64dfSOhad Ben-Cohen * Power off a remote processor (previously booted with rproc_boot()). 1772400e64dfSOhad Ben-Cohen * 1773400e64dfSOhad Ben-Cohen * In case @rproc is still being used by an additional user(s), then 1774400e64dfSOhad Ben-Cohen * this function will just decrement the power refcount and exit, 1775400e64dfSOhad Ben-Cohen * without really powering off the device. 1776400e64dfSOhad Ben-Cohen * 1777400e64dfSOhad Ben-Cohen * Every call to rproc_boot() must (eventually) be accompanied by a call 1778400e64dfSOhad Ben-Cohen * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug. 1779400e64dfSOhad Ben-Cohen * 1780400e64dfSOhad Ben-Cohen * Notes: 1781400e64dfSOhad Ben-Cohen * - we're not decrementing the rproc's refcount, only the power refcount. 1782400e64dfSOhad Ben-Cohen * which means that the @rproc handle stays valid even after rproc_shutdown() 1783400e64dfSOhad Ben-Cohen * returns, and users can still use it with a subsequent rproc_boot(), if 1784400e64dfSOhad Ben-Cohen * needed. 1785400e64dfSOhad Ben-Cohen */ 1786400e64dfSOhad Ben-Cohen void rproc_shutdown(struct rproc *rproc) 1787400e64dfSOhad Ben-Cohen { 1788b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1789400e64dfSOhad Ben-Cohen int ret; 1790400e64dfSOhad Ben-Cohen 1791400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1792400e64dfSOhad Ben-Cohen if (ret) { 1793400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1794400e64dfSOhad Ben-Cohen return; 1795400e64dfSOhad Ben-Cohen } 1796400e64dfSOhad Ben-Cohen 1797400e64dfSOhad Ben-Cohen /* if the remote proc is still needed, bail out */ 1798400e64dfSOhad Ben-Cohen if (!atomic_dec_and_test(&rproc->power)) 1799400e64dfSOhad Ben-Cohen goto out; 1800400e64dfSOhad Ben-Cohen 1801fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, false); 1802400e64dfSOhad Ben-Cohen if (ret) { 1803400e64dfSOhad Ben-Cohen atomic_inc(&rproc->power); 1804400e64dfSOhad Ben-Cohen goto out; 1805400e64dfSOhad Ben-Cohen } 1806400e64dfSOhad Ben-Cohen 1807400e64dfSOhad Ben-Cohen /* clean up all acquired resources */ 1808400e64dfSOhad Ben-Cohen rproc_resource_cleanup(rproc); 1809400e64dfSOhad Ben-Cohen 1810400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 1811400e64dfSOhad Ben-Cohen 1812988d204cSBjorn Andersson /* Free the copy of the resource table */ 1813a0c10687SBjorn Andersson kfree(rproc->cached_table); 1814a0c10687SBjorn Andersson rproc->cached_table = NULL; 1815988d204cSBjorn Andersson rproc->table_ptr = NULL; 1816400e64dfSOhad Ben-Cohen out: 1817400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 1818400e64dfSOhad Ben-Cohen } 1819400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_shutdown); 1820400e64dfSOhad Ben-Cohen 1821400e64dfSOhad Ben-Cohen /** 1822fec47d86SDave Gerlach * rproc_get_by_phandle() - find a remote processor by phandle 1823fec47d86SDave Gerlach * @phandle: phandle to the rproc 1824fec47d86SDave Gerlach * 1825fec47d86SDave Gerlach * Finds an rproc handle using the remote processor's phandle, and then 1826fec47d86SDave Gerlach * return a handle to the rproc. 1827fec47d86SDave Gerlach * 1828fec47d86SDave Gerlach * This function increments the remote processor's refcount, so always 1829fec47d86SDave Gerlach * use rproc_put() to decrement it back once rproc isn't needed anymore. 1830fec47d86SDave Gerlach * 1831fec47d86SDave Gerlach * Returns the rproc handle on success, and NULL on failure. 1832fec47d86SDave Gerlach */ 18338de3dbd0SOhad Ben-Cohen #ifdef CONFIG_OF 1834fec47d86SDave Gerlach struct rproc *rproc_get_by_phandle(phandle phandle) 1835fec47d86SDave Gerlach { 1836fec47d86SDave Gerlach struct rproc *rproc = NULL, *r; 1837fec47d86SDave Gerlach struct device_node *np; 1838fec47d86SDave Gerlach 1839fec47d86SDave Gerlach np = of_find_node_by_phandle(phandle); 1840fec47d86SDave Gerlach if (!np) 1841fec47d86SDave Gerlach return NULL; 1842fec47d86SDave Gerlach 1843fec47d86SDave Gerlach mutex_lock(&rproc_list_mutex); 1844fec47d86SDave Gerlach list_for_each_entry(r, &rproc_list, node) { 1845fec47d86SDave Gerlach if (r->dev.parent && r->dev.parent->of_node == np) { 1846fbb6aacbSBjorn Andersson /* prevent underlying implementation from being removed */ 1847fbb6aacbSBjorn Andersson if (!try_module_get(r->dev.parent->driver->owner)) { 1848fbb6aacbSBjorn Andersson dev_err(&r->dev, "can't get owner\n"); 1849fbb6aacbSBjorn Andersson break; 1850fbb6aacbSBjorn Andersson } 1851fbb6aacbSBjorn Andersson 1852fec47d86SDave Gerlach rproc = r; 1853fec47d86SDave Gerlach get_device(&rproc->dev); 1854fec47d86SDave Gerlach break; 1855fec47d86SDave Gerlach } 1856fec47d86SDave Gerlach } 1857fec47d86SDave Gerlach mutex_unlock(&rproc_list_mutex); 1858fec47d86SDave Gerlach 1859fec47d86SDave Gerlach of_node_put(np); 1860fec47d86SDave Gerlach 1861fec47d86SDave Gerlach return rproc; 1862fec47d86SDave Gerlach } 18638de3dbd0SOhad Ben-Cohen #else 18648de3dbd0SOhad Ben-Cohen struct rproc *rproc_get_by_phandle(phandle phandle) 18658de3dbd0SOhad Ben-Cohen { 18668de3dbd0SOhad Ben-Cohen return NULL; 18678de3dbd0SOhad Ben-Cohen } 18688de3dbd0SOhad Ben-Cohen #endif 1869fec47d86SDave Gerlach EXPORT_SYMBOL(rproc_get_by_phandle); 1870fec47d86SDave Gerlach 1871fec47d86SDave Gerlach /** 1872160e7c84SOhad Ben-Cohen * rproc_add() - register a remote processor 1873400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle to register 1874400e64dfSOhad Ben-Cohen * 1875400e64dfSOhad Ben-Cohen * Registers @rproc with the remoteproc framework, after it has been 1876400e64dfSOhad Ben-Cohen * allocated with rproc_alloc(). 1877400e64dfSOhad Ben-Cohen * 1878400e64dfSOhad Ben-Cohen * This is called by the platform-specific rproc implementation, whenever 1879400e64dfSOhad Ben-Cohen * a new remote processor device is probed. 1880400e64dfSOhad Ben-Cohen * 1881400e64dfSOhad Ben-Cohen * Returns 0 on success and an appropriate error code otherwise. 1882400e64dfSOhad Ben-Cohen * 1883400e64dfSOhad Ben-Cohen * Note: this function initiates an asynchronous firmware loading 1884400e64dfSOhad Ben-Cohen * context, which will look for virtio devices supported by the rproc's 1885400e64dfSOhad Ben-Cohen * firmware. 1886400e64dfSOhad Ben-Cohen * 1887400e64dfSOhad Ben-Cohen * If found, those virtio devices will be created and added, so as a result 18887a186941SOhad Ben-Cohen * of registering this remote processor, additional virtio drivers might be 1889400e64dfSOhad Ben-Cohen * probed. 1890400e64dfSOhad Ben-Cohen */ 1891160e7c84SOhad Ben-Cohen int rproc_add(struct rproc *rproc) 1892400e64dfSOhad Ben-Cohen { 1893b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 189470b85ef8SFernando Guzman Lugo int ret; 1895400e64dfSOhad Ben-Cohen 1896b5ab5e24SOhad Ben-Cohen ret = device_add(dev); 1897b5ab5e24SOhad Ben-Cohen if (ret < 0) 1898b5ab5e24SOhad Ben-Cohen return ret; 1899400e64dfSOhad Ben-Cohen 1900b5ab5e24SOhad Ben-Cohen dev_info(dev, "%s is available\n", rproc->name); 1901400e64dfSOhad Ben-Cohen 1902400e64dfSOhad Ben-Cohen /* create debugfs entries */ 1903400e64dfSOhad Ben-Cohen rproc_create_debug_dir(rproc); 19047a20c64dSSarangdhar Joshi 19057a20c64dSSarangdhar Joshi /* if rproc is marked always-on, request it to boot */ 19067a20c64dSSarangdhar Joshi if (rproc->auto_boot) { 19075e6533f7SSarangdhar Joshi ret = rproc_trigger_auto_boot(rproc); 1908d2e12e66SDave Gerlach if (ret < 0) 1909d2e12e66SDave Gerlach return ret; 19107a20c64dSSarangdhar Joshi } 1911400e64dfSOhad Ben-Cohen 1912d2e12e66SDave Gerlach /* expose to rproc_get_by_phandle users */ 1913d2e12e66SDave Gerlach mutex_lock(&rproc_list_mutex); 1914d2e12e66SDave Gerlach list_add(&rproc->node, &rproc_list); 1915d2e12e66SDave Gerlach mutex_unlock(&rproc_list_mutex); 1916d2e12e66SDave Gerlach 1917d2e12e66SDave Gerlach return 0; 1918400e64dfSOhad Ben-Cohen } 1919160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_add); 1920400e64dfSOhad Ben-Cohen 1921400e64dfSOhad Ben-Cohen /** 1922b5ab5e24SOhad Ben-Cohen * rproc_type_release() - release a remote processor instance 1923b5ab5e24SOhad Ben-Cohen * @dev: the rproc's device 1924b5ab5e24SOhad Ben-Cohen * 1925b5ab5e24SOhad Ben-Cohen * This function should _never_ be called directly. 1926b5ab5e24SOhad Ben-Cohen * 1927b5ab5e24SOhad Ben-Cohen * It will be called by the driver core when no one holds a valid pointer 1928b5ab5e24SOhad Ben-Cohen * to @dev anymore. 1929b5ab5e24SOhad Ben-Cohen */ 1930b5ab5e24SOhad Ben-Cohen static void rproc_type_release(struct device *dev) 1931b5ab5e24SOhad Ben-Cohen { 1932b5ab5e24SOhad Ben-Cohen struct rproc *rproc = container_of(dev, struct rproc, dev); 1933b5ab5e24SOhad Ben-Cohen 19347183a2a7SOhad Ben-Cohen dev_info(&rproc->dev, "releasing %s\n", rproc->name); 19357183a2a7SOhad Ben-Cohen 1936b5ab5e24SOhad Ben-Cohen idr_destroy(&rproc->notifyids); 1937b5ab5e24SOhad Ben-Cohen 1938b5ab5e24SOhad Ben-Cohen if (rproc->index >= 0) 1939b5ab5e24SOhad Ben-Cohen ida_simple_remove(&rproc_dev_index, rproc->index); 1940b5ab5e24SOhad Ben-Cohen 19410f57dc6aSMatt Redfearn kfree(rproc->firmware); 1942fb98e2bdSBjorn Andersson kfree(rproc->ops); 1943b5ab5e24SOhad Ben-Cohen kfree(rproc); 1944b5ab5e24SOhad Ben-Cohen } 1945b5ab5e24SOhad Ben-Cohen 1946c42ca04dSBhumika Goyal static const struct device_type rproc_type = { 1947b5ab5e24SOhad Ben-Cohen .name = "remoteproc", 1948b5ab5e24SOhad Ben-Cohen .release = rproc_type_release, 1949b5ab5e24SOhad Ben-Cohen }; 1950400e64dfSOhad Ben-Cohen 1951400e64dfSOhad Ben-Cohen /** 1952400e64dfSOhad Ben-Cohen * rproc_alloc() - allocate a remote processor handle 1953400e64dfSOhad Ben-Cohen * @dev: the underlying device 1954400e64dfSOhad Ben-Cohen * @name: name of this remote processor 1955400e64dfSOhad Ben-Cohen * @ops: platform-specific handlers (mainly start/stop) 19568b4aec9aSRobert Tivy * @firmware: name of firmware file to load, can be NULL 1957400e64dfSOhad Ben-Cohen * @len: length of private data needed by the rproc driver (in bytes) 1958400e64dfSOhad Ben-Cohen * 1959400e64dfSOhad Ben-Cohen * Allocates a new remote processor handle, but does not register 19608b4aec9aSRobert Tivy * it yet. if @firmware is NULL, a default name is used. 1961400e64dfSOhad Ben-Cohen * 1962400e64dfSOhad Ben-Cohen * This function should be used by rproc implementations during initialization 1963400e64dfSOhad Ben-Cohen * of the remote processor. 1964400e64dfSOhad Ben-Cohen * 1965400e64dfSOhad Ben-Cohen * After creating an rproc handle using this function, and when ready, 1966160e7c84SOhad Ben-Cohen * implementations should then call rproc_add() to complete 1967400e64dfSOhad Ben-Cohen * the registration of the remote processor. 1968400e64dfSOhad Ben-Cohen * 1969400e64dfSOhad Ben-Cohen * On success the new rproc is returned, and on failure, NULL. 1970400e64dfSOhad Ben-Cohen * 1971400e64dfSOhad Ben-Cohen * Note: _never_ directly deallocate @rproc, even if it was not registered 1972433c0e04SBjorn Andersson * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free(). 1973400e64dfSOhad Ben-Cohen */ 1974400e64dfSOhad Ben-Cohen struct rproc *rproc_alloc(struct device *dev, const char *name, 1975400e64dfSOhad Ben-Cohen const struct rproc_ops *ops, 1976400e64dfSOhad Ben-Cohen const char *firmware, int len) 1977400e64dfSOhad Ben-Cohen { 1978400e64dfSOhad Ben-Cohen struct rproc *rproc; 19798b4aec9aSRobert Tivy char *p, *template = "rproc-%s-fw"; 19800f57dc6aSMatt Redfearn int name_len; 1981400e64dfSOhad Ben-Cohen 1982400e64dfSOhad Ben-Cohen if (!dev || !name || !ops) 1983400e64dfSOhad Ben-Cohen return NULL; 1984400e64dfSOhad Ben-Cohen 19850f57dc6aSMatt Redfearn if (!firmware) { 19868b4aec9aSRobert Tivy /* 19878b4aec9aSRobert Tivy * If the caller didn't pass in a firmware name then 19880f57dc6aSMatt Redfearn * construct a default name. 19898b4aec9aSRobert Tivy */ 19908b4aec9aSRobert Tivy name_len = strlen(name) + strlen(template) - 2 + 1; 19910f57dc6aSMatt Redfearn p = kmalloc(name_len, GFP_KERNEL); 19920f57dc6aSMatt Redfearn if (!p) 1993400e64dfSOhad Ben-Cohen return NULL; 19948b4aec9aSRobert Tivy snprintf(p, name_len, template, name); 19958b4aec9aSRobert Tivy } else { 19960f57dc6aSMatt Redfearn p = kstrdup(firmware, GFP_KERNEL); 19970f57dc6aSMatt Redfearn if (!p) 19980f57dc6aSMatt Redfearn return NULL; 19990f57dc6aSMatt Redfearn } 20000f57dc6aSMatt Redfearn 20010f57dc6aSMatt Redfearn rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL); 20020f57dc6aSMatt Redfearn if (!rproc) { 20030f57dc6aSMatt Redfearn kfree(p); 20040f57dc6aSMatt Redfearn return NULL; 20058b4aec9aSRobert Tivy } 20068b4aec9aSRobert Tivy 2007fb98e2bdSBjorn Andersson rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL); 2008fb98e2bdSBjorn Andersson if (!rproc->ops) { 2009fb98e2bdSBjorn Andersson kfree(p); 2010fb98e2bdSBjorn Andersson kfree(rproc); 2011fb98e2bdSBjorn Andersson return NULL; 2012fb98e2bdSBjorn Andersson } 2013fb98e2bdSBjorn Andersson 20148b4aec9aSRobert Tivy rproc->firmware = p; 2015400e64dfSOhad Ben-Cohen rproc->name = name; 2016400e64dfSOhad Ben-Cohen rproc->priv = &rproc[1]; 2017ddf71187SBjorn Andersson rproc->auto_boot = true; 2018400e64dfSOhad Ben-Cohen 2019b5ab5e24SOhad Ben-Cohen device_initialize(&rproc->dev); 2020b5ab5e24SOhad Ben-Cohen rproc->dev.parent = dev; 2021b5ab5e24SOhad Ben-Cohen rproc->dev.type = &rproc_type; 20222aefbef0SMatt Redfearn rproc->dev.class = &rproc_class; 20237c89717fSBjorn Andersson rproc->dev.driver_data = rproc; 2024b5ab5e24SOhad Ben-Cohen 2025b5ab5e24SOhad Ben-Cohen /* Assign a unique device index and name */ 2026b5ab5e24SOhad Ben-Cohen rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL); 2027b5ab5e24SOhad Ben-Cohen if (rproc->index < 0) { 2028b5ab5e24SOhad Ben-Cohen dev_err(dev, "ida_simple_get failed: %d\n", rproc->index); 2029b5ab5e24SOhad Ben-Cohen put_device(&rproc->dev); 2030b5ab5e24SOhad Ben-Cohen return NULL; 2031b5ab5e24SOhad Ben-Cohen } 2032b5ab5e24SOhad Ben-Cohen 2033b5ab5e24SOhad Ben-Cohen dev_set_name(&rproc->dev, "remoteproc%d", rproc->index); 2034b5ab5e24SOhad Ben-Cohen 2035400e64dfSOhad Ben-Cohen atomic_set(&rproc->power, 0); 2036400e64dfSOhad Ben-Cohen 20370f21f9ccSBjorn Andersson /* Default to ELF loader if no load function is specified */ 20380f21f9ccSBjorn Andersson if (!rproc->ops->load) { 20390f21f9ccSBjorn Andersson rproc->ops->load = rproc_elf_load_segments; 2040c1d35c1aSBjorn Andersson rproc->ops->parse_fw = rproc_elf_load_rsc_table; 20410f21f9ccSBjorn Andersson rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table; 20420f21f9ccSBjorn Andersson rproc->ops->sanity_check = rproc_elf_sanity_check; 20430f21f9ccSBjorn Andersson rproc->ops->get_boot_addr = rproc_elf_get_boot_addr; 20440f21f9ccSBjorn Andersson } 2045400e64dfSOhad Ben-Cohen 2046400e64dfSOhad Ben-Cohen mutex_init(&rproc->lock); 2047400e64dfSOhad Ben-Cohen 20487a186941SOhad Ben-Cohen idr_init(&rproc->notifyids); 20497a186941SOhad Ben-Cohen 2050400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->carveouts); 2051400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->mappings); 2052400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->traces); 20537a186941SOhad Ben-Cohen INIT_LIST_HEAD(&rproc->rvdevs); 20547bdc9650SBjorn Andersson INIT_LIST_HEAD(&rproc->subdevs); 20552666ca91SSarangdhar Joshi INIT_LIST_HEAD(&rproc->dump_segments); 2056400e64dfSOhad Ben-Cohen 20578afd519cSFernando Guzman Lugo INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work); 20588afd519cSFernando Guzman Lugo 2059400e64dfSOhad Ben-Cohen rproc->state = RPROC_OFFLINE; 2060400e64dfSOhad Ben-Cohen 2061400e64dfSOhad Ben-Cohen return rproc; 2062400e64dfSOhad Ben-Cohen } 2063400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_alloc); 2064400e64dfSOhad Ben-Cohen 2065400e64dfSOhad Ben-Cohen /** 2066433c0e04SBjorn Andersson * rproc_free() - unroll rproc_alloc() 2067433c0e04SBjorn Andersson * @rproc: the remote processor handle 2068433c0e04SBjorn Andersson * 2069433c0e04SBjorn Andersson * This function decrements the rproc dev refcount. 2070433c0e04SBjorn Andersson * 2071433c0e04SBjorn Andersson * If no one holds any reference to rproc anymore, then its refcount would 2072433c0e04SBjorn Andersson * now drop to zero, and it would be freed. 2073433c0e04SBjorn Andersson */ 2074433c0e04SBjorn Andersson void rproc_free(struct rproc *rproc) 2075433c0e04SBjorn Andersson { 2076433c0e04SBjorn Andersson put_device(&rproc->dev); 2077433c0e04SBjorn Andersson } 2078433c0e04SBjorn Andersson EXPORT_SYMBOL(rproc_free); 2079433c0e04SBjorn Andersson 2080433c0e04SBjorn Andersson /** 2081433c0e04SBjorn Andersson * rproc_put() - release rproc reference 2082400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle 2083400e64dfSOhad Ben-Cohen * 2084c6b5a276SOhad Ben-Cohen * This function decrements the rproc dev refcount. 2085400e64dfSOhad Ben-Cohen * 2086c6b5a276SOhad Ben-Cohen * If no one holds any reference to rproc anymore, then its refcount would 2087c6b5a276SOhad Ben-Cohen * now drop to zero, and it would be freed. 2088400e64dfSOhad Ben-Cohen */ 2089160e7c84SOhad Ben-Cohen void rproc_put(struct rproc *rproc) 2090400e64dfSOhad Ben-Cohen { 2091fbb6aacbSBjorn Andersson module_put(rproc->dev.parent->driver->owner); 2092b5ab5e24SOhad Ben-Cohen put_device(&rproc->dev); 2093400e64dfSOhad Ben-Cohen } 2094160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_put); 2095400e64dfSOhad Ben-Cohen 2096400e64dfSOhad Ben-Cohen /** 2097160e7c84SOhad Ben-Cohen * rproc_del() - unregister a remote processor 2098400e64dfSOhad Ben-Cohen * @rproc: rproc handle to unregister 2099400e64dfSOhad Ben-Cohen * 2100400e64dfSOhad Ben-Cohen * This function should be called when the platform specific rproc 2101400e64dfSOhad Ben-Cohen * implementation decides to remove the rproc device. it should 2102160e7c84SOhad Ben-Cohen * _only_ be called if a previous invocation of rproc_add() 2103400e64dfSOhad Ben-Cohen * has completed successfully. 2104400e64dfSOhad Ben-Cohen * 2105160e7c84SOhad Ben-Cohen * After rproc_del() returns, @rproc isn't freed yet, because 2106c6b5a276SOhad Ben-Cohen * of the outstanding reference created by rproc_alloc. To decrement that 2107433c0e04SBjorn Andersson * one last refcount, one still needs to call rproc_free(). 2108400e64dfSOhad Ben-Cohen * 2109400e64dfSOhad Ben-Cohen * Returns 0 on success and -EINVAL if @rproc isn't valid. 2110400e64dfSOhad Ben-Cohen */ 2111160e7c84SOhad Ben-Cohen int rproc_del(struct rproc *rproc) 2112400e64dfSOhad Ben-Cohen { 2113400e64dfSOhad Ben-Cohen if (!rproc) 2114400e64dfSOhad Ben-Cohen return -EINVAL; 2115400e64dfSOhad Ben-Cohen 2116ddf71187SBjorn Andersson /* if rproc is marked always-on, rproc_add() booted it */ 2117ddf71187SBjorn Andersson /* TODO: make sure this works with rproc->power > 1 */ 2118ddf71187SBjorn Andersson if (rproc->auto_boot) 2119ddf71187SBjorn Andersson rproc_shutdown(rproc); 2120ddf71187SBjorn Andersson 21212099c77dSSarangdhar Joshi mutex_lock(&rproc->lock); 21222099c77dSSarangdhar Joshi rproc->state = RPROC_DELETED; 21232099c77dSSarangdhar Joshi mutex_unlock(&rproc->lock); 21242099c77dSSarangdhar Joshi 2125b003d45bSSarangdhar Joshi rproc_delete_debug_dir(rproc); 2126b003d45bSSarangdhar Joshi 2127fec47d86SDave Gerlach /* the rproc is downref'ed as soon as it's removed from the klist */ 2128fec47d86SDave Gerlach mutex_lock(&rproc_list_mutex); 2129fec47d86SDave Gerlach list_del(&rproc->node); 2130fec47d86SDave Gerlach mutex_unlock(&rproc_list_mutex); 2131fec47d86SDave Gerlach 2132b5ab5e24SOhad Ben-Cohen device_del(&rproc->dev); 2133400e64dfSOhad Ben-Cohen 2134400e64dfSOhad Ben-Cohen return 0; 2135400e64dfSOhad Ben-Cohen } 2136160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_del); 2137400e64dfSOhad Ben-Cohen 21388afd519cSFernando Guzman Lugo /** 21397bdc9650SBjorn Andersson * rproc_add_subdev() - add a subdevice to a remoteproc 21407bdc9650SBjorn Andersson * @rproc: rproc handle to add the subdevice to 21417bdc9650SBjorn Andersson * @subdev: subdev handle to register 21424902676fSBjorn Andersson * 21434902676fSBjorn Andersson * Caller is responsible for populating optional subdevice function pointers. 21447bdc9650SBjorn Andersson */ 21454902676fSBjorn Andersson void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 21467bdc9650SBjorn Andersson { 21477bdc9650SBjorn Andersson list_add_tail(&subdev->node, &rproc->subdevs); 21487bdc9650SBjorn Andersson } 21497bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_add_subdev); 21507bdc9650SBjorn Andersson 21517bdc9650SBjorn Andersson /** 21527bdc9650SBjorn Andersson * rproc_remove_subdev() - remove a subdevice from a remoteproc 21537bdc9650SBjorn Andersson * @rproc: rproc handle to remove the subdevice from 21547bdc9650SBjorn Andersson * @subdev: subdev handle, previously registered with rproc_add_subdev() 21557bdc9650SBjorn Andersson */ 21567bdc9650SBjorn Andersson void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 21577bdc9650SBjorn Andersson { 21587bdc9650SBjorn Andersson list_del(&subdev->node); 21597bdc9650SBjorn Andersson } 21607bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_remove_subdev); 21617bdc9650SBjorn Andersson 21627bdc9650SBjorn Andersson /** 21637c89717fSBjorn Andersson * rproc_get_by_child() - acquire rproc handle of @dev's ancestor 21647c89717fSBjorn Andersson * @dev: child device to find ancestor of 21657c89717fSBjorn Andersson * 21667c89717fSBjorn Andersson * Returns the ancestor rproc instance, or NULL if not found. 21677c89717fSBjorn Andersson */ 21687c89717fSBjorn Andersson struct rproc *rproc_get_by_child(struct device *dev) 21697c89717fSBjorn Andersson { 21707c89717fSBjorn Andersson for (dev = dev->parent; dev; dev = dev->parent) { 21717c89717fSBjorn Andersson if (dev->type == &rproc_type) 21727c89717fSBjorn Andersson return dev->driver_data; 21737c89717fSBjorn Andersson } 21747c89717fSBjorn Andersson 21757c89717fSBjorn Andersson return NULL; 21767c89717fSBjorn Andersson } 21777c89717fSBjorn Andersson EXPORT_SYMBOL(rproc_get_by_child); 21787c89717fSBjorn Andersson 21797c89717fSBjorn Andersson /** 21808afd519cSFernando Guzman Lugo * rproc_report_crash() - rproc crash reporter function 21818afd519cSFernando Guzman Lugo * @rproc: remote processor 21828afd519cSFernando Guzman Lugo * @type: crash type 21838afd519cSFernando Guzman Lugo * 21848afd519cSFernando Guzman Lugo * This function must be called every time a crash is detected by the low-level 21858afd519cSFernando Guzman Lugo * drivers implementing a specific remoteproc. This should not be called from a 21868afd519cSFernando Guzman Lugo * non-remoteproc driver. 21878afd519cSFernando Guzman Lugo * 21888afd519cSFernando Guzman Lugo * This function can be called from atomic/interrupt context. 21898afd519cSFernando Guzman Lugo */ 21908afd519cSFernando Guzman Lugo void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type) 21918afd519cSFernando Guzman Lugo { 21928afd519cSFernando Guzman Lugo if (!rproc) { 21938afd519cSFernando Guzman Lugo pr_err("NULL rproc pointer\n"); 21948afd519cSFernando Guzman Lugo return; 21958afd519cSFernando Guzman Lugo } 21968afd519cSFernando Guzman Lugo 21978afd519cSFernando Guzman Lugo dev_err(&rproc->dev, "crash detected in %s: type %s\n", 21988afd519cSFernando Guzman Lugo rproc->name, rproc_crash_to_string(type)); 21998afd519cSFernando Guzman Lugo 22008afd519cSFernando Guzman Lugo /* create a new task to handle the error */ 22018afd519cSFernando Guzman Lugo schedule_work(&rproc->crash_handler); 22028afd519cSFernando Guzman Lugo } 22038afd519cSFernando Guzman Lugo EXPORT_SYMBOL(rproc_report_crash); 22048afd519cSFernando Guzman Lugo 2205400e64dfSOhad Ben-Cohen static int __init remoteproc_init(void) 2206400e64dfSOhad Ben-Cohen { 22072aefbef0SMatt Redfearn rproc_init_sysfs(); 2208400e64dfSOhad Ben-Cohen rproc_init_debugfs(); 2209b5ab5e24SOhad Ben-Cohen 2210400e64dfSOhad Ben-Cohen return 0; 2211400e64dfSOhad Ben-Cohen } 2212400e64dfSOhad Ben-Cohen module_init(remoteproc_init); 2213400e64dfSOhad Ben-Cohen 2214400e64dfSOhad Ben-Cohen static void __exit remoteproc_exit(void) 2215400e64dfSOhad Ben-Cohen { 2216f42f79afSSuman Anna ida_destroy(&rproc_dev_index); 2217f42f79afSSuman Anna 2218400e64dfSOhad Ben-Cohen rproc_exit_debugfs(); 22192aefbef0SMatt Redfearn rproc_exit_sysfs(); 2220400e64dfSOhad Ben-Cohen } 2221400e64dfSOhad Ben-Cohen module_exit(remoteproc_exit); 2222400e64dfSOhad Ben-Cohen 2223400e64dfSOhad Ben-Cohen MODULE_LICENSE("GPL v2"); 2224400e64dfSOhad Ben-Cohen MODULE_DESCRIPTION("Generic Remote Processor Framework"); 2225