bbm.h revision 30fe8115b55223cb84530ce04c4a20ba9d6dcf0b
187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* 287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * linux/include/linux/mtd/bbm.h 387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * 487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * NAND family Bad Block Management (BBM) header file 587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * - Bad Block Table (BBT) implementation 687590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * 787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * Copyright (c) 2005 Samsung Electronics 887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * Kyungmin Park <kyungmin.park@samsung.com> 987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * 1087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * Copyright (c) 2000-2005 1187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * Thomas Gleixner <tglx@linuxtronix.de> 1287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * 1387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park */ 1487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#ifndef __LINUX_MTD_BBM_H 1587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define __LINUX_MTD_BBM_H 1687590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 1787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* The maximum number of NAND chips in an array */ 1887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_MAX_CHIPS 8 1987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 2087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/** 2187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * struct nand_bbt_descr - bad block table descriptor 22c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @options: options for this descriptor 23c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @pages: the page(s) where we find the bbt, used with option BBT_ABSPAGE 24c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * when bbt is searched, then we store the found bbts pages here. 25c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * Its an array and supports up to 8 chips now 26c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @offs: offset of the pattern in the oob area of the page 27c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @veroffs: offset of the bbt version counter in the oob are of the page 28c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @version: version read from the bbt page during scan 29c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @len: length of the pattern, if 0 no pattern check is performed 30c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @maxblocks: maximum number of blocks to search for a bbt. This number of 31c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * blocks is reserved at the end of the device where the tables are 32c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * written. 33c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than 34c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * bad) block in the stored bbt 35c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * @pattern: pattern to identify bad block table or factory marked good / 36c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini * bad blocks, can be NULL, if len = 0 3787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * 3887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * Descriptor for the bad block table marker and the descriptor for the 3987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * pattern which identifies good and bad blocks. The assumption is made 4087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * that the pattern and the version count are always located in the oob area 4187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * of the first block. 4287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park */ 4387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Parkstruct nand_bbt_descr { 4487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int options; 4587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int pages[NAND_MAX_CHIPS]; 4687590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int offs; 4787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int veroffs; 4887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park uint8_t version[NAND_MAX_CHIPS]; 4987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int len; 5087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int maxblocks; 5187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int reserved_block_code; 5287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park uint8_t *pattern; 5387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park}; 5487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 5587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* Options for the bad block table descriptors */ 5687590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 5787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* The number of bits used per block in the bbt on the device */ 5887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_NRBITS_MSK 0x0000000F 5987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_1BIT 0x00000001 6087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_2BIT 0x00000002 6187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_4BIT 0x00000004 6287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_8BIT 0x00000008 6387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* The bad block table is in the last good block of the device */ 6487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_LASTBLOCK 0x00000010 6587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* The bbt is at the given page, else we must scan for the bbt */ 6687590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_ABSPAGE 0x00000020 6787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* The bbt is at the given page, else we must scan for the bbt */ 6887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_SEARCH 0x00000040 6987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* bbt is stored per chip on multichip devices */ 7087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_PERCHIP 0x00000080 7187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* bbt has a version counter at offset veroffs */ 7287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_VERSION 0x00000100 7387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* Create a bbt if none axists */ 7487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_CREATE 0x00000200 7587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* Search good / bad pattern through all pages of a block */ 7687590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_SCANALLPAGES 0x00000400 7787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* Scan block empty during good / bad block scan */ 7887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_SCANEMPTY 0x00000800 7987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* Write bbt if neccecary */ 8087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_WRITE 0x00001000 8187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* Read and write back block contents when writing bbt */ 8287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_SAVECONTENT 0x00002000 8387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* Search good / bad pattern on the first and the second page */ 8487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_SCAN2NDPAGE 0x00004000 8530fe8115b55223cb84530ce04c4a20ba9d6dcf0bBrian Norris/* Search good / bad pattern on the last page of the eraseblock */ 8630fe8115b55223cb84530ce04c4a20ba9d6dcf0bBrian Norris#define NAND_BBT_SCANLASTPAGE 0x00008000 8787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 8887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* The maximum number of blocks to scan for a bbt */ 8987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#define NAND_BBT_SCAN_MAXBLOCKS 4 9087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 9187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* 9287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park * Constants for oob configuration 9387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park */ 94c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini#define NAND_SMALL_BADBLOCK_POS 5 95c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini#define NAND_LARGE_BADBLOCK_POS 0 96c62d81bcfe82526cc3da10cf4fc63faad368bc60Alessandro Rubini#define ONENAND_BADBLOCK_POS 0 9787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 98211ac75f5e867ab7a54811a514814149caca42c3Kyungmin Park/* 99211ac75f5e867ab7a54811a514814149caca42c3Kyungmin Park * Bad block scanning errors 100211ac75f5e867ab7a54811a514814149caca42c3Kyungmin Park */ 101211ac75f5e867ab7a54811a514814149caca42c3Kyungmin Park#define ONENAND_BBT_READ_ERROR 1 102211ac75f5e867ab7a54811a514814149caca42c3Kyungmin Park#define ONENAND_BBT_READ_ECC_ERROR 2 103211ac75f5e867ab7a54811a514814149caca42c3Kyungmin Park#define ONENAND_BBT_READ_FATAL_ERROR 4 104211ac75f5e867ab7a54811a514814149caca42c3Kyungmin Park 10587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/** 106ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * struct bbm_info - [GENERIC] Bad Block Table data structure 107ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry 108ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * @badblockpos: [INTERN] position of the bad block marker in the oob area 109ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * @options: options for this descriptor 110ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * @bbt: [INTERN] bad block table pointer 111ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * @isbad_bbt: function to determine if a block is bad 112ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for 113ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * initial bad block scan 114ea9b6dcc152f09c207117ab121d4fa03d2db282aRandy Dunlap * @priv: [OPTIONAL] pointer to private bbm date 11587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park */ 11687590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Parkstruct bbm_info { 11787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int bbt_erase_shift; 11887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int badblockpos; 11987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int options; 12087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 12187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park uint8_t *bbt; 12287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 12387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park int (*isbad_bbt)(struct mtd_info *mtd, loff_t ofs, int allowbbt); 12487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 12587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park /* TODO Add more NAND specific fileds */ 12687590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park struct nand_bbt_descr *badblock_pattern; 12787590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 12887590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park void *priv; 12987590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park}; 13087590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 13187590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park/* OneNAND BBT interface */ 13287590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Parkextern int onenand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd); 13387590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Parkextern int onenand_default_bbt(struct mtd_info *mtd); 13487590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park 13587590e26ff4e7d57dfdaa81780b1b0d9e9970a4cKyungmin Park#endif /* __LINUX_MTD_BBM_H */ 136