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.
16 #include "yaffs_mtdif.h"
18 #include "linux/mtd/mtd.h"
19 #include "linux/types.h"
20 #include "linux/time.h"
21 #include "linux/mtd/nand.h"
22 #include "linux/kernel.h"
23 #include "linux/version.h"
24 #include "linux/types.h"
26 #include "yaffs_trace.h"
27 #include "yaffs_guts.h"
28 #include "yaffs_linux.h"
31 #if (LINUX_VERSION_CODE < KERNEL_VERSION(3, 2, 0))
32 #define MTD_OPS_AUTO_OOB MTD_OOB_AUTO
36 #if (LINUX_VERSION_CODE < KERNEL_VERSION(3, 4, 0))
37 #define mtd_erase(m, ei) (m)->erase(m, ei)
38 #define mtd_write_oob(m, addr, pops) (m)->write_oob(m, addr, pops)
39 #define mtd_read_oob(m, addr, pops) (m)->read_oob(m, addr, pops)
40 #define mtd_block_isbad(m, offs) (m)->block_isbad(m, offs)
41 #define mtd_block_markbad(m, offs) (m)->block_markbad(m, offs)
46 int nandmtd_erase_block(struct yaffs_dev *dev, int block_no)
48 struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
50 ((loff_t) block_no) * dev->param.total_bytes_per_chunk *
51 dev->param.chunks_per_block;
57 ei.len = dev->param.total_bytes_per_chunk * dev->param.chunks_per_block;
61 ei.priv = (u_long) dev;
63 retval = mtd_erase(mtd, &ei);
72 static int yaffs_mtd_write(struct yaffs_dev *dev, int nand_chunk,
73 const u8 *data, int data_len,
74 const u8 *oob, int oob_len)
76 struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
78 struct mtd_oob_ops ops;
81 addr = ((loff_t) nand_chunk) * dev->param.total_bytes_per_chunk;
82 memset(&ops, 0, sizeof(ops));
83 ops.mode = MTD_OPS_AUTO_OOB;
84 ops.len = (data) ? data_len : 0;
86 ops.datbuf = (u8 *)data;
87 ops.oobbuf = (u8 *)oob;
89 retval = mtd_write_oob(mtd, addr, &ops);
91 yaffs_trace(YAFFS_TRACE_MTD,
92 "write_oob failed, chunk %d, mtd error %d",
95 return retval ? YAFFS_FAIL : YAFFS_OK;
98 static int yaffs_mtd_read(struct yaffs_dev *dev, int nand_chunk,
99 u8 *data, int data_len,
100 u8 *oob, int oob_len,
101 enum yaffs_ecc_result *ecc_result)
103 struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
105 struct mtd_oob_ops ops;
108 addr = ((loff_t) nand_chunk) * dev->data_bytes_per_chunk;
109 memset(&ops, 0, sizeof(ops));
110 ops.mode = MTD_OPS_AUTO_OOB;
111 ops.len = (data) ? data_len : 0;
112 ops.ooblen = oob_len;
116 #if (MTD_VERSION_CODE < MTD_VERSION(2, 6, 20))
117 /* In MTD 2.6.18 to 2.6.19 nand_base.c:nand_do_read_oob() has a bug;
118 * help it out with ops.len = ops.ooblen when ops.datbuf == NULL.
120 ops.len = (ops.datbuf) ? ops.len : ops.ooblen;
122 /* Read page and oob using MTD.
123 * Check status and determine ECC result.
125 retval = mtd_read_oob(mtd, addr, &ops);
127 yaffs_trace(YAFFS_TRACE_MTD,
128 "read_oob failed, chunk %d, mtd error %d",
135 *ecc_result = YAFFS_ECC_RESULT_NO_ERROR;
139 /* MTD's ECC fixed the data */
141 *ecc_result = YAFFS_ECC_RESULT_FIXED;
147 /* MTD's ECC could not fix the data */
148 dev->n_ecc_unfixed++;
150 *ecc_result = YAFFS_ECC_RESULT_UNFIXED;
157 static int yaffs_mtd_erase(struct yaffs_dev *dev, int block_no)
159 struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
162 struct erase_info ei;
166 block_size = dev->param.total_bytes_per_chunk *
167 dev->param.chunks_per_block;
168 addr = ((loff_t) block_no) * block_size;
176 ei.priv = (u_long) dev;
178 retval = mtd_erase(mtd, &ei);
186 static int yaffs_mtd_mark_bad(struct yaffs_dev *dev, int block_no)
188 struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
189 int blocksize = dev->param.chunks_per_block * dev->data_bytes_per_chunk;
192 yaffs_trace(YAFFS_TRACE_BAD_BLOCKS, "marking block %d bad", block_no);
194 retval = mtd_block_markbad(mtd, (loff_t) blocksize * block_no);
195 return (retval) ? YAFFS_FAIL : YAFFS_OK;
198 static int yaffs_mtd_check_bad(struct yaffs_dev *dev, int block_no)
200 struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
201 int blocksize = dev->param.chunks_per_block * dev->data_bytes_per_chunk;
204 yaffs_trace(YAFFS_TRACE_BAD_BLOCKS, "checking block %d bad", block_no);
206 retval = mtd_block_isbad(mtd, (loff_t) blocksize * block_no);
207 return (retval) ? YAFFS_FAIL : YAFFS_OK;
210 static int yaffs_mtd_initialise(struct yaffs_dev *dev)
215 static int yaffs_mtd_deinitialise(struct yaffs_dev *dev)
221 void yaffs_mtd_drv_install(struct yaffs_dev *dev)
223 struct yaffs_driver *drv = &dev->drv;
225 drv->drv_write_chunk_fn = yaffs_mtd_write;
226 drv->drv_read_chunk_fn = yaffs_mtd_read;
227 drv->drv_erase_fn = yaffs_mtd_erase;
228 drv->drv_mark_bad_fn = yaffs_mtd_mark_bad;
229 drv->drv_check_bad_fn = yaffs_mtd_check_bad;
230 drv->drv_initialise_fn = yaffs_mtd_initialise;
231 drv->drv_deinitialise_fn = yaffs_mtd_deinitialise;
235 struct mtd_info * yaffs_get_mtd_device(dev_t sdev)
237 struct mtd_info *mtd;
239 mtd = yaffs_get_mtd_device(sdev);
241 /* Check it's an mtd device..... */
242 if (MAJOR(sdev) != MTD_BLOCK_MAJOR)
243 return NULL; /* This isn't an mtd device */
245 /* Check it's NAND */
246 if (mtd->type != MTD_NANDFLASH) {
247 yaffs_trace(YAFFS_TRACE_ALWAYS,
248 "yaffs: MTD device is not NAND it's type %d",
253 yaffs_trace(YAFFS_TRACE_OS, " %s %d", WRITE_SIZE_STR, WRITE_SIZE(mtd));
254 yaffs_trace(YAFFS_TRACE_OS, " oobsize %d", mtd->oobsize);
255 yaffs_trace(YAFFS_TRACE_OS, " erasesize %d", mtd->erasesize);
256 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 29)
257 yaffs_trace(YAFFS_TRACE_OS, " size %u", mtd->size);
259 yaffs_trace(YAFFS_TRACE_OS, " size %lld", mtd->size);
265 int yaffs_verify_mtd(struct mtd_info *mtd, int yaffs_version, int inband_tags)
267 if (yaffs_version == 2) {
268 if ((WRITE_SIZE(mtd) < YAFFS_MIN_YAFFS2_CHUNK_SIZE ||
269 mtd->oobsize < YAFFS_MIN_YAFFS2_SPARE_SIZE) &&
271 yaffs_trace(YAFFS_TRACE_ALWAYS,
272 "MTD device does not have the right page sizes"
277 if (WRITE_SIZE(mtd) < YAFFS_BYTES_PER_CHUNK ||
278 mtd->oobsize != YAFFS_BYTES_PER_SPARE) {
279 yaffs_trace(YAFFS_TRACE_ALWAYS,
280 "MTD device does not support have the right page sizes"
290 void yaffs_put_mtd_device(struct mtd_info *mtd)