direct/basic-test/yaffs_norif1.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 /*
  15  * This is an interface module for handling NOR in yaffs1 mode.
  16  */
  17
  18 /* First set up for M18 with 1k chunks and 16-byte spares.
  19  *
  20  * NB We're using the oddball M18 modes of operation here
  21  * The chip is 64MB based at 0x0000, but YAFFS only going to use the top half
  22  * ie. YAFFS will be from 32MB to 64MB.
  23  *
  24  * The M18 has two ways of writing data. Every Programming Region (1kbytes)
  25  * can be programmed in two modes:
  26  * * Object Mode 1024 bytes of write once data.
  27  * * Control Mode: 512bytes of bit-writeable data.
  28  *    This is arranged as 32 * (16 bytes of bit-writable followed by 16 bytes of "dont touch")
  29  *
  30  * The block size is 256kB, making 128 blocks in the 32MB YAFFS area.
  31  * Each block comprises:
  32  *   Offset   0k: 248 x 1k data pages
  33  *   Offset 248k: 248 x 32-byte spare areas implemented as 16 bytes of spare followed by 16 bytes untouched)
  34  *   Offset 248k + (248 * 32): Format marker
  35  *
  36  */
  37
  38 const char *yaffs_norif1_c_version = "$Id: yaffs_norif1.c,v 1.6 2010-02-18 01:18:04 charles Exp $";
  39
  40 #include "yaffs_norif1.h"
  41
  42 #include "yportenv.h"
  43 #include "yaffs_trace.h"
  44
  45 #include "yaffs_flashif.h"
  46 #include "yaffs_guts.h"
  47
  48 #include "devextras.h"
  49
  50 #define SPARE_BYTES_PER_CHUNK   16
  51 #define M18_SKIP                16
  52 #define PROG_REGION_SIZE        1024
  53 #define BLOCK_SIZE_IN_BYTES     (256*1024)
  54 #define CHUNKS_PER_BLOCK        248
  55 #define SPARE_AREA_OFFSET       (CHUNKS_PER_BLOCK * PROG_REGION_SIZE)
  56
  57 #define FORMAT_OFFSET           (SPARE_AREA_OFFSET + CHUNKS_PER_BLOCK * (SPARE_BYTES_PER_CHUNK + M18_SKIP))
  58
  59 #define FORMAT_VALUE            0x1234
  60
  61 #define DATA_BYTES_PER_CHUNK    1024
  62 #define BLOCKS_IN_DEVICE        (8*1024/256)
  63
  64
  65 #define YNOR_PREMARKER          (0xF6)
  66 #define YNOR_POSTMARKER         (0xF0)
  67
  68
  69 #if 1
  70
  71 /* Compile this for a simulation */
  72 #include "ynorsim.h"
  73 #define ynorif1_FlashInit() ynorsim_Initialise()
  74 #define ynorif1_FlashDeinit() ynorsim_Shutdown()
  75 #define ynorif1_FlashWrite32(addr,buf,nwords) ynorsim_Write32(addr,buf,nwords)
  76 #define ynorif1_FlashRead32(addr,buf,nwords) ynorsim_Read32(addr,buf,nwords)
  77 #define ynorif1_FlashEraseBlock(addr) ynorsim_EraseBlock(addr)
  78 #define DEVICE_BASE     ynorsim_GetBase()
  79 #else
  80
  81 /* Compile this for running on blob, hacked for yaffs access */
  82 #include "../blob/yflashrw.h"
  83 #define ynorif1_FlashInit()  do{} while(0)
  84 #define ynorif1_FlashDeinit() do {} while(0)
  85 #define ynorif1_FlashWrite32(addr,buf,nwords) Y_FlashWrite(addr,buf,nwords)
  86 #define ynorif1_FlashRead32(addr,buf,nwords)  Y_FlashRead(addr,buf,nwords)
  87 #define ynorif1_FlashEraseBlock(addr)         Y_FlashErase(addr,BLOCK_SIZE_IN_BYTES)
  88 #define DEVICE_BASE     (32 * 1024 * 1024)
  89 #endif
  90
  91 __u32 *Block2Addr(yaffs_Device *dev, int blockNumber)
  92 {
  93         __u32 addr;
  94         dev=dev;
  95
  96         addr = (__u32) DEVICE_BASE;
  97         addr += blockNumber * BLOCK_SIZE_IN_BYTES;
  98
  99         return (__u32 *) addr;
 100 }
 101
 102 __u32 *Block2FormatAddr(yaffs_Device *dev,int blockNumber)
 103 {
 104         __u32 addr;
 105
 106         addr = (__u32) Block2Addr(dev,blockNumber);
 107         addr += FORMAT_OFFSET;
 108
 109         return (__u32 *)addr;
 110 }
 111 __u32 *Chunk2DataAddr(yaffs_Device *dev,int chunkId)
 112 {
 113         unsigned block;
 114         unsigned chunkInBlock;
 115         __u32  addr;
 116
 117         block = chunkId/dev->param.nChunksPerBlock;
 118         chunkInBlock = chunkId % dev->param.nChunksPerBlock;
 119
 120         addr = (__u32) Block2Addr(dev,block);
 121         addr += chunkInBlock * DATA_BYTES_PER_CHUNK;
 122
 123         return (__u32 *)addr;
 124 }
 125
 126 __u32 *Chunk2SpareAddr(yaffs_Device *dev,int chunkId)
 127 {
 128         unsigned block;
 129         unsigned chunkInBlock;
 130         __u32 addr;
 131
 132         block = chunkId/dev->param.nChunksPerBlock;
 133         chunkInBlock = chunkId % dev->param.nChunksPerBlock;
 134
 135         addr = (__u32) Block2Addr(dev,block);
 136         addr += SPARE_AREA_OFFSET;
 137         addr += chunkInBlock * (SPARE_BYTES_PER_CHUNK + M18_SKIP);
 138         return (__u32 *)addr;
 139 }
 140
 141
 142 void ynorif1_AndBytes(__u8*target, const __u8   *src, int nbytes)
 143 {
 144         while(nbytes > 0){
 145                 *target &= *src;
 146                 target++;
 147                 src++;
 148                 nbytes--;
 149         }
 150 }
 151
 152 int ynorif1_WriteChunkToNAND(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_Spare *spare)
 153 {
 154         __u32 *dataAddr = Chunk2DataAddr(dev,chunkInNAND);
 155         __u32 *spareAddr = Chunk2SpareAddr(dev,chunkInNAND);
 156
 157         yaffs_Spare tmpSpare;
 158
 159         /* We should only be getting called for one of 3 reasons:
 160          * Writing a chunk: data and spare will not be NULL
 161          * Writing a deletion marker: data will be NULL, spare not NULL
 162          * Writing a bad block marker: data will be NULL, spare not NULL
 163          */
 164
 165         if(sizeof(yaffs_Spare) != 16)
 166                 YBUG();
 167
 168         if(data && spare)
 169         {
 170                 if(spare->pageStatus != 0xff)
 171                         YBUG();
 172                 /* Write a pre-marker */
 173                 memset(&tmpSpare,0xff,sizeof(tmpSpare));
 174                 tmpSpare.pageStatus = YNOR_PREMARKER;
 175                 ynorif1_FlashWrite32(spareAddr,(__u32 *)&tmpSpare,sizeof(yaffs_Spare)/4);
 176
 177                 /* Write the data */
 178                 ynorif1_FlashWrite32(dataAddr,(__u32 *)data,dev->param.totalBytesPerChunk / 4);
 179
 180
 181                 memcpy(&tmpSpare,spare,sizeof(yaffs_Spare));
 182
 183                 /* Write the real tags, but override the premarker*/
 184                 tmpSpare.pageStatus = YNOR_PREMARKER;
 185                 ynorif1_FlashWrite32(spareAddr,(__u32 *)&tmpSpare,sizeof(yaffs_Spare)/4);
 186
 187                 /* Write a post-marker */
 188                 tmpSpare.pageStatus = YNOR_POSTMARKER;
 189                 ynorif1_FlashWrite32(spareAddr,(__u32 *)&tmpSpare,sizeof(tmpSpare)/4);
 190
 191         } else if(spare){
 192                 /* This has to be a read-modify-write operation to handle NOR-ness */
 193
 194                 ynorif1_FlashRead32(spareAddr,(__u32 *)&tmpSpare,16/ 4);
 195
 196                 ynorif1_AndBytes((__u8 *)&tmpSpare,(__u8 *)spare,sizeof(yaffs_Spare));
 197
 198                 ynorif1_FlashWrite32(spareAddr,(__u32 *)&tmpSpare,16/ 4);
 199         }
 200         else {
 201                 YBUG();
 202         }
 203
 204
 205         return YAFFS_OK;
 206
 207 }
 208
 209 int ynorif1_ReadChunkFromNAND(yaffs_Device *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare)
 210 {
 211
 212         __u32 *dataAddr = Chunk2DataAddr(dev,chunkInNAND);
 213         __u32 *spareAddr = Chunk2SpareAddr(dev,chunkInNAND);
 214
 215         if(data)
 216         {
 217                 ynorif1_FlashRead32(dataAddr,(__u32 *)data,dev->param.totalBytesPerChunk / 4);
 218         }
 219
 220         if(spare)
 221         {
 222                 ynorif1_FlashRead32(spareAddr,(__u32 *)spare,16/ 4);
 223
 224                 /* If the page status is YNOR_POSTMARKER then it was written properly
 225                  * so change that to 0xFF so that the rest of yaffs is happy.
 226                  */
 227                 if(spare->pageStatus == YNOR_POSTMARKER)
 228                         spare->pageStatus = 0xFF;
 229                 else if(spare->pageStatus != 0xff &&
 230                         (spare->pageStatus | YNOR_PREMARKER) != 0xff)
 231                         spare->pageStatus = YNOR_PREMARKER;
 232         }
 233
 234
 235         return YAFFS_OK;
 236
 237 }
 238
 239 static int ynorif1_FormatBlock(yaffs_Device *dev, int blockNumber)
 240 {
 241         __u32 *blockAddr = Block2Addr(dev,blockNumber);
 242         __u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
 243         __u32 formatValue = FORMAT_VALUE;
 244
 245         ynorif1_FlashEraseBlock(blockAddr);
 246         ynorif1_FlashWrite32(formatAddr,&formatValue,1);
 247
 248         return YAFFS_OK;
 249 }
 250
 251 static int ynorif1_UnformatBlock(yaffs_Device *dev, int blockNumber)
 252 {
 253         __u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
 254         __u32 formatValue = 0;
 255
 256         ynorif1_FlashWrite32(formatAddr,&formatValue,1);
 257
 258         return YAFFS_OK;
 259 }
 260
 261 static int ynorif1_IsBlockFormatted(yaffs_Device *dev, int blockNumber)
 262 {
 263         __u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
 264         __u32 formatValue;
 265
 266
 267         ynorif1_FlashRead32(formatAddr,&formatValue,1);
 268
 269         return (formatValue == FORMAT_VALUE);
 270 }
 271
 272 int ynorif1_EraseBlockInNAND(yaffs_Device *dev, int blockNumber)
 273 {
 274
 275         if(blockNumber < 0 || blockNumber >= BLOCKS_IN_DEVICE)
 276         {
 277                 T(YAFFS_TRACE_ALWAYS,("Attempt to erase non-existant block %d\n",blockNumber));
 278                 return YAFFS_FAIL;
 279         }
 280         else
 281         {
 282                 ynorif1_UnformatBlock(dev,blockNumber);
 283                 ynorif1_FormatBlock(dev,blockNumber);
 284                 return YAFFS_OK;
 285         }
 286
 287 }
 288
 289 int ynorif1_InitialiseNAND(yaffs_Device *dev)
 290 {
 291         int i;
 292
 293         ynorif1_FlashInit();
 294         /* Go through the blocks formatting them if they are not formatted */
 295         for(i = dev->param.startBlock; i <= dev->param.endBlock; i++){
 296                 if(!ynorif1_IsBlockFormatted(dev,i)){
 297                         ynorif1_FormatBlock(dev,i);
 298                 }
 299         }
 300         return YAFFS_OK;
 301 }
 302
 303 int ynorif1_DeinitialiseNAND(yaffs_Device *dev)
 304 {
 305         dev=dev;
 306         ynorif1_FlashDeinit();
 307
 308         return YAFFS_OK;
 309 }
 310
 311