yaffs_mtdif.c

   1 /*
   2  * YAFFS: Yet another FFS. A NAND-flash specific file system.
   3  * yaffs_mtdif.c  NAND mtd wrapper functions.
   4  *
   5  * Copyright (C) 2002 Aleph One Ltd.
   6  *   for Toby Churchill Ltd and Brightstar Engineering
   7  *
   8  * Created by Charles Manning <charles@aleph1.co.uk>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  *
  14  */
  15
  16 const char *yaffs_mtdif_c_version =
  17     "$Id: yaffs_mtdif.c,v 1.17 2006-11-29 20:21:12 charles Exp $";
  18
  19 #include "yportenv.h"
  20
  21
  22 #include "yaffs_mtdif.h"
  23
  24 #include "linux/mtd/mtd.h"
  25 #include "linux/types.h"
  26 #include "linux/time.h"
  27 #include "linux/mtd/nand.h"
  28
  29 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,18))
  30 static struct nand_oobinfo yaffs_oobinfo = {
  31         .useecc = 1,
  32         .eccbytes = 6,
  33         .eccpos = {8, 9, 10, 13, 14, 15}
  34 };
  35
  36 static struct nand_oobinfo yaffs_noeccinfo = {
  37         .useecc = 0,
  38 };
  39 #endif
  40
  41 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,6,17))
  42 static inline void translate_spare2oob(const yaffs_Spare *spare, __u8 *oob)
  43 {
  44         oob[0] = spare->tagByte0;
  45         oob[1] = spare->tagByte1;
  46         oob[2] = spare->tagByte2;
  47         oob[3] = spare->tagByte3;
  48         oob[4] = spare->tagByte4;
  49         oob[5] = spare->tagByte5 & 0x3f;
  50         oob[5] |= spare->blockStatus == 'Y' ? 0: 0x80;
  51         oob[5] |= spare->pageStatus == 0 ? 0: 0x40;
  52         oob[6] = spare->tagByte6;
  53         oob[7] = spare->tagByte7;
  54 }
  55
  56 static inline void translate_oob2spare(yaffs_Spare *spare, __u8 *oob)
  57 {
  58         struct yaffs_NANDSpare *nspare = (struct yaffs_NANDSpare *)spare;
  59         spare->tagByte0 = oob[0];
  60         spare->tagByte1 = oob[1];
  61         spare->tagByte2 = oob[2];
  62         spare->tagByte3 = oob[3];
  63         spare->tagByte4 = oob[4];
  64         spare->tagByte5 = oob[5] == 0xff ? 0xff : oob[5] & 0x3f;
  65         spare->blockStatus = oob[5] & 0x80 ? 0xff : 'Y';
  66         spare->pageStatus = oob[5] & 0x40 ? 0xff : 0;
  67         spare->ecc1[0] = spare->ecc1[1] = spare->ecc1[2] = 0xff;
  68         spare->tagByte6 = oob[6];
  69         spare->tagByte7 = oob[7];
  70         spare->ecc2[0] = spare->ecc2[1] = spare->ecc2[2] = 0xff;
  71
  72         nspare->eccres1 = nspare->eccres2 = 0; /* FIXME */
  73 }
  74 #endif
  75
  76 int nandmtd_WriteChunkToNAND(yaffs_Device * dev, int chunkInNAND,
  77                              const __u8 * data, const yaffs_Spare * spare)
  78 {
  79         struct mtd_info *mtd = (struct mtd_info *)(dev->genericDevice);
  80 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,6,17))
  81         struct mtd_oob_ops ops;
  82 #endif
  83         size_t dummy;
  84         int retval = 0;
  85
  86         loff_t addr = ((loff_t) chunkInNAND) * dev->nDataBytesPerChunk;
  87 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,6,17))
  88         __u8 spareAsBytes[8]; /* OOB */
  89
  90         if (data && !spare)
  91                 retval = mtd->write(mtd, addr, dev->nDataBytesPerChunk,
  92                                 &dummy, data);
  93         else if (spare) {
  94                 if (dev->useNANDECC) {
  95                         translate_spare2oob(spare, spareAsBytes);
  96                         ops.mode = MTD_OOB_AUTO;
  97                         ops.ooblen = 8; /* temp hack */
  98                 } else {
  99                         ops.mode = MTD_OOB_RAW;
 100                         ops.ooblen = YAFFS_BYTES_PER_SPARE;
 101                 }
 102                 ops.len = data ? dev->nDataBytesPerChunk : ops.ooblen;
 103                 ops.datbuf = (u8 *)data;
 104                 ops.ooboffs = 0;
 105                 ops.oobbuf = spareAsBytes;
 106                 retval = mtd->write_oob(mtd, addr, &ops);
 107         }
 108 #else
 109         __u8 *spareAsBytes = (__u8 *) spare;
 110
 111         if (data && spare) {
 112                 if (dev->useNANDECC)
 113                         retval =
 114                             mtd->write_ecc(mtd, addr, dev->nDataBytesPerChunk,
 115                                            &dummy, data, spareAsBytes,
 116                                            &yaffs_oobinfo);
 117                 else
 118                         retval =
 119                             mtd->write_ecc(mtd, addr, dev->nDataBytesPerChunk,
 120                                            &dummy, data, spareAsBytes,
 121                                            &yaffs_noeccinfo);
 122         } else {
 123                 if (data)
 124                         retval =
 125                             mtd->write(mtd, addr, dev->nDataBytesPerChunk, &dummy,
 126                                        data);
 127                 if (spare)
 128                         retval =
 129                             mtd->write_oob(mtd, addr, YAFFS_BYTES_PER_SPARE,
 130                                            &dummy, spareAsBytes);
 131         }
 132 #endif
 133
 134         if (retval == 0)
 135                 return YAFFS_OK;
 136         else
 137                 return YAFFS_FAIL;
 138 }
 139
 140 int nandmtd_ReadChunkFromNAND(yaffs_Device * dev, int chunkInNAND, __u8 * data,
 141                               yaffs_Spare * spare)
 142 {
 143         struct mtd_info *mtd = (struct mtd_info *)(dev->genericDevice);
 144 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,6,17))
 145         struct mtd_oob_ops ops;
 146 #endif
 147         size_t dummy;
 148         int retval = 0;
 149
 150         loff_t addr = ((loff_t) chunkInNAND) * dev->nDataBytesPerChunk;
 151 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,6,17))
 152         __u8 spareAsBytes[8]; /* OOB */
 153
 154         if (data && !spare)
 155                 retval = mtd->read(mtd, addr, dev->nDataBytesPerChunk,
 156                                 &dummy, data);
 157         else if (spare) {
 158                 if (dev->useNANDECC) {
 159                         ops.mode = MTD_OOB_AUTO;
 160                         ops.ooblen = 8; /* temp hack */
 161                 } else {
 162                         ops.mode = MTD_OOB_RAW;
 163                         ops.ooblen = YAFFS_BYTES_PER_SPARE;
 164                 }
 165                 ops.len = data ? dev->nDataBytesPerChunk : ops.ooblen;
 166                 ops.datbuf = data;
 167                 ops.ooboffs = 0;
 168                 ops.oobbuf = spareAsBytes;
 169                 retval = mtd->read_oob(mtd, addr, &ops);
 170                 if (dev->useNANDECC)
 171                         translate_oob2spare(spare, spareAsBytes);
 172         }
 173 #else
 174         __u8 *spareAsBytes = (__u8 *) spare;
 175
 176         if (data && spare) {
 177                 if (dev->useNANDECC) {
 178                         /* Careful, this call adds 2 ints */
 179                         /* to the end of the spare data.  Calling function */
 180                         /* should allocate enough memory for spare, */
 181                         /* i.e. [YAFFS_BYTES_PER_SPARE+2*sizeof(int)]. */
 182                         retval =
 183                             mtd->read_ecc(mtd, addr, dev->nDataBytesPerChunk,
 184                                           &dummy, data, spareAsBytes,
 185                                           &yaffs_oobinfo);
 186                 } else {
 187                         retval =
 188                             mtd->read_ecc(mtd, addr, dev->nDataBytesPerChunk,
 189                                           &dummy, data, spareAsBytes,
 190                                           &yaffs_noeccinfo);
 191                 }
 192         } else {
 193                 if (data)
 194                         retval =
 195                             mtd->read(mtd, addr, dev->nDataBytesPerChunk, &dummy,
 196                                       data);
 197                 if (spare)
 198                         retval =
 199                             mtd->read_oob(mtd, addr, YAFFS_BYTES_PER_SPARE,
 200                                           &dummy, spareAsBytes);
 201         }
 202 #endif
 203
 204         if (retval == 0)
 205                 return YAFFS_OK;
 206         else
 207                 return YAFFS_FAIL;
 208 }
 209
 210 int nandmtd_EraseBlockInNAND(yaffs_Device * dev, int blockNumber)
 211 {
 212         struct mtd_info *mtd = (struct mtd_info *)(dev->genericDevice);
 213         __u32 addr =
 214             ((loff_t) blockNumber) * dev->nDataBytesPerChunk
 215                 * dev->nChunksPerBlock;
 216         struct erase_info ei;
 217         int retval = 0;
 218
 219         ei.mtd = mtd;
 220         ei.addr = addr;
 221         ei.len = dev->nDataBytesPerChunk * dev->nChunksPerBlock;
 222         ei.time = 1000;
 223         ei.retries = 2;
 224         ei.callback = NULL;
 225         ei.priv = (u_long) dev;
 226
 227         /* Todo finish off the ei if required */
 228
 229         sema_init(&dev->sem, 0);
 230
 231         retval = mtd->erase(mtd, &ei);
 232
 233         if (retval == 0)
 234                 return YAFFS_OK;
 235         else
 236                 return YAFFS_FAIL;
 237 }
 238
 239 int nandmtd_InitialiseNAND(yaffs_Device * dev)
 240 {
 241         return YAFFS_OK;
 242 }
 243