Staging: merge 2.6.39-rc3 into staging-next

[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / staging / brcm80211 / util / bcmsrom.c

/*
 * Copyright (c) 2010 Broadcom Corporation
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/etherdevice.h>
#include <bcmdefs.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <stdarg.h>
#include <bcmutils.h>
#include <hndsoc.h>
#include <sbchipc.h>
#include <bcmdevs.h>
#include <pcicfg.h>
#include <siutils.h>
#include <bcmsrom.h>
#include <bcmsrom_tbl.h>

#include <bcmnvram.h>
#include <bcmotp.h>

#define SROM_OFFSET(sih) ((sih->ccrev > 31) ? \
        (((sih->cccaps & CC_CAP_SROM) == 0) ? NULL : \
         ((u8 *)curmap + PCI_16KB0_CCREGS_OFFSET + CC_SROM_OTP)) : \
        ((u8 *)curmap + PCI_BAR0_SPROM_OFFSET))

#if defined(BCMDBG)
#define WRITE_ENABLE_DELAY      500     /* 500 ms after write enable/disable toggle */
#define WRITE_WORD_DELAY        20      /* 20 ms between each word write */
#endif

typedef struct varbuf {
        char *base;             /* pointer to buffer base */
        char *buf;              /* pointer to current position */
        unsigned int size;      /* current (residual) size in bytes */
} varbuf_t;
extern char *_vars;
extern uint _varsz;

static int initvars_srom_si(si_t *sih, void *curmap, char **vars, uint *count);
static void _initvars_srom_pci(u8 sromrev, u16 *srom, uint off, varbuf_t *b);
static int initvars_srom_pci(si_t *sih, void *curmap, char **vars, uint *count);
static int initvars_flash_si(si_t *sih, char **vars, uint *count);
static int sprom_read_pci(si_t *sih, u16 *sprom,
                          uint wordoff, u16 *buf, uint nwords, bool check_crc);
#if defined(BCMNVRAMR)
static int otp_read_pci(si_t *sih, u16 *buf, uint bufsz);
#endif
static u16 srom_cc_cmd(si_t *sih, void *ccregs, u32 cmd,
                          uint wordoff, u16 data);

static int initvars_table(char *start, char *end,
                          char **vars, uint *count);
static int initvars_flash(si_t *sih, char **vp,
                          uint len);

/* Initialization of varbuf structure */
static void varbuf_init(varbuf_t *b, char *buf, uint size)
{
        b->size = size;
        b->base = b->buf = buf;
}

/* append a null terminated var=value string */
static int varbuf_append(varbuf_t *b, const char *fmt, ...)
{
        va_list ap;
        int r;
        size_t len;
        char *s;

        if (b->size < 2)
                return 0;

        va_start(ap, fmt);
        r = vsnprintf(b->buf, b->size, fmt, ap);
        va_end(ap);

        /* C99 snprintf behavior returns r >= size on overflow,
         * others return -1 on overflow.
         * All return -1 on format error.
         * We need to leave room for 2 null terminations, one for the current var
         * string, and one for final null of the var table. So check that the
         * strlen written, r, leaves room for 2 chars.
         */
        if ((r == -1) || (r > (int)(b->size - 2))) {
                b->size = 0;
                return 0;
        }

        /* Remove any earlier occurrence of the same variable */
        s = strchr(b->buf, '=');
        if (s != NULL) {
                len = (size_t) (s - b->buf);
                for (s = b->base; s < b->buf;) {
                        if ((memcmp(s, b->buf, len) == 0) && s[len] == '=') {
                                len = strlen(s) + 1;
                                memmove(s, (s + len),
                                        ((b->buf + r + 1) - (s + len)));
                                b->buf -= len;
                                b->size += (unsigned int)len;
                                break;
                        }

                        while (*s++)
                                ;
                }
        }

        /* skip over this string's null termination */
        r++;
        b->size -= r;
        b->buf += r;

        return r;
}

/*
 * Initialize local vars from the right source for this platform.
 * Return 0 on success, nonzero on error.
 */
int srom_var_init(si_t *sih, uint bustype, void *curmap,
                  char **vars, uint *count)
{
        uint len;

        len = 0;

        ASSERT(bustype == bustype);
        if (vars == NULL || count == NULL)
                return 0;

        *vars = NULL;
        *count = 0;

        switch (bustype) {
        case SI_BUS:
        case JTAG_BUS:
                return initvars_srom_si(sih, curmap, vars, count);

        case PCI_BUS:
                ASSERT(curmap != NULL);
                if (curmap == NULL)
                        return -1;

                return initvars_srom_pci(sih, curmap, vars, count);

        default:
                ASSERT(0);
        }
        return -1;
}

/* In chips with chipcommon rev 32 and later, the srom is in chipcommon,
 * not in the bus cores.
 */
static u16
srom_cc_cmd(si_t *sih, void *ccregs, u32 cmd,
            uint wordoff, u16 data)
{
        chipcregs_t *cc = (chipcregs_t *) ccregs;
        uint wait_cnt = 1000;

        if ((cmd == SRC_OP_READ) || (cmd == SRC_OP_WRITE)) {
                W_REG(&cc->sromaddress, wordoff * 2);
                if (cmd == SRC_OP_WRITE)
                        W_REG(&cc->sromdata, data);
        }

        W_REG(&cc->sromcontrol, SRC_START | cmd);

        while (wait_cnt--) {
                if ((R_REG(&cc->sromcontrol) & SRC_BUSY) == 0)
                        break;
        }

        if (!wait_cnt) {
                return 0xffff;
        }
        if (cmd == SRC_OP_READ)
                return (u16) R_REG(&cc->sromdata);
        else
                return 0xffff;
}

static inline void ltoh16_buf(u16 *buf, unsigned int size)
{
        for (size /= 2; size; size--)
                *(buf + size) = le16_to_cpu(*(buf + size));
}

static inline void htol16_buf(u16 *buf, unsigned int size)
{
        for (size /= 2; size; size--)
                *(buf + size) = cpu_to_le16(*(buf + size));
}

/*
 * Read in and validate sprom.
 * Return 0 on success, nonzero on error.
 */
static int
sprom_read_pci(si_t *sih, u16 *sprom, uint wordoff,
               u16 *buf, uint nwords, bool check_crc)
{
        int err = 0;
        uint i;
        void *ccregs = NULL;

        /* read the sprom */
        for (i = 0; i < nwords; i++) {

                if (sih->ccrev > 31 && ISSIM_ENAB(sih)) {
                        /* use indirect since direct is too slow on QT */
                        if ((sih->cccaps & CC_CAP_SROM) == 0)
                                return 1;

                        ccregs = (void *)((u8 *) sprom - CC_SROM_OTP);
                        buf[i] =
                            srom_cc_cmd(sih, ccregs, SRC_OP_READ,
                                        wordoff + i, 0);

                } else {
                        if (ISSIM_ENAB(sih))
                                buf[i] = R_REG(&sprom[wordoff + i]);

                        buf[i] = R_REG(&sprom[wordoff + i]);
                }

        }

        /* bypass crc checking for simulation to allow srom hack */
        if (ISSIM_ENAB(sih))
                return err;

        if (check_crc) {

                if (buf[0] == 0xffff) {
                        /* The hardware thinks that an srom that starts with 0xffff
                         * is blank, regardless of the rest of the content, so declare
                         * it bad.
                         */
                        return 1;
                }

                /* fixup the endianness so crc8 will pass */
                htol16_buf(buf, nwords * 2);
                if (hndcrc8((u8 *) buf, nwords * 2, CRC8_INIT_VALUE) !=
                    CRC8_GOOD_VALUE) {
                        /* DBG only pci always read srom4 first, then srom8/9 */
                        err = 1;
                }
                /* now correct the endianness of the byte array */
                ltoh16_buf(buf, nwords * 2);
        }
        return err;
}

#if defined(BCMNVRAMR)
static int otp_read_pci(si_t *sih, u16 *buf, uint bufsz)
{
        u8 *otp;
        uint sz = OTP_SZ_MAX / 2;       /* size in words */
        int err = 0;

        ASSERT(bufsz <= OTP_SZ_MAX);

        otp = kzalloc(OTP_SZ_MAX, GFP_ATOMIC);
        if (otp == NULL) {
                return BCME_ERROR;
        }

        err = otp_read_region(sih, OTP_HW_RGN, (u16 *) otp, &sz);

        memcpy(buf, otp, bufsz);

        kfree(otp);

        /* Check CRC */
        if (buf[0] == 0xffff) {
                /* The hardware thinks that an srom that starts with 0xffff
                 * is blank, regardless of the rest of the content, so declare
                 * it bad.
                 */
                return 1;
        }

        /* fixup the endianness so crc8 will pass */
        htol16_buf(buf, bufsz);
        if (hndcrc8((u8 *) buf, SROM4_WORDS * 2, CRC8_INIT_VALUE) !=
            CRC8_GOOD_VALUE) {
                err = 1;
        }
        /* now correct the endianness of the byte array */
        ltoh16_buf(buf, bufsz);

        return err;
}
#endif                          /* defined(BCMNVRAMR) */
/*
* Create variable table from memory.
* Return 0 on success, nonzero on error.
*/
static int initvars_table(char *start, char *end,
                          char **vars, uint *count)
{
        int c = (int)(end - start);

        /* do it only when there is more than just the null string */
        if (c > 1) {
                char *vp = kmalloc(c, GFP_ATOMIC);
                ASSERT(vp != NULL);
                if (!vp)
                        return BCME_NOMEM;
                memcpy(vp, start, c);
                *vars = vp;
                *count = c;
        } else {
                *vars = NULL;
                *count = 0;
        }

        return 0;
}

/*
 * Find variables with <devpath> from flash. 'base' points to the beginning
 * of the table upon enter and to the end of the table upon exit when success.
 * Return 0 on success, nonzero on error.
 */
static int initvars_flash(si_t *sih, char **base, uint len)
{
        char *vp = *base;
        char *flash;
        int err;
        char *s;
        uint l, dl, copy_len;
        char devpath[SI_DEVPATH_BUFSZ];

        /* allocate memory and read in flash */
        flash = kmalloc(NVRAM_SPACE, GFP_ATOMIC);
        if (!flash)
                return BCME_NOMEM;
        err = nvram_getall(flash, NVRAM_SPACE);
        if (err)
                goto exit;

        si_devpath(sih, devpath, sizeof(devpath));

        /* grab vars with the <devpath> prefix in name */
        dl = strlen(devpath);
        for (s = flash; s && *s; s += l + 1) {
                l = strlen(s);

                /* skip non-matching variable */
                if (strncmp(s, devpath, dl))
                        continue;

                /* is there enough room to copy? */
                copy_len = l - dl + 1;
                if (len < copy_len) {
                        err = BCME_BUFTOOSHORT;
                        goto exit;
                }

                /* no prefix, just the name=value */
                strncpy(vp, &s[dl], copy_len);
                vp += copy_len;
                len -= copy_len;
        }

        /* add null string as terminator */
        if (len < 1) {
                err = BCME_BUFTOOSHORT;
                goto exit;
        }
        *vp++ = '\0';

        *base = vp;

 exit:  kfree(flash);
        return err;
}

/*
 * Initialize nonvolatile variable table from flash.
 * Return 0 on success, nonzero on error.
 */
static int initvars_flash_si(si_t *sih, char **vars, uint *count)
{
        char *vp, *base;
        int err;

        ASSERT(vars != NULL);
        ASSERT(count != NULL);

        base = vp = kmalloc(MAXSZ_NVRAM_VARS, GFP_ATOMIC);
        ASSERT(vp != NULL);
        if (!vp)
                return BCME_NOMEM;

        err = initvars_flash(sih, &vp, MAXSZ_NVRAM_VARS);
        if (err == 0)
                err = initvars_table(base, vp, vars, count);

        kfree(base);

        return err;
}

/* Parse SROM and create name=value pairs. 'srom' points to
 * the SROM word array. 'off' specifies the offset of the
 * first word 'srom' points to, which should be either 0 or
 * SROM3_SWRG_OFF (full SROM or software region).
 */

static uint mask_shift(u16 mask)
{
        uint i;
        for (i = 0; i < (sizeof(mask) << 3); i++) {
                if (mask & (1 << i))
                        return i;
        }
        ASSERT(mask);
        return 0;
}

static uint mask_width(u16 mask)
{
        int i;
        for (i = (sizeof(mask) << 3) - 1; i >= 0; i--) {
                if (mask & (1 << i))
                        return (uint) (i - mask_shift(mask) + 1);
        }
        ASSERT(mask);
        return 0;
}

#if defined(BCMDBG)
static bool mask_valid(u16 mask)
{
        uint shift = mask_shift(mask);
        uint width = mask_width(mask);
        return mask == ((~0 << shift) & ~(~0 << (shift + width)));
}
#endif                          /* BCMDBG */

static void _initvars_srom_pci(u8 sromrev, u16 *srom, uint off, varbuf_t *b)
{
        u16 w;
        u32 val;
        const sromvar_t *srv;
        uint width;
        uint flags;
        u32 sr = (1 << sromrev);

        varbuf_append(b, "sromrev=%d", sromrev);

        for (srv = pci_sromvars; srv->name != NULL; srv++) {
                const char *name;

                if ((srv->revmask & sr) == 0)
                        continue;

                if (srv->off < off)
                        continue;

                flags = srv->flags;
                name = srv->name;

                /* This entry is for mfgc only. Don't generate param for it, */
                if (flags & SRFL_NOVAR)
                        continue;

                if (flags & SRFL_ETHADDR) {
                        u8 ea[ETH_ALEN];

                        ea[0] = (srom[srv->off - off] >> 8) & 0xff;
                        ea[1] = srom[srv->off - off] & 0xff;
                        ea[2] = (srom[srv->off + 1 - off] >> 8) & 0xff;
                        ea[3] = srom[srv->off + 1 - off] & 0xff;
                        ea[4] = (srom[srv->off + 2 - off] >> 8) & 0xff;
                        ea[5] = srom[srv->off + 2 - off] & 0xff;

                        varbuf_append(b, "%s=%pM", name, ea);
                } else {
                        ASSERT(mask_valid(srv->mask));
                        ASSERT(mask_width(srv->mask));

                        w = srom[srv->off - off];
                        val = (w & srv->mask) >> mask_shift(srv->mask);
                        width = mask_width(srv->mask);

                        while (srv->flags & SRFL_MORE) {
                                srv++;
                                ASSERT(srv->name != NULL);

                                if (srv->off == 0 || srv->off < off)
                                        continue;

                                ASSERT(mask_valid(srv->mask));
                                ASSERT(mask_width(srv->mask));

                                w = srom[srv->off - off];
                                val +=
                                    ((w & srv->mask) >> mask_shift(srv->
                                                                   mask)) <<
                                    width;
                                width += mask_width(srv->mask);
                        }

                        if ((flags & SRFL_NOFFS)
                            && ((int)val == (1 << width) - 1))
                                continue;

                        if (flags & SRFL_CCODE) {
                                if (val == 0)
                                        varbuf_append(b, "ccode=");
                                else
                                        varbuf_append(b, "ccode=%c%c",
                                                      (val >> 8), (val & 0xff));
                        }
                        /* LED Powersave duty cycle has to be scaled:
                         *(oncount >> 24) (offcount >> 8)
                         */
                        else if (flags & SRFL_LEDDC) {
                                u32 w32 = (((val >> 8) & 0xff) << 24) | /* oncount */
                                    (((val & 0xff)) << 8);      /* offcount */
                                varbuf_append(b, "leddc=%d", w32);
                        } else if (flags & SRFL_PRHEX)
                                varbuf_append(b, "%s=0x%x", name, val);
                        else if ((flags & SRFL_PRSIGN)
                                 && (val & (1 << (width - 1))))
                                varbuf_append(b, "%s=%d", name,
                                              (int)(val | (~0 << width)));
                        else
                                varbuf_append(b, "%s=%u", name, val);
                }
        }

        if (sromrev >= 4) {
                /* Do per-path variables */
                uint p, pb, psz;

                if (sromrev >= 8) {
                        pb = SROM8_PATH0;
                        psz = SROM8_PATH1 - SROM8_PATH0;
                } else {
                        pb = SROM4_PATH0;
                        psz = SROM4_PATH1 - SROM4_PATH0;
                }

                for (p = 0; p < MAX_PATH_SROM; p++) {
                        for (srv = perpath_pci_sromvars; srv->name != NULL;
                             srv++) {
                                if ((srv->revmask & sr) == 0)
                                        continue;

                                if (pb + srv->off < off)
                                        continue;

                                /* This entry is for mfgc only. Don't generate param for it, */
                                if (srv->flags & SRFL_NOVAR)
                                        continue;

                                w = srom[pb + srv->off - off];

                                ASSERT(mask_valid(srv->mask));
                                val = (w & srv->mask) >> mask_shift(srv->mask);
                                width = mask_width(srv->mask);

                                /* Cheating: no per-path var is more than 1 word */

                                if ((srv->flags & SRFL_NOFFS)
                                    && ((int)val == (1 << width) - 1))
                                        continue;

                                if (srv->flags & SRFL_PRHEX)
                                        varbuf_append(b, "%s%d=0x%x", srv->name,
                                                      p, val);
                                else
                                        varbuf_append(b, "%s%d=%d", srv->name,
                                                      p, val);
                        }
                        pb += psz;
                }
        }
}

/*
 * Initialize nonvolatile variable table from sprom.
 * Return 0 on success, nonzero on error.
 */
static int initvars_srom_pci(si_t *sih, void *curmap, char **vars, uint *count)
{
        u16 *srom, *sromwindow;
        u8 sromrev = 0;
        u32 sr;
        varbuf_t b;
        char *vp, *base = NULL;
        bool flash = false;
        int err = 0;

        /*
         * Apply CRC over SROM content regardless SROM is present or not,
         * and use variable <devpath>sromrev's existence in flash to decide
         * if we should return an error when CRC fails or read SROM variables
         * from flash.
         */
        srom = kmalloc(SROM_MAX, GFP_ATOMIC);
        ASSERT(srom != NULL);
        if (!srom)
                return -2;

        sromwindow = (u16 *) SROM_OFFSET(sih);
        if (si_is_sprom_available(sih)) {
                err =
                    sprom_read_pci(sih, sromwindow, 0, srom, SROM_WORDS,
                                   true);

                if ((srom[SROM4_SIGN] == SROM4_SIGNATURE) ||
                    (((sih->buscoretype == PCIE_CORE_ID)
                      && (sih->buscorerev >= 6))
                     || ((sih->buscoretype == PCI_CORE_ID)
                         && (sih->buscorerev >= 0xe)))) {
                        /* sromrev >= 4, read more */
                        err =
                            sprom_read_pci(sih, sromwindow, 0, srom,
                                           SROM4_WORDS, true);
                        sromrev = srom[SROM4_CRCREV] & 0xff;
                } else if (err == 0) {
                        /* srom is good and is rev < 4 */
                        /* top word of sprom contains version and crc8 */
                        sromrev = srom[SROM_CRCREV] & 0xff;
                        /* bcm4401 sroms misprogrammed */
                        if (sromrev == 0x10)
                                sromrev = 1;
                }
        }
#if defined(BCMNVRAMR)
        /* Use OTP if SPROM not available */
        else {
                err = otp_read_pci(sih, srom, SROM_MAX);
                if (err == 0)
                        /* OTP only contain SROM rev8/rev9 for now */
                        sromrev = srom[SROM4_CRCREV] & 0xff;
                else
                        err = 1;
        }
#else
        else
                err = 1;
#endif

        /*
         * We want internal/wltest driver to come up with default
         * sromvars so we can program a blank SPROM/OTP.
         */
        if (err) {
                char *value;
                u32 val;
                val = 0;

                value = si_getdevpathvar(sih, "sromrev");
                if (value) {
                        sromrev = (u8) simple_strtoul(value, NULL, 0);
                        flash = true;
                        goto varscont;
                }

                value = si_getnvramflvar(sih, "sromrev");
                if (value) {
                        err = 0;
                        goto errout;
                }

                {
                        err = -1;
                        goto errout;
                }
        }

 varscont:
        /* Bitmask for the sromrev */
        sr = 1 << sromrev;

        /* srom version check: Current valid versions: 1, 2, 3, 4, 5, 8, 9 */
        if ((sr & 0x33e) == 0) {
                err = -2;
                goto errout;
        }

        ASSERT(vars != NULL);
        ASSERT(count != NULL);

        base = vp = kmalloc(MAXSZ_NVRAM_VARS, GFP_ATOMIC);
        ASSERT(vp != NULL);
        if (!vp) {
                err = -2;
                goto errout;
        }

        /* read variables from flash */
        if (flash) {
                err = initvars_flash(sih, &vp, MAXSZ_NVRAM_VARS);
                if (err)
                        goto errout;
                goto varsdone;
        }

        varbuf_init(&b, base, MAXSZ_NVRAM_VARS);

        /* parse SROM into name=value pairs. */
        _initvars_srom_pci(sromrev, srom, 0, &b);

        /* final nullbyte terminator */
        ASSERT(b.size >= 1);
        vp = b.buf;
        *vp++ = '\0';

        ASSERT((vp - base) <= MAXSZ_NVRAM_VARS);

 varsdone:
        err = initvars_table(base, vp, vars, count);

 errout:
        if (base)
                kfree(base);

        kfree(srom);
        return err;
}


static int initvars_srom_si(si_t *sih, void *curmap, char **vars, uint *varsz)
{
        /* Search flash nvram section for srom variables */
        return initvars_flash_si(sih, vars, varsz);
}