yaffs_mtdif1.c

   1 /*
   2  * YAFFS: Yet another FFS. A NAND-flash specific file system.
   3  * yaffs_mtdif1.c  NAND mtd interface functions for small-page NAND.
   4  *
   5  * Copyright (C) 2002 Aleph One Ltd.
   6  *   for Toby Churchill Ltd and Brightstar Engineering
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 /*
  14  * This module provides the interface between yaffs_nand.c and the
  15  * MTD API.  This version is used when the MTD interface supports the
  16  * 'mtd_oob_ops' style calls to read_oob and write_oob, circa 2.6.17,
  17  * and we have small-page NAND device.
  18  *
  19  * These functions are invoked via function pointers in yaffs_nand.c.
  20  * This replaces functionality provided by functions in yaffs_mtdif.c
  21  * and the yaffs_TagsCompatability functions in yaffs_tagscompat.c that are
  22  * called in yaffs_mtdif.c when the function pointers are NULL.
  23  * We assume the MTD layer is performing ECC (useNANDECC is true).
  24  */
  25
  26 #include "yportenv.h"
  27 #include "yaffs_trace.h"
  28 #include "yaffs_guts.h"
  29 #include "yaffs_packedtags1.h"
  30 #include "yaffs_tagscompat.h"   /* for yaffs_CalcTagsECC */
  31
  32 #include "linux/kernel.h"
  33 #include "linux/version.h"
  34 #include "linux/types.h"
  35 #include "linux/mtd/mtd.h"
  36
  37 /* Don't compile this module if we don't have MTD's mtd_oob_ops interface */
  38 #if (MTD_VERSION_CODE > MTD_VERSION(2, 6, 17))
  39
  40 const char *yaffs_mtdif1_c_version = "$Id: yaffs_mtdif1.c,v 1.12 2010-01-11 04:06:46 charles Exp $";
  41
  42 #ifndef CONFIG_YAFFS_9BYTE_TAGS
  43 # define YTAG1_SIZE 8
  44 #else
  45 # define YTAG1_SIZE 9
  46 #endif
  47
  48 #if 0
  49 /* Use the following nand_ecclayout with MTD when using
  50  * CONFIG_YAFFS_9BYTE_TAGS and the older on-NAND tags layout.
  51  * If you have existing Yaffs images and the byte order differs from this,
  52  * adjust 'oobfree' to match your existing Yaffs data.
  53  *
  54  * This nand_ecclayout scatters/gathers to/from the old-yaffs layout with the
  55  * pageStatus byte (at NAND spare offset 4) scattered/gathered from/to
  56  * the 9th byte.
  57  *
  58  * Old-style on-NAND format: T0,T1,T2,T3,P,B,T4,T5,E0,E1,E2,T6,T7,E3,E4,E5
  59  * We have/need PackedTags1 plus pageStatus: T0,T1,T2,T3,T4,T5,T6,T7,P
  60  * where Tn are the tag bytes, En are MTD's ECC bytes, P is the pageStatus
  61  * byte and B is the small-page bad-block indicator byte.
  62  */
  63 static struct nand_ecclayout nand_oob_16 = {
  64         .eccbytes = 6,
  65         .eccpos = { 8, 9, 10, 13, 14, 15 },
  66         .oobavail = 9,
  67         .oobfree = { { 0, 4 }, { 6, 2 }, { 11, 2 }, { 4, 1 } }
  68 };
  69 #endif
  70
  71 /* Write a chunk (page) of data to NAND.
  72  *
  73  * Caller always provides ExtendedTags data which are converted to a more
  74  * compact (packed) form for storage in NAND.  A mini-ECC runs over the
  75  * contents of the tags meta-data; used to valid the tags when read.
  76  *
  77  *  - Pack ExtendedTags to PackedTags1 form
  78  *  - Compute mini-ECC for PackedTags1
  79  *  - Write data and packed tags to NAND.
  80  *
  81  * Note: Due to the use of the PackedTags1 meta-data which does not include
  82  * a full sequence number (as found in the larger PackedTags2 form) it is
  83  * necessary for Yaffs to re-write a chunk/page (just once) to mark it as
  84  * discarded and dirty.  This is not ideal: newer NAND parts are supposed
  85  * to be written just once.  When Yaffs performs this operation, this
  86  * function is called with a NULL data pointer -- calling MTD write_oob
  87  * without data is valid usage (2.6.17).
  88  *
  89  * Any underlying MTD error results in YAFFS_FAIL.
  90  * Returns YAFFS_OK or YAFFS_FAIL.
  91  */
  92 int nandmtd1_WriteChunkWithTagsToNAND(yaffs_Device *dev,
  93         int chunkInNAND, const __u8 *data, const yaffs_ExtendedTags *etags)
  94 {
  95         struct mtd_info *mtd = dev->genericDevice;
  96         int chunkBytes = dev->nDataBytesPerChunk;
  97         loff_t addr = ((loff_t)chunkInNAND) * chunkBytes;
  98         struct mtd_oob_ops ops;
  99         yaffs_PackedTags1 pt1;
 100         int retval;
 101
 102         /* we assume that PackedTags1 and yaffs_Tags are compatible */
 103         compile_time_assertion(sizeof(yaffs_PackedTags1) == 12);
 104         compile_time_assertion(sizeof(yaffs_Tags) == 8);
 105
 106         yaffs_PackTags1(&pt1, etags);
 107         yaffs_CalcTagsECC((yaffs_Tags *)&pt1);
 108
 109         /* When deleting a chunk, the upper layer provides only skeletal
 110          * etags, one with chunkDeleted set.  However, we need to update the
 111          * tags, not erase them completely.  So we use the NAND write property
 112          * that only zeroed-bits stick and set tag bytes to all-ones and
 113          * zero just the (not) deleted bit.
 114          */
 115 #ifndef CONFIG_YAFFS_9BYTE_TAGS
 116         if (etags->chunkDeleted) {
 117                 memset(&pt1, 0xff, 8);
 118                 /* clear delete status bit to indicate deleted */
 119                 pt1.deleted = 0;
 120         }
 121 #else
 122         ((__u8 *)&pt1)[8] = 0xff;
 123         if (etags->chunkDeleted) {
 124                 memset(&pt1, 0xff, 8);
 125                 /* zero pageStatus byte to indicate deleted */
 126                 ((__u8 *)&pt1)[8] = 0;
 127         }
 128 #endif
 129
 130         memset(&ops, 0, sizeof(ops));
 131         ops.mode = MTD_OOB_AUTO;
 132         ops.len = (data) ? chunkBytes : 0;
 133         ops.ooblen = YTAG1_SIZE;
 134         ops.datbuf = (__u8 *)data;
 135         ops.oobbuf = (__u8 *)&pt1;
 136
 137         retval = mtd->write_oob(mtd, addr, &ops);
 138         if (retval) {
 139                 yaffs_trace(YAFFS_TRACE_MTD,
 140                         "write_oob failed, chunk %d, mtd error %d\n",
 141                         chunkInNAND, retval);
 142         }
 143         return retval ? YAFFS_FAIL : YAFFS_OK;
 144 }
 145
 146 /* Return with empty ExtendedTags but add eccResult.
 147  */
 148 static int rettags(yaffs_ExtendedTags *etags, int eccResult, int retval)
 149 {
 150         if (etags) {
 151                 memset(etags, 0, sizeof(*etags));
 152                 etags->eccResult = eccResult;
 153         }
 154         return retval;
 155 }
 156
 157 /* Read a chunk (page) from NAND.
 158  *
 159  * Caller expects ExtendedTags data to be usable even on error; that is,
 160  * all members except eccResult and blockBad are zeroed.
 161  *
 162  *  - Check ECC results for data (if applicable)
 163  *  - Check for blank/erased block (return empty ExtendedTags if blank)
 164  *  - Check the PackedTags1 mini-ECC (correct if necessary/possible)
 165  *  - Convert PackedTags1 to ExtendedTags
 166  *  - Update eccResult and blockBad members to refect state.
 167  *
 168  * Returns YAFFS_OK or YAFFS_FAIL.
 169  */
 170 int nandmtd1_ReadChunkWithTagsFromNAND(yaffs_Device *dev,
 171         int chunkInNAND, __u8 *data, yaffs_ExtendedTags *etags)
 172 {
 173         struct mtd_info *mtd = dev->genericDevice;
 174         int chunkBytes = dev->nDataBytesPerChunk;
 175         loff_t addr = ((loff_t)chunkInNAND) * chunkBytes;
 176         int eccres = YAFFS_ECC_RESULT_NO_ERROR;
 177         struct mtd_oob_ops ops;
 178         yaffs_PackedTags1 pt1;
 179         int retval;
 180         int deleted;
 181
 182         memset(&ops, 0, sizeof(ops));
 183         ops.mode = MTD_OOB_AUTO;
 184         ops.len = (data) ? chunkBytes : 0;
 185         ops.ooblen = YTAG1_SIZE;
 186         ops.datbuf = data;
 187         ops.oobbuf = (__u8 *)&pt1;
 188
 189 #if (MTD_VERSION_CODE < MTD_VERSION(2, 6, 20))
 190         /* In MTD 2.6.18 to 2.6.19 nand_base.c:nand_do_read_oob() has a bug;
 191          * help it out with ops.len = ops.ooblen when ops.datbuf == NULL.
 192          */
 193         ops.len = (ops.datbuf) ? ops.len : ops.ooblen;
 194 #endif
 195         /* Read page and oob using MTD.
 196          * Check status and determine ECC result.
 197          */
 198         retval = mtd->read_oob(mtd, addr, &ops);
 199         if (retval) {
 200                 yaffs_trace(YAFFS_TRACE_MTD,
 201                         "read_oob failed, chunk %d, mtd error %d\n",
 202                         chunkInNAND, retval);
 203         }
 204
 205         switch (retval) {
 206         case 0:
 207                 /* no error */
 208                 break;
 209
 210         case -EUCLEAN:
 211                 /* MTD's ECC fixed the data */
 212                 eccres = YAFFS_ECC_RESULT_FIXED;
 213                 dev->eccFixed++;
 214                 break;
 215
 216         case -EBADMSG:
 217                 /* MTD's ECC could not fix the data */
 218                 dev->eccUnfixed++;
 219                 /* fall into... */
 220         default:
 221                 rettags(etags, YAFFS_ECC_RESULT_UNFIXED, 0);
 222                 etags->blockBad = (mtd->block_isbad)(mtd, addr);
 223                 return YAFFS_FAIL;
 224         }
 225
 226         /* Check for a blank/erased chunk.
 227          */
 228         if (yaffs_CheckFF((__u8 *)&pt1, 8)) {
 229                 /* when blank, upper layers want eccResult to be <= NO_ERROR */
 230                 return rettags(etags, YAFFS_ECC_RESULT_NO_ERROR, YAFFS_OK);
 231         }
 232
 233 #ifndef CONFIG_YAFFS_9BYTE_TAGS
 234         /* Read deleted status (bit) then return it to it's non-deleted
 235          * state before performing tags mini-ECC check. pt1.deleted is
 236          * inverted.
 237          */
 238         deleted = !pt1.deleted;
 239         pt1.deleted = 1;
 240 #else
 241         deleted = (yaffs_CountBits(((__u8 *)&pt1)[8]) < 7);
 242 #endif
 243
 244         /* Check the packed tags mini-ECC and correct if necessary/possible.
 245          */
 246         retval = yaffs_CheckECCOnTags((yaffs_Tags *)&pt1);
 247         switch (retval) {
 248         case 0:
 249                 /* no tags error, use MTD result */
 250                 break;
 251         case 1:
 252                 /* recovered tags-ECC error */
 253                 dev->tagsEccFixed++;
 254                 if (eccres == YAFFS_ECC_RESULT_NO_ERROR)
 255                         eccres = YAFFS_ECC_RESULT_FIXED;
 256                 break;
 257         default:
 258                 /* unrecovered tags-ECC error */
 259                 dev->tagsEccUnfixed++;
 260                 return rettags(etags, YAFFS_ECC_RESULT_UNFIXED, YAFFS_FAIL);
 261         }
 262
 263         /* Unpack the tags to extended form and set ECC result.
 264          * [set shouldBeFF just to keep yaffs_UnpackTags1 happy]
 265          */
 266         pt1.shouldBeFF = 0xFFFFFFFF;
 267         yaffs_UnpackTags1(etags, &pt1);
 268         etags->eccResult = eccres;
 269
 270         /* Set deleted state */
 271         etags->chunkDeleted = deleted;
 272         return YAFFS_OK;
 273 }
 274
 275 /* Mark a block bad.
 276  *
 277  * This is a persistant state.
 278  * Use of this function should be rare.
 279  *
 280  * Returns YAFFS_OK or YAFFS_FAIL.
 281  */
 282 int nandmtd1_MarkNANDBlockBad(struct yaffs_DeviceStruct *dev, int blockNo)
 283 {
 284         struct mtd_info *mtd = dev->genericDevice;
 285         int blocksize = dev->nChunksPerBlock * dev->nDataBytesPerChunk;
 286         int retval;
 287
 288         yaffs_trace(YAFFS_TRACE_BAD_BLOCKS, "marking block %d bad\n", blockNo);
 289
 290         retval = mtd->block_markbad(mtd, (loff_t)blocksize * blockNo);
 291         return (retval) ? YAFFS_FAIL : YAFFS_OK;
 292 }
 293
 294 /* Check any MTD prerequists.
 295  *
 296  * Returns YAFFS_OK or YAFFS_FAIL.
 297  */
 298 static int nandmtd1_TestPrerequists(struct mtd_info *mtd)
 299 {
 300         /* 2.6.18 has mtd->ecclayout->oobavail */
 301         /* 2.6.21 has mtd->ecclayout->oobavail and mtd->oobavail */
 302         int oobavail = mtd->ecclayout->oobavail;
 303
 304         if (oobavail < YTAG1_SIZE) {
 305                 yaffs_trace(YAFFS_TRACE_ERROR,
 306                         "mtd device has only %d bytes for tags, need %d\n",
 307                         oobavail, YTAG1_SIZE);
 308                 return YAFFS_FAIL;
 309         }
 310         return YAFFS_OK;
 311 }
 312
 313 /* Query for the current state of a specific block.
 314  *
 315  * Examine the tags of the first chunk of the block and return the state:
 316  *  - YAFFS_BLOCK_STATE_DEAD, the block is marked bad
 317  *  - YAFFS_BLOCK_STATE_NEEDS_SCANNING, the block is in use
 318  *  - YAFFS_BLOCK_STATE_EMPTY, the block is clean
 319  *
 320  * Always returns YAFFS_OK.
 321  */
 322 int nandmtd1_QueryNANDBlock(struct yaffs_DeviceStruct *dev, int blockNo,
 323         yaffs_BlockState *pState, __u32 *pSequenceNumber)
 324 {
 325         struct mtd_info *mtd = dev->genericDevice;
 326         int chunkNo = blockNo * dev->nChunksPerBlock;
 327         loff_t addr = (loff_t)chunkNo * dev->nDataBytesPerChunk;
 328         yaffs_ExtendedTags etags;
 329         int state = YAFFS_BLOCK_STATE_DEAD;
 330         int seqnum = 0;
 331         int retval;
 332
 333         /* We don't yet have a good place to test for MTD config prerequists.
 334          * Do it here as we are called during the initial scan.
 335          */
 336         if (nandmtd1_TestPrerequists(mtd) != YAFFS_OK)
 337                 return YAFFS_FAIL;
 338
 339         retval = nandmtd1_ReadChunkWithTagsFromNAND(dev, chunkNo, NULL, &etags);
 340         etags.blockBad = (mtd->block_isbad)(mtd, addr);
 341         if (etags.blockBad) {
 342                 yaffs_trace(YAFFS_TRACE_BAD_BLOCKS,
 343                         "block %d is marked bad\n", blockNo);
 344                 state = YAFFS_BLOCK_STATE_DEAD;
 345         } else if (etags.eccResult != YAFFS_ECC_RESULT_NO_ERROR) {
 346                 /* bad tags, need to look more closely */
 347                 state = YAFFS_BLOCK_STATE_NEEDS_SCANNING;
 348         } else if (etags.chunkUsed) {
 349                 state = YAFFS_BLOCK_STATE_NEEDS_SCANNING;
 350                 seqnum = etags.sequenceNumber;
 351         } else {
 352                 state = YAFFS_BLOCK_STATE_EMPTY;
 353         }
 354
 355         *pState = state;
 356         *pSequenceNumber = seqnum;
 357
 358         /* query always succeeds */
 359         return YAFFS_OK;
 360 }
 361
 362 #endif /*MTD_VERSION*/