1 /* 2 * linux/drivers/mtd/onenand/onenand_bbt.c 3 * 4 * Bad Block Table support for the OneNAND driver 5 * 6 * Copyright(c) 2005-2008 Samsung Electronics 7 * Kyungmin Park <kyungmin.park@samsung.com> 8 * 9 * TODO: 10 * Split BBT core and chip specific BBT. 11 * 12 * This program is free software; you can redistribute it and/or modify 13 * it under the terms of the GNU General Public License version 2 as 14 * published by the Free Software Foundation. 15 */ 16 17 #include <common.h> 18 #include <linux/compat.h> 19 #include <linux/mtd/mtd.h> 20 #include <linux/mtd/onenand.h> 21 #include <malloc.h> 22 23 #include <linux/errno.h> 24 25 /** 26 * check_short_pattern - [GENERIC] check if a pattern is in the buffer 27 * @param buf the buffer to search 28 * @param len the length of buffer to search 29 * @param paglen the pagelength 30 * @param td search pattern descriptor 31 * 32 * Check for a pattern at the given place. Used to search bad block 33 * tables and good / bad block identifiers. Same as check_pattern, but 34 * no optional empty check and the pattern is expected to start 35 * at offset 0. 36 */ 37 static int check_short_pattern(uint8_t * buf, int len, int paglen, 38 struct nand_bbt_descr *td) 39 { 40 int i; 41 uint8_t *p = buf; 42 43 /* Compare the pattern */ 44 for (i = 0; i < td->len; i++) { 45 if (p[i] != td->pattern[i]) 46 return -1; 47 } 48 return 0; 49 } 50 51 /** 52 * create_bbt - [GENERIC] Create a bad block table by scanning the device 53 * @param mtd MTD device structure 54 * @param buf temporary buffer 55 * @param bd descriptor for the good/bad block search pattern 56 * @param chip create the table for a specific chip, -1 read all chips. 57 * Applies only if NAND_BBT_PERCHIP option is set 58 * 59 * Create a bad block table by scanning the device 60 * for the given good/bad block identify pattern 61 */ 62 static int create_bbt(struct mtd_info *mtd, uint8_t * buf, 63 struct nand_bbt_descr *bd, int chip) 64 { 65 struct onenand_chip *this = mtd->priv; 66 struct bbm_info *bbm = this->bbm; 67 int i, j, numblocks, len, scanlen; 68 int startblock; 69 loff_t from; 70 size_t readlen, ooblen; 71 struct mtd_oob_ops ops; 72 int rgn; 73 74 printk(KERN_INFO "Scanning device for bad blocks\n"); 75 76 len = 1; 77 78 /* We need only read few bytes from the OOB area */ 79 scanlen = ooblen = 0; 80 readlen = bd->len; 81 82 /* chip == -1 case only */ 83 /* Note that numblocks is 2 * (real numblocks) here; 84 * see i += 2 below as it makses shifting and masking less painful 85 */ 86 numblocks = this->chipsize >> (bbm->bbt_erase_shift - 1); 87 startblock = 0; 88 from = 0; 89 90 ops.mode = MTD_OPS_PLACE_OOB; 91 ops.ooblen = readlen; 92 ops.oobbuf = buf; 93 ops.len = ops.ooboffs = ops.retlen = ops.oobretlen = 0; 94 95 for (i = startblock; i < numblocks;) { 96 int ret; 97 98 for (j = 0; j < len; j++) { 99 /* No need to read pages fully, 100 * just read required OOB bytes */ 101 ret = onenand_bbt_read_oob(mtd, 102 from + j * mtd->writesize + 103 bd->offs, &ops); 104 105 /* If it is a initial bad block, just ignore it */ 106 if (ret == ONENAND_BBT_READ_FATAL_ERROR) 107 return -EIO; 108 109 if (ret || check_short_pattern 110 (&buf[j * scanlen], scanlen, mtd->writesize, bd)) { 111 bbm->bbt[i >> 3] |= 0x03 << (i & 0x6); 112 printk(KERN_WARNING 113 "Bad eraseblock %d at 0x%08x\n", i >> 1, 114 (unsigned int)from); 115 break; 116 } 117 } 118 i += 2; 119 120 if (FLEXONENAND(this)) { 121 rgn = flexonenand_region(mtd, from); 122 from += mtd->eraseregions[rgn].erasesize; 123 } else 124 from += (1 << bbm->bbt_erase_shift); 125 } 126 127 return 0; 128 } 129 130 /** 131 * onenand_memory_bbt - [GENERIC] create a memory based bad block table 132 * @param mtd MTD device structure 133 * @param bd descriptor for the good/bad block search pattern 134 * 135 * The function creates a memory based bbt by scanning the device 136 * for manufacturer / software marked good / bad blocks 137 */ 138 static inline int onenand_memory_bbt(struct mtd_info *mtd, 139 struct nand_bbt_descr *bd) 140 { 141 unsigned char data_buf[MAX_ONENAND_PAGESIZE]; 142 143 return create_bbt(mtd, data_buf, bd, -1); 144 } 145 146 /** 147 * onenand_isbad_bbt - [OneNAND Interface] Check if a block is bad 148 * @param mtd MTD device structure 149 * @param offs offset in the device 150 * @param allowbbt allow access to bad block table region 151 */ 152 static int onenand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt) 153 { 154 struct onenand_chip *this = mtd->priv; 155 struct bbm_info *bbm = this->bbm; 156 int block; 157 uint8_t res; 158 159 /* Get block number * 2 */ 160 block = (int) (onenand_block(this, offs) << 1); 161 res = (bbm->bbt[block >> 3] >> (block & 0x06)) & 0x03; 162 163 MTDDEBUG (MTD_DEBUG_LEVEL2, 164 "onenand_isbad_bbt: bbt info for offs 0x%08x: (block %d) 0x%02x\n", 165 (unsigned int)offs, block >> 1, res); 166 167 switch ((int)res) { 168 case 0x00: 169 return 0; 170 case 0x01: 171 return 1; 172 case 0x02: 173 return allowbbt ? 0 : 1; 174 } 175 176 return 1; 177 } 178 179 /** 180 * onenand_scan_bbt - [OneNAND Interface] scan, find, read and maybe create bad block table(s) 181 * @param mtd MTD device structure 182 * @param bd descriptor for the good/bad block search pattern 183 * 184 * The function checks, if a bad block table(s) is/are already 185 * available. If not it scans the device for manufacturer 186 * marked good / bad blocks and writes the bad block table(s) to 187 * the selected place. 188 * 189 * The bad block table memory is allocated here. It must be freed 190 * by calling the onenand_free_bbt function. 191 * 192 */ 193 int onenand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd) 194 { 195 struct onenand_chip *this = mtd->priv; 196 struct bbm_info *bbm = this->bbm; 197 int len, ret = 0; 198 199 len = this->chipsize >> (this->erase_shift + 2); 200 /* Allocate memory (2bit per block) */ 201 bbm->bbt = malloc(len); 202 if (!bbm->bbt) 203 return -ENOMEM; 204 /* Clear the memory bad block table */ 205 memset(bbm->bbt, 0x00, len); 206 207 /* Set the bad block position */ 208 bbm->badblockpos = ONENAND_BADBLOCK_POS; 209 210 /* Set erase shift */ 211 bbm->bbt_erase_shift = this->erase_shift; 212 213 if (!bbm->isbad_bbt) 214 bbm->isbad_bbt = onenand_isbad_bbt; 215 216 /* Scan the device to build a memory based bad block table */ 217 if ((ret = onenand_memory_bbt(mtd, bd))) { 218 printk(KERN_ERR 219 "onenand_scan_bbt: Can't scan flash and build the RAM-based BBT\n"); 220 free(bbm->bbt); 221 bbm->bbt = NULL; 222 } 223 224 return ret; 225 } 226 227 /* 228 * Define some generic bad / good block scan pattern which are used 229 * while scanning a device for factory marked good / bad blocks. 230 */ 231 static uint8_t scan_ff_pattern[] = { 0xff, 0xff }; 232 233 static struct nand_bbt_descr largepage_memorybased = { 234 .options = 0, 235 .offs = 0, 236 .len = 2, 237 .pattern = scan_ff_pattern, 238 }; 239 240 /** 241 * onenand_default_bbt - [OneNAND Interface] Select a default bad block table for the device 242 * @param mtd MTD device structure 243 * 244 * This function selects the default bad block table 245 * support for the device and calls the onenand_scan_bbt function 246 */ 247 int onenand_default_bbt(struct mtd_info *mtd) 248 { 249 struct onenand_chip *this = mtd->priv; 250 struct bbm_info *bbm; 251 252 this->bbm = malloc(sizeof(struct bbm_info)); 253 if (!this->bbm) 254 return -ENOMEM; 255 256 bbm = this->bbm; 257 258 memset(bbm, 0, sizeof(struct bbm_info)); 259 260 /* 1KB page has same configuration as 2KB page */ 261 if (!bbm->badblock_pattern) 262 bbm->badblock_pattern = &largepage_memorybased; 263 264 return onenand_scan_bbt(mtd, bbm->badblock_pattern); 265 } 266