blob: ba24cb36d0b908a8bf7fa5c57c9daac4b2957fcb [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001// SPDX-License-Identifier: GPL-2.0-only
Maxim Levitsky9fc51a32010-02-22 20:39:39 +02002/*
3 * Copyright © 2009 - Maxim Levitsky
4 * Common routines & support for xD format
Maxim Levitsky9fc51a32010-02-22 20:39:39 +02005 */
6#include <linux/kernel.h>
Boris Brezillond4092d72017-08-04 17:29:10 +02007#include <linux/mtd/rawnand.h>
Paul Gortmakera0e5cc52011-07-03 15:17:31 -04008#include <linux/module.h>
Artem Bityutskiy0c4a2352013-03-19 10:47:56 +02009#include <linux/sizes.h>
Maxim Levitsky9fc51a32010-02-22 20:39:39 +020010#include "sm_common.h"
11
Boris Brezillon987b9132016-02-03 20:04:59 +010012static int oob_sm_ooblayout_ecc(struct mtd_info *mtd, int section,
13 struct mtd_oob_region *oobregion)
14{
15 if (section > 1)
16 return -ERANGE;
17
18 oobregion->length = 3;
19 oobregion->offset = ((section + 1) * 8) - 3;
20
21 return 0;
22}
23
24static int oob_sm_ooblayout_free(struct mtd_info *mtd, int section,
25 struct mtd_oob_region *oobregion)
26{
27 switch (section) {
28 case 0:
29 /* reserved */
30 oobregion->offset = 0;
31 oobregion->length = 4;
32 break;
33 case 1:
34 /* LBA1 */
35 oobregion->offset = 6;
36 oobregion->length = 2;
37 break;
38 case 2:
39 /* LBA2 */
40 oobregion->offset = 11;
41 oobregion->length = 2;
42 break;
43 default:
44 return -ERANGE;
Maxim Levitsky9fc51a32010-02-22 20:39:39 +020045 }
Boris Brezillon987b9132016-02-03 20:04:59 +010046
47 return 0;
48}
49
50static const struct mtd_ooblayout_ops oob_sm_ops = {
51 .ecc = oob_sm_ooblayout_ecc,
52 .free = oob_sm_ooblayout_free,
Maxim Levitsky9fc51a32010-02-22 20:39:39 +020053};
54
55/* NOTE: This layout is is not compatabable with SmartMedia, */
56/* because the 256 byte devices have page depenent oob layout */
57/* However it does preserve the bad block markers */
58/* If you use smftl, it will bypass this and work correctly */
59/* If you not, then you break SmartMedia compliance anyway */
60
Boris Brezillon987b9132016-02-03 20:04:59 +010061static int oob_sm_small_ooblayout_ecc(struct mtd_info *mtd, int section,
62 struct mtd_oob_region *oobregion)
63{
64 if (section)
65 return -ERANGE;
Maxim Levitsky9fc51a32010-02-22 20:39:39 +020066
Boris Brezillon987b9132016-02-03 20:04:59 +010067 oobregion->length = 3;
68 oobregion->offset = 0;
69
70 return 0;
71}
72
73static int oob_sm_small_ooblayout_free(struct mtd_info *mtd, int section,
74 struct mtd_oob_region *oobregion)
75{
76 switch (section) {
77 case 0:
78 /* reserved */
79 oobregion->offset = 3;
80 oobregion->length = 2;
81 break;
82 case 1:
83 /* LBA1 */
84 oobregion->offset = 6;
85 oobregion->length = 2;
86 break;
87 default:
88 return -ERANGE;
89 }
90
91 return 0;
92}
93
94static const struct mtd_ooblayout_ops oob_sm_small_ops = {
95 .ecc = oob_sm_small_ooblayout_ecc,
96 .free = oob_sm_small_ooblayout_free,
97};
Maxim Levitsky9fc51a32010-02-22 20:39:39 +020098
Boris Brezillonc17556f2018-09-06 14:05:25 +020099static int sm_block_markbad(struct nand_chip *chip, loff_t ofs)
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200100{
Boris Brezillonc17556f2018-09-06 14:05:25 +0200101 struct mtd_info *mtd = nand_to_mtd(chip);
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200102 struct mtd_oob_ops ops;
103 struct sm_oob oob;
Brian Norris5a0edb22013-07-30 17:52:58 -0700104 int ret;
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200105
106 memset(&oob, -1, SM_OOB_SIZE);
107 oob.block_status = 0x0F;
108
109 /* As long as this function is called on erase block boundaries
110 it will work correctly for 256 byte nand */
Brian Norris0612b9d2011-08-30 18:45:40 -0700111 ops.mode = MTD_OPS_PLACE_OOB;
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200112 ops.ooboffs = 0;
113 ops.ooblen = mtd->oobsize;
114 ops.oobbuf = (void *)&oob;
115 ops.datbuf = NULL;
116
117
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200118 ret = mtd_write_oob(mtd, ofs, &ops);
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200119 if (ret < 0 || ops.oobretlen != SM_OOB_SIZE) {
Shreeya Patel63fa37f2018-02-22 22:01:22 +0530120 pr_notice("sm_common: can't mark sector at %i as bad\n",
121 (int)ofs);
Brian Norris5a0edb22013-07-30 17:52:58 -0700122 return -EIO;
123 }
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200124
Brian Norris5a0edb22013-07-30 17:52:58 -0700125 return 0;
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200126}
127
David Woodhouse2764fb42010-02-26 18:45:37 +0000128static struct nand_flash_dev nand_smartmedia_flash_ids[] = {
Artem Bityutskiy0c4a2352013-03-19 10:47:56 +0200129 LEGACY_ID_NAND("SmartMedia 2MiB 3,3V ROM", 0x5d, 2, SZ_8K, NAND_ROM),
130 LEGACY_ID_NAND("SmartMedia 4MiB 3,3V", 0xe3, 4, SZ_8K, 0),
131 LEGACY_ID_NAND("SmartMedia 4MiB 3,3/5V", 0xe5, 4, SZ_8K, 0),
132 LEGACY_ID_NAND("SmartMedia 4MiB 5V", 0x6b, 4, SZ_8K, 0),
133 LEGACY_ID_NAND("SmartMedia 4MiB 3,3V ROM", 0xd5, 4, SZ_8K, NAND_ROM),
134 LEGACY_ID_NAND("SmartMedia 8MiB 3,3V", 0xe6, 8, SZ_8K, 0),
135 LEGACY_ID_NAND("SmartMedia 8MiB 3,3V ROM", 0xd6, 8, SZ_8K, NAND_ROM),
136 LEGACY_ID_NAND("SmartMedia 16MiB 3,3V", 0x73, 16, SZ_16K, 0),
137 LEGACY_ID_NAND("SmartMedia 16MiB 3,3V ROM", 0x57, 16, SZ_16K, NAND_ROM),
138 LEGACY_ID_NAND("SmartMedia 32MiB 3,3V", 0x75, 32, SZ_16K, 0),
139 LEGACY_ID_NAND("SmartMedia 32MiB 3,3V ROM", 0x58, 32, SZ_16K, NAND_ROM),
140 LEGACY_ID_NAND("SmartMedia 64MiB 3,3V", 0x76, 64, SZ_16K, 0),
141 LEGACY_ID_NAND("SmartMedia 64MiB 3,3V ROM", 0xd9, 64, SZ_16K, NAND_ROM),
142 LEGACY_ID_NAND("SmartMedia 128MiB 3,3V", 0x79, 128, SZ_16K, 0),
143 LEGACY_ID_NAND("SmartMedia 128MiB 3,3V ROM", 0xda, 128, SZ_16K, NAND_ROM),
144 LEGACY_ID_NAND("SmartMedia 256MiB 3, 3V", 0x71, 256, SZ_16K, 0),
145 LEGACY_ID_NAND("SmartMedia 256MiB 3,3V ROM", 0x5b, 256, SZ_16K, NAND_ROM),
Artem Bityutskiy8dbfae12013-03-04 15:39:18 +0200146 {NULL}
David Woodhouse2764fb42010-02-26 18:45:37 +0000147};
148
Maxim Levitskyc3611572010-04-19 18:20:41 +0300149static struct nand_flash_dev nand_xd_flash_ids[] = {
Artem Bityutskiy0c4a2352013-03-19 10:47:56 +0200150 LEGACY_ID_NAND("xD 16MiB 3,3V", 0x73, 16, SZ_16K, 0),
151 LEGACY_ID_NAND("xD 32MiB 3,3V", 0x75, 32, SZ_16K, 0),
152 LEGACY_ID_NAND("xD 64MiB 3,3V", 0x76, 64, SZ_16K, 0),
153 LEGACY_ID_NAND("xD 128MiB 3,3V", 0x79, 128, SZ_16K, 0),
154 LEGACY_ID_NAND("xD 256MiB 3,3V", 0x71, 256, SZ_16K, NAND_BROKEN_XD),
155 LEGACY_ID_NAND("xD 512MiB 3,3V", 0xdc, 512, SZ_16K, NAND_BROKEN_XD),
156 LEGACY_ID_NAND("xD 1GiB 3,3V", 0xd3, 1024, SZ_16K, NAND_BROKEN_XD),
157 LEGACY_ID_NAND("xD 2GiB 3,3V", 0xd5, 2048, SZ_16K, NAND_BROKEN_XD),
Artem Bityutskiy8dbfae12013-03-04 15:39:18 +0200158 {NULL}
Maxim Levitskyc3611572010-04-19 18:20:41 +0300159};
160
Miquel Raynalfe13ae02018-07-27 01:18:05 +0200161static int sm_attach_chip(struct nand_chip *chip)
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200162{
Miquel Raynalfe13ae02018-07-27 01:18:05 +0200163 struct mtd_info *mtd = nand_to_mtd(chip);
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200164
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300165 /* Bad block marker position */
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200166 chip->badblockpos = 0x05;
167 chip->badblockbits = 7;
Boris Brezilloncdc784c2018-09-07 00:38:38 +0200168 chip->legacy.block_markbad = sm_block_markbad;
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200169
170 /* ECC layout */
171 if (mtd->writesize == SM_SECTOR_SIZE)
Boris Brezillon987b9132016-02-03 20:04:59 +0100172 mtd_set_ooblayout(mtd, &oob_sm_ops);
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200173 else if (mtd->writesize == SM_SMALL_PAGE)
Boris Brezillon987b9132016-02-03 20:04:59 +0100174 mtd_set_ooblayout(mtd, &oob_sm_small_ops);
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200175 else
176 return -ENODEV;
177
Miquel Raynalfe13ae02018-07-27 01:18:05 +0200178 return 0;
179}
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200180
Miquel Raynalfe13ae02018-07-27 01:18:05 +0200181static const struct nand_controller_ops sm_controller_ops = {
182 .attach_chip = sm_attach_chip,
183};
184
185int sm_register_device(struct mtd_info *mtd, int smartmedia)
186{
187 struct nand_chip *chip = mtd_to_nand(mtd);
188 struct nand_flash_dev *flash_ids;
189 int ret;
190
191 chip->options |= NAND_SKIP_BBTSCAN;
192
193 /* Scan for card properties */
Boris Brezillon7b6a9b22018-11-20 10:02:39 +0100194 chip->legacy.dummy_controller.ops = &sm_controller_ops;
Miquel Raynalfe13ae02018-07-27 01:18:05 +0200195 flash_ids = smartmedia ? nand_smartmedia_flash_ids : nand_xd_flash_ids;
Boris Brezillon00ad3782018-09-06 14:05:14 +0200196 ret = nand_scan_with_ids(chip, 1, flash_ids);
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200197 if (ret)
198 return ret;
199
Miquel Raynal92aa2922018-02-25 23:09:14 +0100200 ret = mtd_device_register(mtd, NULL, 0);
201 if (ret)
202 nand_cleanup(chip);
203
204 return ret;
Maxim Levitsky9fc51a32010-02-22 20:39:39 +0200205}
206EXPORT_SYMBOL_GPL(sm_register_device);
207
208MODULE_LICENSE("GPL");
209MODULE_AUTHOR("Maxim Levitsky <maximlevitsky@gmail.com>");
210MODULE_DESCRIPTION("Common SmartMedia/xD functions");