source: svn/newcon3bcm2_21bu/nexus/build/nfe_driver/nexus_driver_firmware.c

/*
 * Copyright (C) 2010-2011 Broadcom Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
#include <linux/version.h>
#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 33)
#include <linux/autoconf.h>
#else
#include <generated/autoconf.h>
#endif
#include <linux/module.h>
#include <linux/init.h>
#include <linux/firmware.h>
#include <linux/platform_device.h>
#include <linux/elf.h>
#include <linux/slab.h>
#include <linux/vmalloc.h>
#include <linux/moduleloader.h>
#include <linux/err.h>
#include <asm/r4kcache.h>
#include <linux/string.h>
#include "nexus_driver_firmware.h"
#include "b_bare_os.h"

/* Jumptable pointers - forward jumptable pointer is in firmware (fwd_jumptable.c) so we load it with the value in stubs_fwd.S */
/* reverse jumptable pointer is below, we load it to the firmware (stubs_rev.S) */
typedef int (*B_Forward_Jumptable_Entry)(void);
B_Forward_Jumptable_Entry *pForward_Jumptable = NULL;
static b_bare_os_interface *pReverse_Jumptable = NULL;

/* Modified from arch/mips/kernel/vpe.c */
#ifndef ARCH_SHF_SMALL
#define ARCH_SHF_SMALL 0
#endif

#define NFE_PATH_MAX 256

struct mips_hi16 {
        struct mips_hi16 *next;
        Elf32_Addr *addr;
        Elf32_Addr value;
};

struct nfe {
        /* elfloader stuff */
        void *load_addr;
        unsigned long len;
        char *pbuffer;
        unsigned long plen;
        unsigned int uid, gid;
        char cwd[NFE_PATH_MAX];

        unsigned long fwd_jumptable;
        unsigned long rev_jumptable_pointer;
};

static struct mips_hi16 *mips_hi16_list;
static unsigned int gp_offs, gp_addr;

static inline void save_gp_address(unsigned int secbase, unsigned int rel)
{
        gp_addr = secbase + rel;
        gp_offs = gp_addr - (secbase & 0xffff0000);
}

/* Update size with this section: return offset. */
static long get_offset(unsigned int *size, Elf_Shdr * sechdr)
{
        long ret;

        ret = ALIGN(*size, sechdr->sh_addralign ? : 1);
        *size = ret + sechdr->sh_size;
        return ret;
}

/* Lay out the SHF_ALLOC sections in a way not dissimilar to how ld
   might -- code, read-only data, read-write data, small data.  Tally
   sizes, and place the offsets into sh_entsize fields: high bit means it
   belongs in init. */
static void layout_sections(struct module *mod, const Elf_Ehdr * hdr,
                            Elf_Shdr * sechdrs, const char *secstrings)
{
        static unsigned long const masks[][2] = {
                /* NOTE: all executable code must be the first section
                 * in this array; otherwise modify the text_size
                 * finder in the two loops below */
                {SHF_EXECINSTR | SHF_ALLOC, ARCH_SHF_SMALL},
                {SHF_ALLOC, SHF_WRITE | ARCH_SHF_SMALL},
                {SHF_WRITE | SHF_ALLOC, ARCH_SHF_SMALL},
                {ARCH_SHF_SMALL | SHF_ALLOC, 0}
        };
        unsigned int m, i;

        for (i = 0; i < hdr->e_shnum; i++)
                sechdrs[i].sh_entsize = ~0UL;

        for (m = 0; m < ARRAY_SIZE(masks); ++m) {
                for (i = 0; i < hdr->e_shnum; ++i) {
                        Elf_Shdr *s = &sechdrs[i];

                        //  || strncmp(secstrings + s->sh_name, ".init", 5) == 0)
                        if ((s->sh_flags & masks[m][0]) != masks[m][0]
                            || (s->sh_flags & masks[m][1])
                            || s->sh_entsize != ~0UL)
                                continue;
                        s->sh_entsize =
                                get_offset(&mod->core_size, s);
                }

                if (m == 0)
                        mod->core_text_size = mod->core_size;

        }
}

static int apply_r_mips_none(struct module *me, uint32_t *location,
                             Elf32_Addr v)
{
        return 0;
}

static int apply_r_mips_gprel16(struct module *me, uint32_t *location,
                                Elf32_Addr v)
{
        int rel;

        if( !(*location & 0xffff) ) {
                rel = (int)v - gp_addr;
        }
        else {
                /* .sbss + gp(relative) + offset */
                /* kludge! */
                rel =  (int)(short)((int)v + gp_offs +
                                    (int)(short)(*location & 0xffff) - gp_addr);
        }

        if( (rel > 32768) || (rel < -32768) ) {
                printk(KERN_DEBUG "NEXUS firmware loader: apply_r_mips_gprel16: "
                       "relative address 0x%x out of range of gp register\n",
                       rel);
                return -ENOEXEC;
        }

        *location = (*location & 0xffff0000) | (rel & 0xffff);

        return 0;
}

static int apply_r_mips_pc16(struct module *me, uint32_t *location,
                             Elf32_Addr v)
{
        int rel;
        rel = (((unsigned int)v - (unsigned int)location));
        rel >>= 2;              // because the offset is in _instructions_ not bytes.
        rel -= 1;               // and one instruction less due to the branch delay slot.

        if( (rel > 32768) || (rel < -32768) ) {
                printk(KERN_DEBUG "NEXUS firmware loader: "
                       "apply_r_mips_pc16: relative address out of range 0x%x\n", rel);
                return -ENOEXEC;
        }

        *location = (*location & 0xffff0000) | (rel & 0xffff);

        return 0;
}

static int apply_r_mips_32(struct module *me, uint32_t *location,
                           Elf32_Addr v)
{
        *location += v;

        return 0;
}

static int apply_r_mips_26(struct module *me, uint32_t *location,
                           Elf32_Addr v)
{
        if (v % 4) {
                printk(KERN_DEBUG "NEXUS firmware loader: apply_r_mips_26 "
                       " unaligned relocation\n");
                return -ENOEXEC;
        }
/*
 * Not desperately convinced this is a good check of an overflow condition
 * anyway. But it gets in the way of handling undefined weak symbols which
 * we want to set to zero.
 * if ((v & 0xf0000000) != (((unsigned long)location + 4) & 0xf0000000)) {
 * printk(KERN_ERR
 * "module %s: relocation overflow\n",
 * me->name);
 * return -ENOEXEC;
 * }
 */

        *location = (*location & ~0x03ffffff) |
                ((*location + (v >> 2)) & 0x03ffffff);
        return 0;
}


static int apply_r_mips_32_rela(struct module *me, u32 *location, Elf_Addr v)
{
        *location = v;

        return 0;
}

static int apply_r_mips_26_rela(struct module *me, u32 *location, Elf_Addr v)
{
        if (v % 4) {
                pr_err("module %s: dangerous R_MIPS_26 RELArelocation\n",
                       me->name);
                return -ENOEXEC;
        }

        if ((v & 0xf0000000) != (((unsigned long)location + 4) & 0xf0000000)) {
                printk(KERN_ERR
                       "module %s: relocation overflow\n",
                       me->name);
                return -ENOEXEC;
        }

        *location = (*location & ~0x03ffffff) | ((v >> 2) & 0x03ffffff);

        return 0;
}

static int apply_r_mips_hi16_rela(struct module *me, u32 *location, Elf_Addr v)
{
        *location = (*location & 0xffff0000) |
                    ((((long long) v + 0x8000LL) >> 16) & 0xffff);

        return 0;
}

static int apply_r_mips_lo16_rela(struct module *me, u32 *location, Elf_Addr v)
{
        *location = (*location & 0xffff0000) | (v & 0xffff);

        return 0;
}

static int apply_r_mips_64_rela(struct module *me, u32 *location, Elf_Addr v)
{
        *(Elf_Addr *)location = v;

        return 0;
}

static int apply_r_mips_higher_rela(struct module *me, u32 *location,
                                    Elf_Addr v)
{
        *location = (*location & 0xffff0000) |
                    ((((long long) v + 0x80008000LL) >> 32) & 0xffff);

        return 0;
}

static int apply_r_mips_highest_rela(struct module *me, u32 *location,
                                     Elf_Addr v)
{
        *location = (*location & 0xffff0000) |
                    ((((long long) v + 0x800080008000LL) >> 48) & 0xffff);

        return 0;
}


static int apply_r_mips_hi16(struct module *me, uint32_t *location,
                             Elf32_Addr v)
{
        struct mips_hi16 *n;

        /*
         * We cannot relocate this one now because we don't know the value of
         * the carry we need to add.  Save the information, and let LO16 do the
         * actual relocation.
         */
        n = kmalloc(sizeof *n, GFP_KERNEL);
        if (!n)
                return -ENOMEM;

        n->addr = location;
        n->value = v;
        n->next = mips_hi16_list;
        mips_hi16_list = n;

        return 0;
}

static int apply_r_mips_lo16(struct module *me, uint32_t *location,
                             Elf32_Addr v)
{
        unsigned long insnlo = *location;
        Elf32_Addr val, vallo;
        struct mips_hi16 *l, *next;

        /* Sign extend the addend we extract from the lo insn.  */
        vallo = ((insnlo & 0xffff) ^ 0x8000) - 0x8000;

        if (mips_hi16_list != NULL) {

                l = mips_hi16_list;
                while (l != NULL) {
                        unsigned long insn;

                        /*
                         * The value for the HI16 had best be the same.
                         */
                        if (v != l->value) {
                                printk(KERN_DEBUG "NEXUS firmware loader: "
                                       "apply_r_mips_lo16/hi16: \t"
                                       "inconsistent value information\n");
                                goto out_free;
                        }

                        /*
                         * Do the HI16 relocation.  Note that we actually don't
                         * need to know anything about the LO16 itself, except
                         * where to find the low 16 bits of the addend needed
                         * by the LO16.
                         */
                        insn = *l->addr;
                        val = ((insn & 0xffff) << 16) + vallo;
                        val += v;

                        /*
                         * Account for the sign extension that will happen in
                         * the low bits.
                         */
                        val = ((val >> 16) + ((val & 0x8000) != 0)) & 0xffff;

                        insn = (insn & ~0xffff) | val;
                        *l->addr = insn;

                        next = l->next;
                        kfree(l);
                        l = next;
                }

                mips_hi16_list = NULL;
        }

        /*
         * Ok, we're done with the HI16 relocs.  Now deal with the LO16.
         */
        val = v + vallo;
        insnlo = (insnlo & ~0xffff) | (val & 0xffff);
        *location = insnlo;

        return 0;

out_free:
        while (l != NULL) {
                next = l->next;
                kfree(l);
                l = next;
        }
        mips_hi16_list = NULL;

        return -ENOEXEC;
}


static int (*reloc_handlers[]) (struct module *me, uint32_t *location,
                                Elf32_Addr v) = {
        [R_MIPS_NONE]   = apply_r_mips_none,
        [R_MIPS_32]     = apply_r_mips_32,
        [R_MIPS_26]     = apply_r_mips_26,
        [R_MIPS_HI16]   = apply_r_mips_hi16,
        [R_MIPS_LO16]   = apply_r_mips_lo16,
        [R_MIPS_GPREL16] = apply_r_mips_gprel16,
        [R_MIPS_PC16] = apply_r_mips_pc16
};

static char *rstrs[] = {
        [R_MIPS_NONE]   = "MIPS_NONE",
        [R_MIPS_32]     = "MIPS_32",
        [R_MIPS_26]     = "MIPS_26",
        [R_MIPS_HI16]   = "MIPS_HI16",
        [R_MIPS_LO16]   = "MIPS_LO16",
        [R_MIPS_GPREL16] = "MIPS_GPREL16",
        [R_MIPS_PC16] = "MIPS_PC16"
};

static int apply_relocations(Elf32_Shdr *sechdrs,
                      const char *strtab,
                      unsigned int symindex,
                      unsigned int relsec,
                      struct module *me)
{
        Elf32_Rel *rel = (void *) sechdrs[relsec].sh_addr;
        Elf32_Sym *sym;
        uint32_t *location;
        unsigned int i;
        Elf32_Addr v;
        int res;

        for (i = 0; i < sechdrs[relsec].sh_size / sizeof(*rel); i++) {
                Elf32_Word r_info = rel[i].r_info;

                /* This is where to make the change */
                location = (void *)sechdrs[sechdrs[relsec].sh_info].sh_addr
                        + rel[i].r_offset;
                /* This is the symbol it is referring to */
                sym = (Elf32_Sym *)sechdrs[symindex].sh_addr
                        + ELF32_R_SYM(r_info);

                if (!sym->st_value) {
                        printk(KERN_DEBUG "%s: undefined weak symbol %s\n",
                               me->name, strtab + sym->st_name);
                        /* just print the warning, dont barf */
                }

                v = sym->st_value;

                res = reloc_handlers[ELF32_R_TYPE(r_info)](me, location, v);
                if( res ) {
                        char *r = rstrs[ELF32_R_TYPE(r_info)];
                        printk(KERN_WARNING "NEXUS firmware loader: .text+0x%x "
                               "relocation type %s for symbol \"%s\" failed\n",
                               rel[i].r_offset, r ? r : "UNKNOWN",
                               strtab + sym->st_name);
                        return res;
                }
        }

        return 0;
}

static int (*reloc_handlers_rela[]) (struct module *me, u32 *location,
                                Elf_Addr v) = {
        [R_MIPS_NONE]           = apply_r_mips_none,
        [R_MIPS_32]             = apply_r_mips_32_rela,
        [R_MIPS_26]             = apply_r_mips_26_rela,
        [R_MIPS_HI16]           = apply_r_mips_hi16_rela,
        [R_MIPS_LO16]           = apply_r_mips_lo16_rela,
        [R_MIPS_64]             = apply_r_mips_64_rela,
        [R_MIPS_HIGHER]         = apply_r_mips_higher_rela,
        [R_MIPS_HIGHEST]        = apply_r_mips_highest_rela
};

int apply_relocate_add(Elf_Shdr *sechdrs, const char *strtab,
                       unsigned int symindex, unsigned int relsec,
                       struct module *me)
{
        Elf_Mips_Rela *rel = (void *) sechdrs[relsec].sh_addr;
        Elf_Sym *sym;
        u32 *location;
        unsigned int i;
        Elf_Addr v;
        int res;

        printk(KERN_WARNING "Applying relocate section %u to %u\n", relsec,
               sechdrs[relsec].sh_info);

        for (i = 0; i < sechdrs[relsec].sh_size / sizeof(*rel); i++) {
                /* This is where to make the change */
                location = (void *)sechdrs[sechdrs[relsec].sh_info].sh_addr
                        + rel[i].r_offset;
                /* This is the symbol it is referring to */
                sym = (Elf_Sym *)sechdrs[symindex].sh_addr
                        + ELF_MIPS_R_SYM(rel[i]);
                if (IS_ERR_VALUE(sym->st_value)) {
                        /* Ignore unresolved weak symbol */
                        if (ELF_ST_BIND(sym->st_info) == STB_WEAK)
                                continue;
                        printk(KERN_WARNING "%s: Unknown symbol %s\n",
                               me->name, strtab + sym->st_name);
                        return -ENOENT;
                }

                v = sym->st_value + rel[i].r_addend;

                res = reloc_handlers_rela[ELF_MIPS_R_TYPE(rel[i])](me, location, v);
                if (res)
                        return res;
        }

        return 0;
}

/* Change all symbols so that sh_value encodes the pointer directly. */
static void simplify_symbols(Elf_Shdr * sechdrs,
                            unsigned int symindex,
                            const char *strtab,
                            const char *secstrings,
                            unsigned int nsecs, struct module *mod)
{
        Elf_Sym *sym = (void *)sechdrs[symindex].sh_addr;
        unsigned long secbase, bssbase = 0;
        unsigned int i, n = sechdrs[symindex].sh_size / sizeof(Elf_Sym);
        int size;

        /* find the .bss section for COMMON symbols */
        for (i = 0; i < nsecs; i++) {
                if (strncmp(secstrings + sechdrs[i].sh_name, ".bss", 4) == 0) {
                        bssbase = sechdrs[i].sh_addr;
                        break;
                }
        }

        for (i = 1; i < n; i++) {
                switch (sym[i].st_shndx) {
                case SHN_COMMON:
                        /* Allocate space for the symbol in the .bss section.
                           st_value is currently size.
                           We want it to have the address of the symbol. */

                        size = sym[i].st_value;
                        sym[i].st_value = bssbase;

                        bssbase += size;
                        break;

                case SHN_ABS:
                        /* Don't need to do anything */
                        break;

                case SHN_UNDEF:
                        /* ret = -ENOENT; */
                        break;

                case SHN_MIPS_SCOMMON:
                        printk(KERN_DEBUG "simplify_symbols: ignoring SHN_MIPS_SCOMMON "
                               "symbol <%s> st_shndx %d\n", strtab + sym[i].st_name,
                               sym[i].st_shndx);
                        // .sbss section
                        break;

                default:
                        secbase = sechdrs[sym[i].st_shndx].sh_addr;

                        if (strncmp(strtab + sym[i].st_name, "_gp", 3) == 0) {
                                save_gp_address(secbase, sym[i].st_value);
                        }

                        sym[i].st_value += secbase;
                        break;
                }
        }
}

/* Find some program space  */
static void *alloc_progmem(unsigned long len)
{
        void *addr;

        /* simple grab some mem for now */
        addr = vmalloc(len);
        memset(addr,0,len);

        return addr;
}

static void release_progmem(void *ptr)
{
        vfree(ptr);
}

static int find_jumptable_symbol(struct nfe * v, Elf_Shdr * sechdrs,
                                      unsigned int symindex, const char *strtab,
                                      struct module *mod)
{
        Elf_Sym *sym = (void *)sechdrs[symindex].sh_addr;
        unsigned int i, n = sechdrs[symindex].sh_size / sizeof(Elf_Sym);

        v->fwd_jumptable = 0;
        v->rev_jumptable_pointer = 0;

        for (i = 1; i < n; i++) {
                if (strcmp(strtab + sym[i].st_name, "B_Forward_Jumptable") == 0) {
                        v->fwd_jumptable = sym[i].st_value;
                }
                if (strcmp(strtab + sym[i].st_name, "pReverse_Jumptable") == 0) {
                        v->rev_jumptable_pointer = sym[i].st_value;
                }
        }

        if (v->fwd_jumptable == 0 || v->rev_jumptable_pointer == 0)
                return -1;

        return 0;
}

static int nexus_driver_firmware_relocate(struct nfe * v)
{
        Elf_Ehdr *hdr;
        Elf_Shdr *sechdrs;
        long err = 0;
        char *secstrings, *strtab = NULL;
        unsigned int len, i, symindex = 0, strindex = 0, relocate = 0;
        unsigned int start, end;
        struct module mod;      // so we can re-use the relocations code

        memset(&mod, 0, sizeof(struct module));
        strcpy(mod.name, "NEXUS firmware");

        hdr = (Elf_Ehdr *) v->pbuffer;
        len = v->plen;

        /* Sanity checks against insmoding binaries or wrong arch,
           weird elf version */
        if (memcmp(hdr->e_ident, ELFMAG, SELFMAG) != 0
                || (hdr->e_type != ET_REL && hdr->e_type != ET_EXEC)
                || !elf_check_arch(hdr)
                || hdr->e_shentsize != sizeof(*sechdrs)) {
                printk(KERN_WARNING
                           "NEXUS firmware loader: program wrong arch or weird elf version\n");

                return -ENOEXEC;
        }

        if (hdr->e_type == ET_REL)
                relocate = 1;

        if (len < hdr->e_shoff + hdr->e_shnum * sizeof(Elf_Shdr)) {
                printk(KERN_ERR "NEXUS firmware loader: program length %u truncated\n",
                           len);

                return -ENOEXEC;
        }

        /* Convenience variables */
        sechdrs = (void *)hdr + hdr->e_shoff;
        secstrings = (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
        sechdrs[0].sh_addr = 0;

        /* And these should exist, but gcc whinges if we don't init them */
        symindex = strindex = 0;

        if (relocate) {
                for (i = 1; i < hdr->e_shnum; i++) {
                        if (sechdrs[i].sh_type != SHT_NOBITS
                                && len < sechdrs[i].sh_offset + sechdrs[i].sh_size) {
                                printk(KERN_ERR "NEXUS firmware length %u truncated\n",
                                           len);
                                return -ENOEXEC;
                        }

                        /* Mark all sections sh_addr with their address in the
                           temporary image. */
                        sechdrs[i].sh_addr = (size_t) hdr + sechdrs[i].sh_offset;

                        /* Internal symbols and strings. */
                        if (sechdrs[i].sh_type == SHT_SYMTAB) {
                                symindex = i;
                                strindex = sechdrs[i].sh_link;
                                strtab = (char *)hdr + sechdrs[strindex].sh_offset;
                        }
                }
                layout_sections(&mod, hdr, sechdrs, secstrings);
        }

        v->load_addr = alloc_progmem(mod.core_size);
        if (!v->load_addr)
                return -ENOMEM;

        v->len = mod.core_size;

        printk(KERN_WARNING "NEXUS firmware loader: loading to %p relocate=%d\n", v->load_addr,relocate);

        if (relocate) {
                for (i = 0; i < hdr->e_shnum; i++) {
                        void *dest;

                        if (!(sechdrs[i].sh_flags & SHF_ALLOC))
                                continue;

                        dest = v->load_addr + sechdrs[i].sh_entsize;

                        if (sechdrs[i].sh_type != SHT_NOBITS)
                                memcpy(dest, (void *)sechdrs[i].sh_addr,
                                           sechdrs[i].sh_size);
                        /* Update sh_addr to point to copy in image. */
                        sechdrs[i].sh_addr = (unsigned long)dest;

                        printk(KERN_DEBUG " section sh_name %s sh_addr 0x%x\n",
                                   secstrings + sechdrs[i].sh_name, sechdrs[i].sh_addr);
                }

                /* Fix up syms, so that st_value is a pointer to location. */
                simplify_symbols(sechdrs, symindex, strtab, secstrings,
                                 hdr->e_shnum, &mod);

                /* Now do relocations. */
                for (i = 1; i < hdr->e_shnum; i++) {
                        const char *strtab = (char *)sechdrs[strindex].sh_addr;
                        unsigned int info = sechdrs[i].sh_info;

                        /* Not a valid relocation section? */
                        if (info >= hdr->e_shnum)
                                continue;

                        /* Don't bother with non-allocated sections */
                        if (!(sechdrs[info].sh_flags & SHF_ALLOC))
                                continue;

                        if (sechdrs[i].sh_type == SHT_REL)
                                err = apply_relocations(sechdrs, strtab, symindex, i,
                                                        &mod);
                        else if (sechdrs[i].sh_type == SHT_RELA)
                                err = apply_relocate_add(sechdrs, strtab, symindex, i,
                                                         &mod);
                        if (err < 0)
                                return err;

                }
        } else {
                struct elf_phdr *phdr = (struct elf_phdr *) ((char *)hdr + hdr->e_phoff);

                for (i = 0; i < hdr->e_phnum; i++) {
                        if (phdr->p_type == PT_LOAD) {
                                memcpy((void *)phdr->p_paddr,
                                           (char *)hdr + phdr->p_offset,
                                           phdr->p_filesz);
                                memset((void *)phdr->p_paddr + phdr->p_filesz,
                                           0, phdr->p_memsz - phdr->p_filesz);
                        }
                        phdr++;
                }

                for (i = 0; i < hdr->e_shnum; i++) {
                        /* Internal symbols and strings. */
                        if (sechdrs[i].sh_type == SHT_SYMTAB) {
                                symindex = i;
                                strindex = sechdrs[i].sh_link;
                                strtab = (char *)hdr + sechdrs[strindex].sh_offset;

                                /* mark the symtab's address for when we try to find the
                                   magic symbols */
                                sechdrs[i].sh_addr = (size_t) hdr + sechdrs[i].sh_offset;
                        }
                }
        }

        /* make sure it's physically written out */
        start = (unsigned long)v->load_addr;
        start &= ~(cpu_icache_line_size() - 1);
        end = (unsigned long)v->load_addr + v->len;
        end &= ~(cpu_icache_line_size() - 1);

        for (; start <= end; start += cpu_icache_line_size())
                flush_icache_line(start);

        if ((find_jumptable_symbol(v, sechdrs, symindex, strtab, &mod)) < 0) {
                        if (!v->fwd_jumptable)printk(KERN_WARNING "NEXUS firmware loader: firmware does not contain "
                                   "B_Forward_Jumptable symbol\n");
                        if (!v->rev_jumptable_pointer)printk(KERN_WARNING "NEXUS firmware loader: firmware does not contain "
                                          "pReverse_Jumptable symbol\n");
                        return -ENOEXEC;
        }
        pReverse_Jumptable = pb_bare_os;
        pForward_Jumptable = (B_Forward_Jumptable_Entry *) v->fwd_jumptable;
        printk(KERN_WARNING "B_Forward_Jumptable=%x B_Reverse_Jumptable=%x\n",(unsigned int)pForward_Jumptable, (unsigned int)pReverse_Jumptable);

        /* This sets the pointer in the firmware to pointer to the driver's b_bare_os structure */
        *(unsigned long *)(v->rev_jumptable_pointer) = (unsigned long) pReverse_Jumptable;
        return 0;

}


struct nfe v;

int nexus_driver_firmware_init()
{
        int err;
        struct platform_device *pdev;
        const struct firmware *fw;
        const char fw_name[] = "nexus_firmware.elf";
        unsigned long *cast_ptr;
        int i;


        /* Register a simple device so we can load some firmware */
        pdev = platform_device_register_simple("BCMnexus", 0, NULL, 0);
        if (!pdev) {
                printk(KERN_ERR "Failed to register device for \"%s\"\n",
                           fw_name);
                return -EINVAL;
        }

        /* Request the firmware */
        err = request_firmware(&fw, fw_name, &pdev->dev);
        platform_device_unregister(pdev);
        if (err) {
                printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
                           fw_name, err);
                return err;
        }


        v.pbuffer = (char *)fw->data;
        v.plen = fw->size;

        err = nexus_driver_firmware_relocate(&v);
        if (err) {
                printk(KERN_ERR "Failed to relocate firmware. err=%d\n", err);
                release_firmware(fw);
                nexus_driver_firmware_uninit();
                return err;
        }

#if 0
        cast_ptr = (unsigned long *) pForward_Jumptable;
        printk("Entry[0] in fwd table %x\n",*cast_ptr++);
        printk("Entry[1] in fwd table %x\n",*cast_ptr++);
        printk("Entry[2] in fwd table %x\n",*cast_ptr++);
        printk("Entry[3] in fwd table %x\n",*cast_ptr);
        cast_ptr = (unsigned long *) pReverse_Jumptable;
        printk("Entry[0] in rev table %x\n",*cast_ptr++);
        printk("Entry[1] in rev table %x\n",*cast_ptr++);
        printk("Entry[2] in rev table %x\n",*cast_ptr);
#endif
        /* Check tables for NULL entries */
        for(i=0,cast_ptr = (unsigned long *) pForward_Jumptable;*cast_ptr!=(-1);i++,cast_ptr++)
                        if(!*cast_ptr) {
                                printk(KERN_ERR "Null entry at %d in forward table\n",i);
                                release_firmware(fw);
                                nexus_driver_firmware_uninit();
                                return -EINVAL;
                        }
        pReverse_Jumptable->end_of_functions = (void *) -1;
        for(i=0,cast_ptr = (unsigned long *) pReverse_Jumptable;*cast_ptr!=(-1);i++,cast_ptr++)
                        if(!*cast_ptr) {
                                printk(KERN_ERR "Null entry at %d in reverse table\n",i);
                                release_firmware(fw);
                                nexus_driver_firmware_uninit();
                                return -EINVAL;
                        }

        release_firmware(fw);
        return 0;
}

int nexus_driver_firmware_uninit()
{
        if (v.load_addr)
                release_progmem(v.load_addr);
        pForward_Jumptable = NULL;
        return 0;
}