yaffs_mtdif2_single.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 /* mtd interface for YAFFS2 */
  15
  16 #include "yportenv.h"
  17 #include "yaffs_trace.h"
  18
  19 #include "yaffs_mtdif2.h"
  20
  21 #include "linux/mtd/mtd.h"
  22 #include "linux/types.h"
  23 #include "linux/time.h"
  24
  25 #include "yaffs_packedtags2.h"
  26
  27 #include "yaffs_linux.h"
  28
  29 /* NB For use with inband tags....
  30  * We assume that the data buffer is of size total_bytes_per_chunk so that we can also
  31  * use it to load the tags.
  32  */
  33 int nandmtd2_write_chunk_tags(struct yaffs_dev *dev, int nand_chunk,
  34                               const u8 * data,
  35                               const struct yaffs_ext_tags *tags)
  36 {
  37         struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
  38         struct mtd_oob_ops ops;
  39         int retval = 0;
  40
  41         loff_t addr;
  42
  43         struct yaffs_packed_tags2 pt;
  44
  45         int packed_tags_size =
  46             dev->param.no_tags_ecc ? sizeof(pt.t) : sizeof(pt);
  47         void *packed_tags_ptr =
  48             dev->param.no_tags_ecc ? (void *)&pt.t : (void *)&pt;
  49
  50         T(YAFFS_TRACE_MTD,
  51           (TSTR
  52            ("nandmtd2_write_chunk_tags chunk %d data %p tags %p"
  53             TENDSTR), nand_chunk, data, tags));
  54
  55         addr = ((loff_t) nand_chunk) * dev->param.total_bytes_per_chunk;
  56
  57         /* For yaffs2 writing there must be both data and tags.
  58          * If we're using inband tags, then the tags are stuffed into
  59          * the end of the data buffer.
  60          */
  61         if (!data || !tags)
  62                 BUG();
  63         else if (dev->param.inband_tags) {
  64                 struct yaffs_packed_tags2_tags_only *pt2tp;
  65                 pt2tp =
  66                     (struct yaffs_packed_tags2_tags_only *)(data +
  67                                                             dev->
  68                                                             data_bytes_per_chunk);
  69                 yaffs_pack_tags2_tags_only(pt2tp, tags);
  70         } else
  71                 yaffs_pack_tags2(&pt, tags, !dev->param.no_tags_ecc);
  72
  73         ops.mode = MTD_OOB_AUTO;
  74         ops.ooblen = (dev->param.inband_tags) ? 0 : packed_tags_size;
  75         ops.len = dev->param.total_bytes_per_chunk;
  76         ops.ooboffs = 0;
  77         ops.datbuf = (u8 *) data;
  78         ops.oobbuf = (dev->param.inband_tags) ? NULL : packed_tags_ptr;
  79         retval = mtd->write_oob(mtd, addr, &ops);
  80
  81         if (retval == 0)
  82                 return YAFFS_OK;
  83         else
  84                 return YAFFS_FAIL;
  85 }
  86
  87 int nandmtd2_read_chunk_tags(struct yaffs_dev *dev, int nand_chunk,
  88                              u8 * data, struct yaffs_ext_tags *tags)
  89 {
  90         struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
  91         struct mtd_oob_ops ops;
  92
  93         size_t dummy;
  94         int retval = 0;
  95         int local_data = 0;
  96
  97         loff_t addr = ((loff_t) nand_chunk) * dev->param.total_bytes_per_chunk;
  98
  99         struct yaffs_packed_tags2 pt;
 100
 101         int packed_tags_size =
 102             dev->param.no_tags_ecc ? sizeof(pt.t) : sizeof(pt);
 103         void *packed_tags_ptr =
 104             dev->param.no_tags_ecc ? (void *)&pt.t : (void *)&pt;
 105
 106         T(YAFFS_TRACE_MTD,
 107           (TSTR
 108            ("nandmtd2_read_chunk_tags chunk %d data %p tags %p"
 109             TENDSTR), nand_chunk, data, tags));
 110
 111         if (dev->param.inband_tags) {
 112
 113                 if (!data) {
 114                         local_data = 1;
 115                         data = yaffs_get_temp_buffer(dev, __LINE__);
 116                 }
 117
 118         }
 119
 120         if (dev->param.inband_tags || (data && !tags))
 121                 retval = mtd->read(mtd, addr, dev->param.total_bytes_per_chunk,
 122                                    &dummy, data);
 123         else if (tags) {
 124                 ops.mode = MTD_OOB_AUTO;
 125                 ops.ooblen = packed_tags_size;
 126                 ops.len = data ? dev->data_bytes_per_chunk : packed_tags_size;
 127                 ops.ooboffs = 0;
 128                 ops.datbuf = data;
 129                 ops.oobbuf = yaffs_dev_to_lc(dev)->spare_buffer;
 130                 retval = mtd->read_oob(mtd, addr, &ops);
 131         }
 132
 133         if (dev->param.inband_tags) {
 134                 if (tags) {
 135                         struct yaffs_packed_tags2_tags_only *pt2tp;
 136                         pt2tp =
 137                             (struct yaffs_packed_tags2_tags_only *)&data[dev->
 138                                                                          data_bytes_per_chunk];
 139                         yaffs_unpack_tags2_tags_only(tags, pt2tp);
 140                 }
 141         } else {
 142                 if (tags) {
 143                         memcpy(packed_tags_ptr,
 144                                yaffs_dev_to_lc(dev)->spare_buffer,
 145                                packed_tags_size);
 146                         yaffs_unpack_tags2(tags, &pt, !dev->param.no_tags_ecc);
 147                 }
 148         }
 149
 150         if (local_data)
 151                 yaffs_release_temp_buffer(dev, data, __LINE__);
 152
 153         if (tags && retval == -EBADMSG
 154             && tags->ecc_result == YAFFS_ECC_RESULT_NO_ERROR) {
 155                 tags->ecc_result = YAFFS_ECC_RESULT_UNFIXED;
 156                 dev->n_ecc_unfixed++;
 157         }
 158         if (tags && retval == -EUCLEAN
 159             && tags->ecc_result == YAFFS_ECC_RESULT_NO_ERROR) {
 160                 tags->ecc_result = YAFFS_ECC_RESULT_FIXED;
 161                 dev->n_ecc_fixed++;
 162         }
 163         if (retval == 0)
 164                 return YAFFS_OK;
 165         else
 166                 return YAFFS_FAIL;
 167 }
 168
 169 int nandmtd2_mark_block_bad(struct yaffs_dev *dev, int block_no)
 170 {
 171         struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
 172         int retval;
 173         T(YAFFS_TRACE_MTD,
 174           (TSTR("nandmtd2_mark_block_bad %d" TENDSTR), block_no));
 175
 176         retval =
 177             mtd->block_markbad(mtd,
 178                                block_no * dev->param.chunks_per_block *
 179                                dev->param.total_bytes_per_chunk);
 180
 181         if (retval == 0)
 182                 return YAFFS_OK;
 183         else
 184                 return YAFFS_FAIL;
 185
 186 }
 187
 188 int nandmtd2_query_block(struct yaffs_dev *dev, int block_no,
 189                          enum yaffs_block_state *state, u32 * seq_number)
 190 {
 191         struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
 192         int retval;
 193
 194         T(YAFFS_TRACE_MTD, (TSTR("nandmtd2_query_block %d" TENDSTR), block_no));
 195         retval =
 196             mtd->block_isbad(mtd,
 197                              block_no * dev->param.chunks_per_block *
 198                              dev->param.total_bytes_per_chunk);
 199
 200         if (retval) {
 201                 T(YAFFS_TRACE_MTD, (TSTR("block is bad" TENDSTR)));
 202
 203                 *state = YAFFS_BLOCK_STATE_DEAD;
 204                 *seq_number = 0;
 205         } else {
 206                 struct yaffs_ext_tags t;
 207                 nandmtd2_read_chunk_tags(dev, block_no *
 208                                          dev->param.chunks_per_block, NULL, &t);
 209
 210                 if (t.chunk_used) {
 211                         *seq_number = t.seq_number;
 212                         *state = YAFFS_BLOCK_STATE_NEEDS_SCANNING;
 213                 } else {
 214                         *seq_number = 0;
 215                         *state = YAFFS_BLOCK_STATE_EMPTY;
 216                 }
 217         }
 218         T(YAFFS_TRACE_MTD,
 219           (TSTR("block is bad seq %d state %d" TENDSTR), *seq_number, *state));
 220
 221         if (retval == 0)
 222                 return YAFFS_OK;
 223         else
 224                 return YAFFS_FAIL;
 225 }