sm_common.c

Go to the documentation of this file.

/*
 * Copyright © 2009 - Maxim Levitsky
 * Common routines & support for xD format
 *
 * 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.
 */
#include <linux/kernel.h>
#include <linux/mtd/nand.h>
#include <linux/module.h>
#include "sm_common.h"

static struct nand_ecclayout nand_oob_sm = {
    .eccbytes = 6,
    .eccpos = {8, 9, 10, 13, 14, 15},
    .oobfree = {
        {.offset = 0 , .length = 4}, /* reserved */
        {.offset = 6 , .length = 2}, /* LBA1 */
        {.offset = 11, .length = 2}  /* LBA2 */
    }
};

/* NOTE: This layout is is not compatabable with SmartMedia, */
/* because the 256 byte devices have page depenent oob layout */
/* However it does preserve the bad block markers */
/* If you use smftl, it will bypass this and work correctly */
/* If you not, then you break SmartMedia compliance anyway */

static struct nand_ecclayout nand_oob_sm_small = {
    .eccbytes = 3,
    .eccpos = {0, 1, 2},
    .oobfree = {
        {.offset = 3 , .length = 2}, /* reserved */
        {.offset = 6 , .length = 2}, /* LBA1 */
    }
};


static int sm_block_markbad(struct mtd_info *mtd, loff_t ofs)
{
    struct mtd_oob_ops ops;
    struct sm_oob oob;
    int ret, error = 0;

    memset(&oob, -1, SM_OOB_SIZE);
    oob.block_status = 0x0F;

    /* As long as this function is called on erase block boundaries
        it will work correctly for 256 byte nand */
    ops.mode = MTD_OPS_PLACE_OOB;
    ops.ooboffs = 0;
    ops.ooblen = mtd->oobsize;
    ops.oobbuf = (void *)&oob;
    ops.datbuf = NULL;


    ret = mtd_write_oob(mtd, ofs, &ops);
    if (ret < 0 || ops.oobretlen != SM_OOB_SIZE) {
        printk(KERN_NOTICE
            "sm_common: can't mark sector at %i as bad\n",
                                (int)ofs);
        error = -EIO;
    } else
        mtd->ecc_stats.badblocks++;

    return error;
}


static struct nand_flash_dev nand_smartmedia_flash_ids[] = {
    {"SmartMedia 1MiB 5V",          0x6e, 256, 1, 0x1000, 0},
    {"SmartMedia 1MiB 3,3V",        0xe8, 256, 1, 0x1000, 0},
    {"SmartMedia 1MiB 3,3V",        0xec, 256, 1, 0x1000, 0},
    {"SmartMedia 2MiB 3,3V",        0xea, 256, 2, 0x1000, 0},
    {"SmartMedia 2MiB 5V",          0x64, 256, 2, 0x1000, 0},
    {"SmartMedia 2MiB 3,3V ROM",    0x5d, 512, 2, 0x2000, NAND_ROM},
    {"SmartMedia 4MiB 3,3V",        0xe3, 512, 4, 0x2000, 0},
    {"SmartMedia 4MiB 3,3/5V",      0xe5, 512, 4, 0x2000, 0},
    {"SmartMedia 4MiB 5V",          0x6b, 512, 4, 0x2000, 0},
    {"SmartMedia 4MiB 3,3V ROM",    0xd5, 512, 4, 0x2000, NAND_ROM},
    {"SmartMedia 8MiB 3,3V",        0xe6, 512, 8, 0x2000, 0},
    {"SmartMedia 8MiB 3,3V ROM",    0xd6, 512, 8, 0x2000, NAND_ROM},
    {"SmartMedia 16MiB 3,3V",       0x73, 512, 16, 0x4000, 0},
    {"SmartMedia 16MiB 3,3V ROM",   0x57, 512, 16, 0x4000, NAND_ROM},
    {"SmartMedia 32MiB 3,3V",       0x75, 512, 32, 0x4000, 0},
    {"SmartMedia 32MiB 3,3V ROM",   0x58, 512, 32, 0x4000, NAND_ROM},
    {"SmartMedia 64MiB 3,3V",       0x76, 512, 64, 0x4000, 0},
    {"SmartMedia 64MiB 3,3V ROM",   0xd9, 512, 64, 0x4000, NAND_ROM},
    {"SmartMedia 128MiB 3,3V",      0x79, 512, 128, 0x4000, 0},
    {"SmartMedia 128MiB 3,3V ROM",  0xda, 512, 128, 0x4000, NAND_ROM},
    {"SmartMedia 256MiB 3,3V",      0x71, 512, 256, 0x4000 },
    {"SmartMedia 256MiB 3,3V ROM",  0x5b, 512, 256, 0x4000, NAND_ROM},
    {NULL,}
};

static struct nand_flash_dev nand_xd_flash_ids[] = {

    {"xD 16MiB 3,3V",    0x73, 512, 16, 0x4000, 0},
    {"xD 32MiB 3,3V",    0x75, 512, 32, 0x4000, 0},
    {"xD 64MiB 3,3V",    0x76, 512, 64, 0x4000, 0},
    {"xD 128MiB 3,3V",   0x79, 512, 128, 0x4000, 0},
    {"xD 256MiB 3,3V",   0x71, 512, 256, 0x4000, NAND_BROKEN_XD},
    {"xD 512MiB 3,3V",   0xdc, 512, 512, 0x4000, NAND_BROKEN_XD},
    {"xD 1GiB 3,3V",     0xd3, 512, 1024, 0x4000, NAND_BROKEN_XD},
    {"xD 2GiB 3,3V",     0xd5, 512, 2048, 0x4000, NAND_BROKEN_XD},
    {NULL,}
};

int sm_register_device(struct mtd_info *mtd, int smartmedia)
{
    struct nand_chip *chip = mtd->priv;
    int ret;

    chip->options |= NAND_SKIP_BBTSCAN;

    /* Scan for card properties */
    ret = nand_scan_ident(mtd, 1, smartmedia ?
        nand_smartmedia_flash_ids : nand_xd_flash_ids);

    if (ret)
        return ret;

    /* Bad block marker position */
    chip->badblockpos = 0x05;
    chip->badblockbits = 7;
    chip->block_markbad = sm_block_markbad;

    /* ECC layout */
    if (mtd->writesize == SM_SECTOR_SIZE)
        chip->ecc.layout = &nand_oob_sm;
    else if (mtd->writesize == SM_SMALL_PAGE)
        chip->ecc.layout = &nand_oob_sm_small;
    else
        return -ENODEV;

    ret = nand_scan_tail(mtd);

    if (ret)
        return ret;

    return mtd_device_register(mtd, NULL, 0);
}
EXPORT_SYMBOL_GPL(sm_register_device);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Maxim Levitsky <[email protected]>");
MODULE_DESCRIPTION("Common SmartMedia/xD functions");