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> 260a0f0d8bSChristoph Hellwig #include <linux/dma-map-ops.h> 27400e64dfSOhad Ben-Cohen #include <linux/dma-mapping.h> 28e0d07278SJim Quinlan #include <linux/dma-direct.h> /* XXX: pokes into bus_dma_range */ 29400e64dfSOhad Ben-Cohen #include <linux/firmware.h> 30400e64dfSOhad Ben-Cohen #include <linux/string.h> 31400e64dfSOhad Ben-Cohen #include <linux/debugfs.h> 32c0abe2caSBjorn Andersson #include <linux/rculist.h> 33400e64dfSOhad Ben-Cohen #include <linux/remoteproc.h> 34400e64dfSOhad Ben-Cohen #include <linux/iommu.h> 35b5ab5e24SOhad Ben-Cohen #include <linux/idr.h> 36400e64dfSOhad Ben-Cohen #include <linux/elf.h> 37a2b950acSOhad Ben-Cohen #include <linux/crc32.h> 38086d0872SLoic Pallardy #include <linux/of_reserved_mem.h> 39400e64dfSOhad Ben-Cohen #include <linux/virtio_ids.h> 40400e64dfSOhad Ben-Cohen #include <linux/virtio_ring.h> 41cf59d3e9SOhad Ben-Cohen #include <asm/byteorder.h> 42086d0872SLoic Pallardy #include <linux/platform_device.h> 43400e64dfSOhad Ben-Cohen 44400e64dfSOhad Ben-Cohen #include "remoteproc_internal.h" 45400e64dfSOhad Ben-Cohen 46b36de8cfSLoic Pallardy #define HIGH_BITS_MASK 0xFFFFFFFF00000000ULL 47b36de8cfSLoic Pallardy 48fec47d86SDave Gerlach static DEFINE_MUTEX(rproc_list_mutex); 49fec47d86SDave Gerlach static LIST_HEAD(rproc_list); 50dc5192c4SBjorn Andersson static struct notifier_block rproc_panic_nb; 51fec47d86SDave Gerlach 52a2b950acSOhad Ben-Cohen typedef int (*rproc_handle_resource_t)(struct rproc *rproc, 53a2b950acSOhad Ben-Cohen void *, int offset, int avail); 54400e64dfSOhad Ben-Cohen 55c6aed238SLoic Pallardy static int rproc_alloc_carveout(struct rproc *rproc, 56c6aed238SLoic Pallardy struct rproc_mem_entry *mem); 57c6aed238SLoic Pallardy static int rproc_release_carveout(struct rproc *rproc, 58c6aed238SLoic Pallardy struct rproc_mem_entry *mem); 59c6aed238SLoic Pallardy 60b5ab5e24SOhad Ben-Cohen /* Unique indices for remoteproc devices */ 61b5ab5e24SOhad Ben-Cohen static DEFINE_IDA(rproc_dev_index); 62b5ab5e24SOhad Ben-Cohen 638afd519cSFernando Guzman Lugo static const char * const rproc_crash_names[] = { 648afd519cSFernando Guzman Lugo [RPROC_MMUFAULT] = "mmufault", 65b3d39032SBjorn Andersson [RPROC_WATCHDOG] = "watchdog", 66b3d39032SBjorn Andersson [RPROC_FATAL_ERROR] = "fatal error", 678afd519cSFernando Guzman Lugo }; 688afd519cSFernando Guzman Lugo 698afd519cSFernando Guzman Lugo /* translate rproc_crash_type to string */ 708afd519cSFernando Guzman Lugo static const char *rproc_crash_to_string(enum rproc_crash_type type) 718afd519cSFernando Guzman Lugo { 728afd519cSFernando Guzman Lugo if (type < ARRAY_SIZE(rproc_crash_names)) 738afd519cSFernando Guzman Lugo return rproc_crash_names[type]; 74b23f7a09SMasanari Iida return "unknown"; 758afd519cSFernando Guzman Lugo } 768afd519cSFernando Guzman Lugo 77400e64dfSOhad Ben-Cohen /* 78400e64dfSOhad Ben-Cohen * This is the IOMMU fault handler we register with the IOMMU API 79400e64dfSOhad Ben-Cohen * (when relevant; not all remote processors access memory through 80400e64dfSOhad Ben-Cohen * an IOMMU). 81400e64dfSOhad Ben-Cohen * 82400e64dfSOhad Ben-Cohen * IOMMU core will invoke this handler whenever the remote processor 83400e64dfSOhad Ben-Cohen * will try to access an unmapped device address. 84400e64dfSOhad Ben-Cohen */ 85400e64dfSOhad Ben-Cohen static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev, 8677ca2332SOhad Ben-Cohen unsigned long iova, int flags, void *token) 87400e64dfSOhad Ben-Cohen { 888afd519cSFernando Guzman Lugo struct rproc *rproc = token; 898afd519cSFernando Guzman Lugo 90400e64dfSOhad Ben-Cohen dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags); 91400e64dfSOhad Ben-Cohen 928afd519cSFernando Guzman Lugo rproc_report_crash(rproc, RPROC_MMUFAULT); 938afd519cSFernando Guzman Lugo 94400e64dfSOhad Ben-Cohen /* 95400e64dfSOhad Ben-Cohen * Let the iommu core know we're not really handling this fault; 968afd519cSFernando Guzman Lugo * we just used it as a recovery trigger. 97400e64dfSOhad Ben-Cohen */ 98400e64dfSOhad Ben-Cohen return -ENOSYS; 99400e64dfSOhad Ben-Cohen } 100400e64dfSOhad Ben-Cohen 101400e64dfSOhad Ben-Cohen static int rproc_enable_iommu(struct rproc *rproc) 102400e64dfSOhad Ben-Cohen { 103400e64dfSOhad Ben-Cohen struct iommu_domain *domain; 104b5ab5e24SOhad Ben-Cohen struct device *dev = rproc->dev.parent; 105400e64dfSOhad Ben-Cohen int ret; 106400e64dfSOhad Ben-Cohen 107315491e5SSuman Anna if (!rproc->has_iommu) { 108315491e5SSuman Anna dev_dbg(dev, "iommu not present\n"); 1090798e1daSMark Grosen return 0; 110400e64dfSOhad Ben-Cohen } 111400e64dfSOhad Ben-Cohen 112400e64dfSOhad Ben-Cohen domain = iommu_domain_alloc(dev->bus); 113400e64dfSOhad Ben-Cohen if (!domain) { 114400e64dfSOhad Ben-Cohen dev_err(dev, "can't alloc iommu domain\n"); 115400e64dfSOhad Ben-Cohen return -ENOMEM; 116400e64dfSOhad Ben-Cohen } 117400e64dfSOhad Ben-Cohen 11877ca2332SOhad Ben-Cohen iommu_set_fault_handler(domain, rproc_iommu_fault, rproc); 119400e64dfSOhad Ben-Cohen 120400e64dfSOhad Ben-Cohen ret = iommu_attach_device(domain, dev); 121400e64dfSOhad Ben-Cohen if (ret) { 122400e64dfSOhad Ben-Cohen dev_err(dev, "can't attach iommu device: %d\n", ret); 123400e64dfSOhad Ben-Cohen goto free_domain; 124400e64dfSOhad Ben-Cohen } 125400e64dfSOhad Ben-Cohen 126400e64dfSOhad Ben-Cohen rproc->domain = domain; 127400e64dfSOhad Ben-Cohen 128400e64dfSOhad Ben-Cohen return 0; 129400e64dfSOhad Ben-Cohen 130400e64dfSOhad Ben-Cohen free_domain: 131400e64dfSOhad Ben-Cohen iommu_domain_free(domain); 132400e64dfSOhad Ben-Cohen return ret; 133400e64dfSOhad Ben-Cohen } 134400e64dfSOhad Ben-Cohen 135400e64dfSOhad Ben-Cohen static void rproc_disable_iommu(struct rproc *rproc) 136400e64dfSOhad Ben-Cohen { 137400e64dfSOhad Ben-Cohen struct iommu_domain *domain = rproc->domain; 138b5ab5e24SOhad Ben-Cohen struct device *dev = rproc->dev.parent; 139400e64dfSOhad Ben-Cohen 140400e64dfSOhad Ben-Cohen if (!domain) 141400e64dfSOhad Ben-Cohen return; 142400e64dfSOhad Ben-Cohen 143400e64dfSOhad Ben-Cohen iommu_detach_device(domain, dev); 144400e64dfSOhad Ben-Cohen iommu_domain_free(domain); 145400e64dfSOhad Ben-Cohen } 146400e64dfSOhad Ben-Cohen 147086d0872SLoic Pallardy phys_addr_t rproc_va_to_pa(void *cpu_addr) 148eb30596eSLoic Pallardy { 149eb30596eSLoic Pallardy /* 150eb30596eSLoic Pallardy * Return physical address according to virtual address location 151eb30596eSLoic Pallardy * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent 152eb30596eSLoic Pallardy * - in kernel: if region allocated in generic dma memory pool 153eb30596eSLoic Pallardy */ 154eb30596eSLoic Pallardy if (is_vmalloc_addr(cpu_addr)) { 155eb30596eSLoic Pallardy return page_to_phys(vmalloc_to_page(cpu_addr)) + 156eb30596eSLoic Pallardy offset_in_page(cpu_addr); 157eb30596eSLoic Pallardy } 158eb30596eSLoic Pallardy 159eb30596eSLoic Pallardy WARN_ON(!virt_addr_valid(cpu_addr)); 160eb30596eSLoic Pallardy return virt_to_phys(cpu_addr); 161eb30596eSLoic Pallardy } 162086d0872SLoic Pallardy EXPORT_SYMBOL(rproc_va_to_pa); 163eb30596eSLoic Pallardy 164a01f7cd6SSuman Anna /** 165a01f7cd6SSuman Anna * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address 166a01f7cd6SSuman Anna * @rproc: handle of a remote processor 167a01f7cd6SSuman Anna * @da: remoteproc device address to translate 168a01f7cd6SSuman Anna * @len: length of the memory region @da is pointing to 16995347e73SSuman Anna * @is_iomem: optional pointer filled in to indicate if @da is iomapped memory 170a01f7cd6SSuman Anna * 171400e64dfSOhad Ben-Cohen * Some remote processors will ask us to allocate them physically contiguous 172400e64dfSOhad Ben-Cohen * memory regions (which we call "carveouts"), and map them to specific 173a01f7cd6SSuman Anna * device addresses (which are hardcoded in the firmware). They may also have 174a01f7cd6SSuman Anna * dedicated memory regions internal to the processors, and use them either 175a01f7cd6SSuman Anna * exclusively or alongside carveouts. 176400e64dfSOhad Ben-Cohen * 177400e64dfSOhad Ben-Cohen * They may then ask us to copy objects into specific device addresses (e.g. 178400e64dfSOhad Ben-Cohen * code/data sections) or expose us certain symbols in other device address 179400e64dfSOhad Ben-Cohen * (e.g. their trace buffer). 180400e64dfSOhad Ben-Cohen * 181a01f7cd6SSuman Anna * This function is a helper function with which we can go over the allocated 182a01f7cd6SSuman Anna * carveouts and translate specific device addresses to kernel virtual addresses 183a01f7cd6SSuman Anna * so we can access the referenced memory. This function also allows to perform 184a01f7cd6SSuman Anna * translations on the internal remoteproc memory regions through a platform 185a01f7cd6SSuman Anna * implementation specific da_to_va ops, if present. 186a01f7cd6SSuman Anna * 187400e64dfSOhad Ben-Cohen * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too, 188400e64dfSOhad Ben-Cohen * but only on kernel direct mapped RAM memory. Instead, we're just using 189a01f7cd6SSuman Anna * here the output of the DMA API for the carveouts, which should be more 190a01f7cd6SSuman Anna * correct. 191f2867434SSuman Anna * 192f2867434SSuman Anna * Return: a valid kernel address on success or NULL on failure 193400e64dfSOhad Ben-Cohen */ 19440df0a91SPeng Fan void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len, bool *is_iomem) 195400e64dfSOhad Ben-Cohen { 196400e64dfSOhad Ben-Cohen struct rproc_mem_entry *carveout; 197400e64dfSOhad Ben-Cohen void *ptr = NULL; 198400e64dfSOhad Ben-Cohen 199a01f7cd6SSuman Anna if (rproc->ops->da_to_va) { 20040df0a91SPeng Fan ptr = rproc->ops->da_to_va(rproc, da, len, is_iomem); 201a01f7cd6SSuman Anna if (ptr) 202a01f7cd6SSuman Anna goto out; 203a01f7cd6SSuman Anna } 204a01f7cd6SSuman Anna 205400e64dfSOhad Ben-Cohen list_for_each_entry(carveout, &rproc->carveouts, node) { 206400e64dfSOhad Ben-Cohen int offset = da - carveout->da; 207400e64dfSOhad Ben-Cohen 20874457c40SLoic Pallardy /* Verify that carveout is allocated */ 20974457c40SLoic Pallardy if (!carveout->va) 21074457c40SLoic Pallardy continue; 21174457c40SLoic Pallardy 212400e64dfSOhad Ben-Cohen /* try next carveout if da is too small */ 213400e64dfSOhad Ben-Cohen if (offset < 0) 214400e64dfSOhad Ben-Cohen continue; 215400e64dfSOhad Ben-Cohen 216400e64dfSOhad Ben-Cohen /* try next carveout if da is too large */ 217400e64dfSOhad Ben-Cohen if (offset + len > carveout->len) 218400e64dfSOhad Ben-Cohen continue; 219400e64dfSOhad Ben-Cohen 220400e64dfSOhad Ben-Cohen ptr = carveout->va + offset; 221400e64dfSOhad Ben-Cohen 22240df0a91SPeng Fan if (is_iomem) 22340df0a91SPeng Fan *is_iomem = carveout->is_iomem; 22440df0a91SPeng Fan 225400e64dfSOhad Ben-Cohen break; 226400e64dfSOhad Ben-Cohen } 227400e64dfSOhad Ben-Cohen 228a01f7cd6SSuman Anna out: 229400e64dfSOhad Ben-Cohen return ptr; 230400e64dfSOhad Ben-Cohen } 2314afc89d6SSjur Brændeland EXPORT_SYMBOL(rproc_da_to_va); 232400e64dfSOhad Ben-Cohen 233b0019ccdSLoic Pallardy /** 234b0019ccdSLoic Pallardy * rproc_find_carveout_by_name() - lookup the carveout region by a name 235b0019ccdSLoic Pallardy * @rproc: handle of a remote processor 2362e7d4c2cSArnaud Pouliquen * @name: carveout name to find (format string) 2372e7d4c2cSArnaud Pouliquen * @...: optional parameters matching @name string 238b0019ccdSLoic Pallardy * 239b0019ccdSLoic Pallardy * Platform driver has the capability to register some pre-allacoted carveout 240b0019ccdSLoic Pallardy * (physically contiguous memory regions) before rproc firmware loading and 241b0019ccdSLoic Pallardy * associated resource table analysis. These regions may be dedicated memory 242b0019ccdSLoic Pallardy * regions internal to the coprocessor or specified DDR region with specific 243b0019ccdSLoic Pallardy * attributes 244b0019ccdSLoic Pallardy * 245b0019ccdSLoic Pallardy * This function is a helper function with which we can go over the 246b0019ccdSLoic Pallardy * allocated carveouts and return associated region characteristics like 247b0019ccdSLoic Pallardy * coprocessor address, length or processor virtual address. 248b0019ccdSLoic Pallardy * 249b0019ccdSLoic Pallardy * Return: a valid pointer on carveout entry on success or NULL on failure. 250b0019ccdSLoic Pallardy */ 2517e05c8deSLee Jones __printf(2, 3) 252b0019ccdSLoic Pallardy struct rproc_mem_entry * 253b0019ccdSLoic Pallardy rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...) 254b0019ccdSLoic Pallardy { 255b0019ccdSLoic Pallardy va_list args; 256b0019ccdSLoic Pallardy char _name[32]; 257b0019ccdSLoic Pallardy struct rproc_mem_entry *carveout, *mem = NULL; 258b0019ccdSLoic Pallardy 259b0019ccdSLoic Pallardy if (!name) 260b0019ccdSLoic Pallardy return NULL; 261b0019ccdSLoic Pallardy 262b0019ccdSLoic Pallardy va_start(args, name); 263b0019ccdSLoic Pallardy vsnprintf(_name, sizeof(_name), name, args); 264b0019ccdSLoic Pallardy va_end(args); 265b0019ccdSLoic Pallardy 266b0019ccdSLoic Pallardy list_for_each_entry(carveout, &rproc->carveouts, node) { 267b0019ccdSLoic Pallardy /* Compare carveout and requested names */ 268b0019ccdSLoic Pallardy if (!strcmp(carveout->name, _name)) { 269b0019ccdSLoic Pallardy mem = carveout; 270b0019ccdSLoic Pallardy break; 271b0019ccdSLoic Pallardy } 272b0019ccdSLoic Pallardy } 273b0019ccdSLoic Pallardy 274b0019ccdSLoic Pallardy return mem; 275b0019ccdSLoic Pallardy } 276b0019ccdSLoic Pallardy 277c874bf59SLoic Pallardy /** 278c874bf59SLoic Pallardy * rproc_check_carveout_da() - Check specified carveout da configuration 279c874bf59SLoic Pallardy * @rproc: handle of a remote processor 280c874bf59SLoic Pallardy * @mem: pointer on carveout to check 281c874bf59SLoic Pallardy * @da: area device address 282c874bf59SLoic Pallardy * @len: associated area size 283c874bf59SLoic Pallardy * 284c874bf59SLoic Pallardy * This function is a helper function to verify requested device area (couple 28528d7d5c6SLoic Pallardy * da, len) is part of specified carveout. 28628d7d5c6SLoic Pallardy * If da is not set (defined as FW_RSC_ADDR_ANY), only requested length is 28728d7d5c6SLoic Pallardy * checked. 288c874bf59SLoic Pallardy * 28928d7d5c6SLoic Pallardy * Return: 0 if carveout matches request else error 290c874bf59SLoic Pallardy */ 29128d7d5c6SLoic Pallardy static int rproc_check_carveout_da(struct rproc *rproc, 29228d7d5c6SLoic Pallardy struct rproc_mem_entry *mem, u32 da, u32 len) 293c874bf59SLoic Pallardy { 294c874bf59SLoic Pallardy struct device *dev = &rproc->dev; 29528d7d5c6SLoic Pallardy int delta; 296c874bf59SLoic Pallardy 297c874bf59SLoic Pallardy /* Check requested resource length */ 298c874bf59SLoic Pallardy if (len > mem->len) { 299c874bf59SLoic Pallardy dev_err(dev, "Registered carveout doesn't fit len request\n"); 30028d7d5c6SLoic Pallardy return -EINVAL; 301c874bf59SLoic Pallardy } 302c874bf59SLoic Pallardy 303c874bf59SLoic Pallardy if (da != FW_RSC_ADDR_ANY && mem->da == FW_RSC_ADDR_ANY) { 30428d7d5c6SLoic Pallardy /* Address doesn't match registered carveout configuration */ 30528d7d5c6SLoic Pallardy return -EINVAL; 306c874bf59SLoic Pallardy } else if (da != FW_RSC_ADDR_ANY && mem->da != FW_RSC_ADDR_ANY) { 307c874bf59SLoic Pallardy delta = da - mem->da; 308c874bf59SLoic Pallardy 309c874bf59SLoic Pallardy /* Check requested resource belongs to registered carveout */ 310c874bf59SLoic Pallardy if (delta < 0) { 311c874bf59SLoic Pallardy dev_err(dev, 312c874bf59SLoic Pallardy "Registered carveout doesn't fit da request\n"); 31328d7d5c6SLoic Pallardy return -EINVAL; 314c874bf59SLoic Pallardy } 315c874bf59SLoic Pallardy 316c874bf59SLoic Pallardy if (delta + len > mem->len) { 317c874bf59SLoic Pallardy dev_err(dev, 318c874bf59SLoic Pallardy "Registered carveout doesn't fit len request\n"); 31928d7d5c6SLoic Pallardy return -EINVAL; 320c874bf59SLoic Pallardy } 321c874bf59SLoic Pallardy } 322c874bf59SLoic Pallardy 323c874bf59SLoic Pallardy return 0; 324c874bf59SLoic Pallardy } 325c874bf59SLoic Pallardy 3266db20ea8SOhad Ben-Cohen int rproc_alloc_vring(struct rproc_vdev *rvdev, int i) 327400e64dfSOhad Ben-Cohen { 3287a186941SOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 329b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 3306db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 331c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 332096ee786SClement Leger int ret, notifyid; 333c6aed238SLoic Pallardy struct rproc_mem_entry *mem; 334096ee786SClement Leger size_t size; 335400e64dfSOhad Ben-Cohen 3366db20ea8SOhad Ben-Cohen /* actual size of vring (in bytes) */ 337*c2a052a4SXuan Zhuo size = PAGE_ALIGN(vring_size(rvring->num, rvring->align)); 3386db20ea8SOhad Ben-Cohen 339c6aed238SLoic Pallardy rsc = (void *)rproc->table_ptr + rvdev->rsc_offset; 340c6aed238SLoic Pallardy 341c6aed238SLoic Pallardy /* Search for pre-registered carveout */ 342c6aed238SLoic Pallardy mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index, 343c6aed238SLoic Pallardy i); 344c6aed238SLoic Pallardy if (mem) { 345c6aed238SLoic Pallardy if (rproc_check_carveout_da(rproc, mem, rsc->vring[i].da, size)) 346c6aed238SLoic Pallardy return -ENOMEM; 347c6aed238SLoic Pallardy } else { 348c6aed238SLoic Pallardy /* Register carveout in in list */ 34999cf0361SBen Dooks (Codethink) mem = rproc_mem_entry_init(dev, NULL, 0, 35099cf0361SBen Dooks (Codethink) size, rsc->vring[i].da, 351c6aed238SLoic Pallardy rproc_alloc_carveout, 352c6aed238SLoic Pallardy rproc_release_carveout, 353c6aed238SLoic Pallardy "vdev%dvring%d", 354c6aed238SLoic Pallardy rvdev->index, i); 355c6aed238SLoic Pallardy if (!mem) { 356c6aed238SLoic Pallardy dev_err(dev, "Can't allocate memory entry structure\n"); 357c6aed238SLoic Pallardy return -ENOMEM; 358c6aed238SLoic Pallardy } 359c6aed238SLoic Pallardy 360c6aed238SLoic Pallardy rproc_add_carveout(rproc, mem); 3616db20ea8SOhad Ben-Cohen } 3626db20ea8SOhad Ben-Cohen 3636db20ea8SOhad Ben-Cohen /* 3646db20ea8SOhad Ben-Cohen * Assign an rproc-wide unique index for this vring 3656db20ea8SOhad Ben-Cohen * TODO: assign a notifyid for rvdev updates as well 3666db20ea8SOhad Ben-Cohen * TODO: support predefined notifyids (via resource table) 3676db20ea8SOhad Ben-Cohen */ 36815fc6110STejun Heo ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL); 369b39599b7SSuman Anna if (ret < 0) { 37015fc6110STejun Heo dev_err(dev, "idr_alloc failed: %d\n", ret); 3716db20ea8SOhad Ben-Cohen return ret; 3726db20ea8SOhad Ben-Cohen } 37315fc6110STejun Heo notifyid = ret; 3746db20ea8SOhad Ben-Cohen 37548f18f89SBjorn Andersson /* Potentially bump max_notifyid */ 37648f18f89SBjorn Andersson if (notifyid > rproc->max_notifyid) 37748f18f89SBjorn Andersson rproc->max_notifyid = notifyid; 37848f18f89SBjorn Andersson 3796db20ea8SOhad Ben-Cohen rvring->notifyid = notifyid; 3806db20ea8SOhad Ben-Cohen 381c6aed238SLoic Pallardy /* Let the rproc know the notifyid of this vring.*/ 382c0d63157SSjur Brændeland rsc->vring[i].notifyid = notifyid; 3836db20ea8SOhad Ben-Cohen return 0; 3846db20ea8SOhad Ben-Cohen } 3856db20ea8SOhad Ben-Cohen 386400e64dfSOhad Ben-Cohen static int 3876db20ea8SOhad Ben-Cohen rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i) 388400e64dfSOhad Ben-Cohen { 389400e64dfSOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 390b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 391400e64dfSOhad Ben-Cohen struct fw_rsc_vdev_vring *vring = &rsc->vring[i]; 3926db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 393400e64dfSOhad Ben-Cohen 3949d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n", 3957a186941SOhad Ben-Cohen i, vring->da, vring->num, vring->align); 3967a186941SOhad Ben-Cohen 39763140e0eSOhad Ben-Cohen /* verify queue size and vring alignment are sane */ 39863140e0eSOhad Ben-Cohen if (!vring->num || !vring->align) { 39963140e0eSOhad Ben-Cohen dev_err(dev, "invalid qsz (%d) or alignment (%d)\n", 40063140e0eSOhad Ben-Cohen vring->num, vring->align); 401400e64dfSOhad Ben-Cohen return -EINVAL; 402400e64dfSOhad Ben-Cohen } 403400e64dfSOhad Ben-Cohen 404*c2a052a4SXuan Zhuo rvring->num = vring->num; 4056db20ea8SOhad Ben-Cohen rvring->align = vring->align; 4066db20ea8SOhad Ben-Cohen rvring->rvdev = rvdev; 407400e64dfSOhad Ben-Cohen 408400e64dfSOhad Ben-Cohen return 0; 409400e64dfSOhad Ben-Cohen } 410400e64dfSOhad Ben-Cohen 4116db20ea8SOhad Ben-Cohen void rproc_free_vring(struct rproc_vring *rvring) 4127a186941SOhad Ben-Cohen { 4136db20ea8SOhad Ben-Cohen struct rproc *rproc = rvring->rvdev->rproc; 41400a0eec5SClement Leger int idx = rvring - rvring->rvdev->vring; 415c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 4167a186941SOhad Ben-Cohen 4177a186941SOhad Ben-Cohen idr_remove(&rproc->notifyids, rvring->notifyid); 418099a3f33SSjur Brændeland 4194d3ebb3bSMathieu Poirier /* 4204d3ebb3bSMathieu Poirier * At this point rproc_stop() has been called and the installed resource 4214d3ebb3bSMathieu Poirier * table in the remote processor memory may no longer be accessible. As 4224d3ebb3bSMathieu Poirier * such and as per rproc_stop(), rproc->table_ptr points to the cached 4234d3ebb3bSMathieu Poirier * resource table (rproc->cached_table). The cached resource table is 4244d3ebb3bSMathieu Poirier * only available when a remote processor has been booted by the 4254d3ebb3bSMathieu Poirier * remoteproc core, otherwise it is NULL. 4264d3ebb3bSMathieu Poirier * 4274d3ebb3bSMathieu Poirier * Based on the above, reset the virtio device section in the cached 4284d3ebb3bSMathieu Poirier * resource table only if there is one to work with. 4294d3ebb3bSMathieu Poirier */ 4304d3ebb3bSMathieu Poirier if (rproc->table_ptr) { 431c0d63157SSjur Brændeland rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset; 432c0d63157SSjur Brændeland rsc->vring[idx].da = 0; 433c0d63157SSjur Brændeland rsc->vring[idx].notifyid = -1; 4347a186941SOhad Ben-Cohen } 4354d3ebb3bSMathieu Poirier } 4367a186941SOhad Ben-Cohen 4376f8b0373SAlex Elder static int rproc_vdev_do_start(struct rproc_subdev *subdev) 438f5bcb353SBjorn Andersson { 439f5bcb353SBjorn Andersson struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev); 440f5bcb353SBjorn Andersson 441f5bcb353SBjorn Andersson return rproc_add_virtio_dev(rvdev, rvdev->id); 442f5bcb353SBjorn Andersson } 443f5bcb353SBjorn Andersson 4446f8b0373SAlex Elder static void rproc_vdev_do_stop(struct rproc_subdev *subdev, bool crashed) 445f5bcb353SBjorn Andersson { 446f5bcb353SBjorn Andersson struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev); 447d4c036feSLoic Pallardy int ret; 448f5bcb353SBjorn Andersson 449d4c036feSLoic Pallardy ret = device_for_each_child(&rvdev->dev, NULL, rproc_remove_virtio_dev); 450d4c036feSLoic Pallardy if (ret) 451d4c036feSLoic Pallardy dev_warn(&rvdev->dev, "can't remove vdev child device: %d\n", ret); 452f5bcb353SBjorn Andersson } 453f5bcb353SBjorn Andersson 454400e64dfSOhad Ben-Cohen /** 455086d0872SLoic Pallardy * rproc_rvdev_release() - release the existence of a rvdev 456086d0872SLoic Pallardy * 457086d0872SLoic Pallardy * @dev: the subdevice's dev 458086d0872SLoic Pallardy */ 459086d0872SLoic Pallardy static void rproc_rvdev_release(struct device *dev) 460086d0872SLoic Pallardy { 461086d0872SLoic Pallardy struct rproc_vdev *rvdev = container_of(dev, struct rproc_vdev, dev); 462086d0872SLoic Pallardy 463086d0872SLoic Pallardy of_reserved_mem_device_release(dev); 464086d0872SLoic Pallardy 465086d0872SLoic Pallardy kfree(rvdev); 466086d0872SLoic Pallardy } 467086d0872SLoic Pallardy 468e0d07278SJim Quinlan static int copy_dma_range_map(struct device *to, struct device *from) 469e0d07278SJim Quinlan { 470e0d07278SJim Quinlan const struct bus_dma_region *map = from->dma_range_map, *new_map, *r; 471e0d07278SJim Quinlan int num_ranges = 0; 472e0d07278SJim Quinlan 473e0d07278SJim Quinlan if (!map) 474e0d07278SJim Quinlan return 0; 475e0d07278SJim Quinlan 476e0d07278SJim Quinlan for (r = map; r->size; r++) 477e0d07278SJim Quinlan num_ranges++; 478e0d07278SJim Quinlan 479e0d07278SJim Quinlan new_map = kmemdup(map, array_size(num_ranges + 1, sizeof(*map)), 480e0d07278SJim Quinlan GFP_KERNEL); 481e0d07278SJim Quinlan if (!new_map) 482e0d07278SJim Quinlan return -ENOMEM; 483e0d07278SJim Quinlan to->dma_range_map = new_map; 484e0d07278SJim Quinlan return 0; 485e0d07278SJim Quinlan } 486e0d07278SJim Quinlan 487086d0872SLoic Pallardy /** 488fd2c15ecSOhad Ben-Cohen * rproc_handle_vdev() - handle a vdev fw resource 489400e64dfSOhad Ben-Cohen * @rproc: the remote processor 4902bf23461SJindong Yue * @ptr: the vring resource descriptor 4912e7d4c2cSArnaud Pouliquen * @offset: offset of the resource entry 492fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 493400e64dfSOhad Ben-Cohen * 4947a186941SOhad Ben-Cohen * This resource entry requests the host to statically register a virtio 4957a186941SOhad Ben-Cohen * device (vdev), and setup everything needed to support it. It contains 4967a186941SOhad Ben-Cohen * everything needed to make it possible: the virtio device id, virtio 4977a186941SOhad Ben-Cohen * device features, vrings information, virtio config space, etc... 498400e64dfSOhad Ben-Cohen * 4997a186941SOhad Ben-Cohen * Before registering the vdev, the vrings are allocated from non-cacheable 5007a186941SOhad Ben-Cohen * physically contiguous memory. Currently we only support two vrings per 5017a186941SOhad Ben-Cohen * remote processor (temporary limitation). We might also want to consider 5027a186941SOhad Ben-Cohen * doing the vring allocation only later when ->find_vqs() is invoked, and 5037a186941SOhad Ben-Cohen * then release them upon ->del_vqs(). 504400e64dfSOhad Ben-Cohen * 5057a186941SOhad Ben-Cohen * Note: @da is currently not really handled correctly: we dynamically 5067a186941SOhad Ben-Cohen * allocate it using the DMA API, ignoring requested hard coded addresses, 5077a186941SOhad Ben-Cohen * and we don't take care of any required IOMMU programming. This is all 5087a186941SOhad Ben-Cohen * going to be taken care of when the generic iommu-based DMA API will be 5097a186941SOhad Ben-Cohen * merged. Meanwhile, statically-addressed iommu-based firmware images should 5107a186941SOhad Ben-Cohen * use RSC_DEVMEM resource entries to map their required @da to the physical 5117a186941SOhad Ben-Cohen * address of their base CMA region (ouch, hacky!). 512400e64dfSOhad Ben-Cohen * 513f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 514400e64dfSOhad Ben-Cohen */ 5152bf23461SJindong Yue static int rproc_handle_vdev(struct rproc *rproc, void *ptr, 516a2b950acSOhad Ben-Cohen int offset, int avail) 517400e64dfSOhad Ben-Cohen { 5182bf23461SJindong Yue struct fw_rsc_vdev *rsc = ptr; 519b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 5207a186941SOhad Ben-Cohen struct rproc_vdev *rvdev; 5217a186941SOhad Ben-Cohen int i, ret; 522086d0872SLoic Pallardy char name[16]; 523fd2c15ecSOhad Ben-Cohen 524fd2c15ecSOhad Ben-Cohen /* make sure resource isn't truncated */ 525c8784657SGustavo A. R. Silva if (struct_size(rsc, vring, rsc->num_of_vrings) + rsc->config_len > 526c8784657SGustavo A. R. Silva avail) { 527b5ab5e24SOhad Ben-Cohen dev_err(dev, "vdev rsc is truncated\n"); 528fd2c15ecSOhad Ben-Cohen return -EINVAL; 529fd2c15ecSOhad Ben-Cohen } 530fd2c15ecSOhad Ben-Cohen 531fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 532fd2c15ecSOhad Ben-Cohen if (rsc->reserved[0] || rsc->reserved[1]) { 533fd2c15ecSOhad Ben-Cohen dev_err(dev, "vdev rsc has non zero reserved bytes\n"); 534fd2c15ecSOhad Ben-Cohen return -EINVAL; 535fd2c15ecSOhad Ben-Cohen } 536fd2c15ecSOhad Ben-Cohen 5379d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n", 538fd2c15ecSOhad Ben-Cohen rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings); 539400e64dfSOhad Ben-Cohen 5407a186941SOhad Ben-Cohen /* we currently support only two vrings per rvdev */ 5417a186941SOhad Ben-Cohen if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) { 542fd2c15ecSOhad Ben-Cohen dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings); 543400e64dfSOhad Ben-Cohen return -EINVAL; 544400e64dfSOhad Ben-Cohen } 545400e64dfSOhad Ben-Cohen 546899585adSAnna, Suman rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL); 5477a186941SOhad Ben-Cohen if (!rvdev) 5487a186941SOhad Ben-Cohen return -ENOMEM; 5497a186941SOhad Ben-Cohen 550aab8d802SBjorn Andersson kref_init(&rvdev->refcount); 551aab8d802SBjorn Andersson 552f5bcb353SBjorn Andersson rvdev->id = rsc->id; 5537a186941SOhad Ben-Cohen rvdev->rproc = rproc; 554c6aed238SLoic Pallardy rvdev->index = rproc->nb_vdev++; 5557a186941SOhad Ben-Cohen 556086d0872SLoic Pallardy /* Initialise vdev subdevice */ 557086d0872SLoic Pallardy snprintf(name, sizeof(name), "vdev%dbuffer", rvdev->index); 558c774ad01SSuman Anna rvdev->dev.parent = &rproc->dev; 559086d0872SLoic Pallardy rvdev->dev.release = rproc_rvdev_release; 560086d0872SLoic Pallardy dev_set_name(&rvdev->dev, "%s#%s", dev_name(rvdev->dev.parent), name); 561086d0872SLoic Pallardy dev_set_drvdata(&rvdev->dev, rvdev); 562086d0872SLoic Pallardy 563086d0872SLoic Pallardy ret = device_register(&rvdev->dev); 564086d0872SLoic Pallardy if (ret) { 565086d0872SLoic Pallardy put_device(&rvdev->dev); 566086d0872SLoic Pallardy return ret; 567086d0872SLoic Pallardy } 5680374a4eaSChristophe JAILLET 5690374a4eaSChristophe JAILLET ret = copy_dma_range_map(&rvdev->dev, rproc->dev.parent); 5700374a4eaSChristophe JAILLET if (ret) 5710374a4eaSChristophe JAILLET goto free_rvdev; 5720374a4eaSChristophe JAILLET 573086d0872SLoic Pallardy /* Make device dma capable by inheriting from parent's capabilities */ 574086d0872SLoic Pallardy set_dma_ops(&rvdev->dev, get_dma_ops(rproc->dev.parent)); 575086d0872SLoic Pallardy 576086d0872SLoic Pallardy ret = dma_coerce_mask_and_coherent(&rvdev->dev, 577086d0872SLoic Pallardy dma_get_mask(rproc->dev.parent)); 578086d0872SLoic Pallardy if (ret) { 579086d0872SLoic Pallardy dev_warn(dev, 5807efb1425SMark-PK Tsai "Failed to set DMA mask %llx. Trying to continue... (%pe)\n", 5817efb1425SMark-PK Tsai dma_get_mask(rproc->dev.parent), ERR_PTR(ret)); 582086d0872SLoic Pallardy } 583086d0872SLoic Pallardy 5846db20ea8SOhad Ben-Cohen /* parse the vrings */ 585fd2c15ecSOhad Ben-Cohen for (i = 0; i < rsc->num_of_vrings; i++) { 5866db20ea8SOhad Ben-Cohen ret = rproc_parse_vring(rvdev, rsc, i); 5877a186941SOhad Ben-Cohen if (ret) 5886db20ea8SOhad Ben-Cohen goto free_rvdev; 589fd2c15ecSOhad Ben-Cohen } 590fd2c15ecSOhad Ben-Cohen 591a2b950acSOhad Ben-Cohen /* remember the resource offset*/ 592a2b950acSOhad Ben-Cohen rvdev->rsc_offset = offset; 593400e64dfSOhad Ben-Cohen 594a863af5dSBjorn Andersson /* allocate the vring resources */ 595a863af5dSBjorn Andersson for (i = 0; i < rsc->num_of_vrings; i++) { 596a863af5dSBjorn Andersson ret = rproc_alloc_vring(rvdev, i); 597a863af5dSBjorn Andersson if (ret) 598a863af5dSBjorn Andersson goto unwind_vring_allocations; 599a863af5dSBjorn Andersson } 600a863af5dSBjorn Andersson 6017a186941SOhad Ben-Cohen list_add_tail(&rvdev->node, &rproc->rvdevs); 602400e64dfSOhad Ben-Cohen 6036f8b0373SAlex Elder rvdev->subdev.start = rproc_vdev_do_start; 6046f8b0373SAlex Elder rvdev->subdev.stop = rproc_vdev_do_stop; 6054902676fSBjorn Andersson 6064902676fSBjorn Andersson rproc_add_subdev(rproc, &rvdev->subdev); 607400e64dfSOhad Ben-Cohen 608400e64dfSOhad Ben-Cohen return 0; 6097a186941SOhad Ben-Cohen 610a863af5dSBjorn Andersson unwind_vring_allocations: 611a863af5dSBjorn Andersson for (i--; i >= 0; i--) 612a863af5dSBjorn Andersson rproc_free_vring(&rvdev->vring[i]); 6136db20ea8SOhad Ben-Cohen free_rvdev: 614086d0872SLoic Pallardy device_unregister(&rvdev->dev); 6157a186941SOhad Ben-Cohen return ret; 616400e64dfSOhad Ben-Cohen } 617400e64dfSOhad Ben-Cohen 618aab8d802SBjorn Andersson void rproc_vdev_release(struct kref *ref) 619aab8d802SBjorn Andersson { 620aab8d802SBjorn Andersson struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount); 621a863af5dSBjorn Andersson struct rproc_vring *rvring; 622f5bcb353SBjorn Andersson struct rproc *rproc = rvdev->rproc; 623a863af5dSBjorn Andersson int id; 624a863af5dSBjorn Andersson 625a863af5dSBjorn Andersson for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) { 626a863af5dSBjorn Andersson rvring = &rvdev->vring[id]; 627a863af5dSBjorn Andersson rproc_free_vring(rvring); 628a863af5dSBjorn Andersson } 629aab8d802SBjorn Andersson 630f5bcb353SBjorn Andersson rproc_remove_subdev(rproc, &rvdev->subdev); 631aab8d802SBjorn Andersson list_del(&rvdev->node); 632086d0872SLoic Pallardy device_unregister(&rvdev->dev); 633aab8d802SBjorn Andersson } 634aab8d802SBjorn Andersson 635400e64dfSOhad Ben-Cohen /** 636400e64dfSOhad Ben-Cohen * rproc_handle_trace() - handle a shared trace buffer resource 637400e64dfSOhad Ben-Cohen * @rproc: the remote processor 6382bf23461SJindong Yue * @ptr: the trace resource descriptor 6392e7d4c2cSArnaud Pouliquen * @offset: offset of the resource entry 640fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 641400e64dfSOhad Ben-Cohen * 642400e64dfSOhad Ben-Cohen * In case the remote processor dumps trace logs into memory, 643400e64dfSOhad Ben-Cohen * export it via debugfs. 644400e64dfSOhad Ben-Cohen * 645400e64dfSOhad Ben-Cohen * Currently, the 'da' member of @rsc should contain the device address 646400e64dfSOhad Ben-Cohen * where the remote processor is dumping the traces. Later we could also 647400e64dfSOhad Ben-Cohen * support dynamically allocating this address using the generic 648400e64dfSOhad Ben-Cohen * DMA API (but currently there isn't a use case for that). 649400e64dfSOhad Ben-Cohen * 650f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 651400e64dfSOhad Ben-Cohen */ 6522bf23461SJindong Yue static int rproc_handle_trace(struct rproc *rproc, void *ptr, 653a2b950acSOhad Ben-Cohen int offset, int avail) 654400e64dfSOhad Ben-Cohen { 6552bf23461SJindong Yue struct fw_rsc_trace *rsc = ptr; 656a987e6b9SLoic Pallardy struct rproc_debug_trace *trace; 657b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 658400e64dfSOhad Ben-Cohen char name[15]; 659400e64dfSOhad Ben-Cohen 660fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 661b5ab5e24SOhad Ben-Cohen dev_err(dev, "trace rsc is truncated\n"); 662fd2c15ecSOhad Ben-Cohen return -EINVAL; 663fd2c15ecSOhad Ben-Cohen } 664fd2c15ecSOhad Ben-Cohen 665fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 666fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 667fd2c15ecSOhad Ben-Cohen dev_err(dev, "trace rsc has non zero reserved bytes\n"); 668fd2c15ecSOhad Ben-Cohen return -EINVAL; 669fd2c15ecSOhad Ben-Cohen } 670fd2c15ecSOhad Ben-Cohen 671400e64dfSOhad Ben-Cohen trace = kzalloc(sizeof(*trace), GFP_KERNEL); 672172e6ab1SSuman Anna if (!trace) 673400e64dfSOhad Ben-Cohen return -ENOMEM; 674400e64dfSOhad Ben-Cohen 675400e64dfSOhad Ben-Cohen /* set the trace buffer dma properties */ 676a987e6b9SLoic Pallardy trace->trace_mem.len = rsc->len; 677a987e6b9SLoic Pallardy trace->trace_mem.da = rsc->da; 678a987e6b9SLoic Pallardy 679a987e6b9SLoic Pallardy /* set pointer on rproc device */ 680a987e6b9SLoic Pallardy trace->rproc = rproc; 681400e64dfSOhad Ben-Cohen 682400e64dfSOhad Ben-Cohen /* make sure snprintf always null terminates, even if truncating */ 683400e64dfSOhad Ben-Cohen snprintf(name, sizeof(name), "trace%d", rproc->num_traces); 684400e64dfSOhad Ben-Cohen 685400e64dfSOhad Ben-Cohen /* create the debugfs entry */ 686a987e6b9SLoic Pallardy trace->tfile = rproc_create_trace_file(name, rproc, trace); 687400e64dfSOhad Ben-Cohen 688400e64dfSOhad Ben-Cohen list_add_tail(&trace->node, &rproc->traces); 689400e64dfSOhad Ben-Cohen 690400e64dfSOhad Ben-Cohen rproc->num_traces++; 691400e64dfSOhad Ben-Cohen 692a987e6b9SLoic Pallardy dev_dbg(dev, "%s added: da 0x%x, len 0x%x\n", 693a987e6b9SLoic Pallardy name, rsc->da, rsc->len); 694400e64dfSOhad Ben-Cohen 695400e64dfSOhad Ben-Cohen return 0; 696400e64dfSOhad Ben-Cohen } 697400e64dfSOhad Ben-Cohen 698400e64dfSOhad Ben-Cohen /** 699400e64dfSOhad Ben-Cohen * rproc_handle_devmem() - handle devmem resource entry 700400e64dfSOhad Ben-Cohen * @rproc: remote processor handle 7012bf23461SJindong Yue * @ptr: the devmem resource entry 7022e7d4c2cSArnaud Pouliquen * @offset: offset of the resource entry 703fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 704400e64dfSOhad Ben-Cohen * 705400e64dfSOhad Ben-Cohen * Remote processors commonly need to access certain on-chip peripherals. 706400e64dfSOhad Ben-Cohen * 707400e64dfSOhad Ben-Cohen * Some of these remote processors access memory via an iommu device, 708400e64dfSOhad Ben-Cohen * and might require us to configure their iommu before they can access 709400e64dfSOhad Ben-Cohen * the on-chip peripherals they need. 710400e64dfSOhad Ben-Cohen * 711400e64dfSOhad Ben-Cohen * This resource entry is a request to map such a peripheral device. 712400e64dfSOhad Ben-Cohen * 713400e64dfSOhad Ben-Cohen * These devmem entries will contain the physical address of the device in 714400e64dfSOhad Ben-Cohen * the 'pa' member. If a specific device address is expected, then 'da' will 715400e64dfSOhad Ben-Cohen * contain it (currently this is the only use case supported). 'len' will 716400e64dfSOhad Ben-Cohen * contain the size of the physical region we need to map. 717400e64dfSOhad Ben-Cohen * 718400e64dfSOhad Ben-Cohen * Currently we just "trust" those devmem entries to contain valid physical 719400e64dfSOhad Ben-Cohen * addresses, but this is going to change: we want the implementations to 720400e64dfSOhad Ben-Cohen * tell us ranges of physical addresses the firmware is allowed to request, 721400e64dfSOhad Ben-Cohen * and not allow firmwares to request access to physical addresses that 722400e64dfSOhad Ben-Cohen * are outside those ranges. 723f2867434SSuman Anna * 724f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 725400e64dfSOhad Ben-Cohen */ 7262bf23461SJindong Yue static int rproc_handle_devmem(struct rproc *rproc, void *ptr, 727a2b950acSOhad Ben-Cohen int offset, int avail) 728400e64dfSOhad Ben-Cohen { 7292bf23461SJindong Yue struct fw_rsc_devmem *rsc = ptr; 730400e64dfSOhad Ben-Cohen struct rproc_mem_entry *mapping; 731b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 732400e64dfSOhad Ben-Cohen int ret; 733400e64dfSOhad Ben-Cohen 734400e64dfSOhad Ben-Cohen /* no point in handling this resource without a valid iommu domain */ 735400e64dfSOhad Ben-Cohen if (!rproc->domain) 736400e64dfSOhad Ben-Cohen return -EINVAL; 737400e64dfSOhad Ben-Cohen 738fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 739b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc is truncated\n"); 740fd2c15ecSOhad Ben-Cohen return -EINVAL; 741fd2c15ecSOhad Ben-Cohen } 742fd2c15ecSOhad Ben-Cohen 743fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 744fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 745b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc has non zero reserved bytes\n"); 746fd2c15ecSOhad Ben-Cohen return -EINVAL; 747fd2c15ecSOhad Ben-Cohen } 748fd2c15ecSOhad Ben-Cohen 749400e64dfSOhad Ben-Cohen mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 750172e6ab1SSuman Anna if (!mapping) 751400e64dfSOhad Ben-Cohen return -ENOMEM; 752400e64dfSOhad Ben-Cohen 753400e64dfSOhad Ben-Cohen ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags); 754400e64dfSOhad Ben-Cohen if (ret) { 755b5ab5e24SOhad Ben-Cohen dev_err(dev, "failed to map devmem: %d\n", ret); 756400e64dfSOhad Ben-Cohen goto out; 757400e64dfSOhad Ben-Cohen } 758400e64dfSOhad Ben-Cohen 759400e64dfSOhad Ben-Cohen /* 760400e64dfSOhad Ben-Cohen * We'll need this info later when we'll want to unmap everything 761400e64dfSOhad Ben-Cohen * (e.g. on shutdown). 762400e64dfSOhad Ben-Cohen * 763400e64dfSOhad Ben-Cohen * We can't trust the remote processor not to change the resource 764400e64dfSOhad Ben-Cohen * table, so we must maintain this info independently. 765400e64dfSOhad Ben-Cohen */ 766400e64dfSOhad Ben-Cohen mapping->da = rsc->da; 767400e64dfSOhad Ben-Cohen mapping->len = rsc->len; 768400e64dfSOhad Ben-Cohen list_add_tail(&mapping->node, &rproc->mappings); 769400e64dfSOhad Ben-Cohen 770b5ab5e24SOhad Ben-Cohen dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n", 771400e64dfSOhad Ben-Cohen rsc->pa, rsc->da, rsc->len); 772400e64dfSOhad Ben-Cohen 773400e64dfSOhad Ben-Cohen return 0; 774400e64dfSOhad Ben-Cohen 775400e64dfSOhad Ben-Cohen out: 776400e64dfSOhad Ben-Cohen kfree(mapping); 777400e64dfSOhad Ben-Cohen return ret; 778400e64dfSOhad Ben-Cohen } 779400e64dfSOhad Ben-Cohen 780400e64dfSOhad Ben-Cohen /** 781d7c51706SLoic Pallardy * rproc_alloc_carveout() - allocated specified carveout 782d7c51706SLoic Pallardy * @rproc: rproc handle 783d7c51706SLoic Pallardy * @mem: the memory entry to allocate 784d7c51706SLoic Pallardy * 785d7c51706SLoic Pallardy * This function allocate specified memory entry @mem using 786d7c51706SLoic Pallardy * dma_alloc_coherent() as default allocator 787f2867434SSuman Anna * 788f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 789d7c51706SLoic Pallardy */ 790d7c51706SLoic Pallardy static int rproc_alloc_carveout(struct rproc *rproc, 791d7c51706SLoic Pallardy struct rproc_mem_entry *mem) 792d7c51706SLoic Pallardy { 793d7c51706SLoic Pallardy struct rproc_mem_entry *mapping = NULL; 794d7c51706SLoic Pallardy struct device *dev = &rproc->dev; 795d7c51706SLoic Pallardy dma_addr_t dma; 796d7c51706SLoic Pallardy void *va; 797d7c51706SLoic Pallardy int ret; 798d7c51706SLoic Pallardy 799d7c51706SLoic Pallardy va = dma_alloc_coherent(dev->parent, mem->len, &dma, GFP_KERNEL); 800d7c51706SLoic Pallardy if (!va) { 801d7c51706SLoic Pallardy dev_err(dev->parent, 802096ee786SClement Leger "failed to allocate dma memory: len 0x%zx\n", 803096ee786SClement Leger mem->len); 804d7c51706SLoic Pallardy return -ENOMEM; 805d7c51706SLoic Pallardy } 806d7c51706SLoic Pallardy 807096ee786SClement Leger dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%zx\n", 808d7c51706SLoic Pallardy va, &dma, mem->len); 809d7c51706SLoic Pallardy 81060f849a5SLoic Pallardy if (mem->da != FW_RSC_ADDR_ANY && !rproc->domain) { 81160f849a5SLoic Pallardy /* 81260f849a5SLoic Pallardy * Check requested da is equal to dma address 81360f849a5SLoic Pallardy * and print a warn message in case of missalignment. 81460f849a5SLoic Pallardy * Don't stop rproc_start sequence as coprocessor may 81560f849a5SLoic Pallardy * build pa to da translation on its side. 81660f849a5SLoic Pallardy */ 81760f849a5SLoic Pallardy if (mem->da != (u32)dma) 81860f849a5SLoic Pallardy dev_warn(dev->parent, 81960f849a5SLoic Pallardy "Allocated carveout doesn't fit device address request\n"); 82060f849a5SLoic Pallardy } 82160f849a5SLoic Pallardy 822d7c51706SLoic Pallardy /* 823d7c51706SLoic Pallardy * Ok, this is non-standard. 824d7c51706SLoic Pallardy * 825d7c51706SLoic Pallardy * Sometimes we can't rely on the generic iommu-based DMA API 826d7c51706SLoic Pallardy * to dynamically allocate the device address and then set the IOMMU 827d7c51706SLoic Pallardy * tables accordingly, because some remote processors might 828d7c51706SLoic Pallardy * _require_ us to use hard coded device addresses that their 829d7c51706SLoic Pallardy * firmware was compiled with. 830d7c51706SLoic Pallardy * 831d7c51706SLoic Pallardy * In this case, we must use the IOMMU API directly and map 832d7c51706SLoic Pallardy * the memory to the device address as expected by the remote 833d7c51706SLoic Pallardy * processor. 834d7c51706SLoic Pallardy * 835d7c51706SLoic Pallardy * Obviously such remote processor devices should not be configured 836d7c51706SLoic Pallardy * to use the iommu-based DMA API: we expect 'dma' to contain the 837d7c51706SLoic Pallardy * physical address in this case. 838d7c51706SLoic Pallardy */ 83960f849a5SLoic Pallardy if (mem->da != FW_RSC_ADDR_ANY && rproc->domain) { 840d7c51706SLoic Pallardy mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 841d7c51706SLoic Pallardy if (!mapping) { 842d7c51706SLoic Pallardy ret = -ENOMEM; 843d7c51706SLoic Pallardy goto dma_free; 844d7c51706SLoic Pallardy } 845d7c51706SLoic Pallardy 846d7c51706SLoic Pallardy ret = iommu_map(rproc->domain, mem->da, dma, mem->len, 847d7c51706SLoic Pallardy mem->flags); 848d7c51706SLoic Pallardy if (ret) { 849d7c51706SLoic Pallardy dev_err(dev, "iommu_map failed: %d\n", ret); 850d7c51706SLoic Pallardy goto free_mapping; 851d7c51706SLoic Pallardy } 852d7c51706SLoic Pallardy 853d7c51706SLoic Pallardy /* 854d7c51706SLoic Pallardy * We'll need this info later when we'll want to unmap 855d7c51706SLoic Pallardy * everything (e.g. on shutdown). 856d7c51706SLoic Pallardy * 857d7c51706SLoic Pallardy * We can't trust the remote processor not to change the 858d7c51706SLoic Pallardy * resource table, so we must maintain this info independently. 859d7c51706SLoic Pallardy */ 860d7c51706SLoic Pallardy mapping->da = mem->da; 861d7c51706SLoic Pallardy mapping->len = mem->len; 862d7c51706SLoic Pallardy list_add_tail(&mapping->node, &rproc->mappings); 863d7c51706SLoic Pallardy 864d7c51706SLoic Pallardy dev_dbg(dev, "carveout mapped 0x%x to %pad\n", 865d7c51706SLoic Pallardy mem->da, &dma); 86660f849a5SLoic Pallardy } 86760f849a5SLoic Pallardy 86860f849a5SLoic Pallardy if (mem->da == FW_RSC_ADDR_ANY) { 869b36de8cfSLoic Pallardy /* Update device address as undefined by requester */ 870b36de8cfSLoic Pallardy if ((u64)dma & HIGH_BITS_MASK) 871b36de8cfSLoic Pallardy dev_warn(dev, "DMA address cast in 32bit to fit resource table format\n"); 872b36de8cfSLoic Pallardy 873d7c51706SLoic Pallardy mem->da = (u32)dma; 874d7c51706SLoic Pallardy } 875d7c51706SLoic Pallardy 87680137b40SLoic Pallardy mem->dma = dma; 877d7c51706SLoic Pallardy mem->va = va; 878d7c51706SLoic Pallardy 879d7c51706SLoic Pallardy return 0; 880d7c51706SLoic Pallardy 881d7c51706SLoic Pallardy free_mapping: 882d7c51706SLoic Pallardy kfree(mapping); 883d7c51706SLoic Pallardy dma_free: 884d7c51706SLoic Pallardy dma_free_coherent(dev->parent, mem->len, va, dma); 885d7c51706SLoic Pallardy return ret; 886d7c51706SLoic Pallardy } 887d7c51706SLoic Pallardy 888d7c51706SLoic Pallardy /** 889f2e74abfSLoic Pallardy * rproc_release_carveout() - release acquired carveout 890f2e74abfSLoic Pallardy * @rproc: rproc handle 891f2e74abfSLoic Pallardy * @mem: the memory entry to release 892f2e74abfSLoic Pallardy * 893f2e74abfSLoic Pallardy * This function releases specified memory entry @mem allocated via 894d7c51706SLoic Pallardy * rproc_alloc_carveout() function by @rproc. 895f2867434SSuman Anna * 896f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 897f2e74abfSLoic Pallardy */ 898f2e74abfSLoic Pallardy static int rproc_release_carveout(struct rproc *rproc, 899f2e74abfSLoic Pallardy struct rproc_mem_entry *mem) 900f2e74abfSLoic Pallardy { 901f2e74abfSLoic Pallardy struct device *dev = &rproc->dev; 902f2e74abfSLoic Pallardy 903f2e74abfSLoic Pallardy /* clean up carveout allocations */ 904f2e74abfSLoic Pallardy dma_free_coherent(dev->parent, mem->len, mem->va, mem->dma); 905f2e74abfSLoic Pallardy return 0; 906f2e74abfSLoic Pallardy } 907f2e74abfSLoic Pallardy 908f2e74abfSLoic Pallardy /** 909400e64dfSOhad Ben-Cohen * rproc_handle_carveout() - handle phys contig memory allocation requests 910400e64dfSOhad Ben-Cohen * @rproc: rproc handle 9112bf23461SJindong Yue * @ptr: the resource entry 9122e7d4c2cSArnaud Pouliquen * @offset: offset of the resource entry 913fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for image validation) 914400e64dfSOhad Ben-Cohen * 915400e64dfSOhad Ben-Cohen * This function will handle firmware requests for allocation of physically 916400e64dfSOhad Ben-Cohen * contiguous memory regions. 917400e64dfSOhad Ben-Cohen * 918400e64dfSOhad Ben-Cohen * These request entries should come first in the firmware's resource table, 919400e64dfSOhad Ben-Cohen * as other firmware entries might request placing other data objects inside 920400e64dfSOhad Ben-Cohen * these memory regions (e.g. data/code segments, trace resource entries, ...). 921400e64dfSOhad Ben-Cohen * 922400e64dfSOhad Ben-Cohen * Allocating memory this way helps utilizing the reserved physical memory 923400e64dfSOhad Ben-Cohen * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries 924400e64dfSOhad Ben-Cohen * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB 925400e64dfSOhad Ben-Cohen * pressure is important; it may have a substantial impact on performance. 926f2867434SSuman Anna * 927f2867434SSuman Anna * Return: 0 on success, or an appropriate error code otherwise 928400e64dfSOhad Ben-Cohen */ 929fd2c15ecSOhad Ben-Cohen static int rproc_handle_carveout(struct rproc *rproc, 9302bf23461SJindong Yue void *ptr, int offset, int avail) 931400e64dfSOhad Ben-Cohen { 9322bf23461SJindong Yue struct fw_rsc_carveout *rsc = ptr; 933d7c51706SLoic Pallardy struct rproc_mem_entry *carveout; 934b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 935400e64dfSOhad Ben-Cohen 936fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 937b5ab5e24SOhad Ben-Cohen dev_err(dev, "carveout rsc is truncated\n"); 938fd2c15ecSOhad Ben-Cohen return -EINVAL; 939fd2c15ecSOhad Ben-Cohen } 940fd2c15ecSOhad Ben-Cohen 941fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 942fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 943fd2c15ecSOhad Ben-Cohen dev_err(dev, "carveout rsc has non zero reserved bytes\n"); 944fd2c15ecSOhad Ben-Cohen return -EINVAL; 945fd2c15ecSOhad Ben-Cohen } 946fd2c15ecSOhad Ben-Cohen 9479d7814a9SAnna, Suman dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n", 94835386166SLee Jones rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags); 949fd2c15ecSOhad Ben-Cohen 950ffa5f9c8SLoic Pallardy /* 951ffa5f9c8SLoic Pallardy * Check carveout rsc already part of a registered carveout, 952ffa5f9c8SLoic Pallardy * Search by name, then check the da and length 953ffa5f9c8SLoic Pallardy */ 954ffa5f9c8SLoic Pallardy carveout = rproc_find_carveout_by_name(rproc, rsc->name); 955ffa5f9c8SLoic Pallardy 956ffa5f9c8SLoic Pallardy if (carveout) { 957ffa5f9c8SLoic Pallardy if (carveout->rsc_offset != FW_RSC_ADDR_ANY) { 958ffa5f9c8SLoic Pallardy dev_err(dev, 959ffa5f9c8SLoic Pallardy "Carveout already associated to resource table\n"); 960ffa5f9c8SLoic Pallardy return -ENOMEM; 961ffa5f9c8SLoic Pallardy } 962ffa5f9c8SLoic Pallardy 963ffa5f9c8SLoic Pallardy if (rproc_check_carveout_da(rproc, carveout, rsc->da, rsc->len)) 964ffa5f9c8SLoic Pallardy return -ENOMEM; 965ffa5f9c8SLoic Pallardy 966ffa5f9c8SLoic Pallardy /* Update memory carveout with resource table info */ 967ffa5f9c8SLoic Pallardy carveout->rsc_offset = offset; 968ffa5f9c8SLoic Pallardy carveout->flags = rsc->flags; 969ffa5f9c8SLoic Pallardy 970ffa5f9c8SLoic Pallardy return 0; 971ffa5f9c8SLoic Pallardy } 972ffa5f9c8SLoic Pallardy 973d7c51706SLoic Pallardy /* Register carveout in in list */ 97499cf0361SBen Dooks (Codethink) carveout = rproc_mem_entry_init(dev, NULL, 0, rsc->len, rsc->da, 975d7c51706SLoic Pallardy rproc_alloc_carveout, 976d7c51706SLoic Pallardy rproc_release_carveout, rsc->name); 977d7c51706SLoic Pallardy if (!carveout) { 978d7c51706SLoic Pallardy dev_err(dev, "Can't allocate memory entry structure\n"); 97972029c90SLoic Pallardy return -ENOMEM; 980400e64dfSOhad Ben-Cohen } 981400e64dfSOhad Ben-Cohen 982d7c51706SLoic Pallardy carveout->flags = rsc->flags; 983d7c51706SLoic Pallardy carveout->rsc_offset = offset; 98415c0b025SLoic Pallardy rproc_add_carveout(rproc, carveout); 985400e64dfSOhad Ben-Cohen 986400e64dfSOhad Ben-Cohen return 0; 987400e64dfSOhad Ben-Cohen } 988400e64dfSOhad Ben-Cohen 98972029c90SLoic Pallardy /** 99015c0b025SLoic Pallardy * rproc_add_carveout() - register an allocated carveout region 99115c0b025SLoic Pallardy * @rproc: rproc handle 99215c0b025SLoic Pallardy * @mem: memory entry to register 99315c0b025SLoic Pallardy * 99415c0b025SLoic Pallardy * This function registers specified memory entry in @rproc carveouts list. 99515c0b025SLoic Pallardy * Specified carveout should have been allocated before registering. 99615c0b025SLoic Pallardy */ 99715c0b025SLoic Pallardy void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem) 99815c0b025SLoic Pallardy { 99915c0b025SLoic Pallardy list_add_tail(&mem->node, &rproc->carveouts); 100015c0b025SLoic Pallardy } 100115c0b025SLoic Pallardy EXPORT_SYMBOL(rproc_add_carveout); 100215c0b025SLoic Pallardy 100315c0b025SLoic Pallardy /** 100472029c90SLoic Pallardy * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct 100572029c90SLoic Pallardy * @dev: pointer on device struct 100672029c90SLoic Pallardy * @va: virtual address 100772029c90SLoic Pallardy * @dma: dma address 100872029c90SLoic Pallardy * @len: memory carveout length 100972029c90SLoic Pallardy * @da: device address 1010a9f6fe0dSLoic Pallardy * @alloc: memory carveout allocation function 1011a9f6fe0dSLoic Pallardy * @release: memory carveout release function 101272029c90SLoic Pallardy * @name: carveout name 101372029c90SLoic Pallardy * 101472029c90SLoic Pallardy * This function allocates a rproc_mem_entry struct and fill it with parameters 101572029c90SLoic Pallardy * provided by client. 1016f2867434SSuman Anna * 1017f2867434SSuman Anna * Return: a valid pointer on success, or NULL on failure 101872029c90SLoic Pallardy */ 10197e05c8deSLee Jones __printf(8, 9) 102072029c90SLoic Pallardy struct rproc_mem_entry * 102172029c90SLoic Pallardy rproc_mem_entry_init(struct device *dev, 1022096ee786SClement Leger void *va, dma_addr_t dma, size_t len, u32 da, 1023d7c51706SLoic Pallardy int (*alloc)(struct rproc *, struct rproc_mem_entry *), 102472029c90SLoic Pallardy int (*release)(struct rproc *, struct rproc_mem_entry *), 102572029c90SLoic Pallardy const char *name, ...) 102672029c90SLoic Pallardy { 102772029c90SLoic Pallardy struct rproc_mem_entry *mem; 102872029c90SLoic Pallardy va_list args; 102972029c90SLoic Pallardy 103072029c90SLoic Pallardy mem = kzalloc(sizeof(*mem), GFP_KERNEL); 103172029c90SLoic Pallardy if (!mem) 103272029c90SLoic Pallardy return mem; 103372029c90SLoic Pallardy 103472029c90SLoic Pallardy mem->va = va; 103572029c90SLoic Pallardy mem->dma = dma; 103672029c90SLoic Pallardy mem->da = da; 103772029c90SLoic Pallardy mem->len = len; 1038d7c51706SLoic Pallardy mem->alloc = alloc; 103972029c90SLoic Pallardy mem->release = release; 1040d7c51706SLoic Pallardy mem->rsc_offset = FW_RSC_ADDR_ANY; 10411429cca1SLoic Pallardy mem->of_resm_idx = -1; 104272029c90SLoic Pallardy 104372029c90SLoic Pallardy va_start(args, name); 104472029c90SLoic Pallardy vsnprintf(mem->name, sizeof(mem->name), name, args); 104572029c90SLoic Pallardy va_end(args); 104672029c90SLoic Pallardy 104772029c90SLoic Pallardy return mem; 104872029c90SLoic Pallardy } 104972029c90SLoic Pallardy EXPORT_SYMBOL(rproc_mem_entry_init); 105072029c90SLoic Pallardy 105172029c90SLoic Pallardy /** 10521429cca1SLoic Pallardy * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct 10531429cca1SLoic Pallardy * from a reserved memory phandle 10541429cca1SLoic Pallardy * @dev: pointer on device struct 10551429cca1SLoic Pallardy * @of_resm_idx: reserved memory phandle index in "memory-region" 10561429cca1SLoic Pallardy * @len: memory carveout length 10571429cca1SLoic Pallardy * @da: device address 10581429cca1SLoic Pallardy * @name: carveout name 10591429cca1SLoic Pallardy * 10601429cca1SLoic Pallardy * This function allocates a rproc_mem_entry struct and fill it with parameters 10611429cca1SLoic Pallardy * provided by client. 1062f2867434SSuman Anna * 1063f2867434SSuman Anna * Return: a valid pointer on success, or NULL on failure 10641429cca1SLoic Pallardy */ 10657e05c8deSLee Jones __printf(5, 6) 10661429cca1SLoic Pallardy struct rproc_mem_entry * 1067096ee786SClement Leger rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, size_t len, 10681429cca1SLoic Pallardy u32 da, const char *name, ...) 10691429cca1SLoic Pallardy { 10701429cca1SLoic Pallardy struct rproc_mem_entry *mem; 10711429cca1SLoic Pallardy va_list args; 10721429cca1SLoic Pallardy 10731429cca1SLoic Pallardy mem = kzalloc(sizeof(*mem), GFP_KERNEL); 10741429cca1SLoic Pallardy if (!mem) 10751429cca1SLoic Pallardy return mem; 10761429cca1SLoic Pallardy 10771429cca1SLoic Pallardy mem->da = da; 10781429cca1SLoic Pallardy mem->len = len; 10791429cca1SLoic Pallardy mem->rsc_offset = FW_RSC_ADDR_ANY; 10801429cca1SLoic Pallardy mem->of_resm_idx = of_resm_idx; 10811429cca1SLoic Pallardy 10821429cca1SLoic Pallardy va_start(args, name); 10831429cca1SLoic Pallardy vsnprintf(mem->name, sizeof(mem->name), name, args); 10841429cca1SLoic Pallardy va_end(args); 10851429cca1SLoic Pallardy 10861429cca1SLoic Pallardy return mem; 10871429cca1SLoic Pallardy } 10881429cca1SLoic Pallardy EXPORT_SYMBOL(rproc_of_resm_mem_entry_init); 10891429cca1SLoic Pallardy 1090a8aa5ee1SSuman Anna /** 1091a8aa5ee1SSuman Anna * rproc_of_parse_firmware() - parse and return the firmware-name 1092a8aa5ee1SSuman Anna * @dev: pointer on device struct representing a rproc 1093a8aa5ee1SSuman Anna * @index: index to use for the firmware-name retrieval 1094a8aa5ee1SSuman Anna * @fw_name: pointer to a character string, in which the firmware 1095a8aa5ee1SSuman Anna * name is returned on success and unmodified otherwise. 1096a8aa5ee1SSuman Anna * 1097a8aa5ee1SSuman Anna * This is an OF helper function that parses a device's DT node for 1098a8aa5ee1SSuman Anna * the "firmware-name" property and returns the firmware name pointer 1099a8aa5ee1SSuman Anna * in @fw_name on success. 1100a8aa5ee1SSuman Anna * 1101a8aa5ee1SSuman Anna * Return: 0 on success, or an appropriate failure. 1102a8aa5ee1SSuman Anna */ 1103a8aa5ee1SSuman Anna int rproc_of_parse_firmware(struct device *dev, int index, const char **fw_name) 1104a8aa5ee1SSuman Anna { 1105a8aa5ee1SSuman Anna int ret; 1106a8aa5ee1SSuman Anna 1107a8aa5ee1SSuman Anna ret = of_property_read_string_index(dev->of_node, "firmware-name", 1108a8aa5ee1SSuman Anna index, fw_name); 1109a8aa5ee1SSuman Anna return ret ? ret : 0; 1110a8aa5ee1SSuman Anna } 1111a8aa5ee1SSuman Anna EXPORT_SYMBOL(rproc_of_parse_firmware); 1112a8aa5ee1SSuman Anna 11132e7d4c2cSArnaud Pouliquen /* 1114e12bc14bSOhad Ben-Cohen * A lookup table for resource handlers. The indices are defined in 1115e12bc14bSOhad Ben-Cohen * enum fw_resource_type. 1116e12bc14bSOhad Ben-Cohen */ 1117232fcdbbSSjur Brændeland static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = { 11182bf23461SJindong Yue [RSC_CARVEOUT] = rproc_handle_carveout, 11192bf23461SJindong Yue [RSC_DEVMEM] = rproc_handle_devmem, 11202bf23461SJindong Yue [RSC_TRACE] = rproc_handle_trace, 11212bf23461SJindong Yue [RSC_VDEV] = rproc_handle_vdev, 1122232fcdbbSSjur Brændeland }; 1123232fcdbbSSjur Brændeland 1124400e64dfSOhad Ben-Cohen /* handle firmware resource entries before booting the remote processor */ 1125a4b24c75SBjorn Andersson static int rproc_handle_resources(struct rproc *rproc, 1126232fcdbbSSjur Brændeland rproc_handle_resource_t handlers[RSC_LAST]) 1127400e64dfSOhad Ben-Cohen { 1128b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1129e12bc14bSOhad Ben-Cohen rproc_handle_resource_t handler; 1130fd2c15ecSOhad Ben-Cohen int ret = 0, i; 1131400e64dfSOhad Ben-Cohen 1132d4bb86f2SBjorn Andersson if (!rproc->table_ptr) 1133d4bb86f2SBjorn Andersson return 0; 1134d4bb86f2SBjorn Andersson 1135a2b950acSOhad Ben-Cohen for (i = 0; i < rproc->table_ptr->num; i++) { 1136a2b950acSOhad Ben-Cohen int offset = rproc->table_ptr->offset[i]; 1137a2b950acSOhad Ben-Cohen struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset; 1138a4b24c75SBjorn Andersson int avail = rproc->table_sz - offset - sizeof(*hdr); 1139fd2c15ecSOhad Ben-Cohen void *rsc = (void *)hdr + sizeof(*hdr); 1140400e64dfSOhad Ben-Cohen 1141fd2c15ecSOhad Ben-Cohen /* make sure table isn't truncated */ 1142fd2c15ecSOhad Ben-Cohen if (avail < 0) { 1143fd2c15ecSOhad Ben-Cohen dev_err(dev, "rsc table is truncated\n"); 1144fd2c15ecSOhad Ben-Cohen return -EINVAL; 1145fd2c15ecSOhad Ben-Cohen } 1146fd2c15ecSOhad Ben-Cohen 1147fd2c15ecSOhad Ben-Cohen dev_dbg(dev, "rsc: type %d\n", hdr->type); 1148fd2c15ecSOhad Ben-Cohen 1149b1a17513SClement Leger if (hdr->type >= RSC_VENDOR_START && 1150b1a17513SClement Leger hdr->type <= RSC_VENDOR_END) { 1151b1a17513SClement Leger ret = rproc_handle_rsc(rproc, hdr->type, rsc, 1152b1a17513SClement Leger offset + sizeof(*hdr), avail); 1153b1a17513SClement Leger if (ret == RSC_HANDLED) 1154b1a17513SClement Leger continue; 1155b1a17513SClement Leger else if (ret < 0) 1156b1a17513SClement Leger break; 1157b1a17513SClement Leger 1158b1a17513SClement Leger dev_warn(dev, "unsupported vendor resource %d\n", 1159b1a17513SClement Leger hdr->type); 1160b1a17513SClement Leger continue; 1161b1a17513SClement Leger } 1162b1a17513SClement Leger 1163fd2c15ecSOhad Ben-Cohen if (hdr->type >= RSC_LAST) { 1164fd2c15ecSOhad Ben-Cohen dev_warn(dev, "unsupported resource %d\n", hdr->type); 1165e12bc14bSOhad Ben-Cohen continue; 1166400e64dfSOhad Ben-Cohen } 1167400e64dfSOhad Ben-Cohen 1168232fcdbbSSjur Brændeland handler = handlers[hdr->type]; 1169e12bc14bSOhad Ben-Cohen if (!handler) 1170e12bc14bSOhad Ben-Cohen continue; 1171e12bc14bSOhad Ben-Cohen 1172a2b950acSOhad Ben-Cohen ret = handler(rproc, rsc, offset + sizeof(*hdr), avail); 11737a186941SOhad Ben-Cohen if (ret) 1174400e64dfSOhad Ben-Cohen break; 1175400e64dfSOhad Ben-Cohen } 1176400e64dfSOhad Ben-Cohen 1177400e64dfSOhad Ben-Cohen return ret; 1178400e64dfSOhad Ben-Cohen } 1179400e64dfSOhad Ben-Cohen 1180c455daa4SBjorn Andersson static int rproc_prepare_subdevices(struct rproc *rproc) 1181c455daa4SBjorn Andersson { 1182c455daa4SBjorn Andersson struct rproc_subdev *subdev; 1183c455daa4SBjorn Andersson int ret; 1184c455daa4SBjorn Andersson 1185c455daa4SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 1186c455daa4SBjorn Andersson if (subdev->prepare) { 1187c455daa4SBjorn Andersson ret = subdev->prepare(subdev); 1188c455daa4SBjorn Andersson if (ret) 1189c455daa4SBjorn Andersson goto unroll_preparation; 1190c455daa4SBjorn Andersson } 1191c455daa4SBjorn Andersson } 1192c455daa4SBjorn Andersson 1193c455daa4SBjorn Andersson return 0; 1194c455daa4SBjorn Andersson 1195c455daa4SBjorn Andersson unroll_preparation: 1196c455daa4SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 1197c455daa4SBjorn Andersson if (subdev->unprepare) 1198c455daa4SBjorn Andersson subdev->unprepare(subdev); 1199c455daa4SBjorn Andersson } 1200c455daa4SBjorn Andersson 1201c455daa4SBjorn Andersson return ret; 1202c455daa4SBjorn Andersson } 1203c455daa4SBjorn Andersson 1204618fcff3SBjorn Andersson static int rproc_start_subdevices(struct rproc *rproc) 12057bdc9650SBjorn Andersson { 12067bdc9650SBjorn Andersson struct rproc_subdev *subdev; 12077bdc9650SBjorn Andersson int ret; 12087bdc9650SBjorn Andersson 12097bdc9650SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 1210be37b1e0SBjorn Andersson if (subdev->start) { 1211618fcff3SBjorn Andersson ret = subdev->start(subdev); 12127bdc9650SBjorn Andersson if (ret) 12137bdc9650SBjorn Andersson goto unroll_registration; 12147bdc9650SBjorn Andersson } 1215be37b1e0SBjorn Andersson } 12167bdc9650SBjorn Andersson 12177bdc9650SBjorn Andersson return 0; 12187bdc9650SBjorn Andersson 12197bdc9650SBjorn Andersson unroll_registration: 1220be37b1e0SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 1221be37b1e0SBjorn Andersson if (subdev->stop) 1222618fcff3SBjorn Andersson subdev->stop(subdev, true); 1223be37b1e0SBjorn Andersson } 12247bdc9650SBjorn Andersson 12257bdc9650SBjorn Andersson return ret; 12267bdc9650SBjorn Andersson } 12277bdc9650SBjorn Andersson 1228618fcff3SBjorn Andersson static void rproc_stop_subdevices(struct rproc *rproc, bool crashed) 12297bdc9650SBjorn Andersson { 12307bdc9650SBjorn Andersson struct rproc_subdev *subdev; 12317bdc9650SBjorn Andersson 1232be37b1e0SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 1233be37b1e0SBjorn Andersson if (subdev->stop) 1234618fcff3SBjorn Andersson subdev->stop(subdev, crashed); 12357bdc9650SBjorn Andersson } 1236be37b1e0SBjorn Andersson } 12377bdc9650SBjorn Andersson 1238c455daa4SBjorn Andersson static void rproc_unprepare_subdevices(struct rproc *rproc) 1239c455daa4SBjorn Andersson { 1240c455daa4SBjorn Andersson struct rproc_subdev *subdev; 1241c455daa4SBjorn Andersson 1242c455daa4SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 1243c455daa4SBjorn Andersson if (subdev->unprepare) 1244c455daa4SBjorn Andersson subdev->unprepare(subdev); 1245c455daa4SBjorn Andersson } 1246c455daa4SBjorn Andersson } 1247c455daa4SBjorn Andersson 1248400e64dfSOhad Ben-Cohen /** 1249d7c51706SLoic Pallardy * rproc_alloc_registered_carveouts() - allocate all carveouts registered 1250d7c51706SLoic Pallardy * in the list 1251d7c51706SLoic Pallardy * @rproc: the remote processor handle 1252d7c51706SLoic Pallardy * 1253d7c51706SLoic Pallardy * This function parses registered carveout list, performs allocation 1254d7c51706SLoic Pallardy * if alloc() ops registered and updates resource table information 1255d7c51706SLoic Pallardy * if rsc_offset set. 1256d7c51706SLoic Pallardy * 1257d7c51706SLoic Pallardy * Return: 0 on success 1258d7c51706SLoic Pallardy */ 1259d7c51706SLoic Pallardy static int rproc_alloc_registered_carveouts(struct rproc *rproc) 1260d7c51706SLoic Pallardy { 1261d7c51706SLoic Pallardy struct rproc_mem_entry *entry, *tmp; 1262d7c51706SLoic Pallardy struct fw_rsc_carveout *rsc; 1263d7c51706SLoic Pallardy struct device *dev = &rproc->dev; 1264b36de8cfSLoic Pallardy u64 pa; 1265d7c51706SLoic Pallardy int ret; 1266d7c51706SLoic Pallardy 1267d7c51706SLoic Pallardy list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 1268d7c51706SLoic Pallardy if (entry->alloc) { 1269d7c51706SLoic Pallardy ret = entry->alloc(rproc, entry); 1270d7c51706SLoic Pallardy if (ret) { 1271d7c51706SLoic Pallardy dev_err(dev, "Unable to allocate carveout %s: %d\n", 1272d7c51706SLoic Pallardy entry->name, ret); 1273d7c51706SLoic Pallardy return -ENOMEM; 1274d7c51706SLoic Pallardy } 1275d7c51706SLoic Pallardy } 1276d7c51706SLoic Pallardy 1277d7c51706SLoic Pallardy if (entry->rsc_offset != FW_RSC_ADDR_ANY) { 1278d7c51706SLoic Pallardy /* update resource table */ 1279d7c51706SLoic Pallardy rsc = (void *)rproc->table_ptr + entry->rsc_offset; 1280d7c51706SLoic Pallardy 1281d7c51706SLoic Pallardy /* 1282d7c51706SLoic Pallardy * Some remote processors might need to know the pa 1283d7c51706SLoic Pallardy * even though they are behind an IOMMU. E.g., OMAP4's 1284d7c51706SLoic Pallardy * remote M3 processor needs this so it can control 1285d7c51706SLoic Pallardy * on-chip hardware accelerators that are not behind 1286d7c51706SLoic Pallardy * the IOMMU, and therefor must know the pa. 1287d7c51706SLoic Pallardy * 1288d7c51706SLoic Pallardy * Generally we don't want to expose physical addresses 1289d7c51706SLoic Pallardy * if we don't have to (remote processors are generally 1290d7c51706SLoic Pallardy * _not_ trusted), so we might want to do this only for 1291d7c51706SLoic Pallardy * remote processor that _must_ have this (e.g. OMAP4's 1292d7c51706SLoic Pallardy * dual M3 subsystem). 1293d7c51706SLoic Pallardy * 1294d7c51706SLoic Pallardy * Non-IOMMU processors might also want to have this info. 1295d7c51706SLoic Pallardy * In this case, the device address and the physical address 1296d7c51706SLoic Pallardy * are the same. 1297d7c51706SLoic Pallardy */ 1298ffa5f9c8SLoic Pallardy 1299ffa5f9c8SLoic Pallardy /* Use va if defined else dma to generate pa */ 1300d7c51706SLoic Pallardy if (entry->va) 1301b36de8cfSLoic Pallardy pa = (u64)rproc_va_to_pa(entry->va); 1302ffa5f9c8SLoic Pallardy else 1303b36de8cfSLoic Pallardy pa = (u64)entry->dma; 1304ffa5f9c8SLoic Pallardy 1305b36de8cfSLoic Pallardy if (((u64)pa) & HIGH_BITS_MASK) 1306b36de8cfSLoic Pallardy dev_warn(dev, 1307b36de8cfSLoic Pallardy "Physical address cast in 32bit to fit resource table format\n"); 1308b36de8cfSLoic Pallardy 1309b36de8cfSLoic Pallardy rsc->pa = (u32)pa; 1310ffa5f9c8SLoic Pallardy rsc->da = entry->da; 1311ffa5f9c8SLoic Pallardy rsc->len = entry->len; 1312d7c51706SLoic Pallardy } 1313d7c51706SLoic Pallardy } 1314d7c51706SLoic Pallardy 1315d7c51706SLoic Pallardy return 0; 1316d7c51706SLoic Pallardy } 1317d7c51706SLoic Pallardy 13182666ca91SSarangdhar Joshi 13192666ca91SSarangdhar Joshi /** 1320400e64dfSOhad Ben-Cohen * rproc_resource_cleanup() - clean up and free all acquired resources 1321400e64dfSOhad Ben-Cohen * @rproc: rproc handle 1322400e64dfSOhad Ben-Cohen * 1323400e64dfSOhad Ben-Cohen * This function will free all resources acquired for @rproc, and it 13247a186941SOhad Ben-Cohen * is called whenever @rproc either shuts down or fails to boot. 1325400e64dfSOhad Ben-Cohen */ 1326d9473cbfSMathieu Poirier void rproc_resource_cleanup(struct rproc *rproc) 1327400e64dfSOhad Ben-Cohen { 1328400e64dfSOhad Ben-Cohen struct rproc_mem_entry *entry, *tmp; 1329a987e6b9SLoic Pallardy struct rproc_debug_trace *trace, *ttmp; 1330d81fb32fSBjorn Andersson struct rproc_vdev *rvdev, *rvtmp; 1331b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1332400e64dfSOhad Ben-Cohen 1333400e64dfSOhad Ben-Cohen /* clean up debugfs trace entries */ 1334a987e6b9SLoic Pallardy list_for_each_entry_safe(trace, ttmp, &rproc->traces, node) { 1335a987e6b9SLoic Pallardy rproc_remove_trace_file(trace->tfile); 1336400e64dfSOhad Ben-Cohen rproc->num_traces--; 1337a987e6b9SLoic Pallardy list_del(&trace->node); 1338a987e6b9SLoic Pallardy kfree(trace); 1339400e64dfSOhad Ben-Cohen } 1340400e64dfSOhad Ben-Cohen 1341400e64dfSOhad Ben-Cohen /* clean up iommu mapping entries */ 1342400e64dfSOhad Ben-Cohen list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) { 1343400e64dfSOhad Ben-Cohen size_t unmapped; 1344400e64dfSOhad Ben-Cohen 1345400e64dfSOhad Ben-Cohen unmapped = iommu_unmap(rproc->domain, entry->da, entry->len); 1346400e64dfSOhad Ben-Cohen if (unmapped != entry->len) { 1347400e64dfSOhad Ben-Cohen /* nothing much to do besides complaining */ 1348096ee786SClement Leger dev_err(dev, "failed to unmap %zx/%zu\n", entry->len, 1349400e64dfSOhad Ben-Cohen unmapped); 1350400e64dfSOhad Ben-Cohen } 1351400e64dfSOhad Ben-Cohen 1352400e64dfSOhad Ben-Cohen list_del(&entry->node); 1353400e64dfSOhad Ben-Cohen kfree(entry); 1354400e64dfSOhad Ben-Cohen } 1355b6356a01SSuman Anna 1356b6356a01SSuman Anna /* clean up carveout allocations */ 1357b6356a01SSuman Anna list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 1358f2e74abfSLoic Pallardy if (entry->release) 1359f2e74abfSLoic Pallardy entry->release(rproc, entry); 1360b6356a01SSuman Anna list_del(&entry->node); 1361b6356a01SSuman Anna kfree(entry); 1362b6356a01SSuman Anna } 1363d81fb32fSBjorn Andersson 1364d81fb32fSBjorn Andersson /* clean up remote vdev entries */ 1365f5bcb353SBjorn Andersson list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node) 13662b45cef5SBjorn Andersson kref_put(&rvdev->refcount, rproc_vdev_release); 13672666ca91SSarangdhar Joshi 13682666ca91SSarangdhar Joshi rproc_coredump_cleanup(rproc); 13692b45cef5SBjorn Andersson } 1370d9473cbfSMathieu Poirier EXPORT_SYMBOL(rproc_resource_cleanup); 1371400e64dfSOhad Ben-Cohen 13721efa30d0SSarangdhar Joshi static int rproc_start(struct rproc *rproc, const struct firmware *fw) 13731efa30d0SSarangdhar Joshi { 1374a4b24c75SBjorn Andersson struct resource_table *loaded_table; 13751efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 1376a4b24c75SBjorn Andersson int ret; 13771efa30d0SSarangdhar Joshi 13781efa30d0SSarangdhar Joshi /* load the ELF segments to memory */ 13791efa30d0SSarangdhar Joshi ret = rproc_load_segments(rproc, fw); 13801efa30d0SSarangdhar Joshi if (ret) { 13811efa30d0SSarangdhar Joshi dev_err(dev, "Failed to load program segments: %d\n", ret); 13821efa30d0SSarangdhar Joshi return ret; 13831efa30d0SSarangdhar Joshi } 13841efa30d0SSarangdhar Joshi 13851efa30d0SSarangdhar Joshi /* 13861efa30d0SSarangdhar Joshi * The starting device has been given the rproc->cached_table as the 13871efa30d0SSarangdhar Joshi * resource table. The address of the vring along with the other 13881efa30d0SSarangdhar Joshi * allocated resources (carveouts etc) is stored in cached_table. 13891efa30d0SSarangdhar Joshi * In order to pass this information to the remote device we must copy 13901efa30d0SSarangdhar Joshi * this information to device memory. We also update the table_ptr so 13911efa30d0SSarangdhar Joshi * that any subsequent changes will be applied to the loaded version. 13921efa30d0SSarangdhar Joshi */ 13931efa30d0SSarangdhar Joshi loaded_table = rproc_find_loaded_rsc_table(rproc, fw); 13941efa30d0SSarangdhar Joshi if (loaded_table) { 1395a4b24c75SBjorn Andersson memcpy(loaded_table, rproc->cached_table, rproc->table_sz); 13961efa30d0SSarangdhar Joshi rproc->table_ptr = loaded_table; 13971efa30d0SSarangdhar Joshi } 13981efa30d0SSarangdhar Joshi 1399c455daa4SBjorn Andersson ret = rproc_prepare_subdevices(rproc); 1400c455daa4SBjorn Andersson if (ret) { 1401c455daa4SBjorn Andersson dev_err(dev, "failed to prepare subdevices for %s: %d\n", 1402c455daa4SBjorn Andersson rproc->name, ret); 1403f68d51bdSSuman Anna goto reset_table_ptr; 1404c455daa4SBjorn Andersson } 1405c455daa4SBjorn Andersson 14061efa30d0SSarangdhar Joshi /* power up the remote processor */ 14071efa30d0SSarangdhar Joshi ret = rproc->ops->start(rproc); 14081efa30d0SSarangdhar Joshi if (ret) { 14091efa30d0SSarangdhar Joshi dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret); 1410c455daa4SBjorn Andersson goto unprepare_subdevices; 14111efa30d0SSarangdhar Joshi } 14121efa30d0SSarangdhar Joshi 1413618fcff3SBjorn Andersson /* Start any subdevices for the remote processor */ 1414618fcff3SBjorn Andersson ret = rproc_start_subdevices(rproc); 14151efa30d0SSarangdhar Joshi if (ret) { 14161efa30d0SSarangdhar Joshi dev_err(dev, "failed to probe subdevices for %s: %d\n", 14171efa30d0SSarangdhar Joshi rproc->name, ret); 1418c455daa4SBjorn Andersson goto stop_rproc; 14191efa30d0SSarangdhar Joshi } 14201efa30d0SSarangdhar Joshi 14211efa30d0SSarangdhar Joshi rproc->state = RPROC_RUNNING; 14221efa30d0SSarangdhar Joshi 14231efa30d0SSarangdhar Joshi dev_info(dev, "remote processor %s is now up\n", rproc->name); 14241efa30d0SSarangdhar Joshi 14251efa30d0SSarangdhar Joshi return 0; 1426c455daa4SBjorn Andersson 1427c455daa4SBjorn Andersson stop_rproc: 1428c455daa4SBjorn Andersson rproc->ops->stop(rproc); 1429c455daa4SBjorn Andersson unprepare_subdevices: 1430c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1431f68d51bdSSuman Anna reset_table_ptr: 1432f68d51bdSSuman Anna rproc->table_ptr = rproc->cached_table; 1433c455daa4SBjorn Andersson 1434c455daa4SBjorn Andersson return ret; 14351efa30d0SSarangdhar Joshi } 14361efa30d0SSarangdhar Joshi 14376a6c4dc0SMathieu Poirier static int __rproc_attach(struct rproc *rproc) 1438d848a481SMathieu Poirier { 1439d848a481SMathieu Poirier struct device *dev = &rproc->dev; 1440d848a481SMathieu Poirier int ret; 1441d848a481SMathieu Poirier 1442d848a481SMathieu Poirier ret = rproc_prepare_subdevices(rproc); 1443d848a481SMathieu Poirier if (ret) { 1444d848a481SMathieu Poirier dev_err(dev, "failed to prepare subdevices for %s: %d\n", 1445d848a481SMathieu Poirier rproc->name, ret); 1446d848a481SMathieu Poirier goto out; 1447d848a481SMathieu Poirier } 1448d848a481SMathieu Poirier 1449d848a481SMathieu Poirier /* Attach to the remote processor */ 1450d848a481SMathieu Poirier ret = rproc_attach_device(rproc); 1451d848a481SMathieu Poirier if (ret) { 1452d848a481SMathieu Poirier dev_err(dev, "can't attach to rproc %s: %d\n", 1453d848a481SMathieu Poirier rproc->name, ret); 1454d848a481SMathieu Poirier goto unprepare_subdevices; 1455d848a481SMathieu Poirier } 1456d848a481SMathieu Poirier 1457d848a481SMathieu Poirier /* Start any subdevices for the remote processor */ 1458d848a481SMathieu Poirier ret = rproc_start_subdevices(rproc); 1459d848a481SMathieu Poirier if (ret) { 1460d848a481SMathieu Poirier dev_err(dev, "failed to probe subdevices for %s: %d\n", 1461d848a481SMathieu Poirier rproc->name, ret); 1462d848a481SMathieu Poirier goto stop_rproc; 1463d848a481SMathieu Poirier } 1464d848a481SMathieu Poirier 146576f4c875SMathieu Poirier rproc->state = RPROC_ATTACHED; 1466d848a481SMathieu Poirier 1467d848a481SMathieu Poirier dev_info(dev, "remote processor %s is now attached\n", rproc->name); 1468d848a481SMathieu Poirier 1469d848a481SMathieu Poirier return 0; 1470d848a481SMathieu Poirier 1471d848a481SMathieu Poirier stop_rproc: 1472d848a481SMathieu Poirier rproc->ops->stop(rproc); 1473d848a481SMathieu Poirier unprepare_subdevices: 1474d848a481SMathieu Poirier rproc_unprepare_subdevices(rproc); 1475d848a481SMathieu Poirier out: 1476d848a481SMathieu Poirier return ret; 1477d848a481SMathieu Poirier } 1478d848a481SMathieu Poirier 1479400e64dfSOhad Ben-Cohen /* 1480400e64dfSOhad Ben-Cohen * take a firmware and boot a remote processor with it. 1481400e64dfSOhad Ben-Cohen */ 1482400e64dfSOhad Ben-Cohen static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw) 1483400e64dfSOhad Ben-Cohen { 1484b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1485400e64dfSOhad Ben-Cohen const char *name = rproc->firmware; 148658b64090SBjorn Andersson int ret; 1487400e64dfSOhad Ben-Cohen 1488400e64dfSOhad Ben-Cohen ret = rproc_fw_sanity_check(rproc, fw); 1489400e64dfSOhad Ben-Cohen if (ret) 1490400e64dfSOhad Ben-Cohen return ret; 1491400e64dfSOhad Ben-Cohen 1492e981f6d4SSjur Brændeland dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size); 1493400e64dfSOhad Ben-Cohen 1494400e64dfSOhad Ben-Cohen /* 1495400e64dfSOhad Ben-Cohen * if enabling an IOMMU isn't relevant for this rproc, this is 1496400e64dfSOhad Ben-Cohen * just a nop 1497400e64dfSOhad Ben-Cohen */ 1498400e64dfSOhad Ben-Cohen ret = rproc_enable_iommu(rproc); 1499400e64dfSOhad Ben-Cohen if (ret) { 1500400e64dfSOhad Ben-Cohen dev_err(dev, "can't enable iommu: %d\n", ret); 150149cff125SMathieu Poirier return ret; 1502400e64dfSOhad Ben-Cohen } 1503400e64dfSOhad Ben-Cohen 150433467ac3SLoic Pallardy /* Prepare rproc for firmware loading if needed */ 150533467ac3SLoic Pallardy ret = rproc_prepare_device(rproc); 150633467ac3SLoic Pallardy if (ret) { 150733467ac3SLoic Pallardy dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret); 150833467ac3SLoic Pallardy goto disable_iommu; 150933467ac3SLoic Pallardy } 151033467ac3SLoic Pallardy 15113e5f9eb5SSjur Brændeland rproc->bootaddr = rproc_get_boot_addr(rproc, fw); 1512400e64dfSOhad Ben-Cohen 1513c1d35c1aSBjorn Andersson /* Load resource table, core dump segment list etc from the firmware */ 1514c1d35c1aSBjorn Andersson ret = rproc_parse_fw(rproc, fw); 151558b64090SBjorn Andersson if (ret) 151633467ac3SLoic Pallardy goto unprepare_rproc; 1517a0c10687SBjorn Andersson 1518b35d7afcSBjorn Andersson /* reset max_notifyid */ 1519b35d7afcSBjorn Andersson rproc->max_notifyid = -1; 1520b35d7afcSBjorn Andersson 1521c6aed238SLoic Pallardy /* reset handled vdev */ 1522c6aed238SLoic Pallardy rproc->nb_vdev = 0; 1523c6aed238SLoic Pallardy 1524400e64dfSOhad Ben-Cohen /* handle fw resources which are required to boot rproc */ 1525a4b24c75SBjorn Andersson ret = rproc_handle_resources(rproc, rproc_loading_handlers); 1526400e64dfSOhad Ben-Cohen if (ret) { 1527400e64dfSOhad Ben-Cohen dev_err(dev, "Failed to process resources: %d\n", ret); 1528229b85a6SBjorn Andersson goto clean_up_resources; 1529400e64dfSOhad Ben-Cohen } 1530400e64dfSOhad Ben-Cohen 1531d7c51706SLoic Pallardy /* Allocate carveout resources associated to rproc */ 1532d7c51706SLoic Pallardy ret = rproc_alloc_registered_carveouts(rproc); 1533d7c51706SLoic Pallardy if (ret) { 1534d7c51706SLoic Pallardy dev_err(dev, "Failed to allocate associated carveouts: %d\n", 1535d7c51706SLoic Pallardy ret); 1536d7c51706SLoic Pallardy goto clean_up_resources; 1537d7c51706SLoic Pallardy } 1538d7c51706SLoic Pallardy 15391efa30d0SSarangdhar Joshi ret = rproc_start(rproc, fw); 15401efa30d0SSarangdhar Joshi if (ret) 1541229b85a6SBjorn Andersson goto clean_up_resources; 1542400e64dfSOhad Ben-Cohen 1543400e64dfSOhad Ben-Cohen return 0; 1544400e64dfSOhad Ben-Cohen 1545229b85a6SBjorn Andersson clean_up_resources: 1546229b85a6SBjorn Andersson rproc_resource_cleanup(rproc); 1547a0c10687SBjorn Andersson kfree(rproc->cached_table); 1548a0c10687SBjorn Andersson rproc->cached_table = NULL; 1549988d204cSBjorn Andersson rproc->table_ptr = NULL; 155033467ac3SLoic Pallardy unprepare_rproc: 155133467ac3SLoic Pallardy /* release HW resources if needed */ 155233467ac3SLoic Pallardy rproc_unprepare_device(rproc); 155358b64090SBjorn Andersson disable_iommu: 1554400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 1555400e64dfSOhad Ben-Cohen return ret; 1556400e64dfSOhad Ben-Cohen } 1557400e64dfSOhad Ben-Cohen 15581a631382SMathieu Poirier static int rproc_set_rsc_table(struct rproc *rproc) 15591a631382SMathieu Poirier { 15601a631382SMathieu Poirier struct resource_table *table_ptr; 15611a631382SMathieu Poirier struct device *dev = &rproc->dev; 15621a631382SMathieu Poirier size_t table_sz; 15631a631382SMathieu Poirier int ret; 15641a631382SMathieu Poirier 15651a631382SMathieu Poirier table_ptr = rproc_get_loaded_rsc_table(rproc, &table_sz); 15661a631382SMathieu Poirier if (!table_ptr) { 15671a631382SMathieu Poirier /* Not having a resource table is acceptable */ 15681a631382SMathieu Poirier return 0; 15691a631382SMathieu Poirier } 15701a631382SMathieu Poirier 15711a631382SMathieu Poirier if (IS_ERR(table_ptr)) { 15721a631382SMathieu Poirier ret = PTR_ERR(table_ptr); 15731a631382SMathieu Poirier dev_err(dev, "can't load resource table: %d\n", ret); 15741a631382SMathieu Poirier return ret; 15751a631382SMathieu Poirier } 15761a631382SMathieu Poirier 15779dc9507fSMathieu Poirier /* 15789dc9507fSMathieu Poirier * If it is possible to detach the remote processor, keep an untouched 15799dc9507fSMathieu Poirier * copy of the resource table. That way we can start fresh again when 15809dc9507fSMathieu Poirier * the remote processor is re-attached, that is: 15819dc9507fSMathieu Poirier * 15829dc9507fSMathieu Poirier * DETACHED -> ATTACHED -> DETACHED -> ATTACHED 15839dc9507fSMathieu Poirier * 15849dc9507fSMathieu Poirier * Free'd in rproc_reset_rsc_table_on_detach() and 15859dc9507fSMathieu Poirier * rproc_reset_rsc_table_on_stop(). 15869dc9507fSMathieu Poirier */ 15879dc9507fSMathieu Poirier if (rproc->ops->detach) { 15889dc9507fSMathieu Poirier rproc->clean_table = kmemdup(table_ptr, table_sz, GFP_KERNEL); 15899dc9507fSMathieu Poirier if (!rproc->clean_table) 15909dc9507fSMathieu Poirier return -ENOMEM; 15919dc9507fSMathieu Poirier } else { 15929dc9507fSMathieu Poirier rproc->clean_table = NULL; 15939dc9507fSMathieu Poirier } 15949dc9507fSMathieu Poirier 15951a631382SMathieu Poirier rproc->cached_table = NULL; 15961a631382SMathieu Poirier rproc->table_ptr = table_ptr; 15971a631382SMathieu Poirier rproc->table_sz = table_sz; 15981a631382SMathieu Poirier 15991a631382SMathieu Poirier return 0; 16001a631382SMathieu Poirier } 16011a631382SMathieu Poirier 16029dc9507fSMathieu Poirier static int rproc_reset_rsc_table_on_detach(struct rproc *rproc) 16039dc9507fSMathieu Poirier { 16049dc9507fSMathieu Poirier struct resource_table *table_ptr; 16059dc9507fSMathieu Poirier 16069dc9507fSMathieu Poirier /* A resource table was never retrieved, nothing to do here */ 16079dc9507fSMathieu Poirier if (!rproc->table_ptr) 16089dc9507fSMathieu Poirier return 0; 16099dc9507fSMathieu Poirier 16109dc9507fSMathieu Poirier /* 16119dc9507fSMathieu Poirier * If we made it to this point a clean_table _must_ have been 16129dc9507fSMathieu Poirier * allocated in rproc_set_rsc_table(). If one isn't present 16139dc9507fSMathieu Poirier * something went really wrong and we must complain. 16149dc9507fSMathieu Poirier */ 16159dc9507fSMathieu Poirier if (WARN_ON(!rproc->clean_table)) 16169dc9507fSMathieu Poirier return -EINVAL; 16179dc9507fSMathieu Poirier 16189dc9507fSMathieu Poirier /* Remember where the external entity installed the resource table */ 16199dc9507fSMathieu Poirier table_ptr = rproc->table_ptr; 16209dc9507fSMathieu Poirier 16219dc9507fSMathieu Poirier /* 16229dc9507fSMathieu Poirier * If we made it here the remote processor was started by another 16239dc9507fSMathieu Poirier * entity and a cache table doesn't exist. As such make a copy of 16249dc9507fSMathieu Poirier * the resource table currently used by the remote processor and 16259dc9507fSMathieu Poirier * use that for the rest of the shutdown process. The memory 16269dc9507fSMathieu Poirier * allocated here is free'd in rproc_detach(). 16279dc9507fSMathieu Poirier */ 16289dc9507fSMathieu Poirier rproc->cached_table = kmemdup(rproc->table_ptr, 16299dc9507fSMathieu Poirier rproc->table_sz, GFP_KERNEL); 16309dc9507fSMathieu Poirier if (!rproc->cached_table) 16319dc9507fSMathieu Poirier return -ENOMEM; 16329dc9507fSMathieu Poirier 16339dc9507fSMathieu Poirier /* 16349dc9507fSMathieu Poirier * Use a copy of the resource table for the remainder of the 16359dc9507fSMathieu Poirier * shutdown process. 16369dc9507fSMathieu Poirier */ 16379dc9507fSMathieu Poirier rproc->table_ptr = rproc->cached_table; 16389dc9507fSMathieu Poirier 16399dc9507fSMathieu Poirier /* 16409dc9507fSMathieu Poirier * Reset the memory area where the firmware loaded the resource table 16419dc9507fSMathieu Poirier * to its original value. That way when we re-attach the remote 16429dc9507fSMathieu Poirier * processor the resource table is clean and ready to be used again. 16439dc9507fSMathieu Poirier */ 16449dc9507fSMathieu Poirier memcpy(table_ptr, rproc->clean_table, rproc->table_sz); 16459dc9507fSMathieu Poirier 16469dc9507fSMathieu Poirier /* 16479dc9507fSMathieu Poirier * The clean resource table is no longer needed. Allocated in 16489dc9507fSMathieu Poirier * rproc_set_rsc_table(). 16499dc9507fSMathieu Poirier */ 16509dc9507fSMathieu Poirier kfree(rproc->clean_table); 16519dc9507fSMathieu Poirier 16529dc9507fSMathieu Poirier return 0; 16539dc9507fSMathieu Poirier } 16549dc9507fSMathieu Poirier 16558088dd4dSMathieu Poirier static int rproc_reset_rsc_table_on_stop(struct rproc *rproc) 16568088dd4dSMathieu Poirier { 16578088dd4dSMathieu Poirier /* A resource table was never retrieved, nothing to do here */ 16588088dd4dSMathieu Poirier if (!rproc->table_ptr) 16598088dd4dSMathieu Poirier return 0; 16608088dd4dSMathieu Poirier 16618088dd4dSMathieu Poirier /* 16628088dd4dSMathieu Poirier * If a cache table exists the remote processor was started by 16638088dd4dSMathieu Poirier * the remoteproc core. That cache table should be used for 16648088dd4dSMathieu Poirier * the rest of the shutdown process. 16658088dd4dSMathieu Poirier */ 16668088dd4dSMathieu Poirier if (rproc->cached_table) 16678088dd4dSMathieu Poirier goto out; 16688088dd4dSMathieu Poirier 16698088dd4dSMathieu Poirier /* 16708088dd4dSMathieu Poirier * If we made it here the remote processor was started by another 16718088dd4dSMathieu Poirier * entity and a cache table doesn't exist. As such make a copy of 16728088dd4dSMathieu Poirier * the resource table currently used by the remote processor and 16738088dd4dSMathieu Poirier * use that for the rest of the shutdown process. The memory 16748088dd4dSMathieu Poirier * allocated here is free'd in rproc_shutdown(). 16758088dd4dSMathieu Poirier */ 16768088dd4dSMathieu Poirier rproc->cached_table = kmemdup(rproc->table_ptr, 16778088dd4dSMathieu Poirier rproc->table_sz, GFP_KERNEL); 16788088dd4dSMathieu Poirier if (!rproc->cached_table) 16798088dd4dSMathieu Poirier return -ENOMEM; 16808088dd4dSMathieu Poirier 16818088dd4dSMathieu Poirier /* 16828088dd4dSMathieu Poirier * Since the remote processor is being switched off the clean table 16838088dd4dSMathieu Poirier * won't be needed. Allocated in rproc_set_rsc_table(). 16848088dd4dSMathieu Poirier */ 16858088dd4dSMathieu Poirier kfree(rproc->clean_table); 16868088dd4dSMathieu Poirier 16878088dd4dSMathieu Poirier out: 16888088dd4dSMathieu Poirier /* 16898088dd4dSMathieu Poirier * Use a copy of the resource table for the remainder of the 16908088dd4dSMathieu Poirier * shutdown process. 16918088dd4dSMathieu Poirier */ 16928088dd4dSMathieu Poirier rproc->table_ptr = rproc->cached_table; 16938088dd4dSMathieu Poirier return 0; 16948088dd4dSMathieu Poirier } 16958088dd4dSMathieu Poirier 1696400e64dfSOhad Ben-Cohen /* 1697fdf0e00eSMathieu Poirier * Attach to remote processor - similar to rproc_fw_boot() but without 1698fdf0e00eSMathieu Poirier * the steps that deal with the firmware image. 1699fdf0e00eSMathieu Poirier */ 17006a6c4dc0SMathieu Poirier static int rproc_attach(struct rproc *rproc) 1701fdf0e00eSMathieu Poirier { 1702fdf0e00eSMathieu Poirier struct device *dev = &rproc->dev; 1703fdf0e00eSMathieu Poirier int ret; 1704fdf0e00eSMathieu Poirier 1705fdf0e00eSMathieu Poirier /* 1706fdf0e00eSMathieu Poirier * if enabling an IOMMU isn't relevant for this rproc, this is 1707fdf0e00eSMathieu Poirier * just a nop 1708fdf0e00eSMathieu Poirier */ 1709fdf0e00eSMathieu Poirier ret = rproc_enable_iommu(rproc); 1710fdf0e00eSMathieu Poirier if (ret) { 1711fdf0e00eSMathieu Poirier dev_err(dev, "can't enable iommu: %d\n", ret); 1712fdf0e00eSMathieu Poirier return ret; 1713fdf0e00eSMathieu Poirier } 1714fdf0e00eSMathieu Poirier 17156e20a051SArnaud POULIQUEN /* Do anything that is needed to boot the remote processor */ 17166e20a051SArnaud POULIQUEN ret = rproc_prepare_device(rproc); 17176e20a051SArnaud POULIQUEN if (ret) { 17186e20a051SArnaud POULIQUEN dev_err(dev, "can't prepare rproc %s: %d\n", rproc->name, ret); 17196e20a051SArnaud POULIQUEN goto disable_iommu; 17206e20a051SArnaud POULIQUEN } 17216e20a051SArnaud POULIQUEN 17221a631382SMathieu Poirier ret = rproc_set_rsc_table(rproc); 17231a631382SMathieu Poirier if (ret) { 17241a631382SMathieu Poirier dev_err(dev, "can't load resource table: %d\n", ret); 17256e20a051SArnaud POULIQUEN goto unprepare_device; 17261a631382SMathieu Poirier } 17271a631382SMathieu Poirier 1728fdf0e00eSMathieu Poirier /* reset max_notifyid */ 1729fdf0e00eSMathieu Poirier rproc->max_notifyid = -1; 1730fdf0e00eSMathieu Poirier 1731fdf0e00eSMathieu Poirier /* reset handled vdev */ 1732fdf0e00eSMathieu Poirier rproc->nb_vdev = 0; 1733fdf0e00eSMathieu Poirier 1734fdf0e00eSMathieu Poirier /* 1735fdf0e00eSMathieu Poirier * Handle firmware resources required to attach to a remote processor. 1736fdf0e00eSMathieu Poirier * Because we are attaching rather than booting the remote processor, 1737fdf0e00eSMathieu Poirier * we expect the platform driver to properly set rproc->table_ptr. 1738fdf0e00eSMathieu Poirier */ 1739fdf0e00eSMathieu Poirier ret = rproc_handle_resources(rproc, rproc_loading_handlers); 1740fdf0e00eSMathieu Poirier if (ret) { 1741fdf0e00eSMathieu Poirier dev_err(dev, "Failed to process resources: %d\n", ret); 17426e20a051SArnaud POULIQUEN goto unprepare_device; 1743fdf0e00eSMathieu Poirier } 1744fdf0e00eSMathieu Poirier 1745fdf0e00eSMathieu Poirier /* Allocate carveout resources associated to rproc */ 1746fdf0e00eSMathieu Poirier ret = rproc_alloc_registered_carveouts(rproc); 1747fdf0e00eSMathieu Poirier if (ret) { 1748fdf0e00eSMathieu Poirier dev_err(dev, "Failed to allocate associated carveouts: %d\n", 1749fdf0e00eSMathieu Poirier ret); 1750fdf0e00eSMathieu Poirier goto clean_up_resources; 1751fdf0e00eSMathieu Poirier } 1752fdf0e00eSMathieu Poirier 17536a6c4dc0SMathieu Poirier ret = __rproc_attach(rproc); 1754fdf0e00eSMathieu Poirier if (ret) 1755fdf0e00eSMathieu Poirier goto clean_up_resources; 1756fdf0e00eSMathieu Poirier 1757fdf0e00eSMathieu Poirier return 0; 1758fdf0e00eSMathieu Poirier 1759fdf0e00eSMathieu Poirier clean_up_resources: 1760fdf0e00eSMathieu Poirier rproc_resource_cleanup(rproc); 17616e20a051SArnaud POULIQUEN unprepare_device: 17626e20a051SArnaud POULIQUEN /* release HW resources if needed */ 17636e20a051SArnaud POULIQUEN rproc_unprepare_device(rproc); 1764fdf0e00eSMathieu Poirier disable_iommu: 1765fdf0e00eSMathieu Poirier rproc_disable_iommu(rproc); 1766fdf0e00eSMathieu Poirier return ret; 1767fdf0e00eSMathieu Poirier } 1768fdf0e00eSMathieu Poirier 1769fdf0e00eSMathieu Poirier /* 17705e6533f7SSarangdhar Joshi * take a firmware and boot it up. 1771400e64dfSOhad Ben-Cohen * 1772400e64dfSOhad Ben-Cohen * Note: this function is called asynchronously upon registration of the 1773400e64dfSOhad Ben-Cohen * remote processor (so we must wait until it completes before we try 1774400e64dfSOhad Ben-Cohen * to unregister the device. one other option is just to use kref here, 1775400e64dfSOhad Ben-Cohen * that might be cleaner). 1776400e64dfSOhad Ben-Cohen */ 17775e6533f7SSarangdhar Joshi static void rproc_auto_boot_callback(const struct firmware *fw, void *context) 1778400e64dfSOhad Ben-Cohen { 1779400e64dfSOhad Ben-Cohen struct rproc *rproc = context; 1780a2b950acSOhad Ben-Cohen 17812bfc311aSBjorn Andersson rproc_boot(rproc); 1782ddf71187SBjorn Andersson 1783400e64dfSOhad Ben-Cohen release_firmware(fw); 1784400e64dfSOhad Ben-Cohen } 1785400e64dfSOhad Ben-Cohen 17865e6533f7SSarangdhar Joshi static int rproc_trigger_auto_boot(struct rproc *rproc) 178770b85ef8SFernando Guzman Lugo { 178870b85ef8SFernando Guzman Lugo int ret; 178970b85ef8SFernando Guzman Lugo 179070b85ef8SFernando Guzman Lugo /* 1791e3d21939SMathieu Poirier * Since the remote processor is in a detached state, it has already 1792e3d21939SMathieu Poirier * been booted by another entity. As such there is no point in waiting 1793e3d21939SMathieu Poirier * for a firmware image to be loaded, we can simply initiate the process 1794e3d21939SMathieu Poirier * of attaching to it immediately. 1795e3d21939SMathieu Poirier */ 1796e3d21939SMathieu Poirier if (rproc->state == RPROC_DETACHED) 1797e3d21939SMathieu Poirier return rproc_boot(rproc); 1798e3d21939SMathieu Poirier 1799e3d21939SMathieu Poirier /* 180070b85ef8SFernando Guzman Lugo * We're initiating an asynchronous firmware loading, so we can 180170b85ef8SFernando Guzman Lugo * be built-in kernel code, without hanging the boot process. 180270b85ef8SFernando Guzman Lugo */ 18030733d839SShawn Guo ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_UEVENT, 180470b85ef8SFernando Guzman Lugo rproc->firmware, &rproc->dev, GFP_KERNEL, 18055e6533f7SSarangdhar Joshi rproc, rproc_auto_boot_callback); 18062099c77dSSarangdhar Joshi if (ret < 0) 180770b85ef8SFernando Guzman Lugo dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret); 180870b85ef8SFernando Guzman Lugo 180970b85ef8SFernando Guzman Lugo return ret; 181070b85ef8SFernando Guzman Lugo } 181170b85ef8SFernando Guzman Lugo 1812880f5b38SBjorn Andersson static int rproc_stop(struct rproc *rproc, bool crashed) 18131efa30d0SSarangdhar Joshi { 18141efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 18151efa30d0SSarangdhar Joshi int ret; 18161efa30d0SSarangdhar Joshi 1817d2008a96SMathieu Poirier /* No need to continue if a stop() operation has not been provided */ 1818d2008a96SMathieu Poirier if (!rproc->ops->stop) 1819d2008a96SMathieu Poirier return -EINVAL; 1820d2008a96SMathieu Poirier 1821618fcff3SBjorn Andersson /* Stop any subdevices for the remote processor */ 1822618fcff3SBjorn Andersson rproc_stop_subdevices(rproc, crashed); 18231efa30d0SSarangdhar Joshi 18240a8b81cbSBjorn Andersson /* the installed resource table is no longer accessible */ 18258088dd4dSMathieu Poirier ret = rproc_reset_rsc_table_on_stop(rproc); 18268088dd4dSMathieu Poirier if (ret) { 18278088dd4dSMathieu Poirier dev_err(dev, "can't reset resource table: %d\n", ret); 18288088dd4dSMathieu Poirier return ret; 18298088dd4dSMathieu Poirier } 18308088dd4dSMathieu Poirier 18310a8b81cbSBjorn Andersson 18321efa30d0SSarangdhar Joshi /* power off the remote processor */ 18331efa30d0SSarangdhar Joshi ret = rproc->ops->stop(rproc); 18341efa30d0SSarangdhar Joshi if (ret) { 18351efa30d0SSarangdhar Joshi dev_err(dev, "can't stop rproc: %d\n", ret); 18361efa30d0SSarangdhar Joshi return ret; 18371efa30d0SSarangdhar Joshi } 18381efa30d0SSarangdhar Joshi 1839c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1840c455daa4SBjorn Andersson 18411efa30d0SSarangdhar Joshi rproc->state = RPROC_OFFLINE; 18421efa30d0SSarangdhar Joshi 18431efa30d0SSarangdhar Joshi dev_info(dev, "stopped remote processor %s\n", rproc->name); 18441efa30d0SSarangdhar Joshi 18451efa30d0SSarangdhar Joshi return 0; 18461efa30d0SSarangdhar Joshi } 18471efa30d0SSarangdhar Joshi 18486070203fSMathieu Poirier /* 18496070203fSMathieu Poirier * __rproc_detach(): Does the opposite of __rproc_attach() 18506070203fSMathieu Poirier */ 1851d3962a39SMathieu Poirier static int __rproc_detach(struct rproc *rproc) 18526070203fSMathieu Poirier { 18536070203fSMathieu Poirier struct device *dev = &rproc->dev; 18546070203fSMathieu Poirier int ret; 18556070203fSMathieu Poirier 18566070203fSMathieu Poirier /* No need to continue if a detach() operation has not been provided */ 18576070203fSMathieu Poirier if (!rproc->ops->detach) 18586070203fSMathieu Poirier return -EINVAL; 18596070203fSMathieu Poirier 18606070203fSMathieu Poirier /* Stop any subdevices for the remote processor */ 18616070203fSMathieu Poirier rproc_stop_subdevices(rproc, false); 18626070203fSMathieu Poirier 18639dc9507fSMathieu Poirier /* the installed resource table is no longer accessible */ 18649dc9507fSMathieu Poirier ret = rproc_reset_rsc_table_on_detach(rproc); 18659dc9507fSMathieu Poirier if (ret) { 18669dc9507fSMathieu Poirier dev_err(dev, "can't reset resource table: %d\n", ret); 18679dc9507fSMathieu Poirier return ret; 18689dc9507fSMathieu Poirier } 18699dc9507fSMathieu Poirier 18706070203fSMathieu Poirier /* Tell the remote processor the core isn't available anymore */ 18716070203fSMathieu Poirier ret = rproc->ops->detach(rproc); 18726070203fSMathieu Poirier if (ret) { 18736070203fSMathieu Poirier dev_err(dev, "can't detach from rproc: %d\n", ret); 18746070203fSMathieu Poirier return ret; 18756070203fSMathieu Poirier } 18766070203fSMathieu Poirier 18776070203fSMathieu Poirier rproc_unprepare_subdevices(rproc); 18786070203fSMathieu Poirier 18796070203fSMathieu Poirier rproc->state = RPROC_DETACHED; 18806070203fSMathieu Poirier 18816070203fSMathieu Poirier dev_info(dev, "detached remote processor %s\n", rproc->name); 18826070203fSMathieu Poirier 18836070203fSMathieu Poirier return 0; 18846070203fSMathieu Poirier } 18852666ca91SSarangdhar Joshi 18862666ca91SSarangdhar Joshi /** 188770b85ef8SFernando Guzman Lugo * rproc_trigger_recovery() - recover a remoteproc 188870b85ef8SFernando Guzman Lugo * @rproc: the remote processor 188970b85ef8SFernando Guzman Lugo * 189056324d7aSAnna, Suman * The recovery is done by resetting all the virtio devices, that way all the 189170b85ef8SFernando Guzman Lugo * rpmsg drivers will be reseted along with the remote processor making the 189270b85ef8SFernando Guzman Lugo * remoteproc functional again. 189370b85ef8SFernando Guzman Lugo * 189470b85ef8SFernando Guzman Lugo * This function can sleep, so it cannot be called from atomic context. 1895f2867434SSuman Anna * 1896f2867434SSuman Anna * Return: 0 on success or a negative value upon failure 189770b85ef8SFernando Guzman Lugo */ 189870b85ef8SFernando Guzman Lugo int rproc_trigger_recovery(struct rproc *rproc) 189970b85ef8SFernando Guzman Lugo { 19007e83cab8SSarangdhar Joshi const struct firmware *firmware_p; 19017e83cab8SSarangdhar Joshi struct device *dev = &rproc->dev; 19027e83cab8SSarangdhar Joshi int ret; 19037e83cab8SSarangdhar Joshi 19047e83cab8SSarangdhar Joshi ret = mutex_lock_interruptible(&rproc->lock); 19057e83cab8SSarangdhar Joshi if (ret) 19067e83cab8SSarangdhar Joshi return ret; 19077e83cab8SSarangdhar Joshi 19080b145574SAlex Elder /* State could have changed before we got the mutex */ 19090b145574SAlex Elder if (rproc->state != RPROC_CRASHED) 19100b145574SAlex Elder goto unlock_mutex; 19110b145574SAlex Elder 19120b145574SAlex Elder dev_err(dev, "recovering %s\n", rproc->name); 19130b145574SAlex Elder 1914fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, true); 19157e83cab8SSarangdhar Joshi if (ret) 19167e83cab8SSarangdhar Joshi goto unlock_mutex; 1917ddf71187SBjorn Andersson 19182666ca91SSarangdhar Joshi /* generate coredump */ 1919adf60a87SSiddharth Gupta rproc->ops->coredump(rproc); 19202666ca91SSarangdhar Joshi 19217e83cab8SSarangdhar Joshi /* load firmware */ 19227e83cab8SSarangdhar Joshi ret = request_firmware(&firmware_p, rproc->firmware, dev); 19237e83cab8SSarangdhar Joshi if (ret < 0) { 19247e83cab8SSarangdhar Joshi dev_err(dev, "request_firmware failed: %d\n", ret); 19257e83cab8SSarangdhar Joshi goto unlock_mutex; 19267e83cab8SSarangdhar Joshi } 1927ddf71187SBjorn Andersson 19287e83cab8SSarangdhar Joshi /* boot the remote processor up again */ 19297e83cab8SSarangdhar Joshi ret = rproc_start(rproc, firmware_p); 19307e83cab8SSarangdhar Joshi 19317e83cab8SSarangdhar Joshi release_firmware(firmware_p); 19327e83cab8SSarangdhar Joshi 19337e83cab8SSarangdhar Joshi unlock_mutex: 19347e83cab8SSarangdhar Joshi mutex_unlock(&rproc->lock); 19357e83cab8SSarangdhar Joshi return ret; 193670b85ef8SFernando Guzman Lugo } 193770b85ef8SFernando Guzman Lugo 1938400e64dfSOhad Ben-Cohen /** 19398afd519cSFernando Guzman Lugo * rproc_crash_handler_work() - handle a crash 19402e7d4c2cSArnaud Pouliquen * @work: work treating the crash 19418afd519cSFernando Guzman Lugo * 19428afd519cSFernando Guzman Lugo * This function needs to handle everything related to a crash, like cpu 19438afd519cSFernando Guzman Lugo * registers and stack dump, information to help to debug the fatal error, etc. 19448afd519cSFernando Guzman Lugo */ 19458afd519cSFernando Guzman Lugo static void rproc_crash_handler_work(struct work_struct *work) 19468afd519cSFernando Guzman Lugo { 19478afd519cSFernando Guzman Lugo struct rproc *rproc = container_of(work, struct rproc, crash_handler); 19488afd519cSFernando Guzman Lugo struct device *dev = &rproc->dev; 19498afd519cSFernando Guzman Lugo 19508afd519cSFernando Guzman Lugo dev_dbg(dev, "enter %s\n", __func__); 19518afd519cSFernando Guzman Lugo 19528afd519cSFernando Guzman Lugo mutex_lock(&rproc->lock); 19538afd519cSFernando Guzman Lugo 19548afd519cSFernando Guzman Lugo if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) { 19558afd519cSFernando Guzman Lugo /* handle only the first crash detected */ 19568afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 19578afd519cSFernando Guzman Lugo return; 19588afd519cSFernando Guzman Lugo } 19598afd519cSFernando Guzman Lugo 19608afd519cSFernando Guzman Lugo rproc->state = RPROC_CRASHED; 19618afd519cSFernando Guzman Lugo dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt, 19628afd519cSFernando Guzman Lugo rproc->name); 19638afd519cSFernando Guzman Lugo 19648afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 19658afd519cSFernando Guzman Lugo 19662e37abb8SFernando Guzman Lugo if (!rproc->recovery_disabled) 196770b85ef8SFernando Guzman Lugo rproc_trigger_recovery(rproc); 1968a781e5aaSRishabh Bhatnagar 1969a781e5aaSRishabh Bhatnagar pm_relax(rproc->dev.parent); 19708afd519cSFernando Guzman Lugo } 19718afd519cSFernando Guzman Lugo 19728afd519cSFernando Guzman Lugo /** 19731b0ef906SSuman Anna * rproc_boot() - boot a remote processor 1974400e64dfSOhad Ben-Cohen * @rproc: handle of a remote processor 1975400e64dfSOhad Ben-Cohen * 1976400e64dfSOhad Ben-Cohen * Boot a remote processor (i.e. load its firmware, power it on, ...). 1977400e64dfSOhad Ben-Cohen * 1978400e64dfSOhad Ben-Cohen * If the remote processor is already powered on, this function immediately 1979400e64dfSOhad Ben-Cohen * returns (successfully). 1980400e64dfSOhad Ben-Cohen * 1981f2867434SSuman Anna * Return: 0 on success, and an appropriate error value otherwise 1982400e64dfSOhad Ben-Cohen */ 19831b0ef906SSuman Anna int rproc_boot(struct rproc *rproc) 1984400e64dfSOhad Ben-Cohen { 1985400e64dfSOhad Ben-Cohen const struct firmware *firmware_p; 1986400e64dfSOhad Ben-Cohen struct device *dev; 1987400e64dfSOhad Ben-Cohen int ret; 1988400e64dfSOhad Ben-Cohen 1989400e64dfSOhad Ben-Cohen if (!rproc) { 1990400e64dfSOhad Ben-Cohen pr_err("invalid rproc handle\n"); 1991400e64dfSOhad Ben-Cohen return -EINVAL; 1992400e64dfSOhad Ben-Cohen } 1993400e64dfSOhad Ben-Cohen 1994b5ab5e24SOhad Ben-Cohen dev = &rproc->dev; 1995400e64dfSOhad Ben-Cohen 1996400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1997400e64dfSOhad Ben-Cohen if (ret) { 1998400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1999400e64dfSOhad Ben-Cohen return ret; 2000400e64dfSOhad Ben-Cohen } 2001400e64dfSOhad Ben-Cohen 20022099c77dSSarangdhar Joshi if (rproc->state == RPROC_DELETED) { 20032099c77dSSarangdhar Joshi ret = -ENODEV; 20042099c77dSSarangdhar Joshi dev_err(dev, "can't boot deleted rproc %s\n", rproc->name); 20052099c77dSSarangdhar Joshi goto unlock_mutex; 20062099c77dSSarangdhar Joshi } 20072099c77dSSarangdhar Joshi 20080f9dc562SMathieu Poirier /* skip the boot or attach process if rproc is already powered up */ 2009400e64dfSOhad Ben-Cohen if (atomic_inc_return(&rproc->power) > 1) { 2010400e64dfSOhad Ben-Cohen ret = 0; 2011400e64dfSOhad Ben-Cohen goto unlock_mutex; 2012400e64dfSOhad Ben-Cohen } 2013400e64dfSOhad Ben-Cohen 20140f9dc562SMathieu Poirier if (rproc->state == RPROC_DETACHED) { 20150f9dc562SMathieu Poirier dev_info(dev, "attaching to %s\n", rproc->name); 20160f9dc562SMathieu Poirier 20176a6c4dc0SMathieu Poirier ret = rproc_attach(rproc); 20180f9dc562SMathieu Poirier } else { 2019400e64dfSOhad Ben-Cohen dev_info(dev, "powering up %s\n", rproc->name); 2020400e64dfSOhad Ben-Cohen 2021400e64dfSOhad Ben-Cohen /* load firmware */ 2022400e64dfSOhad Ben-Cohen ret = request_firmware(&firmware_p, rproc->firmware, dev); 2023400e64dfSOhad Ben-Cohen if (ret < 0) { 2024400e64dfSOhad Ben-Cohen dev_err(dev, "request_firmware failed: %d\n", ret); 2025400e64dfSOhad Ben-Cohen goto downref_rproc; 2026400e64dfSOhad Ben-Cohen } 2027400e64dfSOhad Ben-Cohen 2028400e64dfSOhad Ben-Cohen ret = rproc_fw_boot(rproc, firmware_p); 2029400e64dfSOhad Ben-Cohen 2030400e64dfSOhad Ben-Cohen release_firmware(firmware_p); 20310f9dc562SMathieu Poirier } 2032400e64dfSOhad Ben-Cohen 2033400e64dfSOhad Ben-Cohen downref_rproc: 2034fbb6aacbSBjorn Andersson if (ret) 2035400e64dfSOhad Ben-Cohen atomic_dec(&rproc->power); 2036400e64dfSOhad Ben-Cohen unlock_mutex: 2037400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 2038400e64dfSOhad Ben-Cohen return ret; 2039400e64dfSOhad Ben-Cohen } 2040400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_boot); 2041400e64dfSOhad Ben-Cohen 2042400e64dfSOhad Ben-Cohen /** 2043400e64dfSOhad Ben-Cohen * rproc_shutdown() - power off the remote processor 2044400e64dfSOhad Ben-Cohen * @rproc: the remote processor 2045400e64dfSOhad Ben-Cohen * 2046400e64dfSOhad Ben-Cohen * Power off a remote processor (previously booted with rproc_boot()). 2047400e64dfSOhad Ben-Cohen * 2048400e64dfSOhad Ben-Cohen * In case @rproc is still being used by an additional user(s), then 2049400e64dfSOhad Ben-Cohen * this function will just decrement the power refcount and exit, 2050400e64dfSOhad Ben-Cohen * without really powering off the device. 2051400e64dfSOhad Ben-Cohen * 2052400e64dfSOhad Ben-Cohen * Every call to rproc_boot() must (eventually) be accompanied by a call 2053400e64dfSOhad Ben-Cohen * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug. 2054400e64dfSOhad Ben-Cohen * 2055400e64dfSOhad Ben-Cohen * Notes: 2056400e64dfSOhad Ben-Cohen * - we're not decrementing the rproc's refcount, only the power refcount. 2057400e64dfSOhad Ben-Cohen * which means that the @rproc handle stays valid even after rproc_shutdown() 2058400e64dfSOhad Ben-Cohen * returns, and users can still use it with a subsequent rproc_boot(), if 2059400e64dfSOhad Ben-Cohen * needed. 2060c13b780cSSuman Anna * 2061c13b780cSSuman Anna * Return: 0 on success, and an appropriate error value otherwise 2062400e64dfSOhad Ben-Cohen */ 2063c13b780cSSuman Anna int rproc_shutdown(struct rproc *rproc) 2064400e64dfSOhad Ben-Cohen { 2065b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 2066c13b780cSSuman Anna int ret = 0; 2067400e64dfSOhad Ben-Cohen 2068400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 2069400e64dfSOhad Ben-Cohen if (ret) { 2070400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 2071c13b780cSSuman Anna return ret; 2072400e64dfSOhad Ben-Cohen } 2073400e64dfSOhad Ben-Cohen 20745e6a0e05SShengjiu Wang if (rproc->state != RPROC_RUNNING && 20755e6a0e05SShengjiu Wang rproc->state != RPROC_ATTACHED) { 20765e6a0e05SShengjiu Wang ret = -EINVAL; 20775e6a0e05SShengjiu Wang goto out; 20785e6a0e05SShengjiu Wang } 20795e6a0e05SShengjiu Wang 2080400e64dfSOhad Ben-Cohen /* if the remote proc is still needed, bail out */ 2081400e64dfSOhad Ben-Cohen if (!atomic_dec_and_test(&rproc->power)) 2082400e64dfSOhad Ben-Cohen goto out; 2083400e64dfSOhad Ben-Cohen 2084fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, false); 2085400e64dfSOhad Ben-Cohen if (ret) { 2086400e64dfSOhad Ben-Cohen atomic_inc(&rproc->power); 2087400e64dfSOhad Ben-Cohen goto out; 2088400e64dfSOhad Ben-Cohen } 2089400e64dfSOhad Ben-Cohen 2090400e64dfSOhad Ben-Cohen /* clean up all acquired resources */ 2091400e64dfSOhad Ben-Cohen rproc_resource_cleanup(rproc); 2092400e64dfSOhad Ben-Cohen 209333467ac3SLoic Pallardy /* release HW resources if needed */ 209433467ac3SLoic Pallardy rproc_unprepare_device(rproc); 209533467ac3SLoic Pallardy 2096400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 2097400e64dfSOhad Ben-Cohen 2098988d204cSBjorn Andersson /* Free the copy of the resource table */ 2099a0c10687SBjorn Andersson kfree(rproc->cached_table); 2100a0c10687SBjorn Andersson rproc->cached_table = NULL; 2101988d204cSBjorn Andersson rproc->table_ptr = NULL; 2102400e64dfSOhad Ben-Cohen out: 2103400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 2104c13b780cSSuman Anna return ret; 2105400e64dfSOhad Ben-Cohen } 2106400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_shutdown); 2107400e64dfSOhad Ben-Cohen 2108400e64dfSOhad Ben-Cohen /** 2109d3962a39SMathieu Poirier * rproc_detach() - Detach the remote processor from the 2110d3962a39SMathieu Poirier * remoteproc core 2111d3962a39SMathieu Poirier * 2112d3962a39SMathieu Poirier * @rproc: the remote processor 2113d3962a39SMathieu Poirier * 2114d3962a39SMathieu Poirier * Detach a remote processor (previously attached to with rproc_attach()). 2115d3962a39SMathieu Poirier * 2116d3962a39SMathieu Poirier * In case @rproc is still being used by an additional user(s), then 2117d3962a39SMathieu Poirier * this function will just decrement the power refcount and exit, 2118d3962a39SMathieu Poirier * without disconnecting the device. 2119d3962a39SMathieu Poirier * 2120d3962a39SMathieu Poirier * Function rproc_detach() calls __rproc_detach() in order to let a remote 2121d3962a39SMathieu Poirier * processor know that services provided by the application processor are 2122d3962a39SMathieu Poirier * no longer available. From there it should be possible to remove the 2123d3962a39SMathieu Poirier * platform driver and even power cycle the application processor (if the HW 2124d3962a39SMathieu Poirier * supports it) without needing to switch off the remote processor. 2125f2867434SSuman Anna * 2126f2867434SSuman Anna * Return: 0 on success, and an appropriate error value otherwise 2127d3962a39SMathieu Poirier */ 2128d3962a39SMathieu Poirier int rproc_detach(struct rproc *rproc) 2129d3962a39SMathieu Poirier { 2130d3962a39SMathieu Poirier struct device *dev = &rproc->dev; 2131d3962a39SMathieu Poirier int ret; 2132d3962a39SMathieu Poirier 2133d3962a39SMathieu Poirier ret = mutex_lock_interruptible(&rproc->lock); 2134d3962a39SMathieu Poirier if (ret) { 2135d3962a39SMathieu Poirier dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 2136d3962a39SMathieu Poirier return ret; 2137d3962a39SMathieu Poirier } 2138d3962a39SMathieu Poirier 21395e6a0e05SShengjiu Wang if (rproc->state != RPROC_ATTACHED) { 21405e6a0e05SShengjiu Wang ret = -EINVAL; 21415e6a0e05SShengjiu Wang goto out; 21425e6a0e05SShengjiu Wang } 21435e6a0e05SShengjiu Wang 2144d3962a39SMathieu Poirier /* if the remote proc is still needed, bail out */ 2145d3962a39SMathieu Poirier if (!atomic_dec_and_test(&rproc->power)) { 2146d3962a39SMathieu Poirier ret = 0; 2147d3962a39SMathieu Poirier goto out; 2148d3962a39SMathieu Poirier } 2149d3962a39SMathieu Poirier 2150d3962a39SMathieu Poirier ret = __rproc_detach(rproc); 2151d3962a39SMathieu Poirier if (ret) { 2152d3962a39SMathieu Poirier atomic_inc(&rproc->power); 2153d3962a39SMathieu Poirier goto out; 2154d3962a39SMathieu Poirier } 2155d3962a39SMathieu Poirier 2156d3962a39SMathieu Poirier /* clean up all acquired resources */ 2157d3962a39SMathieu Poirier rproc_resource_cleanup(rproc); 2158d3962a39SMathieu Poirier 2159d3962a39SMathieu Poirier /* release HW resources if needed */ 2160d3962a39SMathieu Poirier rproc_unprepare_device(rproc); 2161d3962a39SMathieu Poirier 2162d3962a39SMathieu Poirier rproc_disable_iommu(rproc); 2163d3962a39SMathieu Poirier 21649dc9507fSMathieu Poirier /* Free the copy of the resource table */ 21659dc9507fSMathieu Poirier kfree(rproc->cached_table); 21669dc9507fSMathieu Poirier rproc->cached_table = NULL; 2167d3962a39SMathieu Poirier rproc->table_ptr = NULL; 2168d3962a39SMathieu Poirier out: 2169d3962a39SMathieu Poirier mutex_unlock(&rproc->lock); 2170d3962a39SMathieu Poirier return ret; 2171d3962a39SMathieu Poirier } 2172d3962a39SMathieu Poirier EXPORT_SYMBOL(rproc_detach); 2173d3962a39SMathieu Poirier 2174d3962a39SMathieu Poirier /** 2175fec47d86SDave Gerlach * rproc_get_by_phandle() - find a remote processor by phandle 2176fec47d86SDave Gerlach * @phandle: phandle to the rproc 2177fec47d86SDave Gerlach * 2178fec47d86SDave Gerlach * Finds an rproc handle using the remote processor's phandle, and then 2179fec47d86SDave Gerlach * return a handle to the rproc. 2180fec47d86SDave Gerlach * 2181fec47d86SDave Gerlach * This function increments the remote processor's refcount, so always 2182fec47d86SDave Gerlach * use rproc_put() to decrement it back once rproc isn't needed anymore. 2183fec47d86SDave Gerlach * 2184f2867434SSuman Anna * Return: rproc handle on success, and NULL on failure 2185fec47d86SDave Gerlach */ 21868de3dbd0SOhad Ben-Cohen #ifdef CONFIG_OF 2187fec47d86SDave Gerlach struct rproc *rproc_get_by_phandle(phandle phandle) 2188fec47d86SDave Gerlach { 2189fec47d86SDave Gerlach struct rproc *rproc = NULL, *r; 2190fec47d86SDave Gerlach struct device_node *np; 2191fec47d86SDave Gerlach 2192fec47d86SDave Gerlach np = of_find_node_by_phandle(phandle); 2193fec47d86SDave Gerlach if (!np) 2194fec47d86SDave Gerlach return NULL; 2195fec47d86SDave Gerlach 2196c0abe2caSBjorn Andersson rcu_read_lock(); 2197c0abe2caSBjorn Andersson list_for_each_entry_rcu(r, &rproc_list, node) { 2198fec47d86SDave Gerlach if (r->dev.parent && r->dev.parent->of_node == np) { 2199fbb6aacbSBjorn Andersson /* prevent underlying implementation from being removed */ 2200fbb6aacbSBjorn Andersson if (!try_module_get(r->dev.parent->driver->owner)) { 2201fbb6aacbSBjorn Andersson dev_err(&r->dev, "can't get owner\n"); 2202fbb6aacbSBjorn Andersson break; 2203fbb6aacbSBjorn Andersson } 2204fbb6aacbSBjorn Andersson 2205fec47d86SDave Gerlach rproc = r; 2206fec47d86SDave Gerlach get_device(&rproc->dev); 2207fec47d86SDave Gerlach break; 2208fec47d86SDave Gerlach } 2209fec47d86SDave Gerlach } 2210c0abe2caSBjorn Andersson rcu_read_unlock(); 2211fec47d86SDave Gerlach 2212fec47d86SDave Gerlach of_node_put(np); 2213fec47d86SDave Gerlach 2214fec47d86SDave Gerlach return rproc; 2215fec47d86SDave Gerlach } 22168de3dbd0SOhad Ben-Cohen #else 22178de3dbd0SOhad Ben-Cohen struct rproc *rproc_get_by_phandle(phandle phandle) 22188de3dbd0SOhad Ben-Cohen { 22198de3dbd0SOhad Ben-Cohen return NULL; 22208de3dbd0SOhad Ben-Cohen } 22218de3dbd0SOhad Ben-Cohen #endif 2222fec47d86SDave Gerlach EXPORT_SYMBOL(rproc_get_by_phandle); 2223fec47d86SDave Gerlach 22244c1ad562SSuman Anna /** 22254c1ad562SSuman Anna * rproc_set_firmware() - assign a new firmware 22264c1ad562SSuman Anna * @rproc: rproc handle to which the new firmware is being assigned 22274c1ad562SSuman Anna * @fw_name: new firmware name to be assigned 22284c1ad562SSuman Anna * 22294c1ad562SSuman Anna * This function allows remoteproc drivers or clients to configure a custom 22304c1ad562SSuman Anna * firmware name that is different from the default name used during remoteproc 22314c1ad562SSuman Anna * registration. The function does not trigger a remote processor boot, 22324c1ad562SSuman Anna * only sets the firmware name used for a subsequent boot. This function 22334c1ad562SSuman Anna * should also be called only when the remote processor is offline. 22344c1ad562SSuman Anna * 22354c1ad562SSuman Anna * This allows either the userspace to configure a different name through 22364c1ad562SSuman Anna * sysfs or a kernel-level remoteproc or a remoteproc client driver to set 22374c1ad562SSuman Anna * a specific firmware when it is controlling the boot and shutdown of the 22384c1ad562SSuman Anna * remote processor. 22394c1ad562SSuman Anna * 22404c1ad562SSuman Anna * Return: 0 on success or a negative value upon failure 22414c1ad562SSuman Anna */ 22424c1ad562SSuman Anna int rproc_set_firmware(struct rproc *rproc, const char *fw_name) 22434c1ad562SSuman Anna { 22444c1ad562SSuman Anna struct device *dev; 22454c1ad562SSuman Anna int ret, len; 22464c1ad562SSuman Anna char *p; 22474c1ad562SSuman Anna 22484c1ad562SSuman Anna if (!rproc || !fw_name) 22494c1ad562SSuman Anna return -EINVAL; 22504c1ad562SSuman Anna 22514c1ad562SSuman Anna dev = rproc->dev.parent; 22524c1ad562SSuman Anna 22534c1ad562SSuman Anna ret = mutex_lock_interruptible(&rproc->lock); 22544c1ad562SSuman Anna if (ret) { 22554c1ad562SSuman Anna dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 22564c1ad562SSuman Anna return -EINVAL; 22574c1ad562SSuman Anna } 22584c1ad562SSuman Anna 22594c1ad562SSuman Anna if (rproc->state != RPROC_OFFLINE) { 22604c1ad562SSuman Anna dev_err(dev, "can't change firmware while running\n"); 22614c1ad562SSuman Anna ret = -EBUSY; 22624c1ad562SSuman Anna goto out; 22634c1ad562SSuman Anna } 22644c1ad562SSuman Anna 22654c1ad562SSuman Anna len = strcspn(fw_name, "\n"); 22664c1ad562SSuman Anna if (!len) { 22674c1ad562SSuman Anna dev_err(dev, "can't provide empty string for firmware name\n"); 22684c1ad562SSuman Anna ret = -EINVAL; 22694c1ad562SSuman Anna goto out; 22704c1ad562SSuman Anna } 22714c1ad562SSuman Anna 22724c1ad562SSuman Anna p = kstrndup(fw_name, len, GFP_KERNEL); 22734c1ad562SSuman Anna if (!p) { 22744c1ad562SSuman Anna ret = -ENOMEM; 22754c1ad562SSuman Anna goto out; 22764c1ad562SSuman Anna } 22774c1ad562SSuman Anna 227843d3f2c7SDaniele Alessandrelli kfree_const(rproc->firmware); 22794c1ad562SSuman Anna rproc->firmware = p; 22804c1ad562SSuman Anna 22814c1ad562SSuman Anna out: 22824c1ad562SSuman Anna mutex_unlock(&rproc->lock); 22834c1ad562SSuman Anna return ret; 22844c1ad562SSuman Anna } 22854c1ad562SSuman Anna EXPORT_SYMBOL(rproc_set_firmware); 22864c1ad562SSuman Anna 228788d3a136SMathieu Poirier static int rproc_validate(struct rproc *rproc) 228888d3a136SMathieu Poirier { 228988d3a136SMathieu Poirier switch (rproc->state) { 229088d3a136SMathieu Poirier case RPROC_OFFLINE: 229188d3a136SMathieu Poirier /* 229288d3a136SMathieu Poirier * An offline processor without a start() 229388d3a136SMathieu Poirier * function makes no sense. 229488d3a136SMathieu Poirier */ 229588d3a136SMathieu Poirier if (!rproc->ops->start) 229688d3a136SMathieu Poirier return -EINVAL; 229788d3a136SMathieu Poirier break; 229888d3a136SMathieu Poirier case RPROC_DETACHED: 229988d3a136SMathieu Poirier /* 230088d3a136SMathieu Poirier * A remote processor in a detached state without an 230188d3a136SMathieu Poirier * attach() function makes not sense. 230288d3a136SMathieu Poirier */ 230388d3a136SMathieu Poirier if (!rproc->ops->attach) 230488d3a136SMathieu Poirier return -EINVAL; 230588d3a136SMathieu Poirier /* 230688d3a136SMathieu Poirier * When attaching to a remote processor the device memory 230788d3a136SMathieu Poirier * is already available and as such there is no need to have a 230888d3a136SMathieu Poirier * cached table. 230988d3a136SMathieu Poirier */ 231088d3a136SMathieu Poirier if (rproc->cached_table) 231188d3a136SMathieu Poirier return -EINVAL; 231288d3a136SMathieu Poirier break; 231388d3a136SMathieu Poirier default: 231488d3a136SMathieu Poirier /* 231588d3a136SMathieu Poirier * When adding a remote processor, the state of the device 231688d3a136SMathieu Poirier * can be offline or detached, nothing else. 231788d3a136SMathieu Poirier */ 231888d3a136SMathieu Poirier return -EINVAL; 231988d3a136SMathieu Poirier } 232088d3a136SMathieu Poirier 232188d3a136SMathieu Poirier return 0; 232288d3a136SMathieu Poirier } 232388d3a136SMathieu Poirier 2324fec47d86SDave Gerlach /** 2325160e7c84SOhad Ben-Cohen * rproc_add() - register a remote processor 2326400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle to register 2327400e64dfSOhad Ben-Cohen * 2328400e64dfSOhad Ben-Cohen * Registers @rproc with the remoteproc framework, after it has been 2329400e64dfSOhad Ben-Cohen * allocated with rproc_alloc(). 2330400e64dfSOhad Ben-Cohen * 2331400e64dfSOhad Ben-Cohen * This is called by the platform-specific rproc implementation, whenever 2332400e64dfSOhad Ben-Cohen * a new remote processor device is probed. 2333400e64dfSOhad Ben-Cohen * 2334400e64dfSOhad Ben-Cohen * Note: this function initiates an asynchronous firmware loading 2335400e64dfSOhad Ben-Cohen * context, which will look for virtio devices supported by the rproc's 2336400e64dfSOhad Ben-Cohen * firmware. 2337400e64dfSOhad Ben-Cohen * 2338400e64dfSOhad Ben-Cohen * If found, those virtio devices will be created and added, so as a result 23397a186941SOhad Ben-Cohen * of registering this remote processor, additional virtio drivers might be 2340400e64dfSOhad Ben-Cohen * probed. 2341f2867434SSuman Anna * 2342f2867434SSuman Anna * Return: 0 on success and an appropriate error code otherwise 2343400e64dfSOhad Ben-Cohen */ 2344160e7c84SOhad Ben-Cohen int rproc_add(struct rproc *rproc) 2345400e64dfSOhad Ben-Cohen { 2346b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 234770b85ef8SFernando Guzman Lugo int ret; 2348400e64dfSOhad Ben-Cohen 234988d3a136SMathieu Poirier ret = rproc_validate(rproc); 235088d3a136SMathieu Poirier if (ret < 0) 235188d3a136SMathieu Poirier return ret; 235288d3a136SMathieu Poirier 235362b8f9e9SSiddharth Gupta /* add char device for this remoteproc */ 235462b8f9e9SSiddharth Gupta ret = rproc_char_device_add(rproc); 235562b8f9e9SSiddharth Gupta if (ret < 0) 235662b8f9e9SSiddharth Gupta return ret; 235762b8f9e9SSiddharth Gupta 2358305ac5a7SPaul Cercueil ret = device_add(dev); 23597dbdb8bdSSiddharth Gupta if (ret < 0) { 23607dbdb8bdSSiddharth Gupta put_device(dev); 23617dbdb8bdSSiddharth Gupta goto rproc_remove_cdev; 23627dbdb8bdSSiddharth Gupta } 2363305ac5a7SPaul Cercueil 2364305ac5a7SPaul Cercueil dev_info(dev, "%s is available\n", rproc->name); 2365305ac5a7SPaul Cercueil 2366305ac5a7SPaul Cercueil /* create debugfs entries */ 2367305ac5a7SPaul Cercueil rproc_create_debug_dir(rproc); 2368305ac5a7SPaul Cercueil 23697a20c64dSSarangdhar Joshi /* if rproc is marked always-on, request it to boot */ 23707a20c64dSSarangdhar Joshi if (rproc->auto_boot) { 23715e6533f7SSarangdhar Joshi ret = rproc_trigger_auto_boot(rproc); 2372d2e12e66SDave Gerlach if (ret < 0) 23737dbdb8bdSSiddharth Gupta goto rproc_remove_dev; 23747a20c64dSSarangdhar Joshi } 2375400e64dfSOhad Ben-Cohen 2376d2e12e66SDave Gerlach /* expose to rproc_get_by_phandle users */ 2377d2e12e66SDave Gerlach mutex_lock(&rproc_list_mutex); 2378c0abe2caSBjorn Andersson list_add_rcu(&rproc->node, &rproc_list); 2379d2e12e66SDave Gerlach mutex_unlock(&rproc_list_mutex); 2380d2e12e66SDave Gerlach 2381d2e12e66SDave Gerlach return 0; 23827dbdb8bdSSiddharth Gupta 23837dbdb8bdSSiddharth Gupta rproc_remove_dev: 23847dbdb8bdSSiddharth Gupta rproc_delete_debug_dir(rproc); 23857dbdb8bdSSiddharth Gupta device_del(dev); 23867dbdb8bdSSiddharth Gupta rproc_remove_cdev: 23877dbdb8bdSSiddharth Gupta rproc_char_device_remove(rproc); 23887dbdb8bdSSiddharth Gupta return ret; 2389400e64dfSOhad Ben-Cohen } 2390160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_add); 2391400e64dfSOhad Ben-Cohen 2392305ac5a7SPaul Cercueil static void devm_rproc_remove(void *rproc) 2393305ac5a7SPaul Cercueil { 2394305ac5a7SPaul Cercueil rproc_del(rproc); 2395305ac5a7SPaul Cercueil } 2396305ac5a7SPaul Cercueil 2397305ac5a7SPaul Cercueil /** 2398305ac5a7SPaul Cercueil * devm_rproc_add() - resource managed rproc_add() 2399305ac5a7SPaul Cercueil * @dev: the underlying device 2400305ac5a7SPaul Cercueil * @rproc: the remote processor handle to register 2401305ac5a7SPaul Cercueil * 2402305ac5a7SPaul Cercueil * This function performs like rproc_add() but the registered rproc device will 2403305ac5a7SPaul Cercueil * automatically be removed on driver detach. 2404305ac5a7SPaul Cercueil * 2405f2867434SSuman Anna * Return: 0 on success, negative errno on failure 2406305ac5a7SPaul Cercueil */ 2407305ac5a7SPaul Cercueil int devm_rproc_add(struct device *dev, struct rproc *rproc) 2408305ac5a7SPaul Cercueil { 2409305ac5a7SPaul Cercueil int err; 2410305ac5a7SPaul Cercueil 2411305ac5a7SPaul Cercueil err = rproc_add(rproc); 2412305ac5a7SPaul Cercueil if (err) 2413305ac5a7SPaul Cercueil return err; 2414305ac5a7SPaul Cercueil 2415305ac5a7SPaul Cercueil return devm_add_action_or_reset(dev, devm_rproc_remove, rproc); 2416305ac5a7SPaul Cercueil } 2417305ac5a7SPaul Cercueil EXPORT_SYMBOL(devm_rproc_add); 2418305ac5a7SPaul Cercueil 2419400e64dfSOhad Ben-Cohen /** 2420b5ab5e24SOhad Ben-Cohen * rproc_type_release() - release a remote processor instance 2421b5ab5e24SOhad Ben-Cohen * @dev: the rproc's device 2422b5ab5e24SOhad Ben-Cohen * 2423b5ab5e24SOhad Ben-Cohen * This function should _never_ be called directly. 2424b5ab5e24SOhad Ben-Cohen * 2425b5ab5e24SOhad Ben-Cohen * It will be called by the driver core when no one holds a valid pointer 2426b5ab5e24SOhad Ben-Cohen * to @dev anymore. 2427b5ab5e24SOhad Ben-Cohen */ 2428b5ab5e24SOhad Ben-Cohen static void rproc_type_release(struct device *dev) 2429b5ab5e24SOhad Ben-Cohen { 2430b5ab5e24SOhad Ben-Cohen struct rproc *rproc = container_of(dev, struct rproc, dev); 2431b5ab5e24SOhad Ben-Cohen 24327183a2a7SOhad Ben-Cohen dev_info(&rproc->dev, "releasing %s\n", rproc->name); 24337183a2a7SOhad Ben-Cohen 2434b5ab5e24SOhad Ben-Cohen idr_destroy(&rproc->notifyids); 2435b5ab5e24SOhad Ben-Cohen 2436b5ab5e24SOhad Ben-Cohen if (rproc->index >= 0) 2437b5ab5e24SOhad Ben-Cohen ida_simple_remove(&rproc_dev_index, rproc->index); 2438b5ab5e24SOhad Ben-Cohen 24391487dedaSMathieu Poirier kfree_const(rproc->firmware); 2440db655278SSuman Anna kfree_const(rproc->name); 2441fb98e2bdSBjorn Andersson kfree(rproc->ops); 2442b5ab5e24SOhad Ben-Cohen kfree(rproc); 2443b5ab5e24SOhad Ben-Cohen } 2444b5ab5e24SOhad Ben-Cohen 2445c42ca04dSBhumika Goyal static const struct device_type rproc_type = { 2446b5ab5e24SOhad Ben-Cohen .name = "remoteproc", 2447b5ab5e24SOhad Ben-Cohen .release = rproc_type_release, 2448b5ab5e24SOhad Ben-Cohen }; 2449400e64dfSOhad Ben-Cohen 24500c2ae2b1SMathieu Poirier static int rproc_alloc_firmware(struct rproc *rproc, 24510c2ae2b1SMathieu Poirier const char *name, const char *firmware) 24520c2ae2b1SMathieu Poirier { 24531487dedaSMathieu Poirier const char *p; 24540c2ae2b1SMathieu Poirier 24550c2ae2b1SMathieu Poirier /* 24569d5f82c8SMathieu Poirier * Allocate a firmware name if the caller gave us one to work 24579d5f82c8SMathieu Poirier * with. Otherwise construct a new one using a default pattern. 24580c2ae2b1SMathieu Poirier */ 24599d5f82c8SMathieu Poirier if (firmware) 24601487dedaSMathieu Poirier p = kstrdup_const(firmware, GFP_KERNEL); 24619d5f82c8SMathieu Poirier else 24629d5f82c8SMathieu Poirier p = kasprintf(GFP_KERNEL, "rproc-%s-fw", name); 24634df4f8beSMathieu Poirier 24640c2ae2b1SMathieu Poirier if (!p) 24650c2ae2b1SMathieu Poirier return -ENOMEM; 24660c2ae2b1SMathieu Poirier 24670c2ae2b1SMathieu Poirier rproc->firmware = p; 24680c2ae2b1SMathieu Poirier 24690c2ae2b1SMathieu Poirier return 0; 24700c2ae2b1SMathieu Poirier } 24710c2ae2b1SMathieu Poirier 2472bf860aa1SMathieu Poirier static int rproc_alloc_ops(struct rproc *rproc, const struct rproc_ops *ops) 2473bf860aa1SMathieu Poirier { 2474bf860aa1SMathieu Poirier rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL); 2475bf860aa1SMathieu Poirier if (!rproc->ops) 2476bf860aa1SMathieu Poirier return -ENOMEM; 2477bf860aa1SMathieu Poirier 2478adf60a87SSiddharth Gupta /* Default to rproc_coredump if no coredump function is specified */ 2479adf60a87SSiddharth Gupta if (!rproc->ops->coredump) 2480adf60a87SSiddharth Gupta rproc->ops->coredump = rproc_coredump; 2481adf60a87SSiddharth Gupta 2482bf860aa1SMathieu Poirier if (rproc->ops->load) 2483bf860aa1SMathieu Poirier return 0; 2484bf860aa1SMathieu Poirier 2485bf860aa1SMathieu Poirier /* Default to ELF loader if no load function is specified */ 2486bf860aa1SMathieu Poirier rproc->ops->load = rproc_elf_load_segments; 2487bf860aa1SMathieu Poirier rproc->ops->parse_fw = rproc_elf_load_rsc_table; 2488bf860aa1SMathieu Poirier rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table; 2489e29ff72bSClement Leger rproc->ops->sanity_check = rproc_elf_sanity_check; 2490bf860aa1SMathieu Poirier rproc->ops->get_boot_addr = rproc_elf_get_boot_addr; 2491bf860aa1SMathieu Poirier 2492bf860aa1SMathieu Poirier return 0; 2493bf860aa1SMathieu Poirier } 2494bf860aa1SMathieu Poirier 2495400e64dfSOhad Ben-Cohen /** 2496400e64dfSOhad Ben-Cohen * rproc_alloc() - allocate a remote processor handle 2497400e64dfSOhad Ben-Cohen * @dev: the underlying device 2498400e64dfSOhad Ben-Cohen * @name: name of this remote processor 2499400e64dfSOhad Ben-Cohen * @ops: platform-specific handlers (mainly start/stop) 25008b4aec9aSRobert Tivy * @firmware: name of firmware file to load, can be NULL 2501400e64dfSOhad Ben-Cohen * @len: length of private data needed by the rproc driver (in bytes) 2502400e64dfSOhad Ben-Cohen * 2503400e64dfSOhad Ben-Cohen * Allocates a new remote processor handle, but does not register 25048b4aec9aSRobert Tivy * it yet. if @firmware is NULL, a default name is used. 2505400e64dfSOhad Ben-Cohen * 2506400e64dfSOhad Ben-Cohen * This function should be used by rproc implementations during initialization 2507400e64dfSOhad Ben-Cohen * of the remote processor. 2508400e64dfSOhad Ben-Cohen * 2509400e64dfSOhad Ben-Cohen * After creating an rproc handle using this function, and when ready, 2510160e7c84SOhad Ben-Cohen * implementations should then call rproc_add() to complete 2511400e64dfSOhad Ben-Cohen * the registration of the remote processor. 2512400e64dfSOhad Ben-Cohen * 2513400e64dfSOhad Ben-Cohen * Note: _never_ directly deallocate @rproc, even if it was not registered 2514433c0e04SBjorn Andersson * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free(). 2515f2867434SSuman Anna * 2516f2867434SSuman Anna * Return: new rproc pointer on success, and NULL on failure 2517400e64dfSOhad Ben-Cohen */ 2518400e64dfSOhad Ben-Cohen struct rproc *rproc_alloc(struct device *dev, const char *name, 2519400e64dfSOhad Ben-Cohen const struct rproc_ops *ops, 2520400e64dfSOhad Ben-Cohen const char *firmware, int len) 2521400e64dfSOhad Ben-Cohen { 2522400e64dfSOhad Ben-Cohen struct rproc *rproc; 2523400e64dfSOhad Ben-Cohen 2524400e64dfSOhad Ben-Cohen if (!dev || !name || !ops) 2525400e64dfSOhad Ben-Cohen return NULL; 2526400e64dfSOhad Ben-Cohen 25270f57dc6aSMatt Redfearn rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL); 25280c2ae2b1SMathieu Poirier if (!rproc) 25290f57dc6aSMatt Redfearn return NULL; 25300c2ae2b1SMathieu Poirier 2531400e64dfSOhad Ben-Cohen rproc->priv = &rproc[1]; 2532ddf71187SBjorn Andersson rproc->auto_boot = true; 2533418fd787SClement Leger rproc->elf_class = ELFCLASSNONE; 2534418fd787SClement Leger rproc->elf_machine = EM_NONE; 2535400e64dfSOhad Ben-Cohen 2536b5ab5e24SOhad Ben-Cohen device_initialize(&rproc->dev); 2537b5ab5e24SOhad Ben-Cohen rproc->dev.parent = dev; 2538b5ab5e24SOhad Ben-Cohen rproc->dev.type = &rproc_type; 25392aefbef0SMatt Redfearn rproc->dev.class = &rproc_class; 25407c89717fSBjorn Andersson rproc->dev.driver_data = rproc; 25416442df49SAlex Elder idr_init(&rproc->notifyids); 2542b5ab5e24SOhad Ben-Cohen 2543db655278SSuman Anna rproc->name = kstrdup_const(name, GFP_KERNEL); 2544db655278SSuman Anna if (!rproc->name) 2545db655278SSuman Anna goto put_device; 2546db655278SSuman Anna 2547226f5db4SMathieu Poirier if (rproc_alloc_firmware(rproc, name, firmware)) 2548226f5db4SMathieu Poirier goto put_device; 2549226f5db4SMathieu Poirier 2550226f5db4SMathieu Poirier if (rproc_alloc_ops(rproc, ops)) 2551226f5db4SMathieu Poirier goto put_device; 2552226f5db4SMathieu Poirier 2553b5ab5e24SOhad Ben-Cohen /* Assign a unique device index and name */ 2554b5ab5e24SOhad Ben-Cohen rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL); 2555b5ab5e24SOhad Ben-Cohen if (rproc->index < 0) { 2556b5ab5e24SOhad Ben-Cohen dev_err(dev, "ida_simple_get failed: %d\n", rproc->index); 2557226f5db4SMathieu Poirier goto put_device; 2558b5ab5e24SOhad Ben-Cohen } 2559b5ab5e24SOhad Ben-Cohen 2560b5ab5e24SOhad Ben-Cohen dev_set_name(&rproc->dev, "remoteproc%d", rproc->index); 2561b5ab5e24SOhad Ben-Cohen 2562400e64dfSOhad Ben-Cohen atomic_set(&rproc->power, 0); 2563400e64dfSOhad Ben-Cohen 2564400e64dfSOhad Ben-Cohen mutex_init(&rproc->lock); 2565400e64dfSOhad Ben-Cohen 2566400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->carveouts); 2567400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->mappings); 2568400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->traces); 25697a186941SOhad Ben-Cohen INIT_LIST_HEAD(&rproc->rvdevs); 25707bdc9650SBjorn Andersson INIT_LIST_HEAD(&rproc->subdevs); 25712666ca91SSarangdhar Joshi INIT_LIST_HEAD(&rproc->dump_segments); 2572400e64dfSOhad Ben-Cohen 25738afd519cSFernando Guzman Lugo INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work); 25748afd519cSFernando Guzman Lugo 2575400e64dfSOhad Ben-Cohen rproc->state = RPROC_OFFLINE; 2576400e64dfSOhad Ben-Cohen 2577400e64dfSOhad Ben-Cohen return rproc; 25780c2ae2b1SMathieu Poirier 2579226f5db4SMathieu Poirier put_device: 2580226f5db4SMathieu Poirier put_device(&rproc->dev); 25810c2ae2b1SMathieu Poirier return NULL; 2582400e64dfSOhad Ben-Cohen } 2583400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_alloc); 2584400e64dfSOhad Ben-Cohen 2585400e64dfSOhad Ben-Cohen /** 2586433c0e04SBjorn Andersson * rproc_free() - unroll rproc_alloc() 2587433c0e04SBjorn Andersson * @rproc: the remote processor handle 2588433c0e04SBjorn Andersson * 2589433c0e04SBjorn Andersson * This function decrements the rproc dev refcount. 2590433c0e04SBjorn Andersson * 2591433c0e04SBjorn Andersson * If no one holds any reference to rproc anymore, then its refcount would 2592433c0e04SBjorn Andersson * now drop to zero, and it would be freed. 2593433c0e04SBjorn Andersson */ 2594433c0e04SBjorn Andersson void rproc_free(struct rproc *rproc) 2595433c0e04SBjorn Andersson { 2596433c0e04SBjorn Andersson put_device(&rproc->dev); 2597433c0e04SBjorn Andersson } 2598433c0e04SBjorn Andersson EXPORT_SYMBOL(rproc_free); 2599433c0e04SBjorn Andersson 2600433c0e04SBjorn Andersson /** 2601433c0e04SBjorn Andersson * rproc_put() - release rproc reference 2602400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle 2603400e64dfSOhad Ben-Cohen * 2604c6b5a276SOhad Ben-Cohen * This function decrements the rproc dev refcount. 2605400e64dfSOhad Ben-Cohen * 2606c6b5a276SOhad Ben-Cohen * If no one holds any reference to rproc anymore, then its refcount would 2607c6b5a276SOhad Ben-Cohen * now drop to zero, and it would be freed. 2608400e64dfSOhad Ben-Cohen */ 2609160e7c84SOhad Ben-Cohen void rproc_put(struct rproc *rproc) 2610400e64dfSOhad Ben-Cohen { 2611fbb6aacbSBjorn Andersson module_put(rproc->dev.parent->driver->owner); 2612b5ab5e24SOhad Ben-Cohen put_device(&rproc->dev); 2613400e64dfSOhad Ben-Cohen } 2614160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_put); 2615400e64dfSOhad Ben-Cohen 2616400e64dfSOhad Ben-Cohen /** 2617160e7c84SOhad Ben-Cohen * rproc_del() - unregister a remote processor 2618400e64dfSOhad Ben-Cohen * @rproc: rproc handle to unregister 2619400e64dfSOhad Ben-Cohen * 2620400e64dfSOhad Ben-Cohen * This function should be called when the platform specific rproc 2621400e64dfSOhad Ben-Cohen * implementation decides to remove the rproc device. it should 2622160e7c84SOhad Ben-Cohen * _only_ be called if a previous invocation of rproc_add() 2623400e64dfSOhad Ben-Cohen * has completed successfully. 2624400e64dfSOhad Ben-Cohen * 2625160e7c84SOhad Ben-Cohen * After rproc_del() returns, @rproc isn't freed yet, because 2626c6b5a276SOhad Ben-Cohen * of the outstanding reference created by rproc_alloc. To decrement that 2627433c0e04SBjorn Andersson * one last refcount, one still needs to call rproc_free(). 2628400e64dfSOhad Ben-Cohen * 2629f2867434SSuman Anna * Return: 0 on success and -EINVAL if @rproc isn't valid 2630400e64dfSOhad Ben-Cohen */ 2631160e7c84SOhad Ben-Cohen int rproc_del(struct rproc *rproc) 2632400e64dfSOhad Ben-Cohen { 2633400e64dfSOhad Ben-Cohen if (!rproc) 2634400e64dfSOhad Ben-Cohen return -EINVAL; 2635400e64dfSOhad Ben-Cohen 2636ddf71187SBjorn Andersson /* TODO: make sure this works with rproc->power > 1 */ 2637ddf71187SBjorn Andersson rproc_shutdown(rproc); 2638ddf71187SBjorn Andersson 26392099c77dSSarangdhar Joshi mutex_lock(&rproc->lock); 26402099c77dSSarangdhar Joshi rproc->state = RPROC_DELETED; 26412099c77dSSarangdhar Joshi mutex_unlock(&rproc->lock); 26422099c77dSSarangdhar Joshi 2643b003d45bSSarangdhar Joshi rproc_delete_debug_dir(rproc); 2644b003d45bSSarangdhar Joshi 2645fec47d86SDave Gerlach /* the rproc is downref'ed as soon as it's removed from the klist */ 2646fec47d86SDave Gerlach mutex_lock(&rproc_list_mutex); 2647c0abe2caSBjorn Andersson list_del_rcu(&rproc->node); 2648fec47d86SDave Gerlach mutex_unlock(&rproc_list_mutex); 2649fec47d86SDave Gerlach 2650c0abe2caSBjorn Andersson /* Ensure that no readers of rproc_list are still active */ 2651c0abe2caSBjorn Andersson synchronize_rcu(); 2652c0abe2caSBjorn Andersson 2653b5ab5e24SOhad Ben-Cohen device_del(&rproc->dev); 2654930eec0bSSiddharth Gupta rproc_char_device_remove(rproc); 2655400e64dfSOhad Ben-Cohen 2656400e64dfSOhad Ben-Cohen return 0; 2657400e64dfSOhad Ben-Cohen } 2658160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_del); 2659400e64dfSOhad Ben-Cohen 2660305ac5a7SPaul Cercueil static void devm_rproc_free(struct device *dev, void *res) 2661305ac5a7SPaul Cercueil { 2662305ac5a7SPaul Cercueil rproc_free(*(struct rproc **)res); 2663305ac5a7SPaul Cercueil } 2664305ac5a7SPaul Cercueil 2665305ac5a7SPaul Cercueil /** 2666305ac5a7SPaul Cercueil * devm_rproc_alloc() - resource managed rproc_alloc() 2667305ac5a7SPaul Cercueil * @dev: the underlying device 2668305ac5a7SPaul Cercueil * @name: name of this remote processor 2669305ac5a7SPaul Cercueil * @ops: platform-specific handlers (mainly start/stop) 2670305ac5a7SPaul Cercueil * @firmware: name of firmware file to load, can be NULL 2671305ac5a7SPaul Cercueil * @len: length of private data needed by the rproc driver (in bytes) 2672305ac5a7SPaul Cercueil * 2673305ac5a7SPaul Cercueil * This function performs like rproc_alloc() but the acquired rproc device will 2674305ac5a7SPaul Cercueil * automatically be released on driver detach. 2675305ac5a7SPaul Cercueil * 2676f2867434SSuman Anna * Return: new rproc instance, or NULL on failure 2677305ac5a7SPaul Cercueil */ 2678305ac5a7SPaul Cercueil struct rproc *devm_rproc_alloc(struct device *dev, const char *name, 2679305ac5a7SPaul Cercueil const struct rproc_ops *ops, 2680305ac5a7SPaul Cercueil const char *firmware, int len) 2681305ac5a7SPaul Cercueil { 2682305ac5a7SPaul Cercueil struct rproc **ptr, *rproc; 2683305ac5a7SPaul Cercueil 2684305ac5a7SPaul Cercueil ptr = devres_alloc(devm_rproc_free, sizeof(*ptr), GFP_KERNEL); 2685305ac5a7SPaul Cercueil if (!ptr) 26867dcef398SDan Carpenter return NULL; 2687305ac5a7SPaul Cercueil 2688305ac5a7SPaul Cercueil rproc = rproc_alloc(dev, name, ops, firmware, len); 2689305ac5a7SPaul Cercueil if (rproc) { 2690305ac5a7SPaul Cercueil *ptr = rproc; 2691305ac5a7SPaul Cercueil devres_add(dev, ptr); 2692305ac5a7SPaul Cercueil } else { 2693305ac5a7SPaul Cercueil devres_free(ptr); 2694305ac5a7SPaul Cercueil } 2695305ac5a7SPaul Cercueil 2696305ac5a7SPaul Cercueil return rproc; 2697305ac5a7SPaul Cercueil } 2698305ac5a7SPaul Cercueil EXPORT_SYMBOL(devm_rproc_alloc); 2699305ac5a7SPaul Cercueil 27008afd519cSFernando Guzman Lugo /** 27017bdc9650SBjorn Andersson * rproc_add_subdev() - add a subdevice to a remoteproc 27027bdc9650SBjorn Andersson * @rproc: rproc handle to add the subdevice to 27037bdc9650SBjorn Andersson * @subdev: subdev handle to register 27044902676fSBjorn Andersson * 27054902676fSBjorn Andersson * Caller is responsible for populating optional subdevice function pointers. 27067bdc9650SBjorn Andersson */ 27074902676fSBjorn Andersson void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 27087bdc9650SBjorn Andersson { 27097bdc9650SBjorn Andersson list_add_tail(&subdev->node, &rproc->subdevs); 27107bdc9650SBjorn Andersson } 27117bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_add_subdev); 27127bdc9650SBjorn Andersson 27137bdc9650SBjorn Andersson /** 27147bdc9650SBjorn Andersson * rproc_remove_subdev() - remove a subdevice from a remoteproc 27157bdc9650SBjorn Andersson * @rproc: rproc handle to remove the subdevice from 27167bdc9650SBjorn Andersson * @subdev: subdev handle, previously registered with rproc_add_subdev() 27177bdc9650SBjorn Andersson */ 27187bdc9650SBjorn Andersson void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 27197bdc9650SBjorn Andersson { 27207bdc9650SBjorn Andersson list_del(&subdev->node); 27217bdc9650SBjorn Andersson } 27227bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_remove_subdev); 27237bdc9650SBjorn Andersson 27247bdc9650SBjorn Andersson /** 27257c89717fSBjorn Andersson * rproc_get_by_child() - acquire rproc handle of @dev's ancestor 27267c89717fSBjorn Andersson * @dev: child device to find ancestor of 27277c89717fSBjorn Andersson * 2728f2867434SSuman Anna * Return: the ancestor rproc instance, or NULL if not found 27297c89717fSBjorn Andersson */ 27307c89717fSBjorn Andersson struct rproc *rproc_get_by_child(struct device *dev) 27317c89717fSBjorn Andersson { 27327c89717fSBjorn Andersson for (dev = dev->parent; dev; dev = dev->parent) { 27337c89717fSBjorn Andersson if (dev->type == &rproc_type) 27347c89717fSBjorn Andersson return dev->driver_data; 27357c89717fSBjorn Andersson } 27367c89717fSBjorn Andersson 27377c89717fSBjorn Andersson return NULL; 27387c89717fSBjorn Andersson } 27397c89717fSBjorn Andersson EXPORT_SYMBOL(rproc_get_by_child); 27407c89717fSBjorn Andersson 27417c89717fSBjorn Andersson /** 27428afd519cSFernando Guzman Lugo * rproc_report_crash() - rproc crash reporter function 27438afd519cSFernando Guzman Lugo * @rproc: remote processor 27448afd519cSFernando Guzman Lugo * @type: crash type 27458afd519cSFernando Guzman Lugo * 27468afd519cSFernando Guzman Lugo * This function must be called every time a crash is detected by the low-level 27478afd519cSFernando Guzman Lugo * drivers implementing a specific remoteproc. This should not be called from a 27488afd519cSFernando Guzman Lugo * non-remoteproc driver. 27498afd519cSFernando Guzman Lugo * 27508afd519cSFernando Guzman Lugo * This function can be called from atomic/interrupt context. 27518afd519cSFernando Guzman Lugo */ 27528afd519cSFernando Guzman Lugo void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type) 27538afd519cSFernando Guzman Lugo { 27548afd519cSFernando Guzman Lugo if (!rproc) { 27558afd519cSFernando Guzman Lugo pr_err("NULL rproc pointer\n"); 27568afd519cSFernando Guzman Lugo return; 27578afd519cSFernando Guzman Lugo } 27588afd519cSFernando Guzman Lugo 2759a781e5aaSRishabh Bhatnagar /* Prevent suspend while the remoteproc is being recovered */ 2760a781e5aaSRishabh Bhatnagar pm_stay_awake(rproc->dev.parent); 2761a781e5aaSRishabh Bhatnagar 27628afd519cSFernando Guzman Lugo dev_err(&rproc->dev, "crash detected in %s: type %s\n", 27638afd519cSFernando Guzman Lugo rproc->name, rproc_crash_to_string(type)); 27648afd519cSFernando Guzman Lugo 27653ad51c17SAlex Elder /* Have a worker handle the error; ensure system is not suspended */ 27663ad51c17SAlex Elder queue_work(system_freezable_wq, &rproc->crash_handler); 27678afd519cSFernando Guzman Lugo } 27688afd519cSFernando Guzman Lugo EXPORT_SYMBOL(rproc_report_crash); 27698afd519cSFernando Guzman Lugo 2770dc5192c4SBjorn Andersson static int rproc_panic_handler(struct notifier_block *nb, unsigned long event, 2771dc5192c4SBjorn Andersson void *ptr) 2772dc5192c4SBjorn Andersson { 2773dc5192c4SBjorn Andersson unsigned int longest = 0; 2774dc5192c4SBjorn Andersson struct rproc *rproc; 2775dc5192c4SBjorn Andersson unsigned int d; 2776dc5192c4SBjorn Andersson 2777dc5192c4SBjorn Andersson rcu_read_lock(); 2778dc5192c4SBjorn Andersson list_for_each_entry_rcu(rproc, &rproc_list, node) { 2779800dad00SMathieu Poirier if (!rproc->ops->panic) 2780800dad00SMathieu Poirier continue; 2781800dad00SMathieu Poirier 2782800dad00SMathieu Poirier if (rproc->state != RPROC_RUNNING && 2783800dad00SMathieu Poirier rproc->state != RPROC_ATTACHED) 2784dc5192c4SBjorn Andersson continue; 2785dc5192c4SBjorn Andersson 2786dc5192c4SBjorn Andersson d = rproc->ops->panic(rproc); 2787dc5192c4SBjorn Andersson longest = max(longest, d); 2788dc5192c4SBjorn Andersson } 2789dc5192c4SBjorn Andersson rcu_read_unlock(); 2790dc5192c4SBjorn Andersson 2791dc5192c4SBjorn Andersson /* 2792dc5192c4SBjorn Andersson * Delay for the longest requested duration before returning. This can 2793dc5192c4SBjorn Andersson * be used by the remoteproc drivers to give the remote processor time 2794dc5192c4SBjorn Andersson * to perform any requested operations (such as flush caches), when 2795dc5192c4SBjorn Andersson * it's not possible to signal the Linux side due to the panic. 2796dc5192c4SBjorn Andersson */ 2797dc5192c4SBjorn Andersson mdelay(longest); 2798dc5192c4SBjorn Andersson 2799dc5192c4SBjorn Andersson return NOTIFY_DONE; 2800dc5192c4SBjorn Andersson } 2801dc5192c4SBjorn Andersson 2802dc5192c4SBjorn Andersson static void __init rproc_init_panic(void) 2803dc5192c4SBjorn Andersson { 2804dc5192c4SBjorn Andersson rproc_panic_nb.notifier_call = rproc_panic_handler; 2805dc5192c4SBjorn Andersson atomic_notifier_chain_register(&panic_notifier_list, &rproc_panic_nb); 2806dc5192c4SBjorn Andersson } 2807dc5192c4SBjorn Andersson 2808dc5192c4SBjorn Andersson static void __exit rproc_exit_panic(void) 2809dc5192c4SBjorn Andersson { 2810dc5192c4SBjorn Andersson atomic_notifier_chain_unregister(&panic_notifier_list, &rproc_panic_nb); 2811dc5192c4SBjorn Andersson } 2812dc5192c4SBjorn Andersson 2813400e64dfSOhad Ben-Cohen static int __init remoteproc_init(void) 2814400e64dfSOhad Ben-Cohen { 28152aefbef0SMatt Redfearn rproc_init_sysfs(); 2816400e64dfSOhad Ben-Cohen rproc_init_debugfs(); 281762b8f9e9SSiddharth Gupta rproc_init_cdev(); 2818dc5192c4SBjorn Andersson rproc_init_panic(); 2819b5ab5e24SOhad Ben-Cohen 2820400e64dfSOhad Ben-Cohen return 0; 2821400e64dfSOhad Ben-Cohen } 2822a8f40111SBrandon Maier subsys_initcall(remoteproc_init); 2823400e64dfSOhad Ben-Cohen 2824400e64dfSOhad Ben-Cohen static void __exit remoteproc_exit(void) 2825400e64dfSOhad Ben-Cohen { 2826f42f79afSSuman Anna ida_destroy(&rproc_dev_index); 2827f42f79afSSuman Anna 2828dc5192c4SBjorn Andersson rproc_exit_panic(); 2829400e64dfSOhad Ben-Cohen rproc_exit_debugfs(); 28302aefbef0SMatt Redfearn rproc_exit_sysfs(); 2831400e64dfSOhad Ben-Cohen } 2832400e64dfSOhad Ben-Cohen module_exit(remoteproc_exit); 2833400e64dfSOhad Ben-Cohen 2834400e64dfSOhad Ben-Cohen MODULE_LICENSE("GPL v2"); 2835400e64dfSOhad Ben-Cohen MODULE_DESCRIPTION("Generic Remote Processor Framework"); 2836