drivers/mtd/nand/raw/sm_common.c

   1 /*
   2  * Copyright © 2009 - Maxim Levitsky
   3  * Common routines & support for xD format
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  */
   9 #include <linux/kernel.h>
  10 #include <linux/mtd/rawnand.h>
  11 #include <linux/module.h>
  12 #include <linux/sizes.h>
  13 #include "sm_common.h"
  14
  15 static int oob_sm_ooblayout_ecc(struct mtd_info *mtd, int section,
  16                                 struct mtd_oob_region *oobregion)
  17 {
  18         if (section > 1)
  19                 return -ERANGE;
  20
  21         oobregion->length = 3;
  22         oobregion->offset = ((section + 1) * 8) - 3;
  23
  24         return 0;
  25 }
  26
  27 static int oob_sm_ooblayout_free(struct mtd_info *mtd, int section,
  28                                  struct mtd_oob_region *oobregion)
  29 {
  30         switch (section) {
  31         case 0:
  32                 /* reserved */
  33                 oobregion->offset = 0;
  34                 oobregion->length = 4;
  35                 break;
  36         case 1:
  37                 /* LBA1 */
  38                 oobregion->offset = 6;
  39                 oobregion->length = 2;
  40                 break;
  41         case 2:
  42                 /* LBA2 */
  43                 oobregion->offset = 11;
  44                 oobregion->length = 2;
  45                 break;
  46         default:
  47                 return -ERANGE;
  48         }
  49
  50         return 0;
  51 }
  52
  53 static const struct mtd_ooblayout_ops oob_sm_ops = {
  54         .ecc = oob_sm_ooblayout_ecc,
  55         .free = oob_sm_ooblayout_free,
  56 };
  57
  58 /* NOTE: This layout is is not compatabable with SmartMedia, */
  59 /* because the 256 byte devices have page depenent oob layout */
  60 /* However it does preserve the bad block markers */
  61 /* If you use smftl, it will bypass this and work correctly */
  62 /* If you not, then you break SmartMedia compliance anyway */
  63
  64 static int oob_sm_small_ooblayout_ecc(struct mtd_info *mtd, int section,
  65                                       struct mtd_oob_region *oobregion)
  66 {
  67         if (section)
  68                 return -ERANGE;
  69
  70         oobregion->length = 3;
  71         oobregion->offset = 0;
  72
  73         return 0;
  74 }
  75
  76 static int oob_sm_small_ooblayout_free(struct mtd_info *mtd, int section,
  77                                        struct mtd_oob_region *oobregion)
  78 {
  79         switch (section) {
  80         case 0:
  81                 /* reserved */
  82                 oobregion->offset = 3;
  83                 oobregion->length = 2;
  84                 break;
  85         case 1:
  86                 /* LBA1 */
  87                 oobregion->offset = 6;
  88                 oobregion->length = 2;
  89                 break;
  90         default:
  91                 return -ERANGE;
  92         }
  93
  94         return 0;
  95 }
  96
  97 static const struct mtd_ooblayout_ops oob_sm_small_ops = {
  98         .ecc = oob_sm_small_ooblayout_ecc,
  99         .free = oob_sm_small_ooblayout_free,
 100 };
 101
 102 static int sm_block_markbad(struct mtd_info *mtd, loff_t ofs)
 103 {
 104         struct mtd_oob_ops ops;
 105         struct sm_oob oob;
 106         int ret;
 107
 108         memset(&oob, -1, SM_OOB_SIZE);
 109         oob.block_status = 0x0F;
 110
 111         /* As long as this function is called on erase block boundaries
 112                 it will work correctly for 256 byte nand */
 113         ops.mode = MTD_OPS_PLACE_OOB;
 114         ops.ooboffs = 0;
 115         ops.ooblen = mtd->oobsize;
 116         ops.oobbuf = (void *)&oob;
 117         ops.datbuf = NULL;
 118
 119
 120         ret = mtd_write_oob(mtd, ofs, &ops);
 121         if (ret < 0 || ops.oobretlen != SM_OOB_SIZE) {
 122                 pr_notice("sm_common: can't mark sector at %i as bad\n",
 123                           (int)ofs);
 124                 return -EIO;
 125         }
 126
 127         return 0;
 128 }
 129
 130 static struct nand_flash_dev nand_smartmedia_flash_ids[] = {
 131         LEGACY_ID_NAND("SmartMedia 2MiB 3,3V ROM",   0x5d, 2,   SZ_8K, NAND_ROM),
 132         LEGACY_ID_NAND("SmartMedia 4MiB 3,3V",       0xe3, 4,   SZ_8K, 0),
 133         LEGACY_ID_NAND("SmartMedia 4MiB 3,3/5V",     0xe5, 4,   SZ_8K, 0),
 134         LEGACY_ID_NAND("SmartMedia 4MiB 5V",         0x6b, 4,   SZ_8K, 0),
 135         LEGACY_ID_NAND("SmartMedia 4MiB 3,3V ROM",   0xd5, 4,   SZ_8K, NAND_ROM),
 136         LEGACY_ID_NAND("SmartMedia 8MiB 3,3V",       0xe6, 8,   SZ_8K, 0),
 137         LEGACY_ID_NAND("SmartMedia 8MiB 3,3V ROM",   0xd6, 8,   SZ_8K, NAND_ROM),
 138         LEGACY_ID_NAND("SmartMedia 16MiB 3,3V",      0x73, 16,  SZ_16K, 0),
 139         LEGACY_ID_NAND("SmartMedia 16MiB 3,3V ROM",  0x57, 16,  SZ_16K, NAND_ROM),
 140         LEGACY_ID_NAND("SmartMedia 32MiB 3,3V",      0x75, 32,  SZ_16K, 0),
 141         LEGACY_ID_NAND("SmartMedia 32MiB 3,3V ROM",  0x58, 32,  SZ_16K, NAND_ROM),
 142         LEGACY_ID_NAND("SmartMedia 64MiB 3,3V",      0x76, 64,  SZ_16K, 0),
 143         LEGACY_ID_NAND("SmartMedia 64MiB 3,3V ROM",  0xd9, 64,  SZ_16K, NAND_ROM),
 144         LEGACY_ID_NAND("SmartMedia 128MiB 3,3V",     0x79, 128, SZ_16K, 0),
 145         LEGACY_ID_NAND("SmartMedia 128MiB 3,3V ROM", 0xda, 128, SZ_16K, NAND_ROM),
 146         LEGACY_ID_NAND("SmartMedia 256MiB 3, 3V",    0x71, 256, SZ_16K, 0),
 147         LEGACY_ID_NAND("SmartMedia 256MiB 3,3V ROM", 0x5b, 256, SZ_16K, NAND_ROM),
 148         {NULL}
 149 };
 150
 151 static struct nand_flash_dev nand_xd_flash_ids[] = {
 152         LEGACY_ID_NAND("xD 16MiB 3,3V",  0x73, 16,   SZ_16K, 0),
 153         LEGACY_ID_NAND("xD 32MiB 3,3V",  0x75, 32,   SZ_16K, 0),
 154         LEGACY_ID_NAND("xD 64MiB 3,3V",  0x76, 64,   SZ_16K, 0),
 155         LEGACY_ID_NAND("xD 128MiB 3,3V", 0x79, 128,  SZ_16K, 0),
 156         LEGACY_ID_NAND("xD 256MiB 3,3V", 0x71, 256,  SZ_16K, NAND_BROKEN_XD),
 157         LEGACY_ID_NAND("xD 512MiB 3,3V", 0xdc, 512,  SZ_16K, NAND_BROKEN_XD),
 158         LEGACY_ID_NAND("xD 1GiB 3,3V",   0xd3, 1024, SZ_16K, NAND_BROKEN_XD),
 159         LEGACY_ID_NAND("xD 2GiB 3,3V",   0xd5, 2048, SZ_16K, NAND_BROKEN_XD),
 160         {NULL}
 161 };
 162
 163 static int sm_attach_chip(struct nand_chip *chip)
 164 {
 165         struct mtd_info *mtd = nand_to_mtd(chip);
 166
 167         /* Bad block marker position */
 168         chip->badblockpos = 0x05;
 169         chip->badblockbits = 7;
 170         chip->block_markbad = sm_block_markbad;
 171
 172         /* ECC layout */
 173         if (mtd->writesize == SM_SECTOR_SIZE)
 174                 mtd_set_ooblayout(mtd, &oob_sm_ops);
 175         else if (mtd->writesize == SM_SMALL_PAGE)
 176                 mtd_set_ooblayout(mtd, &oob_sm_small_ops);
 177         else
 178                 return -ENODEV;
 179
 180         return 0;
 181 }
 182
 183 static const struct nand_controller_ops sm_controller_ops = {
 184         .attach_chip = sm_attach_chip,
 185 };
 186
 187 int sm_register_device(struct mtd_info *mtd, int smartmedia)
 188 {
 189         struct nand_chip *chip = mtd_to_nand(mtd);
 190         struct nand_flash_dev *flash_ids;
 191         int ret;
 192
 193         chip->options |= NAND_SKIP_BBTSCAN;
 194
 195         /* Scan for card properties */
 196         chip->dummy_controller.ops = &sm_controller_ops;
 197         flash_ids = smartmedia ? nand_smartmedia_flash_ids : nand_xd_flash_ids;
 198         ret = nand_scan_with_ids(chip, 1, flash_ids);
 199         if (ret)
 200                 return ret;
 201
 202         ret = mtd_device_register(mtd, NULL, 0);
 203         if (ret)
 204                 nand_cleanup(chip);
 205
 206         return ret;
 207 }
 208 EXPORT_SYMBOL_GPL(sm_register_device);
 209
 210 MODULE_LICENSE("GPL");
 211 MODULE_AUTHOR("Maxim Levitsky <maximlevitsky@gmail.com>");
 212 MODULE_DESCRIPTION("Common SmartMedia/xD functions");