^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Remote processor elf helpers defines
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2020 Kalray, Inc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #ifndef REMOTEPROC_ELF_LOADER_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #define REMOTEPROC_ELF_LOADER_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include <linux/elf.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/types.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) * fw_elf_get_class - Get elf class
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) * @fw: the ELF firmware image
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) * Note that we use and elf32_hdr to access the class since the start of the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * struct is the same for both elf class
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) * Return: elf class of the firmware
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) static inline u8 fw_elf_get_class(const struct firmware *fw)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) struct elf32_hdr *ehdr = (struct elf32_hdr *)fw->data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) return ehdr->e_ident[EI_CLASS];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) static inline void elf_hdr_init_ident(struct elf32_hdr *hdr, u8 class)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) memcpy(hdr->e_ident, ELFMAG, SELFMAG);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) hdr->e_ident[EI_CLASS] = class;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) hdr->e_ident[EI_DATA] = ELFDATA2LSB;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) hdr->e_ident[EI_VERSION] = EV_CURRENT;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) hdr->e_ident[EI_OSABI] = ELFOSABI_NONE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) /* Generate getter and setter for a specific elf struct/field */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) #define ELF_GEN_FIELD_GET_SET(__s, __field, __type) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) static inline __type elf_##__s##_get_##__field(u8 class, const void *arg) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) if (class == ELFCLASS32) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) return (__type) ((const struct elf32_##__s *) arg)->__field; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) else \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) return (__type) ((const struct elf64_##__s *) arg)->__field; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) } \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) static inline void elf_##__s##_set_##__field(u8 class, void *arg, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) __type value) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) if (class == ELFCLASS32) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) ((struct elf32_##__s *) arg)->__field = (__type) value; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) else \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) ((struct elf64_##__s *) arg)->__field = (__type) value; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) ELF_GEN_FIELD_GET_SET(hdr, e_entry, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) ELF_GEN_FIELD_GET_SET(hdr, e_phnum, u16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) ELF_GEN_FIELD_GET_SET(hdr, e_shnum, u16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) ELF_GEN_FIELD_GET_SET(hdr, e_phoff, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) ELF_GEN_FIELD_GET_SET(hdr, e_shoff, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) ELF_GEN_FIELD_GET_SET(hdr, e_shstrndx, u16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) ELF_GEN_FIELD_GET_SET(hdr, e_machine, u16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) ELF_GEN_FIELD_GET_SET(hdr, e_type, u16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) ELF_GEN_FIELD_GET_SET(hdr, e_version, u32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) ELF_GEN_FIELD_GET_SET(hdr, e_ehsize, u32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) ELF_GEN_FIELD_GET_SET(hdr, e_phentsize, u16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) ELF_GEN_FIELD_GET_SET(hdr, e_shentsize, u16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) ELF_GEN_FIELD_GET_SET(phdr, p_paddr, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) ELF_GEN_FIELD_GET_SET(phdr, p_vaddr, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) ELF_GEN_FIELD_GET_SET(phdr, p_filesz, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) ELF_GEN_FIELD_GET_SET(phdr, p_memsz, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) ELF_GEN_FIELD_GET_SET(phdr, p_type, u32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) ELF_GEN_FIELD_GET_SET(phdr, p_offset, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) ELF_GEN_FIELD_GET_SET(phdr, p_flags, u32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) ELF_GEN_FIELD_GET_SET(phdr, p_align, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) ELF_GEN_FIELD_GET_SET(shdr, sh_type, u32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) ELF_GEN_FIELD_GET_SET(shdr, sh_flags, u32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) ELF_GEN_FIELD_GET_SET(shdr, sh_entsize, u16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) ELF_GEN_FIELD_GET_SET(shdr, sh_size, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) ELF_GEN_FIELD_GET_SET(shdr, sh_offset, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) ELF_GEN_FIELD_GET_SET(shdr, sh_name, u32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) ELF_GEN_FIELD_GET_SET(shdr, sh_addr, u64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) #define ELF_STRUCT_SIZE(__s) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) static inline unsigned long elf_size_of_##__s(u8 class) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) if (class == ELFCLASS32)\
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) return sizeof(struct elf32_##__s); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) else \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) return sizeof(struct elf64_##__s); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) ELF_STRUCT_SIZE(shdr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) ELF_STRUCT_SIZE(phdr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) ELF_STRUCT_SIZE(hdr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) static inline unsigned int elf_strtbl_add(const char *name, void *ehdr, u8 class, size_t *index)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) u16 shstrndx = elf_hdr_get_e_shstrndx(class, ehdr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) void *shdr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) char *strtab;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) size_t idx, ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) shdr = ehdr + elf_size_of_hdr(class) + shstrndx * elf_size_of_shdr(class);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) strtab = ehdr + elf_shdr_get_sh_offset(class, shdr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) idx = index ? *index : 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) if (!strtab || !name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) ret = idx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) strcpy((strtab + idx), name);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) idx += strlen(name) + 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) if (index)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) *index = idx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #endif /* REMOTEPROC_ELF_LOADER_H */