[linux-2.6-block.git] / drivers / mtd / nand / sm_common.c

/*
 * 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 <linux/sizes.h>
#include "sm_common.h"

static int oob_sm_ooblayout_ecc(struct mtd_info *mtd, int section,
				struct mtd_oob_region *oobregion)
{
	if (section > 1)
		return -ERANGE;

	oobregion->length = 3;
	oobregion->offset = ((section + 1) * 8) - 3;

	return 0;
}

static int oob_sm_ooblayout_free(struct mtd_info *mtd, int section,
				 struct mtd_oob_region *oobregion)
{
	switch (section) {
	case 0:
		/* reserved */
		oobregion->offset = 0;
		oobregion->length = 4;
		break;
	case 1:
		/* LBA1 */
		oobregion->offset = 6;
		oobregion->length = 2;
		break;
	case 2:
		/* LBA2 */
		oobregion->offset = 11;
		oobregion->length = 2;
		break;
	default:
		return -ERANGE;
	}

	return 0;
}

static const struct mtd_ooblayout_ops oob_sm_ops = {
	.ecc = oob_sm_ooblayout_ecc,
	.free = oob_sm_ooblayout_free,
};

/* 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 int oob_sm_small_ooblayout_ecc(struct mtd_info *mtd, int section,
				      struct mtd_oob_region *oobregion)
{
	if (section)
		return -ERANGE;

	oobregion->length = 3;
	oobregion->offset = 0;

	return 0;
}

static int oob_sm_small_ooblayout_free(struct mtd_info *mtd, int section,
				       struct mtd_oob_region *oobregion)
{
	switch (section) {
	case 0:
		/* reserved */
		oobregion->offset = 3;
		oobregion->length = 2;
		break;
	case 1:
		/* LBA1 */
		oobregion->offset = 6;
		oobregion->length = 2;
		break;
	default:
		return -ERANGE;
	}

	return 0;
}

static const struct mtd_ooblayout_ops oob_sm_small_ops = {
	.ecc = oob_sm_small_ooblayout_ecc,
	.free = oob_sm_small_ooblayout_free,
};

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

	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);
		return -EIO;
	}

	return 0;
}

static struct nand_flash_dev nand_smartmedia_flash_ids[] = {
	LEGACY_ID_NAND("SmartMedia 2MiB 3,3V ROM",   0x5d, 2,   SZ_8K, NAND_ROM),
	LEGACY_ID_NAND("SmartMedia 4MiB 3,3V",       0xe3, 4,   SZ_8K, 0),
	LEGACY_ID_NAND("SmartMedia 4MiB 3,3/5V",     0xe5, 4,   SZ_8K, 0),
	LEGACY_ID_NAND("SmartMedia 4MiB 5V",         0x6b, 4,   SZ_8K, 0),
	LEGACY_ID_NAND("SmartMedia 4MiB 3,3V ROM",   0xd5, 4,   SZ_8K, NAND_ROM),
	LEGACY_ID_NAND("SmartMedia 8MiB 3,3V",       0xe6, 8,   SZ_8K, 0),
	LEGACY_ID_NAND("SmartMedia 8MiB 3,3V ROM",   0xd6, 8,   SZ_8K, NAND_ROM),
	LEGACY_ID_NAND("SmartMedia 16MiB 3,3V",      0x73, 16,  SZ_16K, 0),
	LEGACY_ID_NAND("SmartMedia 16MiB 3,3V ROM",  0x57, 16,  SZ_16K, NAND_ROM),
	LEGACY_ID_NAND("SmartMedia 32MiB 3,3V",      0x75, 32,  SZ_16K, 0),
	LEGACY_ID_NAND("SmartMedia 32MiB 3,3V ROM",  0x58, 32,  SZ_16K, NAND_ROM),
	LEGACY_ID_NAND("SmartMedia 64MiB 3,3V",      0x76, 64,  SZ_16K, 0),
	LEGACY_ID_NAND("SmartMedia 64MiB 3,3V ROM",  0xd9, 64,  SZ_16K, NAND_ROM),
	LEGACY_ID_NAND("SmartMedia 128MiB 3,3V",     0x79, 128, SZ_16K, 0),
	LEGACY_ID_NAND("SmartMedia 128MiB 3,3V ROM", 0xda, 128, SZ_16K, NAND_ROM),
	LEGACY_ID_NAND("SmartMedia 256MiB 3, 3V",    0x71, 256, SZ_16K, 0),
	LEGACY_ID_NAND("SmartMedia 256MiB 3,3V ROM", 0x5b, 256, SZ_16K, NAND_ROM),
	{NULL}
};

static struct nand_flash_dev nand_xd_flash_ids[] = {
	LEGACY_ID_NAND("xD 16MiB 3,3V",  0x73, 16,   SZ_16K, 0),
	LEGACY_ID_NAND("xD 32MiB 3,3V",  0x75, 32,   SZ_16K, 0),
	LEGACY_ID_NAND("xD 64MiB 3,3V",  0x76, 64,   SZ_16K, 0),
	LEGACY_ID_NAND("xD 128MiB 3,3V", 0x79, 128,  SZ_16K, 0),
	LEGACY_ID_NAND("xD 256MiB 3,3V", 0x71, 256,  SZ_16K, NAND_BROKEN_XD),
	LEGACY_ID_NAND("xD 512MiB 3,3V", 0xdc, 512,  SZ_16K, NAND_BROKEN_XD),
	LEGACY_ID_NAND("xD 1GiB 3,3V",   0xd3, 1024, SZ_16K, NAND_BROKEN_XD),
	LEGACY_ID_NAND("xD 2GiB 3,3V",   0xd5, 2048, SZ_16K, NAND_BROKEN_XD),
	{NULL}
};

int sm_register_device(struct mtd_info *mtd, int smartmedia)
{
	struct nand_chip *chip = mtd_to_nand(mtd);
	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)
		mtd_set_ooblayout(mtd, &oob_sm_ops);
	else if (mtd->writesize == SM_SMALL_PAGE)
		mtd_set_ooblayout(mtd, &oob_sm_small_ops);
	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 <maximlevitsky@gmail.com>");
MODULE_DESCRIPTION("Common SmartMedia/xD functions");
Commit	Line	Data
9fc51a37 ML	1	/*
	2	* Copyright © 2009 - Maxim Levitsky
	3	* Common routines & support for xD format
	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License version 2 as
	7	* published by the Free Software Foundation.
	8	*/
	9	#include <linux/kernel.h>
	10	#include <linux/mtd/nand.h>
a0e5cc58	11	#include <linux/module.h>
0c4a235c	12	#include <linux/sizes.h>
9fc51a37 ML	13	#include "sm_common.h"
9fc51a37 ML	14
987b913c BB	15	static int oob_sm_ooblayout_ecc(struct mtd_info *mtd, int section,
	16	struct mtd_oob_region *oobregion)
	17	{
	18	if (section > 1)
	19	return -ERANGE;
	20
	21	oobregion->length = 3;
	22	oobregion->offset = ((section + 1) * 8) - 3;
	23
	24	return 0;
	25	}
	26
	27	static int oob_sm_ooblayout_free(struct mtd_info *mtd, int section,
	28	struct mtd_oob_region *oobregion)
	29	{
	30	switch (section) {
	31	case 0:
	32	/* reserved */
	33	oobregion->offset = 0;
	34	oobregion->length = 4;
	35	break;
	36	case 1:
	37	/* LBA1 */
	38	oobregion->offset = 6;
	39	oobregion->length = 2;
	40	break;
	41	case 2:
	42	/* LBA2 */
	43	oobregion->offset = 11;
	44	oobregion->length = 2;
	45	break;
	46	default:
	47	return -ERANGE;
9fc51a37	48	}
987b913c BB	49
	50	return 0;
	51	}
	52
	53	static const struct mtd_ooblayout_ops oob_sm_ops = {
	54	.ecc = oob_sm_ooblayout_ecc,
	55	.free = oob_sm_ooblayout_free,
9fc51a37 ML	56	};
	57
	58	/* NOTE: This layout is is not compatabable with SmartMedia, */
	59	/* because the 256 byte devices have page depenent oob layout */
	60	/* However it does preserve the bad block markers */
	61	/* If you use smftl, it will bypass this and work correctly */
	62	/* If you not, then you break SmartMedia compliance anyway */
	63
987b913c BB	64	static int oob_sm_small_ooblayout_ecc(struct mtd_info *mtd, int section,
	65	struct mtd_oob_region *oobregion)
	66	{
	67	if (section)
	68	return -ERANGE;
	69
	70	oobregion->length = 3;
	71	oobregion->offset = 0;
	72
	73	return 0;
	74	}
	75
	76	static int oob_sm_small_ooblayout_free(struct mtd_info *mtd, int section,
	77	struct mtd_oob_region *oobregion)
	78	{
	79	switch (section) {
	80	case 0:
	81	/* reserved */
	82	oobregion->offset = 3;
	83	oobregion->length = 2;
	84	break;
	85	case 1:
	86	/* LBA1 */
	87	oobregion->offset = 6;
	88	oobregion->length = 2;
	89	break;
	90	default:
	91	return -ERANGE;
9fc51a37	92	}
9fc51a37	93
987b913c BB	94	return 0;
	95	}
	96
	97	static const struct mtd_ooblayout_ops oob_sm_small_ops = {
	98	.ecc = oob_sm_small_ooblayout_ecc,
	99	.free = oob_sm_small_ooblayout_free,
	100	};
9fc51a37 ML	101
	102	static int sm_block_markbad(struct mtd_info *mtd, loff_t ofs)
	103	{
	104	struct mtd_oob_ops ops;
	105	struct sm_oob oob;
5a0edb25	106	int ret;
9fc51a37 ML	107
	108	memset(&oob, -1, SM_OOB_SIZE);
	109	oob.block_status = 0x0F;
	110
	111	/* As long as this function is called on erase block boundaries
	112	it will work correctly for 256 byte nand */
0612b9dd	113	ops.mode = MTD_OPS_PLACE_OOB;
9fc51a37 ML	114	ops.ooboffs = 0;
	115	ops.ooblen = mtd->oobsize;
	116	ops.oobbuf = (void *)&oob;
	117	ops.datbuf = NULL;
	118
	119
a2cc5ba0	120	ret = mtd_write_oob(mtd, ofs, &ops);
9fc51a37 ML	121	if (ret < 0 \|\| ops.oobretlen != SM_OOB_SIZE) {
	122	printk(KERN_NOTICE
	123	"sm_common: can't mark sector at %i as bad\n",
	124	(int)ofs);
5a0edb25 BN	125	return -EIO;
5a0edb25 BN	126	}
9fc51a37	127
5a0edb25	128	return 0;
9fc51a37 ML	129	}
9fc51a37 ML	130
2764fb42	131	static struct nand_flash_dev nand_smartmedia_flash_ids[] = {
0c4a235c AB	132	LEGACY_ID_NAND("SmartMedia 2MiB 3,3V ROM", 0x5d, 2, SZ_8K, NAND_ROM),
	133	LEGACY_ID_NAND("SmartMedia 4MiB 3,3V", 0xe3, 4, SZ_8K, 0),
	134	LEGACY_ID_NAND("SmartMedia 4MiB 3,3/5V", 0xe5, 4, SZ_8K, 0),
	135	LEGACY_ID_NAND("SmartMedia 4MiB 5V", 0x6b, 4, SZ_8K, 0),
	136	LEGACY_ID_NAND("SmartMedia 4MiB 3,3V ROM", 0xd5, 4, SZ_8K, NAND_ROM),
	137	LEGACY_ID_NAND("SmartMedia 8MiB 3,3V", 0xe6, 8, SZ_8K, 0),
	138	LEGACY_ID_NAND("SmartMedia 8MiB 3,3V ROM", 0xd6, 8, SZ_8K, NAND_ROM),
	139	LEGACY_ID_NAND("SmartMedia 16MiB 3,3V", 0x73, 16, SZ_16K, 0),
	140	LEGACY_ID_NAND("SmartMedia 16MiB 3,3V ROM", 0x57, 16, SZ_16K, NAND_ROM),
	141	LEGACY_ID_NAND("SmartMedia 32MiB 3,3V", 0x75, 32, SZ_16K, 0),
	142	LEGACY_ID_NAND("SmartMedia 32MiB 3,3V ROM", 0x58, 32, SZ_16K, NAND_ROM),
	143	LEGACY_ID_NAND("SmartMedia 64MiB 3,3V", 0x76, 64, SZ_16K, 0),
	144	LEGACY_ID_NAND("SmartMedia 64MiB 3,3V ROM", 0xd9, 64, SZ_16K, NAND_ROM),
	145	LEGACY_ID_NAND("SmartMedia 128MiB 3,3V", 0x79, 128, SZ_16K, 0),
	146	LEGACY_ID_NAND("SmartMedia 128MiB 3,3V ROM", 0xda, 128, SZ_16K, NAND_ROM),
	147	LEGACY_ID_NAND("SmartMedia 256MiB 3, 3V", 0x71, 256, SZ_16K, 0),
	148	LEGACY_ID_NAND("SmartMedia 256MiB 3,3V ROM", 0x5b, 256, SZ_16K, NAND_ROM),
8dbfae1e	149	{NULL}
c3611570	150	};
2764fb42	151
c3611570	152	static struct nand_flash_dev nand_xd_flash_ids[] = {
0c4a235c AB	153	LEGACY_ID_NAND("xD 16MiB 3,3V", 0x73, 16, SZ_16K, 0),
	154	LEGACY_ID_NAND("xD 32MiB 3,3V", 0x75, 32, SZ_16K, 0),
	155	LEGACY_ID_NAND("xD 64MiB 3,3V", 0x76, 64, SZ_16K, 0),
	156	LEGACY_ID_NAND("xD 128MiB 3,3V", 0x79, 128, SZ_16K, 0),
	157	LEGACY_ID_NAND("xD 256MiB 3,3V", 0x71, 256, SZ_16K, NAND_BROKEN_XD),
	158	LEGACY_ID_NAND("xD 512MiB 3,3V", 0xdc, 512, SZ_16K, NAND_BROKEN_XD),
	159	LEGACY_ID_NAND("xD 1GiB 3,3V", 0xd3, 1024, SZ_16K, NAND_BROKEN_XD),
	160	LEGACY_ID_NAND("xD 2GiB 3,3V", 0xd5, 2048, SZ_16K, NAND_BROKEN_XD),
8dbfae1e	161	{NULL}
2764fb42 DW	162	};
2764fb42 DW	163
c3611570	164	int sm_register_device(struct mtd_info *mtd, int smartmedia)
9fc51a37	165	{
4bd4ebcc	166	struct nand_chip *chip = mtd_to_nand(mtd);
9fc51a37 ML	167	int ret;
9fc51a37 ML	168
2764fb42	169	chip->options \|= NAND_SKIP_BBTSCAN;
9fc51a37 ML	170
9fc51a37 ML	171	/* Scan for card properties */
c3611570 ML	172	ret = nand_scan_ident(mtd, 1, smartmedia ?
c3611570 ML	173	nand_smartmedia_flash_ids : nand_xd_flash_ids);
9fc51a37 ML	174
	175	if (ret)
	176	return ret;
	177
25985edc	178	/* Bad block marker position */
9fc51a37 ML	179	chip->badblockpos = 0x05;
	180	chip->badblockbits = 7;
	181	chip->block_markbad = sm_block_markbad;
	182
	183	/* ECC layout */
	184	if (mtd->writesize == SM_SECTOR_SIZE)
987b913c	185	mtd_set_ooblayout(mtd, &oob_sm_ops);
9fc51a37	186	else if (mtd->writesize == SM_SMALL_PAGE)
987b913c	187	mtd_set_ooblayout(mtd, &oob_sm_small_ops);
9fc51a37 ML	188	else
	189	return -ENODEV;
	190
	191	ret = nand_scan_tail(mtd);
	192
	193	if (ret)
	194	return ret;
	195
ee0e87b1	196	return mtd_device_register(mtd, NULL, 0);
9fc51a37 ML	197	}
	198	EXPORT_SYMBOL_GPL(sm_register_device);
	199
	200	MODULE_LICENSE("GPL");
	201	MODULE_AUTHOR("Maxim Levitsky <maximlevitsky@gmail.com>");
	202	MODULE_DESCRIPTION("Common SmartMedia/xD functions");