2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2010 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
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.
15 * This is an interface module for handling NOR in yaffs1 mode.
18 /* First set up for M18 with 1k chunks and 16-byte spares.
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.
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")
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
38 const char *yaffs_norif1_c_version = "$Id: yaffs_norif1.c,v 1.6 2010-02-18 01:18:04 charles Exp $";
40 #include "yaffs_norif1.h"
43 #include "yaffs_trace.h"
45 #include "yaffs_flashif.h"
46 #include "yaffs_guts.h"
48 #include "devextras.h"
50 #define SPARE_BYTES_PER_CHUNK 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)
57 #define FORMAT_OFFSET (SPARE_AREA_OFFSET + CHUNKS_PER_BLOCK * (SPARE_BYTES_PER_CHUNK + M18_SKIP))
59 #define FORMAT_VALUE 0x1234
61 #define DATA_BYTES_PER_CHUNK 1024
62 #define BLOCKS_IN_DEVICE (8*1024/256)
65 #define YNOR_PREMARKER (0xF6)
66 #define YNOR_POSTMARKER (0xF0)
71 /* Compile this for a simulation */
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()
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)
91 __u32 *Block2Addr(yaffs_Device *dev, int blockNumber)
95 addr = (__u32) DEVICE_BASE;
96 addr += blockNumber * BLOCK_SIZE_IN_BYTES;
98 return (__u32 *) addr;
101 __u32 *Block2FormatAddr(yaffs_Device *dev,int blockNumber)
105 addr = (__u32) Block2Addr(dev,blockNumber);
106 addr += FORMAT_OFFSET;
108 return (__u32 *)addr;
110 __u32 *Chunk2DataAddr(yaffs_Device *dev,int chunkId)
113 unsigned chunkInBlock;
116 block = chunkId/dev->param.nChunksPerBlock;
117 chunkInBlock = chunkId % dev->param.nChunksPerBlock;
119 addr = (__u32) Block2Addr(dev,block);
120 addr += chunkInBlock * DATA_BYTES_PER_CHUNK;
122 return (__u32 *)addr;
125 __u32 *Chunk2SpareAddr(yaffs_Device *dev,int chunkId)
128 unsigned chunkInBlock;
131 block = chunkId/dev->param.nChunksPerBlock;
132 chunkInBlock = chunkId % dev->param.nChunksPerBlock;
134 addr = (__u32) Block2Addr(dev,block);
135 addr += SPARE_AREA_OFFSET;
136 addr += chunkInBlock * (SPARE_BYTES_PER_CHUNK + M18_SKIP);
137 return (__u32 *)addr;
141 void ynorif1_AndBytes(__u8*target, const __u8 *src, int nbytes)
151 int ynorif1_WriteChunkToNAND(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_Spare *spare)
153 __u32 *dataAddr = Chunk2DataAddr(dev,chunkInNAND);
154 __u32 *spareAddr = Chunk2SpareAddr(dev,chunkInNAND);
156 yaffs_Spare tmpSpare;
158 /* We should only be getting called for one of 3 reasons:
159 * Writing a chunk: data and spare will not be NULL
160 * Writing a deletion marker: data will be NULL, spare not NULL
161 * Writing a bad block marker: data will be NULL, spare not NULL
164 if(sizeof(yaffs_Spare) != 16)
169 if(spare->pageStatus != 0xff)
171 /* Write a pre-marker */
172 memset(&tmpSpare,0xff,sizeof(tmpSpare));
173 tmpSpare.pageStatus = YNOR_PREMARKER;
174 ynorif1_FlashWrite32(spareAddr,(__u32 *)&tmpSpare,sizeof(yaffs_Spare)/4);
177 ynorif1_FlashWrite32(dataAddr,(__u32 *)data,dev->param.totalBytesPerChunk / 4);
180 memcpy(&tmpSpare,spare,sizeof(yaffs_Spare));
182 /* Write the real tags, but override the premarker*/
183 tmpSpare.pageStatus = YNOR_PREMARKER;
184 ynorif1_FlashWrite32(spareAddr,(__u32 *)&tmpSpare,sizeof(yaffs_Spare)/4);
186 /* Write a post-marker */
187 tmpSpare.pageStatus = YNOR_POSTMARKER;
188 ynorif1_FlashWrite32(spareAddr,(__u32 *)&tmpSpare,sizeof(tmpSpare)/4);
191 /* This has to be a read-modify-write operation to handle NOR-ness */
193 ynorif1_FlashRead32(spareAddr,(__u32 *)&tmpSpare,16/ 4);
195 ynorif1_AndBytes((__u8 *)&tmpSpare,(__u8 *)spare,sizeof(yaffs_Spare));
197 ynorif1_FlashWrite32(spareAddr,(__u32 *)&tmpSpare,16/ 4);
208 int ynorif1_ReadChunkFromNAND(yaffs_Device *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare)
211 __u32 *dataAddr = Chunk2DataAddr(dev,chunkInNAND);
212 __u32 *spareAddr = Chunk2SpareAddr(dev,chunkInNAND);
216 ynorif1_FlashRead32(dataAddr,(__u32 *)data,dev->param.totalBytesPerChunk / 4);
221 ynorif1_FlashRead32(spareAddr,(__u32 *)spare,16/ 4);
223 /* If the page status is YNOR_POSTMARKER then it was written properly
224 * so change that to 0xFF so that the rest of yaffs is happy.
226 if(spare->pageStatus == YNOR_POSTMARKER)
227 spare->pageStatus = 0xFF;
228 else if(spare->pageStatus != 0xff &&
229 (spare->pageStatus | YNOR_PREMARKER) != 0xff)
230 spare->pageStatus = YNOR_PREMARKER;
238 static int ynorif1_FormatBlock(yaffs_Device *dev, int blockNumber)
240 __u32 *blockAddr = Block2Addr(dev,blockNumber);
241 __u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
242 __u32 formatValue = FORMAT_VALUE;
244 ynorif1_FlashEraseBlock(blockAddr);
245 ynorif1_FlashWrite32(formatAddr,&formatValue,1);
250 static int ynorif1_UnformatBlock(yaffs_Device *dev, int blockNumber)
252 __u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
253 __u32 formatValue = 0;
255 ynorif1_FlashWrite32(formatAddr,&formatValue,1);
260 static int ynorif1_IsBlockFormatted(yaffs_Device *dev, int blockNumber)
262 __u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
266 ynorif1_FlashRead32(formatAddr,&formatValue,1);
268 return (formatValue == FORMAT_VALUE);
271 int ynorif1_EraseBlockInNAND(yaffs_Device *dev, int blockNumber)
274 if(blockNumber < 0 || blockNumber >= BLOCKS_IN_DEVICE)
276 T(YAFFS_TRACE_ALWAYS,("Attempt to erase non-existant block %d\n",blockNumber));
281 ynorif1_UnformatBlock(dev,blockNumber);
282 ynorif1_FormatBlock(dev,blockNumber);
288 int ynorif1_InitialiseNAND(yaffs_Device *dev)
293 /* Go through the blocks formatting them if they are not formatted */
294 for(i = dev->param.startBlock; i <= dev->param.endBlock; i++){
295 if(!ynorif1_IsBlockFormatted(dev,i)){
296 ynorif1_FormatBlock(dev,i);
302 int ynorif1_DeinitialiseNAND(yaffs_Device *dev)
305 ynorif1_FlashDeinit();