1 // SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
3 * Copyright (C) 2019, STMicroelectronics - All Rights Reserved
9 #include <remoteproc.h>
12 * struct resource_table - firmware resource table header
13 * @ver: version number
14 * @num: number of resource entries
15 * @reserved: reserved (must be zero)
16 * @offset: array of offsets pointing at the various resource entries
18 * A resource table is essentially a list of system resources required
19 * by the remote processor. It may also include configuration entries.
20 * If needed, the remote processor firmware should contain this table
21 * as a dedicated ".resource_table" ELF section.
23 * Some resources entries are mere announcements, where the host is informed
24 * of specific remoteproc configuration. Other entries require the host to
25 * do something (e.g. allocate a system resource). Sometimes a negotiation
26 * is expected, where the firmware requests a resource, and once allocated,
27 * the host should provide back its details (e.g. address of an allocated
30 * The header of the resource table, as expressed by this structure,
31 * contains a version number (should we need to change this format in the
32 * future), the number of available resource entries, and their offsets
35 * Immediately following this header are the resource entries themselves.
37 struct resource_table {
44 /* Basic function to verify ELF32 image format */
45 int rproc_elf32_sanity_check(ulong addr, ulong size)
51 pr_debug("Invalid fw address?\n");
55 if (size < sizeof(Elf32_Ehdr)) {
56 pr_debug("Image is too small\n");
60 ehdr = (Elf32_Ehdr *)addr;
61 class = ehdr->e_ident[EI_CLASS];
63 if (!IS_ELF(*ehdr) || ehdr->e_type != ET_EXEC || class != ELFCLASS32) {
64 pr_debug("Not an executable ELF32 image\n");
65 return -EPROTONOSUPPORT;
68 /* We assume the firmware has the same endianness as the host */
69 # ifdef __LITTLE_ENDIAN
70 if (ehdr->e_ident[EI_DATA] != ELFDATA2LSB) {
71 # else /* BIG ENDIAN */
72 if (ehdr->e_ident[EI_DATA] != ELFDATA2MSB) {
74 pr_debug("Unsupported firmware endianness\n");
78 if (size < ehdr->e_shoff + sizeof(Elf32_Shdr)) {
79 pr_debug("Image is too small\n");
83 if (memcmp(ehdr->e_ident, ELFMAG, SELFMAG)) {
84 pr_debug("Image is corrupted (bad magic)\n");
88 if (ehdr->e_phnum == 0) {
89 pr_debug("No loadable segments\n");
93 if (ehdr->e_phoff > size) {
94 pr_debug("Firmware size is too small\n");
101 /* Basic function to verify ELF64 image format */
102 int rproc_elf64_sanity_check(ulong addr, ulong size)
104 Elf64_Ehdr *ehdr = (Elf64_Ehdr *)addr;
108 pr_debug("Invalid fw address?\n");
112 if (size < sizeof(Elf64_Ehdr)) {
113 pr_debug("Image is too small\n");
117 class = ehdr->e_ident[EI_CLASS];
119 if (!IS_ELF(*ehdr) || ehdr->e_type != ET_EXEC || class != ELFCLASS64) {
120 pr_debug("Not an executable ELF64 image\n");
121 return -EPROTONOSUPPORT;
124 /* We assume the firmware has the same endianness as the host */
125 # ifdef __LITTLE_ENDIAN
126 if (ehdr->e_ident[EI_DATA] != ELFDATA2LSB) {
127 # else /* BIG ENDIAN */
128 if (ehdr->e_ident[EI_DATA] != ELFDATA2MSB) {
130 pr_debug("Unsupported firmware endianness\n");
134 if (size < ehdr->e_shoff + sizeof(Elf64_Shdr)) {
135 pr_debug("Image is too small\n");
139 if (memcmp(ehdr->e_ident, ELFMAG, SELFMAG)) {
140 pr_debug("Image is corrupted (bad magic)\n");
144 if (ehdr->e_phnum == 0) {
145 pr_debug("No loadable segments\n");
149 if (ehdr->e_phoff > size) {
150 pr_debug("Firmware size is too small\n");
157 /* Basic function to verify ELF image format */
158 int rproc_elf_sanity_check(ulong addr, ulong size)
160 Elf32_Ehdr *ehdr = (Elf32_Ehdr *)addr;
163 dev_err(dev, "Invalid firmware address\n");
167 if (ehdr->e_ident[EI_CLASS] == ELFCLASS64)
168 return rproc_elf64_sanity_check(addr, size);
170 return rproc_elf32_sanity_check(addr, size);
173 int rproc_elf32_load_image(struct udevice *dev, unsigned long addr, ulong size)
175 Elf32_Ehdr *ehdr; /* Elf header structure pointer */
176 Elf32_Phdr *phdr; /* Program header structure pointer */
177 const struct dm_rproc_ops *ops;
180 ret = rproc_elf32_sanity_check(addr, size);
182 dev_err(dev, "Invalid ELF32 Image %d\n", ret);
186 ehdr = (Elf32_Ehdr *)addr;
187 phdr = (Elf32_Phdr *)(addr + ehdr->e_phoff);
189 ops = rproc_get_ops(dev);
191 /* Load each program header */
192 for (i = 0; i < ehdr->e_phnum; i++, phdr++) {
193 void *dst = (void *)(uintptr_t)phdr->p_paddr;
194 void *src = (void *)addr + phdr->p_offset;
196 if (phdr->p_type != PT_LOAD)
199 if (ops->device_to_virt)
200 dst = ops->device_to_virt(dev, (ulong)dst,
203 dev_dbg(dev, "Loading phdr %i to 0x%p (%i bytes)\n",
204 i, dst, phdr->p_filesz);
206 memcpy(dst, src, phdr->p_filesz);
207 if (phdr->p_filesz != phdr->p_memsz)
208 memset(dst + phdr->p_filesz, 0x00,
209 phdr->p_memsz - phdr->p_filesz);
210 flush_cache(rounddown((unsigned long)dst, ARCH_DMA_MINALIGN),
211 roundup((unsigned long)dst + phdr->p_filesz,
213 rounddown((unsigned long)dst, ARCH_DMA_MINALIGN));
219 int rproc_elf64_load_image(struct udevice *dev, ulong addr, ulong size)
221 const struct dm_rproc_ops *ops = rproc_get_ops(dev);
222 u64 da, memsz, filesz, offset;
228 dev_dbg(dev, "%s: addr = 0x%lx size = 0x%lx\n", __func__, addr, size);
230 if (rproc_elf64_sanity_check(addr, size))
233 ehdr = (Elf64_Ehdr *)addr;
234 phdr = (Elf64_Phdr *)(addr + (ulong)ehdr->e_phoff);
236 /* go through the available ELF segments */
237 for (i = 0; i < ehdr->e_phnum; i++, phdr++) {
239 memsz = phdr->p_memsz;
240 filesz = phdr->p_filesz;
241 offset = phdr->p_offset;
243 if (phdr->p_type != PT_LOAD)
246 dev_dbg(dev, "%s:phdr: type %d da 0x%llx memsz 0x%llx filesz 0x%llx\n",
247 __func__, phdr->p_type, da, memsz, filesz);
249 ptr = (void *)(uintptr_t)da;
250 if (ops->device_to_virt) {
251 ptr = ops->device_to_virt(dev, da, phdr->p_memsz);
253 dev_err(dev, "bad da 0x%llx mem 0x%llx\n", da,
261 memcpy(ptr, (void *)addr + offset, filesz);
263 memset(ptr + filesz, 0x00, memsz - filesz);
265 flush_cache(rounddown((ulong)ptr, ARCH_DMA_MINALIGN),
266 roundup((ulong)ptr + filesz, ARCH_DMA_MINALIGN) -
267 rounddown((ulong)ptr, ARCH_DMA_MINALIGN));
273 int rproc_elf_load_image(struct udevice *dev, ulong addr, ulong size)
275 Elf32_Ehdr *ehdr = (Elf32_Ehdr *)addr;
278 dev_err(dev, "Invalid firmware address\n");
282 if (ehdr->e_ident[EI_CLASS] == ELFCLASS64)
283 return rproc_elf64_load_image(dev, addr, size);
285 return rproc_elf32_load_image(dev, addr, size);
288 static ulong rproc_elf32_get_boot_addr(ulong addr)
290 Elf32_Ehdr *ehdr = (Elf32_Ehdr *)addr;
292 return ehdr->e_entry;
295 static ulong rproc_elf64_get_boot_addr(ulong addr)
297 Elf64_Ehdr *ehdr = (Elf64_Ehdr *)addr;
299 return ehdr->e_entry;
302 ulong rproc_elf_get_boot_addr(struct udevice *dev, ulong addr)
304 Elf32_Ehdr *ehdr = (Elf32_Ehdr *)addr;
306 if (ehdr->e_ident[EI_CLASS] == ELFCLASS64)
307 return rproc_elf64_get_boot_addr(addr);
309 return rproc_elf32_get_boot_addr(addr);
313 * Search for the resource table in an ELF32 image.
314 * Returns the address of the resource table section if found, NULL if there is
315 * no resource table section, or error pointer.
317 static Elf32_Shdr *rproc_elf32_find_rsc_table(struct udevice *dev,
318 ulong fw_addr, ulong fw_size)
322 const char *name_table;
323 struct resource_table *table;
324 const u8 *elf_data = (void *)fw_addr;
325 Elf32_Ehdr *ehdr = (Elf32_Ehdr *)fw_addr;
328 ret = rproc_elf32_sanity_check(fw_addr, fw_size);
330 pr_debug("Invalid ELF32 Image %d\n", ret);
334 /* look for the resource table and handle it */
335 shdr = (Elf32_Shdr *)(elf_data + ehdr->e_shoff);
336 name_table = (const char *)(elf_data +
337 shdr[ehdr->e_shstrndx].sh_offset);
339 for (i = 0; i < ehdr->e_shnum; i++, shdr++) {
340 u32 size = shdr->sh_size;
341 u32 offset = shdr->sh_offset;
343 if (strcmp(name_table + shdr->sh_name, ".resource_table"))
346 table = (struct resource_table *)(elf_data + offset);
348 /* make sure we have the entire table */
349 if (offset + size > fw_size) {
350 pr_debug("resource table truncated\n");
351 return ERR_PTR(-ENOSPC);
354 /* make sure table has at least the header */
355 if (sizeof(*table) > size) {
356 pr_debug("header-less resource table\n");
357 return ERR_PTR(-ENOSPC);
360 /* we don't support any version beyond the first */
361 if (table->ver != 1) {
362 pr_debug("unsupported fw ver: %d\n", table->ver);
363 return ERR_PTR(-EPROTONOSUPPORT);
366 /* make sure reserved bytes are zeroes */
367 if (table->reserved[0] || table->reserved[1]) {
368 pr_debug("non zero reserved bytes\n");
369 return ERR_PTR(-EBADF);
372 /* make sure the offsets array isn't truncated */
373 if (table->num * sizeof(table->offset[0]) +
374 sizeof(*table) > size) {
375 pr_debug("resource table incomplete\n");
376 return ERR_PTR(-ENOSPC);
385 /* Load the resource table from an ELF32 image */
386 int rproc_elf32_load_rsc_table(struct udevice *dev, ulong fw_addr,
387 ulong fw_size, ulong *rsc_addr, ulong *rsc_size)
389 const struct dm_rproc_ops *ops;
393 shdr = rproc_elf32_find_rsc_table(dev, fw_addr, fw_size);
397 return PTR_ERR(shdr);
399 ops = rproc_get_ops(dev);
400 *rsc_addr = (ulong)shdr->sh_addr;
401 *rsc_size = (ulong)shdr->sh_size;
403 src = (void *)fw_addr + shdr->sh_offset;
404 if (ops->device_to_virt)
405 dst = (void *)ops->device_to_virt(dev, *rsc_addr, *rsc_size);
407 dst = (void *)rsc_addr;
409 dev_dbg(dev, "Loading resource table to 0x%8lx (%ld bytes)\n",
410 (ulong)dst, *rsc_size);
412 memcpy(dst, src, *rsc_size);
413 flush_cache(rounddown((unsigned long)dst, ARCH_DMA_MINALIGN),
414 roundup((unsigned long)dst + *rsc_size,
416 rounddown((unsigned long)dst, ARCH_DMA_MINALIGN));
422 * Search for the resource table in an ELF64 image.
423 * Returns the address of the resource table section if found, NULL if there is
424 * no resource table section, or error pointer.
426 static Elf64_Shdr *rproc_elf64_find_rsc_table(struct udevice *dev,
427 ulong fw_addr, ulong fw_size)
431 const char *name_table;
432 struct resource_table *table;
433 const u8 *elf_data = (void *)fw_addr;
434 Elf64_Ehdr *ehdr = (Elf64_Ehdr *)fw_addr;
437 ret = rproc_elf64_sanity_check(fw_addr, fw_size);
439 pr_debug("Invalid ELF64 Image %d\n", ret);
443 /* look for the resource table and handle it */
444 shdr = (Elf64_Shdr *)(elf_data + ehdr->e_shoff);
445 name_table = (const char *)(elf_data +
446 shdr[ehdr->e_shstrndx].sh_offset);
448 for (i = 0; i < ehdr->e_shnum; i++, shdr++) {
449 u64 size = shdr->sh_size;
450 u64 offset = shdr->sh_offset;
452 if (strcmp(name_table + shdr->sh_name, ".resource_table"))
455 table = (struct resource_table *)(elf_data + offset);
457 /* make sure we have the entire table */
458 if (offset + size > fw_size) {
459 pr_debug("resource table truncated\n");
460 return ERR_PTR(-ENOSPC);
463 /* make sure table has at least the header */
464 if (sizeof(*table) > size) {
465 pr_debug("header-less resource table\n");
466 return ERR_PTR(-ENOSPC);
469 /* we don't support any version beyond the first */
470 if (table->ver != 1) {
471 pr_debug("unsupported fw ver: %d\n", table->ver);
472 return ERR_PTR(-EPROTONOSUPPORT);
475 /* make sure reserved bytes are zeroes */
476 if (table->reserved[0] || table->reserved[1]) {
477 pr_debug("non zero reserved bytes\n");
478 return ERR_PTR(-EBADF);
481 /* make sure the offsets array isn't truncated */
482 if (table->num * sizeof(table->offset[0]) +
483 sizeof(*table) > size) {
484 pr_debug("resource table incomplete\n");
485 return ERR_PTR(-ENOSPC);
494 /* Load the resource table from an ELF64 image */
495 int rproc_elf64_load_rsc_table(struct udevice *dev, ulong fw_addr,
496 ulong fw_size, ulong *rsc_addr, ulong *rsc_size)
498 const struct dm_rproc_ops *ops;
502 shdr = rproc_elf64_find_rsc_table(dev, fw_addr, fw_size);
506 return PTR_ERR(shdr);
508 ops = rproc_get_ops(dev);
509 *rsc_addr = (ulong)shdr->sh_addr;
510 *rsc_size = (ulong)shdr->sh_size;
512 src = (void *)fw_addr + shdr->sh_offset;
513 if (ops->device_to_virt)
514 dst = (void *)ops->device_to_virt(dev, *rsc_addr, *rsc_size);
516 dst = (void *)rsc_addr;
518 dev_dbg(dev, "Loading resource table to 0x%8lx (%ld bytes)\n",
519 (ulong)dst, *rsc_size);
521 memcpy(dst, src, *rsc_size);
522 flush_cache(rounddown((unsigned long)dst, ARCH_DMA_MINALIGN),
523 roundup((unsigned long)dst + *rsc_size,
525 rounddown((unsigned long)dst, ARCH_DMA_MINALIGN));
530 /* Load the resource table from an ELF32 or ELF64 image */
531 int rproc_elf_load_rsc_table(struct udevice *dev, ulong fw_addr,
532 ulong fw_size, ulong *rsc_addr, ulong *rsc_size)
535 Elf32_Ehdr *ehdr = (Elf32_Ehdr *)fw_addr;
540 if (ehdr->e_ident[EI_CLASS] == ELFCLASS64)
541 return rproc_elf64_load_rsc_table(dev, fw_addr, fw_size,
544 return rproc_elf32_load_rsc_table(dev, fw_addr, fw_size,