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