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 2206db20ea8SOhad Ben-Cohen int rproc_alloc_vring(struct rproc_vdev *rvdev, int i) 221400e64dfSOhad Ben-Cohen { 2227a186941SOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 223b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 2246db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 225c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 2267a186941SOhad Ben-Cohen dma_addr_t dma; 2277a186941SOhad Ben-Cohen void *va; 2287a186941SOhad Ben-Cohen int ret, size, notifyid; 229400e64dfSOhad Ben-Cohen 2306db20ea8SOhad Ben-Cohen /* actual size of vring (in bytes) */ 2316db20ea8SOhad Ben-Cohen size = PAGE_ALIGN(vring_size(rvring->len, rvring->align)); 2326db20ea8SOhad Ben-Cohen 2336db20ea8SOhad Ben-Cohen /* 2346db20ea8SOhad Ben-Cohen * Allocate non-cacheable memory for the vring. In the future 2356db20ea8SOhad Ben-Cohen * this call will also configure the IOMMU for us 2366db20ea8SOhad Ben-Cohen */ 237b5ab5e24SOhad Ben-Cohen va = dma_alloc_coherent(dev->parent, size, &dma, GFP_KERNEL); 2386db20ea8SOhad Ben-Cohen if (!va) { 239b5ab5e24SOhad Ben-Cohen dev_err(dev->parent, "dma_alloc_coherent failed\n"); 2406db20ea8SOhad Ben-Cohen return -EINVAL; 2416db20ea8SOhad Ben-Cohen } 2426db20ea8SOhad Ben-Cohen 2436db20ea8SOhad Ben-Cohen /* 2446db20ea8SOhad Ben-Cohen * Assign an rproc-wide unique index for this vring 2456db20ea8SOhad Ben-Cohen * TODO: assign a notifyid for rvdev updates as well 2466db20ea8SOhad Ben-Cohen * TODO: support predefined notifyids (via resource table) 2476db20ea8SOhad Ben-Cohen */ 24815fc6110STejun Heo ret = idr_alloc(&rproc->notifyids, rvring, 0, 0, GFP_KERNEL); 249b39599b7SSuman Anna if (ret < 0) { 25015fc6110STejun Heo dev_err(dev, "idr_alloc failed: %d\n", ret); 251b5ab5e24SOhad Ben-Cohen dma_free_coherent(dev->parent, size, va, dma); 2526db20ea8SOhad Ben-Cohen return ret; 2536db20ea8SOhad Ben-Cohen } 25415fc6110STejun Heo notifyid = ret; 2556db20ea8SOhad Ben-Cohen 25648f18f89SBjorn Andersson /* Potentially bump max_notifyid */ 25748f18f89SBjorn Andersson if (notifyid > rproc->max_notifyid) 25848f18f89SBjorn Andersson rproc->max_notifyid = notifyid; 25948f18f89SBjorn Andersson 260276ec993SLoic Pallardy dev_dbg(dev, "vring%d: va %pK dma %pad size 0x%x idr %d\n", 261b605ed8bSAnna, Suman i, va, &dma, size, notifyid); 2626db20ea8SOhad Ben-Cohen 2636db20ea8SOhad Ben-Cohen rvring->va = va; 2646db20ea8SOhad Ben-Cohen rvring->dma = dma; 2656db20ea8SOhad Ben-Cohen rvring->notifyid = notifyid; 2666db20ea8SOhad Ben-Cohen 267c0d63157SSjur Brændeland /* 268c0d63157SSjur Brændeland * Let the rproc know the notifyid and da of this vring. 269c0d63157SSjur Brændeland * Not all platforms use dma_alloc_coherent to automatically 270c0d63157SSjur Brændeland * set up the iommu. In this case the device address (da) will 271c0d63157SSjur Brændeland * hold the physical address and not the device address. 272c0d63157SSjur Brændeland */ 273c0d63157SSjur Brændeland rsc = (void *)rproc->table_ptr + rvdev->rsc_offset; 274c0d63157SSjur Brændeland rsc->vring[i].da = dma; 275c0d63157SSjur Brændeland rsc->vring[i].notifyid = notifyid; 2766db20ea8SOhad Ben-Cohen return 0; 2776db20ea8SOhad Ben-Cohen } 2786db20ea8SOhad Ben-Cohen 279400e64dfSOhad Ben-Cohen static int 2806db20ea8SOhad Ben-Cohen rproc_parse_vring(struct rproc_vdev *rvdev, struct fw_rsc_vdev *rsc, int i) 281400e64dfSOhad Ben-Cohen { 282400e64dfSOhad Ben-Cohen struct rproc *rproc = rvdev->rproc; 283b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 284400e64dfSOhad Ben-Cohen struct fw_rsc_vdev_vring *vring = &rsc->vring[i]; 2856db20ea8SOhad Ben-Cohen struct rproc_vring *rvring = &rvdev->vring[i]; 286400e64dfSOhad Ben-Cohen 2879d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: vring%d: da 0x%x, qsz %d, align %d\n", 2887a186941SOhad Ben-Cohen i, vring->da, vring->num, vring->align); 2897a186941SOhad Ben-Cohen 29063140e0eSOhad Ben-Cohen /* verify queue size and vring alignment are sane */ 29163140e0eSOhad Ben-Cohen if (!vring->num || !vring->align) { 29263140e0eSOhad Ben-Cohen dev_err(dev, "invalid qsz (%d) or alignment (%d)\n", 29363140e0eSOhad Ben-Cohen vring->num, vring->align); 294400e64dfSOhad Ben-Cohen return -EINVAL; 295400e64dfSOhad Ben-Cohen } 296400e64dfSOhad Ben-Cohen 2976db20ea8SOhad Ben-Cohen rvring->len = vring->num; 2986db20ea8SOhad Ben-Cohen rvring->align = vring->align; 2996db20ea8SOhad Ben-Cohen rvring->rvdev = rvdev; 300400e64dfSOhad Ben-Cohen 301400e64dfSOhad Ben-Cohen return 0; 302400e64dfSOhad Ben-Cohen } 303400e64dfSOhad Ben-Cohen 3046db20ea8SOhad Ben-Cohen void rproc_free_vring(struct rproc_vring *rvring) 3057a186941SOhad Ben-Cohen { 30663140e0eSOhad Ben-Cohen int size = PAGE_ALIGN(vring_size(rvring->len, rvring->align)); 3076db20ea8SOhad Ben-Cohen struct rproc *rproc = rvring->rvdev->rproc; 308c0d63157SSjur Brændeland int idx = rvring->rvdev->vring - rvring; 309c0d63157SSjur Brændeland struct fw_rsc_vdev *rsc; 3107a186941SOhad Ben-Cohen 311b5ab5e24SOhad Ben-Cohen dma_free_coherent(rproc->dev.parent, size, rvring->va, rvring->dma); 3127a186941SOhad Ben-Cohen idr_remove(&rproc->notifyids, rvring->notifyid); 313099a3f33SSjur Brændeland 314c0d63157SSjur Brændeland /* reset resource entry info */ 315c0d63157SSjur Brændeland rsc = (void *)rproc->table_ptr + rvring->rvdev->rsc_offset; 316c0d63157SSjur Brændeland rsc->vring[idx].da = 0; 317c0d63157SSjur Brændeland rsc->vring[idx].notifyid = -1; 3187a186941SOhad Ben-Cohen } 3197a186941SOhad Ben-Cohen 3206f8b0373SAlex Elder static int rproc_vdev_do_start(struct rproc_subdev *subdev) 321f5bcb353SBjorn Andersson { 322f5bcb353SBjorn Andersson struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev); 323f5bcb353SBjorn Andersson 324f5bcb353SBjorn Andersson return rproc_add_virtio_dev(rvdev, rvdev->id); 325f5bcb353SBjorn Andersson } 326f5bcb353SBjorn Andersson 3276f8b0373SAlex Elder static void rproc_vdev_do_stop(struct rproc_subdev *subdev, bool crashed) 328f5bcb353SBjorn Andersson { 329f5bcb353SBjorn Andersson struct rproc_vdev *rvdev = container_of(subdev, struct rproc_vdev, subdev); 330f5bcb353SBjorn Andersson 331f5bcb353SBjorn Andersson rproc_remove_virtio_dev(rvdev); 332f5bcb353SBjorn Andersson } 333f5bcb353SBjorn Andersson 334400e64dfSOhad Ben-Cohen /** 335fd2c15ecSOhad Ben-Cohen * rproc_handle_vdev() - handle a vdev fw resource 336400e64dfSOhad Ben-Cohen * @rproc: the remote processor 337400e64dfSOhad Ben-Cohen * @rsc: the vring resource descriptor 338fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 339400e64dfSOhad Ben-Cohen * 3407a186941SOhad Ben-Cohen * This resource entry requests the host to statically register a virtio 3417a186941SOhad Ben-Cohen * device (vdev), and setup everything needed to support it. It contains 3427a186941SOhad Ben-Cohen * everything needed to make it possible: the virtio device id, virtio 3437a186941SOhad Ben-Cohen * device features, vrings information, virtio config space, etc... 344400e64dfSOhad Ben-Cohen * 3457a186941SOhad Ben-Cohen * Before registering the vdev, the vrings are allocated from non-cacheable 3467a186941SOhad Ben-Cohen * physically contiguous memory. Currently we only support two vrings per 3477a186941SOhad Ben-Cohen * remote processor (temporary limitation). We might also want to consider 3487a186941SOhad Ben-Cohen * doing the vring allocation only later when ->find_vqs() is invoked, and 3497a186941SOhad Ben-Cohen * then release them upon ->del_vqs(). 350400e64dfSOhad Ben-Cohen * 3517a186941SOhad Ben-Cohen * Note: @da is currently not really handled correctly: we dynamically 3527a186941SOhad Ben-Cohen * allocate it using the DMA API, ignoring requested hard coded addresses, 3537a186941SOhad Ben-Cohen * and we don't take care of any required IOMMU programming. This is all 3547a186941SOhad Ben-Cohen * going to be taken care of when the generic iommu-based DMA API will be 3557a186941SOhad Ben-Cohen * merged. Meanwhile, statically-addressed iommu-based firmware images should 3567a186941SOhad Ben-Cohen * use RSC_DEVMEM resource entries to map their required @da to the physical 3577a186941SOhad Ben-Cohen * address of their base CMA region (ouch, hacky!). 358400e64dfSOhad Ben-Cohen * 359400e64dfSOhad Ben-Cohen * Returns 0 on success, or an appropriate error code otherwise 360400e64dfSOhad Ben-Cohen */ 361fd2c15ecSOhad Ben-Cohen static int rproc_handle_vdev(struct rproc *rproc, struct fw_rsc_vdev *rsc, 362a2b950acSOhad Ben-Cohen int offset, int avail) 363400e64dfSOhad Ben-Cohen { 364b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 3657a186941SOhad Ben-Cohen struct rproc_vdev *rvdev; 3667a186941SOhad Ben-Cohen int i, ret; 367fd2c15ecSOhad Ben-Cohen 368fd2c15ecSOhad Ben-Cohen /* make sure resource isn't truncated */ 369fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) + rsc->num_of_vrings * sizeof(struct fw_rsc_vdev_vring) 370fd2c15ecSOhad Ben-Cohen + rsc->config_len > avail) { 371b5ab5e24SOhad Ben-Cohen dev_err(dev, "vdev rsc is truncated\n"); 372fd2c15ecSOhad Ben-Cohen return -EINVAL; 373fd2c15ecSOhad Ben-Cohen } 374fd2c15ecSOhad Ben-Cohen 375fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 376fd2c15ecSOhad Ben-Cohen if (rsc->reserved[0] || rsc->reserved[1]) { 377fd2c15ecSOhad Ben-Cohen dev_err(dev, "vdev rsc has non zero reserved bytes\n"); 378fd2c15ecSOhad Ben-Cohen return -EINVAL; 379fd2c15ecSOhad Ben-Cohen } 380fd2c15ecSOhad Ben-Cohen 3819d7814a9SAnna, Suman dev_dbg(dev, "vdev rsc: id %d, dfeatures 0x%x, cfg len %d, %d vrings\n", 382fd2c15ecSOhad Ben-Cohen rsc->id, rsc->dfeatures, rsc->config_len, rsc->num_of_vrings); 383400e64dfSOhad Ben-Cohen 3847a186941SOhad Ben-Cohen /* we currently support only two vrings per rvdev */ 3857a186941SOhad Ben-Cohen if (rsc->num_of_vrings > ARRAY_SIZE(rvdev->vring)) { 386fd2c15ecSOhad Ben-Cohen dev_err(dev, "too many vrings: %d\n", rsc->num_of_vrings); 387400e64dfSOhad Ben-Cohen return -EINVAL; 388400e64dfSOhad Ben-Cohen } 389400e64dfSOhad Ben-Cohen 390899585adSAnna, Suman rvdev = kzalloc(sizeof(*rvdev), GFP_KERNEL); 3917a186941SOhad Ben-Cohen if (!rvdev) 3927a186941SOhad Ben-Cohen return -ENOMEM; 3937a186941SOhad Ben-Cohen 394aab8d802SBjorn Andersson kref_init(&rvdev->refcount); 395aab8d802SBjorn Andersson 396f5bcb353SBjorn Andersson rvdev->id = rsc->id; 3977a186941SOhad Ben-Cohen rvdev->rproc = rproc; 3987a186941SOhad Ben-Cohen 3996db20ea8SOhad Ben-Cohen /* parse the vrings */ 400fd2c15ecSOhad Ben-Cohen for (i = 0; i < rsc->num_of_vrings; i++) { 4016db20ea8SOhad Ben-Cohen ret = rproc_parse_vring(rvdev, rsc, i); 4027a186941SOhad Ben-Cohen if (ret) 4036db20ea8SOhad Ben-Cohen goto free_rvdev; 404fd2c15ecSOhad Ben-Cohen } 405fd2c15ecSOhad Ben-Cohen 406a2b950acSOhad Ben-Cohen /* remember the resource offset*/ 407a2b950acSOhad Ben-Cohen rvdev->rsc_offset = offset; 408400e64dfSOhad Ben-Cohen 409a863af5dSBjorn Andersson /* allocate the vring resources */ 410a863af5dSBjorn Andersson for (i = 0; i < rsc->num_of_vrings; i++) { 411a863af5dSBjorn Andersson ret = rproc_alloc_vring(rvdev, i); 412a863af5dSBjorn Andersson if (ret) 413a863af5dSBjorn Andersson goto unwind_vring_allocations; 414a863af5dSBjorn Andersson } 415a863af5dSBjorn Andersson 4167a186941SOhad Ben-Cohen list_add_tail(&rvdev->node, &rproc->rvdevs); 417400e64dfSOhad Ben-Cohen 4186f8b0373SAlex Elder rvdev->subdev.start = rproc_vdev_do_start; 4196f8b0373SAlex Elder rvdev->subdev.stop = rproc_vdev_do_stop; 4204902676fSBjorn Andersson 4214902676fSBjorn Andersson rproc_add_subdev(rproc, &rvdev->subdev); 422400e64dfSOhad Ben-Cohen 423400e64dfSOhad Ben-Cohen return 0; 4247a186941SOhad Ben-Cohen 425a863af5dSBjorn Andersson unwind_vring_allocations: 426a863af5dSBjorn Andersson for (i--; i >= 0; i--) 427a863af5dSBjorn Andersson rproc_free_vring(&rvdev->vring[i]); 4286db20ea8SOhad Ben-Cohen free_rvdev: 4297a186941SOhad Ben-Cohen kfree(rvdev); 4307a186941SOhad Ben-Cohen return ret; 431400e64dfSOhad Ben-Cohen } 432400e64dfSOhad Ben-Cohen 433aab8d802SBjorn Andersson void rproc_vdev_release(struct kref *ref) 434aab8d802SBjorn Andersson { 435aab8d802SBjorn Andersson struct rproc_vdev *rvdev = container_of(ref, struct rproc_vdev, refcount); 436a863af5dSBjorn Andersson struct rproc_vring *rvring; 437f5bcb353SBjorn Andersson struct rproc *rproc = rvdev->rproc; 438a863af5dSBjorn Andersson int id; 439a863af5dSBjorn Andersson 440a863af5dSBjorn Andersson for (id = 0; id < ARRAY_SIZE(rvdev->vring); id++) { 441a863af5dSBjorn Andersson rvring = &rvdev->vring[id]; 442a863af5dSBjorn Andersson if (!rvring->va) 443a863af5dSBjorn Andersson continue; 444a863af5dSBjorn Andersson 445a863af5dSBjorn Andersson rproc_free_vring(rvring); 446a863af5dSBjorn Andersson } 447aab8d802SBjorn Andersson 448f5bcb353SBjorn Andersson rproc_remove_subdev(rproc, &rvdev->subdev); 449aab8d802SBjorn Andersson list_del(&rvdev->node); 450aab8d802SBjorn Andersson kfree(rvdev); 451aab8d802SBjorn Andersson } 452aab8d802SBjorn Andersson 453400e64dfSOhad Ben-Cohen /** 454400e64dfSOhad Ben-Cohen * rproc_handle_trace() - handle a shared trace buffer resource 455400e64dfSOhad Ben-Cohen * @rproc: the remote processor 456400e64dfSOhad Ben-Cohen * @rsc: the trace resource descriptor 457fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 458400e64dfSOhad Ben-Cohen * 459400e64dfSOhad Ben-Cohen * In case the remote processor dumps trace logs into memory, 460400e64dfSOhad Ben-Cohen * export it via debugfs. 461400e64dfSOhad Ben-Cohen * 462400e64dfSOhad Ben-Cohen * Currently, the 'da' member of @rsc should contain the device address 463400e64dfSOhad Ben-Cohen * where the remote processor is dumping the traces. Later we could also 464400e64dfSOhad Ben-Cohen * support dynamically allocating this address using the generic 465400e64dfSOhad Ben-Cohen * DMA API (but currently there isn't a use case for that). 466400e64dfSOhad Ben-Cohen * 467400e64dfSOhad Ben-Cohen * Returns 0 on success, or an appropriate error code otherwise 468400e64dfSOhad Ben-Cohen */ 469fd2c15ecSOhad Ben-Cohen static int rproc_handle_trace(struct rproc *rproc, struct fw_rsc_trace *rsc, 470a2b950acSOhad Ben-Cohen int offset, int avail) 471400e64dfSOhad Ben-Cohen { 472400e64dfSOhad Ben-Cohen struct rproc_mem_entry *trace; 473b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 474400e64dfSOhad Ben-Cohen void *ptr; 475400e64dfSOhad Ben-Cohen char name[15]; 476400e64dfSOhad Ben-Cohen 477fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 478b5ab5e24SOhad Ben-Cohen dev_err(dev, "trace rsc is truncated\n"); 479fd2c15ecSOhad Ben-Cohen return -EINVAL; 480fd2c15ecSOhad Ben-Cohen } 481fd2c15ecSOhad Ben-Cohen 482fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 483fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 484fd2c15ecSOhad Ben-Cohen dev_err(dev, "trace rsc has non zero reserved bytes\n"); 485fd2c15ecSOhad Ben-Cohen return -EINVAL; 486fd2c15ecSOhad Ben-Cohen } 487fd2c15ecSOhad Ben-Cohen 488400e64dfSOhad Ben-Cohen /* what's the kernel address of this resource ? */ 489400e64dfSOhad Ben-Cohen ptr = rproc_da_to_va(rproc, rsc->da, rsc->len); 490400e64dfSOhad Ben-Cohen if (!ptr) { 491400e64dfSOhad Ben-Cohen dev_err(dev, "erroneous trace resource entry\n"); 492400e64dfSOhad Ben-Cohen return -EINVAL; 493400e64dfSOhad Ben-Cohen } 494400e64dfSOhad Ben-Cohen 495400e64dfSOhad Ben-Cohen trace = kzalloc(sizeof(*trace), GFP_KERNEL); 496172e6ab1SSuman Anna if (!trace) 497400e64dfSOhad Ben-Cohen return -ENOMEM; 498400e64dfSOhad Ben-Cohen 499400e64dfSOhad Ben-Cohen /* set the trace buffer dma properties */ 500400e64dfSOhad Ben-Cohen trace->len = rsc->len; 501400e64dfSOhad Ben-Cohen trace->va = ptr; 502400e64dfSOhad Ben-Cohen 503400e64dfSOhad Ben-Cohen /* make sure snprintf always null terminates, even if truncating */ 504400e64dfSOhad Ben-Cohen snprintf(name, sizeof(name), "trace%d", rproc->num_traces); 505400e64dfSOhad Ben-Cohen 506400e64dfSOhad Ben-Cohen /* create the debugfs entry */ 507400e64dfSOhad Ben-Cohen trace->priv = rproc_create_trace_file(name, rproc, trace); 508400e64dfSOhad Ben-Cohen if (!trace->priv) { 509400e64dfSOhad Ben-Cohen trace->va = NULL; 510400e64dfSOhad Ben-Cohen kfree(trace); 511400e64dfSOhad Ben-Cohen return -EINVAL; 512400e64dfSOhad Ben-Cohen } 513400e64dfSOhad Ben-Cohen 514400e64dfSOhad Ben-Cohen list_add_tail(&trace->node, &rproc->traces); 515400e64dfSOhad Ben-Cohen 516400e64dfSOhad Ben-Cohen rproc->num_traces++; 517400e64dfSOhad Ben-Cohen 518276ec993SLoic Pallardy dev_dbg(dev, "%s added: va %pK, da 0x%x, len 0x%x\n", 51935386166SLee Jones name, ptr, rsc->da, rsc->len); 520400e64dfSOhad Ben-Cohen 521400e64dfSOhad Ben-Cohen return 0; 522400e64dfSOhad Ben-Cohen } 523400e64dfSOhad Ben-Cohen 524400e64dfSOhad Ben-Cohen /** 525400e64dfSOhad Ben-Cohen * rproc_handle_devmem() - handle devmem resource entry 526400e64dfSOhad Ben-Cohen * @rproc: remote processor handle 527400e64dfSOhad Ben-Cohen * @rsc: the devmem resource entry 528fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for sanity checking the image) 529400e64dfSOhad Ben-Cohen * 530400e64dfSOhad Ben-Cohen * Remote processors commonly need to access certain on-chip peripherals. 531400e64dfSOhad Ben-Cohen * 532400e64dfSOhad Ben-Cohen * Some of these remote processors access memory via an iommu device, 533400e64dfSOhad Ben-Cohen * and might require us to configure their iommu before they can access 534400e64dfSOhad Ben-Cohen * the on-chip peripherals they need. 535400e64dfSOhad Ben-Cohen * 536400e64dfSOhad Ben-Cohen * This resource entry is a request to map such a peripheral device. 537400e64dfSOhad Ben-Cohen * 538400e64dfSOhad Ben-Cohen * These devmem entries will contain the physical address of the device in 539400e64dfSOhad Ben-Cohen * the 'pa' member. If a specific device address is expected, then 'da' will 540400e64dfSOhad Ben-Cohen * contain it (currently this is the only use case supported). 'len' will 541400e64dfSOhad Ben-Cohen * contain the size of the physical region we need to map. 542400e64dfSOhad Ben-Cohen * 543400e64dfSOhad Ben-Cohen * Currently we just "trust" those devmem entries to contain valid physical 544400e64dfSOhad Ben-Cohen * addresses, but this is going to change: we want the implementations to 545400e64dfSOhad Ben-Cohen * tell us ranges of physical addresses the firmware is allowed to request, 546400e64dfSOhad Ben-Cohen * and not allow firmwares to request access to physical addresses that 547400e64dfSOhad Ben-Cohen * are outside those ranges. 548400e64dfSOhad Ben-Cohen */ 549fd2c15ecSOhad Ben-Cohen static int rproc_handle_devmem(struct rproc *rproc, struct fw_rsc_devmem *rsc, 550a2b950acSOhad Ben-Cohen int offset, int avail) 551400e64dfSOhad Ben-Cohen { 552400e64dfSOhad Ben-Cohen struct rproc_mem_entry *mapping; 553b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 554400e64dfSOhad Ben-Cohen int ret; 555400e64dfSOhad Ben-Cohen 556400e64dfSOhad Ben-Cohen /* no point in handling this resource without a valid iommu domain */ 557400e64dfSOhad Ben-Cohen if (!rproc->domain) 558400e64dfSOhad Ben-Cohen return -EINVAL; 559400e64dfSOhad Ben-Cohen 560fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 561b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc is truncated\n"); 562fd2c15ecSOhad Ben-Cohen return -EINVAL; 563fd2c15ecSOhad Ben-Cohen } 564fd2c15ecSOhad Ben-Cohen 565fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 566fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 567b5ab5e24SOhad Ben-Cohen dev_err(dev, "devmem rsc has non zero reserved bytes\n"); 568fd2c15ecSOhad Ben-Cohen return -EINVAL; 569fd2c15ecSOhad Ben-Cohen } 570fd2c15ecSOhad Ben-Cohen 571400e64dfSOhad Ben-Cohen mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 572172e6ab1SSuman Anna if (!mapping) 573400e64dfSOhad Ben-Cohen return -ENOMEM; 574400e64dfSOhad Ben-Cohen 575400e64dfSOhad Ben-Cohen ret = iommu_map(rproc->domain, rsc->da, rsc->pa, rsc->len, rsc->flags); 576400e64dfSOhad Ben-Cohen if (ret) { 577b5ab5e24SOhad Ben-Cohen dev_err(dev, "failed to map devmem: %d\n", ret); 578400e64dfSOhad Ben-Cohen goto out; 579400e64dfSOhad Ben-Cohen } 580400e64dfSOhad Ben-Cohen 581400e64dfSOhad Ben-Cohen /* 582400e64dfSOhad Ben-Cohen * We'll need this info later when we'll want to unmap everything 583400e64dfSOhad Ben-Cohen * (e.g. on shutdown). 584400e64dfSOhad Ben-Cohen * 585400e64dfSOhad Ben-Cohen * We can't trust the remote processor not to change the resource 586400e64dfSOhad Ben-Cohen * table, so we must maintain this info independently. 587400e64dfSOhad Ben-Cohen */ 588400e64dfSOhad Ben-Cohen mapping->da = rsc->da; 589400e64dfSOhad Ben-Cohen mapping->len = rsc->len; 590400e64dfSOhad Ben-Cohen list_add_tail(&mapping->node, &rproc->mappings); 591400e64dfSOhad Ben-Cohen 592b5ab5e24SOhad Ben-Cohen dev_dbg(dev, "mapped devmem pa 0x%x, da 0x%x, len 0x%x\n", 593400e64dfSOhad Ben-Cohen rsc->pa, rsc->da, rsc->len); 594400e64dfSOhad Ben-Cohen 595400e64dfSOhad Ben-Cohen return 0; 596400e64dfSOhad Ben-Cohen 597400e64dfSOhad Ben-Cohen out: 598400e64dfSOhad Ben-Cohen kfree(mapping); 599400e64dfSOhad Ben-Cohen return ret; 600400e64dfSOhad Ben-Cohen } 601400e64dfSOhad Ben-Cohen 602400e64dfSOhad Ben-Cohen /** 603400e64dfSOhad Ben-Cohen * rproc_handle_carveout() - handle phys contig memory allocation requests 604400e64dfSOhad Ben-Cohen * @rproc: rproc handle 605400e64dfSOhad Ben-Cohen * @rsc: the resource entry 606fd2c15ecSOhad Ben-Cohen * @avail: size of available data (for image validation) 607400e64dfSOhad Ben-Cohen * 608400e64dfSOhad Ben-Cohen * This function will handle firmware requests for allocation of physically 609400e64dfSOhad Ben-Cohen * contiguous memory regions. 610400e64dfSOhad Ben-Cohen * 611400e64dfSOhad Ben-Cohen * These request entries should come first in the firmware's resource table, 612400e64dfSOhad Ben-Cohen * as other firmware entries might request placing other data objects inside 613400e64dfSOhad Ben-Cohen * these memory regions (e.g. data/code segments, trace resource entries, ...). 614400e64dfSOhad Ben-Cohen * 615400e64dfSOhad Ben-Cohen * Allocating memory this way helps utilizing the reserved physical memory 616400e64dfSOhad Ben-Cohen * (e.g. CMA) more efficiently, and also minimizes the number of TLB entries 617400e64dfSOhad Ben-Cohen * needed to map it (in case @rproc is using an IOMMU). Reducing the TLB 618400e64dfSOhad Ben-Cohen * pressure is important; it may have a substantial impact on performance. 619400e64dfSOhad Ben-Cohen */ 620fd2c15ecSOhad Ben-Cohen static int rproc_handle_carveout(struct rproc *rproc, 621a2b950acSOhad Ben-Cohen struct fw_rsc_carveout *rsc, 622a2b950acSOhad Ben-Cohen int offset, int avail) 623400e64dfSOhad Ben-Cohen { 624400e64dfSOhad Ben-Cohen struct rproc_mem_entry *carveout, *mapping; 625b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 626400e64dfSOhad Ben-Cohen dma_addr_t dma; 627400e64dfSOhad Ben-Cohen void *va; 628400e64dfSOhad Ben-Cohen int ret; 629400e64dfSOhad Ben-Cohen 630fd2c15ecSOhad Ben-Cohen if (sizeof(*rsc) > avail) { 631b5ab5e24SOhad Ben-Cohen dev_err(dev, "carveout rsc is truncated\n"); 632fd2c15ecSOhad Ben-Cohen return -EINVAL; 633fd2c15ecSOhad Ben-Cohen } 634fd2c15ecSOhad Ben-Cohen 635fd2c15ecSOhad Ben-Cohen /* make sure reserved bytes are zeroes */ 636fd2c15ecSOhad Ben-Cohen if (rsc->reserved) { 637fd2c15ecSOhad Ben-Cohen dev_err(dev, "carveout rsc has non zero reserved bytes\n"); 638fd2c15ecSOhad Ben-Cohen return -EINVAL; 639fd2c15ecSOhad Ben-Cohen } 640fd2c15ecSOhad Ben-Cohen 6419d7814a9SAnna, Suman dev_dbg(dev, "carveout rsc: name: %s, da 0x%x, pa 0x%x, len 0x%x, flags 0x%x\n", 64235386166SLee Jones rsc->name, rsc->da, rsc->pa, rsc->len, rsc->flags); 643fd2c15ecSOhad Ben-Cohen 644400e64dfSOhad Ben-Cohen carveout = kzalloc(sizeof(*carveout), GFP_KERNEL); 645172e6ab1SSuman Anna if (!carveout) 6467168d914SDan Carpenter return -ENOMEM; 647400e64dfSOhad Ben-Cohen 648b5ab5e24SOhad Ben-Cohen va = dma_alloc_coherent(dev->parent, rsc->len, &dma, GFP_KERNEL); 649400e64dfSOhad Ben-Cohen if (!va) { 6509c219b23SLee Jones dev_err(dev->parent, 6519c219b23SLee Jones "failed to allocate dma memory: len 0x%x\n", rsc->len); 652400e64dfSOhad Ben-Cohen ret = -ENOMEM; 653400e64dfSOhad Ben-Cohen goto free_carv; 654400e64dfSOhad Ben-Cohen } 655400e64dfSOhad Ben-Cohen 656276ec993SLoic Pallardy dev_dbg(dev, "carveout va %pK, dma %pad, len 0x%x\n", 657b605ed8bSAnna, Suman va, &dma, rsc->len); 658400e64dfSOhad Ben-Cohen 659400e64dfSOhad Ben-Cohen /* 660400e64dfSOhad Ben-Cohen * Ok, this is non-standard. 661400e64dfSOhad Ben-Cohen * 662400e64dfSOhad Ben-Cohen * Sometimes we can't rely on the generic iommu-based DMA API 663400e64dfSOhad Ben-Cohen * to dynamically allocate the device address and then set the IOMMU 664400e64dfSOhad Ben-Cohen * tables accordingly, because some remote processors might 665400e64dfSOhad Ben-Cohen * _require_ us to use hard coded device addresses that their 666400e64dfSOhad Ben-Cohen * firmware was compiled with. 667400e64dfSOhad Ben-Cohen * 668400e64dfSOhad Ben-Cohen * In this case, we must use the IOMMU API directly and map 669400e64dfSOhad Ben-Cohen * the memory to the device address as expected by the remote 670400e64dfSOhad Ben-Cohen * processor. 671400e64dfSOhad Ben-Cohen * 672400e64dfSOhad Ben-Cohen * Obviously such remote processor devices should not be configured 673400e64dfSOhad Ben-Cohen * to use the iommu-based DMA API: we expect 'dma' to contain the 674400e64dfSOhad Ben-Cohen * physical address in this case. 675400e64dfSOhad Ben-Cohen */ 6763bc8140bSLoic Pallardy 6773bc8140bSLoic Pallardy if (rsc->da != FW_RSC_ADDR_ANY && !rproc->domain) { 6783bc8140bSLoic Pallardy dev_err(dev->parent, 6793bc8140bSLoic Pallardy "Bad carveout rsc configuration\n"); 6803bc8140bSLoic Pallardy ret = -ENOMEM; 6813bc8140bSLoic Pallardy goto dma_free; 6823bc8140bSLoic Pallardy } 6833bc8140bSLoic Pallardy 6843bc8140bSLoic Pallardy if (rsc->da != FW_RSC_ADDR_ANY && rproc->domain) { 6857168d914SDan Carpenter mapping = kzalloc(sizeof(*mapping), GFP_KERNEL); 6867168d914SDan Carpenter if (!mapping) { 6877168d914SDan Carpenter ret = -ENOMEM; 6887168d914SDan Carpenter goto dma_free; 6897168d914SDan Carpenter } 6907168d914SDan Carpenter 691400e64dfSOhad Ben-Cohen ret = iommu_map(rproc->domain, rsc->da, dma, rsc->len, 692400e64dfSOhad Ben-Cohen rsc->flags); 693400e64dfSOhad Ben-Cohen if (ret) { 694400e64dfSOhad Ben-Cohen dev_err(dev, "iommu_map failed: %d\n", ret); 6957168d914SDan Carpenter goto free_mapping; 696400e64dfSOhad Ben-Cohen } 697400e64dfSOhad Ben-Cohen 698400e64dfSOhad Ben-Cohen /* 699400e64dfSOhad Ben-Cohen * We'll need this info later when we'll want to unmap 700400e64dfSOhad Ben-Cohen * everything (e.g. on shutdown). 701400e64dfSOhad Ben-Cohen * 702400e64dfSOhad Ben-Cohen * We can't trust the remote processor not to change the 703400e64dfSOhad Ben-Cohen * resource table, so we must maintain this info independently. 704400e64dfSOhad Ben-Cohen */ 705400e64dfSOhad Ben-Cohen mapping->da = rsc->da; 706400e64dfSOhad Ben-Cohen mapping->len = rsc->len; 707400e64dfSOhad Ben-Cohen list_add_tail(&mapping->node, &rproc->mappings); 708400e64dfSOhad Ben-Cohen 709b605ed8bSAnna, Suman dev_dbg(dev, "carveout mapped 0x%x to %pad\n", 710b605ed8bSAnna, Suman rsc->da, &dma); 7110e49b72cSOhad Ben-Cohen } 712400e64dfSOhad Ben-Cohen 713400e64dfSOhad Ben-Cohen /* 714400e64dfSOhad Ben-Cohen * Some remote processors might need to know the pa 715400e64dfSOhad Ben-Cohen * even though they are behind an IOMMU. E.g., OMAP4's 716400e64dfSOhad Ben-Cohen * remote M3 processor needs this so it can control 717400e64dfSOhad Ben-Cohen * on-chip hardware accelerators that are not behind 718400e64dfSOhad Ben-Cohen * the IOMMU, and therefor must know the pa. 719400e64dfSOhad Ben-Cohen * 720400e64dfSOhad Ben-Cohen * Generally we don't want to expose physical addresses 721400e64dfSOhad Ben-Cohen * if we don't have to (remote processors are generally 722400e64dfSOhad Ben-Cohen * _not_ trusted), so we might want to do this only for 723400e64dfSOhad Ben-Cohen * remote processor that _must_ have this (e.g. OMAP4's 724400e64dfSOhad Ben-Cohen * dual M3 subsystem). 7250e49b72cSOhad Ben-Cohen * 7260e49b72cSOhad Ben-Cohen * Non-IOMMU processors might also want to have this info. 7270e49b72cSOhad Ben-Cohen * In this case, the device address and the physical address 7280e49b72cSOhad Ben-Cohen * are the same. 729400e64dfSOhad Ben-Cohen */ 730eb30596eSLoic Pallardy rsc->pa = (u32)rproc_va_to_pa(va); 731400e64dfSOhad Ben-Cohen 732400e64dfSOhad Ben-Cohen carveout->va = va; 733400e64dfSOhad Ben-Cohen carveout->len = rsc->len; 734400e64dfSOhad Ben-Cohen carveout->dma = dma; 735400e64dfSOhad Ben-Cohen carveout->da = rsc->da; 736400e64dfSOhad Ben-Cohen 737400e64dfSOhad Ben-Cohen list_add_tail(&carveout->node, &rproc->carveouts); 738400e64dfSOhad Ben-Cohen 739400e64dfSOhad Ben-Cohen return 0; 740400e64dfSOhad Ben-Cohen 7417168d914SDan Carpenter free_mapping: 7427168d914SDan Carpenter kfree(mapping); 743400e64dfSOhad Ben-Cohen dma_free: 744b5ab5e24SOhad Ben-Cohen dma_free_coherent(dev->parent, rsc->len, va, dma); 745400e64dfSOhad Ben-Cohen free_carv: 746400e64dfSOhad Ben-Cohen kfree(carveout); 747400e64dfSOhad Ben-Cohen return ret; 748400e64dfSOhad Ben-Cohen } 749400e64dfSOhad Ben-Cohen 750e12bc14bSOhad Ben-Cohen /* 751e12bc14bSOhad Ben-Cohen * A lookup table for resource handlers. The indices are defined in 752e12bc14bSOhad Ben-Cohen * enum fw_resource_type. 753e12bc14bSOhad Ben-Cohen */ 754232fcdbbSSjur Brændeland static rproc_handle_resource_t rproc_loading_handlers[RSC_LAST] = { 755fd2c15ecSOhad Ben-Cohen [RSC_CARVEOUT] = (rproc_handle_resource_t)rproc_handle_carveout, 756fd2c15ecSOhad Ben-Cohen [RSC_DEVMEM] = (rproc_handle_resource_t)rproc_handle_devmem, 757fd2c15ecSOhad Ben-Cohen [RSC_TRACE] = (rproc_handle_resource_t)rproc_handle_trace, 758232fcdbbSSjur Brændeland [RSC_VDEV] = (rproc_handle_resource_t)rproc_handle_vdev, 759232fcdbbSSjur Brændeland }; 760232fcdbbSSjur Brændeland 761400e64dfSOhad Ben-Cohen /* handle firmware resource entries before booting the remote processor */ 762a4b24c75SBjorn Andersson static int rproc_handle_resources(struct rproc *rproc, 763232fcdbbSSjur Brændeland rproc_handle_resource_t handlers[RSC_LAST]) 764400e64dfSOhad Ben-Cohen { 765b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 766e12bc14bSOhad Ben-Cohen rproc_handle_resource_t handler; 767fd2c15ecSOhad Ben-Cohen int ret = 0, i; 768400e64dfSOhad Ben-Cohen 769d4bb86f2SBjorn Andersson if (!rproc->table_ptr) 770d4bb86f2SBjorn Andersson return 0; 771d4bb86f2SBjorn Andersson 772a2b950acSOhad Ben-Cohen for (i = 0; i < rproc->table_ptr->num; i++) { 773a2b950acSOhad Ben-Cohen int offset = rproc->table_ptr->offset[i]; 774a2b950acSOhad Ben-Cohen struct fw_rsc_hdr *hdr = (void *)rproc->table_ptr + offset; 775a4b24c75SBjorn Andersson int avail = rproc->table_sz - offset - sizeof(*hdr); 776fd2c15ecSOhad Ben-Cohen void *rsc = (void *)hdr + sizeof(*hdr); 777400e64dfSOhad Ben-Cohen 778fd2c15ecSOhad Ben-Cohen /* make sure table isn't truncated */ 779fd2c15ecSOhad Ben-Cohen if (avail < 0) { 780fd2c15ecSOhad Ben-Cohen dev_err(dev, "rsc table is truncated\n"); 781fd2c15ecSOhad Ben-Cohen return -EINVAL; 782fd2c15ecSOhad Ben-Cohen } 783fd2c15ecSOhad Ben-Cohen 784fd2c15ecSOhad Ben-Cohen dev_dbg(dev, "rsc: type %d\n", hdr->type); 785fd2c15ecSOhad Ben-Cohen 786fd2c15ecSOhad Ben-Cohen if (hdr->type >= RSC_LAST) { 787fd2c15ecSOhad Ben-Cohen dev_warn(dev, "unsupported resource %d\n", hdr->type); 788e12bc14bSOhad Ben-Cohen continue; 789400e64dfSOhad Ben-Cohen } 790400e64dfSOhad Ben-Cohen 791232fcdbbSSjur Brændeland handler = handlers[hdr->type]; 792e12bc14bSOhad Ben-Cohen if (!handler) 793e12bc14bSOhad Ben-Cohen continue; 794e12bc14bSOhad Ben-Cohen 795a2b950acSOhad Ben-Cohen ret = handler(rproc, rsc, offset + sizeof(*hdr), avail); 7967a186941SOhad Ben-Cohen if (ret) 797400e64dfSOhad Ben-Cohen break; 798400e64dfSOhad Ben-Cohen } 799400e64dfSOhad Ben-Cohen 800400e64dfSOhad Ben-Cohen return ret; 801400e64dfSOhad Ben-Cohen } 802400e64dfSOhad Ben-Cohen 803c455daa4SBjorn Andersson static int rproc_prepare_subdevices(struct rproc *rproc) 804c455daa4SBjorn Andersson { 805c455daa4SBjorn Andersson struct rproc_subdev *subdev; 806c455daa4SBjorn Andersson int ret; 807c455daa4SBjorn Andersson 808c455daa4SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 809c455daa4SBjorn Andersson if (subdev->prepare) { 810c455daa4SBjorn Andersson ret = subdev->prepare(subdev); 811c455daa4SBjorn Andersson if (ret) 812c455daa4SBjorn Andersson goto unroll_preparation; 813c455daa4SBjorn Andersson } 814c455daa4SBjorn Andersson } 815c455daa4SBjorn Andersson 816c455daa4SBjorn Andersson return 0; 817c455daa4SBjorn Andersson 818c455daa4SBjorn Andersson unroll_preparation: 819c455daa4SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 820c455daa4SBjorn Andersson if (subdev->unprepare) 821c455daa4SBjorn Andersson subdev->unprepare(subdev); 822c455daa4SBjorn Andersson } 823c455daa4SBjorn Andersson 824c455daa4SBjorn Andersson return ret; 825c455daa4SBjorn Andersson } 826c455daa4SBjorn Andersson 827618fcff3SBjorn Andersson static int rproc_start_subdevices(struct rproc *rproc) 8287bdc9650SBjorn Andersson { 8297bdc9650SBjorn Andersson struct rproc_subdev *subdev; 8307bdc9650SBjorn Andersson int ret; 8317bdc9650SBjorn Andersson 8327bdc9650SBjorn Andersson list_for_each_entry(subdev, &rproc->subdevs, node) { 833be37b1e0SBjorn Andersson if (subdev->start) { 834618fcff3SBjorn Andersson ret = subdev->start(subdev); 8357bdc9650SBjorn Andersson if (ret) 8367bdc9650SBjorn Andersson goto unroll_registration; 8377bdc9650SBjorn Andersson } 838be37b1e0SBjorn Andersson } 8397bdc9650SBjorn Andersson 8407bdc9650SBjorn Andersson return 0; 8417bdc9650SBjorn Andersson 8427bdc9650SBjorn Andersson unroll_registration: 843be37b1e0SBjorn Andersson list_for_each_entry_continue_reverse(subdev, &rproc->subdevs, node) { 844be37b1e0SBjorn Andersson if (subdev->stop) 845618fcff3SBjorn Andersson subdev->stop(subdev, true); 846be37b1e0SBjorn Andersson } 8477bdc9650SBjorn Andersson 8487bdc9650SBjorn Andersson return ret; 8497bdc9650SBjorn Andersson } 8507bdc9650SBjorn Andersson 851618fcff3SBjorn Andersson static void rproc_stop_subdevices(struct rproc *rproc, bool crashed) 8527bdc9650SBjorn Andersson { 8537bdc9650SBjorn Andersson struct rproc_subdev *subdev; 8547bdc9650SBjorn Andersson 855be37b1e0SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 856be37b1e0SBjorn Andersson if (subdev->stop) 857618fcff3SBjorn Andersson subdev->stop(subdev, crashed); 8587bdc9650SBjorn Andersson } 859be37b1e0SBjorn Andersson } 8607bdc9650SBjorn Andersson 861c455daa4SBjorn Andersson static void rproc_unprepare_subdevices(struct rproc *rproc) 862c455daa4SBjorn Andersson { 863c455daa4SBjorn Andersson struct rproc_subdev *subdev; 864c455daa4SBjorn Andersson 865c455daa4SBjorn Andersson list_for_each_entry_reverse(subdev, &rproc->subdevs, node) { 866c455daa4SBjorn Andersson if (subdev->unprepare) 867c455daa4SBjorn Andersson subdev->unprepare(subdev); 868c455daa4SBjorn Andersson } 869c455daa4SBjorn Andersson } 870c455daa4SBjorn Andersson 871400e64dfSOhad Ben-Cohen /** 8722666ca91SSarangdhar Joshi * rproc_coredump_cleanup() - clean up dump_segments list 8732666ca91SSarangdhar Joshi * @rproc: the remote processor handle 8742666ca91SSarangdhar Joshi */ 8752666ca91SSarangdhar Joshi static void rproc_coredump_cleanup(struct rproc *rproc) 8762666ca91SSarangdhar Joshi { 8772666ca91SSarangdhar Joshi struct rproc_dump_segment *entry, *tmp; 8782666ca91SSarangdhar Joshi 8792666ca91SSarangdhar Joshi list_for_each_entry_safe(entry, tmp, &rproc->dump_segments, node) { 8802666ca91SSarangdhar Joshi list_del(&entry->node); 8812666ca91SSarangdhar Joshi kfree(entry); 8822666ca91SSarangdhar Joshi } 8832666ca91SSarangdhar Joshi } 8842666ca91SSarangdhar Joshi 8852666ca91SSarangdhar Joshi /** 886400e64dfSOhad Ben-Cohen * rproc_resource_cleanup() - clean up and free all acquired resources 887400e64dfSOhad Ben-Cohen * @rproc: rproc handle 888400e64dfSOhad Ben-Cohen * 889400e64dfSOhad Ben-Cohen * This function will free all resources acquired for @rproc, and it 8907a186941SOhad Ben-Cohen * is called whenever @rproc either shuts down or fails to boot. 891400e64dfSOhad Ben-Cohen */ 892400e64dfSOhad Ben-Cohen static void rproc_resource_cleanup(struct rproc *rproc) 893400e64dfSOhad Ben-Cohen { 894400e64dfSOhad Ben-Cohen struct rproc_mem_entry *entry, *tmp; 895d81fb32fSBjorn Andersson struct rproc_vdev *rvdev, *rvtmp; 896b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 897400e64dfSOhad Ben-Cohen 898400e64dfSOhad Ben-Cohen /* clean up debugfs trace entries */ 899400e64dfSOhad Ben-Cohen list_for_each_entry_safe(entry, tmp, &rproc->traces, node) { 900400e64dfSOhad Ben-Cohen rproc_remove_trace_file(entry->priv); 901400e64dfSOhad Ben-Cohen rproc->num_traces--; 902400e64dfSOhad Ben-Cohen list_del(&entry->node); 903400e64dfSOhad Ben-Cohen kfree(entry); 904400e64dfSOhad Ben-Cohen } 905400e64dfSOhad Ben-Cohen 906400e64dfSOhad Ben-Cohen /* clean up iommu mapping entries */ 907400e64dfSOhad Ben-Cohen list_for_each_entry_safe(entry, tmp, &rproc->mappings, node) { 908400e64dfSOhad Ben-Cohen size_t unmapped; 909400e64dfSOhad Ben-Cohen 910400e64dfSOhad Ben-Cohen unmapped = iommu_unmap(rproc->domain, entry->da, entry->len); 911400e64dfSOhad Ben-Cohen if (unmapped != entry->len) { 912400e64dfSOhad Ben-Cohen /* nothing much to do besides complaining */ 913e981f6d4SSjur Brændeland dev_err(dev, "failed to unmap %u/%zu\n", entry->len, 914400e64dfSOhad Ben-Cohen unmapped); 915400e64dfSOhad Ben-Cohen } 916400e64dfSOhad Ben-Cohen 917400e64dfSOhad Ben-Cohen list_del(&entry->node); 918400e64dfSOhad Ben-Cohen kfree(entry); 919400e64dfSOhad Ben-Cohen } 920b6356a01SSuman Anna 921b6356a01SSuman Anna /* clean up carveout allocations */ 922b6356a01SSuman Anna list_for_each_entry_safe(entry, tmp, &rproc->carveouts, node) { 923172e6ab1SSuman Anna dma_free_coherent(dev->parent, entry->len, entry->va, 924172e6ab1SSuman Anna entry->dma); 925b6356a01SSuman Anna list_del(&entry->node); 926b6356a01SSuman Anna kfree(entry); 927b6356a01SSuman Anna } 928d81fb32fSBjorn Andersson 929d81fb32fSBjorn Andersson /* clean up remote vdev entries */ 930f5bcb353SBjorn Andersson list_for_each_entry_safe(rvdev, rvtmp, &rproc->rvdevs, node) 9312b45cef5SBjorn Andersson kref_put(&rvdev->refcount, rproc_vdev_release); 9322666ca91SSarangdhar Joshi 9332666ca91SSarangdhar Joshi rproc_coredump_cleanup(rproc); 9342b45cef5SBjorn Andersson } 935400e64dfSOhad Ben-Cohen 9361efa30d0SSarangdhar Joshi static int rproc_start(struct rproc *rproc, const struct firmware *fw) 9371efa30d0SSarangdhar Joshi { 938a4b24c75SBjorn Andersson struct resource_table *loaded_table; 9391efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 940a4b24c75SBjorn Andersson int ret; 9411efa30d0SSarangdhar Joshi 9421efa30d0SSarangdhar Joshi /* load the ELF segments to memory */ 9431efa30d0SSarangdhar Joshi ret = rproc_load_segments(rproc, fw); 9441efa30d0SSarangdhar Joshi if (ret) { 9451efa30d0SSarangdhar Joshi dev_err(dev, "Failed to load program segments: %d\n", ret); 9461efa30d0SSarangdhar Joshi return ret; 9471efa30d0SSarangdhar Joshi } 9481efa30d0SSarangdhar Joshi 9491efa30d0SSarangdhar Joshi /* 9501efa30d0SSarangdhar Joshi * The starting device has been given the rproc->cached_table as the 9511efa30d0SSarangdhar Joshi * resource table. The address of the vring along with the other 9521efa30d0SSarangdhar Joshi * allocated resources (carveouts etc) is stored in cached_table. 9531efa30d0SSarangdhar Joshi * In order to pass this information to the remote device we must copy 9541efa30d0SSarangdhar Joshi * this information to device memory. We also update the table_ptr so 9551efa30d0SSarangdhar Joshi * that any subsequent changes will be applied to the loaded version. 9561efa30d0SSarangdhar Joshi */ 9571efa30d0SSarangdhar Joshi loaded_table = rproc_find_loaded_rsc_table(rproc, fw); 9581efa30d0SSarangdhar Joshi if (loaded_table) { 959a4b24c75SBjorn Andersson memcpy(loaded_table, rproc->cached_table, rproc->table_sz); 9601efa30d0SSarangdhar Joshi rproc->table_ptr = loaded_table; 9611efa30d0SSarangdhar Joshi } 9621efa30d0SSarangdhar Joshi 963c455daa4SBjorn Andersson ret = rproc_prepare_subdevices(rproc); 964c455daa4SBjorn Andersson if (ret) { 965c455daa4SBjorn Andersson dev_err(dev, "failed to prepare subdevices for %s: %d\n", 966c455daa4SBjorn Andersson rproc->name, ret); 967f68d51bdSSuman Anna goto reset_table_ptr; 968c455daa4SBjorn Andersson } 969c455daa4SBjorn Andersson 9701efa30d0SSarangdhar Joshi /* power up the remote processor */ 9711efa30d0SSarangdhar Joshi ret = rproc->ops->start(rproc); 9721efa30d0SSarangdhar Joshi if (ret) { 9731efa30d0SSarangdhar Joshi dev_err(dev, "can't start rproc %s: %d\n", rproc->name, ret); 974c455daa4SBjorn Andersson goto unprepare_subdevices; 9751efa30d0SSarangdhar Joshi } 9761efa30d0SSarangdhar Joshi 977618fcff3SBjorn Andersson /* Start any subdevices for the remote processor */ 978618fcff3SBjorn Andersson ret = rproc_start_subdevices(rproc); 9791efa30d0SSarangdhar Joshi if (ret) { 9801efa30d0SSarangdhar Joshi dev_err(dev, "failed to probe subdevices for %s: %d\n", 9811efa30d0SSarangdhar Joshi rproc->name, ret); 982c455daa4SBjorn Andersson goto stop_rproc; 9831efa30d0SSarangdhar Joshi } 9841efa30d0SSarangdhar Joshi 9851efa30d0SSarangdhar Joshi rproc->state = RPROC_RUNNING; 9861efa30d0SSarangdhar Joshi 9871efa30d0SSarangdhar Joshi dev_info(dev, "remote processor %s is now up\n", rproc->name); 9881efa30d0SSarangdhar Joshi 9891efa30d0SSarangdhar Joshi return 0; 990c455daa4SBjorn Andersson 991c455daa4SBjorn Andersson stop_rproc: 992c455daa4SBjorn Andersson rproc->ops->stop(rproc); 993c455daa4SBjorn Andersson unprepare_subdevices: 994c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 995f68d51bdSSuman Anna reset_table_ptr: 996f68d51bdSSuman Anna rproc->table_ptr = rproc->cached_table; 997c455daa4SBjorn Andersson 998c455daa4SBjorn Andersson return ret; 9991efa30d0SSarangdhar Joshi } 10001efa30d0SSarangdhar Joshi 1001400e64dfSOhad Ben-Cohen /* 1002400e64dfSOhad Ben-Cohen * take a firmware and boot a remote processor with it. 1003400e64dfSOhad Ben-Cohen */ 1004400e64dfSOhad Ben-Cohen static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw) 1005400e64dfSOhad Ben-Cohen { 1006b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1007400e64dfSOhad Ben-Cohen const char *name = rproc->firmware; 100858b64090SBjorn Andersson int ret; 1009400e64dfSOhad Ben-Cohen 1010400e64dfSOhad Ben-Cohen ret = rproc_fw_sanity_check(rproc, fw); 1011400e64dfSOhad Ben-Cohen if (ret) 1012400e64dfSOhad Ben-Cohen return ret; 1013400e64dfSOhad Ben-Cohen 1014e981f6d4SSjur Brændeland dev_info(dev, "Booting fw image %s, size %zd\n", name, fw->size); 1015400e64dfSOhad Ben-Cohen 1016400e64dfSOhad Ben-Cohen /* 1017400e64dfSOhad Ben-Cohen * if enabling an IOMMU isn't relevant for this rproc, this is 1018400e64dfSOhad Ben-Cohen * just a nop 1019400e64dfSOhad Ben-Cohen */ 1020400e64dfSOhad Ben-Cohen ret = rproc_enable_iommu(rproc); 1021400e64dfSOhad Ben-Cohen if (ret) { 1022400e64dfSOhad Ben-Cohen dev_err(dev, "can't enable iommu: %d\n", ret); 1023400e64dfSOhad Ben-Cohen return ret; 1024400e64dfSOhad Ben-Cohen } 1025400e64dfSOhad Ben-Cohen 10263e5f9eb5SSjur Brændeland rproc->bootaddr = rproc_get_boot_addr(rproc, fw); 1027400e64dfSOhad Ben-Cohen 1028c1d35c1aSBjorn Andersson /* Load resource table, core dump segment list etc from the firmware */ 1029c1d35c1aSBjorn Andersson ret = rproc_parse_fw(rproc, fw); 103058b64090SBjorn Andersson if (ret) 103158b64090SBjorn Andersson goto disable_iommu; 1032a0c10687SBjorn Andersson 1033b35d7afcSBjorn Andersson /* reset max_notifyid */ 1034b35d7afcSBjorn Andersson rproc->max_notifyid = -1; 1035b35d7afcSBjorn Andersson 1036400e64dfSOhad Ben-Cohen /* handle fw resources which are required to boot rproc */ 1037a4b24c75SBjorn Andersson ret = rproc_handle_resources(rproc, rproc_loading_handlers); 1038400e64dfSOhad Ben-Cohen if (ret) { 1039400e64dfSOhad Ben-Cohen dev_err(dev, "Failed to process resources: %d\n", ret); 1040229b85a6SBjorn Andersson goto clean_up_resources; 1041400e64dfSOhad Ben-Cohen } 1042400e64dfSOhad Ben-Cohen 10431efa30d0SSarangdhar Joshi ret = rproc_start(rproc, fw); 10441efa30d0SSarangdhar Joshi if (ret) 1045229b85a6SBjorn Andersson goto clean_up_resources; 1046400e64dfSOhad Ben-Cohen 1047400e64dfSOhad Ben-Cohen return 0; 1048400e64dfSOhad Ben-Cohen 1049229b85a6SBjorn Andersson clean_up_resources: 1050229b85a6SBjorn Andersson rproc_resource_cleanup(rproc); 1051a0c10687SBjorn Andersson kfree(rproc->cached_table); 1052a0c10687SBjorn Andersson rproc->cached_table = NULL; 1053988d204cSBjorn Andersson rproc->table_ptr = NULL; 105458b64090SBjorn Andersson disable_iommu: 1055400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 1056400e64dfSOhad Ben-Cohen return ret; 1057400e64dfSOhad Ben-Cohen } 1058400e64dfSOhad Ben-Cohen 1059400e64dfSOhad Ben-Cohen /* 10605e6533f7SSarangdhar Joshi * take a firmware and boot it up. 1061400e64dfSOhad Ben-Cohen * 1062400e64dfSOhad Ben-Cohen * Note: this function is called asynchronously upon registration of the 1063400e64dfSOhad Ben-Cohen * remote processor (so we must wait until it completes before we try 1064400e64dfSOhad Ben-Cohen * to unregister the device. one other option is just to use kref here, 1065400e64dfSOhad Ben-Cohen * that might be cleaner). 1066400e64dfSOhad Ben-Cohen */ 10675e6533f7SSarangdhar Joshi static void rproc_auto_boot_callback(const struct firmware *fw, void *context) 1068400e64dfSOhad Ben-Cohen { 1069400e64dfSOhad Ben-Cohen struct rproc *rproc = context; 1070a2b950acSOhad Ben-Cohen 10712bfc311aSBjorn Andersson rproc_boot(rproc); 1072ddf71187SBjorn Andersson 1073400e64dfSOhad Ben-Cohen release_firmware(fw); 1074400e64dfSOhad Ben-Cohen } 1075400e64dfSOhad Ben-Cohen 10765e6533f7SSarangdhar Joshi static int rproc_trigger_auto_boot(struct rproc *rproc) 107770b85ef8SFernando Guzman Lugo { 107870b85ef8SFernando Guzman Lugo int ret; 107970b85ef8SFernando Guzman Lugo 108070b85ef8SFernando Guzman Lugo /* 108170b85ef8SFernando Guzman Lugo * We're initiating an asynchronous firmware loading, so we can 108270b85ef8SFernando Guzman Lugo * be built-in kernel code, without hanging the boot process. 108370b85ef8SFernando Guzman Lugo */ 108470b85ef8SFernando Guzman Lugo ret = request_firmware_nowait(THIS_MODULE, FW_ACTION_HOTPLUG, 108570b85ef8SFernando Guzman Lugo rproc->firmware, &rproc->dev, GFP_KERNEL, 10865e6533f7SSarangdhar Joshi rproc, rproc_auto_boot_callback); 10872099c77dSSarangdhar Joshi if (ret < 0) 108870b85ef8SFernando Guzman Lugo dev_err(&rproc->dev, "request_firmware_nowait err: %d\n", ret); 108970b85ef8SFernando Guzman Lugo 109070b85ef8SFernando Guzman Lugo return ret; 109170b85ef8SFernando Guzman Lugo } 109270b85ef8SFernando Guzman Lugo 1093880f5b38SBjorn Andersson static int rproc_stop(struct rproc *rproc, bool crashed) 10941efa30d0SSarangdhar Joshi { 10951efa30d0SSarangdhar Joshi struct device *dev = &rproc->dev; 10961efa30d0SSarangdhar Joshi int ret; 10971efa30d0SSarangdhar Joshi 1098618fcff3SBjorn Andersson /* Stop any subdevices for the remote processor */ 1099618fcff3SBjorn Andersson rproc_stop_subdevices(rproc, crashed); 11001efa30d0SSarangdhar Joshi 11010a8b81cbSBjorn Andersson /* the installed resource table is no longer accessible */ 11020a8b81cbSBjorn Andersson rproc->table_ptr = rproc->cached_table; 11030a8b81cbSBjorn Andersson 11041efa30d0SSarangdhar Joshi /* power off the remote processor */ 11051efa30d0SSarangdhar Joshi ret = rproc->ops->stop(rproc); 11061efa30d0SSarangdhar Joshi if (ret) { 11071efa30d0SSarangdhar Joshi dev_err(dev, "can't stop rproc: %d\n", ret); 11081efa30d0SSarangdhar Joshi return ret; 11091efa30d0SSarangdhar Joshi } 11101efa30d0SSarangdhar Joshi 1111c455daa4SBjorn Andersson rproc_unprepare_subdevices(rproc); 1112c455daa4SBjorn Andersson 11131efa30d0SSarangdhar Joshi rproc->state = RPROC_OFFLINE; 11141efa30d0SSarangdhar Joshi 11151efa30d0SSarangdhar Joshi dev_info(dev, "stopped remote processor %s\n", rproc->name); 11161efa30d0SSarangdhar Joshi 11171efa30d0SSarangdhar Joshi return 0; 11181efa30d0SSarangdhar Joshi } 11191efa30d0SSarangdhar Joshi 112070b85ef8SFernando Guzman Lugo /** 11212666ca91SSarangdhar Joshi * rproc_coredump_add_segment() - add segment of device memory to coredump 11222666ca91SSarangdhar Joshi * @rproc: handle of a remote processor 11232666ca91SSarangdhar Joshi * @da: device address 11242666ca91SSarangdhar Joshi * @size: size of segment 11252666ca91SSarangdhar Joshi * 11262666ca91SSarangdhar Joshi * Add device memory to the list of segments to be included in a coredump for 11272666ca91SSarangdhar Joshi * the remoteproc. 11282666ca91SSarangdhar Joshi * 11292666ca91SSarangdhar Joshi * Return: 0 on success, negative errno on error. 11302666ca91SSarangdhar Joshi */ 11312666ca91SSarangdhar Joshi int rproc_coredump_add_segment(struct rproc *rproc, dma_addr_t da, size_t size) 11322666ca91SSarangdhar Joshi { 11332666ca91SSarangdhar Joshi struct rproc_dump_segment *segment; 11342666ca91SSarangdhar Joshi 11352666ca91SSarangdhar Joshi segment = kzalloc(sizeof(*segment), GFP_KERNEL); 11362666ca91SSarangdhar Joshi if (!segment) 11372666ca91SSarangdhar Joshi return -ENOMEM; 11382666ca91SSarangdhar Joshi 11392666ca91SSarangdhar Joshi segment->da = da; 11402666ca91SSarangdhar Joshi segment->size = size; 11412666ca91SSarangdhar Joshi 11422666ca91SSarangdhar Joshi list_add_tail(&segment->node, &rproc->dump_segments); 11432666ca91SSarangdhar Joshi 11442666ca91SSarangdhar Joshi return 0; 11452666ca91SSarangdhar Joshi } 11462666ca91SSarangdhar Joshi EXPORT_SYMBOL(rproc_coredump_add_segment); 11472666ca91SSarangdhar Joshi 11482666ca91SSarangdhar Joshi /** 11492666ca91SSarangdhar Joshi * rproc_coredump() - perform coredump 11502666ca91SSarangdhar Joshi * @rproc: rproc handle 11512666ca91SSarangdhar Joshi * 11522666ca91SSarangdhar Joshi * This function will generate an ELF header for the registered segments 11532666ca91SSarangdhar Joshi * and create a devcoredump device associated with rproc. 11542666ca91SSarangdhar Joshi */ 11552666ca91SSarangdhar Joshi static void rproc_coredump(struct rproc *rproc) 11562666ca91SSarangdhar Joshi { 11572666ca91SSarangdhar Joshi struct rproc_dump_segment *segment; 11582666ca91SSarangdhar Joshi struct elf32_phdr *phdr; 11592666ca91SSarangdhar Joshi struct elf32_hdr *ehdr; 11602666ca91SSarangdhar Joshi size_t data_size; 11612666ca91SSarangdhar Joshi size_t offset; 11622666ca91SSarangdhar Joshi void *data; 11632666ca91SSarangdhar Joshi void *ptr; 11642666ca91SSarangdhar Joshi int phnum = 0; 11652666ca91SSarangdhar Joshi 11662666ca91SSarangdhar Joshi if (list_empty(&rproc->dump_segments)) 11672666ca91SSarangdhar Joshi return; 11682666ca91SSarangdhar Joshi 11692666ca91SSarangdhar Joshi data_size = sizeof(*ehdr); 11702666ca91SSarangdhar Joshi list_for_each_entry(segment, &rproc->dump_segments, node) { 11712666ca91SSarangdhar Joshi data_size += sizeof(*phdr) + segment->size; 11722666ca91SSarangdhar Joshi 11732666ca91SSarangdhar Joshi phnum++; 11742666ca91SSarangdhar Joshi } 11752666ca91SSarangdhar Joshi 11762666ca91SSarangdhar Joshi data = vmalloc(data_size); 11772666ca91SSarangdhar Joshi if (!data) 11782666ca91SSarangdhar Joshi return; 11792666ca91SSarangdhar Joshi 11802666ca91SSarangdhar Joshi ehdr = data; 11812666ca91SSarangdhar Joshi 11822666ca91SSarangdhar Joshi memset(ehdr, 0, sizeof(*ehdr)); 11832666ca91SSarangdhar Joshi memcpy(ehdr->e_ident, ELFMAG, SELFMAG); 11842666ca91SSarangdhar Joshi ehdr->e_ident[EI_CLASS] = ELFCLASS32; 11852666ca91SSarangdhar Joshi ehdr->e_ident[EI_DATA] = ELFDATA2LSB; 11862666ca91SSarangdhar Joshi ehdr->e_ident[EI_VERSION] = EV_CURRENT; 11872666ca91SSarangdhar Joshi ehdr->e_ident[EI_OSABI] = ELFOSABI_NONE; 11882666ca91SSarangdhar Joshi ehdr->e_type = ET_CORE; 11892666ca91SSarangdhar Joshi ehdr->e_machine = EM_NONE; 11902666ca91SSarangdhar Joshi ehdr->e_version = EV_CURRENT; 11912666ca91SSarangdhar Joshi ehdr->e_entry = rproc->bootaddr; 11922666ca91SSarangdhar Joshi ehdr->e_phoff = sizeof(*ehdr); 11932666ca91SSarangdhar Joshi ehdr->e_ehsize = sizeof(*ehdr); 11942666ca91SSarangdhar Joshi ehdr->e_phentsize = sizeof(*phdr); 11952666ca91SSarangdhar Joshi ehdr->e_phnum = phnum; 11962666ca91SSarangdhar Joshi 11972666ca91SSarangdhar Joshi phdr = data + ehdr->e_phoff; 11982666ca91SSarangdhar Joshi offset = ehdr->e_phoff + sizeof(*phdr) * ehdr->e_phnum; 11992666ca91SSarangdhar Joshi list_for_each_entry(segment, &rproc->dump_segments, node) { 12002666ca91SSarangdhar Joshi memset(phdr, 0, sizeof(*phdr)); 12012666ca91SSarangdhar Joshi phdr->p_type = PT_LOAD; 12022666ca91SSarangdhar Joshi phdr->p_offset = offset; 12032666ca91SSarangdhar Joshi phdr->p_vaddr = segment->da; 12042666ca91SSarangdhar Joshi phdr->p_paddr = segment->da; 12052666ca91SSarangdhar Joshi phdr->p_filesz = segment->size; 12062666ca91SSarangdhar Joshi phdr->p_memsz = segment->size; 12072666ca91SSarangdhar Joshi phdr->p_flags = PF_R | PF_W | PF_X; 12082666ca91SSarangdhar Joshi phdr->p_align = 0; 12092666ca91SSarangdhar Joshi 12102666ca91SSarangdhar Joshi ptr = rproc_da_to_va(rproc, segment->da, segment->size); 12112666ca91SSarangdhar Joshi if (!ptr) { 12122666ca91SSarangdhar Joshi dev_err(&rproc->dev, 12132666ca91SSarangdhar Joshi "invalid coredump segment (%pad, %zu)\n", 12142666ca91SSarangdhar Joshi &segment->da, segment->size); 12152666ca91SSarangdhar Joshi memset(data + offset, 0xff, segment->size); 12162666ca91SSarangdhar Joshi } else { 12172666ca91SSarangdhar Joshi memcpy(data + offset, ptr, segment->size); 12182666ca91SSarangdhar Joshi } 12192666ca91SSarangdhar Joshi 12202666ca91SSarangdhar Joshi offset += phdr->p_filesz; 12212666ca91SSarangdhar Joshi phdr++; 12222666ca91SSarangdhar Joshi } 12232666ca91SSarangdhar Joshi 12242666ca91SSarangdhar Joshi dev_coredumpv(&rproc->dev, data, data_size, GFP_KERNEL); 12252666ca91SSarangdhar Joshi } 12262666ca91SSarangdhar Joshi 12272666ca91SSarangdhar Joshi /** 122870b85ef8SFernando Guzman Lugo * rproc_trigger_recovery() - recover a remoteproc 122970b85ef8SFernando Guzman Lugo * @rproc: the remote processor 123070b85ef8SFernando Guzman Lugo * 123156324d7aSAnna, Suman * The recovery is done by resetting all the virtio devices, that way all the 123270b85ef8SFernando Guzman Lugo * rpmsg drivers will be reseted along with the remote processor making the 123370b85ef8SFernando Guzman Lugo * remoteproc functional again. 123470b85ef8SFernando Guzman Lugo * 123570b85ef8SFernando Guzman Lugo * This function can sleep, so it cannot be called from atomic context. 123670b85ef8SFernando Guzman Lugo */ 123770b85ef8SFernando Guzman Lugo int rproc_trigger_recovery(struct rproc *rproc) 123870b85ef8SFernando Guzman Lugo { 12397e83cab8SSarangdhar Joshi const struct firmware *firmware_p; 12407e83cab8SSarangdhar Joshi struct device *dev = &rproc->dev; 12417e83cab8SSarangdhar Joshi int ret; 12427e83cab8SSarangdhar Joshi 12437e83cab8SSarangdhar Joshi dev_err(dev, "recovering %s\n", rproc->name); 124470b85ef8SFernando Guzman Lugo 12457e83cab8SSarangdhar Joshi ret = mutex_lock_interruptible(&rproc->lock); 12467e83cab8SSarangdhar Joshi if (ret) 12477e83cab8SSarangdhar Joshi return ret; 12487e83cab8SSarangdhar Joshi 1249fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, true); 12507e83cab8SSarangdhar Joshi if (ret) 12517e83cab8SSarangdhar Joshi goto unlock_mutex; 1252ddf71187SBjorn Andersson 12532666ca91SSarangdhar Joshi /* generate coredump */ 12542666ca91SSarangdhar Joshi rproc_coredump(rproc); 12552666ca91SSarangdhar Joshi 12567e83cab8SSarangdhar Joshi /* load firmware */ 12577e83cab8SSarangdhar Joshi ret = request_firmware(&firmware_p, rproc->firmware, dev); 12587e83cab8SSarangdhar Joshi if (ret < 0) { 12597e83cab8SSarangdhar Joshi dev_err(dev, "request_firmware failed: %d\n", ret); 12607e83cab8SSarangdhar Joshi goto unlock_mutex; 12617e83cab8SSarangdhar Joshi } 1262ddf71187SBjorn Andersson 12637e83cab8SSarangdhar Joshi /* boot the remote processor up again */ 12647e83cab8SSarangdhar Joshi ret = rproc_start(rproc, firmware_p); 12657e83cab8SSarangdhar Joshi 12667e83cab8SSarangdhar Joshi release_firmware(firmware_p); 12677e83cab8SSarangdhar Joshi 12687e83cab8SSarangdhar Joshi unlock_mutex: 12697e83cab8SSarangdhar Joshi mutex_unlock(&rproc->lock); 12707e83cab8SSarangdhar Joshi return ret; 127170b85ef8SFernando Guzman Lugo } 127270b85ef8SFernando Guzman Lugo 1273400e64dfSOhad Ben-Cohen /** 12748afd519cSFernando Guzman Lugo * rproc_crash_handler_work() - handle a crash 12758afd519cSFernando Guzman Lugo * 12768afd519cSFernando Guzman Lugo * This function needs to handle everything related to a crash, like cpu 12778afd519cSFernando Guzman Lugo * registers and stack dump, information to help to debug the fatal error, etc. 12788afd519cSFernando Guzman Lugo */ 12798afd519cSFernando Guzman Lugo static void rproc_crash_handler_work(struct work_struct *work) 12808afd519cSFernando Guzman Lugo { 12818afd519cSFernando Guzman Lugo struct rproc *rproc = container_of(work, struct rproc, crash_handler); 12828afd519cSFernando Guzman Lugo struct device *dev = &rproc->dev; 12838afd519cSFernando Guzman Lugo 12848afd519cSFernando Guzman Lugo dev_dbg(dev, "enter %s\n", __func__); 12858afd519cSFernando Guzman Lugo 12868afd519cSFernando Guzman Lugo mutex_lock(&rproc->lock); 12878afd519cSFernando Guzman Lugo 12888afd519cSFernando Guzman Lugo if (rproc->state == RPROC_CRASHED || rproc->state == RPROC_OFFLINE) { 12898afd519cSFernando Guzman Lugo /* handle only the first crash detected */ 12908afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 12918afd519cSFernando Guzman Lugo return; 12928afd519cSFernando Guzman Lugo } 12938afd519cSFernando Guzman Lugo 12948afd519cSFernando Guzman Lugo rproc->state = RPROC_CRASHED; 12958afd519cSFernando Guzman Lugo dev_err(dev, "handling crash #%u in %s\n", ++rproc->crash_cnt, 12968afd519cSFernando Guzman Lugo rproc->name); 12978afd519cSFernando Guzman Lugo 12988afd519cSFernando Guzman Lugo mutex_unlock(&rproc->lock); 12998afd519cSFernando Guzman Lugo 13002e37abb8SFernando Guzman Lugo if (!rproc->recovery_disabled) 130170b85ef8SFernando Guzman Lugo rproc_trigger_recovery(rproc); 13028afd519cSFernando Guzman Lugo } 13038afd519cSFernando Guzman Lugo 13048afd519cSFernando Guzman Lugo /** 13051b0ef906SSuman Anna * rproc_boot() - boot a remote processor 1306400e64dfSOhad Ben-Cohen * @rproc: handle of a remote processor 1307400e64dfSOhad Ben-Cohen * 1308400e64dfSOhad Ben-Cohen * Boot a remote processor (i.e. load its firmware, power it on, ...). 1309400e64dfSOhad Ben-Cohen * 1310400e64dfSOhad Ben-Cohen * If the remote processor is already powered on, this function immediately 1311400e64dfSOhad Ben-Cohen * returns (successfully). 1312400e64dfSOhad Ben-Cohen * 1313400e64dfSOhad Ben-Cohen * Returns 0 on success, and an appropriate error value otherwise. 1314400e64dfSOhad Ben-Cohen */ 13151b0ef906SSuman Anna int rproc_boot(struct rproc *rproc) 1316400e64dfSOhad Ben-Cohen { 1317400e64dfSOhad Ben-Cohen const struct firmware *firmware_p; 1318400e64dfSOhad Ben-Cohen struct device *dev; 1319400e64dfSOhad Ben-Cohen int ret; 1320400e64dfSOhad Ben-Cohen 1321400e64dfSOhad Ben-Cohen if (!rproc) { 1322400e64dfSOhad Ben-Cohen pr_err("invalid rproc handle\n"); 1323400e64dfSOhad Ben-Cohen return -EINVAL; 1324400e64dfSOhad Ben-Cohen } 1325400e64dfSOhad Ben-Cohen 1326b5ab5e24SOhad Ben-Cohen dev = &rproc->dev; 1327400e64dfSOhad Ben-Cohen 1328400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1329400e64dfSOhad Ben-Cohen if (ret) { 1330400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1331400e64dfSOhad Ben-Cohen return ret; 1332400e64dfSOhad Ben-Cohen } 1333400e64dfSOhad Ben-Cohen 13342099c77dSSarangdhar Joshi if (rproc->state == RPROC_DELETED) { 13352099c77dSSarangdhar Joshi ret = -ENODEV; 13362099c77dSSarangdhar Joshi dev_err(dev, "can't boot deleted rproc %s\n", rproc->name); 13372099c77dSSarangdhar Joshi goto unlock_mutex; 13382099c77dSSarangdhar Joshi } 13392099c77dSSarangdhar Joshi 1340400e64dfSOhad Ben-Cohen /* skip the boot process if rproc is already powered up */ 1341400e64dfSOhad Ben-Cohen if (atomic_inc_return(&rproc->power) > 1) { 1342400e64dfSOhad Ben-Cohen ret = 0; 1343400e64dfSOhad Ben-Cohen goto unlock_mutex; 1344400e64dfSOhad Ben-Cohen } 1345400e64dfSOhad Ben-Cohen 1346400e64dfSOhad Ben-Cohen dev_info(dev, "powering up %s\n", rproc->name); 1347400e64dfSOhad Ben-Cohen 1348400e64dfSOhad Ben-Cohen /* load firmware */ 1349400e64dfSOhad Ben-Cohen ret = request_firmware(&firmware_p, rproc->firmware, dev); 1350400e64dfSOhad Ben-Cohen if (ret < 0) { 1351400e64dfSOhad Ben-Cohen dev_err(dev, "request_firmware failed: %d\n", ret); 1352400e64dfSOhad Ben-Cohen goto downref_rproc; 1353400e64dfSOhad Ben-Cohen } 1354400e64dfSOhad Ben-Cohen 1355400e64dfSOhad Ben-Cohen ret = rproc_fw_boot(rproc, firmware_p); 1356400e64dfSOhad Ben-Cohen 1357400e64dfSOhad Ben-Cohen release_firmware(firmware_p); 1358400e64dfSOhad Ben-Cohen 1359400e64dfSOhad Ben-Cohen downref_rproc: 1360fbb6aacbSBjorn Andersson if (ret) 1361400e64dfSOhad Ben-Cohen atomic_dec(&rproc->power); 1362400e64dfSOhad Ben-Cohen unlock_mutex: 1363400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 1364400e64dfSOhad Ben-Cohen return ret; 1365400e64dfSOhad Ben-Cohen } 1366400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_boot); 1367400e64dfSOhad Ben-Cohen 1368400e64dfSOhad Ben-Cohen /** 1369400e64dfSOhad Ben-Cohen * rproc_shutdown() - power off the remote processor 1370400e64dfSOhad Ben-Cohen * @rproc: the remote processor 1371400e64dfSOhad Ben-Cohen * 1372400e64dfSOhad Ben-Cohen * Power off a remote processor (previously booted with rproc_boot()). 1373400e64dfSOhad Ben-Cohen * 1374400e64dfSOhad Ben-Cohen * In case @rproc is still being used by an additional user(s), then 1375400e64dfSOhad Ben-Cohen * this function will just decrement the power refcount and exit, 1376400e64dfSOhad Ben-Cohen * without really powering off the device. 1377400e64dfSOhad Ben-Cohen * 1378400e64dfSOhad Ben-Cohen * Every call to rproc_boot() must (eventually) be accompanied by a call 1379400e64dfSOhad Ben-Cohen * to rproc_shutdown(). Calling rproc_shutdown() redundantly is a bug. 1380400e64dfSOhad Ben-Cohen * 1381400e64dfSOhad Ben-Cohen * Notes: 1382400e64dfSOhad Ben-Cohen * - we're not decrementing the rproc's refcount, only the power refcount. 1383400e64dfSOhad Ben-Cohen * which means that the @rproc handle stays valid even after rproc_shutdown() 1384400e64dfSOhad Ben-Cohen * returns, and users can still use it with a subsequent rproc_boot(), if 1385400e64dfSOhad Ben-Cohen * needed. 1386400e64dfSOhad Ben-Cohen */ 1387400e64dfSOhad Ben-Cohen void rproc_shutdown(struct rproc *rproc) 1388400e64dfSOhad Ben-Cohen { 1389b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 1390400e64dfSOhad Ben-Cohen int ret; 1391400e64dfSOhad Ben-Cohen 1392400e64dfSOhad Ben-Cohen ret = mutex_lock_interruptible(&rproc->lock); 1393400e64dfSOhad Ben-Cohen if (ret) { 1394400e64dfSOhad Ben-Cohen dev_err(dev, "can't lock rproc %s: %d\n", rproc->name, ret); 1395400e64dfSOhad Ben-Cohen return; 1396400e64dfSOhad Ben-Cohen } 1397400e64dfSOhad Ben-Cohen 1398400e64dfSOhad Ben-Cohen /* if the remote proc is still needed, bail out */ 1399400e64dfSOhad Ben-Cohen if (!atomic_dec_and_test(&rproc->power)) 1400400e64dfSOhad Ben-Cohen goto out; 1401400e64dfSOhad Ben-Cohen 1402fcd58037SArnaud Pouliquen ret = rproc_stop(rproc, false); 1403400e64dfSOhad Ben-Cohen if (ret) { 1404400e64dfSOhad Ben-Cohen atomic_inc(&rproc->power); 1405400e64dfSOhad Ben-Cohen goto out; 1406400e64dfSOhad Ben-Cohen } 1407400e64dfSOhad Ben-Cohen 1408400e64dfSOhad Ben-Cohen /* clean up all acquired resources */ 1409400e64dfSOhad Ben-Cohen rproc_resource_cleanup(rproc); 1410400e64dfSOhad Ben-Cohen 1411400e64dfSOhad Ben-Cohen rproc_disable_iommu(rproc); 1412400e64dfSOhad Ben-Cohen 1413988d204cSBjorn Andersson /* Free the copy of the resource table */ 1414a0c10687SBjorn Andersson kfree(rproc->cached_table); 1415a0c10687SBjorn Andersson rproc->cached_table = NULL; 1416988d204cSBjorn Andersson rproc->table_ptr = NULL; 1417400e64dfSOhad Ben-Cohen out: 1418400e64dfSOhad Ben-Cohen mutex_unlock(&rproc->lock); 1419400e64dfSOhad Ben-Cohen } 1420400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_shutdown); 1421400e64dfSOhad Ben-Cohen 1422400e64dfSOhad Ben-Cohen /** 1423fec47d86SDave Gerlach * rproc_get_by_phandle() - find a remote processor by phandle 1424fec47d86SDave Gerlach * @phandle: phandle to the rproc 1425fec47d86SDave Gerlach * 1426fec47d86SDave Gerlach * Finds an rproc handle using the remote processor's phandle, and then 1427fec47d86SDave Gerlach * return a handle to the rproc. 1428fec47d86SDave Gerlach * 1429fec47d86SDave Gerlach * This function increments the remote processor's refcount, so always 1430fec47d86SDave Gerlach * use rproc_put() to decrement it back once rproc isn't needed anymore. 1431fec47d86SDave Gerlach * 1432fec47d86SDave Gerlach * Returns the rproc handle on success, and NULL on failure. 1433fec47d86SDave Gerlach */ 14348de3dbd0SOhad Ben-Cohen #ifdef CONFIG_OF 1435fec47d86SDave Gerlach struct rproc *rproc_get_by_phandle(phandle phandle) 1436fec47d86SDave Gerlach { 1437fec47d86SDave Gerlach struct rproc *rproc = NULL, *r; 1438fec47d86SDave Gerlach struct device_node *np; 1439fec47d86SDave Gerlach 1440fec47d86SDave Gerlach np = of_find_node_by_phandle(phandle); 1441fec47d86SDave Gerlach if (!np) 1442fec47d86SDave Gerlach return NULL; 1443fec47d86SDave Gerlach 1444fec47d86SDave Gerlach mutex_lock(&rproc_list_mutex); 1445fec47d86SDave Gerlach list_for_each_entry(r, &rproc_list, node) { 1446fec47d86SDave Gerlach if (r->dev.parent && r->dev.parent->of_node == np) { 1447fbb6aacbSBjorn Andersson /* prevent underlying implementation from being removed */ 1448fbb6aacbSBjorn Andersson if (!try_module_get(r->dev.parent->driver->owner)) { 1449fbb6aacbSBjorn Andersson dev_err(&r->dev, "can't get owner\n"); 1450fbb6aacbSBjorn Andersson break; 1451fbb6aacbSBjorn Andersson } 1452fbb6aacbSBjorn Andersson 1453fec47d86SDave Gerlach rproc = r; 1454fec47d86SDave Gerlach get_device(&rproc->dev); 1455fec47d86SDave Gerlach break; 1456fec47d86SDave Gerlach } 1457fec47d86SDave Gerlach } 1458fec47d86SDave Gerlach mutex_unlock(&rproc_list_mutex); 1459fec47d86SDave Gerlach 1460fec47d86SDave Gerlach of_node_put(np); 1461fec47d86SDave Gerlach 1462fec47d86SDave Gerlach return rproc; 1463fec47d86SDave Gerlach } 14648de3dbd0SOhad Ben-Cohen #else 14658de3dbd0SOhad Ben-Cohen struct rproc *rproc_get_by_phandle(phandle phandle) 14668de3dbd0SOhad Ben-Cohen { 14678de3dbd0SOhad Ben-Cohen return NULL; 14688de3dbd0SOhad Ben-Cohen } 14698de3dbd0SOhad Ben-Cohen #endif 1470fec47d86SDave Gerlach EXPORT_SYMBOL(rproc_get_by_phandle); 1471fec47d86SDave Gerlach 1472fec47d86SDave Gerlach /** 1473160e7c84SOhad Ben-Cohen * rproc_add() - register a remote processor 1474400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle to register 1475400e64dfSOhad Ben-Cohen * 1476400e64dfSOhad Ben-Cohen * Registers @rproc with the remoteproc framework, after it has been 1477400e64dfSOhad Ben-Cohen * allocated with rproc_alloc(). 1478400e64dfSOhad Ben-Cohen * 1479400e64dfSOhad Ben-Cohen * This is called by the platform-specific rproc implementation, whenever 1480400e64dfSOhad Ben-Cohen * a new remote processor device is probed. 1481400e64dfSOhad Ben-Cohen * 1482400e64dfSOhad Ben-Cohen * Returns 0 on success and an appropriate error code otherwise. 1483400e64dfSOhad Ben-Cohen * 1484400e64dfSOhad Ben-Cohen * Note: this function initiates an asynchronous firmware loading 1485400e64dfSOhad Ben-Cohen * context, which will look for virtio devices supported by the rproc's 1486400e64dfSOhad Ben-Cohen * firmware. 1487400e64dfSOhad Ben-Cohen * 1488400e64dfSOhad Ben-Cohen * If found, those virtio devices will be created and added, so as a result 14897a186941SOhad Ben-Cohen * of registering this remote processor, additional virtio drivers might be 1490400e64dfSOhad Ben-Cohen * probed. 1491400e64dfSOhad Ben-Cohen */ 1492160e7c84SOhad Ben-Cohen int rproc_add(struct rproc *rproc) 1493400e64dfSOhad Ben-Cohen { 1494b5ab5e24SOhad Ben-Cohen struct device *dev = &rproc->dev; 149570b85ef8SFernando Guzman Lugo int ret; 1496400e64dfSOhad Ben-Cohen 1497b5ab5e24SOhad Ben-Cohen ret = device_add(dev); 1498b5ab5e24SOhad Ben-Cohen if (ret < 0) 1499b5ab5e24SOhad Ben-Cohen return ret; 1500400e64dfSOhad Ben-Cohen 1501b5ab5e24SOhad Ben-Cohen dev_info(dev, "%s is available\n", rproc->name); 1502400e64dfSOhad Ben-Cohen 1503400e64dfSOhad Ben-Cohen /* create debugfs entries */ 1504400e64dfSOhad Ben-Cohen rproc_create_debug_dir(rproc); 15057a20c64dSSarangdhar Joshi 15067a20c64dSSarangdhar Joshi /* if rproc is marked always-on, request it to boot */ 15077a20c64dSSarangdhar Joshi if (rproc->auto_boot) { 15085e6533f7SSarangdhar Joshi ret = rproc_trigger_auto_boot(rproc); 1509d2e12e66SDave Gerlach if (ret < 0) 1510d2e12e66SDave Gerlach return ret; 15117a20c64dSSarangdhar Joshi } 1512400e64dfSOhad Ben-Cohen 1513d2e12e66SDave Gerlach /* expose to rproc_get_by_phandle users */ 1514d2e12e66SDave Gerlach mutex_lock(&rproc_list_mutex); 1515d2e12e66SDave Gerlach list_add(&rproc->node, &rproc_list); 1516d2e12e66SDave Gerlach mutex_unlock(&rproc_list_mutex); 1517d2e12e66SDave Gerlach 1518d2e12e66SDave Gerlach return 0; 1519400e64dfSOhad Ben-Cohen } 1520160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_add); 1521400e64dfSOhad Ben-Cohen 1522400e64dfSOhad Ben-Cohen /** 1523b5ab5e24SOhad Ben-Cohen * rproc_type_release() - release a remote processor instance 1524b5ab5e24SOhad Ben-Cohen * @dev: the rproc's device 1525b5ab5e24SOhad Ben-Cohen * 1526b5ab5e24SOhad Ben-Cohen * This function should _never_ be called directly. 1527b5ab5e24SOhad Ben-Cohen * 1528b5ab5e24SOhad Ben-Cohen * It will be called by the driver core when no one holds a valid pointer 1529b5ab5e24SOhad Ben-Cohen * to @dev anymore. 1530b5ab5e24SOhad Ben-Cohen */ 1531b5ab5e24SOhad Ben-Cohen static void rproc_type_release(struct device *dev) 1532b5ab5e24SOhad Ben-Cohen { 1533b5ab5e24SOhad Ben-Cohen struct rproc *rproc = container_of(dev, struct rproc, dev); 1534b5ab5e24SOhad Ben-Cohen 15357183a2a7SOhad Ben-Cohen dev_info(&rproc->dev, "releasing %s\n", rproc->name); 15367183a2a7SOhad Ben-Cohen 1537b5ab5e24SOhad Ben-Cohen idr_destroy(&rproc->notifyids); 1538b5ab5e24SOhad Ben-Cohen 1539b5ab5e24SOhad Ben-Cohen if (rproc->index >= 0) 1540b5ab5e24SOhad Ben-Cohen ida_simple_remove(&rproc_dev_index, rproc->index); 1541b5ab5e24SOhad Ben-Cohen 15420f57dc6aSMatt Redfearn kfree(rproc->firmware); 1543fb98e2bdSBjorn Andersson kfree(rproc->ops); 1544b5ab5e24SOhad Ben-Cohen kfree(rproc); 1545b5ab5e24SOhad Ben-Cohen } 1546b5ab5e24SOhad Ben-Cohen 1547c42ca04dSBhumika Goyal static const struct device_type rproc_type = { 1548b5ab5e24SOhad Ben-Cohen .name = "remoteproc", 1549b5ab5e24SOhad Ben-Cohen .release = rproc_type_release, 1550b5ab5e24SOhad Ben-Cohen }; 1551400e64dfSOhad Ben-Cohen 1552400e64dfSOhad Ben-Cohen /** 1553400e64dfSOhad Ben-Cohen * rproc_alloc() - allocate a remote processor handle 1554400e64dfSOhad Ben-Cohen * @dev: the underlying device 1555400e64dfSOhad Ben-Cohen * @name: name of this remote processor 1556400e64dfSOhad Ben-Cohen * @ops: platform-specific handlers (mainly start/stop) 15578b4aec9aSRobert Tivy * @firmware: name of firmware file to load, can be NULL 1558400e64dfSOhad Ben-Cohen * @len: length of private data needed by the rproc driver (in bytes) 1559400e64dfSOhad Ben-Cohen * 1560400e64dfSOhad Ben-Cohen * Allocates a new remote processor handle, but does not register 15618b4aec9aSRobert Tivy * it yet. if @firmware is NULL, a default name is used. 1562400e64dfSOhad Ben-Cohen * 1563400e64dfSOhad Ben-Cohen * This function should be used by rproc implementations during initialization 1564400e64dfSOhad Ben-Cohen * of the remote processor. 1565400e64dfSOhad Ben-Cohen * 1566400e64dfSOhad Ben-Cohen * After creating an rproc handle using this function, and when ready, 1567160e7c84SOhad Ben-Cohen * implementations should then call rproc_add() to complete 1568400e64dfSOhad Ben-Cohen * the registration of the remote processor. 1569400e64dfSOhad Ben-Cohen * 1570400e64dfSOhad Ben-Cohen * On success the new rproc is returned, and on failure, NULL. 1571400e64dfSOhad Ben-Cohen * 1572400e64dfSOhad Ben-Cohen * Note: _never_ directly deallocate @rproc, even if it was not registered 1573433c0e04SBjorn Andersson * yet. Instead, when you need to unroll rproc_alloc(), use rproc_free(). 1574400e64dfSOhad Ben-Cohen */ 1575400e64dfSOhad Ben-Cohen struct rproc *rproc_alloc(struct device *dev, const char *name, 1576400e64dfSOhad Ben-Cohen const struct rproc_ops *ops, 1577400e64dfSOhad Ben-Cohen const char *firmware, int len) 1578400e64dfSOhad Ben-Cohen { 1579400e64dfSOhad Ben-Cohen struct rproc *rproc; 15808b4aec9aSRobert Tivy char *p, *template = "rproc-%s-fw"; 15810f57dc6aSMatt Redfearn int name_len; 1582400e64dfSOhad Ben-Cohen 1583400e64dfSOhad Ben-Cohen if (!dev || !name || !ops) 1584400e64dfSOhad Ben-Cohen return NULL; 1585400e64dfSOhad Ben-Cohen 15860f57dc6aSMatt Redfearn if (!firmware) { 15878b4aec9aSRobert Tivy /* 15888b4aec9aSRobert Tivy * If the caller didn't pass in a firmware name then 15890f57dc6aSMatt Redfearn * construct a default name. 15908b4aec9aSRobert Tivy */ 15918b4aec9aSRobert Tivy name_len = strlen(name) + strlen(template) - 2 + 1; 15920f57dc6aSMatt Redfearn p = kmalloc(name_len, GFP_KERNEL); 15930f57dc6aSMatt Redfearn if (!p) 1594400e64dfSOhad Ben-Cohen return NULL; 15958b4aec9aSRobert Tivy snprintf(p, name_len, template, name); 15968b4aec9aSRobert Tivy } else { 15970f57dc6aSMatt Redfearn p = kstrdup(firmware, GFP_KERNEL); 15980f57dc6aSMatt Redfearn if (!p) 15990f57dc6aSMatt Redfearn return NULL; 16000f57dc6aSMatt Redfearn } 16010f57dc6aSMatt Redfearn 16020f57dc6aSMatt Redfearn rproc = kzalloc(sizeof(struct rproc) + len, GFP_KERNEL); 16030f57dc6aSMatt Redfearn if (!rproc) { 16040f57dc6aSMatt Redfearn kfree(p); 16050f57dc6aSMatt Redfearn return NULL; 16068b4aec9aSRobert Tivy } 16078b4aec9aSRobert Tivy 1608fb98e2bdSBjorn Andersson rproc->ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL); 1609fb98e2bdSBjorn Andersson if (!rproc->ops) { 1610fb98e2bdSBjorn Andersson kfree(p); 1611fb98e2bdSBjorn Andersson kfree(rproc); 1612fb98e2bdSBjorn Andersson return NULL; 1613fb98e2bdSBjorn Andersson } 1614fb98e2bdSBjorn Andersson 16158b4aec9aSRobert Tivy rproc->firmware = p; 1616400e64dfSOhad Ben-Cohen rproc->name = name; 1617400e64dfSOhad Ben-Cohen rproc->priv = &rproc[1]; 1618ddf71187SBjorn Andersson rproc->auto_boot = true; 1619400e64dfSOhad Ben-Cohen 1620b5ab5e24SOhad Ben-Cohen device_initialize(&rproc->dev); 1621b5ab5e24SOhad Ben-Cohen rproc->dev.parent = dev; 1622b5ab5e24SOhad Ben-Cohen rproc->dev.type = &rproc_type; 16232aefbef0SMatt Redfearn rproc->dev.class = &rproc_class; 16247c89717fSBjorn Andersson rproc->dev.driver_data = rproc; 1625b5ab5e24SOhad Ben-Cohen 1626b5ab5e24SOhad Ben-Cohen /* Assign a unique device index and name */ 1627b5ab5e24SOhad Ben-Cohen rproc->index = ida_simple_get(&rproc_dev_index, 0, 0, GFP_KERNEL); 1628b5ab5e24SOhad Ben-Cohen if (rproc->index < 0) { 1629b5ab5e24SOhad Ben-Cohen dev_err(dev, "ida_simple_get failed: %d\n", rproc->index); 1630b5ab5e24SOhad Ben-Cohen put_device(&rproc->dev); 1631b5ab5e24SOhad Ben-Cohen return NULL; 1632b5ab5e24SOhad Ben-Cohen } 1633b5ab5e24SOhad Ben-Cohen 1634b5ab5e24SOhad Ben-Cohen dev_set_name(&rproc->dev, "remoteproc%d", rproc->index); 1635b5ab5e24SOhad Ben-Cohen 1636400e64dfSOhad Ben-Cohen atomic_set(&rproc->power, 0); 1637400e64dfSOhad Ben-Cohen 16380f21f9ccSBjorn Andersson /* Default to ELF loader if no load function is specified */ 16390f21f9ccSBjorn Andersson if (!rproc->ops->load) { 16400f21f9ccSBjorn Andersson rproc->ops->load = rproc_elf_load_segments; 1641c1d35c1aSBjorn Andersson rproc->ops->parse_fw = rproc_elf_load_rsc_table; 16420f21f9ccSBjorn Andersson rproc->ops->find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table; 16430f21f9ccSBjorn Andersson rproc->ops->sanity_check = rproc_elf_sanity_check; 16440f21f9ccSBjorn Andersson rproc->ops->get_boot_addr = rproc_elf_get_boot_addr; 16450f21f9ccSBjorn Andersson } 1646400e64dfSOhad Ben-Cohen 1647400e64dfSOhad Ben-Cohen mutex_init(&rproc->lock); 1648400e64dfSOhad Ben-Cohen 16497a186941SOhad Ben-Cohen idr_init(&rproc->notifyids); 16507a186941SOhad Ben-Cohen 1651400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->carveouts); 1652400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->mappings); 1653400e64dfSOhad Ben-Cohen INIT_LIST_HEAD(&rproc->traces); 16547a186941SOhad Ben-Cohen INIT_LIST_HEAD(&rproc->rvdevs); 16557bdc9650SBjorn Andersson INIT_LIST_HEAD(&rproc->subdevs); 16562666ca91SSarangdhar Joshi INIT_LIST_HEAD(&rproc->dump_segments); 1657400e64dfSOhad Ben-Cohen 16588afd519cSFernando Guzman Lugo INIT_WORK(&rproc->crash_handler, rproc_crash_handler_work); 16598afd519cSFernando Guzman Lugo 1660400e64dfSOhad Ben-Cohen rproc->state = RPROC_OFFLINE; 1661400e64dfSOhad Ben-Cohen 1662400e64dfSOhad Ben-Cohen return rproc; 1663400e64dfSOhad Ben-Cohen } 1664400e64dfSOhad Ben-Cohen EXPORT_SYMBOL(rproc_alloc); 1665400e64dfSOhad Ben-Cohen 1666400e64dfSOhad Ben-Cohen /** 1667433c0e04SBjorn Andersson * rproc_free() - unroll rproc_alloc() 1668433c0e04SBjorn Andersson * @rproc: the remote processor handle 1669433c0e04SBjorn Andersson * 1670433c0e04SBjorn Andersson * This function decrements the rproc dev refcount. 1671433c0e04SBjorn Andersson * 1672433c0e04SBjorn Andersson * If no one holds any reference to rproc anymore, then its refcount would 1673433c0e04SBjorn Andersson * now drop to zero, and it would be freed. 1674433c0e04SBjorn Andersson */ 1675433c0e04SBjorn Andersson void rproc_free(struct rproc *rproc) 1676433c0e04SBjorn Andersson { 1677433c0e04SBjorn Andersson put_device(&rproc->dev); 1678433c0e04SBjorn Andersson } 1679433c0e04SBjorn Andersson EXPORT_SYMBOL(rproc_free); 1680433c0e04SBjorn Andersson 1681433c0e04SBjorn Andersson /** 1682433c0e04SBjorn Andersson * rproc_put() - release rproc reference 1683400e64dfSOhad Ben-Cohen * @rproc: the remote processor handle 1684400e64dfSOhad Ben-Cohen * 1685c6b5a276SOhad Ben-Cohen * This function decrements the rproc dev refcount. 1686400e64dfSOhad Ben-Cohen * 1687c6b5a276SOhad Ben-Cohen * If no one holds any reference to rproc anymore, then its refcount would 1688c6b5a276SOhad Ben-Cohen * now drop to zero, and it would be freed. 1689400e64dfSOhad Ben-Cohen */ 1690160e7c84SOhad Ben-Cohen void rproc_put(struct rproc *rproc) 1691400e64dfSOhad Ben-Cohen { 1692fbb6aacbSBjorn Andersson module_put(rproc->dev.parent->driver->owner); 1693b5ab5e24SOhad Ben-Cohen put_device(&rproc->dev); 1694400e64dfSOhad Ben-Cohen } 1695160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_put); 1696400e64dfSOhad Ben-Cohen 1697400e64dfSOhad Ben-Cohen /** 1698160e7c84SOhad Ben-Cohen * rproc_del() - unregister a remote processor 1699400e64dfSOhad Ben-Cohen * @rproc: rproc handle to unregister 1700400e64dfSOhad Ben-Cohen * 1701400e64dfSOhad Ben-Cohen * This function should be called when the platform specific rproc 1702400e64dfSOhad Ben-Cohen * implementation decides to remove the rproc device. it should 1703160e7c84SOhad Ben-Cohen * _only_ be called if a previous invocation of rproc_add() 1704400e64dfSOhad Ben-Cohen * has completed successfully. 1705400e64dfSOhad Ben-Cohen * 1706160e7c84SOhad Ben-Cohen * After rproc_del() returns, @rproc isn't freed yet, because 1707c6b5a276SOhad Ben-Cohen * of the outstanding reference created by rproc_alloc. To decrement that 1708433c0e04SBjorn Andersson * one last refcount, one still needs to call rproc_free(). 1709400e64dfSOhad Ben-Cohen * 1710400e64dfSOhad Ben-Cohen * Returns 0 on success and -EINVAL if @rproc isn't valid. 1711400e64dfSOhad Ben-Cohen */ 1712160e7c84SOhad Ben-Cohen int rproc_del(struct rproc *rproc) 1713400e64dfSOhad Ben-Cohen { 1714400e64dfSOhad Ben-Cohen if (!rproc) 1715400e64dfSOhad Ben-Cohen return -EINVAL; 1716400e64dfSOhad Ben-Cohen 1717ddf71187SBjorn Andersson /* if rproc is marked always-on, rproc_add() booted it */ 1718ddf71187SBjorn Andersson /* TODO: make sure this works with rproc->power > 1 */ 1719ddf71187SBjorn Andersson if (rproc->auto_boot) 1720ddf71187SBjorn Andersson rproc_shutdown(rproc); 1721ddf71187SBjorn Andersson 17222099c77dSSarangdhar Joshi mutex_lock(&rproc->lock); 17232099c77dSSarangdhar Joshi rproc->state = RPROC_DELETED; 17242099c77dSSarangdhar Joshi mutex_unlock(&rproc->lock); 17252099c77dSSarangdhar Joshi 1726b003d45bSSarangdhar Joshi rproc_delete_debug_dir(rproc); 1727b003d45bSSarangdhar Joshi 1728fec47d86SDave Gerlach /* the rproc is downref'ed as soon as it's removed from the klist */ 1729fec47d86SDave Gerlach mutex_lock(&rproc_list_mutex); 1730fec47d86SDave Gerlach list_del(&rproc->node); 1731fec47d86SDave Gerlach mutex_unlock(&rproc_list_mutex); 1732fec47d86SDave Gerlach 1733b5ab5e24SOhad Ben-Cohen device_del(&rproc->dev); 1734400e64dfSOhad Ben-Cohen 1735400e64dfSOhad Ben-Cohen return 0; 1736400e64dfSOhad Ben-Cohen } 1737160e7c84SOhad Ben-Cohen EXPORT_SYMBOL(rproc_del); 1738400e64dfSOhad Ben-Cohen 17398afd519cSFernando Guzman Lugo /** 17407bdc9650SBjorn Andersson * rproc_add_subdev() - add a subdevice to a remoteproc 17417bdc9650SBjorn Andersson * @rproc: rproc handle to add the subdevice to 17427bdc9650SBjorn Andersson * @subdev: subdev handle to register 17434902676fSBjorn Andersson * 17444902676fSBjorn Andersson * Caller is responsible for populating optional subdevice function pointers. 17457bdc9650SBjorn Andersson */ 17464902676fSBjorn Andersson void rproc_add_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 17477bdc9650SBjorn Andersson { 17487bdc9650SBjorn Andersson list_add_tail(&subdev->node, &rproc->subdevs); 17497bdc9650SBjorn Andersson } 17507bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_add_subdev); 17517bdc9650SBjorn Andersson 17527bdc9650SBjorn Andersson /** 17537bdc9650SBjorn Andersson * rproc_remove_subdev() - remove a subdevice from a remoteproc 17547bdc9650SBjorn Andersson * @rproc: rproc handle to remove the subdevice from 17557bdc9650SBjorn Andersson * @subdev: subdev handle, previously registered with rproc_add_subdev() 17567bdc9650SBjorn Andersson */ 17577bdc9650SBjorn Andersson void rproc_remove_subdev(struct rproc *rproc, struct rproc_subdev *subdev) 17587bdc9650SBjorn Andersson { 17597bdc9650SBjorn Andersson list_del(&subdev->node); 17607bdc9650SBjorn Andersson } 17617bdc9650SBjorn Andersson EXPORT_SYMBOL(rproc_remove_subdev); 17627bdc9650SBjorn Andersson 17637bdc9650SBjorn Andersson /** 17647c89717fSBjorn Andersson * rproc_get_by_child() - acquire rproc handle of @dev's ancestor 17657c89717fSBjorn Andersson * @dev: child device to find ancestor of 17667c89717fSBjorn Andersson * 17677c89717fSBjorn Andersson * Returns the ancestor rproc instance, or NULL if not found. 17687c89717fSBjorn Andersson */ 17697c89717fSBjorn Andersson struct rproc *rproc_get_by_child(struct device *dev) 17707c89717fSBjorn Andersson { 17717c89717fSBjorn Andersson for (dev = dev->parent; dev; dev = dev->parent) { 17727c89717fSBjorn Andersson if (dev->type == &rproc_type) 17737c89717fSBjorn Andersson return dev->driver_data; 17747c89717fSBjorn Andersson } 17757c89717fSBjorn Andersson 17767c89717fSBjorn Andersson return NULL; 17777c89717fSBjorn Andersson } 17787c89717fSBjorn Andersson EXPORT_SYMBOL(rproc_get_by_child); 17797c89717fSBjorn Andersson 17807c89717fSBjorn Andersson /** 17818afd519cSFernando Guzman Lugo * rproc_report_crash() - rproc crash reporter function 17828afd519cSFernando Guzman Lugo * @rproc: remote processor 17838afd519cSFernando Guzman Lugo * @type: crash type 17848afd519cSFernando Guzman Lugo * 17858afd519cSFernando Guzman Lugo * This function must be called every time a crash is detected by the low-level 17868afd519cSFernando Guzman Lugo * drivers implementing a specific remoteproc. This should not be called from a 17878afd519cSFernando Guzman Lugo * non-remoteproc driver. 17888afd519cSFernando Guzman Lugo * 17898afd519cSFernando Guzman Lugo * This function can be called from atomic/interrupt context. 17908afd519cSFernando Guzman Lugo */ 17918afd519cSFernando Guzman Lugo void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type) 17928afd519cSFernando Guzman Lugo { 17938afd519cSFernando Guzman Lugo if (!rproc) { 17948afd519cSFernando Guzman Lugo pr_err("NULL rproc pointer\n"); 17958afd519cSFernando Guzman Lugo return; 17968afd519cSFernando Guzman Lugo } 17978afd519cSFernando Guzman Lugo 17988afd519cSFernando Guzman Lugo dev_err(&rproc->dev, "crash detected in %s: type %s\n", 17998afd519cSFernando Guzman Lugo rproc->name, rproc_crash_to_string(type)); 18008afd519cSFernando Guzman Lugo 18018afd519cSFernando Guzman Lugo /* create a new task to handle the error */ 18028afd519cSFernando Guzman Lugo schedule_work(&rproc->crash_handler); 18038afd519cSFernando Guzman Lugo } 18048afd519cSFernando Guzman Lugo EXPORT_SYMBOL(rproc_report_crash); 18058afd519cSFernando Guzman Lugo 1806400e64dfSOhad Ben-Cohen static int __init remoteproc_init(void) 1807400e64dfSOhad Ben-Cohen { 18082aefbef0SMatt Redfearn rproc_init_sysfs(); 1809400e64dfSOhad Ben-Cohen rproc_init_debugfs(); 1810b5ab5e24SOhad Ben-Cohen 1811400e64dfSOhad Ben-Cohen return 0; 1812400e64dfSOhad Ben-Cohen } 1813400e64dfSOhad Ben-Cohen module_init(remoteproc_init); 1814400e64dfSOhad Ben-Cohen 1815400e64dfSOhad Ben-Cohen static void __exit remoteproc_exit(void) 1816400e64dfSOhad Ben-Cohen { 1817f42f79afSSuman Anna ida_destroy(&rproc_dev_index); 1818f42f79afSSuman Anna 1819400e64dfSOhad Ben-Cohen rproc_exit_debugfs(); 18202aefbef0SMatt Redfearn rproc_exit_sysfs(); 1821400e64dfSOhad Ben-Cohen } 1822400e64dfSOhad Ben-Cohen module_exit(remoteproc_exit); 1823400e64dfSOhad Ben-Cohen 1824400e64dfSOhad Ben-Cohen MODULE_LICENSE("GPL v2"); 1825400e64dfSOhad Ben-Cohen MODULE_DESCRIPTION("Generic Remote Processor Framework"); 1826