Subversion Repositories or1k

/*

 * Common Flash Interface support:

 *   ST Advanced Architecture Command Set (ID 0x0020)

 *

 * (C) 2000 Red Hat. GPL'd

 *

 *

 * 10/10/2000   Nicolas Pitre <nico@cam.org>

 *      - completely revamped method functions so they are aware and

 *        independent of the flash geometry (buswidth, interleave, etc.)

 *      - scalability vs code size is completely set at compile-time

 *        (see include/linux/mtd/cfi.h for selection)

 *      - optimized write buffer method

 * 06/21/2002   Joern Engel <joern@wh.fh-wedel.de> and others

 *      - modified Intel Command Set 0x0001 to support ST Advanced Architecture

 *        (command set 0x0020)

 *      - added a writev function

 */

#include <linux/module.h>

#include <linux/types.h>

#include <linux/kernel.h>

#include <linux/sched.h>

#include <asm/io.h>

#include <asm/byteorder.h>

#include <linux/errno.h>

#include <linux/slab.h>

#include <linux/delay.h>

#include <linux/interrupt.h>

#include <linux/mtd/map.h>

#include <linux/mtd/cfi.h>

#include <linux/mtd/compatmac.h>

static int cfi_staa_read(struct mtd_info *, loff_t, size_t, size_t *, u_char *);

static int cfi_staa_write_buffers(struct mtd_info *, loff_t, size_t, size_t *, const u_char *);

static int cfi_staa_writev(struct mtd_info *mtd, const struct iovec *vecs,

                unsigned long count, loff_t to, size_t *retlen);

static int cfi_staa_erase_varsize(struct mtd_info *, struct erase_info *);

static void cfi_staa_sync (struct mtd_info *);

static int cfi_staa_lock(struct mtd_info *mtd, loff_t ofs, size_t len);

static int cfi_staa_unlock(struct mtd_info *mtd, loff_t ofs, size_t len);

static int cfi_staa_suspend (struct mtd_info *);

static void cfi_staa_resume (struct mtd_info *);

static void cfi_staa_destroy(struct mtd_info *);

struct mtd_info *cfi_cmdset_0020(struct map_info *, int);

static struct mtd_info *cfi_staa_setup (struct map_info *);

static struct mtd_chip_driver cfi_staa_chipdrv = {

        probe: NULL, /* Not usable directly */

        destroy: cfi_staa_destroy,

        name: "cfi_cmdset_0020",

        module: THIS_MODULE

};

/* #define DEBUG_LOCK_BITS */

//#define DEBUG_CFI_FEATURES

#ifdef DEBUG_CFI_FEATURES

static void cfi_tell_features(struct cfi_pri_intelext *extp)

{

        int i;

        printk("  Feature/Command Support: %4.4X\n", extp->FeatureSupport);

        printk("     - Chip Erase:         %s\n", extp->FeatureSupport&1?"supported":"unsupported");

        printk("     - Suspend Erase:      %s\n", extp->FeatureSupport&2?"supported":"unsupported");

        printk("     - Suspend Program:    %s\n", extp->FeatureSupport&4?"supported":"unsupported");

        printk("     - Legacy Lock/Unlock: %s\n", extp->FeatureSupport&8?"supported":"unsupported");

        printk("     - Queued Erase:       %s\n", extp->FeatureSupport&16?"supported":"unsupported");

        printk("     - Instant block lock: %s\n", extp->FeatureSupport&32?"supported":"unsupported");

        printk("     - Protection Bits:    %s\n", extp->FeatureSupport&64?"supported":"unsupported");

        printk("     - Page-mode read:     %s\n", extp->FeatureSupport&128?"supported":"unsupported");

        printk("     - Synchronous read:   %s\n", extp->FeatureSupport&256?"supported":"unsupported");

        for (i=9; i<32; i++) {

                if (extp->FeatureSupport & (1<<i))

                        printk("     - Unknown Bit %X:      supported\n", i);

        }

        printk("  Supported functions after Suspend: %2.2X\n", extp->SuspendCmdSupport);

        printk("     - Program after Erase Suspend: %s\n", extp->SuspendCmdSupport&1?"supported":"unsupported");

        for (i=1; i<8; i++) {

                if (extp->SuspendCmdSupport & (1<<i))

                        printk("     - Unknown Bit %X:               supported\n", i);

        }

        printk("  Block Status Register Mask: %4.4X\n", extp->BlkStatusRegMask);

        printk("     - Lock Bit Active:      %s\n", extp->BlkStatusRegMask&1?"yes":"no");

        printk("     - Valid Bit Active:     %s\n", extp->BlkStatusRegMask&2?"yes":"no");

        for (i=2; i<16; i++) {

                if (extp->BlkStatusRegMask & (1<<i))

                        printk("     - Unknown Bit %X Active: yes\n",i);

        }

        printk("  Vcc Logic Supply Optimum Program/Erase Voltage: %d.%d V\n",

               extp->VccOptimal >> 8, extp->VccOptimal & 0xf);

        if (extp->VppOptimal)

                printk("  Vpp Programming Supply Optimum Program/Erase Voltage: %d.%d V\n",

                       extp->VppOptimal >> 8, extp->VppOptimal & 0xf);

}

#endif

/* This routine is made available to other mtd code via

 * inter_module_register.  It must only be accessed through

 * inter_module_get which will bump the use count of this module.  The

 * addresses passed back in cfi are valid as long as the use count of

 * this module is non-zero, i.e. between inter_module_get and

 * inter_module_put.  Keith Owens <kaos@ocs.com.au> 29 Oct 2000.

 */

struct mtd_info *cfi_cmdset_0020(struct map_info *map, int primary)

{

        struct cfi_private *cfi = map->fldrv_priv;

        int i;

        __u32 base = cfi->chips[0].start;

        if (cfi->cfi_mode) {

                /*

                 * It's a real CFI chip, not one for which the probe

                 * routine faked a CFI structure. So we read the feature

                 * table from it.

                 */

                __u16 adr = primary?cfi->cfiq->P_ADR:cfi->cfiq->A_ADR;

                struct cfi_pri_intelext *extp;

                int ofs_factor = cfi->interleave * cfi->device_type;

                printk(" ST Microelectronics Extended Query Table at 0x%4.4X\n", adr);

                if (!adr)

                        return NULL;

                /* Switch it into Query Mode */

                cfi_send_gen_cmd(0x98, 0x55, base, map, cfi, cfi->device_type, NULL);

                extp = kmalloc(sizeof(*extp), GFP_KERNEL);

                if (!extp) {

                        printk(KERN_ERR "Failed to allocate memory\n");

                        return NULL;

                }

                /* Read in the Extended Query Table */

                for (i=0; i<sizeof(*extp); i++) {

                        ((unsigned char *)extp)[i] =

                                cfi_read_query(map, (base+((adr+i)*ofs_factor)));

                }

                if (extp->MajorVersion != '1' ||

                    (extp->MinorVersion < '0' || extp->MinorVersion > '2')) {

                    printk(KERN_WARNING "  Unknown staa Extended Query "

                           "version %c.%c.\n",  extp->MajorVersion,

                           extp->MinorVersion);

                    kfree(extp);

                    return NULL;

                }

                /* Do some byteswapping if necessary */

                extp->FeatureSupport = cfi32_to_cpu(extp->FeatureSupport);

                extp->BlkStatusRegMask = cfi32_to_cpu(extp->BlkStatusRegMask);

#ifdef DEBUG_CFI_FEATURES

                /* Tell the user about it in lots of lovely detail */

                cfi_tell_features(extp);

#endif  

                /* Install our own private info structure */

                cfi->cmdset_priv = extp;

        }

        for (i=0; i< cfi->numchips; i++) {

                cfi->chips[i].word_write_time = 128;

                cfi->chips[i].buffer_write_time = 128;

                cfi->chips[i].erase_time = 1024;

        }

        map->fldrv = &cfi_staa_chipdrv;

        MOD_INC_USE_COUNT;

        /* Make sure it's in read mode */

        cfi_send_gen_cmd(0xff, 0x55, base, map, cfi, cfi->device_type, NULL);

        return cfi_staa_setup(map);

}

static struct mtd_info *cfi_staa_setup(struct map_info *map)

{

        struct cfi_private *cfi = map->fldrv_priv;

        struct mtd_info *mtd;

        unsigned long offset = 0;

        int i,j;

        unsigned long devsize = (1<<cfi->cfiq->DevSize) * cfi->interleave;

        mtd = kmalloc(sizeof(*mtd), GFP_KERNEL);

        //printk(KERN_DEBUG "number of CFI chips: %d\n", cfi->numchips);

        if (!mtd) {

                printk(KERN_ERR "Failed to allocate memory for MTD device\n");

                kfree(cfi->cmdset_priv);

                return NULL;

        }

        memset(mtd, 0, sizeof(*mtd));

        mtd->priv = map;

        mtd->type = MTD_NORFLASH;

        mtd->size = devsize * cfi->numchips;

        mtd->numeraseregions = cfi->cfiq->NumEraseRegions * cfi->numchips;

        mtd->eraseregions = kmalloc(sizeof(struct mtd_erase_region_info)

                        * mtd->numeraseregions, GFP_KERNEL);

        if (!mtd->eraseregions) {

                printk(KERN_ERR "Failed to allocate memory for MTD erase region info\n");

                kfree(cfi->cmdset_priv);

                return NULL;

        }

        for (i=0; i<cfi->cfiq->NumEraseRegions; i++) {

                unsigned long ernum, ersize;

                ersize = ((cfi->cfiq->EraseRegionInfo[i] >> 8) & ~0xff) * cfi->interleave;

                ernum = (cfi->cfiq->EraseRegionInfo[i] & 0xffff) + 1;

                if (mtd->erasesize < ersize) {

                        mtd->erasesize = ersize;

                }

                for (j=0; j<cfi->numchips; j++) {

                        mtd->eraseregions[(j*cfi->cfiq->NumEraseRegions)+i].offset = (j*devsize)+offset;

                        mtd->eraseregions[(j*cfi->cfiq->NumEraseRegions)+i].erasesize = ersize;

                        mtd->eraseregions[(j*cfi->cfiq->NumEraseRegions)+i].numblocks = ernum;

                }

                offset += (ersize * ernum);

                }

                if (offset != devsize) {

                        /* Argh */

                        printk(KERN_WARNING "Sum of regions (%lx) != total size of set of interleaved chips (%lx)\n", offset, devsize);

                        kfree(mtd->eraseregions);

                        kfree(cfi->cmdset_priv);

                        return NULL;

                }

                for (i=0; i<mtd->numeraseregions;i++){

                        printk(KERN_DEBUG "%d: offset=0x%x,size=0x%x,blocks=%d\n",

                               i,mtd->eraseregions[i].offset,

                               mtd->eraseregions[i].erasesize,

                               mtd->eraseregions[i].numblocks);

                }

        /* Also select the correct geometry setup too */

        mtd->erase = cfi_staa_erase_varsize;

        mtd->read = cfi_staa_read;

        mtd->write = cfi_staa_write_buffers;

        mtd->writev = cfi_staa_writev;

        mtd->sync = cfi_staa_sync;

        mtd->lock = cfi_staa_lock;

        mtd->unlock = cfi_staa_unlock;

        mtd->suspend = cfi_staa_suspend;

        mtd->resume = cfi_staa_resume;

        mtd->flags = MTD_CAP_NORFLASH;

        mtd->flags |= MTD_ECC; /* FIXME: Not all STMicro flashes have this */

        mtd->eccsize = 8; /* FIXME: Should be 0 for STMicro flashes w/out ECC */

        map->fldrv = &cfi_staa_chipdrv;

        MOD_INC_USE_COUNT;

        mtd->name = map->name;

        return mtd;

}

static inline int do_read_onechip(struct map_info *map, struct flchip *chip, loff_t adr, size_t len, u_char *buf)

{

        __u32 status, status_OK;

        unsigned long timeo;

        DECLARE_WAITQUEUE(wait, current);

        int suspended = 0;

        unsigned long cmd_addr;

        struct cfi_private *cfi = map->fldrv_priv;

        adr += chip->start;

        /* Ensure cmd read/writes are aligned. */

        cmd_addr = adr & ~(CFIDEV_BUSWIDTH-1);

        /* Let's determine this according to the interleave only once */

        status_OK = CMD(0x80);

        timeo = jiffies + HZ;

 retry:

        spin_lock_bh(chip->mutex);

        /* Check that the chip's ready to talk to us.

         * If it's in FL_ERASING state, suspend it and make it talk now.

         */

        switch (chip->state) {

        case FL_ERASING:

                if (!((struct cfi_pri_intelext *)cfi->cmdset_priv)->FeatureSupport & 2)

                        goto sleep; /* We don't support erase suspend */

                cfi_write (map, CMD(0xb0), cmd_addr);

                /* If the flash has finished erasing, then 'erase suspend'

                 * appears to make some (28F320) flash devices switch to

                 * 'read' mode.  Make sure that we switch to 'read status'

                 * mode so we get the right data. --rmk

                 */

                cfi_write(map, CMD(0x70), cmd_addr);

                chip->oldstate = FL_ERASING;

                chip->state = FL_ERASE_SUSPENDING;

                //              printk("Erase suspending at 0x%lx\n", cmd_addr);

                for (;;) {

                        status = cfi_read(map, cmd_addr);

                        if ((status & status_OK) == status_OK)

                                break;

                        if (time_after(jiffies, timeo)) {

                                /* Urgh */

                                cfi_write(map, CMD(0xd0), cmd_addr);

                                /* make sure we're in 'read status' mode */

                                cfi_write(map, CMD(0x70), cmd_addr);

                                chip->state = FL_ERASING;

                                spin_unlock_bh(chip->mutex);

                                printk(KERN_ERR "Chip not ready after erase "

                                       "suspended: status = 0x%x\n", status);

                                return -EIO;

                        }

                        spin_unlock_bh(chip->mutex);

                        cfi_udelay(1);

                        spin_lock_bh(chip->mutex);

                }

                suspended = 1;

                cfi_write(map, CMD(0xff), cmd_addr);

                chip->state = FL_READY;

                break;

#if 0

        case FL_WRITING:

                /* Not quite yet */

#endif

        case FL_READY:

                break;

        case FL_CFI_QUERY:

        case FL_JEDEC_QUERY:

                cfi_write(map, CMD(0x70), cmd_addr);

                chip->state = FL_STATUS;

        case FL_STATUS:

                status = cfi_read(map, cmd_addr);

                if ((status & status_OK) == status_OK) {

                        cfi_write(map, CMD(0xff), cmd_addr);

                        chip->state = FL_READY;

                        break;

                }

                /* Urgh. Chip not yet ready to talk to us. */

                if (time_after(jiffies, timeo)) {

                        spin_unlock_bh(chip->mutex);

                        printk(KERN_ERR "waiting for chip to be ready timed out in read. WSM status = %x\n", status);

                        return -EIO;

                }

                /* Latency issues. Drop the lock, wait a while and retry */

                spin_unlock_bh(chip->mutex);

                cfi_udelay(1);

                goto retry;

        default:

        sleep:

                /* Stick ourselves on a wait queue to be woken when

                   someone changes the status */

                set_current_state(TASK_UNINTERRUPTIBLE);

                add_wait_queue(&chip->wq, &wait);

                spin_unlock_bh(chip->mutex);

                schedule();

                remove_wait_queue(&chip->wq, &wait);

                timeo = jiffies + HZ;

                goto retry;

        }

        map->copy_from(map, buf, adr, len);

        if (suspended) {

                chip->state = chip->oldstate;

                /* What if one interleaved chip has finished and the

                   other hasn't? The old code would leave the finished

                   one in READY mode. That's bad, and caused -EROFS

                   errors to be returned from do_erase_oneblock because

                   that's the only bit it checked for at the time.

                   As the state machine appears to explicitly allow

                   sending the 0x70 (Read Status) command to an erasing

                   chip and expecting it to be ignored, that's what we

                   do. */

                cfi_write(map, CMD(0xd0), cmd_addr);

                cfi_write(map, CMD(0x70), cmd_addr);

        }

        wake_up(&chip->wq);

        spin_unlock_bh(chip->mutex);

        return 0;

}

static int cfi_staa_read (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf)

{

        struct map_info *map = mtd->priv;

        struct cfi_private *cfi = map->fldrv_priv;

        unsigned long ofs;

        int chipnum;

        int ret = 0;

        /* ofs: offset within the first chip that the first read should start */

        chipnum = (from >> cfi->chipshift);

        ofs = from - (chipnum <<  cfi->chipshift);

        *retlen = 0;

        while (len) {

                unsigned long thislen;

                if (chipnum >= cfi->numchips)

                        break;

                if ((len + ofs -1) >> cfi->chipshift)

                        thislen = (1<<cfi->chipshift) - ofs;

                else

                        thislen = len;

                ret = do_read_onechip(map, &cfi->chips[chipnum], ofs, thislen, buf);

                if (ret)

                        break;

                *retlen += thislen;

                len -= thislen;

                buf += thislen;

                ofs = 0;

                chipnum++;

        }

        return ret;

}

static inline int do_write_buffer(struct map_info *map, struct flchip *chip,

                                  unsigned long adr, const u_char *buf, int len)

{

        struct cfi_private *cfi = map->fldrv_priv;

        __u32 status, status_OK;

        unsigned long cmd_adr, timeo;

        DECLARE_WAITQUEUE(wait, current);

        int wbufsize, z;

        /* M58LW064A requires bus alignment for buffer wriets -- saw */

        if (adr & (CFIDEV_BUSWIDTH-1))

            return -EINVAL;

        wbufsize = CFIDEV_INTERLEAVE << cfi->cfiq->MaxBufWriteSize;

        adr += chip->start;

        cmd_adr = adr & ~(wbufsize-1);

        /* Let's determine this according to the interleave only once */

        status_OK = CMD(0x80);

        timeo = jiffies + HZ;

 retry:

#ifdef DEBUG_CFI_FEATURES

       printk("%s: chip->state[%d]\n", __FUNCTION__, chip->state);

#endif

        spin_lock_bh(chip->mutex);

        /* Check that the chip's ready to talk to us.

         * Later, we can actually think about interrupting it

         * if it's in FL_ERASING state.

         * Not just yet, though.

         */

        switch (chip->state) {

        case FL_READY:

                break;

        case FL_CFI_QUERY:

        case FL_JEDEC_QUERY:

                cfi_write(map, CMD(0x70), cmd_adr);

                chip->state = FL_STATUS;

#ifdef DEBUG_CFI_FEATURES

        printk("%s: 1 status[%x]\n", __FUNCTION__, cfi_read(map, cmd_adr));

#endif

        case FL_STATUS:

                status = cfi_read(map, cmd_adr);

                if ((status & status_OK) == status_OK)

                        break;

                /* Urgh. Chip not yet ready to talk to us. */

                if (time_after(jiffies, timeo)) {

                        spin_unlock_bh(chip->mutex);

                        printk(KERN_ERR "waiting for chip to be ready timed out in buffer write Xstatus = %x, status = %x\n",

                               status, cfi_read(map, cmd_adr));

                        return -EIO;

                }

                /* Latency issues. Drop the lock, wait a while and retry */

                spin_unlock_bh(chip->mutex);

                cfi_udelay(1);

                goto retry;

        default:

                /* Stick ourselves on a wait queue to be woken when

                   someone changes the status */

                set_current_state(TASK_UNINTERRUPTIBLE);

                add_wait_queue(&chip->wq, &wait);

                spin_unlock_bh(chip->mutex);

                schedule();

                remove_wait_queue(&chip->wq, &wait);

                timeo = jiffies + HZ;

                goto retry;

        }

        ENABLE_VPP(map);

        cfi_write(map, CMD(0xe8), cmd_adr);

        chip->state = FL_WRITING_TO_BUFFER;

        z = 0;

        for (;;) {

                status = cfi_read(map, cmd_adr);

                if ((status & status_OK) == status_OK)

                        break;

                spin_unlock_bh(chip->mutex);

                cfi_udelay(1);

                spin_lock_bh(chip->mutex);

                if (++z > 100) {

                        /* Argh. Not ready for write to buffer */

                        DISABLE_VPP(map);

                        cfi_write(map, CMD(0x70), cmd_adr);

                        chip->state = FL_STATUS;

                        spin_unlock_bh(chip->mutex);

                        printk(KERN_ERR "Chip not ready for buffer write. Xstatus = %x\n", status);

                        return -EIO;

                }

        }

        /* Write length of data to come */

        cfi_write(map, CMD(len/CFIDEV_BUSWIDTH-1), cmd_adr );

        /* Write data */

        for (z = 0; z < len; z += CFIDEV_BUSWIDTH) {

                if (cfi_buswidth_is_1()) {

                        map->write8 (map, *((__u8*)buf)++, adr+z);

                } else if (cfi_buswidth_is_2()) {

                        map->write16 (map, *((__u16*)buf)++, adr+z);

                } else if (cfi_buswidth_is_4()) {

                        map->write32 (map, *((__u32*)buf)++, adr+z);

                } else {

                        DISABLE_VPP(map);

                        return -EINVAL;

                }

        }

        /* GO GO GO */

        cfi_write(map, CMD(0xd0), cmd_adr);

        chip->state = FL_WRITING;

        spin_unlock_bh(chip->mutex);

        cfi_udelay(chip->buffer_write_time);

        spin_lock_bh(chip->mutex);

        timeo = jiffies + (HZ/2);

        z = 0;

        for (;;) {

                if (chip->state != FL_WRITING) {

                        /* Someone's suspended the write. Sleep */

                        set_current_state(TASK_UNINTERRUPTIBLE);

                        add_wait_queue(&chip->wq, &wait);

                        spin_unlock_bh(chip->mutex);

                        schedule();

                        remove_wait_queue(&chip->wq, &wait);

                        timeo = jiffies + (HZ / 2); /* FIXME */

                        spin_lock_bh(chip->mutex);

                        continue;

                }

                status = cfi_read(map, cmd_adr);

                if ((status & status_OK) == status_OK)

                        break;

                /* OK Still waiting */

                if (time_after(jiffies, timeo)) {

                        /* clear status */

                        cfi_write(map, CMD(0x50), cmd_adr);

                        /* put back into read status register mode */

                        cfi_write(map, CMD(0x70), adr);

                        chip->state = FL_STATUS;

                        DISABLE_VPP(map);

                        spin_unlock_bh(chip->mutex);

                        printk(KERN_ERR "waiting for chip to be ready timed out in bufwrite\n");

                        return -EIO;

                }

                /* Latency issues. Drop the lock, wait a while and retry */

                spin_unlock_bh(chip->mutex);

                cfi_udelay(1);

                z++;

                spin_lock_bh(chip->mutex);

        }

        if (!z) {

                chip->buffer_write_time--;

                if (!chip->buffer_write_time)

                        chip->buffer_write_time++;

        }

        if (z > 1)

                chip->buffer_write_time++;

        /* Done and happy. */

        DISABLE_VPP(map);

        chip->state = FL_STATUS;

        /* check for errors: 'lock bit', 'VPP', 'dead cell'/'unerased cell' or 'incorrect cmd' -- saw */

        if ((status & CMD(0x02)) || (status & CMD(0x08)) ||

            (status & CMD(0x10)) || (status & CMD(0x20))) {

#ifdef DEBUG_CFI_FEATURES

            printk("%s: 2 status[%x]\n", __FUNCTION__, status);

#endif

            /* clear status */

            cfi_write(map, CMD(0x50), cmd_adr);

            /* put back into read status register mode */

            cfi_write(map, CMD(0x70), adr);

            wake_up(&chip->wq);

            spin_unlock_bh(chip->mutex);

            return (status & CMD(0x02)) ? -EROFS : -EIO;

        }

        wake_up(&chip->wq);

        spin_unlock_bh(chip->mutex);