2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2011 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 #define SPARE_BYTES_PER_CHUNK 16
50 #define PROG_REGION_SIZE 1024
51 #define BLOCK_SIZE_IN_BYTES (256*1024)
52 #define CHUNKS_PER_BLOCK 248
53 #define SPARE_AREA_OFFSET (CHUNKS_PER_BLOCK * PROG_REGION_SIZE)
55 #define FORMAT_OFFSET (SPARE_AREA_OFFSET + CHUNKS_PER_BLOCK * (SPARE_BYTES_PER_CHUNK + M18_SKIP))
57 #define FORMAT_VALUE 0x1234
59 #define DATA_BYTES_PER_CHUNK 1024
60 #define BLOCKS_IN_DEVICE (8*1024/256)
63 #define YNOR_PREMARKER (0xF6)
64 #define YNOR_POSTMARKER (0xF0)
69 /* Compile this for a simulation */
71 #define ynorif1_FlashInit() ynorsim_initialise()
72 #define ynorif1_FlashDeinit() ynorsim_shutdown()
73 #define ynorif1_FlashWrite32(addr,buf,nwords) ynorsim_wr32(addr,buf,nwords)
74 #define ynorif1_FlashRead32(addr,buf,nwords) ynorsim_rd32(addr,buf,nwords)
75 #define ynorif1_FlashEraseBlock(addr) ynorsim_erase(addr)
76 #define DEVICE_BASE ynorsim_get_base()
79 /* Compile this for running on blob, hacked for yaffs access */
80 #include "../blob/yflashrw.h"
81 #define ynorif1_FlashInit() do{} while(0)
82 #define ynorif1_FlashDeinit() do {} while(0)
83 #define ynorif1_FlashWrite32(addr,buf,nwords) Y_FlashWrite(addr,buf,nwords)
84 #define ynorif1_FlashRead32(addr,buf,nwords) Y_FlashRead(addr,buf,nwords)
85 #define ynorif1_FlashEraseBlock(addr) Y_FlashErase(addr,BLOCK_SIZE_IN_BYTES)
86 #define DEVICE_BASE (32 * 1024 * 1024)
89 static u32 *Block2Addr(struct yaffs_dev *dev, int blockNumber)
94 addr = (u32) DEVICE_BASE;
95 addr += blockNumber * BLOCK_SIZE_IN_BYTES;
100 static u32 *Block2FormatAddr(struct yaffs_dev *dev,int blockNumber)
104 addr = (u32) Block2Addr(dev,blockNumber);
105 addr += FORMAT_OFFSET;
110 static u32 *Chunk2DataAddr(struct yaffs_dev *dev,int chunk_id)
113 unsigned chunkInBlock;
116 block = chunk_id/dev->param.chunks_per_block;
117 chunkInBlock = chunk_id % dev->param.chunks_per_block;
119 addr = (u32) Block2Addr(dev,block);
120 addr += chunkInBlock * DATA_BYTES_PER_CHUNK;
125 static u32 *Chunk2SpareAddr(struct yaffs_dev *dev,int chunk_id)
128 unsigned chunkInBlock;
131 block = chunk_id/dev->param.chunks_per_block;
132 chunkInBlock = chunk_id % dev->param.chunks_per_block;
134 addr = (u32) Block2Addr(dev,block);
135 addr += SPARE_AREA_OFFSET;
136 addr += chunkInBlock * (SPARE_BYTES_PER_CHUNK + M18_SKIP);
141 static void ynorif1_AndBytes(u8*target, const u8 *src, int nbytes)
150 int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
151 const u8 *data, int data_len,
152 const u8 *oob, int oob_len);
153 static int ynorif1_WriteChunkToNAND(struct yaffs_dev *dev,int nand_chunk,
154 const u8 *data, int data_len,
155 const u8 *oob, int oob_len)
157 u32 *dataAddr = Chunk2DataAddr(dev,nand_chunk);
158 u32 *spareAddr = Chunk2SpareAddr(dev,nand_chunk);
160 struct yaffs_spare *spare = (struct yaffs_spare *)oob;
161 struct yaffs_spare tmpSpare;
165 /* We should only be getting called for one of 3 reasons:
166 * Writing a chunk: data and spare will not be NULL
167 * Writing a deletion marker: data will be NULL, spare not NULL
168 * Writing a bad block marker: data will be NULL, spare not NULL
171 if(sizeof(struct yaffs_spare) != 16)
176 if(spare->page_status != 0xff)
178 /* Write a pre-marker */
179 memset(&tmpSpare,0xff,sizeof(tmpSpare));
180 tmpSpare.page_status = YNOR_PREMARKER;
181 ynorif1_FlashWrite32(spareAddr,(u32 *)&tmpSpare,sizeof(struct yaffs_spare)/4);
184 ynorif1_FlashWrite32(dataAddr,(u32 *)data, data_len/ 4);
187 memcpy(&tmpSpare,spare,sizeof(struct yaffs_spare));
189 /* Write the real tags, but override the premarker*/
190 tmpSpare.page_status = YNOR_PREMARKER;
191 ynorif1_FlashWrite32(spareAddr,(u32 *)&tmpSpare,sizeof(struct yaffs_spare)/4);
193 /* Write a post-marker */
194 tmpSpare.page_status = YNOR_POSTMARKER;
195 ynorif1_FlashWrite32(spareAddr,(u32 *)&tmpSpare,sizeof(tmpSpare)/4);
198 /* This has to be a read-modify-write operation to handle NOR-ness */
200 ynorif1_FlashRead32(spareAddr,(u32 *)&tmpSpare,16/ 4);
202 ynorif1_AndBytes((u8 *)&tmpSpare,(u8 *)spare,sizeof(struct yaffs_spare));
204 ynorif1_FlashWrite32(spareAddr,(u32 *)&tmpSpare,16/ 4);
215 static int ynorif1_ReadChunkFromNAND(struct yaffs_dev *dev,int nand_chunk,
216 u8 *data, int data_len,
217 u8 *oob, int oob_len,
218 enum yaffs_ecc_result *ecc_result)
220 struct yaffs_spare *spare = (struct yaffs_spare *)oob;
222 u32 *dataAddr = Chunk2DataAddr(dev,nand_chunk);
223 u32 *spareAddr = Chunk2SpareAddr(dev,nand_chunk);
227 ynorif1_FlashRead32(dataAddr,(u32 *)data,dev->param.total_bytes_per_chunk / 4);
232 ynorif1_FlashRead32(spareAddr,(u32 *)spare, oob_len/ 4);
234 /* If the page status is YNOR_POSTMARKER then it was written properly
235 * so change that to 0xFF so that the rest of yaffs is happy.
237 if(spare->page_status == YNOR_POSTMARKER)
238 spare->page_status = 0xFF;
239 else if(spare->page_status != 0xff &&
240 (spare->page_status | YNOR_PREMARKER) != 0xff)
241 spare->page_status = YNOR_PREMARKER;
245 *ecc_result = YAFFS_ECC_RESULT_NO_ERROR;
252 static int ynorif1_FormatBlock(struct yaffs_dev *dev, int blockNumber)
254 u32 *blockAddr = Block2Addr(dev,blockNumber);
255 u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
256 u32 formatValue = FORMAT_VALUE;
258 ynorif1_FlashEraseBlock(blockAddr);
259 ynorif1_FlashWrite32(formatAddr,&formatValue,1);
264 static int ynorif1_UnformatBlock(struct yaffs_dev *dev, int blockNumber)
266 u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
269 ynorif1_FlashWrite32(formatAddr,&formatValue,1);
274 static int ynorif1_IsBlockFormatted(struct yaffs_dev *dev, int blockNumber)
276 u32 *formatAddr = Block2FormatAddr(dev,blockNumber);
280 ynorif1_FlashRead32(formatAddr,&formatValue,1);
282 return (formatValue == FORMAT_VALUE);
285 static int ynorif1_EraseBlockInNAND(struct yaffs_dev *dev, int blockNumber)
288 if(blockNumber < 0 || blockNumber >= BLOCKS_IN_DEVICE)
290 yaffs_trace(YAFFS_TRACE_ALWAYS,
291 "Attempt to erase non-existant block %d\n",
297 ynorif1_UnformatBlock(dev,blockNumber);
298 ynorif1_FormatBlock(dev,blockNumber);
304 static int ynorif1_InitialiseNAND(struct yaffs_dev *dev)
309 /* Go through the blocks formatting them if they are not formatted */
310 for(i = dev->param.start_block; i <= dev->param.end_block; i++){
311 if(!ynorif1_IsBlockFormatted(dev,i)){
312 ynorif1_FormatBlock(dev,i);
318 static int ynorif1_Deinitialise_flash_fn(struct yaffs_dev *dev)
321 ynorif1_FlashDeinit();
326 void ynorif1_install_drv(struct yaffs_dev *dev)
328 struct yaffs_param *param = &dev->param;
330 param->total_bytes_per_chunk = 1024;
331 param->chunks_per_block =248;
332 param->n_reserved_blocks = 2;
333 param->start_block = 0; // Can use block 0
334 param->end_block = 31; // Last block
335 param->use_nand_ecc = 0; // use YAFFS's ECC
336 param->drv_write_chunk_fn = ynorif1_WriteChunkToNAND;
337 param->drv_read_chunk_fn = ynorif1_ReadChunkFromNAND;
338 param->drv_erase_fn = ynorif1_EraseBlockInNAND;
339 param->drv_initialise_fn = ynorif1_InitialiseNAND;
340 param->drv_deinitialise_fn = ynorif1_Deinitialise_flash_fn;