direct/test-framework/yaffs_fileem2k.c

   1 /*
   2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2011 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 /*
  15  * This provides a YAFFS nand emulation on a file for emulating 2kB pages.
  16  * This is only intended as test code to test persistence etc.
  17  */
  18
  19 #include "yportenv.h"
  20 #include "yaffs_trace.h"
  21
  22 #include "yaffs_flashif2.h"
  23 #include "yaffs_guts.h"
  24 #include "yaffs_fileem2k.h"
  25 #include "yaffs_packedtags2.h"
  26
  27
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <fcntl.h>
  31 #include <unistd.h>
  32
  33 #if 1
  34
  35 #define SIZE_IN_MB 32
  36 /* #define SIZE_IN_MB 128 */
  37
  38 #define PAGE_DATA_SIZE (2048)
  39 #define PAGE_SPARE_SIZE  (64)
  40 #define PAGE_SIZE  (PAGE_DATA_SIZE + PAGE_SPARE_SIZE)
  41 #define PAGES_PER_BLOCK (64)
  42 #define BLOCK_DATA_SIZE (PAGE_DATA_SIZE * PAGES_PER_BLOCK)
  43 #define BLOCK_SIZE (PAGES_PER_BLOCK * (PAGE_SIZE))
  44 #define BLOCKS_PER_MB ((1024*1024)/BLOCK_DATA_SIZE)
  45 #define SIZE_IN_BLOCKS (BLOCKS_PER_MB * SIZE_IN_MB)
  46
  47 #else
  48
  49 #define SIZE_IN_MB 128
  50 #define PAGE_DATA_SIZE (512)
  51 #define SPARE_SIZE  (16)
  52 #define PAGE_SIZE  (PAGE_DATA_SIZE + SPARE_SIZE)
  53 #define PAGES_PER_BLOCK (32)
  54 #define BLOCK_DATA_SIZE (PAGE_SIZE * PAGES_PER_BLOCK)
  55 #define BLOCK_SIZE (PAGES_PER_BLOCK * (PAGE_SIZE))
  56 #define BLOCKS_PER_MB ((1024*1024)/BLOCK_DATA_SIZE)
  57 #define SIZE_IN_BLOCKS (BLOCKS_PER_MB * SIZE_IN_MB)
  58
  59 #endif
  60
  61 #define REPORT_ERROR 0
  62
  63 typedef struct
  64 {
  65         u8 data[PAGE_SIZE]; // Data + spare
  66 } yflash_Page;
  67
  68 typedef struct
  69 {
  70         yflash_Page page[PAGES_PER_BLOCK]; // The pages in the block
  71
  72 } yflash_Block;
  73
  74
  75
  76 #define MAX_HANDLES 20
  77 #define BLOCKS_PER_HANDLE (32*8)
  78
  79 typedef struct
  80 {
  81         int handle[MAX_HANDLES];
  82         int nBlocks;
  83 } yflash_Device;
  84
  85 static yflash_Device filedisk;
  86
  87 int yaffs_test_partial_write = 0;
  88
  89 extern int random_seed;
  90 extern int simulate_power_failure;
  91 static int remaining_ops;
  92 static int nops_so_far;
  93
  94 int ops_multiplier;
  95
  96
  97 static void yflash2_MaybePowerFail(unsigned int nand_chunk, int failPoint)
  98 {
  99
 100    nops_so_far++;
 101
 102
 103    remaining_ops--;
 104    if(simulate_power_failure &&
 105       remaining_ops < 1){
 106        printf("Simulated power failure after %d operations\n",nops_so_far);
 107        printf("  power failed on nand_chunk %d, at fail point %d\n",
 108                         nand_chunk, failPoint);
 109         exit(0);
 110   }
 111 }
 112
 113 static char *NToName(char *buf,int n)
 114 {
 115         sprintf(buf,"emfile-2k-%d",n);
 116         return buf;
 117 }
 118
 119 static char dummyBuffer[BLOCK_SIZE];
 120
 121 static int GetBlockFileHandle(int n)
 122 {
 123         int h;
 124         int requiredSize;
 125
 126         char name[40];
 127         NToName(name,n);
 128         int fSize;
 129         int i;
 130
 131         h =  open(name, O_RDWR | O_CREAT, S_IREAD | S_IWRITE);
 132         if(h >= 0){
 133                 fSize = lseek(h,0,SEEK_END);
 134                 requiredSize = BLOCKS_PER_HANDLE * BLOCK_SIZE;
 135                 if(fSize < requiredSize){
 136                    for(i = 0; i < BLOCKS_PER_HANDLE; i++)
 137                         if(write(h,dummyBuffer,BLOCK_SIZE) != BLOCK_SIZE)
 138                                 return -1;
 139
 140                 }
 141         }
 142
 143         return h;
 144
 145 }
 146
 147 static int  CheckInit(void)
 148 {
 149         static int initialised = 0;
 150         int i;
 151         int blk;
 152
 153         if(initialised)
 154                 return YAFFS_OK;
 155
 156         initialised = 1;
 157
 158         srand(random_seed);
 159         remaining_ops = (rand() % 1000) * 5;
 160         memset(dummyBuffer,0xff,sizeof(dummyBuffer));
 161
 162         filedisk.nBlocks = SIZE_IN_MB * BLOCKS_PER_MB;
 163
 164         for(i = 0; i <  MAX_HANDLES; i++)
 165                 filedisk.handle[i] = -1;
 166
 167         for(i = 0,blk = 0; blk < filedisk.nBlocks; blk+=BLOCKS_PER_HANDLE,i++)
 168                 filedisk.handle[i] = GetBlockFileHandle(i);
 169
 170         return 1;
 171 }
 172
 173
 174 int yflash2_GetNumberOfBlocks(void)
 175 {
 176         CheckInit();
 177
 178         return filedisk.nBlocks;
 179 }
 180
 181
 182 int yaffs_check_all_ff(const u8 *ptr, int n)
 183 {
 184         while(n)
 185         {
 186                 n--;
 187                 if(*ptr!=0xFF) return 0;
 188                 ptr++;
 189         }
 190         return 1;
 191 }
 192
 193
 194 static int yflash2_WriteChunk(struct yaffs_dev *dev, int nand_chunk,
 195                                    const u8 *data, int data_len,
 196                                    const u8 *oob, int oob_len)
 197 {
 198         int retval = YAFFS_OK;
 199         int pos;
 200         int h;
 201         int nwritten;
 202
 203         (void) dev;
 204
 205         if (data && data_len) {
 206                 pos = (nand_chunk % (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE)) * PAGE_SIZE;
 207                 h = filedisk.handle[(nand_chunk / (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE))];
 208                 lseek(h,pos,SEEK_SET);
 209                 nwritten = write(h,data,data_len);
 210                 if(nwritten != data_len)
 211                         retval = YAFFS_FAIL;
 212         }
 213
 214         if (oob && oob_len) {
 215                 pos = (nand_chunk % (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE)) * PAGE_SIZE + PAGE_DATA_SIZE;
 216                 h = filedisk.handle[(nand_chunk / (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE))];
 217                 lseek(h,pos,SEEK_SET);
 218                 nwritten = write(h,oob,oob_len);
 219                 if(nwritten != oob_len)
 220                         retval = YAFFS_FAIL;
 221         }
 222
 223         yflash2_MaybePowerFail(nand_chunk,3);
 224
 225         return retval;
 226 }
 227
 228 static int yflash2_ReadChunk(struct yaffs_dev *dev, int nand_chunk,
 229                                    u8 *data, int data_len,
 230                                    u8 *oob, int oob_len,
 231                                    enum yaffs_ecc_result *ecc_result)
 232 {
 233         int retval = YAFFS_OK;
 234         int pos;
 235         int h;
 236         int nread;
 237
 238         (void) dev;
 239
 240         if (data && data_len) {
 241                 pos = (nand_chunk % (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE)) * PAGE_SIZE;
 242                 h = filedisk.handle[(nand_chunk / (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE))];
 243                 lseek(h,pos,SEEK_SET);
 244                 nread = read(h,data,data_len);
 245                 if(nread != data_len)
 246                         retval = YAFFS_FAIL;
 247         }
 248
 249         if (oob && oob_len) {
 250                 pos = (nand_chunk % (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE)) * PAGE_SIZE + PAGE_DATA_SIZE;
 251                 h = filedisk.handle[(nand_chunk / (PAGES_PER_BLOCK * BLOCKS_PER_HANDLE))];
 252                 lseek(h,pos,SEEK_SET);
 253                 nread = read(h,oob,oob_len);
 254                 if(nread != oob_len)
 255                         retval = YAFFS_FAIL;
 256         }
 257
 258         if (ecc_result)
 259                 *ecc_result = YAFFS_ECC_RESULT_NO_ERROR;
 260
 261         return retval;
 262 }
 263
 264 static int yflash2_EraseBlock(struct yaffs_dev *dev, int block_no)
 265 {
 266         u32 i;
 267         int h;
 268
 269         CheckInit();
 270
 271         if(block_no < 0 || block_no >= filedisk.nBlocks)
 272         {
 273                 yaffs_trace(YAFFS_TRACE_ALWAYS,"Attempt to erase non-existant block %d",block_no);
 274                 return YAFFS_FAIL;
 275         }
 276         else
 277         {
 278
 279                 u8 pg[PAGE_SIZE];
 280                 int syz = PAGE_SIZE;
 281
 282                 memset(pg,0xff,syz);
 283
 284                 h = filedisk.handle[(block_no / ( BLOCKS_PER_HANDLE))];
 285                 lseek(h,((block_no % BLOCKS_PER_HANDLE) * dev->param.chunks_per_block) * PAGE_SIZE, SEEK_SET);
 286                 for(i = 0; i < dev->param.chunks_per_block; i++)
 287                         write(h,pg,PAGE_SIZE);
 288
 289                 return YAFFS_OK;
 290         }
 291 }
 292
 293 static int yflash2_MarkBad(struct yaffs_dev *dev, int block_no)
 294 {
 295         int written;
 296         int h;
 297
 298         struct yaffs_packed_tags2 pt;
 299
 300         CheckInit();
 301
 302         memset(&pt,0,sizeof(pt));
 303         h = filedisk.handle[(block_no / ( BLOCKS_PER_HANDLE))];
 304         lseek(h,((block_no % BLOCKS_PER_HANDLE) * dev->param.chunks_per_block) * PAGE_SIZE + PAGE_DATA_SIZE,SEEK_SET);
 305         written = write(h,&pt,sizeof(pt));
 306
 307         if(written != sizeof(pt))
 308                 return YAFFS_FAIL;
 309
 310         return YAFFS_OK;
 311
 312 }
 313
 314 static int yflash2_CheckBad(struct yaffs_dev *dev, int block_no)
 315 {
 316         YAFFS_UNUSED(dev);
 317         YAFFS_UNUSED(block_no);
 318
 319         return YAFFS_OK;
 320 }
 321
 322 static int yflash2_Initialise(struct yaffs_dev *dev)
 323 {
 324         (void) dev;
 325
 326         CheckInit();
 327
 328         return YAFFS_OK;
 329 }
 330
 331 struct yaffs_dev *yflash2_install_drv(const char *name)
 332 {
 333         struct yaffs_dev *dev = NULL;
 334         struct yaffs_param *param;
 335         struct yaffs_driver *drv;
 336
 337         dev = malloc(sizeof(*dev));
 338
 339         if(!dev)
 340                 return NULL;
 341
 342         memset(dev, 0, sizeof(*dev));
 343
 344         dev->param.name = strdup(name);
 345
 346         if(!dev->param.name) {
 347                 free(dev);
 348                 return NULL;
 349         }
 350
 351         drv = &dev->drv;
 352
 353         drv->drv_write_chunk_fn = yflash2_WriteChunk;
 354         drv->drv_read_chunk_fn = yflash2_ReadChunk;
 355         drv->drv_erase_fn = yflash2_EraseBlock;
 356         drv->drv_mark_bad_fn = yflash2_MarkBad;
 357         drv->drv_check_bad_fn = yflash2_CheckBad;
 358         drv->drv_initialise_fn = yflash2_Initialise;
 359
 360         param = &dev->param;
 361
 362         param->total_bytes_per_chunk = 2048;
 363         param->chunks_per_block = 64;
 364         param->start_block = 0;
 365         param->end_block = yflash2_GetNumberOfBlocks()-1;
 366         param->is_yaffs2 = 1;
 367         param->use_nand_ecc=1;
 368
 369         param->n_reserved_blocks = 5;
 370         param->wide_tnodes_disabled=0;
 371         param->refresh_period = 1000;
 372         param->n_caches = 10; // Use caches
 373
 374         param->enable_xattr = 1;
 375
 376         /* dev->driver_context is not used by this simulator */
 377
 378         yaffs_add_device(dev);
 379
 380         return dev;
 381 }