direct/yaffs_nandif.c

   1 /*
   2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2010 Aleph One Ltd.
   5  *   for Toby Churchill Ltd and Brightstar Engineering
   6  *
   7  * Created by Charles Manning <charles@aleph1.co.uk>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  */
  13
  14 #include "yportenv.h"
  15 #include "yaffs_guts.h"
  16
  17
  18 #include "yaffs_nandif.h"
  19 #include "yaffs_packedtags2.h"
  20
  21 #include "yramsim.h"
  22
  23 #include "yaffs_trace.h"
  24 #include "yaffsfs.h"
  25
  26
  27 /* NB For use with inband tags....
  28  * We assume that the data buffer is of size totalBytersPerChunk so that we can also
  29  * use it to load the tags.
  30  */
  31 int ynandif_WriteChunkWithTagsToNAND(struct yaffs_dev * dev, int nand_chunk,
  32                                       const u8 * data,
  33                                       const struct yaffs_ext_tags * tags)
  34 {
  35
  36         int retval = 0;
  37         struct yaffs_packed_tags2 pt;
  38         void *spare;
  39         unsigned spareSize = 0;
  40         ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
  41
  42         yaffs_trace(YAFFS_TRACE_MTD,
  43                 "nandmtd2_WriteChunkWithTagsToNAND chunk %d data %p tags %p",
  44                 nand_chunk, data, tags);
  45
  46
  47         /* For yaffs2 writing there must be both data and tags.
  48          * If we're using inband tags, then the tags are stuffed into
  49          * the end of the data buffer.
  50          */
  51
  52         if(dev->param.inband_tags){
  53                 struct yaffs_packed_tags2_tags_only *pt2tp;
  54                 pt2tp = (struct yaffs_packed_tags2_tags_only *)
  55                         (data + dev->data_bytes_per_chunk);
  56                 yaffs_pack_tags2_tags_only(pt2tp,tags);
  57                 spare = NULL;
  58                 spareSize = 0;
  59         }
  60         else{
  61                 yaffs_pack_tags2(&pt, tags,!dev->param.no_tags_ecc);
  62                 spare = &pt;
  63                 spareSize = sizeof(struct yaffs_packed_tags2);
  64         }
  65
  66         retval = geometry->writeChunk(dev,nand_chunk,
  67                                 data, dev->param.total_bytes_per_chunk,
  68                                 spare, spareSize);
  69
  70         return retval;
  71 }
  72
  73 int ynandif_ReadChunkWithTagsFromNAND(struct yaffs_dev * dev, int nand_chunk,
  74                                        u8 * data, struct yaffs_ext_tags * tags)
  75 {
  76         struct yaffs_packed_tags2 pt;
  77         int localData = 0;
  78         void *spare = NULL;
  79         unsigned spareSize;
  80         int retval = 0;
  81         int eccStatus; //0 = ok, 1 = fixed, -1 = unfixed
  82         ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
  83
  84         yaffs_trace(YAFFS_TRACE_MTD,
  85                 "nandmtd2_ReadChunkWithTagsFromNAND chunk %d data %p tags %p",
  86                 nand_chunk, data, tags);
  87
  88         if(!tags){
  89                 spare = NULL;
  90                 spareSize = 0;
  91         }else if(dev->param.inband_tags){
  92
  93                 if(!data) {
  94                         localData = 1;
  95                         data = yaffs_get_temp_buffer(dev,__LINE__);
  96                 }
  97                 spare = NULL;
  98                 spareSize = 0;
  99         }
 100         else {
 101                 spare = &pt;
 102                 spareSize = sizeof(struct yaffs_packed_tags2);
 103         }
 104
 105         retval = geometry->readChunk(dev,nand_chunk,
 106                                          data,
 107                                          data ? dev->param.total_bytes_per_chunk : 0,
 108                                          spare,spareSize,
 109                                          &eccStatus);
 110
 111         if(dev->param.inband_tags){
 112                 if(tags){
 113                         struct yaffs_packed_tags2_tags_only * pt2tp;
 114                         pt2tp = (struct yaffs_packed_tags2_tags_only *)&data[dev->data_bytes_per_chunk];
 115                         yaffs_unpack_tags2_tags_only(tags,pt2tp);
 116                 }
 117         }
 118         else {
 119                 if (tags){
 120                         yaffs_unpack_tags2(tags, &pt,!dev->param.no_tags_ecc);
 121                 }
 122         }
 123
 124         if(tags && tags->chunk_used){
 125                 if(eccStatus < 0 ||
 126                    tags->ecc_result == YAFFS_ECC_RESULT_UNFIXED)
 127                         tags->ecc_result = YAFFS_ECC_RESULT_UNFIXED;
 128                 else if(eccStatus > 0 ||
 129                              tags->ecc_result == YAFFS_ECC_RESULT_FIXED)
 130                         tags->ecc_result = YAFFS_ECC_RESULT_FIXED;
 131                 else
 132                         tags->ecc_result = YAFFS_ECC_RESULT_NO_ERROR;
 133         }
 134
 135         if(localData)
 136                 yaffs_release_temp_buffer(dev,data,__LINE__);
 137
 138         return retval;
 139 }
 140
 141 int ynandif_MarkNANDBlockBad(struct yaffs_dev *dev, int blockId)
 142 {
 143         ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
 144
 145         return geometry->markBlockBad(dev,blockId);
 146 }
 147
 148 int ynandif_EraseBlockInNAND(struct yaffs_dev *dev, int blockId)
 149 {
 150         ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
 151
 152         return geometry->eraseBlock(dev,blockId);
 153
 154 }
 155
 156
 157 static int ynandif_IsBlockOk(struct yaffs_dev *dev, int blockId)
 158 {
 159         ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
 160
 161         return geometry->checkBlockOk(dev,blockId);
 162 }
 163
 164 int ynandif_QueryNANDBlock(struct yaffs_dev *dev, int blockId,
 165                 enum yaffs_block_state *state, u32 *seq_number)
 166 {
 167         unsigned chunkNo;
 168         struct yaffs_ext_tags tags;
 169
 170         *seq_number = 0;
 171
 172         chunkNo = blockId * dev->param.chunks_per_block;
 173
 174         if(!ynandif_IsBlockOk(dev,blockId)){
 175                 *state = YAFFS_BLOCK_STATE_DEAD;
 176         }
 177         else
 178         {
 179                 ynandif_ReadChunkWithTagsFromNAND(dev,chunkNo,NULL,&tags);
 180
 181                 if(!tags.chunk_used)
 182                 {
 183                         *state = YAFFS_BLOCK_STATE_EMPTY;
 184                 }
 185                 else
 186                 {
 187                         *state = YAFFS_BLOCK_STATE_NEEDS_SCANNING;
 188                         *seq_number = tags.seq_number;
 189                 }
 190         }
 191
 192         return YAFFS_OK;
 193 }
 194
 195
 196 int ynandif_InitialiseNAND(struct yaffs_dev *dev)
 197 {
 198         ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
 199
 200         geometry->initialise(dev);
 201
 202         return YAFFS_OK;
 203 }
 204
 205 int ynandif_Deinitialise_flash_fn(struct yaffs_dev *dev)
 206 {
 207         ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
 208
 209         geometry->deinitialise(dev);
 210
 211         return YAFFS_OK;
 212 }
 213
 214
 215 struct yaffs_dev *
 216         yaffs_add_dev_from_geometry(const YCHAR *name,
 217                                         const ynandif_Geometry *geometry)
 218 {
 219         YCHAR *clonedName = malloc(sizeof(YCHAR) * (strnlen(name,YAFFS_MAX_NAME_LENGTH)+1));
 220         struct yaffs_dev *dev = malloc(sizeof(struct yaffs_dev));
 221
 222         if(dev && clonedName){
 223                 memset(dev,0,sizeof(struct yaffs_dev));
 224                 strcpy(clonedName,name);
 225
 226                 dev->param.name = clonedName;
 227                 dev->param.write_chunk_tags_fn = ynandif_WriteChunkWithTagsToNAND;
 228                 dev->param.read_chunk_tags_fn = ynandif_ReadChunkWithTagsFromNAND;
 229                 dev->param.erase_fn = ynandif_EraseBlockInNAND;
 230                 dev->param.initialise_flash_fn = ynandif_InitialiseNAND;
 231                 dev->param.query_block_fn = ynandif_QueryNANDBlock;
 232                 dev->param.bad_block_fn = ynandif_MarkNANDBlockBad;
 233                 dev->param.n_caches = 20;
 234                 dev->param.start_block = geometry->start_block;
 235                 dev->param.end_block   = geometry->end_block;
 236                 dev->param.total_bytes_per_chunk  = geometry->dataSize;
 237                 dev->param.spare_bytes_per_chunk  = geometry->spareSize;
 238                 dev->param.inband_tags            = geometry->inband_tags;
 239                 dev->param.chunks_per_block       = geometry->pagesPerBlock;
 240                 dev->param.use_nand_ecc           = geometry->hasECC;
 241                 dev->param.is_yaffs2              = geometry->useYaffs2;
 242                 dev->param.n_reserved_blocks      = 5;
 243                 dev->driver_context               = (void *)geometry;
 244
 245                 yaffs_add_device(dev);
 246
 247                 return dev;
 248         }
 249
 250         if(dev)
 251                 free(dev);
 252         if(clonedName)
 253                 free(clonedName);
 254
 255         return NULL;
 256 }
 257