123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406 |
- /*
- * xrp_firmware: firmware manipulation for the XRP
- *
- * Copyright (c) 2015 - 2017 Cadence Design Systems, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining
- * a copy of this software and associated documentation files (the
- * "Software"), to deal in the Software without restriction, including
- * without limitation the rights to use, copy, modify, merge, publish,
- * distribute, sublicense, and/or sell copies of the Software, and to
- * permit persons to whom the Software is furnished to do so, subject to
- * the following conditions:
- *
- * The above copyright notice and this permission notice shall be included
- * in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
- * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
- * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * Alternatively you can use and distribute this file under the terms of
- * the GNU General Public License version 2 or later.
- */
- #include "xrp_firmware.h"
- #include "xrp_address_map.h"
- #include "xrp_hw.h"
- #include "xrp_internal.h"
- #include "xrp_kernel_dsp_interface.h"
- #include <linux/dma-mapping.h>
- #include <linux/elf.h>
- #include <linux/firmware.h>
- #include <linux/highmem.h>
- #include <linux/io.h>
- #include <linux/of.h>
- #include <linux/of_address.h>
- static phys_addr_t xrp_translate_to_cpu(struct xvp *xvp, Elf32_Phdr *phdr) {
- phys_addr_t res;
- __be32 addr = cpu_to_be32((u32)phdr->p_paddr);
- struct device_node *node = of_get_next_child(xvp->dev->of_node, NULL);
- if (!node)
- node = xvp->dev->of_node;
- res = of_translate_address(node, &addr);
- if (node != xvp->dev->of_node)
- of_node_put(node);
- return res;
- }
- static int xrp_load_segment_to_sysmem(struct xvp *xvp, Elf32_Phdr *phdr) {
- // phys_addr_t pa = xrp_translate_to_cpu(xvp, phdr);
- phys_addr_t pa = xrp_translate_dsp_to_host(&xvp->address_map,phdr->p_paddr);
- struct page *page = pfn_to_page(__phys_to_pfn(pa));
- size_t page_offs = pa & ~PAGE_MASK;
- size_t offs;
- for (offs = 0; offs < phdr->p_memsz; ++page) {
- void *p = kmap(page);
- size_t sz;
- if (!p)
- return -ENOMEM;
- page_offs &= ~PAGE_MASK;
- sz = PAGE_SIZE - page_offs;
- dev_dbg(xvp->dev, "loading segment to host addr 0x%d by host visiul %p,size:%d\n",
- page_offs,p,sz);
- if (offs < phdr->p_filesz) {
- size_t copy_sz = sz;
- if (phdr->p_filesz - offs < copy_sz)
- copy_sz = phdr->p_filesz - offs;
- copy_sz = ALIGN(copy_sz, 4);
- memcpy(p + page_offs, (void *)xvp->firmware->data + phdr->p_offset + offs,
- copy_sz);
- page_offs += copy_sz;
- offs += copy_sz;
- sz -= copy_sz;
- }
- dev_dbg(xvp->dev, "loading segment to host addr 0x%d by host visiul %p,size:%d\n",
- page_offs,p, sz);
- if (offs < phdr->p_memsz && sz) {
- if (phdr->p_memsz - offs < sz)
- sz = phdr->p_memsz - offs;
- sz = ALIGN(sz, 4);
- memset(p + page_offs, 0, sz);
- page_offs += sz;
- offs += sz;
- }
- kunmap(page);
- }
- dma_sync_single_for_device(xvp->dev, pa, phdr->p_memsz, DMA_TO_DEVICE);
- dev_dbg(xvp->dev, "xrp_load_segment_to_sysmem");
- return 0;
- }
- static int xrp_load_segment_to_iomem(struct xvp *xvp, Elf32_Phdr *phdr) {
- // phys_addr_t pa = xrp_translate_to_cpu(xvp, phdr);
- phys_addr_t pa = xrp_translate_dsp_to_host(&xvp->address_map,phdr->p_paddr);
- if(pa==OF_BAD_ADDR)
- {
- dev_err(xvp->dev, "couldn't translate DSP addr 0x%x\n", phdr->p_paddr);
- return -EINVAL;
- }
- void __iomem *p = ioremap(pa, phdr->p_memsz);
- if (!p) {
- dev_err(xvp->dev, "couldn't ioremap %pap x 0x%08x\n", &pa,
- (u32)phdr->p_memsz);
- return -EINVAL;
- }
- dev_dbg(xvp->dev, "loading segment to host addr 0x%pap by host virtual 0x%llx,size:%d,total size:%d,fw dataptr:0x%llx,offset:0x%x\n",
- &pa,p, phdr->p_filesz,(u32)phdr->p_memsz,xvp->firmware->data,phdr->p_offset);
- if(phdr->p_filesz)
- {
- if (xvp->hw_ops->memcpy_tohw)
- xvp->hw_ops->memcpy_tohw(p, (void *)xvp->firmware->data + phdr->p_offset,
- ALIGN(phdr->p_filesz, 4));
- else
- memcpy_toio(p, (void *)xvp->firmware->data + phdr->p_offset,
- ALIGN(phdr->p_filesz, 4));
- dev_dbg(xvp->dev, "copy size:%d\n",ALIGN(phdr->p_filesz, 4));
- }
- if(phdr->p_memsz - phdr->p_filesz)
- {
- if (xvp->hw_ops->memset_hw)
- xvp->hw_ops->memset_hw(p + phdr->p_filesz, 0,
- phdr->p_memsz - phdr->p_filesz);
- else
- memset_io(p + ALIGN(phdr->p_filesz, 4), 0,
- ALIGN(phdr->p_memsz - ALIGN(phdr->p_filesz, 4), 4));
- dev_dbg(xvp->dev, "set size:%d\n",ALIGN(phdr->p_memsz - ALIGN(phdr->p_filesz, 4),4));
- }
- iounmap(p);
- dev_dbg(xvp->dev, "xrp_load_segment_to_iomem done\n");
- return 0;
- }
- static inline bool xrp_section_bad(struct xvp *xvp, const Elf32_Shdr *shdr) {
- return shdr->sh_offset > xvp->firmware->size ||
- shdr->sh_size > xvp->firmware->size - shdr->sh_offset;
- }
- static int xrp_firmware_find_symbol(struct xvp *xvp, const char *name,
- void **paddr, size_t *psize) {
- const Elf32_Ehdr *ehdr = (Elf32_Ehdr *)xvp->firmware->data;
- const void *shdr_data = xvp->firmware->data + ehdr->e_shoff;
- const Elf32_Shdr *sh_symtab = NULL;
- const Elf32_Shdr *sh_strtab = NULL;
- const void *sym_data;
- const void *str_data;
- const Elf32_Sym *esym;
- void *addr = NULL;
- unsigned i;
- if (ehdr->e_shoff == 0) {
- dev_dbg(xvp->dev, "%s: no section header in the firmware image", __func__);
- return -ENOENT;
- }
- if (ehdr->e_shoff > xvp->firmware->size ||
- ehdr->e_shnum * ehdr->e_shentsize > xvp->firmware->size - ehdr->e_shoff) {
- dev_err(xvp->dev, "%s: bad firmware SHDR information", __func__);
- return -EINVAL;
- }
- /* find symbols and string sections */
- for (i = 0; i < ehdr->e_shnum; ++i) {
- const Elf32_Shdr *shdr = shdr_data + i * ehdr->e_shentsize;
- switch (shdr->sh_type) {
- case SHT_SYMTAB:
- sh_symtab = shdr;
- break;
- case SHT_STRTAB:
- sh_strtab = shdr;
- break;
- default:
- break;
- }
- }
- if (!sh_symtab || !sh_strtab) {
- dev_dbg(xvp->dev, "%s: no symtab or strtab in the firmware image",
- __func__);
- return -ENOENT;
- }
- if (xrp_section_bad(xvp, sh_symtab)) {
- dev_err(xvp->dev, "%s: bad firmware SYMTAB section information", __func__);
- return -EINVAL;
- }
- if (xrp_section_bad(xvp, sh_strtab)) {
- dev_err(xvp->dev, "%s: bad firmware STRTAB section information", __func__);
- return -EINVAL;
- }
- /* iterate through all symbols, searching for the name */
- sym_data = xvp->firmware->data + sh_symtab->sh_offset;
- str_data = xvp->firmware->data + sh_strtab->sh_offset;
- for (i = 0; i < sh_symtab->sh_size; i += sh_symtab->sh_entsize) {
- esym = sym_data + i;
- if (!(ELF_ST_TYPE(esym->st_info) == STT_OBJECT &&
- esym->st_name < sh_strtab->sh_size &&
- strncmp(str_data + esym->st_name, name,
- sh_strtab->sh_size - esym->st_name) == 0))
- continue;
- if (esym->st_shndx > 0 && esym->st_shndx < ehdr->e_shnum) {
- const Elf32_Shdr *shdr = shdr_data + esym->st_shndx * ehdr->e_shentsize;
- Elf32_Off in_section_off = esym->st_value - shdr->sh_addr;
- if (xrp_section_bad(xvp, shdr)) {
- dev_err(xvp->dev, "%s: bad firmware section #%d information", __func__,
- esym->st_shndx);
- return -EINVAL;
- }
- if (esym->st_value < shdr->sh_addr || in_section_off > shdr->sh_size ||
- esym->st_size > shdr->sh_size - in_section_off) {
- dev_err(xvp->dev, "%s: bad symbol information", __func__);
- return -EINVAL;
- }
- addr = (void *)xvp->firmware->data + shdr->sh_offset + in_section_off;
- dev_dbg(xvp->dev,
- "%s: found symbol, st_shndx = %d, "
- "sh_offset = 0x%08x, sh_addr = 0x%08x, "
- "st_value = 0x%08x, address = %p",
- __func__, esym->st_shndx, shdr->sh_offset, shdr->sh_addr,
- esym->st_value, addr);
- } else {
- dev_dbg(xvp->dev, "%s: unsupported section index in found symbol: 0x%x",
- __func__, esym->st_shndx);
- return -EINVAL;
- }
- break;
- }
- if (!addr)
- return -ENOENT;
- *paddr = addr;
- *psize = esym->st_size;
- return 0;
- }
- static int xrp_firmware_fixup_symbol(struct xvp *xvp, const char *name,
- phys_addr_t v) {
- u32 v32 = XRP_DSP_COMM_BASE_MAGIC;
- void *addr;
- size_t sz;
- int rc;
- if(v == XRP_NO_TRANSLATION)
- {
- dev_err(xvp->dev, "%s: invalid dsp address %llx", __func__, name);
- return -EINVAL;
- }
- rc = xrp_firmware_find_symbol(xvp, name, &addr, &sz);
- if (rc < 0) {
- dev_err(xvp->dev, "%s: symbol \"%s\" is not found", __func__, name);
- return rc;
- }
- if (sz != sizeof(u32)) {
- dev_err(xvp->dev, "%s: symbol \"%s\" has wrong size: %zu", __func__, name,
- sz);
- return -EINVAL;
- }
- /* update data associated with symbol */
- if (memcmp(addr, &v32, sz) != 0) {
- dev_dbg(xvp->dev, "%s: value pointed to by symbol is incorrect: %*ph",
- __func__, (int)sz, addr);
- }
- v32 = v;
- memcpy(addr, &v32, sz);
- return 0;
- }
- static int xrp_load_firmware(struct xvp *xvp) {
- Elf32_Ehdr *ehdr = (Elf32_Ehdr *)xvp->firmware->data;
- int i;
- if (memcmp(ehdr->e_ident, ELFMAG, SELFMAG)) {
- dev_err(xvp->dev, "bad firmware ELF magic\n");
- return -EINVAL;
- }
- if (ehdr->e_type != ET_EXEC) {
- dev_err(xvp->dev, "bad firmware ELF type\n");
- return -EINVAL;
- }
- if (ehdr->e_machine != 94 /*EM_XTENSA*/) {
- dev_err(xvp->dev, "bad firmware ELF machine\n");
- return -EINVAL;
- }
- if (ehdr->e_phoff >= xvp->firmware->size ||
- ehdr->e_phoff + ehdr->e_phentsize * ehdr->e_phnum > xvp->firmware->size) {
- dev_err(xvp->dev, "bad firmware ELF PHDR information\n");
- return -EINVAL;
- }
- xrp_firmware_fixup_symbol(
- xvp, "xrp_dsp_comm_base",
- xrp_translate_to_dsp(&xvp->address_map, xvp->comm_phys));
- for (i = 0; i < ehdr->e_phnum; ++i) {
- Elf32_Phdr *phdr =
- (void *)xvp->firmware->data + ehdr->e_phoff + i * ehdr->e_phentsize;
- phys_addr_t pa;
- int rc;
- /* Only load non-empty loadable segments, R/W/X */
- if (!(phdr->p_type == PT_LOAD && (phdr->p_flags & (PF_X | PF_R | PF_W)) &&
- phdr->p_memsz > 0))
- continue;
- if (phdr->p_offset >= xvp->firmware->size ||
- phdr->p_offset + phdr->p_filesz > xvp->firmware->size) {
- dev_err(xvp->dev, "bad firmware ELF program header entry %d\n", i);
- return -EINVAL;
- }
- // pa = xrp_translate_to_cpu(xvp, phdr);
- pa=phdr->p_paddr;
- if (pa == (phys_addr_t)OF_BAD_ADDR) {
- dev_err(
- xvp->dev,
- "device address 0x%08x could not be mapped to host physical address",
- (u32)phdr->p_paddr);
- return -EINVAL;
- }
- dev_dbg(xvp->dev, "loading segment %d (device 0x%08x) to physical %pap\n",
- i, (u32)phdr->p_paddr, &pa);
- // if (pfn_valid(__phys_to_pfn(pa)))
- // rc = xrp_load_segment_to_sysmem(xvp, phdr);
- // else
- rc = xrp_load_segment_to_iomem(xvp, phdr);
- if (rc < 0)
- return rc;
- }
- dev_dbg(xvp->dev, "loading firmware sucessful\n");
- return 0;
- }
- int xrp_request_firmware(struct xvp *xvp,Elf32_Addr *boot_addr) {
- int ret = request_firmware(&xvp->firmware, xvp->firmware_name, xvp->dev);
- if (ret < 0 || boot_addr == NULL)
- return ret;
- ret = xrp_load_firmware(xvp);
- *boot_addr = xrp_get_firmware_entry_addr(xvp);
- release_firmware(xvp->firmware);
-
- return ret;
- }
- Elf32_Addr xrp_get_firmware_entry_addr(struct xvp *xvp)
- {
- Elf32_Ehdr *ehdr = (Elf32_Ehdr *)xvp->firmware->data;
- int i;
- if (memcmp(ehdr->e_ident, ELFMAG, SELFMAG)) {
- dev_err(xvp->dev, "bad firmware ELF magic\n");
- return 0;
- }
- if (ehdr->e_type != ET_EXEC) {
- dev_err(xvp->dev, "bad firmware ELF type\n");
- return 0;
- }
- if (ehdr->e_machine != 94 /*EM_XTENSA*/) {
- dev_err(xvp->dev, "bad firmware ELF machine\n");
- return 0;
- }
- return ehdr->e_entry;
- }
|