2 * This file is subject to the terms and conditions of the GNU General Public
3 * License. See the file "COPYING" in the main directory of this archive
6 * Copyright (C) 2004, 2005 MIPS Technologies, Inc. All rights reserved.
7 * Copyright (C) 2013 Imagination Technologies Ltd.
9 * VPE spport module for loading a MIPS SP program into VPE1. The SP
10 * environment is rather simple since there are no TLBs. It needs
11 * to be relocatable (or partiall linked). Initialize your stack in
12 * the startup-code. The loader looks for the symbol __start and sets
13 * up the execution to resume from there. To load and run, simply do
14 * a cat SP 'binary' to the /dev/vpe1 device.
16 #include <linux/kernel.h>
17 #include <linux/device.h>
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/list.h>
22 #include <linux/vmalloc.h>
23 #include <linux/elf.h>
24 #include <linux/seq_file.h>
25 #include <linux/syscalls.h>
26 #include <linux/moduleloader.h>
27 #include <linux/interrupt.h>
28 #include <linux/poll.h>
29 #include <linux/memblock.h>
30 #include <asm/mipsregs.h>
31 #include <asm/mipsmtregs.h>
32 #include <asm/cacheflush.h>
33 #include <linux/atomic.h>
34 #include <asm/mips_mt.h>
35 #include <asm/processor.h>
38 #ifndef ARCH_SHF_SMALL
39 #define ARCH_SHF_SMALL 0
42 /* If this is set, the section belongs in the init part of the module */
43 #define INIT_OFFSET_MASK (1UL << (BITS_PER_LONG-1))
45 struct vpe_control vpecontrol = {
46 .vpe_list_lock = __SPIN_LOCK_UNLOCKED(vpe_list_lock),
47 .vpe_list = LIST_HEAD_INIT(vpecontrol.vpe_list),
48 .tc_list_lock = __SPIN_LOCK_UNLOCKED(tc_list_lock),
49 .tc_list = LIST_HEAD_INIT(vpecontrol.tc_list)
52 /* get the vpe associated with this minor */
53 struct vpe *get_vpe(int minor)
61 spin_lock(&vpecontrol.vpe_list_lock);
62 list_for_each_entry(v, &vpecontrol.vpe_list, list) {
63 if (v->minor == VPE_MODULE_MINOR) {
68 spin_unlock(&vpecontrol.vpe_list_lock);
73 /* get the vpe associated with this minor */
74 struct tc *get_tc(int index)
79 spin_lock(&vpecontrol.tc_list_lock);
80 list_for_each_entry(t, &vpecontrol.tc_list, list) {
81 if (t->index == index) {
86 spin_unlock(&vpecontrol.tc_list_lock);
91 /* allocate a vpe and associate it with this minor (or index) */
92 struct vpe *alloc_vpe(int minor)
96 v = kzalloc(sizeof(struct vpe), GFP_KERNEL);
100 INIT_LIST_HEAD(&v->tc);
101 spin_lock(&vpecontrol.vpe_list_lock);
102 list_add_tail(&v->list, &vpecontrol.vpe_list);
103 spin_unlock(&vpecontrol.vpe_list_lock);
105 INIT_LIST_HEAD(&v->notify);
106 v->minor = VPE_MODULE_MINOR;
112 /* allocate a tc. At startup only tc0 is running, all other can be halted. */
113 struct tc *alloc_tc(int index)
117 tc = kzalloc(sizeof(struct tc), GFP_KERNEL);
121 INIT_LIST_HEAD(&tc->tc);
124 spin_lock(&vpecontrol.tc_list_lock);
125 list_add_tail(&tc->list, &vpecontrol.tc_list);
126 spin_unlock(&vpecontrol.tc_list_lock);
132 /* clean up and free everything */
133 void release_vpe(struct vpe *v)
137 release_progmem(v->load_addr);
141 /* Find some VPE program space */
142 void *alloc_progmem(unsigned long len)
146 #ifdef CONFIG_MIPS_VPE_LOADER_TOM
148 * This means you must tell Linux to use less memory than you
149 * physically have, for example by passing a mem= boot argument.
151 addr = pfn_to_kaddr(max_low_pfn);
152 memset(addr, 0, len);
154 /* simple grab some mem for now */
155 addr = kzalloc(len, GFP_KERNEL);
161 void release_progmem(void *ptr)
163 #ifndef CONFIG_MIPS_VPE_LOADER_TOM
168 /* Update size with this section: return offset. */
169 static long get_offset(unsigned long *size, Elf_Shdr *sechdr)
173 ret = ALIGN(*size, sechdr->sh_addralign ? : 1);
174 *size = ret + sechdr->sh_size;
178 /* Lay out the SHF_ALLOC sections in a way not dissimilar to how ld
179 might -- code, read-only data, read-write data, small data. Tally
180 sizes, and place the offsets into sh_entsize fields: high bit means it
182 static void layout_sections(struct module *mod, const Elf_Ehdr *hdr,
183 Elf_Shdr *sechdrs, const char *secstrings)
185 static unsigned long const masks[][2] = {
186 /* NOTE: all executable code must be the first section
187 * in this array; otherwise modify the text_size
188 * finder in the two loops below */
189 {SHF_EXECINSTR | SHF_ALLOC, ARCH_SHF_SMALL},
190 {SHF_ALLOC, SHF_WRITE | ARCH_SHF_SMALL},
191 {SHF_WRITE | SHF_ALLOC, ARCH_SHF_SMALL},
192 {ARCH_SHF_SMALL | SHF_ALLOC, 0}
196 for (i = 0; i < hdr->e_shnum; i++)
197 sechdrs[i].sh_entsize = ~0UL;
199 for (m = 0; m < ARRAY_SIZE(masks); ++m) {
200 for (i = 0; i < hdr->e_shnum; ++i) {
201 Elf_Shdr *s = &sechdrs[i];
203 if ((s->sh_flags & masks[m][0]) != masks[m][0]
204 || (s->sh_flags & masks[m][1])
205 || s->sh_entsize != ~0UL)
208 get_offset((unsigned long *)&mod->core_layout.size, s);
212 mod->core_layout.text_size = mod->core_layout.size;
217 /* from module-elf32.c, but subverted a little */
220 struct mips_hi16 *next;
225 static struct mips_hi16 *mips_hi16_list;
226 static unsigned int gp_offs, gp_addr;
228 static int apply_r_mips_none(struct module *me, uint32_t *location,
234 static int apply_r_mips_gprel16(struct module *me, uint32_t *location,
239 if (!(*location & 0xffff)) {
240 rel = (int)v - gp_addr;
242 /* .sbss + gp(relative) + offset */
244 rel = (int)(short)((int)v + gp_offs +
245 (int)(short)(*location & 0xffff) - gp_addr);
248 if ((rel > 32768) || (rel < -32768)) {
249 pr_debug("VPE loader: apply_r_mips_gprel16: relative address 0x%x out of range of gp register\n",
254 *location = (*location & 0xffff0000) | (rel & 0xffff);
259 static int apply_r_mips_pc16(struct module *me, uint32_t *location,
263 rel = (((unsigned int)v - (unsigned int)location));
264 rel >>= 2; /* because the offset is in _instructions_ not bytes. */
265 rel -= 1; /* and one instruction less due to the branch delay slot. */
267 if ((rel > 32768) || (rel < -32768)) {
268 pr_debug("VPE loader: apply_r_mips_pc16: relative address out of range 0x%x\n",
273 *location = (*location & 0xffff0000) | (rel & 0xffff);
278 static int apply_r_mips_32(struct module *me, uint32_t *location,
286 static int apply_r_mips_26(struct module *me, uint32_t *location,
290 pr_debug("VPE loader: apply_r_mips_26: unaligned relocation\n");
295 * Not desperately convinced this is a good check of an overflow condition
296 * anyway. But it gets in the way of handling undefined weak symbols which
297 * we want to set to zero.
298 * if ((v & 0xf0000000) != (((unsigned long)location + 4) & 0xf0000000)) {
300 * "module %s: relocation overflow\n",
306 *location = (*location & ~0x03ffffff) |
307 ((*location + (v >> 2)) & 0x03ffffff);
311 static int apply_r_mips_hi16(struct module *me, uint32_t *location,
317 * We cannot relocate this one now because we don't know the value of
318 * the carry we need to add. Save the information, and let LO16 do the
321 n = kmalloc(sizeof(*n), GFP_KERNEL);
327 n->next = mips_hi16_list;
333 static int apply_r_mips_lo16(struct module *me, uint32_t *location,
336 unsigned long insnlo = *location;
337 Elf32_Addr val, vallo;
338 struct mips_hi16 *l, *next;
340 /* Sign extend the addend we extract from the lo insn. */
341 vallo = ((insnlo & 0xffff) ^ 0x8000) - 0x8000;
343 if (mips_hi16_list != NULL) {
350 * The value for the HI16 had best be the same.
353 pr_debug("VPE loader: apply_r_mips_lo16/hi16: inconsistent value information\n");
358 * Do the HI16 relocation. Note that we actually don't
359 * need to know anything about the LO16 itself, except
360 * where to find the low 16 bits of the addend needed
364 val = ((insn & 0xffff) << 16) + vallo;
368 * Account for the sign extension that will happen in
371 val = ((val >> 16) + ((val & 0x8000) != 0)) & 0xffff;
373 insn = (insn & ~0xffff) | val;
381 mips_hi16_list = NULL;
385 * Ok, we're done with the HI16 relocs. Now deal with the LO16.
388 insnlo = (insnlo & ~0xffff) | (val & 0xffff);
399 mips_hi16_list = NULL;
404 static int (*reloc_handlers[]) (struct module *me, uint32_t *location,
406 [R_MIPS_NONE] = apply_r_mips_none,
407 [R_MIPS_32] = apply_r_mips_32,
408 [R_MIPS_26] = apply_r_mips_26,
409 [R_MIPS_HI16] = apply_r_mips_hi16,
410 [R_MIPS_LO16] = apply_r_mips_lo16,
411 [R_MIPS_GPREL16] = apply_r_mips_gprel16,
412 [R_MIPS_PC16] = apply_r_mips_pc16
415 static char *rstrs[] = {
416 [R_MIPS_NONE] = "MIPS_NONE",
417 [R_MIPS_32] = "MIPS_32",
418 [R_MIPS_26] = "MIPS_26",
419 [R_MIPS_HI16] = "MIPS_HI16",
420 [R_MIPS_LO16] = "MIPS_LO16",
421 [R_MIPS_GPREL16] = "MIPS_GPREL16",
422 [R_MIPS_PC16] = "MIPS_PC16"
425 static int apply_relocations(Elf32_Shdr *sechdrs,
427 unsigned int symindex,
431 Elf32_Rel *rel = (void *) sechdrs[relsec].sh_addr;
438 for (i = 0; i < sechdrs[relsec].sh_size / sizeof(*rel); i++) {
439 Elf32_Word r_info = rel[i].r_info;
441 /* This is where to make the change */
442 location = (void *)sechdrs[sechdrs[relsec].sh_info].sh_addr
444 /* This is the symbol it is referring to */
445 sym = (Elf32_Sym *)sechdrs[symindex].sh_addr
446 + ELF32_R_SYM(r_info);
448 if (!sym->st_value) {
449 pr_debug("%s: undefined weak symbol %s\n",
450 me->name, strtab + sym->st_name);
451 /* just print the warning, dont barf */
456 res = reloc_handlers[ELF32_R_TYPE(r_info)](me, location, v);
458 char *r = rstrs[ELF32_R_TYPE(r_info)];
459 pr_warn("VPE loader: .text+0x%x relocation type %s for symbol \"%s\" failed\n",
460 rel[i].r_offset, r ? r : "UNKNOWN",
461 strtab + sym->st_name);
469 static inline void save_gp_address(unsigned int secbase, unsigned int rel)
471 gp_addr = secbase + rel;
472 gp_offs = gp_addr - (secbase & 0xffff0000);
474 /* end module-elf32.c */
476 /* Change all symbols so that sh_value encodes the pointer directly. */
477 static void simplify_symbols(Elf_Shdr *sechdrs,
478 unsigned int symindex,
480 const char *secstrings,
481 unsigned int nsecs, struct module *mod)
483 Elf_Sym *sym = (void *)sechdrs[symindex].sh_addr;
484 unsigned long secbase, bssbase = 0;
485 unsigned int i, n = sechdrs[symindex].sh_size / sizeof(Elf_Sym);
488 /* find the .bss section for COMMON symbols */
489 for (i = 0; i < nsecs; i++) {
490 if (strncmp(secstrings + sechdrs[i].sh_name, ".bss", 4) == 0) {
491 bssbase = sechdrs[i].sh_addr;
496 for (i = 1; i < n; i++) {
497 switch (sym[i].st_shndx) {
499 /* Allocate space for the symbol in the .bss section.
500 st_value is currently size.
501 We want it to have the address of the symbol. */
503 size = sym[i].st_value;
504 sym[i].st_value = bssbase;
510 /* Don't need to do anything */
517 case SHN_MIPS_SCOMMON:
518 pr_debug("simplify_symbols: ignoring SHN_MIPS_SCOMMON symbol <%s> st_shndx %d\n",
519 strtab + sym[i].st_name, sym[i].st_shndx);
524 secbase = sechdrs[sym[i].st_shndx].sh_addr;
526 if (strncmp(strtab + sym[i].st_name, "_gp", 3) == 0)
527 save_gp_address(secbase, sym[i].st_value);
529 sym[i].st_value += secbase;
535 #ifdef DEBUG_ELFLOADER
536 static void dump_elfsymbols(Elf_Shdr *sechdrs, unsigned int symindex,
537 const char *strtab, struct module *mod)
539 Elf_Sym *sym = (void *)sechdrs[symindex].sh_addr;
540 unsigned int i, n = sechdrs[symindex].sh_size / sizeof(Elf_Sym);
542 pr_debug("dump_elfsymbols: n %d\n", n);
543 for (i = 1; i < n; i++) {
544 pr_debug(" i %d name <%s> 0x%x\n", i, strtab + sym[i].st_name,
550 static int find_vpe_symbols(struct vpe *v, Elf_Shdr *sechdrs,
551 unsigned int symindex, const char *strtab,
554 Elf_Sym *sym = (void *)sechdrs[symindex].sh_addr;
555 unsigned int i, n = sechdrs[symindex].sh_size / sizeof(Elf_Sym);
557 for (i = 1; i < n; i++) {
558 if (strcmp(strtab + sym[i].st_name, "__start") == 0)
559 v->__start = sym[i].st_value;
561 if (strcmp(strtab + sym[i].st_name, "vpe_shared") == 0)
562 v->shared_ptr = (void *)sym[i].st_value;
565 if ((v->__start == 0) || (v->shared_ptr == NULL))
572 * Allocates a VPE with some program code space(the load address), copies the
573 * contents of the program (p)buffer performing relocatations/etc, free's it
576 static int vpe_elfload(struct vpe *v)
581 char *secstrings, *strtab = NULL;
582 unsigned int len, i, symindex = 0, strindex = 0, relocate = 0;
583 struct module mod; /* so we can re-use the relocations code */
585 memset(&mod, 0, sizeof(struct module));
586 strcpy(mod.name, "VPE loader");
588 hdr = (Elf_Ehdr *) v->pbuffer;
591 /* Sanity checks against insmoding binaries or wrong arch,
593 if (memcmp(hdr->e_ident, ELFMAG, SELFMAG) != 0
594 || (hdr->e_type != ET_REL && hdr->e_type != ET_EXEC)
595 || !elf_check_arch(hdr)
596 || hdr->e_shentsize != sizeof(*sechdrs)) {
597 pr_warn("VPE loader: program wrong arch or weird elf version\n");
602 if (hdr->e_type == ET_REL)
605 if (len < hdr->e_shoff + hdr->e_shnum * sizeof(Elf_Shdr)) {
606 pr_err("VPE loader: program length %u truncated\n", len);
611 /* Convenience variables */
612 sechdrs = (void *)hdr + hdr->e_shoff;
613 secstrings = (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
614 sechdrs[0].sh_addr = 0;
616 /* And these should exist, but gcc whinges if we don't init them */
617 symindex = strindex = 0;
620 for (i = 1; i < hdr->e_shnum; i++) {
621 if ((sechdrs[i].sh_type != SHT_NOBITS) &&
622 (len < sechdrs[i].sh_offset + sechdrs[i].sh_size)) {
623 pr_err("VPE program length %u truncated\n",
628 /* Mark all sections sh_addr with their address in the
630 sechdrs[i].sh_addr = (size_t) hdr +
631 sechdrs[i].sh_offset;
633 /* Internal symbols and strings. */
634 if (sechdrs[i].sh_type == SHT_SYMTAB) {
636 strindex = sechdrs[i].sh_link;
637 strtab = (char *)hdr +
638 sechdrs[strindex].sh_offset;
641 layout_sections(&mod, hdr, sechdrs, secstrings);
644 v->load_addr = alloc_progmem(mod.core_layout.size);
648 pr_info("VPE loader: loading to %p\n", v->load_addr);
651 for (i = 0; i < hdr->e_shnum; i++) {
654 if (!(sechdrs[i].sh_flags & SHF_ALLOC))
657 dest = v->load_addr + sechdrs[i].sh_entsize;
659 if (sechdrs[i].sh_type != SHT_NOBITS)
660 memcpy(dest, (void *)sechdrs[i].sh_addr,
662 /* Update sh_addr to point to copy in image. */
663 sechdrs[i].sh_addr = (unsigned long)dest;
665 pr_debug(" section sh_name %s sh_addr 0x%x\n",
666 secstrings + sechdrs[i].sh_name,
670 /* Fix up syms, so that st_value is a pointer to location. */
671 simplify_symbols(sechdrs, symindex, strtab, secstrings,
674 /* Now do relocations. */
675 for (i = 1; i < hdr->e_shnum; i++) {
676 const char *strtab = (char *)sechdrs[strindex].sh_addr;
677 unsigned int info = sechdrs[i].sh_info;
679 /* Not a valid relocation section? */
680 if (info >= hdr->e_shnum)
683 /* Don't bother with non-allocated sections */
684 if (!(sechdrs[info].sh_flags & SHF_ALLOC))
687 if (sechdrs[i].sh_type == SHT_REL)
688 err = apply_relocations(sechdrs, strtab,
690 else if (sechdrs[i].sh_type == SHT_RELA)
691 err = apply_relocate_add(sechdrs, strtab,
698 struct elf_phdr *phdr = (struct elf_phdr *)
699 ((char *)hdr + hdr->e_phoff);
701 for (i = 0; i < hdr->e_phnum; i++) {
702 if (phdr->p_type == PT_LOAD) {
703 memcpy((void *)phdr->p_paddr,
704 (char *)hdr + phdr->p_offset,
706 memset((void *)phdr->p_paddr + phdr->p_filesz,
707 0, phdr->p_memsz - phdr->p_filesz);
712 for (i = 0; i < hdr->e_shnum; i++) {
713 /* Internal symbols and strings. */
714 if (sechdrs[i].sh_type == SHT_SYMTAB) {
716 strindex = sechdrs[i].sh_link;
717 strtab = (char *)hdr +
718 sechdrs[strindex].sh_offset;
721 * mark symtab's address for when we try
722 * to find the magic symbols
724 sechdrs[i].sh_addr = (size_t) hdr +
725 sechdrs[i].sh_offset;
730 /* make sure it's physically written out */
731 flush_icache_range((unsigned long)v->load_addr,
732 (unsigned long)v->load_addr + v->len);
734 if ((find_vpe_symbols(v, sechdrs, symindex, strtab, &mod)) < 0) {
735 if (v->__start == 0) {
736 pr_warn("VPE loader: program does not contain a __start symbol\n");
740 if (v->shared_ptr == NULL)
741 pr_warn("VPE loader: program does not contain vpe_shared symbol.\n"
742 " Unable to use AMVP (AP/SP) facilities.\n");
745 pr_info(" elf loaded\n");
749 /* checks VPE is unused and gets ready to load program */
750 static int vpe_open(struct inode *inode, struct file *filp)
752 enum vpe_state state;
753 struct vpe_notifications *notifier;
756 if (VPE_MODULE_MINOR != iminor(inode)) {
757 /* assume only 1 device at the moment. */
758 pr_warn("VPE loader: only vpe1 is supported\n");
763 v = get_vpe(aprp_cpu_index());
765 pr_warn("VPE loader: unable to get vpe\n");
770 state = xchg(&v->state, VPE_STATE_INUSE);
771 if (state != VPE_STATE_UNUSED) {
772 pr_debug("VPE loader: tc in use dumping regs\n");
774 list_for_each_entry(notifier, &v->notify, list)
775 notifier->stop(aprp_cpu_index());
777 release_progmem(v->load_addr);
778 cleanup_tc(get_tc(aprp_cpu_index()));
781 /* this of-course trashes what was there before... */
782 v->pbuffer = vmalloc(P_SIZE);
784 pr_warn("VPE loader: unable to allocate memory\n");
790 v->shared_ptr = NULL;
796 static int vpe_release(struct inode *inode, struct file *filp)
798 #if defined(CONFIG_MIPS_VPE_LOADER_MT) || defined(CONFIG_MIPS_VPE_LOADER_CMP)
803 v = get_vpe(aprp_cpu_index());
807 hdr = (Elf_Ehdr *) v->pbuffer;
808 if (memcmp(hdr->e_ident, ELFMAG, SELFMAG) == 0) {
809 if (vpe_elfload(v) >= 0) {
812 pr_warn("VPE loader: ELF load failed.\n");
816 pr_warn("VPE loader: only elf files are supported\n");
820 /* It's good to be able to run the SP and if it chokes have a look at
821 the /dev/rt?. But if we reset the pointer to the shared struct we
822 lose what has happened. So perhaps if garbage is sent to the vpe
823 device, use it as a trigger for the reset. Hopefully a nice
824 executable will be along shortly. */
826 v->shared_ptr = NULL;
833 pr_warn("VPE loader: ELF load failed.\n");
838 static ssize_t vpe_write(struct file *file, const char __user *buffer,
839 size_t count, loff_t *ppos)
844 if (iminor(file_inode(file)) != VPE_MODULE_MINOR)
847 v = get_vpe(aprp_cpu_index());
852 if ((count + v->len) > v->plen) {
853 pr_warn("VPE loader: elf size too big. Perhaps strip unneeded symbols\n");
857 count -= copy_from_user(v->pbuffer + v->len, buffer, count);
865 const struct file_operations vpe_fops = {
866 .owner = THIS_MODULE,
868 .release = vpe_release,
870 .llseek = noop_llseek,
873 void *vpe_get_shared(int index)
875 struct vpe *v = get_vpe(index);
880 return v->shared_ptr;
882 EXPORT_SYMBOL(vpe_get_shared);
884 int vpe_notify(int index, struct vpe_notifications *notify)
886 struct vpe *v = get_vpe(index);
891 list_add(¬ify->list, &v->notify);
894 EXPORT_SYMBOL(vpe_notify);
896 module_init(vpe_module_init);
897 module_exit(vpe_module_exit);
898 MODULE_DESCRIPTION("MIPS VPE Loader");
899 MODULE_AUTHOR("Elizabeth Oldham, MIPS Technologies, Inc.");
900 MODULE_LICENSE("GPL");