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 19dc5192c4SBjorn Andersson #include <linux/delay.h> 20400e64dfSOhad Ben-Cohen #include <linux/kernel.h> 21400e64dfSOhad Ben-Cohen #include <linux/module.h> 22400e64dfSOhad Ben-Cohen #include <linux/device.h> 23f39650deSAndy Shevchenko #include <linux/panic_notifier.h> 24400e64dfSOhad Ben-Cohen #include <linux/slab.h> 25400e64dfSOhad Ben-Cohen #include <linux/mutex.h> 26400e64dfSOhad Ben-Cohen #include <linux/dma-mapping.h> 27400e64dfSOhad Ben-Cohen #include <linux/firmware.h> 28400e64dfSOhad Ben-Cohen #include <linux/string.h> 29400e64dfSOhad Ben-Cohen #include <linux/debugfs.h> 30c0abe2caSBjorn Andersson #include <linux/rculist.h> 31400e64dfSOhad Ben-Cohen #include <linux/remoteproc.h> 32400e64dfSOhad Ben-Cohen #include <linux/iommu.h> 33b5ab5e24SOhad Ben-Cohen #include <linux/idr.h> 34400e64dfSOhad Ben-Cohen #include <linux/elf.h> 35a2b950acSOhad Ben-Cohen #include <linux/crc32.h> 36086d0872SLoic Pallardy #include <linux/of_reserved_mem.h> 37400e64dfSOhad Ben-Cohen #include <linux/virtio_ids.h> 38400e64dfSOhad Ben-Cohen #include <linux/virtio_ring.h> 39cf59d3e9SOhad Ben-Cohen #include <asm/byteorder.h> 40086d0872SLoic Pallardy #include <linux/platform_device.h> 41400e64dfSOhad Ben-Cohen 42400e64dfSOhad Ben-Cohen #include "remoteproc_internal.h" 43400e64dfSOhad Ben-Cohen 44b36de8cfSLoic Pallardy #define HIGH_BITS_MASK 0xFFFFFFFF00000000ULL 45b36de8cfSLoic Pallardy 46fec47d86SDave Gerlach static DEFINE_MUTEX(rproc_list_mutex); 47fec47d86SDave Gerlach static LIST_HEAD(rproc_list); 48dc5192c4SBjorn Andersson static struct notifier_block rproc_panic_nb; 49fec47d86SDave Gerlach 50a2b950acSOhad Ben-Cohen typedef int (*rproc_handle_resource_t)(struct rproc *rproc, 51a2b950acSOhad Ben-Cohen void *, int offset, int avail); 52400e64dfSOhad Ben-Cohen 53c6aed238SLoic Pallardy static int rproc_alloc_carveout(struct rproc *rproc, 54c6aed238SLoic Pallardy struct rproc_mem_entry *mem); 55c6aed238SLoic Pallardy static int rproc_release_carveout(struct rproc *rproc, 56c6aed238SLoic Pallardy struct rproc_mem_entry *mem); 57c6aed238SLoic Pallardy 58b5ab5e24SOhad Ben-Cohen /* Unique indices for remoteproc devices */ 59b5ab5e24SOhad Ben-Cohen static DEFINE_IDA(rproc_dev_index); 60cab8300bSMukesh Ojha static struct workqueue_struct *rproc_recovery_wq; 61b5ab5e24SOhad Ben-Cohen 628afd519cSFernando Guzman Lugo static const char * const rproc_crash_names[] = { 638afd519cSFernando Guzman Lugo [RPROC_MMUFAULT] = "mmufault", 64b3d39032SBjorn Andersson [RPROC_WATCHDOG] = "watchdog", 65b3d39032SBjorn Andersson [RPROC_FATAL_ERROR] = "fatal error", 668afd519cSFernando Guzman Lugo }; 678afd519cSFernando Guzman Lugo 688afd519cSFernando Guzman Lugo /* translate rproc_crash_type to string */ 698afd519cSFernando Guzman Lugo static const char *rproc_crash_to_string(enum rproc_crash_type type) 708afd519cSFernando Guzman Lugo { 718afd519cSFernando Guzman Lugo if (type < ARRAY_SIZE(rproc_crash_names)) 728afd519cSFernando Guzman Lugo return rproc_crash_names[type]; 73b23f7a09SMasanari Iida return "unknown"; 748afd519cSFernando Guzman Lugo } 758afd519cSFernando Guzman Lugo 76400e64dfSOhad Ben-Cohen /* 77400e64dfSOhad Ben-Cohen * This is the IOMMU fault handler we register with the IOMMU API 78400e64dfSOhad Ben-Cohen * (when relevant; not all remote processors access memory through 79400e64dfSOhad Ben-Cohen * an IOMMU). 80400e64dfSOhad Ben-Cohen * 81400e64dfSOhad Ben-Cohen * IOMMU core will invoke this handler whenever the remote processor 82400e64dfSOhad Ben-Cohen * will try to access an unmapped device address. 83400e64dfSOhad Ben-Cohen */ 84400e64dfSOhad Ben-Cohen static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev, 8577ca2332SOhad Ben-Cohen unsigned long iova, int flags, void *token) 86400e64dfSOhad Ben-Cohen { 878afd519cSFernando Guzman Lugo struct rproc *rproc = token; 888afd519cSFernando Guzman Lugo 89400e64dfSOhad Ben-Cohen dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags); 90400e64dfSOhad Ben-Cohen 918afd519cSFernando Guzman Lugo rproc_report_crash(rproc, RPROC_MMUFAULT); 928afd519cSFernando Guzman Lugo 93400e64dfSOhad Ben-Cohen /* 94400e64dfSOhad Ben-Cohen * Let the iommu core know we're not really handling this fault; 958afd519cSFernando Guzman Lugo * we just used it as a recovery trigger. 96400e64dfSOhad Ben-Cohen */ 97400e64dfSOhad Ben-Cohen return -ENOSYS; 98400e64dfSOhad Ben-Cohen } 99400e64dfSOhad Ben-Cohen 100400e64dfSOhad Ben-Cohen static int rproc_enable_iommu(struct rproc *rproc) 101400e64dfSOhad Ben-Cohen { 102400e64dfSOhad Ben-Cohen struct iommu_domain *domain; 103b5ab5e24SOhad Ben-Cohen struct device *dev = rproc->dev.parent; 104400e64dfSOhad Ben-Cohen int ret; 105400e64dfSOhad Ben-Cohen 106315491e5SSuman Anna if (!rproc->has_iommu) { 107315491e5SSuman Anna dev_dbg(dev, "iommu not present\n"); 1080798e1daSMark Grosen return 0; 109400e64dfSOhad Ben-Cohen } 110400e64dfSOhad Ben-Cohen 111400e64dfSOhad Ben-Cohen domain = iommu_domain_alloc(dev->bus); 112400e64dfSOhad Ben-Cohen if (!domain) { 113400e64dfSOhad Ben-Cohen dev_err(dev, "can't alloc iommu domain\n"); 114400e64dfSOhad Ben-Cohen return -ENOMEM; 115400e64dfSOhad Ben-Cohen } 116400e64dfSOhad Ben-Cohen 11777ca2332SOhad Ben-Cohen iommu_set_fault_handler(domain, rproc_iommu_fault, rproc); 118400e64dfSOhad Ben-Cohen 119400e64dfSOhad Ben-Cohen ret = iommu_attach_device(domain, dev); 120400e64dfSOhad Ben-Cohen if (ret) { 121400e64dfSOhad Ben-Cohen dev_err(dev, "can't attach iommu device: %d\n", ret); 122400e64dfSOhad Ben-Cohen goto free_domain; 123400e64dfSOhad Ben-Cohen } 124400e64dfSOhad Ben-Cohen 125400e64dfSOhad Ben-Cohen rproc->domain = domain; 126400e64dfSOhad Ben-Cohen 127400e64dfSOhad Ben-Cohen return 0; 128400e64dfSOhad Ben-Cohen 129400e64dfSOhad Ben-Cohen free_domain: 130400e64dfSOhad Ben-Cohen iommu_domain_free(domain); 131400e64dfSOhad Ben-Cohen return ret; 132400e64dfSOhad Ben-Cohen } 133400e64dfSOhad Ben-Cohen 134400e64dfSOhad Ben-Cohen static void rproc_disable_iommu(struct rproc *rproc) 135400e64dfSOhad Ben-Cohen { 136400e64dfSOhad Ben-Cohen struct iommu_domain *domain = rproc->domain; 137b5ab5e24SOhad Ben-Cohen struct device *dev = rproc->dev.parent; 138400e64dfSOhad Ben-Cohen 139400e64dfSOhad Ben-Cohen if (!domain) 140400e64dfSOhad Ben-Cohen return; 141400e64dfSOhad Ben-Cohen 142400e64dfSOhad Ben-Cohen iommu_detach_device(domain, dev); 143400e64dfSOhad Ben-Cohen iommu_domain_free(domain); 144400e64dfSOhad Ben-Cohen } 145400e64dfSOhad Ben-Cohen 146086d0872SLoic Pallardy phys_addr_t rproc_va_to_pa(void *cpu_addr) 147eb30596eSLoic Pallardy { 148eb30596eSLoic Pallardy /* 149eb30596eSLoic Pallardy * Return physical address according to virtual address location 150eb30596eSLoic Pallardy * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent 151eb30596eSLoic Pallardy * - in kernel: if region allocated in generic dma memory pool 152eb30596eSLoic Pallardy */ 153eb30596eSLoic Pallardy if (is_vmalloc_addr(cpu_addr)) { 154eb30596eSLoic Pallardy return page_to_phys(vmalloc_to_page(cpu_addr)) + 155eb30596eSLoic Pallardy offset_in_page(cpu_addr); 156eb30596eSLoic Pallardy } 157eb30596eSLoic Pallardy 158eb30596eSLoic Pallardy WARN_ON(!virt_addr_valid(cpu_addr)); 159eb30596eSLoic Pallardy return virt_to_phys(cpu_addr); 160eb30596eSLoic Pallardy } 161086d0872SLoic Pallardy EXPORT_SYMBOL(rproc_va_to_pa); 162eb30596eSLoic Pallardy 163a01f7cd6SSuman Anna /** 164a01f7cd6SSuman Anna * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address 165a01f7cd6SSuman Anna * @rproc: handle of a remote processor 166a01f7cd6SSuman Anna * @da: remoteproc device address to translate 167a01f7cd6SSuman Anna * @len: length of the memory region @da is pointing to 16895347e73SSuman Anna * @is_iomem: optional pointer filled in to indicate if @da is iomapped memory 169a01f7cd6SSuman Anna * 170400e64dfSOhad Ben-Cohen * Some remote processors will ask us to allocate them physically contiguous 171400e64dfSOhad Ben-Cohen * memory regions (which we call "carveouts"), and map them to specific 172a01f7cd6SSuman Anna * device addresses (which are hardcoded in the firmware). They may also have 173a01f7cd6SSuman Anna * dedicated memory regions internal to the processors, and use them either 174a01f7cd6SSuman Anna * exclusively or alongside carveouts. 175400e64dfSOhad Ben-Cohen * 176400e64dfSOhad Ben-Cohen * They may then ask us to copy objects into specific device addresses (e.g. 177400e64dfSOhad Ben-Cohen * code/data sections) or expose us certain symbols in other device address 178400e64dfSOhad Ben-Cohen * (e.g. their trace buffer). 179400e64dfSOhad Ben-Cohen * 180a01f7cd6SSuman Anna * This function is a helper function with which we can go over the allocated 181a01f7cd6SSuman Anna * carveouts and translate specific device addresses to kernel virtual addresses 182a01f7cd6SSuman Anna * so we can access the referenced memory. This function also allows to perform 183a01f7cd6SSuman Anna * translations on the internal remoteproc memory regions through a platform 184a01f7cd6SSuman Anna * implementation specific da_to_va ops, if present. 185a01f7cd6SSuman Anna * 186400e64dfSOhad Ben-Cohen * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too, 187400e64dfSOhad Ben-Cohen * but only on kernel direct mapped RAM memory. Instead, we're just using 188a01f7cd6SSuman Anna * here the output of the DMA API for the carveouts, which should be more 189a01f7cd6SSuman Anna * correct. 190f2867434SSuman Anna * 191f2867434SSuman Anna * Return: a valid kernel address on success or NULL on failure 192400e64dfSOhad Ben-Cohen */ 19340df0a91SPeng Fan void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len, bool *is_iomem) 194400e64dfSOhad Ben-Cohen { 195400e64dfSOhad Ben-Cohen struct rproc_mem_entry *carveout; 196400e64dfSOhad Ben-Cohen void *ptr = NULL; 197400e64dfSOhad Ben-Cohen 198a01f7cd6SSuman Anna if (rproc->ops->da_to_va) { 19940df0a91SPeng Fan ptr = rproc->ops->da_to_va(rproc, da, len, is_iomem); 200a01f7cd6SSuman Anna if (ptr) 201a01f7cd6SSuman Anna goto out; 202a01f7cd6SSuman Anna } 203a01f7cd6SSuman Anna 204400e64dfSOhad Ben-Cohen list_for_each_entry(carveout, &rproc->carveouts, node) { 205400e64dfSOhad Ben-Cohen int offset = da - carveout->da; 206400e64dfSOhad Ben-Cohen 20774457c40SLoic Pallardy /* Verify that carveout is allocated */ 20874457c40SLoic Pallardy if (!carveout->va) 20974457c40SLoic Pallardy continue; 21074457c40SLoic Pallardy 211400e64dfSOhad Ben-Cohen /* try next carveout if da is too small */ 212400e64dfSOhad Ben-Cohen if (offset < 0) 213400e64dfSOhad Ben-Cohen continue; 214400e64dfSOhad Ben-Cohen 215400e64dfSOhad Ben-Cohen /* try next carveout if da is too large */ 216400e64dfSOhad Ben-Cohen if (offset + len > carveout->len) 217400e64dfSOhad Ben-Cohen continue; 218400e64dfSOhad Ben-Cohen 219400e64dfSOhad Ben-Cohen ptr = carveout->va + offset; 220400e64dfSOhad Ben-Cohen 22140df0a91SPeng Fan if (is_iomem) 22240df0a91SPeng Fan *is_iomem = carveout->is_iomem; 22340df0a91SPeng Fan 224400e64dfSOhad Ben-Cohen break; 225400e64dfSOhad Ben-Cohen } 226400e64dfSOhad Ben-Cohen 227a01f7cd6SSuman Anna out: 228400e64dfSOhad Ben-Cohen return ptr; 229400e64dfSOhad Ben-Cohen } 2304afc89d6SSjur Brændeland EXPORT_SYMBOL(rproc_da_to_va); 231400e64dfSOhad Ben-Cohen 232b0019ccdSLoic Pallardy /** 233b0019ccdSLoic Pallardy * rproc_find_carveout_by_name() - lookup the carveout region by a name 234b0019ccdSLoic Pallardy * @rproc: handle of a remote processor 2352e7d4c2cSArnaud Pouliquen * @name: carveout name to find (format string) 2362e7d4c2cSArnaud Pouliquen * @...: optional parameters matching @name string 237b0019ccdSLoic Pallardy * 238b0019ccdSLoic Pallardy * Platform driver has the capability to register some pre-allacoted carveout 239b0019ccdSLoic Pallardy * (physically contiguous memory regions) before rproc firmware loading and 240b0019ccdSLoic Pallardy * associated resource table analysis. These regions may be dedicated memory 241b0019ccdSLoic Pallardy * regions internal to the coprocessor or specified DDR region with specific 242b0019ccdSLoic Pallardy * attributes 243b0019ccdSLoic Pallardy * 244b0019ccdSLoic Pallardy * This function is a helper function with which we can go over the 245b0019ccdSLoic Pallardy * allocated carveouts and return associated region characteristics like 246b0019ccdSLoic Pallardy * coprocessor address, length or processor virtual address. 247b0019ccdSLoic Pallardy * 248b0019ccdSLoic Pallardy * Return: a valid pointer on carveout entry on success or NULL on failure. 249b0019ccdSLoic Pallardy */ 2507e05c8deSLee Jones __printf(2, 3) 251b0019ccdSLoic Pallardy struct rproc_mem_entry * 252b0019ccdSLoic Pallardy rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...) 253b0019ccdSLoic Pallardy { 254b0019ccdSLoic Pallardy va_list args; 255b0019ccdSLoic Pallardy char _name[32]; 256b0019ccdSLoic Pallardy struct rproc_mem_entry *carveout, *mem = NULL; 257b0019ccdSLoic Pallardy 258b0019ccdSLoic Pallardy if (!name) 259b0019ccdSLoic Pallardy return NULL; 260b0019ccdSLoic Pallardy 261b0019ccdSLoic Pallardy va_start(args, name); 262b0019ccdSLoic Pallardy vsnprintf(_name, sizeof(_name), name, args); 263b0019ccdSLoic Pallardy va_end(args); 264b0019ccdSLoic Pallardy 265b0019ccdSLoic Pallardy list_for_each_entry(carveout, &rproc->carveouts, node) { 266b0019ccdSLoic Pallardy /* Compare carveout and requested names */ 267b0019ccdSLoic Pallardy if (!strcmp(carveout->name, _name)) { 268b0019ccdSLoic Pallardy mem = carveout; 269b0019ccdSLoic Pallardy break; 270b0019ccdSLoic Pallardy } 271b0019ccdSLoic Pallardy } 272b0019ccdSLoic Pallardy 273b0019ccdSLoic Pallardy return mem; 274b0019ccdSLoic Pallardy } 275b0019ccdSLoic Pallardy 276c874bf59SLoic Pallardy /** 277c874bf59SLoic Pallardy * rproc_check_carveout_da() - Check specified carveout da configuration 278c874bf59SLoic Pallardy * @rproc: handle of a remote processor 279c874bf59SLoic Pallardy * @mem: pointer on carveout to check 280c874bf59SLoic Pallardy * @da: area device address 281c874bf59SLoic Pallardy * @len: associated area size 282c874bf59SLoic Pallardy * 283c874bf59SLoic Pallardy * This function is a helper function to verify requested device area (couple 28428d7d5c6SLoic Pallardy * da, len) is part of specified carveout. 28528d7d5c6SLoic Pallardy * If da is not set (defined as FW_RSC_ADDR_ANY), only requested length is 28628d7d5c6SLoic Pallardy * checked. 287c874bf59SLoic Pallardy * 28828d7d5c6SLoic Pallardy * Return: 0 if carveout matches request else error 289c874bf59SLoic Pallardy */ 29028d7d5c6SLoic Pallardy static int rproc_check_carveout_da(struct rproc *rproc, 29128d7d5c6SLoic Pallardy struct rproc_mem_entry *mem, u32 da, u32 len) 292c874bf59SLoic Pallardy { 293c874bf59SLoic Pallardy struct device *dev = &rproc->dev; 29428d7d5c6SLoic Pallardy int delta; 295c874bf59SLoic Pallardy 296c874bf59SLoic Pallardy /* Check requested resource length */ 297c874bf59SLoic Pallardy if (len > mem->len) { 298c874bf59SLoic Pallardy dev_err(dev, "Registered carveout doesn't fit len request\n"); 29928d7d5c6SLoic Pallardy return -EINVAL; 300c874bf59SLoic Pallardy } 301c874bf59SLoic Pallardy 302c874bf59SLoic Pallardy if (da != FW_RSC_ADDR_ANY && mem->da == FW_RSC_ADDR_ANY) { 30328d7d5c6SLoic Pallardy /* Address doesn't match registered carveout configuration */ 30428d7d5c6SLoic Pallardy return -EINVAL; 305c874bf59SLoic Pallardy } else if (da != FW_RSC_ADDR_ANY && mem->da != FW_RSC_ADDR_ANY) { 306c874bf59SLoic Pallardy delta = da - mem->da; 307c874bf59SLoic Pallardy 308c874bf59SLoic Pallardy /* Check requested resource belongs to registered carveout */ 309c874bf59SLoic Pallardy if (delta < 0) { 310c874bf59SLoic Pallardy dev_err(dev, 311c874bf59SLoic Pallardy "Registered carveout doesn't fit da request\n"); 31228d7d5c6SLoic Pallardy return -EINVAL; 313c874bf59SLoic Pallardy } 314c874bf59SLoic Pallardy 315c874bf59SLoic Pallardy if (delta + len > mem->len) { 316c874bf59SLoic Pallardy dev_err(dev, 317c874bf59SLoic Pallardy "Registered carveout doesn't fit len request\n"); 31828d7d5c6SLoic Pallardy return -EINVAL; 319c874bf59SLoic Pallardy } 320c874bf59SLoic Pallardy } 321c874bf59SLoic Pallardy 322c874bf59SLoic Pallardy return 0; 323c874bf59SLoic Pallardy } 324c874bf59SLoic Pallardy 3256db20ea8SOhad Ben-Cohen int rproc_alloc_vring(struct rproc_vdev *rvdev, int i) 326400e64dfSOhad Ben-Cohen { 3277a186941SOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 328b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 3296db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 330c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 331096ee786SClement Leger int ret, notifyid; 332c6aed238SLoic Pallardy struct rproc_mem_entry *mem; 333096ee786SClement Leger size_t size; 334400e64dfSOhad Ben-Cohen 3356db20ea8SOhad Ben-Cohen /* actual size of vring (in bytes) */ 336c2a052a4SXuan Zhuo size = PAGE_ALIGN(vring_size(rvring->num, rvring->align)); 3376db20ea8SOhad Ben-Cohen 338c6aed238SLoic Pallardy rsc = (void *)rproc->table_ptr + rvdev->rsc_offset; 339c6aed238SLoic Pallardy 340c6aed238SLoic Pallardy /* Search for pre-registered carveout */ 341c6aed238SLoic Pallardy mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index, 342c6aed238SLoic Pallardy i); 343c6aed238SLoic Pallardy if (mem) { 344c6aed238SLoic Pallardy if (rproc_check_carveout_da(rproc, mem, rsc->vring[i].da, size)) 345c6aed238SLoic Pallardy return -ENOMEM; 346c6aed238SLoic Pallardy } else { 347698ae3d7Swangjianli /* Register carveout in list */ 34899cf0361SBen Dooks (Codethink) mem = rproc_mem_entry_init(dev, NULL, 0, 34999cf0361SBen Dooks (Codethink) size, rsc->vring[i].da, 350c6aed238SLoic Pallardy rproc_alloc_carveout, 351c6aed238SLoic Pallardy rproc_release_carveout, 352c6aed238SLoic Pallardy "vdev%dvring%d", 353c6aed238SLoic Pallardy rvdev->index, i); 354c6aed238SLoic Pallardy if (!mem) { 355c6aed238SLoic Pallardy dev_err(dev, "Can't allocate memory entry structure\n"); 356c6aed238SLoic Pallardy return -ENOMEM; 357c6aed238SLoic Pallardy } 358c6aed238SLoic Pallardy 359c6aed238SLoic Pallardy rproc_add_carveout(rproc, mem); 3606db20ea8SOhad Ben-Cohen } 3616db20ea8SOhad Ben-Cohen 3626db20ea8SOhad Ben-Cohen /* 3636db20ea8SOhad Ben-Cohen * Assign an rproc-wide unique index for this vring 3646db20ea8SOhad Ben-Cohen * TODO: assign a notifyid for rvdev updates as well 3656db20ea8SOhad Ben-Cohen * TODO: support predefined notifyids (via resource table) 3666db20ea8SOhad Ben-Cohen */ 36715fc6110STejun Heo ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL); 368b39599b7SSuman Anna if (ret < 0) { 36915fc6110STejun Heo dev_err(dev, "idr_alloc failed: %d\n", ret); 3706db20ea8SOhad Ben-Cohen return ret; 3716db20ea8SOhad Ben-Cohen } 37215fc6110STejun Heo notifyid = ret; 3736db20ea8SOhad Ben-Cohen 37448f18f89SBjorn Andersson /* Potentially bump max_notifyid */ 37548f18f89SBjorn Andersson if (notifyid > rproc->max_notifyid) 37648f18f89SBjorn Andersson rproc->max_notifyid = notifyid; 37748f18f89SBjorn Andersson 3786db20ea8SOhad Ben-Cohen rvring->notifyid = notifyid; 3796db20ea8SOhad Ben-Cohen 380c6aed238SLoic Pallardy /* Let the rproc know the notifyid of this vring.*/ 381c0d63157SSjur Brændeland rsc->vring[i].notifyid = notifyid; 3826db20ea8SOhad Ben-Cohen return 0; 3836db20ea8SOhad Ben-Cohen } 3846db20ea8SOhad Ben-Cohen 3859c31255cSArnaud Pouliquen int 3866db20ea8SOhad Ben-Cohen rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i) 387400e64dfSOhad Ben-Cohen { 388400e64dfSOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 389b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 390400e64dfSOhad Ben-Cohen struct fw_rsc_vdev_vring *vring = &rsc->vring[i]; 3916db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 392400e64dfSOhad Ben-Cohen 3939d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n", 3947a186941SOhad Ben-Cohen i, vring->da, vring->num, vring->align); 3957a186941SOhad Ben-Cohen 39663140e0eSOhad Ben-Cohen /* verify queue size and vring alignment are sane */ 39763140e0eSOhad Ben-Cohen if (!vring->num || !vring->align) { 39863140e0eSOhad Ben-Cohen dev_err(dev, "invalid qsz (%d) or alignment (%d)\n", 39963140e0eSOhad Ben-Cohen vring->num, vring->align); 400400e64dfSOhad Ben-Cohen return -EINVAL; 401400e64dfSOhad Ben-Cohen } 402400e64dfSOhad Ben-Cohen 403c2a052a4SXuan Zhuo rvring->num = vring->num; 4046db20ea8SOhad Ben-Cohen rvring->align = vring->align; 4056db20ea8SOhad Ben-Cohen rvring->rvdev = rvdev; 406400e64dfSOhad Ben-Cohen 407400e64dfSOhad Ben-Cohen return 0; 408400e64dfSOhad Ben-Cohen } 409400e64dfSOhad Ben-Cohen 4106db20ea8SOhad Ben-Cohen void rproc_free_vring(struct rproc_vring *rvring) 4117a186941SOhad Ben-Cohen { 4126db20ea8SOhad Ben-Cohen struct rproc *rproc = rvring->rvdev->rproc; 41300a0eec5SClement Leger int idx = rvring - rvring->rvdev->vring; 414c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 4157a186941SOhad Ben-Cohen 4167a186941SOhad Ben-Cohen idr_remove(&rproc->notifyids, rvring->notifyid); 417099a3f33SSjur Brændeland 4184d3ebb3bSMathieu Poirier /* 4194d3ebb3bSMathieu Poirier * At this point rproc_stop() has been called and the installed resource 4204d3ebb3bSMathieu Poirier * table in the remote processor memory may no longer be accessible. As 4214d3ebb3bSMathieu Poirier * such and as per rproc_stop(), rproc->table_ptr points to the cached 4224d3ebb3bSMathieu Poirier * resource table (rproc->cached_table). The cached resource table is 4234d3ebb3bSMathieu Poirier * only available when a remote processor has been booted by the 4244d3ebb3bSMathieu Poirier * remoteproc core, otherwise it is NULL. 4254d3ebb3bSMathieu Poirier * 4264d3ebb3bSMathieu Poirier * Based on the above, reset the virtio device section in the cached 4274d3ebb3bSMathieu Poirier * resource table only if there is one to work with. 4284d3ebb3bSMathieu Poirier */ 4294d3ebb3bSMathieu Poirier if (rproc->table_ptr) { 430c0d63157SSjur Brændeland rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset; 431c0d63157SSjur Brændeland rsc->vring[idx].da = 0; 432c0d63157SSjur Brændeland rsc->vring[idx].notifyid = -1; 4337a186941SOhad Ben-Cohen } 4344d3ebb3bSMathieu Poirier } 4357a186941SOhad Ben-Cohen 4369c31255cSArnaud Pouliquen void rproc_add_rvdev(struct rproc *rproc, struct rproc_vdev *rvdev) 43763badba9SArnaud Pouliquen { 43863badba9SArnaud Pouliquen if (rvdev && rproc) 43963badba9SArnaud Pouliquen list_add_tail(&rvdev->node, &rproc->rvdevs); 44063badba9SArnaud Pouliquen } 44163badba9SArnaud Pouliquen 4429c31255cSArnaud Pouliquen void rproc_remove_rvdev(struct rproc_vdev *rvdev) 44363badba9SArnaud Pouliquen { 44463badba9SArnaud Pouliquen if (rvdev) 44563badba9SArnaud Pouliquen list_del(&rvdev->node); 44663badba9SArnaud Pouliquen } 447086d0872SLoic Pallardy /** 448fd2c15ecSOhad Ben-Cohen * rproc_handle_vdev() - handle a vdev fw resource 449400e64dfSOhad Ben-Cohen * @rproc: the remote processor 4502bf23461SJindong Yue * @ptr: the vring resource descriptor 4512e7d4c2cSArnaud Pouliquen * @offset: offset of the resource entry 452fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 453400e64dfSOhad Ben-Cohen * 4547a186941SOhad Ben-Cohen * This resource entry requests the host to statically register a virtio 4557a186941SOhad Ben-Cohen * device (vdev), and setup everything needed to support it. It contains 4567a186941SOhad Ben-Cohen * everything needed to make it possible: the virtio device id, virtio 4577a186941SOhad Ben-Cohen * device features, vrings information, virtio config space, etc... 458400e64dfSOhad Ben-Cohen * 4597a186941SOhad Ben-Cohen * Before registering the vdev, the vrings are allocated from non-cacheable 4607a186941SOhad Ben-Cohen * physically contiguous memory. Currently we only support two vrings per 4617a186941SOhad Ben-Cohen * remote processor (temporary limitation). We might also want to consider 4627a186941SOhad Ben-Cohen * doing the vring allocation only later when ->find_vqs() is invoked, and 4637a186941SOhad Ben-Cohen * then release them upon ->del_vqs(). 464400e64dfSOhad Ben-Cohen * 4657a186941SOhad Ben-Cohen * Note: @da is currently not really handled correctly: we dynamically 4667a186941SOhad Ben-Cohen * allocate it using the DMA API, ignoring requested hard coded addresses, 4677a186941SOhad Ben-Cohen * and we don't take care of any required IOMMU programming. This is all 4687a186941SOhad Ben-Cohen * going to be taken care of when the generic iommu-based DMA API will be 4697a186941SOhad Ben-Cohen * merged. Meanwhile, statically-addressed iommu-based firmware images should 4707a186941SOhad Ben-Cohen * use RSC_DEVMEM resource entries to map their required @da to the physical 4717a186941SOhad Ben-Cohen * address of their base CMA region (ouch, hacky!). 472400e64dfSOhad Ben-Cohen * 473f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 474400e64dfSOhad Ben-Cohen */ 4752bf23461SJindong Yue static int rproc_handle_vdev(struct rproc *rproc, void *ptr, 476a2b950acSOhad Ben-Cohen int offset, int avail) 477400e64dfSOhad Ben-Cohen { 4782bf23461SJindong Yue struct fw_rsc_vdev *rsc = ptr; 479b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 4807a186941SOhad Ben-Cohen struct rproc_vdev *rvdev; 4817d7f8fe4SDan Carpenter size_t rsc_size; 482fd28f879SArnaud Pouliquen struct rproc_vdev_data rvdev_data; 4831d7b61c0SArnaud Pouliquen struct platform_device *pdev; 484fd2c15ecSOhad Ben-Cohen 485fd2c15ecSOhad Ben-Cohen /* make sure resource isn't truncated */ 4867d7f8fe4SDan Carpenter rsc_size = struct_size(rsc, vring, rsc->num_of_vrings); 4877d7f8fe4SDan Carpenter if (size_add(rsc_size, rsc->config_len) > avail) { 488b5ab5e24SOhad Ben-Cohen dev_err(dev, "vdev rsc is truncated\n"); 489fd2c15ecSOhad Ben-Cohen return -EINVAL; 490fd2c15ecSOhad Ben-Cohen } 491fd2c15ecSOhad Ben-Cohen 492fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 493fd2c15ecSOhad Ben-Cohen if (rsc->reserved[0] || rsc->reserved[1]) { 494fd2c15ecSOhad Ben-Cohen dev_err(dev, "vdev rsc has non zero reserved bytes\n"); 495fd2c15ecSOhad Ben-Cohen return -EINVAL; 496fd2c15ecSOhad Ben-Cohen } 497fd2c15ecSOhad Ben-Cohen 4989d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n", 499fd2c15ecSOhad Ben-Cohen rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings); 500400e64dfSOhad Ben-Cohen 5017a186941SOhad Ben-Cohen /* we currently support only two vrings per rvdev */ 5027a186941SOhad Ben-Cohen if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) { 503fd2c15ecSOhad Ben-Cohen dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings); 504400e64dfSOhad Ben-Cohen return -EINVAL; 505400e64dfSOhad Ben-Cohen } 506400e64dfSOhad Ben-Cohen 507fd28f879SArnaud Pouliquen rvdev_data.id = rsc->id; 508fd28f879SArnaud Pouliquen rvdev_data.index = rproc->nb_vdev++; 509fd28f879SArnaud Pouliquen rvdev_data.rsc_offset = offset; 510fd28f879SArnaud Pouliquen rvdev_data.rsc = rsc; 5117a186941SOhad Ben-Cohen 512*65fcf387SShengjiu Wang /* 513*65fcf387SShengjiu Wang * When there is more than one remote processor, rproc->nb_vdev number is 514*65fcf387SShengjiu Wang * same for each separate instances of "rproc". If rvdev_data.index is used 515*65fcf387SShengjiu Wang * as device id, then we get duplication in sysfs, so need to use 516*65fcf387SShengjiu Wang * PLATFORM_DEVID_AUTO to auto select device id. 517*65fcf387SShengjiu Wang */ 518*65fcf387SShengjiu Wang pdev = platform_device_register_data(dev, "rproc-virtio", PLATFORM_DEVID_AUTO, &rvdev_data, 5191d7b61c0SArnaud Pouliquen sizeof(rvdev_data)); 5201d7b61c0SArnaud Pouliquen if (IS_ERR(pdev)) { 5211d7b61c0SArnaud Pouliquen dev_err(dev, "failed to create rproc-virtio device\n"); 5221d7b61c0SArnaud Pouliquen return PTR_ERR(pdev); 5231d7b61c0SArnaud Pouliquen } 524400e64dfSOhad Ben-Cohen 525400e64dfSOhad Ben-Cohen return 0; 526aab8d802SBjorn Andersson } 527aab8d802SBjorn Andersson 528400e64dfSOhad Ben-Cohen /** 529400e64dfSOhad Ben-Cohen * rproc_handle_trace() - handle a shared trace buffer resource 530400e64dfSOhad Ben-Cohen * @rproc: the remote processor 5312bf23461SJindong Yue * @ptr: the trace resource descriptor 5322e7d4c2cSArnaud Pouliquen * @offset: offset of the resource entry 533fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 534400e64dfSOhad Ben-Cohen * 535400e64dfSOhad Ben-Cohen * In case the remote processor dumps trace logs into memory, 536400e64dfSOhad Ben-Cohen * export it via debugfs. 537400e64dfSOhad Ben-Cohen * 538400e64dfSOhad Ben-Cohen * Currently, the 'da' member of @rsc should contain the device address 539400e64dfSOhad Ben-Cohen * where the remote processor is dumping the traces. Later we could also 540400e64dfSOhad Ben-Cohen * support dynamically allocating this address using the generic 541400e64dfSOhad Ben-Cohen * DMA API (but currently there isn't a use case for that). 542400e64dfSOhad Ben-Cohen * 543f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 544400e64dfSOhad Ben-Cohen */ 5452bf23461SJindong Yue static int rproc_handle_trace(struct rproc *rproc, void *ptr, 546a2b950acSOhad Ben-Cohen int offset, int avail) 547400e64dfSOhad Ben-Cohen { 5482bf23461SJindong Yue struct fw_rsc_trace *rsc = ptr; 549a987e6b9SLoic Pallardy struct rproc_debug_trace *trace; 550b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 551400e64dfSOhad Ben-Cohen char name[15]; 552400e64dfSOhad Ben-Cohen 553fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 554b5ab5e24SOhad Ben-Cohen dev_err(dev, "trace rsc is truncated\n"); 555fd2c15ecSOhad Ben-Cohen return -EINVAL; 556fd2c15ecSOhad Ben-Cohen } 557fd2c15ecSOhad Ben-Cohen 558fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 559fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 560fd2c15ecSOhad Ben-Cohen dev_err(dev, "trace rsc has non zero reserved bytes\n"); 561fd2c15ecSOhad Ben-Cohen return -EINVAL; 562fd2c15ecSOhad Ben-Cohen } 563fd2c15ecSOhad Ben-Cohen 564400e64dfSOhad Ben-Cohen trace = kzalloc(sizeof(*trace), GFP_KERNEL); 565172e6ab1SSuman Anna if (!trace) 566400e64dfSOhad Ben-Cohen return -ENOMEM; 567400e64dfSOhad Ben-Cohen 568400e64dfSOhad Ben-Cohen /* set the trace buffer dma properties */ 569a987e6b9SLoic Pallardy trace->trace_mem.len = rsc->len; 570a987e6b9SLoic Pallardy trace->trace_mem.da = rsc->da; 571a987e6b9SLoic Pallardy 572a987e6b9SLoic Pallardy /* set pointer on rproc device */ 573a987e6b9SLoic Pallardy trace->rproc = rproc; 574400e64dfSOhad Ben-Cohen 575400e64dfSOhad Ben-Cohen /* make sure snprintf always null terminates, even if truncating */ 576400e64dfSOhad Ben-Cohen snprintf(name, sizeof(name), "trace%d", rproc->num_traces); 577400e64dfSOhad Ben-Cohen 578400e64dfSOhad Ben-Cohen /* create the debugfs entry */ 579a987e6b9SLoic Pallardy trace->tfile = rproc_create_trace_file(name, rproc, trace); 580400e64dfSOhad Ben-Cohen 581400e64dfSOhad Ben-Cohen list_add_tail(&trace->node, &rproc->traces); 582400e64dfSOhad Ben-Cohen 583400e64dfSOhad Ben-Cohen rproc->num_traces++; 584400e64dfSOhad Ben-Cohen 585a987e6b9SLoic Pallardy dev_dbg(dev, "%s added: da 0x%x, len 0x%x\n", 586a987e6b9SLoic Pallardy name, rsc->da, rsc->len); 587400e64dfSOhad Ben-Cohen 588400e64dfSOhad Ben-Cohen return 0; 589400e64dfSOhad Ben-Cohen } 590400e64dfSOhad Ben-Cohen 591400e64dfSOhad Ben-Cohen /** 592400e64dfSOhad Ben-Cohen * rproc_handle_devmem() - handle devmem resource entry 593400e64dfSOhad Ben-Cohen * @rproc: remote processor handle 5942bf23461SJindong Yue * @ptr: the devmem resource entry 5952e7d4c2cSArnaud Pouliquen * @offset: offset of the resource entry 596fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 597400e64dfSOhad Ben-Cohen * 598400e64dfSOhad Ben-Cohen * Remote processors commonly need to access certain on-chip peripherals. 599400e64dfSOhad Ben-Cohen * 600400e64dfSOhad Ben-Cohen * Some of these remote processors access memory via an iommu device, 601400e64dfSOhad Ben-Cohen * and might require us to configure their iommu before they can access 602400e64dfSOhad Ben-Cohen * the on-chip peripherals they need. 603400e64dfSOhad Ben-Cohen * 604400e64dfSOhad Ben-Cohen * This resource entry is a request to map such a peripheral device. 605400e64dfSOhad Ben-Cohen * 606400e64dfSOhad Ben-Cohen * These devmem entries will contain the physical address of the device in 607400e64dfSOhad Ben-Cohen * the 'pa' member. If a specific device address is expected, then 'da' will 608400e64dfSOhad Ben-Cohen * contain it (currently this is the only use case supported). 'len' will 609400e64dfSOhad Ben-Cohen * contain the size of the physical region we need to map. 610400e64dfSOhad Ben-Cohen * 611400e64dfSOhad Ben-Cohen * Currently we just "trust" those devmem entries to contain valid physical 612400e64dfSOhad Ben-Cohen * addresses, but this is going to change: we want the implementations to 613400e64dfSOhad Ben-Cohen * tell us ranges of physical addresses the firmware is allowed to request, 614400e64dfSOhad Ben-Cohen * and not allow firmwares to request access to physical addresses that 615400e64dfSOhad Ben-Cohen * are outside those ranges. 616f2867434SSuman Anna * 617f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 618400e64dfSOhad Ben-Cohen */ 6192bf23461SJindong Yue static int rproc_handle_devmem(struct rproc *rproc, void *ptr, 620a2b950acSOhad Ben-Cohen int offset, int avail) 621400e64dfSOhad Ben-Cohen { 6222bf23461SJindong Yue struct fw_rsc_devmem *rsc = ptr; 623400e64dfSOhad Ben-Cohen struct rproc_mem_entry *mapping; 624b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 625400e64dfSOhad Ben-Cohen int ret; 626400e64dfSOhad Ben-Cohen 627400e64dfSOhad Ben-Cohen /* no point in handling this resource without a valid iommu domain */ 628400e64dfSOhad Ben-Cohen if (!rproc->domain) 629400e64dfSOhad Ben-Cohen return -EINVAL; 630400e64dfSOhad Ben-Cohen 631fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 632b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc is truncated\n"); 633fd2c15ecSOhad Ben-Cohen return -EINVAL; 634fd2c15ecSOhad Ben-Cohen } 635fd2c15ecSOhad Ben-Cohen 636fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 637fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 638b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc has non zero reserved bytes\n"); 639fd2c15ecSOhad Ben-Cohen return -EINVAL; 640fd2c15ecSOhad Ben-Cohen } 641fd2c15ecSOhad Ben-Cohen 642400e64dfSOhad Ben-Cohen mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 643172e6ab1SSuman Anna if (!mapping) 644400e64dfSOhad Ben-Cohen return -ENOMEM; 645400e64dfSOhad Ben-Cohen 646400e64dfSOhad Ben-Cohen ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags); 647400e64dfSOhad Ben-Cohen if (ret) { 648b5ab5e24SOhad Ben-Cohen dev_err(dev, "failed to map devmem: %d\n", ret); 649400e64dfSOhad Ben-Cohen goto out; 650400e64dfSOhad Ben-Cohen } 651400e64dfSOhad Ben-Cohen 652400e64dfSOhad Ben-Cohen /* 653400e64dfSOhad Ben-Cohen * We'll need this info later when we'll want to unmap everything 654400e64dfSOhad Ben-Cohen * (e.g. on shutdown). 655400e64dfSOhad Ben-Cohen * 656400e64dfSOhad Ben-Cohen * We can't trust the remote processor not to change the resource 657400e64dfSOhad Ben-Cohen * table, so we must maintain this info independently. 658400e64dfSOhad Ben-Cohen */ 659400e64dfSOhad Ben-Cohen mapping->da = rsc->da; 660400e64dfSOhad Ben-Cohen mapping->len = rsc->len; 661400e64dfSOhad Ben-Cohen list_add_tail(&mapping->node, &rproc->mappings); 662400e64dfSOhad Ben-Cohen 663b5ab5e24SOhad Ben-Cohen dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n", 664400e64dfSOhad Ben-Cohen rsc->pa, rsc->da, rsc->len); 665400e64dfSOhad Ben-Cohen 666400e64dfSOhad Ben-Cohen return 0; 667400e64dfSOhad Ben-Cohen 668400e64dfSOhad Ben-Cohen out: 669400e64dfSOhad Ben-Cohen kfree(mapping); 670400e64dfSOhad Ben-Cohen return ret; 671400e64dfSOhad Ben-Cohen } 672400e64dfSOhad Ben-Cohen 673400e64dfSOhad Ben-Cohen /** 674d7c51706SLoic Pallardy * rproc_alloc_carveout() - allocated specified carveout 675d7c51706SLoic Pallardy * @rproc: rproc handle 676d7c51706SLoic Pallardy * @mem: the memory entry to allocate 677d7c51706SLoic Pallardy * 678d7c51706SLoic Pallardy * This function allocate specified memory entry @mem using 679d7c51706SLoic Pallardy * dma_alloc_coherent() as default allocator 680f2867434SSuman Anna * 681f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 682d7c51706SLoic Pallardy */ 683d7c51706SLoic Pallardy static int rproc_alloc_carveout(struct rproc *rproc, 684d7c51706SLoic Pallardy struct rproc_mem_entry *mem) 685d7c51706SLoic Pallardy { 686d7c51706SLoic Pallardy struct rproc_mem_entry *mapping = NULL; 687d7c51706SLoic Pallardy struct device *dev = &rproc->dev; 688d7c51706SLoic Pallardy dma_addr_t dma; 689d7c51706SLoic Pallardy void *va; 690d7c51706SLoic Pallardy int ret; 691d7c51706SLoic Pallardy 692d7c51706SLoic Pallardy va = dma_alloc_coherent(dev->parent, mem->len, &dma, GFP_KERNEL); 693d7c51706SLoic Pallardy if (!va) { 694d7c51706SLoic Pallardy dev_err(dev->parent, 695096ee786SClement Leger "failed to allocate dma memory: len 0x%zx\n", 696096ee786SClement Leger mem->len); 697d7c51706SLoic Pallardy return -ENOMEM; 698d7c51706SLoic Pallardy } 699d7c51706SLoic Pallardy 700096ee786SClement Leger dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%zx\n", 701d7c51706SLoic Pallardy va, &dma, mem->len); 702d7c51706SLoic Pallardy 70360f849a5SLoic Pallardy if (mem->da != FW_RSC_ADDR_ANY && !rproc->domain) { 70460f849a5SLoic Pallardy /* 70560f849a5SLoic Pallardy * Check requested da is equal to dma address 70660f849a5SLoic Pallardy * and print a warn message in case of missalignment. 70760f849a5SLoic Pallardy * Don't stop rproc_start sequence as coprocessor may 70860f849a5SLoic Pallardy * build pa to da translation on its side. 70960f849a5SLoic Pallardy */ 71060f849a5SLoic Pallardy if (mem->da != (u32)dma) 71160f849a5SLoic Pallardy dev_warn(dev->parent, 71260f849a5SLoic Pallardy "Allocated carveout doesn't fit device address request\n"); 71360f849a5SLoic Pallardy } 71460f849a5SLoic Pallardy 715d7c51706SLoic Pallardy /* 716d7c51706SLoic Pallardy * Ok, this is non-standard. 717d7c51706SLoic Pallardy * 718d7c51706SLoic Pallardy * Sometimes we can't rely on the generic iommu-based DMA API 719d7c51706SLoic Pallardy * to dynamically allocate the device address and then set the IOMMU 720d7c51706SLoic Pallardy * tables accordingly, because some remote processors might 721d7c51706SLoic Pallardy * _require_ us to use hard coded device addresses that their 722d7c51706SLoic Pallardy * firmware was compiled with. 723d7c51706SLoic Pallardy * 724d7c51706SLoic Pallardy * In this case, we must use the IOMMU API directly and map 725d7c51706SLoic Pallardy * the memory to the device address as expected by the remote 726d7c51706SLoic Pallardy * processor. 727d7c51706SLoic Pallardy * 728d7c51706SLoic Pallardy * Obviously such remote processor devices should not be configured 729d7c51706SLoic Pallardy * to use the iommu-based DMA API: we expect 'dma' to contain the 730d7c51706SLoic Pallardy * physical address in this case. 731d7c51706SLoic Pallardy */ 73260f849a5SLoic Pallardy if (mem->da != FW_RSC_ADDR_ANY && rproc->domain) { 733d7c51706SLoic Pallardy mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 734d7c51706SLoic Pallardy if (!mapping) { 735d7c51706SLoic Pallardy ret = -ENOMEM; 736d7c51706SLoic Pallardy goto dma_free; 737d7c51706SLoic Pallardy } 738d7c51706SLoic Pallardy 739d7c51706SLoic Pallardy ret = iommu_map(rproc->domain, mem->da, dma, mem->len, 740d7c51706SLoic Pallardy mem->flags); 741d7c51706SLoic Pallardy if (ret) { 742d7c51706SLoic Pallardy dev_err(dev, "iommu_map failed: %d\n", ret); 743d7c51706SLoic Pallardy goto free_mapping; 744d7c51706SLoic Pallardy } 745d7c51706SLoic Pallardy 746d7c51706SLoic Pallardy /* 747d7c51706SLoic Pallardy * We'll need this info later when we'll want to unmap 748d7c51706SLoic Pallardy * everything (e.g. on shutdown). 749d7c51706SLoic Pallardy * 750d7c51706SLoic Pallardy * We can't trust the remote processor not to change the 751d7c51706SLoic Pallardy * resource table, so we must maintain this info independently. 752d7c51706SLoic Pallardy */ 753d7c51706SLoic Pallardy mapping->da = mem->da; 754d7c51706SLoic Pallardy mapping->len = mem->len; 755d7c51706SLoic Pallardy list_add_tail(&mapping->node, &rproc->mappings); 756d7c51706SLoic Pallardy 757d7c51706SLoic Pallardy dev_dbg(dev, "carveout mapped 0x%x to %pad\n", 758d7c51706SLoic Pallardy mem->da, &dma); 75960f849a5SLoic Pallardy } 76060f849a5SLoic Pallardy 76160f849a5SLoic Pallardy if (mem->da == FW_RSC_ADDR_ANY) { 762b36de8cfSLoic Pallardy /* Update device address as undefined by requester */ 763b36de8cfSLoic Pallardy if ((u64)dma & HIGH_BITS_MASK) 764b36de8cfSLoic Pallardy dev_warn(dev, "DMA address cast in 32bit to fit resource table format\n"); 765b36de8cfSLoic Pallardy 766d7c51706SLoic Pallardy mem->da = (u32)dma; 767d7c51706SLoic Pallardy } 768d7c51706SLoic Pallardy 76980137b40SLoic Pallardy mem->dma = dma; 770d7c51706SLoic Pallardy mem->va = va; 771d7c51706SLoic Pallardy 772d7c51706SLoic Pallardy return 0; 773d7c51706SLoic Pallardy 774d7c51706SLoic Pallardy free_mapping: 775d7c51706SLoic Pallardy kfree(mapping); 776d7c51706SLoic Pallardy dma_free: 777d7c51706SLoic Pallardy dma_free_coherent(dev->parent, mem->len, va, dma); 778d7c51706SLoic Pallardy return ret; 779d7c51706SLoic Pallardy } 780d7c51706SLoic Pallardy 781d7c51706SLoic Pallardy /** 782f2e74abfSLoic Pallardy * rproc_release_carveout() - release acquired carveout 783f2e74abfSLoic Pallardy * @rproc: rproc handle 784f2e74abfSLoic Pallardy * @mem: the memory entry to release 785f2e74abfSLoic Pallardy * 786f2e74abfSLoic Pallardy * This function releases specified memory entry @mem allocated via 787d7c51706SLoic Pallardy * rproc_alloc_carveout() function by @rproc. 788f2867434SSuman Anna * 789f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 790f2e74abfSLoic Pallardy */ 791f2e74abfSLoic Pallardy static int rproc_release_carveout(struct rproc *rproc, 792f2e74abfSLoic Pallardy struct rproc_mem_entry *mem) 793f2e74abfSLoic Pallardy { 794f2e74abfSLoic Pallardy struct device *dev = &rproc->dev; 795f2e74abfSLoic Pallardy 796f2e74abfSLoic Pallardy /* clean up carveout allocations */ 797f2e74abfSLoic Pallardy dma_free_coherent(dev->parent, mem->len, mem->va, mem->dma); 798f2e74abfSLoic Pallardy return 0; 799f2e74abfSLoic Pallardy } 800f2e74abfSLoic Pallardy 801f2e74abfSLoic Pallardy /** 802400e64dfSOhad Ben-Cohen * rproc_handle_carveout() - handle phys contig memory allocation requests 803400e64dfSOhad Ben-Cohen * @rproc: rproc handle 8042bf23461SJindong Yue * @ptr: the resource entry 8052e7d4c2cSArnaud Pouliquen * @offset: offset of the resource entry 806fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for image validation) 807400e64dfSOhad Ben-Cohen * 808400e64dfSOhad Ben-Cohen * This function will handle firmware requests for allocation of physically 809400e64dfSOhad Ben-Cohen * contiguous memory regions. 810400e64dfSOhad Ben-Cohen * 811400e64dfSOhad Ben-Cohen * These request entries should come first in the firmware's resource table, 812400e64dfSOhad Ben-Cohen * as other firmware entries might request placing other data objects inside 813400e64dfSOhad Ben-Cohen * these memory regions (e.g. data/code segments, trace resource entries, ...). 814400e64dfSOhad Ben-Cohen * 815400e64dfSOhad Ben-Cohen * Allocating memory this way helps utilizing the reserved physical memory 816400e64dfSOhad Ben-Cohen * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries 817400e64dfSOhad Ben-Cohen * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB 818400e64dfSOhad Ben-Cohen * pressure is important; it may have a substantial impact on performance. 819f2867434SSuman Anna * 820f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 821400e64dfSOhad Ben-Cohen */ 822fd2c15ecSOhad Ben-Cohen static int rproc_handle_carveout(struct rproc *rproc, 8232bf23461SJindong Yue void *ptr, int offset, int avail) 824400e64dfSOhad Ben-Cohen { 8252bf23461SJindong Yue struct fw_rsc_carveout *rsc = ptr; 826d7c51706SLoic Pallardy struct rproc_mem_entry *carveout; 827b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 828400e64dfSOhad Ben-Cohen 829fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 830b5ab5e24SOhad Ben-Cohen dev_err(dev, "carveout rsc is truncated\n"); 831fd2c15ecSOhad Ben-Cohen return -EINVAL; 832fd2c15ecSOhad Ben-Cohen } 833fd2c15ecSOhad Ben-Cohen 834fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 835fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 836fd2c15ecSOhad Ben-Cohen dev_err(dev, "carveout rsc has non zero reserved bytes\n"); 837fd2c15ecSOhad Ben-Cohen return -EINVAL; 838fd2c15ecSOhad Ben-Cohen } 839fd2c15ecSOhad Ben-Cohen 8409d7814a9SAnna, Suman dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n", 84135386166SLee Jones rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags); 842fd2c15ecSOhad Ben-Cohen 843ffa5f9c8SLoic Pallardy /* 844ffa5f9c8SLoic Pallardy * Check carveout rsc already part of a registered carveout, 845ffa5f9c8SLoic Pallardy * Search by name, then check the da and length 846ffa5f9c8SLoic Pallardy */ 847ffa5f9c8SLoic Pallardy carveout = rproc_find_carveout_by_name(rproc, rsc->name); 848ffa5f9c8SLoic Pallardy 849ffa5f9c8SLoic Pallardy if (carveout) { 850ffa5f9c8SLoic Pallardy if (carveout->rsc_offset != FW_RSC_ADDR_ANY) { 851ffa5f9c8SLoic Pallardy dev_err(dev, 852ffa5f9c8SLoic Pallardy "Carveout already associated to resource table\n"); 853ffa5f9c8SLoic Pallardy return -ENOMEM; 854ffa5f9c8SLoic Pallardy } 855ffa5f9c8SLoic Pallardy 856ffa5f9c8SLoic Pallardy if (rproc_check_carveout_da(rproc, carveout, rsc->da, rsc->len)) 857ffa5f9c8SLoic Pallardy return -ENOMEM; 858ffa5f9c8SLoic Pallardy 859ffa5f9c8SLoic Pallardy /* Update memory carveout with resource table info */ 860ffa5f9c8SLoic Pallardy carveout->rsc_offset = offset; 861ffa5f9c8SLoic Pallardy carveout->flags = rsc->flags; 862ffa5f9c8SLoic Pallardy 863ffa5f9c8SLoic Pallardy return 0; 864ffa5f9c8SLoic Pallardy } 865ffa5f9c8SLoic Pallardy 866bf24ecc8Swangjianli /* Register carveout in list */ 86799cf0361SBen Dooks (Codethink) carveout = rproc_mem_entry_init(dev, NULL, 0, rsc->len, rsc->da, 868d7c51706SLoic Pallardy rproc_alloc_carveout, 869d7c51706SLoic Pallardy rproc_release_carveout, rsc->name); 870d7c51706SLoic Pallardy if (!carveout) { 871d7c51706SLoic Pallardy dev_err(dev, "Can't allocate memory entry structure\n"); 87272029c90SLoic Pallardy return -ENOMEM; 873400e64dfSOhad Ben-Cohen } 874400e64dfSOhad Ben-Cohen 875d7c51706SLoic Pallardy carveout->flags = rsc->flags; 876d7c51706SLoic Pallardy carveout->rsc_offset = offset; 87715c0b025SLoic Pallardy rproc_add_carveout(rproc, carveout); 878400e64dfSOhad Ben-Cohen 879400e64dfSOhad Ben-Cohen return 0; 880400e64dfSOhad Ben-Cohen } 881400e64dfSOhad Ben-Cohen 88272029c90SLoic Pallardy /** 88315c0b025SLoic Pallardy * rproc_add_carveout() - register an allocated carveout region 88415c0b025SLoic Pallardy * @rproc: rproc handle 88515c0b025SLoic Pallardy * @mem: memory entry to register 88615c0b025SLoic Pallardy * 88715c0b025SLoic Pallardy * This function registers specified memory entry in @rproc carveouts list. 88815c0b025SLoic Pallardy * Specified carveout should have been allocated before registering. 88915c0b025SLoic Pallardy */ 89015c0b025SLoic Pallardy void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem) 89115c0b025SLoic Pallardy { 89215c0b025SLoic Pallardy list_add_tail(&mem->node, &rproc->carveouts); 89315c0b025SLoic Pallardy } 89415c0b025SLoic Pallardy EXPORT_SYMBOL(rproc_add_carveout); 89515c0b025SLoic Pallardy 89615c0b025SLoic Pallardy /** 89772029c90SLoic Pallardy * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct 89872029c90SLoic Pallardy * @dev: pointer on device struct 89972029c90SLoic Pallardy * @va: virtual address 90072029c90SLoic Pallardy * @dma: dma address 90172029c90SLoic Pallardy * @len: memory carveout length 90272029c90SLoic Pallardy * @da: device address 903a9f6fe0dSLoic Pallardy * @alloc: memory carveout allocation function 904a9f6fe0dSLoic Pallardy * @release: memory carveout release function 90572029c90SLoic Pallardy * @name: carveout name 90672029c90SLoic Pallardy * 90772029c90SLoic Pallardy * This function allocates a rproc_mem_entry struct and fill it with parameters 90872029c90SLoic Pallardy * provided by client. 909f2867434SSuman Anna * 910f2867434SSuman Anna * Return: a valid pointer on success, or NULL on failure 91172029c90SLoic Pallardy */ 9127e05c8deSLee Jones __printf(8, 9) 91372029c90SLoic Pallardy struct rproc_mem_entry * 91472029c90SLoic Pallardy rproc_mem_entry_init(struct device *dev, 915096ee786SClement Leger void *va, dma_addr_t dma, size_t len, u32 da, 916d7c51706SLoic Pallardy int (*alloc)(struct rproc *, struct rproc_mem_entry *), 91772029c90SLoic Pallardy int (*release)(struct rproc *, struct rproc_mem_entry *), 91872029c90SLoic Pallardy const char *name, ...) 91972029c90SLoic Pallardy { 92072029c90SLoic Pallardy struct rproc_mem_entry *mem; 92172029c90SLoic Pallardy va_list args; 92272029c90SLoic Pallardy 92372029c90SLoic Pallardy mem = kzalloc(sizeof(*mem), GFP_KERNEL); 92472029c90SLoic Pallardy if (!mem) 92572029c90SLoic Pallardy return mem; 92672029c90SLoic Pallardy 92772029c90SLoic Pallardy mem->va = va; 92872029c90SLoic Pallardy mem->dma = dma; 92972029c90SLoic Pallardy mem->da = da; 93072029c90SLoic Pallardy mem->len = len; 931d7c51706SLoic Pallardy mem->alloc = alloc; 93272029c90SLoic Pallardy mem->release = release; 933d7c51706SLoic Pallardy mem->rsc_offset = FW_RSC_ADDR_ANY; 9341429cca1SLoic Pallardy mem->of_resm_idx = -1; 93572029c90SLoic Pallardy 93672029c90SLoic Pallardy va_start(args, name); 93772029c90SLoic Pallardy vsnprintf(mem->name, sizeof(mem->name), name, args); 93872029c90SLoic Pallardy va_end(args); 93972029c90SLoic Pallardy 94072029c90SLoic Pallardy return mem; 94172029c90SLoic Pallardy } 94272029c90SLoic Pallardy EXPORT_SYMBOL(rproc_mem_entry_init); 94372029c90SLoic Pallardy 94472029c90SLoic Pallardy /** 9451429cca1SLoic Pallardy * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct 9461429cca1SLoic Pallardy * from a reserved memory phandle 9471429cca1SLoic Pallardy * @dev: pointer on device struct 9481429cca1SLoic Pallardy * @of_resm_idx: reserved memory phandle index in "memory-region" 9491429cca1SLoic Pallardy * @len: memory carveout length 9501429cca1SLoic Pallardy * @da: device address 9511429cca1SLoic Pallardy * @name: carveout name 9521429cca1SLoic Pallardy * 9531429cca1SLoic Pallardy * This function allocates a rproc_mem_entry struct and fill it with parameters 9541429cca1SLoic Pallardy * provided by client. 955f2867434SSuman Anna * 956f2867434SSuman Anna * Return: a valid pointer on success, or NULL on failure 9571429cca1SLoic Pallardy */ 9587e05c8deSLee Jones __printf(5, 6) 9591429cca1SLoic Pallardy struct rproc_mem_entry * 960096ee786SClement Leger rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, size_t len, 9611429cca1SLoic Pallardy u32 da, const char *name, ...) 9621429cca1SLoic Pallardy { 9631429cca1SLoic Pallardy struct rproc_mem_entry *mem; 9641429cca1SLoic Pallardy va_list args; 9651429cca1SLoic Pallardy 9661429cca1SLoic Pallardy mem = kzalloc(sizeof(*mem), GFP_KERNEL); 9671429cca1SLoic Pallardy if (!mem) 9681429cca1SLoic Pallardy return mem; 9691429cca1SLoic Pallardy 9701429cca1SLoic Pallardy mem->da = da; 9711429cca1SLoic Pallardy mem->len = len; 9721429cca1SLoic Pallardy mem->rsc_offset = FW_RSC_ADDR_ANY; 9731429cca1SLoic Pallardy mem->of_resm_idx = of_resm_idx; 9741429cca1SLoic Pallardy 9751429cca1SLoic Pallardy va_start(args, name); 9761429cca1SLoic Pallardy vsnprintf(mem->name, sizeof(mem->name), name, args); 9771429cca1SLoic Pallardy va_end(args); 9781429cca1SLoic Pallardy 9791429cca1SLoic Pallardy return mem; 9801429cca1SLoic Pallardy } 9811429cca1SLoic Pallardy EXPORT_SYMBOL(rproc_of_resm_mem_entry_init); 9821429cca1SLoic Pallardy 983a8aa5ee1SSuman Anna /** 984a8aa5ee1SSuman Anna * rproc_of_parse_firmware() - parse and return the firmware-name 985a8aa5ee1SSuman Anna * @dev: pointer on device struct representing a rproc 986a8aa5ee1SSuman Anna * @index: index to use for the firmware-name retrieval 987a8aa5ee1SSuman Anna * @fw_name: pointer to a character string, in which the firmware 988a8aa5ee1SSuman Anna * name is returned on success and unmodified otherwise. 989a8aa5ee1SSuman Anna * 990a8aa5ee1SSuman Anna * This is an OF helper function that parses a device's DT node for 991a8aa5ee1SSuman Anna * the "firmware-name" property and returns the firmware name pointer 992a8aa5ee1SSuman Anna * in @fw_name on success. 993a8aa5ee1SSuman Anna * 994a8aa5ee1SSuman Anna * Return: 0 on success, or an appropriate failure. 995a8aa5ee1SSuman Anna */ 996a8aa5ee1SSuman Anna int rproc_of_parse_firmware(struct device *dev, int index, const char **fw_name) 997a8aa5ee1SSuman Anna { 998a8aa5ee1SSuman Anna int ret; 999a8aa5ee1SSuman Anna 1000a8aa5ee1SSuman Anna ret = of_property_read_string_index(dev->of_node, "firmware-name", 1001a8aa5ee1SSuman Anna index, fw_name); 1002a8aa5ee1SSuman Anna return ret ? ret : 0; 1003a8aa5ee1SSuman Anna } 1004a8aa5ee1SSuman Anna EXPORT_SYMBOL(rproc_of_parse_firmware); 1005a8aa5ee1SSuman Anna 10062e7d4c2cSArnaud Pouliquen /* 1007e12bc14bSOhad Ben-Cohen * A lookup table for resource handlers. The indices are defined in 1008e12bc14bSOhad Ben-Cohen * enum fw_resource_type. 1009e12bc14bSOhad Ben-Cohen */ 1010232fcdbbSSjur Brændeland static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = { 10112bf23461SJindong Yue [RSC_CARVEOUT] = rproc_handle_carveout, 10122bf23461SJindong Yue [RSC_DEVMEM] = rproc_handle_devmem, 10132bf23461SJindong Yue [RSC_TRACE] = rproc_handle_trace, 10142bf23461SJindong Yue [RSC_VDEV] = rproc_handle_vdev, 1015232fcdbbSSjur Brændeland }; 1016232fcdbbSSjur Brændeland 1017400e64dfSOhad Ben-Cohen /* handle firmware resource entries before booting the remote processor */ 1018a4b24c75SBjorn Andersson static int rproc_handle_resources(struct rproc *rproc, 1019232fcdbbSSjur Brændeland rproc_handle_resource_t handlers[RSC_LAST]) 1020400e64dfSOhad Ben-Cohen { 1021b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1022e12bc14bSOhad Ben-Cohen rproc_handle_resource_t handler; 1023fd2c15ecSOhad Ben-Cohen int ret = 0, i; 1024400e64dfSOhad Ben-Cohen 1025d4bb86f2SBjorn Andersson if (!rproc->table_ptr) 1026d4bb86f2SBjorn Andersson return 0; 1027d4bb86f2SBjorn Andersson 1028a2b950acSOhad Ben-Cohen for (i = 0; i < rproc->table_ptr->num; i++) { 1029a2b950acSOhad Ben-Cohen int offset = rproc->table_ptr->offset[i]; 1030a2b950acSOhad Ben-Cohen struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset; 1031a4b24c75SBjorn Andersson int avail = rproc->table_sz - offset - sizeof(*hdr); 1032fd2c15ecSOhad Ben-Cohen void *rsc = (void *)hdr + sizeof(*hdr); 1033400e64dfSOhad Ben-Cohen 1034fd2c15ecSOhad Ben-Cohen /* make sure table isn't truncated */ 1035fd2c15ecSOhad Ben-Cohen if (avail < 0) { 1036fd2c15ecSOhad Ben-Cohen dev_err(dev, "rsc table is truncated\n"); 1037fd2c15ecSOhad Ben-Cohen return -EINVAL; 1038fd2c15ecSOhad Ben-Cohen } 1039fd2c15ecSOhad Ben-Cohen 1040fd2c15ecSOhad Ben-Cohen dev_dbg(dev, "rsc: type %d\n", hdr->type); 1041fd2c15ecSOhad Ben-Cohen 1042b1a17513SClement Leger if (hdr->type >= RSC_VENDOR_START && 1043b1a17513SClement Leger hdr->type <= RSC_VENDOR_END) { 1044b1a17513SClement Leger ret = rproc_handle_rsc(rproc, hdr->type, rsc, 1045b1a17513SClement Leger offset + sizeof(*hdr), avail); 1046b1a17513SClement Leger if (ret == RSC_HANDLED) 1047b1a17513SClement Leger continue; 1048b1a17513SClement Leger else if (ret < 0) 1049b1a17513SClement Leger break; 1050b1a17513SClement Leger 1051b1a17513SClement Leger dev_warn(dev, "unsupported vendor resource %d\n", 1052b1a17513SClement Leger hdr->type); 1053b1a17513SClement Leger continue; 1054b1a17513SClement Leger } 1055b1a17513SClement Leger 1056fd2c15ecSOhad Ben-Cohen if (hdr->type >= RSC_LAST) { 1057fd2c15ecSOhad Ben-Cohen dev_warn(dev, "unsupported resource %d\n", hdr->type); 1058e12bc14bSOhad Ben-Cohen continue; 1059400e64dfSOhad Ben-Cohen } 1060400e64dfSOhad Ben-Cohen 1061232fcdbbSSjur Brændeland handler = handlers[hdr->type]; 1062e12bc14bSOhad Ben-Cohen if (!handler) 1063e12bc14bSOhad Ben-Cohen continue; 1064e12bc14bSOhad Ben-Cohen 1065a2b950acSOhad Ben-Cohen ret = handler(rproc, rsc, offset + sizeof(*hdr), avail); 10667a186941SOhad Ben-Cohen if (ret) 1067400e64dfSOhad Ben-Cohen break; 1068400e64dfSOhad Ben-Cohen } 1069400e64dfSOhad Ben-Cohen 1070400e64dfSOhad Ben-Cohen return ret; 1071400e64dfSOhad Ben-Cohen } 1072400e64dfSOhad Ben-Cohen 1073c455daa4SBjorn Andersson static int rproc_prepare_subdevices(struct rproc *rproc) 1074c455daa4SBjorn Andersson { 1075c455daa4SBjorn Andersson struct rproc_subdev *subdev; 1076c455daa4SBjorn Andersson int ret; 1077c455daa4SBjorn Andersson 1078c455daa4SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 1079c455daa4SBjorn Andersson if (subdev->prepare) { 1080c455daa4SBjorn Andersson ret = subdev->prepare(subdev); 1081c455daa4SBjorn Andersson if (ret) 1082c455daa4SBjorn Andersson goto unroll_preparation; 1083c455daa4SBjorn Andersson } 1084c455daa4SBjorn Andersson } 1085c455daa4SBjorn Andersson 1086c455daa4SBjorn Andersson return 0; 1087c455daa4SBjorn Andersson 1088c455daa4SBjorn Andersson unroll_preparation: 1089c455daa4SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 1090c455daa4SBjorn Andersson if (subdev->unprepare) 1091c455daa4SBjorn Andersson subdev->unprepare(subdev); 1092c455daa4SBjorn Andersson } 1093c455daa4SBjorn Andersson 1094c455daa4SBjorn Andersson return ret; 1095c455daa4SBjorn Andersson } 1096c455daa4SBjorn Andersson 1097618fcff3SBjorn Andersson static int rproc_start_subdevices(struct rproc *rproc) 10987bdc9650SBjorn Andersson { 10997bdc9650SBjorn Andersson struct rproc_subdev *subdev; 11007bdc9650SBjorn Andersson int ret; 11017bdc9650SBjorn Andersson 11027bdc9650SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 1103be37b1e0SBjorn Andersson if (subdev->start) { 1104618fcff3SBjorn Andersson ret = subdev->start(subdev); 11057bdc9650SBjorn Andersson if (ret) 11067bdc9650SBjorn Andersson goto unroll_registration; 11077bdc9650SBjorn Andersson } 1108be37b1e0SBjorn Andersson } 11097bdc9650SBjorn Andersson 11107bdc9650SBjorn Andersson return 0; 11117bdc9650SBjorn Andersson 11127bdc9650SBjorn Andersson unroll_registration: 1113be37b1e0SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 1114be37b1e0SBjorn Andersson if (subdev->stop) 1115618fcff3SBjorn Andersson subdev->stop(subdev, true); 1116be37b1e0SBjorn Andersson } 11177bdc9650SBjorn Andersson 11187bdc9650SBjorn Andersson return ret; 11197bdc9650SBjorn Andersson } 11207bdc9650SBjorn Andersson 1121618fcff3SBjorn Andersson static void rproc_stop_subdevices(struct rproc *rproc, bool crashed) 11227bdc9650SBjorn Andersson { 11237bdc9650SBjorn Andersson struct rproc_subdev *subdev; 11247bdc9650SBjorn Andersson 1125be37b1e0SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 1126be37b1e0SBjorn Andersson if (subdev->stop) 1127618fcff3SBjorn Andersson subdev->stop(subdev, crashed); 11287bdc9650SBjorn Andersson } 1129be37b1e0SBjorn Andersson } 11307bdc9650SBjorn Andersson 1131c455daa4SBjorn Andersson static void rproc_unprepare_subdevices(struct rproc *rproc) 1132c455daa4SBjorn Andersson { 1133c455daa4SBjorn Andersson struct rproc_subdev *subdev; 1134c455daa4SBjorn Andersson 1135c455daa4SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 1136c455daa4SBjorn Andersson if (subdev->unprepare) 1137c455daa4SBjorn Andersson subdev->unprepare(subdev); 1138c455daa4SBjorn Andersson } 1139c455daa4SBjorn Andersson } 1140c455daa4SBjorn Andersson 1141400e64dfSOhad Ben-Cohen /** 1142d7c51706SLoic Pallardy * rproc_alloc_registered_carveouts() - allocate all carveouts registered 1143d7c51706SLoic Pallardy * in the list 1144d7c51706SLoic Pallardy * @rproc: the remote processor handle 1145d7c51706SLoic Pallardy * 1146d7c51706SLoic Pallardy * This function parses registered carveout list, performs allocation 1147d7c51706SLoic Pallardy * if alloc() ops registered and updates resource table information 1148d7c51706SLoic Pallardy * if rsc_offset set. 1149d7c51706SLoic Pallardy * 1150d7c51706SLoic Pallardy * Return: 0 on success 1151d7c51706SLoic Pallardy */ 1152d7c51706SLoic Pallardy static int rproc_alloc_registered_carveouts(struct rproc *rproc) 1153d7c51706SLoic Pallardy { 1154d7c51706SLoic Pallardy struct rproc_mem_entry *entry, *tmp; 1155d7c51706SLoic Pallardy struct fw_rsc_carveout *rsc; 1156d7c51706SLoic Pallardy struct device *dev = &rproc->dev; 1157b36de8cfSLoic Pallardy u64 pa; 1158d7c51706SLoic Pallardy int ret; 1159d7c51706SLoic Pallardy 1160d7c51706SLoic Pallardy list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 1161d7c51706SLoic Pallardy if (entry->alloc) { 1162d7c51706SLoic Pallardy ret = entry->alloc(rproc, entry); 1163d7c51706SLoic Pallardy if (ret) { 1164d7c51706SLoic Pallardy dev_err(dev, "Unable to allocate carveout %s: %d\n", 1165d7c51706SLoic Pallardy entry->name, ret); 1166d7c51706SLoic Pallardy return -ENOMEM; 1167d7c51706SLoic Pallardy } 1168d7c51706SLoic Pallardy } 1169d7c51706SLoic Pallardy 1170d7c51706SLoic Pallardy if (entry->rsc_offset != FW_RSC_ADDR_ANY) { 1171d7c51706SLoic Pallardy /* update resource table */ 1172d7c51706SLoic Pallardy rsc = (void *)rproc->table_ptr + entry->rsc_offset; 1173d7c51706SLoic Pallardy 1174d7c51706SLoic Pallardy /* 1175d7c51706SLoic Pallardy * Some remote processors might need to know the pa 1176d7c51706SLoic Pallardy * even though they are behind an IOMMU. E.g., OMAP4's 1177d7c51706SLoic Pallardy * remote M3 processor needs this so it can control 1178d7c51706SLoic Pallardy * on-chip hardware accelerators that are not behind 1179d7c51706SLoic Pallardy * the IOMMU, and therefor must know the pa. 1180d7c51706SLoic Pallardy * 1181d7c51706SLoic Pallardy * Generally we don't want to expose physical addresses 1182d7c51706SLoic Pallardy * if we don't have to (remote processors are generally 1183d7c51706SLoic Pallardy * _not_ trusted), so we might want to do this only for 1184d7c51706SLoic Pallardy * remote processor that _must_ have this (e.g. OMAP4's 1185d7c51706SLoic Pallardy * dual M3 subsystem). 1186d7c51706SLoic Pallardy * 1187d7c51706SLoic Pallardy * Non-IOMMU processors might also want to have this info. 1188d7c51706SLoic Pallardy * In this case, the device address and the physical address 1189d7c51706SLoic Pallardy * are the same. 1190d7c51706SLoic Pallardy */ 1191ffa5f9c8SLoic Pallardy 1192ffa5f9c8SLoic Pallardy /* Use va if defined else dma to generate pa */ 1193d7c51706SLoic Pallardy if (entry->va) 1194b36de8cfSLoic Pallardy pa = (u64)rproc_va_to_pa(entry->va); 1195ffa5f9c8SLoic Pallardy else 1196b36de8cfSLoic Pallardy pa = (u64)entry->dma; 1197ffa5f9c8SLoic Pallardy 1198b36de8cfSLoic Pallardy if (((u64)pa) & HIGH_BITS_MASK) 1199b36de8cfSLoic Pallardy dev_warn(dev, 1200b36de8cfSLoic Pallardy "Physical address cast in 32bit to fit resource table format\n"); 1201b36de8cfSLoic Pallardy 1202b36de8cfSLoic Pallardy rsc->pa = (u32)pa; 1203ffa5f9c8SLoic Pallardy rsc->da = entry->da; 1204ffa5f9c8SLoic Pallardy rsc->len = entry->len; 1205d7c51706SLoic Pallardy } 1206d7c51706SLoic Pallardy } 1207d7c51706SLoic Pallardy 1208d7c51706SLoic Pallardy return 0; 1209d7c51706SLoic Pallardy } 1210d7c51706SLoic Pallardy 12112666ca91SSarangdhar Joshi 12122666ca91SSarangdhar Joshi /** 1213400e64dfSOhad Ben-Cohen * rproc_resource_cleanup() - clean up and free all acquired resources 1214400e64dfSOhad Ben-Cohen * @rproc: rproc handle 1215400e64dfSOhad Ben-Cohen * 1216400e64dfSOhad Ben-Cohen * This function will free all resources acquired for @rproc, and it 12177a186941SOhad Ben-Cohen * is called whenever @rproc either shuts down or fails to boot. 1218400e64dfSOhad Ben-Cohen */ 1219d9473cbfSMathieu Poirier void rproc_resource_cleanup(struct rproc *rproc) 1220400e64dfSOhad Ben-Cohen { 1221400e64dfSOhad Ben-Cohen struct rproc_mem_entry *entry, *tmp; 1222a987e6b9SLoic Pallardy struct rproc_debug_trace *trace, *ttmp; 1223d81fb32fSBjorn Andersson struct rproc_vdev *rvdev, *rvtmp; 1224b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1225400e64dfSOhad Ben-Cohen 1226400e64dfSOhad Ben-Cohen /* clean up debugfs trace entries */ 1227a987e6b9SLoic Pallardy list_for_each_entry_safe(trace, ttmp, &rproc->traces, node) { 1228a987e6b9SLoic Pallardy rproc_remove_trace_file(trace->tfile); 1229400e64dfSOhad Ben-Cohen rproc->num_traces--; 1230a987e6b9SLoic Pallardy list_del(&trace->node); 1231a987e6b9SLoic Pallardy kfree(trace); 1232400e64dfSOhad Ben-Cohen } 1233400e64dfSOhad Ben-Cohen 1234400e64dfSOhad Ben-Cohen /* clean up iommu mapping entries */ 1235400e64dfSOhad Ben-Cohen list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) { 1236400e64dfSOhad Ben-Cohen size_t unmapped; 1237400e64dfSOhad Ben-Cohen 1238400e64dfSOhad Ben-Cohen unmapped = iommu_unmap(rproc->domain, entry->da, entry->len); 1239400e64dfSOhad Ben-Cohen if (unmapped != entry->len) { 1240400e64dfSOhad Ben-Cohen /* nothing much to do besides complaining */ 1241096ee786SClement Leger dev_err(dev, "failed to unmap %zx/%zu\n", entry->len, 1242400e64dfSOhad Ben-Cohen unmapped); 1243400e64dfSOhad Ben-Cohen } 1244400e64dfSOhad Ben-Cohen 1245400e64dfSOhad Ben-Cohen list_del(&entry->node); 1246400e64dfSOhad Ben-Cohen kfree(entry); 1247400e64dfSOhad Ben-Cohen } 1248b6356a01SSuman Anna 1249b6356a01SSuman Anna /* clean up carveout allocations */ 1250b6356a01SSuman Anna list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 1251f2e74abfSLoic Pallardy if (entry->release) 1252f2e74abfSLoic Pallardy entry->release(rproc, entry); 1253b6356a01SSuman Anna list_del(&entry->node); 1254b6356a01SSuman Anna kfree(entry); 1255b6356a01SSuman Anna } 1256d81fb32fSBjorn Andersson 1257d81fb32fSBjorn Andersson /* clean up remote vdev entries */ 1258f5bcb353SBjorn Andersson list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node) 12591d7b61c0SArnaud Pouliquen platform_device_unregister(rvdev->pdev); 12602666ca91SSarangdhar Joshi 12612666ca91SSarangdhar Joshi rproc_coredump_cleanup(rproc); 12622b45cef5SBjorn Andersson } 1263d9473cbfSMathieu Poirier EXPORT_SYMBOL(rproc_resource_cleanup); 1264400e64dfSOhad Ben-Cohen 12651efa30d0SSarangdhar Joshi static int rproc_start(struct rproc *rproc, const struct firmware *fw) 12661efa30d0SSarangdhar Joshi { 1267a4b24c75SBjorn Andersson struct resource_table *loaded_table; 12681efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 1269a4b24c75SBjorn Andersson int ret; 12701efa30d0SSarangdhar Joshi 12711efa30d0SSarangdhar Joshi /* load the ELF segments to memory */ 12721efa30d0SSarangdhar Joshi ret = rproc_load_segments(rproc, fw); 12731efa30d0SSarangdhar Joshi if (ret) { 12741efa30d0SSarangdhar Joshi dev_err(dev, "Failed to load program segments: %d\n", ret); 12751efa30d0SSarangdhar Joshi return ret; 12761efa30d0SSarangdhar Joshi } 12771efa30d0SSarangdhar Joshi 12781efa30d0SSarangdhar Joshi /* 12791efa30d0SSarangdhar Joshi * The starting device has been given the rproc->cached_table as the 12801efa30d0SSarangdhar Joshi * resource table. The address of the vring along with the other 12811efa30d0SSarangdhar Joshi * allocated resources (carveouts etc) is stored in cached_table. 12821efa30d0SSarangdhar Joshi * In order to pass this information to the remote device we must copy 12831efa30d0SSarangdhar Joshi * this information to device memory. We also update the table_ptr so 12841efa30d0SSarangdhar Joshi * that any subsequent changes will be applied to the loaded version. 12851efa30d0SSarangdhar Joshi */ 12861efa30d0SSarangdhar Joshi loaded_table = rproc_find_loaded_rsc_table(rproc, fw); 12871efa30d0SSarangdhar Joshi if (loaded_table) { 1288a4b24c75SBjorn Andersson memcpy(loaded_table, rproc->cached_table, rproc->table_sz); 12891efa30d0SSarangdhar Joshi rproc->table_ptr = loaded_table; 12901efa30d0SSarangdhar Joshi } 12911efa30d0SSarangdhar Joshi 1292c455daa4SBjorn Andersson ret = rproc_prepare_subdevices(rproc); 1293c455daa4SBjorn Andersson if (ret) { 1294c455daa4SBjorn Andersson dev_err(dev, "failed to prepare subdevices for %s: %d\n", 1295c455daa4SBjorn Andersson rproc->name, ret); 1296f68d51bdSSuman Anna goto reset_table_ptr; 1297c455daa4SBjorn Andersson } 1298c455daa4SBjorn Andersson 12991efa30d0SSarangdhar Joshi /* power up the remote processor */ 13001efa30d0SSarangdhar Joshi ret = rproc->ops->start(rproc); 13011efa30d0SSarangdhar Joshi if (ret) { 13021efa30d0SSarangdhar Joshi dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret); 1303c455daa4SBjorn Andersson goto unprepare_subdevices; 13041efa30d0SSarangdhar Joshi } 13051efa30d0SSarangdhar Joshi 1306618fcff3SBjorn Andersson /* Start any subdevices for the remote processor */ 1307618fcff3SBjorn Andersson ret = rproc_start_subdevices(rproc); 13081efa30d0SSarangdhar Joshi if (ret) { 13091efa30d0SSarangdhar Joshi dev_err(dev, "failed to probe subdevices for %s: %d\n", 13101efa30d0SSarangdhar Joshi rproc->name, ret); 1311c455daa4SBjorn Andersson goto stop_rproc; 13121efa30d0SSarangdhar Joshi } 13131efa30d0SSarangdhar Joshi 13141efa30d0SSarangdhar Joshi rproc->state = RPROC_RUNNING; 13151efa30d0SSarangdhar Joshi 13161efa30d0SSarangdhar Joshi dev_info(dev, "remote processor %s is now up\n", rproc->name); 13171efa30d0SSarangdhar Joshi 13181efa30d0SSarangdhar Joshi return 0; 1319c455daa4SBjorn Andersson 1320c455daa4SBjorn Andersson stop_rproc: 1321c455daa4SBjorn Andersson rproc->ops->stop(rproc); 1322c455daa4SBjorn Andersson unprepare_subdevices: 1323c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1324f68d51bdSSuman Anna reset_table_ptr: 1325f68d51bdSSuman Anna rproc->table_ptr = rproc->cached_table; 1326c455daa4SBjorn Andersson 1327c455daa4SBjorn Andersson return ret; 13281efa30d0SSarangdhar Joshi } 13291efa30d0SSarangdhar Joshi 13306a6c4dc0SMathieu Poirier static int __rproc_attach(struct rproc *rproc) 1331d848a481SMathieu Poirier { 1332d848a481SMathieu Poirier struct device *dev = &rproc->dev; 1333d848a481SMathieu Poirier int ret; 1334d848a481SMathieu Poirier 1335d848a481SMathieu Poirier ret = rproc_prepare_subdevices(rproc); 1336d848a481SMathieu Poirier if (ret) { 1337d848a481SMathieu Poirier dev_err(dev, "failed to prepare subdevices for %s: %d\n", 1338d848a481SMathieu Poirier rproc->name, ret); 1339d848a481SMathieu Poirier goto out; 1340d848a481SMathieu Poirier } 1341d848a481SMathieu Poirier 1342d848a481SMathieu Poirier /* Attach to the remote processor */ 1343d848a481SMathieu Poirier ret = rproc_attach_device(rproc); 1344d848a481SMathieu Poirier if (ret) { 1345d848a481SMathieu Poirier dev_err(dev, "can't attach to rproc %s: %d\n", 1346d848a481SMathieu Poirier rproc->name, ret); 1347d848a481SMathieu Poirier goto unprepare_subdevices; 1348d848a481SMathieu Poirier } 1349d848a481SMathieu Poirier 1350d848a481SMathieu Poirier /* Start any subdevices for the remote processor */ 1351d848a481SMathieu Poirier ret = rproc_start_subdevices(rproc); 1352d848a481SMathieu Poirier if (ret) { 1353d848a481SMathieu Poirier dev_err(dev, "failed to probe subdevices for %s: %d\n", 1354d848a481SMathieu Poirier rproc->name, ret); 1355d848a481SMathieu Poirier goto stop_rproc; 1356d848a481SMathieu Poirier } 1357d848a481SMathieu Poirier 135876f4c875SMathieu Poirier rproc->state = RPROC_ATTACHED; 1359d848a481SMathieu Poirier 1360d848a481SMathieu Poirier dev_info(dev, "remote processor %s is now attached\n", rproc->name); 1361d848a481SMathieu Poirier 1362d848a481SMathieu Poirier return 0; 1363d848a481SMathieu Poirier 1364d848a481SMathieu Poirier stop_rproc: 1365d848a481SMathieu Poirier rproc->ops->stop(rproc); 1366d848a481SMathieu Poirier unprepare_subdevices: 1367d848a481SMathieu Poirier rproc_unprepare_subdevices(rproc); 1368d848a481SMathieu Poirier out: 1369d848a481SMathieu Poirier return ret; 1370d848a481SMathieu Poirier } 1371d848a481SMathieu Poirier 1372400e64dfSOhad Ben-Cohen /* 1373400e64dfSOhad Ben-Cohen * take a firmware and boot a remote processor with it. 1374400e64dfSOhad Ben-Cohen */ 1375400e64dfSOhad Ben-Cohen static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw) 1376400e64dfSOhad Ben-Cohen { 1377b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1378400e64dfSOhad Ben-Cohen const char *name = rproc->firmware; 137958b64090SBjorn Andersson int ret; 1380400e64dfSOhad Ben-Cohen 1381400e64dfSOhad Ben-Cohen ret = rproc_fw_sanity_check(rproc, fw); 1382400e64dfSOhad Ben-Cohen if (ret) 1383400e64dfSOhad Ben-Cohen return ret; 1384400e64dfSOhad Ben-Cohen 1385e981f6d4SSjur Brændeland dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size); 1386400e64dfSOhad Ben-Cohen 1387400e64dfSOhad Ben-Cohen /* 1388400e64dfSOhad Ben-Cohen * if enabling an IOMMU isn't relevant for this rproc, this is 1389400e64dfSOhad Ben-Cohen * just a nop 1390400e64dfSOhad Ben-Cohen */ 1391400e64dfSOhad Ben-Cohen ret = rproc_enable_iommu(rproc); 1392400e64dfSOhad Ben-Cohen if (ret) { 1393400e64dfSOhad Ben-Cohen dev_err(dev, "can't enable iommu: %d\n", ret); 139449cff125SMathieu Poirier return ret; 1395400e64dfSOhad Ben-Cohen } 1396400e64dfSOhad Ben-Cohen 139733467ac3SLoic Pallardy /* Prepare rproc for firmware loading if needed */ 139833467ac3SLoic Pallardy ret = rproc_prepare_device(rproc); 139933467ac3SLoic Pallardy if (ret) { 140033467ac3SLoic Pallardy dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret); 140133467ac3SLoic Pallardy goto disable_iommu; 140233467ac3SLoic Pallardy } 140333467ac3SLoic Pallardy 14043e5f9eb5SSjur Brændeland rproc->bootaddr = rproc_get_boot_addr(rproc, fw); 1405400e64dfSOhad Ben-Cohen 1406c1d35c1aSBjorn Andersson /* Load resource table, core dump segment list etc from the firmware */ 1407c1d35c1aSBjorn Andersson ret = rproc_parse_fw(rproc, fw); 140858b64090SBjorn Andersson if (ret) 140933467ac3SLoic Pallardy goto unprepare_rproc; 1410a0c10687SBjorn Andersson 1411b35d7afcSBjorn Andersson /* reset max_notifyid */ 1412b35d7afcSBjorn Andersson rproc->max_notifyid = -1; 1413b35d7afcSBjorn Andersson 1414c6aed238SLoic Pallardy /* reset handled vdev */ 1415c6aed238SLoic Pallardy rproc->nb_vdev = 0; 1416c6aed238SLoic Pallardy 1417400e64dfSOhad Ben-Cohen /* handle fw resources which are required to boot rproc */ 1418a4b24c75SBjorn Andersson ret = rproc_handle_resources(rproc, rproc_loading_handlers); 1419400e64dfSOhad Ben-Cohen if (ret) { 1420400e64dfSOhad Ben-Cohen dev_err(dev, "Failed to process resources: %d\n", ret); 1421229b85a6SBjorn Andersson goto clean_up_resources; 1422400e64dfSOhad Ben-Cohen } 1423400e64dfSOhad Ben-Cohen 1424d7c51706SLoic Pallardy /* Allocate carveout resources associated to rproc */ 1425d7c51706SLoic Pallardy ret = rproc_alloc_registered_carveouts(rproc); 1426d7c51706SLoic Pallardy if (ret) { 1427d7c51706SLoic Pallardy dev_err(dev, "Failed to allocate associated carveouts: %d\n", 1428d7c51706SLoic Pallardy ret); 1429d7c51706SLoic Pallardy goto clean_up_resources; 1430d7c51706SLoic Pallardy } 1431d7c51706SLoic Pallardy 14321efa30d0SSarangdhar Joshi ret = rproc_start(rproc, fw); 14331efa30d0SSarangdhar Joshi if (ret) 1434229b85a6SBjorn Andersson goto clean_up_resources; 1435400e64dfSOhad Ben-Cohen 1436400e64dfSOhad Ben-Cohen return 0; 1437400e64dfSOhad Ben-Cohen 1438229b85a6SBjorn Andersson clean_up_resources: 1439229b85a6SBjorn Andersson rproc_resource_cleanup(rproc); 1440a0c10687SBjorn Andersson kfree(rproc->cached_table); 1441a0c10687SBjorn Andersson rproc->cached_table = NULL; 1442988d204cSBjorn Andersson rproc->table_ptr = NULL; 144333467ac3SLoic Pallardy unprepare_rproc: 144433467ac3SLoic Pallardy /* release HW resources if needed */ 144533467ac3SLoic Pallardy rproc_unprepare_device(rproc); 144658b64090SBjorn Andersson disable_iommu: 1447400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 1448400e64dfSOhad Ben-Cohen return ret; 1449400e64dfSOhad Ben-Cohen } 1450400e64dfSOhad Ben-Cohen 14511a631382SMathieu Poirier static int rproc_set_rsc_table(struct rproc *rproc) 14521a631382SMathieu Poirier { 14531a631382SMathieu Poirier struct resource_table *table_ptr; 14541a631382SMathieu Poirier struct device *dev = &rproc->dev; 14551a631382SMathieu Poirier size_t table_sz; 14561a631382SMathieu Poirier int ret; 14571a631382SMathieu Poirier 14581a631382SMathieu Poirier table_ptr = rproc_get_loaded_rsc_table(rproc, &table_sz); 14591a631382SMathieu Poirier if (!table_ptr) { 14601a631382SMathieu Poirier /* Not having a resource table is acceptable */ 14611a631382SMathieu Poirier return 0; 14621a631382SMathieu Poirier } 14631a631382SMathieu Poirier 14641a631382SMathieu Poirier if (IS_ERR(table_ptr)) { 14651a631382SMathieu Poirier ret = PTR_ERR(table_ptr); 14661a631382SMathieu Poirier dev_err(dev, "can't load resource table: %d\n", ret); 14671a631382SMathieu Poirier return ret; 14681a631382SMathieu Poirier } 14691a631382SMathieu Poirier 14709dc9507fSMathieu Poirier /* 14719dc9507fSMathieu Poirier * If it is possible to detach the remote processor, keep an untouched 14729dc9507fSMathieu Poirier * copy of the resource table. That way we can start fresh again when 14739dc9507fSMathieu Poirier * the remote processor is re-attached, that is: 14749dc9507fSMathieu Poirier * 14759dc9507fSMathieu Poirier * DETACHED -> ATTACHED -> DETACHED -> ATTACHED 14769dc9507fSMathieu Poirier * 14779dc9507fSMathieu Poirier * Free'd in rproc_reset_rsc_table_on_detach() and 14789dc9507fSMathieu Poirier * rproc_reset_rsc_table_on_stop(). 14799dc9507fSMathieu Poirier */ 14809dc9507fSMathieu Poirier if (rproc->ops->detach) { 14819dc9507fSMathieu Poirier rproc->clean_table = kmemdup(table_ptr, table_sz, GFP_KERNEL); 14829dc9507fSMathieu Poirier if (!rproc->clean_table) 14839dc9507fSMathieu Poirier return -ENOMEM; 14849dc9507fSMathieu Poirier } else { 14859dc9507fSMathieu Poirier rproc->clean_table = NULL; 14869dc9507fSMathieu Poirier } 14879dc9507fSMathieu Poirier 14881a631382SMathieu Poirier rproc->cached_table = NULL; 14891a631382SMathieu Poirier rproc->table_ptr = table_ptr; 14901a631382SMathieu Poirier rproc->table_sz = table_sz; 14911a631382SMathieu Poirier 14921a631382SMathieu Poirier return 0; 14931a631382SMathieu Poirier } 14941a631382SMathieu Poirier 14959dc9507fSMathieu Poirier static int rproc_reset_rsc_table_on_detach(struct rproc *rproc) 14969dc9507fSMathieu Poirier { 14979dc9507fSMathieu Poirier struct resource_table *table_ptr; 14989dc9507fSMathieu Poirier 14999dc9507fSMathieu Poirier /* A resource table was never retrieved, nothing to do here */ 15009dc9507fSMathieu Poirier if (!rproc->table_ptr) 15019dc9507fSMathieu Poirier return 0; 15029dc9507fSMathieu Poirier 15039dc9507fSMathieu Poirier /* 15049dc9507fSMathieu Poirier * If we made it to this point a clean_table _must_ have been 15059dc9507fSMathieu Poirier * allocated in rproc_set_rsc_table(). If one isn't present 15069dc9507fSMathieu Poirier * something went really wrong and we must complain. 15079dc9507fSMathieu Poirier */ 15089dc9507fSMathieu Poirier if (WARN_ON(!rproc->clean_table)) 15099dc9507fSMathieu Poirier return -EINVAL; 15109dc9507fSMathieu Poirier 15119dc9507fSMathieu Poirier /* Remember where the external entity installed the resource table */ 15129dc9507fSMathieu Poirier table_ptr = rproc->table_ptr; 15139dc9507fSMathieu Poirier 15149dc9507fSMathieu Poirier /* 15159dc9507fSMathieu Poirier * If we made it here the remote processor was started by another 15169dc9507fSMathieu Poirier * entity and a cache table doesn't exist. As such make a copy of 15179dc9507fSMathieu Poirier * the resource table currently used by the remote processor and 15189dc9507fSMathieu Poirier * use that for the rest of the shutdown process. The memory 15199dc9507fSMathieu Poirier * allocated here is free'd in rproc_detach(). 15209dc9507fSMathieu Poirier */ 15219dc9507fSMathieu Poirier rproc->cached_table = kmemdup(rproc->table_ptr, 15229dc9507fSMathieu Poirier rproc->table_sz, GFP_KERNEL); 15239dc9507fSMathieu Poirier if (!rproc->cached_table) 15249dc9507fSMathieu Poirier return -ENOMEM; 15259dc9507fSMathieu Poirier 15269dc9507fSMathieu Poirier /* 15279dc9507fSMathieu Poirier * Use a copy of the resource table for the remainder of the 15289dc9507fSMathieu Poirier * shutdown process. 15299dc9507fSMathieu Poirier */ 15309dc9507fSMathieu Poirier rproc->table_ptr = rproc->cached_table; 15319dc9507fSMathieu Poirier 15329dc9507fSMathieu Poirier /* 15339dc9507fSMathieu Poirier * Reset the memory area where the firmware loaded the resource table 15349dc9507fSMathieu Poirier * to its original value. That way when we re-attach the remote 15359dc9507fSMathieu Poirier * processor the resource table is clean and ready to be used again. 15369dc9507fSMathieu Poirier */ 15379dc9507fSMathieu Poirier memcpy(table_ptr, rproc->clean_table, rproc->table_sz); 15389dc9507fSMathieu Poirier 15399dc9507fSMathieu Poirier /* 15409dc9507fSMathieu Poirier * The clean resource table is no longer needed. Allocated in 15419dc9507fSMathieu Poirier * rproc_set_rsc_table(). 15429dc9507fSMathieu Poirier */ 15439dc9507fSMathieu Poirier kfree(rproc->clean_table); 15449dc9507fSMathieu Poirier 15459dc9507fSMathieu Poirier return 0; 15469dc9507fSMathieu Poirier } 15479dc9507fSMathieu Poirier 15488088dd4dSMathieu Poirier static int rproc_reset_rsc_table_on_stop(struct rproc *rproc) 15498088dd4dSMathieu Poirier { 15508088dd4dSMathieu Poirier /* A resource table was never retrieved, nothing to do here */ 15518088dd4dSMathieu Poirier if (!rproc->table_ptr) 15528088dd4dSMathieu Poirier return 0; 15538088dd4dSMathieu Poirier 15548088dd4dSMathieu Poirier /* 15558088dd4dSMathieu Poirier * If a cache table exists the remote processor was started by 15568088dd4dSMathieu Poirier * the remoteproc core. That cache table should be used for 15578088dd4dSMathieu Poirier * the rest of the shutdown process. 15588088dd4dSMathieu Poirier */ 15598088dd4dSMathieu Poirier if (rproc->cached_table) 15608088dd4dSMathieu Poirier goto out; 15618088dd4dSMathieu Poirier 15628088dd4dSMathieu Poirier /* 15638088dd4dSMathieu Poirier * If we made it here the remote processor was started by another 15648088dd4dSMathieu Poirier * entity and a cache table doesn't exist. As such make a copy of 15658088dd4dSMathieu Poirier * the resource table currently used by the remote processor and 15668088dd4dSMathieu Poirier * use that for the rest of the shutdown process. The memory 15678088dd4dSMathieu Poirier * allocated here is free'd in rproc_shutdown(). 15688088dd4dSMathieu Poirier */ 15698088dd4dSMathieu Poirier rproc->cached_table = kmemdup(rproc->table_ptr, 15708088dd4dSMathieu Poirier rproc->table_sz, GFP_KERNEL); 15718088dd4dSMathieu Poirier if (!rproc->cached_table) 15728088dd4dSMathieu Poirier return -ENOMEM; 15738088dd4dSMathieu Poirier 15748088dd4dSMathieu Poirier /* 15758088dd4dSMathieu Poirier * Since the remote processor is being switched off the clean table 15768088dd4dSMathieu Poirier * won't be needed. Allocated in rproc_set_rsc_table(). 15778088dd4dSMathieu Poirier */ 15788088dd4dSMathieu Poirier kfree(rproc->clean_table); 15798088dd4dSMathieu Poirier 15808088dd4dSMathieu Poirier out: 15818088dd4dSMathieu Poirier /* 15828088dd4dSMathieu Poirier * Use a copy of the resource table for the remainder of the 15838088dd4dSMathieu Poirier * shutdown process. 15848088dd4dSMathieu Poirier */ 15858088dd4dSMathieu Poirier rproc->table_ptr = rproc->cached_table; 15868088dd4dSMathieu Poirier return 0; 15878088dd4dSMathieu Poirier } 15888088dd4dSMathieu Poirier 1589400e64dfSOhad Ben-Cohen /* 1590fdf0e00eSMathieu Poirier * Attach to remote processor - similar to rproc_fw_boot() but without 1591fdf0e00eSMathieu Poirier * the steps that deal with the firmware image. 1592fdf0e00eSMathieu Poirier */ 15936a6c4dc0SMathieu Poirier static int rproc_attach(struct rproc *rproc) 1594fdf0e00eSMathieu Poirier { 1595fdf0e00eSMathieu Poirier struct device *dev = &rproc->dev; 1596fdf0e00eSMathieu Poirier int ret; 1597fdf0e00eSMathieu Poirier 1598fdf0e00eSMathieu Poirier /* 1599fdf0e00eSMathieu Poirier * if enabling an IOMMU isn't relevant for this rproc, this is 1600fdf0e00eSMathieu Poirier * just a nop 1601fdf0e00eSMathieu Poirier */ 1602fdf0e00eSMathieu Poirier ret = rproc_enable_iommu(rproc); 1603fdf0e00eSMathieu Poirier if (ret) { 1604fdf0e00eSMathieu Poirier dev_err(dev, "can't enable iommu: %d\n", ret); 1605fdf0e00eSMathieu Poirier return ret; 1606fdf0e00eSMathieu Poirier } 1607fdf0e00eSMathieu Poirier 16086e20a051SArnaud POULIQUEN /* Do anything that is needed to boot the remote processor */ 16096e20a051SArnaud POULIQUEN ret = rproc_prepare_device(rproc); 16106e20a051SArnaud POULIQUEN if (ret) { 16116e20a051SArnaud POULIQUEN dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret); 16126e20a051SArnaud POULIQUEN goto disable_iommu; 16136e20a051SArnaud POULIQUEN } 16146e20a051SArnaud POULIQUEN 16151a631382SMathieu Poirier ret = rproc_set_rsc_table(rproc); 16161a631382SMathieu Poirier if (ret) { 16171a631382SMathieu Poirier dev_err(dev, "can't load resource table: %d\n", ret); 16186e20a051SArnaud POULIQUEN goto unprepare_device; 16191a631382SMathieu Poirier } 16201a631382SMathieu Poirier 1621fdf0e00eSMathieu Poirier /* reset max_notifyid */ 1622fdf0e00eSMathieu Poirier rproc->max_notifyid = -1; 1623fdf0e00eSMathieu Poirier 1624fdf0e00eSMathieu Poirier /* reset handled vdev */ 1625fdf0e00eSMathieu Poirier rproc->nb_vdev = 0; 1626fdf0e00eSMathieu Poirier 1627fdf0e00eSMathieu Poirier /* 1628fdf0e00eSMathieu Poirier * Handle firmware resources required to attach to a remote processor. 1629fdf0e00eSMathieu Poirier * Because we are attaching rather than booting the remote processor, 1630fdf0e00eSMathieu Poirier * we expect the platform driver to properly set rproc->table_ptr. 1631fdf0e00eSMathieu Poirier */ 1632fdf0e00eSMathieu Poirier ret = rproc_handle_resources(rproc, rproc_loading_handlers); 1633fdf0e00eSMathieu Poirier if (ret) { 1634fdf0e00eSMathieu Poirier dev_err(dev, "Failed to process resources: %d\n", ret); 16356e20a051SArnaud POULIQUEN goto unprepare_device; 1636fdf0e00eSMathieu Poirier } 1637fdf0e00eSMathieu Poirier 1638fdf0e00eSMathieu Poirier /* Allocate carveout resources associated to rproc */ 1639fdf0e00eSMathieu Poirier ret = rproc_alloc_registered_carveouts(rproc); 1640fdf0e00eSMathieu Poirier if (ret) { 1641fdf0e00eSMathieu Poirier dev_err(dev, "Failed to allocate associated carveouts: %d\n", 1642fdf0e00eSMathieu Poirier ret); 1643fdf0e00eSMathieu Poirier goto clean_up_resources; 1644fdf0e00eSMathieu Poirier } 1645fdf0e00eSMathieu Poirier 16466a6c4dc0SMathieu Poirier ret = __rproc_attach(rproc); 1647fdf0e00eSMathieu Poirier if (ret) 1648fdf0e00eSMathieu Poirier goto clean_up_resources; 1649fdf0e00eSMathieu Poirier 1650fdf0e00eSMathieu Poirier return 0; 1651fdf0e00eSMathieu Poirier 1652fdf0e00eSMathieu Poirier clean_up_resources: 1653fdf0e00eSMathieu Poirier rproc_resource_cleanup(rproc); 16546e20a051SArnaud POULIQUEN unprepare_device: 16556e20a051SArnaud POULIQUEN /* release HW resources if needed */ 16566e20a051SArnaud POULIQUEN rproc_unprepare_device(rproc); 1657fdf0e00eSMathieu Poirier disable_iommu: 1658fdf0e00eSMathieu Poirier rproc_disable_iommu(rproc); 1659fdf0e00eSMathieu Poirier return ret; 1660fdf0e00eSMathieu Poirier } 1661fdf0e00eSMathieu Poirier 1662fdf0e00eSMathieu Poirier /* 16635e6533f7SSarangdhar Joshi * take a firmware and boot it up. 1664400e64dfSOhad Ben-Cohen * 1665400e64dfSOhad Ben-Cohen * Note: this function is called asynchronously upon registration of the 1666400e64dfSOhad Ben-Cohen * remote processor (so we must wait until it completes before we try 1667400e64dfSOhad Ben-Cohen * to unregister the device. one other option is just to use kref here, 1668400e64dfSOhad Ben-Cohen * that might be cleaner). 1669400e64dfSOhad Ben-Cohen */ 16705e6533f7SSarangdhar Joshi static void rproc_auto_boot_callback(const struct firmware *fw, void *context) 1671400e64dfSOhad Ben-Cohen { 1672400e64dfSOhad Ben-Cohen struct rproc *rproc = context; 1673a2b950acSOhad Ben-Cohen 16742bfc311aSBjorn Andersson rproc_boot(rproc); 1675ddf71187SBjorn Andersson 1676400e64dfSOhad Ben-Cohen release_firmware(fw); 1677400e64dfSOhad Ben-Cohen } 1678400e64dfSOhad Ben-Cohen 16795e6533f7SSarangdhar Joshi static int rproc_trigger_auto_boot(struct rproc *rproc) 168070b85ef8SFernando Guzman Lugo { 168170b85ef8SFernando Guzman Lugo int ret; 168270b85ef8SFernando Guzman Lugo 168370b85ef8SFernando Guzman Lugo /* 1684e3d21939SMathieu Poirier * Since the remote processor is in a detached state, it has already 1685e3d21939SMathieu Poirier * been booted by another entity. As such there is no point in waiting 1686e3d21939SMathieu Poirier * for a firmware image to be loaded, we can simply initiate the process 1687e3d21939SMathieu Poirier * of attaching to it immediately. 1688e3d21939SMathieu Poirier */ 1689e3d21939SMathieu Poirier if (rproc->state == RPROC_DETACHED) 1690e3d21939SMathieu Poirier return rproc_boot(rproc); 1691e3d21939SMathieu Poirier 1692e3d21939SMathieu Poirier /* 169370b85ef8SFernando Guzman Lugo * We're initiating an asynchronous firmware loading, so we can 169470b85ef8SFernando Guzman Lugo * be built-in kernel code, without hanging the boot process. 169570b85ef8SFernando Guzman Lugo */ 16960733d839SShawn Guo ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_UEVENT, 169770b85ef8SFernando Guzman Lugo rproc->firmware, &rproc->dev, GFP_KERNEL, 16985e6533f7SSarangdhar Joshi rproc, rproc_auto_boot_callback); 16992099c77dSSarangdhar Joshi if (ret < 0) 170070b85ef8SFernando Guzman Lugo dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret); 170170b85ef8SFernando Guzman Lugo 170270b85ef8SFernando Guzman Lugo return ret; 170370b85ef8SFernando Guzman Lugo } 170470b85ef8SFernando Guzman Lugo 1705880f5b38SBjorn Andersson static int rproc_stop(struct rproc *rproc, bool crashed) 17061efa30d0SSarangdhar Joshi { 17071efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 17081efa30d0SSarangdhar Joshi int ret; 17091efa30d0SSarangdhar Joshi 1710d2008a96SMathieu Poirier /* No need to continue if a stop() operation has not been provided */ 1711d2008a96SMathieu Poirier if (!rproc->ops->stop) 1712d2008a96SMathieu Poirier return -EINVAL; 1713d2008a96SMathieu Poirier 1714618fcff3SBjorn Andersson /* Stop any subdevices for the remote processor */ 1715618fcff3SBjorn Andersson rproc_stop_subdevices(rproc, crashed); 17161efa30d0SSarangdhar Joshi 17170a8b81cbSBjorn Andersson /* the installed resource table is no longer accessible */ 17188088dd4dSMathieu Poirier ret = rproc_reset_rsc_table_on_stop(rproc); 17198088dd4dSMathieu Poirier if (ret) { 17208088dd4dSMathieu Poirier dev_err(dev, "can't reset resource table: %d\n", ret); 17218088dd4dSMathieu Poirier return ret; 17228088dd4dSMathieu Poirier } 17238088dd4dSMathieu Poirier 17240a8b81cbSBjorn Andersson 17251efa30d0SSarangdhar Joshi /* power off the remote processor */ 17261efa30d0SSarangdhar Joshi ret = rproc->ops->stop(rproc); 17271efa30d0SSarangdhar Joshi if (ret) { 17281efa30d0SSarangdhar Joshi dev_err(dev, "can't stop rproc: %d\n", ret); 17291efa30d0SSarangdhar Joshi return ret; 17301efa30d0SSarangdhar Joshi } 17311efa30d0SSarangdhar Joshi 1732c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1733c455daa4SBjorn Andersson 17341efa30d0SSarangdhar Joshi rproc->state = RPROC_OFFLINE; 17351efa30d0SSarangdhar Joshi 17361efa30d0SSarangdhar Joshi dev_info(dev, "stopped remote processor %s\n", rproc->name); 17371efa30d0SSarangdhar Joshi 17381efa30d0SSarangdhar Joshi return 0; 17391efa30d0SSarangdhar Joshi } 17401efa30d0SSarangdhar Joshi 17416070203fSMathieu Poirier /* 17426070203fSMathieu Poirier * __rproc_detach(): Does the opposite of __rproc_attach() 17436070203fSMathieu Poirier */ 1744d3962a39SMathieu Poirier static int __rproc_detach(struct rproc *rproc) 17456070203fSMathieu Poirier { 17466070203fSMathieu Poirier struct device *dev = &rproc->dev; 17476070203fSMathieu Poirier int ret; 17486070203fSMathieu Poirier 17496070203fSMathieu Poirier /* No need to continue if a detach() operation has not been provided */ 17506070203fSMathieu Poirier if (!rproc->ops->detach) 17516070203fSMathieu Poirier return -EINVAL; 17526070203fSMathieu Poirier 17536070203fSMathieu Poirier /* Stop any subdevices for the remote processor */ 17546070203fSMathieu Poirier rproc_stop_subdevices(rproc, false); 17556070203fSMathieu Poirier 17569dc9507fSMathieu Poirier /* the installed resource table is no longer accessible */ 17579dc9507fSMathieu Poirier ret = rproc_reset_rsc_table_on_detach(rproc); 17589dc9507fSMathieu Poirier if (ret) { 17599dc9507fSMathieu Poirier dev_err(dev, "can't reset resource table: %d\n", ret); 17609dc9507fSMathieu Poirier return ret; 17619dc9507fSMathieu Poirier } 17629dc9507fSMathieu Poirier 17636070203fSMathieu Poirier /* Tell the remote processor the core isn't available anymore */ 17646070203fSMathieu Poirier ret = rproc->ops->detach(rproc); 17656070203fSMathieu Poirier if (ret) { 17666070203fSMathieu Poirier dev_err(dev, "can't detach from rproc: %d\n", ret); 17676070203fSMathieu Poirier return ret; 17686070203fSMathieu Poirier } 17696070203fSMathieu Poirier 17706070203fSMathieu Poirier rproc_unprepare_subdevices(rproc); 17716070203fSMathieu Poirier 17726070203fSMathieu Poirier rproc->state = RPROC_DETACHED; 17736070203fSMathieu Poirier 17746070203fSMathieu Poirier dev_info(dev, "detached remote processor %s\n", rproc->name); 17756070203fSMathieu Poirier 17766070203fSMathieu Poirier return 0; 17776070203fSMathieu Poirier } 17782666ca91SSarangdhar Joshi 1779ba194232SPeng Fan static int rproc_attach_recovery(struct rproc *rproc) 1780ba194232SPeng Fan { 1781ba194232SPeng Fan int ret; 1782ba194232SPeng Fan 1783ba194232SPeng Fan ret = __rproc_detach(rproc); 1784ba194232SPeng Fan if (ret) 1785ba194232SPeng Fan return ret; 1786ba194232SPeng Fan 1787ba194232SPeng Fan return __rproc_attach(rproc); 1788ba194232SPeng Fan } 1789ba194232SPeng Fan 1790ba194232SPeng Fan static int rproc_boot_recovery(struct rproc *rproc) 1791ba194232SPeng Fan { 1792ba194232SPeng Fan const struct firmware *firmware_p; 1793ba194232SPeng Fan struct device *dev = &rproc->dev; 1794ba194232SPeng Fan int ret; 1795ba194232SPeng Fan 1796ba194232SPeng Fan ret = rproc_stop(rproc, true); 1797ba194232SPeng Fan if (ret) 1798ba194232SPeng Fan return ret; 1799ba194232SPeng Fan 1800ba194232SPeng Fan /* generate coredump */ 1801ba194232SPeng Fan rproc->ops->coredump(rproc); 1802ba194232SPeng Fan 1803ba194232SPeng Fan /* load firmware */ 1804ba194232SPeng Fan ret = request_firmware(&firmware_p, rproc->firmware, dev); 1805ba194232SPeng Fan if (ret < 0) { 1806ba194232SPeng Fan dev_err(dev, "request_firmware failed: %d\n", ret); 1807ba194232SPeng Fan return ret; 1808ba194232SPeng Fan } 1809ba194232SPeng Fan 1810ba194232SPeng Fan /* boot the remote processor up again */ 1811ba194232SPeng Fan ret = rproc_start(rproc, firmware_p); 1812ba194232SPeng Fan 1813ba194232SPeng Fan release_firmware(firmware_p); 1814ba194232SPeng Fan 1815ba194232SPeng Fan return ret; 1816ba194232SPeng Fan } 1817ba194232SPeng Fan 18182666ca91SSarangdhar Joshi /** 181970b85ef8SFernando Guzman Lugo * rproc_trigger_recovery() - recover a remoteproc 182070b85ef8SFernando Guzman Lugo * @rproc: the remote processor 182170b85ef8SFernando Guzman Lugo * 182256324d7aSAnna, Suman * The recovery is done by resetting all the virtio devices, that way all the 182370b85ef8SFernando Guzman Lugo * rpmsg drivers will be reseted along with the remote processor making the 182470b85ef8SFernando Guzman Lugo * remoteproc functional again. 182570b85ef8SFernando Guzman Lugo * 182670b85ef8SFernando Guzman Lugo * This function can sleep, so it cannot be called from atomic context. 1827f2867434SSuman Anna * 1828f2867434SSuman Anna * Return: 0 on success or a negative value upon failure 182970b85ef8SFernando Guzman Lugo */ 183070b85ef8SFernando Guzman Lugo int rproc_trigger_recovery(struct rproc *rproc) 183170b85ef8SFernando Guzman Lugo { 18327e83cab8SSarangdhar Joshi struct device *dev = &rproc->dev; 18337e83cab8SSarangdhar Joshi int ret; 18347e83cab8SSarangdhar Joshi 18357e83cab8SSarangdhar Joshi ret = mutex_lock_interruptible(&rproc->lock); 18367e83cab8SSarangdhar Joshi if (ret) 18377e83cab8SSarangdhar Joshi return ret; 18387e83cab8SSarangdhar Joshi 18390b145574SAlex Elder /* State could have changed before we got the mutex */ 18400b145574SAlex Elder if (rproc->state != RPROC_CRASHED) 18410b145574SAlex Elder goto unlock_mutex; 18420b145574SAlex Elder 18430b145574SAlex Elder dev_err(dev, "recovering %s\n", rproc->name); 18440b145574SAlex Elder 1845ba194232SPeng Fan if (rproc_has_feature(rproc, RPROC_FEAT_ATTACH_ON_RECOVERY)) 1846ba194232SPeng Fan ret = rproc_attach_recovery(rproc); 1847ba194232SPeng Fan else 1848ba194232SPeng Fan ret = rproc_boot_recovery(rproc); 18497e83cab8SSarangdhar Joshi 18507e83cab8SSarangdhar Joshi unlock_mutex: 18517e83cab8SSarangdhar Joshi mutex_unlock(&rproc->lock); 18527e83cab8SSarangdhar Joshi return ret; 185370b85ef8SFernando Guzman Lugo } 185470b85ef8SFernando Guzman Lugo 1855400e64dfSOhad Ben-Cohen /** 18568afd519cSFernando Guzman Lugo * rproc_crash_handler_work() - handle a crash 18572e7d4c2cSArnaud Pouliquen * @work: work treating the crash 18588afd519cSFernando Guzman Lugo * 18598afd519cSFernando Guzman Lugo * This function needs to handle everything related to a crash, like cpu 18608afd519cSFernando Guzman Lugo * registers and stack dump, information to help to debug the fatal error, etc. 18618afd519cSFernando Guzman Lugo */ 18628afd519cSFernando Guzman Lugo static void rproc_crash_handler_work(struct work_struct *work) 18638afd519cSFernando Guzman Lugo { 18648afd519cSFernando Guzman Lugo struct rproc *rproc = container_of(work, struct rproc, crash_handler); 18658afd519cSFernando Guzman Lugo struct device *dev = &rproc->dev; 18668afd519cSFernando Guzman Lugo 18678afd519cSFernando Guzman Lugo dev_dbg(dev, "enter %s\n", __func__); 18688afd519cSFernando Guzman Lugo 18698afd519cSFernando Guzman Lugo mutex_lock(&rproc->lock); 18708afd519cSFernando Guzman Lugo 18718afd519cSFernando Guzman Lugo if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) { 18728afd519cSFernando Guzman Lugo /* handle only the first crash detected */ 18738afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 18748afd519cSFernando Guzman Lugo return; 18758afd519cSFernando Guzman Lugo } 18768afd519cSFernando Guzman Lugo 18778afd519cSFernando Guzman Lugo rproc->state = RPROC_CRASHED; 18788afd519cSFernando Guzman Lugo dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt, 18798afd519cSFernando Guzman Lugo rproc->name); 18808afd519cSFernando Guzman Lugo 18818afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 18828afd519cSFernando Guzman Lugo 18832e37abb8SFernando Guzman Lugo if (!rproc->recovery_disabled) 188470b85ef8SFernando Guzman Lugo rproc_trigger_recovery(rproc); 1885a781e5aaSRishabh Bhatnagar 1886a781e5aaSRishabh Bhatnagar pm_relax(rproc->dev.parent); 18878afd519cSFernando Guzman Lugo } 18888afd519cSFernando Guzman Lugo 18898afd519cSFernando Guzman Lugo /** 18901b0ef906SSuman Anna * rproc_boot() - boot a remote processor 1891400e64dfSOhad Ben-Cohen * @rproc: handle of a remote processor 1892400e64dfSOhad Ben-Cohen * 1893400e64dfSOhad Ben-Cohen * Boot a remote processor (i.e. load its firmware, power it on, ...). 1894400e64dfSOhad Ben-Cohen * 1895400e64dfSOhad Ben-Cohen * If the remote processor is already powered on, this function immediately 1896400e64dfSOhad Ben-Cohen * returns (successfully). 1897400e64dfSOhad Ben-Cohen * 1898f2867434SSuman Anna * Return: 0 on success, and an appropriate error value otherwise 1899400e64dfSOhad Ben-Cohen */ 19001b0ef906SSuman Anna int rproc_boot(struct rproc *rproc) 1901400e64dfSOhad Ben-Cohen { 1902400e64dfSOhad Ben-Cohen const struct firmware *firmware_p; 1903400e64dfSOhad Ben-Cohen struct device *dev; 1904400e64dfSOhad Ben-Cohen int ret; 1905400e64dfSOhad Ben-Cohen 1906400e64dfSOhad Ben-Cohen if (!rproc) { 1907400e64dfSOhad Ben-Cohen pr_err("invalid rproc handle\n"); 1908400e64dfSOhad Ben-Cohen return -EINVAL; 1909400e64dfSOhad Ben-Cohen } 1910400e64dfSOhad Ben-Cohen 1911b5ab5e24SOhad Ben-Cohen dev = &rproc->dev; 1912400e64dfSOhad Ben-Cohen 1913400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1914400e64dfSOhad Ben-Cohen if (ret) { 1915400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1916400e64dfSOhad Ben-Cohen return ret; 1917400e64dfSOhad Ben-Cohen } 1918400e64dfSOhad Ben-Cohen 19192099c77dSSarangdhar Joshi if (rproc->state == RPROC_DELETED) { 19202099c77dSSarangdhar Joshi ret = -ENODEV; 19212099c77dSSarangdhar Joshi dev_err(dev, "can't boot deleted rproc %s\n", rproc->name); 19222099c77dSSarangdhar Joshi goto unlock_mutex; 19232099c77dSSarangdhar Joshi } 19242099c77dSSarangdhar Joshi 19250f9dc562SMathieu Poirier /* skip the boot or attach process if rproc is already powered up */ 1926400e64dfSOhad Ben-Cohen if (atomic_inc_return(&rproc->power) > 1) { 1927400e64dfSOhad Ben-Cohen ret = 0; 1928400e64dfSOhad Ben-Cohen goto unlock_mutex; 1929400e64dfSOhad Ben-Cohen } 1930400e64dfSOhad Ben-Cohen 19310f9dc562SMathieu Poirier if (rproc->state == RPROC_DETACHED) { 19320f9dc562SMathieu Poirier dev_info(dev, "attaching to %s\n", rproc->name); 19330f9dc562SMathieu Poirier 19346a6c4dc0SMathieu Poirier ret = rproc_attach(rproc); 19350f9dc562SMathieu Poirier } else { 1936400e64dfSOhad Ben-Cohen dev_info(dev, "powering up %s\n", rproc->name); 1937400e64dfSOhad Ben-Cohen 1938400e64dfSOhad Ben-Cohen /* load firmware */ 1939400e64dfSOhad Ben-Cohen ret = request_firmware(&firmware_p, rproc->firmware, dev); 1940400e64dfSOhad Ben-Cohen if (ret < 0) { 1941400e64dfSOhad Ben-Cohen dev_err(dev, "request_firmware failed: %d\n", ret); 1942400e64dfSOhad Ben-Cohen goto downref_rproc; 1943400e64dfSOhad Ben-Cohen } 1944400e64dfSOhad Ben-Cohen 1945400e64dfSOhad Ben-Cohen ret = rproc_fw_boot(rproc, firmware_p); 1946400e64dfSOhad Ben-Cohen 1947400e64dfSOhad Ben-Cohen release_firmware(firmware_p); 19480f9dc562SMathieu Poirier } 1949400e64dfSOhad Ben-Cohen 1950400e64dfSOhad Ben-Cohen downref_rproc: 1951fbb6aacbSBjorn Andersson if (ret) 1952400e64dfSOhad Ben-Cohen atomic_dec(&rproc->power); 1953400e64dfSOhad Ben-Cohen unlock_mutex: 1954400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 1955400e64dfSOhad Ben-Cohen return ret; 1956400e64dfSOhad Ben-Cohen } 1957400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_boot); 1958400e64dfSOhad Ben-Cohen 1959400e64dfSOhad Ben-Cohen /** 1960400e64dfSOhad Ben-Cohen * rproc_shutdown() - power off the remote processor 1961400e64dfSOhad Ben-Cohen * @rproc: the remote processor 1962400e64dfSOhad Ben-Cohen * 1963400e64dfSOhad Ben-Cohen * Power off a remote processor (previously booted with rproc_boot()). 1964400e64dfSOhad Ben-Cohen * 1965400e64dfSOhad Ben-Cohen * In case @rproc is still being used by an additional user(s), then 1966400e64dfSOhad Ben-Cohen * this function will just decrement the power refcount and exit, 1967400e64dfSOhad Ben-Cohen * without really powering off the device. 1968400e64dfSOhad Ben-Cohen * 1969400e64dfSOhad Ben-Cohen * Every call to rproc_boot() must (eventually) be accompanied by a call 1970400e64dfSOhad Ben-Cohen * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug. 1971400e64dfSOhad Ben-Cohen * 1972400e64dfSOhad Ben-Cohen * Notes: 1973400e64dfSOhad Ben-Cohen * - we're not decrementing the rproc's refcount, only the power refcount. 1974400e64dfSOhad Ben-Cohen * which means that the @rproc handle stays valid even after rproc_shutdown() 1975400e64dfSOhad Ben-Cohen * returns, and users can still use it with a subsequent rproc_boot(), if 1976400e64dfSOhad Ben-Cohen * needed. 1977c13b780cSSuman Anna * 1978c13b780cSSuman Anna * Return: 0 on success, and an appropriate error value otherwise 1979400e64dfSOhad Ben-Cohen */ 1980c13b780cSSuman Anna int rproc_shutdown(struct rproc *rproc) 1981400e64dfSOhad Ben-Cohen { 1982b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1983c13b780cSSuman Anna int ret = 0; 1984400e64dfSOhad Ben-Cohen 1985400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1986400e64dfSOhad Ben-Cohen if (ret) { 1987400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1988c13b780cSSuman Anna return ret; 1989400e64dfSOhad Ben-Cohen } 1990400e64dfSOhad Ben-Cohen 19915e6a0e05SShengjiu Wang if (rproc->state != RPROC_RUNNING && 19925e6a0e05SShengjiu Wang rproc->state != RPROC_ATTACHED) { 19935e6a0e05SShengjiu Wang ret = -EINVAL; 19945e6a0e05SShengjiu Wang goto out; 19955e6a0e05SShengjiu Wang } 19965e6a0e05SShengjiu Wang 1997400e64dfSOhad Ben-Cohen /* if the remote proc is still needed, bail out */ 1998400e64dfSOhad Ben-Cohen if (!atomic_dec_and_test(&rproc->power)) 1999400e64dfSOhad Ben-Cohen goto out; 2000400e64dfSOhad Ben-Cohen 2001fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, false); 2002400e64dfSOhad Ben-Cohen if (ret) { 2003400e64dfSOhad Ben-Cohen atomic_inc(&rproc->power); 2004400e64dfSOhad Ben-Cohen goto out; 2005400e64dfSOhad Ben-Cohen } 2006400e64dfSOhad Ben-Cohen 2007400e64dfSOhad Ben-Cohen /* clean up all acquired resources */ 2008400e64dfSOhad Ben-Cohen rproc_resource_cleanup(rproc); 2009400e64dfSOhad Ben-Cohen 201033467ac3SLoic Pallardy /* release HW resources if needed */ 201133467ac3SLoic Pallardy rproc_unprepare_device(rproc); 201233467ac3SLoic Pallardy 2013400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 2014400e64dfSOhad Ben-Cohen 2015988d204cSBjorn Andersson /* Free the copy of the resource table */ 2016a0c10687SBjorn Andersson kfree(rproc->cached_table); 2017a0c10687SBjorn Andersson rproc->cached_table = NULL; 2018988d204cSBjorn Andersson rproc->table_ptr = NULL; 2019400e64dfSOhad Ben-Cohen out: 2020400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 2021c13b780cSSuman Anna return ret; 2022400e64dfSOhad Ben-Cohen } 2023400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_shutdown); 2024400e64dfSOhad Ben-Cohen 2025400e64dfSOhad Ben-Cohen /** 2026d3962a39SMathieu Poirier * rproc_detach() - Detach the remote processor from the 2027d3962a39SMathieu Poirier * remoteproc core 2028d3962a39SMathieu Poirier * 2029d3962a39SMathieu Poirier * @rproc: the remote processor 2030d3962a39SMathieu Poirier * 2031d3962a39SMathieu Poirier * Detach a remote processor (previously attached to with rproc_attach()). 2032d3962a39SMathieu Poirier * 2033d3962a39SMathieu Poirier * In case @rproc is still being used by an additional user(s), then 2034d3962a39SMathieu Poirier * this function will just decrement the power refcount and exit, 2035d3962a39SMathieu Poirier * without disconnecting the device. 2036d3962a39SMathieu Poirier * 2037d3962a39SMathieu Poirier * Function rproc_detach() calls __rproc_detach() in order to let a remote 2038d3962a39SMathieu Poirier * processor know that services provided by the application processor are 2039d3962a39SMathieu Poirier * no longer available. From there it should be possible to remove the 2040d3962a39SMathieu Poirier * platform driver and even power cycle the application processor (if the HW 2041d3962a39SMathieu Poirier * supports it) without needing to switch off the remote processor. 2042f2867434SSuman Anna * 2043f2867434SSuman Anna * Return: 0 on success, and an appropriate error value otherwise 2044d3962a39SMathieu Poirier */ 2045d3962a39SMathieu Poirier int rproc_detach(struct rproc *rproc) 2046d3962a39SMathieu Poirier { 2047d3962a39SMathieu Poirier struct device *dev = &rproc->dev; 2048d3962a39SMathieu Poirier int ret; 2049d3962a39SMathieu Poirier 2050d3962a39SMathieu Poirier ret = mutex_lock_interruptible(&rproc->lock); 2051d3962a39SMathieu Poirier if (ret) { 2052d3962a39SMathieu Poirier dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 2053d3962a39SMathieu Poirier return ret; 2054d3962a39SMathieu Poirier } 2055d3962a39SMathieu Poirier 20565e6a0e05SShengjiu Wang if (rproc->state != RPROC_ATTACHED) { 20575e6a0e05SShengjiu Wang ret = -EINVAL; 20585e6a0e05SShengjiu Wang goto out; 20595e6a0e05SShengjiu Wang } 20605e6a0e05SShengjiu Wang 2061d3962a39SMathieu Poirier /* if the remote proc is still needed, bail out */ 2062d3962a39SMathieu Poirier if (!atomic_dec_and_test(&rproc->power)) { 2063d3962a39SMathieu Poirier ret = 0; 2064d3962a39SMathieu Poirier goto out; 2065d3962a39SMathieu Poirier } 2066d3962a39SMathieu Poirier 2067d3962a39SMathieu Poirier ret = __rproc_detach(rproc); 2068d3962a39SMathieu Poirier if (ret) { 2069d3962a39SMathieu Poirier atomic_inc(&rproc->power); 2070d3962a39SMathieu Poirier goto out; 2071d3962a39SMathieu Poirier } 2072d3962a39SMathieu Poirier 2073d3962a39SMathieu Poirier /* clean up all acquired resources */ 2074d3962a39SMathieu Poirier rproc_resource_cleanup(rproc); 2075d3962a39SMathieu Poirier 2076d3962a39SMathieu Poirier /* release HW resources if needed */ 2077d3962a39SMathieu Poirier rproc_unprepare_device(rproc); 2078d3962a39SMathieu Poirier 2079d3962a39SMathieu Poirier rproc_disable_iommu(rproc); 2080d3962a39SMathieu Poirier 20819dc9507fSMathieu Poirier /* Free the copy of the resource table */ 20829dc9507fSMathieu Poirier kfree(rproc->cached_table); 20839dc9507fSMathieu Poirier rproc->cached_table = NULL; 2084d3962a39SMathieu Poirier rproc->table_ptr = NULL; 2085d3962a39SMathieu Poirier out: 2086d3962a39SMathieu Poirier mutex_unlock(&rproc->lock); 2087d3962a39SMathieu Poirier return ret; 2088d3962a39SMathieu Poirier } 2089d3962a39SMathieu Poirier EXPORT_SYMBOL(rproc_detach); 2090d3962a39SMathieu Poirier 2091d3962a39SMathieu Poirier /** 2092fec47d86SDave Gerlach * rproc_get_by_phandle() - find a remote processor by phandle 2093fec47d86SDave Gerlach * @phandle: phandle to the rproc 2094fec47d86SDave Gerlach * 2095fec47d86SDave Gerlach * Finds an rproc handle using the remote processor's phandle, and then 2096fec47d86SDave Gerlach * return a handle to the rproc. 2097fec47d86SDave Gerlach * 2098fec47d86SDave Gerlach * This function increments the remote processor's refcount, so always 2099fec47d86SDave Gerlach * use rproc_put() to decrement it back once rproc isn't needed anymore. 2100fec47d86SDave Gerlach * 2101f2867434SSuman Anna * Return: rproc handle on success, and NULL on failure 2102fec47d86SDave Gerlach */ 21038de3dbd0SOhad Ben-Cohen #ifdef CONFIG_OF 2104fec47d86SDave Gerlach struct rproc *rproc_get_by_phandle(phandle phandle) 2105fec47d86SDave Gerlach { 2106fec47d86SDave Gerlach struct rproc *rproc = NULL, *r; 2107fec47d86SDave Gerlach struct device_node *np; 2108fec47d86SDave Gerlach 2109fec47d86SDave Gerlach np = of_find_node_by_phandle(phandle); 2110fec47d86SDave Gerlach if (!np) 2111fec47d86SDave Gerlach return NULL; 2112fec47d86SDave Gerlach 2113c0abe2caSBjorn Andersson rcu_read_lock(); 2114c0abe2caSBjorn Andersson list_for_each_entry_rcu(r, &rproc_list, node) { 2115fec47d86SDave Gerlach if (r->dev.parent && r->dev.parent->of_node == np) { 2116fbb6aacbSBjorn Andersson /* prevent underlying implementation from being removed */ 2117fbb6aacbSBjorn Andersson if (!try_module_get(r->dev.parent->driver->owner)) { 2118fbb6aacbSBjorn Andersson dev_err(&r->dev, "can't get owner\n"); 2119fbb6aacbSBjorn Andersson break; 2120fbb6aacbSBjorn Andersson } 2121fbb6aacbSBjorn Andersson 2122fec47d86SDave Gerlach rproc = r; 2123fec47d86SDave Gerlach get_device(&rproc->dev); 2124fec47d86SDave Gerlach break; 2125fec47d86SDave Gerlach } 2126fec47d86SDave Gerlach } 2127c0abe2caSBjorn Andersson rcu_read_unlock(); 2128fec47d86SDave Gerlach 2129fec47d86SDave Gerlach of_node_put(np); 2130fec47d86SDave Gerlach 2131fec47d86SDave Gerlach return rproc; 2132fec47d86SDave Gerlach } 21338de3dbd0SOhad Ben-Cohen #else 21348de3dbd0SOhad Ben-Cohen struct rproc *rproc_get_by_phandle(phandle phandle) 21358de3dbd0SOhad Ben-Cohen { 21368de3dbd0SOhad Ben-Cohen return NULL; 21378de3dbd0SOhad Ben-Cohen } 21388de3dbd0SOhad Ben-Cohen #endif 2139fec47d86SDave Gerlach EXPORT_SYMBOL(rproc_get_by_phandle); 2140fec47d86SDave Gerlach 21414c1ad562SSuman Anna /** 21424c1ad562SSuman Anna * rproc_set_firmware() - assign a new firmware 21434c1ad562SSuman Anna * @rproc: rproc handle to which the new firmware is being assigned 21444c1ad562SSuman Anna * @fw_name: new firmware name to be assigned 21454c1ad562SSuman Anna * 21464c1ad562SSuman Anna * This function allows remoteproc drivers or clients to configure a custom 21474c1ad562SSuman Anna * firmware name that is different from the default name used during remoteproc 21484c1ad562SSuman Anna * registration. The function does not trigger a remote processor boot, 21494c1ad562SSuman Anna * only sets the firmware name used for a subsequent boot. This function 21504c1ad562SSuman Anna * should also be called only when the remote processor is offline. 21514c1ad562SSuman Anna * 21524c1ad562SSuman Anna * This allows either the userspace to configure a different name through 21534c1ad562SSuman Anna * sysfs or a kernel-level remoteproc or a remoteproc client driver to set 21544c1ad562SSuman Anna * a specific firmware when it is controlling the boot and shutdown of the 21554c1ad562SSuman Anna * remote processor. 21564c1ad562SSuman Anna * 21574c1ad562SSuman Anna * Return: 0 on success or a negative value upon failure 21584c1ad562SSuman Anna */ 21594c1ad562SSuman Anna int rproc_set_firmware(struct rproc *rproc, const char *fw_name) 21604c1ad562SSuman Anna { 21614c1ad562SSuman Anna struct device *dev; 21624c1ad562SSuman Anna int ret, len; 21634c1ad562SSuman Anna char *p; 21644c1ad562SSuman Anna 21654c1ad562SSuman Anna if (!rproc || !fw_name) 21664c1ad562SSuman Anna return -EINVAL; 21674c1ad562SSuman Anna 21684c1ad562SSuman Anna dev = rproc->dev.parent; 21694c1ad562SSuman Anna 21704c1ad562SSuman Anna ret = mutex_lock_interruptible(&rproc->lock); 21714c1ad562SSuman Anna if (ret) { 21724c1ad562SSuman Anna dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 21734c1ad562SSuman Anna return -EINVAL; 21744c1ad562SSuman Anna } 21754c1ad562SSuman Anna 21764c1ad562SSuman Anna if (rproc->state != RPROC_OFFLINE) { 21774c1ad562SSuman Anna dev_err(dev, "can't change firmware while running\n"); 21784c1ad562SSuman Anna ret = -EBUSY; 21794c1ad562SSuman Anna goto out; 21804c1ad562SSuman Anna } 21814c1ad562SSuman Anna 21824c1ad562SSuman Anna len = strcspn(fw_name, "\n"); 21834c1ad562SSuman Anna if (!len) { 21844c1ad562SSuman Anna dev_err(dev, "can't provide empty string for firmware name\n"); 21854c1ad562SSuman Anna ret = -EINVAL; 21864c1ad562SSuman Anna goto out; 21874c1ad562SSuman Anna } 21884c1ad562SSuman Anna 21894c1ad562SSuman Anna p = kstrndup(fw_name, len, GFP_KERNEL); 21904c1ad562SSuman Anna if (!p) { 21914c1ad562SSuman Anna ret = -ENOMEM; 21924c1ad562SSuman Anna goto out; 21934c1ad562SSuman Anna } 21944c1ad562SSuman Anna 219543d3f2c7SDaniele Alessandrelli kfree_const(rproc->firmware); 21964c1ad562SSuman Anna rproc->firmware = p; 21974c1ad562SSuman Anna 21984c1ad562SSuman Anna out: 21994c1ad562SSuman Anna mutex_unlock(&rproc->lock); 22004c1ad562SSuman Anna return ret; 22014c1ad562SSuman Anna } 22024c1ad562SSuman Anna EXPORT_SYMBOL(rproc_set_firmware); 22034c1ad562SSuman Anna 220488d3a136SMathieu Poirier static int rproc_validate(struct rproc *rproc) 220588d3a136SMathieu Poirier { 220688d3a136SMathieu Poirier switch (rproc->state) { 220788d3a136SMathieu Poirier case RPROC_OFFLINE: 220888d3a136SMathieu Poirier /* 220988d3a136SMathieu Poirier * An offline processor without a start() 221088d3a136SMathieu Poirier * function makes no sense. 221188d3a136SMathieu Poirier */ 221288d3a136SMathieu Poirier if (!rproc->ops->start) 221388d3a136SMathieu Poirier return -EINVAL; 221488d3a136SMathieu Poirier break; 221588d3a136SMathieu Poirier case RPROC_DETACHED: 221688d3a136SMathieu Poirier /* 221788d3a136SMathieu Poirier * A remote processor in a detached state without an 221888d3a136SMathieu Poirier * attach() function makes not sense. 221988d3a136SMathieu Poirier */ 222088d3a136SMathieu Poirier if (!rproc->ops->attach) 222188d3a136SMathieu Poirier return -EINVAL; 222288d3a136SMathieu Poirier /* 222388d3a136SMathieu Poirier * When attaching to a remote processor the device memory 222488d3a136SMathieu Poirier * is already available and as such there is no need to have a 222588d3a136SMathieu Poirier * cached table. 222688d3a136SMathieu Poirier */ 222788d3a136SMathieu Poirier if (rproc->cached_table) 222888d3a136SMathieu Poirier return -EINVAL; 222988d3a136SMathieu Poirier break; 223088d3a136SMathieu Poirier default: 223188d3a136SMathieu Poirier /* 223288d3a136SMathieu Poirier * When adding a remote processor, the state of the device 223388d3a136SMathieu Poirier * can be offline or detached, nothing else. 223488d3a136SMathieu Poirier */ 223588d3a136SMathieu Poirier return -EINVAL; 223688d3a136SMathieu Poirier } 223788d3a136SMathieu Poirier 223888d3a136SMathieu Poirier return 0; 223988d3a136SMathieu Poirier } 224088d3a136SMathieu Poirier 2241fec47d86SDave Gerlach /** 2242160e7c84SOhad Ben-Cohen * rproc_add() - register a remote processor 2243400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle to register 2244400e64dfSOhad Ben-Cohen * 2245400e64dfSOhad Ben-Cohen * Registers @rproc with the remoteproc framework, after it has been 2246400e64dfSOhad Ben-Cohen * allocated with rproc_alloc(). 2247400e64dfSOhad Ben-Cohen * 2248400e64dfSOhad Ben-Cohen * This is called by the platform-specific rproc implementation, whenever 2249400e64dfSOhad Ben-Cohen * a new remote processor device is probed. 2250400e64dfSOhad Ben-Cohen * 2251400e64dfSOhad Ben-Cohen * Note: this function initiates an asynchronous firmware loading 2252400e64dfSOhad Ben-Cohen * context, which will look for virtio devices supported by the rproc's 2253400e64dfSOhad Ben-Cohen * firmware. 2254400e64dfSOhad Ben-Cohen * 2255400e64dfSOhad Ben-Cohen * If found, those virtio devices will be created and added, so as a result 22567a186941SOhad Ben-Cohen * of registering this remote processor, additional virtio drivers might be 2257400e64dfSOhad Ben-Cohen * probed. 2258f2867434SSuman Anna * 2259f2867434SSuman Anna * Return: 0 on success and an appropriate error code otherwise 2260400e64dfSOhad Ben-Cohen */ 2261160e7c84SOhad Ben-Cohen int rproc_add(struct rproc *rproc) 2262400e64dfSOhad Ben-Cohen { 2263b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 226470b85ef8SFernando Guzman Lugo int ret; 2265400e64dfSOhad Ben-Cohen 226688d3a136SMathieu Poirier ret = rproc_validate(rproc); 226788d3a136SMathieu Poirier if (ret < 0) 226888d3a136SMathieu Poirier return ret; 226988d3a136SMathieu Poirier 227062b8f9e9SSiddharth Gupta /* add char device for this remoteproc */ 227162b8f9e9SSiddharth Gupta ret = rproc_char_device_add(rproc); 227262b8f9e9SSiddharth Gupta if (ret < 0) 227362b8f9e9SSiddharth Gupta return ret; 227462b8f9e9SSiddharth Gupta 2275305ac5a7SPaul Cercueil ret = device_add(dev); 22767dbdb8bdSSiddharth Gupta if (ret < 0) { 22777dbdb8bdSSiddharth Gupta put_device(dev); 22787dbdb8bdSSiddharth Gupta goto rproc_remove_cdev; 22797dbdb8bdSSiddharth Gupta } 2280305ac5a7SPaul Cercueil 2281305ac5a7SPaul Cercueil dev_info(dev, "%s is available\n", rproc->name); 2282305ac5a7SPaul Cercueil 2283305ac5a7SPaul Cercueil /* create debugfs entries */ 2284305ac5a7SPaul Cercueil rproc_create_debug_dir(rproc); 2285305ac5a7SPaul Cercueil 22867a20c64dSSarangdhar Joshi /* if rproc is marked always-on, request it to boot */ 22877a20c64dSSarangdhar Joshi if (rproc->auto_boot) { 22885e6533f7SSarangdhar Joshi ret = rproc_trigger_auto_boot(rproc); 2289d2e12e66SDave Gerlach if (ret < 0) 22907dbdb8bdSSiddharth Gupta goto rproc_remove_dev; 22917a20c64dSSarangdhar Joshi } 2292400e64dfSOhad Ben-Cohen 2293d2e12e66SDave Gerlach /* expose to rproc_get_by_phandle users */ 2294d2e12e66SDave Gerlach mutex_lock(&rproc_list_mutex); 2295c0abe2caSBjorn Andersson list_add_rcu(&rproc->node, &rproc_list); 2296d2e12e66SDave Gerlach mutex_unlock(&rproc_list_mutex); 2297d2e12e66SDave Gerlach 2298d2e12e66SDave Gerlach return 0; 22997dbdb8bdSSiddharth Gupta 23007dbdb8bdSSiddharth Gupta rproc_remove_dev: 23017dbdb8bdSSiddharth Gupta rproc_delete_debug_dir(rproc); 23027dbdb8bdSSiddharth Gupta device_del(dev); 23037dbdb8bdSSiddharth Gupta rproc_remove_cdev: 23047dbdb8bdSSiddharth Gupta rproc_char_device_remove(rproc); 23057dbdb8bdSSiddharth Gupta return ret; 2306400e64dfSOhad Ben-Cohen } 2307160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_add); 2308400e64dfSOhad Ben-Cohen 2309305ac5a7SPaul Cercueil static void devm_rproc_remove(void *rproc) 2310305ac5a7SPaul Cercueil { 2311305ac5a7SPaul Cercueil rproc_del(rproc); 2312305ac5a7SPaul Cercueil } 2313305ac5a7SPaul Cercueil 2314305ac5a7SPaul Cercueil /** 2315305ac5a7SPaul Cercueil * devm_rproc_add() - resource managed rproc_add() 2316305ac5a7SPaul Cercueil * @dev: the underlying device 2317305ac5a7SPaul Cercueil * @rproc: the remote processor handle to register 2318305ac5a7SPaul Cercueil * 2319305ac5a7SPaul Cercueil * This function performs like rproc_add() but the registered rproc device will 2320305ac5a7SPaul Cercueil * automatically be removed on driver detach. 2321305ac5a7SPaul Cercueil * 2322f2867434SSuman Anna * Return: 0 on success, negative errno on failure 2323305ac5a7SPaul Cercueil */ 2324305ac5a7SPaul Cercueil int devm_rproc_add(struct device *dev, struct rproc *rproc) 2325305ac5a7SPaul Cercueil { 2326305ac5a7SPaul Cercueil int err; 2327305ac5a7SPaul Cercueil 2328305ac5a7SPaul Cercueil err = rproc_add(rproc); 2329305ac5a7SPaul Cercueil if (err) 2330305ac5a7SPaul Cercueil return err; 2331305ac5a7SPaul Cercueil 2332305ac5a7SPaul Cercueil return devm_add_action_or_reset(dev, devm_rproc_remove, rproc); 2333305ac5a7SPaul Cercueil } 2334305ac5a7SPaul Cercueil EXPORT_SYMBOL(devm_rproc_add); 2335305ac5a7SPaul Cercueil 2336400e64dfSOhad Ben-Cohen /** 2337b5ab5e24SOhad Ben-Cohen * rproc_type_release() - release a remote processor instance 2338b5ab5e24SOhad Ben-Cohen * @dev: the rproc's device 2339b5ab5e24SOhad Ben-Cohen * 2340b5ab5e24SOhad Ben-Cohen * This function should _never_ be called directly. 2341b5ab5e24SOhad Ben-Cohen * 2342b5ab5e24SOhad Ben-Cohen * It will be called by the driver core when no one holds a valid pointer 2343b5ab5e24SOhad Ben-Cohen * to @dev anymore. 2344b5ab5e24SOhad Ben-Cohen */ 2345b5ab5e24SOhad Ben-Cohen static void rproc_type_release(struct device *dev) 2346b5ab5e24SOhad Ben-Cohen { 2347b5ab5e24SOhad Ben-Cohen struct rproc *rproc = container_of(dev, struct rproc, dev); 2348b5ab5e24SOhad Ben-Cohen 23497183a2a7SOhad Ben-Cohen dev_info(&rproc->dev, "releasing %s\n", rproc->name); 23507183a2a7SOhad Ben-Cohen 2351b5ab5e24SOhad Ben-Cohen idr_destroy(&rproc->notifyids); 2352b5ab5e24SOhad Ben-Cohen 2353b5ab5e24SOhad Ben-Cohen if (rproc->index >= 0) 235408333b91Skeliu ida_free(&rproc_dev_index, rproc->index); 2355b5ab5e24SOhad Ben-Cohen 23561487dedaSMathieu Poirier kfree_const(rproc->firmware); 2357db655278SSuman Anna kfree_const(rproc->name); 2358fb98e2bdSBjorn Andersson kfree(rproc->ops); 2359b5ab5e24SOhad Ben-Cohen kfree(rproc); 2360b5ab5e24SOhad Ben-Cohen } 2361b5ab5e24SOhad Ben-Cohen 2362c42ca04dSBhumika Goyal static const struct device_type rproc_type = { 2363b5ab5e24SOhad Ben-Cohen .name = "remoteproc", 2364b5ab5e24SOhad Ben-Cohen .release = rproc_type_release, 2365b5ab5e24SOhad Ben-Cohen }; 2366400e64dfSOhad Ben-Cohen 23670c2ae2b1SMathieu Poirier static int rproc_alloc_firmware(struct rproc *rproc, 23680c2ae2b1SMathieu Poirier const char *name, const char *firmware) 23690c2ae2b1SMathieu Poirier { 23701487dedaSMathieu Poirier const char *p; 23710c2ae2b1SMathieu Poirier 23720c2ae2b1SMathieu Poirier /* 23739d5f82c8SMathieu Poirier * Allocate a firmware name if the caller gave us one to work 23749d5f82c8SMathieu Poirier * with. Otherwise construct a new one using a default pattern. 23750c2ae2b1SMathieu Poirier */ 23769d5f82c8SMathieu Poirier if (firmware) 23771487dedaSMathieu Poirier p = kstrdup_const(firmware, GFP_KERNEL); 23789d5f82c8SMathieu Poirier else 23799d5f82c8SMathieu Poirier p = kasprintf(GFP_KERNEL, "rproc-%s-fw", name); 23804df4f8beSMathieu Poirier 23810c2ae2b1SMathieu Poirier if (!p) 23820c2ae2b1SMathieu Poirier return -ENOMEM; 23830c2ae2b1SMathieu Poirier 23840c2ae2b1SMathieu Poirier rproc->firmware = p; 23850c2ae2b1SMathieu Poirier 23860c2ae2b1SMathieu Poirier return 0; 23870c2ae2b1SMathieu Poirier } 23880c2ae2b1SMathieu Poirier 2389bf860aa1SMathieu Poirier static int rproc_alloc_ops(struct rproc *rproc, const struct rproc_ops *ops) 2390bf860aa1SMathieu Poirier { 2391bf860aa1SMathieu Poirier rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL); 2392bf860aa1SMathieu Poirier if (!rproc->ops) 2393bf860aa1SMathieu Poirier return -ENOMEM; 2394bf860aa1SMathieu Poirier 2395adf60a87SSiddharth Gupta /* Default to rproc_coredump if no coredump function is specified */ 2396adf60a87SSiddharth Gupta if (!rproc->ops->coredump) 2397adf60a87SSiddharth Gupta rproc->ops->coredump = rproc_coredump; 2398adf60a87SSiddharth Gupta 2399bf860aa1SMathieu Poirier if (rproc->ops->load) 2400bf860aa1SMathieu Poirier return 0; 2401bf860aa1SMathieu Poirier 2402bf860aa1SMathieu Poirier /* Default to ELF loader if no load function is specified */ 2403bf860aa1SMathieu Poirier rproc->ops->load = rproc_elf_load_segments; 2404bf860aa1SMathieu Poirier rproc->ops->parse_fw = rproc_elf_load_rsc_table; 2405bf860aa1SMathieu Poirier rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table; 2406e29ff72bSClement Leger rproc->ops->sanity_check = rproc_elf_sanity_check; 2407bf860aa1SMathieu Poirier rproc->ops->get_boot_addr = rproc_elf_get_boot_addr; 2408bf860aa1SMathieu Poirier 2409bf860aa1SMathieu Poirier return 0; 2410bf860aa1SMathieu Poirier } 2411bf860aa1SMathieu Poirier 2412400e64dfSOhad Ben-Cohen /** 2413400e64dfSOhad Ben-Cohen * rproc_alloc() - allocate a remote processor handle 2414400e64dfSOhad Ben-Cohen * @dev: the underlying device 2415400e64dfSOhad Ben-Cohen * @name: name of this remote processor 2416400e64dfSOhad Ben-Cohen * @ops: platform-specific handlers (mainly start/stop) 24178b4aec9aSRobert Tivy * @firmware: name of firmware file to load, can be NULL 2418400e64dfSOhad Ben-Cohen * @len: length of private data needed by the rproc driver (in bytes) 2419400e64dfSOhad Ben-Cohen * 2420400e64dfSOhad Ben-Cohen * Allocates a new remote processor handle, but does not register 24218b4aec9aSRobert Tivy * it yet. if @firmware is NULL, a default name is used. 2422400e64dfSOhad Ben-Cohen * 2423400e64dfSOhad Ben-Cohen * This function should be used by rproc implementations during initialization 2424400e64dfSOhad Ben-Cohen * of the remote processor. 2425400e64dfSOhad Ben-Cohen * 2426400e64dfSOhad Ben-Cohen * After creating an rproc handle using this function, and when ready, 2427160e7c84SOhad Ben-Cohen * implementations should then call rproc_add() to complete 2428400e64dfSOhad Ben-Cohen * the registration of the remote processor. 2429400e64dfSOhad Ben-Cohen * 2430400e64dfSOhad Ben-Cohen * Note: _never_ directly deallocate @rproc, even if it was not registered 2431433c0e04SBjorn Andersson * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free(). 2432f2867434SSuman Anna * 2433f2867434SSuman Anna * Return: new rproc pointer on success, and NULL on failure 2434400e64dfSOhad Ben-Cohen */ 2435400e64dfSOhad Ben-Cohen struct rproc *rproc_alloc(struct device *dev, const char *name, 2436400e64dfSOhad Ben-Cohen const struct rproc_ops *ops, 2437400e64dfSOhad Ben-Cohen const char *firmware, int len) 2438400e64dfSOhad Ben-Cohen { 2439400e64dfSOhad Ben-Cohen struct rproc *rproc; 2440400e64dfSOhad Ben-Cohen 2441400e64dfSOhad Ben-Cohen if (!dev || !name || !ops) 2442400e64dfSOhad Ben-Cohen return NULL; 2443400e64dfSOhad Ben-Cohen 24440f57dc6aSMatt Redfearn rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL); 24450c2ae2b1SMathieu Poirier if (!rproc) 24460f57dc6aSMatt Redfearn return NULL; 24470c2ae2b1SMathieu Poirier 2448400e64dfSOhad Ben-Cohen rproc->priv = &rproc[1]; 2449ddf71187SBjorn Andersson rproc->auto_boot = true; 2450418fd787SClement Leger rproc->elf_class = ELFCLASSNONE; 2451418fd787SClement Leger rproc->elf_machine = EM_NONE; 2452400e64dfSOhad Ben-Cohen 2453b5ab5e24SOhad Ben-Cohen device_initialize(&rproc->dev); 2454b5ab5e24SOhad Ben-Cohen rproc->dev.parent = dev; 2455b5ab5e24SOhad Ben-Cohen rproc->dev.type = &rproc_type; 24562aefbef0SMatt Redfearn rproc->dev.class = &rproc_class; 24577c89717fSBjorn Andersson rproc->dev.driver_data = rproc; 24586442df49SAlex Elder idr_init(&rproc->notifyids); 2459b5ab5e24SOhad Ben-Cohen 2460db655278SSuman Anna rproc->name = kstrdup_const(name, GFP_KERNEL); 2461db655278SSuman Anna if (!rproc->name) 2462db655278SSuman Anna goto put_device; 2463db655278SSuman Anna 2464226f5db4SMathieu Poirier if (rproc_alloc_firmware(rproc, name, firmware)) 2465226f5db4SMathieu Poirier goto put_device; 2466226f5db4SMathieu Poirier 2467226f5db4SMathieu Poirier if (rproc_alloc_ops(rproc, ops)) 2468226f5db4SMathieu Poirier goto put_device; 2469226f5db4SMathieu Poirier 2470b5ab5e24SOhad Ben-Cohen /* Assign a unique device index and name */ 247108333b91Skeliu rproc->index = ida_alloc(&rproc_dev_index, GFP_KERNEL); 2472b5ab5e24SOhad Ben-Cohen if (rproc->index < 0) { 247308333b91Skeliu dev_err(dev, "ida_alloc failed: %d\n", rproc->index); 2474226f5db4SMathieu Poirier goto put_device; 2475b5ab5e24SOhad Ben-Cohen } 2476b5ab5e24SOhad Ben-Cohen 2477b5ab5e24SOhad Ben-Cohen dev_set_name(&rproc->dev, "remoteproc%d", rproc->index); 2478b5ab5e24SOhad Ben-Cohen 2479400e64dfSOhad Ben-Cohen atomic_set(&rproc->power, 0); 2480400e64dfSOhad Ben-Cohen 2481400e64dfSOhad Ben-Cohen mutex_init(&rproc->lock); 2482400e64dfSOhad Ben-Cohen 2483400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->carveouts); 2484400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->mappings); 2485400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->traces); 24867a186941SOhad Ben-Cohen INIT_LIST_HEAD(&rproc->rvdevs); 24877bdc9650SBjorn Andersson INIT_LIST_HEAD(&rproc->subdevs); 24882666ca91SSarangdhar Joshi INIT_LIST_HEAD(&rproc->dump_segments); 2489400e64dfSOhad Ben-Cohen 24908afd519cSFernando Guzman Lugo INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work); 24918afd519cSFernando Guzman Lugo 2492400e64dfSOhad Ben-Cohen rproc->state = RPROC_OFFLINE; 2493400e64dfSOhad Ben-Cohen 2494400e64dfSOhad Ben-Cohen return rproc; 24950c2ae2b1SMathieu Poirier 2496226f5db4SMathieu Poirier put_device: 2497226f5db4SMathieu Poirier put_device(&rproc->dev); 24980c2ae2b1SMathieu Poirier return NULL; 2499400e64dfSOhad Ben-Cohen } 2500400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_alloc); 2501400e64dfSOhad Ben-Cohen 2502400e64dfSOhad Ben-Cohen /** 2503433c0e04SBjorn Andersson * rproc_free() - unroll rproc_alloc() 2504433c0e04SBjorn Andersson * @rproc: the remote processor handle 2505433c0e04SBjorn Andersson * 2506433c0e04SBjorn Andersson * This function decrements the rproc dev refcount. 2507433c0e04SBjorn Andersson * 2508433c0e04SBjorn Andersson * If no one holds any reference to rproc anymore, then its refcount would 2509433c0e04SBjorn Andersson * now drop to zero, and it would be freed. 2510433c0e04SBjorn Andersson */ 2511433c0e04SBjorn Andersson void rproc_free(struct rproc *rproc) 2512433c0e04SBjorn Andersson { 2513433c0e04SBjorn Andersson put_device(&rproc->dev); 2514433c0e04SBjorn Andersson } 2515433c0e04SBjorn Andersson EXPORT_SYMBOL(rproc_free); 2516433c0e04SBjorn Andersson 2517433c0e04SBjorn Andersson /** 2518433c0e04SBjorn Andersson * rproc_put() - release rproc reference 2519400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle 2520400e64dfSOhad Ben-Cohen * 2521c6b5a276SOhad Ben-Cohen * This function decrements the rproc dev refcount. 2522400e64dfSOhad Ben-Cohen * 2523c6b5a276SOhad Ben-Cohen * If no one holds any reference to rproc anymore, then its refcount would 2524c6b5a276SOhad Ben-Cohen * now drop to zero, and it would be freed. 2525400e64dfSOhad Ben-Cohen */ 2526160e7c84SOhad Ben-Cohen void rproc_put(struct rproc *rproc) 2527400e64dfSOhad Ben-Cohen { 2528fbb6aacbSBjorn Andersson module_put(rproc->dev.parent->driver->owner); 2529b5ab5e24SOhad Ben-Cohen put_device(&rproc->dev); 2530400e64dfSOhad Ben-Cohen } 2531160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_put); 2532400e64dfSOhad Ben-Cohen 2533400e64dfSOhad Ben-Cohen /** 2534160e7c84SOhad Ben-Cohen * rproc_del() - unregister a remote processor 2535400e64dfSOhad Ben-Cohen * @rproc: rproc handle to unregister 2536400e64dfSOhad Ben-Cohen * 2537400e64dfSOhad Ben-Cohen * This function should be called when the platform specific rproc 2538400e64dfSOhad Ben-Cohen * implementation decides to remove the rproc device. it should 2539160e7c84SOhad Ben-Cohen * _only_ be called if a previous invocation of rproc_add() 2540400e64dfSOhad Ben-Cohen * has completed successfully. 2541400e64dfSOhad Ben-Cohen * 2542160e7c84SOhad Ben-Cohen * After rproc_del() returns, @rproc isn't freed yet, because 2543c6b5a276SOhad Ben-Cohen * of the outstanding reference created by rproc_alloc. To decrement that 2544433c0e04SBjorn Andersson * one last refcount, one still needs to call rproc_free(). 2545400e64dfSOhad Ben-Cohen * 2546f2867434SSuman Anna * Return: 0 on success and -EINVAL if @rproc isn't valid 2547400e64dfSOhad Ben-Cohen */ 2548160e7c84SOhad Ben-Cohen int rproc_del(struct rproc *rproc) 2549400e64dfSOhad Ben-Cohen { 2550400e64dfSOhad Ben-Cohen if (!rproc) 2551400e64dfSOhad Ben-Cohen return -EINVAL; 2552400e64dfSOhad Ben-Cohen 2553ddf71187SBjorn Andersson /* TODO: make sure this works with rproc->power > 1 */ 2554ddf71187SBjorn Andersson rproc_shutdown(rproc); 2555ddf71187SBjorn Andersson 25562099c77dSSarangdhar Joshi mutex_lock(&rproc->lock); 25572099c77dSSarangdhar Joshi rproc->state = RPROC_DELETED; 25582099c77dSSarangdhar Joshi mutex_unlock(&rproc->lock); 25592099c77dSSarangdhar Joshi 2560b003d45bSSarangdhar Joshi rproc_delete_debug_dir(rproc); 2561b003d45bSSarangdhar Joshi 2562fec47d86SDave Gerlach /* the rproc is downref'ed as soon as it's removed from the klist */ 2563fec47d86SDave Gerlach mutex_lock(&rproc_list_mutex); 2564c0abe2caSBjorn Andersson list_del_rcu(&rproc->node); 2565fec47d86SDave Gerlach mutex_unlock(&rproc_list_mutex); 2566fec47d86SDave Gerlach 2567c0abe2caSBjorn Andersson /* Ensure that no readers of rproc_list are still active */ 2568c0abe2caSBjorn Andersson synchronize_rcu(); 2569c0abe2caSBjorn Andersson 2570b5ab5e24SOhad Ben-Cohen device_del(&rproc->dev); 2571930eec0bSSiddharth Gupta rproc_char_device_remove(rproc); 2572400e64dfSOhad Ben-Cohen 2573400e64dfSOhad Ben-Cohen return 0; 2574400e64dfSOhad Ben-Cohen } 2575160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_del); 2576400e64dfSOhad Ben-Cohen 2577305ac5a7SPaul Cercueil static void devm_rproc_free(struct device *dev, void *res) 2578305ac5a7SPaul Cercueil { 2579305ac5a7SPaul Cercueil rproc_free(*(struct rproc **)res); 2580305ac5a7SPaul Cercueil } 2581305ac5a7SPaul Cercueil 2582305ac5a7SPaul Cercueil /** 2583305ac5a7SPaul Cercueil * devm_rproc_alloc() - resource managed rproc_alloc() 2584305ac5a7SPaul Cercueil * @dev: the underlying device 2585305ac5a7SPaul Cercueil * @name: name of this remote processor 2586305ac5a7SPaul Cercueil * @ops: platform-specific handlers (mainly start/stop) 2587305ac5a7SPaul Cercueil * @firmware: name of firmware file to load, can be NULL 2588305ac5a7SPaul Cercueil * @len: length of private data needed by the rproc driver (in bytes) 2589305ac5a7SPaul Cercueil * 2590305ac5a7SPaul Cercueil * This function performs like rproc_alloc() but the acquired rproc device will 2591305ac5a7SPaul Cercueil * automatically be released on driver detach. 2592305ac5a7SPaul Cercueil * 2593f2867434SSuman Anna * Return: new rproc instance, or NULL on failure 2594305ac5a7SPaul Cercueil */ 2595305ac5a7SPaul Cercueil struct rproc *devm_rproc_alloc(struct device *dev, const char *name, 2596305ac5a7SPaul Cercueil const struct rproc_ops *ops, 2597305ac5a7SPaul Cercueil const char *firmware, int len) 2598305ac5a7SPaul Cercueil { 2599305ac5a7SPaul Cercueil struct rproc **ptr, *rproc; 2600305ac5a7SPaul Cercueil 2601305ac5a7SPaul Cercueil ptr = devres_alloc(devm_rproc_free, sizeof(*ptr), GFP_KERNEL); 2602305ac5a7SPaul Cercueil if (!ptr) 26037dcef398SDan Carpenter return NULL; 2604305ac5a7SPaul Cercueil 2605305ac5a7SPaul Cercueil rproc = rproc_alloc(dev, name, ops, firmware, len); 2606305ac5a7SPaul Cercueil if (rproc) { 2607305ac5a7SPaul Cercueil *ptr = rproc; 2608305ac5a7SPaul Cercueil devres_add(dev, ptr); 2609305ac5a7SPaul Cercueil } else { 2610305ac5a7SPaul Cercueil devres_free(ptr); 2611305ac5a7SPaul Cercueil } 2612305ac5a7SPaul Cercueil 2613305ac5a7SPaul Cercueil return rproc; 2614305ac5a7SPaul Cercueil } 2615305ac5a7SPaul Cercueil EXPORT_SYMBOL(devm_rproc_alloc); 2616305ac5a7SPaul Cercueil 26178afd519cSFernando Guzman Lugo /** 26187bdc9650SBjorn Andersson * rproc_add_subdev() - add a subdevice to a remoteproc 26197bdc9650SBjorn Andersson * @rproc: rproc handle to add the subdevice to 26207bdc9650SBjorn Andersson * @subdev: subdev handle to register 26214902676fSBjorn Andersson * 26224902676fSBjorn Andersson * Caller is responsible for populating optional subdevice function pointers. 26237bdc9650SBjorn Andersson */ 26244902676fSBjorn Andersson void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 26257bdc9650SBjorn Andersson { 26267bdc9650SBjorn Andersson list_add_tail(&subdev->node, &rproc->subdevs); 26277bdc9650SBjorn Andersson } 26287bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_add_subdev); 26297bdc9650SBjorn Andersson 26307bdc9650SBjorn Andersson /** 26317bdc9650SBjorn Andersson * rproc_remove_subdev() - remove a subdevice from a remoteproc 26327bdc9650SBjorn Andersson * @rproc: rproc handle to remove the subdevice from 26337bdc9650SBjorn Andersson * @subdev: subdev handle, previously registered with rproc_add_subdev() 26347bdc9650SBjorn Andersson */ 26357bdc9650SBjorn Andersson void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 26367bdc9650SBjorn Andersson { 26377bdc9650SBjorn Andersson list_del(&subdev->node); 26387bdc9650SBjorn Andersson } 26397bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_remove_subdev); 26407bdc9650SBjorn Andersson 26417bdc9650SBjorn Andersson /** 26427c89717fSBjorn Andersson * rproc_get_by_child() - acquire rproc handle of @dev's ancestor 26437c89717fSBjorn Andersson * @dev: child device to find ancestor of 26447c89717fSBjorn Andersson * 2645f2867434SSuman Anna * Return: the ancestor rproc instance, or NULL if not found 26467c89717fSBjorn Andersson */ 26477c89717fSBjorn Andersson struct rproc *rproc_get_by_child(struct device *dev) 26487c89717fSBjorn Andersson { 26497c89717fSBjorn Andersson for (dev = dev->parent; dev; dev = dev->parent) { 26507c89717fSBjorn Andersson if (dev->type == &rproc_type) 26517c89717fSBjorn Andersson return dev->driver_data; 26527c89717fSBjorn Andersson } 26537c89717fSBjorn Andersson 26547c89717fSBjorn Andersson return NULL; 26557c89717fSBjorn Andersson } 26567c89717fSBjorn Andersson EXPORT_SYMBOL(rproc_get_by_child); 26577c89717fSBjorn Andersson 26587c89717fSBjorn Andersson /** 26598afd519cSFernando Guzman Lugo * rproc_report_crash() - rproc crash reporter function 26608afd519cSFernando Guzman Lugo * @rproc: remote processor 26618afd519cSFernando Guzman Lugo * @type: crash type 26628afd519cSFernando Guzman Lugo * 26638afd519cSFernando Guzman Lugo * This function must be called every time a crash is detected by the low-level 26648afd519cSFernando Guzman Lugo * drivers implementing a specific remoteproc. This should not be called from a 26658afd519cSFernando Guzman Lugo * non-remoteproc driver. 26668afd519cSFernando Guzman Lugo * 26678afd519cSFernando Guzman Lugo * This function can be called from atomic/interrupt context. 26688afd519cSFernando Guzman Lugo */ 26698afd519cSFernando Guzman Lugo void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type) 26708afd519cSFernando Guzman Lugo { 26718afd519cSFernando Guzman Lugo if (!rproc) { 26728afd519cSFernando Guzman Lugo pr_err("NULL rproc pointer\n"); 26738afd519cSFernando Guzman Lugo return; 26748afd519cSFernando Guzman Lugo } 26758afd519cSFernando Guzman Lugo 2676a781e5aaSRishabh Bhatnagar /* Prevent suspend while the remoteproc is being recovered */ 2677a781e5aaSRishabh Bhatnagar pm_stay_awake(rproc->dev.parent); 2678a781e5aaSRishabh Bhatnagar 26798afd519cSFernando Guzman Lugo dev_err(&rproc->dev, "crash detected in %s: type %s\n", 26808afd519cSFernando Guzman Lugo rproc->name, rproc_crash_to_string(type)); 26818afd519cSFernando Guzman Lugo 2682cab8300bSMukesh Ojha queue_work(rproc_recovery_wq, &rproc->crash_handler); 26838afd519cSFernando Guzman Lugo } 26848afd519cSFernando Guzman Lugo EXPORT_SYMBOL(rproc_report_crash); 26858afd519cSFernando Guzman Lugo 2686dc5192c4SBjorn Andersson static int rproc_panic_handler(struct notifier_block *nb, unsigned long event, 2687dc5192c4SBjorn Andersson void *ptr) 2688dc5192c4SBjorn Andersson { 2689dc5192c4SBjorn Andersson unsigned int longest = 0; 2690dc5192c4SBjorn Andersson struct rproc *rproc; 2691dc5192c4SBjorn Andersson unsigned int d; 2692dc5192c4SBjorn Andersson 2693dc5192c4SBjorn Andersson rcu_read_lock(); 2694dc5192c4SBjorn Andersson list_for_each_entry_rcu(rproc, &rproc_list, node) { 2695800dad00SMathieu Poirier if (!rproc->ops->panic) 2696800dad00SMathieu Poirier continue; 2697800dad00SMathieu Poirier 2698800dad00SMathieu Poirier if (rproc->state != RPROC_RUNNING && 2699800dad00SMathieu Poirier rproc->state != RPROC_ATTACHED) 2700dc5192c4SBjorn Andersson continue; 2701dc5192c4SBjorn Andersson 2702dc5192c4SBjorn Andersson d = rproc->ops->panic(rproc); 2703dc5192c4SBjorn Andersson longest = max(longest, d); 2704dc5192c4SBjorn Andersson } 2705dc5192c4SBjorn Andersson rcu_read_unlock(); 2706dc5192c4SBjorn Andersson 2707dc5192c4SBjorn Andersson /* 2708dc5192c4SBjorn Andersson * Delay for the longest requested duration before returning. This can 2709dc5192c4SBjorn Andersson * be used by the remoteproc drivers to give the remote processor time 2710dc5192c4SBjorn Andersson * to perform any requested operations (such as flush caches), when 2711dc5192c4SBjorn Andersson * it's not possible to signal the Linux side due to the panic. 2712dc5192c4SBjorn Andersson */ 2713dc5192c4SBjorn Andersson mdelay(longest); 2714dc5192c4SBjorn Andersson 2715dc5192c4SBjorn Andersson return NOTIFY_DONE; 2716dc5192c4SBjorn Andersson } 2717dc5192c4SBjorn Andersson 2718dc5192c4SBjorn Andersson static void __init rproc_init_panic(void) 2719dc5192c4SBjorn Andersson { 2720dc5192c4SBjorn Andersson rproc_panic_nb.notifier_call = rproc_panic_handler; 2721dc5192c4SBjorn Andersson atomic_notifier_chain_register(&panic_notifier_list, &rproc_panic_nb); 2722dc5192c4SBjorn Andersson } 2723dc5192c4SBjorn Andersson 2724dc5192c4SBjorn Andersson static void __exit rproc_exit_panic(void) 2725dc5192c4SBjorn Andersson { 2726dc5192c4SBjorn Andersson atomic_notifier_chain_unregister(&panic_notifier_list, &rproc_panic_nb); 2727dc5192c4SBjorn Andersson } 2728dc5192c4SBjorn Andersson 2729400e64dfSOhad Ben-Cohen static int __init remoteproc_init(void) 2730400e64dfSOhad Ben-Cohen { 2731cab8300bSMukesh Ojha rproc_recovery_wq = alloc_workqueue("rproc_recovery_wq", 2732cab8300bSMukesh Ojha WQ_UNBOUND | WQ_FREEZABLE, 0); 2733cab8300bSMukesh Ojha if (!rproc_recovery_wq) { 2734cab8300bSMukesh Ojha pr_err("remoteproc: creation of rproc_recovery_wq failed\n"); 2735cab8300bSMukesh Ojha return -ENOMEM; 2736cab8300bSMukesh Ojha } 2737cab8300bSMukesh Ojha 27382aefbef0SMatt Redfearn rproc_init_sysfs(); 2739400e64dfSOhad Ben-Cohen rproc_init_debugfs(); 274062b8f9e9SSiddharth Gupta rproc_init_cdev(); 2741dc5192c4SBjorn Andersson rproc_init_panic(); 2742b5ab5e24SOhad Ben-Cohen 2743400e64dfSOhad Ben-Cohen return 0; 2744400e64dfSOhad Ben-Cohen } 2745a8f40111SBrandon Maier subsys_initcall(remoteproc_init); 2746400e64dfSOhad Ben-Cohen 2747400e64dfSOhad Ben-Cohen static void __exit remoteproc_exit(void) 2748400e64dfSOhad Ben-Cohen { 2749f42f79afSSuman Anna ida_destroy(&rproc_dev_index); 2750f42f79afSSuman Anna 2751cab8300bSMukesh Ojha if (!rproc_recovery_wq) 2752cab8300bSMukesh Ojha return; 2753cab8300bSMukesh Ojha 2754dc5192c4SBjorn Andersson rproc_exit_panic(); 2755400e64dfSOhad Ben-Cohen rproc_exit_debugfs(); 27562aefbef0SMatt Redfearn rproc_exit_sysfs(); 2757cab8300bSMukesh Ojha destroy_workqueue(rproc_recovery_wq); 2758400e64dfSOhad Ben-Cohen } 2759400e64dfSOhad Ben-Cohen module_exit(remoteproc_exit); 2760400e64dfSOhad Ben-Cohen 2761400e64dfSOhad Ben-Cohen MODULE_LICENSE("GPL v2"); 2762400e64dfSOhad Ben-Cohen MODULE_DESCRIPTION("Generic Remote Processor Framework"); 2763