1400e64dfSOhad Ben-Cohen /* 2400e64dfSOhad Ben-Cohen * Remote Processor Framework 3400e64dfSOhad Ben-Cohen * 4400e64dfSOhad Ben-Cohen * Copyright (C) 2011 Texas Instruments, Inc. 5400e64dfSOhad Ben-Cohen * Copyright (C) 2011 Google, Inc. 6400e64dfSOhad Ben-Cohen * 7400e64dfSOhad Ben-Cohen * Ohad Ben-Cohen <ohad@wizery.com> 8400e64dfSOhad Ben-Cohen * Brian Swetland <swetland@google.com> 9400e64dfSOhad Ben-Cohen * Mark Grosen <mgrosen@ti.com> 10400e64dfSOhad Ben-Cohen * Fernando Guzman Lugo <fernando.lugo@ti.com> 11400e64dfSOhad Ben-Cohen * Suman Anna <s-anna@ti.com> 12400e64dfSOhad Ben-Cohen * Robert Tivy <rtivy@ti.com> 13400e64dfSOhad Ben-Cohen * Armando Uribe De Leon <x0095078@ti.com> 14400e64dfSOhad Ben-Cohen * 15400e64dfSOhad Ben-Cohen * This program is free software; you can redistribute it and/or 16400e64dfSOhad Ben-Cohen * modify it under the terms of the GNU General Public License 17400e64dfSOhad Ben-Cohen * version 2 as published by the Free Software Foundation. 18400e64dfSOhad Ben-Cohen * 19400e64dfSOhad Ben-Cohen * This program is distributed in the hope that it will be useful, 20400e64dfSOhad Ben-Cohen * but WITHOUT ANY WARRANTY; without even the implied warranty of 21400e64dfSOhad Ben-Cohen * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22400e64dfSOhad Ben-Cohen * GNU General Public License for more details. 23400e64dfSOhad Ben-Cohen */ 24400e64dfSOhad Ben-Cohen 25400e64dfSOhad Ben-Cohen #define pr_fmt(fmt) "%s: " fmt, __func__ 26400e64dfSOhad Ben-Cohen 27400e64dfSOhad Ben-Cohen #include <linux/kernel.h> 28400e64dfSOhad Ben-Cohen #include <linux/module.h> 29400e64dfSOhad Ben-Cohen #include <linux/device.h> 30400e64dfSOhad Ben-Cohen #include <linux/slab.h> 31400e64dfSOhad Ben-Cohen #include <linux/mutex.h> 32400e64dfSOhad Ben-Cohen #include <linux/dma-mapping.h> 33400e64dfSOhad Ben-Cohen #include <linux/firmware.h> 34400e64dfSOhad Ben-Cohen #include <linux/string.h> 35400e64dfSOhad Ben-Cohen #include <linux/debugfs.h> 362666ca91SSarangdhar Joshi #include <linux/devcoredump.h> 37400e64dfSOhad Ben-Cohen #include <linux/remoteproc.h> 38400e64dfSOhad Ben-Cohen #include <linux/iommu.h> 39b5ab5e24SOhad Ben-Cohen #include <linux/idr.h> 40400e64dfSOhad Ben-Cohen #include <linux/elf.h> 41a2b950acSOhad Ben-Cohen #include <linux/crc32.h> 42400e64dfSOhad Ben-Cohen #include <linux/virtio_ids.h> 43400e64dfSOhad Ben-Cohen #include <linux/virtio_ring.h> 44cf59d3e9SOhad Ben-Cohen #include <asm/byteorder.h> 45400e64dfSOhad Ben-Cohen 46400e64dfSOhad Ben-Cohen #include "remoteproc_internal.h" 47400e64dfSOhad Ben-Cohen 48fec47d86SDave Gerlach static DEFINE_MUTEX(rproc_list_mutex); 49fec47d86SDave Gerlach static LIST_HEAD(rproc_list); 50fec47d86SDave Gerlach 51400e64dfSOhad Ben-Cohen typedef int (*rproc_handle_resources_t)(struct rproc *rproc, 52fd2c15ecSOhad Ben-Cohen struct resource_table *table, int len); 53a2b950acSOhad Ben-Cohen typedef int (*rproc_handle_resource_t)(struct rproc *rproc, 54a2b950acSOhad Ben-Cohen void *, int offset, int avail); 55400e64dfSOhad Ben-Cohen 56b5ab5e24SOhad Ben-Cohen /* Unique indices for remoteproc devices */ 57b5ab5e24SOhad Ben-Cohen static DEFINE_IDA(rproc_dev_index); 58b5ab5e24SOhad Ben-Cohen 598afd519cSFernando Guzman Lugo static const char * const rproc_crash_names[] = { 608afd519cSFernando Guzman Lugo [RPROC_MMUFAULT] = "mmufault", 61b3d39032SBjorn Andersson [RPROC_WATCHDOG] = "watchdog", 62b3d39032SBjorn Andersson [RPROC_FATAL_ERROR] = "fatal error", 638afd519cSFernando Guzman Lugo }; 648afd519cSFernando Guzman Lugo 658afd519cSFernando Guzman Lugo /* translate rproc_crash_type to string */ 668afd519cSFernando Guzman Lugo static const char *rproc_crash_to_string(enum rproc_crash_type type) 678afd519cSFernando Guzman Lugo { 688afd519cSFernando Guzman Lugo if (type < ARRAY_SIZE(rproc_crash_names)) 698afd519cSFernando Guzman Lugo return rproc_crash_names[type]; 70b23f7a09SMasanari Iida return "unknown"; 718afd519cSFernando Guzman Lugo } 728afd519cSFernando Guzman Lugo 73400e64dfSOhad Ben-Cohen /* 74400e64dfSOhad Ben-Cohen * This is the IOMMU fault handler we register with the IOMMU API 75400e64dfSOhad Ben-Cohen * (when relevant; not all remote processors access memory through 76400e64dfSOhad Ben-Cohen * an IOMMU). 77400e64dfSOhad Ben-Cohen * 78400e64dfSOhad Ben-Cohen * IOMMU core will invoke this handler whenever the remote processor 79400e64dfSOhad Ben-Cohen * will try to access an unmapped device address. 80400e64dfSOhad Ben-Cohen */ 81400e64dfSOhad Ben-Cohen static int rproc_iommu_fault(struct iommu_domain *domain, struct device *dev, 8277ca2332SOhad Ben-Cohen unsigned long iova, int flags, void *token) 83400e64dfSOhad Ben-Cohen { 848afd519cSFernando Guzman Lugo struct rproc *rproc = token; 858afd519cSFernando Guzman Lugo 86400e64dfSOhad Ben-Cohen dev_err(dev, "iommu fault: da 0x%lx flags 0x%x\n", iova, flags); 87400e64dfSOhad Ben-Cohen 888afd519cSFernando Guzman Lugo rproc_report_crash(rproc, RPROC_MMUFAULT); 898afd519cSFernando Guzman Lugo 90400e64dfSOhad Ben-Cohen /* 91400e64dfSOhad Ben-Cohen * Let the iommu core know we're not really handling this fault; 928afd519cSFernando Guzman Lugo * we just used it as a recovery trigger. 93400e64dfSOhad Ben-Cohen */ 94400e64dfSOhad Ben-Cohen return -ENOSYS; 95400e64dfSOhad Ben-Cohen } 96400e64dfSOhad Ben-Cohen 97400e64dfSOhad Ben-Cohen static int rproc_enable_iommu(struct rproc *rproc) 98400e64dfSOhad Ben-Cohen { 99400e64dfSOhad Ben-Cohen struct iommu_domain *domain; 100b5ab5e24SOhad Ben-Cohen struct device *dev = rproc->dev.parent; 101400e64dfSOhad Ben-Cohen int ret; 102400e64dfSOhad Ben-Cohen 103315491e5SSuman Anna if (!rproc->has_iommu) { 104315491e5SSuman Anna dev_dbg(dev, "iommu not present\n"); 1050798e1daSMark Grosen return 0; 106400e64dfSOhad Ben-Cohen } 107400e64dfSOhad Ben-Cohen 108400e64dfSOhad Ben-Cohen domain = iommu_domain_alloc(dev->bus); 109400e64dfSOhad Ben-Cohen if (!domain) { 110400e64dfSOhad Ben-Cohen dev_err(dev, "can't alloc iommu domain\n"); 111400e64dfSOhad Ben-Cohen return -ENOMEM; 112400e64dfSOhad Ben-Cohen } 113400e64dfSOhad Ben-Cohen 11477ca2332SOhad Ben-Cohen iommu_set_fault_handler(domain, rproc_iommu_fault, rproc); 115400e64dfSOhad Ben-Cohen 116400e64dfSOhad Ben-Cohen ret = iommu_attach_device(domain, dev); 117400e64dfSOhad Ben-Cohen if (ret) { 118400e64dfSOhad Ben-Cohen dev_err(dev, "can't attach iommu device: %d\n", ret); 119400e64dfSOhad Ben-Cohen goto free_domain; 120400e64dfSOhad Ben-Cohen } 121400e64dfSOhad Ben-Cohen 122400e64dfSOhad Ben-Cohen rproc->domain = domain; 123400e64dfSOhad Ben-Cohen 124400e64dfSOhad Ben-Cohen return 0; 125400e64dfSOhad Ben-Cohen 126400e64dfSOhad Ben-Cohen free_domain: 127400e64dfSOhad Ben-Cohen iommu_domain_free(domain); 128400e64dfSOhad Ben-Cohen return ret; 129400e64dfSOhad Ben-Cohen } 130400e64dfSOhad Ben-Cohen 131400e64dfSOhad Ben-Cohen static void rproc_disable_iommu(struct rproc *rproc) 132400e64dfSOhad Ben-Cohen { 133400e64dfSOhad Ben-Cohen struct iommu_domain *domain = rproc->domain; 134b5ab5e24SOhad Ben-Cohen struct device *dev = rproc->dev.parent; 135400e64dfSOhad Ben-Cohen 136400e64dfSOhad Ben-Cohen if (!domain) 137400e64dfSOhad Ben-Cohen return; 138400e64dfSOhad Ben-Cohen 139400e64dfSOhad Ben-Cohen iommu_detach_device(domain, dev); 140400e64dfSOhad Ben-Cohen iommu_domain_free(domain); 141400e64dfSOhad Ben-Cohen } 142400e64dfSOhad Ben-Cohen 143eb30596eSLoic Pallardy static phys_addr_t rproc_va_to_pa(void *cpu_addr) 144eb30596eSLoic Pallardy { 145eb30596eSLoic Pallardy /* 146eb30596eSLoic Pallardy * Return physical address according to virtual address location 147eb30596eSLoic Pallardy * - in vmalloc: if region ioremapped or defined as dma_alloc_coherent 148eb30596eSLoic Pallardy * - in kernel: if region allocated in generic dma memory pool 149eb30596eSLoic Pallardy */ 150eb30596eSLoic Pallardy if (is_vmalloc_addr(cpu_addr)) { 151eb30596eSLoic Pallardy return page_to_phys(vmalloc_to_page(cpu_addr)) + 152eb30596eSLoic Pallardy offset_in_page(cpu_addr); 153eb30596eSLoic Pallardy } 154eb30596eSLoic Pallardy 155eb30596eSLoic Pallardy WARN_ON(!virt_addr_valid(cpu_addr)); 156eb30596eSLoic Pallardy return virt_to_phys(cpu_addr); 157eb30596eSLoic Pallardy } 158eb30596eSLoic Pallardy 159a01f7cd6SSuman Anna /** 160a01f7cd6SSuman Anna * rproc_da_to_va() - lookup the kernel virtual address for a remoteproc address 161a01f7cd6SSuman Anna * @rproc: handle of a remote processor 162a01f7cd6SSuman Anna * @da: remoteproc device address to translate 163a01f7cd6SSuman Anna * @len: length of the memory region @da is pointing to 164a01f7cd6SSuman Anna * 165400e64dfSOhad Ben-Cohen * Some remote processors will ask us to allocate them physically contiguous 166400e64dfSOhad Ben-Cohen * memory regions (which we call "carveouts"), and map them to specific 167a01f7cd6SSuman Anna * device addresses (which are hardcoded in the firmware). They may also have 168a01f7cd6SSuman Anna * dedicated memory regions internal to the processors, and use them either 169a01f7cd6SSuman Anna * exclusively or alongside carveouts. 170400e64dfSOhad Ben-Cohen * 171400e64dfSOhad Ben-Cohen * They may then ask us to copy objects into specific device addresses (e.g. 172400e64dfSOhad Ben-Cohen * code/data sections) or expose us certain symbols in other device address 173400e64dfSOhad Ben-Cohen * (e.g. their trace buffer). 174400e64dfSOhad Ben-Cohen * 175a01f7cd6SSuman Anna * This function is a helper function with which we can go over the allocated 176a01f7cd6SSuman Anna * carveouts and translate specific device addresses to kernel virtual addresses 177a01f7cd6SSuman Anna * so we can access the referenced memory. This function also allows to perform 178a01f7cd6SSuman Anna * translations on the internal remoteproc memory regions through a platform 179a01f7cd6SSuman Anna * implementation specific da_to_va ops, if present. 180a01f7cd6SSuman Anna * 181a01f7cd6SSuman Anna * The function returns a valid kernel address on success or NULL on failure. 182400e64dfSOhad Ben-Cohen * 183400e64dfSOhad Ben-Cohen * Note: phys_to_virt(iommu_iova_to_phys(rproc->domain, da)) will work too, 184400e64dfSOhad Ben-Cohen * but only on kernel direct mapped RAM memory. Instead, we're just using 185a01f7cd6SSuman Anna * here the output of the DMA API for the carveouts, which should be more 186a01f7cd6SSuman Anna * correct. 187400e64dfSOhad Ben-Cohen */ 18872854fb0SSjur Brændeland void *rproc_da_to_va(struct rproc *rproc, u64 da, int len) 189400e64dfSOhad Ben-Cohen { 190400e64dfSOhad Ben-Cohen struct rproc_mem_entry *carveout; 191400e64dfSOhad Ben-Cohen void *ptr = NULL; 192400e64dfSOhad Ben-Cohen 193a01f7cd6SSuman Anna if (rproc->ops->da_to_va) { 194a01f7cd6SSuman Anna ptr = rproc->ops->da_to_va(rproc, da, len); 195a01f7cd6SSuman Anna if (ptr) 196a01f7cd6SSuman Anna goto out; 197a01f7cd6SSuman Anna } 198a01f7cd6SSuman Anna 199400e64dfSOhad Ben-Cohen list_for_each_entry(carveout, &rproc->carveouts, node) { 200400e64dfSOhad Ben-Cohen int offset = da - carveout->da; 201400e64dfSOhad Ben-Cohen 202400e64dfSOhad Ben-Cohen /* try next carveout if da is too small */ 203400e64dfSOhad Ben-Cohen if (offset < 0) 204400e64dfSOhad Ben-Cohen continue; 205400e64dfSOhad Ben-Cohen 206400e64dfSOhad Ben-Cohen /* try next carveout if da is too large */ 207400e64dfSOhad Ben-Cohen if (offset + len > carveout->len) 208400e64dfSOhad Ben-Cohen continue; 209400e64dfSOhad Ben-Cohen 210400e64dfSOhad Ben-Cohen ptr = carveout->va + offset; 211400e64dfSOhad Ben-Cohen 212400e64dfSOhad Ben-Cohen break; 213400e64dfSOhad Ben-Cohen } 214400e64dfSOhad Ben-Cohen 215a01f7cd6SSuman Anna out: 216400e64dfSOhad Ben-Cohen return ptr; 217400e64dfSOhad Ben-Cohen } 2184afc89d6SSjur Brændeland EXPORT_SYMBOL(rproc_da_to_va); 219400e64dfSOhad Ben-Cohen 220b0019ccdSLoic Pallardy /** 221b0019ccdSLoic Pallardy * rproc_find_carveout_by_name() - lookup the carveout region by a name 222b0019ccdSLoic Pallardy * @rproc: handle of a remote processor 223b0019ccdSLoic Pallardy * @name,..: carveout name to find (standard printf format) 224b0019ccdSLoic Pallardy * 225b0019ccdSLoic Pallardy * Platform driver has the capability to register some pre-allacoted carveout 226b0019ccdSLoic Pallardy * (physically contiguous memory regions) before rproc firmware loading and 227b0019ccdSLoic Pallardy * associated resource table analysis. These regions may be dedicated memory 228b0019ccdSLoic Pallardy * regions internal to the coprocessor or specified DDR region with specific 229b0019ccdSLoic Pallardy * attributes 230b0019ccdSLoic Pallardy * 231b0019ccdSLoic Pallardy * This function is a helper function with which we can go over the 232b0019ccdSLoic Pallardy * allocated carveouts and return associated region characteristics like 233b0019ccdSLoic Pallardy * coprocessor address, length or processor virtual address. 234b0019ccdSLoic Pallardy * 235b0019ccdSLoic Pallardy * Return: a valid pointer on carveout entry on success or NULL on failure. 236b0019ccdSLoic Pallardy */ 237b0019ccdSLoic Pallardy struct rproc_mem_entry * 238b0019ccdSLoic Pallardy rproc_find_carveout_by_name(struct rproc *rproc, const char *name, ...) 239b0019ccdSLoic Pallardy { 240b0019ccdSLoic Pallardy va_list args; 241b0019ccdSLoic Pallardy char _name[32]; 242b0019ccdSLoic Pallardy struct rproc_mem_entry *carveout, *mem = NULL; 243b0019ccdSLoic Pallardy 244b0019ccdSLoic Pallardy if (!name) 245b0019ccdSLoic Pallardy return NULL; 246b0019ccdSLoic Pallardy 247b0019ccdSLoic Pallardy va_start(args, name); 248b0019ccdSLoic Pallardy vsnprintf(_name, sizeof(_name), name, args); 249b0019ccdSLoic Pallardy va_end(args); 250b0019ccdSLoic Pallardy 251b0019ccdSLoic Pallardy list_for_each_entry(carveout, &rproc->carveouts, node) { 252b0019ccdSLoic Pallardy /* Compare carveout and requested names */ 253b0019ccdSLoic Pallardy if (!strcmp(carveout->name, _name)) { 254b0019ccdSLoic Pallardy mem = carveout; 255b0019ccdSLoic Pallardy break; 256b0019ccdSLoic Pallardy } 257b0019ccdSLoic Pallardy } 258b0019ccdSLoic Pallardy 259b0019ccdSLoic Pallardy return mem; 260b0019ccdSLoic Pallardy } 261b0019ccdSLoic Pallardy 2626db20ea8SOhad Ben-Cohen int rproc_alloc_vring(struct rproc_vdev *rvdev, int i) 263400e64dfSOhad Ben-Cohen { 2647a186941SOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 265b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 2666db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 267c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 2687a186941SOhad Ben-Cohen dma_addr_t dma; 2697a186941SOhad Ben-Cohen void *va; 2707a186941SOhad Ben-Cohen int ret, size, notifyid; 271400e64dfSOhad Ben-Cohen 2726db20ea8SOhad Ben-Cohen /* actual size of vring (in bytes) */ 2736db20ea8SOhad Ben-Cohen size = PAGE_ALIGN(vring_size(rvring->len, rvring->align)); 2746db20ea8SOhad Ben-Cohen 2756db20ea8SOhad Ben-Cohen /* 2766db20ea8SOhad Ben-Cohen * Allocate non-cacheable memory for the vring. In the future 2776db20ea8SOhad Ben-Cohen * this call will also configure the IOMMU for us 2786db20ea8SOhad Ben-Cohen */ 279b5ab5e24SOhad Ben-Cohen va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL); 2806db20ea8SOhad Ben-Cohen if (!va) { 281b5ab5e24SOhad Ben-Cohen dev_err(dev->parent, "dma_alloc_coherent failed\n"); 2826db20ea8SOhad Ben-Cohen return -EINVAL; 2836db20ea8SOhad Ben-Cohen } 2846db20ea8SOhad Ben-Cohen 2856db20ea8SOhad Ben-Cohen /* 2866db20ea8SOhad Ben-Cohen * Assign an rproc-wide unique index for this vring 2876db20ea8SOhad Ben-Cohen * TODO: assign a notifyid for rvdev updates as well 2886db20ea8SOhad Ben-Cohen * TODO: support predefined notifyids (via resource table) 2896db20ea8SOhad Ben-Cohen */ 29015fc6110STejun Heo ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL); 291b39599b7SSuman Anna if (ret < 0) { 29215fc6110STejun Heo dev_err(dev, "idr_alloc failed: %d\n", ret); 293b5ab5e24SOhad Ben-Cohen dma_free_coherent(dev->parent, size, va, dma); 2946db20ea8SOhad Ben-Cohen return ret; 2956db20ea8SOhad Ben-Cohen } 29615fc6110STejun Heo notifyid = ret; 2976db20ea8SOhad Ben-Cohen 29848f18f89SBjorn Andersson /* Potentially bump max_notifyid */ 29948f18f89SBjorn Andersson if (notifyid > rproc->max_notifyid) 30048f18f89SBjorn Andersson rproc->max_notifyid = notifyid; 30148f18f89SBjorn Andersson 302276ec993SLoic Pallardy dev_dbg(dev, "vring%d: va %pK dma %pad size 0x%x idr %d\n", 303b605ed8bSAnna, Suman i, va, &dma, size, notifyid); 3046db20ea8SOhad Ben-Cohen 3056db20ea8SOhad Ben-Cohen rvring->va = va; 3066db20ea8SOhad Ben-Cohen rvring->dma = dma; 3076db20ea8SOhad Ben-Cohen rvring->notifyid = notifyid; 3086db20ea8SOhad Ben-Cohen 309c0d63157SSjur Brændeland /* 310c0d63157SSjur Brændeland * Let the rproc know the notifyid and da of this vring. 311c0d63157SSjur Brændeland * Not all platforms use dma_alloc_coherent to automatically 312c0d63157SSjur Brændeland * set up the iommu. In this case the device address (da) will 313c0d63157SSjur Brændeland * hold the physical address and not the device address. 314c0d63157SSjur Brændeland */ 315c0d63157SSjur Brændeland rsc = (void *)rproc->table_ptr + rvdev->rsc_offset; 316c0d63157SSjur Brændeland rsc->vring[i].da = dma; 317c0d63157SSjur Brændeland rsc->vring[i].notifyid = notifyid; 3186db20ea8SOhad Ben-Cohen return 0; 3196db20ea8SOhad Ben-Cohen } 3206db20ea8SOhad Ben-Cohen 321400e64dfSOhad Ben-Cohen static int 3226db20ea8SOhad Ben-Cohen rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i) 323400e64dfSOhad Ben-Cohen { 324400e64dfSOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 325b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 326400e64dfSOhad Ben-Cohen struct fw_rsc_vdev_vring *vring = &rsc->vring[i]; 3276db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 328400e64dfSOhad Ben-Cohen 3299d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n", 3307a186941SOhad Ben-Cohen i, vring->da, vring->num, vring->align); 3317a186941SOhad Ben-Cohen 33263140e0eSOhad Ben-Cohen /* verify queue size and vring alignment are sane */ 33363140e0eSOhad Ben-Cohen if (!vring->num || !vring->align) { 33463140e0eSOhad Ben-Cohen dev_err(dev, "invalid qsz (%d) or alignment (%d)\n", 33563140e0eSOhad Ben-Cohen vring->num, vring->align); 336400e64dfSOhad Ben-Cohen return -EINVAL; 337400e64dfSOhad Ben-Cohen } 338400e64dfSOhad Ben-Cohen 3396db20ea8SOhad Ben-Cohen rvring->len = vring->num; 3406db20ea8SOhad Ben-Cohen rvring->align = vring->align; 3416db20ea8SOhad Ben-Cohen rvring->rvdev = rvdev; 342400e64dfSOhad Ben-Cohen 343400e64dfSOhad Ben-Cohen return 0; 344400e64dfSOhad Ben-Cohen } 345400e64dfSOhad Ben-Cohen 3466db20ea8SOhad Ben-Cohen void rproc_free_vring(struct rproc_vring *rvring) 3477a186941SOhad Ben-Cohen { 34863140e0eSOhad Ben-Cohen int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align)); 3496db20ea8SOhad Ben-Cohen struct rproc *rproc = rvring->rvdev->rproc; 350c0d63157SSjur Brændeland int idx = rvring->rvdev->vring - rvring; 351c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 3527a186941SOhad Ben-Cohen 353b5ab5e24SOhad Ben-Cohen dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma); 3547a186941SOhad Ben-Cohen idr_remove(&rproc->notifyids, rvring->notifyid); 355099a3f33SSjur Brændeland 356c0d63157SSjur Brændeland /* reset resource entry info */ 357c0d63157SSjur Brændeland rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset; 358c0d63157SSjur Brændeland rsc->vring[idx].da = 0; 359c0d63157SSjur Brændeland rsc->vring[idx].notifyid = -1; 3607a186941SOhad Ben-Cohen } 3617a186941SOhad Ben-Cohen 3626f8b0373SAlex Elder static int rproc_vdev_do_start(struct rproc_subdev *subdev) 363f5bcb353SBjorn Andersson { 364f5bcb353SBjorn Andersson struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev); 365f5bcb353SBjorn Andersson 366f5bcb353SBjorn Andersson return rproc_add_virtio_dev(rvdev, rvdev->id); 367f5bcb353SBjorn Andersson } 368f5bcb353SBjorn Andersson 3696f8b0373SAlex Elder static void rproc_vdev_do_stop(struct rproc_subdev *subdev, bool crashed) 370f5bcb353SBjorn Andersson { 371f5bcb353SBjorn Andersson struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev); 372f5bcb353SBjorn Andersson 373f5bcb353SBjorn Andersson rproc_remove_virtio_dev(rvdev); 374f5bcb353SBjorn Andersson } 375f5bcb353SBjorn Andersson 376400e64dfSOhad Ben-Cohen /** 377fd2c15ecSOhad Ben-Cohen * rproc_handle_vdev() - handle a vdev fw resource 378400e64dfSOhad Ben-Cohen * @rproc: the remote processor 379400e64dfSOhad Ben-Cohen * @rsc: the vring resource descriptor 380fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 381400e64dfSOhad Ben-Cohen * 3827a186941SOhad Ben-Cohen * This resource entry requests the host to statically register a virtio 3837a186941SOhad Ben-Cohen * device (vdev), and setup everything needed to support it. It contains 3847a186941SOhad Ben-Cohen * everything needed to make it possible: the virtio device id, virtio 3857a186941SOhad Ben-Cohen * device features, vrings information, virtio config space, etc... 386400e64dfSOhad Ben-Cohen * 3877a186941SOhad Ben-Cohen * Before registering the vdev, the vrings are allocated from non-cacheable 3887a186941SOhad Ben-Cohen * physically contiguous memory. Currently we only support two vrings per 3897a186941SOhad Ben-Cohen * remote processor (temporary limitation). We might also want to consider 3907a186941SOhad Ben-Cohen * doing the vring allocation only later when ->find_vqs() is invoked, and 3917a186941SOhad Ben-Cohen * then release them upon ->del_vqs(). 392400e64dfSOhad Ben-Cohen * 3937a186941SOhad Ben-Cohen * Note: @da is currently not really handled correctly: we dynamically 3947a186941SOhad Ben-Cohen * allocate it using the DMA API, ignoring requested hard coded addresses, 3957a186941SOhad Ben-Cohen * and we don't take care of any required IOMMU programming. This is all 3967a186941SOhad Ben-Cohen * going to be taken care of when the generic iommu-based DMA API will be 3977a186941SOhad Ben-Cohen * merged. Meanwhile, statically-addressed iommu-based firmware images should 3987a186941SOhad Ben-Cohen * use RSC_DEVMEM resource entries to map their required @da to the physical 3997a186941SOhad Ben-Cohen * address of their base CMA region (ouch, hacky!). 400400e64dfSOhad Ben-Cohen * 401400e64dfSOhad Ben-Cohen * Returns 0 on success, or an appropriate error code otherwise 402400e64dfSOhad Ben-Cohen */ 403fd2c15ecSOhad Ben-Cohen static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc, 404a2b950acSOhad Ben-Cohen int offset, int avail) 405400e64dfSOhad Ben-Cohen { 406b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 4077a186941SOhad Ben-Cohen struct rproc_vdev *rvdev; 4087a186941SOhad Ben-Cohen int i, ret; 409fd2c15ecSOhad Ben-Cohen 410fd2c15ecSOhad Ben-Cohen /* make sure resource isn't truncated */ 411fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring) 412fd2c15ecSOhad Ben-Cohen + rsc->config_len > avail) { 413b5ab5e24SOhad Ben-Cohen dev_err(dev, "vdev rsc is truncated\n"); 414fd2c15ecSOhad Ben-Cohen return -EINVAL; 415fd2c15ecSOhad Ben-Cohen } 416fd2c15ecSOhad Ben-Cohen 417fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 418fd2c15ecSOhad Ben-Cohen if (rsc->reserved[0] || rsc->reserved[1]) { 419fd2c15ecSOhad Ben-Cohen dev_err(dev, "vdev rsc has non zero reserved bytes\n"); 420fd2c15ecSOhad Ben-Cohen return -EINVAL; 421fd2c15ecSOhad Ben-Cohen } 422fd2c15ecSOhad Ben-Cohen 4239d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n", 424fd2c15ecSOhad Ben-Cohen rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings); 425400e64dfSOhad Ben-Cohen 4267a186941SOhad Ben-Cohen /* we currently support only two vrings per rvdev */ 4277a186941SOhad Ben-Cohen if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) { 428fd2c15ecSOhad Ben-Cohen dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings); 429400e64dfSOhad Ben-Cohen return -EINVAL; 430400e64dfSOhad Ben-Cohen } 431400e64dfSOhad Ben-Cohen 432899585adSAnna, Suman rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL); 4337a186941SOhad Ben-Cohen if (!rvdev) 4347a186941SOhad Ben-Cohen return -ENOMEM; 4357a186941SOhad Ben-Cohen 436aab8d802SBjorn Andersson kref_init(&rvdev->refcount); 437aab8d802SBjorn Andersson 438f5bcb353SBjorn Andersson rvdev->id = rsc->id; 4397a186941SOhad Ben-Cohen rvdev->rproc = rproc; 4407a186941SOhad Ben-Cohen 4416db20ea8SOhad Ben-Cohen /* parse the vrings */ 442fd2c15ecSOhad Ben-Cohen for (i = 0; i < rsc->num_of_vrings; i++) { 4436db20ea8SOhad Ben-Cohen ret = rproc_parse_vring(rvdev, rsc, i); 4447a186941SOhad Ben-Cohen if (ret) 4456db20ea8SOhad Ben-Cohen goto free_rvdev; 446fd2c15ecSOhad Ben-Cohen } 447fd2c15ecSOhad Ben-Cohen 448a2b950acSOhad Ben-Cohen /* remember the resource offset*/ 449a2b950acSOhad Ben-Cohen rvdev->rsc_offset = offset; 450400e64dfSOhad Ben-Cohen 451a863af5dSBjorn Andersson /* allocate the vring resources */ 452a863af5dSBjorn Andersson for (i = 0; i < rsc->num_of_vrings; i++) { 453a863af5dSBjorn Andersson ret = rproc_alloc_vring(rvdev, i); 454a863af5dSBjorn Andersson if (ret) 455a863af5dSBjorn Andersson goto unwind_vring_allocations; 456a863af5dSBjorn Andersson } 457a863af5dSBjorn Andersson 4587a186941SOhad Ben-Cohen list_add_tail(&rvdev->node, &rproc->rvdevs); 459400e64dfSOhad Ben-Cohen 4606f8b0373SAlex Elder rvdev->subdev.start = rproc_vdev_do_start; 4616f8b0373SAlex Elder rvdev->subdev.stop = rproc_vdev_do_stop; 4624902676fSBjorn Andersson 4634902676fSBjorn Andersson rproc_add_subdev(rproc, &rvdev->subdev); 464400e64dfSOhad Ben-Cohen 465400e64dfSOhad Ben-Cohen return 0; 4667a186941SOhad Ben-Cohen 467a863af5dSBjorn Andersson unwind_vring_allocations: 468a863af5dSBjorn Andersson for (i--; i >= 0; i--) 469a863af5dSBjorn Andersson rproc_free_vring(&rvdev->vring[i]); 4706db20ea8SOhad Ben-Cohen free_rvdev: 4717a186941SOhad Ben-Cohen kfree(rvdev); 4727a186941SOhad Ben-Cohen return ret; 473400e64dfSOhad Ben-Cohen } 474400e64dfSOhad Ben-Cohen 475aab8d802SBjorn Andersson void rproc_vdev_release(struct kref *ref) 476aab8d802SBjorn Andersson { 477aab8d802SBjorn Andersson struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount); 478a863af5dSBjorn Andersson struct rproc_vring *rvring; 479f5bcb353SBjorn Andersson struct rproc *rproc = rvdev->rproc; 480a863af5dSBjorn Andersson int id; 481a863af5dSBjorn Andersson 482a863af5dSBjorn Andersson for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) { 483a863af5dSBjorn Andersson rvring = &rvdev->vring[id]; 484a863af5dSBjorn Andersson if (!rvring->va) 485a863af5dSBjorn Andersson continue; 486a863af5dSBjorn Andersson 487a863af5dSBjorn Andersson rproc_free_vring(rvring); 488a863af5dSBjorn Andersson } 489aab8d802SBjorn Andersson 490f5bcb353SBjorn Andersson rproc_remove_subdev(rproc, &rvdev->subdev); 491aab8d802SBjorn Andersson list_del(&rvdev->node); 492aab8d802SBjorn Andersson kfree(rvdev); 493aab8d802SBjorn Andersson } 494aab8d802SBjorn Andersson 495400e64dfSOhad Ben-Cohen /** 496400e64dfSOhad Ben-Cohen * rproc_handle_trace() - handle a shared trace buffer resource 497400e64dfSOhad Ben-Cohen * @rproc: the remote processor 498400e64dfSOhad Ben-Cohen * @rsc: the trace resource descriptor 499fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 500400e64dfSOhad Ben-Cohen * 501400e64dfSOhad Ben-Cohen * In case the remote processor dumps trace logs into memory, 502400e64dfSOhad Ben-Cohen * export it via debugfs. 503400e64dfSOhad Ben-Cohen * 504400e64dfSOhad Ben-Cohen * Currently, the 'da' member of @rsc should contain the device address 505400e64dfSOhad Ben-Cohen * where the remote processor is dumping the traces. Later we could also 506400e64dfSOhad Ben-Cohen * support dynamically allocating this address using the generic 507400e64dfSOhad Ben-Cohen * DMA API (but currently there isn't a use case for that). 508400e64dfSOhad Ben-Cohen * 509400e64dfSOhad Ben-Cohen * Returns 0 on success, or an appropriate error code otherwise 510400e64dfSOhad Ben-Cohen */ 511fd2c15ecSOhad Ben-Cohen static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc, 512a2b950acSOhad Ben-Cohen int offset, int avail) 513400e64dfSOhad Ben-Cohen { 514400e64dfSOhad Ben-Cohen struct rproc_mem_entry *trace; 515b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 516400e64dfSOhad Ben-Cohen void *ptr; 517400e64dfSOhad Ben-Cohen char name[15]; 518400e64dfSOhad Ben-Cohen 519fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 520b5ab5e24SOhad Ben-Cohen dev_err(dev, "trace rsc is truncated\n"); 521fd2c15ecSOhad Ben-Cohen return -EINVAL; 522fd2c15ecSOhad Ben-Cohen } 523fd2c15ecSOhad Ben-Cohen 524fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 525fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 526fd2c15ecSOhad Ben-Cohen dev_err(dev, "trace rsc has non zero reserved bytes\n"); 527fd2c15ecSOhad Ben-Cohen return -EINVAL; 528fd2c15ecSOhad Ben-Cohen } 529fd2c15ecSOhad Ben-Cohen 530400e64dfSOhad Ben-Cohen /* what's the kernel address of this resource ? */ 531400e64dfSOhad Ben-Cohen ptr = rproc_da_to_va(rproc, rsc->da, rsc->len); 532400e64dfSOhad Ben-Cohen if (!ptr) { 533400e64dfSOhad Ben-Cohen dev_err(dev, "erroneous trace resource entry\n"); 534400e64dfSOhad Ben-Cohen return -EINVAL; 535400e64dfSOhad Ben-Cohen } 536400e64dfSOhad Ben-Cohen 537400e64dfSOhad Ben-Cohen trace = kzalloc(sizeof(*trace), GFP_KERNEL); 538172e6ab1SSuman Anna if (!trace) 539400e64dfSOhad Ben-Cohen return -ENOMEM; 540400e64dfSOhad Ben-Cohen 541400e64dfSOhad Ben-Cohen /* set the trace buffer dma properties */ 542400e64dfSOhad Ben-Cohen trace->len = rsc->len; 543400e64dfSOhad Ben-Cohen trace->va = ptr; 544400e64dfSOhad Ben-Cohen 545400e64dfSOhad Ben-Cohen /* make sure snprintf always null terminates, even if truncating */ 546400e64dfSOhad Ben-Cohen snprintf(name, sizeof(name), "trace%d", rproc->num_traces); 547400e64dfSOhad Ben-Cohen 548400e64dfSOhad Ben-Cohen /* create the debugfs entry */ 549400e64dfSOhad Ben-Cohen trace->priv = rproc_create_trace_file(name, rproc, trace); 550400e64dfSOhad Ben-Cohen if (!trace->priv) { 551400e64dfSOhad Ben-Cohen trace->va = NULL; 552400e64dfSOhad Ben-Cohen kfree(trace); 553400e64dfSOhad Ben-Cohen return -EINVAL; 554400e64dfSOhad Ben-Cohen } 555400e64dfSOhad Ben-Cohen 556400e64dfSOhad Ben-Cohen list_add_tail(&trace->node, &rproc->traces); 557400e64dfSOhad Ben-Cohen 558400e64dfSOhad Ben-Cohen rproc->num_traces++; 559400e64dfSOhad Ben-Cohen 560276ec993SLoic Pallardy dev_dbg(dev, "%s added: va %pK, da 0x%x, len 0x%x\n", 56135386166SLee Jones name, ptr, rsc->da, rsc->len); 562400e64dfSOhad Ben-Cohen 563400e64dfSOhad Ben-Cohen return 0; 564400e64dfSOhad Ben-Cohen } 565400e64dfSOhad Ben-Cohen 566400e64dfSOhad Ben-Cohen /** 567400e64dfSOhad Ben-Cohen * rproc_handle_devmem() - handle devmem resource entry 568400e64dfSOhad Ben-Cohen * @rproc: remote processor handle 569400e64dfSOhad Ben-Cohen * @rsc: the devmem resource entry 570fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 571400e64dfSOhad Ben-Cohen * 572400e64dfSOhad Ben-Cohen * Remote processors commonly need to access certain on-chip peripherals. 573400e64dfSOhad Ben-Cohen * 574400e64dfSOhad Ben-Cohen * Some of these remote processors access memory via an iommu device, 575400e64dfSOhad Ben-Cohen * and might require us to configure their iommu before they can access 576400e64dfSOhad Ben-Cohen * the on-chip peripherals they need. 577400e64dfSOhad Ben-Cohen * 578400e64dfSOhad Ben-Cohen * This resource entry is a request to map such a peripheral device. 579400e64dfSOhad Ben-Cohen * 580400e64dfSOhad Ben-Cohen * These devmem entries will contain the physical address of the device in 581400e64dfSOhad Ben-Cohen * the 'pa' member. If a specific device address is expected, then 'da' will 582400e64dfSOhad Ben-Cohen * contain it (currently this is the only use case supported). 'len' will 583400e64dfSOhad Ben-Cohen * contain the size of the physical region we need to map. 584400e64dfSOhad Ben-Cohen * 585400e64dfSOhad Ben-Cohen * Currently we just "trust" those devmem entries to contain valid physical 586400e64dfSOhad Ben-Cohen * addresses, but this is going to change: we want the implementations to 587400e64dfSOhad Ben-Cohen * tell us ranges of physical addresses the firmware is allowed to request, 588400e64dfSOhad Ben-Cohen * and not allow firmwares to request access to physical addresses that 589400e64dfSOhad Ben-Cohen * are outside those ranges. 590400e64dfSOhad Ben-Cohen */ 591fd2c15ecSOhad Ben-Cohen static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc, 592a2b950acSOhad Ben-Cohen int offset, int avail) 593400e64dfSOhad Ben-Cohen { 594400e64dfSOhad Ben-Cohen struct rproc_mem_entry *mapping; 595b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 596400e64dfSOhad Ben-Cohen int ret; 597400e64dfSOhad Ben-Cohen 598400e64dfSOhad Ben-Cohen /* no point in handling this resource without a valid iommu domain */ 599400e64dfSOhad Ben-Cohen if (!rproc->domain) 600400e64dfSOhad Ben-Cohen return -EINVAL; 601400e64dfSOhad Ben-Cohen 602fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 603b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc is truncated\n"); 604fd2c15ecSOhad Ben-Cohen return -EINVAL; 605fd2c15ecSOhad Ben-Cohen } 606fd2c15ecSOhad Ben-Cohen 607fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 608fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 609b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc has non zero reserved bytes\n"); 610fd2c15ecSOhad Ben-Cohen return -EINVAL; 611fd2c15ecSOhad Ben-Cohen } 612fd2c15ecSOhad Ben-Cohen 613400e64dfSOhad Ben-Cohen mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 614172e6ab1SSuman Anna if (!mapping) 615400e64dfSOhad Ben-Cohen return -ENOMEM; 616400e64dfSOhad Ben-Cohen 617400e64dfSOhad Ben-Cohen ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags); 618400e64dfSOhad Ben-Cohen if (ret) { 619b5ab5e24SOhad Ben-Cohen dev_err(dev, "failed to map devmem: %d\n", ret); 620400e64dfSOhad Ben-Cohen goto out; 621400e64dfSOhad Ben-Cohen } 622400e64dfSOhad Ben-Cohen 623400e64dfSOhad Ben-Cohen /* 624400e64dfSOhad Ben-Cohen * We'll need this info later when we'll want to unmap everything 625400e64dfSOhad Ben-Cohen * (e.g. on shutdown). 626400e64dfSOhad Ben-Cohen * 627400e64dfSOhad Ben-Cohen * We can't trust the remote processor not to change the resource 628400e64dfSOhad Ben-Cohen * table, so we must maintain this info independently. 629400e64dfSOhad Ben-Cohen */ 630400e64dfSOhad Ben-Cohen mapping->da = rsc->da; 631400e64dfSOhad Ben-Cohen mapping->len = rsc->len; 632400e64dfSOhad Ben-Cohen list_add_tail(&mapping->node, &rproc->mappings); 633400e64dfSOhad Ben-Cohen 634b5ab5e24SOhad Ben-Cohen dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n", 635400e64dfSOhad Ben-Cohen rsc->pa, rsc->da, rsc->len); 636400e64dfSOhad Ben-Cohen 637400e64dfSOhad Ben-Cohen return 0; 638400e64dfSOhad Ben-Cohen 639400e64dfSOhad Ben-Cohen out: 640400e64dfSOhad Ben-Cohen kfree(mapping); 641400e64dfSOhad Ben-Cohen return ret; 642400e64dfSOhad Ben-Cohen } 643400e64dfSOhad Ben-Cohen 644400e64dfSOhad Ben-Cohen /** 645d7c51706SLoic Pallardy * rproc_alloc_carveout() - allocated specified carveout 646d7c51706SLoic Pallardy * @rproc: rproc handle 647d7c51706SLoic Pallardy * @mem: the memory entry to allocate 648d7c51706SLoic Pallardy * 649d7c51706SLoic Pallardy * This function allocate specified memory entry @mem using 650d7c51706SLoic Pallardy * dma_alloc_coherent() as default allocator 651d7c51706SLoic Pallardy */ 652d7c51706SLoic Pallardy static int rproc_alloc_carveout(struct rproc *rproc, 653d7c51706SLoic Pallardy struct rproc_mem_entry *mem) 654d7c51706SLoic Pallardy { 655d7c51706SLoic Pallardy struct rproc_mem_entry *mapping = NULL; 656d7c51706SLoic Pallardy struct device *dev = &rproc->dev; 657d7c51706SLoic Pallardy dma_addr_t dma; 658d7c51706SLoic Pallardy void *va; 659d7c51706SLoic Pallardy int ret; 660d7c51706SLoic Pallardy 661d7c51706SLoic Pallardy va = dma_alloc_coherent(dev->parent, mem->len, &dma, GFP_KERNEL); 662d7c51706SLoic Pallardy if (!va) { 663d7c51706SLoic Pallardy dev_err(dev->parent, 664d7c51706SLoic Pallardy "failed to allocate dma memory: len 0x%x\n", mem->len); 665d7c51706SLoic Pallardy return -ENOMEM; 666d7c51706SLoic Pallardy } 667d7c51706SLoic Pallardy 668d7c51706SLoic Pallardy dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%x\n", 669d7c51706SLoic Pallardy va, &dma, mem->len); 670d7c51706SLoic Pallardy 671d7c51706SLoic Pallardy /* 672d7c51706SLoic Pallardy * Ok, this is non-standard. 673d7c51706SLoic Pallardy * 674d7c51706SLoic Pallardy * Sometimes we can't rely on the generic iommu-based DMA API 675d7c51706SLoic Pallardy * to dynamically allocate the device address and then set the IOMMU 676d7c51706SLoic Pallardy * tables accordingly, because some remote processors might 677d7c51706SLoic Pallardy * _require_ us to use hard coded device addresses that their 678d7c51706SLoic Pallardy * firmware was compiled with. 679d7c51706SLoic Pallardy * 680d7c51706SLoic Pallardy * In this case, we must use the IOMMU API directly and map 681d7c51706SLoic Pallardy * the memory to the device address as expected by the remote 682d7c51706SLoic Pallardy * processor. 683d7c51706SLoic Pallardy * 684d7c51706SLoic Pallardy * Obviously such remote processor devices should not be configured 685d7c51706SLoic Pallardy * to use the iommu-based DMA API: we expect 'dma' to contain the 686d7c51706SLoic Pallardy * physical address in this case. 687d7c51706SLoic Pallardy */ 688d7c51706SLoic Pallardy 689d7c51706SLoic Pallardy if (mem->da != FW_RSC_ADDR_ANY) { 690d7c51706SLoic Pallardy if (!rproc->domain) { 691d7c51706SLoic Pallardy dev_err(dev->parent, 692d7c51706SLoic Pallardy "Bad carveout rsc configuration\n"); 693d7c51706SLoic Pallardy ret = -ENOMEM; 694d7c51706SLoic Pallardy goto dma_free; 695d7c51706SLoic Pallardy } 696d7c51706SLoic Pallardy 697d7c51706SLoic Pallardy mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 698d7c51706SLoic Pallardy if (!mapping) { 699d7c51706SLoic Pallardy ret = -ENOMEM; 700d7c51706SLoic Pallardy goto dma_free; 701d7c51706SLoic Pallardy } 702d7c51706SLoic Pallardy 703d7c51706SLoic Pallardy ret = iommu_map(rproc->domain, mem->da, dma, mem->len, 704d7c51706SLoic Pallardy mem->flags); 705d7c51706SLoic Pallardy if (ret) { 706d7c51706SLoic Pallardy dev_err(dev, "iommu_map failed: %d\n", ret); 707d7c51706SLoic Pallardy goto free_mapping; 708d7c51706SLoic Pallardy } 709d7c51706SLoic Pallardy 710d7c51706SLoic Pallardy /* 711d7c51706SLoic Pallardy * We'll need this info later when we'll want to unmap 712d7c51706SLoic Pallardy * everything (e.g. on shutdown). 713d7c51706SLoic Pallardy * 714d7c51706SLoic Pallardy * We can't trust the remote processor not to change the 715d7c51706SLoic Pallardy * resource table, so we must maintain this info independently. 716d7c51706SLoic Pallardy */ 717d7c51706SLoic Pallardy mapping->da = mem->da; 718d7c51706SLoic Pallardy mapping->len = mem->len; 719d7c51706SLoic Pallardy list_add_tail(&mapping->node, &rproc->mappings); 720d7c51706SLoic Pallardy 721d7c51706SLoic Pallardy dev_dbg(dev, "carveout mapped 0x%x to %pad\n", 722d7c51706SLoic Pallardy mem->da, &dma); 723d7c51706SLoic Pallardy } else { 724d7c51706SLoic Pallardy mem->da = (u32)dma; 725d7c51706SLoic Pallardy } 726d7c51706SLoic Pallardy 727d7c51706SLoic Pallardy mem->dma = (u32)dma; 728d7c51706SLoic Pallardy mem->va = va; 729d7c51706SLoic Pallardy 730d7c51706SLoic Pallardy return 0; 731d7c51706SLoic Pallardy 732d7c51706SLoic Pallardy free_mapping: 733d7c51706SLoic Pallardy kfree(mapping); 734d7c51706SLoic Pallardy dma_free: 735d7c51706SLoic Pallardy dma_free_coherent(dev->parent, mem->len, va, dma); 736d7c51706SLoic Pallardy return ret; 737d7c51706SLoic Pallardy } 738d7c51706SLoic Pallardy 739d7c51706SLoic Pallardy /** 740f2e74abfSLoic Pallardy * rproc_release_carveout() - release acquired carveout 741f2e74abfSLoic Pallardy * @rproc: rproc handle 742f2e74abfSLoic Pallardy * @mem: the memory entry to release 743f2e74abfSLoic Pallardy * 744f2e74abfSLoic Pallardy * This function releases specified memory entry @mem allocated via 745d7c51706SLoic Pallardy * rproc_alloc_carveout() function by @rproc. 746f2e74abfSLoic Pallardy */ 747f2e74abfSLoic Pallardy static int rproc_release_carveout(struct rproc *rproc, 748f2e74abfSLoic Pallardy struct rproc_mem_entry *mem) 749f2e74abfSLoic Pallardy { 750f2e74abfSLoic Pallardy struct device *dev = &rproc->dev; 751f2e74abfSLoic Pallardy 752f2e74abfSLoic Pallardy /* clean up carveout allocations */ 753f2e74abfSLoic Pallardy dma_free_coherent(dev->parent, mem->len, mem->va, mem->dma); 754f2e74abfSLoic Pallardy return 0; 755f2e74abfSLoic Pallardy } 756f2e74abfSLoic Pallardy 757f2e74abfSLoic Pallardy /** 758400e64dfSOhad Ben-Cohen * rproc_handle_carveout() - handle phys contig memory allocation requests 759400e64dfSOhad Ben-Cohen * @rproc: rproc handle 760400e64dfSOhad Ben-Cohen * @rsc: the resource entry 761fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for image validation) 762400e64dfSOhad Ben-Cohen * 763400e64dfSOhad Ben-Cohen * This function will handle firmware requests for allocation of physically 764400e64dfSOhad Ben-Cohen * contiguous memory regions. 765400e64dfSOhad Ben-Cohen * 766400e64dfSOhad Ben-Cohen * These request entries should come first in the firmware's resource table, 767400e64dfSOhad Ben-Cohen * as other firmware entries might request placing other data objects inside 768400e64dfSOhad Ben-Cohen * these memory regions (e.g. data/code segments, trace resource entries, ...). 769400e64dfSOhad Ben-Cohen * 770400e64dfSOhad Ben-Cohen * Allocating memory this way helps utilizing the reserved physical memory 771400e64dfSOhad Ben-Cohen * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries 772400e64dfSOhad Ben-Cohen * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB 773400e64dfSOhad Ben-Cohen * pressure is important; it may have a substantial impact on performance. 774400e64dfSOhad Ben-Cohen */ 775fd2c15ecSOhad Ben-Cohen static int rproc_handle_carveout(struct rproc *rproc, 776a2b950acSOhad Ben-Cohen struct fw_rsc_carveout *rsc, 777a2b950acSOhad Ben-Cohen int offset, int avail) 778400e64dfSOhad Ben-Cohen { 779d7c51706SLoic Pallardy struct rproc_mem_entry *carveout; 780b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 781400e64dfSOhad Ben-Cohen 782fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 783b5ab5e24SOhad Ben-Cohen dev_err(dev, "carveout rsc is truncated\n"); 784fd2c15ecSOhad Ben-Cohen return -EINVAL; 785fd2c15ecSOhad Ben-Cohen } 786fd2c15ecSOhad Ben-Cohen 787fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 788fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 789fd2c15ecSOhad Ben-Cohen dev_err(dev, "carveout rsc has non zero reserved bytes\n"); 790fd2c15ecSOhad Ben-Cohen return -EINVAL; 791fd2c15ecSOhad Ben-Cohen } 792fd2c15ecSOhad Ben-Cohen 7939d7814a9SAnna, Suman dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n", 79435386166SLee Jones rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags); 795fd2c15ecSOhad Ben-Cohen 796d7c51706SLoic Pallardy /* Register carveout in in list */ 797d7c51706SLoic Pallardy carveout = rproc_mem_entry_init(dev, 0, 0, rsc->len, rsc->da, 798d7c51706SLoic Pallardy rproc_alloc_carveout, 799d7c51706SLoic Pallardy rproc_release_carveout, rsc->name); 800d7c51706SLoic Pallardy if (!carveout) { 801d7c51706SLoic Pallardy dev_err(dev, "Can't allocate memory entry structure\n"); 80272029c90SLoic Pallardy return -ENOMEM; 803400e64dfSOhad Ben-Cohen } 804400e64dfSOhad Ben-Cohen 805d7c51706SLoic Pallardy carveout->flags = rsc->flags; 806d7c51706SLoic Pallardy carveout->rsc_offset = offset; 80715c0b025SLoic Pallardy rproc_add_carveout(rproc, carveout); 808400e64dfSOhad Ben-Cohen 809400e64dfSOhad Ben-Cohen return 0; 810400e64dfSOhad Ben-Cohen } 811400e64dfSOhad Ben-Cohen 81272029c90SLoic Pallardy /** 81315c0b025SLoic Pallardy * rproc_add_carveout() - register an allocated carveout region 81415c0b025SLoic Pallardy * @rproc: rproc handle 81515c0b025SLoic Pallardy * @mem: memory entry to register 81615c0b025SLoic Pallardy * 81715c0b025SLoic Pallardy * This function registers specified memory entry in @rproc carveouts list. 81815c0b025SLoic Pallardy * Specified carveout should have been allocated before registering. 81915c0b025SLoic Pallardy */ 82015c0b025SLoic Pallardy void rproc_add_carveout(struct rproc *rproc, struct rproc_mem_entry *mem) 82115c0b025SLoic Pallardy { 82215c0b025SLoic Pallardy list_add_tail(&mem->node, &rproc->carveouts); 82315c0b025SLoic Pallardy } 82415c0b025SLoic Pallardy EXPORT_SYMBOL(rproc_add_carveout); 82515c0b025SLoic Pallardy 82615c0b025SLoic Pallardy /** 82772029c90SLoic Pallardy * rproc_mem_entry_init() - allocate and initialize rproc_mem_entry struct 82872029c90SLoic Pallardy * @dev: pointer on device struct 82972029c90SLoic Pallardy * @va: virtual address 83072029c90SLoic Pallardy * @dma: dma address 83172029c90SLoic Pallardy * @len: memory carveout length 83272029c90SLoic Pallardy * @da: device address 83372029c90SLoic Pallardy * @release: memory carveout function 83472029c90SLoic Pallardy * @name: carveout name 83572029c90SLoic Pallardy * 83672029c90SLoic Pallardy * This function allocates a rproc_mem_entry struct and fill it with parameters 83772029c90SLoic Pallardy * provided by client. 83872029c90SLoic Pallardy */ 83972029c90SLoic Pallardy struct rproc_mem_entry * 84072029c90SLoic Pallardy rproc_mem_entry_init(struct device *dev, 84172029c90SLoic Pallardy void *va, dma_addr_t dma, int len, u32 da, 842d7c51706SLoic Pallardy int (*alloc)(struct rproc *, struct rproc_mem_entry *), 84372029c90SLoic Pallardy int (*release)(struct rproc *, struct rproc_mem_entry *), 84472029c90SLoic Pallardy const char *name, ...) 84572029c90SLoic Pallardy { 84672029c90SLoic Pallardy struct rproc_mem_entry *mem; 84772029c90SLoic Pallardy va_list args; 84872029c90SLoic Pallardy 84972029c90SLoic Pallardy mem = kzalloc(sizeof(*mem), GFP_KERNEL); 85072029c90SLoic Pallardy if (!mem) 85172029c90SLoic Pallardy return mem; 85272029c90SLoic Pallardy 85372029c90SLoic Pallardy mem->va = va; 85472029c90SLoic Pallardy mem->dma = dma; 85572029c90SLoic Pallardy mem->da = da; 85672029c90SLoic Pallardy mem->len = len; 857d7c51706SLoic Pallardy mem->alloc = alloc; 85872029c90SLoic Pallardy mem->release = release; 859d7c51706SLoic Pallardy mem->rsc_offset = FW_RSC_ADDR_ANY; 8601429cca1SLoic Pallardy mem->of_resm_idx = -1; 86172029c90SLoic Pallardy 86272029c90SLoic Pallardy va_start(args, name); 86372029c90SLoic Pallardy vsnprintf(mem->name, sizeof(mem->name), name, args); 86472029c90SLoic Pallardy va_end(args); 86572029c90SLoic Pallardy 86672029c90SLoic Pallardy return mem; 86772029c90SLoic Pallardy } 86872029c90SLoic Pallardy EXPORT_SYMBOL(rproc_mem_entry_init); 86972029c90SLoic Pallardy 87072029c90SLoic Pallardy /** 8711429cca1SLoic Pallardy * rproc_of_resm_mem_entry_init() - allocate and initialize rproc_mem_entry struct 8721429cca1SLoic Pallardy * from a reserved memory phandle 8731429cca1SLoic Pallardy * @dev: pointer on device struct 8741429cca1SLoic Pallardy * @of_resm_idx: reserved memory phandle index in "memory-region" 8751429cca1SLoic Pallardy * @len: memory carveout length 8761429cca1SLoic Pallardy * @da: device address 8771429cca1SLoic Pallardy * @name: carveout name 8781429cca1SLoic Pallardy * 8791429cca1SLoic Pallardy * This function allocates a rproc_mem_entry struct and fill it with parameters 8801429cca1SLoic Pallardy * provided by client. 8811429cca1SLoic Pallardy */ 8821429cca1SLoic Pallardy struct rproc_mem_entry * 8831429cca1SLoic Pallardy rproc_of_resm_mem_entry_init(struct device *dev, u32 of_resm_idx, int len, 8841429cca1SLoic Pallardy u32 da, const char *name, ...) 8851429cca1SLoic Pallardy { 8861429cca1SLoic Pallardy struct rproc_mem_entry *mem; 8871429cca1SLoic Pallardy va_list args; 8881429cca1SLoic Pallardy 8891429cca1SLoic Pallardy mem = kzalloc(sizeof(*mem), GFP_KERNEL); 8901429cca1SLoic Pallardy if (!mem) 8911429cca1SLoic Pallardy return mem; 8921429cca1SLoic Pallardy 8931429cca1SLoic Pallardy mem->da = da; 8941429cca1SLoic Pallardy mem->len = len; 8951429cca1SLoic Pallardy mem->rsc_offset = FW_RSC_ADDR_ANY; 8961429cca1SLoic Pallardy mem->of_resm_idx = of_resm_idx; 8971429cca1SLoic Pallardy 8981429cca1SLoic Pallardy va_start(args, name); 8991429cca1SLoic Pallardy vsnprintf(mem->name, sizeof(mem->name), name, args); 9001429cca1SLoic Pallardy va_end(args); 9011429cca1SLoic Pallardy 9021429cca1SLoic Pallardy return mem; 9031429cca1SLoic Pallardy } 9041429cca1SLoic Pallardy EXPORT_SYMBOL(rproc_of_resm_mem_entry_init); 9051429cca1SLoic Pallardy 9061429cca1SLoic Pallardy /** 907e12bc14bSOhad Ben-Cohen * A lookup table for resource handlers. The indices are defined in 908e12bc14bSOhad Ben-Cohen * enum fw_resource_type. 909e12bc14bSOhad Ben-Cohen */ 910232fcdbbSSjur Brændeland static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = { 911fd2c15ecSOhad Ben-Cohen [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout, 912fd2c15ecSOhad Ben-Cohen [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem, 913fd2c15ecSOhad Ben-Cohen [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace, 914232fcdbbSSjur Brændeland [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev, 915232fcdbbSSjur Brændeland }; 916232fcdbbSSjur Brændeland 917400e64dfSOhad Ben-Cohen /* handle firmware resource entries before booting the remote processor */ 918a4b24c75SBjorn Andersson static int rproc_handle_resources(struct rproc *rproc, 919232fcdbbSSjur Brændeland rproc_handle_resource_t handlers[RSC_LAST]) 920400e64dfSOhad Ben-Cohen { 921b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 922e12bc14bSOhad Ben-Cohen rproc_handle_resource_t handler; 923fd2c15ecSOhad Ben-Cohen int ret = 0, i; 924400e64dfSOhad Ben-Cohen 925d4bb86f2SBjorn Andersson if (!rproc->table_ptr) 926d4bb86f2SBjorn Andersson return 0; 927d4bb86f2SBjorn Andersson 928a2b950acSOhad Ben-Cohen for (i = 0; i < rproc->table_ptr->num; i++) { 929a2b950acSOhad Ben-Cohen int offset = rproc->table_ptr->offset[i]; 930a2b950acSOhad Ben-Cohen struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset; 931a4b24c75SBjorn Andersson int avail = rproc->table_sz - offset - sizeof(*hdr); 932fd2c15ecSOhad Ben-Cohen void *rsc = (void *)hdr + sizeof(*hdr); 933400e64dfSOhad Ben-Cohen 934fd2c15ecSOhad Ben-Cohen /* make sure table isn't truncated */ 935fd2c15ecSOhad Ben-Cohen if (avail < 0) { 936fd2c15ecSOhad Ben-Cohen dev_err(dev, "rsc table is truncated\n"); 937fd2c15ecSOhad Ben-Cohen return -EINVAL; 938fd2c15ecSOhad Ben-Cohen } 939fd2c15ecSOhad Ben-Cohen 940fd2c15ecSOhad Ben-Cohen dev_dbg(dev, "rsc: type %d\n", hdr->type); 941fd2c15ecSOhad Ben-Cohen 942fd2c15ecSOhad Ben-Cohen if (hdr->type >= RSC_LAST) { 943fd2c15ecSOhad Ben-Cohen dev_warn(dev, "unsupported resource %d\n", hdr->type); 944e12bc14bSOhad Ben-Cohen continue; 945400e64dfSOhad Ben-Cohen } 946400e64dfSOhad Ben-Cohen 947232fcdbbSSjur Brændeland handler = handlers[hdr->type]; 948e12bc14bSOhad Ben-Cohen if (!handler) 949e12bc14bSOhad Ben-Cohen continue; 950e12bc14bSOhad Ben-Cohen 951a2b950acSOhad Ben-Cohen ret = handler(rproc, rsc, offset + sizeof(*hdr), avail); 9527a186941SOhad Ben-Cohen if (ret) 953400e64dfSOhad Ben-Cohen break; 954400e64dfSOhad Ben-Cohen } 955400e64dfSOhad Ben-Cohen 956400e64dfSOhad Ben-Cohen return ret; 957400e64dfSOhad Ben-Cohen } 958400e64dfSOhad Ben-Cohen 959c455daa4SBjorn Andersson static int rproc_prepare_subdevices(struct rproc *rproc) 960c455daa4SBjorn Andersson { 961c455daa4SBjorn Andersson struct rproc_subdev *subdev; 962c455daa4SBjorn Andersson int ret; 963c455daa4SBjorn Andersson 964c455daa4SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 965c455daa4SBjorn Andersson if (subdev->prepare) { 966c455daa4SBjorn Andersson ret = subdev->prepare(subdev); 967c455daa4SBjorn Andersson if (ret) 968c455daa4SBjorn Andersson goto unroll_preparation; 969c455daa4SBjorn Andersson } 970c455daa4SBjorn Andersson } 971c455daa4SBjorn Andersson 972c455daa4SBjorn Andersson return 0; 973c455daa4SBjorn Andersson 974c455daa4SBjorn Andersson unroll_preparation: 975c455daa4SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 976c455daa4SBjorn Andersson if (subdev->unprepare) 977c455daa4SBjorn Andersson subdev->unprepare(subdev); 978c455daa4SBjorn Andersson } 979c455daa4SBjorn Andersson 980c455daa4SBjorn Andersson return ret; 981c455daa4SBjorn Andersson } 982c455daa4SBjorn Andersson 983618fcff3SBjorn Andersson static int rproc_start_subdevices(struct rproc *rproc) 9847bdc9650SBjorn Andersson { 9857bdc9650SBjorn Andersson struct rproc_subdev *subdev; 9867bdc9650SBjorn Andersson int ret; 9877bdc9650SBjorn Andersson 9887bdc9650SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 989be37b1e0SBjorn Andersson if (subdev->start) { 990618fcff3SBjorn Andersson ret = subdev->start(subdev); 9917bdc9650SBjorn Andersson if (ret) 9927bdc9650SBjorn Andersson goto unroll_registration; 9937bdc9650SBjorn Andersson } 994be37b1e0SBjorn Andersson } 9957bdc9650SBjorn Andersson 9967bdc9650SBjorn Andersson return 0; 9977bdc9650SBjorn Andersson 9987bdc9650SBjorn Andersson unroll_registration: 999be37b1e0SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 1000be37b1e0SBjorn Andersson if (subdev->stop) 1001618fcff3SBjorn Andersson subdev->stop(subdev, true); 1002be37b1e0SBjorn Andersson } 10037bdc9650SBjorn Andersson 10047bdc9650SBjorn Andersson return ret; 10057bdc9650SBjorn Andersson } 10067bdc9650SBjorn Andersson 1007618fcff3SBjorn Andersson static void rproc_stop_subdevices(struct rproc *rproc, bool crashed) 10087bdc9650SBjorn Andersson { 10097bdc9650SBjorn Andersson struct rproc_subdev *subdev; 10107bdc9650SBjorn Andersson 1011be37b1e0SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 1012be37b1e0SBjorn Andersson if (subdev->stop) 1013618fcff3SBjorn Andersson subdev->stop(subdev, crashed); 10147bdc9650SBjorn Andersson } 1015be37b1e0SBjorn Andersson } 10167bdc9650SBjorn Andersson 1017c455daa4SBjorn Andersson static void rproc_unprepare_subdevices(struct rproc *rproc) 1018c455daa4SBjorn Andersson { 1019c455daa4SBjorn Andersson struct rproc_subdev *subdev; 1020c455daa4SBjorn Andersson 1021c455daa4SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 1022c455daa4SBjorn Andersson if (subdev->unprepare) 1023c455daa4SBjorn Andersson subdev->unprepare(subdev); 1024c455daa4SBjorn Andersson } 1025c455daa4SBjorn Andersson } 1026c455daa4SBjorn Andersson 1027400e64dfSOhad Ben-Cohen /** 1028d7c51706SLoic Pallardy * rproc_alloc_registered_carveouts() - allocate all carveouts registered 1029d7c51706SLoic Pallardy * in the list 1030d7c51706SLoic Pallardy * @rproc: the remote processor handle 1031d7c51706SLoic Pallardy * 1032d7c51706SLoic Pallardy * This function parses registered carveout list, performs allocation 1033d7c51706SLoic Pallardy * if alloc() ops registered and updates resource table information 1034d7c51706SLoic Pallardy * if rsc_offset set. 1035d7c51706SLoic Pallardy * 1036d7c51706SLoic Pallardy * Return: 0 on success 1037d7c51706SLoic Pallardy */ 1038d7c51706SLoic Pallardy static int rproc_alloc_registered_carveouts(struct rproc *rproc) 1039d7c51706SLoic Pallardy { 1040d7c51706SLoic Pallardy struct rproc_mem_entry *entry, *tmp; 1041d7c51706SLoic Pallardy struct fw_rsc_carveout *rsc; 1042d7c51706SLoic Pallardy struct device *dev = &rproc->dev; 1043d7c51706SLoic Pallardy int ret; 1044d7c51706SLoic Pallardy 1045d7c51706SLoic Pallardy list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 1046d7c51706SLoic Pallardy if (entry->alloc) { 1047d7c51706SLoic Pallardy ret = entry->alloc(rproc, entry); 1048d7c51706SLoic Pallardy if (ret) { 1049d7c51706SLoic Pallardy dev_err(dev, "Unable to allocate carveout %s: %d\n", 1050d7c51706SLoic Pallardy entry->name, ret); 1051d7c51706SLoic Pallardy return -ENOMEM; 1052d7c51706SLoic Pallardy } 1053d7c51706SLoic Pallardy } 1054d7c51706SLoic Pallardy 1055d7c51706SLoic Pallardy if (entry->rsc_offset != FW_RSC_ADDR_ANY) { 1056d7c51706SLoic Pallardy /* update resource table */ 1057d7c51706SLoic Pallardy rsc = (void *)rproc->table_ptr + entry->rsc_offset; 1058d7c51706SLoic Pallardy 1059d7c51706SLoic Pallardy /* 1060d7c51706SLoic Pallardy * Some remote processors might need to know the pa 1061d7c51706SLoic Pallardy * even though they are behind an IOMMU. E.g., OMAP4's 1062d7c51706SLoic Pallardy * remote M3 processor needs this so it can control 1063d7c51706SLoic Pallardy * on-chip hardware accelerators that are not behind 1064d7c51706SLoic Pallardy * the IOMMU, and therefor must know the pa. 1065d7c51706SLoic Pallardy * 1066d7c51706SLoic Pallardy * Generally we don't want to expose physical addresses 1067d7c51706SLoic Pallardy * if we don't have to (remote processors are generally 1068d7c51706SLoic Pallardy * _not_ trusted), so we might want to do this only for 1069d7c51706SLoic Pallardy * remote processor that _must_ have this (e.g. OMAP4's 1070d7c51706SLoic Pallardy * dual M3 subsystem). 1071d7c51706SLoic Pallardy * 1072d7c51706SLoic Pallardy * Non-IOMMU processors might also want to have this info. 1073d7c51706SLoic Pallardy * In this case, the device address and the physical address 1074d7c51706SLoic Pallardy * are the same. 1075d7c51706SLoic Pallardy */ 1076d7c51706SLoic Pallardy if (entry->va) 1077d7c51706SLoic Pallardy rsc->pa = (u32)rproc_va_to_pa(entry->va); 1078d7c51706SLoic Pallardy } 1079d7c51706SLoic Pallardy } 1080d7c51706SLoic Pallardy 1081d7c51706SLoic Pallardy return 0; 1082d7c51706SLoic Pallardy } 1083d7c51706SLoic Pallardy 1084d7c51706SLoic Pallardy /** 10852666ca91SSarangdhar Joshi * rproc_coredump_cleanup() - clean up dump_segments list 10862666ca91SSarangdhar Joshi * @rproc: the remote processor handle 10872666ca91SSarangdhar Joshi */ 10882666ca91SSarangdhar Joshi static void rproc_coredump_cleanup(struct rproc *rproc) 10892666ca91SSarangdhar Joshi { 10902666ca91SSarangdhar Joshi struct rproc_dump_segment *entry, *tmp; 10912666ca91SSarangdhar Joshi 10922666ca91SSarangdhar Joshi list_for_each_entry_safe(entry, tmp, &rproc->dump_segments, node) { 10932666ca91SSarangdhar Joshi list_del(&entry->node); 10942666ca91SSarangdhar Joshi kfree(entry); 10952666ca91SSarangdhar Joshi } 10962666ca91SSarangdhar Joshi } 10972666ca91SSarangdhar Joshi 10982666ca91SSarangdhar Joshi /** 1099400e64dfSOhad Ben-Cohen * rproc_resource_cleanup() - clean up and free all acquired resources 1100400e64dfSOhad Ben-Cohen * @rproc: rproc handle 1101400e64dfSOhad Ben-Cohen * 1102400e64dfSOhad Ben-Cohen * This function will free all resources acquired for @rproc, and it 11037a186941SOhad Ben-Cohen * is called whenever @rproc either shuts down or fails to boot. 1104400e64dfSOhad Ben-Cohen */ 1105400e64dfSOhad Ben-Cohen static void rproc_resource_cleanup(struct rproc *rproc) 1106400e64dfSOhad Ben-Cohen { 1107400e64dfSOhad Ben-Cohen struct rproc_mem_entry *entry, *tmp; 1108d81fb32fSBjorn Andersson struct rproc_vdev *rvdev, *rvtmp; 1109b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1110400e64dfSOhad Ben-Cohen 1111400e64dfSOhad Ben-Cohen /* clean up debugfs trace entries */ 1112400e64dfSOhad Ben-Cohen list_for_each_entry_safe(entry, tmp, &rproc->traces, node) { 1113400e64dfSOhad Ben-Cohen rproc_remove_trace_file(entry->priv); 1114400e64dfSOhad Ben-Cohen rproc->num_traces--; 1115400e64dfSOhad Ben-Cohen list_del(&entry->node); 1116400e64dfSOhad Ben-Cohen kfree(entry); 1117400e64dfSOhad Ben-Cohen } 1118400e64dfSOhad Ben-Cohen 1119400e64dfSOhad Ben-Cohen /* clean up iommu mapping entries */ 1120400e64dfSOhad Ben-Cohen list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) { 1121400e64dfSOhad Ben-Cohen size_t unmapped; 1122400e64dfSOhad Ben-Cohen 1123400e64dfSOhad Ben-Cohen unmapped = iommu_unmap(rproc->domain, entry->da, entry->len); 1124400e64dfSOhad Ben-Cohen if (unmapped != entry->len) { 1125400e64dfSOhad Ben-Cohen /* nothing much to do besides complaining */ 1126e981f6d4SSjur Brændeland dev_err(dev, "failed to unmap %u/%zu\n", entry->len, 1127400e64dfSOhad Ben-Cohen unmapped); 1128400e64dfSOhad Ben-Cohen } 1129400e64dfSOhad Ben-Cohen 1130400e64dfSOhad Ben-Cohen list_del(&entry->node); 1131400e64dfSOhad Ben-Cohen kfree(entry); 1132400e64dfSOhad Ben-Cohen } 1133b6356a01SSuman Anna 1134b6356a01SSuman Anna /* clean up carveout allocations */ 1135b6356a01SSuman Anna list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 1136f2e74abfSLoic Pallardy if (entry->release) 1137f2e74abfSLoic Pallardy entry->release(rproc, entry); 1138b6356a01SSuman Anna list_del(&entry->node); 1139b6356a01SSuman Anna kfree(entry); 1140b6356a01SSuman Anna } 1141d81fb32fSBjorn Andersson 1142d81fb32fSBjorn Andersson /* clean up remote vdev entries */ 1143f5bcb353SBjorn Andersson list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node) 11442b45cef5SBjorn Andersson kref_put(&rvdev->refcount, rproc_vdev_release); 11452666ca91SSarangdhar Joshi 11462666ca91SSarangdhar Joshi rproc_coredump_cleanup(rproc); 11472b45cef5SBjorn Andersson } 1148400e64dfSOhad Ben-Cohen 11491efa30d0SSarangdhar Joshi static int rproc_start(struct rproc *rproc, const struct firmware *fw) 11501efa30d0SSarangdhar Joshi { 1151a4b24c75SBjorn Andersson struct resource_table *loaded_table; 11521efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 1153a4b24c75SBjorn Andersson int ret; 11541efa30d0SSarangdhar Joshi 11551efa30d0SSarangdhar Joshi /* load the ELF segments to memory */ 11561efa30d0SSarangdhar Joshi ret = rproc_load_segments(rproc, fw); 11571efa30d0SSarangdhar Joshi if (ret) { 11581efa30d0SSarangdhar Joshi dev_err(dev, "Failed to load program segments: %d\n", ret); 11591efa30d0SSarangdhar Joshi return ret; 11601efa30d0SSarangdhar Joshi } 11611efa30d0SSarangdhar Joshi 11621efa30d0SSarangdhar Joshi /* 11631efa30d0SSarangdhar Joshi * The starting device has been given the rproc->cached_table as the 11641efa30d0SSarangdhar Joshi * resource table. The address of the vring along with the other 11651efa30d0SSarangdhar Joshi * allocated resources (carveouts etc) is stored in cached_table. 11661efa30d0SSarangdhar Joshi * In order to pass this information to the remote device we must copy 11671efa30d0SSarangdhar Joshi * this information to device memory. We also update the table_ptr so 11681efa30d0SSarangdhar Joshi * that any subsequent changes will be applied to the loaded version. 11691efa30d0SSarangdhar Joshi */ 11701efa30d0SSarangdhar Joshi loaded_table = rproc_find_loaded_rsc_table(rproc, fw); 11711efa30d0SSarangdhar Joshi if (loaded_table) { 1172a4b24c75SBjorn Andersson memcpy(loaded_table, rproc->cached_table, rproc->table_sz); 11731efa30d0SSarangdhar Joshi rproc->table_ptr = loaded_table; 11741efa30d0SSarangdhar Joshi } 11751efa30d0SSarangdhar Joshi 1176c455daa4SBjorn Andersson ret = rproc_prepare_subdevices(rproc); 1177c455daa4SBjorn Andersson if (ret) { 1178c455daa4SBjorn Andersson dev_err(dev, "failed to prepare subdevices for %s: %d\n", 1179c455daa4SBjorn Andersson rproc->name, ret); 1180f68d51bdSSuman Anna goto reset_table_ptr; 1181c455daa4SBjorn Andersson } 1182c455daa4SBjorn Andersson 11831efa30d0SSarangdhar Joshi /* power up the remote processor */ 11841efa30d0SSarangdhar Joshi ret = rproc->ops->start(rproc); 11851efa30d0SSarangdhar Joshi if (ret) { 11861efa30d0SSarangdhar Joshi dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret); 1187c455daa4SBjorn Andersson goto unprepare_subdevices; 11881efa30d0SSarangdhar Joshi } 11891efa30d0SSarangdhar Joshi 1190618fcff3SBjorn Andersson /* Start any subdevices for the remote processor */ 1191618fcff3SBjorn Andersson ret = rproc_start_subdevices(rproc); 11921efa30d0SSarangdhar Joshi if (ret) { 11931efa30d0SSarangdhar Joshi dev_err(dev, "failed to probe subdevices for %s: %d\n", 11941efa30d0SSarangdhar Joshi rproc->name, ret); 1195c455daa4SBjorn Andersson goto stop_rproc; 11961efa30d0SSarangdhar Joshi } 11971efa30d0SSarangdhar Joshi 11981efa30d0SSarangdhar Joshi rproc->state = RPROC_RUNNING; 11991efa30d0SSarangdhar Joshi 12001efa30d0SSarangdhar Joshi dev_info(dev, "remote processor %s is now up\n", rproc->name); 12011efa30d0SSarangdhar Joshi 12021efa30d0SSarangdhar Joshi return 0; 1203c455daa4SBjorn Andersson 1204c455daa4SBjorn Andersson stop_rproc: 1205c455daa4SBjorn Andersson rproc->ops->stop(rproc); 1206c455daa4SBjorn Andersson unprepare_subdevices: 1207c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1208f68d51bdSSuman Anna reset_table_ptr: 1209f68d51bdSSuman Anna rproc->table_ptr = rproc->cached_table; 1210c455daa4SBjorn Andersson 1211c455daa4SBjorn Andersson return ret; 12121efa30d0SSarangdhar Joshi } 12131efa30d0SSarangdhar Joshi 1214400e64dfSOhad Ben-Cohen /* 1215400e64dfSOhad Ben-Cohen * take a firmware and boot a remote processor with it. 1216400e64dfSOhad Ben-Cohen */ 1217400e64dfSOhad Ben-Cohen static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw) 1218400e64dfSOhad Ben-Cohen { 1219b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1220400e64dfSOhad Ben-Cohen const char *name = rproc->firmware; 122158b64090SBjorn Andersson int ret; 1222400e64dfSOhad Ben-Cohen 1223400e64dfSOhad Ben-Cohen ret = rproc_fw_sanity_check(rproc, fw); 1224400e64dfSOhad Ben-Cohen if (ret) 1225400e64dfSOhad Ben-Cohen return ret; 1226400e64dfSOhad Ben-Cohen 1227e981f6d4SSjur Brændeland dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size); 1228400e64dfSOhad Ben-Cohen 1229400e64dfSOhad Ben-Cohen /* 1230400e64dfSOhad Ben-Cohen * if enabling an IOMMU isn't relevant for this rproc, this is 1231400e64dfSOhad Ben-Cohen * just a nop 1232400e64dfSOhad Ben-Cohen */ 1233400e64dfSOhad Ben-Cohen ret = rproc_enable_iommu(rproc); 1234400e64dfSOhad Ben-Cohen if (ret) { 1235400e64dfSOhad Ben-Cohen dev_err(dev, "can't enable iommu: %d\n", ret); 1236400e64dfSOhad Ben-Cohen return ret; 1237400e64dfSOhad Ben-Cohen } 1238400e64dfSOhad Ben-Cohen 12393e5f9eb5SSjur Brændeland rproc->bootaddr = rproc_get_boot_addr(rproc, fw); 1240400e64dfSOhad Ben-Cohen 1241c1d35c1aSBjorn Andersson /* Load resource table, core dump segment list etc from the firmware */ 1242c1d35c1aSBjorn Andersson ret = rproc_parse_fw(rproc, fw); 124358b64090SBjorn Andersson if (ret) 124458b64090SBjorn Andersson goto disable_iommu; 1245a0c10687SBjorn Andersson 1246b35d7afcSBjorn Andersson /* reset max_notifyid */ 1247b35d7afcSBjorn Andersson rproc->max_notifyid = -1; 1248b35d7afcSBjorn Andersson 1249400e64dfSOhad Ben-Cohen /* handle fw resources which are required to boot rproc */ 1250a4b24c75SBjorn Andersson ret = rproc_handle_resources(rproc, rproc_loading_handlers); 1251400e64dfSOhad Ben-Cohen if (ret) { 1252400e64dfSOhad Ben-Cohen dev_err(dev, "Failed to process resources: %d\n", ret); 1253229b85a6SBjorn Andersson goto clean_up_resources; 1254400e64dfSOhad Ben-Cohen } 1255400e64dfSOhad Ben-Cohen 1256d7c51706SLoic Pallardy /* Allocate carveout resources associated to rproc */ 1257d7c51706SLoic Pallardy ret = rproc_alloc_registered_carveouts(rproc); 1258d7c51706SLoic Pallardy if (ret) { 1259d7c51706SLoic Pallardy dev_err(dev, "Failed to allocate associated carveouts: %d\n", 1260d7c51706SLoic Pallardy ret); 1261d7c51706SLoic Pallardy goto clean_up_resources; 1262d7c51706SLoic Pallardy } 1263d7c51706SLoic Pallardy 12641efa30d0SSarangdhar Joshi ret = rproc_start(rproc, fw); 12651efa30d0SSarangdhar Joshi if (ret) 1266229b85a6SBjorn Andersson goto clean_up_resources; 1267400e64dfSOhad Ben-Cohen 1268400e64dfSOhad Ben-Cohen return 0; 1269400e64dfSOhad Ben-Cohen 1270229b85a6SBjorn Andersson clean_up_resources: 1271229b85a6SBjorn Andersson rproc_resource_cleanup(rproc); 1272a0c10687SBjorn Andersson kfree(rproc->cached_table); 1273a0c10687SBjorn Andersson rproc->cached_table = NULL; 1274988d204cSBjorn Andersson rproc->table_ptr = NULL; 127558b64090SBjorn Andersson disable_iommu: 1276400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 1277400e64dfSOhad Ben-Cohen return ret; 1278400e64dfSOhad Ben-Cohen } 1279400e64dfSOhad Ben-Cohen 1280400e64dfSOhad Ben-Cohen /* 12815e6533f7SSarangdhar Joshi * take a firmware and boot it up. 1282400e64dfSOhad Ben-Cohen * 1283400e64dfSOhad Ben-Cohen * Note: this function is called asynchronously upon registration of the 1284400e64dfSOhad Ben-Cohen * remote processor (so we must wait until it completes before we try 1285400e64dfSOhad Ben-Cohen * to unregister the device. one other option is just to use kref here, 1286400e64dfSOhad Ben-Cohen * that might be cleaner). 1287400e64dfSOhad Ben-Cohen */ 12885e6533f7SSarangdhar Joshi static void rproc_auto_boot_callback(const struct firmware *fw, void *context) 1289400e64dfSOhad Ben-Cohen { 1290400e64dfSOhad Ben-Cohen struct rproc *rproc = context; 1291a2b950acSOhad Ben-Cohen 12922bfc311aSBjorn Andersson rproc_boot(rproc); 1293ddf71187SBjorn Andersson 1294400e64dfSOhad Ben-Cohen release_firmware(fw); 1295400e64dfSOhad Ben-Cohen } 1296400e64dfSOhad Ben-Cohen 12975e6533f7SSarangdhar Joshi static int rproc_trigger_auto_boot(struct rproc *rproc) 129870b85ef8SFernando Guzman Lugo { 129970b85ef8SFernando Guzman Lugo int ret; 130070b85ef8SFernando Guzman Lugo 130170b85ef8SFernando Guzman Lugo /* 130270b85ef8SFernando Guzman Lugo * We're initiating an asynchronous firmware loading, so we can 130370b85ef8SFernando Guzman Lugo * be built-in kernel code, without hanging the boot process. 130470b85ef8SFernando Guzman Lugo */ 130570b85ef8SFernando Guzman Lugo ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG, 130670b85ef8SFernando Guzman Lugo rproc->firmware, &rproc->dev, GFP_KERNEL, 13075e6533f7SSarangdhar Joshi rproc, rproc_auto_boot_callback); 13082099c77dSSarangdhar Joshi if (ret < 0) 130970b85ef8SFernando Guzman Lugo dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret); 131070b85ef8SFernando Guzman Lugo 131170b85ef8SFernando Guzman Lugo return ret; 131270b85ef8SFernando Guzman Lugo } 131370b85ef8SFernando Guzman Lugo 1314880f5b38SBjorn Andersson static int rproc_stop(struct rproc *rproc, bool crashed) 13151efa30d0SSarangdhar Joshi { 13161efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 13171efa30d0SSarangdhar Joshi int ret; 13181efa30d0SSarangdhar Joshi 1319618fcff3SBjorn Andersson /* Stop any subdevices for the remote processor */ 1320618fcff3SBjorn Andersson rproc_stop_subdevices(rproc, crashed); 13211efa30d0SSarangdhar Joshi 13220a8b81cbSBjorn Andersson /* the installed resource table is no longer accessible */ 13230a8b81cbSBjorn Andersson rproc->table_ptr = rproc->cached_table; 13240a8b81cbSBjorn Andersson 13251efa30d0SSarangdhar Joshi /* power off the remote processor */ 13261efa30d0SSarangdhar Joshi ret = rproc->ops->stop(rproc); 13271efa30d0SSarangdhar Joshi if (ret) { 13281efa30d0SSarangdhar Joshi dev_err(dev, "can't stop rproc: %d\n", ret); 13291efa30d0SSarangdhar Joshi return ret; 13301efa30d0SSarangdhar Joshi } 13311efa30d0SSarangdhar Joshi 1332c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1333c455daa4SBjorn Andersson 13341efa30d0SSarangdhar Joshi rproc->state = RPROC_OFFLINE; 13351efa30d0SSarangdhar Joshi 13361efa30d0SSarangdhar Joshi dev_info(dev, "stopped remote processor %s\n", rproc->name); 13371efa30d0SSarangdhar Joshi 13381efa30d0SSarangdhar Joshi return 0; 13391efa30d0SSarangdhar Joshi } 13401efa30d0SSarangdhar Joshi 134170b85ef8SFernando Guzman Lugo /** 13422666ca91SSarangdhar Joshi * rproc_coredump_add_segment() - add segment of device memory to coredump 13432666ca91SSarangdhar Joshi * @rproc: handle of a remote processor 13442666ca91SSarangdhar Joshi * @da: device address 13452666ca91SSarangdhar Joshi * @size: size of segment 13462666ca91SSarangdhar Joshi * 13472666ca91SSarangdhar Joshi * Add device memory to the list of segments to be included in a coredump for 13482666ca91SSarangdhar Joshi * the remoteproc. 13492666ca91SSarangdhar Joshi * 13502666ca91SSarangdhar Joshi * Return: 0 on success, negative errno on error. 13512666ca91SSarangdhar Joshi */ 13522666ca91SSarangdhar Joshi int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size) 13532666ca91SSarangdhar Joshi { 13542666ca91SSarangdhar Joshi struct rproc_dump_segment *segment; 13552666ca91SSarangdhar Joshi 13562666ca91SSarangdhar Joshi segment = kzalloc(sizeof(*segment), GFP_KERNEL); 13572666ca91SSarangdhar Joshi if (!segment) 13582666ca91SSarangdhar Joshi return -ENOMEM; 13592666ca91SSarangdhar Joshi 13602666ca91SSarangdhar Joshi segment->da = da; 13612666ca91SSarangdhar Joshi segment->size = size; 13622666ca91SSarangdhar Joshi 13632666ca91SSarangdhar Joshi list_add_tail(&segment->node, &rproc->dump_segments); 13642666ca91SSarangdhar Joshi 13652666ca91SSarangdhar Joshi return 0; 13662666ca91SSarangdhar Joshi } 13672666ca91SSarangdhar Joshi EXPORT_SYMBOL(rproc_coredump_add_segment); 13682666ca91SSarangdhar Joshi 13692666ca91SSarangdhar Joshi /** 13702666ca91SSarangdhar Joshi * rproc_coredump() - perform coredump 13712666ca91SSarangdhar Joshi * @rproc: rproc handle 13722666ca91SSarangdhar Joshi * 13732666ca91SSarangdhar Joshi * This function will generate an ELF header for the registered segments 13742666ca91SSarangdhar Joshi * and create a devcoredump device associated with rproc. 13752666ca91SSarangdhar Joshi */ 13762666ca91SSarangdhar Joshi static void rproc_coredump(struct rproc *rproc) 13772666ca91SSarangdhar Joshi { 13782666ca91SSarangdhar Joshi struct rproc_dump_segment *segment; 13792666ca91SSarangdhar Joshi struct elf32_phdr *phdr; 13802666ca91SSarangdhar Joshi struct elf32_hdr *ehdr; 13812666ca91SSarangdhar Joshi size_t data_size; 13822666ca91SSarangdhar Joshi size_t offset; 13832666ca91SSarangdhar Joshi void *data; 13842666ca91SSarangdhar Joshi void *ptr; 13852666ca91SSarangdhar Joshi int phnum = 0; 13862666ca91SSarangdhar Joshi 13872666ca91SSarangdhar Joshi if (list_empty(&rproc->dump_segments)) 13882666ca91SSarangdhar Joshi return; 13892666ca91SSarangdhar Joshi 13902666ca91SSarangdhar Joshi data_size = sizeof(*ehdr); 13912666ca91SSarangdhar Joshi list_for_each_entry(segment, &rproc->dump_segments, node) { 13922666ca91SSarangdhar Joshi data_size += sizeof(*phdr) + segment->size; 13932666ca91SSarangdhar Joshi 13942666ca91SSarangdhar Joshi phnum++; 13952666ca91SSarangdhar Joshi } 13962666ca91SSarangdhar Joshi 13972666ca91SSarangdhar Joshi data = vmalloc(data_size); 13982666ca91SSarangdhar Joshi if (!data) 13992666ca91SSarangdhar Joshi return; 14002666ca91SSarangdhar Joshi 14012666ca91SSarangdhar Joshi ehdr = data; 14022666ca91SSarangdhar Joshi 14032666ca91SSarangdhar Joshi memset(ehdr, 0, sizeof(*ehdr)); 14042666ca91SSarangdhar Joshi memcpy(ehdr->e_ident, ELFMAG, SELFMAG); 14052666ca91SSarangdhar Joshi ehdr->e_ident[EI_CLASS] = ELFCLASS32; 14062666ca91SSarangdhar Joshi ehdr->e_ident[EI_DATA] = ELFDATA2LSB; 14072666ca91SSarangdhar Joshi ehdr->e_ident[EI_VERSION] = EV_CURRENT; 14082666ca91SSarangdhar Joshi ehdr->e_ident[EI_OSABI] = ELFOSABI_NONE; 14092666ca91SSarangdhar Joshi ehdr->e_type = ET_CORE; 14102666ca91SSarangdhar Joshi ehdr->e_machine = EM_NONE; 14112666ca91SSarangdhar Joshi ehdr->e_version = EV_CURRENT; 14122666ca91SSarangdhar Joshi ehdr->e_entry = rproc->bootaddr; 14132666ca91SSarangdhar Joshi ehdr->e_phoff = sizeof(*ehdr); 14142666ca91SSarangdhar Joshi ehdr->e_ehsize = sizeof(*ehdr); 14152666ca91SSarangdhar Joshi ehdr->e_phentsize = sizeof(*phdr); 14162666ca91SSarangdhar Joshi ehdr->e_phnum = phnum; 14172666ca91SSarangdhar Joshi 14182666ca91SSarangdhar Joshi phdr = data + ehdr->e_phoff; 14192666ca91SSarangdhar Joshi offset = ehdr->e_phoff + sizeof(*phdr) * ehdr->e_phnum; 14202666ca91SSarangdhar Joshi list_for_each_entry(segment, &rproc->dump_segments, node) { 14212666ca91SSarangdhar Joshi memset(phdr, 0, sizeof(*phdr)); 14222666ca91SSarangdhar Joshi phdr->p_type = PT_LOAD; 14232666ca91SSarangdhar Joshi phdr->p_offset = offset; 14242666ca91SSarangdhar Joshi phdr->p_vaddr = segment->da; 14252666ca91SSarangdhar Joshi phdr->p_paddr = segment->da; 14262666ca91SSarangdhar Joshi phdr->p_filesz = segment->size; 14272666ca91SSarangdhar Joshi phdr->p_memsz = segment->size; 14282666ca91SSarangdhar Joshi phdr->p_flags = PF_R | PF_W | PF_X; 14292666ca91SSarangdhar Joshi phdr->p_align = 0; 14302666ca91SSarangdhar Joshi 14312666ca91SSarangdhar Joshi ptr = rproc_da_to_va(rproc, segment->da, segment->size); 14322666ca91SSarangdhar Joshi if (!ptr) { 14332666ca91SSarangdhar Joshi dev_err(&rproc->dev, 14342666ca91SSarangdhar Joshi "invalid coredump segment (%pad, %zu)\n", 14352666ca91SSarangdhar Joshi &segment->da, segment->size); 14362666ca91SSarangdhar Joshi memset(data + offset, 0xff, segment->size); 14372666ca91SSarangdhar Joshi } else { 14382666ca91SSarangdhar Joshi memcpy(data + offset, ptr, segment->size); 14392666ca91SSarangdhar Joshi } 14402666ca91SSarangdhar Joshi 14412666ca91SSarangdhar Joshi offset += phdr->p_filesz; 14422666ca91SSarangdhar Joshi phdr++; 14432666ca91SSarangdhar Joshi } 14442666ca91SSarangdhar Joshi 14452666ca91SSarangdhar Joshi dev_coredumpv(&rproc->dev, data, data_size, GFP_KERNEL); 14462666ca91SSarangdhar Joshi } 14472666ca91SSarangdhar Joshi 14482666ca91SSarangdhar Joshi /** 144970b85ef8SFernando Guzman Lugo * rproc_trigger_recovery() - recover a remoteproc 145070b85ef8SFernando Guzman Lugo * @rproc: the remote processor 145170b85ef8SFernando Guzman Lugo * 145256324d7aSAnna, Suman * The recovery is done by resetting all the virtio devices, that way all the 145370b85ef8SFernando Guzman Lugo * rpmsg drivers will be reseted along with the remote processor making the 145470b85ef8SFernando Guzman Lugo * remoteproc functional again. 145570b85ef8SFernando Guzman Lugo * 145670b85ef8SFernando Guzman Lugo * This function can sleep, so it cannot be called from atomic context. 145770b85ef8SFernando Guzman Lugo */ 145870b85ef8SFernando Guzman Lugo int rproc_trigger_recovery(struct rproc *rproc) 145970b85ef8SFernando Guzman Lugo { 14607e83cab8SSarangdhar Joshi const struct firmware *firmware_p; 14617e83cab8SSarangdhar Joshi struct device *dev = &rproc->dev; 14627e83cab8SSarangdhar Joshi int ret; 14637e83cab8SSarangdhar Joshi 14647e83cab8SSarangdhar Joshi dev_err(dev, "recovering %s\n", rproc->name); 146570b85ef8SFernando Guzman Lugo 14667e83cab8SSarangdhar Joshi ret = mutex_lock_interruptible(&rproc->lock); 14677e83cab8SSarangdhar Joshi if (ret) 14687e83cab8SSarangdhar Joshi return ret; 14697e83cab8SSarangdhar Joshi 1470fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, true); 14717e83cab8SSarangdhar Joshi if (ret) 14727e83cab8SSarangdhar Joshi goto unlock_mutex; 1473ddf71187SBjorn Andersson 14742666ca91SSarangdhar Joshi /* generate coredump */ 14752666ca91SSarangdhar Joshi rproc_coredump(rproc); 14762666ca91SSarangdhar Joshi 14777e83cab8SSarangdhar Joshi /* load firmware */ 14787e83cab8SSarangdhar Joshi ret = request_firmware(&firmware_p, rproc->firmware, dev); 14797e83cab8SSarangdhar Joshi if (ret < 0) { 14807e83cab8SSarangdhar Joshi dev_err(dev, "request_firmware failed: %d\n", ret); 14817e83cab8SSarangdhar Joshi goto unlock_mutex; 14827e83cab8SSarangdhar Joshi } 1483ddf71187SBjorn Andersson 14847e83cab8SSarangdhar Joshi /* boot the remote processor up again */ 14857e83cab8SSarangdhar Joshi ret = rproc_start(rproc, firmware_p); 14867e83cab8SSarangdhar Joshi 14877e83cab8SSarangdhar Joshi release_firmware(firmware_p); 14887e83cab8SSarangdhar Joshi 14897e83cab8SSarangdhar Joshi unlock_mutex: 14907e83cab8SSarangdhar Joshi mutex_unlock(&rproc->lock); 14917e83cab8SSarangdhar Joshi return ret; 149270b85ef8SFernando Guzman Lugo } 149370b85ef8SFernando Guzman Lugo 1494400e64dfSOhad Ben-Cohen /** 14958afd519cSFernando Guzman Lugo * rproc_crash_handler_work() - handle a crash 14968afd519cSFernando Guzman Lugo * 14978afd519cSFernando Guzman Lugo * This function needs to handle everything related to a crash, like cpu 14988afd519cSFernando Guzman Lugo * registers and stack dump, information to help to debug the fatal error, etc. 14998afd519cSFernando Guzman Lugo */ 15008afd519cSFernando Guzman Lugo static void rproc_crash_handler_work(struct work_struct *work) 15018afd519cSFernando Guzman Lugo { 15028afd519cSFernando Guzman Lugo struct rproc *rproc = container_of(work, struct rproc, crash_handler); 15038afd519cSFernando Guzman Lugo struct device *dev = &rproc->dev; 15048afd519cSFernando Guzman Lugo 15058afd519cSFernando Guzman Lugo dev_dbg(dev, "enter %s\n", __func__); 15068afd519cSFernando Guzman Lugo 15078afd519cSFernando Guzman Lugo mutex_lock(&rproc->lock); 15088afd519cSFernando Guzman Lugo 15098afd519cSFernando Guzman Lugo if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) { 15108afd519cSFernando Guzman Lugo /* handle only the first crash detected */ 15118afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 15128afd519cSFernando Guzman Lugo return; 15138afd519cSFernando Guzman Lugo } 15148afd519cSFernando Guzman Lugo 15158afd519cSFernando Guzman Lugo rproc->state = RPROC_CRASHED; 15168afd519cSFernando Guzman Lugo dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt, 15178afd519cSFernando Guzman Lugo rproc->name); 15188afd519cSFernando Guzman Lugo 15198afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 15208afd519cSFernando Guzman Lugo 15212e37abb8SFernando Guzman Lugo if (!rproc->recovery_disabled) 152270b85ef8SFernando Guzman Lugo rproc_trigger_recovery(rproc); 15238afd519cSFernando Guzman Lugo } 15248afd519cSFernando Guzman Lugo 15258afd519cSFernando Guzman Lugo /** 15261b0ef906SSuman Anna * rproc_boot() - boot a remote processor 1527400e64dfSOhad Ben-Cohen * @rproc: handle of a remote processor 1528400e64dfSOhad Ben-Cohen * 1529400e64dfSOhad Ben-Cohen * Boot a remote processor (i.e. load its firmware, power it on, ...). 1530400e64dfSOhad Ben-Cohen * 1531400e64dfSOhad Ben-Cohen * If the remote processor is already powered on, this function immediately 1532400e64dfSOhad Ben-Cohen * returns (successfully). 1533400e64dfSOhad Ben-Cohen * 1534400e64dfSOhad Ben-Cohen * Returns 0 on success, and an appropriate error value otherwise. 1535400e64dfSOhad Ben-Cohen */ 15361b0ef906SSuman Anna int rproc_boot(struct rproc *rproc) 1537400e64dfSOhad Ben-Cohen { 1538400e64dfSOhad Ben-Cohen const struct firmware *firmware_p; 1539400e64dfSOhad Ben-Cohen struct device *dev; 1540400e64dfSOhad Ben-Cohen int ret; 1541400e64dfSOhad Ben-Cohen 1542400e64dfSOhad Ben-Cohen if (!rproc) { 1543400e64dfSOhad Ben-Cohen pr_err("invalid rproc handle\n"); 1544400e64dfSOhad Ben-Cohen return -EINVAL; 1545400e64dfSOhad Ben-Cohen } 1546400e64dfSOhad Ben-Cohen 1547b5ab5e24SOhad Ben-Cohen dev = &rproc->dev; 1548400e64dfSOhad Ben-Cohen 1549400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1550400e64dfSOhad Ben-Cohen if (ret) { 1551400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1552400e64dfSOhad Ben-Cohen return ret; 1553400e64dfSOhad Ben-Cohen } 1554400e64dfSOhad Ben-Cohen 15552099c77dSSarangdhar Joshi if (rproc->state == RPROC_DELETED) { 15562099c77dSSarangdhar Joshi ret = -ENODEV; 15572099c77dSSarangdhar Joshi dev_err(dev, "can't boot deleted rproc %s\n", rproc->name); 15582099c77dSSarangdhar Joshi goto unlock_mutex; 15592099c77dSSarangdhar Joshi } 15602099c77dSSarangdhar Joshi 1561400e64dfSOhad Ben-Cohen /* skip the boot process if rproc is already powered up */ 1562400e64dfSOhad Ben-Cohen if (atomic_inc_return(&rproc->power) > 1) { 1563400e64dfSOhad Ben-Cohen ret = 0; 1564400e64dfSOhad Ben-Cohen goto unlock_mutex; 1565400e64dfSOhad Ben-Cohen } 1566400e64dfSOhad Ben-Cohen 1567400e64dfSOhad Ben-Cohen dev_info(dev, "powering up %s\n", rproc->name); 1568400e64dfSOhad Ben-Cohen 1569400e64dfSOhad Ben-Cohen /* load firmware */ 1570400e64dfSOhad Ben-Cohen ret = request_firmware(&firmware_p, rproc->firmware, dev); 1571400e64dfSOhad Ben-Cohen if (ret < 0) { 1572400e64dfSOhad Ben-Cohen dev_err(dev, "request_firmware failed: %d\n", ret); 1573400e64dfSOhad Ben-Cohen goto downref_rproc; 1574400e64dfSOhad Ben-Cohen } 1575400e64dfSOhad Ben-Cohen 1576400e64dfSOhad Ben-Cohen ret = rproc_fw_boot(rproc, firmware_p); 1577400e64dfSOhad Ben-Cohen 1578400e64dfSOhad Ben-Cohen release_firmware(firmware_p); 1579400e64dfSOhad Ben-Cohen 1580400e64dfSOhad Ben-Cohen downref_rproc: 1581fbb6aacbSBjorn Andersson if (ret) 1582400e64dfSOhad Ben-Cohen atomic_dec(&rproc->power); 1583400e64dfSOhad Ben-Cohen unlock_mutex: 1584400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 1585400e64dfSOhad Ben-Cohen return ret; 1586400e64dfSOhad Ben-Cohen } 1587400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_boot); 1588400e64dfSOhad Ben-Cohen 1589400e64dfSOhad Ben-Cohen /** 1590400e64dfSOhad Ben-Cohen * rproc_shutdown() - power off the remote processor 1591400e64dfSOhad Ben-Cohen * @rproc: the remote processor 1592400e64dfSOhad Ben-Cohen * 1593400e64dfSOhad Ben-Cohen * Power off a remote processor (previously booted with rproc_boot()). 1594400e64dfSOhad Ben-Cohen * 1595400e64dfSOhad Ben-Cohen * In case @rproc is still being used by an additional user(s), then 1596400e64dfSOhad Ben-Cohen * this function will just decrement the power refcount and exit, 1597400e64dfSOhad Ben-Cohen * without really powering off the device. 1598400e64dfSOhad Ben-Cohen * 1599400e64dfSOhad Ben-Cohen * Every call to rproc_boot() must (eventually) be accompanied by a call 1600400e64dfSOhad Ben-Cohen * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug. 1601400e64dfSOhad Ben-Cohen * 1602400e64dfSOhad Ben-Cohen * Notes: 1603400e64dfSOhad Ben-Cohen * - we're not decrementing the rproc's refcount, only the power refcount. 1604400e64dfSOhad Ben-Cohen * which means that the @rproc handle stays valid even after rproc_shutdown() 1605400e64dfSOhad Ben-Cohen * returns, and users can still use it with a subsequent rproc_boot(), if 1606400e64dfSOhad Ben-Cohen * needed. 1607400e64dfSOhad Ben-Cohen */ 1608400e64dfSOhad Ben-Cohen void rproc_shutdown(struct rproc *rproc) 1609400e64dfSOhad Ben-Cohen { 1610b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1611400e64dfSOhad Ben-Cohen int ret; 1612400e64dfSOhad Ben-Cohen 1613400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1614400e64dfSOhad Ben-Cohen if (ret) { 1615400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1616400e64dfSOhad Ben-Cohen return; 1617400e64dfSOhad Ben-Cohen } 1618400e64dfSOhad Ben-Cohen 1619400e64dfSOhad Ben-Cohen /* if the remote proc is still needed, bail out */ 1620400e64dfSOhad Ben-Cohen if (!atomic_dec_and_test(&rproc->power)) 1621400e64dfSOhad Ben-Cohen goto out; 1622400e64dfSOhad Ben-Cohen 1623fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, false); 1624400e64dfSOhad Ben-Cohen if (ret) { 1625400e64dfSOhad Ben-Cohen atomic_inc(&rproc->power); 1626400e64dfSOhad Ben-Cohen goto out; 1627400e64dfSOhad Ben-Cohen } 1628400e64dfSOhad Ben-Cohen 1629400e64dfSOhad Ben-Cohen /* clean up all acquired resources */ 1630400e64dfSOhad Ben-Cohen rproc_resource_cleanup(rproc); 1631400e64dfSOhad Ben-Cohen 1632400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 1633400e64dfSOhad Ben-Cohen 1634988d204cSBjorn Andersson /* Free the copy of the resource table */ 1635a0c10687SBjorn Andersson kfree(rproc->cached_table); 1636a0c10687SBjorn Andersson rproc->cached_table = NULL; 1637988d204cSBjorn Andersson rproc->table_ptr = NULL; 1638400e64dfSOhad Ben-Cohen out: 1639400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 1640400e64dfSOhad Ben-Cohen } 1641400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_shutdown); 1642400e64dfSOhad Ben-Cohen 1643400e64dfSOhad Ben-Cohen /** 1644fec47d86SDave Gerlach * rproc_get_by_phandle() - find a remote processor by phandle 1645fec47d86SDave Gerlach * @phandle: phandle to the rproc 1646fec47d86SDave Gerlach * 1647fec47d86SDave Gerlach * Finds an rproc handle using the remote processor's phandle, and then 1648fec47d86SDave Gerlach * return a handle to the rproc. 1649fec47d86SDave Gerlach * 1650fec47d86SDave Gerlach * This function increments the remote processor's refcount, so always 1651fec47d86SDave Gerlach * use rproc_put() to decrement it back once rproc isn't needed anymore. 1652fec47d86SDave Gerlach * 1653fec47d86SDave Gerlach * Returns the rproc handle on success, and NULL on failure. 1654fec47d86SDave Gerlach */ 16558de3dbd0SOhad Ben-Cohen #ifdef CONFIG_OF 1656fec47d86SDave Gerlach struct rproc *rproc_get_by_phandle(phandle phandle) 1657fec47d86SDave Gerlach { 1658fec47d86SDave Gerlach struct rproc *rproc = NULL, *r; 1659fec47d86SDave Gerlach struct device_node *np; 1660fec47d86SDave Gerlach 1661fec47d86SDave Gerlach np = of_find_node_by_phandle(phandle); 1662fec47d86SDave Gerlach if (!np) 1663fec47d86SDave Gerlach return NULL; 1664fec47d86SDave Gerlach 1665fec47d86SDave Gerlach mutex_lock(&rproc_list_mutex); 1666fec47d86SDave Gerlach list_for_each_entry(r, &rproc_list, node) { 1667fec47d86SDave Gerlach if (r->dev.parent && r->dev.parent->of_node == np) { 1668fbb6aacbSBjorn Andersson /* prevent underlying implementation from being removed */ 1669fbb6aacbSBjorn Andersson if (!try_module_get(r->dev.parent->driver->owner)) { 1670fbb6aacbSBjorn Andersson dev_err(&r->dev, "can't get owner\n"); 1671fbb6aacbSBjorn Andersson break; 1672fbb6aacbSBjorn Andersson } 1673fbb6aacbSBjorn Andersson 1674fec47d86SDave Gerlach rproc = r; 1675fec47d86SDave Gerlach get_device(&rproc->dev); 1676fec47d86SDave Gerlach break; 1677fec47d86SDave Gerlach } 1678fec47d86SDave Gerlach } 1679fec47d86SDave Gerlach mutex_unlock(&rproc_list_mutex); 1680fec47d86SDave Gerlach 1681fec47d86SDave Gerlach of_node_put(np); 1682fec47d86SDave Gerlach 1683fec47d86SDave Gerlach return rproc; 1684fec47d86SDave Gerlach } 16858de3dbd0SOhad Ben-Cohen #else 16868de3dbd0SOhad Ben-Cohen struct rproc *rproc_get_by_phandle(phandle phandle) 16878de3dbd0SOhad Ben-Cohen { 16888de3dbd0SOhad Ben-Cohen return NULL; 16898de3dbd0SOhad Ben-Cohen } 16908de3dbd0SOhad Ben-Cohen #endif 1691fec47d86SDave Gerlach EXPORT_SYMBOL(rproc_get_by_phandle); 1692fec47d86SDave Gerlach 1693fec47d86SDave Gerlach /** 1694160e7c84SOhad Ben-Cohen * rproc_add() - register a remote processor 1695400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle to register 1696400e64dfSOhad Ben-Cohen * 1697400e64dfSOhad Ben-Cohen * Registers @rproc with the remoteproc framework, after it has been 1698400e64dfSOhad Ben-Cohen * allocated with rproc_alloc(). 1699400e64dfSOhad Ben-Cohen * 1700400e64dfSOhad Ben-Cohen * This is called by the platform-specific rproc implementation, whenever 1701400e64dfSOhad Ben-Cohen * a new remote processor device is probed. 1702400e64dfSOhad Ben-Cohen * 1703400e64dfSOhad Ben-Cohen * Returns 0 on success and an appropriate error code otherwise. 1704400e64dfSOhad Ben-Cohen * 1705400e64dfSOhad Ben-Cohen * Note: this function initiates an asynchronous firmware loading 1706400e64dfSOhad Ben-Cohen * context, which will look for virtio devices supported by the rproc's 1707400e64dfSOhad Ben-Cohen * firmware. 1708400e64dfSOhad Ben-Cohen * 1709400e64dfSOhad Ben-Cohen * If found, those virtio devices will be created and added, so as a result 17107a186941SOhad Ben-Cohen * of registering this remote processor, additional virtio drivers might be 1711400e64dfSOhad Ben-Cohen * probed. 1712400e64dfSOhad Ben-Cohen */ 1713160e7c84SOhad Ben-Cohen int rproc_add(struct rproc *rproc) 1714400e64dfSOhad Ben-Cohen { 1715b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 171670b85ef8SFernando Guzman Lugo int ret; 1717400e64dfSOhad Ben-Cohen 1718b5ab5e24SOhad Ben-Cohen ret = device_add(dev); 1719b5ab5e24SOhad Ben-Cohen if (ret < 0) 1720b5ab5e24SOhad Ben-Cohen return ret; 1721400e64dfSOhad Ben-Cohen 1722b5ab5e24SOhad Ben-Cohen dev_info(dev, "%s is available\n", rproc->name); 1723400e64dfSOhad Ben-Cohen 1724400e64dfSOhad Ben-Cohen /* create debugfs entries */ 1725400e64dfSOhad Ben-Cohen rproc_create_debug_dir(rproc); 17267a20c64dSSarangdhar Joshi 17277a20c64dSSarangdhar Joshi /* if rproc is marked always-on, request it to boot */ 17287a20c64dSSarangdhar Joshi if (rproc->auto_boot) { 17295e6533f7SSarangdhar Joshi ret = rproc_trigger_auto_boot(rproc); 1730d2e12e66SDave Gerlach if (ret < 0) 1731d2e12e66SDave Gerlach return ret; 17327a20c64dSSarangdhar Joshi } 1733400e64dfSOhad Ben-Cohen 1734d2e12e66SDave Gerlach /* expose to rproc_get_by_phandle users */ 1735d2e12e66SDave Gerlach mutex_lock(&rproc_list_mutex); 1736d2e12e66SDave Gerlach list_add(&rproc->node, &rproc_list); 1737d2e12e66SDave Gerlach mutex_unlock(&rproc_list_mutex); 1738d2e12e66SDave Gerlach 1739d2e12e66SDave Gerlach return 0; 1740400e64dfSOhad Ben-Cohen } 1741160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_add); 1742400e64dfSOhad Ben-Cohen 1743400e64dfSOhad Ben-Cohen /** 1744b5ab5e24SOhad Ben-Cohen * rproc_type_release() - release a remote processor instance 1745b5ab5e24SOhad Ben-Cohen * @dev: the rproc's device 1746b5ab5e24SOhad Ben-Cohen * 1747b5ab5e24SOhad Ben-Cohen * This function should _never_ be called directly. 1748b5ab5e24SOhad Ben-Cohen * 1749b5ab5e24SOhad Ben-Cohen * It will be called by the driver core when no one holds a valid pointer 1750b5ab5e24SOhad Ben-Cohen * to @dev anymore. 1751b5ab5e24SOhad Ben-Cohen */ 1752b5ab5e24SOhad Ben-Cohen static void rproc_type_release(struct device *dev) 1753b5ab5e24SOhad Ben-Cohen { 1754b5ab5e24SOhad Ben-Cohen struct rproc *rproc = container_of(dev, struct rproc, dev); 1755b5ab5e24SOhad Ben-Cohen 17567183a2a7SOhad Ben-Cohen dev_info(&rproc->dev, "releasing %s\n", rproc->name); 17577183a2a7SOhad Ben-Cohen 1758b5ab5e24SOhad Ben-Cohen idr_destroy(&rproc->notifyids); 1759b5ab5e24SOhad Ben-Cohen 1760b5ab5e24SOhad Ben-Cohen if (rproc->index >= 0) 1761b5ab5e24SOhad Ben-Cohen ida_simple_remove(&rproc_dev_index, rproc->index); 1762b5ab5e24SOhad Ben-Cohen 17630f57dc6aSMatt Redfearn kfree(rproc->firmware); 1764fb98e2bdSBjorn Andersson kfree(rproc->ops); 1765b5ab5e24SOhad Ben-Cohen kfree(rproc); 1766b5ab5e24SOhad Ben-Cohen } 1767b5ab5e24SOhad Ben-Cohen 1768c42ca04dSBhumika Goyal static const struct device_type rproc_type = { 1769b5ab5e24SOhad Ben-Cohen .name = "remoteproc", 1770b5ab5e24SOhad Ben-Cohen .release = rproc_type_release, 1771b5ab5e24SOhad Ben-Cohen }; 1772400e64dfSOhad Ben-Cohen 1773400e64dfSOhad Ben-Cohen /** 1774400e64dfSOhad Ben-Cohen * rproc_alloc() - allocate a remote processor handle 1775400e64dfSOhad Ben-Cohen * @dev: the underlying device 1776400e64dfSOhad Ben-Cohen * @name: name of this remote processor 1777400e64dfSOhad Ben-Cohen * @ops: platform-specific handlers (mainly start/stop) 17788b4aec9aSRobert Tivy * @firmware: name of firmware file to load, can be NULL 1779400e64dfSOhad Ben-Cohen * @len: length of private data needed by the rproc driver (in bytes) 1780400e64dfSOhad Ben-Cohen * 1781400e64dfSOhad Ben-Cohen * Allocates a new remote processor handle, but does not register 17828b4aec9aSRobert Tivy * it yet. if @firmware is NULL, a default name is used. 1783400e64dfSOhad Ben-Cohen * 1784400e64dfSOhad Ben-Cohen * This function should be used by rproc implementations during initialization 1785400e64dfSOhad Ben-Cohen * of the remote processor. 1786400e64dfSOhad Ben-Cohen * 1787400e64dfSOhad Ben-Cohen * After creating an rproc handle using this function, and when ready, 1788160e7c84SOhad Ben-Cohen * implementations should then call rproc_add() to complete 1789400e64dfSOhad Ben-Cohen * the registration of the remote processor. 1790400e64dfSOhad Ben-Cohen * 1791400e64dfSOhad Ben-Cohen * On success the new rproc is returned, and on failure, NULL. 1792400e64dfSOhad Ben-Cohen * 1793400e64dfSOhad Ben-Cohen * Note: _never_ directly deallocate @rproc, even if it was not registered 1794433c0e04SBjorn Andersson * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free(). 1795400e64dfSOhad Ben-Cohen */ 1796400e64dfSOhad Ben-Cohen struct rproc *rproc_alloc(struct device *dev, const char *name, 1797400e64dfSOhad Ben-Cohen const struct rproc_ops *ops, 1798400e64dfSOhad Ben-Cohen const char *firmware, int len) 1799400e64dfSOhad Ben-Cohen { 1800400e64dfSOhad Ben-Cohen struct rproc *rproc; 18018b4aec9aSRobert Tivy char *p, *template = "rproc-%s-fw"; 18020f57dc6aSMatt Redfearn int name_len; 1803400e64dfSOhad Ben-Cohen 1804400e64dfSOhad Ben-Cohen if (!dev || !name || !ops) 1805400e64dfSOhad Ben-Cohen return NULL; 1806400e64dfSOhad Ben-Cohen 18070f57dc6aSMatt Redfearn if (!firmware) { 18088b4aec9aSRobert Tivy /* 18098b4aec9aSRobert Tivy * If the caller didn't pass in a firmware name then 18100f57dc6aSMatt Redfearn * construct a default name. 18118b4aec9aSRobert Tivy */ 18128b4aec9aSRobert Tivy name_len = strlen(name) + strlen(template) - 2 + 1; 18130f57dc6aSMatt Redfearn p = kmalloc(name_len, GFP_KERNEL); 18140f57dc6aSMatt Redfearn if (!p) 1815400e64dfSOhad Ben-Cohen return NULL; 18168b4aec9aSRobert Tivy snprintf(p, name_len, template, name); 18178b4aec9aSRobert Tivy } else { 18180f57dc6aSMatt Redfearn p = kstrdup(firmware, GFP_KERNEL); 18190f57dc6aSMatt Redfearn if (!p) 18200f57dc6aSMatt Redfearn return NULL; 18210f57dc6aSMatt Redfearn } 18220f57dc6aSMatt Redfearn 18230f57dc6aSMatt Redfearn rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL); 18240f57dc6aSMatt Redfearn if (!rproc) { 18250f57dc6aSMatt Redfearn kfree(p); 18260f57dc6aSMatt Redfearn return NULL; 18278b4aec9aSRobert Tivy } 18288b4aec9aSRobert Tivy 1829fb98e2bdSBjorn Andersson rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL); 1830fb98e2bdSBjorn Andersson if (!rproc->ops) { 1831fb98e2bdSBjorn Andersson kfree(p); 1832fb98e2bdSBjorn Andersson kfree(rproc); 1833fb98e2bdSBjorn Andersson return NULL; 1834fb98e2bdSBjorn Andersson } 1835fb98e2bdSBjorn Andersson 18368b4aec9aSRobert Tivy rproc->firmware = p; 1837400e64dfSOhad Ben-Cohen rproc->name = name; 1838400e64dfSOhad Ben-Cohen rproc->priv = &rproc[1]; 1839ddf71187SBjorn Andersson rproc->auto_boot = true; 1840400e64dfSOhad Ben-Cohen 1841b5ab5e24SOhad Ben-Cohen device_initialize(&rproc->dev); 1842b5ab5e24SOhad Ben-Cohen rproc->dev.parent = dev; 1843b5ab5e24SOhad Ben-Cohen rproc->dev.type = &rproc_type; 18442aefbef0SMatt Redfearn rproc->dev.class = &rproc_class; 18457c89717fSBjorn Andersson rproc->dev.driver_data = rproc; 1846b5ab5e24SOhad Ben-Cohen 1847b5ab5e24SOhad Ben-Cohen /* Assign a unique device index and name */ 1848b5ab5e24SOhad Ben-Cohen rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL); 1849b5ab5e24SOhad Ben-Cohen if (rproc->index < 0) { 1850b5ab5e24SOhad Ben-Cohen dev_err(dev, "ida_simple_get failed: %d\n", rproc->index); 1851b5ab5e24SOhad Ben-Cohen put_device(&rproc->dev); 1852b5ab5e24SOhad Ben-Cohen return NULL; 1853b5ab5e24SOhad Ben-Cohen } 1854b5ab5e24SOhad Ben-Cohen 1855b5ab5e24SOhad Ben-Cohen dev_set_name(&rproc->dev, "remoteproc%d", rproc->index); 1856b5ab5e24SOhad Ben-Cohen 1857400e64dfSOhad Ben-Cohen atomic_set(&rproc->power, 0); 1858400e64dfSOhad Ben-Cohen 18590f21f9ccSBjorn Andersson /* Default to ELF loader if no load function is specified */ 18600f21f9ccSBjorn Andersson if (!rproc->ops->load) { 18610f21f9ccSBjorn Andersson rproc->ops->load = rproc_elf_load_segments; 1862c1d35c1aSBjorn Andersson rproc->ops->parse_fw = rproc_elf_load_rsc_table; 18630f21f9ccSBjorn Andersson rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table; 18640f21f9ccSBjorn Andersson rproc->ops->sanity_check = rproc_elf_sanity_check; 18650f21f9ccSBjorn Andersson rproc->ops->get_boot_addr = rproc_elf_get_boot_addr; 18660f21f9ccSBjorn Andersson } 1867400e64dfSOhad Ben-Cohen 1868400e64dfSOhad Ben-Cohen mutex_init(&rproc->lock); 1869400e64dfSOhad Ben-Cohen 18707a186941SOhad Ben-Cohen idr_init(&rproc->notifyids); 18717a186941SOhad Ben-Cohen 1872400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->carveouts); 1873400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->mappings); 1874400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->traces); 18757a186941SOhad Ben-Cohen INIT_LIST_HEAD(&rproc->rvdevs); 18767bdc9650SBjorn Andersson INIT_LIST_HEAD(&rproc->subdevs); 18772666ca91SSarangdhar Joshi INIT_LIST_HEAD(&rproc->dump_segments); 1878400e64dfSOhad Ben-Cohen 18798afd519cSFernando Guzman Lugo INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work); 18808afd519cSFernando Guzman Lugo 1881400e64dfSOhad Ben-Cohen rproc->state = RPROC_OFFLINE; 1882400e64dfSOhad Ben-Cohen 1883400e64dfSOhad Ben-Cohen return rproc; 1884400e64dfSOhad Ben-Cohen } 1885400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_alloc); 1886400e64dfSOhad Ben-Cohen 1887400e64dfSOhad Ben-Cohen /** 1888433c0e04SBjorn Andersson * rproc_free() - unroll rproc_alloc() 1889433c0e04SBjorn Andersson * @rproc: the remote processor handle 1890433c0e04SBjorn Andersson * 1891433c0e04SBjorn Andersson * This function decrements the rproc dev refcount. 1892433c0e04SBjorn Andersson * 1893433c0e04SBjorn Andersson * If no one holds any reference to rproc anymore, then its refcount would 1894433c0e04SBjorn Andersson * now drop to zero, and it would be freed. 1895433c0e04SBjorn Andersson */ 1896433c0e04SBjorn Andersson void rproc_free(struct rproc *rproc) 1897433c0e04SBjorn Andersson { 1898433c0e04SBjorn Andersson put_device(&rproc->dev); 1899433c0e04SBjorn Andersson } 1900433c0e04SBjorn Andersson EXPORT_SYMBOL(rproc_free); 1901433c0e04SBjorn Andersson 1902433c0e04SBjorn Andersson /** 1903433c0e04SBjorn Andersson * rproc_put() - release rproc reference 1904400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle 1905400e64dfSOhad Ben-Cohen * 1906c6b5a276SOhad Ben-Cohen * This function decrements the rproc dev refcount. 1907400e64dfSOhad Ben-Cohen * 1908c6b5a276SOhad Ben-Cohen * If no one holds any reference to rproc anymore, then its refcount would 1909c6b5a276SOhad Ben-Cohen * now drop to zero, and it would be freed. 1910400e64dfSOhad Ben-Cohen */ 1911160e7c84SOhad Ben-Cohen void rproc_put(struct rproc *rproc) 1912400e64dfSOhad Ben-Cohen { 1913fbb6aacbSBjorn Andersson module_put(rproc->dev.parent->driver->owner); 1914b5ab5e24SOhad Ben-Cohen put_device(&rproc->dev); 1915400e64dfSOhad Ben-Cohen } 1916160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_put); 1917400e64dfSOhad Ben-Cohen 1918400e64dfSOhad Ben-Cohen /** 1919160e7c84SOhad Ben-Cohen * rproc_del() - unregister a remote processor 1920400e64dfSOhad Ben-Cohen * @rproc: rproc handle to unregister 1921400e64dfSOhad Ben-Cohen * 1922400e64dfSOhad Ben-Cohen * This function should be called when the platform specific rproc 1923400e64dfSOhad Ben-Cohen * implementation decides to remove the rproc device. it should 1924160e7c84SOhad Ben-Cohen * _only_ be called if a previous invocation of rproc_add() 1925400e64dfSOhad Ben-Cohen * has completed successfully. 1926400e64dfSOhad Ben-Cohen * 1927160e7c84SOhad Ben-Cohen * After rproc_del() returns, @rproc isn't freed yet, because 1928c6b5a276SOhad Ben-Cohen * of the outstanding reference created by rproc_alloc. To decrement that 1929433c0e04SBjorn Andersson * one last refcount, one still needs to call rproc_free(). 1930400e64dfSOhad Ben-Cohen * 1931400e64dfSOhad Ben-Cohen * Returns 0 on success and -EINVAL if @rproc isn't valid. 1932400e64dfSOhad Ben-Cohen */ 1933160e7c84SOhad Ben-Cohen int rproc_del(struct rproc *rproc) 1934400e64dfSOhad Ben-Cohen { 1935400e64dfSOhad Ben-Cohen if (!rproc) 1936400e64dfSOhad Ben-Cohen return -EINVAL; 1937400e64dfSOhad Ben-Cohen 1938ddf71187SBjorn Andersson /* if rproc is marked always-on, rproc_add() booted it */ 1939ddf71187SBjorn Andersson /* TODO: make sure this works with rproc->power > 1 */ 1940ddf71187SBjorn Andersson if (rproc->auto_boot) 1941ddf71187SBjorn Andersson rproc_shutdown(rproc); 1942ddf71187SBjorn Andersson 19432099c77dSSarangdhar Joshi mutex_lock(&rproc->lock); 19442099c77dSSarangdhar Joshi rproc->state = RPROC_DELETED; 19452099c77dSSarangdhar Joshi mutex_unlock(&rproc->lock); 19462099c77dSSarangdhar Joshi 1947b003d45bSSarangdhar Joshi rproc_delete_debug_dir(rproc); 1948b003d45bSSarangdhar Joshi 1949fec47d86SDave Gerlach /* the rproc is downref'ed as soon as it's removed from the klist */ 1950fec47d86SDave Gerlach mutex_lock(&rproc_list_mutex); 1951fec47d86SDave Gerlach list_del(&rproc->node); 1952fec47d86SDave Gerlach mutex_unlock(&rproc_list_mutex); 1953fec47d86SDave Gerlach 1954b5ab5e24SOhad Ben-Cohen device_del(&rproc->dev); 1955400e64dfSOhad Ben-Cohen 1956400e64dfSOhad Ben-Cohen return 0; 1957400e64dfSOhad Ben-Cohen } 1958160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_del); 1959400e64dfSOhad Ben-Cohen 19608afd519cSFernando Guzman Lugo /** 19617bdc9650SBjorn Andersson * rproc_add_subdev() - add a subdevice to a remoteproc 19627bdc9650SBjorn Andersson * @rproc: rproc handle to add the subdevice to 19637bdc9650SBjorn Andersson * @subdev: subdev handle to register 19644902676fSBjorn Andersson * 19654902676fSBjorn Andersson * Caller is responsible for populating optional subdevice function pointers. 19667bdc9650SBjorn Andersson */ 19674902676fSBjorn Andersson void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 19687bdc9650SBjorn Andersson { 19697bdc9650SBjorn Andersson list_add_tail(&subdev->node, &rproc->subdevs); 19707bdc9650SBjorn Andersson } 19717bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_add_subdev); 19727bdc9650SBjorn Andersson 19737bdc9650SBjorn Andersson /** 19747bdc9650SBjorn Andersson * rproc_remove_subdev() - remove a subdevice from a remoteproc 19757bdc9650SBjorn Andersson * @rproc: rproc handle to remove the subdevice from 19767bdc9650SBjorn Andersson * @subdev: subdev handle, previously registered with rproc_add_subdev() 19777bdc9650SBjorn Andersson */ 19787bdc9650SBjorn Andersson void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 19797bdc9650SBjorn Andersson { 19807bdc9650SBjorn Andersson list_del(&subdev->node); 19817bdc9650SBjorn Andersson } 19827bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_remove_subdev); 19837bdc9650SBjorn Andersson 19847bdc9650SBjorn Andersson /** 19857c89717fSBjorn Andersson * rproc_get_by_child() - acquire rproc handle of @dev's ancestor 19867c89717fSBjorn Andersson * @dev: child device to find ancestor of 19877c89717fSBjorn Andersson * 19887c89717fSBjorn Andersson * Returns the ancestor rproc instance, or NULL if not found. 19897c89717fSBjorn Andersson */ 19907c89717fSBjorn Andersson struct rproc *rproc_get_by_child(struct device *dev) 19917c89717fSBjorn Andersson { 19927c89717fSBjorn Andersson for (dev = dev->parent; dev; dev = dev->parent) { 19937c89717fSBjorn Andersson if (dev->type == &rproc_type) 19947c89717fSBjorn Andersson return dev->driver_data; 19957c89717fSBjorn Andersson } 19967c89717fSBjorn Andersson 19977c89717fSBjorn Andersson return NULL; 19987c89717fSBjorn Andersson } 19997c89717fSBjorn Andersson EXPORT_SYMBOL(rproc_get_by_child); 20007c89717fSBjorn Andersson 20017c89717fSBjorn Andersson /** 20028afd519cSFernando Guzman Lugo * rproc_report_crash() - rproc crash reporter function 20038afd519cSFernando Guzman Lugo * @rproc: remote processor 20048afd519cSFernando Guzman Lugo * @type: crash type 20058afd519cSFernando Guzman Lugo * 20068afd519cSFernando Guzman Lugo * This function must be called every time a crash is detected by the low-level 20078afd519cSFernando Guzman Lugo * drivers implementing a specific remoteproc. This should not be called from a 20088afd519cSFernando Guzman Lugo * non-remoteproc driver. 20098afd519cSFernando Guzman Lugo * 20108afd519cSFernando Guzman Lugo * This function can be called from atomic/interrupt context. 20118afd519cSFernando Guzman Lugo */ 20128afd519cSFernando Guzman Lugo void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type) 20138afd519cSFernando Guzman Lugo { 20148afd519cSFernando Guzman Lugo if (!rproc) { 20158afd519cSFernando Guzman Lugo pr_err("NULL rproc pointer\n"); 20168afd519cSFernando Guzman Lugo return; 20178afd519cSFernando Guzman Lugo } 20188afd519cSFernando Guzman Lugo 20198afd519cSFernando Guzman Lugo dev_err(&rproc->dev, "crash detected in %s: type %s\n", 20208afd519cSFernando Guzman Lugo rproc->name, rproc_crash_to_string(type)); 20218afd519cSFernando Guzman Lugo 20228afd519cSFernando Guzman Lugo /* create a new task to handle the error */ 20238afd519cSFernando Guzman Lugo schedule_work(&rproc->crash_handler); 20248afd519cSFernando Guzman Lugo } 20258afd519cSFernando Guzman Lugo EXPORT_SYMBOL(rproc_report_crash); 20268afd519cSFernando Guzman Lugo 2027400e64dfSOhad Ben-Cohen static int __init remoteproc_init(void) 2028400e64dfSOhad Ben-Cohen { 20292aefbef0SMatt Redfearn rproc_init_sysfs(); 2030400e64dfSOhad Ben-Cohen rproc_init_debugfs(); 2031b5ab5e24SOhad Ben-Cohen 2032400e64dfSOhad Ben-Cohen return 0; 2033400e64dfSOhad Ben-Cohen } 2034400e64dfSOhad Ben-Cohen module_init(remoteproc_init); 2035400e64dfSOhad Ben-Cohen 2036400e64dfSOhad Ben-Cohen static void __exit remoteproc_exit(void) 2037400e64dfSOhad Ben-Cohen { 2038f42f79afSSuman Anna ida_destroy(&rproc_dev_index); 2039f42f79afSSuman Anna 2040400e64dfSOhad Ben-Cohen rproc_exit_debugfs(); 20412aefbef0SMatt Redfearn rproc_exit_sysfs(); 2042400e64dfSOhad Ben-Cohen } 2043400e64dfSOhad Ben-Cohen module_exit(remoteproc_exit); 2044400e64dfSOhad Ben-Cohen 2045400e64dfSOhad Ben-Cohen MODULE_LICENSE("GPL v2"); 2046400e64dfSOhad Ben-Cohen MODULE_DESCRIPTION("Generic Remote Processor Framework"); 2047